slather 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTRhNzdkNDJiNDE5MjJkZjdiMzJmMTA2ZTVjNDA2MTRiZjgzNjZmMQ==
+    MjE0ZGEwODBjMDJiM2QyY2IyMDhhOWU2M2Y3ZTAyYjljZjdhNDk0OQ==
   data.tar.gz: !binary |-
-    NjcyYzEzNGE0YWU0M2YzZTk1ZDk5NTc4OTdkZTQxZjY3YjAxYWJhMA==
+    MzFlYjM1YzliYzk4MWJlZWExYjYzZDQyMzM5YzJhNWQ0NDZlODc0OA==
 SHA512:
   metadata.gz: !binary |-
-    Nzk1ZGUyYWIxOGJlMWE1NWMwZTUwZDA3NDY4ZjI0MjA5OWYwYTU0M2E4OGU1
-    MDU0MDhlNTYyNDkyYTg5NjRjMmU2ZjJiYTBmMmFhNDg0OTA5NTYyMWU2YzA0
-    ZmUzZDY2YzkxZGI2NzUwNjIxYjU3Y2RiODFiZDc4ODk0MmM2NmQ=
+    Yzg0NmNkYzY1MmUwZWExZTRkMjA0ODI2NWE1NWM4YWEwZjliYWUwZGUwZDhm
+    NDg0NGE0YmZiY2NjODI3ODQ3ZjcwNDQzMWJlY2QyZWJjOGE5Mzc3NWE3NWQ2
+    ZDZiYmJiOWNlMGZhNmJmMDhlNmJiNzMyYjU5ODUwNTY4NTczZmU=
   data.tar.gz: !binary |-
-    YjQ4MDgxMTZmNmQ2OTJiYjgyZDhkNzRmYWFiYTI5MGY1MDk3YjIwYmM0OThl
-    YTAwYjk1NmNiMmJlNTNkYjM3Yjk5NDlmNzA4NDMwZjNiNWMxNWVkODFhZjFi
-    ZTg0ODgxOGQ1MjZhYTE5YTNjZWIxYzI5YzExMjg1MTVmYzYwMWU=
+    YTIyZThhMWFjY2VhMDA4NzUwOWE4YmI0YzFhN2Q2YTFkNDc2MzQ0NDQzMTVl
+    ZWQ5MjIyYTVkZTc5ODBhMDg4YTIwN2Y2ZDQ2OWE5YjZiZDA1MTUxYmE3OGU3
+    NTExNjBiZTFjYWY2ZDJjMDRkYTc2MWVkNjdkNmU5OGVmOGEwZTE=

data/.gitignore

@@ -21,4 +21,22 @@ tmp
 *.a
 mkmf.log
 
+# Xcode
+#
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
 *.DS_Store

data/README.md

@@ -1,6 +1,9 @@
 # Slather
 
