alcove 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3a24347defb0bd648d7c15cd13d754590615977
+  data.tar.gz: a7530953e48cfc71bde431f94a235b3a17407293
+SHA512:
+  metadata.gz: e74cccadf0a4dcd053843c3d5271c27e11c1823d91499d855c86981ea76b9c90c55490fd358522866b5c8c39ba54ca3a0f9542ee9827d71234e3be664da9f1a6
+  data.tar.gz: a95b48ef3a9ccd19fabda7e85c88fb3f47c2a2602bf34b5483ca6bef751b9859f9d7e36060a826bbe6bca5d3d9ea045bc0382845ac72f3664566c2c8869106c8

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Isaac Overacker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,26 @@
+# Alcove [![Build Status](https://travis-ci.org/ioveracker/Alcove.svg?branch=master)](https://travis-ci.org/ioveracker/Alcove)
+Painless code coverage reporting for Objective-C projects.   Most of the heavy lifting is done by the venerable lcov.  Alcove simply searches the nooks and crannies to collect the data needed to generate the report and ties everything together for you.  Best of all, it's a gem with minimal depedencies, so installation is quick and painless.
+
+## Installation
+
+    $ sudo gem install alcove
+    
+If you don't have it already, you'll also need to install lcov.
+
+*Homebrew*
+
+    $ brew install lcov
+
+*MacPorts*
+
+    $ sudo port install lcov
+
+## Xcode Project Configuration
+If you haven't already, open your project in Xcode and update your main target to Generate Test Coverage Files and Instrument Program Flow *for Debug configuration only*).
+
+## Generating Reports
+Now that you have the prerequisites out of the way, you can generate a report.  Make sure you've recently executed your tests, then:
+
+    alcove --product-name <your-product-name>
+
+Be sure to check out the --help for additional options for fine-tuning your report.

data/bin/alcove

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'alcove'
+require 'alcove/version'
+require 'ostruct'
+require 'optparse'
+
+options = OpenStruct.new
+OptionParser.new do |opts|
+    opts.banner = "Usage: alcove --product-name <product-name> [options]"
+
+    opts.on('-h', '--help', 'Displays the help screen') do
+        puts opts
+        exit
+    end
+
+    options.output_directory = 'alcove-report'
+    opts.on('-o', '--output-directory DIR', 'Place report in DIR instead of default') do |o|
+        options.output_directory = o
+    end
+
+    options.product_name = ''
+    opts.on('-p', '--product-name NAME', 'The name of your product') do |p|
+        options.product_name = p
+    end
+
+    options.remove_filter = []
+    opts.on('-r', '--remove-filter X,Y,Z...', ::Array, 'A list of filters (e.g. *.h,main.m)') do |r|
+        options.remove_filter = r
+    end
+
+    opts.on('-s', '--search-directory DIR', 'Search in DIR for coverage files') do |s|
+        options.search_directory = s
+    end
+
+    options.verbose = false
+    opts.on('-v', '--verbose', 'Output additional information') do
+        options.verbose = true
+    end
+
+    opts.on_tail('--version', 'Show version') do
+        puts Alcove::VERSION
+        exit
+    end
+
+    begin
+        opts.parse!(ARGV)
+        if options.product_name.length == 0
+            puts '--product-name is required'.yellow
+            puts opts
+            exit(1)
+        end
+    rescue OptionParser::InvalidOption => e
+        puts e
+        puts opts
+        exit(1)
+    end
+end
+
+alcoveOptions = OpenStruct.new
+alcoveOptions.output_directory = options.output_directory
+alcoveOptions.product_name = options.product_name
+alcoveOptions.remove_filter = options.remove_filter
+alcoveOptions.search_directory = options.search_directory
+alcoveOptions.verbose = options.verbose
+
+alcove = Alcove.new(alcoveOptions)
+alcove.generate_report

data/lib/alcove.rb

@@ -0,0 +1,113 @@
+require 'colored'
+require 'etc'
+require 'find'
+require 'fileutils'
+require 'ostruct'
+require 'optparse'
+
+class Alcove
+    def initialize(options)
+        @output_directory = options.output_directory
+        @product_name = options.product_name
+        @remove_filter = options.remove_filter
+        @verbose = options.verbose
+        @search_directory = options.search_directory
+    end
+
+    def generate_report
+        temp_dir = 'alcove-temp'
+        # geninfo parameters
+        gi_filename = 'alcove-info.temp'
+        gi_filename_absolute = File.join(temp_dir, gi_filename)
+        # lcov parameters
+        lcov_filename = 'alcove-lcov.info'
+        lcov_filename_absolute = File.join(temp_dir, lcov_filename)
+        lcov_system_removals = ['*iPhoneSimulator*']
+
+        puts ' 🔍  Generating report...'
+
+        FileUtils.rm_rf(temp_dir)
+        FileUtils.mkdir(temp_dir)
+
+        puts ' 📦  Gathering .gcno and .gcda files...' if @verbose
+        copy_input_files(@product_name, temp_dir)
+
+        gen_success = gen_info_files(gi_filename_absolute, temp_dir)
+        if gen_success
+            puts ' ✅  geninfo successful'.green if @verbose
+        else
+            puts ' 🚫  geninfo failed!'.red
+            FileUtils.rm_rf(temp_dir)
+            exit(1)
+        end
+
+        lcov_removals = lcov_system_removals + @remove_filter
+        lcov_success = lcov(gi_filename_absolute, lcov_removals, lcov_filename_absolute)
+        if lcov_success
+            puts ' ✅  lcov successful'.green if @verbose
+        else
+            puts ' 🚫  lcov failed!'.red
+            FileUtils.rm_rf(temp_dir)
+            exit(1)
+        end
+
+        genhtml_success = genhtml(@output_directory, lcov_filename_absolute)
+        if genhtml_success
+            puts '' if @verbose
+            puts ' ✅  Successfully generated report'.green
+            puts " 🍻  Open #{@output_directory}/index.html to view the report"
+        else
+            puts ' 🚫  genhtml failed!'.red
+            FileUtils.rm_rf(temp_dir)
+            exit(1)
+        end
+
+        FileUtils.rm_rf(temp_dir)
+    end
+
+private
+
+    def copy_input_files(product_name, temp_dir)
+        derived_data = ''
+        if @search_directory
+            puts "  Search directory provided." if @verbose
+            derived_data = @search_directory
+        elsif ENV['XCS_SOURCE_DIR']
+            puts "  Xcode Server found." if @verbose
+            derived_data = ENV['XCS_SOURCE_DIR'].sub('Source', 'DerivedData')
+        else
+            puts "  Development machine found." if @verbose
+            derived_data = File.join(Etc.getpwuid.dir, "/Library/Developer/Xcode/DerivedData")
+        end
+
+        puts "  Searching in #{derived_data}..." if @verbose
+        Find.find(derived_data) do |path|
+            if path.match(/#{product_name}.*\.gcda\Z/) || path.match(/#{product_name}.*\.gcno\Z/)
+                puts "  👍  .#{path.sub(derived_data, "")}".green if @verbose
+                FileUtils.cp(path, "#{temp_dir}/")
+            end
+        end
+    end
+
+    def gen_info_files(filename, temp_dir)
+        absolute_temp_dir = File.join(Dir.pwd, temp_dir)
+        gen_info_cmd = "geninfo #{absolute_temp_dir}/*.gcno --output-filename #{filename}"
+        gen_info_cmd += ' --quiet' unless @verbose
+        return system gen_info_cmd
+    end
+
+    def lcov(info_filename, filenames_to_remove, lcov_file)
+        all_removals = filenames_to_remove.map { |i| '"' + i.to_s + '"' }.join(" ")
+        lcov_cmd = "lcov --remove #{info_filename} #{all_removals} > #{lcov_file}"
+        lcov_cmd += ' --quiet' unless @verbose
+        return system lcov_cmd
+    end
+
+
+    def genhtml(output_directory, lcov_filename)
+        FileUtils.mkpath(output_directory)
+        genhtml_cmd = "genhtml --no-function-coverage --no-branch-coverage --output-directory #{output_directory} #{lcov_filename}"
+        genhtml_cmd += ' --quiet' unless @verbose
+        return system genhtml_cmd
+    end
+end

data/lib/alcove/version.rb

@@ -0,0 +1,3 @@
+class Alcove
+    VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: alcove
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Isaac Overacker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Painless code coverage reporting for Xcode projects written in Objective-C.
+email: isaac@overacker.me
+executables:
+- alcove
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/alcove/version.rb
+- lib/alcove.rb
+- bin/alcove
+- README.md
+- LICENSE
+homepage: https://github.com/ioveracker/alcove
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Painless code coverage reporting for Objective-C.
+test_files: []