danger 2.0.1 → 2.1.0

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

@@ -23,9 +23,15 @@ module Danger
   # @example Warn when there are merge commits in the diff
   #
   #          if commits.any? { |c| c.message =~ /^Merge branch 'master'/ }
-  #             warn 'Please rebase to get rid of the merge commits in this PR'
+  #            warn 'Please rebase to get rid of the merge commits in this PR'
   #          end
   #
+  # @example Warn when somebody tries to add nokogiri to the project
+  #
+  #          diff = git.diff_for_file["Gemfile.lock"]
+  #          if diff && diff.patch =~ "nokogiri"
+  #            warn 'Please do not add nokogiri to the project. Thank you.'
+  #          end
   #
   # @see  danger/danger
   # @tags core, git
@@ -100,5 +106,13 @@ module Danger
     def commits
       @git.log.to_a
     end
+
+    # @!group Git Metadata
+    # Details for a specific file in this diff
+    # @return [Git::Diff::DiffFile] from the gem `git`
+    #
+    def diff_for_file(file)
+      modified_files.include?(file) ? @git.diff[file] : nil
+    end
   end
 end

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

@@ -71,11 +71,16 @@ module Danger
   #
   # @see  danger/danger
   # @tags core, github
-
+  #
   class DangerfileGitHubPlugin < Plugin
+    # So that this init can fail.
+    def self.new(dangerfile)
+      return nil if dangerfile.env.request_source.class != Danger::RequestSources::GitHub
+      super
+    end
+
     def initialize(dangerfile)
       super(dangerfile)
-      return nil unless dangerfile.env.request_source.class == Danger::RequestSources::GitHub
 
       @github = dangerfile.env.request_source
     end
@@ -177,16 +182,23 @@ module Danger
     end
 
     # @!group GitHub Misc
-    # Returns a HTML anchor for a file, or files in the head repository. An example would be:
-    # `<a href='https://github.com/artsy/eigen/blob/561827e46167077b5e53515b4b7349b8ae04610b/file.txt'>file.txt</a>`
+    # Returns a list of HTML anchors for a file, or files in the head repository. An example would be:
+    # `<a href='https://github.com/artsy/eigen/blob/561827e46167077b5e53515b4b7349b8ae04610b/file.txt'>file.txt</a>`. 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)
+    def html_link(paths, full_path: true)
       paths = [paths] unless paths.kind_of?(Array)
       commit = head_commit
       repo = pr_json[:head][:repo][:html_url]
+
       paths = paths.map do |path|
-        path_with_slash = "/#{path}" unless path.start_with? "/"
-        create_link("#{repo}/blob/#{commit}#{path_with_slash}", path)
+        url_path = path.start_with?("/") ? path : "/#{path}"
+        text = full_path ? path : File.basename(path)
+        create_link("#{repo}/blob/#{commit}#{url_path}", text)
       end
 
       return paths.first if paths.count < 2

data/lib/danger/helpers/comments_helper.rb

@@ -0,0 +1,105 @@
+require "redcarpet"
+
+module Danger
+  module Helpers
+    module CommentsHelper
+      def markdown_parser
+        @markdown_parser ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML.new(hard_wrap: true), no_intra_emphasis: true)
+      end
+
+      def parse_tables_from_comment(comment)
+        comment.split("</table>")
+      end
+
+      def violations_from_table(table)
+        regex = %r{<td data-sticky="true">(?:<del>)?(.*?)(?:</del>)?\s*</td>}im
+        table.scan(regex).flatten.map(&:strip)
+      end
+
+      def process_markdown(violation)
+        html = markdown_parser.render(violation.message)
+        # Remove the outer `<p>`, the -5 represents a newline + `</p>`
+        html = html[3...-5] if html.start_with? "<p>"
+        Violation.new(html, violation.sticky)
+      end
+
+      def parse_comment(comment)
+        tables = parse_tables_from_comment(comment)
+        violations = {}
+        tables.each do |table|
+          next unless table =~ %r{<th width="100%"(.*?)</th>}im
+          title = Regexp.last_match(1)
+          kind = table_kind_from_title(title)
+          next unless kind
+
+          violations[kind] = violations_from_table(table)
+        end
+
+        violations.reject { |_, v| v.empty? }
+      end
+
+      def table(name, emoji, violations, all_previous_violations)
+        content = violations.map { |v| process_markdown(v) }.uniq
+        kind = table_kind_from_title(name)
+        previous_violations = all_previous_violations[kind] || []
+        messages = content.map(&:message)
+        resolved_violations = previous_violations.uniq - messages
+        count = content.count
+
+        {
+          name: name,
+          emoji: emoji,
+          content: content,
+          resolved: resolved_violations,
+          count: count
+        }
+      end
+
+      def table_kind_from_title(title)
+        if title =~ /error/i
+          :error
+        elsif title =~ /warning/i
+          :warning
+        elsif title =~ /message/i
+          :message
+        end
+      end
+
+      def generate_comment(warnings: [], errors: [], messages: [], markdowns: [], previous_violations: {}, danger_id: "danger", template: "github")
+        require "erb"
+
+        md_template = File.join(Danger.gem_path, "lib/danger/comment_generators/#{template}.md.erb")
+
+        # erb: http://www.rrn.dk/rubys-erb-templating-system
+        # for the extra args: http://stackoverflow.com/questions/4632879/erb-template-removing-the-trailing-line
+        @tables = [
+          table("Error", "no_entry_sign", errors, previous_violations),
+          table("Warning", "warning", warnings, previous_violations),
+          table("Message", "book", messages, previous_violations)
+        ]
+        @markdowns = markdowns
+        @danger_id = danger_id
+
+        return ERB.new(File.read(md_template), 0, "-").result(binding)
+      end
+
+      def generate_description(warnings: nil, errors: nil)
+        if errors.empty? && warnings.empty?
+          return "All green. #{random_compliment}"
+        else
+          message = "⚠ "
+          message += "#{'Error'.danger_pluralize(errors.count)}. " unless errors.empty?
+          message += "#{'Warning'.danger_pluralize(warnings.count)}. " unless warnings.empty?
+          message += "Don't worry, everything is fixable."
+          return message
+        end
+      end
+
+      def random_compliment
+        compliment = ["Well done.", "Congrats.", "Woo!",
+                      "Yay.", "Jolly good show.", "Good on 'ya.", "Nice work."]
+        compliment.sample
+      end
+    end
+  end
+end

data/lib/danger/plugin_support/plugin_file_resolver.rb

@@ -41,7 +41,7 @@ module Danger
         end
       # When empty, imply you want to test the current lib folder as a plugin
       else
-        Dir.glob(File.join(".", "lib/*.rb")).map { |path| File.expand_path(path) }
+        Dir.glob(File.join(".", "lib/**/*.rb")).map { |path| File.expand_path(path) }
       end
     end
   end

data/lib/danger/plugin_support/plugin_parser.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 =begin
 
@@ -171,7 +171,7 @@ module Danger
         attribute_meths = klass.attributes[:instance].values.map(&:values).flatten
 
         methods = klass.meths - klass.inherited_meths - attribute_meths
-        usable_methods = methods.select { |m| m.visibility == :public }.reject { |m| m.name == :initialize || m.name == :instance_name }
+        usable_methods = methods.select { |m| m.visibility == :public }.reject { |m| m.name == :initialize || m.name == :instance_name || m.name == :new }
 
         plugin_gem = klass.file.include?("gems") ? klass.file.split("gems/").last.split("-")[0..-2].join("-") : nil
         # Pull out the gem's path ( to make relative file paths )

data/lib/danger/plugin_support/templates/readme_table.html.erb

@@ -11,14 +11,16 @@
 
 <%- unless plugin["attributes"].empty? %>
 #### Attributes
-<%- plugin["attributes"].each do |attribute| %><tr>
+<%- plugin["attributes"].each do |attribute| %>
 `<%= attribute.keys.first %>` - <%= attribute.values.first["write"]["body_md"] %>
 <%- end %>
 <%- end %>
 
+<%- unless plugin["methods"].empty? %>
 #### Methods
 <%- plugin["methods"].each do |method| %>
 `<%= method["name"] %>` - <%= method["body_md"] %>
 <%- end %>
+<%- end %>
 
 <% end %>

data/lib/danger/request_source/github.rb

@@ -1,10 +1,12 @@
 # coding: utf-8
 require 'octokit'
-require 'redcarpet'
+require 'danger/helpers/comments_helper'
 
 module Danger
   module RequestSources
     class GitHub < RequestSource
+      include Danger::Helpers::CommentsHelper
+
       attr_accessor :pr_json, :issue_json, :support_tokenless_auth
 
       def initialize(ci_source, environment)
@@ -32,10 +34,6 @@ module Danger
         @client ||= Octokit::Client.new(access_token: @token)
       end
 
-      def markdown_parser
-        @markdown_parser ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML, no_intra_emphasis: true)
-      end
-
       def pr_diff
         @pr_diff ||= client.pull_request(ci_source.repo_slug, ci_source.pull_request_id, accept: 'application/vnd.github.v3.diff')
       end
@@ -93,7 +91,8 @@ module Danger
                                   messages: messages,
                                  markdowns: markdowns,
                        previous_violations: previous_violations,
-                                 danger_id: danger_id)
+                                 danger_id: danger_id,
+                                  template: 'github')
 
           if editable_issues.empty?
             comment_result = client.add_comment(ci_source.repo_slug, ci_source.pull_request_id, body)
@@ -112,7 +111,7 @@ module Danger
 
       def submit_pull_request_status!(warnings: [], errors: [], details_url: [])
         status = (errors.count.zero? ? 'success' : 'failure')
-        message = generate_github_description(warnings: warnings, errors: errors)
+        message = generate_description(warnings: warnings, errors: errors)
 
         latest_pr_commit_ref = self.pr_json[:head][:sha]
 
@@ -154,93 +153,6 @@ module Danger
         end
       end
 
