rubocop-rails 2.14.2 → 2.19.1

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Using `flash` assignment before `render` in Rails controllers will persist the message for too long.
+      # Check https://guides.rubyonrails.org/action_controller_overview.html#flash-now
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because it replaces `flash` by `flash.now`.
+      #   Even though it is usually a mistake, it might be used intentionally.
+      #
+      # @example
+      #
+      #   # bad
+      #   class HomeController < ApplicationController
+      #     def create
+      #       flash[:alert] = "msg"
+      #       render :index
+      #     end
+      #   end
+      #
+      #   # good
+      #   class HomeController < ApplicationController
+      #     def create
+      #       flash.now[:alert] = "msg"
+      #       render :index
+      #     end
+      #   end
+      #
+      class ActionControllerFlashBeforeRender < Base
+        extend AutoCorrector
+
+        MSG = 'Use `flash.now` before `render`.'
+
+        def_node_search :flash_assignment?, <<~PATTERN
+          ^(send (send nil? :flash) :[]= ...)
+        PATTERN
+
+        def_node_search :render?, <<~PATTERN
+          (send nil? :render ...)
+        PATTERN
+
+        def_node_search :action_controller?, <<~PATTERN
+          {
+            (const {nil? cbase} :ApplicationController)
+            (const (const {nil? cbase} :ActionController) :Base)
+          }
+        PATTERN
+
+        RESTRICT_ON_SEND = [:flash].freeze
+
+        def on_send(flash_node)
+          return unless flash_assignment?(flash_node)
+
+          return unless followed_by_render?(flash_node)
+
+          return unless instance_method_or_block?(flash_node)
+
+          return unless inherit_action_controller_base?(flash_node)
+
+          add_offense(flash_node) do |corrector|
+            corrector.replace(flash_node, 'flash.now')
+          end
+        end
+
+        private
+
+        def followed_by_render?(flash_node)
+          flash_assignment_node = find_ancestor(flash_node, type: :send)
+          context = flash_assignment_node
+          if (node = context.each_ancestor(:if, :rescue).first)
+            return false if use_redirect_to?(context)
+
+            context = node
+          elsif context.right_siblings.empty?
+            return true
+          end
+          context = context.right_siblings
+
+          context.compact.any? do |render_candidate|
+            render?(render_candidate)
+          end
+        end
+
+        def inherit_action_controller_base?(node)
+          class_node = find_ancestor(node, type: :class)
+          return unless class_node
+
+          action_controller?(class_node)
+        end
+
+        def instance_method_or_block?(node)
+          def_node = find_ancestor(node, type: :def)
+          block_node = find_ancestor(node, type: :block)
+
+          def_node || block_node
+        end
+
+        def use_redirect_to?(context)
+          context.right_siblings.compact.any? do |sibling|
+            sibling.send_type? && sibling.method?(:redirect_to)
+          end
+        end
+
+        def find_ancestor(node, type:)
+          node.each_ancestor(type).first
+        end
+      end
+    end
+  end
+end

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

@@ -30,8 +30,8 @@ module RuboCop
 
         def_node_matcher :action_controller_test_case?, <<~PATTERN
           (class
-            (const nil? _)
-            (const (const {nil? cbase} :ActionController) :TestCase) nil?)
+            (const _ _)
+            (const (const {nil? cbase} :ActionController) :TestCase) _)
         PATTERN
 
         def on_class(node)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces the consistent use of action filter methods.
+      # Enforces the consistent use of action filter methods.
       #
       # The cop is configurable and can enforce the use of the older
       # something_filter methods or the newer something_action methods.
@@ -69,7 +69,7 @@ module RuboCop
 
         RESTRICT_ON_SEND = FILTER_METHODS + ACTION_METHODS
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           check_method_node(node.send_node)
         end
 

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

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Enforces consistent ordering of the standard Rails RESTful controller actions.
+      #
+      # The cop is configurable and can enforce any ordering of the standard actions.
+      # All other methods are ignored. So, the actions specified in `ExpectedOrder` should be
+      # defined before actions not specified.
+      #
+      # [source,yaml]
+      # ----
+      #  Rails/ActionOrder:
+      #    ExpectedOrder:
+      #      - index
+      #      - show
+      #      - new
+      #      - edit
+      #      - create
+      #      - update
+      #      - destroy
+      # ----
+      #
+      # @example
+      #   # bad
+      #   def index; end
+      #   def destroy; end
+      #   def show; end
+      #
+      #   # good
+      #   def index; end
+      #   def show; end
+      #   def destroy; end
+      class ActionOrder < Base
+        extend AutoCorrector
+        include VisibilityHelp
+        include DefNode
+        include RangeHelp
+
+        MSG = 'Action `%<current>s` should appear before `%<previous>s`.'
+
+        def_node_search :action_declarations, '(def {%1} ...)'
+
+        def on_class(node)
+          action_declarations(node, actions).each_cons(2) do |previous, current|
+            next if node_visibility(current) != :public || non_public?(current)
+            next if find_index(current) >= find_index(previous)
+
+            register_offense(previous, current)
+          end
+        end
+
+        private
+
+        def expected_order
+          cop_config['ExpectedOrder'].map(&:to_sym)
+        end
+
+        def actions
+          @actions ||= Set.new(expected_order)
+        end
+
+        def find_index(node)
+          expected_order.find_index(node.method_name)
+        end
+
+        def register_offense(previous, current)
+          message = format(
+            MSG,
+            expected_order: expected_order.join(', '),
+            previous: previous.method_name,
+            current: current.method_name
+          )
+          add_offense(current, message: message) do |corrector|
+            current = correction_target(current)
+            previous = correction_target(previous)
+
+            swap_range(corrector, current, previous)
+          end
+        end
+
+        def correction_target(def_node)
+          range_with_comments_and_lines(def_node.each_ancestor(:if).first || def_node)
+        end
+
+        def add_range(range1, range2)
+          range1.with(
+            begin_pos: [range1.begin_pos, range2.begin_pos].min,
+            end_pos: [range1.end_pos, range2.end_pos].max
+          )
+        end
+
+        def range_with_comments(node)
+          # rubocop:todo InternalAffairs/LocationExpression
+          # Using `RuboCop::Ext::Comment#source_range` requires RuboCop > 1.46,
+          # which introduces https://github.com/rubocop/rubocop/pull/11630.
+          ranges = [node, *processed_source.ast_with_comments[node]].map { |comment| comment.loc.expression }
+          # rubocop:enable InternalAffairs/LocationExpression
+          ranges.reduce do |result, range|
+            add_range(result, range)
+          end
+        end
+
+        def range_with_comments_and_lines(node)
+          range_by_whole_lines(range_with_comments(node), include_final_newline: true)
+        end
+
+        def swap_range(corrector, range1, range2)
+          corrector.insert_before(range2, range1.source)
+          corrector.remove(range1)
+        end
+      end
+    end
+  end
+end

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

@@ -21,14 +21,13 @@ module RuboCop
 
         MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
 
-        ALIASES = {
-          update_attributes: :update,
-          update_attributes!: :update!
-        }.freeze
+        ALIASES = { update_attributes: :update, update_attributes!: :update! }.freeze
 
         RESTRICT_ON_SEND = ALIASES.keys.freeze
 
         def on_send(node)
+          return if node.arguments.empty?
+
           method_name = node.method_name
           alias_method = ALIASES[method_name]
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that Active Record callbacks are declared
+      # Checks that Active Record callbacks are declared
       # in the order in which they will be executed.
       #
       # @example
@@ -104,7 +104,7 @@ module RuboCop
         end
 
         def end_position_for(node)
-          end_line = buffer.line_for_position(node.loc.expression.end_pos)
+          end_line = buffer.line_for_position(node.source_range.end_pos)
           buffer.line_range(end_line).end_pos
         end
 
@@ -112,8 +112,7 @@ module RuboCop
           annotation_line = node.first_line - 1
           first_comment = nil
 
-          processed_source.comments_before_line(annotation_line)
-                          .reverse_each do |comment|
+          processed_source.each_comment_in_lines(0..annotation_line).reverse_each do |comment|
             if comment.location.line == annotation_line && !inline_comment?(comment)
               first_comment = comment
               annotation_line -= 1
@@ -124,7 +123,11 @@ module RuboCop
         end
 
         def inline_comment?(comment)
+          # rubocop:todo InternalAffairs/LocationExpression
+          # Using `RuboCop::Ext::Comment#source_range` requires RuboCop > 1.46,
+          # which introduces https://github.com/rubocop/rubocop/pull/11630.
           !comment_line?(comment.loc.expression.source_line)
