gitlab-styles 6.2.0 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8de6943529f148b2e25546b043835e1d00cb06b4b9c88124457b9556830e7c29
-  data.tar.gz: 44f5b72122c8626318a1914eec7e3e462eeab5c479393d2f526b6e4937123131
+  metadata.gz: 4f15e657637a0d30fed824f3d8312b970b9ee9bebc5a0feb603b83fa884b1705
+  data.tar.gz: fef3baec21ab04501f316d754a02aab77fb4dc816a048f87070d6d1b4a28f74c
 SHA512:
-  metadata.gz: 35e146b2b436d9801ee242f8867662be1b3b9febe1f6b55eebf951fbe676dfdfffd93d3f0615928940a0b68bcc5e8ea049c23ac035a468db235f28464c32e648
-  data.tar.gz: 9352b19250deedf7a716c576ab3f54b18e855dca95f5a18ed204bbe34ef7d395ed27a75e2dfe7ad00969552f28f474550053e8479e15c35487defe4f73bc9646
+  metadata.gz: 9954e550cf2ead877c73939a6f20893be5a584eb2c4f0850ea2cb5c8f4e976f3a20d3f910c0a39072c87e666cba51a8f5d283c56e33e2b2db76b1376f18cab7f
+  data.tar.gz: a54833e11f28072707ca11e21428820d888a8c95f89a5577e2633d324311400eca5d277b93311a405239397ca9ad3abac2a9982fcd5ace63f5a4491af970d513

data/gitlab-styles.gemspec

@@ -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/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.0'
+    VERSION = '6.5.0'
   end
 end

data/rubocop-code_reuse.yml

@@ -1,3 +1,7 @@
+---
+require:
+  - ./lib/gitlab/styles/rubocop
+
 # Denies the use of ActiveRecord methods outside of configured
 # excluded directories
 # Directories that allow the use of the denied methods.

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-migrations.yml

@@ -1,4 +1,7 @@
 ---
+require:
+  - ./lib/gitlab/styles/rubocop
+
 # Checks for methods that may lead to batch type issues on a table that's been
 # explicitly denied because of its size.
 #

data/rubocop-performance.yml

@@ -1,4 +1,7 @@
 ---
+require:
+  - rubocop-performance
+
 # 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
 Performance/AncestorsInclude:
@@ -35,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-rails.yml

@@ -1,4 +1,8 @@
 ---
+require:
+  - rubocop-rails
+  - ./lib/gitlab/styles/rubocop
+
 # Enables Rails cops.
 Rails:
   Enabled: true
@@ -183,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-rspec.yml

@@ -1,4 +1,7 @@
 ---
+require:
+  - ./lib/gitlab/styles/rubocop
+
 # Check that instances are not being stubbed globally.
 RSpec/AnyInstance:
   Enabled: false

data/rubocop-security.yml

@@ -1,4 +1,7 @@
 ---
+require:
+  - rubocop-gitlab-security
+
 # This cop checks for the use of JSON class methods which have potential
 # security issues.
 Security/JSONLoad:

data/rubocop-style.yml

@@ -1,4 +1,7 @@
 ---
+require:
+  - ./lib/gitlab/styles/rubocop
+
 # Checks for grouping of accessors in class and module bodies.
 # https://docs.rubocop.org/rubocop/0.89/cops_style.html#styleaccessorgrouping
 Style/AccessorGrouping:
@@ -294,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.0
+  version: 6.5.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2021-11-17 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
@@ -164,6 +178,7 @@ files:
 - 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/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 +189,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 +200,7 @@ files:
 - rubocop-code_reuse.yml
 - rubocop-default.yml
 - rubocop-gemspec.yml
+- rubocop-graphql.yml
 - rubocop-layout.yml
 - rubocop-lint.yml
 - rubocop-metrics.yml
@@ -213,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: GitLab style guides and shared style configs.