danger 3.4.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44b2fc8e9ba271755b5995d03991b6039535ef80
-  data.tar.gz: 20de81281c3a7291570bf4d0cabef7b995806cca
+  metadata.gz: 21f670d087989c2099520be07dd3e1204a9c2eef
+  data.tar.gz: 3fbfee83973b73b19496f8c8bd74dd2ecbd8e09d
 SHA512:
-  metadata.gz: 86f4f302fdf25c27e572f08c2ec7424f52d24c87f8e125cb511e88572645e2f04a507a8aafcb82642acc73f74466695267662262cad34fc6964e9a131964dd4d
-  data.tar.gz: 35606932eacff700e806a9cb68d629e2f0eff6d27752248f6b6c1c348772d3d7c568c3f2345c2302b112fbfb4b33b624f47ba5ec404c027262e9faac2f1a64e2
+  metadata.gz: 11595711e242836e3328f7f0b1f4ef3ab54d60b561c2507052ddc74b0209f323f6fe04e5c96a1525026e055745b5f3a3eb86fee550e70bcb0df7cdfafc9a902e
+  data.tar.gz: 0367b7abdc0e048bc0cbcb7fbb7f324520952ed13b0b4de3e4eea87cc6bafae900ff0bbf3cb97baa9ff7be89d8f0f93910cd840de9e362012c0aa4f3673a95f3

data/README.md

