gitlab-styles 3.3.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b678f69301c072f2a4ff3568240a53603af1dde32d22b4bcc7bfde79477fb281
-  data.tar.gz: c5c3462573f631914c3bd10bd84589cec1f3f75c39e40acf11b9fca28c110e50
+  metadata.gz: 00dda1d4ea5cfd931d74ccf3def7dd6ed3552359c2519e7b6a73464cb3612b92
+  data.tar.gz: 8fd90715af2921b22e53d241f12e4a546f8d53923a688028132af3e5e28f0349
 SHA512:
-  metadata.gz: 57d30093fc6fbe46cb2039e89c16f68b97dab5d2e794e75f8ab732c8e723887bd1dc3dd3708561d12767055b46820a413a495bf3a1790af4f1caf1f4f128230f
-  data.tar.gz: b58567db3d26db1a13f5c6327484f34cb79bc5914a1a27357b54cbe41e88fb5efbffba56d2605630c66dd91cc4cd9d5078e276cf6425caed7af789fcfd8bfa92
+  metadata.gz: 58e29fee8c087356c272e72e9d3a8b719581e5f185ceed85d554a9ccb664654288373b2a6d1e4c1ba9587bfce4c2225960797e4c89e321688da8fa52d4a12b81
+  data.tar.gz: a2c2f9843238a87f1af60f28beac5ec8c1ae5f1d236ab1554e88d07f95824e6474dda3b96ff5ec26a3219015c5415ea21824d41cc98d3cd06990b5ff55104097

data/.gitignore

@@ -3,10 +3,12 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/
 
 # rspec failure tracking
 .rspec_status
+
+# Ignore IDE specific files
+.idea/

data/.gitlab-ci.yml

@@ -1,13 +1,45 @@
-image: ruby:2.3
+stages:
+  - release
+  - test
 
-before_script:
-  - bundle --version
-  - bundle install
+default:
+  image: ruby:2.6
+  tags:
+    - gitlab-org
+  before_script:
+    - bundle --version
+    - bundle install
+
+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 tags, create a pipeline.
+    - if: '$CI_COMMIT_TAG'
 
 styles:
+  stage: test
   script:
     - bundle exec rubocop --debug --parallel
 
 specs:
+  stage: test
   script:
     - bundle exec rspec
+
+release:
+  stage: release
+  rules:
+    - if: '$CI_COMMIT_TAG'
+  script:
+    - gem update --system
+    - ruby --version
+    - gem env version
+    - gem build gitlab-styles.gemspec
+    - gem push gitlab-styles*.gem
+  artifacts:
+    paths:
+      - gitlab-styles*.gem
+    expire_in: 30 days

data/.gitlab/merge_request_templates/Release.md

