xcov 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74b4b027c48a06ae5c565d14ca7056f4b16f7e85
-  data.tar.gz: a433237612938cd44bdc600d9f6e44519e8dfa92
+  metadata.gz: 3e2fbf38638743436f19f20c895047c07af963e5
+  data.tar.gz: 611fa1e2c51729ae7a96f40c92bf259609cc1a90
 SHA512:
-  metadata.gz: 9352b7e868175b3987ff7c963b19505ae415accda365d312dada36a573092ae36f13d315b46a02d1bcdc9202908d74e9f6976e50a4816318466f552f46b40410
-  data.tar.gz: 4594aa1fd03814dd815d64bceaabbf324192d4687b593c2d9606071b09daa09dfa3ee18d013c654b26993a78f229f34736639a05db6d398b0f6d4cb639efa13f
+  metadata.gz: 57198ae9212ebdead54ddad4217af75e2f2e8a64211ec937cda182c685b2881e9fe96ee416c381983f7bac6c6a26f9f7e1958ea241fcb926a5226cc39f431ed1
+  data.tar.gz: d68831b7fcf3b8b08b48f93ff8ba4656da14f10e05abbd1146dc7b08abd03dd936a43f56894dc3a80f43962e7c9e07795d78adc5f819a503a2b524ebda3d667a

data/README.md

