danger 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3d5dcfa64082b3686cad3e6ae09ca23af616914
-  data.tar.gz: 151921230dd40b9c27c54c8def4a6740e24b9435
+  metadata.gz: 52836eb7928792ec1e8ec0ffb78076c0e1d6cae0
+  data.tar.gz: 9d550c596cfe8e25764a0662965fc4e4768ddf54
 SHA512:
-  metadata.gz: ff42d5811f941c173b73ea315ba646fcabf692178bbf91d41a19dd5a32d6a151604d40687aff54a3f66ed0e19fa03c19b3fa1e702bda3a3d24a6e4d2cafb2d71
-  data.tar.gz: 87db09b4a3696166880024b6755c25e17c637724b2e1b4c9e22d1732e7ad12675c7ab1d37d703399b214a4e31971bf24e75d7ffa3205129a98519aae4ddfe2ad
+  metadata.gz: 7103cf673b79e9827e1eef36a08c8001540fff0e0f5f535d2d4ce01a4b3d836546ea4cf083e736c5bf4ce0f3a3e9f3f93829713313672fa2d6f10f7c06ab591a
+  data.tar.gz: 2af2f1aebc31d5c3b573e2af054a46975160c9b200b3d06511036d0b7a05862b36869273a8d99083724725f11edf97632664200e752b5b63aba3f26695cf6a0b

data/lib/danger.rb

@@ -26,4 +26,18 @@ module Danger
     end
     return Gem::Specification.find_by_name(gem_name).gem_dir
   end
+
+  # @return [String] Latest version of Danger on https://rubygems.org
+  def self.danger_outdated?
+    require "danger/clients/rubygems_client"
+    latest_version = RubyGemsClient.latest_danger_version
+
+    if Gem::Version.new(latest_version) > Gem::Version.new(Danger::VERSION)
+      latest_version
+    else
+      false
+    end
+  rescue StandardError => _e
+    false
+  end
 end

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]
+      @supported_request_sources ||= [Danger::RequestSources::GitHub, Danger::RequestSources::GitLab, Danger::RequestSources::BitbucketServer]
     end
 
     def initialize(env)

data/lib/danger/ci_source/local_git_repo.rb

@@ -12,6 +12,10 @@ module Danger
       env.key? "DANGER_USE_LOCAL_GIT"
     end
 
+    def self.validates_as_pr?(_env)
+      false
+    end
+
     def git
       @git ||= GitRepo.new
     end

data/lib/danger/clients/rubygems_client.rb

@@ -0,0 +1,14 @@
+module Danger
+  class RubyGemsClient
+    API_URL = "https://rubygems.org/api/v1/versions/danger/latest.json".freeze
+    DUMMY_VERSION = "0.0.0".freeze
+
+    def self.latest_danger_version
+      require "json"
+      json = JSON.parse(Faraday.get(API_URL).body)
+      json.fetch("version") { DUMMY_VERSION }
+    rescue StandardError => _e
+      DUMMY_VERSION
+    end
+  end
+end

data/lib/danger/comment_generators/bitbucket_server.md.erb

@@ -0,0 +1,20 @@
+<%- @tables.each do |table| -%>
+  <%- if table[:content].any? || table[:resolved].any? -%>
+| | <%= table[:count] %> <%= table[:name] %><%= "s" unless table[:count] == 1 %> |
+|---|---|
+    <%- table[:content].each do |violation| -%>
+| <%= character_from_emoji(table[:emoji]) %> | <%= violation.message %> |
+    <%- end -%>
+    <%- table[:resolved].each do |message| -%>
+| :white_check_mark: | <%= message %> |
+    <%- end -%>
+
+  <%- end -%>
+<%- end -%>
+
+<%- @markdowns.each do |current| -%>
+<%= current %>
+<%# the previous line has to be aligned far to the left, otherwise markdown can break easily %>
+<%- end -%>
+
+Generated by 🚫 [danger](http://example.com/ "generated_by_<%= @danger_id %>")

data/lib/danger/comment_generators/github_inline.md.erb

@@ -0,0 +1,26 @@
+<%- @tables.each do |table| -%>
+  <%- if table[:content].any? -%>
+<table data-meta="generated_by_<%= @danger_id %>">
+  <tbody>
+    <%- table[:content].each do |violation| -%>
+    <tr>
+      <td>:<%= table[:emoji] %>:</td>
+      <td width="100%" data-sticky="<%= violation.sticky %>"><%= "<del>" if table[:resolved] %><%= violation.message %><%= "</del>" if table[:resolved] %></td>
+    </tr>
+    <%- end -%>
+  </tbody>
+</table>
+  <%- end -%>
+<%- end -%>
+
+<%- @markdowns.each do |current| -%>
+<%= current %>
+<%# the previous line has to be aligned far to the left, otherwise markdown can break easily %>
+<%- end -%>
+<%# We need to add the generated_by_ to identify comments from danger. But with inlines %>
+<%# it might be a little annoying, so we set on the table, but if we have markdown we add the footer anyway %>
+<%- if @markdowns.count > 0 -%>
+<p align="right" data-meta="generated_by_<%= @danger_id %>">
+  Generated by :no_entry_sign: <a href="http://danger.systems/">danger</a>
+</p>
+<%- end -%>

data/lib/danger/danger_core/dangerfile.rb

@@ -8,6 +8,7 @@ require "danger/danger_core/plugins/dangerfile_danger_plugin"
 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"
 
 module Danger
   class Dangerfile
@@ -35,7 +36,7 @@ module Danger
 
     # The ones that everything would break without
     def self.essential_plugin_classes
-      [DangerfileMessagingPlugin, DangerfileGitPlugin, DangerfileDangerPlugin, DangerfileGitHubPlugin, DangerfileGitLabPlugin]
+      [DangerfileMessagingPlugin, DangerfileGitPlugin, DangerfileDangerPlugin, DangerfileGitHubPlugin, DangerfileGitLabPlugin, DangerfileBitbucketServerPlugin]
     end
 
     # Both of these methods exist on all objects
@@ -203,7 +204,8 @@ module Danger
 
     def print_results
       status = status_report
-      return if (status[:errors] + status[:warnings] + status[:messages] + status[:markdowns]).count.zero?
+      violations = violation_report
+      return if (violations[:errors] + violations[:warnings] + violations[:messages] + status[:markdowns]).count.zero?
 
       ui.section("Results:") do
         [:errors, :warnings, :messages].each do |key|
@@ -216,14 +218,15 @@ module Danger
                   else
                     formatted
                   end
-          rows = status[key]
+          rows = violations[key]
           print_list(title, rows)
         end
 
         if status[:markdowns].count > 0
-          ui.section("Markdown:") do
+          ui.title("Markdown:") do
             status[:markdowns].each do |current_markdown|
-              ui.puts current_markdown
+              ui.puts "#{current_markdown.file}\#L#{current_markdown.line}" if current_markdown.file && current_markdown.line
+              ui.puts current_markdown.message
             end
           end
         end
@@ -235,7 +238,13 @@ module Danger
     def print_list(title, rows)
       ui.title(title) do
         rows.each do |row|
-          ui.puts("- [ ] #{row}")
+          if row.file && row.line
+            path = "#{row.file}\#L#{row.line}: "
+          else
+            path = ""
+          end
+
+          ui.puts("- [ ] #{path}#{row.message}")
         end
       end unless rows.empty?
     end

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

@@ -0,0 +1,28 @@
+module Danger
+  class Markdown
+    attr_accessor :message, :file, :line
+
+    def initialize(message, file, line)
+      self.message = message
+      self.file = file
+      self.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 to_s
+      extra = []
+      extra << "file: #{file}" unless file.nil?
+      extra << "line: #{line}" unless line.nil?
+
+      "Markdown #{message} { #{extra.join ', '} }"
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Danger
+  class Violation
+    attr_accessor :message, :sticky, :file, :line
+
+    def initialize(message, sticky, file, line)
+      self.message = message
+      self.sticky = sticky
+      self.file = file
+      self.line = line
+    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 inline?
+      return (file.nil? && line.nil?) == false
+    end
+
+    def to_s
+      extra = []
+      extra << "sticky: true" if sticky
+      extra << "file: #{file}" unless file.nil?
+      extra << "line: #{line}" unless line.nil?
+
+      "Violation #{message} { #{extra.join ', '} }"
+    end
+  end
+end

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

@@ -0,0 +1,182 @@
+# coding: utf-8
+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
+  #
+  #          fail "Please add labels to this PR" if bitbucket_server.pr_labels.empty?
+  #
+  # @example Check if a user is in a specific bitbucket_server org, and message them if so
+  #
+  #          unless bitbucket_server.api.organization_member?('danger', bitbucket_server.pr_author)
+  #            message "@#{bitbucket_server.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
+  #
+  #          fail "Please provide a summary in the Pull Request description" if bitbucket_server.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_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." unless 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 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)
+      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}" : ""
+        create_link("#{repo}/browse/#{url_path}?at=#{commit}#{line_ref}", text)
+      end
+
+      return paths.first if paths.count < 2
+      paths.first(paths.count - 1).join(", ") + " & " + paths.last
+    end
+
+    private
+
+    def create_link(href, text)
+      "<a href='#{href}'>#{text}</a>"
+    end
+  end
+end

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

