danger 8.0.3

data/lib/danger/danger_core/plugins/dangerfile_git_plugin.rb

@@ -0,0 +1,158 @@
+require "danger/plugin_support/plugin"
+require "danger/core_ext/file_list"
+
+# Danger
+module Danger
+  # Handles interacting with git inside a Dangerfile. Providing access to files that have changed, and useful statistics. Also provides
+  # access to the commits in the form of [Git::Log](https://github.com/schacon/ruby-git/blob/master/lib/git/log.rb) objects.
+  #
+  # @example Do something to all new and edited markdown files
+  #
+  #          markdowns = (git.added_files + git.modified_files)
+  #          do_something markdowns.select{ |file| file.end_with? "md" }
+  #
+  # @example Don't allow a file to be deleted
+  #
+  #          deleted = git.deleted_files.include? "my/favourite.file"
+  #          failure "Don't delete my precious" if deleted
+  #
+  # @example Fail really big diffs
+  #
+  #          failure "We cannot handle the scale of this PR" if git.lines_of_code > 50_000
+  #
+  # @example Warn when there are merge commits in the diff
+  #
+  #          if git.commits.any? { |c| c.message =~ /^Merge branch 'master'/ }
+  #            warn 'Please rebase to get rid of the merge commits in this PR'
+  #          end
+  #
+  # @example Warn when somebody tries to add nokogiri to the project
+  #
+  #          diff = git.diff_for_file("Gemfile.lock")
+  #          if diff && diff.patch =~ "nokogiri"
+  #            warn 'Please do not add nokogiri to the project. Thank you.'
+  #          end
+  #
+  # @see  danger/danger
+  # @tags core, git
+
+  class DangerfileGitPlugin < Plugin
+    # The instance name used in the Dangerfile
+    # @return [String]
+    #
+    def self.instance_name
+      "git"
+    end
+
+    def initialize(dangerfile)
+      super(dangerfile)
+      raise unless dangerfile.env.scm.class == Danger::GitRepo
+
+      @git = dangerfile.env.scm
+    end
+
+    # @!group Git Files
+    # Paths for files that were added during the diff
+    # @return [FileList<String>] an [Array] subclass
+    #
+    def added_files
+      Danger::FileList.new(@git.diff.select { |diff| diff.type == "new" }.map(&:path))
+    end
+
+    # @!group Git Files
+    # Paths for files that were removed during the diff
+    # @return [FileList<String>] an [Array] subclass
+    #
+    def deleted_files
+      Danger::FileList.new(@git.diff.select { |diff| diff.type == "deleted" }.map(&:path))
+    end
+
+    # @!group Git Files
+    # Paths for files that changed during the diff
+    # @return [FileList<String>] an [Array] subclass
+    #
+    def modified_files
+      Danger::FileList.new(@git.diff.select { |diff| diff.type == "modified" }.map(&:path))
+    end
+
+    # @!group Git Metadata
+    # List of renamed files
+    # @return [Array<Hash>] with keys `:before` and `:after`
+    #
+    def renamed_files
+      @git.renamed_files
+    end
+
+    # @!group Git Metadata
+    # Whole diff
+    # @return [Git::Diff] from the gem `git`
+    #
+    def diff
+      @git.diff
+    end
+
+    # @!group Git Metadata
+    # The overall lines of code added/removed in the diff
+    # @return [Fixnum]
+    #
+    def lines_of_code
+      @git.diff.lines
+    end
+
+    # @!group Git Metadata
+    # The overall lines of code removed in the diff
+    # @return [Fixnum]
+    #
+    def deletions
+      @git.diff.deletions
+    end
+
+    # @!group Git Metadata
+    # The overall lines of code added in the diff
+    # @return [Fixnum]
+    #
+    def insertions
+      @git.diff.insertions
+    end
+
+    # @!group Git Metadata
+    # The log of commits inside the diff
+    # @return [Git::Log] from the gem `git`
+    #
+    def commits
+      @git.log.to_a
+    end
+
+    # @!group Git Metadata
+    # Details for a specific file in this diff
+    # @return [Git::Diff::DiffFile] from the gem `git`
+    #
+    def diff_for_file(file)
+      (added_files + modified_files).include?(file) ? @git.diff[file] : nil
+    end
+
+    # @!group Git Metadata
+    # Statistics for a specific file in this diff
+    # @return [Hash] with keys `:insertions`, `:deletions` giving line counts, and `:before`, `:after` giving file contents, or nil if the file has no changes or does not exist
+    #
+    def info_for_file(file)
+      return nil unless modified_files.include?(file) || added_files.include?(file) || deleted_files.include?(file)
+      stats = @git.diff.stats[:files][file]
+      diff = @git.diff[file]
+      {
+        insertions: stats[:insertions],
+        deletions: stats[:deletions],
+        before: added_files.include?(file) || deleted_files.include?(file) ? nil : diff.blob(:src).contents,
+        after: added_files.include?(file) || deleted_files.include?(file) ? nil : diff.blob(:dst).contents
+      }
+    end
+
+    # @!group Git Metadata
+    # List of remote tags
+    # @return [String]
+    #
+    def tags
+      @git.tags.each_line
+    end
+  end
+end

data/lib/danger/danger_core/plugins/dangerfile_github_plugin.rb

@@ -0,0 +1,254 @@
+require "danger/plugin_support/plugin"
+
+module Danger
+  # Handles interacting with GitHub inside a Dangerfile. Provides a few functions which wrap `pr_json` and also
+  # through a few standard functions to simplify your code.
+  #
+  # @example Warn when a PR is classed as work in progress
+  #
+  #          warn "PR is classed as Work in Progress" if github.pr_title.include? "[WIP]"
+  #
+  # @example Declare a PR to be simple to avoid specific Danger rules
+  #
+  #          declared_trivial = (github.pr_title + github.pr_body).include?("#trivial")
+  #
+  # @example Ensure that labels have been used on the PR
+  #
+  #          failure "Please add labels to this PR" if github.pr_labels.empty?
+  #
+  # @example Check if a user is in a specific GitHub org, and message them if so
+  #
+  #          unless github.api.organization_member?('danger', github.pr_author)
+  #            message "@#{github.pr_author} is not a contributor yet, would you like to join the Danger org?"
+  #          end
+  #
+  # @example Ensure there is a summary for a PR
+  #
+  #          failure "Please provide a summary in the Pull Request description" if github.pr_body.length < 5
+  #
+  # @example Only accept PRs to the develop branch
+  #
+  #          failure "Please re-submit this PR to develop, we may have already fixed your issue." if github.branch_for_base != "develop"
+  #
+  # @example Note when PRs don't reference a milestone, which goes away when it does
+  #
+  #          has_milestone = github.pr_json["milestone"] != nil
+  #          warn("This PR does not refer to an existing milestone", sticky: false) unless has_milestone
+  #
+  # @example Note when a PR cannot be manually merged, which goes away when you can
+  #
+  #          can_merge = github.pr_json["mergeable"]
+  #          warn("This PR cannot be merged yet.", sticky: false) unless can_merge
+  #
+  # @example Highlight when a celebrity makes a pull request
+  #
+  #          message "Welcome, Danger." if github.pr_author == "dangermcshane"
+  #
+  # @example Ensure that all PRs have an assignee
+  #
+  #          warn "This PR does not have any assignees yet." unless github.pr_json["assignee"]
+  #
+  # @example Send a message with links to a collection of specific files
+  #
+  #          if git.modified_files.include? "config/*.js"
+  #            config_files = git.modified_files.select { |path| path.include? "config/" }
+  #            message "This PR changes #{ github.html_link(config_files) }"
+  #          end
+  #
+  # @example Highlight with a clickable link if a Package.json is changed
+  #
+  #         warn "#{github.html_link("Package.json")} was edited." if git.modified_files.include? "Package.json"
+  #
+  # @example Note an issue with a particular line on a file using the #L[num] syntax, e.g. `#L23`
+  #
+  #         linter_json = `my_linter lint "file"`
+  #         results = JSON.parse linter_json
+  #         unless results.empty?
+  #           file, line, warning = result.first
+  #           warn "#{github.html_link("#{file}#L#{line}")} has linter issue: #{warning}."
+  #         end
+  #
+  #
+  # @see  danger/danger
+  # @tags core, github
+  #
+  class DangerfileGitHubPlugin < Plugin
+    # So that this init can fail.
+    def self.new(dangerfile)
+      return nil if dangerfile.env.request_source.class != Danger::RequestSources::GitHub
+      super
+    end
+
+    def initialize(dangerfile)
+      super(dangerfile)
+
+      @github = dangerfile.env.request_source
+    end
+
+    # The instance name used in the Dangerfile
+    # @return [String]
+    #
+    def self.instance_name
+      "github"
+    end
+
+    # @!group PR Review
+    #
+    # In Beta. Provides access to creating a GitHub Review instead of a typical GitHub comment.
+    #
+    # To use you announce the start of your review, and the end via the `start` and `submit` functions,
+    # for example:
+    #
+    # github.review.start
+    # github.review.fail(message)
+    # github.review.warn(message)
+    # github.review.message(message)
+    # github.review.markdown(message)
+    # github.review.submit
+    #
+    # @return [ReviewDSL]
+    def review
+      @github.review
+    end
+
+    # @!group PR Metadata
+    # The title of the Pull Request.
+    # @return [String]
+    #
+    def pr_title
+      @github.pr_json["title"].to_s
+    end
+
+    # @!group PR Metadata
+    # The body text of the Pull Request.
+    # @return [String]
+    #
+    def pr_body
+      pr_json["body"].to_s
+    end
+
+    # @!group PR Metadata
+    # The username of the author of the Pull Request.
+    # @return [String]
+    #
+    def pr_author
+      pr_json["user"]["login"].to_s
+    end
+
+    # @!group PR Metadata
+    # The labels assigned to the Pull Request.
+    # @return [String]
+    #
+    def pr_labels
+      @github.issue_json["labels"].map { |l| l[:name] }
+    end
+
+    # @!group PR Commit Metadata
+    # The branch to which the PR is going to be merged into.
+    # @return [String]
+    #
+    def branch_for_base
+      pr_json["base"]["ref"]
+    end
+
+    # @!group PR Commit Metadata
+    # The branch to which the PR is going to be merged from.
+    # @return [String]
+    #
+    def branch_for_head
+      pr_json["head"]["ref"]
+    end
+
+    # @!group PR Commit Metadata
+    # The base commit to which the PR is going to be merged as a parent.
+    # @return [String]
+    #
+    def base_commit
+      pr_json["base"]["sha"]
+    end
+
+    # @!group PR Commit Metadata
+    # The head commit to which the PR is requesting to be merged from.
+    # @return [String]
+    #
+    def head_commit
+      pr_json["head"]["sha"]
+    end
+
+    # @!group GitHub Misc
+    # The hash that represents the PR's JSON. For an example of what this looks like
+    # see the [Danger Fixture'd one](https://raw.githubusercontent.com/danger/danger/master/spec/fixtures/github_api/pr_response.json).
+    # @return [Hash]
+    #
+    def pr_json
+      @github.pr_json
+    end
+
+    # @!group GitHub Misc
+    # Provides access to the GitHub API client used inside Danger. Making
+    # it easy to use the GitHub API inside a Dangerfile.
+    # @return [Octokit::Client]
+    def api
+      @github.client
+    end
+
+    # @!group PR Content
+    # The unified diff produced by Github for this PR
+    # see [Unified diff](https://en.wikipedia.org/wiki/Diff_utility#Unified_format)
+    # @return [String]
+    def pr_diff
+      @github.pr_diff
+    end
+
+    # @!group GitHub Misc
+    # Returns a list of HTML anchors for a file, or files in the head repository. An example would be:
+    # `<a href='https://github.com/artsy/eigen/blob/561827e46167077b5e53515b4b7349b8ae04610b/file.txt'>file.txt</a>`. It returns a string of multiple anchors if passed an array.
+    # @param    [String or Array<String>] paths
+    #           A list of strings to convert to github anchors
+    # @param    [Bool] full_path
+    #           Shows the full path as the link's text, defaults to `true`.
+    #
+    # @return [String]
+    def html_link(paths, full_path: true)
+      paths = [paths] unless paths.kind_of?(Array)
+      commit = head_commit
+      repo = pr_json["head"]["repo"]["html_url"]
+
+      paths = paths.map do |path|
+        url_path = path.start_with?("/") ? path : "/#{path}"
+        text = full_path ? path : File.basename(path)
+        create_link("#{repo}/blob/#{commit}#{url_path}", text)
+      end
+
+      return paths.first if paths.count < 2
+      paths.first(paths.count - 1).join(", ") + " & " + paths.last
+    end
+
+    # @!group GitHub Misc
+    # Use to ignore inline messages which lay outside a diff's range, thereby not posting them in the main comment.
+    # You can set hash to change behavior per each kinds. (ex. `{warning: true, error: false}`)
+    # @param    [Bool] or [Hash<Symbol, Bool>] dismiss
+    #           Ignore out of range inline messages, defaults to `true`
+    #
+    # @return   [void]
+    def dismiss_out_of_range_messages(dismiss = true)
+      if dismiss.kind_of?(Hash)
+        @github.dismiss_out_of_range_messages = dismiss
+      elsif dismiss.kind_of?(TrueClass)
+        @github.dismiss_out_of_range_messages = true
+      elsif dismiss.kind_of?(FalseClass)
+        @github.dismiss_out_of_range_messages = false
+      end
+    end
+
+    %i(title body author labels json).each do |suffix|
+      alias_method "mr_#{suffix}".to_sym, "pr_#{suffix}".to_sym
+    end
+
+    private
+
+    def create_link(href, text)
+      "<a href='#{href}'>#{text}</a>"
+    end
+  end
+end

