rubocop-govuk 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e5ccad5d8a29404c085805725894f1e34fcddd9a8081fb6d49dc46fcb83c442
-  data.tar.gz: bff295ee9cf144c60f5b2653f7c3744e886c34303032d443d735f022269cb94e
+  metadata.gz: c913a7eee4164badca90121c68221e58784c2a982b9d77edc95a2efb40307e1b
+  data.tar.gz: 970496645c0749dcae4fcf588f3579ded14a5819cb4d17e0e9fc303cae15b0bd
 SHA512:
-  metadata.gz: 5dfb9ea5aca2f9158feb74e46141b32b0a48054ccfa90e82f5cf337a26bcd9ab12ffefc005f930828f0839afdee26fc9aaf22695421dfc6672678ec6e36ab440
-  data.tar.gz: 34c1d26adf2d8d9118ffccca9128ba3f402328d6378865d949c50707fcd38d2b58c7dbcd91de33d3ea9937d5b9570c8aee670bc73ed284f405b53d86470503b0
+  metadata.gz: b98cb3980e29b44f0aaeddd15977ace72241019aae4b01ad7c037e1bab32b23cad77dafc7e4a39cd88a2bbc3eeb67c7739b899ca1413edbd962bb2383f5c4b56
+  data.tar.gz: 218ff2564b26902b9f12e472fbe780678cc93b41ea360fa71d913de9ac665651332df109ae5d5f519e2f32dbb653aa9247ad0dda4d29cd4f900745cd03a1f4d6

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 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/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

@@ -2,7 +2,6 @@
 # "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
 
@@ -12,7 +11,6 @@ Layout/EmptyLineBetweenDefs:
 # 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 +31,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
 

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,17 @@ 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.'
-  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.'
-  Enabled: false
+  Blacklist:
+    - update_attribute

data/config/rspec.yml

@@ -0,0 +1,37 @@
+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

data/config/style.yml

@@ -5,21 +5,18 @@
 # 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
@@ -116,10 +113,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 +127,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 +136,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,21 +144,13 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-govuk
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.11.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -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:

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