danger 0.8.5 → 0.9.0

data/lib/danger/danger_core/dangerfile_dsl.rb

@@ -20,7 +20,7 @@ module Danger
       end
 
       def load_default_plugins
-        Dir['./danger_plugins/*.rb'].each do |file|
+        Dir["./danger_plugins/*.rb"].each do |file|
           require File.expand_path(file)
         end
       end

data/lib/danger/danger_core/environment_manager.rb

@@ -1,5 +1,5 @@
-require 'danger/ci_source/ci_source'
-require 'danger/request_source/request_source'
+require "danger/ci_source/ci_source"
+require "danger/request_source/request_source"
 
 module Danger
   class EnvironmentManager
@@ -18,7 +18,7 @@ module Danger
         end
       end
 
-      raise 'Could not find a valid pull request within the known CI sources'.red unless self.ci_source
+      raise "Could not find a valid pull request within the known CI sources".red unless self.ci_source
 
       RequestSources::RequestSource.available_request_sources.each do |klass|
         next unless self.ci_source.supports?(klass)
@@ -28,7 +28,7 @@ module Danger
         self.request_source = request_source
       end
 
-      raise 'Could not find a Request Source'.red unless self.request_source
+      raise "Could not find a Request Source".red unless self.request_source
 
       self.scm = self.request_source.scm
     end
@@ -62,11 +62,11 @@ module Danger
     end
 
     def self.danger_head_branch
-      'danger_head'
+      "danger_head"
     end
 
     def self.danger_base_branch
-      'danger_base'
+      "danger_base"
     end
   end
 end

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

@@ -1,5 +1,5 @@
-require 'danger/plugin_support/plugin'
-require 'danger/core_ext/file_list'
+require "danger/plugin_support/plugin"
+require "danger/core_ext/file_list"
 
 module Danger
   # Handles interacting with git inside a Dangerfile. Providing access to files that have changed, and useful statistics. Also provides
@@ -31,7 +31,7 @@ module Danger
 
   class DangerfileGitPlugin < Plugin
     def self.instance_name
-      'git'
+      "git"
     end
 
     def initialize(dangerfile)
@@ -46,7 +46,7 @@ module Danger
     # @return [FileList<String>] an [Array] subclass
     #
     def added_files
-      Danger::FileList.new(@git.diff.select { |diff| diff.type == 'new' }.map(&:path))
+      Danger::FileList.new(@git.diff.select { |diff| diff.type == "new" }.map(&:path))
     end
 
     # @!group Git Files
@@ -54,7 +54,7 @@ module Danger
     # @return [FileList<String>] an [Array] subclass
     #
     def deleted_files
-      Danger::FileList.new(@git.diff.select { |diff| diff.type == 'deleted' }.map(&:path))
+      Danger::FileList.new(@git.diff.select { |diff| diff.type == "deleted" }.map(&:path))
     end
 
     # @!group Git Files

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

@@ -1,4 +1,4 @@
-require 'danger/plugin_support/plugin'
+require "danger/plugin_support/plugin"
 
 module Danger
   # Handles interacting with GitHub inside a Dangerfile. Provides a few functions which wrap `pr_json` and also
@@ -34,7 +34,7 @@ module Danger
     end
 
     def self.instance_name
-      'github'
+      "github"
     end
 
     # @!group PR Metadata

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

@@ -1,4 +1,4 @@
-require 'danger/plugin_support/plugin'
+require "danger/plugin_support/plugin"
 
 module Danger
   # One way to support internal plugins is via `plugin.import` this gives you
@@ -25,7 +25,7 @@ module Danger
 
   class DangerfileImportPlugin < Plugin
     def self.instance_name
-      'plugin'
+      "plugin"
     end
 
     # @!group Plugins
@@ -37,10 +37,10 @@ module Danger
     # @return [void]
 
     def import(path)
-      raise '`import` requires a string' unless path.kind_of?(String)
-      path += '.rb' unless path.end_with?('.rb')
+      raise "`import` requires a string" unless path.kind_of?(String)
+      path += ".rb" unless path.end_with?(".rb")
 
-      if path.start_with?('http')
+      if path.start_with?("http")
         import_url(path)
       else
         import_local(path)
@@ -56,10 +56,10 @@ module Danger
     #           https URL to the Ruby file to use
     # @return [void]
     def import_url(url)
-      raise 'URL is not https, for security reasons `danger` only supports encrypted requests' unless url.start_with?('https://')
+      raise "URL is not https, for security reasons `danger` only supports encrypted requests" unless url.start_with?("https://")
 
-      require 'tmpdir'
-      require 'faraday'
+      require "tmpdir"
+      require "faraday"
 
       @http_client ||= Faraday.new do |b|
         b.adapter :net_http
@@ -67,7 +67,7 @@ module Danger
       content = @http_client.get(url)
 
       Dir.mktmpdir do |dir|
-        path = File.join(dir, 'temporary_remote_action.rb')
+        path = File.join(dir, "temporary_remote_action.rb")
         File.write(path, content.body)
         import_local(path)
       end

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

