Class: RuboCop::Cop::RSpec::HookArgument

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/rspec/hook_argument.rb

Overview

Checks the arguments passed to ‘before`, `around`, and `after`.

This cop checks for consistent style when specifying RSpec hooks which run for each example. There are three supported styles: “implicit”, “each”, and “example.” All styles have the same behavior.

Examples:

when configuration is ‘EnforcedStyle: implicit`

# bad
before(:each) do
  # ...
end

# bad
before(:example) do
  # ...
end

# good
before do
  # ...
end

when configuration is ‘EnforcedStyle: each`

# bad
before(:example) do
  # ...
end

# good
before do
  # ...
end

# good
before(:each) do
  # ...
end

when configuration is ‘EnforcedStyle: example`

# bad
before(:each) do
  # ...
end

# bad
before do
  # ...
end

# good
before(:example) do
  # ...
end

Constant Summary collapse

IMPLICIT_MSG = 
'Omit the default `%<scope>p` argument for RSpec hooks.'
EXPLICIT_MSG = 
'Use `%<scope>p` for RSpec hooks.'

Instance Method Summary collapse

Methods inherited from Base

inherited, #on_new_investigation

Methods included from RSpec::Language::NodePattern

#block_pattern, #send_pattern

Methods included from RSpec::Language

#example?, #example_group?, #example_group_with_body?, #hook?, #include?, #let?, #rspec?, #shared_group?, #spec_group?, #subject?

Instance Method Details

#on_block(node) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/rubocop/cop/rspec/hook_argument.rb', line 75

def on_block(node)
  hook(node) do |method_send, scope_name|
    return correct_style_detected if scope_name.equal?(style)
    return check_implicit(method_send) unless scope_name

    style_detected(scope_name)
    msg = explicit_message(scope_name)
    add_offense(method_send, message: msg) do |corrector|
      scope = implicit_style? ? '' : "(#{style.inspect})"
      corrector.replace(argument_range(method_send), scope)
    end
  end
end

#scoped_hook(node) ⇒ Object 



68
69
70
 
# File 'lib/rubocop/cop/rspec/hook_argument.rb', line 68

def_node_matcher :scoped_hook, <<-PATTERN
  (block $(send _ #Hooks.all (sym ${:each :example})) ...)
PATTERN

#unscoped_hook(node) ⇒ Object 



73
 
# File 'lib/rubocop/cop/rspec/hook_argument.rb', line 73

def_node_matcher :unscoped_hook, '(block $(send _ #Hooks.all) ...)'