rubocop-rails 2.12.4 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c247cc795386a013c8f1a9dd7a76a08ef8fbd3c729ebe69e2f99bcb28a7baf6
-  data.tar.gz: f85139a9ef4a5f1666672431285e6d34ca9a8c0a367bf6c1e2b8ed2d3d0acf63
+  metadata.gz: f12ec262c68bd72f514b80f2140b51278a947f21726ef6307e6267eaec7df4ae
+  data.tar.gz: 2a09b4db338465d1904a19e8d4af871ba485e75244613299fabe473854125e4c
 SHA512:
-  metadata.gz: cd4893d903809e187a9094f84a14209aecfc931e4773df64e1c5a05c94fce22305ca0b0c899881545e697ceae8c6facb3400d0dc41415fed57a3b07244b7fdff
-  data.tar.gz: 91832638f61072047b0cf11b300d7be679a8fc7f708dc47cb5769eb1cd7852c8caf70452d6297cca122af4a53fd0599605d7221a8fc647e96352934fb0828684
+  metadata.gz: fbf73dc2e978bc210e2dc190b8042720f24e6e374962b2873e6c29ec989ed2a7c1b05646c22a38d57f28e753104ac40a0e592730e63703d99dbb80fc6b498651
+  data.tar.gz: b70e78355a3fa5b09f3a2a1603c71b16547c3f2f80c0ce7c2dbbc3c38cae0a0ca9464a50895eb54ac8ccd558c9259bf28a1e4ebebb9e3d4f05102832f178fc11

data/config/default.yml

@@ -180,6 +180,12 @@ Rails/BulkChangeTable:
   Include:
     - db/migrate/*.rb
 
+Rails/CompactBlank:
+  Description: 'Checks if collection can be blank-compacted with `compact_blank`.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '2.13'
+
 Rails/ContentTag:
   Description: 'Use `tag.something` instead of `tag(:something)`.'
   Reference:
@@ -245,6 +251,12 @@ Rails/DelegateAllowBlank:
   Enabled: true
   VersionAdded: '0.44'
 
+Rails/DurationArithmetic:
+  Description: 'Do not use duration as arithmetic operand with `Time.current`.'
+  StyleGuide: 'https://rails.rubystyle.guide#duration-arithmetic'
+  Enabled: pending
+  VersionAdded: '2.13'
+
 Rails/DynamicFindBy:
   Description: 'Use `find_by` instead of dynamic `find_by_*`.'
   StyleGuide: 'https://rails.rubystyle.guide#find_by'
@@ -612,6 +624,11 @@ Rails/RedundantForeignKey:
   Enabled: true
   VersionAdded: '2.6'
 
+Rails/RedundantPresenceValidationOnBelongsTo:
+  Description: 'Checks for redundant presence validation on belongs_to association.'
+  Enabled: pending
+  VersionAdded: '2.13'
+
 Rails/RedundantReceiverInWithOptions:
   Description: 'Checks for redundant receiver in `with_options`.'
   Enabled: true
@@ -646,9 +663,9 @@ Rails/RefuteMethods:
 Rails/RelativeDateConstant:
   Description: 'Do not assign relative date to constants.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.48'
-  VersionChanged: '0.59'
-  AutoCorrect: false
+  VersionChanged: '2.13'
 
 Rails/RenderInline:
   Description: 'Prefer using a template over inline rendering.'
@@ -695,6 +712,11 @@ Rails/ReversibleMigrationMethodDefinition:
   Include:
     - db/migrate/*.rb
 
+Rails/RootJoinChain:
+  Description: 'Use a single `#join` instead of chaining on `Rails.root` or `Rails.public_path`.'
+  Enabled: pending
+  VersionAdded: '2.13'
+
 Rails/SafeNavigation:
   Description: "Use Ruby's safe navigation operator (`&.`) instead of `try!`."
   Enabled: true
@@ -727,6 +749,13 @@ Rails/SaveBang:
   AllowedReceivers: []
   SafeAutoCorrect: false
 
+Rails/SchemaComment:
+  Description: >-
+    This cop enforces the use of the `comment` option when adding a new table or column
+    to the database during a migration.
+  Enabled: false
+  VersionAdded: '2.13'
+
 Rails/ScopeArgs:
   Description: 'Checks the arguments of ActiveRecord scopes.'
   Enabled: true
@@ -789,9 +818,9 @@ Rails/TimeZone:
   StyleGuide: 'https://rails.rubystyle.guide#time'
   Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
   Enabled: true
-  Safe: false
+  SafeAutoCorrect: false
   VersionAdded: '0.30'
-  VersionChanged: '2.10'
+  VersionChanged: '2.13'
   # 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
@@ -814,13 +843,12 @@ Rails/UniqBeforePluck:
   Description: 'Prefer the use of uniq or distinct before pluck.'
   Enabled: true
   VersionAdded: '0.40'
-  VersionChanged: '2.8'
+  VersionChanged: '2.13'
   EnforcedStyle: conservative
   SupportedStyles:
     - conservative
     - aggressive
   SafeAutoCorrect: false
-  AutoCorrect: false
 
 Rails/UniqueValidationWithoutIndex:
   Description: 'Uniqueness validation should have a unique index on the database column.'

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # A mixin to extend cops for Active Record features
+    module ActiveRecordMigrationsHelper
+      extend NodePattern::Macros
+
+      RAILS_ABSTRACT_SCHEMA_DEFINITIONS = %i[
+        bigint binary boolean date datetime decimal float integer json string
+        text time timestamp virtual
+      ].freeze
+      RAILS_ABSTRACT_SCHEMA_DEFINITIONS_HELPERS = %i[
+        column references belongs_to primary_key numeric
+      ].freeze
+      POSTGRES_SCHEMA_DEFINITIONS = %i[
+        bigserial bit bit_varying cidr citext daterange hstore inet interval
+        int4range int8range jsonb ltree macaddr money numrange oid point line
+        lseg box path polygon circle serial tsrange tstzrange tsvector uuid xml
+      ].freeze
+      MYSQL_SCHEMA_DEFINITIONS = %i[
+        blob tinyblob mediumblob longblob tinytext mediumtext longtext
+        unsigned_integer unsigned_bigint unsigned_float unsigned_decimal
+      ].freeze
+
+      def_node_matcher :create_table_with_block?, <<~PATTERN
+        (block
+          (send nil? :create_table ...)
+          (args (arg _var))
+          _)
+      PATTERN
+    end
+  end
+end

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

@@ -6,6 +6,10 @@ module RuboCop
       # Checks that ActiveRecord aliases are not used. The direct method names
       # are more clear and easier to read.
       #
+      # @safety
+      #   This cop is unsafe because custom `update_attributes` method call was changed to
+      #   `update` but the method name remained same in the method definition.
+      #
       # @example
       #   #bad
       #   book.update_attributes!(author: 'Alice')

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

@@ -3,7 +3,11 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that controllers subclass ApplicationController.
+      # This cop checks that controllers subclass `ApplicationController`.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because it may let the logic from `ApplicationController`
+      #   sneak into a controller that is not purposed to inherit logic common among other controllers.
       #
       # @example
       #

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

@@ -3,7 +3,11 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that jobs subclass ApplicationJob with Rails 5.0.
+      # This cop checks that jobs subclass `ApplicationJob` with Rails 5.0.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because it may let the logic from `ApplicationJob`
+      #   sneak into a job that is not purposed to inherit logic common among other jobs.
       #
       # @example
       #

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

@@ -3,7 +3,11 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that mailers subclass ApplicationMailer with Rails 5.0.
+      # This cop checks that mailers subclass `ApplicationMailer` with Rails 5.0.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because it may let the logic from `ApplicationMailer`
+      #   sneak into a mailer that is not purposed to inherit logic common among other mailers.
       #
       # @example
       #

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

@@ -3,7 +3,12 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that models subclass ApplicationRecord with Rails 5.0.
+      # This cop checks that models subclass `ApplicationRecord` with Rails 5.0.
+      #
+      # @safety
+      #   This cop's autocorrection is unsafe because it may let the logic from `ApplicationRecord`
+      #   sneak into an Active Record model that is not purposed to inherit logic common among other
+      #   Active Record models.
       #
       # @example
       #

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

@@ -10,6 +10,12 @@ module RuboCop
       # database to look for a column named <tt>`*`</tt> (or `"*"`) as opposed
       # to expanding the column list as one would likely expect.
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because it turns a quoted `*` into
+      #   an SQL `*`, unquoted. `*` is a valid column name in certain databases
+      #   supported by Rails, and even though it is usually a mistake,
+      #   it might denote legitimate access to a column named `*`.
+      #
       # @example
       #   # bad
       #   MyTable.arel_table["*"]

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

@@ -6,15 +6,16 @@ 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
       # to prevent interference between the auto-correction 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
+      #   if the receiver is a non-empty blank string, tab, or newline meta characters.
+      #
       # @example NilOrEmpty: true (default)
       #   # Converts usages of `nil? || empty?` to `blank?`
       #

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Checks if collection can be blank-compacted with `compact_blank`.
+      #
+      # @safety
+      #   It is unsafe by default because false positives may occur in the
+      #   blank check of block arguments to the receiver object.
+      #
+      #   For example, `[[1, 2], [3, nil]].reject { |first, second| second.blank? }` and
+      #   `[[1, 2], [3, nil]].compact_blank` are not compatible. The same is true for `empty?`.
+      #   This will work fine when the receiver is a hash object.
+      #
+      # @example
+      #
+      #   # bad
+      #   collection.reject(&:blank?)
+      #   collection.reject(&:empty?)
+      #   collection.reject { |_k, v| v.blank? }
+      #   collection.reject { |_k, v| v.empty? }
+      #
+      #   # good
+      #   collection.compact_blank
+      #
+      #   # bad
+      #   collection.reject!(&:blank?)
+      #   collection.reject!(&:empty?)
+      #   collection.reject! { |_k, v| v.blank? }
+      #   collection.reject! { |_k, v| v.empty? }
+      #
+      #   # good
+      #   collection.compact_blank!
+      #
+      class CompactBlank < Base
+        include RangeHelp
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        MSG = 'Use `%<preferred_method>s` instead.'
+        RESTRICT_ON_SEND = %i[reject reject!].freeze
+
+        minimum_target_rails_version 6.1
+
+        def_node_matcher :reject_with_block?, <<~PATTERN
+          (block
+            (send _ {:reject :reject!})
+            $(args ...)
+            (send
+              $(lvar _) {:blank? :empty?}))
+        PATTERN
+
+        def_node_matcher :reject_with_block_pass?, <<~PATTERN
+          (send _ {:reject :reject!}
+            (block_pass
+              (sym {:blank? :empty?})))
+        PATTERN
+
+        def on_send(node)
+          return unless bad_method?(node)
+
+          range = offense_range(node)
+          preferred_method = preferred_method(node)
+          add_offense(range, message: format(MSG, preferred_method: preferred_method)) do |corrector|
+            corrector.replace(range, preferred_method)
+          end
+        end
+
+        private
+
+        def bad_method?(node)
+          return true if reject_with_block_pass?(node)
+
+          if (arguments, receiver_in_block = reject_with_block?(node.parent))
+            return arguments.length == 1 || use_hash_value_block_argument?(arguments, receiver_in_block)
+          end
+
+          false
+        end
+
+        def use_hash_value_block_argument?(arguments, receiver_in_block)
+          arguments.length == 2 && arguments[1].source == receiver_in_block.source
+        end
+
+        def offense_range(node)
+          end_pos = node.parent&.block_type? ? node.parent.loc.expression.end_pos : node.loc.expression.end_pos
+
+          range_between(node.loc.selector.begin_pos, end_pos)
+        end
+
+        def preferred_method(node)
+          node.method?(:reject) ? 'compact_blank' : 'compact_blank!'
+        end
+      end
+    end
+  end
+end

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

@@ -6,8 +6,8 @@ module RuboCop
       # This cop checks legacy syntax usage of `tag`
       #
       # NOTE: Allow `tag` when the first argument is a variable because
-      #       `tag(name)` is simpler rather than `tag.public_send(name)`.
-      #       And this cop will be renamed to something like `LegacyTag` in the future. (e.g. RuboCop Rails 2.0)
+      # `tag(name)` is simpler rather than `tag.public_send(name)`.
+      # And this cop will be renamed to something like `LegacyTag` in the future. (e.g. RuboCop Rails 2.0)
       #
       # @example
       #  # bad

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

@@ -41,16 +41,11 @@ module RuboCop
       #     t.datetime :updated_at, default: -> { 'CURRENT_TIMESTAMP' }
       #   end
       class CreateTableWithTimestamps < Base
+        include ActiveRecordMigrationsHelper
+
         MSG = 'Add timestamps when creating a new table.'
         RESTRICT_ON_SEND = %i[create_table].freeze
 
-        def_node_matcher :create_table_with_block?, <<~PATTERN
-          (block
-            (send nil? :create_table ...)
-            (args (arg _var))
-            _)
-        PATTERN
-
         def_node_matcher :create_table_with_timestamps_proc?, <<~PATTERN
           (send nil? :create_table (sym _) ... (block-pass (sym :timestamps)))
         PATTERN

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks if a duration is added to or subtracted from `Time.current`.
+      #
+      # @example
+      #   # bad
+      #   Time.current - 1.minute
+      #   Time.current + 2.days
+      #
+      #   # good - using relative would make it harder to express and read
+      #   Date.yesterday + 3.days
+      #   created_at - 1.minute
+      #   3.days - 1.hour
+      #
+      #   # good
+      #   1.minute.ago
+      #   2.days.from_now
+      class DurationArithmetic < Base
+        extend AutoCorrector
+
+        MSG = 'Do not add or subtract duration.'
+
+        RESTRICT_ON_SEND = %i[+ -].freeze
+
+        DURATIONS = Set[:second, :seconds, :minute, :minutes, :hour, :hours,
+                        :day, :days, :week, :weeks, :fortnight, :fortnights]
+
+        # @!method duration_arithmetic_argument?(node)
+        #   Match duration subtraction or addition with current time.
+        #
+        #   @example source that matches
+        #     Time.current - 1.hour
+        #
+        #   @example source that matches
+        #     ::Time.zone.now + 1.hour
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @yield operator and duration
+        def_node_matcher :duration_arithmetic_argument?, <<~PATTERN
+          (send #time_current? ${ :+ :- } $#duration?)
+        PATTERN
+
+        # @!method duration?(node)
+        #   Match a literal Duration
+        #
+        #   @example source that matches
+        #     1.hour
+        #
+        #   @example source that matches
+        #     9.5.weeks
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Boolean] true if matches
+        def_node_matcher :duration?, '(send { int float (send nil _) } DURATIONS)'
+
+        # @!method time_current?(node)
+        #   Match Time.current
+        #
+        #   @example source that matches
+        #     Time.current
+        #
+        #   @example source that matches
+        #     ::Time.zone.now
+        #
+        #   @param node [RuboCop::AST::Node]
+        #   @return [Boolean] true if matches
+        def_node_matcher :time_current?, <<~PATTERN
+          {
+            (send (const _ :Time) :current)
+            (send (send (const _ :Time) :zone) :now)
+          }
+        PATTERN
+
+        def on_send(node)
+          duration_arithmetic_argument?(node) do |*operation|
+            add_offense(node) do |corrector|
+              corrector.replace(node.source_range, corrected_source(*operation))
+            end
+          end
+        end
+
+        private
+
+        def corrected_source(operator, duration)
+          if operator == :-
+            "#{duration.source}.ago"
+          else
+            "#{duration.source}.from_now"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,6 +7,10 @@ module RuboCop
       # Use `find_by` instead of dynamic method.
       # See. https://rails.rubystyle.guide#find_by
       #
+      # @safety
+      #   It is certainly unsafe when not configured properly, i.e. user-defined `find_by_xxx`
+      #   method is not added to cop's `AllowedMethods`.
+      #
       # @example
       #   # bad
       #   User.find_by_name(name)

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

@@ -67,7 +67,7 @@ module RuboCop
         private
 
         def in_routing_block?(node)
-          !!node.each_ancestor(:block).detect { |block| ROUTING_METHODS.include?(block.send_node.method_name) }
+          !!node.each_ancestor(:block).detect { |block| ROUTING_METHODS.include?(block.method_name) }
         end
 
         def needs_conversion?(data)

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

@@ -6,13 +6,14 @@ module RuboCop
       # This cop checks that methods specified in the filter's `only` or
       # `except` options are defined within the same class or module.
       #
-      # You can technically specify methods of superclass or methods added by
-      # mixins on the filter, but these can confuse developers. If you specify
-      # methods that are defined in other classes or modules, you should
-      # define the filter in that class or module.
-      #
-      # If you rely on behaviour defined in the superclass actions, you must
-      # remember to invoke `super` in the subclass actions.
+      # @safety
+      #   You can technically specify methods of superclass or methods added by
+      #   mixins on the filter, but these can confuse developers. If you specify
+      #   methods that are defined in other classes or modules, you should
+      #   define the filter in that class or module.
+      #
+      #   If you rely on behaviour defined in the superclass actions, you must
+      #   remember to invoke `super` in the subclass actions.
       #
       # @example
       #   # bad

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

@@ -8,6 +8,10 @@ module RuboCop
       # Without the `Mailer` suffix it isn't immediately apparent what's a mailer
       # and which views are related to the mailer.
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because renaming a constant is
+      #   always an unsafe operation.
+      #
       # @example
       #   # bad
       #   class User < ActionMailer::Base

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

@@ -6,8 +6,9 @@ module RuboCop
       # This cop enforces the use of `collection.exclude?(obj)`
       # over `!collection.include?(obj)`.
       #
-      # It is marked as unsafe by default because false positive will occur for
-      # a receiver object that do not have `exclude?` method. (e.g. `IPAddr`)
+      # @safety
+      #   This cop is unsafe because false positive will occur for
+      #   receiver objects that do not have an `exclude?` method. (e.g. `IPAddr`)
       #
       # @example
       #   # bad

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

@@ -5,6 +5,10 @@ module RuboCop
     module Rails
       # This cop checks for the use of output calls like puts and print
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because depending on the Rails log level configuration,
+      #   changing from `puts` to `Rails.logger.debug` could result in no output being shown.
+      #
       # @example
       #   # bad
       #   puts 'A debug message'

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

@@ -9,6 +9,13 @@ 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.
       #
+      # @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
+      #   in Rails 6.1 via rails/rails#38760, at which point the cop is safe.
+      #
+      #   See: https://github.com/rubocop/rubocop-rails/pull/249
+      #
       # @example
       #   # bad
       #   Model.pluck(:a).first

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

@@ -5,6 +5,9 @@ module RuboCop
     module Rails
       # This cop enforces the use of `ids` over `pluck(:id)` and `pluck(primary_key)`.
       #
+      # @safety
+      #   This cop is unsafe if the receiver object is not an Active Record object.
+      #
       # @example
       #   # bad
       #   User.pluck(:id)

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

@@ -9,14 +9,15 @@ module RuboCop
       # Since `pluck` is an eager method and hits the database immediately,
       # using `select` helps to avoid additional database queries.
       #
-      # This cop has two different enforcement modes. When the EnforcedStyle
-      # is conservative (the default) then only calls to `pluck` on a constant
+      # 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.
       #
-      # 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.
+      # @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.
       #
       # @example
       #   # bad

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

@@ -14,6 +14,11 @@ module RuboCop
       # * The task does not need application code.
       # * The task invokes the `:environment` task.
       #
+      # @safety
+      #   Probably not a problem in most cases, but it is possible that calling `:environment` task
+      #   will break a behavior. It's also slower. E.g. some task that only needs one gem to be
+      #   loaded to run will run significantly faster without loading the whole application.
+      #
       # @example
       #   # bad
       #   task :foo do