Class: RuboCop::Cop::Layout::EmptyLinesAroundClassBody

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

Overview

This cop checks if empty lines around the bodies of classes match the configuration.

Examples:

EnforcedStyle: empty_lines

# good

class Foo

  def bar
    # ...
  end

end

EnforcedStyle: empty_lines_except_namespace

# good

class Foo
  class Bar

    # ...

  end
end

EnforcedStyle: empty_lines_special

# good
class Foo

  def bar; end

end

EnforcedStyle: beginning_only

# good

class Foo

  def bar
    # ...
  end
end

EnforcedStyle: ending_only

# good

class Foo
  def bar
    # ...
  end

end

EnforcedStyle: no_empty_lines (default)

# good

class Foo
  def bar
    # ...
  end
end

Constant Summary collapse

KIND =
'class'

Constants included from EmptyLinesAroundBody

RuboCop::Cop::Layout::EmptyLinesAroundBody::MSG_DEFERRED, RuboCop::Cop::Layout::EmptyLinesAroundBody::MSG_EXTRA, RuboCop::Cop::Layout::EmptyLinesAroundBody::MSG_MISSING

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

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 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_class(node) ⇒ Object


73
74
75
76
77
# File 'lib/rubocop/cop/layout/empty_lines_around_class_body.rb', line 73

def on_class(node)
  first_line = node.parent_class.first_line if node.parent_class

  check(node, node.body, adjusted_first_line: first_line)
end

#on_sclass(node) ⇒ Object


79
80
81
# File 'lib/rubocop/cop/layout/empty_lines_around_class_body.rb', line 79

def on_sclass(node)
  check(node, node.body)
end