Class: RuboCop::Cop::Layout::EmptyLinesAroundAccessModifier

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle, RangeHelp
Defined in:
lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb

Overview

Access modifiers should be surrounded by blank lines.

Examples:

EnforcedStyle: around (default)


# bad
class Foo
  def bar; end
  private
  def baz; end
end

# good
class Foo
  def bar; end

  private

  def baz; end
end

EnforcedStyle: only_before


# bad
class Foo
  def bar; end
  private
  def baz; end
end

# good
class Foo
  def bar; end

  private
  def baz; end
end

Constant Summary collapse

MSG_AFTER = 
'Keep a blank line after `%<modifier>s`.'
MSG_BEFORE_AND_AFTER = 
'Keep a blank line before and after ' \
'`%<modifier>s`.'
MSG_BEFORE_FOR_ONLY_BEFORE = 
'Keep a blank line before `%<modifier>s`.'
MSG_AFTER_FOR_ONLY_BEFORE = 
'Remove a blank line after `%<modifier>s`.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #join_force?, lint?, match?, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

#initialize(config = nil, options = nil) ⇒ EmptyLinesAroundAccessModifier

Returns a new instance of EmptyLinesAroundAccessModifier


54
55
56
57
58
 
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 54

def initialize(config = nil, options = nil)
  super

  @block_line = nil
end

Instance Method Details

#autocorrect(node) ⇒ Object 


98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 98

def autocorrect(node)
  lambda do |corrector|
    line = range_by_whole_lines(node.source_range)

    unless previous_line_empty?(node.first_line)
      corrector.insert_before(line, "\n")
    end

    correct_next_line_if_denied_style(corrector, node, line)
  end
end

#on_block(node) ⇒ Object 


81
82
83
 
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 81

def on_block(node)
  @block_line = node.source_range.first_line
end

#on_class(node) ⇒ Object 


60
61
62
63
64
65
66
67
 
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 60

def on_class(node)
  @class_or_module_def_first_line = if node.parent_class
                                      node.parent_class.first_line
                                    else
                                      node.source_range.first_line
                                    end
  @class_or_module_def_last_line = node.source_range.last_line
end

#on_module(node) ⇒ Object 


69
70
71
72
 
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 69

def on_module(node)
  @class_or_module_def_first_line = node.source_range.first_line
  @class_or_module_def_last_line = node.source_range.last_line
end

#on_sclass(node) ⇒ Object 


74
75
76
77
78
79
 
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 74

def on_sclass(node)
  @class_or_module_def_first_line =
    node.identifier.source_range.first_line
  @class_or_module_def_last_line =
    node.source_range.last_line
end

#on_send(node) ⇒ Object 


85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 85

def on_send(node)
  return unless node.bare_access_modifier?

  case style
  when :around
    return if empty_lines_around?(node)
  when :only_before
    return if allowed_only_before_style?(node)
  end

  add_offense(node)
end