Class: RuboCop::Cop::Rails::ActiveRecordAliases

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

Overview

Checks that ActiveRecord aliases are not used. The direct method names are more clear and easier to read.

Examples:

#bad
Book.update_attributes!(author: 'Alice')

#good
Book.update!(author: 'Alice')

Constant Summary collapse

MSG =
'Use `%<prefer>s` instead of `%<current>s`.'.freeze
ALIASES =
{
  update_attributes: :update,
  update_attributes!: :update!
}.freeze

Constants included from Util

Util::ASGN_NODES, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, 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, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

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 AST::Sexp

#s

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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, 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



35
36
37
38
39
40
41
42
# File 'lib/rubocop/cop/rails/active_record_aliases.rb', line 35

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(
      node.loc.selector,
      ALIASES[node.method_name].to_s
    )
  end
end

#on_send(node) ⇒ Object



23
24
25
26
27
28
29
30
31
32
33
# File 'lib/rubocop/cop/rails/active_record_aliases.rb', line 23

def on_send(node)
  ALIASES.each do |bad, good|
    next unless node.method?(bad)

    add_offense(node,
                message: format(MSG, prefer: good, current: bad),
                location: :selector,
                severity: :warning)
    break
  end
end