xcov 0.12.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bdbe837c78361b3aeaf31da767e58129ccd508d
-  data.tar.gz: 4f2f77ba7fd3921e11a89f12f974181d33e8f469
+  metadata.gz: a541fad0337d84ad690cb556ead08462a202d4ca
+  data.tar.gz: 92103ad669d1a7b30a7873ed400ea928bc1ba296
 SHA512:
-  metadata.gz: a8ac0d10a2ece773d76ff02f7394c244f8d992bc951826367fbaa2e4e5df9b1601a3c71c4c0a4be42221e8243c4f9237b4d55281ab79ea1bbbfb2650037322f7
-  data.tar.gz: 5ba1246ccfb26b870b46494848b901592c61a2e68bc1bf72a7d37977bdea6864859b7f3fcd9fef976793fbf630a78a409f6b600dd40e4602653c8dd466904726
+  metadata.gz: 0a0cd8ee13eec12362f5b89e92c3b91711f7fa7ead460985166439026cdc34c858a7f2b281503203f86e4aa8d75280359d0ca4ad2ef7a49b74e01da2e3b7f754
+  data.tar.gz: 25996d44347d50e596b0c0546917c146417c24498f6ef71534730aa8560c13aa603163aae0c5e50cc8ae42a157a2e3a6bde380c20eca7bcd9fc6e3357d678c85

data/README.md

@@ -58,6 +58,7 @@ xcov -w LystSDK.xcworkspace -s LystSDK -o xcov_output
 * `--json_report`: Enables the creation of a json report (optional).
 * `--markdown_report`: Enables the creation of a markdown report (optional).
 * `--skip_slack`: Add this flag to avoid publishing results on Slack (optional).
+* `--only_project_targets`: Display the coverage only for main project targets (e.g. skip Pods targets).
 
 _**Note:** All paths you provide should be absolute and unescaped_
 

data/lib/xcov/model/line.rb

@@ -0,0 +1,31 @@
+module Xcov
+  class Line
+
+    attr_reader :execution_count
+    attr_reader :executable
+    attr_reader :ranges
+
+    def initialize (execution_count, executable, ranges = nil)
+      @execution_count = execution_count
+      @executable = executable
+      @ranges = ranges
+    end
+
+    def covered?
+      execution_count > 0
+    end
+
+    # Class methods
+
+    def self.map (dictionary)
+      ranges = map_ranges(dictionary["ranges"])
+      Line.new(dictionary["executionCount"], dictionary["executable"], ranges)
+    end
+
+    def self.map_ranges (dictionaries)
+      return nil if dictionaries.nil?
+      dictionaries.map { |dictionary| Range.map(dictionary) }
+    end
+
+  end
+end

data/lib/xcov/model/range.rb

@@ -0,0 +1,25 @@
+module Xcov
+  class Range
+
+    attr_reader :execution_count
+    attr_reader :location
+    attr_reader :length
+
+    def initialize (execution_count, location, length)
+      @execution_count = execution_count
+      @location = location
+      @length = length
+    end
+
+    # Class methods
+
+    def self.map (dictionary)
+      Range.new(
+        dictionary["executionCount"],
+        dictionary["location"],
+        dictionary["length"]
+      )
+    end
+
+  end
+end

data/lib/xcov/model/report.rb

@@ -17,12 +17,19 @@ module Xcov
 
     def average_coverage targets
       return 0 if targets.count == 0
+      return targets.first.coverage if targets.count == 1
 
-      coverage = 0
-      targets.each do |target|
-        coverage = coverage + target.coverage
+      executable = targets.reduce(0) do |partial_result, target|
+        partial_result + target.executable_lines
       end
-      coverage / targets.count
+
+      covered = targets.reduce(0) do |partial_result, target|
+        partial_result + target.covered_lines
+      end
+
+      return 0 if executable == 0 # avoid ZeroDivisionError
+
+      covered.to_f / executable.to_f
     end
 
     def print_description
@@ -75,6 +82,15 @@ module Xcov
         filtered_targets = filtered_targets.select { |target| self.included_targets.include?(target["name"])}
       end
 
+      supported_targets = Xcov.project.targets
+      if Xcov.config[:only_project_targets] && !supported_targets.empty?
+        filtered_targets = filtered_targets.select do |target|
+          name = target["name"]
+          name.slice! File.extname(name) # remove target extensions
+          supported_targets.include?(name)
+        end
+      end
+
       filtered_targets
     end
 

data/lib/xcov/model/source.rb

@@ -10,8 +10,9 @@ module Xcov
     attr_accessor :coverage
     attr_accessor :functions
     attr_accessor :function_templates
+    attr_accessor :lines
 
-    def initialize (name, location, coverage, functions)
+    def initialize (name, location, coverage, functions, lines = nil)
       @name = CGI::escapeHTML(name)
       @location = CGI::escapeHTML(location)
       @coverage = coverage
@@ -21,6 +22,7 @@ module Xcov
       @coverage_color = self.create_coverage_color
       @id = Source.create_id(name)
       @type = Source.type(name)
+      @lines = lines
 
       if @ignored
         UI.message "Ignoring #{name} coverage".yellow
@@ -60,6 +62,15 @@ module Xcov
       return value
     end
 
+    def number_of_executable_lines
+      return 0 if lines.nil? || lines.empty?
+      lines.select { |line| line.executable }.count
+    end
+
+    def number_of_covered_lines
+      return 0 if lines.nil? || lines.empty?
+      lines.select { |line| line.covered? }.count
+    end
 
     # Class methods
 
@@ -68,8 +79,13 @@ module Xcov
       location = dictionary["location"]
       coverage = dictionary["coverage"]
       functions = dictionary["functions"].map { |function| Function.map(function)}
+      lines = map_lines(dictionary["lines"])
+      Source.new(name, location, coverage, functions, lines)
+    end
 
-      Source.new(name, location, coverage, functions)
+    def self.map_lines (dictionaries)
+      return nil if dictionaries.nil?
+      dictionaries.map { |line| Line.map(line) }
     end
 
     def self.type (name)

data/lib/xcov/model/target.rb

@@ -4,14 +4,18 @@ module Xcov
   class Target < Xcov::Base
 
     attr_accessor :name
-    attr_accessor :coverage
+    attr_accessor :executable_lines # number of executable lines in target
+    attr_accessor :covered_lines # number of covered lines in target
     attr_accessor :files
     attr_accessor :file_templates
 
-    def initialize (name, coverage, files)
+    def initialize (name, executable, covered, files)
       @name = CGI::escapeHTML(name)
-      @coverage = coverage
+      @executable_lines = executable
+      @covered_lines = covered
       @files = files
+      # we cast to floats because integers always return 0
+      @coverage = executable == 0 ? 0.0 : covered.to_f / executable # avoid ZeroDivisionError
       @displayable_coverage = self.create_displayable_coverage
       @coverage_color = self.create_coverage_color
       @id = Target.create_id(name)
@@ -56,18 +60,13 @@ module Xcov
       name = dictionary["name"]
       files = dictionary["files"].map { |file| Source.map(file)}
       files = files.sort &by_coverage_with_ignored_at_the_end
-      coverage = Target.calculate_coverage(files)
 
-      Target.new(name, coverage, files)
-    end
+      non_ignored_files = Target.select_non_ignored_files(files)
+      executable = Target.calculate_number_of_executable_lines(non_ignored_files)
+      covered = Target.calculate_number_of_covered_lines(non_ignored_files)
 
-    def self.calculate_coverage (files)
-      coverage = 0
-      non_ignored_files = files.select { |file| !file.ignored }
-      non_ignored_files.each { |file| coverage += file.coverage }
-      coverage = coverage / non_ignored_files.count unless non_ignored_files.empty?
 
-      coverage
+      Target.new(name, executable, covered, files)
     end
 
     def self.by_coverage_with_ignored_at_the_end
@@ -83,5 +82,25 @@ module Xcov
       }
     end
 
+    def self.select_non_ignored_files(files)
+      files.select { |file| !file.ignored }
+    end
+
+    def self.calculate_number_of_covered_lines (files)
+      return 0 if files.nil? || files.empty?
+
+      files.reduce(0) do |partial_result, file|
+        partial_result + file.number_of_covered_lines
+      end
+    end
+
+    def self.calculate_number_of_executable_lines (files)
+      return 0 if files.nil? || files.empty?
+
+      files.reduce(0) do |partial_result, file|
+        partial_result + file.number_of_executable_lines
+      end
+    end
+
   end
 end

