danger-SwiftInfo 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f79aa81d20b9946f3e74a5d56a4205d3226b0d723c41faa428edc214e7950c4
-  data.tar.gz: 3b72ae88fa9f5c4d147bd503fdf0d2a2414e0c472a6794e44f78e4704867afb3
+  metadata.gz: ad09bccb0604f6885f6263b62e68e8321766f3d9855ea875692913acc67e5c01
+  data.tar.gz: '09b97e63b9180bdf6731542a36819d13ca72c0533a04b8bc5815ce5351b5d14a'
 SHA512:
-  metadata.gz: '042798967e1704ef9153033c469a2e2a91d74c7ea8ab8d65470e3c737ee82a157c4130fac7ce2da5a6be1f5a7037f07e1adc011eb197f5d23cfd075e8e905433'
-  data.tar.gz: 022cbea2b8a6bab044c441d01cf3bc3731d47ac60591a36e83a1cbdbf3a2315ca157ab5735a9d790d0ceb33a6f522593338869f478bd76203d8a2bb29035270b
+  metadata.gz: 9f20e40f9a0ee0772d8f9b2a029359f2fa3ca90e1aeff83ab6508476f078a36dc3e9826457b8d3b3e1538a6a883c3e8adf3ef58e97f00b9ba00a337b2254de3c
+  data.tar.gz: e6ccc788b68450fff44b0996e95c4ceb98b92eb69538f0b4511d09df7b974aca90192e3b743e4de5c4e5a46221faf5b77416fdbdc23e276efd721caeffaa653a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-SwiftInfo (0.0.3)
+    danger-SwiftInfo (0.0.4)
       danger-plugin-api (~> 1.0)
 
 GEM

data/README.md

@@ -1,17 +1,51 @@
 # danger-SwiftInfo
 
-A description of danger-SwiftInfo.
+A [Danger](http://danger.systems/) plugin that runs and prints [SwiftInfo](https://github.com/rockbruno/SwiftInfo) results to pull requests.
 
-## Installation
+Requires SwiftInfo 2.3.1 or newer.
 
-    $ gem install danger-SwiftInfo
+### How does it look?
 
-## Usage
+<img src="https://i.imgur.com/8kvEx5O.png">
 
-    Methods and attributes from this plugin are available in
-    your `Dangerfile` under the `SwiftInfo` namespace.
+### Installation
 
-## Development
+Just add the gem to your Gemfile:
+
+```ruby
+gem 'danger-SwiftInfo'
+```
+
+### Usage
+
+To use this plugin, you need to modify both your Dangerfile and your SwiftInfo's Infofile.
+
+#### Dangerfile
+
+Call `swiftinfo.run` with the path to your SwiftInfo binary as an argument. (inside `Pods` if CocoaPods was used or just `swiftinfo` if Homebrew was used)
+
+```ruby
+swiftinfo.run './Pods/SwiftInfo/bin/swiftinfo'
+```
+
+#### Infofile
+
+To print the final output to Danger, call `api.print(output)` from your Infofile.
+
+Note that when ran from this plugin, SwiftInfo will be executed with the `-pullRequest -s` arguments which can be inspected and used as a condition. This logic is abstracted under the `isInPullRequestMode` boolean, which you can use to extract different providers in Danger runs and prevent saving the output, for example.
+
+```swift
+if isInPullRequestMode {
+    // The specific Danger flow
+    api.print(output: output)
+} else {
+    // The regular release flow
+    api.sendToSlack(output: output, webhookUrl: url)
+    api.save(output: output)
+}
+```
+
+### Development
 
 1. Clone this repo
 2. Run `bundle install` to setup dependencies.

data/lib/danger_SwiftInfo.rb

@@ -1,3 +1,3 @@
 module SwiftInfo
-    VERSION = "0.0.3".freeze
+    VERSION = "0.0.4".freeze
 end

data/lib/danger_plugin.rb

@@ -6,12 +6,12 @@ module Danger
     # somewhere in your project.
     # You can detect that SwiftInfo is running specifically for Danger
     # by adding a `if isInPullRequestMode` condition in your Infofile.
-    # You can use it to extract different rules and prevent saving the new output.
+    # You can use this condition to extract different rules and prevent saving the new output.
     # @example Run SwiftInfo
     #
-    #          SwiftInfo.run './Pods/SwiftInfo/bin/swiftinfo'
+    #          swiftinfo.run './Pods/SwiftInfo/bin/swiftinfo'
     #
-    # @see  Bruno Rocha/danger-SwiftInfo
+    # @see  rockbruno/danger-SwiftInfo
     # @tags swift, xcode, swiftinfo, ios
     #
     class DangerSwiftInfo < Plugin
@@ -20,8 +20,10 @@ module Danger
         # @return   [void]
         #
         def run(path)
-            stdout, stderr, status = Open3.capture3(path + " -pullRequest -s")
-            message(stdout)
+            binPath = path
+            output = `#{binPath} -pullRequest -s`
+            html = output.sub("\n", "<br>")
+            message(output)
         end
 
         def self.instance_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-SwiftInfo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Bruno Rocha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-19 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api