rubocop-rails 2.9.0 → 2.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b997fb5d9995a5c7db5d151e13b86cf0dbd2b27f890e9ad116d11fab30a1b7e0
-  data.tar.gz: 91c6b0a496bcbe9c92b0833944b301e893c9f9ee6e75db0fb393436c9869dc81
+  metadata.gz: bfb9c60dfc813cddff8b72b3f19b337ec3a6570f6210398841ed3852d9dcfad1
+  data.tar.gz: 4d026033a03b8f08ccf51e9503cd83c0266132e677478732b64b4fdbe664b02a
 SHA512:
-  metadata.gz: d59f7cbb8d1f311bcdda8eda6c1c55d5cbc772993cac726f6d16d1947ca324b95354e24770140d3fce1a860cd2b4995d55c78e946c21ed85c9f4964b4d908794
-  data.tar.gz: 891fc8896d26423f80edd9db48e75c065c3e46ccb03a534f182dd3af928b19165e7d2d259cd842b1222a729ba4e234d461e370327db4bb520673ab61071e0e89
+  metadata.gz: 1fbc8870d37ee91a53e15f1d067517f8430cd9a0bb383bf27c80c4f84db32ded964c3f345caa6d026aaba187f3e7c78d6a838824433b16d3e9cac9ed7ecd337c
+  data.tar.gz: 0cf8c155c3b987a10f581d4983240696fa444d7157e54e4bb2d2ac616721e80a4dacd264e32d15a0165e66d7d1511d97b9c8a07d4e94e1e41accfc71b7803228

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-20 Bozhidar Batsov
+Copyright (c) 2012-21 Bozhidar Batsov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,9 +1,9 @@
 # RuboCop Rails
 
 [![Gem Version](https://badge.fury.io/rb/rubocop-rails.svg)](https://badge.fury.io/rb/rubocop-rails)
-[![CircleCI](https://circleci.com/gh/rubocop-hq/rubocop-rails.svg?style=svg)](https://circleci.com/gh/rubocop-hq/rubocop-rails)
+[![CircleCI](https://circleci.com/gh/rubocop/rubocop-rails.svg?style=svg)](https://circleci.com/gh/rubocop/rubocop-rails)
 
-A [RuboCop](https://github.com/rubocop-hq/rubocop) extension focused on enforcing Rails best practices and coding conventions.
+A [RuboCop](https://github.com/rubocop/rubocop) extension focused on enforcing Rails best practices and coding conventions.
 
 Note: This repository manages rubocop-rails gem (>= 2.0.0). rubocop-rails gem (<= 1.5.0) has been renamed to [rubocop-rails_config](https://rubygems.org/gems/rubocop-rails_config) gem.
 
@@ -90,14 +90,14 @@ Rails cops support the following versions:
 
 If you use RuboCop Rails in your project, you can include one of these badges in your readme to let people know that your code is written following the community Rails Style Guide.
 
-[![Rails Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop-rails)
+[![Rails Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop-rails)
 
 [![Rails Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://rails.rubystyle.guide)
 
 Here are the Markdown snippets for the two badges:
 
 ``` markdown
-[![Rails Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop-rails)
+[![Rails Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop-rails)
 
 [![Rails Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://rails.rubystyle.guide)
 ```

data/config/default.yml

@@ -17,6 +17,27 @@ AllCops:
   # as the default.
   TargetRailsVersion: ~
 
+Lint/NumberConversion:
+  # Add Rails' duration methods to the ignore list for `Lint/NumberConversion`
+  # so that calling `to_i` on one of these does not register an offense.
+  # See: https://github.com/rubocop/rubocop/issues/8950
+  IgnoredMethods:
+    - ago
+    - from_now
+    - second
+    - seconds
+    - minute
+    - minutes
+    - hour
+    - hours
+    - day
+    - days
+    - week
+    - weeks
+    - fortnight
+    - fortnights
+    - in_milliseconds
+
 Rails/ActionFilter:
   Description: 'Enforces consistent use of action filter methods.'
   Enabled: true
@@ -62,6 +83,16 @@ Rails/ActiveSupportAliases:
   Enabled: true
   VersionAdded: '0.48'
 
+Rails/AddColumnIndex:
+  Description: >-
+    Rails migrations don't make use of a given `index` key, but also
+    doesn't given an error when it's used, so it makes it seem like an
+    index might be used.
+  Enabled: pending
+  VersionAdded: '2.11'
+  Include:
+    - db/migrate/*.rb
+
 Rails/AfterCommitOverride:
   Description: >-
                   This cop enforces that there is only one call to `after_commit`
@@ -128,8 +159,9 @@ Rails/BelongsTo:
 Rails/Blank:
   Description: 'Enforces use of `blank?`.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.48'
-  VersionChanged: '0.67'
+  VersionChanged: '2.10'
   # Convert usages of `nil? || empty?` to `blank?`
   NilOrEmpty: true
   # Convert usages of `!present?` to `blank?`
@@ -171,7 +203,7 @@ Rails/Date:
                   such as Date.today, Date.current etc.
   Enabled: true
   VersionAdded: '0.30'
-  VersionChanged: '0.33'
+  VersionChanged: '2.11'
   # The value `strict` disallows usage of `Date.today`, `Date.current`,
   # `Date#to_time` etc.
   # The value `flexible` allows usage of `Date.current`, `Date.yesterday`, etc
@@ -181,6 +213,7 @@ Rails/Date:
   SupportedStyles:
     - strict
     - flexible
+  AllowToTime: true
 
 Rails/DefaultScope:
   Description: 'Avoid use of `default_scope`.'
@@ -207,8 +240,9 @@ Rails/DynamicFindBy:
   Description: 'Use `find_by` instead of dynamic `find_by_*`.'
   StyleGuide: 'https://rails.rubystyle.guide#find_by'
   Enabled: true
+  Safe: false
   VersionAdded: '0.44'
-  VersionChanged: '2.6'
+  VersionChanged: '2.10'
   # The `Whitelist` has been deprecated, Please use `AllowedMethods` instead.
   Whitelist:
     - find_by_sql
@@ -217,6 +251,12 @@ Rails/DynamicFindBy:
   AllowedReceivers:
     - Gem::Specification
 
+Rails/EagerEvaluationLogMessage:
+  Description: 'Checks that blocks are used for interpolated strings passed to `Rails.logger.debug`.'
+  Reference: 'https://guides.rubyonrails.org/debugging_rails_applications.html#impact-of-logs-on-performance'
+  Enabled: pending
+  VersionAdded: '2.11'
+
 Rails/EnumHash:
   Description: 'Prefer hash syntax over array syntax when defining enums.'
   StyleGuide: 'https://rails.rubystyle.guide#enums'
@@ -237,6 +277,20 @@ Rails/EnvironmentComparison:
   Enabled: true
   VersionAdded: '0.52'
 
+Rails/EnvironmentVariableAccess:
+  Description: 'Do not access `ENV` directly after initialization.'
+  # TODO: Set to `pending` status in RuboCop Rails 2 series when migration doc will be written.
+  Enabled: false
+  VersionAdded: '2.10'
+  VersionChanged: '2.11'
+  Include:
+    - app/**/*.rb
+    - lib/**/*.rb
+  Exclude:
+    - lib/**/*.rake
+  AllowReads: false
+  AllowWrites: false
+
 Rails/Exit:
   Description: >-
                   Favor `fail`, `break`, `return`, etc. over `exit` in
@@ -251,6 +305,11 @@ Rails/Exit:
   Exclude:
     - lib/**/*.rake
 
+Rails/ExpandedDateRange:
+  Description: 'Checks for expanded date range.'
+  Enabled: pending
+  VersionAdded: '2.11'
+
 Rails/FilePath:
   Description: 'Use `Rails.root.join` for file path joining.'
   Enabled: true
@@ -266,6 +325,8 @@ Rails/FindBy:
   StyleGuide: 'https://rails.rubystyle.guide#find_by'
   Enabled: true
   VersionAdded: '0.30'
+  VersionChanged: '2.11'
+  IgnoreWhereFirst: true
   Include:
     - app/models/**/*.rb
 
@@ -327,11 +388,20 @@ Rails/HttpStatus:
   Description: 'Enforces use of symbolic or numeric value to define HTTP status.'
   Enabled: true
   VersionAdded: '0.54'
+  VersionChanged: '2.11'
   EnforcedStyle: symbolic
   SupportedStyles:
     - numeric
     - symbolic
 
+Rails/I18nLocaleAssignment:
+  Description: 'Prefer the usage of `I18n.with_locale` instead of manually updating `I18n.locale` value.'
+  Enabled: 'pending'
+  VersionAdded: '2.11'
+  Include:
+    - spec/**/*.rb
+    - test/**/*.rb
+
 Rails/IgnoredSkipActionFilterOption:
   Description: 'Checks that `if` and `only` (or `except`) are not used together as options of `skip_*` action filter.'
   Reference: 'https://api.rubyonrails.org/classes/AbstractController/Callbacks/ClassMethods.html#method-i-_normalize_callback_options'
@@ -540,7 +610,9 @@ Rails/RedundantReceiverInWithOptions:
 Rails/ReflectionClassName:
   Description: 'Use a string for `class_name` option value in the definition of a reflection.'
   Enabled: true
+  Safe: false
   VersionAdded: '0.64'
+  VersionChanged: '2.10'
 
 Rails/RefuteMethods:
   Description: 'Use `assert_not` methods instead of `refute` methods.'
@@ -583,6 +655,12 @@ Rails/RequestReferer:
     - referer
     - referrer
 
+Rails/RequireDependency:
+  Description: 'Do not use `require_dependency` when running in Zeitwerk mode. `require_dependency` is for autoloading in classic mode.'
+  Reference: 'https://guides.rubyonrails.org/autoloading_and_reloading_constants.html'
+  Enabled: false
+  VersionAdded: '2.10'
+
 Rails/ReversibleMigration:
   Description: 'Checks whether the change method of the migration file is reversible.'
   StyleGuide: 'https://rails.rubystyle.guide#reversible-migration'
@@ -592,6 +670,13 @@ Rails/ReversibleMigration:
   Include:
     - db/migrate/*.rb
 
+Rails/ReversibleMigrationMethodDefinition:
+  Description: 'Checks whether the migration implements either a `change` method or both an `up` and a `down` method.'
+  Enabled: false
+  VersionAdded: '2.10'
+  Include:
+    - db/migrate/*.rb
+
 Rails/SafeNavigation:
   Description: "Use Ruby's safe navigation operator (`&.`) instead of `try!`."
   Enabled: true
@@ -687,13 +772,24 @@ Rails/TimeZone:
   Enabled: true
   Safe: false
   VersionAdded: '0.30'
-  VersionChanged: '0.68'
+  VersionChanged: '2.10'
   # The value `strict` means that `Time` should be used with `zone`.
   # The value `flexible` allows usage of `in_time_zone` instead of `zone`.
   EnforcedStyle: flexible
   SupportedStyles:
     - strict
     - flexible
+  Exclude:
+    - '**/*.gemspec'
+
+Rails/TimeZoneAssignment:
+  Description: 'Prefer the usage of `Time.use_zone` instead of manually updating `Time.zone` value.'
+  Reference: 'https://thoughtbot.com/blog/its-about-time-zones'
+  Enabled: 'pending'
+  VersionAdded: '2.10'
+  Include:
+    - spec/**/*.rb
+    - test/**/*.rb
 
 Rails/UniqBeforePluck:
   Description: 'Prefer the use of uniq or distinct before pluck.'
@@ -723,6 +819,13 @@ Rails/UnknownEnv:
     - test
     - production
 
+Rails/UnusedIgnoredColumns:
+  Description: 'Remove a column that does not exist from `ignored_columns`.'
+  Enabled: pending
+  VersionAdded: '2.11'
+  Include:
+    - app/models/**/*.rb
+
 Rails/Validation:
   Description: 'Use validates :attribute, hash of validations.'
   Enabled: true
@@ -735,17 +838,20 @@ Rails/WhereEquals:
   Description: 'Pass conditions to `where` as a hash instead of manually constructing SQL.'
   StyleGuide: 'https://rails.rubystyle.guide/#hash-conditions'
   Enabled: 'pending'
+  SafeAutoCorrect: false
   VersionAdded: '2.9'
+  VersionChanged: '2.10'
 
 Rails/WhereExists:
   Description: 'Prefer `exists?(...)` over `where(...).exists?`.'
   Enabled: 'pending'
+  SafeAutoCorrect: false
   EnforcedStyle: exists
   SupportedStyles:
     - exists
     - where
   VersionAdded: '2.7'
-  VersionChanged: '2.8'
+  VersionChanged: '2.10'
 
 Rails/WhereNot:
   Description: 'Use `where.not(...)` instead of manually constructing negated SQL in `where`.'

data/config/obsoletion.yml

@@ -0,0 +1,7 @@
+#
+# Configuration for obsoletion.
+#
+# See: https://docs.rubocop.org/rubocop/extensions.html#config-obsoletions
+#
+extracted:
+  Rails/*: ~

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

@@ -8,6 +8,13 @@ module RuboCop
 
       WHERE_METHODS = %i[where rewhere].freeze
 
+      def_node_matcher :active_record?, <<~PATTERN
+        {
+          (const nil? :ApplicationRecord)
+          (const (const nil? :ActiveRecord) :Base)
+        }
+      PATTERN
+
       def_node_search :find_set_table_name, <<~PATTERN
         (send self :table_name= {str sym})
       PATTERN
@@ -16,6 +23,10 @@ module RuboCop
         (send nil? :belongs_to {str sym} ...)
       PATTERN
 
+      def inherit_active_record_base?(node)
+        node.each_ancestor(:class).any? { |class_node| active_record?(class_node.parent_class) }
+      end
+
       def external_dependency_checksum
         return @external_dependency_checksum if defined?(@external_dependency_checksum)
 

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop 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.
+      #
+      # @example
+      #   # bad (will not add an index)
+      #   add_column :table, :column, :integer, index: true
+      #
+      #   # good
+      #   add_column :table, :column, :integer
+      #   add_index :table, :column
+      #
+      class AddColumnIndex < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = '`add_column` does not accept an `index` key, use `add_index` instead.'
+        RESTRICT_ON_SEND = %i[add_column].freeze
+
+        # @!method add_column_with_index(node)
+        def_node_matcher :add_column_with_index, <<~PATTERN
+          (
+            send nil? :add_column $_table $_column
+              <(hash <$(pair {(sym :index) (str "index")} $_) ...>) ...>
+          )
+        PATTERN
+
+        def on_send(node)
+          table, column, pair, value = add_column_with_index(node)
+          return unless pair
+
+          add_offense(pair) do |corrector|
+            corrector.remove(index_range(pair))
+
+            add_index = "add_index #{table.source}, #{column.source}"
+            add_index_opts = ''
+
+            if value.hash_type?
+              hash = value.loc.expression.adjust(begin_pos: 1, end_pos: -1).source.strip
+              add_index_opts = ", #{hash}"
+            end
+
+            corrector.insert_after(node, "\n#{add_index}#{add_index_opts}")
+          end
+        end
+
+        private
+
+        def index_range(pair_node)
+          range_with_surrounding_comma(
+            range_with_surrounding_space(range: pair_node.loc.expression, side: :left),
+            :left
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -75,7 +75,7 @@ module RuboCop
         def on_send(node)
           default_attribute(node) do |attribute|
             value = attribute.children.last
-            return unless TYPE_OFFENDERS.any? { |type| value.type == type }
+            return unless TYPE_OFFENDERS.any?(value.type)
 
             add_offense(value) do |corrector|
               expression = default_attribute(node).children.last

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

@@ -68,7 +68,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[belongs_to].freeze
 
         def_node_matcher :match_belongs_to_with_options, <<~PATTERN
-          (send _ :belongs_to _
+          (send _ :belongs_to ...
             (hash <$(pair (sym :required) ${true false}) ...>)
           )
         PATTERN

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

@@ -6,6 +6,10 @@ module RuboCop
       # This cop checks for code that can be written with simpler conditionals
       # using `Object#blank?` defined by Active Support.
       #
+      # This cop is marked as unsafe auto-correction, because `' '.empty?` returns false,
+      # but `' '.blank?` returns true. Therefore, auto-correction is not compatible
+      # if the receiver is a non-empty blank string, tab, or newline meta characters.
+      #
       # 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

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

@@ -28,19 +28,34 @@ module RuboCop
         MSG = 'Use `tag` instead of `content_tag`.'
         RESTRICT_ON_SEND = %i[content_tag].freeze
 
+        def on_new_investigation
+          @corrected_nodes = nil
+        end
+
         def on_send(node)
           first_argument = node.first_argument
-          return unless first_argument
-
-          return if first_argument.variable? || first_argument.send_type? || first_argument.const_type?
+          return if !first_argument ||
+                    allowed_argument?(first_argument) ||
+                    corrected_ancestor?(node)
 
           add_offense(node) do |corrector|
             autocorrect(corrector, node)
+
+            @corrected_nodes ||= Set.new.compare_by_identity
+            @corrected_nodes.add(node)
           end
         end
 
         private
 
+        def corrected_ancestor?(node)
+          node.each_ancestor(:send).any? { |ancestor| @corrected_nodes&.include?(ancestor) }
+        end
+
+        def allowed_argument?(argument)
+          argument.variable? || argument.send_type? || argument.const_type? || argument.splat_type?
+        end
+
         def autocorrect(corrector, node)
           if method_name?(node.first_argument)
             range = correction_range(node)