slather 1.8.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f112ecdd585fc0e1ec5d2a20e10b9ab38a3a355
-  data.tar.gz: a10bcd0d9036bb4e66ca5dd91cf6d874ca667b6e
+  metadata.gz: e29925c45c07bc530dfadabea493ce213e7c463e
+  data.tar.gz: 4349b2ddac614dc2743cf512ca537637bb765c04
 SHA512:
-  metadata.gz: 46cf336e773f273f6e0ac10131028725f6a5d908dd86315d7615c89bdc9d2a113d4cb271bb1ba511626300c7d952c995284cbd2671a1527c26ff0cc5c44e8090
-  data.tar.gz: fc30e49d6dbd3c0589830aa80ef8d0942f17574b5fb4c57ec0bfaa611e09a62eb79e626557031ce09fba11c79407bfa97734991dd78309452fb87c9e7af6d256
+  metadata.gz: 12f3d539e348aea80bb1ef490ff281ef4b250de56e21682cdfdfbb1a8371ca62253d693e87ddf14496fee037df2b86b0fff11181e14282eb358232ac0a40b47b
+  data.tar.gz: e2025df52453c14802781dd7f41bfa2c0f991ef8893febe01a6a14ccff2136d8c50a4c6360b117d34037bc0eb69d8667b437d98b68b8677f581702271febd68f

data/.gitignore

@@ -23,7 +23,6 @@ mkmf.log
 
 # Xcode
 #
-build/
 *.pbxuser
 !default.pbxuser
 *.mode1v3
@@ -43,3 +42,5 @@ DerivedData
 cobertura.xml
 .gutter.json
 html
+*.gcda
+*.gcno

data/.travis.yml

@@ -1,5 +1,6 @@
 language: objective-c
 script: bundle exec rspec 
+osx_image: xcode7
 
 # Sets Travis to run the Ruby specs on OS X machines which are required to
 # build the native extensions of Xcodeproj.

data/CHANGELOG.md

@@ -2,7 +2,27 @@
 
 ## master
 
-## v1.8.2
+## v2.0.0
+* Correct html rendering when using profdata format   
+  [cutz](https://github.com/cutz)
+  [#124](https://github.com/SlatherOrg/slather/pull/124)
+
+* Making HTML directory self contained   
+  [Colin Cornaby](https://github.com/colincornaby)
+  [#137](https://github.com/SlatherOrg/slather/pull/137)
+
+* Add `binary_basename` configuration option   
+  [Boris Bügling](https://github.com/neonichu)
+  [#128](https://github.com/SlatherOrg/slather/pull/128)
+
+* Add support to profdata file format   
+  [Simone Civetta](https://github.com/viteinfinite)
+  [Olivier Halligon](https://github.com/AliSoftware)
+  [Matt Delves](https://github.com/mattdelves)
+  [Pierre-Marc Airoldi](https://github.com/petester42)
+  [#92](https://github.com/venmo/slather/pull/92)
+
+## v1.8.3
 * Add buildkite support to coveralls   
   [David Hardiman](https://github.com/dhardiman)
   [#98](https://github.com/venmo/slather/pull/98)

data/README.md

@@ -1,10 +1,10 @@
 
 
-![Slather Logo](https://raw.githubusercontent.com/venmo/slather/master/docs/logo.jpg)
+![Slather Logo](https://raw.githubusercontent.com/SlatherOrg/slather/master/docs/logo.jpg)
 
 [![Gem Version](https://badge.fury.io/rb/slather.svg)](http://badge.fury.io/rb/slather)
-[![Build Status](https://travis-ci.org/venmo/slather.svg?branch=master)](https://travis-ci.org/venmo/slather)
-[![Coverage Status](https://coveralls.io/repos/venmo/slather/badge.svg?branch=ayanonagon%2Fcoveralls)](https://coveralls.io/r/venmo/slather?branch=ayanonagon%2Fcoveralls)
+[![Build Status](https://travis-ci.org/SlatherOrg/slather.svg?branch=master)](https://travis-ci.org/SlatherOrg/slather)
+[![Coverage Status](https://coveralls.io/repos/SlatherOrg/slather/badge.svg?branch=master)](https://coveralls.io/r/SlatherOrg/slather?branch=master)
 
 Generate test coverage reports for Xcode projects & hook it into CI.
 
@@ -33,21 +33,26 @@ $ bundle
 
 ## Usage
 
-Set up your project for test coverage:
+Apple drastically improved the support for code coverage in Xcode 7, including dedicated UI for enabling it. You can now setup your project for test coverage inside the scheme editor, by ticking the *"Gather coverage data"* checkbox:
+
+![](README_Images/test_scheme.png)
+
+To verify you're ready to generate test coverage, run your test suite on your project, and then run:
 
 ```sh
-$ slather setup path/to/project.xcodeproj
+$ slather coverage -s path/to/project.xcodeproj
 ```
 
-This will enable the `Generate Test Coverage` and `Instrument Program Flow` flags for your project.
-
+### Previous versions of Xcode
 
-To verify you're ready to generate test coverage, run your test suite on your project, and then run:
+Set up your project for test coverage:
 
 ```sh
-$ slather coverage -s path/to/project.xcodeproj
+$ slather setup path/to/project.xcodeproj
 ```
 
+This will enable the `Generate Test Coverage` and `Instrument Program Flow` flags for your project.
+
 ### Usage with Codecov
 
 Login to [Codecov](https://codecov.io/) (no need to activate a repository, this happens automatically). Right now, `slather` supports Codecov via **all** supported CI providers [listed here](https://github.com/codecov/codecov-bash#ci-providers).
@@ -193,7 +198,7 @@ Slather will look for the test coverage files in `DerivedData` by default. If yo
 
 ## Contributing
 
-We’d love to see your ideas for improving this library! The best way to contribute is by submitting a pull request. We’ll do our best to respond to your patch as soon as possible. You can also submit a [new GitHub issue](https://github.com/venmo/slather/issues/new) if you find bugs or have questions. :octocat:
+We’d love to see your ideas for improving this library! The best way to contribute is by submitting a pull request. We’ll do our best to respond to your patch as soon as possible. You can also submit a [new GitHub issue](https://github.com/SlatherOrg/slather/issues/new) if you find bugs or have questions. :octocat:
 
 Please make sure to follow our general coding style and add test coverage for new features!
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+
+desc 'Execute tests'
+task :spec do
+  sh 'bundle exec rspec spec'
+end
+

data/bin/slather

@@ -9,7 +9,7 @@ Clamp do
 
   subcommand "coverage", "Computes coverage for the supplied project" do
 
-    parameter "[xcodeproj]", "Path to the xcodeproj", :attribute_name => :xcodeproj_path
+    parameter "[PROJECT]", "Path to the xcodeproj", :attribute_name => :xcodeproj_path
 
     option ["--travis", "-t"], :flag, "Indicate that the builds are running on Travis CI"
     option ["--circleci"], :flag, "Indicate that the builds are running on CircleCI"
@@ -27,6 +27,12 @@ Clamp do
     option ["--source-directory"], "SOURCE_DIRECTORY", "The directory where your source files are located."
     option ["--output-directory"], "OUTPUT_DIRECTORY", "The directory where your Cobertura XML report will be written to."
     option ["--ignore", "-i"], "IGNORE", "ignore files conforming to a path", :multivalued => true
+    option ["--verbose", "-v"], :flag, "Enable verbose mode"
+
+    option ["--input-format"], "INPUT_FORMAT", "Input format (gcov, profdata)"
+    option ["--scheme"], "SCHEME", "The scheme for which the coverage was generated"
+    option ["--binary-file"], "BINARY_FILE", "The binary file against the which the coverage will be run"
+    option ["--binary-basename"], "BINARY_BASENAME", "Basename of the file against which the coverage will be run"
 
     def execute
       puts "Slathering..."
@@ -37,6 +43,13 @@ Clamp do
       setup_source_directory
       setup_output_directory
       setup_coverage_service
+      setup_verbose_mode
+      setup_input_format
+      setup_scheme
+      setup_binary_file
+      setup_binary_basename
+
+      project.configure
 
       post
 
@@ -81,7 +94,7 @@ Clamp do
         if xcodeproj_path_to_open
           project = Slather::Project.open(xcodeproj_path_to_open)
         else
-          raise StandardError, "Must provide an xcodeproj through .slather.yml"
+          raise StandardError, "Must provide an xcodeproj either via the 'slather [SUBCOMMAND] [PROJECT].xcodeproj' command or through .slather.yml"
         end
       end
     end
@@ -101,15 +114,41 @@ Clamp do
       end
     end
 
+    def setup_verbose_mode
+      project.verbose_mode = verbose?
+    end
+
+    def setup_input_format
+      project.input_format = input_format
+    end
+
+    def setup_scheme
+      project.scheme = scheme
+    end
+
+    def setup_binary_file
+      project.binary_file = binary_file
+    end
+
+    def setup_binary_basename
+      project.binary_basename = binary_basename
+    end
+
   end
 
-  subcommand "setup", "Configures an xcodeproj for test coverage generation" do
+  subcommand "setup", "Configures a .xcodeproj for test coverage generation" do
+
+    parameter "[PROJECT]", "Path to the .xcodeproj", :attribute_name => :xcodeproj_path
 
-    parameter "[xcodeproj]", "Path to the xcodeproj", :attribute_name => :xcodeproj_path
+    option ["--format"], "FORMAT", "Type of coverage to use (gcov, clang, auto)"
 
     def execute
-      project = Slather::Project.open(xcodeproj_path)
-      project.setup_for_coverage
+      xcodeproj_path_to_open = xcodeproj_path || Slather::Project.yml["xcodeproj"]
+      unless xcodeproj_path_to_open
+        raise StandardError, "Must provide a .xcodeproj either via the 'slather [SUBCOMMAND] [PROJECT].xcodeproj' command or through .slather.yml"
+      end
+      project = Slather::Project.open(xcodeproj_path_to_open)
+      project.setup_for_coverage(format ? format.to_sym : :auto)
       project.save
     end
 

data/lib/slather/coverage_file.rb

@@ -1,6 +1,12 @@
+require 'slather/coverage_info'
+require 'slather/coveralls_coverage'
+
 module Slather
   class CoverageFile
 
+    include CoverageInfo
+    include CoverallsCoverage
+
     attr_accessor :project, :gcno_file_pathname
 
     def initialize(project, gcno_file_pathname)
@@ -11,7 +17,6 @@ module Slather
     def source_file_pathname
       @source_file_pathname ||= begin
         base_filename = gcno_file_pathname.basename.sub_ext("")
-        # TODO: Handle Swift
         path = nil
         if project.source_directory
           path = Dir["#{project.source_directory}/**/#{base_filename}.{#{supported_file_extensions.join(",")}}"].first
@@ -36,10 +41,6 @@ module Slather
       source_file.read
     end
 
-    def source_file_pathname_relative_to_repo_root
-      source_file_pathname.realpath.relative_path_from(Pathname("./").realpath)
-    end
-
     def gcov_data
       @gcov_data ||= begin
         gcov_output = `gcov "#{source_file_pathname}" --object-directory "#{gcno_file_pathname.parent}" --branch-probabilities --branch-counts`
@@ -58,6 +59,24 @@ module Slather
       end
     end
 
+    def all_lines
+      unless cleaned_gcov_data.empty?
+        first_line_start = cleaned_gcov_data =~ /^\s+(-|#+|[0-9+]):\s+1:/
+        cleaned_gcov_data[first_line_start..-1].split("\n").map
+      else
+        []
+      end
+    end
+
+    def cleaned_gcov_data
+      data = gcov_data.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '').gsub(/^function(.*) called [0-9]+ returned [0-9]+% blocks executed(.*)$\r?\n/, '')
+      data.gsub(/^branch(.*)$\r?\n/, '')
+    end
+
+    def raw_data
+      self.gcov_data
+    end
+
     def line_coverage_data
       unless cleaned_gcov_data.empty?
         first_line_start = cleaned_gcov_data =~ /^\s+(-|#+|[0-9+]):\s+1:/
@@ -70,9 +89,8 @@ module Slather
       end
     end
 
-    def cleaned_gcov_data
-      data = gcov_data.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '').gsub(/^function(.*) called [0-9]+ returned [0-9]+% blocks executed(.*)$\r?\n/, '')
-      data.gsub(/^branch(.*)$\r?\n/, '')
+    def line_number_in_line(line)
+      line.split(':')[1].strip.to_i
     end
 
     def coverage_for_line(line)
@@ -89,102 +107,31 @@ module Slather
       end
     end
 
-    def num_lines_tested
-      line_coverage_data.compact.select { |cd| cd > 0 }.count
-    end
-
-    def num_lines_testable
-      line_coverage_data.compact.count
-    end
-
-    def rate_lines_tested
-      if num_lines_testable > 0
-        (num_lines_tested / num_lines_testable.to_f)
-      else
-        0
-      end
-    end
-
-    def percentage_lines_tested
-      if num_lines_testable == 0
-        100
-      else
-        rate_lines_tested * 100
-      end
-    end
-
     def branch_coverage_data
       @branch_coverage_data ||= begin
         branch_coverage_data = Hash.new
 
-          gcov_data.scan(/(^(\s+(-|#+|[0-9]+):\s+[1-9]+:(.*)$\r?\n)(^branch\s+[0-9]+\s+[a-zA-Z0-9]+\s+[a-zA-Z0-9]+$\r?\n)+)+/) do |data|
-            lines = data[0].split("\n")
-            line_number = lines[0].split(':')[1].strip.to_i
-            branch_coverage_data[line_number] = lines[1..-1].map do |line|
-              if line.split(' ')[2].strip == "never"
-                0
-              else
-                line.split(' ')[3].strip.to_i
-              end
+        gcov_data.scan(/(^(\s+(-|#+|[0-9]+):\s+[1-9]+:(.*)$\r?\n)(^branch\s+[0-9]+\s+[a-zA-Z0-9]+\s+[a-zA-Z0-9]+$\r?\n)+)+/) do |data|
+          lines = data[0].split("\n")
+          line_number = lines[0].split(':')[1].strip.to_i
+          branch_coverage_data[line_number] = lines[1..-1].map do |line|
+            if line.split(' ')[2].strip == "never"
+              0
+            else
+              line.split(' ')[3].strip.to_i
             end
           end
+        end
         branch_coverage_data
       end
     end
 
-    def branch_coverage_data_for_statement_on_line(line_number)
-      branch_coverage_data[line_number] || []
-    end
-
-    def num_branches_for_statement_on_line(line_number)
-      branch_coverage_data_for_statement_on_line(line_number).length
-    end
-
-    def num_branch_hits_for_statement_on_line(line_number)
-      branch_coverage_data_for_statement_on_line(line_number).count { |hit_count| hit_count > 0 }
-    end
-
-    def rate_branch_coverage_for_statement_on_line(line_number)
-      branch_data = branch_coverage_data_for_statement_on_line(line_number)
-      if branch_data.empty?
-        0.0
-      else
-        (num_branch_hits_for_statement_on_line(line_number) / branch_data.length.to_f)
-      end
-    end
-
-    def percentage_branch_coverage_for_statement_on_line(line_number)
-      rate_branch_coverage_for_statement_on_line(line_number) * 100
-    end
-
-    def num_branches_testable
-      branch_coverage_data.keys.reduce(0) do |sum, line_number|
-        sum += num_branches_for_statement_on_line(line_number)
-      end
-    end
-
-    def num_branches_tested
-      branch_coverage_data.keys.reduce(0) do |sum, line_number|
-        sum += num_branch_hits_for_statement_on_line(line_number)
-      end
-    end
-
-    def rate_branches_tested
-      if (num_branches_testable > 0)
-        (num_branches_tested / num_branches_testable.to_f)
-      else
-        0.0
-      end
-    end
-
     def source_file_basename
       File.basename(source_file_pathname, '.m')
     end
 
-    def ignored?
-      project.ignore_list.any? do |ignore|
-        File.fnmatch(ignore, source_file_pathname_relative_to_repo_root)
-      end
+    def line_number_separator
+      ":"
     end
 
     def supported_file_extensions

data/lib/slather/coverage_info.rb

@@ -0,0 +1,84 @@
+module Slather
+  module CoverageInfo
+
+    def num_lines_tested
+      line_coverage_data.compact.select { |cd| cd > 0 }.count
+    end
+
+    def num_lines_testable
+      line_coverage_data.compact.count
+    end
+
+    def rate_lines_tested
+      if num_lines_testable > 0
+        (num_lines_tested / num_lines_testable.to_f)
+      else
+        0
+      end
+    end
+
+    def percentage_lines_tested
+      if num_lines_testable == 0
+        100
+      else
+        rate_lines_tested * 100
+      end
+    end
+
+    def branch_coverage_data_for_statement_on_line(line_number)
+      branch_coverage_data[line_number] || []
+    end
+
+    def num_branches_for_statement_on_line(line_number)
+      branch_coverage_data_for_statement_on_line(line_number).length
+    end
+
+    def num_branch_hits_for_statement_on_line(line_number)
+      branch_coverage_data_for_statement_on_line(line_number).count { |hit_count| hit_count > 0 }
+    end
+
+    def rate_branch_coverage_for_statement_on_line(line_number)
+      branch_data = branch_coverage_data_for_statement_on_line(line_number)
+      if branch_data.empty?
+        0.0
+      else
+        (num_branch_hits_for_statement_on_line(line_number) / branch_data.length.to_f)
+      end
+    end
+
+    def percentage_branch_coverage_for_statement_on_line(line_number)
+      rate_branch_coverage_for_statement_on_line(line_number) * 100
+    end
+
+    def num_branches_testable
+      branch_coverage_data.keys.reduce(0) do |sum, line_number|
+        sum += num_branches_for_statement_on_line(line_number)
+      end
+    end
+
+    def num_branches_tested
+      branch_coverage_data.keys.reduce(0) do |sum, line_number|
+        sum += num_branch_hits_for_statement_on_line(line_number)
+      end
+    end
+
+    def rate_branches_tested
+      if (num_branches_testable > 0)
+        (num_branches_tested / num_branches_testable.to_f)
+      else
+        0.0
+      end
+    end
+
+    def source_file_pathname_relative_to_repo_root
+      source_file_pathname.realpath.relative_path_from(Pathname("./").realpath)
+    end
+
+    def ignored?
+      project.ignore_list.any? do |ignore|
+        File.fnmatch(ignore, source_file_pathname_relative_to_repo_root)
+      end
+    end
+
+  end
+end

data/lib/slather/coverage_service/cobertura_xml_output.rb

@@ -5,7 +5,11 @@ module Slather
     module CoberturaXmlOutput
 
       def coverage_file_class
-        Slather::CoverageFile
+        if input_format == "profdata"
+          Slather::ProfdataCoverageFile
+        else
+          Slather::CoverageFile
+        end
       end
       private :coverage_file_class
 
@@ -23,9 +27,10 @@ module Slather
         File.write(output_file, report.to_s)
       end
 
-      def grouped_coverage_files
+      def grouped_coverage_files(coverage_files)
         groups = Hash.new
         coverage_files.each do |coverage_file|
+          next if coverage_file == nil
           path = File.dirname(coverage_file.source_file_pathname_relative_to_repo_root)
           if groups[path] == nil
             groups[path] = Array.new
@@ -50,7 +55,7 @@ module Slather
         packages_node = @doc.at_css "packages"
 
         # group files by path
-        grouped_coverage_files.each do |path , package_coverage_files|
+          grouped_coverage_files(coverage_files).each do |path , package_coverage_files|
           package_node = Nokogiri::XML::Node.new "package", @doc
           package_node.parent = packages_node
           classes_node = Nokogiri::XML::Node.new "classes", @doc
@@ -127,8 +132,7 @@ module Slather
         lines_node = Nokogiri::XML::Node.new "lines", @doc
         lines_node.parent = class_node
         
-        coverage_file.cleaned_gcov_data.split("\n").each do |line|
-          line_segments = line.split(':')
+        coverage_file.all_lines.each do |line|
           if coverage_file.coverage_for_line(line)
             line_node = create_line_node(line, coverage_file)
             line_node.parent = lines_node
@@ -138,7 +142,7 @@ module Slather
       end
 
       def create_line_node(line, coverage_file)
-        line_number = line.split(':')[1].strip.to_i
+        line_number = coverage_file.line_number_in_line(line)
         line_node = Nokogiri::XML::Node.new "line", @doc
         line_node['number'] = line_number
         line_node['branch'] = "false"

data/lib/slather/coverage_service/coveralls.rb

@@ -3,7 +3,11 @@ module Slather
     module Coveralls
 
       def coverage_file_class
-        Slather::CoverallsCoverageFile
+        if input_format == "profdata"
+          Slather::ProfdataCoverageFile
+        else
+          Slather::CoverageFile
+        end
       end
       private :coverage_file_class
 

data/lib/slather/coverage_service/gutter_json_output.rb

@@ -3,7 +3,11 @@ module Slather
     module GutterJsonOutput
 
       def coverage_file_class
-        Slather::CoverageFile
+        if input_format == "profdata"
+          Slather::ProfdataCoverageFile
+        else
+          Slather::CoverageFile
+        end
       end
       private :coverage_file_class
 
@@ -12,24 +16,24 @@ module Slather
         symbols = {}
 
         coverage_files.each do |coverage_file|
-          next unless coverage_file.gcov_data
+          next unless coverage_file.raw_data
 
           filename = coverage_file.source_file_pathname.to_s
           filename = filename.sub(Pathname.pwd.to_s, '').reverse.chomp("/").reverse
 
-          coverage_file.cleaned_gcov_data.split("\n").each do |line|
-            data = line.split(':')
+          coverage_file.all_lines.each do |line|
 
-            line_number = data[1].to_i
+            line_number = coverage_file.line_number_in_line(line)
             next unless line_number > 0
 
-            coverage = data[0].strip
+            coverage = coverage_file.coverage_for_line(line)
+            short_text = coverage != nil ? coverage.to_s : "-"
 
             symbol = {  'line' => line_number,
                         'long_text' => '',
-                        'short_text' => coverage }
+                        'short_text' => short_text }
 
-            if coverage != '-'
+            if coverage != nil
               symbol['background_color'] = coverage.to_i > 0 ? '0x35CC4B' : '0xFC635E'
             end
 

data/lib/slather/coverage_service/hardcover.rb

@@ -3,7 +3,11 @@ module Slather
     module Hardcover
 
       def coverage_file_class
-        Slather::CoverallsCoverageFile
+        if input_format == "profdata"
+          Slather::ProfdataCoverageFile
+        else
+          Slather::CoverageFile
+        end
       end
       private :coverage_file_class