rubocop-rails 2.7.0 → 2.9.1

data/lib/rubocop/cop/rails/where_not.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # 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'])
+      #
+      #   # good
+      #   User.where.not(name: 'Gabe')
+      #   User.where.not(name: nil)
+      #   User.where.not(name: ['john', 'jane'])
+      #
+      class WhereNot < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Use `%<good_method>s` instead of manually constructing negated SQL in `where`.'
+        RESTRICT_ON_SEND = %i[where].freeze
+
+        def_node_matcher :where_method_call?, <<~PATTERN
+          {
+            (send _ :where (array $str_type? $_ ?))
+            (send _ :where $str_type? $_ ?)
+          }
+        PATTERN
+
+        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
+
+        NOT_EQ_ANONYMOUS_RE = /\A([\w.]+)\s+(?:!=|<>)\s+\?\z/.freeze           # column != ?, column <> ?
+        NOT_IN_ANONYMOUS_RE = /\A([\w.]+)\s+NOT\s+IN\s+\(\?\)\z/i.freeze       # column NOT IN (?)
+        NOT_EQ_NAMED_RE     = /\A([\w.]+)\s+(?:!=|<>)\s+:(\w+)\z/.freeze       # column != :column, column <> :column
+        NOT_IN_NAMED_RE     = /\A([\w.]+)\s+NOT\s+IN\s+\(:(\w+)\)\z/i.freeze   # column NOT IN (:column)
+        IS_NOT_NULL_RE      = /\A([\w.]+)\s+IS\s+NOT\s+NULL\z/i.freeze         # column IS NOT NULL
+
+        private
+
+        def offense_range(node)
+          range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos)
+        end
+
+        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
+
+        def build_good_method(column, value)
+          if column.include?('.')
+            "where.not('#{column}' => #{value})"
+          else
+            "where.not(#{column}: #{value})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails_cops.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'mixin/active_record_helper'
+require_relative 'mixin/enforce_superclass'
 require_relative 'mixin/index_method'
 require_relative 'mixin/target_rails_version'
 
@@ -9,11 +10,14 @@ require_relative 'rails/active_record_aliases'
 require_relative 'rails/active_record_callbacks_order'
 require_relative 'rails/active_record_override'
 require_relative 'rails/active_support_aliases'
+require_relative 'rails/after_commit_override'
 require_relative 'rails/application_controller'
 require_relative 'rails/application_job'
 require_relative 'rails/application_mailer'
 require_relative 'rails/application_record'
+require_relative 'rails/arel_star'
 require_relative 'rails/assert_not'
+require_relative 'rails/attribute_default_block_value'
 require_relative 'rails/belongs_to'
 require_relative 'rails/blank'
 require_relative 'rails/bulk_change_table'
@@ -48,6 +52,7 @@ require_relative 'rails/mailer_name'
 require_relative 'rails/match_route'
 require_relative 'rails/negate_include'
 require_relative 'rails/not_null_column'
+require_relative 'rails/order_by_id'
 require_relative 'rails/output'
 require_relative 'rails/output_safety'
 require_relative 'rails/pick'
@@ -75,9 +80,12 @@ require_relative 'rails/save_bang'
 require_relative 'rails/scope_args'
 require_relative 'rails/short_i18n'
 require_relative 'rails/skips_model_validations'
+require_relative 'rails/squished_sql_heredocs'
 require_relative 'rails/time_zone'
 require_relative 'rails/uniq_before_pluck'
 require_relative 'rails/unique_validation_without_index'
 require_relative 'rails/unknown_env'
 require_relative 'rails/validation'
+require_relative 'rails/where_equals'
 require_relative 'rails/where_exists'
+require_relative 'rails/where_not'

data/lib/rubocop/rails/schema_loader.rb

@@ -13,15 +13,15 @@ module RuboCop
       #
       # @return [Schema, nil]
       def load(target_ruby_version)
-        return @schema if defined?(@schema)
+        return @load if defined?(@load)
 
-        @schema = load!(target_ruby_version)
+        @load = load!(target_ruby_version)
       end
 
       def reset!
-        return unless instance_variable_defined?(:@schema)
+        return unless instance_variable_defined?(:@load)
 
-        remove_instance_variable(:@schema)
+        remove_instance_variable(:@load)
       end
 
       def db_schema_path

data/lib/rubocop/rails/schema_loader/schema.rb

@@ -97,14 +97,12 @@ module RuboCop
           end.compact
         end
 
-        def each_content(node)
-          return enum_for(__method__, node) unless block_given?
+        def each_content(node, &block)
+          return enum_for(__method__, node) unless block
 
           case node.body&.type
           when :begin
