rubocop-rails 2.11.3 → 2.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afc20a9d5f0799fab1f02a5a05c3b297a47b1713f6b948a25511da46b2e5a332
-  data.tar.gz: d71033e04f2cd0b1f7801d1ab80d99859af6e3d1bfba9551dec1d18a0e7b40dc
+  metadata.gz: f6f12cb9a10c2b1cf1ffe2a4713ccfdd4d88885378bde05d3988d829bf73218d
+  data.tar.gz: e60c60867234af9be31f066397aa23ddfedf8b167fa86269761717a81ad89f75
 SHA512:
-  metadata.gz: eab328cf38c0f4957b79c3722175edd1a259af69f6c7c4a4501bc72a245b70ef3d4290b4daf4ef6925bf643dcffb1370a50ccfc5e7e870e138c3df675598df54
-  data.tar.gz: 7fb02325ab085ed0d716718dc02da92b39da5710b117b49a722f8f0d4de4d2e47648278a39aff455b81d2186b4914eed7f797fbdfd86d2ff4ee570dc20543309
+  metadata.gz: b002f9f18331d8f4fe34f69dd0226e2ae607e632360e370dec3b5f2df39e4c1d10426ca5b9a574f83d579a841e705cb8b2332b6a2956dc76f6b130d56f824b30
+  data.tar.gz: 5e84d9ed3b6a8991fa8b905d38e30a6c26828d8b9a73b0db552485872b0a31bff17aab3b6109170a98950b132eb1929be16552b27143f56567daf4e2ef9e7d16

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'irb'
+require 'rubocop'
+require 'rubocop-rails'
+
+ARGV.clear
+
+IRB.start(__FILE__)

data/config/default.yml

@@ -9,7 +9,7 @@ AllCops:
     - bin/*
     - db/schema.rb
   # What version of Rails is the inspected code using?  If a value is specified
-  # for TargetRailsVersion then it is used.  Acceptable values are specificed
+  # for TargetRailsVersion then it is used.  Acceptable values are specified
   # as a float (i.e. 5.1); the patch version of Rails should not be included.
   # If TargetRailsVersion is not set, RuboCop will parse the Gemfile.lock or
   # gems.locked file to find the version of Rails that has been bound to the
@@ -181,12 +181,17 @@ Rails/BulkChangeTable:
     - db/migrate/*.rb
 
 Rails/ContentTag:
-  Description: 'Use `tag` instead of `content_tag`.'
+  Description: 'Use `tag.something` instead of `tag(:something)`.'
   Reference:
+    - 'https://github.com/rubocop/rubocop-rails/issues/260'
     - 'https://github.com/rails/rails/issues/25195'
     - 'https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-content_tag'
   Enabled: true
   VersionAdded: '2.6'
+  VersionChanged: '2.12'
+  # This `Exclude` config prevents false positives for `tag` calls to `has_one: tag`. No helpers are used in normal models.
+  Exclude:
+    - app/models/**/*.rb
 
 Rails/CreateTableWithTimestamps:
   Description: >-
@@ -196,6 +201,10 @@ Rails/CreateTableWithTimestamps:
   VersionAdded: '0.52'
   Include:
     - db/migrate/*.rb
+  Exclude:
+    # Respect the `active_storage_variant_records` table of `*_create_active_storage_tables.active_storage.rb`
+    # auto-generated by `bin/rails active_storage:install` even if `created_at` is not specified.
+    - db/migrate/*_create_active_storage_tables.active_storage.rb
 
 Rails/Date:
   Description: >-
@@ -499,6 +508,7 @@ Rails/OrderById:
 Rails/Output:
   Description: 'Checks for calls to puts, print, etc.'
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '0.15'
   VersionChanged: '0.19'
   Include:
@@ -607,6 +617,14 @@ Rails/RedundantReceiverInWithOptions:
   Enabled: true
   VersionAdded: '0.52'
 
+Rails/RedundantTravelBack:
+  Description: This cop checks for redundant `travel_back` calls.
+  Enabled: pending
+  VersionAdded: '2.12'
+  Include:
+    - spec/**/*.rb
+    - test/**/*.rb
+
 Rails/ReflectionClassName:
   Description: 'Use a string for `class_name` option value in the definition of a reflection.'
   Enabled: true
@@ -713,6 +731,7 @@ Rails/ScopeArgs:
   Description: 'Checks the arguments of ActiveRecord scopes.'
   Enabled: true
   VersionAdded: '0.19'
+  VersionChanged: '2.12'
   Include:
     - app/models/**/*.rb
 
@@ -804,7 +823,7 @@ Rails/UniqBeforePluck:
   AutoCorrect: false
 
 Rails/UniqueValidationWithoutIndex:
-  Description: 'Uniqueness validation should be with a unique index.'
+  Description: 'Uniqueness validation should have a unique index on the database column.'
   Enabled: true
   VersionAdded: '2.5'
   Include:

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

@@ -3,21 +3,21 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks that `tag` is used instead of `content_tag`
-      # because `content_tag` is legacy syntax.
+      # This cop checks legacy syntax usage of `tag`
       #
-      # NOTE: Allow `content_tag` when the first argument is a variable because
-      #      `content_tag(name)` is simpler rather than `tag.public_send(name)`.
+      # 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)
       #
       # @example
       #  # bad
-      #  content_tag(:p, 'Hello world!')
-      #  content_tag(:br)
+      #  tag(:p)
+      #  tag(:br, class: 'classname')
       #
       #  # good
-      #  tag.p('Hello world!')
-      #  tag.br
-      #  content_tag(name, 'Hello world!')
+      #  tag.p
+      #  tag.br(class: 'classname')
+      #  tag(name, class: 'classname')
       class ContentTag < Base
         include RangeHelp
         extend AutoCorrector
@@ -25,25 +25,26 @@ module RuboCop
 
         minimum_target_rails_version 5.1
 
-        MSG = 'Use `tag` instead of `content_tag`.'
-        RESTRICT_ON_SEND = %i[content_tag].freeze
+        MSG = 'Use `tag.%<preferred_method>s` instead of `tag(%<current_argument>s)`.'
+        RESTRICT_ON_SEND = %i[tag].freeze
 
         def on_new_investigation
           @corrected_nodes = nil
         end
 
         def on_send(node)
+          return unless node.receiver.nil?
+          return if node.arguments.count >= 3
+
           first_argument = node.first_argument
           return if !first_argument ||
                     allowed_argument?(first_argument) ||
                     corrected_ancestor?(node)
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
+          preferred_method = node.first_argument.value.to_s.underscore
+          message = format(MSG, preferred_method: preferred_method, current_argument: first_argument.source)
 
-            @corrected_nodes ||= Set.new.compare_by_identity
-            @corrected_nodes.add(node)
-          end
+          register_offense(node, message, preferred_method)
         end
 
         private
@@ -53,26 +54,35 @@ module RuboCop
         end
 
         def allowed_argument?(argument)
-          argument.variable? || argument.send_type? || argument.const_type? || argument.splat_type?
+          argument.variable? ||
+            argument.send_type? ||
+            argument.const_type? ||
+            argument.splat_type? ||
+            allowed_name?(argument)
         end
 
-        def autocorrect(corrector, node)
-          if method_name?(node.first_argument)
-            range = correction_range(node)
-
-            rest_args = node.arguments.drop(1)
-            replacement = "tag.#{node.first_argument.value.to_s.underscore}(#{rest_args.map(&:source).join(', ')})"
+        def register_offense(node, message, preferred_method)
+          add_offense(node, message: message) do |corrector|
+            autocorrect(corrector, node, preferred_method)
 
-            corrector.replace(range, replacement)
-          else
-            corrector.replace(node.loc.selector, 'tag')
+            @corrected_nodes ||= Set.new.compare_by_identity
+            @corrected_nodes.add(node)
           end
         end
 
-        def method_name?(node)
-          return false unless node.str_type? || node.sym_type?
+        def autocorrect(corrector, node, preferred_method)
+          range = correction_range(node)
+
+          rest_args = node.arguments.drop(1)
+          replacement = "tag.#{preferred_method}(#{rest_args.map(&:source).join(', ')})"
+
+          corrector.replace(range, replacement)
+        end
+
+        def allowed_name?(argument)
+          return false unless argument.str_type? || argument.sym_type?
 
-          /^[a-zA-Z_][a-zA-Z_\-0-9]*$/.match?(node.value)
+          !/^[a-zA-Z\-][a-zA-Z\-0-9]*$/.match?(argument.value)
         end
 
         def correction_range(node)

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

@@ -100,7 +100,7 @@ module RuboCop
 
         def method_name_matches?(method_name, body)
           method_name == body.method_name ||
-            include_prefix_case? && method_name == prefixed_method_name(body)
+            (include_prefix_case? && method_name == prefixed_method_name(body))
         end
 
         def include_prefix_case?

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

@@ -40,7 +40,7 @@ module RuboCop
         IGNORED_ARGUMENT_TYPES = %i[hash splat].freeze
 
         def on_send(node)
-          return if node.receiver.nil? && !inherit_active_record_base?(node) || allowed_invocation?(node)
+          return if (node.receiver.nil? && !inherit_active_record_base?(node)) || allowed_invocation?(node)
 
           method_name = node.method_name
           static_name = static_method_name(method_name)

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

@@ -43,9 +43,20 @@ module RuboCop
         private
 
         def ignored?(node)
+          return true if active_model_error_where?(node.receiver)
+
           method_chain = node.each_node(:send).map(&:method_name)
+
           (cop_config['IgnoredMethods'].map(&:to_sym) & method_chain).any?
         end
+
+        def active_model_error_where?(node)
+          node.method?(:where) && active_model_error?(node.receiver)
+        end
+
+        def active_model_error?(node)
+          node.send_type? && node.method?(:errors)
+        end
       end
     end
   end

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

@@ -45,7 +45,7 @@ module RuboCop
         PATTERN
 
         def_node_matcher :association_with_options?, <<~PATTERN
-          (send nil? {:has_many :has_one} _ (hash $...))
+          (send nil? {:has_many :has_one} ... (hash $...))
         PATTERN
 
         def_node_matcher :dependent_option?, <<~PATTERN
@@ -100,8 +100,8 @@ module RuboCop
         end
 
         def contain_valid_options_in_with_options_block?(node)
-          if with_options_block(node)
-            return true if valid_options?(with_options_block(node))
+          if (options = with_options_block(node))
+            return true if valid_options?(options)
 
             return false unless node.parent
 
@@ -114,6 +114,10 @@ module RuboCop
         end
 
         def valid_options?(options)
+          return false if options.nil?
+
+          options = options.first.children.first.pairs if options.first.kwsplat_type?
+
           return true unless options
           return true if options.any? do |o|
             dependent_option?(o) || present_option?(o)

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

@@ -27,6 +27,7 @@ module RuboCop
         KEYWORD_ARGS = %i[
           method params session body flash xhr as headers env to
         ].freeze
+        ROUTING_METHODS = %i[draw routes].freeze
         RESTRICT_ON_SEND = %i[get post put patch delete head].freeze
 
         minimum_target_rails_version 5.0
@@ -40,6 +41,8 @@ module RuboCop
         PATTERN
 
         def on_send(node)
+          return if in_routing_block?(node)
+
           http_request?(node) do |data|
             return unless needs_conversion?(data)
 
@@ -63,13 +66,17 @@ module RuboCop
 
         private
 
+        def in_routing_block?(node)
+          !!node.each_ancestor(:block).detect { |block| ROUTING_METHODS.include?(block.send_node.method_name) }
+        end
+
         def needs_conversion?(data)
           return true unless data.hash_type?
           return false if kwsplat_hash?(data)
 
           data.each_pair.none? do |pair|
             special_keyword_arg?(pair.key) ||
-              format_arg?(pair.key) && data.pairs.one?
+              (format_arg?(pair.key) && data.pairs.one?)
           end
         end
 

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

@@ -124,9 +124,10 @@ module RuboCop
           block = parent.each_child_node(:begin).first
           return unless block
 
-          defined_methods = block.each_child_node(:def).map(&:method_name)
+          defined_action_methods = defined_action_methods(block)
+
           methods = array_values(methods_node).reject do |method|
-            defined_methods.include?(method)
+            defined_action_methods.include?(method)
           end
 
           message = message(methods, parent)
@@ -135,6 +136,26 @@ module RuboCop
 
         private
 
