gitlab-styles 4.0.0 → 5.1.0

data/rubocop-lint.yml

@@ -1,3 +1,4 @@
+---
 # Checks for ambiguous block association with method when param passed without
 # parentheses.
 Lint/AmbiguousBlockAssociation:
@@ -18,6 +19,10 @@ Lint/AmbiguousRegexpLiteral:
 Lint/AssignmentInCondition:
   Enabled: false
 
+# Checks for places where binary operator has identical operands
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
 # Default values in optional keyword arguments and optional ordinal arguments
 # should not refer back to the name of the argument.
 Lint/CircularArgumentReference:
@@ -31,6 +36,22 @@ Lint/Debugger:
 Lint/DeprecatedClassMethods:
   Enabled: true
 
+# Algorithmic constants for OpenSSL::Cipher and OpenSSL::Digest deprecated since OpenSSL version 2.2.0.
+# Prefer passing a string instead.
+# https://docs.rubocop.org/rubocop/0.89/cops_lint.html#lintdeprecatedopensslconstant
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+# Checks that there are no repeated conditions used in if 'elsif'.
+# https://docs.rubocop.org/rubocop/0.89/cops_lint.html#lintduplicateelsifcondition
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+# Checks that there are no repeated exceptions used in 'rescue' expressions.
+# https://docs.rubocop.org/rubocop/0.89/cops_lint.html#lintduplicaterescueexception
+Lint/DuplicateRescueException:
+  Enabled: true
+
 # Check for immutable argument given to each_with_object.
 Lint/EachWithObjectArgument:
   Enabled: true
@@ -39,6 +60,11 @@ Lint/EachWithObjectArgument:
 Lint/ElseLayout:
   Enabled: true
 
+# Checks for the presence of if, elsif and unless branches without a body.
+# https://docs.rubocop.org/rubocop/0.89/cops_lint.html#lintemptyconditionalbody
+Lint/EmptyConditionalBody:
+  Enabled: true
+
 # Checks for empty ensure block.
 Lint/EmptyEnsure:
   Enabled: true
@@ -55,6 +81,11 @@ Lint/EnsureReturn:
 Lint/FlipFlop:
   Enabled: true
 
+# Checks for the presence of precise comparison of floating point numbers.
+# https://docs.rubocop.org/rubocop/0.89/cops_lint.html#lintfloatcomparison
+Lint/FloatComparison:
+  Enabled: true
+
 # Catches floating-point literals too large or small for Ruby to represent.
 Lint/FloatOutOfRange:
   Enabled: true
@@ -81,10 +112,21 @@ Lint/LiteralAsCondition:
 Lint/LiteralInInterpolation:
   Enabled: true
 
-# This cop checks for uses of *begin...end while/until something*.
+# Checks for uses of *begin...end while/until something*.
 Lint/Loop:
   Enabled: false
 
+# Checks for the presence of constructors and lifecycle callbacks without calls to super.
+# https://docs.rubocop.org/rubocop/0.89/cops_lint.html#lintmissingsuper
+Lint/MissingSuper:
+  Enabled: false
+
+# Do not mix named captures and numbered captures in a Regexp literal
+# because numbered capture is ignored if they’re mixed.
+# https://docs.rubocop.org/rubocop/0.89/cops_lint.html#lintmixedregexpcapturetypes
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
 # Do not use nested method definitions.
 Lint/NestedMethodDefinition:
   Enabled: true
@@ -93,6 +135,11 @@ Lint/NestedMethodDefinition:
 Lint/NextWithoutAccumulator:
   Enabled: true
 
+# Looks for references of Regexp captures that are out of range and thus always returns nil.
+# https://docs.rubocop.org/rubocop/0.89/cops_lint.html#lintoutofrangeregexpref
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
 # Checks for method calls with a space before the opening parenthesis.
 Lint/ParenthesesAsGroupedExpression:
   Enabled: true
@@ -126,6 +173,11 @@ Lint/RescueException:
 Lint/SafeNavigationWithEmpty:
   Enabled: true
 
+# Checks for self-assignments.
+# https://docs.rubocop.org/rubocop/0.89/cops_lint.html#lintselfassignment
+Lint/SelfAssignment:
+  Enabled: true
+
 # Checks for the order which exceptions are rescued to avoid rescueing a less specific exception before a more specific exception.
 Lint/ShadowedException:
   Enabled: false
@@ -143,6 +195,11 @@ Lint/StructNewOverride:
 Lint/SuppressedException:
   Enabled: false
 
+# Checks for top level return with arguments.
+# https://docs.rubocop.org/rubocop/0.89/cops_lint.html#linttoplevelreturnwithargument
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
 # Do not use prefix `_` for a variable that is used.
 Lint/UnderscorePrefixedVariableName:
   Enabled: true
@@ -155,6 +212,11 @@ Lint/UnifiedInteger:
 Lint/UnreachableCode:
   Enabled: true
 
+# Checks for loops that will have at most one iteration.
+# https://docs.rubocop.org/rubocop/0.89/cops_lint.html#lintunreachableloop
+Lint/UnreachableLoop:
+  Enabled: true
+
 # This cop checks for unused block arguments.
 Lint/UnusedBlockArgument:
   Enabled: false
@@ -172,10 +234,6 @@ Lint/UselessAccessModifier:
 Lint/UselessAssignment:
   Enabled: true
 
-# Checks for comparison of something with itself.
-Lint/UselessComparison:
-  Enabled: true
-
 # Checks for useless `else` in `begin..end` without `rescue`.
 Lint/UselessElseWithoutRescue:
   Enabled: true

data/rubocop-metrics.yml

@@ -1,3 +1,4 @@
+---
 # A calculated magnitude based on number of assignments,
 # branches, and conditions.
 Metrics/AbcSize:

data/rubocop-migrations.yml

@@ -0,0 +1,22 @@
+---
+# Checks for methods that may lead to batch type issues on a table that's been
+# explicitly denied because of its size.
+#
+# Even though these methods perform functions to avoid
+# downtime, using it with tables with millions of rows still causes a
+# significant delay in the deploy process and is best avoided.
+#
+# See https://gitlab.com/gitlab-com/infrastructure/issues/1602 for more
+# information.
+# The default can be changed as follows:
+#     Migration/UpdateLargeTable:
+#       DeniedTables:
+#         - :usage_data
+#         - :version_checks
+#       DeniedMethods:
+#         - :add_column_with_default
+#         - :change_column_type_concurrently
+#         - :rename_column_concurrently
+#         - :update_column_in_batches
+Migration/UpdateLargeTable:
+  Enabled: false

data/rubocop-naming.yml

@@ -1,3 +1,4 @@
+---
 # Check the naming of accessor methods for get_/set_.
 Naming/AccessorMethodName:
   Enabled: false

data/rubocop-performance.yml

@@ -1,3 +1,15 @@
+---
+# Used to identify usages of ancestors.include? and change them to use ⇐ instead.
+# https://docs.rubocop.org/rubocop-performance/1.8/cops_performance.html#performanceancestorsinclude
+Performance/AncestorsInclude:
+  Enabled: true
+
+# Identifies places where numeric argument to BigDecimal should be converted to string.
+# Initializing from String is faster than from Numeric for BigDecimal.
+# https://docs.rubocop.org/rubocop-performance/1.8/cops_performance.html#performancebigdecimalwithnumericargument
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+
 # Use `caller(n..n)` instead of `caller`.
 Performance/Caller:
   Enabled: false
@@ -31,17 +43,53 @@ Performance/RedundantMerge:
   Enabled: true
   MaxKeyValuePairs: 1
 
+# Identifies places where sort { |a, b| a <=> b } can be replaced with sort.
+# https://docs.rubocop.org/rubocop-performance/1.7/cops_performance.html#performanceredundantsortblock
+Performance/RedundantSortBlock:
+  Enabled: true
+
+# Checks for redundant String#chars.
+# https://docs.rubocop.org/rubocop-performance/1.8/cops_performance.html#performanceredundantstringchars
+Performance/RedundantStringChars:
+  Enabled: true
+
+# Identifies places where reverse.first(n) and reverse.first can be replaced by last(n).reverse and last.
+# https://docs.rubocop.org/rubocop-performance/1.8/cops_performance.html#performancereversefirst
+Performance/ReverseFirst:
+  Enabled: true
+
+# Identifies places where sort { |a, b| b <=> a } can be replaced by a faster sort.reverse.
+# https://docs.rubocop.org/rubocop-performance/1.8/cops_performance.html#performancesortreverse
+Performance/SortReverse:
+  Enabled: true
+
+# Identifies places where gsub(/a+/, 'a') and gsub!(/a+/, 'a') can be replaced by squeeze('a') and squeeze!('a').
+# https://docs.rubocop.org/rubocop-performance/1.8/cops_performance.html#performancesqueeze
+Performance/Squeeze:
+  Enabled: true
+
 # Use `start_with?` instead of a regex match anchored to the beginning of a
 # string.
 Performance/StartWith:
   Enabled: true
 
+# Identifies unnecessary use of a regex where String#include? would suffice.
+# https://docs.rubocop.org/rubocop-performance/1.8/cops_performance.html#performancestringinclude
+Performance/StringInclude:
+  Enabled: true
+
 # Use `tr` instead of `gsub` when you are replacing the same number of
 # characters. Use `delete` instead of `gsub` when you are deleting
 # characters.
 Performance/StringReplacement:
   Enabled: true
 
+# Identifies places where custom code finding the sum of elements in some
+# Enumerable object can be replaced by Enumerable#sum method.
+# https://docs.rubocop.org/rubocop-performance/1.8/cops_performance.html#performancesum
+Performance/Sum:
+  Enabled: true
+
 # Checks for `.times.map` calls.
 Performance/TimesMap:
   Enabled: true

data/rubocop-rails.yml

@@ -1,3 +1,4 @@
+---
 # Enables Rails cops.
 Rails:
   Enabled: true
@@ -7,6 +8,18 @@ Rails/ActionFilter:
   Enabled: true
   EnforcedStyle: action
 
+# Checks that Active Record callbacks are declared in the order in which they will be executed.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railsactiverecordcallbacksorder
+Rails/ActiveRecordCallbacksOrder:
+  Enabled: true
+
+# Enforces that there is only one call to after_commit
+# (and its aliases - after_create_commit, after_update_commit, and after_destroy_commit)
+# with the same callback name per model.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railsaftercommitoverride
+Rails/AfterCommitOverride:
+  Enabled: true
+
 # Check that models subclass ApplicationRecord.
 Rails/ApplicationRecord:
   Enabled: false
@@ -43,6 +56,12 @@ Rails/FindBy:
     - 'app/**/*.rb'
     - 'lib/**/*.rb'
 
+# Enforces that ActiveRecord#find is used instead of where.take!, find_by!, and find_by_id!
+# to retrieve a single record by primary key when you expect it to be found.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railsfindbyid
+Rails/FindById:
+  Enabled: true
+
 # Prefer `all.find_each` over `all.find`.
 Rails/FindEach:
   Enabled: true
@@ -57,6 +76,26 @@ Rails/HasAndBelongsToMany:
 Rails/HttpPositionalArguments:
   Enabled: true
 
+# Checks that Active Support’s inquiry method is not used.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railsinquiry
+Rails/Inquiry:
+  Enabled: true
+
+# Enforces that mailer names end with Mailer suffix.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railsmailername
+Rails/MailerName:
+  Enabled: true
+
+# Identifies places where defining routes with match can be replaced with a specific HTTP method.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railsmatchroute
+Rails/MatchRoute:
+  Enabled: true
+
+# Enforces the use of collection.exclude?(obj) over !collection.include?(obj).
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railsnegateinclude
+Rails/NegateInclude:
+  Enabled: true
+
 # Checks for calls to puts, print, etc.
 Rails/Output:
   Enabled: true
@@ -71,6 +110,16 @@ Rails/Output:
 Rails/OutputSafety:
   Enabled: false
 
+# Enforces the use of pluck over map.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railspluck
+Rails/Pluck:
+  Enabled: true
+
+# Identifies places where pluck is used in where query methods and can be replaced with select.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railspluckinwhere
+Rails/PluckInWhere:
+  Enabled: true
+
 # Checks for incorrect grammar when using methods like `3.day.ago`.
 Rails/PluralizationGrammar:
   Enabled: true
@@ -87,10 +136,30 @@ Rails/ReadWriteAttribute:
 Rails/RelativeDateConstant:
   Enabled: false
 
+# Looks for inline rendering within controller actions.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railsrenderinline
+Rails/RenderInline:
+  Enabled: true
+
+# Identifies places where render text: can be replaced with render plain:.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railsrenderplaintext
+Rails/RenderPlainText:
+  Enabled: true
+
 # Checks the arguments of ActiveRecord scopes.
 Rails/ScopeArgs:
   Enabled: true
 
+# Enforces that short forms of I18n methods are used: t instead of translate and l instead of localize.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railsshorti18n
+Rails/ShortI18n:
+  Enabled: true
+
+# Checks SQL heredocs to use .squish.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railssquishedsqlheredocs
+Rails/SquishedSQLHeredocs:
+  Enabled: true
+
 # This cop checks for the use of Time methods without zone.
 Rails/TimeZone:
   Enabled: false
@@ -98,3 +167,13 @@ Rails/TimeZone:
 # This cop checks for the use of old-style attribute validation macros.
 Rails/Validation:
   Enabled: true
+
+# Enforces consistent style when using exists?.
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railswhereexists
+Rails/WhereExists:
+  Enabled: true
+
+# Identifies places where manually constructed SQL in where can be replaced with where.not(...).
+# https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railswherenot
+Rails/WhereNot:
+  Enabled: true

data/rubocop-rspec.yml

@@ -1,3 +1,4 @@
+---
 # Check that instances are not being stubbed globally.
 RSpec/AnyInstance:
   Enabled: false
@@ -36,6 +37,14 @@ RSpec/EmptyExampleGroup:
     - it_should_email!
     - it_should_not_email!
 
+# Checks if there is an empty line after let blocks.
+RSpec/EmptyLineAfterLetBlock:
+  Enabled: true
+
+# Checks if there is an empty line after shared example blocks.
+RSpec/EmptyLineAfterSharedExample:
+  Enabled: true
+
 # Checks for long example.
 RSpec/ExampleLength:
   Enabled: false
@@ -134,6 +143,11 @@ RSpec/SingleLineHook:
     - 'spec/factories/*'
     - 'spec/requests/api/v3/*'
 
+# Checks that message expectations do not have a configured response.
+# https://docs.rubocop.org/rubocop-rspec/1.44/cops_rspec.html#rspecstubbedmock
+RSpec/StubbedMock:
+  Enabled: false
+
 # Checks for stubbed test subjects.
 RSpec/SubjectStub:
   Enabled: false

data/rubocop-security.yml

@@ -1,3 +1,4 @@
+---
 # This cop checks for the use of JSON class methods which have potential
 # security issues.
 Security/JSONLoad:

data/rubocop-style.yml

@@ -1,3 +1,9 @@
+---
+# Checks for grouping of accessors in class and module bodies.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleaccessorgrouping
+Style/AccessorGrouping:
+  Enabled: true
+
 # Use alias_method instead of alias.
 Style/Alias:
   EnforcedStyle: prefer_alias_method
@@ -8,6 +14,11 @@ Style/Alias:
 Style/AndOr:
   Enabled: true
 
+# Enforces the use of Array() instead of explicit Array check or [*var]
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#stylearraycoercion
+Style/ArrayCoercion:
+  Enabled: true
+
 # Use `Array#join` instead of `Array#*`.
 Style/ArrayJoin:
   Enabled: true
@@ -24,6 +35,11 @@ Style/Attr:
 Style/BeginBlock:
   Enabled: true
 
+# Checks for places where attr_reader and attr_writer for the same method can be combined into single attr_accessor.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#stylebisectedattraccessor
+Style/BisectedAttrAccessor:
+  Enabled: true
+
 # Do not use block comments.
 Style/BlockComments:
   Enabled: true
@@ -33,10 +49,15 @@ Style/BlockComments:
 Style/BlockDelimiters:
   Enabled: true
 
-# This cop checks for uses of the case equality operator(===).
+# Checks for uses of the case equality operator(===).
 Style/CaseEquality:
   Enabled: false
 
+# Identifies places where if-elsif constructions can be replaced with case-when.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#stylecaselikeif
+Style/CaseLikeIf:
+  Enabled: true
+
 # Checks for uses of character literals.
 Style/CharacterLiteral:
   Enabled: true
@@ -95,6 +116,12 @@ Style/EndBlock:
 Style/EvenOdd:
   Enabled: true
 
+# Enforces the use of explicit block argument to avoid writing block literal that
+# just passes its arguments to another block.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleexplicitblockargument
+Style/ExplicitBlockArgument:
+  Enabled: true
+
 # Enforces consistency when using exponential notation for numbers in the code
 Style/ExponentialNotation:
   Enabled: true
