gitlab-styles 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30bceb716d5e39ed5e48f4d42fd4457eb0a0608be5419e03ac325a3db385da08
-  data.tar.gz: 50058ac5c12783bd57e55e9cf19973ffb9aec21c277e3ff20839849271feb64c
+  metadata.gz: 73ee648b7b50478acc9d34d9a84e108a69ea1067b28b9bd9ab04f364b09f5ee1
+  data.tar.gz: a157fb76a7d78910b51231f3cda7388e1db87080e0b52a9b623322ba35664bff
 SHA512:
-  metadata.gz: b5f700edd701ed7b465a1e5bac5971dee3e7f31df2603a03dc76fd048feb98ec23e4fb1e70b2704e5f3899eecb0c2f6817a1d508bcf1708a092587e9ba2a4f86
-  data.tar.gz: 3ba624b97b7bab08fa1fb26b82cae5f72494e639a1c7cc000d95098ad39807218e15e118654a2518076ae3409f31ee55caa980e3d88cac26394d26e10f079b0f
+  metadata.gz: 9a46d0faf108cf1a4a33209dd1e4f6e6021c28e0d877e4835d07980bcc1810bb0d378198505f146d7175111449c3d919923970a0550ecdd55bb43a66310f199e
+  data.tar.gz: 621abc0dbb787baec9491369a45061d608c5bf71b31b31530bb63426b3ee0bb3e53ea16d0a63656bf136097023953eab287dabeb274d8a95bd9af991686cdaa0

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/lib/gitlab/styles/rubocop.rb

@@ -17,6 +17,7 @@ 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'
+require 'gitlab/styles/rubocop/cop/rspec/example_starting_character'
 
 module Gitlab
   module Styles

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - GitLab
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-10 00:00:00.000000000 Z
+date: 2020-12-08 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: []
@@ -132,6 +132,7 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/merge_request_templates/New Static Analysis Check.md"
 - ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - ".rubocop.yml"
@@ -160,6 +161,7 @@ files:
 - lib/gitlab/styles/rubocop/cop/rspec/base.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
@@ -187,7 +189,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 +205,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: []