class RuboCop::Cop::RSpec::ExpectChange
Checks for consistent style of change matcher.
Enforces either passing object and attribute as arguments to the matcher or passing a block that reads the attribute value.
This cop can be configured using the `EnforcedStyle` option.
@example `EnforcedStyle: block`
# bad expect(run).to change(Foo, :bar) # good expect(run).to change { Foo.bar }
@example `EnforcedStyle: method_call`
# bad expect(run).to change { Foo.bar } expect(run).to change { foo.baz } # good expect(run).to change(Foo, :bar) expect(run).to change(foo, :baz) # also good when there are arguments or chained method calls expect(run).to change { Foo.bar(:count) } expect(run).to change { user.reload.name }
Constants
- MSG_BLOCK
- MSG_CALL
Public Instance Methods
autocorrect(node)
click to toggle source
# File lib/rubocop/cop/rspec/expect_change.rb, line 72 def autocorrect(node) if style == :block autocorrect_method_call_to_block(node) else autocorrect_block_to_method_call(node) end end
on_block(node)
click to toggle source
# File lib/rubocop/cop/rspec/expect_change.rb, line 61 def on_block(node) return unless style == :method_call expect_change_with_block(node) do |receiver, message| add_offense( node, message: format(MSG_BLOCK, obj: receiver, attr: message) ) end end
on_send(node)
click to toggle source
# File lib/rubocop/cop/rspec/expect_change.rb, line 50 def on_send(node) return unless style == :block expect_change_with_arguments(node) do |receiver, message| add_offense( node, message: format(MSG_CALL, obj: receiver, attr: message) ) end end
Private Instance Methods
autocorrect_block_to_method_call(node)
click to toggle source
# File lib/rubocop/cop/rspec/expect_change.rb, line 91 def autocorrect_block_to_method_call(node) lambda do |corrector| expect_change_with_block(node) do |receiver, message| replacement = "change(#{receiver}, :#{message})" corrector.replace(node.loc.expression, replacement) end end end
autocorrect_method_call_to_block(node)
click to toggle source
# File lib/rubocop/cop/rspec/expect_change.rb, line 82 def autocorrect_method_call_to_block(node) lambda do |corrector| expect_change_with_arguments(node) do |receiver, message| replacement = "change { #{receiver}.#{message} }" corrector.replace(node.loc.expression, replacement) end end end