Class: RuboCop::Cop::RSpec::MessageExpectation

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/rspec/message_expectation.rb

Overview

Checks for consistent message expectation style.

This cop can be configured in your configuration using the ‘EnforcedStyle` option and supports `–auto-gen-config`.

Examples:

‘EnforcedStyle: allow`


# bad
expect(foo).to receive(:bar)

# good
allow(foo).to receive(:bar)

‘EnforcedStyle: expect`


# bad
allow(foo).to receive(:bar)

# good
expect(foo).to receive(:bar)

Constant Summary collapse

MSG = 
'Prefer `%<style>s` for setting message expectations.'
SUPPORTED_STYLES = 
%w[allow expect].freeze

Constants inherited from Cop

Cop::DEFAULT_CONFIGURATION, Cop::DEFAULT_PATTERN_RE

Constants included from RSpec::Language

RSpec::Language::ALL, RSpec::Language::RSPEC

Instance Method Summary collapse

Methods inherited from Cop

inherited, #relevant_file?

Instance Method Details

#on_send(node) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/rubocop/cop/rspec/message_expectation.rb', line 40

def on_send(node)
  message_expectation(node) do |match|
    return correct_style_detected if preferred_style?(match)

    message = format(MSG, style: style)
    add_offense(match, location: :selector, message: message) do
      opposite_style_detected
    end
  end
end