@@ -1,5 +1,5 @@
-require 'danger/danger_core/violation'
-require 'danger/plugin_support/plugin'
+require "danger/danger_core/violation"
+require "danger/plugin_support/plugin"
 
 module Danger
   # Provides the feedback mechanism for Danger. Danger can keep track of
@@ -54,7 +54,7 @@ module Danger
     end
 
     def self.instance_name
-      'messaging'
+      "messaging"
     end
 
     # @!group Core

data/lib/danger/danger_core/standard_error.rb

@@ -1,5 +1,5 @@
-require 'claide'
-require 'claide/informative_error'
+require "claide"
+require "claide/informative_error"
 
 module Danger
   # From below here - this entire file was taken verbatim for CocoaPods-Core.
@@ -73,12 +73,12 @@ module Danger
 
         trace_line = backtrace.find { |l| l.include?(dsl_path.to_s) } || trace_line
         return m unless trace_line
-        line_numer = trace_line.split(':')[1].to_i - 1
+        line_numer = trace_line.split(":")[1].to_i - 1
         return m unless line_numer
 
         lines      = contents.lines
-        indent     = ' #  '
-        indicator  = indent.tr('#', '>')
+        indent     = " #  "
+        indicator  = indent.tr("#", ">")
         first_line = line_numer.zero?
         last_line  = (line_numer == (lines.count - 1))
 