+          # rubocop:enable InternalAffairs/LocationExpression
         end
 
         def start_line_position(node)

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

@@ -25,12 +25,9 @@ module RuboCop
       #   end
       #
       class ActiveRecordOverride < Base
-        MSG =
-          'Use %<prefer>s callbacks instead of overriding the Active Record ' \
-          'method `%<bad>s`.'
+        MSG = 'Use %<prefer>s callbacks instead of overriding the Active Record method `%<bad>s`.'
         BAD_METHODS = %i[create destroy save update].freeze
-        ACTIVE_RECORD_CLASSES = %w[ApplicationRecord ActiveModel::Base
-                                   ActiveRecord::Base].freeze
+        ACTIVE_RECORD_CLASSES = %w[ApplicationRecord ActiveModel::Base ActiveRecord::Base].freeze
 
         def on_def(node)
           return unless BAD_METHODS.include?(node.method_name)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that ActiveSupport aliases to core ruby methods
+      # Checks that ActiveSupport aliases to core ruby methods
       # are not used.
       #
       # @example

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks for Rails framework classes that are patched directly instead of using Active Support load hooks. Direct
+      # patching forcibly loads the framework referenced, using hooks defers loading until it's actually needed.
+      #
+      # @safety
+      #   While using lazy load hooks is recommended, it changes the order in which is code is loaded and may reveal
+      #   load order dependency bugs.
+      #
+      # @example
+      #
+      #   # bad
+      #   ActiveRecord::Base.include(MyClass)
+      #
+      #   # good
+      #   ActiveSupport.on_load(:active_record) { include MyClass }
+      class ActiveSupportOnLoad < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
+        RESTRICT_ON_SEND = %i[prepend include extend].freeze
+        LOAD_HOOKS = {
+          'ActionCable' => 'action_cable',
+          'ActionCable::Channel::Base' => 'action_cable_channel',
+          'ActionCable::Connection::Base' => 'action_cable_connection',
+          'ActionCable::Connection::TestCase' => 'action_cable_connection_test_case',
+          'ActionController::API' => 'action_controller',
+          'ActionController::Base' => 'action_controller',
+          'ActionController::TestCase' => 'action_controller_test_case',
+          'ActionDispatch::IntegrationTest' => 'action_dispatch_integration_test',
+          'ActionDispatch::Request' => 'action_dispatch_request',
+          'ActionDispatch::Response' => 'action_dispatch_response',
+          'ActionDispatch::SystemTestCase' => 'action_dispatch_system_test_case',
+          'ActionMailbox::Base' => 'action_mailbox',
+          'ActionMailbox::InboundEmail' => 'action_mailbox_inbound_email',
+          'ActionMailbox::Record' => 'action_mailbox_record',
+          'ActionMailbox::TestCase' => 'action_mailbox_test_case',
+          'ActionMailer::Base' => 'action_mailer',
+          'ActionMailer::TestCase' => 'action_mailer_test_case',
+          'ActionText::Content' => 'action_text_content',
+          'ActionText::Record' => 'action_text_record',
+          'ActionText::RichText' => 'action_text_rich_text',
+          'ActionView::Base' => 'action_view',
+          'ActionView::TestCase' => 'action_view_test_case',
+          'ActiveJob::Base' => 'active_job',
+          'ActiveJob::TestCase' => 'active_job_test_case',
+          'ActiveRecord::Base' => 'active_record',
+          'ActiveStorage::Attachment' => 'active_storage_attachment',
+          'ActiveStorage::Blob' => 'active_storage_blob',
+          'ActiveStorage::Record' => 'active_storage_record',
+          'ActiveStorage::VariantRecord' => 'active_storage_variant_record',
+          'ActiveSupport::TestCase' => 'active_support_test_case'
+        }.freeze
+
+        def on_send(node)
+          receiver, method, arguments = *node # rubocop:disable InternalAffairs/NodeDestructuring
+          return unless receiver && (hook = LOAD_HOOKS[receiver.const_name])
+
+          preferred = "ActiveSupport.on_load(:#{hook}) { #{method} #{arguments.source} }"
+          add_offense(node, message: format(MSG, prefer: preferred, current: node.source)) do |corrector|
+            corrector.replace(node, preferred)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for migrations using `add_column` that have an `index`
+      # Checks for migrations using `add_column` that have an `index`
       # key. `add_column` does not accept `index`, but also does not raise an
       # error for extra keys, so it is possible to mistakenly add the key without
       # realizing it will not actually add an index.
@@ -42,7 +42,7 @@ module RuboCop
             add_index_opts = ''
 
             if value.hash_type?
-              hash = value.loc.expression.adjust(begin_pos: 1, end_pos: -1).source.strip
+              hash = value.source_range.adjust(begin_pos: 1, end_pos: -1).source.strip
               add_index_opts = ", #{hash}"
             end
 
@@ -53,10 +53,7 @@ module RuboCop
         private
 
         def index_range(pair_node)
-          range_with_surrounding_comma(
-            range_with_surrounding_space(range: pair_node.loc.expression, side: :left),
-            :left
-          )
+          range_with_surrounding_comma(range_with_surrounding_space(pair_node.source_range, side: :left), :left)
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop enforces that there is only one call to `after_commit`
+      # Enforces that there is only one call to `after_commit`
       # (and its aliases - `after_create_commit`, `after_update_commit`,
       # and `after_destroy_commit`) with the same callback name per model.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that controllers subclass `ApplicationController`.
+      # Checks that controllers subclass `ApplicationController`.
       #
       # @safety
       #   This cop's autocorrection is unsafe because it may let the logic from `ApplicationController`
@@ -25,7 +25,7 @@ module RuboCop
 
         MSG = 'Controllers should subclass `ApplicationController`.'
         SUPERCLASS = 'ApplicationController'
-        BASE_PATTERN = '(const (const nil? :ActionController) :Base)'
+        BASE_PATTERN = '(const (const {nil? cbase} :ActionController) :Base)'
 
         # rubocop:disable Layout/ClassStructure
         include RuboCop::Cop::EnforceSuperclass

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that jobs subclass `ApplicationJob` with Rails 5.0.
+      # Checks that jobs subclass `ApplicationJob` with Rails 5.0.
       #
       # @safety
       #   This cop's autocorrection is unsafe because it may let the logic from `ApplicationJob`
@@ -28,7 +28,7 @@ module RuboCop
 
         MSG = 'Jobs should subclass `ApplicationJob`.'
         SUPERCLASS = 'ApplicationJob'
-        BASE_PATTERN = '(const (const nil? :ActiveJob) :Base)'
+        BASE_PATTERN = '(const (const {nil? cbase} :ActiveJob) :Base)'
 
         # rubocop:disable Layout/ClassStructure
         include RuboCop::Cop::EnforceSuperclass
@@ -36,7 +36,7 @@ module RuboCop
 
         def autocorrect(node)
           lambda do |corrector|
-            corrector.replace(node.source_range, self.class::SUPERCLASS)
+            corrector.replace(node, self.class::SUPERCLASS)
           end
         end
       end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that mailers subclass `ApplicationMailer` with Rails 5.0.
+      # Checks that mailers subclass `ApplicationMailer` with Rails 5.0.
       #
       # @safety
       #   This cop's autocorrection is unsafe because it may let the logic from `ApplicationMailer`
@@ -28,7 +28,7 @@ module RuboCop
 
         MSG = 'Mailers should subclass `ApplicationMailer`.'
         SUPERCLASS = 'ApplicationMailer'
-        BASE_PATTERN = '(const (const nil? :ActionMailer) :Base)'
+        BASE_PATTERN = '(const (const {nil? cbase} :ActionMailer) :Base)'
 
         # rubocop:disable Layout/ClassStructure
         include RuboCop::Cop::EnforceSuperclass

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that models subclass `ApplicationRecord` with Rails 5.0.
+      # Checks that models subclass `ApplicationRecord` with Rails 5.0.
       #
       # @safety
       #   This cop's autocorrection is unsafe because it may let the logic from `ApplicationRecord`
@@ -29,7 +29,7 @@ module RuboCop
 
         MSG = 'Models should subclass `ApplicationRecord`.'
         SUPERCLASS = 'ApplicationRecord'
-        BASE_PATTERN = '(const (const nil? :ActiveRecord) :Base)'
+        BASE_PATTERN = '(const (const {nil? cbase} :ActiveRecord) :Base)'
 
         # rubocop:disable Layout/ClassStructure
         include RuboCop::Cop::EnforceSuperclass

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop prevents usage of `"*"` on an Arel::Table column reference.
+      # Prevents usage of `"*"` on an Arel::Table column reference.
       #
       # Using `arel_table["*"]` causes the outputted string to be a literal
       # quoted asterisk (e.g. <tt>`my_model`.`*`</tt>). This causes the
