gitlab-styles 7.1.0 → 8.0.0

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

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

data/lib/gitlab/styles/rubocop/cop/fips/sha1.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 SHA1 < RuboCop::Cop::Base
-            include Gitlab::Styles::Common::BannedConstants
-
-            MESSAGE_TEMPLATE = 'SHA1 is likely to become non-compliant in the near future. Use %{replacement} instead.'
-
-            REPLACEMENTS = {
-              'OpenSSL::Digest::SHA1' => 'OpenSSL::Digest::SHA256',
-              'Digest::SHA1' => '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

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        # This cop prevents usage of the `git` and `github` arguments to `gem` in a
-        # `Gemfile` in order to avoid additional points of failure beyond
-        # rubygems.org.
-        class GemFetcher < RuboCop::Cop::Cop
-          MSG = 'Do not use gems from git repositories, only use gems from RubyGems.'
-
-          GIT_KEYS = [:git, :github].freeze
-
-          def on_send(node)
-            return unless gemfile?(node)
-
-            func_name = node.children[1]
-            return unless func_name == :gem
-
-            node.children.last.each_node(:pair) do |pair|
-              key_name = pair.children[0].children[0].to_sym
-              add_offense(node, location: pair.source_range) if GIT_KEYS.include?(key_name)
-            end
-          end
-
-          private
-
-          def gemfile?(node)
-            node
-              .location
-              .expression
-              .source_buffer
-              .name
-              .end_with?("Gemfile")
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../model_helpers'
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        # Cop that prevents the use of `in_batches`
-        class InBatches < RuboCop::Cop::Cop
-          MSG = 'Do not use `in_batches`, use `each_batch` from the EachBatch module instead'
-
-          def on_send(node)
-            return unless node.children[1] == :in_batches
-
-            add_offense(node, location: :selector)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/gitlab/styles/rubocop/cop/internal_affairs/deprecate_cop_helper.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        module InternalAffairs
-          # Cop that denies the use of CopHelper.
-          class DeprecateCopHelper < RuboCop::Cop::Cop
-            MSG = 'Do not use `CopHelper` or methods from it, use improved patterns described in https://www.rubydoc.info/gems/rubocop/RuboCop/RSpec/ExpectOffense'
-
-            def_node_matcher :cop_helper, <<~PATTERN
-              (send nil? ${:include :extend :prepend}
-                (const _ {:CopHelper}))
-            PATTERN
-
-            def_node_search :cop_helper_method, <<~PATTERN
-              (send nil? {:inspect_source :inspect_source_file :parse_source :autocorrect_source_file :autocorrect_source :_investigate} ...)
-            PATTERN
-
-            def_node_search :cop_helper_method_on_instance, <<~PATTERN
-              (send (send nil? _) {:messages :highlights :offenses} ...)
-            PATTERN
-
-            def on_send(node)
-              cop_helper(node) do
-                add_offense(node)
-              end
-
-              cop_helper_method(node) do
-                add_offense(node)
-              end
-
-              cop_helper_method_on_instance(node) do
-                add_offense(node)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        # Ensures a line break after guard clauses.
-        #
-        # @example
-        #   # bad
-        #   return unless condition
-        #   do_stuff
-        #
-        #   # good
-        #   return unless condition
-        #
-        #   do_stuff
-        #
-        #   # bad
-        #   raise if condition
-        #   do_stuff
-        #
-        #   # good
-        #   raise if condition
-        #
-        #   do_stuff
-        #
-        #   Multiple guard clauses are allowed without
-        #   line break.
-        #
-        #   # good
-        #   return unless condition_a
-        #   return unless condition_b
-        #
-        #   do_stuff
-        #
-        #   Guard clauses in case statement are allowed without
-        #   line break.
-        #
-        #   # good
-        #   case model
-        #     when condition_a
-        #       return true unless condition_b
-        #     when
-        #       ...
-        #   end
-        #
-        #   Guard clauses before end are allowed without
-        #   line break.
-        #
-        #   # good
-        #   if condition_a
-        #     do_something
-        #   else
-        #     do_something_else
-        #     return unless condition
-        #   end
-        #
-        #   do_something_more
-        class LineBreakAfterGuardClauses < RuboCop::Cop::Cop
-          MSG = 'Add a line break after guard clauses'
-
-          def_node_matcher :guard_clause_node?, <<-PATTERN
-            [{(send nil? {:raise :fail :throw} ...) return break next} single_line?]
-          PATTERN
-
-          def on_if(node)
-            return unless node.single_line?
-            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)
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.insert_after(node.loc.expression, "\n")
-            end
-          end
-
-          private
-
-          def guard_clause?(node)
-            return false unless node.if_type?
-
-            guard_clause_node?(node.if_branch)
-          end
-
-          def next_sibling(node)
-            node.parent.children[node.sibling_index + 1]
-          end
-
-          def next_line(node)
-            processed_source[node.loc.line]
-          end
-
-          def clause_last_line?(line)
-            line =~ /^\s*(?:end|elsif|else|when|rescue|ensure)/
-          end
-        end
-      end
-    end
-  end
-end

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

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

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-require_relative '../../migration_helpers'
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        module Migration
-          # This cop checks for methods that may lead to batch type issues on a table that's been
-          # explicitly denied because of its size.
-          #
-          # Even though though these methods perform functions to avoid
-          # downtime, using it with tables with millions of rows still causes a
-          # significant delay in the deploy process and is best avoided.
-          #
-          # See https://gitlab.com/gitlab-com/infrastructure/issues/1602 for more
-          # information.
-          class UpdateLargeTable < RuboCop::Cop::Cop
-            include MigrationHelpers
-
-            MSG = 'Using `%s` on the `%s` table will take a long time to ' \
-              'complete, and should be avoided unless absolutely ' \
-              'necessary'
-
-            def_node_matcher :batch_update?, <<~PATTERN
-              (send nil? ${#denied_method?}
-                (sym $...)
-                ...)
-            PATTERN
-
-            def on_send(node)
-              return if denied_tables.empty? || denied_methods.empty?
-              return unless in_migration?(node)
-
-              matches = batch_update?(node)
-              return unless matches
-
-              update_method = matches.first
-              table = matches.last.to_a.first
-
-              return unless denied_tables.include?(table)
-
-              add_offense(node, message: format(MSG, update_method, table))
-            end
-
-            private
-
-            def denied_tables
-              cop_config['DeniedTables'] || []
-            end
-
-            def denied_method?(method_name)
-              denied_methods.include?(method_name)
-            end
-
-            def denied_methods
-              cop_config['DeniedMethods'] || []
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/gitlab/styles/rubocop/cop/performance/rubyzip.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        module Performance
-          # This cop flags inefficient uses of rubyzip's Zip::File, since when instantiated
-          # it reads the file's Central Directory into memory entirely. For zips with many
-          # files and directories, this can be very expensive even when the archive's size
-          # in bytes is small.
-          #
-          # See also:
-          # - https://github.com/rubyzip/rubyzip/issues/506
-          # - https://github.com/rubyzip/rubyzip#notes-on-zipinputstream
-          class Rubyzip < RuboCop::Cop::Cop
-            MSG = 'Be careful when opening or iterating zip files via Zip::File. ' \
-                  'Zip archives may contain many entries, and their file index is ' \
-                  'read into memory upon construction, which can lead to ' \
-                  'high memory use and poor performance. ' \
-                  'Consider iterating archive entries via Zip::InputStream instead.'
-
-            def_node_matcher :reads_central_directory?, <<-PATTERN
-              (send
-                (const
-                  (const {nil? (cbase)} :Zip) :File) {:new :open :foreach} ...)
-            PATTERN
-
-            def on_send(node)
-              return unless reads_central_directory?(node)
-
-              add_offense(node)
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../model_helpers'
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        # Cop that prevents the use of polymorphic associations
-        class PolymorphicAssociations < RuboCop::Cop::Cop
-          include ModelHelpers
-
-          MSG = 'Do not use polymorphic associations, use separate tables instead'
-
-          def on_send(node)
-            return unless in_model?(node)
-            return unless node.children[1] == :belongs_to
-
-            node.children.last.each_node(:pair) do |pair|
-              key_name = pair.children[0].children[0]
-
-              add_offense(pair) if key_name == :polymorphic
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/gitlab/styles/rubocop/cop/rails/include_url_helper.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../../model_helpers'
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        module Rails
-          class IncludeUrlHelper < RuboCop::Cop::Cop
-            MSG = <<~MSG
-              Avoid including `ActionView::Helpers::UrlHelper`.
-              It adds/overrides ~40 methods while usually only one is needed.
-              Instead, use the `Gitlab::Routing.url_helpers`/`Application.routes.url_helpers`(outside of gitlab)
-              and `ActionController::Base.helpers.link_to`.
-              See https://gitlab.com/gitlab-org/gitlab/-/issues/340567.
-            MSG
-
-            def_node_matcher :include_url_helpers_node?, <<~PATTERN
-              (send nil? :include (const (const (const {nil? cbase} :ActionView) :Helpers) :UrlHelper))
-            PATTERN
-
-            def on_send(node)
-              add_offense(node) if include_url_helpers_node?(node)
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module Styles
-    module Rubocop
-      module Cop
-        # This cop prevents usage of 'redirect_to' in actions 'destroy' without specifying 'status'.
-        # See https://gitlab.com/gitlab-org/gitlab-ce/issues/31840
-        class RedirectWithStatus < RuboCop::Cop::Cop
-          MSG = 'Do not use "redirect_to" without "status" in "destroy" action'
-
-          def on_def(node)
-            return unless in_controller?(node)
-            return unless destroy?(node) || destroy_all?(node)
-
-            node.each_descendant(:send) do |def_node|
-              next unless redirect_to?(def_node)
-
-              methods = []
-
-              def_node.children.last.each_node(:pair) do |pair|
-                methods << pair.children.first.children.first
-              end
-
-              add_offense(def_node, location: :selector) unless methods.include?(:status)
-            end
-          end
-
-          private
-
-          def in_controller?(node)
-            node.location.expression.source_buffer.name.end_with?('_controller.rb')
-          end
-
-          def destroy?(node)
-            node.children.first == :destroy
-          end
-
-          def destroy_all?(node)
-            node.children.first == :destroy_all
-          end
-
-          def redirect_to?(node)
-            node.children[1] == :redirect_to
-          end
-        end
-      end
-    end
-  end
-end

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

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