makandra-rubocop 9.1.0 → 10.0.0

data/config/ext/rails.yml

@@ -15,7 +15,7 @@ AllCops:
     - 'public/system/**/*'
     - '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
@@ -27,7 +27,7 @@ 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:
+  AllowedMethods:
     - ago
     - from_now
     - second
@@ -44,6 +44,28 @@ Lint/NumberConversion:
     - fortnights
     - in_milliseconds
 
+Rails:
+  Enabled: true
+  DocumentationBaseURL: https://docs.rubocop.org/rubocop-rails
+
+Rails/ActionControllerFlashBeforeRender:
+  Description: 'Use `flash.now` instead of `flash` before `render`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#flash-before-render'
+  Reference: 'https://api.rubyonrails.org/classes/ActionController/FlashBeforeRender.html'
+  Enabled: false # there may be cases where we actually want to use `flash` before a render.
+  SafeAutoCorrect: false
+  VersionAdded: '2.16'
+
+Rails/ActionControllerTestCase:
+  Description: 'Use `ActionDispatch::IntegrationTest` instead of `ActionController::TestCase`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#integration-testing'
+  Reference: 'https://api.rubyonrails.org/classes/ActionController/TestCase.html'
+  Enabled: false # we don't use this anyway
+  SafeAutoCorrect: false
+  VersionAdded: '2.14'
+  Include:
+    - '**/test/**/*.rb'
+
 Rails/ActionFilter:
   Description: 'Enforces consistent use of action filter methods.'
   Enabled: true
@@ -54,6 +76,22 @@ Rails/ActionFilter:
     - filter
   Include:
     - app/controllers/**/*.rb
+    - app/mailers/**/*.rb
+
+Rails/ActionOrder:
+  Description: 'Enforce consistent ordering of controller actions.'
+  Enabled: false # The best order is debatable, and there maybe valid reasons not to stick to any particular order
+  VersionAdded: '2.17'
+  ExpectedOrder:
+    - index
+    - show
+    - new
+    - edit
+    - create
+    - update
+    - destroy
+  Include:
+    - app/controllers/**/*.rb
 
 Rails/ActiveRecordAliases:
   Description: >-
@@ -89,6 +127,15 @@ Rails/ActiveSupportAliases:
   Enabled: false
   VersionAdded: '0.48'
 
+Rails/ActiveSupportOnLoad:
+  Description: 'Use `ActiveSupport.on_load(...)` to patch Rails framework classes.'
+  Enabled: true
+  Reference:
+    - 'https://api.rubyonrails.org/classes/ActiveSupport/LazyLoadHooks.html'
+    - 'https://guides.rubyonrails.org/engines.html#available-load-hooks'
+  SafeAutoCorrect: false
+  VersionAdded: '2.16'
+
 Rails/AddColumnIndex:
   Description: >-
     Rails migrations don't make use of a given `index` key, but also
@@ -101,7 +148,7 @@ Rails/AddColumnIndex:
 
 Rails/AfterCommitOverride:
   Description: >-
-    This cop enforces that there is only one call to `after_commit`
+    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: true
@@ -186,13 +233,27 @@ Rails/BulkChangeTable:
   Include:
     - db/migrate/*.rb
 
+Rails/CompactBlank:
+  Description: 'Checks if collection can be blank-compacted with `compact_blank`.'
+  Enabled: false # This may lead to false positives. See https://docs.rubocop.org/rubocop-rails/cops_rails.html#railscompactblank
+  Safe: false
+  VersionAdded: '2.13'
+
 Rails/ContentTag:
   Description: 'Use `tag` instead of `content_tag`.'
   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: false # We currently use content_tag in many applications. If content_tag should become deprecated in the future we'll have to change it anyway, but until then, we'll keep the content_tag syntax
   VersionAdded: '2.6'
+  VersionChanged: '2.12'
+  # This `Exclude` config prevents false positives for `tag` calls to `has_one: tag` and Puma configuration:
+  # https://puma.io/puma/Puma/DSL.html#tag-instance_method
+  # No helpers are used in normal models and configs.
+  Exclude:
+    - app/models/**/*.rb
+    - config/**/*.rb
 
 Rails/CreateTableWithTimestamps:
   Description: >-
@@ -202,6 +263,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: >-
@@ -243,6 +308,35 @@ Rails/DelegateAllowBlank:
   Enabled: true
   VersionAdded: '0.44'
 
