rubocop-rails 2.15.2 → 2.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 169ed04b1f5378e9e08fbffdca151afaf4b84fd54b1867a173740aadaede60b3
-  data.tar.gz: 1a2ac75c313cfcdeec1814d7e3aff4777c5013527d2cf4a2aa4f95aeb45446bf
+  metadata.gz: 9258d56d31fc4adeef0526b551dbe652abe70dd4599debc25ee39be54b743330
+  data.tar.gz: ab2d60fe9b2a61ac47f8f15f8753fb60dd26e278d5452d23501f59a398fd7b0a
 SHA512:
-  metadata.gz: 51d495edd3e825db49ece8f51bfc118c73887681f414b86d31cd47d85dc5a1a22a385a2a17ed4ebf7d1c6332989795e2cde999a364d911c60f452993dc926c4b
-  data.tar.gz: 4546785b39af93e6c7fe5a6a3b637fa5c21d4b358c38ea8ad3ebd5c272d1d0a504e8206e8201cfe3771af9199c336649d033e32b324f16b06fc7d150054dc488
+  metadata.gz: 7ba4c487f87fdbd58130ba06fc0184c9c5b5dabe5ee3934aa03930c27467072a7f89ac77ba423fe89f69ad9739c2dfcbeac1bb947e64804757e6efbdb47b47a5
+  data.tar.gz: 223e0693edfd7de08b9d6a770fbdd7ced5c6422cab60d5074657ef65dd7b4ce538c8f61c37cc15156d63824e1d4060a654bca1fef7830d1b587e7ca84d516f62

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-22 Bozhidar Batsov
+Copyright (c) 2012-26 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,18 +1,19 @@
 # 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/rubocop-rails.svg?style=svg)](https://circleci.com/gh/rubocop/rubocop-rails)
+[![CI](https://github.com/rubocop/rubocop-rails/actions/workflows/test.yml/badge.svg)](https://github.com/rubocop/rubocop-rails/actions/workflows/test.yml)
 
 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.
+> [!IMPORTANT]
+> 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.
 
 ## Installation
 
 Just install the `rubocop-rails` gem
 
 ```sh
-gem install rubocop-rails
+$ gem install rubocop-rails
 ```
 
 or if you use bundler put this in your `Gemfile`
@@ -31,13 +32,13 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-rails
+plugins: rubocop-rails
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-rails
 ```
@@ -45,22 +46,96 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop Rails
 cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```sh
-rubocop --require rubocop-rails
+$ rubocop --plugin rubocop-rails
 ```
 
-Note: `--rails` option is required while `rubocop` command supports `--rails` option.
-
 ### Rake task
 
 ```ruby
+require 'rubocop/rake_task'
+
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rails'
+  task.plugins << 'rubocop-rails'
+end
+```
+
+## RuboCop Rails configuration
+
+The following settings specific to RuboCop Rails can be configured in `.rubocop.yml`.
+
+### `AllCops: TargetRailsVersion`
+
+What version of Rails is the inspected code using? If a value is specified
+for `TargetRailsVersion` then it is used. Acceptable values are specified
+as a float (e.g., 7.2); the patch version of Rails should not be included.
+
+```yaml
+AllCops:
+  TargetRailsVersion: 7.2
+```
+
+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
+application. If neither of those files exist, RuboCop will use Rails 5.0
+as the default.
+
+### `AllCops: MigratedSchemaVersion`
+
+By specifying the `MigratedSchemaVersion` option, migration files that have already been run can be ignored.
+When `MigratedSchemaVersion: '20241225000000'` is set, migration files lower than or equal to '20241225000000' will be ignored.
+For example, to ignore db/migrate/20241225000000_create_articles.rb and earlier migrations you would configure it the following way:
+
+```yaml
+AllCops:
+  MigratedSchemaVersion: '20241225000000'
+```
+
+This prevents inspecting schema settings for already applied migration files.
+Changing already applied migrations should be avoided because it can lead to the schema getting out of sync
+between your local copy and what it actually is in production, depending on when `bin/rails db:migrate` was executed.
+If you want to modify your schema to comply with the cops, you should instead create new migrations.
+
+## Rails configuration tip
+
+In Rails 6.1+, add the following `config.generators.after_generate` setting to
+your `config/environments/development.rb` to apply RuboCop autocorrection to code generated by `bin/rails g`.
+
+```ruby
+# config/environments/development.rb
+Rails.application.configure do
+  config.generators.after_generate do |files|
+    parsable_files = files.filter { |file| file.end_with?('.rb') }
+    unless parsable_files.empty?
+      system("bundle exec rubocop -A --fail-level=E #{parsable_files.shelljoin}", exception: true)
+    end
+  end
 end
 ```
 
+It uses `rubocop -A` to apply `Style/FrozenStringLiteralComment` and other unsafe autocorrection cops.
+`rubocop -A` is unsafe autocorrection, but code generated by default is simple and less likely to
+be incompatible with `rubocop -A`. If you have problems you can replace it with `rubocop -a` instead.
+
+In Rails 7.2+, it is recommended to use `config.generators.apply_rubocop_autocorrect_after_generate!` instead of the above setting:
+
+```diff
+ # config/environments/development.rb
+ Rails.application.configure do
+   (snip)
+   # Apply autocorrection by RuboCop to files generated by `bin/rails generate`.
+-  # config.generators.apply_rubocop_autocorrect_after_generate!
++  config.generators.apply_rubocop_autocorrect_after_generate!
+ end
+```
+
+You only need to uncomment.
+
 ## The Cops
 
 All cops are located under