-            node.body.children.each do |child|
-              yield(child)
-            end
+            node.body.children.each(&block)
           else
             yield(node.body)
           end
@@ -178,6 +176,8 @@ module RuboCop
         attr_reader :table_name
 
         def initialize(node)
+          super(node)
+
           @table_name = node.first_argument.value
           @columns, @expression = build_columns_or_expr(node.arguments[1])
           @unique = nil

data/lib/rubocop/rails/version.rb

@@ -4,7 +4,11 @@ module RuboCop
   module Rails
     # This module holds the RuboCop Rails version information.
     module Version
-      STRING = '2.7.0'
+      STRING = '2.9.1'
+
+      def self.document_version
+        STRING.match('\d+\.\d+').to_s
+      end
     end
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.9.1
 platform: ruby
 authors:
 - Bozhidar Batsov
 - Jonas Arvidsson
 - Yuji Nakayama
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,14 +46,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.87.0
+        version: 0.90.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.87.0
+        version: 0.90.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: |
   Automatic Rails code style checking tool.
   A RuboCop extension focused on enforcing Rails best practices and coding conventions.
@@ -70,6 +76,7 @@ files:
 - config/default.yml
 - lib/rubocop-rails.rb
 - lib/rubocop/cop/mixin/active_record_helper.rb
+- lib/rubocop/cop/mixin/enforce_superclass.rb
 - lib/rubocop/cop/mixin/index_method.rb
 - lib/rubocop/cop/mixin/target_rails_version.rb
 - lib/rubocop/cop/rails/action_filter.rb
@@ -77,11 +84,14 @@ files:
 - lib/rubocop/cop/rails/active_record_callbacks_order.rb
 - lib/rubocop/cop/rails/active_record_override.rb
 - lib/rubocop/cop/rails/active_support_aliases.rb
+- lib/rubocop/cop/rails/after_commit_override.rb
 - lib/rubocop/cop/rails/application_controller.rb
 - lib/rubocop/cop/rails/application_job.rb
 - lib/rubocop/cop/rails/application_mailer.rb
 - lib/rubocop/cop/rails/application_record.rb
+- lib/rubocop/cop/rails/arel_star.rb
 - lib/rubocop/cop/rails/assert_not.rb
+- lib/rubocop/cop/rails/attribute_default_block_value.rb
 - lib/rubocop/cop/rails/belongs_to.rb
 - lib/rubocop/cop/rails/blank.rb
 - lib/rubocop/cop/rails/bulk_change_table.rb
@@ -116,6 +126,7 @@ files:
 - lib/rubocop/cop/rails/match_route.rb
 - lib/rubocop/cop/rails/negate_include.rb
 - lib/rubocop/cop/rails/not_null_column.rb
+- lib/rubocop/cop/rails/order_by_id.rb
 - lib/rubocop/cop/rails/output.rb
 - lib/rubocop/cop/rails/output_safety.rb
 - lib/rubocop/cop/rails/pick.rb
@@ -143,12 +154,15 @@ files:
 - lib/rubocop/cop/rails/scope_args.rb
 - lib/rubocop/cop/rails/short_i18n.rb
 - lib/rubocop/cop/rails/skips_model_validations.rb
+- lib/rubocop/cop/rails/squished_sql_heredocs.rb
 - lib/rubocop/cop/rails/time_zone.rb
 - lib/rubocop/cop/rails/uniq_before_pluck.rb
 - lib/rubocop/cop/rails/unique_validation_without_index.rb
 - lib/rubocop/cop/rails/unknown_env.rb
 - lib/rubocop/cop/rails/validation.rb
+- lib/rubocop/cop/rails/where_equals.rb
 - lib/rubocop/cop/rails/where_exists.rb
+- lib/rubocop/cop/rails/where_not.rb
 - lib/rubocop/cop/rails_cops.rb
 - lib/rubocop/rails.rb
 - lib/rubocop/rails/inject.rb
@@ -162,9 +176,9 @@ metadata:
   homepage_uri: https://docs.rubocop.org/rubocop-rails/
   changelog_uri: https://github.com/rubocop-hq/rubocop-rails/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop-hq/rubocop-rails/
-  documentation_uri: https://docs.rubocop.org/rubocop-rails/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.9/
   bug_tracker_uri: https://github.com/rubocop-hq/rubocop-rails/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -179,8 +193,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.1
+signing_key:
 specification_version: 4
 summary: Automatic Rails code style checking tool.
 test_files: []