+Rails/DeprecatedActiveModelErrorsMethods:
+  Description: 'Avoid manipulating ActiveModel errors hash directly.'
+  Enabled: true
+  Safe: false
+  VersionAdded: '2.14'
+  VersionChanged: '2.15'
+
+Rails/DotSeparatedKeys:
+  Description: 'Enforces the use of dot-separated keys instead of `:scope` options in `I18n` translation methods.'
+  StyleGuide: 'https://rails.rubystyle.guide/#dot-separated-keys'
+  Enabled: false # if they key is set dynamically, using the scope option is more favorable than using dot-separated keys with string interpolation
+  VersionAdded: '2.15'
+
+Rails/DuplicateAssociation:
+  Description: "Don't repeat associations in a model."
+  Enabled: true
+  VersionAdded: '2.14'
+
+Rails/DuplicateScope:
+  Description: 'Multiple scopes share this same where clause.'
+  Enabled: true
+  VersionAdded: '2.14'
+
+Rails/DurationArithmetic:
+  Description: 'Do not use duration as arithmetic operand with `Time.current`.'
+  StyleGuide: 'https://rails.rubystyle.guide#duration-arithmetic'
+  Enabled: true
+  VersionAdded: '2.13'
+
 Rails/DynamicFindBy:
   Description: 'Use `find_by` instead of dynamic `find_by_*`.'
   StyleGuide: 'https://rails.rubystyle.guide#find_by'
@@ -252,10 +346,13 @@ Rails/DynamicFindBy:
   # The `Whitelist` has been deprecated, Please use `AllowedMethods` instead.
   Whitelist:
     - find_by_sql
+    - find_by_token_for
   AllowedMethods:
     - find_by_sql
+    - find_by_token_for
   AllowedReceivers:
     - Gem::Specification
+    - page # Prevents a warning for `page.find_by_id`. See: https://github.com/rubocop/rubocop-rails/issues/778
 
 Rails/EagerEvaluationLogMessage:
   Description: 'Checks that blocks are used for interpolated strings passed to `Rails.logger.debug`.'
@@ -351,12 +448,20 @@ Rails/FindEach:
   VersionChanged: '2.9'
   Include:
     - app/models/**/*.rb
-  IgnoredMethods:
+  AllowedMethods:
     # Methods that don't work well with `find_each`.
     - order
     - limit
     - select
     - lock
+  AllowedPatterns: []
+
+Rails/FreezeTime:
+  Description: 'Prefer `freeze_time` over `travel_to` with an argument of the current time.'
+  StyleGuide: 'https://rails.rubystyle.guide/#freeze-time'
+  Enabled: false  # dangerous because freeze_time calls travel_to with Time.now but the cop also indicates usages of Time.current or other timezone-dependent times which are not the same as Time.now
+  VersionAdded: '2.16'
+  SafeAutoCorrect: false
 
 Rails/HasAndBelongsToMany:
   Description: 'Prefer has_many :through to has_and_belongs_to_many.'
@@ -399,6 +504,15 @@ Rails/HttpStatus:
     - numeric
     - symbolic
 
+Rails/I18nLazyLookup:
+  Description: 'Checks for places where I18n "lazy" lookup can be used.'
+  StyleGuide: 'https://rails.rubystyle.guide/#lazy-lookup'
+  Reference: 'https://guides.rubyonrails.org/i18n.html#lazy-lookup'
+  Enabled: true
+  VersionAdded: '2.14'
+  Include:
+    - 'controllers/**/*'
+
 Rails/I18nLocaleAssignment:
   Description: 'Prefer the usage of `I18n.with_locale` instead of manually updating `I18n.locale` value.'
   Enabled: false
@@ -407,6 +521,19 @@ Rails/I18nLocaleAssignment:
     - spec/**/*.rb
     - test/**/*.rb
 
+Rails/I18nLocaleTexts:
+  Description: 'Enforces use of I18n and locale files instead of locale specific strings.'
+  StyleGuide: 'https://rails.rubystyle.guide/#locale-texts'
+  Enabled: true
+  VersionAdded: '2.14'
+
+Rails/IgnoredColumnsAssignment:
+  Description: 'Looks for assignments of `ignored_columns` that override previous assignments.'
+  StyleGuide: 'https://rails.rubystyle.guide/#append-ignored-columns'
+  Enabled: false  # we don't really use ignored_columns
+  SafeAutoCorrect: false
+  VersionAdded: '2.17'
+
 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'
@@ -414,6 +541,7 @@ Rails/IgnoredSkipActionFilterOption:
   VersionAdded: '0.63'
   Include:
     - app/controllers/**/*.rb
+    - app/mailers/**/*.rb
 
 Rails/IndexBy:
   Description: 'Prefer `index_by` over `each_with_object`, `to_h`, or `map`.'
@@ -437,17 +565,19 @@ Rails/InverseOf:
   Description: 'Checks for associations where the inverse cannot be determined automatically.'
   Enabled: true
   VersionAdded: '0.52'
+  IgnoreScopes: false
   Include:
     - app/models/**/*.rb
 
 Rails/LexicallyScopedActionFilter:
-  Description: "Checks that methods specified in the filter's `only` or `except` options are explicitly defined in the controller."
+  Description: "Checks that methods specified in the filter's `only` or `except` options are explicitly defined in the class."
   StyleGuide: 'https://rails.rubystyle.guide#lexically-scoped-action-filter'
   Enabled: true
   Safe: false
   VersionAdded: '0.52'
   Include:
     - app/controllers/**/*.rb
+    - app/mailers/**/*.rb
 
 Rails/LinkToBlank:
   Description: 'Checks that `link_to` with a `target: "_blank"` have a `rel: "noopener"` option passed to them.'
@@ -478,6 +608,13 @@ Rails/MatchRoute:
     - config/routes.rb
     - config/routes/**/*.rb
 
+Rails/MigrationClassName:
+  Description: 'The class name of the migration should match its file name.'
+  Enabled: true
+  VersionAdded: '2.14'
+  Include:
+    - db/migrate/*.rb
+
 Rails/NegateInclude:
   Description: 'Prefer `collection.exclude?(obj)` over `!collection.include?(obj)`.'
   StyleGuide: 'https://rails.rubystyle.guide#exclude'
@@ -504,6 +641,7 @@ Rails/OrderById:
 Rails/Output:
   Description: 'Checks for calls to puts, print, etc.'
   Enabled: false
+  SafeAutoCorrect: false
   VersionAdded: '0.15'
   VersionChanged: '0.19'
   Include:
@@ -607,11 +745,25 @@ Rails/RedundantForeignKey:
   Enabled: true
   VersionAdded: '2.6'
 
+Rails/RedundantPresenceValidationOnBelongsTo:
+  Description: 'Checks for redundant presence validation on belongs_to association.'
+  Enabled: true
+  SafeAutoCorrect: false
+  VersionAdded: '2.13'
+
 Rails/RedundantReceiverInWithOptions:
   Description: 'Checks for redundant receiver in `with_options`.'
   Enabled: true
   VersionAdded: '0.52'
 
+Rails/RedundantTravelBack:
+  Description: Checks for redundant `travel_back` calls.
+  Enabled: true
+  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
@@ -633,9 +785,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.'
@@ -672,15 +824,33 @@ Rails/ReversibleMigration:
   Reference: 'https://api.rubyonrails.org/classes/ActiveRecord/Migration/CommandRecorder.html'
   Enabled: true
   VersionAdded: '0.47'
+  VersionChanged: '2.13'
   Include:
-    - db/migrate/*.rb
+    - db/**/*.rb
 
 Rails/ReversibleMigrationMethodDefinition:
   Description: 'Checks whether the migration implements either a `change` method or both an `up` and a `down` method.'
-  Enabled: false # If the migration starts with a class definition, no change-, up-, or down-method is recognized, although they exist
+  Enabled: false
   VersionAdded: '2.10'
+  VersionChanged: '2.13'
   Include:
-    - db/migrate/*.rb
+    - db/**/*.rb
+
+Rails/RootJoinChain:
+  Description: 'Use a single `#join` instead of chaining on `Rails.root` or `Rails.public_path`.'
+  Enabled: true
+  VersionAdded: '2.13'
+
+Rails/RootPathnameMethods:
+  Description: 'Use `Rails.root` IO methods instead of passing it to `File`.'
+  Enabled: true
+  SafeAutoCorrect: false
+  VersionAdded: '2.16'
+
+Rails/RootPublicPath:
+  Description: "Favor `Rails.public_path` over `Rails.root` with `'public'`."
+  Enabled: false
+  VersionAdded: '2.15'
 
 Rails/SafeNavigation:
   Description: "Use Ruby's safe navigation operator (`&.`) instead of `try!`."
@@ -714,10 +884,18 @@ Rails/SaveBang:
   AllowedReceivers: []
   SafeAutoCorrect: false
 
+Rails/SchemaComment:
+  Description: >-
+    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
   VersionAdded: '0.19'
+  VersionChanged: '2.12'
   Include:
     - app/models/**/*.rb
 
@@ -767,17 +945,32 @@ Rails/SquishedSQLHeredocs:
   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.
+  # to be preserved in order to work, thus autocorrection is not safe.
   SafeAutoCorrect: false
 
+Rails/StripHeredoc:
+  Description: 'Enforces the use of squiggly heredoc over `strip_heredoc`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#prefer-squiggly-heredoc'
+  Enabled: true
+  VersionAdded: '2.15'
+
+Rails/TableNameAssignment:
+  Description: >-
+    Do not use `self.table_name =`. Use Inflections or `table_name_prefix` instead.
+  StyleGuide: 'https://rails.rubystyle.guide/#keep-ar-defaults'
+  Enabled: false
+  VersionAdded: '2.14'
+  Include:
+    - app/models/**/*.rb
+
 Rails/TimeZone:
   Description: 'Checks the correct usage of time zone aware methods.'
   StyleGuide: 'https://rails.rubystyle.guide#time'
   Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
   Enabled: false
-  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
@@ -796,6 +989,33 @@ Rails/TimeZoneAssignment:
     - spec/**/*.rb
     - test/**/*.rb
 
+Rails/ToFormattedS:
+  Description: 'Checks for consistent uses of `to_fs` or `to_formatted_s`.'
+  StyleGuide: 'https://rails.rubystyle.guide/#prefer-to-fs'
+  Enabled: true
+  EnforcedStyle: to_formatted_s
+  SupportedStyles:
+    - to_fs
+    - to_formatted_s
+  VersionAdded: '2.15'
+
+Rails/ToSWithArgument:
+  Description: 'Identifies passing any argument to `#to_s`.'
+  Enabled: false
+  Safe: false
+  VersionAdded: '2.16'
+
+Rails/TopLevelHashWithIndifferentAccess:
+  Description: 'Identifies top-level `HashWithIndifferentAccess`.'
+  Reference: 'https://guides.rubyonrails.org/upgrading_ruby_on_rails.html#top-level-hashwithindifferentaccess-is-soft-deprecated'
+  Enabled: true
+  VersionAdded: '2.16'
+
+Rails/TransactionExitStatement:
+  Description: 'Avoid the usage of `return`, `break` and `throw` in transaction blocks.'
+  Enabled: true # Get a head start on deprecations: https://blog.saeloun.com/2020/04/06/rails-disallow-return-break-and-throw-to-exit-transaction.html
+  VersionAdded: '2.14'
+
 Rails/UniqBeforePluck:
   Description: 'Prefer the use of uniq or distinct before pluck.'
   Enabled: true
@@ -806,7 +1026,6 @@ Rails/UniqBeforePluck:
     - conservative
     - aggressive
   SafeAutoCorrect: false
-  AutoCorrect: false
 
 Rails/UniqueValidationWithoutIndex:
   Description: 'Uniqueness validation should be with a unique index.'
@@ -856,12 +1075,29 @@ Rails/WhereExists:
   VersionAdded: '2.7'
   VersionChanged: '2.10'
 
+Rails/WhereMissing:
+  Description: 'Use `where.missing(...)` to find missing relationship records.'
+  StyleGuide: 'https://rails.rubystyle.guide/#finding-missing-relationship-records'
+  Enabled: true
+  VersionAdded: '2.16'
+
 Rails/WhereNot:
   Description: 'Use `where.not(...)` instead of manually constructing negated SQL in `where`.'
   StyleGuide: 'https://rails.rubystyle.guide/#hash-conditions'
   Enabled: true
   VersionAdded: '2.8'
 
+Rails/WhereNotWithMultipleConditions:
+  Description: 'Do not use `where.not(...)` with multiple conditions.'
+  Enabled: true
+  VersionAdded: '2.17'
+
 # Accept `redirect_to(...) and return` and similar cases.
 Style/AndOr:
   EnforcedStyle: conditionals
+
+Style/SymbolProc:
+  AllowedMethods:
+    - define_method
+    - mail
+    - respond_to