rubocop-rails 2.23.1 → 2.26.2

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Looks for enums written with keyword arguments syntax.
+      #
+      # Defining enums with keyword arguments syntax is deprecated and will be removed in Rails 8.0.
+      # Positional arguments should be used instead:
+      #
+      # @example
+      #   # bad
+      #   enum status: { active: 0, archived: 1 }, _prefix: true
+      #
+      #   # good
+      #   enum :status, { active: 0, archived: 1 }, prefix: true
+      #
+      class EnumSyntax < Base
+        extend AutoCorrector
+        extend TargetRubyVersion
+        extend TargetRailsVersion
+
+        minimum_target_ruby_version 3.0
+        minimum_target_rails_version 7.0
+
+        MSG = 'Enum defined with keyword arguments in `%<enum>s` enum declaration. Use positional arguments instead.'
+        MSG_OPTIONS = 'Enum defined with deprecated options in `%<enum>s` enum declaration. Remove the `_` prefix.'
+        RESTRICT_ON_SEND = %i[enum].freeze
+
+        # From https://github.com/rails/rails/blob/v7.2.1/activerecord/lib/active_record/enum.rb#L231
+        OPTION_NAMES = %w[prefix suffix scopes default instance_methods].freeze
+        UNDERSCORED_OPTION_NAMES = OPTION_NAMES.map { |option| "_#{option}" }.freeze
+
+        def_node_matcher :enum?, <<~PATTERN
+          (send nil? :enum (hash $...))
+        PATTERN
+
+        def_node_matcher :enum_with_options?, <<~PATTERN
+          (send nil? :enum $_ ${array hash} $_)
+        PATTERN
+
+        def on_send(node)
+          check_and_correct_keyword_args(node)
+          check_enum_options(node)
+        end
+
+        private
+
+        def check_and_correct_keyword_args(node)
+          enum?(node) do |pairs|
+            pairs.each do |pair|
+              next if option_key?(pair)
+
+              correct_keyword_args(node, pair.key, pair.value, pairs[1..])
+            end
+          end
+        end
+
+        def check_enum_options(node)
+          enum_with_options?(node) do |key, _, options|
+            options.children.each do |option|
+              next unless option_key?(option)
+
+              add_offense(option.key, message: format(MSG_OPTIONS, enum: enum_name_value(key))) do |corrector|
+                corrector.replace(option.key, option.key.source.delete_prefix('_'))
+              end
+            end
+          end
+        end
+
+        def correct_keyword_args(node, key, values, options)
+          add_offense(values, message: format(MSG, enum: enum_name_value(key))) do |corrector|
+            # TODO: Multi-line autocorrect could be implemented in the future.
+            next if multiple_enum_definitions?(node)
+
+            preferred_syntax = "enum #{enum_name(key)}, #{values.source}#{correct_options(options)}"
+
+            corrector.replace(node, preferred_syntax)
+          end
+        end
+
+        def multiple_enum_definitions?(node)
+          keys = node.first_argument.keys.map { |key| key.source.delete_prefix('_') }
+          filterred_keys = keys.filter { |key| !OPTION_NAMES.include?(key) }
+          filterred_keys.size >= 2
+        end
+
+        def enum_name_value(key)
+          case key.type
+          when :sym, :str
+            key.value
+          else
+            key.source
+          end
+        end
+
+        def enum_name(elem)
+          case elem.type
+          when :str
+            elem.value.dump
+          when :sym
+            elem.value.inspect
+          else
+            elem.source
+          end
+        end
+
+        def option_key?(pair)
+          UNDERSCORED_OPTION_NAMES.include?(pair.key.source)
+        end
+
+        def correct_options(options)
+          corrected_options = options.map do |pair|
+            name = if pair.key.source[0] == '_'
+                     pair.key.source[1..]
+                   else
+                     pair.key.source
+                   end
+
+            "#{name}: #{pair.value.source}"
+          end.join(', ')
+
+          ", #{corrected_options}" unless corrected_options.empty?
+        end
+      end
+    end
+  end
+end

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

