slather 2.4.2 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 468a58d0b18f5ae7633a796c72205f80d4db2eb8
-  data.tar.gz: 4f4ee9f3346d2849a29e7a654be2e42354209320
+  metadata.gz: e4792a1ef157980aebe454c8f2f66ba615afce74
+  data.tar.gz: 20c3278d981f6b6989d59ea446a5e102f2cc1119
 SHA512:
-  metadata.gz: 67a07567cfcd9b80606b67b2e40ce3c0f96679f556bf8919bbbbd6d6ccd099d33ad1bab5d624307ee55c4cf3cc80fd9006fef1227998e7d04d9ed593c5b79b90
-  data.tar.gz: 1bd3e902f18d8bee77087615a9806da2359ea235a86fcae23e70c5900ee1ae0ed47ed72789756e9ebd78286589abb5be0f25a26eac1557b083054218799587d8
+  metadata.gz: 76515b90aa82cad8d98ee37d31b8204e28053a987c1207d60a07e3f843bab9579faef26ef9e2ce4129a171a323a86bc98d376fe23ee21b030fc8c367032b39bb
+  data.tar.gz: 0bf97e2d021ceb10ac033fe93a45c4eed0b17be60c23e05ba6ee0c554c3260da0d21982104be9a58e34486330c7a72b3860a3a0c1264ee13f0ea349353da2bea

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # CHANGELOG
 
-## master
+## v2.4.3
+
+* Initial Xcode 9 support
+  [ksuther](https://github.com/ksuther) [#339](https://github.com/SlatherOrg/slather/pull/339), [ivanbrunel](https://github.com/ivanbruel) [#321](https://github.com/SlatherOrg/slather/pull/321), [FDREAL](https://github.com/FDREAL) [#338](https://github.com/SlatherOrg/slather/pull/338)
+
+* Add `--json` output option for basic JSON format not specific to any particular service.
+  [ileitch](https://github.com/ileitch)
+  [#318](https://github.com/SlatherOrg/slather/pull/318)
 
 ## v2.4.2
 

data/lib/slather.rb

@@ -10,6 +10,7 @@ require 'slather/coverage_service/hardcover'
 require 'slather/coverage_service/gutter_json_output'
 require 'slather/coverage_service/simple_output'
 require 'slather/coverage_service/html_output'
+require 'slather/coverage_service/json_output'
 require 'cfpropertylist'
 
 module Slather

data/lib/slather/command/coverage_command.rb

@@ -13,6 +13,7 @@ class CoverageCommand < Clamp::Command
   option ["--simple-output", "-s"], :flag, "Output coverage results to the terminal"
   option ["--gutter-json", "-g"], :flag, "Output coverage results as Gutter JSON format"
   option ["--cobertura-xml", "-x"], :flag, "Output coverage results as Cobertura XML format"
+  option ["--json"], :flag, "Output coverage results as simple JSON"
   option ["--html"], :flag, "Output coverage results as static html pages"
   option ["--show"], :flag, "Indicate that the static html pages will open automatically"
 
@@ -116,6 +117,8 @@ class CoverageCommand < Clamp::Command
     elsif html?
       project.coverage_service = :html
       project.show_html = show?
+    elsif json?
+      project.coverage_service = :json
     end
   end
 

data/lib/slather/coverage_service/json_output.rb

@@ -0,0 +1,38 @@
+require 'nokogiri'
+require 'date'
+
+module Slather
+  module CoverageService
+    module JsonOutput
+
+      def coverage_file_class
+        if input_format == "profdata"
+          Slather::ProfdataCoverageFile
+        else
+          Slather::CoverageFile
+        end
+      end
+      private :coverage_file_class
+
+      def post
+        report = coverage_files.map do |file|
+          {
+            file: file.source_file_pathname_relative_to_repo_root,
+            coverage: file.line_coverage_data
+          }
+        end.to_json
+
+        store_report(report)
+      end
+
+      def store_report(report)
+        output_file = 'report.json'
+        if output_directory
+          FileUtils.mkdir_p(output_directory)
+          output_file = File.join(output_directory, output_file)
+        end
+        File.write(output_file, report.to_s)
+      end
+    end
+  end
+end

data/lib/slather/project.rb

@@ -158,14 +158,29 @@ module Slather
       raise StandardError, "The specified build directory (#{self.build_directory}) does not exist" unless File.exists?(self.build_directory)
       dir = nil
       if self.scheme
-        dir = Dir[File.join("#{build_directory}","/**/CodeCoverage/#{self.scheme}")].first
+        dir = Dir[File.join(build_directory,"/**/CodeCoverage/#{self.scheme}")].first
       else
-        dir = Dir[File.join("#{build_directory}","/**/#{first_product_name}")].first
+        dir = Dir[File.join(build_directory,"/**/#{first_product_name}")].first
       end
 
       if dir == nil
         # Xcode 7.3 moved the location of Coverage.profdata
-        dir = Dir[File.join("#{build_directory}","/**/CodeCoverage")].first
+        dir = Dir[File.join(build_directory,"/**/CodeCoverage")].first
+      end
+
+      if dir == nil && Slather.xcode_version[0] >= 9
+        # Xcode 9 moved the location of Coverage.profdata
+        coverage_files = Dir[File.join(build_directory, "/**/ProfileData/*/Coverage.profdata")]
+
+        if coverage_files.count == 0
+          # Look up one directory
+          # The ProfileData directory is next to Intermediates.noindex (in previous versions of Xcode the coverage was inside Intermediates)
+          coverage_files = Dir[File.join(build_directory, "../**/ProfileData/*/Coverage.profdata")]
+        end
+
+        if coverage_files != nil
+          dir = Pathname.new(coverage_files.first).parent()
+        end
       end
 
       raise StandardError, "No coverage directory found." unless dir != nil
@@ -339,6 +354,8 @@ module Slather
         extend(Slather::CoverageService::CoberturaXmlOutput)
       when :html
         extend(Slather::CoverageService::HtmlOutput)
+      when :json
+        extend(Slather::CoverageService::JsonOutput)
       else
         raise ArgumentError, "`#{coverage_service}` is not a valid coverage service. Try `terminal`, `coveralls`, `gutter_json`, `cobertura_xml` or `html`"
       end
@@ -404,9 +421,15 @@ module Slather
         end
 
         search_list = binary_basename || find_buildable_names(xcscheme)
+        search_dir = profdata_coverage_dir
+
+        if Slather.xcode_version[0] >= 9
+          # Go from the directory containing Coverage.profdata back to the directory containing Products (back out of ProfileData/UUID-dir)
+          search_dir = File.join(search_dir, '../..')
+        end
 
         search_list.each do |search_for|
-          found_product = Dir["#{profdata_coverage_dir}/Products/#{configuration}*/#{search_for}*"].sort { |x, y|
+          found_product = Dir["#{search_dir}/Products/#{configuration}*/#{search_for}*"].sort { |x, y|
             # Sort the matches without the file extension to ensure better matches when there are multiple candidates
             # For example, if the binary_basename is Test then we want Test.app to be matched before Test Helper.app
             File.basename(x, File.extname(x)) <=> File.basename(y, File.extname(y))

data/lib/slather/version.rb

@@ -1,3 +1,3 @@
 module Slather
-  VERSION = '2.4.2' unless defined?(Slather::VERSION)
+  VERSION = '2.4.3' unless defined?(Slather::VERSION)
 end

data/slather.gemspec

@@ -4,33 +4,33 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'slather/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "slather"
+  spec.name          = 'slather'
   spec.version       = Slather::VERSION
-  spec.authors       = ["Mark Larsen"]
-  spec.email         = ["mark@venmo.com"]
+  spec.authors       = ['Mark Larsen']
+  spec.email         = ['mark@venmo.com']
   spec.summary       = %q{Test coverage reports for Xcode projects}
-  spec.homepage      = "https://github.com/SlatherOrg/slather"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/SlatherOrg/slather'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "rake", "~> 10.4"
-  spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "pry", "~> 0.9"
-  spec.add_development_dependency "cocoapods", "~> 1.2"
-  spec.add_development_dependency "json_spec", "~> 1.1.4"
-  spec.add_development_dependency "equivalent-xml", "~> 0.5.1"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'cocoapods', '~> 1.2'
+  spec.add_development_dependency 'json_spec', '~> 1.1.4'
+  spec.add_development_dependency 'equivalent-xml', '~> 0.5.1'
 
-  spec.add_dependency "clamp", "~> 0.6"
-  spec.add_dependency "xcodeproj", "~> 1.4"
-  spec.add_dependency "nokogiri", "~> 1.6"
-  spec.add_dependency "CFPropertyList", "~> 2.2"
+  spec.add_dependency 'clamp', '~> 0.6'
+  spec.add_dependency 'xcodeproj', '~> 1.4'
+  spec.add_dependency 'nokogiri', '>= 1.6', '< 1.7'
+  spec.add_dependency 'CFPropertyList', '~> 2.2'
 
   ## Version 5 needs Ruby 2.2, so we specify an upper bound to stay compatible with system ruby
   spec.add_runtime_dependency 'activesupport', '>= 4.0.2', '< 5'

data/spec/fixtures/report.json

@@ -0,0 +1 @@
+[{"file":"spec/fixtures/fixtures/fixtures.m","coverage":[null,null,null,null,null,null,null,null,null,null,null,null,null,1,1,1,null,null,0,0,0,null,null]},{"file":"spec/fixtures/fixtures/more_files/Branches.m","coverage":[null,null,null,null,null,null,null,null,null,null,null,null,null,2,2,1,1,1,0,0,1,1,1,2,2,2,2,2,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,null,null]},{"file":"spec/fixtures/fixturesTests/BranchesTests.m","coverage":[null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,2,2,2,2,null,2,2,2,2,null,1,1,1,1,null,1,1,1,1,null,null]},{"file":"spec/fixtures/fixturesTests/fixturesTests.m","coverage":[null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,2,2,2,2,null,null,2,2,2,2,null,null,1,1,1,1,null,null,1,1,1,1,1,null,null]},{"file":"spec/fixtures/fixturesTests/peekaviewTests💣.m","coverage":[null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,1,1,1,1,null,null,1,1,1,1,null,null,1,1,1,null,null]},{"file":"spec/fixtures/fixturesTwo/fixturesTwo.m","coverage":[null,null,null,null,null,null,null,null,null,null,null,null,null,1,1,1,1,1,1,null,null]}]

data/spec/slather/coverage_service/gutter_json_spec.rb

@@ -22,7 +22,7 @@ describe Slather::CoverageService::GutterJsonOutput do
     it "should print out the coverage for each file, and then total coverage" do
       fixtures_project.post
 
-      fixture_json = File.read(FIXTURES_JSON_PATH)
+      fixture_json = File.read(FIXTURES_GUTTER_JSON_PATH)
       current_json = File.read('.gutter.json')
 
       expect(current_json).to be_json_eql(fixture_json)

data/spec/slather/coverage_service/json_spec.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+require 'json'
+
+describe Slather::CoverageService::JsonOutput do
+
+  let(:fixtures_project) do
+    proj = Slather::Project.open(FIXTURES_PROJECT_PATH)
+    proj.build_directory = TEMP_DERIVED_DATA_PATH
+    proj.binary_basename = ["fixturesTests", "libfixturesTwo"]
+    proj.input_format = "profdata"
+    proj.coverage_service = "json"
+    proj.configure
+    proj
+  end
+
+  describe '#coverage_file_class' do
+    it "should return ProfdataCoverageFile" do
+      expect(fixtures_project.send(:coverage_file_class)).to eq(Slather::ProfdataCoverageFile)
+    end
+  end
+
+  describe '#post' do
+    it "should create an JSON report spanning all coverage files" do
+      fixtures_project.post
+
+      output_json = JSON.parse(File.read('report.json'))
+      fixture_json = JSON.parse(File.read(FIXTURES_JSON_PATH))
+
+      expect(output_json).to eq(fixture_json)
+      FileUtils.rm('report.json')
+    end
+
+    it "should create an JSON report in the given output directory" do
+      fixtures_project.output_directory = "./output"
+      fixtures_project.post
+
+      filepath = "#{fixtures_project.output_directory}/report.json"
+      expect(File.exists?(filepath)).to be_truthy
+
+      FileUtils.rm_rf(fixtures_project.output_directory)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -13,7 +13,8 @@ require 'equivalent-xml'
 
 
 FIXTURES_XML_PATH = File.join(File.dirname(__FILE__), 'fixtures/cobertura.xml')
-FIXTURES_JSON_PATH = File.join(File.dirname(__FILE__), 'fixtures/gutter.json')
+FIXTURES_JSON_PATH = File.join(File.dirname(__FILE__), 'fixtures/report.json')
+FIXTURES_GUTTER_JSON_PATH = File.join(File.dirname(__FILE__), 'fixtures/gutter.json')
 FIXTURES_HTML_FOLDER_PATH = File.join(File.dirname(__FILE__), 'fixtures/fixtures_html')
 FIXTURES_PROJECT_PATH = File.join(File.dirname(__FILE__), 'fixtures/fixtures.xcodeproj')
 FIXTURES_WORKSPACE_PATH = File.join(File.dirname(__FILE__), 'fixtures/fixtures.xcworkspace')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slather
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.4.3
 platform: ruby
 authors:
 - Mark Larsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -168,16 +168,22 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
   requirement: !ruby/object:Gem::Requirement
@@ -246,6 +252,7 @@ files:
 - lib/slather/coverage_service/gutter_json_output.rb
 - lib/slather/coverage_service/hardcover.rb
 - lib/slather/coverage_service/html_output.rb
+- lib/slather/coverage_service/json_output.rb
 - lib/slather/coverage_service/simple_output.rb
 - lib/slather/coveralls_coverage.rb
 - lib/slather/profdata_coverage_file.rb
@@ -294,6 +301,7 @@ files:
 - spec/fixtures/fixtures_html/index.html
 - "spec/fixtures/fixtures_html/peekaviewTests\U0001F4A3.m.html"
 - spec/fixtures/gutter.json
+- spec/fixtures/report.json
 - spec/slather/cocoapods_plugin_spec.rb
 - spec/slather/coverage_file_spec.rb
 - spec/slather/coverage_service/cobertura_xml_spec.rb
@@ -301,6 +309,7 @@ files:
 - spec/slather/coverage_service/gutter_json_spec.rb
 - spec/slather/coverage_service/hardcover_spec.rb
 - spec/slather/coverage_service/html_output_spec.rb
+- spec/slather/coverage_service/json_spec.rb
 - spec/slather/coverage_service/simple_output_spec.rb
 - spec/slather/fixtures.gcno
 - spec/slather/profdata_coverage_spec.rb
@@ -373,6 +382,7 @@ test_files:
 - spec/fixtures/fixtures_html/index.html
 - "spec/fixtures/fixtures_html/peekaviewTests\U0001F4A3.m.html"
 - spec/fixtures/gutter.json
+- spec/fixtures/report.json
 - spec/slather/cocoapods_plugin_spec.rb
 - spec/slather/coverage_file_spec.rb
 - spec/slather/coverage_service/cobertura_xml_spec.rb
@@ -380,6 +390,7 @@ test_files:
 - spec/slather/coverage_service/gutter_json_spec.rb
 - spec/slather/coverage_service/hardcover_spec.rb
 - spec/slather/coverage_service/html_output_spec.rb
+- spec/slather/coverage_service/json_spec.rb
 - spec/slather/coverage_service/simple_output_spec.rb
 - spec/slather/fixtures.gcno
 - spec/slather/profdata_coverage_spec.rb