gitlab-styles 4.1.0 → 5.2.0

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+require_relative '../../rspec/helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module RSpec
+          class Base < RuboCop::Cop::RSpec::Base
+            include Rubocop::Rspec::Helpers
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# 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 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 < Base
+            extend RuboCop::Cop::AutoCorrector
+            include RuboCop::RSpec::EmptyLineSeparation
+
+            MSG = 'Add an empty line after `%<let>s` block.'
+
+            def_node_matcher :lets, LET.block_pattern
+
+            def on_block(node)
+              lets(node) do
+                break if last_child?(node)
+                next if node.single_line?
+
+                missing_separating_line_offense(node) do |method|
+                  format(MSG, let: method)
+                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'
+require_relative 'base'
+
+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 < Base
+            extend RuboCop::Cop::AutoCorrector
+            include RuboCop::RSpec::EmptyLineSeparation
+
+            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_offense(node) do |method|
+                  format(MSG, example: method)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+require_relative 'base'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module RSpec
+          # Checks for common mistakes in example descriptions.
+          #
+          # This cop will correct docstrings that begin/end with space or words that start with a capital letter.
+          #
+          # @see https://gitlab.com/gitlab-org/gitlab/-/merge_requests/46336#note_442669518
+          #
+          # @example
+          #   # bad
+          #   it 'Does something' do
+          #   end
+          #
+          #   # good
+          #   it 'does nothing' do
+          #   end
+          #
+          # @example
+          #   # bad
+          #   it ' does something' do
+          #   end
+          #
+          #   # good
+          #   it 'does something' do
+          #   end
+          #
+          # @example
+          #   # bad
+          #   it 'does something ' do
+          #   end
+          #
+          #   # good
+          #   it 'does something' do
+          #   end
+          #
+          # @example
+          #   # bad
+          #   it ' does something ' do
+          #   end
+          #
+          #   # good
+          #   it 'does something' do
+          #   end
+          class ExampleStartingCharacter < Base
+            extend RuboCop::Cop::AutoCorrector
+
+            MSG = 'Only start words with lowercase alpha with no leading/trailing spaces when describing your tests.'
+
+            def_node_matcher :it_description, <<-PATTERN
+          (block (send _ :it ${
+            (str $_)
+            (dstr (str $_ ) ...)
+          } ...) ...)
+            PATTERN
+
+            def on_block(node)
+              it_description(node) do |description_node, _message|
+                add_wording_offense(description_node, MSG) if invalid_description?(text(description_node))
+              end
+            end
+
+            private
+
+            def add_wording_offense(node, message)
+              docstring = docstring(node)
+              add_offense(docstring, message: message) do |corrector|
+                corrector.replace(docstring, replacement_text(node))
+              end
+            end
+
+            def docstring(node)
+              expr = node.loc.expression
+
+              Parser::Source::Range.new(
+                expr.source_buffer,
+                expr.begin_pos + 1,
+                expr.end_pos - 1
+              )
+            end
+
+            def invalid_description?(message)
+              message.match?(/(^([A-Z]{1}[a-z]+\s|\s)|\s$)/)
+            end
+
+            def replacement_text(node)
+              text = text(node)
+
+              text.strip!
+
+              text = downcase_first_letter(text) if invalid_description?(text)
+
+              text
+            end
+
+            # Recursive processing is required to process nested dstr nodes
+            # that is the case for \-separated multiline strings with interpolation.
+            def text(node)
+              case node.type
+              when :dstr
+                node.node_parts.map { |child_node| text(child_node) }.join
+              when :str
+                node.value
+              when :begin
+                node.source
+              end
+            end
+
+            def downcase_first_letter(str)
+              str[0].downcase + str[1..]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rubocop-rspec'
+require_relative 'base'
 
 module Gitlab
   module Styles
@@ -17,7 +18,9 @@ module Gitlab
           #   # good
           #   expect(page).to have_link('Link', href: 'https://example.com')
           #   expect(page).to have_link('Example')
