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

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

Overview

Access modifiers should be surrounded by blank lines.

Examples:


# 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`.'.freeze
MSG_BEFORE_AND_AFTER =
'Keep a blank line before and after ' \
'`%<modifier>s`.'.freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #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?, #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

Methods included from PathUtil

absolute?, 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



32
33
34
35
36
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 32

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

  @block_line = nil
end

Instance Method Details

#autocorrect(node) ⇒ Object



73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 73

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

    unless next_line_empty?(node.last_line)
      corrector.insert_after(line, "\n")
    end
  end
end

#on_block(node) ⇒ Object



61
62
63
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 61

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

#on_class(node) ⇒ Object



38
39
40
41
42
43
44
45
46
47
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 38

def on_class(node)
  _name, superclass, _body = *node

  @class_or_module_def_first_line = if superclass
                                      superclass.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



49
50
51
52
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 49

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



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

def on_sclass(node)
  self_node, _body = *node

  @class_or_module_def_first_line = self_node.source_range.first_line
  @class_or_module_def_last_line = self_node.source_range.last_line
end

#on_send(node) ⇒ Object



65
66
67
68
69
70
71
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 65

def on_send(node)
  return unless node.bare_access_modifier?

  return if empty_lines_around?(node)

  add_offense(node)
end