Class: RuboCop::Cop::Style::EmptyLinesAroundAccessModifier

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

Overview

Access modifiers should be surrounded by blank lines.

Constant Summary collapse

MSG = 
'Keep a blank line before and after `%s`.'

Constants included from AccessModifierNode

AccessModifierNode::MODULE_FUNCTION_NODE, AccessModifierNode::PRIVATE_NODE, AccessModifierNode::PROTECTED_NODE, AccessModifierNode::PUBLIC_NODE

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from AccessModifierNode

#class_constructor?, #class_or_module_parent?, #modifier_node?, #modifier_structure?

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/rubocop/cop/style/empty_lines_around_access_modifier.rb', line 20

def autocorrect(node)
  lambda do |corrector|
    send_line = node.loc.line
    previous_line = processed_source[send_line - 2]
    next_line = processed_source[send_line]

    line = Parser::Source::Range.new(
      processed_source.buffer,
      node.loc.expression.begin_pos - node.loc.column,
      node.loc.expression.end_pos
    )

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

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

#on_send(node) ⇒ Object 



12
13
14
15
16
17
18
 
# File 'lib/rubocop/cop/style/empty_lines_around_access_modifier.rb', line 12

def on_send(node)
  return unless modifier_node?(node)

  return if empty_lines_around?(node)

  add_offense(node, :expression)
end