gitlab-styles 6.3.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdb4b922d729575676263e2cb9cf6f63b50be1d8b4205d96af7ecb6aaa2c4c84
-  data.tar.gz: 46a11af0a19079547b1d25e988e80d8271a5fe15fda707096662aee73a4cc9c3
+  metadata.gz: 7243d64ca027fd058b9183cab0e19417797fa05e9b13de3f31200027b39c0440
+  data.tar.gz: c45d182c5dc811e729bc93c26db12c9127b276ad266fad7be3bc921b7d1def89
 SHA512:
-  metadata.gz: df88cc8b9ea74b138c8768130b310d50d2204bed62e4648b292a8b0f058dad46335e23432564a546e0acc0ae9ef3c8a2487f4690f8e4ee2a73e6209665441746
-  data.tar.gz: 2d744fd1097268298c1073404bf84ddd4d65b28dbfa4b5bfad95857ea310734d24f93b81870e0c03454c26a2aa8de19470c7f75374e73db25ac0067a2665bebf
+  metadata.gz: 64fed474c7b045454a9dad3e9faf742ca4bc371084562033e7062eeb4a6e0130084000e5579e6b1c2f32c47c4b674d5b5f6d7cc4dd07d6b53d93e229e5178453
+  data.tar.gz: 735af04bd27f127aa2bc99cb1ca06a951892bcf42957e82c2a3e029b570ae29ca88d3be4de3aba0f21e6d0a82197c1fbc26b4f6c96289c8d682832c4291c37af

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module Style
+          # This cop 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
+            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'
+
+            def_node_matcher :uses_open_struct?, <<-PATTERN
+              (const {nil? (cbase)} :OpenStruct)
+            PATTERN
+
+            def on_const(node)
+              return unless uses_open_struct?(node)
+              return if custom_class_or_module_definition?(node)
+
+              add_offense(node)
+            end
+
+            private
+
+            def custom_class_or_module_definition?(node)
+              parent = node.parent
+
+              (parent.class_type? || parent.module_type?) && node.left_siblings.empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Styles
-    VERSION = '6.3.0'
+    VERSION = '6.4.0'
   end
 end

data/rubocop-performance.yml

@@ -38,11 +38,9 @@ Performance/DoubleStartEndWith:
 Performance/MethodObjectAsBlock: # (new in 1.9)
   Enabled: true
 
-# Use `Struct.new(..., keyword_init: true)` instead of `OpenStruct.new(...)`.
+# Superseded by Style/OpenStructUse
 Performance/OpenStruct:
-  Enabled: true
-  Exclude:
-    - 'spec/**/*'
+  Enabled: false
 
 # Use `Range#cover?` instead of `Range#include?`.
 Performance/RangeInclude:

data/rubocop-style.yml

@@ -297,6 +297,10 @@ Style/NumericLiterals:
 Style/OneLineConditional:
   Enabled: true
 
+# Do not use OpenStruct.
+Style/OpenStructUse:
+  Enabled: true
+
 # Don't use parentheses around the condition of an if/unless/while.
 Style/ParenthesesAroundCondition:
   Enabled: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.4.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-17 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -175,6 +175,7 @@ files:
 - lib/gitlab/styles/rubocop/cop/rspec/single_line_hook.rb
 - lib/gitlab/styles/rubocop/cop/rspec/verbose_include_metadata.rb
 - lib/gitlab/styles/rubocop/cop/style/hash_transformation.rb
+- lib/gitlab/styles/rubocop/cop/style/open_struct_use.rb
 - lib/gitlab/styles/rubocop/cop/without_reactive_cache.rb
 - lib/gitlab/styles/rubocop/migration_helpers.rb
 - lib/gitlab/styles/rubocop/model_helpers.rb