slather 0.0.232 → 0.0.233

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bbb2caf17f28f8fe8f73db141d508930399ba60
-  data.tar.gz: 41a11f359af9d87b35813a953f245100ba990e6c
+  metadata.gz: 0dde61485c0ba365e1030ab355fceb8a83f54822
+  data.tar.gz: 5f52fc6736730b6c04d0fec21284d2972fa098a8
 SHA512:
-  metadata.gz: b803cd88dbc314d6ad08c1af670c08485d33c3274a5206ac395156202a9bf7290c46a62c4b41a3cb5e5896d62f126ccf325d8740fbd01f2ee1b33853f3990f35
-  data.tar.gz: f487734a7facc0130c11bf9c6d7d0ab5ba6447a73ab02369c58cb223bcdb39945e20423c3c0843d10244159aef82180d5825f79e6f0f69b1579364a3f98bb3a4
+  metadata.gz: 68313dc2637e7b9e59cabd5961a092bd6546ae958624877311eaf1823b86fb2d4bcab0ab71728c0b31c304c57c572907b53ae8eab0eeadabec4ec55853ec50df
+  data.tar.gz: 8551d85897124c58a9895a8a0448a4fd2152af1c90f118263e92da4f8ecbd8fcb8e80644fb9cf21e8b6ee672430d6a5338b26a8defc5f89d7e96860e725c3eac

data/bin/slather

@@ -1,19 +1,54 @@
 #!/usr/bin/env ruby
 
 require 'clamp'
+require 'yaml'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'slather')
 
 Clamp do
 
-  parameter "xcodeproj", "Path to the xcodeproj", :attribute_name => :xcodeproj_path
-  option ["--build-directory", "-b"], "BUILD_DIRECTORY", "The directory where gcno files will be written to. Defaults to derived data."
+  self.default_subcommand = "coverage"
+
+  subcommand "coverage", "Computes coverage for the supplised project" do
+
+    option "--project, -p", "PROJECT", "Path to the xcodeproj", :attribute_name => :xcodeproj_path
+
+    option ["--coveralls", "-c"], :flag, "Post coverage results to coveralls"
+    option ["--simple-output", "-s"], :flag, "Post coverage results to coveralls"
+
+    option ["--build-directory", "-b"], "BUILD_DIRECTORY", "The directory where gcno files will be written to. Defaults to derived data."
+    option ["--ignore", "-i"], "IGNORE", "ignore files conforming to a path", :multivalued => true
+
+    def execute
+      puts "Slathering..."
+
+      xcodeproj_path_to_open = xcodeproj_path || Slather::Project.yml_file["xcodeproj"]
+
+      project = Slather::Project.open(xcodeproj_path_to_open)
+
+      if coveralls?
+        project.extend(Slather::CoverageService::Coveralls)
+      elsif simple_output?
+        project.extend(Slather::CoverageService::SimpleOutput)
+      end
+          
+      project.ignore_list = ignore_list if !ignore_list.empty?
+      project.build_directory = build_directory if build_directory
+      project.post
+
+      puts "Done slathering!"
+    end
 
-  def execute
-    puts "Slathering..."
-    project = Slather::Project.open(xcodeproj_path)
-    project.build_directory = build_directory
-    project.post_to_coveralls
-    puts "Done slathering!"
   end
 
+  subcommand "setup", "Configures an xcodeproj for test coverage generation" do
+
+    parameter "[xcodeproj]", "Path to the xcodeproj", :attribute_name => :xcodeproj_path
+
+    def execute
+      project = Slather::Project.open(xcodeproj_path)
+      project.setup_for_coverage
+      project.save
+    end
+
+  end
 end

data/lib/slather/coverage_file.rb

@@ -11,7 +11,7 @@ module Slather
       @source_file_pathname ||= begin
         base_filename = gcno_file_pathname.basename.sub_ext("")
         # TODO: Handle Swift
-        path = Dir["#{project.main_group.real_path}/*/#{base_filename}.m"].first
+        path = Dir["#{project.main_group.real_path}/**/#{base_filename}.m"].first
         path && Pathname(path)
       end
     end

data/lib/slather/coverage_service/coveralls.rb

@@ -0,0 +1,27 @@
+module Slather
+  module CoverageService
+    module Coveralls
+
+      def coverage_file_class
+        Slather::CoverallsCoverageFile
+      end
+
+      def coveralls_coverage_data
+        {
+          :service_job_id => ENV['TRAVIS_JOB_ID'],
+          :service_name => "travis-ci",
+          :source_files => coverage_files.map(&:as_json)
+        }.to_json
+      end
+      private :coveralls_coverage_data
+
+      def post
+        f = File.open('coveralls_json_file', 'w+')
+        f.write(coveralls_coverage_data)
+        `curl -s --form json_file=@#{f.path} https://coveralls.io/api/v1/jobs`
+        FileUtils.rm(f)
+      end
+
+    end
+  end
+end

data/lib/slather/coverage_service/simple_output.rb

