danger-additional-logging 0.0.1

data/lib/danger/danger_core/message_aggregator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "danger/danger_core/message_group"
+require "danger/helpers/message_groups_array_helper"
+
+module Danger
+  class MessageAggregator
+    def self.aggregate(*args)
+      new(*args).aggregate
+    end
+
+    def initialize(warnings: [],
+                   errors: [],
+                   messages: [],
+                   markdowns: [],
+                   danger_id: "danger")
+      @messages = warnings + errors + messages + markdowns
+      @danger_id = danger_id
+    end
+
+    # aggregates the messages into an array of MessageGroups
+    # @return [[MessageGroup]]
+    def aggregate
+      # oookay I took some shortcuts with this one.
+      # first, sort messages by file and line
+      @messages.sort! { |a, b| a.compare_by_file_and_line(b) }
+
+      # now create an initial empty message group
+      first_group = MessageGroup.new(file: nil,
+                                     line: nil)
+      @message_groups = @messages.reduce([first_group]) do |groups, msg|
+        # We get to take a shortcut because we sorted the messages earlier - only
+        # have to see if we can append msg to the last group in the list
+        if groups.last << msg
+          # we appended it, so return groups unchanged
+          groups
+        else
+          # have to create a new group since msg wasn't appended to the other
+          # group
+          new_group = MessageGroup.new(file: msg.file,
+                                       line: msg.line)
+          new_group << msg
+          groups << new_group
+        end
+      end
+
+      @message_groups.extend(Helpers::MessageGroupsArrayHelper)
+    end
+  end
+end

data/lib/danger/danger_core/message_group.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Danger
+  class MessageGroup
+    def initialize(file: nil, line: nil)
+      @file = file
+      @line = line
+    end
+
+    # Returns whether this `MessageGroup` is for the same line of code as
+    #   `other`, taking which file they are in to account.
+    # @param other [MessageGroup, Markdown, Violation]
+    # @return [Boolean] whether this `MessageGroup` is for the same line of code
+    def same_line?(other)
+      other.file == file && other.line == line
+    end
+
+    # Merges two `MessageGroup`s that represent the same line of code
+    # In future, perhaps `MessageGroup` will be able to represent a group of
+    # messages for multiple lines.
+    def merge(other)
+      raise ArgumentError, "Cannot merge with MessageGroup for a different line" unless same_line?(other)
+
+      @messages = (messages + other.messages).uniq
+    end
+
+    # Adds a message to the group.
+    # @param message [Markdown, Violation] the message to add
+    def <<(message)
+      # TODO: insertion sort
+      return nil unless same_line?(message)
+
+      inserted = false
+      messages.each.with_index do |other, idx|
+        if (message <=> other) == -1
+          inserted = true
+          messages.insert(idx, message)
+          break
+        end
+      end
+      messages << message unless inserted
+      messages
+    end
+
+    # The list of messages in this group. This list will be sorted in decreasing
+    # order of severity (error, warning, message, markdown)
+    def messages
+      @messages ||= []
+    end
+
+    attr_reader :file, :line
+
+    # @return a hash of statistics. Currently only :warnings_count and
+    # :errors_count
+    def stats
+      stats = { warnings_count: 0, errors_count: 0 }
+      messages.each do |msg|
+        stats[:warnings_count] += 1 if msg.type == :warning
+        stats[:errors_count] += 1 if msg.type == :error
+      end
+      stats
+    end
+
+    def markdowns
+      messages.select { |x| x.type == :markdown }
+    end
+  end
+end

data/lib/danger/danger_core/messages/base.rb

@@ -0,0 +1,57 @@
+module Danger
+  class BaseMessage
+    attr_accessor :message, :file, :line, :type
+
+    def initialize(type:, message:, file: nil, line: nil)
+      @type = type
+      @message = message
+      @file = file
+      @line = line
+    end
+
+    def compare_by_file_and_line(other)
+      order = cmp_nils(file, other.file)
+      return order unless order.nil?
+
+      order = file <=> other.file
+      return order unless order.zero?
+
+      order = cmp_nils(line, other.line)
+      return order unless order.nil?
+
+      line <=> other.line
+    end
+
+    # compares a and b based entirely on whether one or the other is nil
+    # arguments are in the same order as `a <=> b`
+    # nil is sorted earlier - so cmp_nils(nil, 1) => -1
+    #
+    # If neither are nil, rather than returning `a <=> b` which would seem
+    # like the obvious shortcut, `nil` is returned.
+    # This allows us to distinguish between cmp_nils returning 0 for a
+    # comparison of filenames, which means "a comparison on the lines is
+    # meaningless - you cannot have a line number for a nil file - so they
+    # should be sorted the same", and a <=> b returning 0, which means "the
+    # files are the same, so compare on the lines"
+    #
+    # @return 0, 1, -1, or nil
+    def cmp_nils(a, b)
+      if a.nil? && b.nil?
+        0
+      elsif a.nil?
+        -1
+      elsif b.nil?
+        1
+      end
+    end
+
+    def eql?(other)
+      return self == other
+    end
+
+    # @return [Boolean] returns true if is a file or line, false otherwise
+    def inline?
+      file || line
+    end
+  end
+end

data/lib/danger/danger_core/messages/markdown.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "danger/danger_core/messages/base"
+
+module Danger
+  class Markdown < BaseMessage
+    def initialize(message, file = nil, line = nil)
+      super(type: :markdown, message: message, file: file, line: line)
+    end
+
+    def ==(other)
+      return false if other.nil?
+      return false unless other.kind_of? self.class
+
+      other.message == message &&
+        other.file == file &&
+        other.line == line
+    end
+
+    def hash
+      h = 1
+      h = h * 31 + message.hash
+      h = h * 17 + file.hash
+      h * 17 + line.hash
+    end
+
+    def to_s
+      extra = []
+      extra << "file: #{file}" unless file
+      extra << "line: #{line}" unless line
+
+      "Markdown #{message} { #{extra.join ', '} }"
+    end
+
+    def <=>(other)
+      return 1 if other.type != :markdown
+
+      compare_by_file_and_line(other)
+    end
+  end
+end

