rubocop-rails 2.8.1 → 2.11.0

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

@@ -0,0 +1,98 @@
+# 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(attribute: value)`.
+      #
+      # @example
+      #   # bad
+      #   User.where('name = ?', 'Gabe')
+      #   User.where('name = :name', name: 'Gabe')
+      #   User.where('name IS NULL')
+      #   User.where('name IN (?)', ['john', 'jane'])
+      #   User.where('name IN (:names)', names: ['john', 'jane'])
+      #   User.where('users.name = :name', name: 'Gabe')
+      #
+      #   # good
+      #   User.where(name: 'Gabe')
+      #   User.where(name: nil)
+      #   User.where(name: ['john', 'jane'])
+      #   User.where(users: { name: 'Gabe' })
+      class WhereEquals < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Use `%<good_method>s` instead of manually constructing SQL.'
+        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
+
+        EQ_ANONYMOUS_RE = /\A([\w.]+)\s+=\s+\?\z/.freeze             # column = ?
+        IN_ANONYMOUS_RE = /\A([\w.]+)\s+IN\s+\(\?\)\z/i.freeze       # column IN (?)
+        EQ_NAMED_RE     = /\A([\w.]+)\s+=\s+:(\w+)\z/.freeze         # column = :column
+        IN_NAMED_RE     = /\A([\w.]+)\s+IN\s+\(:(\w+)\)\z/i.freeze   # column IN (:column)
+        IS_NULL_RE      = /\A([\w.]+)\s+IS\s+NULL\z/i.freeze         # column IS 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 EQ_ANONYMOUS_RE, IN_ANONYMOUS_RE
+              value_node.source
+            when EQ_NAMED_RE, 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_NULL_RE
+              'nil'
+            else
+              return
+            end
+
+          [Regexp.last_match(1), value]
+        end
+
+        def build_good_method(column, value)
+          if column.include?('.')
+            table, column = column.split('.')
+
+            "where(#{table}: { #{column}: #{value} })"
+          else
+            "where(#{column}: #{value})"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,6 +11,17 @@ module RuboCop
       # When EnforcedStyle is 'where' then the cop enforces
       # `where(...).exists?` over `exists?(...)`.
       #
+      # This cop is unsafe for auto-correction because the behavior may change on the following case:
+      #
+      # [source,ruby]
+      # ----
+      # Author.includes(:articles).where(articles: {id: id}).exists?
+      # #=> Perform `eager_load` behavior (`LEFT JOIN` query) and get result.
+      #
+      # Author.includes(:articles).exists?(articles: {id: id})
+      # #=> Perform `preload` behavior and `ActiveRecord::StatementInvalid` error occurs.
+      # ----
+      #
       # @example EnforcedStyle: exists (default)
       #   # bad
       #   User.where(name: 'john').exists?
@@ -36,10 +47,12 @@ module RuboCop
       #   User.where('name = ?', 'john').exists?
       #   user.posts.where(published: true).exists?
       #   User.where('length(name) > 10').exists?
-      class WhereExists < Cop
+      class WhereExists < Base
         include ConfigurableEnforcedStyle
+        extend AutoCorrector
 
         MSG = 'Prefer `%<good_method>s` over `%<bad_method>s`.'
+        RESTRICT_ON_SEND = %i[exists?].freeze
 
         def_node_matcher :where_exists_call?, <<~PATTERN
           (send (send _ :where $...) :exists?)
@@ -54,19 +67,12 @@ module RuboCop
             return unless convertable_args?(args)
 
             range = correction_range(node)
-            message = format(MSG, good_method: build_good_method(args), bad_method: range.source)
-            add_offense(node, location: range, message: message)
-          end
-        end
-
-        def autocorrect(node)
-          args = find_offenses(node)
+            good_method = build_good_method(args)
+            message = format(MSG, good_method: good_method, bad_method: range.source)
 
