rubocop-govuk 3.11.0 → 3.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c913a7eee4164badca90121c68221e58784c2a982b9d77edc95a2efb40307e1b
-  data.tar.gz: 970496645c0749dcae4fcf588f3579ded14a5819cb4d17e0e9fc303cae15b0bd
+  metadata.gz: bbde5e0b6a71966c3c76a712077229e4be9de9ab400a3ad54e43ce55a98d2920
+  data.tar.gz: f09db889982c986669ce7a6ab535f3d8011d2725ee65aa5aa92df451e2cb406a
 SHA512:
-  metadata.gz: b98cb3980e29b44f0aaeddd15977ace72241019aae4b01ad7c037e1bab32b23cad77dafc7e4a39cd88a2bbc3eeb67c7739b899ca1413edbd962bb2383f5c4b56
-  data.tar.gz: 218ff2564b26902b9f12e472fbe780678cc93b41ea360fa71d913de9ac665651332df109ae5d5f519e2f32dbb653aa9247ad0dda4d29cd4f900745cd03a1f4d6
+  metadata.gz: bed4ce6b4dc5eb4633258405831b182e72f495738b3152eca931623069a35cbf37322e3788da43c616960cfe1a668871ba41b26d9104e98416853d86ba03b83a
+  data.tar.gz: b299bbdb9ec85294230c07239cec79e256d39f3203257ba2fe6ae8ef1c2da53a64ea93911564d2de01b3c3174e5bb602949da656f27240b3c144f9c1f190fabd

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+# 3.16.0
+
+- Bump and lock rubocop-rails to 2.6.0
+- Bump and lock rubocop-rspec to 1.39.0
+
+# 3.15.0
+
+- Remove cops that are RuboCop defaults (#88)
+- Disable Rails/DynamicFindBy
+- Permit "and", "but" with RSpec/ContextWording
+
+# 3.14.0
+
+- Disable Rails/InverseOf
+- Disable Rails/HasManyOrHasOneDependent
+- Disable Rails/OutputSafety
+
+# 3.13.0
+
+- Disable Layout/FirstMethodArgumentLineBreak (#79)
+- Disable Layout/MultilineMethodArgumentLineBreaks (#80)
+
+# 3.12.0
+
+- Disable Rails/HasAndBelongsToMany (#77)
+
 # 3.11.0
 
 - Add optional config for RSpec Cops (#75)

data/README.md

@@ -11,35 +11,39 @@ Add `rubocop-govuk` to your Gemfile and then run `bundle install`:
 gem 'rubocop-govuk'
 ```
 
-Inherit rules from the gem by adding the following to your project's RuboCop config:
+Then inherit the default rules by adding the following in your project:
 
 ```yaml
 # .rubocop.yml
 inherit_gem:
   rubocop-govuk:
     - config/default.yml
+
+inherit_mode:
+  merge:
+    - Exclude
 ```
 
-or if you also need Rails specific rules:
+You can also configure additional rules for Rails and RSpec:
 
 ```yaml
 # .rubocop.yml
 inherit_gem:
   rubocop-govuk:
-    - config/default.yml
+    ...
     - config/rails.yml
-
-inherit_mode:
-  merge:
-    - Exclude
 ```
 
-## Usage
+```yaml
+# .rubocop.yml
+inherit_gem:
+  rubocop-govuk:
+    ...
+    - config/rspec.yml
+```
 
-Run RuboCop:
+## Testing
 
-```sh
-bundle exec rubocop
-```
+Run `bundle exec rake`.
 
 [guides]: https://github.com/alphagov/styleguides

data/config/layout.yml

@@ -1,10 +1,3 @@
-# Part of the orignal GDS styleguide
-# "Use empty lines between defs and to break up a method into logical paragraphs."
-# https://github.com/alphagov/styleguides/blob/6395a10d41c3938f4c147cda443fd83f854c3e7a/ruby.md#general
-Layout/EmptyLineBetweenDefs:
-  Enabled: true
-  AllowAdjacentOneLineDefs: false
-
 # https://github.com/alphagov/govuk-lint/pull/7
 # "There are occasions where following this rule forces you to make the
 # code less readable. This is particularly the case for tests where method
@@ -83,17 +76,3 @@ Layout/MultilineArrayLineBreaks:
 # and avoids wasting time tweaking an arbitrary layout.
 Layout/MultilineHashKeyLineBreaks:
   Enabled: true
-
-# We should be consistent: if some items of a method call are
-# on multiple lines, then all items should be. This works
-# better with the indentation Cops, produces clearer diffs,
-# and avoids wasting time tweaking an arbitrary layout.
-Layout/MultilineMethodArgumentLineBreaks:
-  Enabled: true
-
-# We should put each argument of a method call on a new line,
-# if any are on new lines. This prevents unnecessary decisions
-# about which style to use; the multiline style also helps to
-# avoid excessively long lines.
-Layout/FirstMethodArgumentLineBreak:
-  Enabled: true

data/config/rails.yml

@@ -13,6 +13,17 @@ AllCops:
 Rails:
   Enabled: true
 
+# We have custom find_by methods in several repos, which
+# we're not going to rename. This Cop also raises false
+# positives for find_by methods that are unrelated to model
+# classes, as well as for repos using Mongoid. The value
+# of the consistency this brings is limited, since we mostly
+# use find_by(key: value) anyway.
+#
+# https://github.com/rubocop-hq/rubocop/issues/3758
+Rails/DynamicFindBy:
+  Enabled: false
+
 # We commonly print output in Ruby code that has been
 # extracted from a Rake task in 'lib/'.
 Rails/Output:
@@ -27,3 +38,44 @@ Rails/Output:
 Rails/SkipsModelValidations:
   Blacklist:
     - update_attribute
+
+# While using has_many/through does have some advantages,
+# it also requires a significant amount of boilerplate code:
+#
+# - An additional 'has_many :join_table' statement
+# - An additional class for the join table (model)
+#
+# This Cop/rule appears to have been written with the
+# assumption that all join tables have inherent meaning,
+# we want to represent, which is not the case; sometimes
+# relationships are just # many-to-many, and that's it.
+Rails/HasAndBelongsToMany:
+  Enabled: false
+
+# While using 'inverse_of' can reduce DB queries, we have
+# not found this to be a problem in practice. The advantage
+# of turning this on would be that we make the inverse
+# behaviour explicit everywhere ActiveRecord can't apply it
+# automatically, but this is rarely a surprise for developers.
+# We also don't want to add 'inverse_of: false' everywhere;
+# at the time of writing, there is no auto-correct for this.
+Rails/InverseOf:
+  Enabled: false
+
+# This is incompatible with the more robust use of foreign
+# key constraints, which provide the same behaviour.
+#
+# Example: https://github.com/alphagov/content-publisher/blob/f26d9b551842fdf2084159b5b7f1bb078da56936/db/schema.rb#L396
+Rails/HasManyOrHasOneDependent:
+  Enabled: false
+
+# We commonly want to render HTML without escaping it, which
+# is what 'html_safe' is for. In many cases, the content we
+# render has already been sanitised (e.g. through Govspeak),
+# or is otherwise trusted e.g. from a content item. We trust
+# that developers will use 'html_safe' responsibly, and prefer
+# the default, escaped output otherwise. At the time of writing,
+# this Cop is disabled in a lot of repos, indicating it offers
+# little value to many developers.
+Rails/OutputSafety:
+  Enabled: false

data/config/rspec.yml

@@ -35,3 +35,13 @@ RSpec/MessageSpies:
 # it's not clear what action to take to fix an issue.
 RSpec/NestedGroups:
   Enabled: false
+
+# Nested contexts make more sense with "and" or "but", since
+# they are a refinement of an outer context.
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - without
+    - and
+    - but

data/config/style.yml

@@ -13,20 +13,6 @@ Style/IfUnlessModifier:
 Style/MethodCalledOnDoEndBlock:
   Enabled: true
 
-# Part of the orignal GDS styleguide
-# "Omit the parentheses when the method doesn’t accept any arguments"
-# https://github.com/alphagov/styleguides/blob/6395a10d41c3938f4c147cda443fd83f854c3e7a/ruby.md#syntax
-Style/MethodCallWithoutArgsParentheses:
-  Enabled: true
-
-# Part of the orignal GDS styleguide
-# "Use Ruby 1.9 syntax for symbolic hash keys.
-# This includes method calls."
-# https://github.com/alphagov/styleguides/blob/6395a10d41c3938f4c147cda443fd83f854c3e7a/ruby.md#collections
-Style/HashSyntax:
-  Exclude:
-  - 'db/schema.rb'
-
 # Part of the orignal GDS styleguide
 # "Add a trailing comma to multi-line array [...]
 # for clearer diffs with less line noise."
@@ -153,11 +139,6 @@ Style/RegexpLiteral:
 Style/SafeNavigation:
   Enabled: false
 
-# We should allow for single line empty methods, as this
-# is a convention for Rails controller actions.
-Style/SingleLineMethods:
-  AllowIfMethodIsEmpty: true
-
 # Introduced in: b171d652d3e434b74ddc621df3b5be24c49bc7e8
 # This cop was added in preperation for a Ruby feature
 # that is no longer likely to become part of the language.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-govuk
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.16.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.85.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.85.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.28'
+        version: 1.39.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.28'
+        version: 1.39.0
 description: Shared RuboCop rules for Ruby projects in GOV.UK
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: RuboCop GOV.UK