@@ -99,7 +99,7 @@ module Danger
       description = self.description
       if dsl_path && description =~ /((#{Regexp.quote File.expand_path(dsl_path)}|#{Regexp.quote dsl_path.to_s}):\d+)/
         trace_line = Regexp.last_match[1]
-        description = description.sub(/#{Regexp.quote trace_line}:\s*/, '')
+        description = description.sub(/#{Regexp.quote trace_line}:\s*/, "")
       end
       [trace_line, description]
     end

data/lib/danger/plugin_support/plugin.rb

@@ -5,7 +5,7 @@ module Danger
     end
 
     def self.instance_name
-      to_s.gsub('Danger', '').danger_underscore.split('/').last
+      to_s.gsub("Danger", "").danger_underscore.split("/").last
     end
 
     # Both of these methods exist on all objects

data/lib/danger/plugin_support/plugin_file_resolver.rb

@@ -1,5 +1,5 @@
-require 'bundler'
-require 'pathname'
+require "bundler"
+require "pathname"
 
 module Danger
   class PluginFileResolver
@@ -19,11 +19,11 @@ module Danger
         Bundler.with_clean_env do
           Dir.mktmpdir do |dir|
             gem_names = @refs
-            deps = gem_names.map { |name| Bundler::Dependency.new(name, '>= 0') }
+            deps = gem_names.map { |name| Bundler::Dependency.new(name, ">= 0") }
 
             # Use Gems from rubygems.org
             source = Bundler::SourceList.new
-            source.add_rubygems_remote('https://rubygems.org')
+            source.add_rubygems_remote("https://rubygems.org")
 
             # Create a definition to bundle, make sure it always updates
             # and uses the latest version from the server
@@ -36,12 +36,12 @@ module Danger
 
             # Get the name'd gems out of bundler, then pull out all their paths
             gems = gem_names.flat_map { |name| bundler.specs[name] }
-            gems.flat_map { |gem| Dir.glob(File.join(gem.gem_dir, 'lib/**/**/**.rb')) }
+            gems.flat_map { |gem| Dir.glob(File.join(gem.gem_dir, "lib/**/**/**.rb")) }
           end
         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,8 +1,8 @@
 require 'json'
 
-=begin 
+=begin
 
-  So you want to improve this? Great. Hard thing is getting yourself into a position where you 
+  So you want to improve this? Great. Hard thing is getting yourself into a position where you
   have access to all the tokens, so here's something you should run in `bundle exec pry` to dig in:
 
       require 'danger'
@@ -15,13 +15,12 @@ require 'json'
       parser.to_dict(plugins)
 
   Then some helpers
-  
+
       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 }
 
-
   the alternative, is to add
 
       require 'pry'
@@ -31,7 +30,6 @@ require 'json'
 
 =end
 
-
 module Danger
   class PluginParser
     attr_accessor :registry
@@ -39,7 +37,7 @@ module Danger
     def initialize(paths)
       raise "Path cannot be empty" if paths.empty?
 
-      if paths.is_a? String
+      if paths.kind_of? String
         @paths = [File.expand_path(paths)]
       else
         @paths = paths
@@ -56,7 +54,7 @@ module Danger
 
       # This turns on YARD debugging
       # $DEBUG = true
-      
+
       self.registry = YARD::Registry.load(files, true)
     end
 
@@ -73,29 +71,76 @@ module Danger
       to_dict(plugins).to_json
     end
 
-    def to_dict(classes)
-      d_meth = lambda do |meth|
-        return nil if meth.nil?
-        {
-          name: meth.name,
-          body_md: meth.docstring,
-          params: meth.parameters,
-          tags: meth.tags.map do |t|
-            {
-               name: t.tag_name,
-               types: t.types
-            }
-          end
-        }
+    # rubocop:disable Metrics/AbcSize
+
+    def method_return_string(meth)
+      return "" unless meth[:tags]
+
+      return_value = meth[:tags].find { |t| t[:name] == "return" && t[:types] }
+      return "" if return_value.nil?
+      return "" if return_value[:types].nil?
+      return "" unless return_value[:types].kind_of? Array
+
+      unless return_value.empty?
+        return "" if return_value[:types].first == "void"
+        return return_value[:types].first
       end
+      ""
+    end
 
-      d_attr = lambda do |attribute|
-        {
-          read: d_meth.call(attribute[:read]),
-          write: d_meth.call(attribute[:write])
-        }
+    def method_params(params)
+      return {} unless params[:params]
+
+      params_names = params[:params].compact.flat_map(&:first)
+      params_values = params[:tags].find { |t| t[:name] == "param" }
+
+      return {} if params_values.nil?
+      return {} if params_values[:types].nil?
+
+      return params_names.map.with_index do |name, index|
+        { name => params_values[:types][index] }
       end
+    end
 
+    def method_parser(meth)
+      return nil if meth.nil?
+      method = {
+        name: meth.name,
+        body_md: meth.docstring,
+        params: meth.parameters,
+        tags: meth.tags.map { |t| { name: t.tag_name, types: t.types } }
+      }
+
+      return_v = method_return_string(method)
+      params_v = method_params(method)
+
+      # Pull out some derived data
+      method[:param_couplets] = params_v
+      method[:return] = return_v
+
+      # Create the center params, `thing: OK, other: Thing`
+      string_params = params_v.map do |param|
+        name = param.keys.first
+        param[name].nil? ? name : name + ": " + param[name]
+      end.join ", "
+
+      # Wrap it in () if there _are_ params
+      string_params = "(" + string_params + ")" unless string_params.empty?
+      # Append the return type if we have one
+      suffix = return_v.empty? ? "" : " -> #{return_v}"
+
+      method[:one_liner] = meth.name.to_s + string_params + suffix
+      method
+    end
+
+    def attribute_parser(attribute)
+      {
+        read: method_parser(attribute[:read]),
+        write: method_parser(attribute[:write])
+      }
+    end
+
+    def to_dict(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
@@ -109,16 +154,15 @@ module Danger
           name: klass.name.to_s,
           body_md: klass.docstring,
           instance_name: real_klass.instance_name,
-          example_code: klass.tags.select { |t| t.tag_name == "example" }.map { |tag| {:title => tag.name, :text => tag.text} }.compact,
-          attributes: klass.attributes[:instance].map do |pair|
-            { pair.first => d_attr.call(pair.last) }
-          end,
-          methods: usable_methods.map { |m| d_meth.call(m) },
+          example_code: klass.tags.select { |t| t.tag_name == "example" }.map { |tag| { title: tag.name, text: tag.text } }.compact,
+          attributes: klass.attributes[:instance].map { |pair| { pair.first => attribute_parser(pair.last) } },
+          methods: usable_methods.map { |m| method_parser(m) },
           tags: klass.tags.select { |t| t.tag_name == "tags" }.map(&:text).compact,
           see: klass.tags.select { |t| t.tag_name == "see" }.map(&:name).map(&:split).flatten.compact,
           file: klass.file.gsub(File.expand_path("."), "")
         }
       end
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/danger/request_source/request_source.rb

@@ -13,7 +13,7 @@ module Danger
       end
 
       def initialize(_ci_source, _environment)
-        raise 'Subclass and overwrite initialize'
+        raise "Subclass and overwrite initialize"
       end
 
       def validates?
@@ -33,15 +33,15 @@ module Danger
       end
 
       def update_pull_request!(_warnings: [], _errors: [], _messages: [], _markdowns: [])
-        raise 'Subclass and overwrite update_pull_request!'
+        raise "Subclass and overwrite update_pull_request!"
       end
 
       def setup_danger_branches
-        raise 'Subclass and overwrite setup_danger_branches'
+        raise "Subclass and overwrite setup_danger_branches"
       end
 
       def fetch_details
-        raise 'Subclass and overwrite initialize'
+        raise "Subclass and overwrite initialize"
       end
     end
   end

data/lib/danger/scm_source/git_repo.rb

@@ -1,12 +1,12 @@
 # For more info see: https://github.com/schacon/ruby-git
 
-require 'git'
+require "git"
 
 module Danger
   class GitRepo
     attr_accessor :diff, :log
 
-    def diff_for_folder(folder, from: 'master', to: 'HEAD')
+    def diff_for_folder(folder, from: "master", to: "HEAD")
       repo = Git.open folder
       self.diff = repo.diff(from, to)
       self.log = repo.log.between(from, to)
@@ -17,7 +17,7 @@ module Danger
     end
 
     def head_commit
-      exec 'rev-parse HEAD'
+      exec "rev-parse HEAD"
     end
 
     def origins