gitlab-styles 3.2.0 → 5.1.0

data/rubocop-metrics.yml

@@ -1,3 +1,4 @@
+---
 # A calculated magnitude based on number of assignments,
 # branches, and conditions.
 Metrics/AbcSize:
@@ -23,10 +24,6 @@ Metrics/CyclomaticComplexity:
   Enabled: true
   Max: 13
 
-# Limit lines to 80 characters.
-Metrics/LineLength:
-  Enabled: false
-
 # Avoid methods longer than 10 lines of code.
 Metrics/MethodLength:
   Enabled: false

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
@@ -30,6 +31,13 @@ Naming/MemoizedInstanceVariableName:
 Naming/MethodName:
   Enabled: true
 
+# Method parameter names for how descriptive they are.
+Naming/MethodParameterName:
+  Enabled: true
+  MinNameLength: 2
+  AllowedNames:
+    - _
+
 # Use `spam?` instead of `is_spam?`
 # Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
 # NamePrefix: is_, has_, have_
@@ -37,18 +45,11 @@ Naming/MethodName:
 # NameWhitelist: is_a?
 Naming/PredicateName:
   Enabled: true
-  NamePrefixBlacklist: is_
+  ForbiddenPrefixes: is_
   Exclude:
     - 'spec/**/*'
     - 'features/**/*'
 
-# Method parameter names for how descriptive they are.
-Naming/UncommunicativeMethodParamName:
-  Enabled: true
-  MinNameLength: 2
-  AllowedNames:
-    - _
-
 # Use the configured style when naming variables.
 Naming/VariableName:
   EnforcedStyle: snake_case

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,15 +49,15 @@ Style/BlockComments:
 Style/BlockDelimiters:
   Enabled: true
 
- # This cop checks for braces around the last parameter in a method call
-# if the last parameter is a hash.
-Style/BracesAroundHashParameters:
-  Enabled: false
-
-# 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
@@ -100,6 +116,16 @@ 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
+
 # Checks use of for or each in multiline loops.
 Style/For:
   Enabled: true
@@ -110,7 +136,14 @@ Style/FormatStringToken:
 
 # Checks if there is a magic comment to enforce string literals
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  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:
@@ -119,11 +152,37 @@ 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:
   Enabled: true
 
+# looks for uses of _.each_with_object({}) {...}, _.map {...}.to_h, and Hash[_.map {...}]
+# that are actually just transforming the keys of a hash, and tries to use a simpler & faster
+# call to transform_keys instead.
+Style/HashTransformKeys:
+  Enabled: true
+
+# looks for uses of _.each_with_object({}) {...}, _.map {...}.to_h, and Hash[_.map {...}]
+# that are actually just transforming the values of a hash, and tries to use a simpler & faster
+# call to transform_values instead.
+Style/HashTransformValues:
+  Enabled: true
+
 # Checks that conditional statements do not have an identical line at the
 # end of each branch, which can validly be moved out of the conditional.
 Style/IdenticalConditionalBranches:
@@ -146,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
@@ -229,14 +293,47 @@ Style/ParenthesesAroundCondition:
 Style/PreferredHashMethods:
   Enabled: false
 
+# Checks for %W when interpolation is not needed.
+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
 
+# Checks for %q/%Q when single quotes or double quotes would do.
+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
@@ -245,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
@@ -284,14 +396,6 @@ Style/TrailingCommaInArguments:
   Enabled: true
   EnforcedStyleForMultiline: no_comma
 
-# Checks for %W when interpolation is not needed.
-Style/UnneededCapitalW:
-  Enabled: true
-
-# Checks for %q/%Q when single quotes or double quotes would do.
-Style/UnneededPercentQ:
-  Enabled: false
-
 # Don't interpolate global, instance and class variables directly in strings.
 Style/VariableInterpolation:
   Enabled: true