1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
|
# coding: utf-8
require "helper"
describe Thor::Shell::Basic do
def shell
@shell ||= Thor::Shell::Basic.new
end
describe "#padding" do
it "cannot be set to below zero" do
shell.padding = 10
expect(shell.padding).to eq(10)
shell.padding = -1
expect(shell.padding).to eq(0)
end
end
describe "#indent" do
it "sets the padding temporarily" do
shell.indent { expect(shell.padding).to eq(1) }
expect(shell.padding).to eq(0)
end
it "derives padding from original value" do
shell.padding = 6
shell.indent { expect(shell.padding).to eq(7) }
end
it "accepts custom indentation amounts" do
shell.indent(6) do
expect(shell.padding).to eq(6)
end
end
it "increases the padding when nested" do
shell.indent do
expect(shell.padding).to eq(1)
shell.indent do
expect(shell.padding).to eq(2)
end
end
expect(shell.padding).to eq(0)
end
end
describe "#ask" do
it "prints a message to the user and gets the response" do
expect(Thor::LineEditor).to receive(:readline).with("Should I overwrite it? ", {}).and_return("Sure")
expect(shell.ask("Should I overwrite it?")).to eq("Sure")
end
it "prints a message to the user prefixed with the current padding" do
expect(Thor::LineEditor).to receive(:readline).with(" Enter your name: ", {}).and_return("George")
shell.padding = 2
shell.ask("Enter your name:")
end
it "prints a message and returns nil if EOF is given as input" do
expect(Thor::LineEditor).to receive(:readline).with(" ", {}).and_return(nil)
expect(shell.ask("")).to eq(nil)
end
it "prints a message to the user and does not echo stdin if the echo option is set to false" do
expect($stdout).to receive(:print).with("What's your password? ")
expect($stdin).to receive(:noecho).and_return("mysecretpass")
expect(shell.ask("What's your password?", echo: false)).to eq("mysecretpass")
end
it "prints a message to the user with the available options, expects case-sensitive matching, and determines the correctness of the answer" do
flavors = %w(strawberry chocolate vanilla)
expect(Thor::LineEditor).to receive(:readline).with("What's your favorite Neopolitan flavor? [strawberry, chocolate, vanilla] ", {limited_to: flavors}).and_return("chocolate")
expect(shell.ask("What's your favorite Neopolitan flavor?", limited_to: flavors)).to eq("chocolate")
end
it "prints a message to the user with the available options, expects case-sensitive matching, and reasks the question after an incorrect response" do
flavors = %w(strawberry chocolate vanilla)
expect($stdout).to receive(:print).with("Your response must be one of: [strawberry, chocolate, vanilla]. Please try again.\n")
expect(Thor::LineEditor).to receive(:readline).with("What's your favorite Neopolitan flavor? [strawberry, chocolate, vanilla] ", {limited_to: flavors}).and_return("moose tracks", "chocolate")
expect(shell.ask("What's your favorite Neopolitan flavor?", limited_to: flavors)).to eq("chocolate")
end
it "prints a message to the user with the available options, expects case-sensitive matching, and reasks the question after a case-insensitive match" do
flavors = %w(strawberry chocolate vanilla)
expect($stdout).to receive(:print).with("Your response must be one of: [strawberry, chocolate, vanilla]. Please try again.\n")
expect(Thor::LineEditor).to receive(:readline).with("What's your favorite Neopolitan flavor? [strawberry, chocolate, vanilla] ", {limited_to: flavors}).and_return("cHoCoLaTe", "chocolate")
expect(shell.ask("What's your favorite Neopolitan flavor?", limited_to: flavors)).to eq("chocolate")
end
it "prints a message to the user with the available options, expects case-insensitive matching, and determines the correctness of the answer" do
flavors = %w(strawberry chocolate vanilla)
expect(Thor::LineEditor).to receive(:readline).with("What's your favorite Neopolitan flavor? [strawberry, chocolate, vanilla] ", {limited_to: flavors, case_insensitive: true}).and_return("CHOCOLATE")
expect(shell.ask("What's your favorite Neopolitan flavor?", limited_to: flavors, case_insensitive: true)).to eq("chocolate")
end
it "prints a message to the user with the available options, expects case-insensitive matching, and reasks the question after an incorrect response" do
flavors = %w(strawberry chocolate vanilla)
expect($stdout).to receive(:print).with("Your response must be one of: [strawberry, chocolate, vanilla]. Please try again.\n")
expect(Thor::LineEditor).to receive(:readline).with("What's your favorite Neopolitan flavor? [strawberry, chocolate, vanilla] ", {limited_to: flavors, case_insensitive: true}).and_return("moose tracks", "chocolate")
expect(shell.ask("What's your favorite Neopolitan flavor?", limited_to: flavors, case_insensitive: true)).to eq("chocolate")
end
it "prints a message to the user containing a default and sets the default if only enter is pressed" do
expect(Thor::LineEditor).to receive(:readline).with("What's your favorite Neopolitan flavor? (vanilla) ", {default: "vanilla"}).and_return("")
expect(shell.ask("What's your favorite Neopolitan flavor?", default: "vanilla")).to eq("vanilla")
end
it "prints a message to the user with the available options and reasks the question after an incorrect response and then returns the default" do
flavors = %w(strawberry chocolate vanilla)
expect($stdout).to receive(:print).with("Your response must be one of: [strawberry, chocolate, vanilla]. Please try again.\n")
expect(Thor::LineEditor).to receive(:readline).with("What's your favorite Neopolitan flavor? [strawberry, chocolate, vanilla] (vanilla) ", {default: "vanilla", limited_to: flavors}).and_return("moose tracks", "")
expect(shell.ask("What's your favorite Neopolitan flavor?", default: "vanilla", limited_to: flavors)).to eq("vanilla")
end
end
describe "#yes?" do
it "asks the user and returns true if the user replies yes" do
expect(Thor::LineEditor).to receive(:readline).with("Should I overwrite it? ", {add_to_history: false}).and_return("y")
expect(shell.yes?("Should I overwrite it?")).to be true
end
it "asks the user and returns false if the user replies no" do
expect(Thor::LineEditor).to receive(:readline).with("Should I overwrite it? ", {add_to_history: false}).and_return("n")
expect(shell.yes?("Should I overwrite it?")).not_to be true
end
it "asks the user and returns false if the user replies with an answer other than yes or no" do
expect(Thor::LineEditor).to receive(:readline).with("Should I overwrite it? ", {add_to_history: false}).and_return("foobar")
expect(shell.yes?("Should I overwrite it?")).to be false
end
end
describe "#no?" do
it "asks the user and returns true if the user replies no" do
expect(Thor::LineEditor).to receive(:readline).with("Should I overwrite it? ", {add_to_history: false}).and_return("n")
expect(shell.no?("Should I overwrite it?")).to be true
end
it "asks the user and returns false if the user replies yes" do
expect(Thor::LineEditor).to receive(:readline).with("Should I overwrite it? ", {add_to_history: false}).and_return("Yes")
expect(shell.no?("Should I overwrite it?")).to be false
end
it "asks the user and returns false if the user replies with an answer other than yes or no" do
expect(Thor::LineEditor).to receive(:readline).with("Should I overwrite it? ", {add_to_history: false}).and_return("foobar")
expect(shell.no?("Should I overwrite it?")).to be false
end
end
describe "#say" do
it "prints a message to the user" do
expect($stdout).to receive(:print).with("Running...\n")
shell.say("Running...")
end
it "prints a message to the user without new line if it ends with a whitespace" do
expect($stdout).to receive(:print).with("Running... ")
shell.say("Running... ")
end
it "does not use a new line with whitespace+newline embedded" do
expect($stdout).to receive(:print).with("It's \nRunning...\n")
shell.say("It's \nRunning...")
end
it "prints a message to the user without new line" do
expect($stdout).to receive(:print).with("Running...")
shell.say("Running...", nil, false)
end
it "coerces everything to a string before printing" do
expect($stdout).to receive(:print).with("this_is_not_a_string\n")
shell.say(:this_is_not_a_string, nil, true)
end
it "does not print a message if muted" do
expect($stdout).not_to receive(:print)
shell.mute do
shell.say("Running...")
end
end
it "does not print a message if base is set to quiet" do
shell.base = MyCounter.new [1, 2]
expect(shell.base).to receive(:options).and_return(quiet: true)
expect($stdout).not_to receive(:print)
shell.say("Running...")
end
end
describe "#say_error" do
it "prints a message to the user" do
expect($stderr).to receive(:print).with("Running...\n")
shell.say_error("Running...")
end
it "prints a message to the user without new line if it ends with a whitespace" do
expect($stderr).to receive(:print).with("Running... ")
shell.say_error("Running... ")
end
it "does not use a new line with whitespace+newline embedded" do
expect($stderr).to receive(:print).with("It's \nRunning...\n")
shell.say_error("It's \nRunning...")
end
it "prints a message to the user without new line" do
expect($stderr).to receive(:print).with("Running...")
shell.say_error("Running...", nil, false)
end
it "coerces everything to a string before printing" do
expect($stderr).to receive(:print).with("this_is_not_a_string\n")
shell.say_error(:this_is_not_a_string, nil, true)
end
it "does not print a message if muted" do
expect($stderr).not_to receive(:print)
shell.mute do
shell.say_error("Running...")
end
end
it "does not print a message if base is set to quiet" do
shell.base = MyCounter.new [1, 2]
expect(shell.base).to receive(:options).and_return(quiet: true)
expect($stderr).not_to receive(:print)
shell.say_error("Running...")
end
end
describe "#print_wrapped" do
let(:message) do
"Creates a back-up of the given folder by compressing it in a .tar.gz\n"\
"file and then uploading it to the configured Amazon S3 Bucket.\n\n"\
"It does not verify the integrity of the generated back-up."
end
before do
allow(ENV).to receive(:[]).with("THOR_COLUMNS").and_return(80)
end
context "without indentation" do
subject(:wrap_text) { described_class.new.print_wrapped(message) }
let(:expected_output) do
"Creates a back-up of the given folder by compressing it in a .tar.gz file and\n"\
"then uploading it to the configured Amazon S3 Bucket.\n\n"\
"It does not verify the integrity of the generated back-up.\n"
end
it "properly wraps the text around the 80th column" do
expect { wrap_text }.to output(expected_output).to_stdout
end
end
context "with indentation" do
subject(:wrap_text) { described_class.new.print_wrapped(message, indent: 4) }
let(:expected_output) do
" Creates a back-up of the given folder by compressing it in a .tar.gz file\n"\
" and then uploading it to the configured Amazon S3 Bucket.\n\n"\
" It does not verify the integrity of the generated back-up.\n"
end
it "properly wraps the text around the 80th column" do
expect { wrap_text }.to output(expected_output).to_stdout
end
end
end
describe "#say_status" do
it "prints a message to the user with status" do
expect($stdout).to receive(:print).with(" create ~/.thor/command.thor\n")
shell.say_status(:create, "~/.thor/command.thor")
end
it "always uses new line" do
expect($stdout).to receive(:print).with(" create \n")
shell.say_status(:create, "")
end
it "indents a multiline message" do
status = :foobar
lines = ["first line", "second line", " third line", " fourth line"]
expect($stdout).to receive(:print) do |string|
formatted_status = string[/^\s*#{status}\s*/]
margin = " " * formatted_status.length
expect(string).to eq(formatted_status + lines.join("\n#{margin}") + "\n")
end
shell.say_status(status, lines.join("\n") + "\n")
end
it "does not print a message if base is muted" do
expect(shell).to receive(:mute?).and_return(true)
expect($stdout).not_to receive(:print)
shell.mute do
shell.say_status(:created, "~/.thor/command.thor")
end
end
it "does not print a message if base is set to quiet" do
base = MyCounter.new [1, 2]
expect(base).to receive(:options).and_return(quiet: true)
expect($stdout).not_to receive(:print)
shell.base = base
shell.say_status(:created, "~/.thor/command.thor")
end
it "does not print a message if log status is set to false" do
expect($stdout).not_to receive(:print)
shell.say_status(:created, "~/.thor/command.thor", false)
end
it "uses padding to set message's left margin" do
shell.padding = 2
expect($stdout).to receive(:print).with(" create ~/.thor/command.thor\n")
shell.say_status(:create, "~/.thor/command.thor")
end
end
describe "#print_in_columns" do
before do
@array = [1_234_567_890]
@array += ("a".."e").to_a
end
it "prints in columns" do
content = capture(:stdout) { shell.print_in_columns(@array) }
expect(content.rstrip).to eq("1234567890 a b c d e")
end
end
describe "#print_table" do
before do
@table = []
@table << ["abc", "#123", "first three"]
@table << ["", "#0", "empty"]
@table << ["xyz", "#786", "last three"]
end
it "prints a table" do
content = capture(:stdout) { shell.print_table(@table) }
expect(content).to eq(<<-TABLE)
abc #123 first three
#0 empty
xyz #786 last three
TABLE
end
it "prints a table with indentation" do
content = capture(:stdout) { shell.print_table(@table, indent: 2) }
expect(content).to eq(<<-TABLE)
abc #123 first three
#0 empty
xyz #786 last three
TABLE
end
it "uses maximum terminal width" do
@table << ["def", "#456", "Lançam foo bar"]
@table << ["ghi", "#789", "بالله عليكم"]
content = capture(:stdout) { shell.print_table(@table, indent: 2, truncate: 20) }
expect(content).to eq(<<-TABLE)
abc #123 firs...
#0 empty
xyz #786 last...
def #456 Lanç...
ghi #789 بالل...
TABLE
end
it "honors the colwidth option" do
content = capture(:stdout) { shell.print_table(@table, colwidth: 10) }
expect(content).to eq(<<-TABLE)
abc #123 first three
#0 empty
xyz #786 last three
TABLE
end
it "prints tables with implicit columns" do
2.times { @table.first.pop }
content = capture(:stdout) { shell.print_table(@table) }
expect(content).to eq(<<-TABLE)
abc#{" "}
#0 empty
xyz #786 last three
TABLE
end
it "prints a table with small numbers and right-aligns them" do
table = [
["Name", "Number", "Color"], # rubocop: disable Style/WordArray
["Erik", 1, "green"]
]
content = capture(:stdout) { shell.print_table(table) }
expect(content).to eq(<<-TABLE)
Name Number Color
Erik 1 green
TABLE
end
it "doesn't output extra spaces for right-aligned columns in the last column" do
table = [
["Name", "Number"], # rubocop: disable Style/WordArray
["Erik", 1]
]
content = capture(:stdout) { shell.print_table(table) }
expect(content).to eq(<<-TABLE)
Name Number
Erik 1
TABLE
end
it "prints a table with big numbers" do
table = [
["Name", "Number", "Color"], # rubocop: disable Style/WordArray
["Erik", 1_234_567_890_123, "green"]
]
content = capture(:stdout) { shell.print_table(table) }
expect(content).to eq(<<-TABLE)
Name Number Color
Erik 1234567890123 green
TABLE
end
it "prints a table with borders" do
content = capture(:stdout) { shell.print_table(@table, borders: true) }
expect(content).to eq(<<-TABLE)
+-----+------+-------------+
| abc | #123 | first three |
| | #0 | empty |
| xyz | #786 | last three |
+-----+------+-------------+
TABLE
end
it "prints a table with borders and separators" do
@table.insert(1, :separator)
content = capture(:stdout) { shell.print_table(@table, borders: true) }
expect(content).to eq(<<-TABLE)
+-----+------+-------------+
| abc | #123 | first three |
+-----+------+-------------+
| | #0 | empty |
| xyz | #786 | last three |
+-----+------+-------------+
TABLE
end
it "prints a table with borders and small numbers and right-aligns them" do
table = [
["Name", "Number", "Color"], # rubocop: disable Style/WordArray
["Erik", 1, "green"]
]
content = capture(:stdout) { shell.print_table(table, borders: true) }
expect(content).to eq(<<-TABLE)
+------+--------+-------+
| Name | Number | Color |
| Erik | 1 | green |
+------+--------+-------+
TABLE
end
it "prints a table with borders and indentation" do
table = [
["Name", "Number", "Color"], # rubocop: disable Style/WordArray
["Erik", 1, "green"]
]
content = capture(:stdout) { shell.print_table(table, borders: true, indent: 2) }
expect(content).to eq(<<-TABLE)
+------+--------+-------+
| Name | Number | Color |
| Erik | 1 | green |
+------+--------+-------+
TABLE
end
end
describe "#file_collision" do
it "shows a menu with options" do
expect(Thor::LineEditor).to receive(:readline).with('Overwrite foo? (enter "h" for help) [Ynaqh] ', {add_to_history: false}).and_return("n")
shell.file_collision("foo")
end
it "outputs a new line and returns true if stdin is closed" do
expect($stdout).to receive(:print).with("\n")
expect(Thor::LineEditor).to receive(:readline).and_return(nil)
expect(shell.file_collision("foo")).to be true
end
it "returns true if the user chooses default option" do
expect(Thor::LineEditor).to receive(:readline).and_return("")
expect(shell.file_collision("foo")).to be true
end
it "returns false if the user chooses no" do
expect(Thor::LineEditor).to receive(:readline).and_return("n")
expect(shell.file_collision("foo")).to be false
end
it "returns true if the user chooses yes" do
expect(Thor::LineEditor).to receive(:readline).and_return("y")
expect(shell.file_collision("foo")).to be true
end
it "shows help usage if the user chooses help" do
expect(Thor::LineEditor).to receive(:readline).and_return("h", "n")
help = capture(:stdout) { shell.file_collision("foo") }
expect(help).to match(/h \- help, show this help/)
end
it "quits if the user chooses quit" do
expect($stdout).to receive(:print).with("Aborting...\n")
expect(Thor::LineEditor).to receive(:readline).and_return("q")
expect do
shell.file_collision("foo")
end.to raise_error(SystemExit)
end
it "always returns true if the user chooses always" do
expect(Thor::LineEditor).to receive(:readline).with('Overwrite foo? (enter "h" for help) [Ynaqh] ', {add_to_history: false}).and_return("a")
expect(shell.file_collision("foo")).to be true
expect($stdout).not_to receive(:print)
expect(shell.file_collision("foo")).to be true
end
describe "when a block is given" do
it "displays diff and merge options to the user" do
expect(Thor::LineEditor).to receive(:readline).with('Overwrite foo? (enter "h" for help) [Ynaqdhm] ', {add_to_history: false}).and_return("s")
shell.file_collision("foo") {}
end
it "invokes the diff command" do
expect(Thor::LineEditor).to receive(:readline).and_return("d")
expect(Thor::LineEditor).to receive(:readline).and_return("n")
expect(shell).to receive(:system).with(/diff -u/)
capture(:stdout) { shell.file_collision("foo") {} }
end
it "invokes the merge tool" do
allow(shell).to receive(:merge_tool).and_return("meld")
expect(Thor::LineEditor).to receive(:readline).and_return("m")
expect(shell).to receive(:system).with("meld", /foo/, "foo")
capture(:stdout) { shell.file_collision("foo") {} }
end
it "invokes the merge tool that specified at ENV['THOR_MERGE']" do
allow(ENV).to receive(:[]).with("THOR_MERGE").and_return("meld")
expect(Thor::LineEditor).to receive(:readline).and_return("m")
expect(shell).to receive(:system).with("meld", /foo/, "foo")
capture(:stdout) { shell.file_collision("foo") {} }
end
it "show warning if user chooses merge but merge tool is not specified" do
allow(shell).to receive(:merge_tool).and_return("")
expect(Thor::LineEditor).to receive(:readline).and_return("m")
expect(Thor::LineEditor).to receive(:readline).and_return("n")
help = capture(:stdout) { shell.file_collision("foo") {} }
expect(help).to match(/Please specify merge tool to `THOR_MERGE` env/)
end
end
end
end
|