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

Inherits:
Cop
  • Object
show all
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.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

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?, #correctable?, #disable_offense, #disable_uncorrectable?, #safe_autocorrect?, #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

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

Instance Method Details

#autocorrect(node) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/rubocop/cop/style/attr.rb', line 32

def autocorrect(node)
  attr_name, setter = *node.arguments

  node_expr = node.source_range
  attr_expr = attr_name.source_range

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

  lambda do |corrector|
    corrector.replace(node.loc.selector, replacement_method(node))
    corrector.remove(remove) if remove
  end
end

#on_send(node) ⇒ Object 



22
23
24
25
26
27
28
29
30
 
# File 'lib/rubocop/cop/style/attr.rb', line 22

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)

  add_offense(node, location: :selector)
end