@@ -7,6 +7,18 @@ module RuboCop
       #
       # @example
       #   # bad
+      #   enum :status, { active: 0, archived: 0 }
+      #
+      #   # good
+      #   enum :status, { active: 0, archived: 1 }
+      #
+      #   # bad
+      #   enum :status, [:active, :archived, :active]
+      #
+      #   # good
+      #   enum :status, [:active, :archived]
+      #
+      #   # bad
       #   enum status: { active: 0, archived: 0 }
       #
       #   # good
@@ -24,6 +36,10 @@ module RuboCop
         RESTRICT_ON_SEND = %i[enum].freeze
 
         def_node_matcher :enum?, <<~PATTERN
+          (send nil? :enum $_ ${array hash} ...)
+        PATTERN
+
+        def_node_matcher :enum_with_old_syntax?, <<~PATTERN
           (send nil? :enum (hash $...))
         PATTERN
 
@@ -32,15 +48,17 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          enum?(node) do |pairs|
+          enum?(node) do |key, args|
+            consecutive_duplicates(args.values).each do |item|
+              add_offense(item, message: message(key, item))
+            end
+          end
+
+          enum_with_old_syntax?(node) do |pairs|
             pairs.each do |pair|
               enum_values(pair) do |key, args|
-                items = args.values
-
-                next unless duplicates?(items)
-
-                consecutive_duplicates(items).each do |item|
-                  add_offense(item, message: format(MSG, value: item.source, enum: enum_name(key)))
+                consecutive_duplicates(args.values).each do |item|
+                  add_offense(item, message: message(key, item))
                 end
               end
             end
@@ -57,6 +75,10 @@ module RuboCop
             key.source
           end
         end
+
+        def message(key, item)
+          format(MSG, value: item.source, enum: enum_name(key))
+        end
       end
     end
   end

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

@@ -51,7 +51,7 @@ module RuboCop
           return if allow?(begin_node, end_node)
 
           preferred_method = preferred_method(begin_node)
-          if begin_node.method?(:beginning_of_week) && begin_node.arguments.one?
+          if begin_node.method?(:beginning_of_week) && begin_node.arguments.one? && end_node.arguments.one?
             return unless same_argument?(begin_node, end_node)
 
             preferred_method << "(#{begin_node.first_argument.source})"

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

@@ -97,7 +97,7 @@ module RuboCop
           return unless node.arguments.any? { |e| rails_root_nodes?(e) }
 
           register_offense(node, require_to_s: true) do |corrector|
-            autocorrect_file_join(corrector, node)
+            autocorrect_file_join(corrector, node) unless node.first_argument.array_type?
           end
         end
 

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

@@ -59,7 +59,7 @@ module RuboCop
           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)
+          first_loc = range_between(node.receiver.source_range.end_pos, node.loc.selector.end_pos)
 
           corrector.replace(where_loc, 'find_by')
           corrector.replace(first_loc, '')

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

@@ -13,6 +13,8 @@ module RuboCop
       #   render plain: 'foo/bar', status: 304
       #   redirect_to root_url, status: 301
       #   head 200
+      #   assert_response 200
+      #   assert_redirected_to '/some/path', status: 301
       #
       #   # good
       #   render :foo, status: :ok
@@ -20,6 +22,8 @@ module RuboCop
       #   render plain: 'foo/bar', status: :not_modified
       #   redirect_to root_url, status: :moved_permanently
       #   head :ok
+      #   assert_response :ok
+      #   assert_redirected_to '/some/path', status: :moved_permanently
       #
       # @example EnforcedStyle: numeric
       #   # bad
@@ -28,6 +32,8 @@ module RuboCop
       #   render plain: 'foo/bar', status: :not_modified
       #   redirect_to root_url, status: :moved_permanently
       #   head :ok
+      #   assert_response :ok
+      #   assert_redirected_to '/some/path', status: :moved_permanently
       #
       #   # good
       #   render :foo, status: 200
