Class: RuboCop::Cop::Layout::EmptyLinesAfterModuleInclusion

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/layout/empty_lines_after_module_inclusion.rb

Overview

Checks for an empty line after a module inclusion method (‘extend`, `include` and `prepend`), or a group of them.

Examples:

# bad
class Foo
  include Bar
  attr_reader :baz
end

# good
class Foo
  include Bar

  attr_reader :baz
end

# also good - multiple module inclusions grouped together
class Foo
  extend Bar
  include Baz
  prepend Qux
end

Constant Summary collapse

MSG = 
'Add an empty line after module inclusion.'
MODULE_INCLUSION_METHODS = 
%i[include extend prepend].freeze
RESTRICT_ON_SEND = 
MODULE_INCLUSION_METHODS

Constants included from RangeHelp

RangeHelp::BYTE_ORDER_MARK, RangeHelp::NOT_GIVEN

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from 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
 
# File 'lib/rubocop/cop/layout/empty_lines_after_module_inclusion.rb', line 40

def on_send(node)
  return if node.receiver || node.arguments.empty?
  return if node.parent&.type?(:send, :any_block)

  return if next_line_empty_or_enable_directive_comment?(node.last_line)

  next_line_node = next_line_node(node)
  return unless require_empty_line?(next_line_node)

  add_offense(node) { |corrector| autocorrect(corrector, node) }
end