summaryrefslogtreecommitdiffstats
path: root/spec/shared_behaviours/things_that_declare_options.rb
blob: 1b41c2279490568b279c088ced36025196037379 (plain)
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
# -*- coding: utf-8 -*-
shared_examples_for "things that declare options" do
  it "should support options without arguments" do
    subject = add_options_to { option "--bar" }
    subject.should be_option :bar
  end

  it "should support options with an empty block" do
    subject = add_options_to do
      option "--foo" do
        # this section deliberately left blank
      end
    end
    subject.should be
    subject.should be_option :foo
  end

  it "should support option documentation" do
    text = "Sturm und Drang (German pronunciation: [ˈʃtʊʁm ʊnt ˈdʁaŋ]) …"

    subject = add_options_to do
      option "--foo" do
        desc text
      end
    end

    subject.get_option(:foo).desc.should == text
  end

  it "should list all the options" do
    subject = add_options_to do
      option "--foo"
      option "--bar"
    end
    subject.options.should =~ [:foo, :bar]
  end

  it "should detect conflicts in long options" do
    expect {
      add_options_to do
        option "--foo"
        option "--foo"
      end
    }.should raise_error ArgumentError, /Option foo conflicts with existing option foo/i
  end

  it "should detect conflicts in short options" do
    expect {
      add_options_to do
        option "-f"
        option "-f"
      end
    }.should raise_error ArgumentError, /Option f conflicts with existing option f/
  end

  ["-f", "--foo"].each do |option|
    ["", " FOO", "=FOO", " [FOO]", "=[FOO]"].each do |argument|
      input = option + argument
      it "should detect conflicts within a single option like #{input.inspect}" do
        expect {
          add_options_to do
            option input, input
          end
        }.should raise_error ArgumentError, /duplicates existing alias/
      end
    end
  end


  # Verify the range of interesting conflicts to check for ordering causing
  # the behaviour to change, or anything exciting like that.
  [ %w{--foo}, %w{-f}, %w{-f --foo}, %w{--baz -f},
    %w{-f --baz}, %w{-b --foo}, %w{--foo -b}
  ].each do |conflict|
    base = %w{--foo -f}
    it "should detect conflicts between #{base.inspect} and #{conflict.inspect}" do
      expect {
        add_options_to do
          option *base
          option *conflict
        end
      }.should raise_error ArgumentError, /conflicts with existing option/
    end
  end

  it "should fail if we are not consistent about taking an argument" do
    expect { add_options_to do option "--foo=bar", "--bar" end }.
      should raise_error ArgumentError, /inconsistent about taking an argument/
  end

  it "should accept optional arguments" do
    subject = add_options_to do option "--foo=[baz]", "--bar=[baz]" end
    [:foo, :bar].each do |name|
      subject.should be_option name
    end
  end

  describe "#takes_argument?" do
    it "should detect an argument being absent" do
      subject = add_options_to do option "--foo" end
      subject.get_option(:foo).should_not be_takes_argument
    end
    ["=FOO", " FOO", "=[FOO]", " [FOO]"].each do |input|
      it "should detect an argument given #{input.inspect}" do
        subject = add_options_to do option "--foo#{input}" end
        subject.get_option(:foo).should be_takes_argument
      end
    end
  end

  describe "#optional_argument?" do
    it "should be false if no argument is present" do
      option = add_options_to do option "--foo" end.get_option(:foo)
      option.should_not be_takes_argument
      option.should_not be_optional_argument
    end

    ["=FOO", " FOO"].each do |input|
      it "should be false if the argument is mandatory (like #{input.inspect})" do
        option = add_options_to do option "--foo#{input}" end.get_option(:foo)
      option.should be_takes_argument
      option.should_not be_optional_argument
      end
    end

    ["=[FOO]", " [FOO]"].each do |input|
      it "should be true if the argument is optional (like #{input.inspect})" do
        option = add_options_to do option "--foo#{input}" end.get_option(:foo)
      option.should be_takes_argument
      option.should be_optional_argument
      end
    end
  end
end