@@ -5,7 +5,7 @@
 [![Gem](https://img.shields.io/gem/v/xcov.svg?style=flat)](http://rubygems.org/gems/xcov)
 [![Gem Downloads](https://img.shields.io/gem/dt/xcov.svg?style=flat)](http://rubygems.org/gems/xcov)
 
-**xCov** is a friendly visualizer for Xcode's code coverage files.
+**xcov** is a friendly visualizer for Xcode's code coverage files.
 
 ## Installation
 ```
@@ -14,7 +14,9 @@ sudo gem install xcov
 
 ## Features
 * Built on top of [Fastlane](https://fastlane.tools), you can easily plug it on to your CI environment.
-* Generates nice HTML reports.
+* Blacklisting of those files which coverage you want to ignore.
+* Minimum acceptable coverage percentage.
+* Nice HTML reports.
 
 ![/assets_readme/report.png](/assets_readme/report.png)
 
@@ -23,7 +25,7 @@ sudo gem install xcov
 ![/assets_readme/slack_integration.png](/assets_readme/slack_integration.png)
 
 ## Requirements
-In order to make *xCov* run you must:
+In order to make *xcov* run you must:
 * Use Xcode 7.
 * Have the latest version of Xcode command line tools.
 * Set your project scheme as **shared**.
@@ -32,7 +34,7 @@ In order to make *xCov* run you must:
 ![/assets_readme/gather_coverage.png](/assets_readme/gather_coverage.png)
 
 ## Usage
-*xCov* analyzes the `.xccoverage` files created after running your tests therefore, before executing xCov, you need to run your tests with either `Xcode`, `xcodebuild` or [scan](https://github.com/fastlane/scan). Once completed, obtain your coverage report by providing a few parameters:
+*xcov* analyzes the `.xccoverage` files created after running your tests therefore, before executing xcov, you need to run your tests with either `Xcode`, `xcodebuild` or [scan](https://github.com/fastlane/scan). Once completed, obtain your coverage report by providing a few parameters:
 ```
 xcov -w LystSDK.xcworkspace -s LystSDK -o xcov_output
 ```
@@ -43,14 +45,34 @@ xcov -w LystSDK.xcworkspace -s LystSDK -o xcov_output
 * `--scheme` `-s`: Scheme of the project to analyze.
 * `--output_directory` `-o`: Path for the output folder where the report files will be saved.
 * `--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
+* `--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.
 * `--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).
 * `--skip_slack`: Add this flag to avoid publishing results on Slack (optional).
 
+### 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).
+
+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
+# Api files
+- LSTSessionApi.swift
+- LSTComponentsApi.swift
+- LSTNotificationsApi.swift
+
+# Managers
+- LSTRequestManager.m
+- LSTCookiesManager.m
+
+# Utils
+- LSTStateMachine.swift
+```
+
 ### [Fastlane](https://github.com/fastlane/fastlane/blob/master/docs/Actions.md)
-*Fastlane 1.61.0* includes *xCov* as a custom action. You can easily create your coverage reports as follows:
+*Fastlane 1.61.0* includes *xcov* as a custom action. You can easily create your coverage reports as follows:
 ```ruby
 xcov(
   workspace: "YourWorkspace.xcworkspace",
@@ -61,6 +83,9 @@ xcov(
 
 ## Changelog
 
+### v.0.6
+* Ignored coverage for a specified list of files
+
 ### v.0.5
 * Fixed bug using the `derived_data_path` option
 * Fixed bug sorting multiple `.xccoverage` files by datetime

data/assets/stylesheets/main.css

@@ -1,5 +1,5 @@
 /**
-Xcov - Xcode code coverage without hassle
+xcov - Xcode code coverage without hassle
 A tool developed by Carlos Vidal @carlostify
 */
 
@@ -140,6 +140,15 @@ html, body, .full-height {
   cursor: pointer;
 }
 
+.file-ignored-row {
+	color: #838383;
+  padding-top: 5px;
+  padding-bottom: 5px;
+  border-style: solid;
+  border-color: #202020;
+  border-width: 0px 0px 1px 0px;
+}
+
 .target-files {
   background-color: #363636;
   padding-top: 10px;

data/lib/xcov.rb

@@ -3,6 +3,7 @@ require 'xcov/version'
 require 'xcov/manager'
 require 'xcov/options'
 require 'xcov/runner'
+require 'xcov/ignore_handler'
 require 'xcov/error_handler'
 require 'xcov/slack_poster'
 require 'xcov/model/base'
@@ -16,13 +17,11 @@ module Xcov
   class << self
 
     attr_accessor :config
+    attr_accessor :ignore_list
     attr_accessor :project
 
-    def config=(value)
-      @config = value
-
-      FastlaneCore::Project.detect_projects(value)
-      @project = FastlaneCore::Project.new(config)
+    def project=(value)
+      @project = value
       @project.select_scheme
     end
 

data/lib/xcov/commands_generator.rb

@@ -11,16 +11,13 @@ module Xcov
     FastlaneCore::CommanderGenerator.new.generate(Xcov::Options.available_options)
 
     def self.start
-      FastlaneCore::UpdateChecker.start_looking_for_update("xcov")
       new.run
-    ensure
-      FastlaneCore::UpdateChecker.show_update_status("xcov", Xcov::VERSION)
     end
 
     def convert_options(options)
-      o = options.__hash__.dup
-      o.delete(:verbose)
-      o
+      converted_options = options.__hash__.dup
+      converted_options.delete(:verbose)
+      converted_options
     end
 
     def run
@@ -43,7 +40,6 @@ module Xcov
       end
 
       default_command :report
-
       run!
     end
 

data/lib/xcov/ignore_handler.rb

@@ -0,0 +1,19 @@
+
+module Xcov
+  class IgnoreHandler
+
+    def read_ignore_file
+      require "yaml"
+      ignore_file_path = Xcov.config[:ignore_file_path]
+      ignore_list = []
+      begin
+        ignore_list = YAML.load_file(ignore_file_path)
+      rescue
+        Helper.log.info "Skipping file blacklisting as no ignore file was found at path #{ignore_file_path}".yellow
+      end
+
+      ignore_list
+    end
+
+  end
+end

data/lib/xcov/manager.rb

@@ -4,8 +4,20 @@ module Xcov
   class Manager
 
     def work(options)
+      # Set command options
       Xcov.config = options
-      FastlaneCore::PrintTable.print_values(config: options, hide_keys: [:slack_url], title: "Summary for xCov #{Xcov::VERSION}")
+
+      # Set project options
+      FastlaneCore::Project.detect_projects(options)
+      Xcov.project = FastlaneCore::Project.new(options)
+
+      # Set ignored files list
+      Xcov.ignore_list = IgnoreHandler.new.read_ignore_file
+
+      # Print summary
+      FastlaneCore::PrintTable.print_values(config: options, hide_keys: [:slack_url], title: "Summary for xcov #{Xcov::VERSION}")
+
+      # Run xcov
       Runner.new.run
     end
 

data/lib/xcov/model/base.rb

@@ -11,10 +11,14 @@ module Xcov
     attr_accessor :id
 
     def create_displayable_coverage
+      return "" if @ignored
+
       "%.0f%%" % [(@coverage*100)]
     end
 
     def create_coverage_color
+      return "#363636" if @ignored
+
       if @coverage > 0.8
         return "#1FCB32"
       elsif @coverage > 0.65

data/lib/xcov/model/source.rb

@@ -5,6 +5,7 @@ module Xcov
 
     attr_accessor :name
     attr_accessor :type
+    attr_accessor :ignored
     attr_accessor :coverage
     attr_accessor :functions
     attr_accessor :function_templates
@@ -13,10 +14,15 @@ module Xcov
       @name = CGI::escapeHTML(name)
       @coverage = coverage
       @functions = functions
+      @ignored = Xcov.ignore_list.include?(name)
       @displayable_coverage = self.create_displayable_coverage
       @coverage_color = self.create_coverage_color
       @id = Source.create_id(name)
       @type = Source.type(name)
+
+      if @ignored
+        Helper.log.info "Ignoring #{name} coverage".yellow
+      end
     end
 
     def print_description

data/lib/xcov/model/target.rb

@@ -37,12 +37,22 @@ module Xcov
 
     def self.map (dictionary)
       name = dictionary["name"]
-      coverage = dictionary["coverage"]
       files = dictionary["files"].map { |file| Source.map(file)}
       files = files.sort! { |lhs, rhs| lhs.coverage <=> rhs.coverage }
+                   .sort! { |lhs, rhs| (lhs.ignored ? 1:0) <=> (rhs.ignored ? 1:0) }
+      coverage = Target.calculate_coverage(files)
 
       Target.new(name, coverage, files)
     end
 
+    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
+    end
+
   end
 end

data/lib/xcov/options.rb

@@ -51,6 +51,11 @@ module Xcov
                                      description: "Raise exception if overall coverage percentage is under this value (ie. 75)",
                                      type: Float,
                                      default_value: 0),
+       FastlaneCore::ConfigItem.new(key: :ignore_file_path,
+                                    short_option: "-x",
+                                    env_name: "XCOV_IGNORE_FILE_PATH",
+                                    description: "Relative or absolute path to the file containing the list of ignored files",
+                                    default_value: File.join(containing, ".xcovignore")),
        FastlaneCore::ConfigItem.new(key: :include_test_targets,
                                     env_name: "XCOV_INCLUDE_TEST_TARGETS",
                                     description: "Enables coverage reports for .xctest targets",

data/lib/xcov/runner.rb

@@ -66,7 +66,7 @@ module Xcov
         table_rows << [target.name, target.displayable_coverage]
       end
       puts Terminal::Table.new({
-        title: "xCov Coverage Report".green,
+        title: "xcov Coverage Report".green,
         rows: table_rows
       })
       puts ""

data/lib/xcov/slack_poster.rb

@@ -25,7 +25,7 @@ module Xcov
         }
       end
 
-      result = notifier.ping "xCov Coverage Report",
+      result = notifier.ping "Your *xcov* coverage report",
                              icon_url: 'https://s3-eu-west-1.amazonaws.com/fastlane.tools/fastlane.png',
                              attachments: attachments
 

data/lib/xcov/version.rb

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

data/views/file.erb

@@ -1,5 +1,9 @@
         <!-- Single file starts here -->
+        <% if @ignored %>
+        <div class="row file-ignored-row">
+        <% else %>
         <div class="row file-row" file-id="<%= @id %>">
+        <% end %>
           <div class="col-xs-10 col-md-10 col-lg-10">
             <span><img class="file-icon" src="resources/file_<%= @type %>.png"/></span>
             <%= @name %>

data/views/report.erb

@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 <!--
-Xcov - Xcode code coverage without hassle
+xcov - Xcode code coverage without hassle
 A tool developed by Carlos Vidal @carlostify
 -->
 <html>
@@ -8,7 +8,7 @@ A tool developed by Carlos Vidal @carlostify
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width, initial-scale=1">
-  <title>xCov - Code coverage report</title>
+  <title>xcov - Code coverage report</title>
   <link rel="stylesheet" media="screen" href="resources/bootstrap.min.css" />
   <link rel="stylesheet" media="screen" href="resources/opensans.css" />
   <link rel="stylesheet" media="all" href="resources/main.css" />
@@ -52,7 +52,7 @@ A tool developed by Carlos Vidal @carlostify
     <!-- Footer starts here -->
     <div class="row footer">
       <div class="col-xs-12 col-md-offset-1 col-md-10 col-lg-offset-2 col-lg-8 text-center">
-        xCov - Xcode coverage reports without hassle - A tool developed by
+        xcov - Xcode coverage reports without hassle - A tool developed by
         <a href="https://github.com/nakiostudio" target="_blank">Carlos Vidal</a> -
         <a href="https://twitter.com/carlostify" target="_blank">@carlostify</a>
       </div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcov
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Carlos Vidal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastlane_core
@@ -184,7 +184,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: xCov is a friendly visualizer for Xcode's code coverage files
+description: xcov is a friendly visualizer for Xcode's code coverage files
 email:
 - nakioparkour@gmail.com
 executables:
@@ -213,6 +213,7 @@ files:
 - lib/xcov.rb
 - lib/xcov/commands_generator.rb
 - lib/xcov/error_handler.rb
+- lib/xcov/ignore_handler.rb
 - lib/xcov/manager.rb
 - lib/xcov/model/base.rb
 - lib/xcov/model/function.rb
@@ -250,6 +251,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: xCov is a friendly visualizer for Xcode's code coverage files
+summary: xcov is a friendly visualizer for Xcode's code coverage files
 test_files: []
 has_rdoc: