rubocop-rails 2.17.2 → 2.17.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97069bbada22491ece697f32f933ce8dc5274c18ad2782bb832cd83b168874a3
-  data.tar.gz: 4a691068f93c7be89e9cf695c3be16fe183cb23be4b187e822a9bf9d896c9af7
+  metadata.gz: e1cd420a9b6ec0e14a26063533cf9db61a81a43e44bec26a8b98e577cf761e49
+  data.tar.gz: 73918575c04e0f9ee8390d3efc0a4eb49b1cb4093695ecbafddbf995c406869d
 SHA512:
-  metadata.gz: 213e3da3d5e23338c53ee9428d8d44a57123fa8a239c3974e5eb0181797555639da23ed7e09336e906e14ba3c99c46e33efba18db44646f0efe86913dc0b7847
-  data.tar.gz: ed27cd2b9106a650b01fc700e9c2511971853412f49aa93876589dfa67e77c7a246fa364dd4682747fc97ffe8121d286a4096e6ef0b257483668c36f99fec9e1
+  metadata.gz: 93fffc6d3f6cbb781692725c13eb6f049e3106f2fb7ccb43a48fdf7c0d85a189914740d2ef743b0642eaa94ae0fc584ec1a32be53095a12167b3c02db2b035d4
+  data.tar.gz: 05ac2a5767f2c65437629fa623b3b4506547227c5b608a7ebc4e29a91b831e794ac6ee7c62a55b1573f3b228d40b6aaaedbda1fb7b81481c51f9c0df6884f389

data/config/default.yml

@@ -540,7 +540,7 @@ Rails/I18nLazyLookup:
   Enabled: pending
   VersionAdded: '2.14'
   Include:
-    - 'controllers/**/*'
+    - 'app/controllers/**/*.rb'
 
 Rails/I18nLocaleAssignment:
   Description: 'Prefer the usage of `I18n.with_locale` instead of manually updating `I18n.locale` value.'

data/lib/rubocop/cop/mixin/active_record_helper.rb

@@ -10,8 +10,8 @@ module RuboCop
 
       def_node_matcher :active_record?, <<~PATTERN
         {
-          (const nil? :ApplicationRecord)
-          (const (const nil? :ActiveRecord) :Base)
+          (const {nil? cbase} :ApplicationRecord)
+          (const (const {nil? cbase} :ActiveRecord) :Base)
         }
       PATTERN
 

data/lib/rubocop/cop/mixin/index_method.rb

@@ -134,7 +134,7 @@ module RuboCop
         end
 
         def self.from_hash_brackets_map(node, match)
-          new(match, node.children.last, 'Hash['.length, ']'.length)
+          new(match, node.children.last, "#{node.receiver.source}[".length, ']'.length)
         end
 
         def strip_prefix_and_suffix(node, corrector)

data/lib/rubocop/cop/mixin/migrations_helper.rb

@@ -8,7 +8,7 @@ module RuboCop
 
       def_node_matcher :migration_class?, <<~PATTERN
         (class
-          (const nil? _)
+          (const {nil? cbase} _)
           (send
             (const (const {nil? cbase} :ActiveRecord) :Migration)
             :[]

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

@@ -43,8 +43,8 @@ module RuboCop
 
         def_node_search :action_controller?, <<~PATTERN
           {
-            (const nil? :ApplicationController)
-            (const (const nil? :ActionController) :Base)
+            (const {nil? cbase} :ApplicationController)
+            (const (const {nil? cbase} :ActionController) :Base)
           }
         PATTERN
 
@@ -69,9 +69,12 @@ module RuboCop
         def followed_by_render?(flash_node)
           flash_assigment_node = find_ancestor(flash_node, type: :send)
           context = flash_assigment_node
-          context = context.parent if context.parent.if_type?
+          if (if_node = context.each_ancestor(:if).first)
+            context = if_node
+          elsif context.right_siblings.empty?
+            return true
+          end
           context = context.right_siblings
-          return true if context.empty?
 
           context.compact.any? do |node|
             render?(node)

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

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

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

@@ -6,7 +6,8 @@ module RuboCop
       # 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.
+      # All other methods are ignored. So, the actions specified in `ExpectedOrder` should be
+      # defined before actions not specified.
       #
       # [source,yaml]
       # ----
@@ -35,6 +36,7 @@ module RuboCop
         extend AutoCorrector
         include VisibilityHelp
         include DefNode
+        include RangeHelp
 
         MSG = 'Action `%<current>s` should appear before `%<previous>s`.'
 
@@ -71,9 +73,43 @@ module RuboCop
             current: current.method_name
           )
           add_offense(current, message: message) do |corrector|
-            corrector.replace(current, previous.source)
-            corrector.replace(previous, current.source)
+            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)
+          ranges = [
+            node,
+            *processed_source.ast_with_comments[node]
+          ].map do |element|
+            element.location.expression
           end
