danger 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 730a6b52e123cb69852704e92867526da77dcaa3
-  data.tar.gz: c48c217b428923652f446788107c0d140074e967
+  metadata.gz: e02bc78c88ffbdd9d2c7c7b4abd87939c2a76837
+  data.tar.gz: 173e0a2993c408b5b6e53c379239e97228839bc3
 SHA512:
-  metadata.gz: e722f6688e5a65281c751a762fb3f8df5342080a404b15b7ca62c7ec6dcf3ff501dafc4a9f9881c75a5661ca5b64f3aec4309a3dcdcd693a607d24d241c970c9
-  data.tar.gz: 4a205ad49112adbb1980182cabebecb6c79eabdab0da89f70cabd7a58b2cd669c304e9dafa26b107aab6924f09f7700203bdaeac7a0d5a0026bf27ebbe97b5aa
+  metadata.gz: 001cd98d2bd528920fd6aafffea0aca00b41672e32e52588ba30f1eb2e9614cd246bf066f7ced68bbe6ec289f90e0c03774ea8e6d075de1ced383f20909a8854
+  data.tar.gz: 65669c564bcae4590b3bc384b5d3a96c16b74404e48d4489eaef4cc6d17a8a53270db8e5cfa3969579c3bac5176b47187de777f31012b92dcc52b660a5b59591

data/lib/danger/ci_source/local_git_repo.rb

@@ -28,7 +28,7 @@ module Danger
         github_host = env["DANGER_GITHUB_HOST"] || "github.com"
 
         # get the remote URL
-        remote = run_git "remote show origin -n | grep \"Fetch URL\" | cut -d ':' -f 2-"
+        remote = run_git("remote show origin -n").lines.grep(/Fetch URL/)[0].split(": ", 2)[1]
         if remote
           remote_url_matches = remote.match(%r{#{Regexp.escape github_host}(:|/)(?<repo_slug>.+/.+?)(?:\.git)?$})
           if !remote_url_matches.nil? and remote_url_matches["repo_slug"]
@@ -40,10 +40,10 @@ module Danger
 
         specific_pr = env["LOCAL_GIT_PR_ID"]
         pr_ref = specific_pr ? "##{specific_pr}" : ""
-        pr_command = "log --merges --oneline | grep \"Merge pull request #{pr_ref}\" | head -n 1"
+        pr_command = "log --merges --oneline"
 
         # get the most recent PR merge
-        pr_merge = run_git pr_command.strip
+        pr_merge = run_git(pr_command.strip).lines.grep(Regexp.new("Merge pull request " + pr_ref))[0]
 
         if pr_merge.to_s.empty?
           if specific_pr

data/lib/danger/commands/plugins/plugin_json.rb

@@ -0,0 +1,40 @@
+require "danger/plugin_support/plugin_parser"
+require "danger/plugin_support/plugin_file_resolver"
+
+module Danger
+  class PluginJSON < CLAide::Command::Plugins
+    self.summary = "Prints the JSON documentation representing a plugin"
+    self.command = "json"
+
+    attr_accessor :cork
+
+    def initialize(argv)
+      @refs = argv.arguments! unless argv.arguments.empty?
+      @cork = Cork::Board.new(silent: argv.option("silent", false),
+                              verbose: argv.option("verbose", false))
+      super
+    end
+
+    self.summary = "Lint plugins from files, gems or the current folder. Outputs JSON array representation of Plugins on success."
+
+    self.description = <<-DESC
+      Converts a collection of file paths of Danger plugins into a JSON format.
+      Note: Before 1.0, it will also parse the represented JSON to validate whether http://danger.systems would
+      show the plugin on the website.
+    DESC
+
+    self.arguments = [
+      CLAide::Argument.new("Paths, Gems or Nothing", false, true)
+    ]
+
+    def run
+      file_resolver = PluginFileResolver.new(@refs)
+      paths = file_resolver.resolve_to_paths
+
+      parser = PluginParser.new(paths)
+      parser.parse
+      json = parser.to_json_string
+      cork.puts json
+    end
+  end
+end

data/lib/danger/commands/plugins/plugin_lint.rb

@@ -1,5 +1,6 @@
 require "danger/plugin_support/plugin_parser"
 require "danger/plugin_support/plugin_file_resolver"
+require "danger/plugin_support/plugin_linter"
 
 module Danger
   class PluginLint < CLAide::Command::Plugins
@@ -34,7 +35,12 @@ module Danger
       parser = PluginParser.new(paths)
       parser.parse
       json = parser.to_json
-      cork.puts json
+
+      linter = PluginLinter.new(json)
+      linter.lint
+      linter.print_summary(cork)
+
+      exit(1) if linter.failed?
     end
   end
 end

data/lib/danger/commands/runner.rb

@@ -13,6 +13,7 @@ module Danger
                                          "https://github.com/danger/danger-plugin-template")
 
     require "danger/commands/plugins/plugin_lint"
+    require "danger/commands/plugins/plugin_json"
     require "danger/commands/plugins/plugin_readme"
 
     self.summary = "Run the Dangerfile."

data/lib/danger/plugin_support/plugin_linter.rb

@@ -0,0 +1,154 @@
+module Danger
+  class PluginLinter
+    # An internal class that is used to represent a rule for the linter.
+    class Rule
+      attr_accessor :modifier, :description, :title, :function, :ref, :metadata, :type
+
+      def initialize(modifier, ref, title, description, function)
+        @modifier = modifier
+        @title = title
+        @description = description
+        @function = function
+        @ref = ref
+      end
+
+      def object_applied_to
+        metadata[:name].to_s.bold + " (" + type + ")"
+      end
+    end
+
+    attr_accessor :json, :warnings, :errors
+
+    def initialize(json)
+      @json = json
+      @warnings = []
+      @errors = []
+    end
+
+    # Lints the current JSON, looking at:
+    # * Class rules
+    # * Method rules
+    # * Attribute rules
+    #
+    def lint
+      json.each do |plugin|
+        apply_rules(plugin, "class", class_rules)
+
+        plugin[:methods].each do |method|
+          apply_rules(method, "method", method_rules)
+        end
+
+        plugin[:attributes].each do |method_hash|
+          method_name = method_hash.keys.first
+          method = method_hash[method_name]
+
+          value = method[:write] || method[:read]
+          apply_rules(value, "attribute", method_rules)
+        end
+      end
+    end
+
+    # Did the linter pass/fail?
+    #
+    def failed?
+      errors.empty? == false
+    end
+
+    # Prints a summary of the errors and warnings.
+    #
+    def print_summary(ui)
+      # Print whether it passed/failed at the top
+      if failed?
+        ui.notice "Passed\n"
+      else
+        ui.puts "\n[!] Failed\n".red
+      end
+
+      # A generic proc to handle the similarities between
+      # erros and warnings.
+      do_rules = proc do |name, rules|
+        unless rules.empty?
+          ui.section(name.bold) do
+            rules.each do |rule|
+              title = rule.title.bold + " - #{rule.object_applied_to}"
+              ui.labeled(title, [rule.description, link(rule.ref)])
+              ui.puts ""
+            end
+          end
+        end
+      end
+
+      # Run the rules
+      do_rules.call("Errors".red, errors)
+      do_rules.call("Warnings".yellow, warnings)
+    end
+
+    private
+
+    # Rules that apply to a class
+    #
+    def class_rules
+      [
+        Rule.new(:error, 4..6, "Description Markdown", "Above your class you need documentation that covers the scope, and the usage of your plugin.", proc do |json|
+          json[:body_md] && json[:body_md].empty?
+        end),
+        Rule.new(:warning, 30, "Tags", "This plugin does not include `@tags tag1, tag2` and thus will be harder to find in search.", proc do |json|
+          json[:tags] && json[:tags].empty?
+        end),
+        Rule.new(:warning, 29, "References", "Ideally, you have a reference implementation of your plugin that you can show to people, add `@see org/repo` to have the site auto link it.", proc do |json|
+          json[:see] && json[:see].empty?
+        end),
+        Rule.new(:error, 8..27, "Examples", "You should include some examples of common use-cases for your plugin.", proc do |json|
+          json[:example_code] && json[:example_code].empty?
+        end)
+      ]
+    end
+
+    # Rules that apply to individual methods, and attributes
+    #
+    def method_rules
+      [
+        Rule.new(:error, 40..41, "Description", "You should include a description for your method.", proc do |json|
+          json[:body_md] && json[:body_md].empty?
+        end),
+        Rule.new(:warning, 43..45, "Params", "If the function has no useful return value, use ` @return  [void]`.", proc do |json|
+          json[:param_couplets] && json[:param_couplets].flat_map(&:values).include?(nil)
+        end),
+        Rule.new(:warning, 46, "Return Type", "If the function has no useful return value, use ` @return  [void]` - this will be ignored by documentation generators.", proc do |json|
+          json[:return] && json[:return].empty?
+        end)
+      ]
+    end
+
+    # Generates a link to see an example of said rule
+    #
+    def link(ref)
+      if ref.kind_of? Range
+        "@see - " + "https://github.com/dbgrandi/danger-prose/blob/v2.0.0/lib/danger_plugin.rb#L#{ref.min}#-L#{ref.max}".blue
+      elsif ref.kind_of? Fixnum
+        "@see - " + "https://github.com/dbgrandi/danger-prose/blob/v2.0.0/lib/danger_plugin.rb#L#{ref}".blue
+      else
+        "@see - " + "https://github.com/dbgrandi/danger-prose/blob/v2.0.0/lib/danger_plugin.rb".blue
+      end
+    end
+
+    # Runs the rule, if it fails then additional metadata
+    # is added to the rule (for printing later) and it's
+    # added to either `warnings` or `errors`.
+    #
+    def apply_rules(json, type, rules)
+      rules.each do |rule|
+        next unless rule.function.call(json)
+        rule.metadata = json
+        rule.type = type
+
+        case rule.modifier
+        when :warning
+          warnings << rule
+        when :error
+          errors << rule
+        end
+      end
+    end
+  end
+end

data/lib/danger/plugin_support/plugin_parser.rb

@@ -68,7 +68,12 @@ module Danger
 
     def to_json
       plugins = plugins_from_classes(classes_in_file)
-      to_dict(plugins).to_json
+      to_h(plugins)
+    end
+
+    def to_json_string
+      plugins = plugins_from_classes(classes_in_file)
+      to_h(plugins).to_json
     end
 
     # rubocop:disable Metrics/AbcSize
@@ -140,7 +145,7 @@ module Danger
       }
     end
 
-    def to_dict(classes)
+    def to_h(classes)
       classes.map do |klass|
         # Adds the class being parsed into the ruby runtime, so that we can access it's instance_name
         require klass.file

data/lib/danger/scm_source/git_repo.rb

@@ -21,7 +21,7 @@ module Danger
     end
 
     def origins
-      exec "remote show origin -n | grep \"Fetch URL\" | cut -d ':' -f 2-"
+      exec("remote show origin -n").lines.grep(/Fetch URL/)[0].split(": ", 2)[1]
     end
   end
 end

data/lib/danger/version.rb

@@ -1,4 +1,4 @@
 module Danger
-  VERSION = "0.9.0".freeze
+  VERSION = "0.9.1".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: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Orta Therox
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: claide
@@ -322,6 +322,7 @@ files:
 - lib/danger/commands/init.rb
 - lib/danger/commands/init_helpers/interviewer.rb
 - lib/danger/commands/local.rb
+- lib/danger/commands/plugins/plugin_json.rb
 - lib/danger/commands/plugins/plugin_lint.rb
 - lib/danger/commands/plugins/plugin_readme.rb
 - lib/danger/commands/runner.rb
@@ -339,6 +340,7 @@ files:
 - lib/danger/danger_core/violation.rb
 - lib/danger/plugin_support/plugin.rb
 - lib/danger/plugin_support/plugin_file_resolver.rb
+- 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/github.rb