+        def defined_action_methods(block)
+          defined_methods = block.each_child_node(:def).map(&:method_name)
+
+          defined_methods + aliased_action_methods(block, defined_methods)
+        end
+
+        def aliased_action_methods(node, defined_methods)
+          alias_methods = node.each_child_node(:send).select { |send_node| send_node.method?(:alias_method) }
+
+          hash_of_alias_methods = alias_methods.each_with_object({}) do |alias_method, result|
+            result[alias_method.last_argument.value] = alias_method.first_argument.value
+          end
+
+          defined_methods.each_with_object([]) do |defined_method, aliased_method|
+            if (new_method_name = hash_of_alias_methods[defined_method])
+              aliased_method << new_method_name
+            end
+          end
+        end
+
         # @param node [RuboCop::AST::Node]
         # @return [Array<Symbol>]
         def array_values(node) # rubocop:disable Metrics/MethodLength

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

@@ -75,8 +75,8 @@ module RuboCop
           corrector.replace(str_range, "#{existing_rel} noopener")
         end
 
-        def add_rel(send_node, offence_node, corrector)
-          opening_quote = offence_node.children.last.source[0]
+        def add_rel(send_node, offense_node, corrector)
+          opening_quote = offense_node.children.last.source[0]
           closing_quote = opening_quote == ':' ? '' : opening_quote
           new_rel_exp = ", rel: #{opening_quote}noopener#{closing_quote}"
           range = if (last_argument = send_node.last_argument).hash_type?

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

@@ -14,6 +14,9 @@ module RuboCop
       #   # good
       #   Rails.logger.debug 'A debug message'
       class Output < Base
+        include RangeHelp
+        extend AutoCorrector
+
         MSG = 'Do not write to stdout. ' \
               "Use Rails's logger if you want to log."
         RESTRICT_ON_SEND = %i[
@@ -35,10 +38,13 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return unless (output?(node) || io_output?(node)) &&
-                        node.arguments?
+          return unless (output?(node) || io_output?(node)) && node.arguments?
+
+          range = offense_range(node)
 
-          add_offense(node.loc.selector)
+          add_offense(range) do |corrector|
+            corrector.replace(range, 'Rails.logger.debug')
+          end
         end
 
         private
@@ -46,6 +52,14 @@ module RuboCop
         def match_gvar?(sym)
           %i[$stdout $stderr].include?(sym)
         end
+
+        def offense_range(node)
+          if node.receiver
+            range_between(node.loc.expression.begin_pos, node.loc.selector.end_pos)
+          else
+            node.loc.selector
+          end
+        end
       end
     end
   end

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

@@ -61,8 +61,8 @@ module RuboCop
         def offense?(node)
           number, = *node.receiver
 
-          singular_receiver?(number) && plural_method?(node.method_name) ||
-            plural_receiver?(number) && singular_method?(node.method_name)
+          (singular_receiver?(number) && plural_method?(node.method_name)) ||
+            (plural_receiver?(number) && singular_method?(node.method_name))
         end
 
         def plural_method?(method_name)

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop checks for redundant `travel_back` calls.
+      # Since Rails 5.2, `travel_back` is automatically called at the end of the test.
+      #
+      # @example
+      #
+      #   # bad
+      #   def teardown
+      #     do_something
+      #     travel_back
+      #   end
+      #
+      #   # good
+      #   def teardown
+      #     do_something
+      #   end
+      #
+      #   # bad
+      #   after do
+      #     do_something
+      #     travel_back
+      #   end
+      #
+      #   # good
+      #   after do
+      #     do_something
+      #   end
+      #
+      class RedundantTravelBack < Base
+        include RangeHelp
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        minimum_target_rails_version 5.2
+
+        MSG = 'Redundant `travel_back` detected.'
+        RESTRICT_ON_SEND = %i[travel_back].freeze
+
+        def on_send(node)
+          return unless node.each_ancestor(:def, :block).any? do |ancestor|
+            method_name = ancestor.def_type? ? :teardown : :after
+
+            ancestor.method?(method_name)
+          end
+
+          add_offense(node) do |corrector|
+            corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -90,7 +90,7 @@ module RuboCop
         end
 
         def nested_relative_date(node, &callback)
-          return if node.block_type?
+          return if node.nil? || node.block_type?
 
           node.each_child_node do |child|
             nested_relative_date(child, &callback)

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

@@ -317,16 +317,24 @@ module RuboCop
           return if receiver != node.receiver &&
                     reversible_change_table_call?(node)
 
+          action = if method_name == :remove
+                     target_rails_version >= 6.1 ? 't.remove (without type)' : 't.remove'
+                   else
+                     "change_table(with #{method_name})"
+                   end
+
           add_offense(
             node,
-            message: format(MSG, action: "change_table(with #{method_name})")
+            message: format(MSG, action: action)
           )
         end
 
         def reversible_change_table_call?(node)
           case node.method_name
-          when :change, :remove
+          when :change
             false
+          when :remove
+            target_rails_version >= 6.1 && all_hash_key?(node.arguments.last, :type)
           when :change_default, :change_column_default, :change_table_comment,
                :change_column_comment
             all_hash_key?(node.arguments.last, :from, :to)
@@ -343,8 +351,8 @@ module RuboCop
 
         def within_reversible_or_up_only_block?(node)
           node.each_ancestor(:block).any? do |ancestor|
-            ancestor.block_type? &&
-              ancestor.send_node.method?(:reversible) ||
+            (ancestor.block_type? &&
+              ancestor.send_node.method?(:reversible)) ||
               ancestor.send_node.method?(:up_only)
           end
         end

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

@@ -14,6 +14,8 @@ module RuboCop
       #   # good
       #   scope :something, -> { where(something: true) }
       class ScopeArgs < Base
+        extend AutoCorrector
+
         MSG = 'Use `lambda`/`proc` instead of a plain method call.'
         RESTRICT_ON_SEND = %i[scope].freeze
 
@@ -21,7 +23,9 @@ module RuboCop
 
         def on_send(node)
           scope?(node) do |second_arg|
-            add_offense(second_arg)
+            add_offense(second_arg) do |corrector|
+              corrector.replace(second_arg, "-> { #{second_arg.source} }")
+            end
           end
         end
       end

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

@@ -27,7 +27,7 @@ module RuboCop
       class UniqueValidationWithoutIndex < Base
         include ActiveRecordHelper
 
-        MSG = 'Uniqueness validation should be with a unique index.'
+        MSG = 'Uniqueness validation should have a unique index on the database column.'
         RESTRICT_ON_SEND = %i[validates].freeze
 
         def on_send(node)

data/lib/rubocop/cop/rails_cops.rb

@@ -72,6 +72,7 @@ require_relative 'rails/read_write_attribute'
 require_relative 'rails/redundant_allow_nil'
 require_relative 'rails/redundant_foreign_key'
 require_relative 'rails/redundant_receiver_in_with_options'
+require_relative 'rails/redundant_travel_back'
 require_relative 'rails/reflection_class_name'
 require_relative 'rails/refute_methods'
 require_relative 'rails/relative_date_constant'

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.11.3'
+      STRING = '2.12.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.11.3
+  version: 2.12.3
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-11 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,6 +72,7 @@ extra_rdoc_files:
 files:
 - LICENSE.txt
 - README.md
+- bin/console
 - bin/setup
 - config/default.yml
 - config/obsoletion.yml
@@ -147,6 +148,7 @@ files:
 - lib/rubocop/cop/rails/redundant_allow_nil.rb
 - lib/rubocop/cop/rails/redundant_foreign_key.rb
 - lib/rubocop/cop/rails/redundant_receiver_in_with_options.rb
+- lib/rubocop/cop/rails/redundant_travel_back.rb
 - lib/rubocop/cop/rails/reflection_class_name.rb
 - lib/rubocop/cop/rails/refute_methods.rb
 - lib/rubocop/cop/rails/relative_date_constant.rb
@@ -186,7 +188,7 @@ metadata:
   homepage_uri: https://docs.rubocop.org/rubocop-rails/
   changelog_uri: https://github.com/rubocop/rubocop-rails/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop-rails/
-  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.11/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.12/
   bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
 post_install_message:
 rdoc_options: []
@@ -203,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.18
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Automatic Rails code style checking tool.