class RuboCop::Cop::Style::Attr

Checks for uses of Module#attr.

@example

# bad - creates a single attribute accessor (deprecated in Ruby 1.9)
attr :something, true
attr :one, :two, :three # behaves as attr_reader

# good
attr_accessor :something
attr_reader :one, :two, :three

Constants

MSG
RESTRICT_ON_SEND

Public Instance Methods

on_send(node) click to toggle source
# File lib/rubocop/cop/style/attr.rb, line 24
def on_send(node)
  return unless node.command?(:attr) && node.arguments?
  # check only for method definitions in class/module body
  return if node.parent && !node.parent.class_type? && !class_eval?(node.parent)

  message = message(node)
  add_offense(node.loc.selector, message: message) do |corrector|
    autocorrect(corrector, node)
  end
end

Private Instance Methods

autocorrect(corrector, node) click to toggle source
# File lib/rubocop/cop/style/attr.rb, line 37
def autocorrect(corrector, node)
  attr_name, setter = *node.arguments

  node_expr = node.source_range
  attr_expr = attr_name.source_range

  remove = range_between(attr_expr.end_pos, node_expr.end_pos) if setter&.boolean_type?

  corrector.replace(node.loc.selector, replacement_method(node))
  corrector.remove(remove) if remove
end
message(node) click to toggle source
# File lib/rubocop/cop/style/attr.rb, line 49
def message(node)
  format(MSG, replacement: replacement_method(node))
end
replacement_method(node) click to toggle source
# File lib/rubocop/cop/style/attr.rb, line 53
def replacement_method(node)
  setter = node.last_argument

  if setter&.boolean_type?
    setter.true_type? ? 'attr_accessor' : 'attr_reader'
  else
    'attr_reader'
  end
end