gitlab-styles 3.2.0 → 5.1.0

data/lib/gitlab/styles/rubocop/cop/rspec/single_line_hook.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'rubocop-rspec'
+require_relative 'base'
 
 module Gitlab
   module Styles
@@ -21,8 +24,8 @@ module Gitlab
           #   after(:each) do
           #     undo_something
           #   end
-          class SingleLineHook < RuboCop::Cop::RSpec::Cop
-            MESSAGE = "Don't use single-line hook blocks.".freeze
+          class SingleLineHook < Base
+            MESSAGE = "Don't use single-line hook blocks."
 
             def_node_search :rspec_hook?, <<~PATTERN
               (send nil? {:after :around :before} ...)
@@ -32,7 +35,7 @@ module Gitlab
               return unless node.single_line?
               return unless rspec_hook?(node)
 
-              add_offense(node, location: :expression, message: MESSAGE)
+              add_offense(node, message: MESSAGE)
             end
           end
         end

data/lib/gitlab/styles/rubocop/cop/rspec/verbose_include_metadata.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'rubocop-rspec'
+require_relative 'base'
 
 module Gitlab
   module Styles
@@ -15,8 +18,10 @@ module Gitlab
           #   # good
           #   describe MyClass, :js do
           #   end
-          class VerboseIncludeMetadata < RuboCop::Cop::RSpec::Cop
-            MSG = 'Use `%s` instead of `%s`.'.freeze
+          class VerboseIncludeMetadata < Base
+            extend RuboCop::Cop::AutoCorrector
+
+            MSG = 'Use `%s` instead of `%s`.'
 
             SELECTORS = %i[describe context feature example_group it specify example scenario its].freeze
 
@@ -35,25 +40,19 @@ module Gitlab
 
             def on_send(node)
               invalid_metadata_matches(node) do |match|
-                add_offense(node, location: :expression, message: format(MSG, good(match), bad(match)))
-              end
-            end
-
-            def autocorrect(node)
-              lambda do |corrector|
-                invalid_metadata_matches(node) do |match|
-                  corrector.replace(match.loc.expression, good(match))
+                add_offense(node, message: format(MSG, good(match), bad(match))) do |corrector|
+                  invalid_metadata_matches(node) do |match|
+                    corrector.replace(match.loc.expression, good(match))
+                  end
                 end
               end
             end
 
             private
 
-            def invalid_metadata_matches(node)
+            def invalid_metadata_matches(node, &block)
               include_metadata(node) do |matches|
-                matches.select(&method(:invalid_metadata?)).each do |match|
-                  yield match
-                end
+                matches.select(&method(:invalid_metadata?)).each(&block)
               end
             end
 

data/lib/gitlab/styles/rubocop/cop/without_reactive_cache.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
       module Cop
         # Cop that prevents the use of `without_reactive_cache`
         class WithoutReactiveCache < RuboCop::Cop::Cop
-          MSG = 'without_reactive_cache is for debugging purposes only. Please use with_reactive_cache.'.freeze
+          MSG = 'without_reactive_cache is for debugging purposes only. Please use with_reactive_cache.'
 
           def on_send(node)
             return unless node.children[1] == :without_reactive_cache

data/lib/gitlab/styles/rubocop/migration_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop

data/lib/gitlab/styles/rubocop/model_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
@@ -5,7 +7,7 @@ module Gitlab
         # Returns true if the given node originated from the models directory.
         def in_model?(node)
           path = node.location.expression.source_buffer.name
-          pwd = RuboCop::PathUtil.pwd
+          pwd = Dir.pwd
           models_path = File.join(pwd, 'app', 'models')
           ee_models_path = File.join(pwd, 'ee', 'app', 'models')
 

data/lib/gitlab/styles/rubocop/rspec/helpers.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Rspec
+        module Helpers
+          include RuboCop::RSpec::Language
+
+          LET = SelectorSet.new(%i[let_it_be]) + RuboCop::RSpec::Language::Helpers::ALL
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
-    VERSION = '3.2.0'.freeze
+    VERSION = '5.1.0'
   end
 end

data/rubocop-all.yml

@@ -1,5 +1,6 @@
+---
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
   # Cop names are not displayed in offense messages by default. Change behavior
   # by overriding DisplayCopNames, or by giving the -D/--display-cop-names
   # option.

data/rubocop-bundler.yml

@@ -1,3 +1,4 @@
+---
 # Gems in consecutive lines should be alphabetically sorted
 Bundler/OrderedGems:
   Enabled: false

data/rubocop-code_reuse.yml

@@ -0,0 +1,24 @@
+# Denies the use of ActiveRecord methods outside of configured
+# excluded directories
+# Directories that allow the use of the denied methods.
+# To start we provide a default configuration that matches
+# a standard Rails app and enable.
+# The default configuration can be overridden by
+# providing your own Exclusion list as follows:
+# CodeReuse/ActiveRecord:
+#  Enabled: true
+#  Exclude:
+#    - app/models/**/*.rb
+#    - config/**/*.rb
+#    - db/**/*.rb
+#    - lib/tasks/**/*.rb
+#    - spec/**/*.rb
+#    - lib/gitlab/**/*.rb
+CodeReuse/ActiveRecord:
+  Enabled: true
+  Exclude:
+    - app/models/**/*.rb
+    - config/**/*.rb
+    - db/**/*.rb
+    - lib/tasks/**/*.rb
+    - spec/**/*.rb

data/rubocop-default.yml

@@ -1,3 +1,4 @@
+---
 require:
   - rubocop-gitlab-security
   - rubocop-performance
@@ -12,6 +13,7 @@ inherit_from:
   - rubocop-layout.yml
   - rubocop-lint.yml
   - rubocop-metrics.yml
+  - rubocop-migrations.yml
   - rubocop-naming.yml
   - rubocop-performance.yml
   - rubocop-rails.yml

data/rubocop-gemspec.yml

@@ -1,3 +1,4 @@
+---
 # Dependencies in the gemspec should be alphabetically sorted
 # Configuration parameters: Include, TreatCommentsAsGroupSeparators.
 Gemspec/OrderedDependencies:

data/rubocop-layout.yml

@@ -1,20 +1,17 @@
+---
 # Check indentation of private/protected visibility modifiers.
 Layout/AccessModifierIndentation:
   Enabled: true
 
 # Align the elements of an array literal if they span more than one line.
-Layout/AlignArray:
+Layout/ArrayAlignment:
   Enabled: true
 
-# Align the elements of a hash literal if they span more than one line.
-Layout/AlignHash:
+# Checks the indentation of the first line of the right-hand-side of a
+# multi-line assignment.
+Layout/AssignmentIndentation:
   Enabled: true
 
-# Here we check if the parameters on a multi-line method call or
-# definition are aligned.
-Layout/AlignParameters:
-  Enabled: false
-
 # Align block ends correctly.
 Layout/BlockAlignment:
   Enabled: true
@@ -64,6 +61,11 @@ Layout/EmptyLines:
 Layout/EmptyLinesAroundAccessModifier:
   Enabled: true
 
+# Checks for a newline after an attribute accessor or a group of them
+# https://docs.rubocop.org/rubocop/0.89/cops_layout.html#layoutemptylinesaroundattributeaccessor
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
 # Keeps track of empty lines around block bodies.
 Layout/EmptyLinesAroundBlockBody:
   Enabled: true
@@ -102,27 +104,36 @@ Layout/ExtraSpacing:
 Layout/FirstMethodParameterLineBreak:
   Enabled: true
 
+# Align the elements of a hash literal if they span more than one line.
+Layout/HashAlignment:
+  Enabled: true
+
+# This cops checks the indentation of the here document bodies.
+Layout/HeredocIndentation:
+  Enabled: false
+
 # Keep indentation straight.
 Layout/IndentationConsistency:
   Enabled: true
 
-# Use 2 spaces for indentation.
-Layout/IndentationWidth:
+# No hard tabs.
+Layout/IndentationStyle:
   Enabled: true
 
-# Checks the indentation of the first line of the right-hand-side of a
-# multi-line assignment.
-Layout/IndentAssignment:
+# Use 2 spaces for indentation.
+Layout/IndentationWidth:
   Enabled: true
 
-# This cops checks the indentation of the here document bodies.
-Layout/IndentHeredoc:
-  Enabled: false
-
 # Comments should start with a space.
 Layout/LeadingCommentSpace:
   Enabled: true
 
+# Limit lines to 120 characters.
+Layout/LineLength:
+  Enabled: true
+  Max: 120
+  IgnoredPatterns: ['\s#\srubocop']
+
 # Checks that the closing brace in an array literal is either on the same line
 # as the last array element, or a new line.
 Layout/MultilineArrayBraceLayout:
@@ -160,6 +171,11 @@ Layout/MultilineOperationIndentation:
   Enabled: true
   EnforcedStyle: indented
 
+# Here we check if the parameters on a multi-line method call or
+# definition are aligned.
+Layout/ParameterAlignment:
+  Enabled: false
+
 # Use spaces after colons.
 Layout/SpaceAfterColon:
   Enabled: true
@@ -189,6 +205,10 @@ Layout/SpaceAroundEqualsInParameterDefault:
 Layout/SpaceAroundKeyword:
   Enabled: true
 
+# Checks method call operators to not have spaces around them.
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
 # Use a single space around operators.
 Layout/SpaceAroundOperators:
   Enabled: true
@@ -235,12 +255,8 @@ Layout/SpaceInsideStringInterpolation:
   EnforcedStyle: no_space
   Enabled: true
 
-# No hard tabs.
-Layout/Tab:
-  Enabled: true
-
 # Checks trailing blank lines and final newline.
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Enabled: true
 
 # Avoid trailing whitespace.

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
@@ -47,10 +73,6 @@ Lint/EmptyEnsure:
 Lint/EmptyWhen:
   Enabled: true
 
-# END blocks should not be placed inside method definitions.
-Lint/EndInMethod:
-  Enabled: true
-
 # Do not use return in an ensure block.
 Lint/EnsureReturn:
   Enabled: true
@@ -59,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
@@ -67,10 +94,6 @@ Lint/FloatOutOfRange:
 Lint/FormatParameterMismatch:
   Enabled: true
 
-# This cop checks for *rescue* blocks with no body.
-Lint/HandleExceptions:
-  Enabled: false
-
 # Checks for adjacent string literals on the same line, which could better be
 # represented as a single string literal.
 Lint/ImplicitStringConcatenation:
@@ -89,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
@@ -101,15 +135,32 @@ 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
 
+# Checks for raise or fail statements which are raising Exception class.
+Lint/RaiseException:
+  Enabled: true
+
 # Checks for `rand(1)` calls. Such calls always return `0` and most likely
 # a mistake.
 Lint/RandOne:
   Enabled: true
 
+# This cop checks for unneeded usages of splat expansion
+Lint/RedundantSplatExpansion:
+  Enabled: false
+
+# Checks for Object#to_s usage in string interpolation.
+Lint/RedundantStringCoercion:
+  Enabled: true
+
 # Use parentheses in the method call to avoid confusion about precedence.
 Lint/RequireParentheses:
   Enabled: true
@@ -122,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
@@ -131,8 +187,17 @@ Lint/ShadowedException:
 Lint/ShadowingOuterLocalVariable:
   Enabled: false
 
-# Checks for Object#to_s usage in string interpolation.
-Lint/StringConversionInInterpolation:
+# Checks unexpected overrides of the Struct built-in methods via Struct.new.
+Lint/StructNewOverride:
+  Enabled: true
+
+# This cop checks for *rescue* blocks with no body.
+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.
@@ -143,14 +208,15 @@ Lint/UnderscorePrefixedVariableName:
 Lint/UnifiedInteger:
   Enabled: true
 
-# This cop checks for unneeded usages of splat expansion
-Lint/UnneededSplatExpansion:
-  Enabled: false
-
 # Unreachable code.
 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
@@ -168,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