rubocop-rails 2.7.1 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cffb4c138d270540b5821e23b2c5450a1939d4b01a2720ce400a8bb510ff90c
-  data.tar.gz: e0702c6ae4a7a43a01034b32d64ad67bac55659d6a5ec471685bda3c6d2a43fe
+  metadata.gz: 8acb3cfc05c02eae959355280c244243a1dd2f6a979c3468e505015844144c97
+  data.tar.gz: 0ba96204c723ae8ec4e7e3ca1b17760b9a8dcc7dfce9b9bc13c008243d35e672
 SHA512:
-  metadata.gz: 0ce7f6953d24239b8ce71a2e759da5007eb94a752f34ccb8d738273f5f75c63f57664042964f9766652c16e076996bb294edafc7d687a923c60ae2f56328afd3
-  data.tar.gz: b810b20d35548b34813946fff138c204fe0ce4f64a68b2f09e63a69c102ad44cf476a543b8bcf87f9caf42d5312ec277e14d23650100df21fb27fb14cc246216
+  metadata.gz: 866bd70db471cfbc203226e0007e660c82f2914dcfcf43c3385d9063599935812783525132785b1256abad61b46c960a372dca0d38d64acf22b63a7eb8b76819
+  data.tar.gz: aa456d390b46dad8be62e104d293e1fdbb4fc1d13c3a68affd1238c29773509e55ded7dd4b219734c4d51d0099d8d44894df145690013c0712d80089d51c9fe7

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.
 
@@ -86,6 +86,22 @@ Rails cops support the following versions:
 
 - Rails 4.2+
 
