rubocop-rails 2.0.1 → 2.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c86591caa45eacc65b20aa23e80fd623b3122a7e28d57b80b9122c20bcf60793
-  data.tar.gz: f1dd97d9221040cc8f03ecdea45706b215c4f7b820abdceecfe623c50c005338
+  metadata.gz: b020fcc0db6203c33dfe23032cc2c6ec0df139e6abb048409bdf7439ea2d4183
+  data.tar.gz: fc6e892161124d21b9067e01e6b86178857df27d14ae687f3f0fdcceb2b3d078
 SHA512:
-  metadata.gz: '00134581586524ab6f4123346ac212cfee0b87cc333974498d786b407221ba8d7ea5d09ad438e3bb492e68970aea57625753f00e646b2cfa8d4062e1ff67e8b9'
-  data.tar.gz: fc6bedd9fdd740b1098a6620f176e742f989d96bca8e1267981b5483081f7139e451ed9fad8715883f7a5c3a95f95e9fb235889a418a8eee7699970d27a37c73
+  metadata.gz: f09636066a282111462ab5cc3b93463ec0cd8a111e2882b6e7c21889da3b36958766f722926418439e48933d8791ce41c0edadc3e4a590c5f8caeb82f35ad5b1
+  data.tar.gz: 40586400ad94701ee39ee71ab7280f7328889245f4786503cf5a851d158a05e4f736eea42c53f61164a420af8fab7e19854c6302237115a29efd3bdd1f19cc68

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-18 Bozhidar Batsov
+Copyright (c) 2012-23 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.
 
@@ -12,13 +12,13 @@ Note: This repository manages rubocop-rails gem (>= 2.0.0). rubocop-rails gem (<
 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`
 
 ```ruby
-gem 'rubocop-rails'
+gem 'rubocop-rails', require: false
 ```
 
 ## Usage
@@ -48,7 +48,7 @@ cops together with the standard cops.
 ### Command line
 
 ```sh
-rubocop --require rubocop-rails --rails
+$ rubocop --require rubocop-rails
 ```
 
 Note: `--rails` option is required while `rubocop` command supports `--rails` option.
@@ -61,6 +61,27 @@ RuboCop::RakeTask.new do |task|
 end
 ```
 
+## Rails configuration tip
+
+If you are using Rails 6.1 or newer, add the following `config.generators.after_generate` setting to
+your config/application.rb to apply RuboCop autocorrection to code generated by `bin/rails g`.
+
+```ruby
+# config/application.rb
+module YourCoolApp
+  class Application < Rails::Application
+    config.generators.after_generate do |files|
+      parsable_files = files.filter { |file| file.end_with?('.rb') }
+      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 autocorretion 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.
+
 ## The Cops
 
 All cops are located under
@@ -76,6 +97,32 @@ Rails/FindBy:
     - lib/example.rb
 ```
 
+## Documentation
+
+You can read a lot more about RuboCop Rails in its [official docs](https://docs.rubocop.org/rubocop-rails/).
+
+## Compatibility
+
+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).