rubocop-govuk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64fec5146e2d9675100ef4f3e9e2e20662b9fe142c3543ba944b093a22567e5c
+  data.tar.gz: e3b797ff3bda459208fab3db93f3cdb852cbbe694afdd7ef75df89cf290e1cdc
+SHA512:
+  metadata.gz: 1f31c42621eb74cea67290c161c8febe47f85adffa4a6caa392290d8a48b02f2c0113e992aa1e97aca3335d8a1aae2ed97b2d133622c0e3215238bf988fa0dc2
+  data.tar.gz: 751fdab0163a353a6c65233c9a752df7b011fb5e551caf48a0e848013050fbcd343ba263fda5de2667fb4eaabe0d1910b06cadb55758020e7248a5f67af47f4e

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 1.0.0
+
+* Allow importing of Ruby and Rails rules seperately
+
+# 0.2.0
+
+* Disable the Style/FormatStringToken cop
+
+# 0.1.0
+
+* Initial release with previous work from `govuk-lint`

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License(MIT)
+
+Copyright (C) 2015 Crown Copyright (Government Digital Service)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# RuboCop GOV.UK
+
+This repository provides common RuboCop rules for use with GOV.UK Ruby projects to comply with our [style guides][guides].
+
+## Installation
+
+Add `rubocop-govuk` to your Gemfile and then run `bundle install`:
+```ruby
+# Gemfile
+gem 'rubocop-govuk'
+```
+
+Inherit rules from the gem by adding the following to your project's RuboCop config:
+```yaml
+# .rubocop
+inherit_gem:
+  rubocop-govuk: 
+    - config/default.yml
+```
+
+or if you also need Rails specific rules:
+
+```yaml
+# .rubocop
+inherit_gem:
+  rubocop-govuk: 
+    - config/default.yml
+    - config/rails.yml
+```
+
+## Usage
+
+Run RuboCop: 
+
+```sh
+bundle exec rubocop
+```
+
+[guides]: https://github.com/alphagov/styleguides

data/config/default.yml

@@ -0,0 +1,19 @@
+AllCops:
+  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:
+  - gds-ruby-styleguide.yml
+  - other-lint.yml
+  - other-style.yml
+  - other-metrics.yml
+  - other-excludes.yml

data/config/gds-ruby-styleguide.yml

@@ -0,0 +1,337 @@
+############
+## General
+############
+
+Layout/BlockAlignment:
+  Description: 'Align block ends correctly.'
+  Enabled: true
+
+Layout/CaseIndentation:
+  Description: Indentation of when in a case/when/[else/]end.
+  Enabled: true
+  EnforcedStyle: case
+  SupportedStyles:
+  - case
+  - end
+  IndentOneStep: false
+
+Layout/ClosingParenthesisIndentation:
+  Description: 'Checks the indentation of hanging closing parentheses.'
+  Enabled: false
+
+Style/MutableConstant:
+  Description: 'Freeze mutable objects assigned to constants.'
+  Enabled: true
+
+Lint/ElseLayout:
+  Description: 'Check for odd code arrangement in an else block.'
+  Enabled: true
+
+# Supports --auto-correct
+Layout/EmptyLineBetweenDefs:
+  Description: Use empty lines between defs.
+  Enabled: true
+  AllowAdjacentOneLineDefs: false
+
+Layout/EmptyLines:
+  Description: "Don't use several empty lines in a row."
+  Enabled: true
+
+Layout/EndAlignment:
+  Description: 'Align ends correctly.'
+  Enabled: true
+
+Layout/EndOfLine:
+  Description: 'Use Unix-style line endings.'
+  Enabled: true
+
+# Supports --auto-correct
+Layout/IndentationWidth:
+  Description: Use 2 spaces for indentation.
+  Enabled: true
+
+# Supports --auto-correct
+Layout/IndentationConsistency:
+  Description: Keep indentation straight.
+  Enabled: true
+
+Metrics/LineLength:
+  Description: Limit lines to 80 characters.
+  Enabled: false
+  Max: 80
+
+ # Supports --auto-correct
+Layout/SpaceAroundOperators:
+  Description: Use spaces around operators.
+  Enabled: true
+
+# Supports --auto-correct
+Layout/SpaceBeforeBlockBraces:
+  Description: Checks that the left block brace has or doesn't have space before it.
+  Enabled: true
+  EnforcedStyle: space
+  SupportedStyles:
+  - space
+  - no_space
+
+# Supports --auto-correct
+Layout/SpaceAfterSemicolon:
+  Description: Use spaces after semicolons.
+  Enabled: true
+
+# Supports --auto-correct
+Layout/SpaceAfterColon:
+  Description: Use spaces after colons.
+  Enabled: true
+
+# Supports --auto-correct
+Layout/SpaceAfterComma:
+  Description: Use spaces after commas.
+  Enabled: true
+
+# Supports --auto-correct
+Layout/SpaceInsideReferenceBrackets:
+  Description: No spaces after array[ or before ].
+  Enabled: true
+
+# Supports --auto-correct
+Layout/SpaceInsideArrayLiteralBrackets:
+  Description: No spaces after array = [ or before ].
+  Enabled: true
+
+# Supports --auto-correct
+Layout/SpaceInsideParens:
+  Description: No spaces after ( or before ).
+  Enabled: true
+
+Layout/Tab:
+  Description: No hard tabs.
+  Enabled: true
+
+# Supports --auto-correct
+Layout/TrailingWhitespace:
+  Description: Avoid trailing whitespace.
+  Enabled: true
+
+# Supports --auto-correct
+Layout/TrailingBlankLines:
+  Description: Checks trailing blank lines and final newline.
+  Enabled: true
+  EnforcedStyle: final_newline
+  SupportedStyles:
+  - final_newline
+  - final_blank_line
+
+## Syntax
+
+# Supports --auto-correct
+Style/AndOr:
+  Description: Use &&/|| instead of and/or.
+  Enabled: true
+
+# Supports --auto-correct
+Style/DefWithParentheses:
+  Description: Use def with parentheses when there are arguments.
+  Enabled: true
+
+Style/For:
+  Description: Checks use of for or each in multiline loops.
+  Enabled: true
+  EnforcedStyle: each
+  SupportedStyles:
+  - for
+  - each
+
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  Enabled: false
+
+Style/MethodCalledOnDoEndBlock:
+  Description: Avoid chaining a method call on a do...end block.
+  Enabled: true
+
+Style/MethodCallWithoutArgsParentheses:
+  Description: 'Do not use parentheses for method calls with no arguments.'
+  Enabled: true
+
+Style/MultilineBlockChain:
+  Description: Avoid multi-line chains of blocks.
+  Enabled: true
+
+Style/MultilineIfThen:
+  Description: Never use then for multi-line if/unless.
+  Enabled: true
+
+Style/MultilineTernaryOperator:
+  Description: 'Avoid multi-line ?: (the ternary operator); use if/unless instead.'
+  Enabled: true
+
+Style/NestedTernaryOperator:
+  Description: Use one expression per branch in a ternary operator.
+  Enabled: true
+
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  Enabled: true
+
+# Supports --auto-correct
+Style/ParenthesesAroundCondition:
+  Description: Don't use parentheses around the condition of an if/unless/while.
+  Enabled: true
+  AllowSafeAssignment: true
+
+# Supports --auto-correct
+Style/RedundantReturn:
+  Description: Don't use return where it's not required.
+  Enabled: true
+  AllowMultipleReturnValues: false
+
+# Supports --auto-correct
+Layout/SpaceAfterMethodName:
+  Description: Never put a space between a method name and the opening parenthesis in
+    a method definition.
+  Enabled: true
+
+# Supports --auto-correct
+Layout/SpaceAroundEqualsInParameterDefault:
+  Description: Checks that the equals signs in parameter default assignments have or
+    don't have surrounding space depending on configuration.
+  Enabled: true
+  EnforcedStyle: space
+  SupportedStyles:
+  - space
+  - no_space
+
+Style/UnlessElse:
+  Description: Never use unless with else. Rewrite these with the positive case first.
+  Enabled: true
+
+# Supports --auto-correct
+Lint/UnusedBlockArgument:
+  Description: Checks for unused block arguments.
+  Enabled: true
+
+## Naming
+
+Naming/ClassAndModuleCamelCase:
+  Description: Use CamelCase for classes and modules.
+  Enabled: true
+
+# Supports --auto-correct
+Style/ClassMethods:
+  Description: Use self when defining module/class methods.
+  Enabled: true
+
+Style/ClassVars:
+  Description: Avoid the use of class variables.
+  Enabled: true
+
+Naming/ConstantName:
+  Description: Constants should use SCREAMING_SNAKE_CASE.
+  Enabled: true
+
+Naming/MethodName:
+  Description: Use the configured style when naming methods.
+  Enabled: true
+  EnforcedStyle: snake_case
+  SupportedStyles:
+  - snake_case
+  - camelCase
+
+# Supports --auto-correct
+Style/TrivialAccessors:
+  Description: Prefer attr_* methods to trivial readers/writers.
+  Enabled: true
+  ExactNameMatch: true
+  AllowPredicates: true
+  AllowDSLWriters: false
+  Whitelist:
+  - to_ary
+  - to_a
+  - to_c
+  - to_enum
+  - to_h
+  - to_hash
+  - to_i
+  - to_int
+  - to_io
+  - to_open
+  - to_path
+  - to_proc
+  - to_r
+  - to_regexp
+  - to_str
+  - to_s
+  - to_sym
+
+Naming/VariableName:
+  Description: Use the configured style when naming variables.
+  Enabled: true
+  EnforcedStyle: snake_case
+  SupportedStyles:
+  - snake_case
+  - camelCase
+
+## Exceptions
+
+# Supports --auto-correct
+Lint/RescueException:
+  Description: Avoid rescuing the Exception class.
+  Enabled: true
+
+## Collections
+
+# Supports --auto-correct
+Layout/AlignArray:
+  Description: Align the elements of an array literal if they span more than one line.
+  Enabled: true
+
+# Supports --auto-correct
+Style/HashSyntax:
+  Description: 'Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax { :a => 1,
+    :b => 2 }.'
+  Enabled: true
+  Exclude:
+  - 'db/schema.rb'
+
+  EnforcedStyle: ruby19
+  SupportedStyles:
+  - ruby19
+  - hash_rockets
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+# Supports --auto-correct
+Style/WordArray:
+  Description: Use %w or %W for arrays of words.
+  Enabled: true
+  MinSize: 0
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+## Strings
+
+# Supports --auto-correct
+Lint/StringConversionInInterpolation:
+  Description: Checks for Object#to_s usage in string interpolation.
+  Enabled: true
+
+# Supports --auto-correct
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes

data/config/other-excludes.yml

@@ -0,0 +1,16 @@
+AllCops:
+  Exclude:
+    - db/schema.rb
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - test/**/*
+    - "**/spec/**/*"
+  ExcludedMethods: ["namespace"]
+
+Bundler/DuplicatedGem:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false

data/config/other-lint.yml

@@ -0,0 +1,129 @@
+Lint/AmbiguousOperator:
+  Description: >-
+     Checks for ambiguous operators in the first argument of a
+     method invocation without parentheses.
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Description: >-
+    Checks for ambiguous regexp literals in the first argument of
+    a method invocation without parenthesis.
+  Enabled: true
+
+Lint/AssignmentInCondition:
+  Description: "Don't use assignment in conditions."
+  Enabled: true
+
+Layout/ConditionPosition:
+  Description: 'Checks for condition placed in a confusing position relative to the keyword.'
+  Enabled: true
+
+Lint/Debugger:
+  Description: 'Check for debugger calls.'
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Description: 'Check for deprecated class method calls.'
+  Enabled: true
+
+Lint/EmptyEnsure:
+  Description: 'Checks for empty ensure block.'
+  Enabled: true
+
+Lint/EmptyInterpolation:
+  Description: 'Checks for empty string interpolation.'
+  Enabled: true
+
+Lint/EndInMethod:
+  Description: 'END blocks should not be placed inside method definitions.'
+  Enabled: true
+
+Lint/EnsureReturn:
+  Description: 'Never use return in an ensure block.'
+  Enabled: true
+
+Security/Eval:
+  Description: 'The use of eval represents a serious security risk.'
+  Enabled: true
+
+Lint/HandleExceptions:
+  Description: "Don't suppress exception."
+  Enabled: true
+
+Lint/LiteralAsCondition:
+  Description: 'Checks of literals used in conditions.'
+  Enabled: true
+
+Lint/LiteralInInterpolation:
+  Description: 'Checks for literals used in interpolation.'
+  Enabled: true
+
+Lint/Loop:
+  Description: >-
+     Use Kernel#loop with break rather than begin/end/until or
+     begin/end/while for post-loop tests.
+  Enabled: true
+
+Lint/ParenthesesAsGroupedExpression:
+  Description: >-
+     Checks for method calls with a space before the opening
+     parenthesis.
+  Enabled: true
+
+Lint/PercentStringArray:
+  Description: Checks for unwanted commas and quotes in %w/%W literals eg %w('foo', “bar”).
+  Enabled: true
+
+Lint/RequireParentheses:
+  Description: >-
+     Use parentheses in the method call to avoid confusion
+     about precedence.
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Description: >-
+     Do not use the same name as outer local variable
+     for block arguments or block local variables.
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Description: >-
+     Put a space between a method name and the first argument
+     in a method call without parentheses.
+  Enabled: true
+
+Lint/UnderscorePrefixedVariableName:
+  Description: 'Do not use prefix `_` for a variable that is used.'
+  Enabled: true
+
+Lint/UnusedMethodArgument:
+  Description: 'Checks for unused method arguments.'
+  Enabled: true
+
+Lint/UnreachableCode:
+  Description: 'Unreachable code.'
+  Enabled: true
+
+Lint/UselessAccessModifier:
+  Description: 'Checks for useless access modifiers.'
+  Enabled: true
+
+Lint/UselessAssignment:
+  Description: 'Checks for useless assignment to a local variable.'
+  Enabled: true
+
+Lint/UselessComparison:
+  Description: 'Checks for comparison of something with itself.'
+  Enabled: true
+
+Lint/UselessElseWithoutRescue:
+  Description: 'Checks for useless `else` in `begin..end` without `rescue`.'
+  Enabled: true
+
+Lint/UselessSetterCall:
+  Description: 'Checks for useless setter call to a local variable.'
+  Enabled: true
+
+Lint/Void:
+  Description: 'Possible use of operator/literal/variable in void context.'
+  Enabled: true

