alcove 0.1.0 → 0.2.0.pre.alpha.pre.36

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: c3a24347defb0bd648d7c15cd13d754590615977
-  data.tar.gz: a7530953e48cfc71bde431f94a235b3a17407293
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmM2NTQyZDc5OGEyNGY5YjQ5YTFkMWRjODc1OTdlODg2MWJjOWMxZA==
+  data.tar.gz: !binary |-
+    NmMyYzI1NTM1ZmE0NDFkZDg1YjQ5M2QwMmRmMWYxNjI5NTJlY2U1OA==
 SHA512:
-  metadata.gz: e74cccadf0a4dcd053843c3d5271c27e11c1823d91499d855c86981ea76b9c90c55490fd358522866b5c8c39ba54ca3a0f9542ee9827d71234e3be664da9f1a6
-  data.tar.gz: a95b48ef3a9ccd19fabda7e85c88fb3f47c2a2602bf34b5483ca6bef751b9859f9d7e36060a826bbe6bca5d3d9ea045bc0382845ac72f3664566c2c8869106c8
+  metadata.gz: !binary |-
+    ZDM3YjY3Yjg1MzNlNTllYzMwMTY5N2Q0YTc4NGEyM2VhYjk4Yzg0NmFkNGVm
+    ZWEzMmMzNDY4YTJjZDEzZWQ2M2E2ZjAzMWU2MTc2MGJhNjk5ZjEyYjY2NzZl
+    NGM1ZmRhZWU3NGEyYmI4N2NmZDYzOGYwMjMxMjI5NThjNzgyNDc=
+  data.tar.gz: !binary |-
+    ZjVmOTRiN2JmOTE5M2ExMjY1NWM2ZjZlZmI1NTA1YzdhY2I3MWY0YTQyYTll
+    NTE1YTA4M2NmMmE5NjI2YmQ4OWVhNDI4MDUwMWE2ZmFjYzFhMDgyNmEwYTEw
+    MzVkNWJjYzQ5ZWIzYTE0ODk3MWZhNzM4MGVjMzExMmMxZDk5Y2Q=

data/README.md

@@ -1,9 +1,9 @@
-# Alcove [![Build Status](https://travis-ci.org/ioveracker/Alcove.svg?branch=master)](https://travis-ci.org/ioveracker/Alcove)
+# Alcove [![Gem Version](https://badge.fury.io/rb/alcove.svg)](http://badge.fury.io/rb/alcove) [![Build Status](https://travis-ci.org/ioveracker/Alcove.svg?branch=master)](https://travis-ci.org/ioveracker/Alcove) [![Code Climate](https://codeclimate.com/github/ioveracker/Alcove/badges/gpa.svg)](https://codeclimate.com/github/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
+    $ gem install alcove
     
 If you don't have it already, you'll also need to install lcov.
 
@@ -16,7 +16,8 @@ If you don't have it already, you'll also need to install lcov.
     $ 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*).
