Class: RuboCop::Cop::Style::Attr

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/attr.rb

Overview

This cop checks for uses of Module#attr.

Examples:

# 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

Constant Summary collapse

MSG =
'Do not use `attr`. Use `%<replacement>s` instead.'
RESTRICT_ON_SEND =
%i[attr].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_send(node) ⇒ Object


24
25
26
27
28
29
30
31
32
33
# 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