gitlab-styles 13.1.0 → 14.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e57fcdf2fdb535c445887ec28fe2c32809c24b90cf0202a27cf04f086c32fbc
-  data.tar.gz: '074834caba51bf818e60afdffe2260f644d270d065af3eb46dd256d6deb90d5c'
+  metadata.gz: 2e07aeadc05dafb796aaa44e43f0f0e7c53344048756b9d402a81949f71d14c2
+  data.tar.gz: 90b4af4c628cc78a537907563f14068a2d18f8eff3199db32a3434c8adb12f04
 SHA512:
-  metadata.gz: 60c696ef6dcde1baac7ff18ba02267f1d275182cf4ffa0bdfe400c7144ae8100bfc9f15e3faea4597e45afc3dd18e3445fda8b55ce1b9251ca57b985f682ab40
-  data.tar.gz: 980a9c08bf84a10dc151c188b66cc60d3e42a953aea058955ad65bc6d8ad32d7498f154ce74257b71a1ef620d58cd3ef1f28c0025f2547c17eb5b5be02e60bb8
+  metadata.gz: c237f8409677ebffef96022175af2604d4e14472df266f4cc00112a2f44e4b374537326540eb5786573dd6680b4215e126500bc4373af3bc01d5c40957ca68ec
+  data.tar.gz: be9a4aa227f7913295c98b2445e3f4108cd42f17ee5b81f12416f3b2e31c273b153980d6bb45c54c1d51eb3dff4c6a16c6bcac51ea96a1bfaea198d6820c9760

data/.gitlab/merge_request_templates/New Static Analysis Check.md

@@ -11,11 +11,37 @@ Please describe the proposal and add a link to the source (for example, http://w
   - CHOICE_A: :a:
   - CHOICE_B: :b:
   - Vote yourself for both choices so that people know these are the choices
+- [ ] Provide the impact of the proposal on `gitlab-org/gitlab`
 - [ ] The MR doesn't have significant objections, and is getting a majority of :+1: vs :-1: (remember that [we don't need to reach a consensus](https://about.gitlab.com/handbook/values/#collaboration-is-not-consensus))
 - [ ] (If applicable) One style is getting a majority of vote (compared to the other choice)
 - [ ] (If applicable) Update the MR with the chosen style
 - [ ] Follow the [review process](https://docs.gitlab.com/ee/development/code_review.html) as usual
 
+### Impact on gitlab-org/gitlab>
+
+<!--
+
+1. In monolith's Gemfile, point `gitlab-styles` gem to this very MR branch.
+
+    For example, in Gemfile:
+
+        ...
+        gem 'gitlab-styles', '~> 13.1.0', require: false,
+            git: 'https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles.git',
+            ref: '<MR branch>' # rubocop:disable Cop/GemFetcher
+        ...
+
+2. Run `bundle update`
+3. Run `bundle exec rubocop --only <cop/rule> | pbcopy`
+4. Paste the output below
+
+-->
+
+```
+[Paste the output here]
+```
+
+
 /label ~"Engineering Productivity" ~"development guidelines" ~"static code analysis"
 
 /cc @gitlab-org/maintainers/rails-backend

data/.gitlab-ci.yml

@@ -16,7 +16,7 @@ default:
     - gitlab-org
 
 .base-ruby-job:
-  image: "ruby:${RUBY_VERSION}"
+  image: "${GITLAB_DEPENDENCY_PROXY}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

data/.rubocop_todo.yml

@@ -1,26 +1,18 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --exclude-limit 10000`
-# on 2025-02-02 02:50:28 UTC using RuboCop version 1.71.0.
+# on 2025-08-12 06:28:35 UTC using RuboCop version 1.71.2.
 # 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
+# Offense count: 3
 # 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: 10
 InternalAffairs/MissingCopDepartment:

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    gitlab-styles (13.1.0)
-      rubocop (= 1.71.1)
-      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)
+    gitlab-styles (14.0.0)
+      rubocop (= 1.81.7)
+      rubocop-capybara (= 2.21.0)
+      rubocop-factory_bot (= 2.26.1)
+      rubocop-graphql (= 1.5.4)
+      rubocop-performance (= 1.23.1)
+      rubocop-rails (= 2.29.1)
+      rubocop-rspec (= 3.4.0)
+      rubocop-rspec_rails (= 2.30.0)
 
 GEM
   remote: https://rubygems.org/
@@ -101,6 +101,7 @@ GEM
       kramdown (~> 2.0)
     language_server-protocol (3.17.0.3)
     lefthook (1.3.13)
+    lint_roller (1.1.0)
     method_source (1.0.0)
     mini_mime (1.1.5)
     minitest (5.18.0)
@@ -113,9 +114,10 @@ GEM
       sawyer (~> 0.9)
     open4 (1.3.4)
     parallel (1.24.0)
-    parser (3.3.1.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
+    prism (1.6.0)
     proc_to_ast (0.1.0)
       coderay
       parser
@@ -156,35 +158,37 @@ GEM
       binding_of_caller
       rspec-parameterized-core (< 2)
     rspec-support (3.12.0)
-    rubocop (1.71.1)
+    rubocop (1.81.7)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.0)
-      parser (>= 3.3.1.0)
+    rubocop-ast (1.48.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
     rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
     rubocop-factory_bot (2.26.1)
       rubocop (~> 1.61)
     rubocop-graphql (1.5.4)
       rubocop (>= 1.50, < 2)
-    rubocop-performance (1.21.1)
+    rubocop-performance (1.23.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rails (2.26.0)
+    rubocop-rails (2.29.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.52.0, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (3.0.4)
+    rubocop-rspec (3.4.0)
       rubocop (~> 1.61)
     rubocop-rspec_rails (2.30.0)
       rubocop (~> 1.61)

data/README.md

@@ -19,6 +19,19 @@ Or install it yourself as:
 
     $ gem install gitlab-styles
 
+## Why We Pin Gem Versions
+
+`gitlab-styles` pins specific versions of RuboCop and related gems (e.g., `rubocop-rails`, `rubocop-rspec`, `rubocop-performance`) to ensure **consistent rule configuration and behavior across all GitLab projects**.
+
+When gems are left unpinned, minor or patch version updates can introduce:
+
+- **New or modified RuboCop rules** that may conflict with your project's configuration
+- **Inconsistent linting results** across different environments and CI/CD pipelines
+- **Unexpected build failures** when developers or CI systems install different versions
+- **Configuration drift** between projects using `gitlab-styles`
+
+By pinning versions, we guarantee that all projects using `gitlab-styles` enforce the same coding standards and rules, regardless of when they install the gem.
+
 ## Usage
 
 ### Inherit all rules

data/gitlab-styles.gemspec

@@ -22,14 +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.71.1'
-  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_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_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 = '13.1.0'
+    VERSION = '14.0.0'
   end
 end

data/lib/rubocop/cop/avoid_return_from_blocks.rb

@@ -67,8 +67,7 @@ module Rubocop
       end
 
       def def?(node)
-        node.type?(:def, :defs) ||
-          (node.block_type? && DEF_METHODS.include?(node.method_name))
+        node.any_def_type? || (node.block_type? && DEF_METHODS.include?(node.method_name))
       end
 
       def allowed?(block_node)

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

@@ -5,6 +5,16 @@ require_relative '../../../gitlab/styles/common/banned_constants'
 module Rubocop
   module Cop
     module Fips
+      # Checks for the usage of MD5, which is not FIPS-compliant.
+      # It suggests using a FIPS-compliant alternative like SHA256.
+      #
+      # @example
+      #   # bad
+      #   OpenSSL::Digest::MD5.hexdigest('foo')
+      #   Digest::MD5.hexdigest('foo')
+      #
+      #   # good
+      #   OpenSSL::Digest::SHA256.hexdigest('foo')
       class MD5 < RuboCop::Cop::Base
         include Gitlab::Styles::Common::BannedConstants
 

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

@@ -5,6 +5,17 @@ require_relative '../../../gitlab/styles/common/banned_constants'
 module Rubocop
   module Cop
     module Fips
+      # Flags usage of the Digest class (which is not FIPS-compliant) and suggests replacing it with OpenSSL::Digest
+      # (which is FIPS-compliant).
+      #
+      # @example
+      #   # bad
+      #   Digest::SHA1.hexdigest('foo')
+      #   Digest::SHA512('foo')
+      #
+      #   # good
+      #   OpenSSL::Digest::SHA1.hexdigest('foo')
+      #   OpenSSL::Digest::SHA512.hexdigest('foo')
       class OpenSSL < RuboCop::Cop::Base
         extend RuboCop::Cop::AutoCorrector
         include Gitlab::Styles::Common::BannedConstants

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

@@ -5,6 +5,14 @@ require_relative '../../../gitlab/styles/common/banned_constants'
 module Rubocop
   module Cop
     module Fips
+      # Cop that denies the use of Digest::SHA1
+      # @example
+      #   # bad
+      #   OpenSSL::Digest::SHA1.hexdigest('foo')
+      #   Digest::SHA1('ABC')
+      #
+      #   # good
+      #   OpenSSL::Digest::SHA256.hexdigest('foo')
       class SHA1 < RuboCop::Cop::Base
         include Gitlab::Styles::Common::BannedConstants
 

data/lib/rubocop/cop/gem_fetcher.rb

@@ -5,6 +5,12 @@ module Rubocop
     # Prevents usage of the `git` and `github` arguments to `gem` in a
     # `Gemfile` in order to avoid additional points of failure beyond
     # rubygems.org.
+    # @example
+    #   # bad
+    #   gem 'rack', git: 'https://github.com/rack/rack'
+    #
+    #   # good
+    #   gem "rack"
     class GemFetcher < RuboCop::Cop::Base
       MSG = 'Do not use gems from git repositories, only use gems from RubyGems or vendored gems. ' \
         'See https://docs.gitlab.com/ee/development/gemfile.html#no-gems-fetched-from-git-repositories'

data/lib/rubocop/cop/in_batches.rb

@@ -3,6 +3,14 @@
 module Rubocop
   module Cop
     # Cop that prevents the use of `in_batches`
+    # @example
+    #   # bad
+    #   Foo.in_batches do |relation|
+    #   end
+    #
+    #   # good
+    #   Foo.each_batch do |relation|
+    #   end
     class InBatches < RuboCop::Cop::Base
       MSG = 'Do not use `in_batches`, use `each_batch` from the EachBatch module instead'
 

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

@@ -81,7 +81,7 @@ module Rubocop
           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 = 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( |$)/) }

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

@@ -4,6 +4,18 @@ module Rubocop
   module Cop
     module InternalAffairs
       # Cop that denies the use of CopHelper.
+      # @example
+      #   # bad
+      #   include CopHelper
+      #
+      #   inspect_source(<<~RUBY)
+      #     #....
+      #   RUBY
+      #
+      #   # good
+      #   expect_offense(<<~RUBY)
+      #     # ....
+      #   RUBY
       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'
 

data/lib/rubocop/cop/line_break_around_conditional_block.rb

@@ -100,7 +100,7 @@ module Rubocop
       end
 
       def end_clause_line?(line)
-        line =~ /^\s*(#|rescue|else|elsif|when)/
+        line =~ /^\s*(#|rescue|else|elsif|when|ensure)/
       end
 
       def begin_line?(line)

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

@@ -8,6 +8,12 @@ module Rubocop
       # files and directories, this can be very expensive even when the archive's size
       # in bytes is small.
       #
+      # @example
+      #   # bad
+      #   Zip::File.open('file_path.zip', &block)
+      #
+      #   # good
+      #   Zip::InputStream.open('file_path.zip')
       # See also:
       # - https://github.com/rubyzip/rubyzip/issues/506
       # - https://github.com/rubyzip/rubyzip#notes-on-zipinputstream

data/lib/rubocop/cop/polymorphic_associations.rb

@@ -3,6 +3,17 @@
 module Rubocop
   module Cop
     # Cop that prevents the use of polymorphic associations
+    # @example
+    #   # bad
+    #   class Comment < ApplicationRecord
+    #     belongs_to :commentable, polymorphic: true
+    #   end
+    #
+    #   # good
+    #   class Comment < ApplicationRecord
+    #     belongs_to :post
+    #     belongs_to :article
+    #   end
     class PolymorphicAssociations < RuboCop::Cop::Base
       MSG = 'Do not use polymorphic associations, use separate tables instead'
 

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

@@ -14,7 +14,8 @@ module Rubocop
       #   css_classes = ["gl-mt-3", "md:gl-mt-5"]
       #   %div{ class: ["gl-mt-3", "md:gl-mt-5"] }
       class MaxWidthMediaQueries < RuboCop::Cop::Base
-        TAILWIND_CSS_CLASS = /max-(sm|md|lg|xl):gl-/
+        ALLOWLIST = ['hidden'].freeze
+        TAILWIND_CSS_CLASS = /max-(sm|md|lg|xl):gl-(?!#{ALLOWLIST.join('|')})/
         MSG = 'Do not use max-width media query utility classes unless absolutely necessary. ' \
           'Use min-width media query utility classes instead.'
 

data/rubocop-naming.yml

@@ -48,7 +48,7 @@ Naming/MethodParameterName:
 # NamePrefix: is_, has_, have_
 # NamePrefixBlacklist: is_, has_, have_
 # NameWhitelist: is_a?
-Naming/PredicateName:
+Naming/PredicatePrefix:
   Enabled: true
   ForbiddenPrefixes:
     - is_

data/rubocop-style.yml

@@ -475,6 +475,10 @@ Style/TrailingCommaInArguments:
   Enabled: true
   EnforcedStyleForMultiline: no_comma
 
+# Checks for the use of logical operators in an unless condition.
+Style/UnlessLogicalOperators:
+  Enabled: true
+
 # Don't interpolate global, instance and class variables directly in strings.
 Style/VariableInterpolation:
   Enabled: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 13.1.0
+  version: 14.0.0
 platform: ruby
 authors:
 - GitLab
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2026-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,110 +16,110 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.71.1
+        version: 1.81.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.71.1
+        version: 1.81.7
 - !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.26.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.26.1
 - !ruby/object:Gem::Dependency
   name: rubocop-graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.5.4
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.21.1
+        version: 1.23.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.21.1
+        version: 1.23.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.26.0
+        version: 2.29.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.26.0
+        version: 2.29.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: 3.4.0
 - !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.30.0
 - !ruby/object:Gem::Dependency
@@ -409,7 +409,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: GitLab style guides and shared style configs.