+If you haven't already, open your project in Xcode and update your non-test targets to Generate Test Coverage Files and Instrument Program Flow (*for Debug configuration only*).
+![Xcode](http://i.imgur.com/xdcg4er.png?1)
 
 ## 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:
@@ -24,3 +25,20 @@ Now that you have the prerequisites out of the way, you can generate a report.
     alcove --product-name <your-product-name>
 
 Be sure to check out the --help for additional options for fine-tuning your report.
+
+## Options
+
+### --output-directory
+Specify this option to change the output directory for the report.  Any intermediate paths will be created.
+
+### --product-name
+The product name specified in your Xcode project.
+
+### --remove-filter
+A list of filters to use when gathering files for the report.  Use this if you want to exclude certain files from the report.  For example: `alcove --product-name SampleProduct --remove-filter *.h,main.m` will exclude header files and the main.m file from the report.
+
+### --search-directory
+Use this option to specify the directory to be searched for your product.  Alcove plays nicely with the the structure on your development machine, as well as on an Xcode Server, but if you have some funky output directory for your build, you can specify its parent here.
+
+## Attribution
+Shoutout to [@NateBank](https://github.com/NateBank) for the [name suggestion](https://www.youtube.com/watch?v=j1Q-a5zCmhc).

data/bin/alcove

@@ -7,62 +7,125 @@ require 'optparse'
 
 options = OpenStruct.new
 OptionParser.new do |opts|
-    opts.banner = "Usage: alcove --product-name <product-name> [options]"
+  opts.banner = "Usage: alcove --product-name <product-name> [options]"
 
-    opts.on('-h', '--help', 'Displays the help screen') do
-        puts opts
-        exit
-    end
+  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.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
+  opts.on("--percent-file", "Generate a file containing coverage percent") do |p|
+    options.generate_percent_file = true
+  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
+  options.product_name = ""
+  opts.on("-p", "--product-name NAME", "The name of your product") do |p|
+    options.product_name = p
+  end
 
-    opts.on('-s', '--search-directory DIR', 'Search in DIR for coverage files') do |s|
-        options.search_directory = s
-    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
 
-    options.verbose = false
-    opts.on('-v', '--verbose', 'Output additional information') do
-        options.verbose = true
-    end
+  opts.on("-s", "--search-directory DIR", "Search in DIR for coverage files") do |s|
+    options.search_directory = s
+  end
 
-    opts.on_tail('--version', 'Show version') do
-        puts Alcove::VERSION
-        exit
-    end
+  options.verbose = false
+  opts.on("-v", "--verbose", "Output additional information") do
+    options.verbose = true
+  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)
+  opts.on_tail("--version", "Show version") do
+    puts Alcove::VERSION
+    exit
+  end
+
+  begin
+    opts.parse!(ARGV)
+    if options.product_name.length == 0
+      STDERR.puts "--product-name is required".yellow
+      puts opts
+      exit(1)
     end
+  rescue OptionParser::InvalidOption => e
+    puts e
+    puts opts
+    exit(1)
+  end
+end
+
+def exit_with_code(code)
+  FileUtils.rm_rf(Alcove::TEMP_DIR)
+  exit(code)
 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
+puts " 🔍  Generating report..."
+
+FileUtils.rm_rf(Alcove::TEMP_DIR)
+FileUtils.mkdir(Alcove::TEMP_DIR)
+
+if options.search_directory
+  search_directory = options.search_directory
+else
+  search_directory = alcove.get_search_directory
+end
+alcove.copy_input_files_to_temp(search_directory, options.product_name)
+
+gi_filename_absolute = File.join(Alcove::TEMP_DIR, "alcove-info.temp")
+gen_success = alcove.gen_info_files(gi_filename_absolute)
+if gen_success
+  puts " ✅  geninfo successful".green if options.verbose
+else
+  STDERR.puts " 🚫  geninfo failed!".red
+  exit_with_code(1)
+end
+
+lcov_filename_absolute = File.join(Alcove::TEMP_DIR, "alcove-lcov.info")
+lcov_success = alcove.lcov(gi_filename_absolute, options.remove_filter, lcov_filename_absolute)
+if lcov_success
+  puts " ✅  lcov successful".green if options.verbose
+else
+  STDERR.puts " 🚫  lcov failed!".red
+  exit_with_code(1)
+end
+
+genhtml_success, coverage_percent = alcove.genhtml(lcov_filename_absolute, options.output_directory)
+if genhtml_success
+  puts "" if options.verbose
+  puts " ✅  Successfully generated report".green
+
+  coverage_string = " 📊  Line coverage: #{coverage_percent}%"
+  if coverage_percent < 50
+    puts coverage_string.red
+  elsif coverage_percent < 85
+    puts coverage_string.yellow
+  else
+    puts coverage_string.green
+  end
+
+  puts " 🍻  Open #{options.output_directory}/index.html to view the report"
+
+else
+  STDERR.puts " 🚫  genhtml failed!".red
+  exit_with_code(1)
+end
+
+if options.generate_percent_file
+  File.open("#{options.output_directory}/alcove-percent.txt", 'w') {|f|
+    f.write(coverage_percent)
+  }
+
+end
+
+exit_with_code(0)

data/lib/alcove.rb

@@ -4,110 +4,98 @@ require 'find'
 require 'fileutils'
 require 'ostruct'
 require 'optparse'
+require 'open3'
 
 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
+  TEMP_DIR = "alcove-temp"
+  # Public: Initializes a new instance.
+  def initialize(options)
+    @verbose = options.verbose
+  end
+
+  # Public: Determines the directory to use when searching for .gcno and .gcda
+  #   files.
+  #
+  # Returns the directory to search.
+  def get_search_directory
+    if ENV["XCS_SOURCE_DIR"]
+      puts "  Xcode Server found." if @verbose
+      ENV["XCS_SOURCE_DIR"].sub("Source", "DerivedData")
+    else
+      puts "  Development machine found." if @verbose
+      File.join(Etc.getpwuid.dir, "/Library/Developer/Xcode/DerivedData")
     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
+
+  # Public: Searches for the .gcno and .gcda files required to generate the
+  #   report and copies them into the temp directory.
+  #
+  # search_directory - The directory to search for .gcno and .gcda files.
+  # product_name     - The product name (${PRODUCT_NAME}) from the Xcode
+  #                    project, which will be used to determine what .gcno and
+  #                    .gcda files to copy.
+  #
+  # Returns nothing.
+  def copy_input_files_to_temp(search_directory, product_name)
+    puts " 📦  Gathering .gcno and .gcda files..." if @verbose
+    puts "  Searching in #{search_directory}..." if @verbose
+    Find.find(search_directory) do |path|
+      if path.match(/#{product_name}.*\.gcda\Z/) || path.match(/#{product_name}.*\.gcno\Z/)
+        puts "  👍  .#{path.sub(search_directory, "")}".green if @verbose
+        FileUtils.cp(path, "#{Alcove::TEMP_DIR}/")
+      end
     end
+  end
+
+  # Public: Calls the geninfo command to generate information files for
+  #   lcov to process.
+  #
+  # filename - The name of the file to be created by geninfo.
+  #
+  # Returns the result of the geninfo command.
+  def gen_info_files(filename)
+    absolute_temp_dir = File.join(Dir.pwd, Alcove::TEMP_DIR)
+    gen_info_cmd = "geninfo #{absolute_temp_dir}/*.gcno --output-filename #{filename}"
+    gen_info_cmd << " --quiet" unless @verbose
+    system gen_info_cmd
+  end
+
+  # Public: Calls the lcov command to generate coverage information files.
+  #
+  # info_filename       - The name of the file generated by geninfo
+  # filenames_to_remove - An array of filters to remove from the report.
+  # lcov_file           - The file in which lcov will place the generated info.
+  #
+  # Returns the result of the lcov command.
+  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
+    system lcov_cmd
+  end
+
+  # Public: Calls the genhtml command to generate an HTML report from the
+  #   lcov information file.
+  #
+  # lcov_file_path    - The path to the file generated by lcov.
+  # output_directory  - The directory where output files should be placed.
+  #
+  # Returns the result of the genhtml command.
+  def genhtml(lcov_file_path, output_directory)
+    FileUtils.mkpath(output_directory)
+    genhtml_cmd = "genhtml --no-function-coverage --no-branch-coverage --output-directory #{output_directory} #{lcov_file_path}"
+
+    stdout, stderr, exit_status = Open3.capture3(genhtml_cmd)
+    puts stdout if @verbose
+    summary_string = extract_percent_from_summary(stdout)
+
+    return exit_status.success?, summary_string
+  end
+
+  # Public: Extracts the percentage from the lcov summary string.
+  #
+  # summary - The summary string output by lcov or genhtml
+  def extract_percent_from_summary(summary)
+    summary[/lines.*: (.*)%/, 1].to_f
+  end
 end

data/lib/alcove/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alcove
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.pre.alpha.pre.36
 platform: ruby
 authors:
 - Isaac Overacker
@@ -28,30 +28,44 @@ dependencies:
   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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
 description: Painless code coverage reporting for Xcode projects written in Objective-C.
 email: isaac@overacker.me
 executables:
@@ -59,11 +73,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/alcove/version.rb
-- lib/alcove.rb
-- bin/alcove
-- README.md
 - LICENSE
+- README.md
+- bin/alcove
+- lib/alcove.rb
+- lib/alcove/version.rb
 homepage: https://github.com/ioveracker/alcove
 licenses:
 - MIT
@@ -74,17 +88,17 @@ 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'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Painless code coverage reporting for Objective-C.