rubocop-rails 2.15.2 → 2.17.0

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Use `where.missing(...)` to find missing relationship records.
+      #
+      # This cop is enabled in Rails 6.1 or higher.
+      #
+      # @example
+      #   # bad
+      #   Post.left_joins(:author).where(authors: { id: nil })
+      #
+      #   # good
+      #   Post.where.missing(:author)
+      #
+      class WhereMissing < Base
+        include RangeHelp
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        MSG = 'Use `where.missing(:%<left_joins_association>s)` instead of ' \
+              '`%<left_joins_method>s(:%<left_joins_association>s).where(%<where_association>s: { id: nil })`.'
+        RESTRICT_ON_SEND = %i[left_joins left_outer_joins].freeze
+
+        minimum_target_rails_version 6.1
+
+        # @!method where_node_and_argument(node)
+        def_node_search :where_node_and_argument, <<~PATTERN
+          $(send ... :where (hash <(pair $(sym _) (hash (pair (sym :id) (nil))))...> ))
+        PATTERN
+
+        # @!method missing_relationship(node)
+        def_node_search :missing_relationship, <<~PATTERN
+          (pair (sym _) (hash (pair (sym :id) (nil))))
+        PATTERN
+
+        def on_send(node)
+          return unless node.first_argument.sym_type?
+
+          where_node_and_argument(root_receiver(node)) do |where_node, where_argument|
+            next unless same_relationship?(where_argument, node.first_argument)
+
+            range = range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos)
+            register_offense(node, where_node, where_argument, range)
+            break
+          end
+        end
+
+        private
+
+        def root_receiver(node)
+          node&.parent&.send_type? ? root_receiver(node.parent) : node
+        end
+
+        def same_relationship?(where, left_joins)
+          where.value.to_s.match?(/^#{left_joins.value}s?$/)
+        end
+
+        def register_offense(node, where_node, where_argument, range)
+          add_offense(range, message: message(node, where_argument)) do |corrector|
+            corrector.replace(node.loc.selector, 'where.missing')
+            if multi_condition?(where_node.first_argument)
+              replace_where_method(corrector, where_node)
+            else
+              remove_where_method(corrector, node, where_node)
+            end
+          end
+        end
+
+        def replace_where_method(corrector, where_node)
+          missing_relationship(where_node) do |where_clause|
+            corrector.remove(replace_range(where_clause))
+          end
+        end
+
+        def replace_range(child)
+          if (right_sibling = child.right_sibling)
+            range_between(child.loc.expression.begin_pos, right_sibling.loc.expression.begin_pos)
+          else
+            range_between(child.left_sibling.loc.expression.end_pos, child.loc.expression.end_pos)
+          end
+        end
+
+        def remove_where_method(corrector, node, where_node)
+          range = range_between(where_node.loc.selector.begin_pos, where_node.loc.end.end_pos)
+          if node.multiline? && !same_line?(node, where_node)
+            range = range_by_whole_lines(range, include_final_newline: true)
+          else
+            corrector.remove(where_node.loc.dot)
+          end
+
+          corrector.remove(range)
+        end
+
+        def same_line?(left_joins_node, where_node)
+          left_joins_node.loc.selector.line == where_node.loc.selector.line
+        end
+
+        def multi_condition?(where_arg)
+          where_arg.children.count > 1
+        end
+
+        def message(node, where_argument)
+          format(MSG, left_joins_association: node.first_argument.value, left_joins_method: node.method_name,
+                      where_association: where_argument.value)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Identifies calls to `where.not` with multiple hash arguments.
+      #
+      # The behavior of `where.not` changed in Rails 6.1. Prior to the change,
+      # `.where.not(trashed: true, role: 'admin')` evaluated to
+      # `WHERE trashed != TRUE AND role != 'admin'`.
+      # From Rails 6.1 onwards, this executes the query
+      # `WHERE NOT (trashed == TRUE AND roles == 'admin')`.
+      #
+      # @example
+      #   # bad
+      #   User.where.not(trashed: true, role: 'admin')
+      #   User.where.not(trashed: true, role: ['moderator', 'admin'])
+      #   User.joins(:posts).where.not(posts: { trashed: true, title: 'Rails' })
+      #
+      #   # good
+      #   User.where.not(trashed: true)
+      #   User.where.not(role: ['moderator', 'admin'])
+      #   User.where.not(trashed: true).where.not(role: ['moderator', 'admin'])
+      #   User.where.not('trashed = ? OR role = ?', true, 'admin')
+      class WhereNotWithMultipleConditions < Base
+        MSG = 'Use a SQL statement instead of `where.not` with multiple conditions.'
+        RESTRICT_ON_SEND = %i[not].freeze
+
+        def_node_matcher :where_not_call?, <<~PATTERN
+          (send (send _ :where) :not $...)
+        PATTERN
+
+        def on_send(node)
+          where_not_call?(node) do |args|
+            next unless args[0].hash_type?
+            next unless multiple_arguments_hash? args[0]
+
+            range = node.receiver.loc.selector.with(end_pos: node.loc.expression.end_pos)
+
+            add_offense(range)
+          end
+        end
+
+        private
+
+        def multiple_arguments_hash?(hash)
+          return true if hash.pairs.size >= 2
+          return false unless hash.values[0].hash_type?
+
+          multiple_arguments_hash?(hash.values[0])
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails_cops.rb

@@ -8,12 +8,15 @@ require_relative 'mixin/index_method'
 require_relative 'mixin/migrations_helper'
 require_relative 'mixin/target_rails_version'
 
+require_relative 'rails/action_controller_flash_before_render'
 require_relative 'rails/action_controller_test_case'
 require_relative 'rails/action_filter'
+require_relative 'rails/action_order'
 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/active_support_on_load'
 require_relative 'rails/add_column_index'
 require_relative 'rails/after_commit_override'
 require_relative 'rails/application_controller'
@@ -50,6 +53,7 @@ require_relative 'rails/file_path'
 require_relative 'rails/find_by'
 require_relative 'rails/find_by_id'
 require_relative 'rails/find_each'
+require_relative 'rails/freeze_time'
 require_relative 'rails/has_and_belongs_to_many'
 require_relative 'rails/has_many_or_has_one_dependent'
 require_relative 'rails/helper_instance_variable'
@@ -58,6 +62,7 @@ require_relative 'rails/http_status'
 require_relative 'rails/i18n_lazy_lookup'
 require_relative 'rails/i18n_locale_assignment'
 require_relative 'rails/i18n_locale_texts'
+require_relative 'rails/ignored_columns_assignment'
 require_relative 'rails/ignored_skip_action_filter_option'
 require_relative 'rails/index_by'
 require_relative 'rails/index_with'
@@ -97,6 +102,7 @@ require_relative 'rails/require_dependency'
 require_relative 'rails/reversible_migration'
 require_relative 'rails/reversible_migration_method_definition'
 require_relative 'rails/root_join_chain'
+require_relative 'rails/root_pathname_methods'
 require_relative 'rails/root_public_path'
 require_relative 'rails/safe_navigation'
 require_relative 'rails/safe_navigation_with_blank'
@@ -111,6 +117,8 @@ require_relative 'rails/table_name_assignment'
 require_relative 'rails/time_zone'
 require_relative 'rails/time_zone_assignment'
 require_relative 'rails/to_formatted_s'
+require_relative 'rails/to_s_with_argument'
+require_relative 'rails/top_level_hash_with_indifferent_access'
 require_relative 'rails/transaction_exit_statement'
 require_relative 'rails/uniq_before_pluck'
 require_relative 'rails/unique_validation_without_index'
@@ -119,4 +127,6 @@ require_relative 'rails/unused_ignored_columns'
 require_relative 'rails/validation'
 require_relative 'rails/where_equals'
 require_relative 'rails/where_exists'
+require_relative 'rails/where_missing'
 require_relative 'rails/where_not'
+require_relative 'rails/where_not_with_multiple_conditions'

data/lib/rubocop/rails/version.rb

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

data/lib/rubocop-rails.rb

@@ -14,6 +14,16 @@ RuboCop::Rails::Inject.defaults!
 
 require_relative 'rubocop/cop/rails_cops'
 
+RuboCop::Cop::Style::HashExcept.minimum_target_ruby_version(2.0)
+
+RuboCop::Cop::Style::MethodCallWithArgsParentheses.singleton_class.prepend(
+  Module.new do
+    def autocorrect_incompatible_with
+      super.push(RuboCop::Cop::Rails::EagerEvaluationLogMessage)
+    end
+  end
+)
+
 RuboCop::Cop::Style::RedundantSelf.singleton_class.prepend(
   Module.new do
     def autocorrect_incompatible_with

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.15.2
+  version: 2.17.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-07 00:00:00.000000000 Z
+date: 2022-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.33.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -56,7 +56,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.33.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -72,8 +72,6 @@ extra_rdoc_files:
 files:
 - LICENSE.txt
 - README.md
-- bin/console
-- bin/setup
 - config/default.yml
 - config/obsoletion.yml
 - lib/rubocop-rails.rb
@@ -84,12 +82,15 @@ files:
 - lib/rubocop/cop/mixin/index_method.rb
 - lib/rubocop/cop/mixin/migrations_helper.rb
 - lib/rubocop/cop/mixin/target_rails_version.rb
+- lib/rubocop/cop/rails/action_controller_flash_before_render.rb
 - lib/rubocop/cop/rails/action_controller_test_case.rb
 - lib/rubocop/cop/rails/action_filter.rb
+- lib/rubocop/cop/rails/action_order.rb
 - lib/rubocop/cop/rails/active_record_aliases.rb
 - 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/active_support_on_load.rb
 - lib/rubocop/cop/rails/add_column_index.rb
 - lib/rubocop/cop/rails/after_commit_override.rb
 - lib/rubocop/cop/rails/application_controller.rb
@@ -126,6 +127,7 @@ files:
 - lib/rubocop/cop/rails/find_by.rb
 - lib/rubocop/cop/rails/find_by_id.rb
 - lib/rubocop/cop/rails/find_each.rb
+- lib/rubocop/cop/rails/freeze_time.rb
 - lib/rubocop/cop/rails/has_and_belongs_to_many.rb
 - lib/rubocop/cop/rails/has_many_or_has_one_dependent.rb
 - lib/rubocop/cop/rails/helper_instance_variable.rb
@@ -134,6 +136,7 @@ files:
 - lib/rubocop/cop/rails/i18n_lazy_lookup.rb
 - lib/rubocop/cop/rails/i18n_locale_assignment.rb
 - lib/rubocop/cop/rails/i18n_locale_texts.rb
+- lib/rubocop/cop/rails/ignored_columns_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
@@ -173,6 +176,7 @@ files:
 - lib/rubocop/cop/rails/reversible_migration.rb
 - lib/rubocop/cop/rails/reversible_migration_method_definition.rb
 - lib/rubocop/cop/rails/root_join_chain.rb
+- lib/rubocop/cop/rails/root_pathname_methods.rb
 - lib/rubocop/cop/rails/root_public_path.rb
 - lib/rubocop/cop/rails/safe_navigation.rb
 - lib/rubocop/cop/rails/safe_navigation_with_blank.rb
@@ -187,6 +191,8 @@ files:
 - lib/rubocop/cop/rails/time_zone.rb
 - lib/rubocop/cop/rails/time_zone_assignment.rb
 - lib/rubocop/cop/rails/to_formatted_s.rb
+- lib/rubocop/cop/rails/to_s_with_argument.rb
+- lib/rubocop/cop/rails/top_level_hash_with_indifferent_access.rb
 - lib/rubocop/cop/rails/transaction_exit_statement.rb
 - lib/rubocop/cop/rails/uniq_before_pluck.rb
 - lib/rubocop/cop/rails/unique_validation_without_index.rb
@@ -195,7 +201,9 @@ files:
 - 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_missing.rb
 - lib/rubocop/cop/rails/where_not.rb
+- lib/rubocop/cop/rails/where_not_with_multiple_conditions.rb
 - lib/rubocop/cop/rails_cops.rb
 - lib/rubocop/rails.rb
 - lib/rubocop/rails/inject.rb
@@ -209,7 +217,7 @@ metadata:
   homepage_uri: https://docs.rubocop.org/rubocop-rails/
   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.15/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.17/
   bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -227,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Automatic Rails code style checking tool.

data/bin/console

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'irb'
-require 'rubocop'
-require 'rubocop-rails'
-
-ARGV.clear
-
-IRB.start(__FILE__)

data/bin/setup

@@ -1,7 +0,0 @@
-#!/usr/bin/env bash
-
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install