Merge pull request #48 from diogot/xcresult

Add support for xcresult

Author: marcelofabri

.gitattributes

@@ -0,0 +1 @@
+*.xcresult binary

.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
 # kind_of? is a good way to check a type
 Style/ClassCheck:
   EnforcedStyle: kind_of?

.travis.yml

@@ -3,9 +3,17 @@ cache:
   directories:
     - bundle
 
+os: osx
+osx_image: xcode11
+
 rvm:
   - 2.6.0
   - 2.5.3
 
+# install bundler 2.x
+before_install:
+    - gem update --system
+    - gem install bundler
+
 script:
     - bundle exec rake spec

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in danger-xcode_summary.gemspec

Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    danger-xcode_summary (0.5.3)
+    danger-xcode_summary (1.0.0)
       danger-plugin-api (~> 1.0)
+      xcresult (~> 0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -137,6 +138,7 @@ GEM
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.1.0)
     unicode-display_width (2.0.0)
+    xcresult (0.2.1)
     yard (0.9.26)
 
 PLATFORMS
@@ -156,4 +158,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.2.17
+   2.2.26

Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A guardfile for making Danger Plugins
 # For more info see https://github.com/guard/guard#readme
 

README.md

@@ -6,12 +6,6 @@
 
 A [Danger](http://danger.systems) plugin that shows all build errors, warnings and unit tests results generated from `xcodebuild`.
 
-You need to use [xcpretty](https://github.com/supermarin/xcpretty) with 
-[xcpretty-json-formatter](https://github.com/marcelofabri/xcpretty-json-formatter) 
-to generate a JSON file that this plugin can read.
-
-**Using [danger-swift](https://github.com/danger/swift)**? You may want to take a look at [danger-swift-xcodesummary](https://github.com/f-meloni/danger-swift-xcodesummary).
-
 ## How does it look?
 
 <table>
@@ -62,24 +56,6 @@ to generate a JSON file that this plugin can read.
   </tbody>
 </table>
 
-<table>
-  <thead>
-    <tr>
-      <th width="50"></th>
-      <th width="100%">
-          1 Message
-      </th>
-     </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><g-emoji alias="book" fallback-src="https://assets-cdn.github.com/images/icons/emoji/unicode/1f4d6.png">📖</g-emoji></td>
-      <td>Executed 5 tests, with 1 failure (0 unexpected) in 0.032 (0.065) seconds</td>
-    </tr>
-      </tr>
-  </tbody>
-</table>
-
 ## Installation
 
 Add this line to your Gemfile:
@@ -93,9 +69,13 @@ gem 'danger-xcode_summary'
 Just add this line to your `Dangerfile`:
 
 ```ruby
-xcode_summary.report 'xcodebuild.json'
+xcode_summary.report 'MyApp.xcresult'
 ```
 
+You need to pass the path of the `xcresult` generated after compiling your app.
+By default, this is inside the `DerivedData` for your project, but you can use the `-resultBundlePath`
+flag when calling `xcodebuild` to customize its path. You can read more about it in this [blog post from the folks at PSPDFKit](https://pspdfkit.com/blog/2021/deflaking-ci-tests-with-xcresults/#using-xcresult-bundles).
+
 You can also ignore warnings from certain files by setting `ignored_files`: 
 Warning: `ignored_files` patterns applied on relative paths.  
 
@@ -105,10 +85,10 @@ xcode_summary.ignored_files = 'Pods/**'
 
 # Ignoring specific warnings
 xcode_summary.ignored_results { |result|
-  result.message.start_with? 'ld' # Ignore ld_warnings
+  result.message.include? 'ld' # Ignore ld_warnings
 }
 
-xcode_summary.report 'xcodebuild.json'
+xcode_summary.report 'MyApp.xcresult'
 ```
 
 You can use `ignores_warnings` to supress warnings and shows only errors.
@@ -123,13 +103,13 @@ When this value is enabled, each warnings and errors are commented on each lines
 ```ruby
 # Comment on each lines
 xcode_summary.inline_mode = true
-xcode_summary.report 'xcodebuild.json'
+xcode_summary.report 'MyApp.xcresult'
 ```
 
-You can get warning and error number by calling `warning_error_count`. The return will be a JSON string contains warning and error count, e.g {"warnings":1,"errors":3}:
+You can get warning and error number by calling `warning_error_count`. The return will be a JSON string contains warning and error count, e.g `{"warnings":1,"errors":3}`:
 
 ```ruby
-result = xcode_summary.warning_error_count 'xcodebuild.json'
+result = xcode_summary.warning_error_count 'MyApp.xcresult'
 ```
 
 ## License

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

danger-xcode_summary.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'xcode_summary/gem_version.rb'
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.4.0"
 
+  spec.add_dependency 'xcresult', '~> 0.2'
   spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
 
   # General ruby development

lib/xcode_summary/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module XcodeSummary
-  VERSION = '0.5.3'
+  VERSION = '1.0.0'
 end