data/config/other-metrics.yml

@@ -0,0 +1,11 @@
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/config/other-style.yml

@@ -0,0 +1,386 @@
+Layout/AccessModifierIndentation:
+  Description: Check indentation of private/protected visibility modifiers.
+  Enabled: true
+  EnforcedStyle: outdent
+
+Naming/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+
+Style/Alias:
+  Description: 'Use alias_method instead of alias.'
+  Enabled: false
+
+Layout/AlignHash:
+  Description: >-
+    Align the elements of a hash literal if they span more than
+    one line.
+  Enabled: false
+
+Layout/AlignParameters:
+  Description: >-
+    Align the parameters of a method call if they span more
+    than one line.
+  Enabled: false
+
+Style/ArrayJoin:
+  Description: 'Use Array#join instead of Array#*.'
+  Enabled: false
+
+Style/AsciiComments:
+  Description: 'Use only ascii symbols in comments.'
+  Enabled: false
+
+Naming/AsciiIdentifiers:
+  Description: 'Use only ascii symbols in identifiers.'
+  Enabled: false
+
+Style/Attr:
+  Description: 'Checks for uses of Module#attr.'
+  Enabled: false
+
+Style/BeginBlock:
+  Description: 'Avoid the use of BEGIN blocks.'
+  Enabled: false
+
+Style/BlockComments:
+  Description: 'Do not use block comments.'
+  Enabled: false
+
+Metrics/BlockNesting:
+  Description: 'Avoid excessive block nesting'
+  Enabled: false
+
+Style/BlockDelimiters:
+  Description: >-
+    Avoid using {...} for multi-line blocks (multiline chaining is
+    always ugly).
+    Prefer {...} over do...end for single-line blocks.
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Description: 'Enforce braces style inside hash parameters.'
+  Enabled: true
+
+Style/CaseEquality:
+  Description: 'Avoid explicit use of the case equality operator(===).'
+  Enabled: false
+
+Style/CharacterLiteral:
+  Description: 'Checks for uses of character literals.'
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Description: 'Checks style of children classes and modules.'
+  Enabled: false
+
+Metrics/ClassLength:
+  Description: 'Avoid classes longer than 100 lines of code.'
+  Enabled: false
+
+Style/CollectionMethods:
+  Description: 'Preferred collection methods.'
+  Enabled: false
+
+Style/ColonMethodCall:
+  Description: 'Do not use :: for method call.'
+  Enabled: false
+
+Style/CommentAnnotation:
+  Description: >-
+    Checks formatting of special comments
+    (TODO, FIXME, OPTIMIZE, HACK, REVIEW).
+  Enabled: false
+
+Layout/CommentIndentation:
+  Description: 'Indentation of comments.'
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Description: 'Avoid complex methods.'
+  Enabled: false
+
+Style/PreferredHashMethods:
+  Description: 'Checks for use of deprecated Hash methods.'
+  Enabled: false
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+Layout/DotPosition:
+  Description: 'Checks the position of the dot in multi-line method calls.'
+  Enabled: false
+
+Style/DoubleNegation:
+  Description: 'Checks for uses of double negation (!!).'
+  Enabled: false
+
+Style/EachWithObject:
+  Description: 'Prefer `each_with_object` over `inject` or `reduce`.'
+  Enabled: false
+
+Layout/EmptyLinesAroundAccessModifier:
+  Description: "Keep blank lines around access modifiers."
+  Enabled: true
+
+Layout/EmptyLines:
+  Description: "Keeps track of empty lines around expression bodies."
+  Enabled: false
+
+Style/EmptyLiteral:
+  Description: 'Prefer literals to Array.new/Hash.new/String.new.'
+  Enabled: false
+
+Style/Encoding:
+  Description: 'Use UTF-8 as the source file encoding.'
+  Enabled: false
+
+Style/EndBlock:
+  Description: 'Avoid the use of END blocks.'
+  Enabled: false
+
+Style/EvenOdd:
+  Description: 'Favor the use of Fixnum#even? && Fixnum#odd?'
+  Enabled: false
+
+Naming/FileName:
+  Description: 'Use snake_case for source file names.'
+  Enabled: false
+
+Lint/FlipFlop:
+  Description: 'Checks for flip flops'
+  Enabled: false
+
+Style/FormatString:
+  Description: 'Enforce the use of Kernel#sprintf, Kernel#format or String#%.'
+  Enabled: false
+
+Style/GlobalVars:
+  Description: 'Do not introduce global variables.'
+  Enabled: false
+
+Style/GuardClause:
+  Description: 'Check for conditionals that can be replaced with guard clauses'
+  Enabled: false
+
+Style/IfWithSemicolon:
+  Description: 'Never use if x; .... Use the ternary operator instead.'
+  Enabled: false
+
+Layout/IndentFirstArrayElement:
+  Description: >-
+    Checks the indentation of the first element in an array
+    literal.
+  Enabled: false
+
+Layout/IndentFirstHashElement:
+  Description: 'Checks the indentation of the first key in a hash literal.'
+  Enabled: false
+
+Style/Lambda:
+  Description: 'Use the new lambda literal syntax for single-line blocks.'
+  Enabled: false
+
+Style/LambdaCall:
+  Description: 'Use lambda.call(...) instead of lambda.(...).'
+  Enabled: false
+
+Layout/LeadingCommentSpace:
+  Description: 'Comments should start with a space.'
+  Enabled: false
+
+Style/LineEndConcatenation:
+  Description: >-
+    Use \ instead of + or << to concatenate two string literals at
+    line end.
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Description: >-
+    Checks if the method definitions have or don't have
+    parentheses.
+  Enabled: false
+
+Metrics/MethodLength:
+  Description: 'Avoid methods longer than 10 lines of code.'
+  Enabled: false
+
+Style/ModuleFunction:
+  Description: 'Checks for usage of `extend self` in modules.'
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/NegatedIf:
+  Description: >-
+    Favor unless over if for negative conditions
+    (or control flow or).
+  Enabled: false
+
+Style/NegatedWhile:
+  Description: 'Favor until over while for negative conditions.'
+  Enabled: false
+
+Style/Next:
+  Description: 'Use `next` to skip iteration instead of a condition at the end.'
+  Enabled: false
+
+Style/NilComparison:
+  Description: 'Prefer x.nil? to x == nil.'
+  Enabled: false
+
+Style/NonNilCheck:
+  Description: 'Checks for redundant nil checks.'
+  Enabled: false
+
+Style/Not:
+  Description: 'Use ! instead of not.'
+  Enabled: false
+
+Style/NumericLiterals:
+  Description: >-
+    Add underscores to large numeric literals to improve their
+    readability.
+  Enabled: false
+
+Metrics/ParameterLists:
+  Description: 'Avoid parameter lists longer than three or four parameters.'
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Description: 'Use `%`-literal delimiters consistently'
+  Enabled: false
+
+Style/PerlBackrefs:
+  Description: 'Avoid Perl-style regex back references.'
+  Enabled: false
+
+Naming/PredicateName:
+  Description: 'Check the names of predicate methods.'
+  Enabled: false
+
+Style/Proc:
+  Description: 'Use proc instead of Proc.new.'
+  Enabled: false
+
+Style/RaiseArgs:
+  Description: 'Checks the arguments passed to raise/fail.'
+  Enabled: false
+
+Style/RedundantBegin:
+  Description: "Don't use begin blocks when they are not needed."
+  Enabled: false
+
+Style/RedundantException:
+  Description: "Checks for an obsolete RuntimeException argument in raise/fail."
+  Enabled: false
+
+Style/RedundantSelf:
+  Description: "Don't use self where it's not needed."
+  Enabled: false
+
+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
+
+Style/RescueModifier:
+  Description: 'Avoid using rescue in its modifier form.'
+  Enabled: false
+
+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
+
+Style/SelfAssignment:
+  Description: 'Checks for places where self-assignment shorthand should have been used.'
+  Enabled: false
+
+Style/Semicolon:
+  Description: "Don't use semicolons to terminate expressions."
+  Enabled: false
+
+Style/SignalException:
+  Description: 'Checks for proper usage of fail and raise.'
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Description: 'Enforces the names of some block params.'
+  Enabled: false
+
+Style/SingleLineMethods:
+  Description: 'Avoid single-line methods.'
+  Enabled: false
+
+Layout/SpaceBeforeFirstArg:
+  Description: >-
+    Checks that exactly one space is used between a method name
+    and the first argument for method calls without parentheses.
+  Enabled: false
+
+Layout/SpaceAroundKeyword:
+  Description: 'Use spaces after if/elsif/unless/while/until/case/when.'
+  Enabled: false
+
+Layout/SpaceAfterNot:
+  Description: Tracks redundant space after the ! operator.
+  Enabled: false
+
+Layout/SpaceBeforeComment:
+  Description: >-
+    Checks for missing space between code and a comment on the
+    same line.
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  Description: >-
+    Checks that block braces have or don't have surrounding space.
+    For blocks taking parameters, checks that the left brace has
+    or doesn't have trailing space.
+  Enabled: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  Description: "Use spaces inside hash literal braces - or don't."
+  Enabled: true
+
+Style/SpecialGlobalVars:
+  Description: 'Avoid Perl-style global variables.'
+  Enabled: false
+
+Style/RedundantCapitalW:
+  Description: 'Checks for %W when interpolation is not needed.'
+  Enabled: false
+
+Style/CommandLiteral:
+  Description: 'Checks for %x when `` would do.'
+  Enabled: false
+
+Style/VariableInterpolation:
+  Description: >-
+    Don't interpolate global, instance and class variables
+    directly in strings.
+  Enabled: false
+
+Style/WhenThen:
+  Description: 'Use when x then ... for one-line cases.'
+  Enabled: false
+
+Style/WhileUntilDo:
+  Description: 'Checks for redundant do after while or until.'
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Description: >-
+    Favor modifier while/until usage when you have a
+    single-line body.
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/config/rails.yml

