gitlab-styles 8.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b56e4d8be26ddd4c64b078c7ba35ee9cde92ee9aa8510303fc8e56f55d76b4c
-  data.tar.gz: 9e3aae79876619f3f189ad51133ad0e5b6c9f2b50a9d08fcaa1d37275bfe4ccc
+  metadata.gz: 50eab9da6dd93cfbda3c8a8877e6ac2f8ce8274d6f92116973e6c9c1ee590d5f
+  data.tar.gz: f7e187d901c89bb4d4ba4a40d72523b10c5148ef965d60b243e8c09c9bc21642
 SHA512:
-  metadata.gz: 7bf2ad47042480c6e187b5643c963e8e2560c8f7d38ed9431308902b0074aca0a52f740790fc2cd82e59611e50156b7dc18d89a562b17c1c8cce2c1db3ebe50b
-  data.tar.gz: b97431178490c4344cf1eaec23c1bf2596b7e44a2a8182ea2295add370e7e0c67da6bfa5fc4b213540306a681534e62272736669549e2949168b09bc4b1ddf8d
+  metadata.gz: a9d90f34b3a3e6d97c6a791c5f91a26318b956751a77b2827f5370e15f8717bdf30cf30ddad0c63afd1f2335707d76dd948d1c7898c0d762f9b19389dea55d49
+  data.tar.gz: 9634b21fcc052557e12ebd277279089e4cfd325b88860c45a5250da554b0f14e378b7cdf8c9648d019649cd1396b327fc7cf10d48462622f00f1af888cd61b31

data/.gitlab-ci.yml

@@ -3,7 +3,7 @@ stages:
   - deploy
 
 default:
-  image: ruby:2.7
+  image: "ruby:${RUBY_VERSION}"
   tags:
     - gitlab-org
   before_script:
@@ -23,11 +23,17 @@ styles:
   stage: test
   script:
     - bundle exec rubocop --debug --parallel
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0']
 
 specs:
   stage: test
   script:
     - bundle exec rspec
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0']
 
 include:
   - project: 'gitlab-org/quality/pipeline-common'

data/.rubocop.yml

@@ -4,7 +4,18 @@ inherit_from:
 require:
   - rubocop/cop/internal_affairs
 
+AllCops:
+  NewCops: disable # https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/issues/40
+  SuggestExtensions: false # https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/issues/39
+
 InternalAffairs/DeprecateCopHelper:
   Enabled: true
   Include:
     - spec/**/*.rb
+
+# This only makes sense for cops that are included with RuboCop. We could add
+# our own config/default.yml and do something like
+# https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb,
+# but realistically this is OK here.
+InternalAffairs/UndefinedConfig:
+  Enabled: false

data/Gemfile

@@ -5,9 +5,13 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in gitlab-rubocop.gemspec
 gemspec
 
+group :development do
+  gem "lefthook", require: false
+end
+
 group :test do
   # Pin these dependencies, otherwise a new rule could break the CI pipelines
-  gem 'rubocop', '0.91.1'
-  gem 'rubocop-rspec', '1.44.1'
-  gem 'rspec-parameterized', '0.4.2', require: false
+  gem 'rubocop', '1.38.0'
+  gem 'rubocop-rspec', '2.15.0'
+  gem 'rspec-parameterized', '0.5.2', require: false
 end

data/README.md

@@ -66,10 +66,19 @@ After checking out the repo, run `bin/setup` to install dependencies.
 Then, run `rake spec` to run the tests. You can also run `bin/console` for an
 interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To test some rules locally, there is a test application [in the playground folder](./playground/). It is a vanilla Rails 6 application with your local `gitlab-styles` included, and it is used to test RuboCop rules. You can add code in it (preferably RuboCop offenses) and run the following command to test the RuboCop policy we setup:
+
+```shell
+cd playground
+bundle install
+bundle exec rubocop -c .rubocop.yml
+```
+
+### Activate lefthook locally
+
+```shell
+lefthook install
+```
 
 ## Contributing
 
@@ -80,7 +89,18 @@ to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Release Process
 
-Please refer to the [Release Process](docs/release_process.md).
+We release `gitlab-styles` on an ad-hoc basis. There is no regularity to when
+we release, we just release when we make a change - no matter the size of the
+change.
+
+To release a new version:
+
+1. Create a Merge Request.
+1. Use Merge Request template [Release.md](https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/blob/master/.gitlab/merge_request_templates/Release.md).
+1. Follow the instructions.
+1. A new gem version is [published automatically](https://gitlab.com/gitlab-org/quality/pipeline-common/-/blob/master/ci/gem-release.yml) after the Merge Request has been merged.
+
+See [!123](https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/123) as an example.
 
 ## License
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "gitlab/styles"

data/gitlab-styles.gemspec

@@ -16,18 +16,18 @@ 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)/})
+    f.match(%r{^(docs|test|spec|features|playground)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '~> 0.91', '>= 0.91.1'
+  spec.add_dependency 'rubocop', '~> 1.38.0'
   spec.add_dependency 'rubocop-gitlab-security', '~> 0.1.1'
-  spec.add_dependency 'rubocop-graphql', '~> 0.10'
-  spec.add_dependency 'rubocop-performance', '~> 1.9.2'
-  spec.add_dependency 'rubocop-rails', '~> 2.9'
-  spec.add_dependency 'rubocop-rspec', '~> 1.44'
+  spec.add_dependency 'rubocop-graphql', '~> 0.14'
+  spec.add_dependency 'rubocop-performance', '~> 1.14'
+  spec.add_dependency 'rubocop-rails', '~> 2.15'
+  spec.add_dependency 'rubocop-rspec', '~> 2.15'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'gitlab-dangerfiles', '~> 2.11.0'

data/lefthook.yml

@@ -0,0 +1,16 @@
+# Lefthook configuration. For more information, see:
+# https://github.com/Arkweid/lefthook/blob/master/docs/full_guide.md
+
+pre-push:
+  parallel: true
+  commands:
+    # Run ruby linting
+    rubocop:
+      files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
+      glob: '*.{rb,rake}'
+      run: bundle exec rubocop --parallel --force-exclusion {files}
+
+    # Run all tests (warn if there are any missing tools required for tests).
+    rspec:
+      run: bundle exec rspec -f progress
+      glob: '*.rb'

data/lib/gitlab/styles/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Styles
-    VERSION = '8.0.0'
+    VERSION = '9.1.0'
   end
 end

data/lib/rubocop/cop/active_record_dependent.rb

@@ -5,11 +5,11 @@ require_relative '../../gitlab/styles/rubocop/model_helpers'
 module Rubocop
   module Cop
     # Cop that prevents the use of `dependent: ...` in ActiveRecord models.
-    class ActiveRecordDependent < RuboCop::Cop::Cop
+    class ActiveRecordDependent < RuboCop::Cop::Base
       include Gitlab::Styles::Rubocop::ModelHelpers
 
       MSG = 'Do not use `dependent:` to remove associated data, ' \
-        'use foreign keys with cascading deletes instead.'
+            'use foreign keys with cascading deletes instead.'
 
       METHOD_NAMES = [:has_many, :has_one, :belongs_to].freeze
       ALLOWED_OPTIONS = [:restrict_with_error].freeze

data/lib/rubocop/cop/active_record_serialize.rb

@@ -5,7 +5,7 @@ require_relative '../../gitlab/styles/rubocop/model_helpers'
 module Rubocop
   module Cop
     # Cop that prevents the use of `serialize` in ActiveRecord models.
-    class ActiveRecordSerialize < RuboCop::Cop::Cop
+    class ActiveRecordSerialize < RuboCop::Cop::Base
       include Gitlab::Styles::Rubocop::ModelHelpers
 
       MSG = 'Do not store serialized data in the database, use separate columns and/or tables instead'
@@ -13,7 +13,7 @@ module Rubocop
       def on_send(node)
         return unless in_model?(node)
 
-        add_offense(node, location: :selector) if node.children[1] == :serialize
+        add_offense(node.loc.selector) if node.children[1] == :serialize
       end
     end
   end

data/lib/rubocop/cop/avoid_return_from_blocks.rb

@@ -20,7 +20,7 @@ module Rubocop
     #     do_something_else
     #   end
     #
-    class AvoidReturnFromBlocks < RuboCop::Cop::Cop
+    class AvoidReturnFromBlocks < RuboCop::Cop::Base
       MSG = 'Do not return from a block, use next or break instead.'
       DEF_METHODS = %i[define_method lambda].freeze
       WHITELISTED_METHODS = %i[each each_filename times loop].freeze
@@ -38,6 +38,8 @@ module Rubocop
         end
       end
 
+      alias_method :on_numblock, :on_block
+
       private
 
       def top_block?(node)

data/lib/rubocop/cop/code_reuse/active_record.rb

@@ -4,9 +4,9 @@ module Rubocop
   module Cop
     module CodeReuse
       # Cop that denies the use of ActiveRecord methods outside of models.
-      class ActiveRecord < RuboCop::Cop::Cop
+      class ActiveRecord < RuboCop::Cop::Base
         MSG = 'This method can only be used inside an ActiveRecord model: ' \
-    'https://gitlab.com/gitlab-org/gitlab-foss/issues/49653'
+              'https://gitlab.com/gitlab-org/gitlab-foss/issues/49653'
 
         # Various methods from ActiveRecord::Querying that are denied. We
         # exclude some generic ones such as `any?` and `first`, as these may
@@ -72,7 +72,7 @@ module Rubocop
           # `Project.group(:name)`.
           return if NOT_ALLOWED[send_name] && !first_arg
 
-          add_offense(node, location: :selector)
+          add_offense(node.loc.selector)
         end
       end
     end

data/lib/rubocop/cop/custom_error_class.rb

@@ -2,7 +2,7 @@
 
 module Rubocop
   module Cop
-    # This cop makes sure that custom error classes, when empty, are declared
+    # Makes sure that custom error classes, when empty, are declared
     # with Class.new.
     #
     # @example
@@ -15,7 +15,9 @@ module Rubocop
     #
     #   # good
     #   FooError = Class.new(StandardError)
-    class CustomErrorClass < RuboCop::Cop::Cop
+    class CustomErrorClass < RuboCop::Cop::Base
+      extend RuboCop::Cop::AutoCorrector
+
       MSG = 'Use `Class.new(SuperClass)` to define an empty custom error class.'
 
       def on_class(node)
@@ -28,16 +30,12 @@ module Rubocop
 
         return unless parent_klass&.to_s&.end_with?('Error')
 
-        add_offense(node)
-      end
-
-      def autocorrect(node)
-        klass = node.identifier
-        parent = node.parent_class
+        add_offense(node) do |corrector|
+          klass = node.identifier
+          parent = node.parent_class
 
-        replacement = "#{class_name_from_node(klass)} = Class.new(#{class_name_from_node(parent)})"
+          replacement = "#{class_name_from_node(klass)} = Class.new(#{class_name_from_node(parent)})"
 
-        lambda do |corrector|
           corrector.replace(node.source_range, replacement)
         end
       end

data/lib/rubocop/cop/gem_fetcher.rb

@@ -2,10 +2,10 @@
 
 module Rubocop
   module Cop
-    # This cop prevents usage of the `git` and `github` arguments to `gem` in a
+    # Prevents usage of the `git` and `github` arguments to `gem` in a
     # `Gemfile` in order to avoid additional points of failure beyond
     # rubygems.org.
-    class GemFetcher < RuboCop::Cop::Cop
+    class GemFetcher < RuboCop::Cop::Base
       MSG = 'Do not use gems from git repositories, only use gems from RubyGems.'
 
       GIT_KEYS = [:git, :github].freeze
@@ -18,7 +18,7 @@ module Rubocop
 
         node.children.last.each_node(:pair) do |pair|
           key_name = pair.children[0].children[0].to_sym
-          add_offense(node, location: pair.source_range) if GIT_KEYS.include?(key_name)
+          add_offense(pair.source_range) if GIT_KEYS.include?(key_name)
         end
       end
 

data/lib/rubocop/cop/in_batches.rb

@@ -5,13 +5,13 @@ require_relative '../../gitlab/styles/rubocop/model_helpers'
 module Rubocop
   module Cop
     # Cop that prevents the use of `in_batches`
-    class InBatches < RuboCop::Cop::Cop
+    class InBatches < RuboCop::Cop::Base
       MSG = 'Do not use `in_batches`, use `each_batch` from the EachBatch module instead'
 
       def on_send(node)
         return unless node.children[1] == :in_batches
 
-        add_offense(node, location: :selector)
+        add_offense(node.loc.selector)
       end
     end
   end

data/lib/rubocop/cop/internal_affairs/deprecate_cop_helper.rb

@@ -4,18 +4,21 @@ module Rubocop
   module Cop
     module InternalAffairs
       # Cop that denies the use of CopHelper.
-      class DeprecateCopHelper < RuboCop::Cop::Cop
+      class DeprecateCopHelper < RuboCop::Cop::Base
         MSG = 'Do not use `CopHelper` or methods from it, use improved patterns described in https://www.rubydoc.info/gems/rubocop/RuboCop/RSpec/ExpectOffense'
 
+        # @!method cop_helper(node)
         def_node_matcher :cop_helper, <<~PATTERN
           (send nil? ${:include :extend :prepend}
             (const _ {:CopHelper}))
         PATTERN
 
+        # @!method cop_helper_method(node)
         def_node_search :cop_helper_method, <<~PATTERN
           (send nil? {:inspect_source :inspect_source_file :parse_source :autocorrect_source_file :autocorrect_source :_investigate} ...)
         PATTERN
 
+        # @!method cop_helper_method_on_instance(node)
         def_node_search :cop_helper_method_on_instance, <<~PATTERN
           (send (send nil? _) {:messages :highlights :offenses} ...)
         PATTERN

data/lib/rubocop/cop/line_break_after_guard_clauses.rb

@@ -55,9 +55,10 @@ module Rubocop
     #   end
     #
     #   do_something_more
-    class LineBreakAfterGuardClauses < RuboCop::Cop::Cop
+    class LineBreakAfterGuardClauses < RuboCop::Cop::Base
       MSG = 'Add a line break after guard clauses'
 
+      # @!method guard_clause_node?(node)
       def_node_matcher :guard_clause_node?, <<-PATTERN
         [{(send nil? {:raise :fail :throw} ...) return break next} single_line?]
       PATTERN

data/lib/rubocop/cop/line_break_around_conditional_block.rb

@@ -42,7 +42,8 @@ module Rubocop
     #        do_something
     #      end
     #    end
-    class LineBreakAroundConditionalBlock < RuboCop::Cop::Cop
+    class LineBreakAroundConditionalBlock < RuboCop::Cop::Base
+      extend RuboCop::Cop::AutoCorrector
       include RuboCop::Cop::RangeHelp
 
       MSG = 'Add a line break around conditional blocks'
@@ -53,17 +54,15 @@ module Rubocop
         return if node.single_line?
         return unless node.if? || node.unless?
 
-        add_offense(node) unless previous_line_valid?(node)
-        add_offense(node) unless last_line_valid?(node)
-      end
-
-      def autocorrect(node)
-        lambda do |corrector|
+        corrector_block = lambda do |corrector|
           line = range_by_whole_lines(node.source_range)
 
           corrector.insert_before(line, "\n") unless previous_line_valid?(node)
           corrector.insert_after(line, "\n") unless last_line_valid?(node)
         end
+
+        add_offense(node, &corrector_block) unless previous_line_valid?(node)
+        add_offense(node, &corrector_block) unless last_line_valid?(node)
       end
 
       private

data/lib/rubocop/cop/migration/update_large_table.rb

@@ -4,7 +4,7 @@ require_relative '../../../gitlab/styles/rubocop/migration_helpers'
 module Rubocop
   module Cop
     module Migration
-      # This cop checks for methods that may lead to batch type issues on a table that's been
+      # Checks for methods that may lead to batch type issues on a table that's been
       # explicitly denied because of its size.
       #
       # Even though though these methods perform functions to avoid
@@ -13,13 +13,14 @@ module Rubocop
       #
       # See https://gitlab.com/gitlab-com/infrastructure/issues/1602 for more
       # information.
-      class UpdateLargeTable < RuboCop::Cop::Cop
+      class UpdateLargeTable < RuboCop::Cop::Base
         include Gitlab::Styles::Rubocop::MigrationHelpers
 
         MSG = 'Using `%s` on the `%s` table will take a long time to ' \
-          'complete, and should be avoided unless absolutely ' \
-          'necessary'
+              'complete, and should be avoided unless absolutely ' \
+              'necessary'
 
+        # @!method batch_update?(node)
         def_node_matcher :batch_update?, <<~PATTERN
           (send nil? ${#denied_method?}
             (sym $...)

data/lib/rubocop/cop/performance/rubyzip.rb

@@ -3,7 +3,7 @@
 module Rubocop
   module Cop
     module Performance
-      # This cop flags inefficient uses of rubyzip's Zip::File, since when instantiated
+      # Flags inefficient uses of rubyzip's Zip::File, since when instantiated
       # it reads the file's Central Directory into memory entirely. For zips with many
       # files and directories, this can be very expensive even when the archive's size
       # in bytes is small.
@@ -11,13 +11,14 @@ module Rubocop
       # See also:
       # - https://github.com/rubyzip/rubyzip/issues/506
       # - https://github.com/rubyzip/rubyzip#notes-on-zipinputstream
-      class Rubyzip < RuboCop::Cop::Cop
+      class Rubyzip < RuboCop::Cop::Base
         MSG = 'Be careful when opening or iterating zip files via Zip::File. ' \
               'Zip archives may contain many entries, and their file index is ' \
               'read into memory upon construction, which can lead to ' \
               'high memory use and poor performance. ' \
               'Consider iterating archive entries via Zip::InputStream instead.'
 
+        # @!method reads_central_directory?(node)
         def_node_matcher :reads_central_directory?, <<-PATTERN
           (send
             (const

data/lib/rubocop/cop/polymorphic_associations.rb

@@ -5,7 +5,7 @@ require_relative '../../gitlab/styles/rubocop/model_helpers'
 module Rubocop
   module Cop
     # Cop that prevents the use of polymorphic associations
-    class PolymorphicAssociations < RuboCop::Cop::Cop
+    class PolymorphicAssociations < RuboCop::Cop::Base
       include Gitlab::Styles::Rubocop::ModelHelpers
 
       MSG = 'Do not use polymorphic associations, use separate tables instead'

data/lib/rubocop/cop/rails/include_url_helper.rb

@@ -5,7 +5,7 @@ require_relative '../../../gitlab/styles/rubocop/model_helpers'
 module Rubocop
   module Cop
     module Rails
-      class IncludeUrlHelper < RuboCop::Cop::Cop
+      class IncludeUrlHelper < RuboCop::Cop::Base
         MSG = <<~MSG
           Avoid including `ActionView::Helpers::UrlHelper`.
           It adds/overrides ~40 methods while usually only one is needed.
@@ -14,6 +14,7 @@ module Rubocop
           See https://gitlab.com/gitlab-org/gitlab/-/issues/340567.
         MSG
 
+        # @!method include_url_helpers_node?(node)
         def_node_matcher :include_url_helpers_node?, <<~PATTERN
           (send nil? :include (const (const (const {nil? cbase} :ActionView) :Helpers) :UrlHelper))
         PATTERN

data/lib/rubocop/cop/redirect_with_status.rb

@@ -2,9 +2,9 @@
 
 module Rubocop
   module Cop
-    # This cop prevents usage of 'redirect_to' in actions 'destroy' without specifying 'status'.
+    # Prevents usage of 'redirect_to' in actions 'destroy' without specifying 'status'.
     # See https://gitlab.com/gitlab-org/gitlab-ce/issues/31840
-    class RedirectWithStatus < RuboCop::Cop::Cop
+    class RedirectWithStatus < RuboCop::Cop::Base
       MSG = 'Do not use "redirect_to" without "status" in "destroy" action'
 
       def on_def(node)
@@ -20,7 +20,7 @@ module Rubocop
             methods << pair.children.first.children.first
           end
 
-          add_offense(def_node, location: :selector) unless methods.include?(:status)
+          add_offense(def_node.loc.selector) unless methods.include?(:status)
         end
       end
 

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

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 require 'rubocop-rspec'
-require_relative '../../../gitlab/styles/rubocop/rspec/helpers'
 
 module Rubocop
   module Cop
     module RSpec
       class Base < RuboCop::Cop::RSpec::Base
-        include Gitlab::Styles::Rubocop::Rspec::Helpers
       end
     end
   end

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

@@ -39,22 +39,22 @@ module Rubocop
       #
       class EmptyLineAfterLetBlock < Base
         extend RuboCop::Cop::AutoCorrector
-        include RuboCop::RSpec::EmptyLineSeparation
+        include RuboCop::Cop::RSpec::EmptyLineSeparation
 
         MSG = 'Add an empty line after `%<let>s` block.'
 
-        def_node_matcher :lets, LET.block_pattern
-
         def on_block(node)
-          lets(node) do
-            break if last_child?(node)
-            next if node.single_line?
+          RuboCop::RSpec::ExampleGroup.new(node).lets.each do |let|
+            break if last_child?(let)
+            next if let.single_line?
 
-            missing_separating_line_offense(node) do |method|
+            missing_separating_line_offense(let) do |method|
+              format(MSG, let: method)
               format(MSG, let: method)
             end
           end
         end
+        alias_method :on_numblock, :on_block
       end
     end
   end

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

@@ -39,12 +39,13 @@ module Rubocop
       #
       class EmptyLineAfterSharedExample < Base
         extend RuboCop::Cop::AutoCorrector
-        include RuboCop::RSpec::EmptyLineSeparation
+        include RuboCop::Cop::RSpec::EmptyLineSeparation
 
         MSG = 'Add an empty line after `%<example>s` block.'
 
+        # @!method shared_examples(node)
         def_node_matcher :shared_examples,
-                         (SharedGroups::ALL + Includes::ALL).block_pattern
+                         block_pattern('{#SharedGroups.all #Includes.all}')
 
         def on_block(node)
           shared_examples(node) do
@@ -55,6 +56,7 @@ module Rubocop
             end
           end
         end
+        alias_method :on_numblock, :on_block
       end
     end
   end

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

@@ -52,6 +52,7 @@ module Rubocop
 
         MSG = 'Only start words with lowercase alpha with no leading/trailing spaces when describing your tests.'
 
+        # @!method it_description(node)
         def_node_matcher :it_description, <<-PATTERN
       (block (send _ :it ${
         (str $_)
@@ -64,6 +65,7 @@ module Rubocop
             add_wording_offense(description_node, MSG) if invalid_description?(text(description_node))
           end
         end
+        alias_method :on_numblock, :on_block
 
         private
 

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

@@ -6,7 +6,7 @@ require_relative 'base'
 module Rubocop
   module Cop
     module RSpec
-      # This cop checks for unused parameters to the `have_link` matcher.
+      # Checks for unused parameters to the `have_link` matcher.
       #
       # @example
       #
@@ -21,6 +21,7 @@ module Rubocop
 
         MESSAGE = "The second argument to `have_link` should be a Hash."
 
+        # @!method unused_parameters?(node)
         def_node_matcher :unused_parameters?, <<~PATTERN
           (send nil? :have_link
             _ !{hash nil}

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

@@ -6,7 +6,7 @@ require_relative 'base'
 module Rubocop
   module Cop
     module RSpec
-      # This cop checks for single-line hook blocks
+      # Checks for single-line hook blocks
       #
       # @example
       #
@@ -25,6 +25,7 @@ module Rubocop
       class SingleLineHook < Base
         MESSAGE = "Don't use single-line hook blocks."
 
+        # @!method rspec_hook?(node)
         def_node_search :rspec_hook?, <<~PATTERN
           (send nil? {:after :around :before} ...)
         PATTERN
@@ -35,6 +36,7 @@ module Rubocop
 
           add_offense(node, message: MESSAGE)
         end
+        alias_method :on_numblock, :on_block
       end
     end
   end

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

@@ -23,6 +23,7 @@ module Rubocop
 
         SELECTORS = %i[describe context feature example_group it specify example scenario its].freeze
 
+        # @!method include_metadata(node)
         def_node_matcher :include_metadata, <<-PATTERN
           (send {(const nil? :RSpec) nil?} {#{SELECTORS.map(&:inspect).join(' ')}}
             !const
@@ -30,6 +31,7 @@ module Rubocop
             (hash $...))
         PATTERN
 
+        # @!method invalid_metadata?(node)
         def_node_matcher :invalid_metadata?, <<-PATTERN
           (pair
             (sym $...)

data/lib/rubocop/cop/style/hash_transformation.rb

@@ -3,7 +3,7 @@
 module Rubocop
   module Cop
     module Style
-      # This cop identifies places where `map { ... }.to_h` or
+      # Identifies places where `map { ... }.to_h` or
       # `Hash[map { ... }]` can be replaced with `to_h { ... }`,
       # saving an intermediate array allocation.
       #
@@ -20,11 +20,13 @@ module Rubocop
       #   array.to_h { |x| [x, x + 1] }
       #
       # Full credit: https://github.com/eugeneius/rubocop-performance/blob/hash_transformation/lib/rubocop/cop/performance/hash_transformation.rb
-      class HashTransformation < RuboCop::Cop::Cop
+      class HashTransformation < RuboCop::Cop::Base
+        extend RuboCop::Cop::AutoCorrector
         include RuboCop::Cop::RangeHelp
 
         MSG = 'Use `to_h { ... }` instead of `%<current>s`.'
 
+        # @!method to_h_candidate?(node)
         def_node_matcher :to_h_candidate?, <<~PATTERN
           {
             [(send
@@ -38,17 +40,13 @@ module Rubocop
           to_h_candidate?(node) do |_block, call|
             range = offense_range(node, call)
             message = message(node, call)
-            add_offense(node, location: range, message: message)
-          end
-        end
-
-        def autocorrect(node)
-          block, call = to_h_candidate?(node)
+            add_offense(range, message: message) do |corrector|
+              block, call = to_h_candidate?(node)
 
-          lambda do |corrector|
-            corrector.remove(after_block(node, block))
-            corrector.replace(call.loc.selector, 'to_h')
-            corrector.remove(before_block(node, block))
+              corrector.remove(after_block(node, block))
+              corrector.replace(call.loc.selector, 'to_h')
+              corrector.remove(before_block(node, block))
+            end
           end
         end
 

data/lib/rubocop/cop/style/open_struct_use.rb

@@ -3,18 +3,19 @@
 module Rubocop
   module Cop
     module Style
-      # This cop flags uses of OpenStruct, as it is now officially discouraged
+      # Flags uses of OpenStruct, as it is now officially discouraged
       # to be used for performance, version compatibility, and potential security issues.
       #
       # See also:
       # - https://rubyreferences.github.io/rubychanges/3.0.html#standard-library
       # - https://docs.ruby-lang.org/en/3.0.0/OpenStruct.html#class-OpenStruct-label-Caveats
       # - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67855
-      class OpenStructUse < RuboCop::Cop::Cop
+      class OpenStructUse < RuboCop::Cop::Base
         MSG = 'Avoid using `OpenStruct`. It is officially discouraged. ' \
               'Replace it with `Struct`, `Hash`, or RSpec doubles. ' \
               'See https://docs.ruby-lang.org/en/3.0.0/OpenStruct.html#class-OpenStruct-label-Caveats'
 
+        # @!method uses_open_struct?(node)
         def_node_matcher :uses_open_struct?, <<-PATTERN
           (const {nil? (cbase)} :OpenStruct)
         PATTERN

data/lib/rubocop/cop/without_reactive_cache.rb

@@ -3,13 +3,13 @@
 module Rubocop
   module Cop
     # Cop that prevents the use of `without_reactive_cache`
-    class WithoutReactiveCache < RuboCop::Cop::Cop
+    class WithoutReactiveCache < RuboCop::Cop::Base
       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
 
-        add_offense(node, location: :selector)
+        add_offense(node.loc.selector)
       end
     end
   end

data/rubocop-layout.yml

@@ -135,7 +135,7 @@ Layout/LeadingCommentSpace:
 Layout/LineLength:
   Enabled: true
   Max: 120
-  IgnoredPatterns: ['\s#\srubocop']
+  AllowedPatterns: ['\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.

data/rubocop-rspec.yml

@@ -14,6 +14,16 @@ RSpec/BeEql:
 RSpec/BeforeAfterAll:
   Enabled: false
 
+# 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
+RSpec/Capybara/SpecificFinders:
+  Enabled: false
+
+# Enforces consistent use of be_a or be_kind_of.
+# https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/131#note_1141022718
+RSpec/ClassCheck:
+  Enabled: false
+
 # Check that the first argument to the top level describe is the tested class or
 # module.
 RSpec/DescribeClass:
@@ -34,11 +44,6 @@ RSpec/DescribedClass:
 # Checks if an example group does not include any tests.
 RSpec/EmptyExampleGroup:
   Enabled: true
-  CustomIncludeMethods:
-    - run_permission_checks
-    - run_group_permission_checks
-    - it_should_email!
-    - it_should_not_email!
 
 # Checks if there is an empty line after let blocks.
 RSpec/EmptyLineAfterLetBlock:
@@ -66,6 +71,12 @@ RSpec/ExampleWording:
 RSpec/ExpectActual:
   Enabled: true
 
+# Checks for `expect {...}.to change {...}` using a block.
+# See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/122#note_1089192391
+RSpec/ExpectChange:
+  Enabled: true
+  EnforcedStyle: block
+
 # Checks for opportunities to use `expect { … }.to output`.
 RSpec/ExpectOutput:
   Enabled: true
@@ -136,6 +147,10 @@ RSpec/NotToNot:
   EnforcedStyle: not_to
   Enabled: true
 
+# See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/122#note_1089202045
+RSpec/PredicateMatcher:
+  Enabled: false
+
 # Check for repeated description strings in example groups.
 RSpec/RepeatedDescription:
   Enabled: false
@@ -159,3 +174,10 @@ RSpec/SubjectStub:
 # Prefer using verifying doubles over normal doubles.
 RSpec/VerifiedDoubles:
   Enabled: true
+
+RSpec:
+  Language:
+    Helpers:
+      - let_it_be
+      - let_it_be_with_refind
+      - let_it_be_with_reload

data/rubocop-security.yml

@@ -11,6 +11,10 @@ Security/JSONLoad:
 Security/Eval:
   Enabled: true
 
+# Checks for the first argument to IO.read, IO.binread, IO.write, IO.binwrite, IO.foreach, and IO.readlines
+Security/IoMethods:
+  Enabled: true
+
 GitlabSecurity/DeepMunge:
   Enabled: true
   Exclude:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 9.1.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2022-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.91'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.91.1
+        version: 1.38.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.91'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.91.1
+        version: 1.38.0
 - !ruby/object:Gem::Dependency
   name: rubocop-gitlab-security
   requirement: !ruby/object:Gem::Requirement
@@ -50,56 +44,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.44'
+        version: '2.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.44'
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -181,12 +175,12 @@ files:
 - bin/console
 - bin/setup
 - gitlab-styles.gemspec
+- lefthook.yml
 - lib/gitlab/styles.rb
 - lib/gitlab/styles/common/banned_constants.rb
 - lib/gitlab/styles/rubocop.rb
 - lib/gitlab/styles/rubocop/migration_helpers.rb
 - lib/gitlab/styles/rubocop/model_helpers.rb
-- lib/gitlab/styles/rubocop/rspec/helpers.rb
 - lib/gitlab/styles/version.rb
 - lib/rubocop/cop/active_record_dependent.rb
 - lib/rubocop/cop/active_record_serialize.rb
@@ -207,7 +201,6 @@ files:
 - lib/rubocop/cop/rails/include_url_helper.rb
 - lib/rubocop/cop/redirect_with_status.rb
 - lib/rubocop/cop/rspec/base.rb
-- lib/rubocop/cop/rspec/empty_line_after_final_let_it_be.rb
 - lib/rubocop/cop/rspec/empty_line_after_let_block.rb
 - lib/rubocop/cop/rspec/empty_line_after_shared_example.rb
 - lib/rubocop/cop/rspec/example_starting_character.rb

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

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

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

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop-rspec'
-require_relative 'base'
-
-module Rubocop
-  module Cop
-    module RSpec
-      # Checks if there is an empty line after the last `let_it_be` block.
-      #
-      # @example
-      #   # bad
-      #   let_it_be(:foo) { bar }
-      #   let_it_be(:something) { other }
-      #   it { does_something }
-      #
-      #   # good
-      #   let_it_be(:foo) { bar }
-      #   let_it_be(:something) { other }
-      #
-      #   it { does_something }
-      class EmptyLineAfterFinalLetItBe < Base
-        extend RuboCop::Cop::AutoCorrector
-        include RuboCop::RSpec::EmptyLineSeparation
-
-        MSG = 'Add an empty line after the last `let_it_be`.'
-
-        def_node_matcher :let_it_be?, <<-PATTERN
-          {
-            (block (send #rspec? {:let_it_be :let_it_be_with_refind :let_it_be_with_reload} ...) ...)
-            (send #rspec? {:let_it_be :let_it_be_with_refind :let_it_be_with_reload} _ block_pass)
-          }
-        PATTERN
-
-        def on_block(node)
-          return unless example_group_with_body?(node)
-
-          final_let_it_be = node.body.child_nodes.reverse.find { |child| let_it_be?(child) }
-
-          return if final_let_it_be.nil?
-
-          missing_separating_line_offense(final_let_it_be) { MSG }
-        end
-      end
-    end
-  end
-end