rubocop-rails 2.14.2 → 2.15.2

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks if the value of the option `class_name`, in
+      # Checks if the value of the option `class_name`, in
       # the definition of a reflection is a string.
       #
       # @safety

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks whether constant value isn't relative date.
+      # Checks whether constant value isn't relative date.
       # Because the relative date will be evaluated only once.
       #
       # @safety

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for inline rendering within controller actions.
+      # Looks for inline rendering within controller actions.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop identifies places where `render text:` can be
+      # Identifies places where `render text:` can be
       # replaced with `render plain:`.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for consistent uses of `request.referer` or
+      # Checks for consistent uses of `request.referer` or
       # `request.referrer`, depending on the cop's configuration.
       #
       # @example EnforcedStyle: referer (default)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the usage of `require_dependency`.
+      # Checks for the usage of `require_dependency`.
       #
       # `require_dependency` is an obsolete method for Rails applications running in Zeitwerk mode.
       # In Zeitwerk mode, the semantics should match Ruby's and no need to be defensive with load order,

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks whether the change method of the migration file is
+      # Checks whether the change method of the migration file is
       # reversible.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks whether the migration implements
+      # Checks whether the migration implements
       # either a `change` method or both an `up` and a `down`
       # method.
       #
@@ -49,15 +49,15 @@ module RuboCop
               'both an `up` and a `down` method.'
 
         def_node_matcher :change_method?, <<~PATTERN
