gitlab-styles 6.6.0 → 8.0.0

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+require_relative 'base'
+
+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

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+require_relative 'base'
+
+module Rubocop
+  module Cop
+    module RSpec
+      # This cop checks for unused parameters to the `have_link` matcher.
+      #
+      # @example
+      #
+      #   # bad
+      #   expect(page).to have_link('Link', 'https://example.com')
+      #
+      #   # good
+      #   expect(page).to have_link('Link', href: 'https://example.com')
+      #   expect(page).to have_link('Example')
+      class HaveLinkParameters < Base
+        extend RuboCop::Cop::AutoCorrector
+
+        MESSAGE = "The second argument to `have_link` should be a Hash."
+
+        def_node_matcher :unused_parameters?, <<~PATTERN
+          (send nil? :have_link
+            _ !{hash nil}
+          )
+        PATTERN
+
+        def on_send(node)
+          return unless unused_parameters?(node)
+
+          location = node.arguments[1..]
+                       .map(&:source_range)
+                       .reduce(:join)
+
+          add_offense(location, message: MESSAGE) do |corrector|
+            corrector.insert_after(location.end, "\n")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+require_relative 'base'
+
+module Rubocop
+  module Cop
+    module RSpec
+      # This cop checks for single-line hook blocks
+      #
+      # @example
+      #
+      #   # bad
+      #   before { do_something }
+      #   after(:each) { undo_something }
+      #
+      #   # good
+      #   before do
+      #     do_something
+      #   end
+      #
+      #   after(:each) do
+      #     undo_something
+      #   end
+      class SingleLineHook < Base
+        MESSAGE = "Don't use single-line hook blocks."
+
+        def_node_search :rspec_hook?, <<~PATTERN
+          (send nil? {:after :around :before} ...)
+        PATTERN
+
+        def on_block(node)
+          return unless node.single_line?
+          return unless rspec_hook?(node)
+
+          add_offense(node, message: MESSAGE)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+require_relative 'base'
+
+module Rubocop
+  module Cop
+    module RSpec
+      # Checks for verbose include metadata used in the specs.
+      #
+      # @example
+      #   # bad
+      #   describe MyClass, js: true do
+      #   end
+      #
+      #   # good
+      #   describe MyClass, :js do
+      #   end
+      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
+
+        def_node_matcher :include_metadata, <<-PATTERN
+          (send {(const nil? :RSpec) nil?} {#{SELECTORS.map(&:inspect).join(' ')}}
+            !const
+            ...
+            (hash $...))
+        PATTERN
+
+        def_node_matcher :invalid_metadata?, <<-PATTERN
+          (pair
+            (sym $...)
+            (true))
+        PATTERN
+
+        def on_send(node)
+          invalid_metadata_matches(node) do |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, &block)
+          include_metadata(node) do |matches|
+            matches.select { |match| invalid_metadata?(match) }.each(&block)
+          end
+        end
+
+        def bad(match)
+          "#{metadata_key(match)}: true"
+        end
+
+        def good(match)
+          ":#{metadata_key(match)}"
+        end
+
+        def metadata_key(match)
+          match.children[0].source
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/hash_transformation.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module Cop
+    module Style
+      # This cop identifies places where `map { ... }.to_h` or
+      # `Hash[map { ... }]` can be replaced with `to_h { ... }`,
+      # saving an intermediate array allocation.
+      #
+      # @example
+      #   # bad
+      #   hash.map { |k, v| [v.upcase, k.downcase] }.to_h
+      #   hash.collect { |k, v| [v.upcase, k.downcase] }.to_h
+      #   Hash[hash.map { |k, v| [v.upcase, k.downcase] }]
+      #   Hash[hash.collect { |k, v| [v.upcase, k.downcase] }]
+      #   array.map { |x| [x, x + 1] }.to_h
+      #
+      #   # good
+      #   hash.to_h { |k, v| [v.upcase, k.downcase] }
+      #   array.to_h { |x| [x, x + 1] }
+      #
+      # Full credit: https://github.com/eugeneius/rubocop-performance/blob/hash_transformation/lib/rubocop/cop/performance/hash_transformation.rb
+      class HashTransformation < RuboCop::Cop::Cop
+        include RuboCop::Cop::RangeHelp
+
+        MSG = 'Use `to_h { ... }` instead of `%<current>s`.'
+
+        def_node_matcher :to_h_candidate?, <<~PATTERN
+          {
+            [(send
+              $(block $(send _ {:map :collect}) ...) :to_h) !block_literal?]
+            (send (const nil? :Hash) :[]
+              $(block $(send _ {:map :collect}) ...))
+          }
+        PATTERN
+
+        def on_send(node)
+          to_h_candidate?(node) do |_block, call|
+            range = offense_range(node, call)
+            message = message(node, call)
+            add_offense(node, location: range, message: message)
+          end
+        end
+
+        def autocorrect(node)
+          block, call = to_h_candidate?(node)
+
+          lambda do |corrector|
+            corrector.remove(after_block(node, block))
+            corrector.replace(call.loc.selector, 'to_h')
+            corrector.remove(before_block(node, block))
+          end
+        end
+
+        private
+
+        def offense_range(node, call)
+          return node.source_range if node.children.first.const_type?
+
+          range_between(call.loc.selector.begin_pos, node.loc.selector.end_pos)
+        end
+
+        def message(node, call)
+          current = if node.children.first.const_type?
+                      "Hash[#{call.method_name} { ... }]"
+                    else
+                      "#{call.method_name} { ... }.to_h"
+                    end
+
+          format(MSG, current: current)
+        end
+
+        def after_block(node, block)
+          block.source_range.end.join(node.source_range.end)
+        end
+
+        def before_block(node, block)
+          node.source_range.begin.join(block.source_range.begin)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/open_struct_use.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module Cop
+    module Style
+      # This cop flags uses of OpenStruct, as it is now officially discouraged
+      # to be used for performance, version compatibility, and potential security issues.
+      #
+      # See also:
+      # - https://rubyreferences.github.io/rubychanges/3.0.html#standard-library
+      # - https://docs.ruby-lang.org/en/3.0.0/OpenStruct.html#class-OpenStruct-label-Caveats
+      # - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67855
+      class OpenStructUse < RuboCop::Cop::Cop
+        MSG = 'Avoid using `OpenStruct`. It is officially discouraged. ' \
+              'Replace it with `Struct`, `Hash`, or RSpec doubles. ' \
+              'See https://docs.ruby-lang.org/en/3.0.0/OpenStruct.html#class-OpenStruct-label-Caveats'
+
+        def_node_matcher :uses_open_struct?, <<-PATTERN
+          (const {nil? (cbase)} :OpenStruct)
+        PATTERN
+
+        def on_const(node)
+          return unless uses_open_struct?(node)
+          return if custom_class_or_module_definition?(node)
+
+          add_offense(node)
+        end
+
+        private
+
+        def custom_class_or_module_definition?(node)
+          parent = node.parent
+
+          (parent.class_type? || parent.module_type?) && node.left_siblings.empty?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/without_reactive_cache.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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.'
+
+      def on_send(node)
+        return unless node.children[1] == :without_reactive_cache
+
+        add_offense(node, location: :selector)
+      end
+    end
+  end
+end

