class RuboCop::Cop::Layout::EmptyLinesAroundAttributeAccessor
Checks for a newline after an attribute accessor or a group of them. ‘alias` syntax and `alias_method`, `public`, `protected`, and `private` methods are allowed by default. These are customizable with `AllowAliasSyntax` and `AllowedMethods` options.
@example
# bad attr_accessor :foo def do_something end # good attr_accessor :foo def do_something end # good attr_accessor :foo attr_reader :bar attr_writer :baz attr :qux def do_something end
@example AllowAliasSyntax: true (default)
# good attr_accessor :foo alias :foo? :foo def do_something end
@example AllowAliasSyntax: false
# bad attr_accessor :foo alias :foo? :foo def do_something end # good attr_accessor :foo alias :foo? :foo def do_something end
@example AllowedMethods: [‘private’]
# good attr_accessor :foo private :foo def do_something end
Constants
- MSG
Public Instance Methods
Source
# File lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb, line 70 def on_send(node) return unless node.attribute_accessor? return if next_line_empty?(node.last_line) return if next_line_empty_or_enable_directive_comment?(node.last_line) next_line_node = next_line_node(node) return unless require_empty_line?(next_line_node) add_offense(node) { |corrector| autocorrect(corrector, node) } end
Private Instance Methods
Source
# File lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb, line 123 def allow_alias?(node) allow_alias_syntax? && node.alias_type? end
Source
# File lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb, line 133 def allow_alias_syntax? cop_config.fetch('AllowAliasSyntax', true) end
Source
# File lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb, line 127 def attribute_or_allowed_method?(node) return false unless node.send_type? node.attribute_accessor? || allowed_method?(node.method_name) end
Source
# File lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb, line 83 def autocorrect(corrector, node) node_range = range_by_whole_lines(node.source_range) next_line = node_range.last_line + 1 if next_line_enable_directive_comment?(next_line) node_range = processed_source.comment_at_line(next_line) end corrector.insert_after(node_range, "\n") end
Source
# File lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb, line 107 def next_line_empty?(line) processed_source[line].nil? || processed_source[line].blank? end
Source
# File lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb, line 94 def next_line_empty_or_enable_directive_comment?(line) return true if next_line_empty?(line) next_line = line + 1 next_line_enable_directive_comment?(next_line) && next_line_empty?(next_line) end
Source
# File lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb, line 101 def next_line_enable_directive_comment?(line) return false unless (comment = processed_source.comment_at_line(line)) DirectiveComment.new(comment).enabled? end
Source
# File lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb, line 117 def next_line_node(node) return if node.parent.if_type? node.right_sibling end
Source
# File lib/rubocop/cop/layout/empty_lines_around_attribute_accessor.rb, line 111 def require_empty_line?(node) return false unless node.respond_to?(:type) !allow_alias?(node) && !attribute_or_allowed_method?(node) end