Class: RuboCop::Cop::Rails::FindBy

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

Overview

This cop is used to identify usages of ‘where.first` and change them to use `find_by` instead.

Examples:

# bad
User.where(name: 'Bruce').first
User.where(name: 'Bruce').take

# good
User.find_by(name: 'Bruce')

Constant Summary collapse

MSG = 
'Use `find_by` instead of `where.%<method>s`.'.freeze
TARGET_SELECTORS = 
%i[first take].freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, 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?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

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



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/rails/find_by.rb', line 34

def autocorrect(node)
  # Don't autocorrect where(...).first, because it can return different
  # results from find_by. (They order records differently, so the
  # 'first' record can be different.)
  return if node.method?(:first)

  where_loc = node.receiver.loc.selector
  first_loc = range_between(node.loc.dot.begin_pos,
                            node.loc.selector.end_pos)

  lambda do |corrector|
    corrector.replace(where_loc, 'find_by')
    corrector.replace(first_loc, '')
  end
end

#on_send(node) ⇒ Object 



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

def on_send(node)
  return unless where_first?(node)

  range = range_between(node.receiver.loc.selector.begin_pos,
                        node.loc.selector.end_pos)

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