gitlab-styles 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f34644596ecbfd782a8a8d5781251743cbe2f0ef079467416c4e15c784769693
-  data.tar.gz: 531fb802e1a50564fbbfad34e96f66b8a2227e6c182999750a39456f2ae17c98
+  metadata.gz: 30bceb716d5e39ed5e48f4d42fd4457eb0a0608be5419e03ac325a3db385da08
+  data.tar.gz: 50058ac5c12783bd57e55e9cf19973ffb9aec21c277e3ff20839849271feb64c
 SHA512:
-  metadata.gz: 9a4036572db91754b18045e0e9ec40d9747a633773c49fb3edcdc53d0ac8b6ae2743f94ffe5fc2ce6cc8a60a51216eb7b85c89dfb039f747370cca4831c9cc41
-  data.tar.gz: 78eb2aaec9c221dad33fb99c719c3ad838a39f4978381b2f99ef011f87c8c8ee67a24d9b6e26af2eea4d1b3a03e03e80aab5c2718afaa998764a3cf68d8153e4
+  metadata.gz: b5f700edd701ed7b465a1e5bac5971dee3e7f31df2603a03dc76fd048feb98ec23e4fb1e70b2704e5f3899eecb0c2f6817a1d508bcf1708a092587e9ba2a4f86
+  data.tar.gz: 3ba624b97b7bab08fa1fb26b82cae5f72494e639a1c7cc000d95098ad39807218e15e118654a2518076ae3409f31ee55caa980e3d88cac26394d26e10f079b0f

data/.gitlab-ci.yml

@@ -1,6 +1,6 @@
 stages:
-  - release
   - test
+  - deploy
 
 default:
   image: ruby:2.6
@@ -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/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,5 @@
 inherit_from:
   - rubocop-default.yml
-  - .rubocop_todo.yml
+
+require:
+  - rubocop/cop/internal_affairs

data/lib/gitlab/styles/rubocop.rb

@@ -8,6 +8,7 @@ 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/line_break_around_conditional_block'
 require 'gitlab/styles/rubocop/cop/code_reuse/active_record'
 require 'gitlab/styles/rubocop/cop/migration/update_large_table'
 require 'gitlab/styles/rubocop/cop/without_reactive_cache'

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/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/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

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

@@ -40,7 +40,7 @@ module Gitlab
 
               return unless denied_tables.include?(table)
 
-              add_offense(node, location: :expression, message: format(MSG, update_method, table))
+              add_offense(node, message: format(MSG, update_method, table))
             end
 
             private

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

@@ -19,7 +19,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 == :polymorphic
+              add_offense(pair) if key_name == :polymorphic
             end
           end
         end

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

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

data/lib/gitlab/styles/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Styles
-    VERSION = '5.0.0'
+    VERSION = '5.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - GitLab
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2020-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - gitlab_rubygems@gitlab.com
 executables: []
@@ -135,7 +135,6 @@ files:
 - ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -154,6 +153,7 @@ 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/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/redirect_with_status.rb
@@ -187,7 +187,7 @@ homepage: https://gitlab.com/gitlab-org/gitlab-styles
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: GitLab style guides and shared style configs.
 test_files: []

data/.rubocop_todo.yml

@@ -1,7 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2017-11-03 15:49:59 +0100 using RuboCop version 0.51.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.