danger 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b3337b2e55d499b082ba5f7aed4f5216e95349c
-  data.tar.gz: c1bfe7f5a5de81631266d4afa0d82ca8d8f8b31d
+  metadata.gz: 00d92eed49b5e7fc0093a196fead65e3e9f6eaa8
+  data.tar.gz: bd6ed16e33d9127c511018c3b55d4cf68db67524
 SHA512:
-  metadata.gz: 5ab6e3ef7b0db9db6032a2dbaea15d41ea56c7fdbc552677298cbd9c6587bb99346ad022b494f07917059a024252d785eff6ed0a821412c480f47bd715fb7c32
-  data.tar.gz: 714c8816a1fe0c8965460266f129589a8064b57dd0c601ed8b91f312a92e0e6bde6d522aa14f135efc2cc33e96047201aa1e36d2115f4a7bb34a77679c3424d0
+  metadata.gz: d10ab63bf1fd7f244187c854b2ae092b8dbb20f73ba61d8041375476dfd2b5d8cf80c5a778fe9d20b41a8b8539c62c2b83a2400eb79f5cebb1042d6cb1aab358
+  data.tar.gz: 3a94d29282e62e9396508fd8ad9563202c160d3e81cdc201d45567f40af465c07d6a774c0812ee899fde63ddf79f9d55408449685a84ffbcaff0884a9ab1d678

data/README.md

@@ -5,15 +5,15 @@
 
 Formalize your Pull Request etiquette.
 
-*Note:* Not ready for public usage yet. Work in progress
+*Note:* Not ready for public usage yet - unless you're willing to look inside the codebase. This is a Work in progress, though it is active use on [Artsy/Eigen](https://github.com/artsy/eigen/) and [fastlane/fastlane-core](https://github.com/fastlane/fastlane_core).
 
 -------
 <p align="center">
-    <a href="#installation">Installation</a> &bull; 
-    <a href="#usage">Usage</a> &bull; 
-    <a href="#dsl">DSL</a> &bull; 
-    <a href="#constraints">Constraints</a> &bull; 
-    <a href="#advanced">Advanced</a> &bull; 
+    <a href="#installation">Installation</a> &bull;
+    <a href="#usage">Usage</a> &bull;
+    <a href="#dsl">DSL</a> &bull;
+    <a href="#constraints">Constraints</a> &bull;
+    <a href="#advanced">Advanced</a> &bull;
     <a href="#contributing">Contributing</a>
 </p>
 
@@ -48,6 +48,7 @@ In CI run `bundle exec danger`.  This will look at your `Dangerfile` and provide
 :abc:  | `pr_title` | The title of the PR
 :book:  | `pr_body` | The body of the PR
 :busts_in_silhouette:  | `pr_author` | The author who submitted the PR
+:bookmark: | `pr_labels` | The labels added to the PR
 
 You can then create a `Dangerfile` like the following:
 
@@ -71,7 +72,6 @@ warn("Author @#{pr_author} is not a contributor") unless ["KrauseFx", "orta"].in
 ## Constraints
 
 * **GitHub** - Built with same-repo PRs in mind
-* **Git** - Built with master as the merge branch
 
 ## Advanced
 
