gitlab-styles 6.2.1 → 6.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3dfc98241b9f277b993b5a8e599903c804202bf1324e5770463f7f0f85dee91
-  data.tar.gz: 0d52074c0f1b5679c777e290094b36a2b2ecc473a3239e406134d1c014614cf4
+  metadata.gz: f43bff11daad05b1bb5f442c18f3fa7b8ef871e60f7675dd165f55b1515953f7
+  data.tar.gz: 57317b8cb40639df642e1d058f342eba63979b237f18cc5d5290065aef5a3a5f
 SHA512:
-  metadata.gz: 2e644dfd8ee68ec0700f5953d65fc0c6b2e535b20779e317178360b5879fa174f3c9d44077cdf0dee2bb28b79054d053ff8673b2c609dc4bd7262bd38566b428
-  data.tar.gz: dc9fbcf0d42ed4b8ce6e9dd05348068aa3478d987b03fc4306d6e0b55893b619de5b0e0830285f9f2f59bcc38e02be9b61046523a20b3c46b049ce52b93cf1e4
+  metadata.gz: bb319a3ada8ae43e77ba1de5aeb4234e9c6d8c97848f3ae3870222a4b0a4f4ae2f8f2d6356f8cd9b9747101482758834ceacb5cd2cef09519fd17e736a272c05
+  data.tar.gz: bb37685d5084df12a4820c47ce43ec0106aa50e05f9a7ddbde97c9956a7ec50e62fac388a968ba909c356c66324511fa5f407455b538ea1d183d2fa2f20367d1

data/gitlab-styles.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['gitlab_rubygems@gitlab.com']
 
   spec.summary       = 'GitLab style guides and shared style configs.'
-  spec.homepage      = 'https://gitlab.com/gitlab-org/gitlab-styles'
+  spec.homepage      = 'https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rubocop', '~> 0.91', '>= 0.91.1'
   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'

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module Performance
+          # This cop 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.
+          #
+          # See also:
+          # - https://github.com/rubyzip/rubyzip/issues/506
+          # - https://github.com/rubyzip/rubyzip#notes-on-zipinputstream
+          class Rubyzip < RuboCop::Cop::Cop
+            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.'
+
+            def_node_matcher :reads_central_directory?, <<-PATTERN
+              (send
+                (const
+                  (const {nil? (cbase)} :Zip) :File) {:new :open :foreach} ...)
+            PATTERN
+
+            def on_send(node)
+              return unless reads_central_directory?(node)
+
+              add_offense(node)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../../model_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module Rails
+          class IncludeUrlHelper < RuboCop::Cop::Cop
+            MSG = <<~MSG
+              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`.
+              See https://gitlab.com/gitlab-org/gitlab/-/issues/340567.
+            MSG
+
+            def_node_matcher :include_url_helpers_node?, <<~PATTERN
+              (send nil? :include (const (const (const {nil? cbase} :ActionView) :Helpers) :UrlHelper))
+            PATTERN
+
+            def on_send(node)
+              add_offense(node) if include_url_helpers_node?(node)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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.2.1'
+    VERSION = '6.6.0'
   end
 end

data/rubocop-default.yml

@@ -4,12 +4,14 @@ require:
   - rubocop-performance
   - rubocop-rspec
   - rubocop-rails
+  - rubocop-graphql
   - ./lib/gitlab/styles/rubocop
 
 inherit_from:
   - rubocop-all.yml
   - rubocop-bundler.yml
   - rubocop-gemspec.yml
+  - rubocop-graphql.yml
   - rubocop-layout.yml
   - rubocop-lint.yml
   - rubocop-metrics.yml

data/rubocop-graphql.yml

@@ -0,0 +1,30 @@
+---
+require:
+  - rubocop-graphql
+
+# Ensures all arguments have a description
+# Disabled because our bespoke Graphql/Descriptions cop covers this.
+GraphQL/ArgumentDescription:
+  Enabled: false
+
+# Ensures all fields have a description
+# Disabled because our bespoke Graphql/Descriptions cop covers this.
+GraphQL/FieldDescription:
+  Enabled: false
+
+# Suggests using input type instead of many arguments
+GraphQL/ExtractInputType:
+  Enabled: false
+
+# Suggests extracting fields with common prefixes to the separate type
+GraphQL/ExtractType:
+  Enabled: false
+
+# Checks that types are defined with class-based API
+GraphQL/LegacyDsl:
+  Enabled: false
+
+# Ensures all types have a description
+# Disabled because our bespoke Graphql/Descriptions cop covers this.
+GraphQL/ObjectDescription:
+  Enabled: false

data/rubocop-performance.yml

@@ -1,6 +1,7 @@
 ---
 require:
   - rubocop-performance
+  - ./lib/gitlab/styles/rubocop
 
 # Used to identify usages of ancestors.include? and change them to use ⇐ instead.
 # https://docs.rubocop.org/rubocop-performance/1.8/cops_performance.html#performanceancestorsinclude
@@ -38,11 +39,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:
@@ -114,3 +113,9 @@ Performance/Sum:
 # Checks for `.times.map` calls.
 Performance/TimesMap:
   Enabled: true
+
+# Flags potentially expensive operations on ZIP archives.
+Performance/Rubyzip:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'

data/rubocop-rails.yml

@@ -1,6 +1,7 @@
 ---
 require:
   - rubocop-rails
+  - ./lib/gitlab/styles/rubocop
 
 # Enables Rails cops.
 Rails:
@@ -186,3 +187,7 @@ Rails/WhereExists:
 # https://docs.rubocop.org/rubocop-rails/2.8/cops_rails.html#railswherenot
 Rails/WhereNot:
   Enabled: true
+
+# Bans the use of `include ActionView::Helpers::UrlHelper`.
+Rails/IncludeUrlHelper:
+  Enabled: true

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.2.1
+  version: 6.6.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -163,7 +177,9 @@ files:
 - lib/gitlab/styles/rubocop/cop/line_break_after_guard_clauses.rb
 - lib/gitlab/styles/rubocop/cop/line_break_around_conditional_block.rb
 - lib/gitlab/styles/rubocop/cop/migration/update_large_table.rb
+- lib/gitlab/styles/rubocop/cop/performance/rubyzip.rb
 - lib/gitlab/styles/rubocop/cop/polymorphic_associations.rb
+- lib/gitlab/styles/rubocop/cop/rails/include_url_helper.rb
 - lib/gitlab/styles/rubocop/cop/redirect_with_status.rb
 - lib/gitlab/styles/rubocop/cop/rspec/base.rb
 - lib/gitlab/styles/rubocop/cop/rspec/empty_line_after_final_let_it_be.rb
@@ -174,6 +190,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
@@ -184,6 +201,7 @@ files:
 - rubocop-code_reuse.yml
 - rubocop-default.yml
 - rubocop-gemspec.yml
+- rubocop-graphql.yml
 - rubocop-layout.yml
 - rubocop-lint.yml
 - rubocop-metrics.yml
@@ -194,7 +212,7 @@ files:
 - rubocop-rspec.yml
 - rubocop-security.yml
 - rubocop-style.yml
-homepage: https://gitlab.com/gitlab-org/gitlab-styles
+homepage: https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles
 licenses:
 - MIT
 metadata: {}