xcov 0.11.3 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 857a2cce20017d32986a779c445b0542be242af0
-  data.tar.gz: 673eb99ccbb1f740fd7d41bfdcfd80dab8977f96
+  metadata.gz: c02009c2981afaac60ecbddd456a99e69a921862
+  data.tar.gz: f991f7a721295624e74205c55b1b703c8d912c96
 SHA512:
-  metadata.gz: 02a500bb7dfcdf2c1eb57ec6dfc0e62bf034aabbe07c4557cc853459da6ab38d5ba41ae5f656ea804b53131acabcc9d52aba55657f07ae76ec91cfd64f8b7344
-  data.tar.gz: 26cca614b0d16d9ea24665668339243b8fc4245d93021fa588ddef1b22850f1749e6938ffae0470c9f85308837a80478bcff555bc83a499891c8922a22f98f35
+  metadata.gz: 9a97f422cca8e295b7965303670f0ee281a510c355ccd31665c8c0bd732c7be1c9244bb91b8ad54ea5e5187afd353b775b15a740f5476445727a7cccc13842f4
+  data.tar.gz: a922d3a9d26b0b485b63fa35b2720bed5f4f6d29c084d9a972baee33dec87033c939d99240b365d86459d9b1442c3ab5246450d0490410bf901c6078d6bb978f

data/README.md

@@ -44,11 +44,13 @@ xcov -w LystSDK.xcworkspace -s LystSDK -o xcov_output
 * `--project` `-p`: Path of your `xcodeproj` file (optional).
 * `--scheme` `-s`: Scheme of the project to analyze.
 * `--output_directory` `-o`: Path for the output folder where the report files will be saved.
+* `--source_directory` `-r`: The path to project's root directory.
 * `--derived_data_path` `-j`: Path of your project `Derived Data` folder (optional).
 * `--minimum_coverage_percentage` `-m`: Raise exception if overall coverage percentage is under this value (ie. 75).
 * `--include_test_targets`: Enables coverage reports for `.xctest` targets.
 * `--ignore_file_path` `-x`: Relative or absolute path to the file containing the list of ignored files.
 * `--exclude_targets`: Comma separated list of targets to exclude from coverage report.
+* `--include_targets`: Comma separated list of targets to include in coverage report.
 * `--slack_url` `-i`: Incoming WebHook for your Slack group to post results (optional).
 * `--slack_channel` `-e`: Slack channel where the results will be posted (optional).
 * `--html_report`: Enables the creation of a html report. Enabled by default (optional).
@@ -61,6 +63,8 @@ _**Note:** All paths you provide should be absolute and unescaped_
 ### Ignoring files
 You can easily ignore the coverage for a specified set of files by adding their filenames to the *ignore file* specified with the `--ignore_file_path` parameter (this file is `.xcovignore` by default). You can also specify a wildcard expression for matching a group of files.
 
+If you want to ignore all the files from a directory (folder), specify directory's relative path in *ignore file*. Also, specify `source_directory` if that differs from working directory (which is the default value).
+
 Each one of the filenames you would like to ignore must be prefixed by the dash symbol `-`. In addition you can comment lines by prefixing them by `#`. Example:
 
 ```yaml
@@ -78,6 +82,10 @@ Each one of the filenames you would like to ignore must be prefixed by the dash
 
 # Exclude all files ending by "View.swift"
 - .*View.swift
+
+# Exclude all dependencies
+- Pods
+- Carthage/Checkouts
 ```
 
 ### [Fastlane](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Actions.md)

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}"
+        command = "#{ENV['XCOV_CORE_LIBRARY_PATH'].shellescape} -s #{file.shellescape} -o #{report_output.path.shellescape} --add-location"
         description = [{ prefix: "Parsing .xccoverage file: " }]
         execute_command(command, description)
         output_file = File.read(report_output.path)

data/lib/xcov-core/version.rb

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

data/lib/xcov/ignore_handler.rb

@@ -16,6 +16,16 @@ module Xcov
       return @list.any? { |pattern| filename =~ Regexp.new("#{pattern}$") }
     end
 
+    def should_ignore_file_at_path path
+      # Ignore specific files
+      filename = File.basename(path)
+      return true if should_ignore_file(filename)
+      
+      # Also ignore the files from ignored folders
+      relative = relative_path(path)
+      return @list.any? { |ignored_path| relative_path(path).start_with? ignored_path }
+    end
+
     # Static methods
 
     def self.read_ignore_file
@@ -31,5 +41,21 @@ module Xcov
       return ignore_list
     end
 
+    # Auxiliary methods
+
+    # Returns a relative path against `source_directory`.
+    def relative_path path
+      require 'pathname'
+
+      full_path = Pathname.new(path).realpath             # /full/path/to/project/where/is/file.extension
+      base_path = Pathname.new(source_directory).realpath # /full/path/to/project/
+
+      full_path.relative_path_from(base_path).to_s        # where/is/file.extension
+    end
+
+    def source_directory
+      Xcov.config[:source_directory]
+    end
+
   end
 end

data/lib/xcov/model/report.rb

@@ -66,7 +66,14 @@ module Xcov
     def self.filter_targets targets
       filtered_targets = Array.new(targets)
       filtered_targets = filtered_targets.select { |target| !target["name"].include?(".xctest") } if !Xcov.config[:include_test_targets]
-      filtered_targets = filtered_targets.select { |target| !self.excluded_targets.include?(target["name"])}
+
+      if Xcov.config[:exclude_targets]
+        filtered_targets = filtered_targets.select { |target| !self.excluded_targets.include?(target["name"])}
+      end
+
+      if Xcov.config[:include_targets]
+        filtered_targets = filtered_targets.select { |target| self.included_targets.include?(target["name"])}
+      end
 
       filtered_targets
     end
@@ -75,11 +82,29 @@ module Xcov
       excluded_targets = Array.new()
 
       if Xcov.config[:exclude_targets]
-        excluded_targets = Xcov.config[:exclude_targets].split(/\s*,\s*/)
+        if Xcov.config[:exclude_targets].is_a?(Array)
+          excluded_targets = Xcov.config[:exclude_targets]
+        else
+          excluded_targets = Xcov.config[:exclude_targets].split(/\s*,\s*/)
+        end
       end
 
       excluded_targets
     end
 
+    def self.included_targets
+      included_targets = Array.new()
+
+      if Xcov.config[:include_targets]
+        if Xcov.config[:include_targets].is_a?(Array)
+          included_targets = Xcov.config[:include_targets]
+        else
+          included_targets = Xcov.config[:include_targets].split(/\s*,\s*/)
+        end
+      end
+
+      included_targets
+    end
+
   end
 end

data/lib/xcov/model/source.rb

@@ -4,17 +4,19 @@ module Xcov
   class Source < Xcov::Base
 
     attr_accessor :name
+    attr_accessor :location
     attr_accessor :type
     attr_accessor :ignored
     attr_accessor :coverage
     attr_accessor :functions
     attr_accessor :function_templates
 
-    def initialize (name, coverage, functions)
+    def initialize (name, location, coverage, functions)
       @name = CGI::escapeHTML(name)
+      @location = CGI::escapeHTML(location)
       @coverage = coverage
       @functions = functions
-      @ignored = Xcov.ignore_handler.should_ignore_file(name)
+      @ignored = Xcov.ignore_handler.should_ignore_file_at_path(location)
       @displayable_coverage = self.create_displayable_coverage
       @coverage_color = self.create_coverage_color
       @id = Source.create_id(name)
@@ -63,10 +65,11 @@ module Xcov
 
     def self.map (dictionary)
       name = dictionary["name"]
+      location = dictionary["location"]
       coverage = dictionary["coverage"]
       functions = dictionary["functions"].map { |function| Function.map(function)}
 
-      Source.new(name, coverage, functions)
+      Source.new(name, location, coverage, functions)
     end
 
     def self.type (name)

data/lib/xcov/options.rb

@@ -35,11 +35,28 @@ module Xcov
                                      optional: true,
                                      env_name: "XCOV_SCHEME",
                                      description: "The project's scheme. Make sure it's marked as `Shared`"),
+        FastlaneCore::ConfigItem.new(key: :source_directory,
+                                     short_option: "-r",
+                                     optional: true,
+                                     env_name: "XCOV_SOURCE_DIRECTORY",
+                                     description: "The path to project's root directory",
+                                     default_value: Dir.pwd,
+                                     verify_block: proc do |value|
+                                       v = File.expand_path(value.to_s)
+                                       raise "Specified source directory does not exist".red unless File.exist?(v)
+                                       raise "Invalid source directory path, it must point to a directory".red unless File.directory?(v)
+                                     end
+                                     ),
         FastlaneCore::ConfigItem.new(key: :derived_data_path,
                                      short_option: "-j",
                                      env_name: "XCOV_DERIVED_DATA_PATH",
                                      description: "The directory where build products and other derived data will go",
-                                     optional: true),
+                                     optional: true,
+                                     verify_block: proc do |value|
+                                       v = File.expand_path(value.to_s)
+                                       raise "Specified derived data directory does not exist".red unless File.exist?(v)
+                                       raise "Invalid derived data path, it must point to a directory".red unless File.directory?(v)
+                                     end),
         FastlaneCore::ConfigItem.new(key: :output_directory,
                                      short_option: "-o",
                                      env_name: "XCOV_OUTPUT_DIRECTORY",
@@ -98,7 +115,12 @@ module Xcov
                                      default_value: false),
         FastlaneCore::ConfigItem.new(key: :exclude_targets,
                                      optional: true,
-                                     description: "Comma separated list of targets to exclude from coverage report")
+                                     conflicting_options: [:include_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")
       ]
     end
 

data/lib/xcov/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcov
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: '0.12'
 platform: ruby
 authors:
 - Carlos Vidal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-23 00:00:00.000000000 Z
+date: 2016-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane_core