data/rubocop-default.yml

@@ -10,6 +10,7 @@ require:
 inherit_from:
   - rubocop-all.yml
   - rubocop-bundler.yml
+  - rubocop-fips.yml
   - rubocop-gemspec.yml
   - rubocop-graphql.yml
   - rubocop-layout.yml

data/rubocop-fips.yml

@@ -0,0 +1,15 @@
+---
+require:
+  - ./lib/gitlab/styles/rubocop
+
+# Denies usage of MD5
+Fips/MD5:
+  Enabled: true
+
+# Denies usage of SHA1
+Fips/SHA1:
+  Enabled: true
+
+# Replaces ::Digest with ::OpenSSL::Digest
+Fips/OpenSSL:
+  Enabled: true

data/rubocop-rspec.yml

@@ -95,8 +95,9 @@ RSpec/ImplicitExpect:
   EnforcedStyle: is_expected
 
 # Checks for the usage of instance variables.
+# https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#subject-and-let-variables
 RSpec/InstanceVariable:
-  Enabled: false
+  Enabled: true
 
 # Checks for `subject` definitions that come after `let` definitions.
 RSpec/LeadingSubject:
@@ -157,4 +158,4 @@ RSpec/SubjectStub:
 
 # Prefer using verifying doubles over normal doubles.
 RSpec/VerifiedDoubles:
-  Enabled: false
+  Enabled: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 6.6.0
+  version: 8.0.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -114,6 +114,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: gitlab-dangerfiles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -152,12 +166,14 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/changelog_config.yml"
 - ".gitlab/merge_request_templates/New Static Analysis Check.md"
 - ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- Dangerfile
 - Gemfile
 - LICENSE.md
 - README.md
@@ -166,40 +182,46 @@ files:
 - bin/setup
 - gitlab-styles.gemspec
 - lib/gitlab/styles.rb
+- lib/gitlab/styles/common/banned_constants.rb
 - lib/gitlab/styles/rubocop.rb