@@ -0,0 +1,35 @@
+<!-- Replace `v4.5.0` with the previous release here, and `e18d76b309e42888759c1effe96767f13e34ae55`
+with the latest commit from https://gitlab.com/gitlab-org/gitlab-styles/commits/master that will be included in the release. -->
+- Diff: https://gitlab.com/gitlab-org/gitlab-styles/compare/v4.5.0...e18d76b309e42888759c1effe96767f13e34ae55
+
+- Release notes:
+
+<!-- Keep the sections order but remove the empty sections -->
+
+```markdown
+### New scenarios and scenario updates
+
+- !aaa <Title of the aaa MR>.
+
+### Fixes
+
+- !bbb <Title of the bbb MR>.
+
+### Doc changes
+
+- !ccc <Title of the ccc MR>.
+
+### Other changes (CI, backstage)
+
+- !ddd <Title of the ddd MR>.
+```
+
+- Checklist before merging:
+  - [ ] Diff link is up-to-date.
+  - [ ] Based on the diff, `lib/gitlab/styles/version.rb` is updated, according to [SemVer](https://semver.org).
+  - [ ] Release notes are accurate.
+
+- Checklist after merging:
+  - [ ] [Create a tag for the new release version](docs/release_process.md#how-to).
+
+/label ~"Engineering Productivity" ~"tooling::workflow"

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gitlab-rubocop.gemspec
@@ -5,6 +7,7 @@ gemspec
 
 group :test do
   # Pin these dependencies, otherwise a new rule could break the CI pipelines
-  gem 'rubocop', '0.74.0'
+  gem 'rubocop', '0.82.0'
   gem 'rubocop-rspec', '1.36.0'
+  gem 'rspec-parameterized', '0.4.2', require: false
 end

data/README.md

@@ -42,6 +42,7 @@ rules:
 - `rubocop-gemspec.yml`
 - `rubocop-layout.yml`
 - `rubocop-lint.yml`
+- `rubocop-migrations.yml`
 - `rubocop-metrics.yml`
 - `rubocop-naming.yml`
 - `rubocop-performance.yml`
@@ -77,6 +78,10 @@ https://gitlab.com/gitlab-org/gitlab-styles. This project is intended to be a
 safe, welcoming space for collaboration, and contributors are expected to adhere
 to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+## Release Process
+
+Please refer to the [Release Process](docs/release_process.md).
+
 ## License
 
 The gem is available as open source under the terms of the

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/gitlab-styles.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gitlab/styles/version'
@@ -13,16 +15,16 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(docs|test|spec|features)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '~> 0.74.0'
+  spec.add_dependency 'rubocop', '~> 0.82.0'
   spec.add_dependency 'rubocop-gitlab-security', '~> 0.1.0'
-  spec.add_dependency 'rubocop-performance', '~> 1.4.1'
-  spec.add_dependency 'rubocop-rails', '~> 2.0'
+  spec.add_dependency 'rubocop-performance', '~> 1.5.2'
+  spec.add_dependency 'rubocop-rails', '~> 2.5'
   spec.add_dependency 'rubocop-rspec', '~> 1.36'
 
   spec.add_development_dependency 'bundler', '~> 1.16'

data/lib/gitlab/styles.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gitlab/styles/version'
 
 module Gitlab

data/lib/gitlab/styles/rubocop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gitlab/styles/rubocop/cop/custom_error_class'
 require 'gitlab/styles/rubocop/cop/gem_fetcher'
 require 'gitlab/styles/rubocop/cop/active_record_serialize'
@@ -6,10 +8,13 @@ require 'gitlab/styles/rubocop/cop/polymorphic_associations'
 require 'gitlab/styles/rubocop/cop/active_record_dependent'
 require 'gitlab/styles/rubocop/cop/in_batches'
 require 'gitlab/styles/rubocop/cop/line_break_after_guard_clauses'
+require 'gitlab/styles/rubocop/cop/migration/update_large_table'
 require 'gitlab/styles/rubocop/cop/without_reactive_cache'
 require 'gitlab/styles/rubocop/cop/rspec/single_line_hook'
 require 'gitlab/styles/rubocop/cop/rspec/have_link_parameters'
 require 'gitlab/styles/rubocop/cop/rspec/verbose_include_metadata'
+require 'gitlab/styles/rubocop/cop/rspec/empty_line_after_shared_example'
+require 'gitlab/styles/rubocop/cop/rspec/empty_line_after_let_block'
 
 module Gitlab
   module Styles

data/lib/gitlab/styles/rubocop/cop/active_record_dependent.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../model_helpers'
 
 module Gitlab
@@ -9,7 +11,7 @@ module Gitlab
           include ModelHelpers
 
           MSG = 'Do not use `dependent: to remove associated data, ' \
-            'use foreign keys with cascading deletes instead'.freeze
+            'use foreign keys with cascading deletes instead'
 
           METHOD_NAMES = [:has_many, :has_one, :belongs_to].freeze
 

data/lib/gitlab/styles/rubocop/cop/active_record_serialize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../model_helpers'
 
 module Gitlab
@@ -8,7 +10,7 @@ module Gitlab
         class ActiveRecordSerialize < RuboCop::Cop::Cop
           include ModelHelpers
 
-          MSG = 'Do not store serialized data in the database, use separate columns and/or tables instead'.freeze
+          MSG = 'Do not store serialized data in the database, use separate columns and/or tables instead'
 
           def on_send(node)
             return unless in_model?(node)

data/lib/gitlab/styles/rubocop/cop/custom_error_class.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
@@ -16,7 +18,7 @@ module Gitlab
         #   # good
         #   FooError = Class.new(StandardError)
         class CustomErrorClass < RuboCop::Cop::Cop
-          MSG = 'Use `Class.new(SuperClass)` to define an empty custom error class.'.freeze
+          MSG = 'Use `Class.new(SuperClass)` to define an empty custom error class.'
 
           def on_class(node)
             _klass, parent, body = node.children

data/lib/gitlab/styles/rubocop/cop/gem_fetcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
@@ -6,7 +8,7 @@ module Gitlab
         # `Gemfile` in order to avoid additional points of failure beyond
         # rubygems.org.
         class GemFetcher < RuboCop::Cop::Cop
-          MSG = 'Do not use gems from git repositories, only use gems from RubyGems.'.freeze
+          MSG = 'Do not use gems from git repositories, only use gems from RubyGems.'
 
           GIT_KEYS = [:git, :github].freeze
 

data/lib/gitlab/styles/rubocop/cop/in_batches.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../model_helpers'
 
 module Gitlab
@@ -6,7 +8,7 @@ module Gitlab
       module Cop
         # Cop that prevents the use of `in_batches`
         class InBatches < RuboCop::Cop::Cop
-          MSG = 'Do not use `in_batches`, use `each_batch` from the EachBatch module instead'.freeze
+          MSG = 'Do not use `in_batches`, use `each_batch` from the EachBatch module instead'
 
           def on_send(node)
             return unless node.children[1] == :in_batches

data/lib/gitlab/styles/rubocop/cop/line_break_after_guard_clauses.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
@@ -56,7 +58,7 @@ module Gitlab
         #
         #   do_something_more
         class LineBreakAfterGuardClauses < RuboCop::Cop::Cop
-          MSG = 'Add a line break after guard clauses'.freeze
+          MSG = 'Add a line break after guard clauses'
 
           def_node_matcher :guard_clause_node?, <<-PATTERN
             [{(send nil? {:raise :fail :throw} ...) return break next} single_line?]

data/lib/gitlab/styles/rubocop/cop/migration/update_large_table.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+require_relative '../../migration_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module Migration
+          # This cop checks for methods that may lead to batch type issues on a table that's been
+          # explicitly denied because of its size.
+          #
+          # Even though though these methods perform functions to avoid
+          # downtime, using it with tables with millions of rows still causes a
+          # significant delay in the deploy process and is best avoided.
+          #
+          # See https://gitlab.com/gitlab-com/infrastructure/issues/1602 for more
+          # information.
+          class UpdateLargeTable < RuboCop::Cop::Cop
+            include MigrationHelpers
+
+            MSG = 'Using `%s` on the `%s` table will take a long time to ' \
+              'complete, and should be avoided unless absolutely ' \
+              'necessary'
+
+            def_node_matcher :batch_update?, <<~PATTERN
+              (send nil? ${#denied_method?}
+                (sym $...)
+                ...)
+            PATTERN
+
+            def on_send(node)
+              return if denied_tables.empty? || denied_methods.empty?
+              return unless in_migration?(node)
+
+              matches = batch_update?(node)
+              return unless matches
+
+              update_method = matches.first
+              table = matches.last.to_a.first
+
+              return unless denied_tables.include?(table)
+
+              add_offense(node, location: :expression, message: format(MSG, update_method, table))
+            end
+
+            private
+
+            def denied_tables
+              cop_config['DeniedTables'] || []
+            end
+
+            def denied_method?(method_name)
+              denied_methods.include?(method_name)
+            end
+
+            def denied_methods
+              cop_config['DeniedMethods'] || []
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/polymorphic_associations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../model_helpers'
 
 module Gitlab
@@ -8,7 +10,7 @@ module Gitlab
         class PolymorphicAssociations < RuboCop::Cop::Cop
           include ModelHelpers
 
-          MSG = 'Do not use polymorphic associations, use separate tables instead'.freeze
+          MSG = 'Do not use polymorphic associations, use separate tables instead'
 
           def on_send(node)
             return unless in_model?(node)

data/lib/gitlab/styles/rubocop/cop/redirect_with_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
@@ -5,7 +7,7 @@ module Gitlab
         # This cop prevents usage of 'redirect_to' in actions 'destroy' without specifying 'status'.
         # See https://gitlab.com/gitlab-org/gitlab-ce/issues/31840
         class RedirectWithStatus < RuboCop::Cop::Cop
-          MSG = 'Do not use "redirect_to" without "status" in "destroy" action'.freeze
+          MSG = 'Do not use "redirect_to" without "status" in "destroy" action'
 
           def on_def(node)
             return unless in_controller?(node)

data/lib/gitlab/styles/rubocop/cop/rspec/empty_line_after_let_block.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module RSpec
+          # Checks if there is an empty line after let blocks.
+          #
+          # @example
+          #   # bad
+          #   RSpec.describe Foo do
+          #     let(:something) { 'something' }
+          #     let(:another_thing) do
+          #     end
+          #     let(:something_else) do
+          #     end
+          #     let(:last_thing) { 'last thing' }
+          #   end
+          #
+          #   # good
+          #   RSpec.describe Foo do
+          #     let(:something) { 'something' }
+          #     let(:another_thing) do
+          #     end
+          #
+          #     let(:something_else) do
+          #     end
+          #
+          #     let(:last_thing) { 'last thing' }
+          #   end
+          #
+          #   # good - it's ok to have non-separated without do/end blocks
+          #   RSpec.describe Foo do
+          #     let(:something) { 'something' }
+          #     let(:last_thing) { 'last thing' }
+          #   end
+          #
+          class EmptyLineAfterLetBlock < RuboCop::Cop::RSpec::Cop
+            include RuboCop::RSpec::BlankLineSeparation
+
+            MSG = 'Add an empty line after `%<let>s` block.'
+
+            def_node_matcher :lets, Helpers::ALL.block_pattern
+
+            def on_block(node)
+              lets(node) do
+                break if last_child?(node)
+                next if node.single_line?
+
+                missing_separating_line(node) do |location|
+                  add_offense(node,
+                              location: location,
+                              message: format(MSG, let: node.method_name))
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/rspec/empty_line_after_shared_example.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module RSpec
+          # Checks if there is an empty line after shared example blocks.
+          #
+          # @example
+          #   # bad
+          #   RSpec.describe Foo do
+          #     it_behaves_like 'do this first'
+          #     it_behaves_like 'does this' do
+          #     end
+          #     it_behaves_like 'does that' do
+          #     end
+          #     it_behaves_like 'do some more'
+          #   end
+          #
+          #   # good
+          #   RSpec.describe Foo do
+          #     it_behaves_like 'do this first'
+          #     it_behaves_like 'does this' do
+          #     end
+          #
+          #     it_behaves_like 'does that' do
+          #     end
+          #
+          #     it_behaves_like 'do some more'
+          #   end
+          #
+          #   # fair - it's ok to have non-separated without blocks
+          #   RSpec.describe Foo do
+          #     it_behaves_like 'do this first'
+          #     it_behaves_like 'does this'
+          #   end
+          #
+          class EmptyLineAfterSharedExample < RuboCop::Cop::RSpec::Cop
+            include RuboCop::RSpec::BlankLineSeparation
+
+            MSG = 'Add an empty line after `%<example>s` block.'
+
+            def_node_matcher :shared_examples,
+                             (SharedGroups::ALL + Includes::ALL).block_pattern
+
+            def on_block(node)
+              shared_examples(node) do
+                break if last_child?(node)
+
+                missing_separating_line(node) do |location|
+                  add_offense(node,
+                              location: location,
+                              message: format(MSG, example: node.method_name))
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/rspec/have_link_parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop-rspec'
 
 module Gitlab
@@ -16,7 +18,7 @@ module Gitlab
           #   expect(page).to have_link('Link', href: 'https://example.com')
           #   expect(page).to have_link('Example')
           class HaveLinkParameters < RuboCop::Cop::RSpec::Cop
-            MESSAGE = "The second argument to `have_link` should be a Hash.".freeze
+            MESSAGE = "The second argument to `have_link` should be a Hash."
 
             def_node_matcher :unused_parameters?, <<~PATTERN
               (send nil? :have_link

data/lib/gitlab/styles/rubocop/cop/rspec/single_line_hook.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop-rspec'
 
 module Gitlab
@@ -22,7 +24,7 @@ module Gitlab
           #     undo_something
           #   end
           class SingleLineHook < RuboCop::Cop::RSpec::Cop
-            MESSAGE = "Don't use single-line hook blocks.".freeze
+            MESSAGE = "Don't use single-line hook blocks."
 
             def_node_search :rspec_hook?, <<~PATTERN
               (send nil? {:after :around :before} ...)

data/lib/gitlab/styles/rubocop/cop/rspec/verbose_include_metadata.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop-rspec'
 
 module Gitlab
@@ -16,7 +18,7 @@ module Gitlab
           #   describe MyClass, :js do
           #   end
           class VerboseIncludeMetadata < RuboCop::Cop::RSpec::Cop
-            MSG = 'Use `%s` instead of `%s`.'.freeze
+            MSG = 'Use `%s` instead of `%s`.'
 
             SELECTORS = %i[describe context feature example_group it specify example scenario its].freeze
 

data/lib/gitlab/styles/rubocop/cop/without_reactive_cache.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop
       module Cop
         # Cop that prevents the use of `without_reactive_cache`
         class WithoutReactiveCache < RuboCop::Cop::Cop
-          MSG = 'without_reactive_cache is for debugging purposes only. Please use with_reactive_cache.'.freeze
+          MSG = 'without_reactive_cache is for debugging purposes only. Please use with_reactive_cache.'
 
           def on_send(node)
             return unless node.children[1] == :without_reactive_cache

data/lib/gitlab/styles/rubocop/migration_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop

data/lib/gitlab/styles/rubocop/model_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
     module Rubocop

data/lib/gitlab/styles/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Styles
-    VERSION = '3.3.0'.freeze
+    VERSION = '4.3.0'
   end
 end

data/rubocop-all.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
   # Cop names are not displayed in offense messages by default. Change behavior
   # by overriding DisplayCopNames, or by giving the -D/--display-cop-names
   # option.

data/rubocop-default.yml

@@ -12,6 +12,7 @@ inherit_from:
   - rubocop-layout.yml
   - rubocop-lint.yml
   - rubocop-metrics.yml
+  - rubocop-migrations.yml
   - rubocop-naming.yml
   - rubocop-performance.yml
   - rubocop-rails.yml

data/rubocop-layout.yml

@@ -3,18 +3,14 @@ Layout/AccessModifierIndentation:
   Enabled: true
 
 # Align the elements of an array literal if they span more than one line.
-Layout/AlignArray:
+Layout/ArrayAlignment:
   Enabled: true
 
-# Align the elements of a hash literal if they span more than one line.
-Layout/AlignHash:
+# Checks the indentation of the first line of the right-hand-side of a
+# multi-line assignment.
+Layout/AssignmentIndentation:
   Enabled: true
 
-# Here we check if the parameters on a multi-line method call or
-# definition are aligned.
-Layout/AlignParameters:
-  Enabled: false
-
 # Align block ends correctly.
 Layout/BlockAlignment:
   Enabled: true
@@ -102,27 +98,36 @@ Layout/ExtraSpacing:
 Layout/FirstMethodParameterLineBreak:
   Enabled: true
 
+# Align the elements of a hash literal if they span more than one line.
+Layout/HashAlignment:
+  Enabled: true
+
+# This cops checks the indentation of the here document bodies.
+Layout/HeredocIndentation:
+  Enabled: false
+
 # Keep indentation straight.
 Layout/IndentationConsistency:
   Enabled: true
 
-# Use 2 spaces for indentation.
-Layout/IndentationWidth:
+# No hard tabs.
+Layout/IndentationStyle:
   Enabled: true
 
-# Checks the indentation of the first line of the right-hand-side of a
-# multi-line assignment.
-Layout/IndentAssignment:
+# Use 2 spaces for indentation.
+Layout/IndentationWidth:
   Enabled: true
 
-# This cops checks the indentation of the here document bodies.
-Layout/IndentHeredoc:
-  Enabled: false
-
 # Comments should start with a space.
 Layout/LeadingCommentSpace:
   Enabled: true
 
+# Limit lines to 120 characters.
+Layout/LineLength:
+  Enabled: true
+  Max: 120
+  IgnoredPatterns: ['\s#\srubocop']
+
 # Checks that the closing brace in an array literal is either on the same line
 # as the last array element, or a new line.
 Layout/MultilineArrayBraceLayout:
@@ -160,6 +165,11 @@ Layout/MultilineOperationIndentation:
   Enabled: true
   EnforcedStyle: indented
 
+# Here we check if the parameters on a multi-line method call or
+# definition are aligned.
+Layout/ParameterAlignment:
+  Enabled: false
+
 # Use spaces after colons.
 Layout/SpaceAfterColon:
   Enabled: true
@@ -189,6 +199,10 @@ Layout/SpaceAroundEqualsInParameterDefault:
 Layout/SpaceAroundKeyword:
   Enabled: true
 
+# Checks method call operators to not have spaces around them.
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
 # Use a single space around operators.
 Layout/SpaceAroundOperators:
   Enabled: true
@@ -235,12 +249,8 @@ Layout/SpaceInsideStringInterpolation:
   EnforcedStyle: no_space
   Enabled: true
 
-# No hard tabs.
-Layout/Tab:
-  Enabled: true
-
 # Checks trailing blank lines and final newline.
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Enabled: true
 
 # Avoid trailing whitespace.

data/rubocop-lint.yml

@@ -47,10 +47,6 @@ Lint/EmptyEnsure:
 Lint/EmptyWhen:
   Enabled: true
 
-# END blocks should not be placed inside method definitions.
-Lint/EndInMethod:
-  Enabled: true
-
 # Do not use return in an ensure block.
 Lint/EnsureReturn:
   Enabled: true
@@ -67,10 +63,6 @@ Lint/FloatOutOfRange:
 Lint/FormatParameterMismatch:
   Enabled: true
 
-# This cop checks for *rescue* blocks with no body.
-Lint/HandleExceptions:
-  Enabled: false
-
 # Checks for adjacent string literals on the same line, which could better be
 # represented as a single string literal.
 Lint/ImplicitStringConcatenation:
@@ -105,11 +97,23 @@ Lint/NextWithoutAccumulator:
 Lint/ParenthesesAsGroupedExpression:
   Enabled: true
 
+# Checks for raise or fail statements which are raising Exception class.
+Lint/RaiseException:
+  Enabled: true
+
 # Checks for `rand(1)` calls. Such calls always return `0` and most likely
 # a mistake.
 Lint/RandOne:
   Enabled: true
 
+# This cop checks for unneeded usages of splat expansion
+Lint/RedundantSplatExpansion:
+  Enabled: false
+
+# Checks for Object#to_s usage in string interpolation.
+Lint/RedundantStringCoercion:
+  Enabled: true
+
 # Use parentheses in the method call to avoid confusion about precedence.
 Lint/RequireParentheses:
   Enabled: true
@@ -131,10 +135,14 @@ Lint/ShadowedException:
 Lint/ShadowingOuterLocalVariable:
   Enabled: false
 
-# Checks for Object#to_s usage in string interpolation.
-Lint/StringConversionInInterpolation:
+# Checks unexpected overrides of the Struct built-in methods via Struct.new.
+Lint/StructNewOverride:
   Enabled: true
 
+# This cop checks for *rescue* blocks with no body.
+Lint/SuppressedException:
+  Enabled: false
+
 # Do not use prefix `_` for a variable that is used.
 Lint/UnderscorePrefixedVariableName:
   Enabled: true
@@ -143,10 +151,6 @@ Lint/UnderscorePrefixedVariableName:
 Lint/UnifiedInteger:
   Enabled: true
 
-# This cop checks for unneeded usages of splat expansion
-Lint/UnneededSplatExpansion:
-  Enabled: false
-
 # Unreachable code.
 Lint/UnreachableCode:
   Enabled: true

data/rubocop-metrics.yml

@@ -23,12 +23,6 @@ Metrics/CyclomaticComplexity:
   Enabled: true
   Max: 13
 
-# Limit lines to 120 characters.
-Metrics/LineLength:
-  Enabled: true
-  Max: 120
-  IgnoredPatterns: ['\s#\srubocop']
-
 # Avoid methods longer than 10 lines of code.
 Metrics/MethodLength:
   Enabled: false

data/rubocop-migrations.yml

@@ -0,0 +1,21 @@
+# Checks for methods that may lead to batch type issues on a table that's been
+# explicitly denied because of its size.
+#
+# Even though these methods perform functions to avoid
+# downtime, using it with tables with millions of rows still causes a
+# significant delay in the deploy process and is best avoided.
+#
+# See https://gitlab.com/gitlab-com/infrastructure/issues/1602 for more
+# information.
+# The default can be changed as follows:
+#     Migration/UpdateLargeTable:
+#       DeniedTables:
+#         - :usage_data
+#         - :version_checks
+#       DeniedMethods:
+#         - :add_column_with_default
+#         - :change_column_type_concurrently
+#         - :rename_column_concurrently
+#         - :update_column_in_batches
+Migration/UpdateLargeTable:
+  Enabled: false

data/rubocop-naming.yml

@@ -30,6 +30,13 @@ Naming/MemoizedInstanceVariableName:
 Naming/MethodName:
   Enabled: true
 
+# Method parameter names for how descriptive they are.
+Naming/MethodParameterName:
+  Enabled: true
+  MinNameLength: 2
+  AllowedNames:
+    - _
+
 # Use `spam?` instead of `is_spam?`
 # Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
 # NamePrefix: is_, has_, have_
@@ -37,18 +44,11 @@ Naming/MethodName:
 # NameWhitelist: is_a?
 Naming/PredicateName:
   Enabled: true
-  NamePrefixBlacklist: is_
+  ForbiddenPrefixes: is_
   Exclude:
     - 'spec/**/*'
     - 'features/**/*'
 
-# Method parameter names for how descriptive they are.
-Naming/UncommunicativeMethodParamName:
-  Enabled: true
-  MinNameLength: 2
-  AllowedNames:
-    - _
-
 # Use the configured style when naming variables.
 Naming/VariableName:
   EnforcedStyle: snake_case

data/rubocop-rspec.yml

@@ -36,6 +36,14 @@ RSpec/EmptyExampleGroup:
     - it_should_email!
     - it_should_not_email!
 
+# Checks if there is an empty line after let blocks.
+RSpec/EmptyLineAfterLetBlock:
+  Enabled: true
+
+# Checks if there is an empty line after shared example blocks.
+RSpec/EmptyLineAfterSharedExample:
+  Enabled: true
+
 # Checks for long example.
 RSpec/ExampleLength:
   Enabled: false

data/rubocop-style.yml

@@ -33,11 +33,6 @@ Style/BlockComments:
 Style/BlockDelimiters:
   Enabled: true
 
- # This cop checks for braces around the last parameter in a method call
-# if the last parameter is a hash.
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 # This cop checks for uses of the case equality operator(===).
 Style/CaseEquality:
   Enabled: false
@@ -100,6 +95,10 @@ Style/EndBlock:
 Style/EvenOdd:
   Enabled: true
 
+# Enforces consistency when using exponential notation for numbers in the code
+Style/ExponentialNotation:
+  Enabled: true
+
 # Checks use of for or each in multiline loops.
 Style/For:
   Enabled: true
@@ -110,7 +109,7 @@ Style/FormatStringToken:
 
 # Checks if there is a magic comment to enforce string literals
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: true
 
 # Do not introduce global variables.
 Style/GlobalVars:
@@ -119,11 +118,27 @@ Style/GlobalVars:
     - 'lib/backup/**/*'
     - 'lib/tasks/**/*'
 
+# Checks for uses of each_key and each_value Hash methods.
+Style/HashEachMethods:
+  Enabled: true
+
 # Prefer Ruby 1.9 hash syntax `{ a: 1, b: 2 }`
 # over 1.8 syntax `{ :a => 1, :b => 2 }`.
 Style/HashSyntax:
   Enabled: true
 
+# looks for uses of _.each_with_object({}) {...}, _.map {...}.to_h, and Hash[_.map {...}]
+# that are actually just transforming the keys of a hash, and tries to use a simpler & faster
+# call to transform_keys instead.
+Style/HashTransformKeys:
+  Enabled: true
+
+# looks for uses of _.each_with_object({}) {...}, _.map {...}.to_h, and Hash[_.map {...}]
+# that are actually just transforming the values of a hash, and tries to use a simpler & faster
+# call to transform_values instead.
+Style/HashTransformValues:
+  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:
@@ -229,6 +244,10 @@ Style/ParenthesesAroundCondition:
 Style/PreferredHashMethods:
   Enabled: false
 
+# Checks for %W when interpolation is not needed.
+Style/RedundantCapitalW:
+  Enabled: true
+
 # Checks for an obsolete RuntimeException argument in raise/fail.
 Style/RedundantException:
   Enabled: true
@@ -237,6 +256,10 @@ Style/RedundantException:
 Style/RedundantParentheses:
   Enabled: true
 
+# Checks for %q/%Q when single quotes or double quotes would do.
+Style/RedundantPercentQ:
+  Enabled: false
+
 # Use `sort` instead of `sort_by { |x| x }`.
 Style/RedundantSortBy:
   Enabled: true
@@ -284,14 +307,6 @@ Style/TrailingCommaInArguments:
   Enabled: true
   EnforcedStyleForMultiline: no_comma
 
-# Checks for %W when interpolation is not needed.
-Style/UnneededCapitalW:
-  Enabled: true
-
-# Checks for %q/%Q when single quotes or double quotes would do.
-Style/UnneededPercentQ:
-  Enabled: false
-
 # 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: 3.3.0
+  version: 4.3.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: 0.82.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: 0.82.0
 - !ruby/object:Gem::Dependency
   name: rubocop-gitlab-security
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -151,8 +152,11 @@ files:
 - lib/gitlab/styles/rubocop/cop/gem_fetcher.rb
 - lib/gitlab/styles/rubocop/cop/in_batches.rb
 - lib/gitlab/styles/rubocop/cop/line_break_after_guard_clauses.rb
+- lib/gitlab/styles/rubocop/cop/migration/update_large_table.rb
 - lib/gitlab/styles/rubocop/cop/polymorphic_associations.rb
 - lib/gitlab/styles/rubocop/cop/redirect_with_status.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/have_link_parameters.rb
 - lib/gitlab/styles/rubocop/cop/rspec/single_line_hook.rb
 - lib/gitlab/styles/rubocop/cop/rspec/verbose_include_metadata.rb
@@ -167,6 +171,7 @@ files:
 - rubocop-layout.yml
 - rubocop-lint.yml
 - rubocop-metrics.yml
+- rubocop-migrations.yml
 - rubocop-naming.yml
 - rubocop-performance.yml
 - rubocop-rails.yml
@@ -192,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: GitLab style guides and shared style configs.