Merge pull request jonreid#1 from designatednerd/master

Lcov 1.11 + CocoaPod

Author: designatednerd

README.md

@@ -1,56 +1,75 @@
 ![XcodeCoverage](http://qualitycoding.org/jrwp/wp-content/uploads/2014/03/XcodeCoverage.png)
 
-These scripts provide a simple way to generate HTML reports of the code coverage
-of your Xcode project.  
+These scripts provide a simple way to generate HTML reports of the code coverage of your Xcode project.  
 
 
-Installation
-============
+Xcode Project Setup
+===================
+
+Before you get started, there are a couple of steps you will need to take to prepare your project: 
+
+1. Depending on your version of Xcode, you may need to get Xcode's coverage instrumentation by going to Xcode > Preferences, into Downloads, and installing Command Line Tools. If you do not see this as an option in the Downloads section, the tools should already be installed. 
+4. In your Xcode project, enable these two build settings at the project level for your Debug configuration only:
+	* Instrument Program Flow
+	* Generate Test Coverage Files
+
 
-1. Fork this repository; you're probably going to want to make your own
-modifications.
+Installation: Standard
+======================
+
+1. Fork this repository; you're probably going to want to make your own modifications.
 2. Place the XcodeCoverage folder in the same folder as your Xcode project.
-3. Depending on your version of Xcode, you may need to get Xcode's coverage
-instrumentation by going to Xcode Preferences, into Downloads, and installing
-Command Line Tools.
-4. In your Xcode project, enable these two build settings at the project level
-for your Debug configuration only:
-  * Instrument Program Flow
-  * Generate Test Coverage Files
-5. In your main target, add a Run Script build phase to execute
-``XcodeCoverage/exportenv.sh``
+5. In your main target, add a Run Script build phase to execute `XcodeCoverage/exportenv.sh`
+
+A few people have been tripped up by the last step: Make sure you add the script to your main target (your app or library), not your test target.
+
+
+Installation: CocoaPods
+=======================
 
-A few people have been tripped up by the last step: Make sure you add the
-script to your main target (your app or library), not your test target.
+A [CocoaPod](http://cocoapods.org/) has been added for convenient use in simple projects. There are a couple of things you should be aware of if you are using the CocoaPod instead of the standard method: 
+
+- There will be no actual files added to your project. Files are only added through `preserve_paths`, so they will be available in your `Pods/XcodeCoverage` path, but you will not see them in Xcode, and they will not be compiled by Xcode.
+- You will not be able to modify the scripts without those modifications being potentially overwritten by CocoaPods. 
+
+If those caveats are deal-breakers, please use the standard installation method above. 
+
+The steps to install via CocoaPods: 
+
+1. Add `pod 'XcodeCoverage', '~>1.0'` (or whatever [version specification](http://guides.cocoapods.org/using/the-podfile.html#specifying-pod-versions) you desire) to your Podfile. 
+2. Run `pod install`. This will download the necessary files.
+3. In your main target, add a Run Script build phase to execute
+`Pods/XcodeCoverage/exportenv.sh`. 
+
+Again, make sure you add the script to your main target (your app or library), not your test target.
 
 
 Execution
 =========
 
-1. Run your unit tests
+Immediately after installation, run your application at least once to generate the `env.sh` file, which will be placed at the same level as your `.xcodeproj` folder. This file should *not* be checked into version control, since it contains paths local to your machine. 
+
+Once that task has been completed, the process is very simple: 
+
+1. Run your unit tests.
 2. In Terminal, execute `getcov` in your project's XcodeCoverage folder.
 
-If you make changes to your test code without changing the production code and
-want a clean slate, use the ``cleancov`` script.
+If you make changes to your test code without changing the production code and want a clean slate, use the `cleancov` script.
 
-If you make changes to your production code, you should clear out all build
-artifacts before measuring code coverage again. "Clean Build Folder" by holding
-down the Option key in Xcode's "Product" menu.
+If you make changes to your production code, you should clear out all build artifacts before measuring code coverage again. "Clean Build Folder" by holding down the Option key in Xcode's "Product" menu, or by using the ⌥⇧⌘K key combination.
 
 **Optional:** XcodeCoverage can prompt to run code coverage after running unit tests:
 
   * Edit Xcode scheme -> Test -> Post-actions
-  * Set "Shell" to: ``/bin/bash``
+  * Set "Shell" to: `/bin/bash`
   * Set "Provide build settings from" to your main target
-  * Set script to:
-  ``source ${SRCROOT}/XcodeCoverage/run_code_coverage_post.sh``
+  * Set script to: `source ${SRCROOT}/XcodeCoverage/run_code_coverage_post.sh`
 
 
 Modification
 ============
 
-There are two places you may want to modify:
+There are two places you may want to modify the included files if you are using the standard installation:
 
-1. In envcov.sh, ``LCOV_INFO`` determines the name shown in the report.
-2. In getcov, edit ``exclude_data()`` to specify which files to exclude, for
-example, third-party libraries.
+1. In `envcov.sh`, `LCOV_INFO` determines the name shown in the report.
+2. In `getcov`, edit `exclude_data()` to specify which files to exclude, for example, third-party libraries.

XcodeCoverage.podspec

@@ -0,0 +1,16 @@
+Pod::Spec.new do |spec|
+  spec.name                     = 'XcodeCoverage'
+  spec.summary                  = 'Code coverage for Xcode projects'
+  spec.version                  = '1.0.0'
+  spec.platform                 = :ios
+  spec.ios.deployment_target    = '6.0'
+  spec.authors                  = {'Jon Reid' => '[email protected]'}
+  spec.homepage                 = 'https://github.com/jonreid/XcodeCoverage'
+  spec.license                  = 'MIT'
+  spec.source                   = {:git => 'https://github.com/jonreid/XcodeCoverage.git', :tag => "#{spec.version}"}
+  
+  #these files will be brought into the filesystem, but not added to your .xcodeproj. 
+  spec.preserve_paths           = 'cleancov', 'getcov', 'llvm-cov-wrapper.sh', 'envcov.sh', 'lcov-1.11/*', 'exportenv.sh', 'run_code_coverage_post.sh'
+  
+  spec.requires_arc             = true
+end

envcov.sh

@@ -5,16 +5,36 @@
 #
 
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-source ${DIR}/env.sh
+ENV_DIR="${DIR}"
+
+if [[ $DIR == *Pods/XcodeCoverage* ]]
+then
+   echo "Using Cocoapods!"
+   cd ..
+   cd ..
+   
+   #The env.sh file will be in the project root.
+   ENV_DIR="$(pwd)"
+fi
+
+source ${ENV_DIR}/env.sh
 
 # Change the report name if you like:
 LCOV_INFO=Coverage.info
 
 XCODECOVERAGE_PATH="${SRCROOT}/XcodeCoverage"
-LCOV_PATH="${XCODECOVERAGE_PATH}/lcov-1.10/bin"
+
+if [[ $DIR == *Pods/XcodeCoverage* ]]
+then
+   echo "Using Cocoapods!"
+   #The current directory will be where XcodeCoverage is living, not in SRCROOT
+   XCODECOVERAGE_PATH="${DIR}"
+fi
+
+LCOV_PATH="${XCODECOVERAGE_PATH}/lcov-1.11/bin"
 OBJ_DIR=${OBJECT_FILE_DIR_normal}/${CURRENT_ARCH}
 
 # Fix for the new LLVM-COV that requires gcov to have a -v paramter
 LCOV() {
 	${LCOV_PATH}/lcov "$@" --gcov-tool ${XCODECOVERAGE_PATH}/llvm-cov-wrapper.sh
-}
+}

exportenv.sh

@@ -4,5 +4,5 @@
 #   Source: https://github.com/jonreid/XcodeCoverage
 #
 
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+DIR="${SRCROOT}"
 export | egrep '( BUILT_PRODUCTS_DIR)|(CURRENT_ARCH)|(OBJECT_FILE_DIR_normal)|(SRCROOT)|(OBJROOT)' > ${DIR}/env.sh

lcov-1.10/COPYING renamed to lcov-1.11/COPYING

@@ -0,0 +1,226 @@
+#!/usr/bin/perl -w
+#
+#   Copyright (c) International Business Machines  Corp., 2002
+#
+#   This program is free software;  you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation; either version 2 of the License, or (at
+#   your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful, but
+#   WITHOUT ANY WARRANTY;  without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#   General Public License for more details.                 
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program;  if not, write to the Free Software
+#   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+#
+#
+# gendesc
+#
+#   This script creates a description file as understood by genhtml.
+#   Input file format:
+#
+#   For each test case:
+#     <test name><optional whitespace>
+#     <at least one whitespace character (blank/tab)><test description>
+#   
+#   Actual description may consist of several lines. By default, output is
+#   written to stdout. Test names consist of alphanumeric characters
+#   including _ and -.
+#
+#
+# History:
+#   2002-09-02: created by Peter Oberparleiter <[email protected]>
+#
+
+use strict;
+use File::Basename; 
+use Getopt::Long;
+
+
+# Constants
+our $lcov_version	= 'LCOV version 1.11';
+our $lcov_url		= "http://ltp.sourceforge.net/coverage/lcov.php";
+our $tool_name		= basename($0);
+
+
+# Prototypes
+sub print_usage(*);
+sub gen_desc();
+sub warn_handler($);
+sub die_handler($);
+
+
+# Global variables
+our $help;
+our $version;
+our $output_filename;
+our $input_filename;
+
+
+#
+# Code entry point
+#
+
+$SIG{__WARN__} = \&warn_handler;
+$SIG{__DIE__} = \&die_handler;
+
+# Prettify version string
+$lcov_version =~ s/\$\s*Revision\s*:?\s*(\S+)\s*\$/$1/;
+
+# Parse command line options
+if (!GetOptions("output-filename=s" => \$output_filename,
+		"version" =>\$version,
+		"help|?" => \$help
+		))
+{
+	print(STDERR "Use $tool_name --help to get usage information\n");
+	exit(1);
+}
+
+$input_filename = $ARGV[0];
+
+# Check for help option
+if ($help)
+{
+	print_usage(*STDOUT);
+	exit(0);
+}
+
+# Check for version option
+if ($version)
+{
+	print("$tool_name: $lcov_version\n");
+	exit(0);
+}
+
+
+# Check for input filename
+if (!$input_filename)
+{
+	die("No input filename specified\n".
+	    "Use $tool_name --help to get usage information\n");
+}
+
+# Do something
+gen_desc();
+
+
+#
+# print_usage(handle)
+#
+# Write out command line usage information to given filehandle.
+#
+
+sub print_usage(*)
+{
+	local *HANDLE = $_[0];
+
+	print(HANDLE <<END_OF_USAGE)
+Usage: $tool_name [OPTIONS] INPUTFILE
+
+Convert a test case description file into a format as understood by genhtml.
+
+  -h, --help                        Print this help, then exit
+  -v, --version                     Print version number, then exit
+  -o, --output-filename FILENAME    Write description to FILENAME
+
+For more information see: $lcov_url
+END_OF_USAGE
+	;
+}
+
+
+#
+# gen_desc()
+#
+# Read text file INPUT_FILENAME and convert the contained description to a
+# format as understood by genhtml, i.e.
+#
+#    TN:<test name>
+#    TD:<test description>
+#
+# If defined, write output to OUTPUT_FILENAME, otherwise to stdout.
+#
+# Die on error.
+#
+
+sub gen_desc()
+{
+	local *INPUT_HANDLE;
+	local *OUTPUT_HANDLE;
+	my $empty_line = "ignore";
+
+	open(INPUT_HANDLE, "<", $input_filename)
+		or die("ERROR: cannot open $input_filename!\n");
+
+	# Open output file for writing
+	if ($output_filename)
+	{
+		open(OUTPUT_HANDLE, ">", $output_filename)
+			or die("ERROR: cannot create $output_filename!\n");
+	}
+	else
+	{
+		*OUTPUT_HANDLE = *STDOUT;
+	}
+
+	# Process all lines in input file
+	while (<INPUT_HANDLE>)
+	{
+		chomp($_);
+
+		if (/^(\w[\w-]*)(\s*)$/)
+		{
+			# Matched test name
+			# Name starts with alphanum or _, continues with
+			# alphanum, _ or -
+			print(OUTPUT_HANDLE "TN: $1\n");
+			$empty_line = "ignore";
+		}
+		elsif (/^(\s+)(\S.*?)\s*$/)
+		{
+			# Matched test description
+			if ($empty_line eq "insert")
+			{
+				# Write preserved empty line
+				print(OUTPUT_HANDLE "TD: \n");
+			}
+			print(OUTPUT_HANDLE "TD: $2\n");
+			$empty_line = "observe";
+		}
+		elsif (/^\s*$/)
+		{
+			# Matched empty line to preserve paragraph separation
+			# inside description text
+			if ($empty_line eq "observe")
+			{
+				$empty_line = "insert";
+			}
+		}
+	}
+
+	# Close output file if defined
+	if ($output_filename)
+	{
+		close(OUTPUT_HANDLE);
+	}
+
+	close(INPUT_HANDLE);
+}
+
+sub warn_handler($)
+{
+	my ($msg) = @_;
+
+	warn("$tool_name: $msg");
+}
+
+sub die_handler($)
+{
+	my ($msg) = @_;
+
+	die("$tool_name: $msg");
+}