slather 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6570b6eb98ca404460677120ce2bff49446d5047
-  data.tar.gz: a387ce407d1748ba2fcb6cc57261c601f53900fb
+  metadata.gz: 46f9e4fda1716e9fef3ef6cf621c7008d1b3f0ed
+  data.tar.gz: 4f34b0648dcd51da3480ba7bc138069790096345
 SHA512:
-  metadata.gz: bd10828959766f25526d693082585fb5a08295c79e3f1c8e48181abb3c3235e85f043c45a2fdb8cef4e33f3feaf1b39054a8df4ef64d4a78567f85b8c0989e61
-  data.tar.gz: 3226f015ea7a407d33112f275d231ef3935f8e96d1d9724ab93b577ed2b049d21e2d24765d80188a7826508b62ce403a22248071c54d0d3bb0e087545dc79d4d
+  metadata.gz: 6a5ab9bfa9dc93b84d94eccaf2f2d6313ab98efbc46e60d3df0bd10244d77e5c48994f83e4e8430d349a80b9a8219cdfb3942e8ee4fe81ba0cc98be60847dd11
+  data.tar.gz: 41d88beeca785be4edd61526e455ed2a6265078536332b1ba1adee3f4e1a813b129f833871a554950c26d6c9b292f775da835f6ee0b121b5c1ec4b86606ac0df

data/README.md