data/lib/xcov/options.rb

@@ -119,12 +119,19 @@ module Xcov
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :exclude_targets,
                                      optional: true,
-                                     conflicting_options: [:include_targets],
+                                     conflicting_options: [:include_targets, :only_project_targets],
                                      description: "Comma separated list of targets to exclude from coverage report"),
         FastlaneCore::ConfigItem.new(key: :include_targets,
                                      optional: true,
-                                     conflicting_options: [:exclude_targets],
-                                     description: "Comma separated list of targets to include in coverage report. If specified then exlude_targets will be ignored")
+                                     conflicting_options: [:exclude_targets, :only_project_targets],
+                                     description: "Comma separated list of targets to include in coverage report. If specified then exlude_targets will be ignored"),
+        FastlaneCore::ConfigItem.new(key: :only_project_targets,
+                                     optional: true,
+                                     conflicting_options: [:exclude_targets, :include_targets],
+                                     description: "Display the coverage only for main project targets (e.g. skip Pods targets)",
+                                     is_string: false,
+                                     default_value: false)
+
       ]
     end
 

data/lib/xcov/project_extensions.rb

@@ -0,0 +1,33 @@
+require "fastlane_core"
+require "xcodeproj"
+
+module FastlaneCore
+  class Project
+
+    # Returns project targets
+    def targets
+      project_path = get_project_path
+      return [] if project_path.nil?
+
+      proj = Xcodeproj::Project.open(project_path)
+      
+      proj.targets.map do |target|
+       target.name
+     end
+    end
+
+    private
+    
+    def get_project_path
+      # Given the workspace and scheme, we can compute project path
+      if workspace?
+        if options[:workspace] && options[:scheme]
+          build_settings(key: "PROJECT_FILE_PATH")
+        end
+      else
+        options[:project]
+      end
+    end
+
+  end
+end

data/lib/xcov/version.rb

@@ -1,6 +1,6 @@
 module Xcov
 
-  VERSION = "0.12.5"
+  VERSION = "1.0.0"
   DESCRIPTION = "xcov is a friendly visualizer for Xcode's code coverage files"
 
 end

data/lib/xcov-core/version.rb

@@ -1,5 +1,5 @@
 module Xcov
   module Core
-    VERSION = "0.3"
+    VERSION = "0.4"
   end
 end

data/lib/xcov-core.rb

@@ -13,7 +13,7 @@ module Xcov
 
       def self.parse(file)
         report_output = Tempfile.new("report.json")
-        command = "#{ENV['XCOV_CORE_LIBRARY_PATH'].shellescape} -s #{file.shellescape} -o #{report_output.path.shellescape} --add-location"
+        command = "#{ENV['XCOV_CORE_LIBRARY_PATH'].shellescape} -s #{file.shellescape} -o #{report_output.path.shellescape} --include-lines-info"
         description = [{ prefix: "Parsing .xccoverage file: " }]
         execute_command(command, description)
         output_file = File.read(report_output.path)

data/lib/xcov.rb

@@ -11,6 +11,9 @@ require 'xcov/model/report'
 require 'xcov/model/target'
 require 'xcov/model/source'
 require 'xcov/model/function'
+require 'xcov/model/line'
+require 'xcov/model/range'
+require 'xcov/project_extensions'
 require 'fastlane_core'
 
 module Xcov

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcov
 version: !ruby/object:Gem::Version
-  version: 0.12.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Carlos Vidal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-17 00:00:00.000000000 Z
+date: 2017-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -203,10 +217,13 @@ files:
 - lib/xcov/manager.rb
 - lib/xcov/model/base.rb
 - lib/xcov/model/function.rb
+- lib/xcov/model/line.rb
+- lib/xcov/model/range.rb
 - lib/xcov/model/report.rb
 - lib/xcov/model/source.rb
 - lib/xcov/model/target.rb
 - lib/xcov/options.rb
+- lib/xcov/project_extensions.rb
 - lib/xcov/runner.rb
 - lib/xcov/slack_poster.rb
 - lib/xcov/version.rb