xcresult 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8b059189c741bbaf7e5f4a5c23ef524dcf57a012001a138ca975564718846d6
-  data.tar.gz: 34c8ba16f96f43e0672289e99f910367fb06fed72f550c8aae2ffaa04bc8d78a
+  metadata.gz: 719d1f64f463138bc78b23e18d124c07f815af7c7b052560d426feced0fbad64
+  data.tar.gz: 2ac8faad5109f78cde5a7c3bdd56aea980fdb5d9bdd80b2b38568034a627ae65
 SHA512:
-  metadata.gz: 11cdf9db657dafb8fa579cdbf3a7359abe3026cdfaf23dda45c8271e6d6678c675360b0c3cb27d30d1985890e4c23099f06ba56ed85f61a7b069115efa34c36b
-  data.tar.gz: 9bc16d6b395414bbac5c8da3a48e82974c59222a9bfa5f4bfc12df83eaa048293a3440d451c1da9432e878f4c3f3cc0929c017eeccc8cbb3a9caa44d14ab9bcf
+  metadata.gz: 576989a630f4abdd1550ab25dfdfe8034df9349ebe17784061bc2468c52026509dd9d02e669225101436510127ddd27088ad56f51a2589d070e462740e775679
+  data.tar.gz: 1a97becb5676f1f2c08ed4ef685785d008be4055c80c01d109fe0405387dbb3ed5fc34182d8cc619432e925cc0c492b257bce70ca1c5f53ccafcf0191a4bedbe

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    xcresult (0.1.0)
+    xcresult (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,10 @@
-# Xcresult
+# XCResult
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xcresult`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Twitter: @joshdholtz](https://img.shields.io/badge/contact-@joshdholtz-blue.svg?style=flat)](https://twitter.com/KrauseFx)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/KrauseFx/trainer/blob/master/LICENSE)
+[![Gem](https://img.shields.io/gem/v/xcresult.svg?style=flat)](http://rubygems.org/gems/trainer)
 
-TODO: Delete this and the text above, and describe your gem
+Ruby interface for inspecting data and exporting data from Xcode 11 `.xcresult` files
 
 ## Installation
 
@@ -20,9 +22,30 @@ Or install it yourself as:
 
     $ gem install xcresult
 
+## Roadmap
+
+- [x] Allow for easy querying of test plan summaires
+- [x] Allow for easy exporting of `.xccovreport` files
+- [ ] Allow for exporting of screenshots
+- [ ] Add full documentation on all classes and methods
+- [ ] Add more and better explain examples
+- [ ] Add tests and improved code coverage
+
 ## Usage
 
-TODO: Write usage instructions here
+### Export .xccovreport files from .xcresult
+
+```rb
+parser = XCResult::Parser.new(path: 'YourProject.xcresult')
+export_xccovreport_paths = parser.export_xccovreports(destination: './outputs')
+```
+
+### Get test plan summaries from .xcresult
+
+```rb
+parser = XCResult::Parser.new(path: 'YourProject.xcresult')
+summaries = parser.action_test_plan_summaries
+```
 
 ## Development
 

data/lib/xcresult/parser.rb

@@ -39,11 +39,13 @@ module XCResult
     def export_xccovreports(destination: nil)
       destination ||= Dir.pwd
 
-      coverages = actions_invocation_record.actions.map do |action|
+      # Collects report references
+      report_refs = actions_invocation_record.actions.map do |action|
         action.action_result.coverage.report_ref
       end.compact
-      ids = coverages.map(&:id)
+      ids = report_refs.map(&:id)
 
+      # Exports all xccovreport files from the report references
       ids.each_with_index.map do |id, i|
         output_path = File.join(destination, "action_#{i}.xccovreport")
         cmd = "xcrun xcresulttool export --path #{path} --id '#{id}' --output-path #{output_path} --type file"
@@ -53,6 +55,25 @@ module XCResult
       end
     end
 
+    def export_xccovarchives(destination: nil)
+      destination ||= Dir.pwd
+
+      # Collects archive references
+      archive_refs = actions_invocation_record.actions.map do |action|
+        action.action_result.coverage.archive_ref
+      end.compact
+      ids = archive_refs.map(&:id)
+
+      # Exports all xcovarchive directories from the archive references
+      ids.each_with_index.map do |id, i|
+        output_path = File.join(destination, "action_#{i}.xccovarchive")
+        cmd = "xcrun xcresulttool export --path #{path} --id '#{id}' --output-path #{output_path} --type directory"
+        execute_cmd(cmd)
+
+        output_path
+      end
+    end
+
     private
 
     def get_result_bundle_json(id: nil)

data/lib/xcresult/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module XCResult
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/xcresult.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcresult
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Josh Holtz
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2019-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler