gitlab-styles 7.1.0 → 8.0.0

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-styles
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 8.0.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -184,39 +184,39 @@ files:
 - 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/avoid_return_from_blocks.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/fips/md5.rb
-- lib/gitlab/styles/rubocop/cop/fips/open_ssl.rb
-- lib/gitlab/styles/rubocop/cop/fips/sha1.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

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

@@ -1,36 +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
-          ALLOWED_OPTIONS = [:restrict_with_error].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]
-              option_name = pair.children[1].children[0]
-
-              break if ALLOWED_OPTIONS.include?(option_name)
-
-              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

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

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        # Checks for return inside blocks.
-        # For more information see: https://gitlab.com/gitlab-org/gitlab-foss/issues/42889
-        #
-        # @example
-        #   # bad
-        #   call do
-        #     return if something
-        #
-        #     do_something_else
-        #   end
-        #
-        #   # good
-        #   call do
-        #     break if something
-        #
-        #     do_something_else
-        #   end
-        #
-        class AvoidReturnFromBlocks < RuboCop::Cop::Cop
-          MSG = 'Do not return from a block, use next or break instead.'
-          DEF_METHODS = %i[define_method lambda].freeze
-          WHITELISTED_METHODS = %i[each each_filename times loop].freeze
-
-          def on_block(node)
-            block_body = node.body
-
-            return unless block_body
-            return unless top_block?(node)
-
-            block_body.each_node(:return) do |return_node|
-              next if parent_blocks(node, return_node).all? { |block| whitelisted?(block) }
-
-              add_offense(return_node)
-            end
-          end
-
-          private
-
-          def top_block?(node)
-            current_node = node
-            top_block = nil
-
-            while current_node && current_node.type != :def
-              top_block = current_node if current_node.block_type?
-              current_node = current_node.parent
-            end
-
-            top_block == node
-          end
-
-          def parent_blocks(node, current_node)
-            blocks = []
-
-            until node == current_node || def?(current_node)
-              blocks << current_node if current_node.block_type?
-              current_node = current_node.parent
-            end
-
-            blocks << node if node == current_node && !def?(node)
-            blocks
-          end
-
-          def def?(node)
-            node.def_type? || node.defs_type? ||
-              (node.block_type? && DEF_METHODS.include?(node.method_name))
-          end
-
-          def whitelisted?(block_node)
-            WHITELISTED_METHODS.include?(block_node.method_name)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,84 +0,0 @@
-# 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,
-              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
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        # This cop makes sure that custom error classes, when empty, are declared
-        # with Class.new.
-        #
-        # @example
-        #   # bad
-        #   class FooError < StandardError
-        #   end
-        #
-        #   # okish
-        #   class FooError < StandardError; end
-        #
-        #   # good
-        #   FooError = Class.new(StandardError)
-        class CustomErrorClass < RuboCop::Cop::Cop
-          MSG = 'Use `Class.new(SuperClass)` to define an empty custom error class.'
-
-          def on_class(node)
-            parent = node.parent_class
-            body = node.body
-
-            return if body
-
-            parent_klass = class_name_from_node(parent)
-
-            return unless parent_klass&.to_s&.end_with?('Error')
-
-            add_offense(node)
-          end
-
-          def autocorrect(node)
-            klass = node.identifier
-            parent = node.parent_class
-
-            replacement = "#{class_name_from_node(klass)} = Class.new(#{class_name_from_node(parent)})"
-
-            lambda do |corrector|
-              corrector.replace(node.source_range, replacement)
-            end
-          end
-
-          private
-
-          # The nested constant `Foo::Bar::Baz` looks like:
-          #
-          #   s(:const,
-          #     s(:const,
-          #       s(:const, nil, :Foo), :Bar), :Baz)
-          #
-          # So recurse through that to get the name as written in the source.
-          #
-          def class_name_from_node(node, suffix = nil)
-            return unless node&.type == :const
-
-            name = node.children[1].to_s
-            name = "#{name}::#{suffix}" if suffix
-
-            if node.children[0]
-              class_name_from_node(node.children[0], name)
-            else
-              name
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/gitlab/styles/rubocop/cop/fips/md5.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../../common/banned_constants'
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        module Fips
-          class MD5 < RuboCop::Cop::Base
-            include Gitlab::Styles::Common::BannedConstants
-
-            MESSAGE_TEMPLATE = 'MD5 is not FIPS-compliant. Use %{replacement} instead.'
-
-            REPLACEMENTS = {
-              'OpenSSL::Digest::MD5' => 'OpenSSL::Digest::SHA256',
-              'Digest::MD5' => 'OpenSSL::Digest::SHA256'
-            }.freeze
-
-            def initialize(config = nil, options = nil)
-              @message_template = MESSAGE_TEMPLATE
-              @replacements = REPLACEMENTS
-              @autocorrect = false
-              super(config, options)
-            end
-          end
-        end
-      end
-    end
-  end
-end