-          lambda do |corrector|
-            corrector.replace(
-              correction_range(node),
-              build_good_method(args)
-            )
+            add_offense(range, message: message) do |corrector|
+              corrector.replace(range, good_method)
+            end
           end
         end
 

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

@@ -15,16 +15,20 @@ module RuboCop
       #   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' })
       #
-      class WhereNot < Cop
+      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
           {
@@ -45,21 +49,8 @@ module RuboCop
             good_method = build_good_method(*column_and_value)
             message = format(MSG, good_method: good_method)
 
-            add_offense(node, location: range, message: message)
-          end
-        end
-
-        def autocorrect(node)
-          where_method_call?(node) do |template_node, value_node|
-            value_node = value_node.first
-
-            lambda do |corrector|
-              range = offense_range(node)
-
-              column, value = *extract_column_and_value(template_node, value_node)
-              replacement = build_good_method(column, value)
-
-              corrector.replace(range, replacement)
+            add_offense(range, message: message) do |corrector|
+              corrector.replace(range, good_method)
             end
           end
         end
@@ -97,7 +88,9 @@ module RuboCop
 
         def build_good_method(column, value)
           if column.include?('.')
-            "where.not('#{column}' => #{value})"
+            table, column = column.split('.')
+
+            "where.not(#{table}: { #{column}: #{value} })"
           else
             "where.not(#{column}: #{value})"
           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,12 +10,15 @@ 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/add_column_index'
 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'
@@ -25,10 +29,13 @@ require_relative 'rails/default_scope'
 require_relative 'rails/delegate'
 require_relative 'rails/delegate_allow_blank'
 require_relative 'rails/dynamic_find_by'
+require_relative 'rails/eager_evaluation_log_message'
 require_relative 'rails/enum_hash'
 require_relative 'rails/enum_uniqueness'
 require_relative 'rails/environment_comparison'
+require_relative 'rails/environment_variable_access'
 require_relative 'rails/exit'
+require_relative 'rails/expanded_date_range'
 require_relative 'rails/file_path'
 require_relative 'rails/find_by'
 require_relative 'rails/find_by_id'
@@ -38,6 +45,7 @@ require_relative 'rails/has_many_or_has_one_dependent'
 require_relative 'rails/helper_instance_variable'
 require_relative 'rails/http_positional_arguments'
 require_relative 'rails/http_status'
+require_relative 'rails/i18n_locale_assignment'
 require_relative 'rails/ignored_skip_action_filter_option'
 require_relative 'rails/index_by'
 require_relative 'rails/index_with'
@@ -70,7 +78,9 @@ require_relative 'rails/relative_date_constant'
 require_relative 'rails/render_inline'
 require_relative 'rails/render_plain_text'
 require_relative 'rails/request_referer'
+require_relative 'rails/require_dependency'
 require_relative 'rails/reversible_migration'
+require_relative 'rails/reversible_migration_method_definition'
 require_relative 'rails/safe_navigation'
 require_relative 'rails/safe_navigation_with_blank'
 require_relative 'rails/save_bang'
@@ -79,9 +89,12 @@ 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/time_zone_assignment'
 require_relative 'rails/uniq_before_pluck'
 require_relative 'rails/unique_validation_without_index'
 require_relative 'rails/unknown_env'
+require_relative 'rails/unused_ignored_columns'
 require_relative 'rails/validation'
+require_relative 'rails/where_equals'
 require_relative 'rails/where_exists'
 require_relative 'rails/where_not'

data/lib/rubocop/rails.rb

@@ -8,5 +8,7 @@ module RuboCop
     CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+
+    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config', 'obsoletion.yml')
   end
 end

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

@@ -98,7 +98,7 @@ module RuboCop
         end
 
         def each_content(node, &block)
-          return enum_for(__method__, node) unless block_given?
+          return enum_for(__method__, node) unless block
 
           case node.body&.type
           when :begin
@@ -114,7 +114,7 @@ module RuboCop
         attr_reader :name, :type, :not_null
 
         def initialize(node)
-          @name = node.first_argument.value
+          @name = node.first_argument.str_content
           @type = node.method_name
           @not_null = nil
 
@@ -128,9 +128,7 @@ module RuboCop
           return unless pairs.hash_type?
 
           pairs.each_pair do |k, v|
-            if k.value == :null
-              @not_null = v.true_type? ? false : true
-            end
+            @not_null = !v.true_type? if k.value == :null
           end
         end
       end

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.8.1'
+      STRING = '2.11.0'
+
+      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.8.1
+  version: 2.11.0
 platform: ruby
 authors:
 - Bozhidar Batsov
 - Jonas Arvidsson
 - Yuji Nakayama
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2021-06-21 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: 1.7.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: 1.7.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.
@@ -68,8 +74,10 @@ files:
 - README.md
 - bin/setup
 - config/default.yml
+- config/obsoletion.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,12 +85,15 @@ 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/add_column_index.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
@@ -93,10 +104,13 @@ files:
 - lib/rubocop/cop/rails/delegate.rb
 - lib/rubocop/cop/rails/delegate_allow_blank.rb
 - lib/rubocop/cop/rails/dynamic_find_by.rb
+- lib/rubocop/cop/rails/eager_evaluation_log_message.rb
 - lib/rubocop/cop/rails/enum_hash.rb
 - lib/rubocop/cop/rails/enum_uniqueness.rb
 - lib/rubocop/cop/rails/environment_comparison.rb
+- lib/rubocop/cop/rails/environment_variable_access.rb
 - lib/rubocop/cop/rails/exit.rb
+- lib/rubocop/cop/rails/expanded_date_range.rb
 - lib/rubocop/cop/rails/file_path.rb
 - lib/rubocop/cop/rails/find_by.rb
 - lib/rubocop/cop/rails/find_by_id.rb
@@ -106,6 +120,7 @@ files:
 - lib/rubocop/cop/rails/helper_instance_variable.rb
 - lib/rubocop/cop/rails/http_positional_arguments.rb
 - lib/rubocop/cop/rails/http_status.rb
+- lib/rubocop/cop/rails/i18n_locale_assignment.rb
 - lib/rubocop/cop/rails/ignored_skip_action_filter_option.rb
 - lib/rubocop/cop/rails/index_by.rb
 - lib/rubocop/cop/rails/index_with.rb
@@ -138,7 +153,9 @@ files:
 - lib/rubocop/cop/rails/render_inline.rb
 - lib/rubocop/cop/rails/render_plain_text.rb
 - lib/rubocop/cop/rails/request_referer.rb
+- lib/rubocop/cop/rails/require_dependency.rb
 - lib/rubocop/cop/rails/reversible_migration.rb
+- lib/rubocop/cop/rails/reversible_migration_method_definition.rb
 - lib/rubocop/cop/rails/safe_navigation.rb
 - lib/rubocop/cop/rails/safe_navigation_with_blank.rb
 - lib/rubocop/cop/rails/save_bang.rb
@@ -147,10 +164,13 @@ files:
 - 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/time_zone_assignment.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/unused_ignored_columns.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
@@ -159,16 +179,16 @@ files:
 - lib/rubocop/rails/schema_loader.rb
 - lib/rubocop/rails/schema_loader/schema.rb
 - lib/rubocop/rails/version.rb
-homepage: https://github.com/rubocop-hq/rubocop-rails
+homepage: https://github.com/rubocop/rubocop-rails
 licenses:
 - MIT
 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/
-  bug_tracker_uri: https://github.com/rubocop-hq/rubocop-rails/issues
-post_install_message: 
+  changelog_uri: https://github.com/rubocop/rubocop-rails/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/rubocop/rubocop-rails/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.11/
+  bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -176,15 +196,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.18
+signing_key:
 specification_version: 4
 summary: Automatic Rails code style checking tool.
 test_files: []