+## Readme Badge
+
+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/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/rubocop-rails)
+
+[![Rails Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://rails.rubystyle.guide)
+```
+
 ## Contributing
 
 Checkout the [contribution guidelines](CONTRIBUTING.md).

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,14 @@ Rails/ActiveSupportAliases:
   Enabled: true
   VersionAdded: '0.48'
 
+Rails/AfterCommitOverride:
+  Description: >-
+                  This cop 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.
+  Enabled: 'pending'
+  VersionAdded: '2.8'
+
 Rails/ApplicationController:
   Description: 'Check that controllers subclass ApplicationController.'
   Enabled: true
@@ -90,6 +119,12 @@ Rails/ApplicationRecord:
   VersionAdded: '0.49'
   VersionChanged: '2.5'
 
+Rails/ArelStar:
+  Description: 'Enforces `Arel.star` instead of `"*"` for expanded columns.'
+  Enabled: true
+  SafeAutoCorrect: false
+  VersionAdded: '2.9'
+
 Rails/AssertNot:
   Description: 'Use `assert_not` instead of `assert !`.'
   Enabled: true
@@ -97,6 +132,13 @@ Rails/AssertNot:
   Include:
     - '**/test/**/*'
 
+Rails/AttributeDefaultBlockValue:
+  Description: 'Pass method call in block for attribute option `default`.'
+  Enabled: pending
+  VersionAdded: '2.9'
+  Include:
+    - 'models/**/*'
+
 Rails/BelongsTo:
   Description: >-
                   Use `optional: true` instead of `required: false` for
@@ -107,8 +149,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?`
@@ -186,8 +229,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
@@ -216,6 +260,18 @@ Rails/EnvironmentComparison:
   Enabled: true
   VersionAdded: '0.52'
 
+Rails/EnvironmentVariableAccess:
+  Description: 'Do not access `ENV` directly after initialization.'
+  Enabled: pending
+  VersionAdded: '2.10'
+  Include:
+    - app/**/*.rb
+    - lib/**/*.rb
+  Exclude:
+    - lib/**/*.rake
+  AllowReads: false
+  AllowWrites: false
+
 Rails/Exit:
   Description: >-
                   Favor `fail`, `break`, `return`, etc. over `exit` in
@@ -261,8 +317,15 @@ Rails/FindEach:
   StyleGuide: 'https://rails.rubystyle.guide#find-each'
   Enabled: true
   VersionAdded: '0.30'
+  VersionChanged: '2.9'
   Include:
     - app/models/**/*.rb
+  IgnoredMethods:
+    # Methods that don't work well with `find_each`.
+    - order
+    - limit
+    - select
+    - lock
 
 Rails/HasAndBelongsToMany:
   Description: 'Prefer has_many :through to has_and_belongs_to_many.'
@@ -313,14 +376,16 @@ Rails/IgnoredSkipActionFilterOption:
     - app/controllers/**/*.rb
 
 Rails/IndexBy:
-  Description: 'Prefer `index_by` over `each_with_object` or `map`.'
+  Description: 'Prefer `index_by` over `each_with_object`, `to_h`, or `map`.'
   Enabled: true
   VersionAdded: '2.5'
+  VersionChanged: '2.8'
 
 Rails/IndexWith:
-  Description: 'Prefer `index_with` over `each_with_object` or `map`.'
+  Description: 'Prefer `index_with` over `each_with_object`, `to_h`, or `map`.'
   Enabled: true
   VersionAdded: '2.5'
+  VersionChanged: '2.8'
 
 Rails/Inquiry:
   Description: "Prefer Ruby's comparison operators over Active Support's `Array#inquiry` and `String#inquiry`."
@@ -357,6 +422,7 @@ Rails/MailerName:
   Description: 'Mailer should end with `Mailer` suffix.'
   StyleGuide: 'https://rails.rubystyle.guide/#mailer-name'
   Enabled: 'pending'
+  SafeAutoCorrect: false
   VersionAdded: '2.7'
   Include:
     - app/mailers/**/*.rb
@@ -376,7 +442,9 @@ Rails/NegateInclude:
   Description: 'Prefer `collection.exclude?(obj)` over `!collection.include?(obj)`.'
   StyleGuide: 'https://rails.rubystyle.guide#exclude'
   Enabled: 'pending'
+  Safe: false
   VersionAdded: '2.7'
+  VersionChanged: '2.9'
 
 Rails/NotNullColumn:
   Description: 'Do not add a NOT NULL column without a default value.'
@@ -385,6 +453,14 @@ Rails/NotNullColumn:
   Include:
     - db/migrate/*.rb
 
+Rails/OrderById:
+  Description: >-
+                  Do not use the `id` column for ordering.
+                  Use a timestamp column to order chronologically.
+  StyleGuide: 'https://rails.rubystyle.guide/#order-by-id'
+  Enabled: false
+  VersionAdded: '2.8'
+
 Rails/Output:
   Description: 'Checks for calls to puts, print, etc.'
   Enabled: true
@@ -426,6 +502,11 @@ Rails/PluckInWhere:
   Enabled: 'pending'
   Safe: false
   VersionAdded: '2.7'
+  VersionChanged: '2.8'
+  EnforcedStyle: conservative
+  SupportedStyles:
+    - conservative
+    - aggressive
 
 Rails/PluralizationGrammar:
   Description: 'Checks for incorrect grammar when using methods like `3.day.ago`.'
@@ -494,7 +575,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.'
@@ -537,6 +620,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'
@@ -546,6 +635,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
@@ -624,6 +720,16 @@ Rails/SkipsModelValidations:
     - upsert_all
   AllowedMethods: []
 
+Rails/SquishedSQLHeredocs:
+  Description: 'Checks SQL heredocs to use `.squish`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#squished-heredocs'
+  Enabled: 'pending'
+  VersionAdded: '2.8'
+  VersionChanged: '2.9'
+  # Some SQL syntax (e.g. PostgreSQL comments and functions) requires newlines
+  # to be preserved in order to work, thus auto-correction is not safe.
+  SafeAutoCorrect: false
+
 Rails/TimeZone:
   Description: 'Checks the correct usage of time zone aware methods.'
   StyleGuide: 'https://rails.rubystyle.guide#time'
@@ -631,23 +737,35 @@ 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.'
   Enabled: true
   VersionAdded: '0.40'
-  VersionChanged: '2.6'
+  VersionChanged: '2.8'
   EnforcedStyle: conservative
   SupportedStyles:
     - conservative
     - aggressive
+  SafeAutoCorrect: false
   AutoCorrect: false
 
 Rails/UniqueValidationWithoutIndex:
@@ -674,10 +792,30 @@ Rails/Validation:
   Include:
     - app/models/**/*.rb
 
+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.10'
+
+Rails/WhereNot:
+  Description: 'Use `where.not(...)` instead of manually constructing negated SQL in `where`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#hash-conditions'
+  Enabled: 'pending'
+  VersionAdded: '2.8'
 
 # Accept `redirect_to(...) and return` and similar cases.
 Style/AndOr:

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)
 
@@ -35,10 +46,11 @@ module RuboCop
         table_name = find_set_table_name(class_node).to_a.last&.first_argument
         return table_name.value.to_s if table_name
 
-        namespaces = class_node.each_ancestor(:class, :module)
-        [class_node, *namespaces]
+        class_nodes = class_node.defined_module.each_node
+        namespaces = class_node.each_ancestor(:class, :module).map(&:identifier)
+        [*class_nodes, *namespaces]
           .reverse
-          .map { |klass| klass.identifier.children[1] }.join('_')
+          .map { |node| node.children[1] }.join('_')
           .tableize
       end
 
@@ -52,6 +64,7 @@ module RuboCop
       # @param table [RuboCop::Rails::SchemaLoader::Table]
       # @return [String, nil]
       def resolve_relation_into_column(name:, class_node:, table:)
+        return unless table
         return name if table.with_column?(name: name)
 
         find_belongs_to(class_node) do |belongs_to|

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Common functionality for enforcing a specific superclass.
+    module EnforceSuperclass
+      def self.included(base)
+        base.def_node_matcher :class_definition, <<~PATTERN
+          (class (const _ !:#{base::SUPERCLASS}) #{base::BASE_PATTERN} ...)
+        PATTERN
+
+        base.def_node_matcher :class_new_definition, <<~PATTERN
+          [!^(casgn {nil? cbase} :#{base::SUPERCLASS} ...)
+           !^^(casgn {nil? cbase} :#{base::SUPERCLASS} (block ...))
+           (send (const {nil? cbase} :Class) :new #{base::BASE_PATTERN})]
+        PATTERN
+      end
+
+      def on_class(node)
+        class_definition(node) do
+          register_offense(node.children[1])
+        end
+      end
+
+      def on_send(node)
+        class_new_definition(node) do
+          register_offense(node.children.last)
+        end
+      end
+
+      private
+
+      def register_offense(offense_node)
+        add_offense(offense_node) do |corrector|
+          corrector.replace(offense_node.source_range, self.class::SUPERCLASS)
+        end
+      end
+    end
+  end
+end