@@ -72,6 +72,26 @@ install: bundle install --without=documentation --path ../travis_bundle_dir
 after_success: slather
 ```
 
+### Cobertura
+
+To create a Cobertura XML report set `cobertura_xml` as coverage service inside your `.slather.yml`:
+
+```yml
+# .slather.yml
+
+coverage_service: cobertura_xml
+xcodeproj: path/to/project.xcodeproj
+ignore:
+  - ExamplePodCode/*
+  - ProjectTestsGroup/*
+```
+
+Or use the command line options `--cobertura-xml` or `-x`:
+
+```sh
+$ slather coverage -x
+```
+
 ### Coverage for code included via CocoaPods
 
 If you're trying to compute the coverage of code that has been included via
@@ -86,7 +106,7 @@ source_directory: Pods/AFNetworking
 
 ### Custom Build Directory
 
-Slather will look for the test coverage files in `DerivedData` by default. If you send build output to a custom location, like [this](https://github.com/erikdoe/ocmock/blob/master/Tools/travis.sh#L12), then you should also set the `build_directory` property in `.slather.yml`
+Slather will look for the test coverage files in `DerivedData` by default. If you send build output to a custom location, like [this](https://github.com/erikdoe/ocmock/blob/7f4d22b38eedf1bb9a12ab1591ac0a5d436db61a/Tools/travis.sh#L12), then you should also set the `build_directory` property in `.slather.yml`
 
 ## Contributing
 

data/bin/slather

@@ -16,6 +16,7 @@ Clamp do
     option ["--coveralls", "-c"], :flag, "Post coverage results to coveralls"
     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 ["--build-directory", "-b"], "BUILD_DIRECTORY", "The directory where gcno files will be written to. Defaults to derived data."
     option ["--source-directory"], "SOURCE_DIRECTORY", "The directory where your source files are located."
@@ -75,6 +76,8 @@ Clamp do
         project.coverage_service = :terminal
       elsif gutter_json?
         project.coverage_service = :gutter_json
+      elsif cobertura_xml?
+        project.coverage_service = :cobertura_xml
       end
     end
 

data/lib/slather.rb

@@ -2,6 +2,7 @@ require 'slather/version'
 require 'slather/project'
 require 'slather/coverage_file'
 require 'slather/coveralls_coverage_file'
+require 'slather/coverage_service/cobertura_xml_output'
 require 'slather/coverage_service/coveralls'
 require 'slather/coverage_service/gutter_json_output'
 require 'slather/coverage_service/simple_output'

data/lib/slather/coverage_file.rb

@@ -38,7 +38,7 @@ module Slather
 
     def gcov_data
       @gcov_data ||= begin
-        gcov_output = `gcov "#{source_file_pathname}" --object-directory "#{gcno_file_pathname.parent}"`
+        gcov_output = `gcov "#{source_file_pathname}" --object-directory "#{gcno_file_pathname.parent}" --branch-probabilities --branch-counts`
         # Sometimes gcov makes gcov files for Cocoa Touch classes, like NSRange. Ignore and delete later.
         gcov_files_created = gcov_output.scan(/creating '(.+\..+\.gcov)'/)
 
@@ -48,16 +48,15 @@ module Slather
         end
 
         gcov_files_created.each { |file| FileUtils.rm_f(file) }
-
         gcov_data
       end
     end
 
-    def coverage_data
-      if gcov_data
-        first_line_start = gcov_data =~ /^\s+(-|#+|[0-9+]):\s+1:/
+    def line_coverage_data
+      if cleaned_gcov_data
+        first_line_start = cleaned_gcov_data =~ /^\s+(-|#+|[0-9+]):\s+1:/
 
-        gcov_data[first_line_start..-1].split("\n").map do |line|
+        cleaned_gcov_data[first_line_start..-1].split("\n").map do |line|
           coverage_for_line(line)
         end
       else
@@ -65,6 +64,11 @@ module Slather
       end
     end
 
+    def cleaned_gcov_data
+      data = gcov_data.gsub(/^function(.*) called [0-9]+ returned [0-9]+% blocks executed(.*)$\r?\n/, '')
+      data.gsub(/^branch(.*)$\r?\n/, '')
+    end
+
     def coverage_for_line(line)
       line =~ /^(.+?):/
 
@@ -80,11 +84,15 @@ module Slather
     end
 
     def num_lines_tested
-      coverage_data.compact.select { |cd| cd > 0 }.count
+      line_coverage_data.compact.select { |cd| cd > 0 }.count
     end
 
     def num_lines_testable
-      coverage_data.compact.count
+      line_coverage_data.compact.count
+    end
+
+    def rate_lines_tested
+      (num_lines_tested / num_lines_testable.to_f)
     end
 
     def percentage_lines_tested
@@ -95,6 +103,74 @@ module Slather
       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)+)+/) {|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
+        }
+        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 == nil
+        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)
+        0.0
+      else
+        (num_branches_tested / num_branches_testable.to_f)
+      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)

data/lib/slather/coverage_service/cobertura_xml_output.rb

@@ -0,0 +1,167 @@
+require 'nokogiri'
+
+module Slather
+  module CoverageService
+    module CoberturaXmlOutput
+
+      def coverage_file_class
+        Slather::CoverageFile
+      end
+      private :coverage_file_class
+
+      def post
+        cobertura_xml_report = create_xml_report(coverage_files)
+        File.open('cobertura.xml', 'w') { |file|
+          file.write(cobertura_xml_report.to_s)
+        }
+      end
+
+      def grouped_coverage_files
+        groups = Hash.new
+        coverage_files.each do |coverage_file|
+          path = File.dirname(coverage_file.source_file_pathname_relative_to_repo_root)
+          if groups[path] == nil
+            groups[path] = Array.new
+          end
+          groups[path].push(coverage_file)
+        end
+        groups
+      end
+
+      def create_xml_report(coverage_files)
+        total_project_lines = 0
+        total_project_lines_tested = 0
+        total_project_line_rate = 0.0
+        total_project_branches = 0
+        total_project_branches_tested = 0
+
+        create_empty_xml_report
+        coverage_node = @doc.root
+        source_node = @doc.at_css "source" 
+        source_node.content = Pathname.pwd.to_s
+        packages_node = @doc.at_css "packages"
+
+        # group files by path
+        grouped_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
+          classes_node.parent = package_node
+          package_node['name'] = path.gsub(/\//, '.')
+
+          total_package_lines = 0
+          total_package_lines_tested = 0
+          total_package_lines_rate = 0.0
+          total_package_branches = 0
+          total_package_branches_tested = 0
+
+          package_coverage_files.each do |package_coverage_file|
+            next unless package_coverage_file.gcov_data
+            class_node = create_class_node(package_coverage_file)
+            class_node.parent = classes_node
+            total_package_lines += package_coverage_file.num_lines_testable
+            total_package_lines_tested += package_coverage_file.num_lines_tested
+            total_package_branches += package_coverage_file.num_branches_testable
+            total_package_branches_tested += package_coverage_file.num_branches_tested
+          end
+
+          total_package_line_rate = '%.16f' % (total_package_lines_tested / total_package_lines.to_f)
+          total_package_branch_rate = '%.16f' % (total_package_branches_tested / total_package_branches.to_f)
+
+          package_node['line-rate'] = total_package_line_rate
+          package_node['branch-rate'] = total_package_branch_rate
+          package_node['complexity'] = '0.0'
+
+          total_project_lines += total_package_lines
+          total_project_lines_tested += total_package_lines_tested
+          total_project_branches += total_package_branches
+          total_project_branches_tested += total_package_branches_tested
+        end
+
+        total_project_line_rate = '%.16f' % (total_project_lines_tested / total_project_lines.to_f)
+        total_project_branch_rate = '%.16f' % (total_project_branches_tested / total_project_branches.to_f)
+
+        coverage_node['line-rate'] = total_project_line_rate
+        coverage_node['branch-rate'] = total_project_branch_rate
+        coverage_node['lines-covered'] = total_project_lines_tested
+        coverage_node['lines-valid'] = total_project_lines
+        coverage_node['branches-covered'] = total_project_branches_tested
+        coverage_node['branches-valid'] = total_project_branches
+        coverage_node['complexity'] = "0.0"
+        coverage_node['timestamp'] = DateTime.now.strftime('%s')
+        coverage_node['version'] = "Slather #{Slather::VERSION}"
+        @doc.to_xml
+      end
+
+      def create_class_node(coverage_file)
+        filename = coverage_file.source_file_basename
+        filepath = coverage_file.source_file_pathname_relative_to_repo_root.to_s
+
+        class_node = Nokogiri::XML::Node.new "class", @doc
+        class_node['name'] = filename
+        class_node['filename'] = filepath
+        class_node['line-rate'] = '%.16f' % coverage_file.rate_lines_tested
+        class_node['branch-rate'] = '1.0'
+
+        methods_node = Nokogiri::XML::Node.new "methods", @doc
+        methods_node.parent = class_node
+        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(':')
+          if coverage_file.coverage_for_line(line)
+            line_number = line_segments[1].strip.to_i
+            line_node = create_line_node(line, coverage_file)
+            line_node.parent = lines_node
+          end
+        end
+        class_node['branch-rate'] = '%.16f' % [coverage_file.rate_branches_tested]
+        class_node['complexity'] = '0.0'
+        class_node
+      end
+
+      def create_line_node(line, coverage_file)
+        line_number = line.split(':')[1].strip.to_i
+        line_node = Nokogiri::XML::Node.new "line", @doc
+        line_node['number'] = line_number
+        line_node['branch'] = "false"
+        line_node['hits'] = coverage_file.coverage_for_line(line)
+      
+        if coverage_file.branch_coverage_data_for_statement_on_line(line_number)
+          line_node['branch'] = "true"  
+          conditions_node = Nokogiri::XML::Node.new "conditions", @doc
+          conditions_node.parent = line_node
+          condition_node = Nokogiri::XML::Node.new "condition", @doc
+          condition_node.parent = conditions_node
+          condition_node['number'] = "0"
+          condition_node['type'] = "jump"
+          branches_testable = coverage_file.num_branches_for_statement_on_line(line_number)
+          branch_hits = coverage_file.num_branch_hits_for_statement_on_line(line_number)
+          condition_coverage = coverage_file.percentage_branch_coverage_for_statement_on_line(line_number)
+          condition_node['coverage'] = "#{condition_coverage.to_i}%"
+          line_node['condition-coverage'] = "#{condition_coverage.to_i}% (#{branch_hits}/#{branches_testable})"
+        end
+        line_node
+      end
+
+      def create_empty_xml_report
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.doc.create_internal_subset(
+            'coverage',
+            nil,
+            "http://cobertura.sourceforge.net/xml/coverage-04.dtd"
+          )
+          xml.coverage do
+            xml.sources do
+              xml.source
+            end
+            xml.packages
+          end
+        end
+        @doc = builder.doc
+      end
+
+    end
+  end
+end

data/lib/slather/coverage_service/gutter_json_output.rb

@@ -17,7 +17,7 @@ module Slather
           filename = coverage_file.source_file_pathname.to_s
           filename = filename.sub(Pathname.pwd.to_s, '')[1..-1]
 
-          coverage_file.gcov_data.split("\n").each do |line|
+          coverage_file.cleaned_gcov_data.split("\n").each do |line|
             data = line.split(':')
 
             line_number = data[1].to_i

data/lib/slather/coveralls_coverage_file.rb

@@ -5,7 +5,7 @@ module Slather
       {
         :name => source_file_pathname_relative_to_repo_root.to_s,
         :source => source_data,
-        :coverage => coverage_data
+        :coverage => line_coverage_data
       }
     end
 

data/lib/slather/project.rb

@@ -106,8 +106,10 @@ module Slather
         extend(Slather::CoverageService::SimpleOutput)
       elsif service == :gutter_json
         extend(Slather::CoverageService::GutterJsonOutput)
+      elsif service == :cobertura_xml
+        extend(Slather::CoverageService::CoberturaXmlOutput)
       else
-        raise ArgumentError, "`#{coverage_service}` is not a valid coverage service. Try `terminal` or `coveralls`"
+        raise ArgumentError, "`#{coverage_service}` is not a valid coverage service. Try `terminal`, `coveralls`, `gutter_json` or `cobertura_xml`"
       end
       @coverage_service = service
     end

data/lib/slather/version.rb

@@ -1,3 +1,3 @@
 module Slather
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/slather.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "clamp", "~> 0.6"
   spec.add_dependency "xcodeproj", "~> 0.19.2"
+  spec.add_dependency "nokogiri", "~> 1.6.3"
 end

data/spec/fixtures/cobertura.xml

@@ -0,0 +1,128 @@
+<?xml version="1.0"?>
+<!DOCTYPE coverage SYSTEM "http://cobertura.sourceforge.net/xml/coverage-04.dtd">
+<coverage line-rate="0.6603773584905660" branch-rate="0.1190476190476190" lines-covered="35" lines-valid="53" branches-covered="5" branches-valid="42" complexity="0.0" timestamp="" version="">
+  <sources>
+    <source></source>
+  </sources>
+  <packages>
+    <package name="spec.fixtures.fixtures.more_files" line-rate="0.3846153846153846" branch-rate="0.3333333333333333" complexity="0.0">
+      <classes>
+        <class name="Branches" filename="spec/fixtures/fixtures/more_files/Branches.m" line-rate="0.5000000000000000" branch-rate="0.4000000000000000" complexity="0.0">
+          <methods/>
+          <lines>
+            <line number="13" branch="false" hits="2"/>
+            <line number="15" branch="true" hits="2" condition-coverage="100% (2/2)">
+              <conditions>
+                <condition number="0" type="jump" coverage="100%"/>
+              </conditions>
+            </line>
+            <line number="16" branch="false" hits="1"/>
+            <line number="18" branch="true" hits="1" condition-coverage="50% (1/2)">
+              <conditions>
+                <condition number="0" type="jump" coverage="50%"/>
+              </conditions>
+            </line>
+            <line number="19" branch="false" hits="0"/>
+            <line number="20" branch="false" hits="0"/>
+            <line number="21" branch="false" hits="1"/>
+            <line number="22" branch="false" hits="1"/>
+            <line number="25" branch="false" hits="2"/>
+            <line number="26" branch="true" hits="2" condition-coverage="50% (1/2)">
+              <conditions>
+                <condition number="0" type="jump" coverage="50%"/>
+              </conditions>
+            </line>
+            <line number="27" branch="false" hits="2"/>
+            <line number="29" branch="true" hits="0" condition-coverage="0% (0/4)">
+              <conditions>
+                <condition number="0" type="jump" coverage="0%"/>
+              </conditions>
+            </line>
+            <line number="31" branch="false" hits="0"/>
+            <line number="32" branch="false" hits="0"/>
+            <line number="35" branch="false" hits="0"/>
+            <line number="36" branch="false" hits="0"/>
+            <line number="38" branch="false" hits="0"/>
+            <line number="39" branch="false" hits="0"/>
+            <line number="41" branch="false" hits="0"/>
+            <line number="43" branch="false" hits="2"/>
+          </lines>
+        </class>
+        <class name="peekaview" filename="spec/fixtures/fixtures/more_files/peekaview.m" line-rate="0.0000000000000000" branch-rate="0.0000000000000000" complexity="0.0">
+          <methods/>
+          <lines>
+            <line number="13" branch="false" hits="0"/>
+            <line number="15" branch="false" hits="0"/>
+            <line number="16" branch="true" hits="0" condition-coverage="0% (0/2)">
+              <conditions>
+                <condition number="0" type="jump" coverage="0%"/>
+              </conditions>
+            </line>
+            <line number="18" branch="false" hits="0"/>
+            <line number="19" branch="false" hits="0"/>
+            <line number="20" branch="false" hits="0"/>
+          </lines>
+        </class>
+      </classes>
+    </package>
+    <package name="spec.fixtures.fixtures" line-rate="0.5000000000000000" branch-rate="NaN" complexity="0.0">
+      <classes>
+        <class name="fixtures" filename="spec/fixtures/fixtures/fixtures.m" line-rate="0.5000000000000000" branch-rate="0.0000000000000000" complexity="0.0">
+          <methods/>
+          <lines>
+            <line number="15" branch="false" hits="1"/>
+            <line number="16" branch="false" hits="1"/>
+            <line number="20" branch="false" hits="0"/>
+            <line number="21" branch="false" hits="0"/>
+          </lines>
+        </class>
+      </classes>
+    </package>
+    <package name="spec.fixtures.fixturesTests" line-rate="1.0000000000000000" branch-rate="0.0333333333333333" complexity="0.0">
+      <classes>
+        <class name="BranchesTests" filename="spec/fixtures/fixturesTests/BranchesTests.m" line-rate="1.0000000000000000" branch-rate="0.0000000000000000" complexity="0.0">
+          <methods/>
+          <lines>
+            <line number="19" branch="false" hits="2"/>
+            <line number="21" branch="false" hits="2"/>
+            <line number="25" branch="false" hits="2"/>
+            <line number="26" branch="false" hits="2"/>
+            <line number="29" branch="false" hits="1"/>
+            <line number="30" branch="false" hits="1"/>
+            <line number="31" branch="false" hits="1"/>
+            <line number="34" branch="false" hits="1"/>
+            <line number="35" branch="false" hits="1"/>
+            <line number="36" branch="false" hits="1"/>
+          </lines>
+        </class>
+        <class name="fixturesTests" filename="spec/fixtures/fixturesTests/fixturesTests.m" line-rate="1.0000000000000000" branch-rate="0.0000000000000000" complexity="0.0">
+          <methods/>
+          <lines>
+            <line number="20" branch="false" hits="1"/>
+            <line number="22" branch="false" hits="1"/>
+            <line number="27" branch="false" hits="1"/>
+            <line number="28" branch="false" hits="1"/>
+            <line number="32" branch="false" hits="1"/>
+            <line number="33" branch="false" hits="1"/>
+            <line number="34" branch="false" hits="1"/>
+          </lines>
+        </class>
+        <class name="peekaviewTests" filename="spec/fixtures/fixturesTests/peekaviewTests.m" line-rate="1.0000000000000000" branch-rate="0.0333333333333333" complexity="0.0">
+          <methods/>
+          <lines>
+            <line number="19" branch="false" hits="1"/>
+            <line number="21" branch="false" hits="1"/>
+            <line number="26" branch="false" hits="1"/>
+            <line number="27" branch="false" hits="1"/>
+            <line number="31" branch="true" hits="2" condition-coverage="3% (1/30)">
+              <conditions>
+                <condition number="0" type="jump" coverage="3%"/>
+              </conditions>
+            </line>
+            <line number="32" branch="false" hits="1"/>
+          </lines>
+        </class>
+      </classes>
+    </package>
+  </packages>
+</coverage>