Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

yield_control hardening #1167

Merged
merged 2 commits into from Mar 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 25 additions & 16 deletions lib/rspec/matchers/built_in/yield.rb
Expand Up @@ -98,7 +98,7 @@ def assert_valid_expect_block!
# Not intended to be instantiated directly.
class YieldControl < BaseMatcher
def initialize
at_least(:once)
@expectation_type = @expected_yields_count = nil
end

# @api public
Expand Down Expand Up @@ -153,7 +153,7 @@ def times
def matches?(block)
@probe = YieldProbe.probe(block)
return false unless @probe.has_block?

return @probe.num_yields > 0 unless @expectation_type
@probe.num_yields.__send__(@expectation_type, @expected_yields_count)
end

Expand Down Expand Up @@ -182,35 +182,44 @@ def supports_block_expectations?
private

def set_expected_yields_count(relativity, n)
raise "Multiple count constraints are not supported" if @expectation_type

@expectation_type = relativity
@expected_yields_count = case n
when Numeric then n
when :once then 1
when :twice then 2
when :thrice then 3
end
@expected_yields_count = count_constraint_to_number(n)
end

def count_constraint_to_number(n)
case n
when Numeric then n
when :once then 1
when :twice then 2
when :thrice then 3
else
raise ArgumentError, "Expected a number, :once, :twice or :thrice," \
" but got #{n}"
end
end

def failure_reason
return ' but was not a block' unless @probe.has_block?
return '' unless @expected_yields_count
" #{human_readable_expectation_type}#{human_readable_count(@expected_yields_count)}" \
" but yielded #{human_readable_count(@probe.num_yields)}"
"#{human_readable_expectation_type}#{human_readable_count(@expected_yields_count)}" \
" but yielded#{human_readable_count(@probe.num_yields)}"
end

def human_readable_expectation_type
case @expectation_type
when :<= then 'at most '
when :>= then 'at least '
when :<= then ' at most'
when :>= then ' at least'
else ''
end
end

def human_readable_count(count)
case count
when 1 then 'once'
when 2 then 'twice'
else "#{count} times"
when nil then ''
when 1 then ' once'
when 2 then ' twice'
else " #{count} times"
end
end
end
Expand Down
18 changes: 17 additions & 1 deletion spec/rspec/matchers/built_in/yield_spec.rb
Expand Up @@ -58,7 +58,7 @@ def each_arg(*args, &block)
it 'fails if the block does not yield' do
expect {
expect { |b| _dont_yield(&b) }.to yield_control
}.to fail_with(/expected given block to yield control/)
}.to fail_with(/expected given block to yield control but/)
end

it 'does not return a meaningful value from the block' do
Expand All @@ -67,6 +67,22 @@ def each_arg(*args, &block)
expect(val).to be_nil
end

it 'raises an error if given an invalid count argument' do
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just for clarity, do you mind to add examples for a failure message like

expect {
  expect { |b| 0.times.each(&b) }.to yield_control.at_least(:once)
}.to fail_with(/expected given block to yield control at least once but did not yield/)

expect {
  expect { |b| 2.times.each(&b) }.to yield_control.at_most(:once)
}.to fail_with(/expected given block to yield control at most once but yielded twice/)

expect {
  expect { |b| 1.times.each(&b) }.to yield_control.at_least(:twice)
}.to fail_with(/expected given block to yield control at least twice but yielded once/)

expect {
  expect { |b| 0.times.each(&b) }.to yield_control
}.to fail_with(/expected given block to yield control but did not yield/)

expect { yield_control.exactly('2') }.to raise_error(ArgumentError)
expect { yield_control.at_least(:trice_with_typo) }.to raise_error(ArgumentError)
expect { yield_control.at_most(nil) }.to raise_error(ArgumentError)
end

it 'is yet to support multiple calls to compatible count constraints' do
pending
expect { |b| 1.upto(4, &b) }.to yield_control.at_least(3).at_most(4).times
expect { |b| 1.upto(2, &b) }.not_to yield_control.at_least(3).at_most(4).times
end

it 'raises an error on multiple incompatible calls to count constraints' do
expect { yield_control.once.twice }.to raise_error(/multiple/i)
end

context "with exact count" do
it 'fails if the block yields wrong number of times' do
expect {
Expand Down