class RuboCop::Cop::RSpec::ScatteredSetup

Checks for setup scattered across multiple hooks in an example group.

Unify ‘before`, `after`, and `around` hooks when possible.

@example

# bad
describe Foo do
  before { setup1 }
  before { setup2 }
end

# good
describe Foo do
  before do
    setup1
    setup2
  end
end

Constants

MSG

Public Instance Methods

on_block(node) click to toggle source
# File lib/rubocop/cop/rspec/scattered_setup.rb, line 33
def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
  return unless example_group?(node)

  repeated_hooks(node).each do |occurrences|
    occurrences.each do |occurrence|
      message = message(occurrences, occurrence)
      add_offense(occurrence, message: message) do |corrector|
        autocorrect(corrector, occurrences.first, occurrence)
      end
    end
  end
end

Private Instance Methods

autocorrect(corrector, first_occurrence, occurrence) click to toggle source
# File lib/rubocop/cop/rspec/scattered_setup.rb, line 76
def autocorrect(corrector, first_occurrence, occurrence)
  return if first_occurrence == occurrence || !first_occurrence.body

  # Take heredocs into account
  body = occurrence.body&.source_range&.with(
    end_pos: final_end_location(occurrence).begin_pos
  )

  corrector.insert_after(first_occurrence.body,
                         "\n#{body&.source}")
  corrector.remove(range_by_whole_lines(occurrence.source_range,
                                        include_final_newline: true))
end
lines_msg(numbers) click to toggle source
# File lib/rubocop/cop/rspec/scattered_setup.rb, line 61
def lines_msg(numbers)
  if numbers.size == 1
    "line #{numbers.first}"
  else
    "lines #{numbers.join(', ')}"
  end
end
message(occurrences, occurrence) click to toggle source
# File lib/rubocop/cop/rspec/scattered_setup.rb, line 69
def message(occurrences, occurrence)
  lines = occurrences.map(&:first_line)
  lines_except_current = lines - [occurrence.first_line]
  format(MSG, hook_name: occurrences.first.method_name,
              lines: lines_msg(lines_except_current))
end
repeated_hooks(node) click to toggle source
# File lib/rubocop/cop/rspec/scattered_setup.rb, line 48
def repeated_hooks(node)
  hooks = RuboCop::RSpec::ExampleGroup.new(node)
    .hooks
    .select(&:knowable_scope?)
    .group_by { |hook| [hook.name, hook.scope, hook.metadata] }
    .values
    .reject(&:one?)

  hooks.map do |hook|
    hook.map(&:to_node)
  end
end