rubocop-govuk 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab10ddfc89214d7fae46f59e6c4b562938daa350796eb48e2f78ab56fcd7df7c
-  data.tar.gz: 574eef536a366973c7c7f8fd36d3a824ad034056957730247345899323a21f21
+  metadata.gz: f9c2665fb72c667c3f07e7b9c58773452d606d6ef538eb8a72ec737db214387c
+  data.tar.gz: a651269b0301ba985c67ca643505becad473424dacb789cabfc0ecca51e756c9
 SHA512:
-  metadata.gz: f11edcb99e6acaf178b3daaacedccd66764e8b660a824e12016057b5877cbd11249e41e08a7697ee5610fc8fb09a8ffe3834d748d6930bf4472294aa9633ff5c
-  data.tar.gz: 12cf45d1bb91ad44bf5cdc42e7a8d223a062e8ecf2156273d0c6bf298ff741747d146af837882dbf9700f321fb82a8b3b603d6fa1a39378ca5018230177a70e0
+  metadata.gz: 151c3d8ec8811c0f8921a4f3ce842527e0c9b677a425c17891da6e379c97b30b1f22fad6f18e4dfcfa4f65a492baea8b62060431830b057bfb83b575448318ae
+  data.tar.gz: 7516c91b9bc30c5565fcff0000a456c48f8adecd3fcc74f4675bd0f6172798d5fa5d70402b7f92b502b45d0af196ca782a438ef71753e4cbd4907fe622a61d71

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 3.9.0
+
+* Enable Style/Alias (#60)
+* Enable Style/AsciiComments (#60)
+* Enable Style/BlockDelimiters (#60)
+* Enable Style/CaseEquality (#60)
+* Enable Style/PreferredHashMethods (#60)
+* Enable Style/DoubleNegation (#60)
+* Enable Style/FormatString (#60)
+* Enable Style/Encoding (#64)
+* Enable Style/IfWithSemicolon (#64)
+* Enable Style/Lambda (#64)
+* Enable Style/LambdaCall (#64)
+* Enable Style/ModuleFunction (#64)
+* Enable Style/NilComparison (#64)
+* Enable Style/SignalException (#64)
+* Enable Style/SingleLineMethods (#64)
+* Enable Style/CommandLiteral (#64)
+* Disable Metrics/BlockLength (#65, #68)
+
 # 3.8.0
 
 * Enable check for flip-flops (#55)

data/config/default.yml

@@ -6,6 +6,8 @@ AllCops:
     - 'tmp/**/*'
     - 'db/schema.rb'
     - 'db/migrate/201*'
+    - 'vendor/**/*'
+    - 'node_modules/**/*'
 
   DisplayCopNames:
     Description: 'Display cop names in offense messages'

data/config/metrics.yml

@@ -1,17 +1,13 @@
-# Introduced in: 195e1d6934e610efed35151cfe90b01b805d7581
-# Introduced in: b7a98b43a4b0644b8d4ac40aa3ddaf35f06fa58f
-# "Many test frameworks use blocks for the entire test
-# case in a file as well as for individual tests within the file.
-# It's not unusual for a test case to be several lines
-# longer than the upper limit of the BlockLength cop,
-# and there's very little we can do to avoid that so
-# there's no point running this cop on our tests."
+# 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.
+#
+# For this Cop, there are also several kinds of file that
+# have long blocks by convention (tests, config, rake tasks,
+# gemspecs), to the point where its value is dubious.
 Metrics/BlockLength:
-  Enabled: true
-  Exclude:
-    - test/**/*
-    - "**/spec/**/*"
-  ExcludedMethods: ["namespace"]
+  Enabled: false
 
 # Introduced in: 736b3d295f88b9ba6676fc168b823535582388c2
 # "Disable opinionated cops"

data/config/style.yml

@@ -80,38 +80,31 @@ Style/StringLiterals:
 Style/FormatStringToken:
   Enabled: false
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
+# This is a contentious issue, since 'alias_method' works in
+# all circumstances, whereas 'alias' only works lexically. As
+# with single vs. double quotes, it seems pointless to expend
+# effort deciding between them. Our predominant style is to use
+# 'alias_method', which always works.
 Style/Alias:
-  Description: 'Use alias_method instead of alias.'
-  Enabled: false
+  EnforcedStyle: prefer_alias_method
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
+# This prevents weird characters in comments, such as stylistic
+# quote characters and strange whitespace. We should only allow
+# special characters when they are essential for a comment. It's
+# a waste of effort to go and find the special sequence when an
+# alternative exists e.g. '×' can be replaced with '*' in maths.
 Style/AsciiComments:
-  Description: 'Use only ascii symbols in comments.'
-  Enabled: false
+  AllowedChars: ['£']
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/BeginBlock:
-  Description: 'Avoid the use of BEGIN blocks.'
-  Enabled: false
-
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
+# We should only use braces in multiline blocks in a # chained
+# method call. This is consistent with the RSpec 'expect' syntax.
+#
+# expect {
+#   a_long_and_complex_method_call
+# }.to raise_error(SomeError)
+#
 Style/BlockDelimiters:
-  Description: >-
-    Avoid using {...} for multi-line blocks (multiline chaining is
-    always ugly).
-    Prefer {...} over do...end for single-line blocks.
-  Enabled: false
-
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/CaseEquality:
-  Description: 'Avoid explicit use of the case equality operator(===).'
-  Enabled: false
+  EnforcedStyle: braces_for_chaining
 
 # Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
 # TODO: unclear why this is here!
@@ -119,12 +112,6 @@ Style/ClassAndModuleChildren:
   Description: 'Checks style of children classes and modules.'
   Enabled: false
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/PreferredHashMethods:
-  Description: 'Checks for use of deprecated Hash methods.'
-  Enabled: false
-
 # Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
 # Documenting every class is a lot of effort and we don't
 # expect to get any value from this. Another risk of adding
@@ -134,23 +121,6 @@ Style/Documentation:
   Description: 'Document classes and non-namespace modules.'
   Enabled: false
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/DoubleNegation:
-  Description: 'Checks for uses of double negation (!!).'
-  Enabled: false
-
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/Encoding:
-  Description: 'Use UTF-8 as the source file encoding.'
-  Enabled: false
-
-# TODO: duplicate (other-excludes.yml), remove
-Style/FormatString:
-  Description: 'Enforce the use of Kernel#sprintf, Kernel#format or String#%.'
-  Enabled: false
-
 # Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
 # TODO: unclear why this is here!
 Style/GlobalVars:
@@ -167,24 +137,6 @@ 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/IfWithSemicolon:
-  Description: 'Never use if x; .... Use the ternary operator instead.'
-  Enabled: false
-
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/Lambda:
-  Description: 'Use the new lambda literal syntax for single-line blocks.'
-  Enabled: false
-
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/LambdaCall:
-  Description: 'Use lambda.call(...) instead of lambda.(...).'
-  Enabled: false
-
 # Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
 # TODO: unclear why this is here!
 Style/MethodDefParentheses:
@@ -193,12 +145,6 @@ Style/MethodDefParentheses:
     parentheses.
   Enabled: false
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/ModuleFunction:
-  Description: 'Checks for usage of `extend self` in modules.'
-  Enabled: false
-
 # Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
 # TODO: unclear why this is here!
 Style/NegatedIf:
@@ -213,12 +159,6 @@ Style/Next:
   Description: 'Use `next` to skip iteration instead of a condition at the end.'
   Enabled: false
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/NilComparison:
-  Description: 'Prefer x.nil? to x == nil.'
-  Enabled: false
-
 # Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
 # TODO: unclear why this is here!
 Style/NumericLiterals:
@@ -257,24 +197,10 @@ Style/SafeNavigation:
     existance of the object to safe navigation (`&.`).
   Enabled: false
 
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/SignalException:
-  Description: 'Checks for proper usage of fail and raise.'
-  Enabled: false
-
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here! Suggest enabling with
-# "AllowIfMethodIsEmpty: true" to accommodate Rails actions.
+# We should allow for single line empty methods, as this
+# is a convention for Rails controller actions.
 Style/SingleLineMethods:
-  Description: 'Avoid single-line methods.'
-  Enabled: false
-
-# Introduced in: c69a7eb3af955d6c4c0cf0c3cec8e9f330c74429
-# TODO: unclear why this is here!
-Style/CommandLiteral:
-  Description: 'Checks for %x when `` would do.'
-  Enabled: false
+  AllowIfMethodIsEmpty: true
 
 # Introduced in: b171d652d3e434b74ddc621df3b5be24c49bc7e8
 # This cop was added in preperation for a Ruby feature

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-govuk
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake