coverband 0.0.15 → 0.0.16

data/README.md

@@ -15,15 +15,21 @@ After running in production for 30 minutes, we were able very easily delete 2000
 
 Add this line to your application's Gemfile:
 
-    gem 'coverband'
+```bash
+gem 'coverband'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install coverband
+```bash
+$ gem install coverband
+```
 
 ## Example Output
 
@@ -52,51 +58,55 @@ After installing the gem, you likely want to get the rake tasks configured as we
 
 Either add the below to your `Rakefile` or to a file included in your Rakefile
 
-	require 'coverband'
-	Coverband.configure do |config|
-      config.redis             = Redis.new
-      # merge in lines to consider covered manually to override any misses
-	  # existing_coverage = {'./cover_band_server/app.rb' => Array.new(31,1)}
-	  # JSON.parse(File.read('./tmp/coverband_baseline.json')).merge(existing_coverage) 
-      config.coverage_baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
-      config.root_paths        = ['/app/']
-      config.ignore            = ['vendor']
-    end
-
-	desc "report unused lines"
-	task :coverband => :environment do
-	  Coverband::Reporter
-	end
+```ruby
+require 'coverband'
+Coverband.configure do |config|
+  config.redis             = Redis.new
+  # merge in lines to consider covered manually to override any misses
+  # existing_coverage = {'./cover_band_server/app.rb' => Array.new(31,1)}
+  # JSON.parse(File.read('./tmp/coverband_baseline.json')).merge(existing_coverage) 
+  config.coverage_baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
+  config.root_paths        = ['/app/']
+  config.ignore            = ['vendor']
+end
+
+desc "report unused lines"
+  task :coverband => :environment do
+  Coverband::Reporter
+end
 	
-	desc "get coverage baseline"
-	task :coverband_baseline do
-	  Coverband::Reporter.baseline {
-	  	#rails
-      	require File.expand_path("../config/environment", __FILE__)
-      	#sinatra
-      	#require File.expand_path("./app", __FILE__)
-      }
-    end
+desc "get coverage baseline"
+task :coverband_baseline do
+  Coverband::Reporter.baseline {
+    #rails
+    require File.expand_path("../config/environment", __FILE__)
+    #sinatra
+    #require File.expand_path("./app", __FILE__)
+  }
+end
+```
     
 #### Configure rack middleware
 
 For the best coverage you want this loaded as early as possible. I have been putting it directly in my `config.ru` but you could use an initializer, though you may end up missing some boot up coverage.
 
-	require File.dirname(__FILE__) + '/config/environment'
+```ruby
+require File.dirname(__FILE__) + '/config/environment'
 	
-	require 'coverband'
-	
-	Coverband.configure do |config|
-	  config.root              = Dir.pwd
-	  config.redis             = Redis.new
-	  config.coverage_baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
-	  config.root_paths        = ['/app/']
-	  config.ignore            = ['vendor']
-	  config.percentage        = 100.0
-	end
-
-	use Coverband::Middleware
-	run ActionController::Dispatcher.new
+require 'coverband'
+
+Coverband.configure do |config|
+  config.root              = Dir.pwd
+  config.redis             = Redis.new
+  config.coverage_baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
+  config.root_paths        = ['/app/']
+  config.ignore            = ['vendor']
+  config.percentage        = 100.0
+end
+
+use Coverband::Middleware
+run ActionController::Dispatcher.new
+```
 	
 #### Configure Manually (for example for background jobs)
 
@@ -104,42 +114,47 @@ It is easy to use coverband outside of a Rack environment. Make sure you configu
 
 For example if you had a base resque class, you could use the `before_perform` and `after_perform` hooks to add Coverband
 
-
-      def before_perform(*args)
-		if (rand * 100.0) > Coverband.configuration.percentage
-          @@coverband ||= Coverband::Base.new
-          @recording_samples = true
-          @@coverband.start
-        else
-          @recording_samples = false
-        end
-      end
+```ruby
+def before_perform(*args)
+  if (rand * 100.0) > Coverband.configuration.percentage
+    @@coverband ||= Coverband::Base.new
+    @recording_samples = true
+    @@coverband.start
+  else
+    @recording_samples = false
+  end
+end
       
-      def after_perform(*args)
-        if  @recording_samples
-          @@coverband.stop
-          @@coverband.save
-        end
-      end
+def after_perform(*args)
+  if @recording_samples
+    @@coverband.stop
+    @@coverband.save
+  end
+end
+```
 
 In general you can run coverband anywhere by using the lines below
 
-    require 'coverband'
-    Coverband.configure do |config|
-      config.redis             = Redis.new
-      config.percentage        = 50.0
-    end
-    coverband = Coverband::Base.new
+```ruby
+require 'coverband'
+	
+Coverband.configure do |config|
+  config.redis             = Redis.new
+  config.percentage        = 50.0
+end
+  
+coverband = Coverband::Base.new
     
-    #manual
-    coverband.start
-    coverband.stop
-    coverband.save
+#manual
+coverband.start
+coverband.stop
+coverband.save
     
-    #sampling
-    coverband.sample {
-    	#code to sample coverband
-    }
+#sampling
+coverband.sample {
+  #code to sample coverband
+}
+```
  
 ## Clearing Line Coverage Data
 
@@ -150,11 +165,12 @@ you can live with minor inconsistancy for some files.
 
 As often as you like or as part of a deploy hook you can clear the recorded coverband data with the following command.
 
-    # defaults to the currently configured Coverband.configuration.redis
-    Coverband::Reporter.clear_coverage
-    # or pass in the current target redis
-    Coverband::Reporter.clear_coverage(Redis.new(:host => 'target.com', :port => 6789))
-
+```ruby
+# defaults to the currently configured Coverband.configuration.redis
+Coverband::Reporter.clear_coverage
+# or pass in the current target redis
+Coverband::Reporter.clear_coverage(Redis.new(:host => 'target.com', :port => 6789))
+```
 
 ## TODO
 

data/lib/coverband.rb

@@ -1,4 +1,5 @@
 require 'redis'
+require 'logger'
 
 require 'coverband/version'
 require 'coverband/redis_store'
@@ -18,7 +19,7 @@ module Coverband
   end
 
   class Configuration
-    attr_accessor :redis, :coverage_baseline, :root_paths, :root, :ignore, :percentage, :verbose, :reporter, :stats
+    attr_accessor :redis, :coverage_baseline, :root_paths, :root, :ignore, :percentage, :verbose, :reporter, :stats, :logger, :startup_delay
     
     def initialize
       @root = Dir.pwd
@@ -30,6 +31,8 @@ module Coverband
       @percentage = 0.0
       @verbose = false
       @reporter = 'scov'
+      @logger = nil
+      @startup_delay = 0
     end
   end
   

data/lib/coverband/base.rb

@@ -6,11 +6,14 @@ module Coverband
       @enabled = false
       @tracer_set = false
       @files = {}
+      @file_usage = {}
+      @startup_delay = Coverband.configuration.startup_delay
       @ignore_patterns = Coverband.configuration.ignore
       @sample_percentage = Coverband.configuration.percentage
       @reporter = Coverband::RedisStore.new(Coverband.configuration.redis) if Coverband.configuration.redis
       @stats    = Coverband.configuration.stats
       @verbose  = Coverband.configuration.verbose
+      @logger   = Coverband.configuration.logger || Logger.new(STDOUT)
     end
 
     def start
@@ -39,7 +42,8 @@ module Coverband
     protected
 
     def configure_sampling
-      if (rand * 100.0) > @sample_percentage
+      if @startup_delay!=0 || (rand * 100.0) > @sample_percentage
+        @startup_delay -= 1 if @startup_delay > 0
         @enabled = false
       else
         @enabled = true
@@ -55,8 +59,8 @@ module Coverband
       @stats.increment "coverband.request.recorded.#{@enabled}" if @stats
     rescue RuntimeError => err
       if @verbose
-        puts "error stating recording coverage"
-        puts "error: #{err.inspect} #{err.message}"
+        @logger.info "error stating recording coverage"
+        @logger.info "error: #{err.inspect} #{err.message}"
       end
     end
 
@@ -77,10 +81,16 @@ module Coverband
     end
     
     def add_file(file, line)
-      if file.match(@project_directory) && !@ignore_patterns.any?{|pattern| file.match(/#{pattern}/) } 
+      if !file.match(/(\/gems\/|internal\:prelude)/) && file.match(@project_directory) && !@ignore_patterns.any?{|pattern| file.match(/#{pattern}/) } 
+        if @verbose
+          if @file_usage.include?(file)
+            @file_usage[file] += 1
+          else
+            @file_usage[file] = 1
+          end
+        end
         if @files.include?(file)
-          @files[file] << line
-          @files[file].uniq!
+          @files[file] << line unless @files.include?(line)
         else
           @files[file] = [line]
         end
@@ -89,29 +99,32 @@ module Coverband
     
     def report_coverage
       unless @enabled
-        puts "coverage disabled" if @verbose
+        @logger.info "coverage disabled" if @verbose
         return
       end
 
       unset_tracer
 
+      @logger.info "coverband file usage: #{@file_usage.sort_by {|_key, value| value}.inspect}" if @verbose
+
       if @reporter
         if @reporter.class.name.match(/redis/i)
           before_time = Time.now
-          @stats.increment "coverband.files.recorded.#{@files.length}" if @stats
+          @stats.increment "coverband.files.recorded_files", @files.length if @stats
           @reporter.store_report(@files)
           time_spent = Time.now - before_time
           @stats.timing "coverband.files.recorded_time", time_spent if @stats
           @files = {}
+          @@file_usage = {}
         end
       elsif @verbose
-        puts "coverage report: "
-        puts @files.inspect
+        @logger.info "coverage report: "
+        @logger.info @files.inspect
       end
     rescue RuntimeError => err
       if @verbose
-        puts "coverage missing"
-        puts "error: #{err.inspect} #{err.message}"
+        @logger.info "coverage missing"
+        @logger.info "error: #{err.inspect} #{err.message}"
       end
     end
   end

data/lib/coverband/redis_store.rb

@@ -25,7 +25,7 @@ module Coverband
 
     def store_array(key, values)
       if sadd_supports_array?
-        redis.sadd(key, values)
+        redis.sadd(key, values) && (values.length > 0)
       else
         values.each do |value|
           redis.sadd(key, value)

data/lib/coverband/version.rb

@@ -1,3 +1,3 @@
 module Coverband
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

data/test/unit/base_test.rb

@@ -1,7 +1,7 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class BaseTest < Test::Unit::TestCase
-  
+
   should "start should enable coverage" do
     coverband = Coverband::Base.new
     assert_equal false, coverband.instance_variable_get("@enabled")
@@ -22,23 +22,27 @@ class BaseTest < Test::Unit::TestCase
   end
   
   should "allow for sampling with a block and enable when 100 percent sample" do
+    logger = Logger.new(STDOUT)
     coverband = Coverband::Base.new
     coverband.instance_variable_set("@sample_percentage", 100.0)
     coverband.instance_variable_set("@verbose", true)
+    coverband.instance_variable_set("@logger", logger)
     coverband.instance_variable_set("@reporter", nil)
     assert_equal false, coverband.instance_variable_get("@enabled")
-    coverband.expects(:puts).at_least_once
+    logger.expects(:info).at_least_once
     coverband.sample { 1 + 1 }
     assert_equal true, coverband.instance_variable_get("@enabled")
   end
   
   should "allow reporting with start stop save" do
+    logger = Logger.new(STDOUT)
     coverband = Coverband::Base.new
     coverband.instance_variable_set("@sample_percentage", 100.0)
     coverband.instance_variable_set("@verbose", true)
+    coverband.instance_variable_set("@logger", logger)
     coverband.instance_variable_set("@reporter", nil)
     assert_equal false, coverband.instance_variable_get("@enabled")
-    coverband.expects(:puts).at_least_once
+    logger.expects(:info).at_least_once
     coverband.start
     1 + 1
     coverband.stop

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-12 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -182,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1687477973538567061
+      hash: -615228549007876358
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1687477973538567061
+      hash: -615228549007876358
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23