gitlab-dangerfiles 1.0.0 → 2.1.1

data/lib/gitlab/dangerfiles/changes.rb

@@ -4,41 +4,63 @@ require_relative "title_linting"
 
 module Gitlab
   module Dangerfiles
+    # @!attribute file
+    #   @return [String] the file name that's changed.
+    # @!attribute change_type
+    #   @return [Symbol] the type of change (+:added+, +:modified+, +:deleted+, +:renamed_before+, +:renamed_after+).
+    # @!attribute category
+    #   @return [Symbol] the category of the change.
+    #     This is defined by consumers of the gem through +helper.changes_by_category+ or +helper.changes+.
     Change = Struct.new(:file, :change_type, :category)
 
     class Changes < ::SimpleDelegator
+      # Return an +Gitlab::Dangerfiles::Changes+ object with only the changes for the added files.
+      #
+      # @return [Gitlab::Dangerfiles::Changes]
       def added
         select_by_change_type(:added)
       end
 
+      # @return [Gitlab::Dangerfiles::Changes] the changes for the modified files.
       def modified
         select_by_change_type(:modified)
       end
 
+      # @return [Gitlab::Dangerfiles::Changes] the changes for the deleted files.
       def deleted
         select_by_change_type(:deleted)
       end
 
+      # @return [Gitlab::Dangerfiles::Changes] the changes for the renamed files (before the rename).
       def renamed_before
         select_by_change_type(:renamed_before)
       end
 
+      # @return [Gitlab::Dangerfiles::Changes] the changes for the renamed files (after the rename).
       def renamed_after
         select_by_change_type(:renamed_after)
       end
 
+      # @param category [Symbol] A category of change.
+      #
+      # @return [Boolean] whether there are any change for the given +category+.
       def has_category?(category)
         any? { |change| change.category == category }
       end
 
+      # @param category [Symbol] a category of change.
+      #
+      # @return [Gitlab::Dangerfiles::Changes] changes for the given +category+.
       def by_category(category)
         Changes.new(select { |change| change.category == category })
       end
 
+      # @return [Array<Symbol>] an array of the unique categories of changes.
       def categories
         map(&:category).uniq
       end
 
+      # @return [Array<String>] an array of the changed files.
       def files
         map(&:file)
       end

data/lib/gitlab/dangerfiles/commit_linter.rb

@@ -8,14 +8,17 @@ module Gitlab
     class CommitLinter < BaseLinter
       MAX_CHANGED_FILES_IN_COMMIT = 3
       MAX_CHANGED_LINES_IN_COMMIT = 30
-      SHORT_REFERENCE_REGEX = %r{([\w\-\/]+)?(?<!`)(#|!|&|%)\d+(?<!`)}.freeze
+      # Issue, MR, Epic
+      SHORT_REFERENCE_REGEX = %r{([\w\-\/]+)?(?<!`)(#|!|&)\d+(?<!`)}.freeze
+      # Milestone
+      MS_SHORT_REFERENCE_REGEX = %r{([\w\-\/]+)?(?<!`)%"?\d{1,3}\.\d{1,3}"?(?<!`)}.freeze
 
       def self.problems_mapping
         super.merge(
           {
             separator_missing: "The commit subject and body must be separated by a blank line",
             details_too_many_changes: "Commits that change #{MAX_CHANGED_LINES_IN_COMMIT} or more lines across " \
-            "at least #{MAX_CHANGED_FILES_IN_COMMIT} files must describe these changes in the commit body",
+            "at least #{MAX_CHANGED_FILES_IN_COMMIT} files should describe these changes in the commit body",
             details_line_too_long: "The commit body should not contain more than #{MAX_LINE_LENGTH} characters per line",
             message_contains_text_emoji: "Avoid the use of Markdown Emoji such as `:+1:`. These add limited value " \
             "to the commit message, and are displayed as plain text outside of GitLab",
@@ -139,7 +142,8 @@ module Gitlab
       end
 
       def message_contains_short_reference?
-        commit.message.match?(SHORT_REFERENCE_REGEX)
+        commit.message.match?(SHORT_REFERENCE_REGEX) ||
+          commit.message.match?(MS_SHORT_REFERENCE_REGEX)
       end
 
       def emoji_checker

data/lib/gitlab/dangerfiles/config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Dangerfiles
+    class Config
+      # @!attribute code_size_thresholds
+      #   @return [{ high: Integer, medium: Integer }] a hash of the form +{ high: 42, medium: 12 }+ where +:high+ is the lines changed threshold which triggers an error, and +:medium+ is the lines changed threshold which triggers a warning. Also, see +DEFAULT_CHANGES_SIZE_THRESHOLDS+ for the format of the hash.
+      attr_accessor :code_size_thresholds
+
+      # @!attribute max_commits_count
+      #   @return [Integer] the maximum number of allowed non-squashed/non-fixup commits for a given MR. A warning is triggered if the MR has more commits.
+      attr_accessor :max_commits_count
+
+      DEFAULT_CHANGES_SIZE_THRESHOLDS = { high: 2_000, medium: 500 }.freeze
+      DEFAULT_COMMIT_MESSAGES_MAX_COMMITS_COUNT = 10
+
+      def initialize
+        @code_size_thresholds = DEFAULT_CHANGES_SIZE_THRESHOLDS
+        @max_commits_count = DEFAULT_COMMIT_MESSAGES_MAX_COMMITS_COUNT
+      end
+    end
+  end
+end

data/lib/gitlab/dangerfiles/emoji_checker.rb

@@ -4,6 +4,7 @@ require "json"
 
 module Gitlab
   module Dangerfiles
+    # @api private
     class EmojiChecker
       DIGESTS = File.expand_path("../../../fixtures/emojis/digests.json", __dir__)
       ALIASES = File.expand_path("../../../fixtures/emojis/aliases.json", __dir__)

data/lib/gitlab/dangerfiles/title_linting.rb

@@ -19,6 +19,8 @@ module Gitlab
       end
 
       def has_draft_flag?(title)
+        puts "This method is deprecated in favor of `helper.draft_mr?`."
+
         DRAFT_REGEX.match?(title)
       end
 

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "1.0.0"
+    VERSION = "2.1.1"
   end
 end

data/lib/gitlab/dangerfiles/weightage.rb

@@ -2,6 +2,7 @@
 
 module Gitlab
   module Dangerfiles
+    # @api private
     module Weightage
       CAPACITY_MULTIPLIER = 2 # change this number to change what it means to be a reduced capacity reviewer 1/this number
       BASE_REVIEWER_WEIGHT = 1

data/lib/gitlab/dangerfiles/weightage/maintainers.rb

@@ -5,6 +5,7 @@ require_relative "../weightage"
 module Gitlab
   module Dangerfiles
     module Weightage
+      # @api private
       class Maintainers
         def initialize(maintainers)
           @maintainers = maintainers

data/lib/gitlab/dangerfiles/weightage/reviewers.rb

@@ -18,6 +18,7 @@ module Gitlab
       # | hungry traintainer           |                              8 |
       # +------------------------------+--------------------------------+
       #
+      # @api private
       class Reviewers
         DEFAULT_REVIEWER_WEIGHT = Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER * Gitlab::Dangerfiles::Weightage::BASE_REVIEWER_WEIGHT
         TRAINTAINER_WEIGHT = 3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.1
 platform: ruby
 authors:
-- Rémy Coutable
+- GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-gitlab
@@ -110,7 +110,7 @@ dependencies:
         version: '0'
 description: This gem provides common Dangerfile and plugins for GitLab projects.
 email:
-- remy@rymai.me
+- gitlab_rubygems@gitlab.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -119,6 +119,7 @@ files:
 - ".gitlab-ci.yml"
 - ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -130,14 +131,17 @@ files:
 - fixtures/emojis/aliases.json
 - fixtures/emojis/digests.json
 - gitlab-dangerfiles.gemspec
-- lib/danger/helper.rb
-- lib/danger/roulette.rb
+- lib/danger/plugins/helper.rb
+- lib/danger/plugins/roulette.rb
+- lib/danger/rules/changes_size/Dangerfile
+- lib/danger/rules/commit_messages/Dangerfile
 - lib/gitlab-dangerfiles.rb
 - lib/gitlab/Dangerfile
 - lib/gitlab/dangerfiles.rb
 - lib/gitlab/dangerfiles/base_linter.rb
 - lib/gitlab/dangerfiles/changes.rb
 - lib/gitlab/dangerfiles/commit_linter.rb
+- lib/gitlab/dangerfiles/config.rb
 - lib/gitlab/dangerfiles/emoji_checker.rb
 - lib/gitlab/dangerfiles/merge_request_linter.rb
 - lib/gitlab/dangerfiles/spec_helper.rb
@@ -154,7 +158,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://gitlab.com/gitlab-org/gitlab-dangerfiles
   source_code_uri: https://gitlab.com/gitlab-org/gitlab-dangerfiles
-  changelog_uri: https://gitlab.com/gitlab-org/gitlab-dangerfiles
+  changelog_uri: https://gitlab.com/gitlab-org/gitlab-dangerfiles/-/releases
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -170,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: This gem provides common Dangerfile and plugins for GitLab projects.

data/lib/danger/helper.rb

@@ -1,311 +0,0 @@
-# frozen_string_literal: true
-
-require "net/http"
-require "json"
-require "danger"
-require_relative "../gitlab/dangerfiles/changes"
-require_relative "../gitlab/dangerfiles/teammate"
-require_relative "../gitlab/dangerfiles/title_linting"
-
-module Danger
-  # Common helper functions for our danger scripts.
-  class Helper < Danger::Plugin
-    RELEASE_TOOLS_BOT = "gitlab-release-tools-bot"
-    DRAFT_REGEX = /\A*#{Regexp.union(/(?i)(\[WIP\]\s*|WIP:\s*|WIP$)/, /(?i)(\[draft\]|\(draft\)|draft:|draft\s\-\s|draft$)/)}+\s*/i.freeze
-    CATEGORY_LABELS = {
-      docs: "~documentation", # Docs are reviewed along DevOps stages, so don't need roulette for now.
-      none: "",
-      qa: "~QA",
-      test: "~test ~Quality for `spec/features/*`",
-      engineering_productivity: '~"Engineering Productivity" for CI, Danger',
-      ci_template: '~"ci::templates"',
-    }.freeze
-
-    HTTPError = Class.new(StandardError)
-
-    def gitlab_helper
-      # Unfortunately the following does not work:
-      # - respond_to?(:gitlab)
-      # - respond_to?(:gitlab, true)
-      gitlab
-    rescue NoMethodError
-      nil
-    end
-
-    def html_link(str)
-      ci? ? gitlab_helper.html_link(str) : str
-    end
-
-    def ci?
-      !gitlab_helper.nil?
-    end
-
-    # @param [String] url
-    def http_get_json(url)
-      rsp = Net::HTTP.get_response(URI.parse(url))
-
-      unless rsp.is_a?(Net::HTTPOK)
-        raise HTTPError, "Failed to read #{url}: #{rsp.code} #{rsp.message}"
-      end
-
-      JSON.parse(rsp.body)
-    end
-
-    def added_files
-      @added_files ||= if changes_from_api
-          changes_from_api.select { |file| file["new_file"] }.map { |file| file["new_path"] }
-        else
-          git.added_files.to_a
-        end
-    end
-
-    def modified_files
-      @modified_files ||= if changes_from_api
-          changes_from_api.select { |file| !file["new_file"] && !file["deleted_file"] && !file["renamed_file"] }.map { |file| file["new_path"] }
-        else
-          git.modified_files.to_a
-        end
-    end
-
-    def renamed_files
-      @renamed_files ||= if changes_from_api
-          changes_from_api.select { |file| file["renamed_file"] }.each_with_object([]) do |file, memo|
-            memo << { before: file["old_path"], after: file["new_path"] }
-          end
-        else
-          git.renamed_files.to_a
-        end
-    end
-
-    def deleted_files
-      @deleted_files ||= if changes_from_api
-          changes_from_api.select { |file| file["deleted_file"] }.map { |file| file["new_path"] }
-        else
-          git.deleted_files.to_a
-        end
-    end
-
-    def diff_for_file(filename)
-      if changes_from_api
-        changes_hash = changes_from_api.find { |file| file["new_path"] == filename }
-        changes_hash["diff"] if changes_hash
-      else
-        git.diff_for_file(filename)&.patch
-      end
-    end
-
-    def changes_from_api
-      return nil unless ci?
-      return nil if defined?(@force_changes_from_git)
-
-      @changes_from_api ||= gitlab_helper.api.merge_request_changes(gitlab_helper.mr_json["project_id"], gitlab_helper.mr_json["iid"]).to_h["changes"]
-    rescue
-      # Fallback to the Git strategy in any case
-      @force_changes_from_git = true
-      nil
-    end
-
-    # Returns a list of all files that have been added, modified or renamed.
-    # `modified_files` might contain paths that already have been renamed,
-    # so we need to remove them from the list.
-    #
-    # Considering these changes:
-    #
-    # - A new_file.rb
-    # - D deleted_file.rb
-    # - M modified_file.rb
-    # - R renamed_file_before.rb -> renamed_file_after.rb
-    #
-    # it will return
-    # ```
-    # [ 'new_file.rb', 'modified_file.rb', 'renamed_file_after.rb' ]
-    # ```
-    #
-    # @return [Array<String>]
-    def all_changed_files
-      Set.new
-        .merge(added_files)
-        .merge(modified_files)
-        .merge(renamed_files.map { |x| x[:after] })
-        .subtract(renamed_files.map { |x| x[:before] })
-        .to_a
-        .sort
-    end
-
-    # Returns a string containing changed lines as git diff
-    #
-    # Considering changing a line in lib/gitlab/usage_data.rb it will return:
-    #
-    # [ "--- a/lib/gitlab/usage_data.rb",
-    #   "+++ b/lib/gitlab/usage_data.rb",
-    #   "+      # Test change",
-    #   "-      # Old change" ]
-    def changed_lines(changed_file)
-      diff = diff_for_file(changed_file)
-      return [] unless diff
-
-      diff.split("\n").select { |line| %r{^[+-]}.match?(line) }
-    end
-
-    def release_automation?
-      gitlab_helper&.mr_author == RELEASE_TOOLS_BOT
-    end
-
-    def markdown_list(items)
-      list = items.map { |item| "* `#{item}`" }.join("\n")
-
-      if items.size > 10
-        "\n<details>\n\n#{list}\n\n</details>\n"
-      else
-        list
-      end
-    end
-
-    # @return [Hash<Symbol,Array<String>>]
-    def changes_by_category(categories)
-      all_changed_files.each_with_object(Hash.new { |h, k| h[k] = [] }) do |file, hash|
-        categories_for_file(file, categories).each { |category| hash[category] << file }
-      end
-    end
-
-    # @return [Gitlab::Dangerfiles::Changes]
-    def changes(categories)
-      Gitlab::Dangerfiles::Changes.new([]).tap do |changes|
-        added_files.each do |file|
-          categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :added, category) }
-        end
-
-        modified_files.each do |file|
-          categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :modified, category) }
-        end
-
-        deleted_files.each do |file|
-          categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :deleted, category) }
-        end
-
-        renamed_files.map { |x| x[:before] }.each do |file|
-          categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :renamed_before, category) }
-        end
-
-        renamed_files.map { |x| x[:after] }.each do |file|
-          categories_for_file(file, categories).each { |category| changes << Gitlab::Dangerfiles::Change.new(file, :renamed_after, category) }
-        end
-      end
-    end
-
-    # Determines the categories a file is in, e.g., `[:frontend]`, `[:backend]`, or  `%i[frontend engineering_productivity]`
-    # using filename regex and specific change regex if given.
-    #
-    # @return Array<Symbol>
-    def categories_for_file(file, categories)
-      _, categories = categories.find do |key, _|
-        filename_regex, changes_regex = Array(key)
-
-        found = filename_regex.match?(file)
-        found &&= changed_lines(file).any? { |changed_line| changes_regex.match?(changed_line) } if changes_regex
-
-        found
-      end
-
-      Array(categories || :unknown)
-    end
-
-    # Returns the GFM for a category label, making its best guess if it's not
-    # a category we know about.
-    #
-    # @return[String]
-    def label_for_category(category)
-      CATEGORY_LABELS.fetch(category, "~#{category}")
-    end
-
-    def new_teammates(usernames)
-      usernames.map { |u| Gitlab::Dangerfiles::Teammate.new("username" => u) }
-    end
-
-    def mr_iid
-      return "" unless ci?
-
-      gitlab_helper.mr_json["iid"]
-    end
-
-    def mr_title
-      return "" unless ci?
-
-      gitlab_helper.mr_json["title"]
-    end
-
-    def mr_web_url
-      return "" unless ci?
-
-      gitlab_helper.mr_json["web_url"]
-    end
-
-    def mr_labels
-      return [] unless ci?
-
-      gitlab_helper.mr_labels
-    end
-
-    def mr_target_branch
-      return "" unless ci?
-
-      gitlab_helper.mr_json["target_branch"]
-    end
-
-    def draft_mr?
-      Gitlab::Dangerfiles::TitleLinting.has_draft_flag?(mr_title)
-    end
-
-    def security_mr?
-      mr_web_url.include?("/gitlab-org/security/")
-    end
-
-    def cherry_pick_mr?
-      Gitlab::Dangerfiles::TitleLinting.has_cherry_pick_flag?(mr_title)
-    end
-
-    def run_all_rspec_mr?
-      Gitlab::Dangerfiles::TitleLinting.has_run_all_rspec_flag?(mr_title)
-    end
-
-    def run_as_if_foss_mr?
-      Gitlab::Dangerfiles::TitleLinting.has_run_as_if_foss_flag?(mr_title)
-    end
-
-    def stable_branch?
-      /\A\d+-\d+-stable-ee/i.match?(mr_target_branch)
-    end
-
-    def mr_has_labels?(*labels)
-      labels = labels.flatten.uniq
-
-      (labels & mr_labels) == labels
-    end
-
-    def labels_list(labels, sep: ", ")
-      labels.map { |label| %Q{~"#{label}"} }.join(sep)
-    end
-
-    def prepare_labels_for_mr(labels)
-      return "" unless labels.any?
-
-      "/label #{labels_list(labels, sep: " ")}"
-    end
-
-    def changed_files(regex)
-      all_changed_files.grep(regex)
-    end
-
-    def has_database_scoped_labels?(current_mr_labels)
-      current_mr_labels.any? { |label| label.start_with?("database::") }
-    end
-
-    def has_ci_changes?
-      changed_files(%r{\A(\.gitlab-ci\.yml|\.gitlab/ci/)}).any?
-    end
-
-    def group_label(labels)
-      labels.find { |label| label.start_with?("group::") }
-    end
-  end
-end