@@ -83,10 +83,15 @@ You can access more detailed information by accessing the following variables
 `env.scm.diff` | The full [GitDiff](https://github.com/schacon/ruby-git/blob/master/lib/git/diff.rb) file for the diff.
 `env.ci_source` | To get information like the repo slug or pull request ID
 
-## Special Thanks
+## Test locally with `danger local`
 
-Thanks [@orta](https://twitter.com/orta) for starting this project
+Using `danger local` will look for the last merged pull request in your git history, and apply your current
+`Dangerfile` against that Pull Request. Useful when editing.
+
+## Useful bits of knowledge ATM
+
+* You can set the base branch in the command line arguments see: `bundle exec danger --help`.
 
 ## License
 
-> This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs. 
+> This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs.

data/lib/danger/available_values.rb

@@ -20,7 +20,8 @@ module Danger
       [
         :pr_title,
         :pr_body,
-        :pr_author
+        :pr_author,
+        :pr_labels
       ]
     end
   end

data/lib/danger/ci_source/circle.rb

@@ -1,20 +1,47 @@
 # https://circleci.com/docs/environment-variables
 require 'uri'
+require 'danger/circle_api'
 
 module Danger
   module CISource
     class CircleCI < CI
       def self.validates?(env)
-        return !env["CIRCLE_BUILD_NUM"].nil? &&
-          !env["CI_PULL_REQUEST"].nil? &&
-          URI.parse(env["CI_PULL_REQUEST"]).path.split("/").count == 5
+        return false if env["CIRCLE_BUILD_NUM"].nil?
+        return true unless env["CI_PULL_REQUEST"].nil?
+
+        return !env["CIRCLE_PROJECT_USERNAME"].nil? && !env["CIRCLE_PROJECT_REPONAME"].nil?
+      end
+
+      def client
+        @client ||= CircleAPI.new(@circle_token)
+      end
+
+      def fetch_pull_request_url(repo_slug, build_number)
+        build_json = client.fetch_build(repo_slug, build_number)
+        build_json[:pull_request_urls].first
+      end
+
+      def pull_request_url(env)
+        url = env["CI_PULL_REQUEST"]
+
+        if url.nil? && !env["CIRCLE_PROJECT_USERNAME"].nil? && !env["CIRCLE_PROJECT_REPONAME"].nil?
+          repo_slug = env["CIRCLE_PROJECT_USERNAME"] + "/" + env["CIRCLE_PROJECT_REPONAME"]
+          url = fetch_pull_request_url(repo_slug, env["CIRCLE_BUILD_NUM"])
+        end
+
+        url
       end
 
       def initialize(env)
-        paths = URI.parse(env["CI_PULL_REQUEST"]).path.split("/")
-        # The first one is an extra slash, ignore it
-        self.repo_slug = paths[1] + "/" + paths[2]
-        self.pull_request_id = paths[4]
+        @circle_token = env["CIRCLE_CI_API_TOKEN"]
+        url = pull_request_url(env)
+
+        if URI.parse(url).path.split("/").count == 5
+          paths = URI.parse(url).path.split("/")
+          # The first one is an extra slash, ignore it
+          self.repo_slug = paths[1] + "/" + paths[2]
+          self.pull_request_id = paths[4]
+        end
       end
     end
   end

data/lib/danger/ci_source/local_git_repo.rb

@@ -0,0 +1,42 @@
+# For more info see: https://github.com/schacon/ruby-git
+
+require 'git'
+require 'uri'
+
+module Danger
+  module CISource
+    class LocalGitRepo < CI
+      attr_accessor :base_commit, :head_commit
+
+      def self.validates?(env)
+        return !env["DANGER_USE_LOCAL_GIT"].nil?
+      end
+
+      def initialize(*)
+        git = Git.open(".")
+        if git.remote("origin")
+          url = git.remote("origin").url
+          # deal with https://
+          if url.start_with? "https://github.com/"
+            self.repo_slug = url.gsub("https://github.com/", "").gsub(".git", '')
+
+          # deal with SSH origin
+          elsif url.start_with? "git@github.com:"
+            self.repo_slug = url.gsub("git@github.com:", "").gsub(".git", '')
+          end
+        end
+
+        logs = git.log.since('2 weeks ago')
+        # Look for something like
+        # "Merge pull request #38 from KrauseFx/funky_circles\n\nAdd support for GitHub compare URLs that don't conform
+        pr_merge = logs.detect { |log| (/Merge pull request #[0-9]* from/ =~ log.message) == 0 }
+        if pr_merge
+          # then pull out the 38, to_i
+          self.pull_request_id = pr_merge.message.gsub("Merge pull request #", "").to_i
+          self.base_commit = pr_merge.parents[0].sha
+          self.head_commit = pr_merge.parents[1].sha
+        end
+      end
+    end
+  end
+end

data/lib/danger/circle_api.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+
+module Danger
+  class CircleAPI
+    attr_accessor :circle_token
+
+    def initialize(circle_token = nil)
+      self.circle_token = circle_token
+    end
+
+    def client
+      @client ||= Faraday.new(url: 'https://circleci.com/api/v1')
+    end
+
+    def fetch_build(repo_slug, build_number)
+      url = "project/#{repo_slug}/#{build_number}"
+      params = { :'circle-token' => circle_token }
+      response = client.get url, params, accept: 'application/json'
+      json = JSON.parse(response.body, symbolize_names: true)
+      json
+    end
+  end
+end

data/lib/danger/{init.rb → commands/init.rb}

@@ -1,5 +1,5 @@
 module Danger
-  class Init < Danger::Runner
+  class Init < Runner
     self.description = 'Creates a Dangerfile.'
     self.command = 'init'
 

data/lib/danger/commands/local.rb

@@ -0,0 +1,52 @@
+module Danger
+  class Local < Runner
+    self.description = 'Run the Dangerfile locally.'
+    self.command = 'local'
+
+    def initialize(argv)
+      @dangerfile_path = "Dangerfile" if File.exist? "Dangerfile"
+      super
+    end
+
+    def validate!
+      super
+      unless @dangerfile_path
+        help! "Could not find a Dangerfile."
+      end
+    end
+
+    def run
+      ENV["DANGER_USE_LOCAL_GIT"] = "YES"
+
+      dm = Dangerfile.new
+      dm.env = EnvironmentManager.new(ENV)
+
+      source = dm.env.ci_source
+      unless source.repo_slug
+        puts "danger local".red " failed because it only works with GitHub projects at the moment. Sorry."
+        exit 0
+      end
+
+      puts "Running your Dangerfile against this PR - https://github.com/#{source.repo_slug}/pulls/#{source.pull_request_id}"
+
+      if verbose != true
+        puts "Turning on --verbose"
+        dm.verbose = true
+      end
+
+      puts ""
+
+      gh = GitHub.new(dm.env.ci_source, ENV)
+      # We can use tokenless here, as it's running on someone's computer
+      # and is IP locked, as opposed  to on the CI.
+      gh.support_tokenless_auth = true
+      gh.fetch_details
+
+      dm.env.request_source = gh
+
+      dm.env.scm = GitRepo.new
+      dm.env.scm.diff_for_folder(".", dm.env.ci_source.base_commit, dm.env.ci_source.head_commit)
+      dm.parse Pathname.new(@dangerfile_path)
+    end
+  end
+end

data/lib/danger/{runner.rb → commands/runner.rb}

@@ -1,10 +1,15 @@
 module Danger
   class Runner < CLAide::Command
+    require 'danger/commands/init'
+    require 'danger/commands/local'
+
     self.description = 'Run the Dangerfile.'
     self.command = 'danger'
 
     def initialize(argv)
       @dangerfile_path = "Dangerfile" if File.exist? "Dangerfile"
+      @base = argv.option('base')
+      @head = argv.option('head')
       super
     end
 
@@ -15,13 +20,26 @@ module Danger
       end
     end
 
+    def self.options
+      [
+        ['--base=[master|dev|stable]', 'A branch/tag/commit to use as the base of the diff'],
+        ['--head=[master|dev|stable]', 'A branch/tag/commit to use as the head']
+      ].concat(super)
+    end
+
     def run
       # The order of the following commands is *really* important
       dm = Dangerfile.new
+      dm.verbose = verbose
       dm.env = EnvironmentManager.new(ENV)
       return unless dm.env.ci_source # if it's not a PR
       dm.env.fill_environment_vars
-      dm.env.scm.diff_for_folder(".")
+
+      gh = dm.env.request_source
+      ci_base = @base || gh.base_commit
+      ci_head = @head || gh.head_commit
+
+      dm.env.scm.diff_for_folder(".", ci_base, ci_head)
       dm.parse Pathname.new(@dangerfile_path)
 
       post_results(dm)

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

@@ -9,6 +9,6 @@
   <% end %>
 <% end %>
 
-<p align="right" meta="generated_by_danger">
+<p align="right" data-meta="generated_by_danger" data-base-commit="<%= @base_commit %>" data-head-commit="<%= @head_commit %>" >
   Generated by :no_entry_sign: <a href="https://github.com/KrauseFx/danger/">danger</a>
 </p>

data/lib/danger/dangerfile.rb

@@ -7,7 +7,7 @@ module Danger
   class Dangerfile
     include Danger::Dangerfile::DSL
 
-    attr_accessor :env, :warnings, :errors, :messages
+    attr_accessor :env, :warnings, :errors, :messages, :verbose
 
     # @return [Pathname] the path where the Dangerfile was loaded from. It is nil
     #         if the Dangerfile was generated programmatically.
@@ -21,9 +21,33 @@ module Danger
       'Dangerfile'
     end
 
+    # Iterates through the DSL's attributes, and table's the output
+    def print_known_info
+      puts "Danger v#{Danger::VERSION}"
+      width = AvailableValues.all.map(&:to_s).map(&:length).max
+      puts "DSL Attributes:"
+      puts "-" * (width + 4)
+      AvailableValues.all.each do |value|
+        spaces = (width - value.to_s.length)
+        puts "| #{value.to_s.blue}#{' ' * spaces} | #{self.send(value)}"
+      end
+      puts "-" * (width + 4)
+
+      puts "Metadata:"
+      puts "#{'SCM'.blue}      : #{env.scm.class}"
+      puts "#{'Source'.blue}   : #{env.ci_source.class}"
+      puts "#{'Requests'.blue} : #{env.request_source.class}"
+      puts "           #{'Base commit'.blue} : #{env.request_source.base_commit}"
+      puts "           #{'HEAD commit'.blue} : #{env.request_source.head_commit}"
+      puts "           git diff  #{env.request_source.base_commit} #{env.request_source.head_commit}".yellow
+      puts "\n\n"
+    end
+
     # Parses the file at a path, optionally takes the content of the file for DI
     #
     def parse(path, contents = nil)
+      print_known_info if verbose
+
       contents ||= File.open(path, 'r:utf-8', &:read)
 
       # Work around for Rubinius incomplete encoding in 1.9 mode

data/lib/danger/dangerfile_dsl.rb

@@ -42,6 +42,9 @@ module Danger
         puts "Printing message '#{message}'"
       end
 
+      # When an undefined method is called, we check to see if it's something
+      # that either the `scm` or the `request_source` can handle.
+      # This opens us up to letting those object extend themselves naturally.
       def method_missing(method_sym, *_arguments, &_block)
         unless AvailableValues.all.include?(method_sym)
           raise "Unknown method '#{method_sym}', please check out the documentation for available variables".red

data/lib/danger/request_sources/github.rb

@@ -6,16 +6,19 @@ require 'octokit'
 
 module Danger
   class GitHub
-    attr_accessor :ci_source, :pr_json, :environment
+    attr_accessor :ci_source, :pr_json, :issue_json, :environment, :base_commit, :head_commit, :support_tokenless_auth
 
     def initialize(ci_source, environment)
       self.ci_source = ci_source
       self.environment = environment
+      self.support_tokenless_auth = false
+
+      Octokit.auto_paginate = true
     end
 
     def client
       token = @environment["DANGER_GITHUB_API_TOKEN"]
-      raise "No API given, please provide one using `DANGER_GITHUB_API_TOKEN`" unless token
+      raise "No API given, please provide one using `DANGER_GITHUB_API_TOKEN`" if !token && !support_tokenless_auth
 
       @client ||= Octokit::Client.new(
         access_token: token
@@ -24,9 +27,19 @@ module Danger
 
     def fetch_details
       self.pr_json = client.pull_request(ci_source.repo_slug, ci_source.pull_request_id)
+      fetch_issue_details(self.pr_json)
+    end
+
+    def fetch_issue_details(pr_json)
+      href = pr_json[:_links][:issue][:href]
+      self.issue_json = client.get(href)
     end
 
-    def latest_pr_commit_ref
+    def base_commit
+      self.pr_json[:base][:sha]
+    end
+
+    def head_commit
       self.pr_json[:head][:sha]
     end
 
@@ -42,6 +55,10 @@ module Danger
       self.pr_json[:user][:login]
     end
 
+    def pr_labels
+      self.issue_json[:labels].map { |l| l[:name] }
+    end
+
     # Sending data to GitHub
     def update_pull_request!(warnings: nil, errors: nil, messages: nil)
       comment_result = {}

data/lib/danger/scm_source/git_repo.rb

@@ -1,4 +1,4 @@
-# https://github.com/schacon/ruby-git
+# For more info see: https://github.com/schacon/ruby-git
 
 require 'git'
 
@@ -6,9 +6,9 @@ module Danger
   class GitRepo
     attr_accessor :diff
 
-    def diff_for_folder(folder, from = "HEAD", to = 'master')
+    def diff_for_folder(folder, from = "master", to = 'HEAD')
       g = Git.open(folder)
-      self.diff = g.diff(to, from)
+      self.diff = g.diff(from, to)
     end
 
     def files_modified

data/lib/danger/version.rb

@@ -1,4 +1,4 @@
 module Danger
-  VERSION = "0.2.1"
-  DESCRIPTION = "Ensure your pull request is up to standard with a nice DSL"
+  VERSION = "0.3.0"
+  DESCRIPTION = "Automate your PR etiquette."
 end

data/lib/danger.rb

@@ -1,8 +1,7 @@
 require "danger/version"
 require "danger/dangerfile"
 require "danger/environment_manager"
-require "danger/runner"
-require "danger/init"
+require "danger/commands/runner"
 require "danger/available_values"
 
 require "claide"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Orta Therox
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: claide
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -155,16 +155,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.35.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.35.1
 description: Create a Dangerfile to introspect your pull request in CI, makes it easy
   to enforce social conventions like changelogs and tests.
 email:
@@ -184,14 +184,17 @@ files:
 - lib/danger/ci_source/buildkite.rb
 - lib/danger/ci_source/ci_source.rb
 - lib/danger/ci_source/circle.rb
+- lib/danger/ci_source/local_git_repo.rb
 - lib/danger/ci_source/travis.rb
+- lib/danger/circle_api.rb
+- lib/danger/commands/init.rb
+- lib/danger/commands/local.rb
+- lib/danger/commands/runner.rb
 - lib/danger/comment_generators/github.md.erb
 - lib/danger/dangerfile.rb
 - lib/danger/dangerfile_dsl.rb
 - lib/danger/environment_manager.rb
-- lib/danger/init.rb
 - lib/danger/request_sources/github.rb
-- lib/danger/runner.rb
 - lib/danger/scm_source/git_repo.rb
 - lib/danger/standard_error.rb
 - lib/danger/version.rb
@@ -215,8 +218,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Ensure your pull request is up to standard with a nice DSL
+summary: Automate your PR etiquette.
 test_files: []