rubocop-govuk 3.10.0 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e5ccad5d8a29404c085805725894f1e34fcddd9a8081fb6d49dc46fcb83c442
-  data.tar.gz: bff295ee9cf144c60f5b2653f7c3744e886c34303032d443d735f022269cb94e
+  metadata.gz: 1171ad385c38876c2f62430dcb6adaebaaca00ff54e75a6dd8c270d18c09e841
+  data.tar.gz: 3575953156d194c6eb0e2bb6b64244862608fd6980df1a8a30668c6eb088ffa5
 SHA512:
-  metadata.gz: 5dfb9ea5aca2f9158feb74e46141b32b0a48054ccfa90e82f5cf337a26bcd9ab12ffefc005f930828f0839afdee26fc9aaf22695421dfc6672678ec6e36ab440
-  data.tar.gz: 34c1d26adf2d8d9118ffccca9128ba3f402328d6378865d949c50707fcd38d2b58c7dbcd91de33d3ea9937d5b9570c8aee670bc73ed284f405b53d86470503b0
+  metadata.gz: 9a76bcf79590b6181faf54c27f19b0674137f78863d2c0a8121291eaa4c4b149e0d239405ed292665b7d6f554eb96d33594aaba6a2ff7508b2b1e0dd3e27c64b
+  data.tar.gz: c56adb23766c457038b2a3b9dd4b7f4892258ed309f92d2a2d273ef03fab82c05e4d27b8afcd8c42f2bf962127011dfa619504053dc8f61285231acdd540dc4d

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+# 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)
+- Enable Style/Next (#74)
+- Partially enable Rails/SkipsModelValidations (#74)
+- Partially enable Rails/Output (#74)
+- Enable Rails/HasAndBelongsToMany (#74)
+- Enable Bundler/DuplicatedGem (#74)
+
 # 3.10.0
 
 * Enable Style/NegatedIf (#71)

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/capybara.yml

@@ -0,0 +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:
+  Exclude:
+    - 'spec/features/**/*.rb'

data/config/default.yml

@@ -10,19 +10,15 @@ AllCops:
     - 'node_modules/**/*'
 
   DisplayCopNames:
-    Description: 'Display cop names in offense messages'
     Enabled: true
 
   ExtraDetails:
-    Description: 'Display extra details in offense messages.'
     Enabled: true
 
   DisplayStyleGuide:
-    Description: 'Display style guide URLs in offense messages.'
     Enabled: true
 
 inherit_from:
-  - bundler.yml
   - layout.yml
   - metrics.yml
   - naming.yml

data/config/layout.yml

@@ -1,18 +1,9 @@
-# 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:
-  Description: Use empty lines between defs.
-  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
 # names form the test descriptions. Keeping test descriptions under a
 # certain length can force them to become cryptic."
 Layout/LineLength:
-  Description: Limit lines to 80 characters.
   Enabled: false
 
 # We have two styles of method call in our apps:
@@ -33,7 +24,6 @@ Layout/MultilineMethodCallIndentation:
 # "Outdent private etc"
 # https://github.com/alphagov/styleguides/blob/6395a10d41c3938f4c147cda443fd83f854c3e7a/ruby.md#classes
 Layout/AccessModifierIndentation:
-  Description: Check indentation of private/protected visibility modifiers.
   Enabled: true
   EnforcedStyle: outdent
 
@@ -86,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/metrics.yml

@@ -46,7 +46,6 @@ Metrics/PerceivedComplexity:
 # We should avoid cops that are based on heuristics, since
 # it's not clear what action to take to fix an issue.
 Metrics/BlockNesting:
-  Description: 'Avoid excessive block nesting'
   Enabled: false
 
 # Analog of: 736b3d295f88b9ba6676fc168b823535582388c2
@@ -55,7 +54,6 @@ Metrics/BlockNesting:
 # We should avoid cops that are based on heuristics, since
 # it's not clear what action to take to fix an issue.
 Metrics/CyclomaticComplexity:
-  Description: 'Avoid complex methods.'
   Enabled: false
 
 # Analog of: 736b3d295f88b9ba6676fc168b823535582388c2
@@ -64,7 +62,6 @@ Metrics/CyclomaticComplexity:
 # We should avoid cops that are based on heuristics, since
 # it's not clear what action to take to fix an issue.
 Metrics/MethodLength:
-  Description: 'Avoid methods longer than 10 lines of code.'
   Enabled: false
 
 # Analog of: 736b3d295f88b9ba6676fc168b823535582388c2
@@ -73,5 +70,4 @@ Metrics/MethodLength:
 # We should avoid cops that are based on heuristics, since
 # it's not clear what action to take to fix an issue.
 Metrics/ParameterLists:
-  Description: 'Avoid parameter lists longer than three or four parameters.'
   Enabled: false

data/config/naming.yml

@@ -13,8 +13,9 @@
 Naming/AccessorMethodName:
   Enabled: false
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
+# We should be free to decide on interfaces that make sense to us.
+# At the time of writing, this Cop is not auto-correctable, and
+# would generate a prohibitively high number of issues across our
+# repos, which would require manual intervention.
 Naming/PredicateName:
-  Description: 'Check the names of predicate methods.'
   Enabled: false

data/config/rails.yml

@@ -13,20 +13,69 @@ AllCops:
 Rails:
   Enabled: true
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Rails/HasAndBelongsToMany:
-  Description: 'Prefer has_many :through to has_and_belongs_to_many.'
+# 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
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
+# We commonly print output in Ruby code that has been
+# extracted from a Rake task in 'lib/'.
 Rails/Output:
-  Description: 'Checks for calls to puts, print, etc.'
-  Enabled: false
+  Exclude:
+    - 'lib/**/*.rb'
 
-# Introduced in: 91d7bf4895db12727582ad7bf47bdcb20ab178f7
-# TODO: unclear (in any real detail) why this is here!
+# It's unclear what remedial action to take for the total
+# set of methods this Cop has issues with. For example, we
+# use 'update_all' in many of our repos, for which there is
+# no efficient alternative. Instead, we should only enable
+# this Cop for methods that have a clear alternative.
 Rails/SkipsModelValidations:
-  Description: 'Avoid methods that skip model validations.'
+  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

@@ -0,0 +1,47 @@
+require: rubocop-rspec
+
+inherit_from:
+  - capybara.yml
+
+# Analog of: 736b3d295f88b9ba6676fc168b823535582388c2
+#
+# We should avoid cops that are based on heuristics, since
+# it's not clear what action to take to fix an issue.
+RSpec/ExampleLength:
+  Enabled: false
+
+# We have common cases, such as rake tasks, where we do not
+# use a class to the describe the test.
+RSpec/DescribeClass:
+  Enabled: false
+
+# We accept multiple expectations (within reason), preferring
+# them to running mulitple similar tests.
+RSpec/MultipleExpectations:
+  Enabled: false
+
+# Part of the GOV.UK feature style involves instance variables.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/features/**/*.rb'
+
+# In GOV.UK we quite often test that a class received a method.
+RSpec/MessageSpies:
+  Enabled: false
+
+# Analog of: 736b3d295f88b9ba6676fc168b823535582388c2
+#
+# We should avoid cops that are based on heuristics, since
+# 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

@@ -5,31 +5,14 @@
 # line statements to re-written makes it a harder
 # to follow the branching logic."
 Style/IfUnlessModifier:
-  Description: Favor modifier if/unless usage when you have a single-line body.
   Enabled: false
 
 # Part of the orignal GDS styleguide
 # "Never chain do...end"
 # https://github.com/alphagov/styleguides/blob/6395a10d41c3938f4c147cda443fd83f854c3e7a/ruby.md#syntax
 Style/MethodCalledOnDoEndBlock:
-  Description: Avoid chaining a method call on a do...end block.
   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:
-  Description: 'Do not use parentheses for method calls with no arguments.'
-  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."
@@ -116,10 +99,12 @@ Style/AsciiComments:
 Style/BlockDelimiters:
   EnforcedStyle: braces_for_chaining
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
+# We have no concensus on this. Using the nested style is the
+# default for generated Rails app (see 'config/application.rb').
+# Using the compact style can help to reduce boilerplate within
+# modules. At the time of writing, the auto-correct for this Cop
+# is unsafe for moving to either style.
 Style/ClassAndModuleChildren:
-  Description: 'Checks style of children classes and modules.'
   Enabled: false
 
 # Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
@@ -128,7 +113,6 @@ Style/ClassAndModuleChildren:
 # more documentation is the potential for confusion if that
 # documentation gets out-of-sync with the class/module.
 Style/Documentation:
-  Description: 'Document classes and non-namespace modules.'
   Enabled: false
 
 # Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
@@ -138,13 +122,6 @@ Style/Documentation:
 # "There are occasions where following this rule forces you to make the
 # code less readable."
 Style/GuardClause:
-  Description: 'Check for conditionals that can be replaced with guard clauses'
-  Enabled: false
-
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/Next:
-  Description: 'Use `next` to skip iteration instead of a condition at the end.'
   Enabled: false
 
 # Analog of: 736b3d295f88b9ba6676fc168b823535582388c2
@@ -153,28 +130,15 @@ Style/Next:
 # We should avoid cops that are based on heuristics, since
 # it's not clear what action to take to fix an issue.
 Style/RegexpLiteral:
-  Description: >-
-    Use %r for regular expressions matching more than
-    `MaxSlashes` '/' characters.
-    Use %r only for regular expressions matching more than
-    `MaxSlashes` '/' character.
   Enabled: false
 
-# Introduced in: 7aaebf4dbdf2a8d677b4000d3cd3512d4fb91e99
-# "This is a relatively new Ruby feature and is not mentioned in the Style
-# guide, so this commit disables it by default."
-# TODO: unclear why this is here!
+# Using safe navigation is less explicit than making a clear
+# check for truthiness, as evidenced by its own safelist for
+# certain methods. Safe navigation is also less visible and
+# pollutes otherwise readable method calls.
 Style/SafeNavigation:
-  Description: >-
-    This cop transforms usages of a method call safeguarded by a check for the
-    existance of the object to safe navigation (`&.`).
   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.10.0
+  version: 3.15.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.85.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.85.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
@@ -90,13 +90,14 @@ files:
 - CHANGELOG.md
 - LICENSE.md
 - README.md
-- config/bundler.yml
+- config/capybara.yml
 - config/default.yml
 - config/layout.yml
 - config/metrics.yml
 - config/naming.yml
 - config/rails.yml
 - config/rake.yml
+- config/rspec.yml
 - config/style.yml
 homepage: https://github.com/alphagov/rubocop-govuk
 licenses:
@@ -117,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

data/config/bundler.yml

@@ -1,12 +0,0 @@
-# Introduced in: 278fc6e903834acfb37565795a196b85282560b0
-# "A common pattern in our Gemfiles is to declare a gem
-# differently if we're in a dev mode or not. For example
-#
-# if ENV['API_DEV']
-#   gem 'gds-api-adapters', path: '../gds-api-adapters'
-# else
-#   gem 'gds-api-adapters', "~> 50.8.0"
-# end"
-# TODO: see if we can remove this (no longer valid??)
-Bundler/DuplicatedGem:
-  Enabled: false