rubocop-govuk 3.14.0 → 3.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 248e60260a8647aef347016c34f825328544408b2d6805dd19b82105570663f1
-  data.tar.gz: 55966fee3db3a3c27aa56f087629c560dbfd47e6b31945885abce3569c98dc14
+  metadata.gz: b616c24ca10792345f9270f1eda98ba66a75a4d1672cf1a917db76596ec8ffd1
+  data.tar.gz: 672788da8bcbd07a06a544acb7b746a34cc697446d72c76cf7fd745ffc0e3454
 SHA512:
-  metadata.gz: 927073b5c07e0efd223e2a9d3a1bfe726cbbb09f8592171178efb04f0462d025b25615c4164c856523e53f5746eb62c223225c0a5d6d942a1b4c51402e8d274c
-  data.tar.gz: d3244ce4fdbbbcd3cbdb3e6ea5076dc84f9fcf662d624fec9b5486214ca2fb4125379d33a5c3b14cbeea4b75b5bedc0030441d77393f1586e0e73d631246aee6
+  metadata.gz: 2ea901cf52031d78896105a99c1792eb47c2c2d90ce8b14f3ac76c2767e74fed7b6570b309f1a429f5c6416eb51dee99aa90af1faa9b168748337e466f7bd7d0
+  data.tar.gz: 1a0373d4ad1b24899a92b916214cc0f8fc097ba1dd2b2962e44a193d28fb7f1c910df1bef8a48f62cb6baddd62a952cd2501decd6c3af9d8d0bbe7817ec8718c

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+# 3.17.2
+
+- Rename Blacklist to ForbiddenMethods to fix rubocop-rails warnings
+
+# 3.17.1
+
+- Pin rubocop-ast to 0.8.0
+
+# 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

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

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:
@@ -25,7 +36,7 @@ Rails/Output:
 # no efficient alternative. Instead, we should only enable
 # this Cop for methods that have a clear alternative.
 Rails/SkipsModelValidations:
-  Blacklist:
+  ForbiddenMethods:
     - update_attribute
 
 # While using has_many/through does have some advantages,
@@ -68,3 +79,16 @@ Rails/HasManyOrHasOneDependent:
 # 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.14.0
+  version: 3.17.2
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,70 +16,84 @@ 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-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.8.1
 - !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 +132,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