@@ -38,7 +38,7 @@ module RuboCop
           return unless (star = star_bracket?(node))
 
           add_offense(star) do |corrector|
-            corrector.replace(star.loc.expression, 'Arel.star')
+            corrector.replace(star, 'Arel.star')
           end
         end
       end

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

@@ -25,7 +25,7 @@ module RuboCop
           return unless offensive?(node)
 
           add_offense(node) do |corrector|
-            expression = node.loc.expression
+            expression = node.source_range
 
             corrector.replace(expression, corrected_source(expression.source))
           end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for `attribute` class methods that specify a `:default` option
+      # Looks for `attribute` class methods that specify a `:default` option
       # which value is an array, string literal or method call without a block.
       # It will accept all other values, such as string, symbol, integer and float literals
       # as well as constants.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop looks for belongs_to associations where we control whether the
+      # Looks for belongs_to associations where we control whether the
       # association is required via the deprecated `required` option instead.
       #
       # Since Rails 5, belongs_to associations are required by default and this
@@ -47,9 +47,6 @@ module RuboCop
       #   class Post < ApplicationRecord
       #     belongs_to :blog, optional: false
       #   end
-      #
-      # @see https://guides.rubyonrails.org/5_0_release_notes.html
-      # @see https://github.com/rails/rails/pull/18937
       class BelongsTo < Base
         extend AutoCorrector
         extend TargetRailsVersion
@@ -83,7 +80,7 @@ module RuboCop
               end
 
             add_offense(node.loc.selector, message: message) do |corrector|
-              corrector.replace(option_node.loc.expression, replacement)
+              corrector.replace(option_node, replacement)
             end
           end
         end

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

@@ -3,17 +3,17 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks for code that can be written with simpler conditionals
+      # Checks for code that can be written with simpler conditionals
       # using `Object#blank?` defined by Active Support.
       #
       # Interaction with `Style/UnlessElse`:
       # The configuration of `NotPresent` will not produce an offense in the
-      # context of `unless else` if `Style/UnlessElse` is inabled. This is
-      # to prevent interference between the auto-correction of the two cops.
+      # context of `unless else` if `Style/UnlessElse` is enabled. This is
+      # to prevent interference between the autocorrection of the two cops.
       #
       # @safety
-      #   This cop is unsafe auto-correction, because `' '.empty?` returns false,
-      #   but `' '.blank?` returns true. Therefore, auto-correction is not compatible
+      #   This cop is unsafe autocorrection, because `' '.empty?` returns false,
+      #   but `' '.blank?` returns true. Therefore, autocorrection is not compatible
       #   if the receiver is a non-empty blank string, tab, or newline meta characters.
       #
       # @example NilOrEmpty: true (default)
@@ -63,8 +63,7 @@ module RuboCop
 
         MSG_NIL_OR_EMPTY = 'Use `%<prefer>s` instead of `%<current>s`.'
         MSG_NOT_PRESENT = 'Use `%<prefer>s` instead of `%<current>s`.'
-        MSG_UNLESS_PRESENT = 'Use `if %<prefer>s` instead of ' \
-                             '`%<current>s`.'
+        MSG_UNLESS_PRESENT = 'Use `if %<prefer>s` instead of `%<current>s`.'
         RESTRICT_ON_SEND = %i[!].freeze
 
         # `(send nil $_)` is not actually a valid match for an offense. Nodes
@@ -143,10 +142,10 @@ module RuboCop
 
           if method_call
             corrector.replace(node.loc.keyword, 'if')
-            range = method_call.loc.expression
+            range = method_call.source_range
           else
             variable1, _variable2 = nil_or_empty?(node) || not_present?(node)
-            range = node.loc.expression
+            range = node.source_range
           end
 
           corrector.replace(range, replacement(variable1))
@@ -154,9 +153,9 @@ module RuboCop
 
         def unless_condition(node, method_call)
           if node.modifier_form?
-            node.loc.keyword.join(node.loc.expression.end)
+            node.loc.keyword.join(node.source_range.end)
           else
-            node.loc.expression.begin.join(method_call.loc.expression)
+            node.source_range.begin.join(method_call.source_range)
           end
         end