danger 3.2.2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc585b3a42ead8015e789fab0a20800043436033
-  data.tar.gz: 5568de8b9b97cdf2296ff8ef386286a4dc03096d
+  metadata.gz: 7e10fb247dbfbbf65bddac255ef51fbde2886ec7
+  data.tar.gz: 26e8a81ba580a77b844ee956875974dc52605e41
 SHA512:
-  metadata.gz: c955e1a1a81c272e25e6abdb5b3d8e51630f2f2850ef4c696acda0e5348f37211ced89910af612a592fab1c492c4ddc6bb3ccc9c0d704a49c23330ee0d628528
-  data.tar.gz: 8d88d1ad781ff5705e44d3f8780191786ccbb19012fc845c062c58b3412bf6a504f2c11b73a4a8052ab43d4a243e85920deba3c76564a561009cf98d3f385c6f
+  metadata.gz: 5af8334759ab6fd99078bdc24b25723f21266fc2a3ef603c66ea0940576f7b2228740aead12e1d6198afce6ce1ce46fb2f074d4b111d615f693bb29bb4eda08a
+  data.tar.gz: a9248512d06c5c37cbcf45f2d29ebb8ff02f325e8609c540b9eb05629fb0a01ac81fce622a198a7b13fc76fe3f04c1d879312f915a7480f44bf6b91db94c737b

data/lib/danger/ci_source/jenkins.rb

@@ -38,7 +38,7 @@ module Danger
     end
 
     def supported_request_sources
-      @supported_request_sources ||= [Danger::RequestSources::GitHub, Danger::RequestSources::GitLab, Danger::RequestSources::BitbucketServer]
+      @supported_request_sources ||= [Danger::RequestSources::GitHub, Danger::RequestSources::GitLab, Danger::RequestSources::BitbucketServer, Danger::RequestSources::BitbucketCloud]
     end
 
     def initialize(env)

data/lib/danger/core_ext/string.rb

@@ -1,17 +1,15 @@
 class String
-  def danger_class
-    split("_").collect!(&:capitalize).join
-  end
-
+  # @return [String] the plural form of self determined by count
   def danger_pluralize(count)
     "#{count} #{self}#{'s' unless count == 1}"
   end
 
+  # @return [String] converts to underscored, lowercase form
   def danger_underscore
-    self.gsub(/::/, "/").
-      gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
-      gsub(/([a-z\d])([A-Z])/, '\1_\2').
-      tr("-", "_").
+    self.gsub(/::/, "/".freeze).
+      gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2'.freeze).
+      gsub(/([a-z\d])([A-Z])/, '\1_\2'.freeze).
+      tr("-".freeze, "_".freeze).
       downcase
   end
 end

data/lib/danger/danger_core/dangerfile.rb

@@ -9,6 +9,7 @@ require "danger/danger_core/plugins/dangerfile_git_plugin"
 require "danger/danger_core/plugins/dangerfile_github_plugin"
 require "danger/danger_core/plugins/dangerfile_gitlab_plugin"
 require "danger/danger_core/plugins/dangerfile_bitbucket_server_plugin"
+require "danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin"
 
 module Danger
   class Dangerfile
@@ -36,7 +37,7 @@ module Danger
 
     # The ones that everything would break without
     def self.essential_plugin_classes
-      [DangerfileMessagingPlugin, DangerfileGitPlugin, DangerfileDangerPlugin, DangerfileGitHubPlugin, DangerfileGitLabPlugin, DangerfileBitbucketServerPlugin]
+      [DangerfileMessagingPlugin, DangerfileGitPlugin, DangerfileDangerPlugin, DangerfileGitHubPlugin, DangerfileGitLabPlugin, DangerfileBitbucketServerPlugin, DangerfileBitbucketCloudPlugin]
     end
 
     # Both of these methods exist on all objects

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

@@ -2,7 +2,7 @@ module Danger
   class Markdown
     attr_accessor :message, :file, :line
 
-    def initialize(message, file, line)
+    def initialize(message, file = nil, line = nil)
       self.message = message
       self.file = file
       self.line = line
@@ -17,16 +17,17 @@ module Danger
         other.line == line
     end
 
+    # @return [Boolean] returns true if is a file or line, false otherwise
     def inline?
-      return (file.nil? && line.nil?) == false
+      file || line
     end
 
     def to_s
       extra = []
-      extra << "file: #{file}" unless file.nil?
-      extra << "line: #{line}" unless line.nil?
+      extra << "file: #{file}" unless file
+      extra << "line: #{line}" unless line
 
-      "Markdown #{message} { #{extra.join ', '} }"
+      "Markdown #{message} { #{extra.join ', '.freeze} }"
     end
   end
 end

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

@@ -2,7 +2,7 @@ module Danger
   class Violation
     attr_accessor :message, :sticky, :file, :line
 
-    def initialize(message, sticky, file, line)
+    def initialize(message, sticky, file = nil, line = nil)
       self.message = message
       self.sticky = sticky
       self.file = file
@@ -19,17 +19,18 @@ module Danger
         other.line == line
     end
 
+    # @return [Boolean] returns true if is a file or line, false otherwise
     def inline?
-      return (file.nil? && line.nil?) == false
+      file || line
     end
 
     def to_s
       extra = []
       extra << "sticky: true" if sticky
-      extra << "file: #{file}" unless file.nil?
-      extra << "line: #{line}" unless line.nil?
+      extra << "file: #{file}" unless file
+      extra << "line: #{line}" unless line
 
-      "Violation #{message} { #{extra.join ', '} }"
+      "Violation #{message} { #{extra.join ', '.freeze} }"
     end
   end
 end

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

@@ -0,0 +1,198 @@
+# coding: utf-8
+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
+  #
+  #          fail "Please add labels to this PR" if bitbucket_cloud.pr_labels.empty?
+  #
+  # @example Ensure there is a summary for a PR
+  #
+  #          fail "Please provide a summary in the Pull Request description" if bitbucket_cloud.pr_body.length < 5
+  #
+  # @example Only accept PRs to the develop branch
+  #
+  #          fail "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." unless 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][: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 Cloud Misc
+    # Returns a list of HTML anchors for a file, or files in the head repository.
+    # 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)
+      create_link(paths, full_path) { |href, text| create_html_link(href, text) }
+    end
+
+    # @!group Bitbucket Cloud 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
+
+    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_html_link(href, text)
+      "<a href='#{href}'>#{text}</a>"
+    end
+
+    def create_markdown_link(href, text)
+      "[#{text}](#{href})"
+    end
+  end
+end

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

@@ -99,6 +99,8 @@ module Danger
         :gitlab
       when Danger::RequestSources::BitbucketServer
         :bitbucket_server
+      when Danger::RequestSources::BitbucketCloud
+        :bitbucket_cloud
       else
         :unknown
       end

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

@@ -114,5 +114,21 @@ module Danger
     def diff_for_file(file)
       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)
+      stats = @git.diff.stats[:files][file]
+      diff = @git.diff[file]
+      {
+        insertions: stats[:insertions],
+        deletions: stats[:deletions],
+        before: diff.blob(:src).contents,
+        after: diff.blob(:dst).contents
+      }
+    end
   end
 end

data/lib/danger/helpers/comment.rb

@@ -0,0 +1,22 @@
+module Danger
+  class Comment
+    attr_reader :id, :body
+
+    def initialize(id, body)
+      @id = id
+      @body = body
+    end
+
+    def self.from_github(comment)
+      self.new(comment[:id], comment[:body])
+    end
+
+    def self.from_gitlab(comment)
+      self.new(comment.id, comment.body)
+    end
+
+    def generated_by_danger?(danger_id)
+      body.include?("generated_by_#{danger_id}")
+    end
+  end
+end

data/lib/danger/helpers/comments_helper.rb

@@ -180,27 +180,6 @@ module Danger
 
         return NEW_REGEX.match(table)
       end
