rubocop-govuk 3.12.0 → 3.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48b85a6990ecf33c92d9506a869a15ee68f5c04c065d71fb1328ea6e115a9182
-  data.tar.gz: 1af1fda610c32d6a02e8bbc632f9c78aa03825c1fcc3e83c77a6809b70156e6a
+  metadata.gz: 9af3af6d23a64db34fb0e3713513b75a2666647c18b60c92379a8d000cf3bcca
+  data.tar.gz: 87cae9593714f68d179f0588a340d0d6792495a295043eef258f09d79cefd9ae
 SHA512:
-  metadata.gz: dcbceebe47c06f3df409779bef414174a6264af3a4f1c9be97b433adad2d7d74d9337d53a812971e316728e9fa9cd3d6b742e5c0397045735dce58d61585bff9
-  data.tar.gz: 8d91c162862383603bcfff118e71f31528b567c23a09a2706e74341450fa46b7a5c30059d9fc25edcebd64d4f5faa497320b9a66131af60abfd71d3b9f12271d
+  metadata.gz: e3c33dab371549df141d65ec957462d79d5d9f3de28206c2f4842fd692c0e58b417bf24cef2238a7539ea141f1364639f6db9032d3d62c60c5082164399b244a
+  data.tar.gz: 89c6ac7ca0daf85714140b5f6ce4d3b9e6d02646267ff4a4f848f63d191450691e79dea222ca494ffbce13cee24119010722f772b65e537bef5f283507c7a6fd

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+# 3.17.0
+
+- Enable Rails/SaveBang
+- Enable Style/DateTime
+- Enforce strict Time.zone.now
+- Bump rubocop to 0.87.1
+- Bump rubocop-rspec to 1.42.0
+
+# 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)

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:
@@ -40,3 +51,44 @@ Rails/SkipsModelValidations:
 # 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
+
+# We seldom check the return value of 'update' to see if
+# the operation was successful. Since we assume success, we
+# should raise an exception if this is not the case.
+Rails/SaveBang:
+  Enabled: true
+
+# We should avoid unnecessary ambiguity between 'Time.current'
+# and 'Time.zone.now', where 'Time.current' behaves differently
+# depending on application config. We should always be explicit
+# about whether we mean 'Time[.zone].now'.
+Rails/TimeZone:
+  EnforcedStyle: "strict"

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,14 +139,17 @@ 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.
 # https://github.com/rubocop-hq/rubocop/issues/7197
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+# We should only use DateTime when it's necessary to account
+# for ancient calendar changes. Otherwise, the arbitrary use
+# of this class in place of Date or Time is confusing.
+#
+# https://rubystyle.guide/#no-datetime
+Style/DateTime:
+  Enabled: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-govuk
 version: !ruby/object:Gem::Version
-  version: 3.12.0
+  version: 3.17.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-07-20 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.87.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.87.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.42.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.28'
+        version: 1.42.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