gitlab-styles 14.1.0 → 15.0.0

data/gitlab-styles.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gitlab/styles/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 3.1'
+  spec.required_ruby_version = '>= 3.3'
   spec.name          = 'gitlab-styles'
   spec.version       = Gitlab::Styles::VERSION
   spec.authors       = ['GitLab']
@@ -16,31 +16,30 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(docs|test|spec|features|playground)/})
+    f.match(%r{^(docs|test|spec|features)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '1.81.7'
-  spec.add_dependency 'rubocop-capybara', '2.21.0'
-  spec.add_dependency 'rubocop-factory_bot', '2.26.1'
-  spec.add_dependency 'rubocop-graphql', '1.5.4'
-  spec.add_dependency 'rubocop-performance', '1.23.1'
-  spec.add_dependency 'rubocop-rails', '2.29.1'
-  spec.add_dependency 'rubocop-rspec', '3.4.0'
-  spec.add_dependency 'rubocop-rspec_rails', '2.30.0'
+  spec.add_dependency 'rubocop', '1.92.1'
+  spec.add_dependency 'rubocop-capybara', '3.1.0'
+  spec.add_dependency 'rubocop-factory_bot', '2.28.0'
+  spec.add_dependency 'rubocop-graphql', '1.8.0'
+  spec.add_dependency 'rubocop-performance', '1.27.0'
+  spec.add_dependency 'rubocop-rails', '2.38.0'
+  spec.add_dependency 'rubocop-rspec', '3.10.2'
+  spec.add_dependency 'rubocop-rspec_rails', '2.33.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'gitlab-dangerfiles', '~> 4.6.0'
-  spec.add_development_dependency 'lefthook', '~> 1.3.13'
-  spec.add_development_dependency 'pry-byebug', '~> 3.10'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec-parameterized-table_syntax', '~> 1.0.0'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
-  spec.add_development_dependency 'simplecov', '~> 0.22.0'
-  spec.add_development_dependency 'simplecov-cobertura', '~> 2.1.0'
-  spec.add_development_dependency 'simplecov-html', '~> 0.12.3'
-  spec.add_development_dependency 'test_file_finder', '~> 0.1.4'
+  spec.add_development_dependency 'bundler', '~> 4.0'
+  spec.add_development_dependency 'gitlab-dangerfiles', '~> 4.14.0'
+  spec.add_development_dependency 'lefthook', '~> 2.2'
+  spec.add_development_dependency 'pry-byebug', '~> 3.12'
+  spec.add_development_dependency 'rake', '~> 13.4'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'rspec-parameterized-table_syntax', '~> 2.1'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.7'
+  spec.add_development_dependency 'simplecov', '~> 1.3'
+  spec.add_development_dependency 'simplecov-cobertura', '~> 4.0'
+  spec.add_development_dependency 'test_file_finder', '~> 0.3'
 end

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Auto-require the RSpec cops under `rubocop/cop/rspec/**/*.rb`. They need the rubocop-rspec plugin.
+Dir[File.join(File.expand_path('../../../rubocop/cop/rspec', __dir__), '**', '*.rb')].each { |cop| require(cop) }

data/lib/gitlab/styles/rubocop.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
-# Auto-require all cops under `rubocop/cop/**/*.rb`
-cops_glob = File.join(__dir__, '..', '..', 'rubocop', 'cop', '**', '*.rb')
-Dir[cops_glob].each { |cop| require(cop) }
+# Auto-require all cops under `rubocop/cop/**/*.rb`, except the RSpec cops, which need rubocop-rspec.
+# The rubocop-*.yml configs don't use this: each requires only the cops it configures, and
+# `rubocop-rspec.yml` loads the RSpec cops through `gitlab/styles/rubocop/rspec`.
+cops_dir = File.expand_path('../../rubocop/cop', __dir__)
+rspec_cops_dir = File.join(cops_dir, 'rspec')
+Dir[File.join(cops_dir, '**', '*.rb')].each { |cop| require(cop) unless cop.start_with?("#{rspec_cops_dir}/") }
 
 module Gitlab
   module Styles

data/lib/gitlab/styles/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Styles
-    VERSION = '14.1.0'
+    VERSION = '15.0.0'
   end
 end

data/lib/rubocop/cop/avoid_return_from_blocks.rb

@@ -39,6 +39,7 @@ module Rubocop
       end
 
       alias_method :on_numblock, :on_block
+      alias_method :on_itblock, :on_block
 
       private
 
@@ -47,7 +48,7 @@ module Rubocop
         top_block = nil
 
         while current_node && current_node.type != :def
-          top_block = current_node if current_node.block_type?
+          top_block = current_node if current_node.any_block_type?
           current_node = current_node.parent
         end
 
@@ -58,7 +59,7 @@ module Rubocop
         blocks = []
 
         until node == current_node || def?(current_node)
-          blocks << current_node if current_node.block_type?
+          blocks << current_node if current_node.any_block_type?
           current_node = current_node.parent
         end
 
@@ -67,7 +68,7 @@ module Rubocop
       end
 
       def def?(node)
-        node.any_def_type? || (node.block_type? && DEF_METHODS.include?(node.method_name))
+        node.any_def_type? || (node.any_block_type? && DEF_METHODS.include?(node.method_name))
       end
 
       def allowed?(block_node)

data/lib/rubocop/cop/rspec/base.rb

@@ -6,6 +6,7 @@ module Rubocop
   module Cop
     module RSpec
       class Base < RuboCop::Cop::RSpec::Base # rubocop:disable InternalAffairs/CopDescriptionWithExample -- Base class
+        exclude_from_registry
       end
     end
   end

data/lib/rubocop/cop/rspec/empty_line_after_let_block.rb

@@ -55,6 +55,7 @@ module Rubocop
           end
         end
         alias_method :on_numblock, :on_block
+        alias_method :on_itblock, :on_block
       end
     end
   end

data/lib/rubocop/cop/rspec/empty_line_after_shared_example.rb

@@ -46,9 +46,9 @@ module Rubocop
         # @!method shared_examples(node)
         def_node_matcher :shared_examples, <<~PATTERN
           {
-            (block (send #rspec? #SharedGroups.all ...) ...)
+            (any_block (send #rspec? #SharedGroups.all ...) ...)
             {
-              (block (send nil? #Includes.all ...) ...)
+              (any_block (send nil? #Includes.all ...) ...)
               (send nil? #Includes.all ...)
             }
           }
@@ -64,6 +64,7 @@ module Rubocop
           end
         end
         alias_method :on_numblock, :on_block
+        alias_method :on_itblock, :on_block
       end
     end
   end

data/lib/rubocop/cop/rspec/example_starting_character.rb

@@ -54,7 +54,7 @@ module Rubocop
 
         # @!method it_description(node)
         def_node_matcher :it_description, <<-PATTERN
-      (block (send _ :it ${
+      (any_block (send _ :it ${
         (str $_)
         (dstr (str $_ ) ...)
       } ...) ...)
@@ -66,6 +66,7 @@ module Rubocop
           end
         end
         alias_method :on_numblock, :on_block
+        alias_method :on_itblock, :on_block
 
         private
 
@@ -91,9 +92,7 @@ module Rubocop
         end
 
         def replacement_text(node)
-          text = text(node)
-
-          text.strip!
+          text = text(node).strip
 
           text = downcase_first_letter(text) if invalid_description?(text)
 

data/lib/rubocop/cop/rspec/feature_spec_max_examples.rb

@@ -35,6 +35,7 @@ module Rubocop
           @example_count += 1 if example?(node)
         end
         alias_method :on_numblock, :on_block
+        alias_method :on_itblock, :on_block
 
         def on_investigation_end
           add_global_offense(format(MSG, count: @example_count, max: @max)) if @example_count > @max

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

@@ -37,6 +37,7 @@ module Rubocop
           add_offense(node, message: MESSAGE)
         end
         alias_method :on_numblock, :on_block
+        alias_method :on_itblock, :on_block
       end
     end
   end

data/rubocop-all.yml

@@ -1,7 +1,7 @@
 ---
 AllCops:
   # The oldest supported Ruby version.
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.3
   # 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-capybara.yml

@@ -1,7 +1,6 @@
 ---
-require:
+plugins:
   - rubocop-capybara
-  - ./lib/gitlab/styles/rubocop
 
 # Checks if there is a more specific finder offered by Capybara.
 # https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/131#note_1141024624

data/rubocop-code_reuse.yml

@@ -1,6 +1,6 @@
 ---
 require:
-  - ./lib/gitlab/styles/rubocop
+  - ./lib/rubocop/cop/code_reuse/active_record
 
 # Denies the use of ActiveRecord methods outside of configured
 # excluded directories

data/rubocop-default.yml

@@ -1,7 +1,4 @@
 ---
-require:
-  - ./lib/gitlab/styles/rubocop
-
 inherit_from:
   - rubocop-all.yml
   - rubocop-capybara.yml

data/rubocop-factory_bot.yml

@@ -1,7 +1,6 @@
 ---
-require:
+plugins:
   - rubocop-factory_bot
-  - ./lib/gitlab/styles/rubocop
 
 # Check for create_list FactoryBot declarations higher than MaxAmount
 FactoryBot/ExcessiveCreateList:

data/rubocop-fips.yml

@@ -1,6 +1,8 @@
 ---
 require:
-  - ./lib/gitlab/styles/rubocop
+  - ./lib/rubocop/cop/fips/md5
+  - ./lib/rubocop/cop/fips/open_ssl
+  - ./lib/rubocop/cop/fips/sha1
 
 # Denies usage of MD5
 Fips/MD5:

data/rubocop-graphql.yml

@@ -1,5 +1,5 @@
 ---
-require:
+plugins:
   - rubocop-graphql
 
 # Ensures all arguments have a description

data/rubocop-internal-affairs.yml

@@ -1,6 +1,9 @@
 ---
 require:
-  - ./lib/gitlab/styles/rubocop
+  - ./lib/rubocop/cop/internal_affairs/cop_description_with_example
+  - ./lib/rubocop/cop/internal_affairs/deprecate_cop_helper
+  - ./lib/rubocop/cop/internal_affairs/missing_cop_department
+  - ./lib/rubocop/cop/internal_affairs/use_restrict_on_send
 
 InternalAffairs/DeprecateCopHelper:
   Include:

data/rubocop-layout.yml

@@ -1,6 +1,7 @@
 ---
 require:
-  - ./lib/gitlab/styles/rubocop
+  - ./lib/rubocop/cop/layout/line_break_after_final_mixin
+  - ./lib/rubocop/cop/line_break_around_conditional_block
 
 # Check indentation of private/protected visibility modifiers.
 Layout/AccessModifierIndentation:
@@ -57,6 +58,10 @@ Layout/DotPosition:
 Layout/ElseAlignment:
   Enabled: true
 
+# Add an empty line after guard clauses.
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+
 # Checks for a newline after the final magic comment.
 Layout/EmptyLineAfterMagicComment:
   Enabled: true

data/rubocop-migrations.yml

@@ -1,6 +1,6 @@
 ---
 require:
-  - ./lib/gitlab/styles/rubocop
+  - ./lib/rubocop/cop/migration/update_large_table
 
 # Checks for methods that may lead to batch type issues on a table that's been
 # explicitly denied because of its size.

data/rubocop-performance.yml

@@ -1,19 +1,14 @@
 ---
-require:
+plugins:
   - rubocop-performance
-  - ./lib/gitlab/styles/rubocop
+require:
+  - ./lib/rubocop/cop/performance/rubyzip
 
 # 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
-
 Performance/BlockGivenWithExplicitBlock: # (new in 1.9)
   Enabled: true
 

data/rubocop-rails.yml

@@ -1,7 +1,13 @@
 ---
-require:
+plugins:
   - rubocop-rails
-  - ./lib/gitlab/styles/rubocop
+require:
+  - ./lib/rubocop/cop/active_record_dependent
+  - ./lib/rubocop/cop/active_record_serialize
+  - ./lib/rubocop/cop/in_batches
+  - ./lib/rubocop/cop/polymorphic_associations
+  - ./lib/rubocop/cop/redirect_with_status
+  - ./lib/rubocop/cop/rails/include_url_helper
 
 # Cop that prevents the use of `dependent: ...` in ActiveRecord models.
 Cop/ActiveRecordDependent:

data/rubocop-rspec.yml

@@ -1,8 +1,9 @@
 ---
-require:
+plugins:
   - rubocop-rspec
   - rubocop-rspec_rails
-  - ./lib/gitlab/styles/rubocop
+require:
+  - ./lib/gitlab/styles/rubocop/rspec
 
 # Check that instances are not being stubbed globally.
 RSpec/AnyInstance:
@@ -21,6 +22,22 @@ RSpec/BeforeAfterAll:
 RSpec/ClassCheck:
   Enabled: false
 
+# Checks that `context` docstrings start with an allowed prefix. These are the
+# most common prefixes in gitlab-org/gitlab:
+# https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92980
+# Quote them all, because YAML reads unquoted `on` as `true`.
+RSpec/ContextWording:
+  Prefixes:
+    - 'when'
+    - 'with'
+    - 'without'
+    - 'for'
+    - 'and'
+    - 'on'
+    - 'in'
+    - 'as'
+    - 'if'
+
 # Check that the first argument to the top level describe is the tested class or
 # module.
 RSpec/DescribeClass:

data/rubocop-security.yml

@@ -1,6 +1,12 @@
 ---
 require:
-  - ./lib/gitlab/styles/rubocop
+  - ./lib/rubocop/cop/gitlab_security/deep_munge
+  - ./lib/rubocop/cop/gitlab_security/json_serialization
+  - ./lib/rubocop/cop/gitlab_security/public_send
+  - ./lib/rubocop/cop/gitlab_security/redirect_to_params_update
+  - ./lib/rubocop/cop/gitlab_security/send_file_params
+  - ./lib/rubocop/cop/gitlab_security/sql_injection
+  - ./lib/rubocop/cop/gitlab_security/system_command_injection
 
 # Checks for implementations of the hash method which combine values using
 # custom logic instead of delegating to Array#hash.

data/rubocop-style.yml

@@ -1,6 +1,9 @@
 ---
 require:
-  - ./lib/gitlab/styles/rubocop
+  - ./lib/rubocop/cop/avoid_return_from_blocks
+  - ./lib/rubocop/cop/custom_error_class
+  - ./lib/rubocop/cop/style/hash_transformation
+  - ./lib/rubocop/cop/style/iso8601_date
 
 # Checks for grouping of accessors in class and module bodies.
 # https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleaccessorgrouping

data/rubocop-tailwind.yml

@@ -1,6 +1,7 @@
 ---
 require:
-  - ./lib/gitlab/styles/rubocop
+  - ./lib/rubocop/cop/tailwind/max_width_media_queries
+  - ./lib/rubocop/cop/tailwind/string_interpolation
 
 # Prevent string interpolation when building Tailwind CSS utils names
 Tailwind/StringInterpolation: