rubocop-govuk 3.17.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b616c24ca10792345f9270f1eda98ba66a75a4d1672cf1a917db76596ec8ffd1
-  data.tar.gz: 672788da8bcbd07a06a544acb7b746a34cc697446d72c76cf7fd745ffc0e3454
+  metadata.gz: 347f72f459d1d27eed0cb6091f07a4bebd0a2d1dc43d915f64370349fb670dd1
+  data.tar.gz: c04dc7953ff4437d04d70c96fd63e092b4e1429fc77188012029f2ee4d758bd6
 SHA512:
-  metadata.gz: 2ea901cf52031d78896105a99c1792eb47c2c2d90ce8b14f3ac76c2767e74fed7b6570b309f1a429f5c6416eb51dee99aa90af1faa9b168748337e466f7bd7d0
-  data.tar.gz: 1a0373d4ad1b24899a92b916214cc0f8fc097ba1dd2b2962e44a193d28fb7f1c910df1bef8a48f62cb6baddd62a952cd2501decd6c3af9d8d0bbe7817ec8718c
+  metadata.gz: 0e12b34da4a0cb1bec5649039495da937742339ecfeb15f49fe25553dd13f1b3bc6f45f79ff4aeb121b59639084fea577a7b394e15f7b97745fbcf520ff36e7e
+  data.tar.gz: b95261537420b8907a19056fad2b34e664d3f466c9a254401237429d44e3c5fcc01ab569b0f00f24fc67fe375dcd4d37ffb717e14532896e09aeb4690fb634b7

data/CHANGELOG.md

@@ -1,3 +1,49 @@
+# 4.2.0
+
+- Update rubocop to 1.23.0
+- Update rubocop-ast to 1.13.0
+- Update rubocop-rails to 2.12.4
+- Update rubocop-rspec to 2.6.0
+
+# 4.1.0
+
+- Update rubocop to 1.21.0
+- Update rubocop-ast to 1.11.0
+- Update rubocop-rails to 2.12.0
+- Update rubocop-rspec to 2.4.0
+- Update rubocop-rake to 0.6.0
+
+# 4.0.0
+
+- Update rubocop to 1.15.0
+- Update rubocop-ast to 1.6.0
+- Update rubocop-rails to 2.10.0
+- Update rubocop-rspec to 2.3.0
+
+# 4.0.0.pre.1
+
+- Released as a pre-release to try surface any issues before wider rollout,
+  use https://github.com/alphagov/rubocop-govuk/issues/129 to record any
+  problems
+- BREAKING: Upgraded from Rubocop 0.x to 1.x which introduces lots of new
+  cops
+- Update rubocop to 1.10.0
+- Update rubocop-ast to 1.4.0
+- Update rubocop-rails to 2.9.1
+- Update rubocop-rspec to 2.2.0
+- Make stable dependencies (>= 1.0) less strict on patch version
+- Disable `SuggestExtensions` to stop Rubocop suggesting additional
+  extensions at runtime
+- Explicitly set target Ruby version to `>= 2.6` in gemspec
+- Downgrade local Ruby version to `2.6.6` to capture lowest supported
+  Ruby version
+- Fix namespace change of `Capybara/FeatureMethods`
+- Disable `Naming/VariableNumbers`
+
+# 4.0.0.pre.pre.1
+
+- Mistakenly named release, same as 4.0.0.pre.1
+
 # 3.17.2
 
 - Rename Blacklist to ForbiddenMethods to fix rubocop-rails warnings

data/CONTRIBUTING.md