-      def random_compliment
-        compliment = ['Well done.', 'Congrats.', 'Woo!',
-                      'Yay.', 'Jolly good show.', "Good on 'ya.", 'Nice work.']
-        compliment.sample
-      end
-
-      def generate_github_description(warnings: nil, errors: nil)
-        if errors.empty? && warnings.empty?
-          return "All green. #{random_compliment}"
-        else
-          message = "⚠ "
-          message += "#{'Error'.danger_pluralize(errors.count)}. " unless errors.empty?
-          message += "#{'Warning'.danger_pluralize(warnings.count)}. " unless warnings.empty?
-          message += "Don't worry, everything is fixable."
-          return message
-        end
-      end
-
-      def generate_comment(warnings: [], errors: [], messages: [], markdowns: [], previous_violations: {}, danger_id: 'danger')
-        require 'erb'
-
-        md_template = File.join(Danger.gem_path, 'lib/danger/comment_generators/github.md.erb')
-
-        # erb: http://www.rrn.dk/rubys-erb-templating-system
-        # for the extra args: http://stackoverflow.com/questions/4632879/erb-template-removing-the-trailing-line
-        @tables = [
-          table('Error', 'no_entry_sign', errors, previous_violations),
-          table('Warning', 'warning', warnings, previous_violations),
-          table('Message', 'book', messages, previous_violations)
-        ]
-        @markdowns = markdowns
-        @danger_id = danger_id
-
-        return ERB.new(File.read(md_template), 0, '-').result(binding)
-      end
-
-      def table(name, emoji, violations, all_previous_violations)
-        content = violations.map { |v| process_markdown(v) }.uniq
-        kind = table_kind_from_title(name)
-        previous_violations = all_previous_violations[kind] || []
-        messages = content.map(&:message)
-        resolved_violations = previous_violations.uniq - messages
-        count = content.count
-        { name: name, emoji: emoji, content: content, resolved: resolved_violations, count: count }
-      end
-
-      def parse_comment(comment)
-        tables = parse_tables_from_comment(comment)
-        violations = {}
-        tables.each do |table|
-          next unless table =~ %r{<th width="100%"(.*?)</th>}im
-          title = Regexp.last_match(1)
-          kind = table_kind_from_title(title)
-          next unless kind
-
-          violations[kind] = violations_from_table(table)
-        end
-
-        violations.reject { |_, v| v.empty? }
-      end
-
-      def violations_from_table(table)
-        regex = %r{<td data-sticky="true">(?:<del>)?(.*?)(?:</del>)?\s*</td>}im
-        table.scan(regex).flatten.map(&:strip)
-      end
-
-      def table_kind_from_title(title)
-        if title =~ /error/i
-          :error
-        elsif title =~ /warning/i
-          :warning
-        elsif title =~ /message/i
-          :message
-        end
-      end
-
-      def parse_tables_from_comment(comment)
-        comment.split("</table>")
-      end
-
-      def process_markdown(violation)
-        html = markdown_parser.render(violation.message)
-        # Remove the outer `<p>`, the -5 represents a newline + `</p>`
-        html = html[3...-5] if html.start_with? "<p>"
-        Violation.new(html, violation.sticky)
-      end
-
       # @return [String] The organisation name, is nil if it can't be detected
       def organisation
         matched = self.issue_json[:repository_url].match(%r{repos\/(.*)\/})

data/lib/danger/request_source/request_source.rb

@@ -18,7 +18,8 @@ module Danger
         raise "Subclass and overwrite initialize"
       end
 
-      def validates?
+      # What does this do?
+      def validates_as_ci?
         !!self.scm.origins.match(%r{#{Regexp.escape self.host}(:|/)(?<repo_slug>.+/.+?)(?:\.git)?$})
       end
 

data/lib/danger/version.rb

@@ -1,4 +1,4 @@
 module Danger
-  VERSION = "2.0.1".freeze
+  VERSION = "2.1.0".freeze
   DESCRIPTION = "Automate your PR etiquette.".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Orta Therox
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: claide
@@ -340,6 +340,7 @@ files:
 - lib/danger/commands/plugins/plugin_lint.rb
 - lib/danger/commands/plugins/plugin_readme.rb
 - lib/danger/commands/runner.rb
+- lib/danger/commands/systems.rb
 - lib/danger/comment_generators/github.md.erb
 - lib/danger/core_ext/file_list.rb
 - lib/danger/core_ext/string.rb
@@ -353,6 +354,7 @@ files:
 - lib/danger/danger_core/plugins/dangerfile_messaging_plugin.rb
 - lib/danger/danger_core/standard_error.rb
 - lib/danger/danger_core/violation.rb
+- lib/danger/helpers/comments_helper.rb
 - lib/danger/plugin_support/plugin.rb
 - lib/danger/plugin_support/plugin_file_resolver.rb
 - lib/danger/plugin_support/plugin_linter.rb
@@ -382,8 +384,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Automate your PR etiquette.
 test_files: []
+has_rdoc: