class RuboCop::Cop::Rails::WhereNot
This cop identifies places where manually constructed SQL in `where` can be replaced with `where.not(…)`.
@example
# bad User.where('name != ?', 'Gabe') User.where('name != :name', name: 'Gabe') User.where('name <> ?', 'Gabe') User.where('name <> :name', name: 'Gabe') User.where('name IS NOT NULL') User.where('name NOT IN (?)', ['john', 'jane']) User.where('name NOT IN (:names)', names: ['john', 'jane']) User.where('users.name != :name', name: 'Gabe') # good User.where.not(name: 'Gabe') User.where.not(name: nil) User.where.not(name: ['john', 'jane']) User.where.not(users: { name: 'Gabe' })
Constants
- IS_NOT_NULL_RE
- MSG
- NOT_EQ_ANONYMOUS_RE
- NOT_EQ_NAMED_RE
- NOT_IN_ANONYMOUS_RE
- NOT_IN_NAMED_RE
- RESTRICT_ON_SEND
Public Instance Methods
on_send(node)
click to toggle source
# File lib/rubocop/cop/rails/where_not.rb, line 40 def on_send(node) where_method_call?(node) do |template_node, value_node| value_node = value_node.first range = offense_range(node) column_and_value = extract_column_and_value(template_node, value_node) return unless column_and_value good_method = build_good_method(*column_and_value) message = format(MSG, good_method: good_method) add_offense(range, message: message) do |corrector| corrector.replace(range, good_method) end end end
Private Instance Methods
build_good_method(column, value)
click to toggle source
# File lib/rubocop/cop/rails/where_not.rb, line 89 def build_good_method(column, value) if column.include?('.') table, column = column.split('.') "where.not(#{table}: { #{column}: #{value} })" else "where.not(#{column}: #{value})" end end
extract_column_and_value(template_node, value_node)
click to toggle source
# File lib/rubocop/cop/rails/where_not.rb, line 70 def extract_column_and_value(template_node, value_node) value = case template_node.value when NOT_EQ_ANONYMOUS_RE, NOT_IN_ANONYMOUS_RE value_node.source when NOT_EQ_NAMED_RE, NOT_IN_NAMED_RE return unless value_node.hash_type? pair = value_node.pairs.find { |p| p.key.value.to_sym == Regexp.last_match(2).to_sym } pair.value.source when IS_NOT_NULL_RE 'nil' else return end [Regexp.last_match(1), value] end
offense_range(node)
click to toggle source
# File lib/rubocop/cop/rails/where_not.rb, line 66 def offense_range(node) range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos) end