gitlab-styles 4.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00dda1d4ea5cfd931d74ccf3def7dd6ed3552359c2519e7b6a73464cb3612b92
-  data.tar.gz: 8fd90715af2921b22e53d241f12e4a546f8d53923a688028132af3e5e28f0349
+  metadata.gz: b2ceb4c3c99df5b88255a7b7bcd4cbfaa5e029f81cc73f09b937cb15b7e53ffd
+  data.tar.gz: e4e5a5425299c7cb3d8e40f79fb4f817444aec62c378d8c8b547a309e3fe7211
 SHA512:
-  metadata.gz: 58e29fee8c087356c272e72e9d3a8b719581e5f185ceed85d554a9ccb664654288373b2a6d1e4c1ba9587bfce4c2225960797e4c89e321688da8fa52d4a12b81
-  data.tar.gz: a2c2f9843238a87f1af60f28beac5ec8c1ae5f1d236ab1554e88d07f95824e6474dda3b96ff5ec26a3219015c5415ea21824d41cc98d3cd06990b5ff55104097
+  metadata.gz: 1626e2623b8e2d5bb2eeff292a4746a8352f302a53277b9118bd20494f6489501f7f19c0442510435ca55ac92cdf61536dfe5bb5c3ad09a9f3eea1b769636780
+  data.tar.gz: b64077d9097e0d3adb6365fe41662b6e5264921ebfa5ed493b7dec7c8eaa8dbc4ae63c286b51f34b55811664a8a8e3fa9da5aa0098840f5dfddac54c9af419b4

data/.editorconfig

@@ -0,0 +1,18 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{rb,yml}]
+indent_size = 2
+
+[*.{rb,yml,md}]
+indent_style = space
+charset = utf-8
+
+[*.{md,markdown}]
+trim_trailing_whitespace = false

data/.gitlab-ci.yml

@@ -1,9 +1,9 @@
 stages:
-  - release
   - test
+  - deploy
 
 default:
-  image: ruby:2.6
+  image: ruby:2.7
   tags:
     - gitlab-org
   before_script:
@@ -29,17 +29,6 @@ specs:
   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
+include:
+  - project: 'gitlab-org/quality/pipeline-common'
+    file: '/ci/gem-release.yml'

data/.gitlab/merge_request_templates/New Static Analysis Check.md

@@ -0,0 +1,21 @@
+## Description of the proposal
+
+<!--
+Please describe the proposal and add a link to the source (for example, http://www.betterspecs.org/).
+-->
+
+### Check-list
+
+- [ ] Mention this proposal in the relevant Slack channels (e.g. `#development`, `#backend`, `#frontend`)
+- [ ] If there is a choice to make between two potential styles, set up an emoji vote in the MR:
+  - CHOICE_A: :a:
+  - CHOICE_B: :b:
+  - Vote yourself for both choices so that people know these are the choices
+- [ ] The MR doesn't have significant objections, and is getting a majority of :+1: vs :-1: (remember that [we don't need to reach a consensus](https://about.gitlab.com/handbook/values/#collaboration-is-not-consensus))
+- [ ] (If applicable) One style is getting a majority of vote (compared to the other choice)
+- [ ] (If applicable) Update the MR with the chosen style
+- [ ] Follow the [review process](https://docs.gitlab.com/ee/development/code_review.html) as usual
+
+/label ~"Engineering Productivity" ~"development guidelines" ~"static code analysis"
+
+/cc @gitlab-org/maintainers/rails-backend

data/.gitlab/merge_request_templates/Release.md

@@ -7,7 +7,7 @@ with the latest commit from https://gitlab.com/gitlab-org/gitlab-styles/commits/
 <!-- Keep the sections order but remove the empty sections -->
 
 ```markdown
-### New scenarios and scenario updates
+### New features and features updates
 
 - !aaa <Title of the aaa MR>.
 
@@ -19,7 +19,7 @@ with the latest commit from https://gitlab.com/gitlab-org/gitlab-styles/commits/
 
 - !ccc <Title of the ccc MR>.
 
-### Other changes (CI, backstage)
+### Other changes (tooling, technical debt)
 
 - !ddd <Title of the ddd MR>.
 ```
@@ -30,6 +30,6 @@ with the latest commit from https://gitlab.com/gitlab-org/gitlab-styles/commits/
   - [ ] Release notes are accurate.
 
 - Checklist after merging:
-  - [ ] [Create a tag for the new release version](docs/release_process.md#how-to).
+  - [ ] [Update the release notes for the newly created tag](docs/release_process.md#how-to).
 
-/label ~"Engineering Productivity" ~"tooling::workflow"
+/label ~"Engineering Productivity" ~"feature" ~"feature::maintenance" ~"static code analysis"

data/.rubocop.yml

@@ -1,3 +1,10 @@
 inherit_from:
   - rubocop-default.yml
-  - .rubocop_todo.yml
+
+require:
+  - rubocop/cop/internal_affairs
+
+InternalAffairs/DeprecateCopHelper:
+  Enabled: true
+  Include:
+    - spec/**/*.rb

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 
 group :test do
   # Pin these dependencies, otherwise a new rule could break the CI pipelines
-  gem 'rubocop', '0.82.0'
-  gem 'rubocop-rspec', '1.36.0'
+  gem 'rubocop', '0.89.1'
+  gem 'rubocop-rspec', '1.44.1'
   gem 'rspec-parameterized', '0.4.2', require: false
 end

data/gitlab-styles.gemspec

@@ -5,6 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gitlab/styles/version'
 
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.6'
   spec.name          = 'gitlab-styles'
   spec.version       = Gitlab::Styles::VERSION
   spec.authors       = ['GitLab']
@@ -21,13 +22,13 @@ 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.82.0'
+  spec.add_dependency 'rubocop', '~> 0.89.1'
   spec.add_dependency 'rubocop-gitlab-security', '~> 0.1.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_dependency 'rubocop-performance', '~> 1.8.1'
+  spec.add_dependency 'rubocop-rails', '~> 2.8'
+  spec.add_dependency 'rubocop-rspec', '~> 1.44'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/gitlab/styles/rubocop.rb

@@ -1,20 +1,8 @@
 # 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'
-require 'gitlab/styles/rubocop/cop/redirect_with_status'
-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'
+# Auto-require all cops under `gitlab/styles/rubocop/cop/**/*.rb`
+cops_glob = File.join(__dir__, 'rubocop', 'cop', '**', '*.rb')
+Dir[cops_glob].sort.each(&method(:require))
 
 module Gitlab
   module Styles

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

@@ -22,7 +22,7 @@ module Gitlab
             node.children.last.each_node(:pair) do |pair|
               key_name = pair.children[0].children[0]
 
-              add_offense(pair, location: :expression) if key_name == :dependent
+              add_offense(pair) if key_name == :dependent
             end
           end
         end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module CodeReuse
+          # Cop that denies the use of ActiveRecord methods outside of models.
+          class ActiveRecord < RuboCop::Cop::Cop
+            MSG = 'This method can only be used inside an ActiveRecord model: ' \
+        'https://gitlab.com/gitlab-org/gitlab-foss/issues/49653'
+
+            # Various methods from ActiveRecord::Querying that are denied. We
+            # exclude some generic ones such as `any?` and `first`, as these may
+            # lead to too many false positives, since `Array` also supports these
+            # methods.
+            #
+            # The keys of this Hash are the denied method names. The values are
+            # booleans that indicate if the method should only be denied if any
+            # arguments are provided.
+            NOT_ALLOWED = {
+              average: true,
+              calculate: true,
+              count_by_sql: true,
+              create_with: true,
+              distinct: false,
+              eager_load: true,
+              exists?: true,
+              find_by: true,
+              find_by!: true,
+              find_by_sql: true,
+              find_each: true,
+              find_in_batches: true,
+              find_or_create_by: true,
+              find_or_create_by!: true,
+              find_or_initialize_by: true,
+              first!: false,
+              first_or_create: true,
+              first_or_create!: true,
+              first_or_initialize: true,
+              from: true,
+              group: true,
+              having: true,
+              ids: false,
+              includes: true,
+              joins: true,
+              limit: true,
+              lock: false,
+              many?: false,
+              offset: true,
+              order: true,
+              pluck: true,
+              preload: true,
+              readonly: false,
+              references: true,
+              reorder: true,
+              rewhere: true,
+              take: false,
+              take!: false,
+              unscope: false,
+              where: false,
+              with: true
+            }.freeze
+
+            def on_send(node)
+              receiver = node.children[0]
+              send_name = node.children[1]
+              first_arg = node.children[2]
+
+              return unless receiver && NOT_ALLOWED.key?(send_name)
+
+              # If the rule requires an argument to be given, but none are
+              # provided, we won't register an offense. This prevents us from
+              # adding offenses for `project.group`, while still covering
+              # `Project.group(:name)`.
+              return if NOT_ALLOWED[send_name] && !first_arg
+
+              add_offense(node, location: :selector)
+            end
+
+            # We can not auto correct code like this, as it requires manual
+            # refactoring. Instead, we'll just allow the surrounding scope.
+            #
+            # Despite this method's presence, you should not use it. This method
+            # exists to make it possible to allow large chunks of offenses we
+            # can't fix in the short term. If you are writing new code, follow the
+            # code reuse guidelines, instead of allowing any new offenses.
+            def autocorrect(node)
+              scope = surrounding_scope_of(node)
+              indent = indentation_of(scope)
+
+              lambda do |corrector|
+                # This prevents us from inserting the same enable/disable comment
+                # for a method or block that has multiple offenses.
+                next if allowed_scopes.include?(scope)
+
+                corrector.insert_before(
+                  scope.source_range,
+                  "# rubocop: disable #{cop_name}\n#{indent}"
+                )
+
+                corrector.insert_after(
+                  scope.source_range,
+                  "\n#{indent}# rubocop: enable #{cop_name}"
+                )
+
+                allowed_scopes << scope
+              end
+            end
+
+            def indentation_of(node)
+              ' ' * node.loc.expression.source_line[/\A */].length
+            end
+
+            def surrounding_scope_of(node)
+              %i[def defs block begin].each do |type|
+                if (found = node.each_ancestor(type).first)
+                  return found
+                end
+              end
+            end
+
+            def allowed_scopes
+              @allowed_scopes ||= Set.new
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,7 +21,8 @@ module Gitlab
           MSG = 'Use `Class.new(SuperClass)` to define an empty custom error class.'
 
           def on_class(node)
-            _klass, parent, body = node.children
+            parent = node.parent_class
+            body = node.body
 
             return if body
 
@@ -29,11 +30,13 @@ module Gitlab
 
             return unless parent_klass&.to_s&.end_with?('Error')
 
-            add_offense(node, location: :expression)
+            add_offense(node)
           end
 
           def autocorrect(node)
-            klass, parent, _body = node.children
+            klass = node.identifier
+            parent = node.parent_class
+
             replacement = "#{class_name_from_node(klass)} = Class.new(#{class_name_from_node(parent)})"
 
             lambda do |corrector|

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

@@ -20,7 +20,7 @@ module Gitlab
 
             node.children.last.each_node(:pair) do |pair|
               key_name = pair.children[0].children[0].to_sym
-              add_offense(node, location: pair.source_range, message: MSG) if GIT_KEYS.include?(key_name)
+              add_offense(node, location: pair.source_range) if GIT_KEYS.include?(key_name)
             end
           end
 

data/lib/gitlab/styles/rubocop/cop/internal_affairs/deprecate_cop_helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module InternalAffairs
+          # Cop that denies the use of CopHelper.
+          class DeprecateCopHelper < RuboCop::Cop::Cop
+            MSG = 'Do not use `CopHelper` or methods from it, use improved patterns described in https://github.com/rubocop-hq/rubocop/issues/8003'
+
+            def_node_matcher :cop_helper, <<~PATTERN
+              (send nil? ${:include :extend :prepend}
+                (const _ {:CopHelper}))
+            PATTERN
+
+            def_node_search :cop_helper_method, <<~PATTERN
+              (send nil? {:inspect_source :inspect_source_file :parse_source :autocorrect_source_file :autocorrect_source :_investigate} ...)
+            PATTERN
+
+            def_node_search :cop_helper_method_on_instance, <<~PATTERN
+              (send (send nil? _) {:messages :highlights :offenses} ...)
+            PATTERN
+
+            def on_send(node)
+              cop_helper(node) do
+                add_offense(node)
+              end
+
+              cop_helper_method(node) do
+                add_offense(node)
+              end
+
+              cop_helper_method_on_instance(node) do
+                add_offense(node)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -69,7 +69,7 @@ module Gitlab
             return unless guard_clause?(node)
             return if next_line(node).blank? || clause_last_line?(next_line(node)) || guard_clause?(next_sibling(node))
 
-            add_offense(node, location: :expression, message: MSG)
+            add_offense(node)
           end
 
           def autocorrect(node)

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        # Ensures a line break around conditional blocks.
+        #
+        # @example
+        #    # bad
+        #    do_something
+        #    if condition
+        #      do_extra_stuff
+        #    end
+        #    do_something_more
+        #
+        #    # good
+        #    do_something
+        #
+        #    if condition
+        #      do_extra_stuff
+        #    end
+        #
+        #    do_something_more
+        #
+        #    # bad
+        #    do_something
+        #    unless condition
+        #      do_extra_stuff
+        #    end
+        #
+        #    do_something_more
+        #
+        #    # good
+        #    def a_method
+        #      if condition
+        #        do_something
+        #      end
+        #    end
+        #
+        #    # good
+        #    on_block do
+        #      if condition
+        #        do_something
+        #      end
+        #    end
+        class LineBreakAroundConditionalBlock < RuboCop::Cop::Cop
+          include RuboCop::Cop::RangeHelp
+
+          MSG = 'Add a line break around conditional blocks'
+
+          def on_if(node)
+            # This cop causes errors in haml files, so let's skip those
+            return if in_haml?(node)
+            return if node.single_line?
+            return unless node.if? || node.unless?
+
+            add_offense(node) unless previous_line_valid?(node)
+            add_offense(node) unless last_line_valid?(node)
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              line = range_by_whole_lines(node.source_range)
+
+              corrector.insert_before(line, "\n") unless previous_line_valid?(node)
+              corrector.insert_after(line, "\n") unless last_line_valid?(node)
+            end
+          end
+
+          private
+
+          def previous_line_valid?(node)
+            previous_line(node).empty? ||
+              start_clause_line?(previous_line(node)) ||
+              block_start?(previous_line(node)) ||
+              begin_line?(previous_line(node)) ||
+              assignment_line?(previous_line(node)) ||
+              rescue_line?(previous_line(node))
+          end
+
+          def last_line_valid?(node)
+            last_line(node).empty? ||
+              end_line?(last_line(node)) ||
+              end_clause_line?(last_line(node))
+          end
+
+          def previous_line(node)
+            processed_source[node.loc.line - 2]
+          end
+
+          def last_line(node)
+            processed_source[node.loc.last_line]
+          end
+
+          def start_clause_line?(line)
+            line =~ /^\s*(def|=end|#|module|class|if|unless|else|elsif|ensure|when)/
+          end
+
+          def end_clause_line?(line)
+            line =~ /^\s*(#|rescue|else|elsif|when)/
+          end
+
+          def begin_line?(line)
+            # an assignment followed by a begin or ust a begin
+            line =~ /^\s*(@?(\w|\|+|=|\[|\]|\s)+begin|begin)/
+          end
+
+          def assignment_line?(line)
+            line =~ /^\s*.*=/
+          end
+
+          def rescue_line?(line)
+            line =~ /^\s*rescue/
+          end
+
+          def block_start?(line)
+            line.match(/ (do|{)( \|.*?\|)?\s?(#.+)?\z/)
+          end
+
+          def end_line?(line)
+            line =~ /^\s*(end|})/
+          end
+
+          def in_haml?(node)
+            node.location.expression.source_buffer.name.end_with?('.haml.rb')
+          end
+        end
+      end
+    end
+  end
+end