File: description_generation_spec.rb

package info (click to toggle)
ruby-rspec 3.13.0c0e0m0s1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,856 kB
  • sloc: ruby: 70,868; sh: 1,423; makefile: 99
file content (194 lines) | stat: -rw-r--r-- 7,346 bytes parent folder | download | duplicates (2)
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
RSpec.describe 'a matcher is expected to be able to have its description generated' do
  after(:example) do
    RSpec::Matchers.clear_generated_description
  end

  example "expect(...).to eq expected" do
    expect("this").to eq "this"
    expect(RSpec::Matchers.generated_description).to eq "is expected to eq \"this\""
  end

  example "expect(...).to not eq expected" do
    expect("this").not_to eq "that"
    expect(RSpec::Matchers.generated_description).to eq "is expected not to eq \"that\""
  end

  example "expect(...).to be empty (arbitrary predicate)" do
    expect([]).to be_empty
    expect(RSpec::Matchers.generated_description).to eq "is expected to be empty"
  end

  example "expect(...).to not be empty (arbitrary predicate)" do
    expect([1]).not_to be_empty
    expect(RSpec::Matchers.generated_description).to eq "is expected not to be empty"
  end

  example "expect(...).to be truthy" do
    expect(true).to be_truthy
    expect(RSpec::Matchers.generated_description).to eq "is expected to be truthy"
  end

  example "expect(...).to be falsey" do
    expect(false).to be_falsey
    expect(RSpec::Matchers.generated_description).to eq "is expected to be falsey"
  end

  example "expect(...).to be nil" do
    expect(nil).to be_nil
    expect(RSpec::Matchers.generated_description).to eq "is expected to be nil"
  end

  example "expect(...).to be > n" do
    expect(5).to be > 3
    expect(RSpec::Matchers.generated_description).to eq "is expected to be > 3"
  end

  example "expect(...).to be between min and max" do
    expect(10).to be_between(0, 10)
    expect(RSpec::Matchers.generated_description).to eq "is expected to be between 0 and 10 (inclusive)"
  end

  example "expect(...).to be exclusively between min and max" do
    expect(9).to be_between(0, 10).exclusive
    expect(RSpec::Matchers.generated_description).to eq "is expected to be between 0 and 10 (exclusive)"
  end

  example "expect(...).to be predicate arg1, arg2 and arg3" do
    class Parent; end
    class Child < Parent
      def child_of?(*parents)
        parents.all? { |parent| is_a?(parent) }
      end
    end
    expect(Child.new).to be_a_child_of(Parent, Object)
    expect(RSpec::Matchers.generated_description).to eq "is expected to be a child of Parent and Object"
  end

  example "expect(...).to equal" do
    expected = "expected"
    expect(expected).to equal(expected)
    expect(RSpec::Matchers.generated_description).to eq "is expected to equal \"expected\""
  end

  example "expect(...).not_to equal" do
    expect(5).not_to equal(37)
    expect(RSpec::Matchers.generated_description).to eq "is expected not to equal 37"
  end

  example "expect(...).to eql" do
    expect("string").to eql("string")
    expect(RSpec::Matchers.generated_description).to eq "is expected to eql \"string\""
  end

  example "expect(...).not_to eql" do
    expect("a").not_to eql(:a)
    expect(RSpec::Matchers.generated_description).to eq "is expected not to eql :a"
  end

  example "expect(...).to have_key" do
    expect({ :a => "a" }).to have_key(:a)
    expect(RSpec::Matchers.generated_description).to eq "is expected to have key :a"
  end

  example "expect(...).to have_some_method" do
    object = Object.new
    def object.has_eyes_closed?; true; end

    expect(object).to have_eyes_closed
    expect(RSpec::Matchers.generated_description).to eq 'is expected to have eyes closed'
  end

  example "expect(...).to have_some_method(args*)" do
    object = Object.new
    def object.has_taste_for?(*_args); true; end

    expect(object).to have_taste_for("wine", "cheese")
    expect(RSpec::Matchers.generated_description).to eq 'is expected to have taste for "wine" and "cheese"'
  end

  example "expect(...).to include(x)" do
    expect([1, 2, 3]).to include(3)
    expect(RSpec::Matchers.generated_description).to eq "is expected to include 3"
  end

  example "expect(...).to include(x) when x responds to description but is not a matcher" do
    obj = double(:description => "description", :inspect => "inspect")
    expect([obj]).to include(obj)
    expect(RSpec::Matchers.generated_description).to eq "is expected to include inspect"
  end

  example "expect(...).to include(x) when x responds to description and is a matcher" do
    matcher = double(:description                => "description",
                     :matches?                   => true,
                     :failure_message => "")
    expect([matcher]).to include(matcher)
    expect(RSpec::Matchers.generated_description).to eq "is expected to include (description)"
  end

  example "expect(array).to contain_exactly(1, 2, 3)" do
    expect([1, 2, 3]).to contain_exactly(1, 2, 3)
    expect(RSpec::Matchers.generated_description).to eq "is expected to contain exactly 1, 2, and 3"
  end

  example "expect(...).to match" do
    expect("this string").to match(/this string/)
    expect(RSpec::Matchers.generated_description).to eq "is expected to match /this string/"
  end

  example "expect(...).to raise_error" do
    expect { raise 'foo' }.to raise_error Exception
    expect(RSpec::Matchers.generated_description).to eq "is expected to raise Exception"
  end

  example "expect(...).to raise_error with class" do
    expect { raise }.to raise_error(RuntimeError)
    expect(RSpec::Matchers.generated_description).to eq "is expected to raise RuntimeError"
  end

  example "expect(...).to raise_error with class and message" do
    expect { raise "there was an error" }.to raise_error(RuntimeError, "there was an error")
    expect(RSpec::Matchers.generated_description).to eq "is expected to raise RuntimeError with \"there was an error\""
  end

  example "expect(...).to respond_to" do
    expect([]).to respond_to(:insert)
    expect(RSpec::Matchers.generated_description).to eq "is expected to respond to #insert"
  end

  example "expect(...).to throw symbol" do
    expect { throw :what_a_mess }.to throw_symbol
    expect(RSpec::Matchers.generated_description).to eq "is expected to throw a Symbol"
  end

  example "expect(...).to throw symbol (with named symbol)" do
    expect { throw :what_a_mess }.to throw_symbol(:what_a_mess)
    expect(RSpec::Matchers.generated_description).to eq "is expected to throw :what_a_mess"
  end

  example "expect(...).to matcher_that_delegates_to_an_internal_expectation" do
    expect(1).to matcher_that_delegates_to_an_internal_expectation
    expect(RSpec::Matchers.generated_description).to eq "is expected to matcher that delegates to an internal expectation"
  end

  example "expect(...).not_to matcher_that_delegates_to_an_internal_expectation" do
    expect(1).not_to matcher_that_delegates_to_an_internal_expectation
    expect(RSpec::Matchers.generated_description).to eq "is expected not to matcher that delegates to an internal expectation"
  end

  RSpec::Matchers.define :matcher_that_delegates_to_an_internal_expectation do
    match { expect(1).to eq(1) }
    match_when_negated { expect(1).to eq(1) }
  end
end

RSpec.describe "a Matcher with no description" do
  it "provides a helpful message when used in a string-less example block" do
    matcher = Class.new do
      def matches?(_ignore); true; end
      def failure_message; ""; end
    end.new

    expect(5).to matcher
    expect(RSpec::Matchers.generated_description).to match(/When you call.*description method/m)
  end
end