@@ -0,0 +1,41 @@
+##################### Rails ##################################
+
+# By default Rails is switched off so this can be used by non-Rails apps,
+# this can be enabled in a local .rubocop.yml file
+
+require: rubocop-rails
+
+Rails:
+  Enabled: true
+
+Rails/ActionFilter:
+  Description: 'Enforces consistent use of action filter methods.'
+  Enabled: false
+
+Rails/Delegate:
+  Description: 'Prefer delegate method for delegations.'
+  Enabled: false
+
+Rails/HasAndBelongsToMany:
+  Description: 'Prefer has_many :through to has_and_belongs_to_many.'
+  Enabled: false
+
+Rails/Output:
+  Description: 'Checks for calls to puts, print, etc.'
+  Enabled: false
+
+Rails/ReadWriteAttribute:
+  Description: 'Checks for read_attribute(:attr) and write_attribute(:attr, val).'
+  Enabled: false
+
+Rails/ScopeArgs:
+  Description: 'Checks the arguments of ActiveRecord scopes.'
+  Enabled: false
+
+Rails/Validation:
+  Description: 'Use sexy validations.'
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Description: 'Avoid methods that skip model validations.'
+  Enabled: false

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-govuk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Government Digital Service
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.76'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.76'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+description: Shared RuboCop rules for Ruby projects in GOV.UK
+email:
+- govuk-dev@digital.cabinet-office.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- config/default.yml
+- config/gds-ruby-styleguide.yml
+- config/other-excludes.yml
+- config/other-lint.yml
+- config/other-metrics.yml
+- config/other-style.yml
+- config/rails.yml
+homepage: https://github.com/alphagov/rubocop-govuk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: RuboCop GOV.UK
+test_files: []