gitlab-styles 6.0.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88825b6aaa4961f16a29bfc14cdb1d590700a74e81fe68e072fccd2046506c6b
-  data.tar.gz: 5634afcb51a117e54f4760c43f12d3b2564d08b62bbcd49d97b7cde7c88014d6
+  metadata.gz: bdb4b922d729575676263e2cb9cf6f63b50be1d8b4205d96af7ecb6aaa2c4c84
+  data.tar.gz: 46a11af0a19079547b1d25e988e80d8271a5fe15fda707096662aee73a4cc9c3
 SHA512:
-  metadata.gz: 99652ceb45ae8e31ac3105bd7913a2c85e0a5a22cd97ad5d30081fd1b55b4d1734671d9cdbfdf1875dbdbc314efb9fe433b8859a18761ebea1d1054f58aa88d1
-  data.tar.gz: 2b16d7dc347ec66fd1656d735bc6427c485c88e27d7fb3030e0a852d76fb338705a976e85fb949b25b3994035134251da3771a9f3c914767d6d7158ecf5137e4
+  metadata.gz: df88cc8b9ea74b138c8768130b310d50d2204bed62e4648b292a8b0f058dad46335e23432564a546e0acc0ae9ef3c8a2487f4690f8e4ee2a73e6209665441746
+  data.tar.gz: 2d744fd1097268298c1073404bf84ddd4d65b28dbfa4b5bfad95857ea310734d24f93b81870e0c03454c26a2aa8de19470c7f75374e73db25ac0067a2665bebf

data/.gitlab-ci.yml

@@ -14,8 +14,8 @@ workflow:
   rules:
     # For merge requests, create a pipeline.
     - if: '$CI_MERGE_REQUEST_IID'
-    # For `master` branch, create a pipeline (this includes on schedules, pushes, merges, etc.).
-    - if: '$CI_COMMIT_BRANCH == "master"'
+    # For the default branch, create a pipeline (this includes on schedules, pushes, merges, etc.).
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
     # For tags, create a pipeline.
     - if: '$CI_COMMIT_TAG'
 

data/gitlab-styles.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '~> 0.91.1'
+  spec.add_dependency 'rubocop', '~> 0.91', '>= 0.91.1'
   spec.add_dependency 'rubocop-gitlab-security', '~> 0.1.1'
   spec.add_dependency 'rubocop-performance', '~> 1.9.2'
   spec.add_dependency 'rubocop-rails', '~> 2.9'

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

@@ -44,7 +44,6 @@ module Gitlab
               ids: false,
               includes: true,
               joins: true,
-              limit: true,
               lock: false,
               many?: false,
               offset: true,

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/rspec/empty_line_after_final_let_it_be.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+require_relative 'base'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module RSpec
+          # Checks if there is an empty line after the last `let_it_be` block.
+          #
+          # @example
+          #   # bad
+          #   let_it_be(:foo) { bar }
+          #   let_it_be(:something) { other }
+          #   it { does_something }
+          #
+          #   # good
+          #   let_it_be(:foo) { bar }
+          #   let_it_be(:something) { other }
+          #
+          #   it { does_something }
+          class EmptyLineAfterFinalLetItBe < Base
+            extend RuboCop::Cop::AutoCorrector
+            include RuboCop::RSpec::EmptyLineSeparation
+
+            MSG = 'Add an empty line after the last `let_it_be`.'
+
+            def_node_matcher :let_it_be?, <<-PATTERN
+              {
+                (block (send #rspec? {:let_it_be :let_it_be_with_refind :let_it_be_with_reload} ...) ...)
+                (send #rspec? {:let_it_be :let_it_be_with_refind :let_it_be_with_reload} _ block_pass)
+              }
+            PATTERN
+
+            def on_block(node)
+              return unless example_group_with_body?(node)
+
+              final_let_it_be = node.body.child_nodes.reverse.find { |child| let_it_be?(child) }
+
+              return if final_let_it_be.nil?
+
+              missing_separating_line_offense(final_let_it_be) { MSG }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module Style
+          # This cop identifies places where `map { ... }.to_h` or
+          # `Hash[map { ... }]` can be replaced with `to_h { ... }`,
+          # saving an intermediate array allocation.
+          #
+          # @example
+          #   # bad
+          #   hash.map { |k, v| [v.upcase, k.downcase] }.to_h
+          #   hash.collect { |k, v| [v.upcase, k.downcase] }.to_h
+          #   Hash[hash.map { |k, v| [v.upcase, k.downcase] }]
+          #   Hash[hash.collect { |k, v| [v.upcase, k.downcase] }]
+          #   array.map { |x| [x, x + 1] }.to_h
+          #
+          #   # good
+          #   hash.to_h { |k, v| [v.upcase, k.downcase] }
+          #   array.to_h { |x| [x, x + 1] }
+          #
+          # Full credit: https://github.com/eugeneius/rubocop-performance/blob/hash_transformation/lib/rubocop/cop/performance/hash_transformation.rb
+          class HashTransformation < RuboCop::Cop::Cop
+            include RuboCop::Cop::RangeHelp
+
+            MSG = 'Use `to_h { ... }` instead of `%<current>s`.'
+
+            def_node_matcher :to_h_candidate?, <<~PATTERN
+              {
+                [(send
+                  $(block $(send _ {:map :collect}) ...) :to_h) !block_literal?]
+                (send (const nil? :Hash) :[]
+                  $(block $(send _ {:map :collect}) ...))
+              }
+            PATTERN
+
+            def on_send(node)
+              to_h_candidate?(node) do |_block, call|
+                range = offense_range(node, call)
+                message = message(node, call)
+                add_offense(node, location: range, message: message)
+              end
+            end
+
+            def autocorrect(node)
+              block, call = to_h_candidate?(node)
+
+              lambda do |corrector|
+                corrector.remove(after_block(node, block))
+                corrector.replace(call.loc.selector, 'to_h')
+                corrector.remove(before_block(node, block))
+              end
+            end
+
+            private
+
+            def offense_range(node, call)
+              return node.source_range if node.children.first.const_type?
+
+              range_between(call.loc.selector.begin_pos, node.loc.selector.end_pos)
+            end
+
+            def message(node, call)
+              current = if node.children.first.const_type?
+                          "Hash[#{call.method_name} { ... }]"
+                        else
+                          "#{call.method_name} { ... }.to_h"
+                        end
+
+              format(MSG, current: current)
+            end
+
+            def after_block(node, block)
+              block.source_range.end.join(node.source_range.end)
+            end
+
+            def before_block(node, block)
+              node.source_range.begin.join(block.source_range.begin)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/rspec/helpers.rb

@@ -9,7 +9,8 @@ module Gitlab
         module Helpers
           include RuboCop::RSpec::Language
 
-          LET = SelectorSet.new(%i[let_it_be]) + RuboCop::RSpec::Language::Helpers::ALL
+          LET_IT_BE_HELPERS = SelectorSet.new(%i[let_it_be let_it_be_with_refind let_it_be_with_reload])
+          LET = LET_IT_BE_HELPERS + RuboCop::RSpec::Language::Helpers::ALL
         end
       end
     end

data/lib/gitlab/styles/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Styles
-    VERSION = '6.0.0'
+    VERSION = '6.3.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-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,6 +38,12 @@ Performance/DoubleStartEndWith:
 Performance/MethodObjectAsBlock: # (new in 1.9)
   Enabled: true
 
+# Use `Struct.new(..., keyword_init: true)` instead of `OpenStruct.new(...)`.
+Performance/OpenStruct:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+
 # Use `Range#cover?` instead of `Range#include?`.
 Performance/RangeInclude:
   Enabled: true

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:
@@ -187,6 +190,13 @@ Style/HashTransformKeys:
 Style/HashTransformValues:
   Enabled: true
 
+
+# This cop identifies places where `map { ... }.to_h` or
+# `Hash[map { ... }]` can be replaced with `to_h { ... }`,
+# saving an intermediate array allocation.
+Style/HashTransformation:
+  Enabled: true
+
 # Checks that conditional statements do not have an identical line at the
 # end of each branch, which can validly be moved out of the conditional.
 Style/IdenticalConditionalBranches:

metadata

@@ -1,20 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.3.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-07 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.91'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.91.1
   type: :runtime
@@ -22,6 +25,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.91'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.91.1
 - !ruby/object:Gem::Dependency
@@ -158,14 +164,17 @@ 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
 - lib/gitlab/styles/rubocop/cop/rspec/empty_line_after_let_block.rb
 - lib/gitlab/styles/rubocop/cop/rspec/empty_line_after_shared_example.rb
 - lib/gitlab/styles/rubocop/cop/rspec/example_starting_character.rb
 - lib/gitlab/styles/rubocop/cop/rspec/have_link_parameters.rb
 - 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/without_reactive_cache.rb
 - lib/gitlab/styles/rubocop/migration_helpers.rb
 - lib/gitlab/styles/rubocop/model_helpers.rb
@@ -205,7 +214,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.