Class: RuboCop::Cop::Rails::DynamicFindBy

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

Overview

This cop checks dynamic ‘find_by_*` methods. Use `find_by` instead of dynamic method. See. github.com/rubocop-hq/rails-style-guide#find_by

Examples:

# bad
User.find_by_name(name)

# bad
User.find_by_name_and_email(name)

# bad
User.find_by_email!(name)

# good
User.find_by(name: name)

# good
User.find_by(name: name, email: email)

# good
User.find_by!(email: email)

Constant Summary collapse

MSG = 
'Use `%<static_name>s` instead of dynamic `%<method>s`.'.freeze
METHOD_PATTERN = 
/^find_by_(.+?)(!)?$/

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/rubocop/cop/rails/dynamic_find_by.rb', line 46

def autocorrect(node)
  _receiver, method, *args = *node
  static_name = static_method_name(method.to_s)
  keywords = column_keywords(method)

  return if keywords.size != args.size

  lambda do |corrector|
    corrector.replace(node.loc.selector, static_name)
    keywords.each.with_index do |keyword, idx|
      corrector.insert_before(args[idx].loc.expression, keyword)
    end
  end
end

#on_send(node) ⇒ Object 



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

def on_send(node)
  method_name = node.method_name.to_s

  return if whitelist.include?(method_name)

  static_name = static_method_name(method_name)

  return unless static_name

  add_offense(node,
              message: format(MSG, static_name: static_name,
                                   method: node.method_name))
end