@@ -0,0 +1,78 @@
+# Contributing
+
+This guidance is intended for changes to:
+
+- versions of dependencies for this repo (e.g. RuboCop itself); and
+- the [extra config we have](https://github.com/alphagov/rubocop-govuk/tree/main/config) to support historical GOV.UK patterns.
+
+All dependencies should be [locked to patch versions to avoid surprise upgrades](https://github.com/alphagov/rubocop-govuk/pull/154) in consumer repos.
+
+## Getting started
+
+To install dependencies:
+
+```bash
+bundle
+```
+
+To lint the config / Rakefile:
+
+```bash
+bundle exec rake
+```
+
+RuboCop GOV.UK is a styleguide, so each rule in each YAML file should have a comment to explain why it's there. This is enforced by linting with [a custom `explain_yourself` rake task](https://github.com/alphagov/rubocop-govuk/blob/main/Rakefile).
+
+## Doing a release
+
+### 1. Check what the impact is going to be
+
+Find out how much effort it will be to adopt your changes in typical GOV.UK repos. This could just be running `rubocop -A` to autocorrect new issues, or it could involve significant manual effort.
+
+You can test changes locally by tweaking the Gemfile or `.gemspec` for the repo e.g.
+
+```
+gem "rubocop-govuk", path: "/govuk/rubocop-govuk"
+```
+
+This is a rough list of typical GOV.UK repos we recommend testing against:
+
+- An old app e.g. Whitehall, Smart Answers
+- A newer app e.g. Content Publisher, Email Alert API
+- A non-Rails app e.g. Search API
+- A gem e.g. GDS API Adapters
+
+### 2. Decide if the config needs to change
+
+Ideally we should have none of our own config and follow RuboCop defaults:
+
+- This is easier than making our own decisions.
+- We don't want to diverge from the Ruby community.
+
+However, we also want to make it easy for all GOV.UK repos to keep pace with RuboCop GOV.UK. This means we should **try to ensure all issues can be auto-corrected or are easy to fix manually**.
+
+You should only change the config as a last resort. Examples of good changes:
+
+- Disable a rule if it's based on heuristics ([example](https://github.com/alphagov/rubocop-govuk/blob/ce655779e45892db6ac00d6789c652ec2e506748/config/metrics.yml#L1-L10)).
+
+- Change a rule to match a GOV.UK-wide pattern ([example](https://github.com/alphagov/rubocop-govuk/blob/ce655779e45892db6ac00d6789c652ec2e506748/config/rails.yml#L16-L25)).
+
+- Change a rule if the effort to fix is *very* high ([example](https://github.com/alphagov/rubocop-govuk/blob/ce655779e45892db6ac00d6789c652ec2e506748/config/rspec.yml#L33-L35)).
+
+Sometimes it's more appropriate to put config overrides in the `.rubocop.yml` file of consumer repos ([example](https://github.com/alphagov/content-store/blob/857275148323fc9536490aefc253c8a9e73a175a/.rubocop.yml#L10-L12)). Use this approach if the override is only necessary in a small number of repos.
+
+### 3. Consider making a pre-release version
+
+This can be helpful if there are lots of changes where it's hard to assess the impact e.g. a major dependency upgrade. Use the pre-release version to gather feedback from maintainers of consumer repos, working with them to make any necessary adjustments here before releasing the next official version.
+
+👉 [Example of major release after testing a pre-release version](https://github.com/alphagov/rubocop-govuk/compare/v4.0.0.pre.1...v4.0.0).
+
+### 4. Make your CHANGELOG really helpful
+
+The [CHANGELOG.md](CHANGELOG.md) is what maintainers of consumer repos will use to understand your changes. Tools like Dependabot will automatically include it in PR descriptions. A helpful changelog:
+
+- Gives an overview of the change e.g. "Upgrade X to Y".
+
+- Explains any actions to take e.g. "run `rubocop -A`".
+
+- Advises on potential compatibility issues (TODO: example).

data/README.md

@@ -1,6 +1,8 @@
 # RuboCop GOV.UK
 
-This repository provides common RuboCop rules for use with GOV.UK Ruby projects to comply with our [style guides][guides].
+Defines the linting rules for GDS Ruby applications, primarily those associated with GOV.UK.
+
+GOV.UK has used a styleguide for many years, starting with rules in written form, which we then [automated with RuboCop](https://github.com/alphagov/styleguides/commit/cb589cdc4ba17f9c341f4db75900e554dd042672#diff-99f257b41e6471357be7e37c3a41d79045d11f7f0ae1000d6f7fc63b502273e7) and later [moved into this repo](https://github.com/alphagov/govuk-rfcs/blob/main/rfc-100-linting.md#proposal). A styleguide is a valuable asset: it keeps our code consistent and prevents stylistic squabbles. Everyone on GOV.UK is encouraged to use it in their Ruby projects and [contribute](CONTRIBUTING.md) to dependency upgrades and new releases, keeping pace with the rest of the Ruby community.
 
 ## Installation
 
@@ -8,7 +10,7 @@ Add `rubocop-govuk` to your Gemfile and then run `bundle install`:
 
 ```ruby
 # Gemfile
-gem 'rubocop-govuk'
+gem 'rubocop-govuk', require: false
 ```
 
 Then inherit the default rules by adding the following in your project:
@@ -42,8 +44,6 @@ inherit_gem:
     - config/rspec.yml
 ```
 
-## Testing
-
-Run `bundle exec rake`.
+## Contributing
 
-[guides]: https://github.com/alphagov/styleguides
+Rules in this repo are defined based on their compatibility with GOV.UK apps and their code conventions. Everyone else is welcome to use it and suggest changes - see [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

data/config/capybara.yml

@@ -1,5 +1,5 @@
 # Within GOV.UK we use Capybara test method syntax of feature,
 # scenario. We don't want this outside of feature specs though.
-Capybara/FeatureMethods:
+RSpec/Capybara/FeatureMethods:
   Exclude:
     - 'spec/features/**/*.rb'

data/config/default.yml

@@ -1,5 +1,6 @@
 AllCops:
   NewCops: disable
+  SuggestExtensions: false
   Exclude:
     - 'bin/**'
     - 'config.ru'

data/config/naming.yml

@@ -19,3 +19,10 @@ Naming/AccessorMethodName:
 # repos, which would require manual intervention.
 Naming/PredicateName:
   Enabled: false
+
+# This rule can cause readability issues when applied (for example
+# `born_on_or_before_6_april_1935` becomes `born_on_or_before_6april1935`)
+# and would require lots of amends to apply either `normalcase`
+# or `snake_case` to projects. It is not auto-correctable.
+Naming/VariableNumber:
+  Enabled: false

data/config/rspec.yml

@@ -10,6 +10,11 @@ inherit_from:
 RSpec/ExampleLength:
   Enabled: false
 
+# We should avoid cops that are based on heuristics, since
+# it's not clear what action to take to fix an issue.
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
 # We have common cases, such as rake tasks, where we do not
 # use a class to the describe the test.
 RSpec/DescribeClass:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-govuk
 version: !ruby/object:Gem::Version
-  version: 3.17.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -30,70 +30,70 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.87.1
+        version: 1.23.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.87.1
+        version: 1.23.0
 - !ruby/object:Gem::Dependency
   name: rubocop-ast
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.12.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.12.4
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.42.0
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.42.0
+        version: 2.6.0
 description: Shared RuboCop rules for Ruby projects in GOV.UK
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE.md
 - README.md
 - config/capybara.yml
@@ -125,14 +126,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.31
 signing_key: 
 specification_version: 4
 summary: RuboCop GOV.UK