@@ -111,6 +138,13 @@ Style/FormatStringToken:
 Style/FrozenStringLiteralComment:
   Enabled: true
 
+# Enforces the use of $stdout/$stderr/$stdin instead of STDOUT/STDERR/STDIN. STDOUT/STDERR/STDIN are constants,
+# and while you can actually reassign (possibly to redirect some stream) constants in Ruby,
+# you’ll get an interpreter warning if you do so.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleglobalstdstream
+Style/GlobalStdStream:
+  Enabled: true
+
 # Do not introduce global variables.
 Style/GlobalVars:
   Enabled: true
@@ -118,10 +152,20 @@ Style/GlobalVars:
     - 'lib/backup/**/*'
     - 'lib/tasks/**/*'
 
+# Checks for presence or absence of braces around hash literal as a last array item depending on configuration.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#stylehashaslastarrayitem
+Style/HashAsLastArrayItem:
+  Enabled: true
+
 # Checks for uses of each_key and each_value Hash methods.
 Style/HashEachMethods:
   Enabled: true
 
+# Checks for places where case-when represents a simple 1:1 mapping and can be replaced with a hash lookup.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#stylehashlikecase
+Style/HashLikeCase:
+  Enabled: false
+
 # Prefer Ruby 1.9 hash syntax `{ a: 1, b: 2 }`
 # over 1.8 syntax `{ :a => 1, :b => 2 }`.
 Style/HashSyntax:
@@ -161,6 +205,11 @@ Style/InverseMethods:
 Style/LambdaCall:
   Enabled: true
 
+# Checks for places where keyword arguments can be used instead of boolean arguments when defining methods.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleoptionalbooleanparameter
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 # Use `strip` instead of `lstrip.rstrip`.
 Style/Strip:
   Enabled: true
@@ -248,10 +297,25 @@ Style/PreferredHashMethods:
 Style/RedundantCapitalW:
   Enabled: true
 
+# Checks for redundant assignment before returning.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleredundantassignment
+Style/RedundantAssignment:
+  Enabled: true
+
 # Checks for an obsolete RuntimeException argument in raise/fail.
 Style/RedundantException:
   Enabled: true
 
+# Identifies places where fetch(key) { value } can be replaced by fetch(key, value).
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleredundantfetchblock
+Style/RedundantFetchBlock:
+  Enabled: true
+
+# Checks for the presence of superfluous .rb extension in the filename provided to require and require_relative.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleredundantfileextensioninrequire
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
 # Checks for parentheses that seem not to serve any purpose.
 Style/RedundantParentheses:
   Enabled: true
@@ -260,6 +324,16 @@ Style/RedundantParentheses:
 Style/RedundantPercentQ:
   Enabled: false
 
+# Checks for unnecessary single-element Regexp character classes.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleredundantregexpcharacterclass
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+# Checks for redundant escapes inside Regexp literals.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleredundantregexpescape
+Style/RedundantRegexpEscape:
+  Enabled: true
+
 # Use `sort` instead of `sort_by { |x| x }`.
 Style/RedundantSortBy:
   Enabled: true
@@ -268,16 +342,31 @@ Style/RedundantSortBy:
 Style/Semicolon:
   Enabled: true
 
+# Sometimes using dig method ends up with just a single argument. In such cases, dig should be replaced with [].
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#stylesingleargumentdig
+Style/SingleArgumentDig:
+  Enabled: true
+
 # Checks for proper usage of fail and raise.
 Style/SignalException:
   EnforcedStyle: only_raise
   Enabled: true
 
+# Checks that arrays are sliced with endless ranges instead of ary[start..-1] on Ruby 2.6+.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleslicingwithrange
+Style/SlicingWithRange:
+  Enabled: true
+
 # Check for the usage of parentheses around stabby lambda arguments.
 Style/StabbyLambdaParentheses:
   EnforcedStyle: require_parentheses
   Enabled: true
 
+# Checks for places where string concatenation can be replaced with string interpolation.
+# https://docs.rubocop.org/rubocop/0.89/cops_style.html#stylestringconcatenation
+Style/StringConcatenation:
+  Enabled: true
+
 # Checks if uses of quotes match the configured preference.
 Style/StringLiterals:
   Enabled: false