-- lib/gitlab/styles/rubocop/cop/active_record_dependent.rb
-- lib/gitlab/styles/rubocop/cop/active_record_serialize.rb
-- lib/gitlab/styles/rubocop/cop/code_reuse/active_record.rb
-- lib/gitlab/styles/rubocop/cop/custom_error_class.rb
-- lib/gitlab/styles/rubocop/cop/gem_fetcher.rb
-- lib/gitlab/styles/rubocop/cop/in_batches.rb
-- lib/gitlab/styles/rubocop/cop/internal_affairs/deprecate_cop_helper.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/performance/rubyzip.rb
-- lib/gitlab/styles/rubocop/cop/polymorphic_associations.rb
-- lib/gitlab/styles/rubocop/cop/rails/include_url_helper.rb
-- lib/gitlab/styles/rubocop/cop/redirect_with_status.rb
-- lib/gitlab/styles/rubocop/cop/rspec/base.rb
-- lib/gitlab/styles/rubocop/cop/rspec/empty_line_after_final_let_it_be.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
-- lib/gitlab/styles/rubocop/cop/style/hash_transformation.rb
-- lib/gitlab/styles/rubocop/cop/style/open_struct_use.rb
-- lib/gitlab/styles/rubocop/cop/without_reactive_cache.rb
 - lib/gitlab/styles/rubocop/migration_helpers.rb
 - lib/gitlab/styles/rubocop/model_helpers.rb
 - lib/gitlab/styles/rubocop/rspec/helpers.rb
 - lib/gitlab/styles/version.rb
+- lib/rubocop/cop/active_record_dependent.rb
+- lib/rubocop/cop/active_record_serialize.rb
+- lib/rubocop/cop/avoid_return_from_blocks.rb
+- lib/rubocop/cop/code_reuse/active_record.rb
+- lib/rubocop/cop/custom_error_class.rb
+- lib/rubocop/cop/fips/md5.rb
+- lib/rubocop/cop/fips/open_ssl.rb
+- lib/rubocop/cop/fips/sha1.rb
+- lib/rubocop/cop/gem_fetcher.rb
+- lib/rubocop/cop/in_batches.rb
+- lib/rubocop/cop/internal_affairs/deprecate_cop_helper.rb
+- lib/rubocop/cop/line_break_after_guard_clauses.rb
+- lib/rubocop/cop/line_break_around_conditional_block.rb
+- lib/rubocop/cop/migration/update_large_table.rb
+- lib/rubocop/cop/performance/rubyzip.rb
+- lib/rubocop/cop/polymorphic_associations.rb
+- lib/rubocop/cop/rails/include_url_helper.rb
+- lib/rubocop/cop/redirect_with_status.rb
+- lib/rubocop/cop/rspec/base.rb
+- lib/rubocop/cop/rspec/empty_line_after_final_let_it_be.rb
+- lib/rubocop/cop/rspec/empty_line_after_let_block.rb
+- lib/rubocop/cop/rspec/empty_line_after_shared_example.rb
+- lib/rubocop/cop/rspec/example_starting_character.rb
+- lib/rubocop/cop/rspec/have_link_parameters.rb
+- lib/rubocop/cop/rspec/single_line_hook.rb
+- lib/rubocop/cop/rspec/verbose_include_metadata.rb
+- lib/rubocop/cop/style/hash_transformation.rb
+- lib/rubocop/cop/style/open_struct_use.rb
+- lib/rubocop/cop/without_reactive_cache.rb
 - rubocop-all.yml
 - rubocop-bundler.yml
 - rubocop-code_reuse.yml
 - rubocop-default.yml
+- rubocop-fips.yml
 - rubocop-gemspec.yml
 - rubocop-graphql.yml
 - rubocop-layout.yml

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

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../model_helpers'
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        # Cop that prevents the use of `dependent: ...` in ActiveRecord models.
-        class ActiveRecordDependent < RuboCop::Cop::Cop
-          include ModelHelpers
-
-          MSG = 'Do not use `dependent: to remove associated data, ' \
-            'use foreign keys with cascading deletes instead'
-
-          METHOD_NAMES = [:has_many, :has_one, :belongs_to].freeze
-
-          def on_send(node)
-            return unless in_model?(node)
-            return unless METHOD_NAMES.include?(node.children[1])
-
-            node.children.last.each_node(:pair) do |pair|
-              key_name = pair.children[0].children[0]
-
-              add_offense(pair) if key_name == :dependent
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../model_helpers'
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        # Cop that prevents the use of `serialize` in ActiveRecord models.
-        class ActiveRecordSerialize < RuboCop::Cop::Cop
-          include ModelHelpers
-
-          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)
-
-            add_offense(node, location: :selector) if node.children[1] == :serialize
-          end
-        end
-      end
-    end
-  end
-end