File: options_spec.rb

package info (click to toggle)
ruby-thor 1.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 904 kB
  • sloc: ruby: 9,250; makefile: 8; sh: 1
file content (559 lines) | stat: -rw-r--r-- 20,587 bytes parent folder | download
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
require "helper"
require "thor/parser"

describe Thor::Options do
  def create(opts, defaults = {}, stop_on_unknown = false, exclusives = [], at_least_ones = [])
    relation = {
      exclusive_option_names: exclusives,
      at_least_one_option_names: at_least_ones
    }
    opts.each do |key, value|
      opts[key] = Thor::Option.parse(key, value) unless value.is_a?(Thor::Option)
    end
    @opt = Thor::Options.new(opts, defaults, stop_on_unknown, false, relation)
  end

  def parse(*args)
    @opt.parse(args.flatten)
  end

  def check_unknown!
    @opt.check_unknown!
  end

  def remaining
    @opt.remaining
  end

  describe "#to_switches" do
    it "turns true values into a flag" do
      expect(Thor::Options.to_switches(color: true)).to eq("--color")
    end

    it "ignores nil" do
      expect(Thor::Options.to_switches(color: nil)).to eq("")
    end

    it "ignores false" do
      expect(Thor::Options.to_switches(color: false)).to eq("")
    end

    it "avoids extra spaces" do
      expect(Thor::Options.to_switches(color: false, foo: nil)).to eq("")
    end

    it "writes --name value for anything else" do
      expect(Thor::Options.to_switches(format: "specdoc")).to eq('--format "specdoc"')
    end

    it "joins several values" do
      switches = Thor::Options.to_switches(color: true, foo: "bar").split(" ").sort
      expect(switches).to eq(%w("bar" --color --foo))
    end

    it "accepts arrays" do
      expect(Thor::Options.to_switches(count: [1, 2, 3])).to eq("--count 1 2 3")
    end

    it "accepts hashes" do
      expect(Thor::Options.to_switches(count: {a: :b})).to eq("--count a:b")
    end

    it "accepts underscored options" do
      expect(Thor::Options.to_switches(under_score_option: "foo bar")).to eq('--under_score_option "foo bar"')
    end
  end

  describe "#parse" do
    it "allows multiple aliases for a given switch" do
      create %w(--foo --bar --baz) => :string
      expect(parse("--foo", "12")["foo"]).to eq("12")
      expect(parse("--bar", "12")["foo"]).to eq("12")
      expect(parse("--baz", "12")["foo"]).to eq("12")
    end

    it "allows custom short names" do
      create "-f" => :string
      expect(parse("-f", "12")).to eq("f" => "12")
    end

    it "allows custom short-name aliases" do
      create %w(--bar -f) => :string
      expect(parse("-f", "12")).to eq("bar" => "12")
    end

    it "accepts conjoined short switches" do
      create %w(--foo -f) => true, %w(--bar -b) => true, %w(--app -a) => true
      opts = parse("-fba")
      expect(opts["foo"]).to be true
      expect(opts["bar"]).to be true
      expect(opts["app"]).to be true
    end

    it "accepts conjoined short switches with input" do
      create %w(--foo -f) => true, %w(--bar -b) => true, %w(--app -a) => :required
      opts = parse "-fba", "12"
      expect(opts["foo"]).to be true
      expect(opts["bar"]).to be true
      expect(opts["app"]).to eq("12")
    end

    it "returns the default value if none is provided" do
      create foo: "baz", bar: :required
      expect(parse("--bar", "boom")["foo"]).to eq("baz")
    end

    it "returns the default value from defaults hash to required arguments" do
      create Hash[bar: :required], Hash[bar: "baz"]
      expect(parse["bar"]).to eq("baz")
    end

    it "gives higher priority to defaults given in the hash" do
      create Hash[bar: true], Hash[bar: false]
      expect(parse["bar"]).to eq(false)
    end

    it "raises an error for unknown switches" do
      create foo: "baz", bar: :required
      parse("--bar", "baz", "--baz", "unknown")

      expected = "Unknown switches \"--baz\"".dup
      expected << "\nDid you mean?  \"--bar\"" if Thor::Correctable

      expect { check_unknown! }.to raise_error(Thor::UnknownArgumentError) do |error|
        expect(error.to_s).to eq(expected)
      end
    end

    it "skips leading non-switches" do
      create(foo: "baz")

      expect(parse("asdf", "--foo", "bar")).to eq("foo" => "bar")
    end

    it "correctly recognizes things that look kind of like options, but aren't, as not options" do
      create(foo: "baz")
      expect(parse("--asdf---asdf", "baz", "--foo", "--asdf---dsf--asdf")).to eq("foo" => "--asdf---dsf--asdf")
      check_unknown!
    end

    it "accepts underscores in commandline args hash for boolean" do
      create foo_bar: :boolean
      expect(parse("--foo_bar")["foo_bar"]).to eq(true)
      expect(parse("--no_foo_bar")["foo_bar"]).to eq(false)
    end

    it "accepts underscores in commandline args hash for strings" do
      create foo_bar: :string, baz_foo: :string
      expect(parse("--foo_bar", "baz")["foo_bar"]).to eq("baz")
      expect(parse("--baz_foo", "foo bar")["baz_foo"]).to eq("foo bar")
    end

    it "interprets everything after -- as args instead of options" do
      create(foo: :string, bar: :required)
      expect(parse(%w(--bar abc moo -- --foo def -a))).to eq("bar" => "abc")
      expect(remaining).to eq(%w(moo --foo def -a))
    end

    it "ignores -- when looking for single option values" do
      create(foo: :string, bar: :required)
      expect(parse(%w(--bar -- --foo def -a))).to eq("bar" => "--foo")
      expect(remaining).to eq(%w(def -a))
    end

    it "ignores -- when looking for array option values" do
      create(foo: :array)
      expect(parse(%w(--foo a b -- c d -e))).to eq("foo" => %w(a b c d -e))
      expect(remaining).to eq([])
    end

    it "ignores -- when looking for hash option values" do
      create(foo: :hash)
      expect(parse(%w(--foo a:b -- c:d -e))).to eq("foo" => {"a" => "b", "c" => "d"})
      expect(remaining).to eq(%w(-e))
    end

    it "ignores trailing --" do
      create(foo: :string)
      expect(parse(%w(--foo --))).to eq("foo" => nil)
      expect(remaining).to eq([])
    end

    describe "with no input" do
      it "and no switches returns an empty hash" do
        create({})
        expect(parse).to eq({})
      end

      it "and several switches returns an empty hash" do
        create "--foo" => :boolean, "--bar" => :string
        expect(parse).to eq({})
      end

      it "and a required switch raises an error" do
        create "--foo" => :required
        expect { parse }.to raise_error(Thor::RequiredArgumentMissingError, "No value provided for required options '--foo'")
      end
    end

    describe "with one required and one optional switch" do
      before do
        create "--foo" => :required, "--bar" => :boolean
      end

      it "raises an error if the required switch has no argument" do
        expect { parse("--foo") }.to raise_error(Thor::MalformattedArgumentError)
      end

      it "raises an error if the required switch isn't given" do
        expect { parse("--bar") }.to raise_error(Thor::RequiredArgumentMissingError)
      end

      it "raises an error if the required switch is set to nil" do
        expect { parse("--no-foo") }.to raise_error(Thor::RequiredArgumentMissingError)
      end

      it "does not raises an error if the required option has a default value" do
        options = {required: true, type: :string, default: "baz"}
        create foo: Thor::Option.new("foo", options), bar: :boolean
        expect { parse("--bar") }.not_to raise_error
      end
    end

    context "when stop_on_unknown is true" do
      before do
        create({foo: :string, verbose: :boolean}, {}, true)
      end

      it "stops parsing on first non-option" do
        expect(parse(%w(foo --verbose))).to eq({})
        expect(remaining).to eq(%w(foo --verbose))
      end

      it "stops parsing on unknown option" do
        expect(parse(%w(--bar --verbose))).to eq({})
        expect(remaining).to eq(%w(--bar --verbose))
      end

      it "retains -- after it has stopped parsing" do
        expect(parse(%w(--bar -- whatever))).to eq({})
        expect(remaining).to eq(%w(--bar -- whatever))
      end

      it "still accepts options that are given before non-options" do
        expect(parse(%w(--verbose foo))).to eq("verbose" => true)
        expect(remaining).to eq(%w(foo))
      end

      it "still accepts options that require a value" do
        expect(parse(%w(--foo bar baz))).to eq("foo" => "bar")
        expect(remaining).to eq(%w(baz))
      end

      it "still interprets everything after -- as args instead of options" do
        expect(parse(%w(-- --verbose))).to eq({})
        expect(remaining).to eq(%w(--verbose))
      end
    end

    context "when exclusives is given" do
      before do
        create({foo: :boolean, bar: :boolean, baz: :boolean, qux: :boolean}, {}, false,
               [["foo", "bar"], ["baz","qux"]])
      end

      it "raises an error if exclusive argumets are given" do
        expect{parse(%w[--foo --bar])}.to raise_error(Thor::ExclusiveArgumentError, "Found exclusive options '--foo', '--bar'")
      end

      it "does not raise an error if exclusive argumets are not given" do
        expect{parse(%w[--foo --baz])}.not_to raise_error
      end
    end

    context "when at_least_ones is given" do
      before do
        create({foo: :string, bar: :boolean, baz: :boolean, qux: :boolean}, {}, false,
               [], [["foo", "bar"], ["baz","qux"]])
      end

      it "raises an error if at least one of required argumet is not given" do
        expect{parse(%w[--baz])}.to raise_error(Thor::AtLeastOneRequiredArgumentError, "Not found at least one of required options '--foo', '--bar'")
      end

      it "does not raise an error if at least one of required argument is given" do
        expect{parse(%w[--foo --baz])}.not_to raise_error
      end
    end

    context "when exclusives is given" do
      before do
        create({foo: :boolean, bar: :boolean, baz: :boolean, qux: :boolean}, {}, false,
               [["foo", "bar"], ["baz","qux"]])
      end

      it "raises an error if exclusive argumets are given" do
        expect{parse(%w[--foo --bar])}.to raise_error(Thor::ExclusiveArgumentError, "Found exclusive options '--foo', '--bar'")
      end

      it "does not raise an error if exclusive argumets are not given" do
        expect{parse(%w[--foo --baz])}.not_to raise_error
      end
    end

    context "when at_least_ones is given" do
      before do
        create({foo: :string, bar: :boolean, baz: :boolean, qux: :boolean}, {}, false,
               [], [["foo", "bar"], ["baz","qux"]])
      end

      it "raises an error if at least one of required argumet is not given" do
        expect{parse(%w[--baz])}.to raise_error(Thor::AtLeastOneRequiredArgumentError, "Not found at least one of required options '--foo', '--bar'")
      end

      it "does not raise an error if at least one of required argument is given" do
        expect{parse(%w[--foo --baz])}.not_to raise_error
      end
    end

    describe "with :string type" do
      before do
        create %w(--foo -f) => :required
      end

      it "accepts a switch <value> assignment" do
        expect(parse("--foo", "12")["foo"]).to eq("12")
      end

      it "accepts a switch=<value> assignment" do
        expect(parse("-f=12")["foo"]).to eq("12")
        expect(parse("--foo=12")["foo"]).to eq("12")
        expect(parse("--foo=bar=baz")["foo"]).to eq("bar=baz")
        expect(parse("--foo=-bar")["foo"]).to eq("-bar")
        expect(parse("--foo=-bar -baz")["foo"]).to eq("-bar -baz")
      end

      it "must accept underscores switch=value assignment" do
        create foo_bar: :required
        expect(parse("--foo_bar=http://example.com/under_score/")["foo_bar"]).to eq("http://example.com/under_score/")
      end

      it "accepts a --no-switch format" do
        create "--foo" => "bar"
        expect(parse("--no-foo")["foo"]).to be nil
      end

      it "does not consume an argument for --no-switch format" do
        create "--cheese" => :string
        expect(parse("burger", "--no-cheese", "fries")["cheese"]).to be nil
      end

      it "accepts a --switch format on non required types" do
        create "--foo" => :string
        expect(parse("--foo")["foo"]).to eq("foo")
      end

      it "accepts a --switch format on non required types with default values" do
        create "--baz" => :string, "--foo" => "bar"
        expect(parse("--baz", "bang", "--foo")["foo"]).to eq("bar")
      end

      it "overwrites earlier values with later values" do
        expect(parse("--foo=bar", "--foo", "12")["foo"]).to eq("12")
        expect(parse("--foo", "12", "--foo", "13")["foo"]).to eq("13")
      end

      it "raises error when value isn't in enum" do
        enum = %w(apple banana)
        create fruit: Thor::Option.new("fruit", type: :string, enum: enum)
        expect { parse("--fruit", "orange") }.to raise_error(Thor::MalformattedArgumentError,
            "Expected '--fruit' to be one of #{enum.join(', ')}; got orange")
      end

      it "does not erroneously mutate defaults" do
        create foo: Thor::Option.new("foo", type: :string, repeatable: true, required: false, default: [])
        expect(parse("--foo=bar", "--foo", "12")["foo"]).to eq(["bar", "12"])
        expect(@opt.instance_variable_get(:@switches)["--foo"].default).to eq([])
      end
    end

    describe "with :boolean type" do
      before do
        create "--foo" => false
      end

      it "accepts --opt assignment" do
        expect(parse("--foo")["foo"]).to eq(true)
        expect(parse("--foo", "--bar")["foo"]).to eq(true)
      end

      it "uses the default value if no switch is given" do
        expect(parse("")["foo"]).to eq(false)
      end

      it "accepts --opt=value assignment" do
        expect(parse("--foo=true")["foo"]).to eq(true)
        expect(parse("--foo=false")["foo"]).to eq(false)
      end

      it "accepts --[no-]opt variant, setting false for value" do
        expect(parse("--no-foo")["foo"]).to eq(false)
      end

      it "accepts --[skip-]opt variant, setting false for value" do
        expect(parse("--skip-foo")["foo"]).to eq(false)
      end

      it "accepts --[skip-]opt variant, setting false for value, even if there's a trailing non-switch" do
        expect(parse("--skip-foo", "asdf")["foo"]).to eq(false)
      end

      it "will prefer 'no-opt' variant over inverting 'opt' if explicitly set" do
        create "--no-foo" => true
        expect(parse("--no-foo")["no-foo"]).to eq(true)
      end

      it "will prefer 'skip-opt' variant over inverting 'opt' if explicitly set" do
        create "--skip-foo" => true
        expect(parse("--skip-foo")["skip-foo"]).to eq(true)
      end

      it "will prefer 'skip-opt' variant over inverting 'opt' if explicitly set, even if there's a trailing non-switch" do
        create "--skip-foo" => true
        expect(parse("--skip-foo", "asdf")["skip-foo"]).to eq(true)
      end

      it "will prefer 'skip-opt' variant over inverting 'opt' if explicitly set, and given a value" do
        create "--skip-foo" => true
        expect(parse("--skip-foo=f")["skip-foo"]).to eq(false)
        expect(parse("--skip-foo=false")["skip-foo"]).to eq(false)
        expect(parse("--skip-foo=t")["skip-foo"]).to eq(true)
        expect(parse("--skip-foo=true")["skip-foo"]).to eq(true)
      end

      it "accepts inputs in the human name format" do
        create foo_bar: :boolean
        expect(parse("--foo-bar")["foo_bar"]).to eq(true)
        expect(parse("--no-foo-bar")["foo_bar"]).to eq(false)
        expect(parse("--skip-foo-bar")["foo_bar"]).to eq(false)
      end

      it "doesn't eat the next part of the param" do
        expect(parse("--foo", "bar")).to eq("foo" => true)
        expect(@opt.remaining).to eq(%w(bar))
      end

      it "doesn't eat the next part of the param with 'no-opt' variant" do
        expect(parse("--no-foo", "bar")).to eq("foo" => false)
        expect(@opt.remaining).to eq(%w(bar))
      end

      it "doesn't eat the next part of the param with 'skip-opt' variant" do
        expect(parse("--skip-foo", "bar")).to eq("foo" => false)
        expect(@opt.remaining).to eq(%w(bar))
      end

      it "allows multiple values if repeatable is specified" do
        create verbose: Thor::Option.new("verbose", type: :boolean, aliases: "-v", repeatable: true)
        expect(parse("-v", "-v", "-v")["verbose"].count).to eq(3)
      end
    end

    describe "with :hash type" do
      before do
        create "--attributes" => :hash
      end

      it "accepts a switch=<value> assignment" do
        expect(parse("--attributes=name:string", "age:integer")["attributes"]).to eq("name" => "string", "age" => "integer")
        expect(parse("--attributes=-name:string", "age:integer", "--gender:string")["attributes"]).to eq("-name" => "string", "age" => "integer")
      end

      it "accepts a switch <value> assignment" do
        expect(parse("--attributes", "name:string", "age:integer")["attributes"]).to eq("name" => "string", "age" => "integer")
      end

      it "must not mix values with other switches" do
        expect(parse("--attributes", "name:string", "age:integer", "--baz", "cool")["attributes"]).to eq("name" => "string", "age" => "integer")
      end

      it "must not allow the same hash key to be specified multiple times" do
        expect { parse("--attributes", "name:string", "name:integer") }.to raise_error(Thor::MalformattedArgumentError, "You can't specify 'name' more than once in option '--attributes'; got name:string and name:integer")
      end

      it "allows multiple values if repeatable is specified" do
        create attributes: Thor::Option.new("attributes", type: :hash, repeatable: true)
        expect(parse("--attributes", "name:one", "foo:1", "--attributes", "name:two", "bar:2")["attributes"]).to eq({"name"=>"two", "foo"=>"1", "bar" => "2"})
      end
    end

    describe "with :array type" do
      before do
        create "--attributes" => :array
      end

      it "accepts a switch=<value> assignment" do
        expect(parse("--attributes=a", "b", "c")["attributes"]).to eq(%w(a b c))
        expect(parse("--attributes=-a", "b", "-c")["attributes"]).to eq(%w(-a b))
      end

      it "accepts a switch <value> assignment" do
        expect(parse("--attributes", "a", "b", "c")["attributes"]).to eq(%w(a b c))
      end

      it "must not mix values with other switches" do
        expect(parse("--attributes", "a", "b", "c", "--baz", "cool")["attributes"]).to eq(%w(a b c))
      end

      it "allows multiple values if repeatable is specified" do
        create attributes: Thor::Option.new("attributes", type: :array, repeatable: true)
        expect(parse("--attributes", "1", "2", "--attributes", "3", "4")["attributes"]).to eq([["1", "2"], ["3", "4"]])
      end

      it "raises error when value isn't in enum" do
        enum = %w(apple banana)
        create fruit: Thor::Option.new("fruits", type: :array, enum: enum)
        expect { parse("--fruits=", "apple", "banana", "strawberry") }.to raise_error(Thor::MalformattedArgumentError,
            "Expected all values of '--fruits' to be one of #{enum.join(', ')}; got strawberry")
      end
    end

    describe "with :numeric type" do
      before do
        create "n" => :numeric, "m" => 5
      end

      it "accepts a -nXY assignment" do
        expect(parse("-n12")["n"]).to eq(12)
      end

      it "converts values to numeric types" do
        expect(parse("-n", "3", "-m", ".5")).to eq("n" => 3, "m" => 0.5)
      end

      it "raises error when value isn't numeric" do
        expect { parse("-n", "foo") }.to raise_error(Thor::MalformattedArgumentError,
                                                     "Expected numeric value for '-n'; got \"foo\"")
      end

      it "raises error when value isn't in Array enum" do
        enum = [1, 2]
        create limit: Thor::Option.new("limit", type: :numeric, enum: enum)
        expect { parse("--limit", "3") }.to raise_error(Thor::MalformattedArgumentError,
                                                        "Expected '--limit' to be one of 1, 2; got 3")
      end

      it "raises error when value isn't in Range enum" do
        enum = 1..2
        create limit: Thor::Option.new("limit", type: :numeric, enum: enum)
        expect { parse("--limit", "3") }.to raise_error(Thor::MalformattedArgumentError,
                                                        "Expected '--limit' to be one of 1..2; got 3")
      end

      it "allows multiple values if repeatable is specified" do
        create run: Thor::Option.new("run", type: :numeric, repeatable: true)
        expect(parse("--run", "1", "--run", "2")["run"]).to eq([1, 2])
      end
    end
  end
end