+          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

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

@@ -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

@@ -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

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

@@ -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

@@ -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/content_tag.rb

@@ -81,7 +81,7 @@ module RuboCop
         def allowed_name?(argument)
           return false unless argument.str_type? || argument.sym_type?
 
-          !/^[a-zA-Z\-][a-zA-Z\-0-9]*$/.match?(argument.value)
+          !/^[a-zA-Z-][a-zA-Z\-0-9]*$/.match?(argument.value)
         end
 
         def correction_range(node)

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

@@ -24,7 +24,7 @@ module RuboCop
         TRANSLATE_METHODS = %i[translate t].freeze
 
         def_node_matcher :translate_with_scope?, <<~PATTERN
-          (send {nil? (const nil? :I18n)} {:translate :t} ${sym_type? str_type?}
+          (send {nil? (const {nil? cbase} :I18n)} {:translate :t} ${sym_type? str_type?}
             (hash <$(pair (sym :scope) ${array_type? sym_type?}) ...>)
           )
         PATTERN

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

@@ -70,8 +70,8 @@ module RuboCop
         #   @return [Boolean] true if matches
         def_node_matcher :time_current?, <<~PATTERN
           {
-            (send (const _ :Time) :current)
-            (send (send (const _ :Time) :zone) :now)
+            (send (const {nil? cbase} :Time) :current)
+            (send (send (const {nil? cbase} :Time) :zone) :now)
           }
         PATTERN
 

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

@@ -53,7 +53,7 @@ module RuboCop
           method_name = node.method_name
           static_name = static_method_name(method_name)
           return unless static_name
-          return if node.arguments.any? { |argument| IGNORED_ARGUMENT_TYPES.include?(argument.type) }
+          return unless dynamic_find_by_arguments?(node)
 
           message = format(MSG, static_name: static_name, method: method_name)
           add_offense(node, message: message) do |corrector|
@@ -65,12 +65,8 @@ module RuboCop
         private
 
         def autocorrect(corrector, node)
-          keywords = column_keywords(node.method_name)
-
-          return if keywords.size != node.arguments.size
-
           autocorrect_method_name(corrector, node)
-          autocorrect_argument_keywords(corrector, node, keywords)
+          autocorrect_argument_keywords(corrector, node, column_keywords(node.method_name))
         end
 
         def allowed_invocation?(node)
@@ -120,6 +116,20 @@ module RuboCop
 
           match[2] ? 'find_by!' : 'find_by'
         end
+
+        def dynamic_find_by_arguments?(node)
+          dynamic_find_by_arguments_count?(node) && dynamic_find_by_arguments_type?(node)
+        end
+
+        def dynamic_find_by_arguments_count?(node)
+          column_keywords(node.method_name).size == node.arguments.size
+        end
+
+        def dynamic_find_by_arguments_type?(node)
+          node.arguments.none? do |argument|
+            IGNORED_ARGUMENT_TYPES.include?(argument.type)
+          end
+        end
       end
     end
   end

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

@@ -34,15 +34,15 @@ module RuboCop
         RESTRICT_ON_SEND = %i[join].freeze
 
         def_node_matcher :file_join_nodes?, <<~PATTERN
-          (send (const nil? :File) :join ...)
+          (send (const {nil? cbase} :File) :join ...)
         PATTERN
 
         def_node_search :rails_root_nodes?, <<~PATTERN
-          (send (const nil? :Rails) :root)
+          (send (const {nil? cbase} :Rails) :root)
         PATTERN
 
         def_node_matcher :rails_root_join_nodes?, <<~PATTERN
-          (send (send (const nil? :Rails) :root) :join ...)
+          (send #rails_root_nodes? :join ...)
         PATTERN
 
         def on_dstr(node)

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

@@ -29,17 +29,17 @@ module RuboCop
 
         MSG = 'Use `freeze_time` instead of `travel_to`.'
         NOW_METHODS = %i[now new current].freeze
-        CONV_METHODS = %i[to_time in_time_zone].freeze
+        CONVERT_METHODS = %i[to_time in_time_zone].freeze
         RESTRICT_ON_SEND = %i[travel_to].freeze
 
         # @!method time_now?(node)
         def_node_matcher :time_now?, <<~PATTERN
-          (const nil? {:Time :DateTime})
+          (const {nil? cbase} {:Time :DateTime})
         PATTERN
 
         # @!method zoned_time_now?(node)
         def_node_matcher :zoned_time_now?, <<~PATTERN
-          (send (const nil? :Time) :zone)
+          (send (const {nil? cbase} :Time) :zone)
         PATTERN
 
         def on_send(node)
@@ -63,9 +63,11 @@ module RuboCop
         end
 
         def current_time_with_convert?(node, method_name)
-          return false unless CONV_METHODS.include?(method_name)
+          return false unless CONVERT_METHODS.include?(method_name)
+
+          child_node, child_method_name, time_argument = *node.children
+          return if time_argument
 
-          child_node, child_method_name = *node.children
           current_time?(child_node, child_method_name)
         end
       end

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

@@ -37,7 +37,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[has_many has_one].freeze
 
         def_node_search :active_resource_class?, <<~PATTERN
-          (const (const nil? :ActiveResource) :Base)
+          (const (const {nil? cbase} :ActiveResource) :Base)
         PATTERN
 
         def_node_matcher :association_without_options?, <<~PATTERN

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

@@ -37,7 +37,7 @@ module RuboCop
         def_node_matcher :form_builder_class?, <<~PATTERN
           (const
             (const
-               (const nil? :ActionView) :Helpers) :FormBuilder)
+               (const {nil? cbase} :ActionView) :Helpers) :FormBuilder)
         PATTERN
 
         def on_ivar(node)

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

@@ -34,6 +34,8 @@ module RuboCop
 
         MSG = 'Use "lazy" lookup for the text used in controllers.'
 
+        RESTRICT_ON_SEND = %i[translate t].freeze
+
         def_node_matcher :translate_call?, <<~PATTERN
           (send nil? {:translate :t} ${sym_type? str_type?} ...)
         PATTERN

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

@@ -46,7 +46,7 @@ module RuboCop
 
         def_node_matcher :on_bad_hash_brackets_map, <<~PATTERN
           (send
-            (const _ :Hash)
+            (const {nil? cbase} :Hash)
             :[]
             (block
               (call _ {:map :collect})

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

@@ -49,7 +49,7 @@ module RuboCop
 
         def_node_matcher :on_bad_hash_brackets_map, <<~PATTERN
           (send
-            (const _ :Hash)
+            (const {nil? cbase} :Hash)
             :[]
             (block
               (call _ {:map :collect})

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

@@ -34,8 +34,8 @@ module RuboCop
 
         def_node_matcher :mailer_base_class?, <<~PATTERN
           {
-            (const (const nil? :ActionMailer) :Base)
-            (const nil? :ApplicationMailer)
+            (const (const {nil? cbase} :ActionMailer) :Base)
+            (const {nil? cbase} :ApplicationMailer)
           }
         PATTERN
 
@@ -44,7 +44,7 @@ module RuboCop
         PATTERN
 
         def_node_matcher :class_new_definition?, <<~PATTERN
-          (send (const nil? :Class) :new #mailer_base_class?)
+          (send (const {nil? cbase} :Class) :new #mailer_base_class?)
         PATTERN
 
         def on_class(node)

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

@@ -29,7 +29,7 @@ module RuboCop
 
           basename = basename_without_timestamp_and_suffix(processed_source.file_path)
 
-          class_identifier = node.identifier
+          class_identifier = node.identifier.location.name
           camelized_basename = camelize(basename)
           return if class_identifier.source.casecmp(camelized_basename).zero?
 

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

@@ -32,7 +32,7 @@ module RuboCop
           (send
             {
               (gvar #match_gvar?)
-              {(const nil? :STDOUT) (const nil? :STDERR)}
+              (const {nil? cbase} {:STDOUT :STDERR})
             }
             {:binwrite :syswrite :write :write_nonblock}
             ...)

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

@@ -26,7 +26,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[require_dependency].freeze
 
         def_node_matcher :require_dependency_call?, <<~PATTERN
-          (send {nil? (const _ :Kernel)} :require_dependency _)
+          (send {nil? (const {nil? cbase} :Kernel)} :require_dependency _)
         PATTERN
 
         def on_send(node)

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

@@ -163,12 +163,11 @@ module RuboCop
         def on_send(node)
           evidence(node) do |method, path, args, rails_root|
             add_offense(node, message: format(MSG, method: method, rails_root: rails_root.source)) do |corrector|
-              if dir_glob?(node)
-                replacement = build_path_glob(path, method)
-              else
-                replacement = "#{path.source}.#{method}"
-                replacement += "(#{args.map(&:source).join(', ')})" unless args.empty?
-              end
+              replacement = if dir_glob?(node)
+                              build_path_glob_replacement(path, method)
+                            else
+                              build_path_replacement(path, method, args)
+                            end
 
               corrector.replace(node, replacement)
             end
@@ -184,7 +183,7 @@ module RuboCop
           yield(method, path, args, rails_root)
         end
 
-        def build_path_glob(path, method)
+        def build_path_glob_replacement(path, method)
           receiver = range_between(path.loc.expression.begin_pos, path.children.first.loc.selector.end_pos).source
 
           argument = if path.arguments.one?
@@ -196,6 +195,18 @@ module RuboCop
           "#{receiver}.#{method}(#{argument})"
         end
 
+        def build_path_replacement(path, method, args)
+          path_replacement = path.source
+          if path.arguments? && !path.parenthesized_call?
+            path_replacement[' '] = '('
+            path_replacement << ')'
+          end
+
+          replacement = "#{path_replacement}.#{method}"
+          replacement += "(#{args.map(&:source).join(', ')})" unless args.empty?
+          replacement
+        end
+
         def include_interpolation?(arguments)
           arguments.any? do |argument|
             argument.children.any? { |child| child.respond_to?(:begin_type?) && child.begin_type? }

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

@@ -49,7 +49,7 @@ module RuboCop
         RESTRICT_ON_SEND = PREFERRED_METHODS.keys.freeze
 
         def_node_matcher :long_i18n?, <<~PATTERN
-          (send {nil? (const nil? :I18n)} ${:translate :localize} ...)
+          (send {nil? (const {nil? cbase} :I18n)} ${:translate :localize} ...)
         PATTERN
 
         def on_send(node)

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

@@ -57,7 +57,7 @@ module RuboCop
 
         def_node_matcher :good_touch?, <<~PATTERN
           {
-            (send (const nil? :FileUtils) :touch ...)
+            (send (const {nil? cbase} :FileUtils) :touch ...)
             (send _ :touch {true false})
           }
         PATTERN

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

@@ -23,7 +23,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[zone=].freeze
 
         def_node_matcher :time_zone_assignment?, <<~PATTERN
-          (send (const nil? :Time) :zone= ...)
+          (send (const {nil? cbase} :Time) :zone= ...)
         PATTERN
 
         def on_send(node)

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

@@ -21,6 +21,37 @@ module RuboCop
         extend AutoCorrector
         extend TargetRailsVersion
 
+        # These types are defined by the following files in ActiveSupport:
+        #   lib/active_support/core_ext/array/conversions.rb
+        #   lib/active_support/core_ext/date/conversions.rb
+        #   lib/active_support/core_ext/date_time/conversions.rb
+        #   lib/active_support/core_ext/numeric/conversions.rb
+        #   lib/active_support/core_ext/range/conversions.rb
+        #   lib/active_support/core_ext/time/conversions.rb
+        #   lib/active_support/time_with_zone.rb
+        EXTENDED_FORMAT_TYPES = Set.new(
+          %i[
+            currency
+            db
+            delimited
+            human
+            human_size
+            inspect
+            iso8601
+            long
+            long_ordinal
+            nsec
+            number
+            percentage
+            phone
+            rfc822
+            rounded
+            short
+            time
+            usec
+          ]
+        )
+
         MSG = 'Use `to_formatted_s` instead.'
 
         RESTRICT_ON_SEND = %i[to_s].freeze
@@ -28,13 +59,19 @@ module RuboCop
         minimum_target_rails_version 7.0
 
         def on_send(node)
-          return if node.arguments.empty?
+          return unless rails_extended_to_s?(node)
 
           add_offense(node.loc.selector) do |corrector|
             corrector.replace(node.loc.selector, 'to_formatted_s')
           end
         end
         alias on_csend on_send
+
+        private
+
+        def rails_extended_to_s?(node)
+          node.first_argument&.sym_type? && EXTENDED_FORMAT_TYPES.include?(node.first_argument.value)
+        end
       end
     end
   end

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.17.2'
+      STRING = '2.17.3'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.17.2
+  version: 2.17.3
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2022-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport