Class: RuboCop::Cop::Rails::ReadWriteAttribute

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/rails/read_write_attribute.rb

Overview

This cop checks for the use of the read_attribute or write_attribute methods.

Examples:


# bad
x = read_attributed(:attr)
write_attribute(:attr, val)

# good
x = self[:attr]
self[:attr] = val

Constant Summary collapse

MSG =
'Prefer `%s` over `%s`.'

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object


40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/rubocop/cop/rails/read_write_attribute.rb', line 40

def autocorrect(node)
  _receiver, method_name, _body = *node

  case method_name
  when :read_attribute
    replacement = read_attribute_replacement(node)
  when :write_attribute
    replacement = write_attribute_replacement(node)
  end

  ->(corrector) { corrector.replace(node.loc.expression, replacement) }
end

#message(node) ⇒ Object


30
31
32
33
34
35
36
37
38
# File 'lib/rubocop/cop/rails/read_write_attribute.rb', line 30

def message(node)
  _receiver, method_name, *_args = *node

  if method_name == :read_attribute
    format(MSG, 'self[:attr]', 'read_attribute(:attr)')
  else
    format(MSG, 'self[:attr] = val', 'write_attribute(:attr, val)')
  end
end

#on_send(node) ⇒ Object


21
22
23
24
25
26
27
28
# File 'lib/rubocop/cop/rails/read_write_attribute.rb', line 21

def on_send(node)
  receiver, method_name, *_args = *node
  return if receiver
  return unless [:read_attribute,
                 :write_attribute].include?(method_name)

  add_offense(node, :selector)
end