@@ -0,0 +1,31 @@
+module Slather
+  module CoverageService
+    module SimpleOutput
+
+      def coverage_file_class
+        Slather::CoverallsCoverageFile
+      end
+
+      def post
+        total_project_lines = 0
+        total_project_lines_tested = 0
+        coverage_files.each do |coverage_file|
+          # ignore lines that don't count towards coverage (comments, whitespace, etc). These are nil in the array.
+          coverage_data = coverage_file.coverage_data.compact
+
+          lines_tested = coverage_data.select { |cd| cd > 0 }.count
+          total_lines = coverage_data.count
+          percentage = '%.2f' % [(lines_tested / total_lines.to_f) * 100.0]
+
+          total_project_lines_tested += lines_tested
+          total_project_lines += total_lines
+
+          puts "#{coverage_file.source_file_pathname_relative_to_project_root}: #{lines_tested} of #{total_lines} lines (#{percentage}%)"
+        end
+        total_percentage = '%.2f' % [(total_project_lines_tested / total_project_lines.to_f) * 100.0]
+        puts "Test Coverage: #{total_percentage}%"
+      end
+
+    end
+  end
+end

data/lib/slather/project.rb

@@ -1,11 +1,18 @@
 require 'fileutils'
 require 'xcodeproj'
 require 'json'
+require 'yaml'
 
 module Slather
   class Project < Xcodeproj::Project
 
-    attr_accessor :build_directory
+    attr_accessor :build_directory, :ignore_list
+
+    def self.open(xcodeproj)
+      proj = super
+      proj.configure_from_yml
+      proj
+    end
 
     def derived_data_dir
       File.expand_path('~') + "/Library/Developer/Xcode/DerivedData/"
@@ -18,37 +25,55 @@ module Slather
     private :build_directory
 
     def coverage_files
-      Dir["#{build_directory}/**/*.gcno"].map do |file|
-        coverage_file = Slather::CoverallsCoverageFile.new(file)
+      coverage_files = Dir["#{build_directory}/**/*.gcno"].map do |file|
+        coverage_file = coverage_file_class.new(file)
         coverage_file.project = self
-        # If there's no source file for this gcno, or the gcno is old, it probably belongs to another project.
-        if coverage_file.source_file_pathname
-          stale_seconds_limit = 60
-          if (Time.now - File.mtime(file) < stale_seconds_limit)
-            next coverage_file
-          else
-            puts "Skipping #{file} -- older than #{stale_seconds_limit} seconds ago."
-          end
+        # If there's no source file for this gcno, it probably belongs to another project.
+        if coverage_file.source_file_pathname && !(coverage_file.source_file_pathname_relative_to_project_root.to_s =~ /^(#{ignore_list.join("|")})$/)
+          coverage_file
+        else
+          nil
         end
-        next nil
       end.compact
+
+      if coverage_files.empty?
+        raise StandardError, "No coverage files found. Are you sure your project is setup for generating coverage files? Try `slather setup your/project.pbxproj`"
+      else
+        coverage_files
+      end
     end
     private :coverage_files
 
-    def coveralls_coverage_data
-      {
-        :service_job_id => ENV['TRAVIS_JOB_ID'],
-        :service_name => "travis-ci",
-        :source_files => coverage_files.map(&:as_json)
-      }.to_json
+    def self.yml_file
+      @yml_file ||= begin
+        yml_filename = '.slather.yml'
+        if File.exist?(yml_filename)
+          YAML.load_file(yml_filename)
+        else
+          {}
+        end
+      end
+    end
+
+    def configure_from_yml
+      self.build_directory = self.class.yml_file["build_directory"] if self.class.yml_file["build_directory"]
+      self.ignore_list = self.class.yml_file["ignore"] || []
+
+      coverage_service = self.class.yml_file["coverage_service"]
+      if coverage_service == "coveralls"
+        extend(Slather::CoverageService::Coveralls)
+      elsif coverage_service == "terminal"
+        extend(Slather::CoverageService::SimpleOutput)
+      elsif !self.class.method_defined?(:post)
+        raise ArgumentError, "value `#{coverage_service}` not valid for key `coverage_service` in #{self.class.yml_file.path}. Try `terminal` or `coveralls`"
+      end
     end
-    private :coveralls_coverage_data
 
-    def post_to_coveralls
-      f = File.open('coveralls_json_file', 'w+')
-      f.write(coveralls_coverage_data)
-      `curl -s --form json_file=@#{f.path} https://coveralls.io/api/v1/jobs`
-      FileUtils.rm(f)
+    def setup_for_coverage
+      build_configurations.each do |build_configuration|
+        build_configuration.build_settings["GCC_INSTRUMENT_PROGRAM_FLOW_ARCS"] = "YES"
+        build_configuration.build_settings["GCC_GENERATE_TEST_COVERAGE_FILES"] = "YES"
+      end
     end
 
   end

data/lib/slather/version.rb

@@ -1,3 +1,3 @@
 module Slather
-  VERSION = "0.0.232"
+  VERSION = "0.0.233"
 end

data/lib/slather.rb

@@ -2,6 +2,8 @@ require 'slather/version'
 require 'slather/project'
 require 'slather/coverage_file'
 require 'slather/coveralls_coverage_file'
+require 'slather/coverage_service/coveralls'
+require 'slather/coverage_service/simple_output'
 
 module Slather
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slather
 version: !ruby/object:Gem::Version
-  version: 0.0.232
+  version: 0.0.233
 platform: ruby
 authors:
 - Mark Larsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,6 +110,8 @@ files:
 - bin/slather
 - lib/slather.rb
 - lib/slather/coverage_file.rb
+- lib/slather/coverage_service/coveralls.rb
+- lib/slather/coverage_service/simple_output.rb
 - lib/slather/coveralls_coverage_file.rb
 - lib/slather/project.rb
 - lib/slather/version.rb