gitlab-styles 12.0.1 → 13.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5301968fa7603c90e9ed917011c49e4a3124a7c442963e778fcc1f4862c7cf03
-  data.tar.gz: 4b7676b2fcdb2bed6f3be9c8b0505ba04afa5ec008e95b6c980da5ef3a795032
+  metadata.gz: 260717767462cb5c7d3c94c228d8a00f9ec264a7b4a550056200349262f4c50e
+  data.tar.gz: 2031cf6ed85f7ea0f14fbaf475f7281c4b451af29973f258fda34f0e01360aef
 SHA512:
-  metadata.gz: bcb7c63e4e3cacd1638d87b2406483d763ecad6dbdb218a3da292f8be56112ca64d0d1596ac108143981d502834f6672e4c9128981edc8b6bd05566c924289f7
-  data.tar.gz: e08bb7c660e85a30ffc64d669363e6b420219745231a5ea7e5524e657ae72c4f6b1fcb00c9d01d31c9bb846c5d8be57db22d8640dff67ae554f76db2092375ae
+  metadata.gz: 390db75820765a83667b91e370513595ce74e03a7ad6c17a6a5679059d320b950401f7aa45723299e13e810db3c5c590d1c91f0a1bc13ef4d63d2fab6d92d84c
+  data.tar.gz: 3746d0712a9fa09def9d490862860d6bc67af3ef02c207be186ed1641b81d24734f23222256655c6296604bbf2a0d2d86d06ccb09f4f04eb606158b282004e0c

data/.gitlab-ci.yml

@@ -18,12 +18,14 @@ default:
 .base-ruby-job:
   image: "ruby:${RUBY_VERSION}"
   before_script:
+    - bundle_version=$(grep -A 1 "BUNDLED WITH" Gemfile.lock | grep -oE '[[:digit:].]+')
+    - gem install bundler --version "$bundle_version" --no-document  # Bundler is not installed with the image
     - bundle --version
     - bundle config set --local deployment 'true'
     - bundle install -j $(nproc)
   parallel:
     matrix:
-      - RUBY_VERSION: ['3.0', '3.1', '3.2']
+      - RUBY_VERSION: ['3.1', '3.2', '3.3']
 
 styles:
   extends: .base-ruby-job
@@ -35,8 +37,8 @@ specs:
   extends: .base-ruby-job
   stage: test
   script:
-    # Disable simplecov for all Ruby version other than 3.0
-    - if [[ "$RUBY_VERSION" != "3.0" ]]; then export SIMPLECOV=0; fi
+    # Disable simplecov for all Ruby version other than the target Ruby version.
+    - if [[ "$RUBY_VERSION" != "3.1" ]]; then export SIMPLECOV=0; fi
     - bundle exec rspec
   artifacts:
     name: coverage

data/.rubocop.yml

@@ -1,13 +1,21 @@
 inherit_from:
-  - rubocop-default.yml
+  - rubocop-all.yml
+  - rubocop-minimal.yml
+  - rubocop-internal-affairs.yml
   - .rubocop_todo.yml
 
 require:
   - rubocop/cop/internal_affairs
   - rubocop-rake
 
+inherit_mode:
+  merge:
+    - Exclude
+
 AllCops:
   NewCops: disable # https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/issues/40
+  Exclude:
+    - 'playground/**/*'
 
 Gemspec/DevelopmentDependencies:
   EnforcedStyle: gemspec
@@ -24,3 +32,22 @@ InternalAffairs/DeprecateCopHelper:
 # but realistically this is OK here.
 InternalAffairs/UndefinedConfig:
   Enabled: false