-
-      class Comment
-        attr_reader :id, :body
-
-        def initialize(id, body)
-          @id = id
-          @body = body
-        end
-
-        def self.from_github(comment)
-          self.new(comment[:id], comment[:body])
-        end
-
-        def self.from_gitlab(comment)
-          self.new(comment.id, comment.body)
-        end
-
-        def generated_by_danger?(danger_id)
-          body.include?("generated_by_#{danger_id}")
-        end
-      end
     end
   end
 end

data/lib/danger/helpers/comments_parsing_helper.rb

@@ -9,7 +9,7 @@ module Danger
       #
       # @return [Violation or Markdown] the extracted message
       def parse_message_from_row(row)
-        Violation.new(row, true, nil, nil)
+        Violation.new(row, true)
       end
 
       def parse_tables_from_comment(comment)

data/lib/danger/request_source/bitbucket_cloud.rb

@@ -0,0 +1,78 @@
+# coding: utf-8
+require "danger/helpers/comments_helper"
+
+module Danger
+  module RequestSources
+    class BitbucketCloud < RequestSource
+      include Danger::Helpers::CommentsHelper
+      attr_accessor :pr_json
+
+      def initialize(ci_source, environment)
+        self.ci_source = ci_source
+        self.environment = environment
+
+        project, slug = ci_source.repo_slug.split("/")
+        @api = BitbucketCloudAPI.new(project, slug, ci_source.pull_request_id, environment)
+      end
+
+      def validates_as_ci?
+        # TODO: ???
+        true
+      end
+
+      def validates_as_api_source?
+        @api.credentials_given?
+      end
+
+      def scm
+        @scm ||= GitRepo.new
+      end
+
+      def host
+        @host ||= @api.host
+      end
+
+      def fetch_details
+        self.pr_json = @api.fetch_pr_json
+      end
+
+      def setup_danger_branches
+        base_commit = self.pr_json[:destination][:commit][:hash]
+        head_commit = self.pr_json[:source][:commit][:hash]
+
+        # Next, we want to ensure that we have a version of the current branch at a known location
+        self.scm.exec "branch #{EnvironmentManager.danger_base_branch} #{base_commit}"
+
+        # OK, so we want to ensure that we have a known head branch, this will always represent
+        # the head of the PR ( e.g. the most recent commit that will be merged. )
+        self.scm.exec "branch #{EnvironmentManager.danger_head_branch} #{head_commit}"
+      end
+
+      def organisation
+        nil
+      end
+
+      def update_pull_request!(warnings: [], errors: [], messages: [], markdowns: [], danger_id: "danger")
+        delete_old_comments(danger_id: danger_id)
+
+        comment = generate_description(warnings: warnings, errors: errors)
+        comment += "\n\n"
+        comment += generate_comment(warnings: warnings,
+                                     errors: errors,
+                                   messages: messages,
+                                  markdowns: markdowns,
+                        previous_violations: {},
+                                  danger_id: danger_id,
+                                   template: "bitbucket_server")
+
+        @api.post_comment(comment)
+      end
+
+      def delete_old_comments(danger_id: "danger")
+        @api.fetch_last_comments.each do |c|
+          @api.delete_comment(c[:id]) if c[:content][:raw] =~ /generated_by_#{danger_id}/
+        end
+      end
+    end
+  end
+end

data/lib/danger/request_source/bitbucket_cloud_api.rb

@@ -0,0 +1,80 @@
+# coding: utf-8
+require "danger/helpers/comments_helper"
+
+module Danger
+  module RequestSources
+    class BitbucketCloudAPI
+      attr_accessor :host, :pr_api_endpoint, :pr_api_endpoint_v1
+
+      def initialize(project, slug, pull_request_id, environment)
+        @username = environment["DANGER_BITBUCKETCLOUD_USERNAME"]
+        @password = environment["DANGER_BITBUCKETCLOUD_PASSWORD"]
+        self.pr_api_endpoint = "https://api.bitbucket.org/2.0/repositories/#{project}/#{slug}/pullrequests/#{pull_request_id}"
+        self.pr_api_endpoint_v1 = "https://api.bitbucket.org/1.0/repositories/#{project}/#{slug}/pullrequests/#{pull_request_id}"
+      end
+
+      def inspect
+        inspected = super
+
+        if @password
+          inspected = inspected.sub! @password, "********".freeze
+        end
+
+        inspected
+      end
+
+      def credentials_given?
+        @username && !@username.empty? && @password && !@password.empty?
+      end
+
+      def fetch_pr_json
+        uri = URI(pr_api_endpoint)
+        fetch_json(uri)
+      end
+
+      def fetch_last_comments
+        uri = URI("#{pr_api_endpoint}/activity?limit=1000")
+        fetch_json(uri)[:values].select { |v| v[:comment] }.map { |v| v[:comment] }
+      end
+
+      def delete_comment(id)
+        uri = URI("#{pr_api_endpoint_v1}/comments/#{id}")
+        delete(uri)
+      end
+
+      def post_comment(text)
+        uri = URI("#{pr_api_endpoint_v1}/comments")
+        body = { content: text }.to_json
+        post(uri, body)
+      end
+
+      private
+
+      def fetch_json(uri)
+        req = Net::HTTP::Get.new(uri.request_uri, { "Content-Type" => "application/json" })
+        req.basic_auth @username, @password
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(req)
+        end
+        JSON.parse(res.body, symbolize_names: true)
+      end
+
+      def post(uri, body)
+        req = Net::HTTP::Post.new(uri.request_uri, { "Content-Type" => "application/json" })
+        req.basic_auth @username, @password
+        req.body = body
+        Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(req)
+        end
+      end
+
+      def delete(uri)
+        req = Net::HTTP::Delete.new(uri.request_uri, { "Content-Type" => "application/json" })
+        req.basic_auth @username, @password
+        Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(req)
+        end
+      end
+    end
+  end
+end

data/lib/danger/request_source/github.rb

@@ -1,6 +1,7 @@
 # coding: utf-8
 require "octokit"
 require "danger/helpers/comments_helper"
+require "danger/helpers/comment"
 
 module Danger
   module RequestSources

data/lib/danger/request_source/gitlab.rb

@@ -1,6 +1,7 @@
 # coding: utf-8
 require "gitlab"
 require "danger/helpers/comments_helper"
+require "danger/helpers/comment"
 
 module Danger
   module RequestSources

data/lib/danger/version.rb

@@ -1,4 +1,4 @@
 module Danger
-  VERSION = "3.2.2".freeze
+  VERSION = "3.3.0".freeze
   DESCRIPTION = "Like Unit Tests, but for your Team Culture.".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.3.0
 platform: ruby
 authors:
 - Orta Therox
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-14 00:00:00.000000000 Z
+date: 2016-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: claide
@@ -398,6 +398,7 @@ files:
 - lib/danger/danger_core/executor.rb
 - lib/danger/danger_core/messages/markdown.rb
 - lib/danger/danger_core/messages/violation.rb
+- lib/danger/danger_core/plugins/dangerfile_bitbucket_cloud_plugin.rb
 - lib/danger/danger_core/plugins/dangerfile_bitbucket_server_plugin.rb
 - lib/danger/danger_core/plugins/dangerfile_danger_plugin.rb
 - lib/danger/danger_core/plugins/dangerfile_git_plugin.rb
@@ -405,6 +406,7 @@ files:
 - lib/danger/danger_core/plugins/dangerfile_gitlab_plugin.rb
 - lib/danger/danger_core/plugins/dangerfile_messaging_plugin.rb
 - lib/danger/danger_core/standard_error.rb
+- lib/danger/helpers/comment.rb
 - lib/danger/helpers/comments_helper.rb
 - lib/danger/helpers/comments_parsing_helper.rb
 - lib/danger/plugin_support/plugin.rb
@@ -412,6 +414,8 @@ files:
 - lib/danger/plugin_support/plugin_linter.rb
 - lib/danger/plugin_support/plugin_parser.rb
 - lib/danger/plugin_support/templates/readme_table.html.erb
+- lib/danger/request_source/bitbucket_cloud.rb
+- lib/danger/request_source/bitbucket_cloud_api.rb
 - lib/danger/request_source/bitbucket_server.rb
 - lib/danger/request_source/bitbucket_server_api.rb
 - lib/danger/request_source/github.rb