@@ -45,6 +45,8 @@ We keep all of the end-user documentation at [http://danger.systems](http://dang
 
 Some quick links: [Guides Index](http://danger.systems/guides.html), [DSL Reference](http://danger.systems/reference.html), [Getting Started](http://danger.systems/guides/getting_started.html) and [What does Danger Do?](http://danger.systems/guides/what_does_danger_do.html).
 
+Sidenote: There is a [pure JS version](https://github.com/danger/danger-js) in the works, it's at the point where it can fail your build but that's about it for now, would love help there if it interests you.
+
 ## I'm here to help out!
 
 Brilliant. So, let's get you set up.

data/lib/danger/ci_source/jenkins.rb

@@ -17,6 +17,12 @@ module Danger
   #
   # With that set up, you can edit your job to add `bundle exec danger` at the build action.
   #
+  # ##### Pipeline
+  # If your're using [pipelines](https://jenkins.io/solutions/pipeline/) you should be using the [GitHub branch source plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+Branch+Source+Plugin)
+  # for easy setup and handling of PRs.
+  #
+  # After you've set up the plugin, add a `sh 'bundle exec danger'` line in your pipeline script and make sure that build PRs is enabled.
+  #
   # #### GitLab
   # You will want to be using the [GitLab Plugin](https://github.com/jenkinsci/gitlab-plugin)
   # in order to ensure that you have the build environment set up for MR integration.
@@ -53,7 +59,7 @@ module Danger
     end
 
     def initialize(env)
-      self.repo_url = env.fetch("GIT_URL_1") { env["GIT_URL"] }
+      self.repo_url = self.class.repo_url(env)
       self.pull_request_id = self.class.pull_request_id(env)
 
       repo_matches = self.repo_url.match(%r{([\/:])([^\/]+\/[^\/.]+)(?:.git)?$})
@@ -63,9 +69,34 @@ module Danger
     def self.pull_request_id(env)
       if env["ghprbPullId"]
         env["ghprbPullId"]
+      elsif env["CHANGE_ID"]
+        env["CHANGE_ID"]
       else
         env["gitlabMergeRequestId"]
       end
     end
+
+    def self.repo_url(env)
+      if env["GIT_URL_1"]
+        env["GIT_URL_1"]
+      elsif env["CHANGE_URL"]
+        change_url = env["CHANGE_URL"]
+        case change_url
+        when %r{\/pull\/} # GitHub
+          matches = change_url.match(%r{(.+)\/pull\/[0-9]+})
+          matches[1] unless matches.nil?
+        when %r{\/merge_requests\/} # GitLab
+          matches = change_url.match(%r{(.+)\/merge_requests\/[0-9]+})
+          matches[1] unless matches.nil?
+        when %r{\/pull-requests\/} # Bitbucket
+          matches = change_url.match(%r{(.+)\/pull-requests\/[0-9]+})
+          matches[1] unless matches.nil?
+        else
+          change_url
+        end
+      else
+        env["GIT_URL"]
+      end
+    end
   end
 end

data/lib/danger/ci_source/local_git_repo.rb

@@ -2,10 +2,15 @@
 
 require "git"
 require "uri"
-require "danger/ci_source/support/remote_finder"
-require "danger/ci_source/support/merged_pull_request_finder"
+
 require "danger/request_sources/github"
 
+require "danger/ci_source/support/find_repo_info_from_url"
+require "danger/ci_source/support/find_repo_info_from_logs"
+require "danger/ci_source/support/no_repo_info"
+require "danger/ci_source/support/pull_request_finder"
+require "danger/ci_source/support/commits"
+
 module Danger
   # ignore
   class LocalGitRepo < CI
@@ -31,29 +36,82 @@ module Danger
       @supported_request_sources ||= [Danger::RequestSources::GitHub]
     end
 
-    def print_repo_slug_warning
-      puts "Danger local requires a repository hosted on GitHub.com or GitHub Enterprise.".freeze
+    def initialize(env = {})
+      @env = env
+
+      self.repo_slug = remote_info.slug
+      raise_error_for_missing_remote if remote_info.kind_of?(NoRepoInfo)
+
+      self.pull_request_id = found_pull_request.pull_request_id
+
+      if sha
+        self.base_commit = commits.base
+        self.head_commit = commits.head
+      else
+        self.base_commit = found_pull_request.base
+        self.head_commit = found_pull_request.head
+      end
     end
 
-    def parents(sha)
-      @parents ||= run_git("rev-list --parents -n 1 #{sha}").strip.split(" ".freeze)
+    private
+
+    attr_reader :env
+
+    def raise_error_for_missing_remote
+      raise missing_remote_error_message
     end
 
-    def initialize(env = {})
-      repo_slug = RemoteFinder.new(
-        env["DANGER_GITHUB_HOST"] || "github.com".freeze,
-        run_git("remote show origin -n".freeze)
-      ).call
-
-      pull_request_id, sha = MergedPullRequestFinder.new(
-        env.fetch("LOCAL_GIT_PR_ID") { "" },
-        run_git("log --oneline -1000000".freeze)
-      ).call
-
-      self.repo_slug = repo_slug ? repo_slug : print_repo_slug_warning
-      self.pull_request_id = pull_request_id
-      self.base_commit = parents(sha)[0]
-      self.head_commit = parents(sha)[1]
+    def missing_remote_error_message
+      "danger cannot find your git remote, please set a remote. " \
+      "And the repository must host on GitHub.com or GitHub Enterprise."
+    end
+
+    def remote_info
+      @_remote_info ||= begin
+        remote_info = begin
+          if given_pull_request_url?
+            FindRepoInfoFromURL.new(env["LOCAL_GIT_PR_URL"]).call
+          else
+            FindRepoInfoFromLogs.new(
+              env["DANGER_GITHUB_HOST"] || "github.com".freeze,
+              run_git("remote show origin -n".freeze)
+            ).call
+          end
+        end
+
+        remote_info || NoRepoInfo.new
+      end
+    end
+
+    def found_pull_request
+      @_found_pull_request ||= begin
+        if given_pull_request_url?
+          PullRequestFinder.new(
+            remote_info.id,
+            remote_info.slug,
+            remote: true
+          ).call
+        else
+          PullRequestFinder.new(
+            env.fetch("LOCAL_GIT_PR_ID") { "".freeze },
+            remote_info.slug,
+            remote: false,
+            git_logs: run_git("log --oneline -1000000".freeze)
+          ).call
+        end
+      end
+    end
+
+    def given_pull_request_url?
+      env["LOCAL_GIT_PR_URL"] && !env["LOCAL_GIT_PR_URL"].empty?
+    end
+
+    def sha
+      @_sha ||= found_pull_request.sha
+    end
+
+    def commits
+      @_commits ||= Commits.new(run_git("rev-list --parents -n 1 #{sha}"))
     end
   end
 end

data/lib/danger/ci_source/support/commits.rb

@@ -0,0 +1,17 @@
+class Commits
+  def initialize(base_head)
+    @base_head = base_head.strip.split(" ".freeze)
+  end
+
+  def base
+    base_head.first
+  end
+
+  def head
+    base_head.last
+  end
+
+  private
+
+  attr_reader :base_head
+end

data/lib/danger/ci_source/support/find_repo_info_from_logs.rb

@@ -0,0 +1,35 @@
+require "danger/ci_source/support/repo_info"
+
+module Danger
+  class FindRepoInfoFromLogs
+    def initialize(github_host, remote_logs)
+      @github_host = github_host
+      @remote_logs = remote_logs
+    end
+
+    def call
+      matched = remote.match(regexp)
+
+      if matched
+        RepoInfo.new(matched["repo_slug"], nil)
+      end
+    end
+
+    private
+
+    attr_reader :remote_logs, :github_host
+
+    def remote
+      remote_logs.lines.grep(/Fetch URL/)[0].split(": ".freeze, 2)[1]
+    end
+
+    def regexp
+      %r{
+        #{Regexp.escape(github_host)}
+        (:|/|(:/))
+        (?<repo_slug>[^/]+/.+?)
+        (?:\.git)?$
+      }x
+    end
+  end
+end

data/lib/danger/ci_source/support/find_repo_info_from_url.rb

@@ -0,0 +1,27 @@
+require "danger/ci_source/support/repo_info"
+
+module Danger
+  class FindRepoInfoFromURL
+    REGEXP = %r{
+      (?<slug>[^/]+/[^/]+)
+      (/(pull|merge_requests|pull-requests)/)
+      (?<id>\d+)
+    }x
+
+    def initialize(url)
+      @url = url
+    end
+
+    def call
+      matched = url.match(REGEXP)
+
+      if matched
+        RepoInfo.new(matched[:slug], matched[:id])
+      end
+    end
+
+    private
+
+    attr_reader :url
+  end
+end

data/lib/danger/ci_source/support/local_pull_request.rb

@@ -0,0 +1,20 @@
+module Danger
+  class LocalPullRequest
+    attr_reader :pull_request_id, :sha
+
+    def initialize(log_line)
+      @log_line = log_line
+
+      @pull_request_id = log_line.match(/#(?<id>[0-9]+)/)[:id]
+      @sha = log_line.split(" ".freeze).first
+    end
+
+    def valid?
+      pull_request_id && sha
+    end
+
+    private
+
+    attr_reader :log_line
+  end
+end

data/lib/danger/ci_source/support/no_pull_request.rb

@@ -0,0 +1,7 @@
+module Danger
+  class NoPullRequest
+    def valid?
+      false
+    end
+  end
+end

data/lib/danger/ci_source/support/no_repo_info.rb

@@ -0,0 +1,5 @@
+module Danger
+  class NoRepoInfo
+    attr_reader :slug, :id
+  end
+end

data/lib/danger/ci_source/support/{merged_pull_request_finder.rb → pull_request_finder.rb}

@@ -1,25 +1,82 @@
+require "danger/ci_source/support/local_pull_request"
+require "danger/ci_source/support/remote_pull_request"
+require "danger/ci_source/support/no_pull_request"
+
 module Danger
-  class MergedPullRequestFinder
-    def initialize(specific_pull_request_id, git_logs)
+  class PullRequestFinder
+    def initialize(specific_pull_request_id, repo_slug = nil, remote: false, git_logs: "")
       @specific_pull_request_id = specific_pull_request_id
       @git_logs = git_logs
+      @repo_slug = repo_slug
+      @remote = to_boolean(remote)
     end
 
     def call
-      check_if_any_merged_pull_request!
+      check_if_any_pull_request!
 
-      [merged_pull_request_id, merged_pull_request_sha]
+      pull_request
     end
 
     private
 
-    attr_reader :specific_pull_request_id, :git_logs
+    attr_reader :specific_pull_request_id, :git_logs, :repo_slug, :remote
+
+    def to_boolean(maybe_string)
+      if ["true", "1", "yes", "y", true].include?(maybe_string)
+        true
+      else
+        false
+      end
+    end
+
+    def check_if_any_pull_request!
+      unless pull_request.valid?
+        if !specific_pull_request_id.empty?
+          raise "Could not find the Pull Request (#{specific_pull_request_id}) inside the git history for this repo."
+        else
+          raise "No recent Pull Requests found for this repo, danger requires at least one Pull Request for the local mode.".freeze
+        end
+      end
+    end
+
+    # @return [String] Log line of most recent merged Pull Request
+    def pull_request
+      @pull_request ||= begin
+        return if pull_request_ref.empty?
+
+        if both_present?
+          LocalPullRequest.new(pick_the_most_recent_one_from_two_matches)
+        elsif only_merged_pull_request_present?
+          LocalPullRequest.new(most_recent_merged_pull_request)
+        elsif only_squash_and_merged_pull_request_present?
+          LocalPullRequest.new(most_recent_squash_and_merged_pull_request)
+        elsif remote && remote_pull_request
+          RemotePullRequest.new(
+            remote_pull_request.number.to_s,
+            remote_pull_request.head.sha,
+            remote_pull_request.base.sha
+          )
+        else
+          NoPullRequest.new
+        end
+      end
+    end
 
     # @return [String] "#42"
     def pull_request_ref
       !specific_pull_request_id.empty? ? "##{specific_pull_request_id}" : "#\\d+".freeze
     end
 
+    def remote_pull_request
+      @_remote_pull_request ||= begin
+        client.pull_request(repo_slug, specific_pull_request_id)
+      end
+    end
+
+    def both_present?
+      most_recent_merged_pull_request && most_recent_squash_and_merged_pull_request
+    end
+
     # @return [String] Log line of format: "Merge pull request #42"
     def most_recent_merged_pull_request
       @most_recent_merged_pull_request ||= begin
@@ -34,23 +91,17 @@ module Danger
       end
     end
 
-    # @return [String] Log line of most recent merged Pull Request
-    def merged_pull_request
-      return if pull_request_ref.empty?
+    def pick_the_most_recent_one_from_two_matches
+      merged_index = git_logs.lines.index(most_recent_merged_pull_request)
+      squash_and_merged_index = git_logs.lines.index(most_recent_squash_and_merged_pull_request)
 
-      if both_present?
-        pick_the_most_recent_one_from_two_matches
-      elsif only_merged_pull_request_present?
-        most_recent_merged_pull_request
-      elsif only_squash_and_merged_pull_request_present?
+      if merged_index > squash_and_merged_index # smaller index is more recent
         most_recent_squash_and_merged_pull_request
+      else
+        most_recent_merged_pull_request
       end
     end
 
-    def both_present?
-      most_recent_merged_pull_request && most_recent_squash_and_merged_pull_request
-    end
-
     def only_merged_pull_request_present?
       return false if most_recent_squash_and_merged_pull_request
 
@@ -63,33 +114,9 @@ module Danger
       !most_recent_squash_and_merged_pull_request.nil? && !most_recent_squash_and_merged_pull_request.empty?
     end
 
-    def pick_the_most_recent_one_from_two_matches
-      merged_index = git_logs.lines.index(most_recent_merged_pull_request)
-      squash_and_merged_index = git_logs.lines.index(most_recent_squash_and_merged_pull_request)
-
-      if merged_index > squash_and_merged_index # smaller index is more recent
-        most_recent_squash_and_merged_pull_request
-      else
-        most_recent_merged_pull_request
-      end
-    end
-
-    def check_if_any_merged_pull_request!
-      if merged_pull_request.to_s.empty?
-        if !specific_pull_request_id.empty?
-          raise "Could not find the Pull Request (#{specific_pull_request_id}) inside the git history for this repo."
-        else
-          raise "No recent Pull Requests found for this repo, danger requires at least one Pull Request for the local mode.".freeze
-        end
-      end
-    end
-
-    def merged_pull_request_id
-      merged_pull_request.match(/#(?<id>[0-9]+)/)[:id]
-    end
-
-    def merged_pull_request_sha
-      merged_pull_request.split(" ".freeze).first
+    def client
+      require "octokit"
+      Octokit::Client.new(access_token: ENV["DANGER_GITHUB_API_TOKEN"])
     end
   end
 end

data/lib/danger/ci_source/support/remote_pull_request.rb

@@ -0,0 +1,15 @@
+module Danger
+  class RemotePullRequest
+    attr_reader :pull_request_id, :sha, :head, :base
+
+    def initialize(pull_request_id, head, base)
+      @pull_request_id = pull_request_id
+      @head = head
+      @base = base
+    end
+
+    def valid?
+      pull_request_id && head && base
+    end
+  end
+end

data/lib/danger/ci_source/support/repo_info.rb

@@ -0,0 +1,10 @@
+module Danger
+  class RepoInfo
+    attr_reader :slug, :id
+
+    def initialize(slug, id)
+      @slug = slug
+      @id = id
+    end
+  end
+end

data/lib/danger/commands/dangerfile/gem.rb

@@ -0,0 +1,43 @@
+require "claide_plugin"
+require "danger/commands/dangerfile/init"
+
+module Danger
+  class DangerfileGem < DangerfileCommand
+    self.summary = "Create a gem-based Dangerfile quickly."
+    def self.description
+      <<-DESC
+                Creates a scaffold for the development of a new gem based Dangerfile
+                named `NAME` according to the best practices.
+      DESC
+    end
+    self.command = "gem"
+    self.arguments = [
+      CLAide::Argument.new("NAME", true)
+    ]
+
+    def initialize(argv)
+      @name = argv.shift_argument
+      prefix = "dangerfile" + "-"
+      unless @name.nil? || @name.empty? || @name.start_with?(prefix)
+        @name = prefix + @name.dup
+      end
+      @template_url = argv.shift_argument
+      super
+    end
+
+    def validate!
+      super
+      if @name.nil? || @name.empty?
+        help! "A name for the plugin is required."
+      end
+
+      help! "The plugin name cannot contain spaces." if @name =~ /\s/
+    end
+
+    def run
+      runner = CLAide::TemplateRunner.new(@name, "https://github.com/danger/dangerfile-gem-template")
+      runner.clone_template
+      runner.configure_template
+    end
+  end
+end

data/lib/danger/commands/dangerfile/init.rb

@@ -0,0 +1,30 @@
+require "danger/danger_core/dangerfile_generator"
+
+# Mainly so we can have a nice strucutre for commands
+
+module Danger
+  class DangerfileCommand < Runner
+    self.summary = "Easily create you Dangerfiles."
+    self.command = "dangerfile"
+
+    self.abstract_command = true
+    def self.options
+      []
+    end
+  end
+end
+
+# Just a less verbose way of doing the Dangerfile from `danger init`.
+
+module Danger
+  class DangerfileInit < DangerfileCommand
+    self.summary = "Create an example Dangerfile."
+    self.command = "init"
+
+    def run
+      content = DangerfileGenerator.create_dangerfile(".", cork)
+      File.write("Dangerfile", content)
+      cork.puts "Created" + "./Dangerfile".green
+    end
+  end
+end

data/lib/danger/commands/init.rb

@@ -1,4 +1,5 @@
 require "danger/commands/init_helpers/interviewer"
+require "danger/danger_core/dangerfile_generator"
 require "danger/ci_source/local_git_repo"
 require "yaml"
 
@@ -53,8 +54,7 @@ module Danger
     end
 
     def setup_dangerfile
-      dir = Danger.gem_path
-      content = File.read(File.join(dir, "lib", "assets", "DangerfileTemplate"))
+      content = DangerfileGenerator.create_dangerfile(".", cork)
       File.write("Dangerfile", content)
 
       ui.header "Step 1: Creating a starter Dangerfile"