data/lib/danger/danger_core/messages/violation.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "danger/danger_core/messages/base"
+
+module Danger
+  class Violation < BaseMessage
+    VALID_TYPES = %I[error warning message].freeze
+    attr_accessor :sticky
+
+    def initialize(message, sticky, file = nil, line = nil, type: :warning)
+      raise ArgumentError unless VALID_TYPES.include?(type)
+
+      super(type: type, message: message, file: file, line: line)
+      self.sticky = sticky
+    end
+
+    def ==(other)
+      return false if other.nil?
+      return false unless other.kind_of? self.class
+
+      other.message == message &&
+        other.sticky == sticky &&
+        other.file == file &&
+        other.line == line
+    end
+
+    def hash
+      h = 1
+      h = h * 31 + message.hash
+      h = h * 13 + sticky.hash
+      h = h * 17 + file.hash
+      h * 17 + line.hash
+    end
+
+    def <=>(other)
+      types = VALID_TYPES + [:markdown]
+      order = types.index(type) <=> types.index(other.type)
+      return order unless order.zero?
+
+      compare_by_file_and_line(other)
+    end
+
+    def to_s
+      extra = []
+      extra << "sticky: #{sticky}"
+      extra << "file: #{file}" if file
+      extra << "line: #{line}" if line
+      extra << "type: #{type}"
+
+      "Violation #{message} { #{extra.join ', '} }"
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+require "danger/plugin_support/plugin"
+
+module Danger
+  # Handles interacting with Bitbucket Cloud 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 bitbucket_cloud.pr_title.include? "[WIP]"
+  #
+  # @example Declare a PR to be simple to avoid specific Danger rules
+  #
+  #          declared_trivial = (bitbucket_cloud.pr_title + bitbucket_cloud.pr_body).include?("#trivial")
+  #
+  # @example Ensure that labels have been used on the PR
+  #
+  #          failure "Please add labels to this PR" if bitbucket_cloud.pr_labels.empty?
+  #
+  # @example Ensure there is a summary for a PR
+  #
+  #          failure "Please provide a summary in the Pull Request description" if bitbucket_cloud.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 bitbucket_cloud.branch_for_base != "develop"
+  #
+  # @example Highlight when a celebrity makes a pull request
+  #
+  #          message "Welcome, Danger." if bitbucket_cloud.pr_author == "dangermcshane"
+  #
+  # @example Ensure that all PRs have an assignee
+  #
+  #          warn "This PR does not have any assignees yet." if bitbucket_cloud.pr_json[:reviewers].length == 0
+  #
+  # @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 #{ bitbucket_cloud.html_link(config_files) }"
+  #          end
+  #
+  # @example Highlight with a clickable link if a Package.json is changed
+  #
+  #         warn "#{bitbucket_cloud.html_link("Package.json")} was edited." if git.modified_files.include? "Package.json"
+  #
+  # @see  danger/danger
+  # @tags core, bitbucket_cloud
+  #
+  class DangerfileBitbucketCloudPlugin < Plugin
+    # So that this init can fail.
+    def self.new(dangerfile)
+      return nil if dangerfile.env.request_source.class != Danger::RequestSources::BitbucketCloud
+
+      super
+    end
+
+    # The instance name used in the Dangerfile
+    # @return [String]
+    #
+    def self.instance_name
+      "bitbucket_cloud"
+    end
+
+    def initialize(dangerfile)
+      super(dangerfile)
+      @bs = dangerfile.env.request_source
+    end
+
+    # @!group Bitbucket Cloud 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/bitbucket_cloud_api/pr_response.json).
+    # @return [Hash]
+    def pr_json
+      @bs.pr_json
+    end
+
+    # @!group PR Metadata
+    # The title of the Pull Request.
+    # @return [String]
+    #
+    def pr_title
+      @bs.pr_json[:title].to_s
+    end
+
+    # @!group PR Metadata
+    # The body text of the Pull Request.
+    # @return [String]
+    #
+    def pr_description
+      @bs.pr_json[:description].to_s
+    end
+    alias pr_body pr_description
+
+    # @!group PR Metadata
+    # The username of the author of the Pull Request.
+    # @return [String]
+    #
+    def pr_author
+      @bs.pr_json[:author][:nickname]
+    end
+
+    # @!group PR Commit Metadata
+    # The branch to which the PR is going to be merged into.
+    # @return [String]
+    #
+    def branch_for_base
+      @bs.pr_json[:destination][:branch][:name]
+    end
+
+    # @!group PR Commit Metadata
+    # A href that represents the current PR
+    # @return [String]
+    #
+    def pr_link
+      @bs.pr_json[:links][:self][:href]
+    end
+
+    # @!group PR Commit Metadata
+    # The branch to which the PR is going to be merged from.
+    # @return [String]
+    #
+    def branch_for_head
+      @bs.pr_json[:source][:branch][:name]
+    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
+      @bs.pr_json[:destination][:commit][:hash]
+    end
+
+    # @!group PR Commit Metadata
+    # The head commit to which the PR is requesting to be merged from.
+    # @return [String]
+    #
+    def head_commit
+      @bs.pr_json[:source][:commit][:hash]
+    end
+  end
+end

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