+
+# Disable Rails-specific cops auto-enabled as part of `gitlab-styles`.
+CodeReuse/ActiveRecord:
+  Enabled: false
+
+Cop/ActiveRecordDependent:
+  Enabled: false
+
+Cop/ActiveRecordSerialize:
+  Enabled: false
+
+Cop/PolymorphicAssociations:
+  Enabled: false
+
+Cop/RedirectWithStatus:
+  Enabled: false
+
+Cop/InBatches:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,17 +1,33 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-01-24 13:27:15 UTC using RuboCop version 1.57.2.
+# on 2024-09-06 09:55:51 UTC using RuboCop version 1.64.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 11
+# This cop supports safe autocorrection (--autocorrect).
+InternalAffairs/CopDescriptionWithExample:
+  Exclude:
+    - 'lib/rubocop/cop/fips/md5.rb'
+    - 'lib/rubocop/cop/fips/open_ssl.rb'
+    - 'lib/rubocop/cop/fips/sha1.rb'
+    - 'lib/rubocop/cop/gem_fetcher.rb'
+    - 'lib/rubocop/cop/gitlab_security/deep_munge.rb'
+    - 'lib/rubocop/cop/in_batches.rb'
+    - 'lib/rubocop/cop/internal_affairs/deprecate_cop_helper.rb'
+    - 'lib/rubocop/cop/line_break_around_conditional_block.rb'
+    - 'lib/rubocop/cop/migration/update_large_table.rb'
+    - 'lib/rubocop/cop/performance/rubyzip.rb'
+    - 'lib/rubocop/cop/polymorphic_associations.rb'
+
 # Offense count: 1
 InternalAffairs/InheritDeprecatedCopClass:
   Exclude:
     - 'lib/rubocop/cop/gitlab_security/json_serialization.rb'
 
-# Offense count: 11
+# Offense count: 10
 InternalAffairs/MissingCopDepartment:
   Exclude:
     - 'lib/rubocop/cop/active_record_dependent.rb'
@@ -24,4 +40,3 @@ InternalAffairs/MissingCopDepartment:
     - 'lib/rubocop/cop/line_break_around_conditional_block.rb'
     - 'lib/rubocop/cop/polymorphic_associations.rb'
     - 'lib/rubocop/cop/redirect_with_status.rb'
-    - 'lib/rubocop/cop/without_reactive_cache.rb'

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    gitlab-styles (12.0.1)
-      rubocop (~> 1.62.1)
-      rubocop-factory_bot (~> 2.25.1)
-      rubocop-graphql (~> 1.5.0)
-      rubocop-performance (~> 1.20.2)
-      rubocop-rails (~> 2.24.0)
-      rubocop-rspec (~> 2.27.1)
+    gitlab-styles (13.0.1)
+      rubocop (~> 1.67.0)
+      rubocop-capybara (~> 2.21.0)
+      rubocop-factory_bot (~> 2.26.1)
+      rubocop-graphql (~> 1.5.4)
+      rubocop-performance (~> 1.21.1)
+      rubocop-rails (~> 2.26.0)
+      rubocop-rspec (~> 3.0.4)
+      rubocop-rspec_rails (~> 2.30.0)
 
 GEM
   remote: https://rubygems.org/
@@ -92,7 +94,7 @@ GEM
       multi_xml (>= 0.5.2)
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
-    json (2.7.1)
+    json (2.7.2)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -111,7 +113,7 @@ GEM
       sawyer (~> 0.9)
     open4 (1.3.4)
     parallel (1.24.0)
-    parser (3.3.0.5)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
     proc_to_ast (0.1.0)
@@ -125,13 +127,14 @@ GEM
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
     public_suffix (5.0.3)
-    racc (1.7.3)
+    racc (1.8.0)
     rack (3.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
     rchardet (1.8.0)
-    regexp_parser (2.8.3)
-    rexml (3.2.6)
+    regexp_parser (2.9.2)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -153,39 +156,39 @@ GEM
       binding_of_caller
       rspec-parameterized-core (< 2)
     rspec-support (3.12.0)
-    rubocop (1.62.1)
+    rubocop (1.67.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
-    rubocop-graphql (1.5.0)
-      rubocop (>= 0.90, < 2)
-    rubocop-performance (1.20.2)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-graphql (1.5.4)
+      rubocop (>= 1.50, < 2)
+    rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    rubocop-rails (2.24.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.26.0)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
+      rubocop (>= 1.52.0, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.27.1)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
+    rubocop-rspec (3.0.4)
+      rubocop (~> 1.61)
+    rubocop-rspec_rails (2.30.0)
+      rubocop (~> 1.61)
+      rubocop-rspec (~> 3, >= 3.0.1)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     sawyer (0.9.2)
@@ -200,6 +203,7 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    strscan (3.1.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     test_file_finder (0.1.4)

data/README.md

@@ -50,6 +50,7 @@ rules:
 - `rubocop-rspec.yml`
 - `rubocop-security.yml`
 - `rubocop-style.yml`
+- `rubocop-tailwind.yml`
 
 Example:
 

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.0'
+  spec.required_ruby_version = '>= 3.1'
   spec.name          = 'gitlab-styles'
   spec.version       = Gitlab::Styles::VERSION
   spec.authors       = ['GitLab']
@@ -22,12 +22,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '~> 1.62.1'
-  spec.add_dependency 'rubocop-factory_bot', '~> 2.25.1'
-  spec.add_dependency 'rubocop-graphql', '~> 1.5.0'
-  spec.add_dependency 'rubocop-performance', '~> 1.20.2'
-  spec.add_dependency 'rubocop-rails', '~> 2.24.0'
-  spec.add_dependency 'rubocop-rspec', '~> 2.27.1'
+  spec.add_dependency 'rubocop', '~> 1.67.0'
+  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.21.1'
+  spec.add_dependency 'rubocop-rails', '~> 2.26.0'
+  spec.add_dependency 'rubocop-rspec', '~> 3.0.4'
+  spec.add_dependency 'rubocop-rspec_rails', '~> 2.30.0'
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'gitlab-dangerfiles', '~> 4.6.0'

data/lib/gitlab/styles/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Styles
-    VERSION = '12.0.1'
+    VERSION = '13.0.1'
   end
 end

data/lib/rubocop/cop/active_record_dependent.rb

@@ -3,6 +3,12 @@
 module Rubocop
   module Cop
     # Cop that prevents the use of `dependent: ...` in ActiveRecord models.
+    # @example
+    #   # bad
+    #   belongs_to :foo, dependent: :destroy
+    #
+    #   # good
+    #   belongs_to :foo # With database foreign key with cascading deletes
     class ActiveRecordDependent < RuboCop::Cop::Base
       MSG = 'Do not use `dependent:` to remove associated data, ' \
         'use foreign keys with cascading deletes instead.'

data/lib/rubocop/cop/active_record_serialize.rb

@@ -3,6 +3,13 @@
 module Rubocop
   module Cop
     # Cop that prevents the use of `serialize` in ActiveRecord models.
+    #
+    # @example
+    #   # bad
+    #   serialize :preferences
+    #
+    #   # good
+    #   # Column for each individual preference
     class ActiveRecordSerialize < RuboCop::Cop::Base
       MSG = 'Do not store serialized data in the database, use separate columns and/or tables instead'
 

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

@@ -4,9 +4,24 @@ module Rubocop
   module Cop
     module CodeReuse
       # Cop that denies the use of ActiveRecord methods outside of models.
+      #
+      # @example
+      #   # bad
+      #   # In app/workers/some_worker.rb
+      #   User.where(admin: true)
+      #
+      #   # good
+      #   # In app/workers/some_worker.rb
+      #   User.admins
+      #   # In app/models/user.rb
+      #   scope :admins, -> { where(admin: true) }
+      #
+      # See also:
+      # - https://docs.gitlab.com/ee/development/reusing_abstractions.html
+      # - https://gitlab.com/gitlab-org/gitlab-foss/issues/49653
       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://docs.gitlab.com/ee/development/reusing_abstractions.html'
 
         # Various methods from ActiveRecord::Querying that are denied. We
         # exclude some generic ones such as `any?` and `first`, as these may

data/lib/rubocop/cop/fips/md5.rb

@@ -19,7 +19,7 @@ module Rubocop
           @message_template = MESSAGE_TEMPLATE
           @replacements = REPLACEMENTS
           @autocorrect = false
-          super(config, options)
+          super
         end
       end
     end

data/lib/rubocop/cop/fips/open_ssl.rb

@@ -23,7 +23,7 @@ module Rubocop
           @message_template = MESSAGE_TEMPLATE
           @replacements = REPLACEMENTS
           @autocorrect = true
-          super(config, options)
+          super
         end
       end
     end

data/lib/rubocop/cop/fips/sha1.rb

@@ -19,7 +19,7 @@ module Rubocop
           @message_template = MESSAGE_TEMPLATE
           @replacements = REPLACEMENTS
           @autocorrect = false
-          super(config, options)
+          super
         end
       end
     end

data/lib/rubocop/cop/gitlab_security/json_serialization.rb

@@ -30,7 +30,7 @@ module RuboCop
       #   )
       #
       # See https://gitlab.com/gitlab-org/gitlab-ce/issues/29661
-      class JsonSerialization < RuboCop::Cop::Cop
+      class JsonSerialization < RuboCop::Cop::Base
         MSG = "Don't use `%s` without specifying `only`"
 
         # Check for `to_json` sent to any object that's not a Hash literal or
@@ -72,8 +72,9 @@ module RuboCop
           @method = matched.first
 
           if matched.last.nil? || matched.last.empty?
+            @offense_found = true
             # Empty `to_json` call
-            add_offense(node, location: :selector, message: format_message)
+            add_offense(node.loc.selector, message: format_message)
           else
             check_arguments(node, matched)
           end
@@ -102,6 +103,8 @@ module RuboCop
 
           return unless requires_only?
 
+          @offense_found = true
+
           # Add a top-level offense for the entire argument list, but only if
           # we haven't yet added any offenses to the child Hash values (such
           # as `include`)
@@ -117,6 +120,7 @@ module RuboCop
             includes.each_child_node do |child_node|
               next if contains_only?(child_node)
 
+              @offense_found = true
               add_offense(child_node, message: format_message)
             end
           end
@@ -125,7 +129,7 @@ module RuboCop
         def requires_only?
           return false if @_has_top_level_only
 
-          offenses.count.zero?
+          !@offense_found
         end
       end
     end

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'rubocop/cop/internal_affairs/cop_description'
+require 'rubocop/cop/mixin/documentation_comment'
+
+module Rubocop
+  module Cop
+    module InternalAffairs
+      # Enforces the cop description to start with a word such as verb, and to include good and bad examples
+      #
+      # @example
+      #   # bad
+      #   # This cop checks ....
+      #   # @example
+      #   #   # bad
+      #   #   !array.empty?
+      #   #
+      #   #   # good
+      #   #   array.any?
+      #   class SomeCop < Base
+      #     ....
+      #   end
+      #
+      #   # bad
+      #   # Checks ...
+      #   class SomeCop < Base
+      #     ...
+      #   end
+      #
+      #   # good
+      #   # Checks ...
+      #   #
+      #   # @example
+      #   #   # bad
+      #   #   !array.empty?
+      #   #
+      #   #   # good
+      #   #   array.any?
+      #   #
+      #   class SomeCop < Base
+      #     ...
+      #   end
+      class CopDescriptionWithExample < RuboCop::Cop::InternalAffairs::CopDescription
+        include RuboCop::Cop::DocumentationComment
+        extend RuboCop::Cop::AutoCorrector
+
+        MSG_MISSING_EXAMPLES = 'Description should include good and bad examples'
+        MSG_MISSING_DESCRIPTION = 'Must include a description'
+
+        def on_class(node)
+          super
+
+          module_node = node.parent
+
+          return unless module_node && node.parent_class
+
+          return if description_includes_example?(node)
+
+          description_beginning = first_comment_line(module_node)
+
+          if description_beginning.nil?
+            register_offense_for_missing_description(node)
+          else
+            register_offense_for_missing_examples(module_node, description_beginning)
+          end
+        end
+
+        private
+
+        def register_offense_for_missing_description(node)
+          add_offense(node, message: MSG_MISSING_DESCRIPTION)
+        end
+
+        def register_offense_for_missing_examples(module_node, description_beginning)
+          range = range(module_node, description_beginning)
+          add_offense(range, message: MSG_MISSING_EXAMPLES)
+        end
+
+        def description_includes_example?(node)
+          lines = preceding_lines(node)
+          index_of_example = lines.index { |line| line.text.match?(/# @example( |$)/) }
+          return false unless index_of_example
+
+          lines_after_example = lines[index_of_example + 1..]
+
+          lines_after_example.any? { |line| line.text.downcase.match?(/#   # good( |$)/) } &&
+            lines_after_example.any? { |line| line.text.downcase.match?(/#   # bad( |$)/) }
+        end
+      end
+    end
+  end
+end

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

@@ -3,6 +3,31 @@
 module Rubocop
   module Cop
     module Rails
+      #  Avoid including `ActionView::Helpers::UrlHelper`.
+      #  It adds/overrides ~40 methods while usually only one is needed.
+      #  Instead, use the `Gitlab::Routing.url_helpers`/`Application.routes.url_helpers`(outside of gitlab)
+      #  and `ActionController::Base.helpers.link_to`.
+      #
+      # @example
+      #   # bad
+      #   class Foo
+      #     include ActionView::Helpers::UrlHelper  # <-- includes 40 new methods !
+      #
+      #     def link_to_something
+      #       link_to(...)
+      #     end
+      #   end
+      #
+      #   # good
+      #   class Foo
+      #     def link_to_something
+      #       url = Gitlab::Routing.url_helpers.project_blob_path(...)
+      #       ActionController::Base.helpers.link_to(url, "Link text")
+      #     end
+      #   end
+      #
+      # See also
+      # - https://gitlab.com/gitlab-org/gitlab/-/issues/340567.
       class IncludeUrlHelper < RuboCop::Cop::Base
         MSG = <<~MSG
           Avoid including `ActionView::Helpers::UrlHelper`.

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

@@ -5,7 +5,7 @@ require 'rubocop-rspec'
 module Rubocop
   module Cop
     module RSpec
-      class Base < RuboCop::Cop::RSpec::Base
+      class Base < RuboCop::Cop::RSpec::Base # rubocop:disable InternalAffairs/CopDescriptionWithExample -- Base class
       end
     end
   end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Flags use of strftime('%Y-%m-%d') for formatting dates
+      # the preferred method is using .iso8601
+      #
+      # @example
+      #   # bad
+      #   DateTime.now.strftime('%Y-%m-%d')
+      #   Time.now.strftime("%Y-%m-%d")
+      #   Date.today.strftime("%Y-%m-%d")
+      #
+      #   # good
+      #   DateTime.now.to_date.iso8601
+      #   Time.now.to_date.iso8601
+      #   Date.today.iso8601
+      #
+      # See also:
+      # - https://gitlab.com/gitlab-org/gitlab/-/issues/410638
+      class Iso8601Date < RuboCop::Cop::Base
+        extend RuboCop::Cop::AutoCorrector
+        include RangeHelp
+
+        MSG = 'Use `iso8601` instead of `strftime("%Y-%m-%d")`.'
+        RESTRICT_ON_SEND = [:strftime].freeze
+
+        # @!method strftime_iso8601?(node)
+        def_node_matcher :strftime_iso8601?, <<~PATTERN
+        (send $(...) :strftime (str "%Y-%m-%d"))
+        PATTERN
+
+        def on_send(node)
+          return unless strftime_iso8601?(node)
+
+          range = range_between(node.loc.selector.begin_pos, node.loc.end.end_pos)
+
+          add_offense(range) do |corrector|
+            corrector.replace(range, 'to_date.iso8601')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,15 @@ module Rubocop
       # Flags uses of OpenStruct, as it is now officially discouraged
       # to be used for performance, version compatibility, and potential security issues.
       #
+      # @example
+      #   # bad
+      #   class SubClass < OpenStruct
+      #   end
+      #
+      #   # good
+      #   class SubClass
+      #   end
+      #
       # 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

data/lib/rubocop/cop/tailwind/string_interpolation.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module Cop
+    module Tailwind
+      # This prevents utility class names from being built dynamically using string interpolation.
+      # Tailwind needs to be able to parse fully qualified names to include the necessary utils in
+      # the bundle.
+      # @example
+      #   # bad
+      #   bgColor = "gl-bg-#{palette}-#{variant}"
+      #   cssClasses = "gl-#{display} gl-border"
+      #   width = "gl-w-1/#{denominator}"
+      #
+      #   # good
+      #   bgColor = "gl-bg-red-800"
+      #   cssClasses = "gl-flex gl-border"
+      #   width = "gl-w-1/2"
+      class StringInterpolation < RuboCop::Cop::Base
+        TAILWIND_CSS_CLASS = %r{(^|\s)gl-[a-z0-9\-/]*$}
+        MSG = 'String interpolations in CSS utility class names are forbidden. See https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/issues/73.'
+
+        # @!method interpolated_tailwind_class?(node)
+        def_node_matcher :interpolated_tailwind_class?, <<~PATTERN
+          (dstr
+            (str /#{TAILWIND_CSS_CLASS}/)
+            (begin ...)
+            ...
+          )
+        PATTERN
+
+        def on_dstr(node)
+          return unless interpolated_tailwind_class?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/rubocop-all.yml

@@ -1,7 +1,7 @@
 ---
 AllCops:
   # The oldest supported Ruby version.
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
   # 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,5 +1,6 @@
 ---
 require:
+  - rubocop-capybara
   - ./lib/gitlab/styles/rubocop
 
 # Checks if there is a more specific finder offered by Capybara.

data/rubocop-default.yml

@@ -4,9 +4,12 @@ require:
 
 inherit_from:
   - rubocop-all.yml
-  - rubocop-minimal.yml
   - rubocop-capybara.yml
+  - rubocop-code_reuse.yml
+  - rubocop-factory_bot.yml
   - rubocop-graphql.yml
   - rubocop-internal-affairs.yml
   - rubocop-migrations.yml
+  - rubocop-minimal.yml
   - rubocop-rails.yml
+  - rubocop-tailwind.yml

data/rubocop-factory_bot.yml

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

data/rubocop-gemspec.yml

@@ -1,4 +1,8 @@
 ---
+# Prefer add_dependency over add_runtime_dependency as the latter is considered soft-deprecated.
+Gemspec/AddRuntimeDependency:
+  Enabled: true
+
 # Checks that deprecated attributes are not set in a gemspec file. Removing
 # deprecated attributes allows the user to receive smaller packed gems.
 Gemspec/DeprecatedAttributeAssignment:

data/rubocop-internal-affairs.yml

@@ -9,3 +9,12 @@ InternalAffairs/DeprecateCopHelper:
 InternalAffairs/MissingCopDepartment:
   Include:
     - 'lib/rubocop/cop/**/*.rb'
+
+# Superseded by InternalAffairs/CopDescriptionWithExample
+InternalAffairs/CopDescription:
+  Enabled: false
+
+InternalAffairs/CopDescriptionWithExample:
+  Enabled: true
+  Include:
+    - 'lib/rubocop/cop/**/*.rb'

data/rubocop-lint.yml

@@ -381,6 +381,11 @@ Lint/UselessElseWithoutRescue:
 Lint/UselessMethodDefinition: # (new in 0.90)
   Enabled: true
 
+# Certain numeric operations have no impact, being: Adding or subtracting 0, multiplying
+# or dividing by 1 or raising to the power of 1. These are probably leftover from debugging, or are mistakes.
+Lint/UselessNumericOperation:
+  Enabled: true
+
 # Checks for useless setter call to a local variable.
 Lint/UselessSetterCall:
   Enabled: true

data/rubocop-naming.yml

@@ -50,7 +50,8 @@ Naming/MethodParameterName:
 # NameWhitelist: is_a?
 Naming/PredicateName:
   Enabled: true
-  ForbiddenPrefixes: is_
+  ForbiddenPrefixes:
+    - is_
   Exclude:
     - 'spec/**/*'
     - 'features/**/*'

data/rubocop-rails.yml

@@ -63,7 +63,8 @@ Rails/Blank:
 # Checks the correct usage of date aware methods, such as `Date.today`,
 # `Date.current`, etc.
 Rails/Date:
-  Enabled: false
+  Enabled: true
+  EnforcedStyle: flexible
 
 # Prefer delegate method for delegations.
 # Disabled per https://gitlab.com/gitlab-org/gitlab-ce/issues/35869
@@ -74,6 +75,11 @@ Rails/Delegate:
 Rails/DynamicFindBy:
   Enabled: false
 
+# Defining enums with keyword arguments syntax is deprecated and will be removed in
+# Rails 8.0. Positional arguments should be used instead
+Rails/EnumSyntax:
+  Enabled: true
+
 # This cop enforces that 'exit' calls are not used within a rails app.
 Rails/Exit:
   Enabled: true
@@ -199,7 +205,8 @@ Rails/SquishedSQLHeredocs:
 
 # This cop checks for the use of Time methods without zone.
 Rails/TimeZone:
-  Enabled: false
+  Enabled: true
+  EnforcedStyle: flexible
 
 # Checks for the use of exit statements (namely return, break and throw) in
 # transactions. This is due to the eventual unexpected behavior when using
@@ -225,6 +232,11 @@ Rails/WhereExists:
 Rails/WhereNot:
   Enabled: true
 
+# Identifies places where manually constructed SQL in where can be replaced with ranges.
+# https://docs.rubocop.org/rubocop-rails/cops_rails.html#railswhererange
+Rails/WhereRange:
+  Enabled: true
+
 # Bans the use of `include ActionView::Helpers::UrlHelper`.
 Rails/IncludeUrlHelper:
   Enabled: true

data/rubocop-rspec.yml

@@ -1,6 +1,7 @@
 ---
 require:
   - rubocop-rspec
+  - rubocop-rspec_rails
   - ./lib/gitlab/styles/rubocop
 
 # Check that instances are not being stubbed globally.
@@ -38,6 +39,18 @@ RSpec/DescribedClass:
   Enabled: true
   SkipBlocks: true
 
+# Enforces custom RSpec dialects.
+# Migrated config from RSpec/Capybara/FeatureMethods
+RSpec/Dialect:
+  Enabled: true
+  PreferredMethods:
+    background: :before
+    scenario:   :it
+    xscenario:  :xit
+    given:      :let
+    given!:     :let!
+    feature:    :describe
+
 # Checks if an example group does not include any tests.
 RSpec/EmptyExampleGroup:
   Enabled: true
@@ -55,6 +68,11 @@ RSpec/ExampleLength:
   Enabled: false
   Max: 5
 
+# Avoid `it do` instead use `specify do`
+RSpec/ExampleWithoutDescription:
+  Enabled: true
+  EnforcedStyle: single_line_only
+
 # Do not use should when describing your tests.
 RSpec/ExampleWording:
   Enabled: true
@@ -78,12 +96,6 @@ RSpec/ExpectChange:
 RSpec/ExpectOutput:
   Enabled: true
 
-# Checks the file and folder naming of the spec file.
-# Will be replaced with RSpec/SpecFilePathFormat and RSpec/SpecFilePathSuffix.
-RSpec/FilePath:
-  Enabled: true
-  IgnoreMethods: true
-
 # Checks if there are focused specs.
 RSpec/Focus:
   Enabled: true
@@ -103,6 +115,10 @@ RSpec/ImplicitExpect:
   Enabled: true
   EnforcedStyle: is_expected
 
+# Do not set up test data using indexes (e.g., item_1, item_2).
+RSpec/IndexedLet:
+  Enabled: false
+
 # Checks for the usage of instance variables.
 # https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#subject-and-let-variables
 RSpec/InstanceVariable:
@@ -116,6 +132,11 @@ RSpec/LeadingSubject:
 RSpec/LetSetup:
   Enabled: false
 
+# Checks where match_array is used.
+# see: https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/225
+RSpec/MatchArray:
+  Enabled: false
+
 # Check that chains of messages are not being stubbed.
 RSpec/MessageChain:
   Enabled: false
@@ -160,16 +181,19 @@ RSpec/SingleLineHook:
     - 'spec/factories/*'
     - 'spec/requests/api/v3/*'
 
+# Sort RSpec metadata alphabetically.
+# see: https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/232#note_2089653748
+RSpec/SortMetadata:
+  Enabled: false
+
 # Checks the file and folder naming of the spec file.
-# Will replace RSpec/FilePath.
 RSpec/SpecFilePathFormat:
-  Enabled: false
+  Enabled: true
   IgnoreMethods: true
 
 # Checks the file and folder naming of the spec file.
-# Will replace RSpec/FilePath.
 RSpec/SpecFilePathSuffix:
-  Enabled: false
+  Enabled: true
 
 # Checks that message expectations do not have a configured response.
 # https://docs.rubocop.org/rubocop-rspec/1.44/cops_rspec.html#rspecstubbedmock

data/rubocop-style.yml

@@ -182,8 +182,11 @@ Style/HashLikeCase:
 
 # Prefer Ruby 1.9 hash syntax `{ a: 1, b: 2 }`
 # over 1.8 syntax `{ :a => 1, :b => 2 }`.
+# Short-hand Hash syntax does not work prior 3.1.
+# See https://gitlab.com/gitlab-org/gitlab/-/issues/435940#note_1703307479
 Style/HashSyntax:
   Enabled: true
+  EnforcedShorthandSyntax: never
 
 # 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
@@ -222,6 +225,10 @@ Style/InfiniteLoop:
 Style/InverseMethods:
   Enabled: false
 
+# Use iso8601 date format via specific function instead of strftime
+Style/Iso8601Date:
+  Enabled: true
+
 Style/KeywordParametersOrder: # (new in 0.90)
   Enabled: true
 
@@ -238,6 +245,10 @@ Style/OptionalBooleanParameter:
 Style/Strip:
   Enabled: true
 
+# Checks for usages of each with <<, push, or append which can be replaced by map.
+Style/MapIntoArray:
+  Enabled: true
+
 # Checks if the method definitions have or don't have parentheses.
 Style/MethodDefParentheses:
   Enabled: true
@@ -360,6 +371,12 @@ Style/RedundantFetchBlock:
 Style/RedundantFileExtensionInRequire:
   Enabled: true
 
+# Before Ruby 3.0, interpolated strings followed the frozen string literal magic comment which sometimes made it
+# necessary to explicitly unfreeze them. Ruby 3.0 changed interpolated strings to always be unfrozen which makes
+# unfreezing them redundant.
+Style/RedundantInterpolationUnfreeze:
+  Enabled: true
+
 # Checks for parentheses that seem not to serve any purpose.
 Style/RedundantParentheses:
   Enabled: true
@@ -389,6 +406,10 @@ Style/RedundantSortBy:
 Style/Semicolon:
   Enabled: true
 
+# Detects the use of the public_send method with a literal method name argument.
+Style/SendWithLiteralMethodName:
+  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:
@@ -427,6 +448,11 @@ Style/StringMethods:
     intern: to_sym
   Enabled: true
 
+# Checks for redundant argument forwarding when calling super with arguments identical to
+# the method definition.
+Style/SuperArguments:
+  Enabled: true
+
 # Use %i or %I for arrays of symbols.
 Style/SymbolArray:
   Enabled: false

data/rubocop-tailwind.yml

@@ -0,0 +1,7 @@
+---
+require:
+  - ./lib/gitlab/styles/rubocop
+
+# Prevent string interpolation when building Tailwind CSS utils names
+Tailwind/StringInterpolation:
+  Enabled: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 12.0.1
+  version: 13.0.1
 platform: ruby
 authors:
 - GitLab
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,84 +16,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.62.1
+        version: 1.67.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.62.1
+        version: 1.67.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.21.0
 - !ruby/object:Gem::Dependency
   name: rubocop-factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.25.1
+        version: 2.26.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.25.1
+        version: 2.26.1
 - !ruby/object:Gem::Dependency
   name: rubocop-graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.5.4
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.2
+        version: 1.21.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.2
+        version: 1.21.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.24.0
+        version: 2.26.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.24.0
+        version: 2.26.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.27.1
+        version: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.30.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.27.1
+        version: 2.30.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -313,6 +341,7 @@ files:
 - lib/rubocop/cop/gitlab_security/sql_injection.rb
 - lib/rubocop/cop/gitlab_security/system_command_injection.rb
 - lib/rubocop/cop/in_batches.rb
+- lib/rubocop/cop/internal_affairs/cop_description_with_example.rb
 - lib/rubocop/cop/internal_affairs/deprecate_cop_helper.rb
 - lib/rubocop/cop/internal_affairs/missing_cop_department.rb
 - lib/rubocop/cop/internal_affairs/use_restrict_on_send.rb
@@ -334,8 +363,9 @@ files:
 - lib/rubocop/cop/rspec/useless_dynamic_definition.rb
 - lib/rubocop/cop/rspec/verbose_include_metadata.rb
 - lib/rubocop/cop/style/hash_transformation.rb
+- lib/rubocop/cop/style/iso8601_date.rb
 - lib/rubocop/cop/style/open_struct_use.rb
-- lib/rubocop/cop/without_reactive_cache.rb
+- lib/rubocop/cop/tailwind/string_interpolation.rb
 - rubocop-all.yml
 - rubocop-bundler.yml
 - rubocop-capybara.yml
@@ -357,6 +387,7 @@ files:
 - rubocop-rspec.yml
 - rubocop-security.yml
 - rubocop-style.yml
+- rubocop-tailwind.yml
 homepage: https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles
 licenses:
 - MIT
@@ -369,7 +400,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/rubocop/cop/without_reactive_cache.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Rubocop
-  module Cop
-    # Cop that prevents the use of `without_reactive_cache`
-    class WithoutReactiveCache < RuboCop::Cop::Base
-      MSG = 'without_reactive_cache is for debugging purposes only. Please use with_reactive_cache.'
-
-      RESTRICT_ON_SEND = %i[without_reactive_cache].freeze
-
-      def on_send(node)
-        add_offense(node.loc.selector)
-      end
-    end
-  end
-end