-TODO: Write a gem description
+Generate test coverage reports for Xcode projects. Apply tests liberally.
+
+| [Parsimmon](https://github.com/ayanonagon/Parsimmon) | [![Parsimmon Coverage](https://coveralls.io/repos/ayanonagon/Parsimmon/badge.png?branch=master)](https://coveralls.io/r/ayanonagon/Parsimmon?branch=master) |
+|------------------------------------------------------------|:----------------------------------------------------:|
 
 ## Installation
 
@@ -12,18 +15,54 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install slather
+Setup your project for test coverage:
 
-## Usage
+    $ slather setup path/to/project.xcodeproj
+
+This will enable the `Generate Test Coverage` and `Instrument Program Flow` flags for your project.
+
+
+To test if you're ready to generate test coverage, run your test suite on your project, and then run:
+
+    $ slather coverage -s path/to/project.xcodeproj
+
+### Coveralls
+
+Login to https://coveralls.io/ and enable your repository. Right now, `slather` only supports coveralls via Travis CI.
+
+Make a `.slather.yml` file:
 
-TODO: Write usage instructions here
+```yml
+# .slather.yml
+
+coverage_service: coveralls
+xcodeproj: path/to/project.xcodeproj
+ignore:
+  - ExamplePodCode/*
+  - ProjectTestsGroup/*
+```
+
+And then in your `.travis.yml`, call `slather` after a successful_build
+
+```yml
+# .travis.yml
+
+after_success: slather
+```
+
+### Custom Build Directory
+
+Slather will look for the test coverage files in `DerivedData` by default. If you send build output to a custom location, like [this](https://github.com/erikdoe/ocmock/blob/master/Tools/travis.sh#L12), then you should also set the `build_directory` property in `.slather.yml`
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/slather/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+We'd love to see your ideas for improving this library! The best way to contribute is by submitting a pull request. We'll do our best to respond to your patch as soon as possible. You can also submit a [new Github issue](https://github.com/venmo/slather/issues/new) if you find bugs or have questions. :octocat:
+
+Please make sure to follow our general coding style and add test coverage for new features!
+
+## Contributors
+
+* [@tpoulos](https://github.com/tpoulos), the perfect logo.
+* [@ayanonagon](https://github.com/ayanonagon) and [@kylef](https://github.com/benzguo), feedback and testing.

data/bin/slather

@@ -1,17 +1,85 @@
 #!/usr/bin/env ruby
-
 require 'clamp'
-require File.join(File.dirname(__FILE__), '..', 'lib', 'slather')
+require 'yaml'
+require File.join(File.dirname(__FILE__), '../lib/slather')
 
 Clamp do
 
-  parameter "xcodeproj", "Path to the xcodeproj", :attribute_name => :xcodeproj_path
+  self.default_subcommand = "coverage"
+
+  subcommand "coverage", "Computes coverage for the supplised project" do
+
+    parameter "[xcodeproj]", "Path to the xcodeproj", :attribute_name => :xcodeproj_path
+
+    option ["--travis", "-t"], :flag, "Indicate that the builds are running on Travis CI"
+
+    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..."
+          
+      setup_service_name
+      setup_ignore_list
+      setup_build_directory
+      setup_coverage_service
+
+      post
+
+      puts "Slathered"
+    end
+
+    def setup_build_directory
+      project.build_directory = build_directory if build_directory
+    end
+
+    def setup_ignore_list
+      project.ignore_list = ignore_list if !ignore_list.empty?
+    end
+
+    def setup_service_name
+      if travis?
+        project.ci_service = :travis_ci
+      end
+    end
+
+    def post
+      project.post
+    end
+
+    def project
+      @project ||= begin
+        xcodeproj_path_to_open = xcodeproj_path || Slather::Project.yml["xcodeproj"]
+        if xcodeproj_path_to_open
+          project = Slather::Project.open(xcodeproj_path_to_open)
+        else
+          raise StandardError, "Must provide an xcodeproj through .slather.yml"
+        end
+      end
+    end
+
+    def setup_coverage_service
+      if coveralls?
+        project.coverage_service = :coveralls
+      elsif simple_output?
+        project.coverage_service = :terminal
+      end
+    end
 
-  def execute
-    puts "slathering..."
-    project = Slather::Project.open(xcodeproj_path)
-    project.post_to_coveralls
-    puts "done!"
   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.rb

@@ -2,6 +2,11 @@ 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
+
+  Encoding.default_external = "utf-8"
+
 end

data/lib/slather/coverage_file.rb

@@ -3,15 +3,16 @@ module Slather
 
     attr_accessor :project, :gcno_file_pathname
 
-    def initialize(gcno_file_pathname)
-      @gcno_file_pathname = Pathname(gcno_file_pathname)
+    def initialize(project, gcno_file_pathname)
+      self.project = project
+      self.gcno_file_pathname = Pathname(gcno_file_pathname)
     end
 
     def source_file_pathname
       @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
@@ -24,8 +25,8 @@ module Slather
       source_file.read
     end
 
-    def source_file_pathname_relative_to_project_root
-      source_file_pathname.relative_path_from(project.main_group.real_path)
+    def source_file_pathname_relative_to_repo_root
+      source_file_pathname.relative_path_from(Pathname("./").realpath)
     end
 
     def gcov_data
@@ -57,5 +58,11 @@ module Slather
       end
     end
 
+    def ignored?
+      project.ignore_list.any? do |ignore|
+        File.fnmatch(ignore, source_file_pathname_relative_to_repo_root)
+      end
+    end
+
   end
 end

data/lib/slather/coverage_service/coveralls.rb

@@ -0,0 +1,52 @@
+module Slather
+  module CoverageService
+    module Coveralls
+
+      def coverage_file_class
+        Slather::CoverallsCoverageFile
+      end
+      private :coverage_file_class
+
+      def travis_job_id
+        ENV['TRAVIS_JOB_ID']
+      end
+      private :travis_job_id
+
+      def coveralls_coverage_data
+        if ci_service == :travis_ci
+          if travis_job_id
+            {
+              :service_job_id => travis_job_id,
+              :service_name => "travis-ci",
+              :source_files => coverage_files.map(&:as_json)
+            }.to_json
+          else
+            raise StandardError, "Environment variable `TRAVIS_JOB_ID` not set. Is this running on a travis build?"
+          end
+        else
+          raise StandardError, "No support for ci named #{ci_service}"
+        end
+      end
+      private :coveralls_coverage_data
+
+      def post
+        f = File.open('coveralls_json_file', 'w+')
+        begin
+          f.write(coveralls_coverage_data)
+          f.close
+          `curl -s --form json_file=@#{f.path} #{coveralls_api_jobs_path}`
+        rescue StandardError => e
+          FileUtils.rm(f)
+          raise e
+        end
+        FileUtils.rm(f)
+      end
+
+      def coveralls_api_jobs_path
+        "https://coveralls.io/api/v1/jobs"
+      end
+      private :coveralls_api_jobs_path
+
+    end
+  end
+end

data/lib/slather/coverage_service/simple_output.rb

@@ -0,0 +1,32 @@
+module Slather
+  module CoverageService
+    module SimpleOutput
+
+      def coverage_file_class
+        Slather::CoverallsCoverageFile
+      end
+      private :coverage_file_class
+
+      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_repo_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/coveralls_coverage_file.rb

@@ -11,7 +11,7 @@ module Slather
 
     def as_json
       {
-        :name => source_file_pathname_relative_to_project_root.to_s,
+        :name => source_file_pathname_relative_to_repo_root.to_s,
         :source => source_data,
         :coverage => coverage_data
       }

data/lib/slather/project.rb

@@ -1,47 +1,95 @@
 require 'fileutils'
 require 'xcodeproj'
 require 'json'
+require 'yaml'
 
 module Slather
   class Project < Xcodeproj::Project
 
+    attr_accessor :build_directory, :ignore_list, :ci_service, :coverage_service
+
+    def self.open(xcodeproj)
+      proj = super
+      proj.configure_from_yml
+      proj
+    end
+
     def derived_data_dir
       File.expand_path('~') + "/Library/Developer/Xcode/DerivedData/"
     end
     private :derived_data_dir
 
+    def build_directory
+      @build_directory || derived_data_dir
+    end
+
     def coverage_files
-      Dir["#{derived_data_dir}/**/*.gcno"].map do |file|
-        coverage_file = Slather::CoverallsCoverageFile.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
-        end
-        next nil
+      coverage_files = Dir["#{build_directory}/**/*.gcno"].map do |file|
+        coverage_file = coverage_file_class.new(self, file)
+        # If there's no source file for this gcno, it probably belongs to another project.
+        coverage_file.source_file_pathname && !coverage_file.ignored? ? coverage_file : 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'] || 27647662,
-        :service_name => "travis-ci",
-        :source_files => coverage_files.map(&:as_json)
-      }.to_json
+    def self.yml_filename
+      '.slather.yml'
+    end
+
+    def self.yml
+      @yml ||= File.exist?(yml_filename) ? YAML.load_file(yml_filename) : {}
+    end
+
+    def configure_from_yml
+      configure_build_directory_from_yml
+      configure_ignore_list_from_yml
+      configure_ci_service_from_yml
+      configure_coverage_service_from_yml
+    end
+
+    def configure_build_directory_from_yml
+      self.build_directory = self.class.yml["build_directory"] if self.class.yml["build_directory"] && !@build_directory
+    end
+
+    def configure_ignore_list_from_yml
+      self.ignore_list = [(self.class.yml["ignore"] || [])].flatten unless self.ignore_list
+    end
+
+    def configure_ci_service_from_yml
+      self.ci_service = (self.class.yml["ci_service"] || :travis_ci) unless self.ci_service
+    end
+
+    def ci_service=(service)
+      @ci_service = service && service.to_sym
+    end
+
+    def configure_coverage_service_from_yml
+      self.coverage_service = (self.class.yml["coverage_service"] || :terminal) unless coverage_service
+    end
+
+    def coverage_service=(service)
+      service = service && service.to_sym
+      if service == :coveralls
+        extend(Slather::CoverageService::Coveralls)
+      elsif service == :terminal
+        extend(Slather::CoverageService::SimpleOutput)
+      else
+        raise ArgumentError, "`#{coverage_service}` is not a valid coverage service. Try `terminal` or `coveralls`"
+      end
+      @coverage_service = service
     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