data/lib/danger/danger_core/plugins/dangerfile_gitlab_plugin.rb

@@ -0,0 +1,240 @@
+require "danger/plugin_support/plugin"
+
+module Danger
+  # Handles interacting with GitLab inside a Dangerfile. Provides a few functions which wrap `mr_json` and also
+  # through a few standard functions to simplify your code.
+  #
+  # @example Warn when an MR is classed as work in progress.
+  #
+  #          warn "MR is classed as Work in Progress" if gitlab.mr_title.include? "[WIP]"
+  #
+  # @example Declare a MR to be simple to avoid specific Danger rules.
+  #
+  #          declared_trivial = (gitlab.mr_title + gitlab.mr_body).include?("#trivial")
+  #
+  # @example Ensure that labels have been applied to the MR.
+  #
+  #          failure "Please add labels to this MR" if gitlab.mr_labels.empty?
+  #
+  # @example Ensure that all MRs have an assignee.
+  #
+  #          warn "This MR does not have any assignees yet." unless gitlab.mr_json["assignee"]
+  #
+  # @example Ensure there is a summary for a MR.
+  #
+  #          failure "Please provide a summary in the Merge Request description" if gitlab.mr_body.length < 5
+  #
+  # @example Only accept MRs to the develop branch.
+  #
+  #          failure "Please re-submit this MR to develop, we may have already fixed your issue." if gitlab.branch_for_merge != "develop"
+  #
+  # @example Note when MRs don't reference a milestone, make the warning stick around on subsequent runs
+  #
+  #          has_milestone = gitlab.mr_json["milestone"] != nil
+  #          warn("This MR does not refer to an existing milestone", sticky: true) unless has_milestone
+  #
+  # @example Note when a MR cannot be manually merged
+  #
+  #          can_merge = gitlab.mr_json["mergeable"]
+  #          warn("This MR cannot be merged yet.") unless can_merge
+  #
+  # @example Highlight when a celebrity makes a merge request.
+  #
+  #          message "Welcome, Danger." if gitlab.mr_author == "dangermcshane"
+  #
+  # @example Send a message with links to a collection of specific files.
+  #
+  #          if git.modified_files.include? "config/*.js"
+  #            config_files = git.modified_files.select { |path| path.include? "config/" }
+  #            message "This MR changes #{ gitlab.html_link(config_files) }"
+  #          end
+  #
+  # @example Highlight with a clickable link if a Package.json is changed.
+  #
+  #         warn "#{gitlab.html_link("Package.json")} was edited." if git.modified_files.include? "Package.json"
+  #
+  # @example Select a random group member as assignee if no assignee is selected
+  #
+  #         if gitlab.mr_json["assignee"].nil?
+  #           reviewer = gitlab.api.group_members(gitlab.api.merge_request_approvals(project_id, mr_id).to_hash["approver_groups"].first["group"]["id"]).sample
+  #           if gitlab.api.group_members(gitlab.api.merge_request_approvals(project_id, mr_id).to_hash["approver_groups"].first["group"]["id"]).length > 1
+  #             while reviewer.to_hash["id"] == gitlab.mr_json["author"]["id"] do
+  #               reviewer = gitlab.api.group_members(gitlab.api.merge_request_approvals(project_id, mr_id).to_hash["approver_groups"].first["group"]["id"]).sample
+  #             end
+  #           end
+  #           message "Reviewer roulete rolled for: #{reviewer.to_hash['name']} (@#{reviewer.to_hash['username']})"
+  #           gitlab.api.update_merge_request(project_id, mr_id, { assignee_id: reviewer.to_hash["id"] })
+  #         end
+  # 
+  #
+  # @see  danger/danger
+  # @tags core, gitlab
+  #
+  class DangerfileGitLabPlugin < Plugin
+    # So that this init can fail.
+    def self.new(dangerfile)
+      return nil if dangerfile.env.request_source.class != Danger::RequestSources::GitLab
+      super
+    end
+
+    # The instance name used in the Dangerfile
+    # @return [String]
+    #
+    def self.instance_name
+      "gitlab"
+    end
+
+    def initialize(dangerfile)
+      super(dangerfile)
+
+      @gitlab = dangerfile.env.request_source
+    end
+
+    # @!group MR Metadata
+    # The title of the Merge Request
+    # @return [String]
+    #
+    def mr_title
+      @gitlab.mr_json.title.to_s
+    end
+
+    # @!group MR Metadata
+    # The body text of the Merge Request
+    # @return [String]
+    #
+    def mr_body
+      @gitlab.mr_json.description.to_s
+    end
+
+    # @!group MR Metadata
+    # The username of the author of the Merge Request
+    # @return [String]
+    #
+    def mr_author
+      @gitlab.mr_json.author.username.to_s
+    end
+
+    # @!group MR Metadata
+    # The labels assigned to the Merge Request
+    # @return [String]
+    #
+    def mr_labels
+      @gitlab.mr_json.labels
+    end
+
+    # @!group MR Content
+    # The unified diff produced by GitLab for this MR
+    # see [Unified diff](https://en.wikipedia.org/wiki/Diff_utility#Unified_format)
+    # @return [String]
+    #
+    def mr_diff
+      @gitlab.mr_diff
+    end
+
+    # @!group MR Commit Metadata
+    # The branch to which the MR is going to be merged into
+    # @deprecated Please use {#branch_for_base} instead
+    # @return [String]
+    #
+    def branch_for_merge
+      branch_for_base
+    end
+
+    # @!group MR Commit Metadata
+    # The branch to which the MR is going to be merged into.
+    # @return [String]
+    #
+    def branch_for_base
+      @gitlab.mr_json.target_branch
+    end
+
+    # @!group MR Commit Metadata
+    # The branch to which the MR is going to be merged from.
+    # @return [String]
+    #
+    def branch_for_head
+      @gitlab.mr_json.source_branch
+    end
+
+    # @!group MR Commit Metadata
+    # The base commit to which the MR is going to be merged as a parent
+    # @return [String]
+    #
+    def base_commit
+      @gitlab.mr_json.diff_refs.base_sha
+    end
+
+    # @!group MR Commit Metadata
+    # The head commit to which the MR is requesting to be merged from
+    # @return [String]
+    #
+    def head_commit
+      @gitlab.mr_json.diff_refs.head_sha
+    end
+
+    # @!group GitLab Misc
+    # The hash that represents the MR's JSON. See documentation for the
+    # structure [here](http://docs.gitlab.com/ce/api/merge_requests.html#get-single-mr)
+    # @return [Hash]
+    #
+    def mr_json
+      @gitlab.mr_json.to_hash
+    end
+
+    # @!group GitLab Misc
+    # Provides access to the GitLab API client used inside Danger. Making
+    # it easy to use the GitLab API inside a Dangerfile. See the gitlab
+    # gem's [documentation](http://www.rubydoc.info/gems/gitlab/Gitlab/Client)
+    # for accessible methods.
+    # @return [GitLab::Client]
+    #
+    def api
+      @gitlab.client
+    end
+
+    # @!group GitLab Misc
+    # Returns the web_url of the source project.
+    # @return [String]
+    #
+    def repository_web_url
+      @repository_web_url ||= begin
+        project = api.project(mr_json["source_project_id"])
+        project.web_url
+      end
+    end
+
+    # @!group GitLab Misc
+    # Returns a list of HTML anchors for a file, or files in the head repository. An example would be:
+    # `<a href='https://gitlab.com/artsy/eigen/blob/561827e46167077b5e53515b4b7349b8ae04610b/file.txt'>file.txt</a>`. It returns a string of multiple anchors if passed an array.
+    # @param    [String or Array<String>] paths
+    #           A list of strings to convert to gitlab anchors
+    # @param    [Bool] full_path
+    #           Shows the full path as the link's text, defaults to `true`.
+    #
+    # @return [String]
+    #
+    def html_link(paths, full_path: true)
+      paths = [paths] unless paths.kind_of?(Array)
+      commit = head_commit
+
+      paths = paths.map do |path|
+        url_path = path.start_with?("/") ? path : "/#{path}"
+        text = full_path ? path : File.basename(path)
+        create_link("#{repository_web_url}/blob/#{commit}#{url_path}", text)
+      end
+
+      return paths.first if paths.count < 2
+      paths.first(paths.count - 1).join(", ") + " & " + paths.last
+    end
+
+    %i(title body author labels json diff).each do |suffix|
+      alias_method "pr_#{suffix}".to_sym, "mr_#{suffix}".to_sym
+    end
+
+    private
+
+    def create_link(href, text)
+      "<a href='#{href}'>#{text}</a>"
+    end
+  end
+end