Class: RuboCop::Cop::InternalAffairs::EmptyLineBetweenExpectOffenseAndCorrection

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/internal_affairs/empty_line_between_expect_offense_and_correction.rb

Overview

This cop checks whether `expect_offense` and correction expectation methods (i.e. `expect_correction` and `expect_no_corrections`) are separated by empty line.

Examples:

# bad
it 'registers and corrects an offense' do
  expect_offense(<<~RUBY)
    bad_method
    ^^^^^^^^^^ Use `good_method`.
  RUBY
  expect_correction(<<~RUBY)
    good_method
  RUBY
end

# good
it 'registers and corrects an offense' do
  expect_offense(<<~RUBY)
    bad_method
    ^^^^^^^^^^ Use `good_method`.
  RUBY

  expect_correction(<<~RUBY)
    good_method
  RUBY
end

Constant Summary collapse

MSG =
'Add empty line between `expect_offense` and `%<expect_correction>s`.'
RESTRICT_ON_SEND =
%i[expect_offense].freeze
CORRECTION_EXPECTATION_METHODS =
%i[expect_correction expect_no_corrections].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from RuboCop::Cop::IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#on_send(node) ⇒ Object


40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/rubocop/cop/internal_affairs/empty_line_between_expect_offense_and_correction.rb', line 40

def on_send(node)
  return unless (next_sibling = node.right_sibling) && next_sibling.send_type?

  method_name = next_sibling.method_name
  return unless CORRECTION_EXPECTATION_METHODS.include?(method_name)

  range = offense_range(node)
  return unless range.last_line + 1 == next_sibling.loc.line

  add_offense(range, message: format(MSG, expect_correction: method_name)) do |corrector|
    corrector.insert_after(range, "\n")
  end
end