-          class HaveLinkParameters < RuboCop::Cop::RSpec::Cop
+          class HaveLinkParameters < Base
+            extend RuboCop::Cop::AutoCorrector
+
             MESSAGE = "The second argument to `have_link` should be a Hash."
 
             def_node_matcher :unused_parameters?, <<~PATTERN
@@ -29,11 +32,13 @@ module Gitlab
             def on_send(node)
               return unless unused_parameters?(node)
 
-              location = node.arguments[1..-1]
-                .map(&:source_range)
-                .reduce(:join)
+              location = node.arguments[1..]
+                           .map(&:source_range)
+                           .reduce(:join)
 
-              add_offense(node, location: location, message: MESSAGE)
+              add_offense(location, message: MESSAGE) do |corrector|
+                corrector.insert_after(location.end, "\n")
+              end
             end
           end
         end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rubocop-rspec'
+require_relative 'base'
 
 module Gitlab
   module Styles
@@ -23,7 +24,7 @@ module Gitlab
           #   after(:each) do
           #     undo_something
           #   end
-          class SingleLineHook < RuboCop::Cop::RSpec::Cop
+          class SingleLineHook < Base
             MESSAGE = "Don't use single-line hook blocks."
 
             def_node_search :rspec_hook?, <<~PATTERN
@@ -34,7 +35,7 @@ module Gitlab
               return unless node.single_line?
               return unless rspec_hook?(node)
 
-              add_offense(node, location: :expression, message: MESSAGE)
+              add_offense(node, message: MESSAGE)
             end
           end
         end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rubocop-rspec'
+require_relative 'base'
 
 module Gitlab
   module Styles
@@ -17,7 +18,9 @@ module Gitlab
           #   # good
           #   describe MyClass, :js do
           #   end
-          class VerboseIncludeMetadata < RuboCop::Cop::RSpec::Cop
+          class VerboseIncludeMetadata < Base
+            extend RuboCop::Cop::AutoCorrector
+
             MSG = 'Use `%s` instead of `%s`.'
 
             SELECTORS = %i[describe context feature example_group it specify example scenario its].freeze
@@ -37,25 +40,19 @@ module Gitlab
 
             def on_send(node)
               invalid_metadata_matches(node) do |match|
-                add_offense(node, location: :expression, message: format(MSG, good(match), bad(match)))
-              end
-            end
-
-            def autocorrect(node)
-              lambda do |corrector|
-                invalid_metadata_matches(node) do |match|
-                  corrector.replace(match.loc.expression, good(match))
+                add_offense(node, message: format(MSG, good(match), bad(match))) do |corrector|
+                  invalid_metadata_matches(node) do |match|
+                    corrector.replace(match.loc.expression, good(match))
+                  end
                 end
               end
             end
 
             private
 
-            def invalid_metadata_matches(node)
+            def invalid_metadata_matches(node, &block)
               include_metadata(node) do |matches|
-                matches.select(&method(:invalid_metadata?)).each do |match|
-                  yield match
-                end
+                matches.select(&method(:invalid_metadata?)).each(&block)
               end
             end
 

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

@@ -7,7 +7,7 @@ module Gitlab
         # Returns true if the given node originated from the models directory.
         def in_model?(node)
           path = node.location.expression.source_buffer.name
-          pwd = RuboCop::PathUtil.pwd
+          pwd = Dir.pwd
           models_path = File.join(pwd, 'app', 'models')
           ee_models_path = File.join(pwd, 'ee', 'app', 'models')
 

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Rspec
+        module Helpers
+          include RuboCop::RSpec::Language
+
+          LET = SelectorSet.new(%i[let_it_be]) + RuboCop::RSpec::Language::Helpers::ALL
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Styles
-    VERSION = '4.1.0'
+    VERSION = '5.2.0'
   end
 end

data/rubocop-all.yml

@@ -1,3 +1,4 @@
+---
 AllCops:
   TargetRubyVersion: 2.6
   # Cop names are not displayed in offense messages by default. Change behavior