@@ -35,18 +41,22 @@ module RuboCop
       #   render plain: 'foo/bar', status: 304
       #   redirect_to root_url, status: 301
       #   head 200
+      #   assert_response 200
+      #   assert_redirected_to '/some/path', status: 301
       #
       class HttpStatus < Base
         include ConfigurableEnforcedStyle
         extend AutoCorrector
 
-        RESTRICT_ON_SEND = %i[render redirect_to head].freeze
+        RESTRICT_ON_SEND = %i[render redirect_to head assert_response assert_redirected_to].freeze
 
         def_node_matcher :http_status, <<~PATTERN
           {
             (send nil? {:render :redirect_to} _ $hash)
             (send nil? {:render :redirect_to} $hash)
-            (send nil? :head ${int sym} ...)
+            (send nil? {:head :assert_response} ${int sym} ...)
+            (send nil? :assert_redirected_to _ $hash ...)
+            (send nil? :assert_redirected_to $hash ...)
           }
         PATTERN
 

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

@@ -52,7 +52,7 @@ module RuboCop
           (send
             nil?
             {#{FILTERS.join(' ')}}
-            _
+            ...
             $_)
         PATTERN
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # Checks for calls to `link_to` that contain a
+      # Checks for calls to `link_to`, `link_to_if`, and `link_to_unless` methods that contain a
       # `target: '_blank'` but no `rel: 'noopener'`. This can be a security
       # risk as the loaded page will have control over the previous page
       # and could change its location for phishing purposes.
@@ -24,7 +24,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Specify a `:rel` option containing noopener.'
-        RESTRICT_ON_SEND = %i[link_to].freeze
+        RESTRICT_ON_SEND = %i[link_to link_to_if link_to_unless].freeze
 
         def_node_matcher :blank_target?, <<~PATTERN
           (pair {(sym :target) (str "target")} {(str "_blank") (sym :_blank)})

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

@@ -3,24 +3,42 @@
 module RuboCop
   module Cop
     module Rails
-      # Checks for add_column call with NOT NULL constraint in migration file.
+      # Checks for add_column calls with a NOT NULL constraint without a default
+      # value.
       #
-      # `TEXT` can have default values in PostgreSQL, but not in MySQL.
-      # It will automatically detect an adapter from `development` environment
-      # in `config/database.yml` or the environment variable `DATABASE_URL`
-      # when the `Database` option is not set. If the database is MySQL,
-      # this cop ignores offenses for the `TEXT`.
+      # This cop only applies when adding a column to an existing table, since
+      # existing records will not have a value for the new column. New tables
+      # can freely use NOT NULL columns without defaults, since there are no
+      # records that could violate the constraint.
+      #
+      # If you need to add a NOT NULL column to an existing table, you must add
+      # it as nullable first, back-fill the data, and then use
+      # `change_column_null`. Alternatively, you could add the column with a
+      # default first to have the database automatically backfill existing rows,
+      # and then use `change_column_default` to remove the default.
+      #
+      # `TEXT` cannot have a default value in MySQL.
+      # The cop will automatically detect an adapter from `development`
+      # environment in `config/database.yml` or the environment variable
+      # `DATABASE_URL` when the `Database` option is not set. If the database
+      # is MySQL, this cop ignores offenses for `TEXT` columns.
       #
       # @example
       #   # bad
       #   add_column :users, :name, :string, null: false
       #   add_reference :products, :category, null: false
+      #   change_table :users do |t|
+      #     t.string :name, null: false
+      #   end
       #
       #   # good
       #   add_column :users, :name, :string, null: true
       #   add_column :users, :name, :string, null: false, default: ''
+      #   change_table :users do |t|
+      #     t.string :name, null: false, default: ''
+      #   end
       #   add_reference :products, :category
-      #   add_reference :products, :category, null: false, default: 1
+      #   change_column_null :products, :category_id, false
       class NotNullColumn < Base
         include DatabaseTypeResolvable
 
@@ -35,6 +53,22 @@ module RuboCop
           (send nil? :add_reference _ _ (hash $...))
         PATTERN
 
+        def_node_matcher :change_table?, <<~PATTERN
+          (block (send nil? :change_table ...) (args (arg $_)) _)
+        PATTERN
+
+        def_node_matcher :add_not_null_column_in_change_table?, <<~PATTERN
+          (send (lvar $_) :column _ $_ (hash $...))
+        PATTERN
+
+        def_node_matcher :add_not_null_column_via_shortcut_in_change_table?, <<~PATTERN
+          (send (lvar $_) $_ _ (hash $...))
+        PATTERN
+
+        def_node_matcher :add_not_null_reference_in_change_table?, <<~PATTERN
+          (send (lvar $_) :add_reference _ _ (hash $...))
+        PATTERN
+
         def_node_matcher :null_false?, <<~PATTERN
           (pair (sym :null) (false))
         PATTERN
@@ -48,16 +82,25 @@ module RuboCop
           check_add_reference(node)
         end
 
+        def on_block(node)
+          check_change_table(node)
+        end
+        alias on_numblock on_block
+
         private
 
+        def check_column(type, pairs)
+          if type.respond_to?(:value)
+            return if type.value == :virtual || type.value == 'virtual'
+            return if (type.value == :text || type.value == 'text') && database == MYSQL
+          end
+
+          check_pairs(pairs)
+        end
+
         def check_add_column(node)
           add_not_null_column?(node) do |type, pairs|
-            if type.respond_to?(:value)
-              return if type.value == :virtual || type.value == 'virtual'
-              return if (type.value == :text || type.value == 'text') && database == MYSQL
-            end
-
-            check_pairs(pairs)
+            check_column(type, pairs)
           end
         end
 
@@ -67,6 +110,43 @@ module RuboCop
           end
         end
 
+        def check_add_column_in_change_table(node, table)
+          add_not_null_column_in_change_table?(node) do |receiver, type, pairs|
+            next unless receiver == table
+
+            check_column(type, pairs)
+          end
+        end
+
+        def check_add_column_via_shortcut_in_change_table(node, table)
+          add_not_null_column_via_shortcut_in_change_table?(node) do |receiver, type, pairs|
+            next unless receiver == table
+
+            check_column(type, pairs)
+          end
+        end
+
+        def check_add_reference_in_change_table(node, table)
+          add_not_null_reference_in_change_table?(node) do |receiver, pairs|
+            next unless receiver == table
+
+            check_pairs(pairs)
+          end
+        end
+
+        def check_change_table(node)
+          change_table?(node) do |table|
+            next unless node.body
+
+            children = node.body.begin_type? ? node.body.children : [node.body]
+            children.each do |child|
+              check_add_column_in_change_table(child, table)
+              check_add_column_via_shortcut_in_change_table(child, table)
+              check_add_reference_in_change_table(child, table)
+            end
+          end
+        end
+
         def check_pairs(pairs)
           return if pairs.any? { |pair| default_option?(pair) }
 

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

@@ -9,6 +9,10 @@ module RuboCop
       # `pick` avoids. When called on an Active Record relation, `pick` adds a
       # limit to the query so that only one value is fetched from the database.
       #
+      # Note that when `pick` is added to a relation with an existing limit, it
+      # causes a subquery to be added. In most cases this is undesirable, and
+      # care should be taken while resolving this violation.
+      #
       # @safety
       #   This cop is unsafe because `pluck` is defined on both `ActiveRecord::Relation` and `Enumerable`,
       #   whereas `pick` is only defined on `ActiveRecord::Relation` in Rails 6.0. This was addressed

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

@@ -7,17 +7,26 @@ module RuboCop
       # and can be replaced with `select`.
       #
       # Since `pluck` is an eager method and hits the database immediately,
-      # using `select` helps to avoid additional database queries.
+      # using `select` helps to avoid additional database queries by running as
+      # a subquery.
       #
-      # This cop has two different enforcement modes. When the `EnforcedStyle`
-      # is `conservative` (the default) then only calls to `pluck` on a constant
-      # (i.e. a model class) in the `where` is used as offenses.
+      # This cop has two modes of enforcement. When the `EnforcedStyle` is set
+      # to `conservative` (the default), only calls to `pluck` on a constant
+      # (e.g. a model class) within `where` are considered offenses.
       #
       # @safety
-      #   When the `EnforcedStyle` is `aggressive` then all calls to `pluck` in the
-      #   `where` is used as offenses. This may lead to false positives
-      #   as the cop cannot replace to `select` between calls to `pluck` on an
-      #   `ActiveRecord::Relation` instance vs a call to `pluck` on an `Array` instance.
+      #   When `EnforcedStyle` is set to `aggressive`, all calls to `pluck`
+      #   within `where` are considered offenses. This might lead to false
+      #   positives because the check cannot distinguish between calls to
+      #   `pluck` on an `ActiveRecord::Relation` instance and calls to `pluck`
+      #   on an `Array` instance.
+      #
+      #   Additionally, when using a subquery with the SQL `IN` operator,
+      #   databases like PostgreSQL and MySQL can't optimize complex queries as
+      #   well. They need to scan all records of the outer table against the
+      #   subquery result sequentially, rather than using an index. This can
+      #   cause significant performance issues compared to writing the query
+      #   differently or using `pluck`.
       #
       # @example
       #   # bad

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

@@ -10,25 +10,39 @@ module RuboCop
       #   # bad
       #   3.day.ago
       #   1.months.ago
+      #   5.megabyte
+      #   1.gigabytes
       #
       #   # good
       #   3.days.ago
       #   1.month.ago
+      #   5.megabytes
+      #   1.gigabyte
       class PluralizationGrammar < Base
         extend AutoCorrector
 
-        SINGULAR_DURATION_METHODS = { second: :seconds,
-                                      minute: :minutes,
-                                      hour: :hours,
-                                      day: :days,
-                                      week: :weeks,
-                                      fortnight: :fortnights,
-                                      month: :months,
-                                      year: :years }.freeze
-
-        RESTRICT_ON_SEND = SINGULAR_DURATION_METHODS.keys + SINGULAR_DURATION_METHODS.values
-
-        PLURAL_DURATION_METHODS = SINGULAR_DURATION_METHODS.invert.freeze
+        SINGULAR_METHODS = {
+          second: :seconds,
+          minute: :minutes,
+          hour: :hours,
+          day: :days,
+          week: :weeks,
+          fortnight: :fortnights,
+          month: :months,
+          year: :years,
+          byte: :bytes,
+          kilobyte: :kilobytes,
+          megabyte: :megabytes,
+          gigabyte: :gigabytes,
+          terabyte: :terabytes,
+          petabyte: :petabytes,
+          exabyte: :exabytes,
+          zettabyte: :zettabytes
+        }.freeze
+
+        RESTRICT_ON_SEND = SINGULAR_METHODS.keys + SINGULAR_METHODS.values
+
+        PLURAL_METHODS = SINGULAR_METHODS.invert.freeze
 
         MSG = 'Prefer `%<number>s.%<correct>s`.'
 
@@ -86,15 +100,15 @@ module RuboCop
         end
 
         def pluralize(method_name)
-          SINGULAR_DURATION_METHODS.fetch(method_name.to_sym).to_s
+          SINGULAR_METHODS.fetch(method_name.to_sym).to_s
         end
 
         def singularize(method_name)
-          PLURAL_DURATION_METHODS.fetch(method_name.to_sym).to_s
+          PLURAL_METHODS.fetch(method_name.to_sym).to_s
         end
 
         def duration_method?(method_name)
-          SINGULAR_DURATION_METHODS.key?(method_name) || PLURAL_DURATION_METHODS.key?(method_name)
+          SINGULAR_METHODS.key?(method_name) || PLURAL_METHODS.key?(method_name)
         end
       end
     end

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

@@ -98,8 +98,6 @@ module RuboCop
         end
 
         def on_or(node)
-          return unless cop_config['NilOrEmpty']
-
           exists_and_not_empty?(node) do |var1, var2|
             return unless var1 == var2
 

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

@@ -3,35 +3,6 @@
 module RuboCop
   module Cop
     module Rails
-      # TODO: In the future, please support only RuboCop 1.52+ and use `RuboCop::Cop::AllowedReceivers`:
-      #       https://github.com/rubocop/rubocop/blob/v1.52.0/lib/rubocop/cop/mixin/allowed_receivers.rb
-      #       At that time, this duplicated module implementation can be removed.
-      module AllowedReceivers
-        def allowed_receiver?(receiver)
-          receiver_name = receiver_name(receiver)
-
-          allowed_receivers.include?(receiver_name)
-        end
-
-        def receiver_name(receiver)
-          return receiver_name(receiver.receiver) if receiver.receiver && !receiver.receiver.const_type?
-
-          if receiver.send_type?
-            if receiver.receiver
-              "#{receiver_name(receiver.receiver)}.#{receiver.method_name}"
-            else
-              receiver.method_name.to_s
-            end
-          else
-            receiver.source
-          end
-        end
-
-        def allowed_receivers
-          cop_config.fetch('AllowedReceivers', [])
-        end
-      end
-
       # Detect redundant `all` used as a receiver for Active Record query methods.
       #
       # For the methods `delete_all` and `destroy_all`, this cop will only check cases where the receiver is a model.

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

@@ -40,7 +40,7 @@ module RuboCop
         def on_send(node)
           association_with_foreign_key(node) do |type, name, options, foreign_key_pair, foreign_key|
             if redundant?(node, type, name, options, foreign_key)
-              add_offense(foreign_key_pair.source_range) do |corrector|
+              add_offense(foreign_key_pair) do |corrector|
                 range = range_with_surrounding_space(foreign_key_pair.source_range, side: :left)
                 range = range_with_surrounding_comma(range, :left)
 

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

@@ -39,6 +39,9 @@ module RuboCop
         MSG = 'Remove explicit presence validation for %<association>s.'
         RESTRICT_ON_SEND = %i[validates].freeze
 
+        # From https://github.com/rails/rails/blob/7a0bf93b9dd291c7f61121a41b3a813ac8857e6a/activemodel/lib/active_model/validations/validates.rb#L157-L159
+        NON_VALIDATION_OPTIONS = %i[if unless on allow_blank allow_nil strict].freeze
+
         minimum_target_rails_version 5.0
 
         # @!method presence_validation?(node)
@@ -170,6 +173,12 @@ module RuboCop
 
         def on_send(node)
           presence_validation?(node) do |all_keys, options, presence|
+            # If presence is the only validation option and other non-validation options
+            # are present, removing it will cause rails to error.
+            used_option_keys = options.keys.select(&:sym_type?).map(&:value)
+            remaining_validations = used_option_keys - NON_VALIDATION_OPTIONS - [:presence]
+            return if remaining_validations.none? && options.keys.length > 1
+
             keys = non_optional_belongs_to(node.parent, all_keys)
             return if keys.none?
 

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

@@ -78,7 +78,7 @@ module RuboCop
 
           send_nodes.each do |send_node|
             receiver = send_node.receiver
-            add_offense(receiver.source_range) do |corrector|
+            add_offense(receiver) do |corrector|
               autocorrect(corrector, send_node, node)
             end
           end

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

@@ -43,7 +43,7 @@ module RuboCop
             return if reflection_class_name.value.send_type? && reflection_class_name.value.receiver.nil?
             return if reflection_class_name.value.lvar_type? && str_assigned?(reflection_class_name)
 
-            add_offense(reflection_class_name.source_range) do |corrector|
+            add_offense(reflection_class_name) do |corrector|
               autocorrect(corrector, reflection_class_name)
             end
           end