-          [ #migration_class? `(def :change (args) _) ]
+          `(def :change (args) _)
         PATTERN
 
         def_node_matcher :up_and_down_methods?, <<~PATTERN
-          [ #migration_class? `(def :up (args) _) `(def :down (args) _) ]
+          [`(def :up (args) _) `(def :down (args) _)]
         PATTERN
 
         def on_class(node)
-          return if change_method?(node) || up_and_down_methods?(node)
+          return if !migration_class?(node) || change_method?(node) || up_and_down_methods?(node)
 
           add_offense(node)
         end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Favor `Rails.public_path` over `Rails.root` with `'public'`
+      #
+      # @example
+      #   # bad
+      #   Rails.root.join('public')
+      #   Rails.root.join('public/file.pdf')
+      #   Rails.root.join('public', 'file.pdf')
+      #
+      #   # good
+      #   Rails.public_path
+      #   Rails.public_path.join('file.pdf')
+      #   Rails.public_path.join('file.pdf')
+      #
+      class RootPublicPath < Base
+        extend AutoCorrector
+
+        MSG = 'Use `Rails.public_path`.'
+
+        RESTRICT_ON_SEND = %i[join].to_set.freeze
+
+        PATTERN = %r{\Apublic(/|\z)}.freeze
+
+        def_node_matcher :rails_root_public, <<~PATTERN
+          (send
+            (send
+              $(const {nil? cbase} :Rails) :root) :join
+            (str $#public_path?) $...)
+        PATTERN
+
+        def on_send(node)
+          return unless (rails, maybe_public_path, other_args = rails_root_public(node))
+
+          add_offense(node) do |corrector|
+            first_args = maybe_public_path.gsub(PATTERN, '')
+
+            args = other_args.map(&:source)
+            args.unshift("'#{first_args}'") unless first_args.empty?
+
+            replacement = "#{rails.source}.public_path"
+            replacement += ".join(#{args.join(', ')})" unless args.empty?
+
+            corrector.replace(node, replacement)
+          end
+        end
+
+        private
+
+        def public_path?(string)
+          PATTERN.match?(string)
+        end
+      end
+    end
+  end
+end

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

@@ -3,8 +3,9 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop converts usages of `try!` to `&.`. It can also be configured
-      # to convert `try`. It will convert code to use safe navigation.
+      # Converts usages of `try!` to `&.`. It can also be configured
+      # to convert `try`. It will convert code to use safe navigation
+      # if the target Ruby version is set to 2.3+
       #
       # @example ConvertTry: false (default)
       #   # bad
@@ -39,6 +40,9 @@ module RuboCop
       class SafeNavigation < Base
         include RangeHelp
         extend AutoCorrector
+        extend TargetRubyVersion
+
+        minimum_target_ruby_version 2.3
 
         MSG = 'Use safe navigation (`&.`) instead of `%<try>s`.'
         RESTRICT_ON_SEND = %i[try try!].freeze
@@ -47,15 +51,6 @@ module RuboCop
           (send _ ${:try :try!} $_ ...)
         PATTERN
 
-        # Monkey patching for `Style/RedundantSelf` of RuboCop core.
-        # rubocop:disable Style/ClassAndModuleChildren
-        class Style::RedundantSelf
-          def self.autocorrect_incompatible_with
-            [Rails::SafeNavigation]
-          end
-        end
-        # rubocop:enable Style/ClassAndModuleChildren
-
         def self.autocorrect_incompatible_with
           [Style::RedundantSelf]
         end
@@ -75,7 +70,7 @@ module RuboCop
 
         def autocorrect(corrector, node)
           method_node, *params = *node.arguments
-          method = method_node.source[1..-1]
+          method = method_node.source[1..]
 
           range = if node.receiver
                     range_between(node.loc.dot.begin_pos, node.loc.expression.end_pos)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks to make sure safe navigation isn't used with `blank?` in
+      # Checks to make sure safe navigation isn't used with `blank?` in
       # a conditional.
       #
       # @safety

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop identifies possible cases where Active Record save! or related
+      # Identifies possible cases where Active Record save! or related
       # should be used instead of save because the model might have failed to
       # save and an exception is better than unhandled failure.
       #
@@ -37,7 +37,7 @@ module RuboCop
       #
       #   update_attributes
       #
-      #   # After running rubocop --safe-auto-correct
+      #   # After running rubocop --safe-autocorrect
       #   def update_attributes
       #   end
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the use of the `comment` option when adding a new table or column
+      # Enforces the use of the `comment` option when adding a new table or column
       # to the database during a migration.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for scope calls where it was passed
+      # Checks for scope calls where it was passed
       # a method (usually a scope) instead of a lambda/proc.
       #
       # @example

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces that short forms of `I18n` methods are used:
+      # Enforces that short forms of `I18n` methods are used:
       # `t` instead of `translate` and `l` instead of `localize`.
       #
       # This cop has two different enforcement modes. When the EnforcedStyle

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of methods which skip
+      # Checks for the use of methods which skip
       # validations which are listed in
       # https://guides.rubyonrails.org/active_record_validations.html#skipping-validations
       #

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

@@ -8,7 +8,7 @@ module RuboCop
       #
       # @safety
       #   Some SQL syntax (e.g. PostgreSQL comments and functions) requires newlines
-      #   to be preserved in order to work, thus auto-correction for this cop is not safe.
+      #   to be preserved in order to work, thus autocorrection for this cop is not safe.
       #
       # @example
       #   # bad

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Enforces the use of squiggly heredoc over `strip_heredoc`.
+      #
+      # @example
+      #
+      #   # bad
+      #   <<EOS.strip_heredoc
+      #     some text
+      #   EOS
+      #
+      #   # bad
+      #   <<-EOS.strip_heredoc
+      #     some text
+      #   EOS
+      #
+      #   # good
+      #   <<~EOS
+      #     some text
+      #   EOS
+      #
+      class StripHeredoc < Base
+        extend AutoCorrector
+        extend TargetRubyVersion
+
+        MSG = 'Use squiggly heredoc (`<<~`) instead of `strip_heredoc`.'
+        RESTRICT_ON_SEND = %i[strip_heredoc].freeze
+
+        minimum_target_ruby_version 2.3
+
+        def on_send(node)
+          return unless (receiver = node.receiver)
+          return unless receiver.str_type? || receiver.dstr_type?
+          return unless receiver.respond_to?(:heredoc?) && receiver.heredoc?
+
+          register_offense(node, receiver)
+        end
+
+        private
+
+        def register_offense(node, heredoc)
+          add_offense(node) do |corrector|
+            squiggly_heredoc = heredoc.source.sub(/\A<<(-|~)?/, '<<~')
+
+            corrector.replace(heredoc, squiggly_heredoc)
+            corrector.remove(node.loc.dot)
+            corrector.remove(node.loc.selector)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the absence of explicit table name assignment.
+      # Enforces the absence of explicit table name assignment.
       #
       # `self.table_name=` should only be used for very good reasons,
       # such as not having control over the database, or working

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of Time methods without zone.
+      # Checks for the use of Time methods without zone.
       #
       # Built on top of Ruby on Rails style guide (https://rails.rubystyle.guide#time)
       # and the article http://danilenko.org/2012/7/6/rails_timezones/
@@ -28,17 +28,17 @@ module RuboCop
       #   Time.zone.parse('2015-03-02T19:05:37')
       #   Time.zone.parse('2015-03-02T19:05:37Z') # Respect ISO 8601 format with timezone specifier.
       #
-      # @example EnforcedStyle: strict
-      #   # `strict` means that `Time` should be used with `zone`.
-      #
-      #   # bad
-      #   Time.at(timestamp).in_time_zone
-      #
       # @example EnforcedStyle: flexible (default)
       #   # `flexible` allows usage of `in_time_zone` instead of `zone`.
       #
       #   # good
       #   Time.at(timestamp).in_time_zone
+      #
+      # @example EnforcedStyle: strict
+      #   # `strict` means that `Time` should be used with `zone`.
+      #
+      #   # bad
+      #   Time.at(timestamp).in_time_zone
       class TimeZone < Base
         include ConfigurableEnforcedStyle
         extend AutoCorrector

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of `Time.zone=` method.
+      # Checks for the use of `Time.zone=` method.
       #
       # The `zone` attribute persists for the rest of the Ruby runtime, potentially causing
       # unexpected behavior at a later time.
@@ -22,12 +22,12 @@ module RuboCop
         MSG = 'Use `Time.use_zone` with block instead of `Time.zone=`.'
         RESTRICT_ON_SEND = %i[zone=].freeze
 
-        def_node_matcher :time_zone_assignement?, <<~PATTERN
+        def_node_matcher :time_zone_assignment?, <<~PATTERN
           (send (const nil? :Time) :zone= ...)
         PATTERN
 
         def on_send(node)
-          return unless time_zone_assignement?(node)
+          return unless time_zone_assignment?(node)
 
           add_offense(node)
         end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks for consistent uses of `to_fs` or `to_formatted_s`,
+      # depending on the cop's configuration.
+      #
+      # @example EnforcedStyle: to_fs (default)
+      #
+      #   # bad
+      #   time.to_formatted_s(:db)
+      #
+      #   # good
+      #   time.to_fs(:db)
+      #
+      # @example EnforcedStyle: to_formatted_s
+      #
+      #   # bad
+      #   time.to_fs(:db)
+      #
+      #   # good
+      #   time.to_formatted_s(:db)
+      #
+      class ToFormattedS < Base
+        include ConfigurableEnforcedStyle
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        minimum_target_rails_version 7.0
+
+        MSG = 'Use `%<prefer>s` instead.'
+        RESTRICT_ON_SEND = %i[to_formatted_s to_fs].freeze
+
+        def on_send(node)
+          return if node.method?(style)
+
+          add_offense(node.loc.selector, message: format(MSG, prefer: style)) do |corrector|
+            corrector.replace(node.loc.selector, style)
+          end
+        end
+        alias on_csend on_send
+      end
+    end
+  end
+end

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

@@ -3,10 +3,10 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of exit statements (namely `return`,
+      # Checks for the use of exit statements (namely `return`,
       # `break` and `throw`) in transactions. This is due to the eventual
       # unexpected behavior when using ActiveRecord >= 7, where transactions
-      # exitted using these statements are being rollbacked rather than
+      # exited using these statements are being rollbacked rather than
       # committed (pre ActiveRecord 7 behavior).
       #
       # As alternatives, it would be more intuitive to explicitly raise an
@@ -29,6 +29,11 @@ module RuboCop
       #     throw if user.active?
       #   end
       #
+      #   # bad, as `with_lock` implicitly opens a transaction too
+      #   user.with_lock do
+      #     throw if user.active?
+      #   end
+      #
       #   # good
       #   ApplicationRecord.transaction do
       #     # Rollback
@@ -47,18 +52,26 @@ module RuboCop
           Exit statement `%<statement>s` is not allowed. Use `raise` (rollback) or `next` (commit).
         MSG
 
-        RESTRICT_ON_SEND = %i[transaction].freeze
+        RESTRICT_ON_SEND = %i[transaction with_lock].freeze
 
         def_node_search :exit_statements, <<~PATTERN
           ({return | break | send nil? :throw} ...)
         PATTERN
 
+        def_node_matcher :rescue_body_return_node?, <<~PATTERN
+          (:resbody ...
+            ...
+            ({return | break | send nil? :throw} ...)
+            ...
+          )
+        PATTERN
+
         def on_send(node)
           return unless (parent = node.parent)
           return unless parent.block_type? && parent.body
 
           exit_statements(parent.body).each do |statement_node|
-            next if in_rescue?(statement_node) || nested_block?(statement_node)
+            next if statement_node.break_type? && nested_block?(statement_node)
 
             statement = statement(statement_node)
             message = format(MSG, statement: statement)
@@ -79,13 +92,7 @@ module RuboCop
           end
         end
 
-        def in_rescue?(statement_node)
-          statement_node.ancestors.find(&:rescue_type?)
-        end
-
         def nested_block?(statement_node)
-          return false unless statement_node.break_type?
-
           !statement_node.ancestors.find(&:block_type?).method?(:transaction)
         end
       end

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

@@ -56,9 +56,9 @@ module RuboCop
 
         def with_index?(klass, table, names)
           # Compatibility for Rails 4.2.
-          add_indicies = schema.add_indicies_by(table_name: table_name(klass))
+          add_indices = schema.add_indices_by(table_name: table_name(klass))
 
-          (table.indices + add_indicies).any? do |index|
+          (table.indices + add_indices).any? do |index|
             index.unique &&
               (index.columns.to_set == names ||
                include_column_names_in_expression_index?(index, names))

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that environments called with `Rails.env` predicates
+      # Checks that environments called with `Rails.env` predicates
       # exist.
       # By default the cop allows three environments which Rails ships with:
       # `development`, `test`, and `production`.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop suggests you remove a column that does not exist in the schema from `ignored_columns`.
+      # Suggests you remove a column that does not exist in the schema from `ignored_columns`.
       # `ignored_columns` is necessary to drop a column from RDBMS, but you don't need it after the migration
       # to drop the column. You avoid forgetting to remove `ignored_columns` by this cop.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for the use of old-style attribute validation macros.
+      # Checks for the use of old-style attribute validation macros.
       #
       # @example
       #   # bad

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop identifies places where manually constructed SQL
+      # Identifies places where manually constructed SQL
       # in `where` can be replaced with `where(attribute: value)`.
       #
       # @safety

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces consistent style when using `exists?`.
+      # Enforces consistent style when using `exists?`.
       #
       # Two styles are supported for this cop. When EnforcedStyle is 'exists'
       # then the cop enforces `exists?(...)` over `where(...).exists?`.
@@ -12,7 +12,7 @@ module RuboCop
       # `where(...).exists?` over `exists?(...)`.
       #
       # @safety
-      #   This cop is unsafe for auto-correction because the behavior may change on the following case:
+      #   This cop is unsafe for autocorrection because the behavior may change on the following case:
       #
       #   [source,ruby]
       #   ----

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop identifies places where manually constructed SQL
+      # Identifies places where manually constructed SQL
       # in `where` can be replaced with `where.not(...)`.
       #
       # @example

data/lib/rubocop/cop/rails_cops.rb

@@ -34,6 +34,7 @@ require_relative 'rails/default_scope'
 require_relative 'rails/delegate'
 require_relative 'rails/delegate_allow_blank'
 require_relative 'rails/deprecated_active_model_errors_methods'
+require_relative 'rails/dot_separated_keys'
 require_relative 'rails/duplicate_association'
 require_relative 'rails/duplicate_scope'
 require_relative 'rails/duration_arithmetic'
@@ -96,6 +97,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_public_path'
 require_relative 'rails/safe_navigation'
 require_relative 'rails/safe_navigation_with_blank'
 require_relative 'rails/save_bang'
@@ -104,9 +106,11 @@ 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/strip_heredoc'
 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/transaction_exit_statement'
 require_relative 'rails/uniq_before_pluck'
 require_relative 'rails/unique_validation_without_index'