@@ -40,7 +40,7 @@ module Danger
     # @return   [void]
     #
     def import_plugin(path_or_url)
-      raise "`import` requires a string" unless path_or_url.kind_of?(String)
+      raise "`import_plugin` requires a string" unless path_or_url.kind_of?(String)
 
       if path_or_url.start_with?("http")
         import_url(path_or_url)
@@ -49,23 +49,78 @@ module Danger
       end
     end
 
+    # @!group Danger
+    # Import a Dangerfile.
+    #
+    # @param    [Hash] opts
+    # @option opts [String] :github Github path
+    # @option opts [String] :gem Gem name
+    # @option opts [String] :path Path to Dangerfile
+    # @return   [void]
+    def import_dangerfile(opts)
+      if opts.kind_of?(String)
+        warn "Use `import_dangerfile(github: '#{opts}')` instead of `import_dangerfile '#{opts}'`."
+        import_dangerfile_from_github(opts)
+      elsif opts.kind_of?(Hash)
+        if opts.key?(:github)
+          import_dangerfile_from_github(opts[:github])
+        elsif opts.key?(:path)
+          import_dangerfile_from_path(opts[:path])
+        elsif opts.key?(:gem)
+          import_dangerfile_from_gem(opts[:gem])
+        else
+          raise "`import` requires a Hash with either :github or :gem"
+        end
+      else
+        raise "`import` requires a Hash" unless opts.kind_of?(Hash)
+      end
+    end
+
+    private
+
+    # @!group Danger
+    # Read and execute a local Dangerfile.
+    #
+    # @param    [String] path
+    #           A path to a Dangerfile.
+    # @return   [void]
+    #
+    def import_dangerfile_from_path(path)
+      raise "`import_dangerfile_from_path` requires a string" unless path.kind_of?(String)
+      local_path = File.join(path, "Dangerfile")
+      @dangerfile.parse(Pathname.new(local_path))
+    end
+
+    # @!group Danger
+    # Read and execute a Dangerfile from a gem.
+    #
+    # @param    [String] name
+    #           The name of the gem that contains a Dangerfile.
+    # @return   [void]
+    #
+    def import_dangerfile_from_gem(name)
+      raise "`import_dangerfile_from_gem` requires a string" unless name.kind_of?(String)
+      spec = Gem::Specification.find_by_name(name)
+      import_dangerfile_from_path(spec.gem_dir)
+    rescue Gem::MissingSpecError
+      raise "`import_dangerfile_from_gem` tried to load `#{name}` and failed, did you forget to include it in your Gemfile?"
+    end
+
     # @!group Danger
     # Download and execute a remote Dangerfile.
     #
-    # @param    [String] repo slug
+    # @param    [String] slug
     #           A slug that represents the repo where the Dangerfile is.
     # @return   [void]
     #
-    def import_dangerfile(slug)
-      raise "`import` requires a string" unless slug.kind_of?(String)
+    def import_dangerfile_from_github(slug)
+      raise "`import_dangerfile_from_github` requires a string" unless slug.kind_of?(String)
       org, repo = slug.split("/")
       download_url = env.request_source.file_url(organisation: org, repository: repo, branch: "master", path: "Dangerfile")
       local_path = download(download_url)
       @dangerfile.parse(Pathname.new(local_path))
     end
 
-    private
-
     # @!group Plugins
     # Download a local or remote plugin or Dangerfile.
     # This method will not import the file for you, use plugin.import instead