Class: RuboCop::Cop::Rails::ActiveRecordOverride

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Rails::ActiveRecordOverride

Defined in:

lib/rubocop/cop/rails/active_record_override.rb

Overview

Checks for overriding built-in Active Record methods instead of using callbacks.

Examples:

# bad
class Book < ApplicationRecord
  def save
    self.title = title.upcase!
    super
  end
end

# good
class Book < ApplicationRecord
  before_save :upcase_title

  def upcase_title
    self.title = title.upcase!
  end
end

Constant Summary

MSG =

'Use %<prefer>s callbacks instead of overriding the Active Record ' \
'method `%<bad>s`.'

BAD_METHODS =

%i[create destroy save update].freeze

ACTIVE_RECORD_CLASSES =

%w[ApplicationRecord ActiveModel::Base
ActiveRecord::Base].freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #on_def(node) ⇒ Object

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?, #messages, non_rails, #parse, qualified_cop_name, #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?, #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

#on_def(node) ⇒ Object

# File 'lib/rubocop/cop/rails/active_record_override.rb', line 35

def on_def(node)
  return unless BAD_METHODS.include?(node.method_name)

  parent_class_name = find_parent_class_name(node)
  return unless active_model?(parent_class_name)

  return unless node.descendants.any?(&:zsuper_type?)

  add_offense(node, message: message(node.method_name))
end