Class: RuboCop::Cop::Layout::EmptyLinesAroundAccessModifier
- Includes:
- RangeHelp
- Defined in:
- lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb
Overview
Access modifiers should be surrounded by blank lines.
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`.'
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
- #autocorrect(node) ⇒ Object
-
#initialize(config = nil, options = nil) ⇒ EmptyLinesAroundAccessModifier
constructor
A new instance of EmptyLinesAroundAccessModifier.
- #on_block(node) ⇒ Object
- #on_class(node) ⇒ Object
- #on_module(node) ⇒ Object
- #on_sclass(node) ⇒ Object
- #on_send(node) ⇒ Object
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 AST::Sexp
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 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, 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.
32 33 34 35 36 |
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 32 def initialize(config = nil, = nil) super @block_line = nil end |
Instance Method Details
#autocorrect(node) ⇒ Object
71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 71 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
59 60 61 |
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 59 def on_block(node) @block_line = node.source_range.first_line end |
#on_class(node) ⇒ Object
38 39 40 41 42 43 44 45 |
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 38 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
47 48 49 50 |
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 47 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
52 53 54 55 56 57 |
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 52 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
63 64 65 66 67 68 69 |
# File 'lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb', line 63 def on_send(node) return unless node. return if empty_lines_around?(node) add_offense(node) end |