@@ -0,0 +1,211 @@
+require "danger/plugin_support/plugin"
+
+module Danger
+  # Handles interacting with Bitbucket Server 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 bitbucket_server.pr_title.include? "[WIP]"
+  #
+  # @example Declare a PR to be simple to avoid specific Danger rules
+  #
+  #          declared_trivial = (bitbucket_server.pr_title + bitbucket_server.pr_body).include?("#trivial")
+  #
+  # @example Ensure that labels have been used on the PR
+  #
+  #          failure "Please add labels to this PR" if bitbucket_server.pr_labels.empty?
+  #
+  # @example Ensure there is a summary for a PR
+  #
+  #          failure "Please provide a summary in the Pull Request description" if bitbucket_server.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 bitbucket_server.branch_for_base != "develop"
+  #
+  # @example Highlight when a celebrity makes a pull request
+  #
+  #          message "Welcome, Danger." if bitbucket_server.pr_author == "dangermcshane"
+  #
+  # @example Ensure that all PRs have an assignee
+  #
+  #          warn "This PR does not have any assignees yet." if bitbucket_server.pr_json[:reviewers].length == 0
+  #
+  # @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 #{ bitbucket_server.html_link(config_files) }"
+  #          end
+  #
+  # @example Highlight with a clickable link if a Package.json is changed
+  #
+  #         warn "#{bitbucket_server.html_link("Package.json")} was edited." if git.modified_files.include? "Package.json"
+  #
+  # @see  danger/danger
+  # @tags core, bitbucket_server
+  #
+  class DangerfileBitbucketServerPlugin < Plugin
+    # So that this init can fail.
+    def self.new(dangerfile)
+      return nil if dangerfile.env.request_source.class != Danger::RequestSources::BitbucketServer
+
+      super
+    end
+
+    # The instance name used in the Dangerfile
+    # @return [String]
+    #
+    def self.instance_name
+      "bitbucket_server"
+    end
+
+    def initialize(dangerfile)
+      super(dangerfile)
+      @bs = dangerfile.env.request_source
+    end
+
+    # @!group Bitbucket Server 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/bitbucket_server_api/pr_response.json).
+    # @return [Hash]
+    def pr_json
+      @bs.pr_json
+    end
+
+    # @!group PR Metadata
+    # The title of the Pull Request.
+    # @return [String]
+    #
+    def pr_title
+      @bs.pr_json[:title].to_s
+    end
+
+    # @!group PR Metadata
+    # The body text of the Pull Request.
+    # @return [String]
+    #
+    def pr_description
+      @bs.pr_json[:description].to_s
+    end
+    alias pr_body pr_description
+
+    # @!group PR Metadata
+    # The username of the author of the Pull Request.
+    # @return [String]
+    #
+    def pr_author
+      @bs.pr_json[:author][:user][:slug].to_s
+    end
+
+    # @!group PR Commit Metadata
+    # The branch to which the PR is going to be merged into.
+    # @return [String]
+    #
+    def branch_for_base
+      @bs.pr_json[:toRef][:displayId].to_s
+    end
+
+    # @!group PR Commit Metadata
+    # A href that represents the current PR
+    # @return [String]
+    #
+    def pr_link
+      @bs.pr_json[:links][:self].flat_map { |l| l[:href] }.first.to_s
+    end
+
+    # @!group PR Commit Metadata
+    # The branch to which the PR is going to be merged from.
+    # @return [String]
+    #
+    def branch_for_head
+      @bs.pr_json[:fromRef][:displayId].to_s
+    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
+      @bs.pr_json[:toRef][:latestCommit].to_s
+    end
+
+    # @!group PR Commit Metadata
+    # The head commit to which the PR is requesting to be merged from.
+    # @return [String]
+    #
+    def head_commit
+      @bs.pr_json[:fromRef][:latestCommit].to_s
+    end
+
+    # @!group Bitbucket Server Misc
+    # Returns a list of Markdown links for a file, or files in the head repository.
+    # It returns a string of multiple anchors if passed an array.
+    # @note     Atlassian [disabled inline HTML support](https://jira.atlassian.com/browse/BSERV-7147).
+    #           This method method left for backward compatibility.
+    # @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)
+      markdown_link(paths, full_path: full_path)
+    end
+
+    # @!group Bitbucket Server Misc
+    # Returns a list of Markdown links for a file, or files in the head repository.
+    # It returns a string of multiple links if passed an array.
+    # @param    [String or Array<String>] paths
+    #           A list of strings to convert to Markdown links
+    # @param    [Bool] full_path
+    #           Shows the full path as the link's text, defaults to `true`.
+    #
+    # @return [String]
+    #
+    def markdown_link(paths, full_path: true)
+      create_link(paths, full_path) { |href, text| create_markdown_link(href, text) }
+    end
+
+    # @!group Bitbucket Server Misc
+    # Updates the PR with build status and build server job link.
+    # @param    [String] status
+    #           SUCCESSFUL, FAILED and INPROGRESS
+    # @param    [String] build_job_link
+    #           Build server job link
+    # @param    [String] description
+    #           Build status description
+    # @return   [String]
+    #
+    def update_pr_build_status(status, build_job_link, description)
+      @bs.update_pr_build_status(status, build_job_link, description)
+    end
+
+    private
+
+    def create_link(paths, full_path)
+      paths = [paths] unless paths.kind_of?(Array)
+      commit = head_commit
+      repo = pr_json[:fromRef][:repository][:links][:self].flat_map { |l| l[:href] }.first
+
+      paths = paths.map do |path|
+        path, line = path.split("#")
+        url_path = path.start_with?("/") ? path : "/#{path}"
+        text = full_path ? path : File.basename(path)
+        url_path.gsub!(" ", "%20")
+        line_ref = line ? "##{line}" : ""
+        yield("#{repo}#{url_path}?at=#{commit}#{line_ref}", text)
+      end
+
+      return paths.first if paths.count < 2
+
+      paths.first(paths.count - 1).join(", ") + " & " + paths.last
+    end
+
+    def create_markdown_link(href, text)
+      "[#{text}](#{href})"
+    end
+  end
+end