coverband 1.0.3 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32fd77ef72fd2521addf3e66074af44d1963f16b
-  data.tar.gz: 6f978b929e31a9d2ad67e1964ea431b8823eed2e
+  metadata.gz: cc5c300ba7c487716b6a46f455757351caaaafea
+  data.tar.gz: 6a8509f0b16f807930bcb15a409f273bbdcdd241
 SHA512:
-  metadata.gz: 5f88e79d2e75dfeb687438f27d251e3eda0693622cbd9dd8697b45bdff95d6ba6c750d2a3aae048829a2cacac87090747320d3e9a5dfe2f7fb17378a765bc2ea
-  data.tar.gz: 6802dcf7c4d5efdd7f757f4ff7bf4ae5b4eafac379c9742580f28a84dc5396c8b2ca0f2a08c72c77e6724507d8650c260e0f3d174fbd1f9c28ab9b778ea94202
+  metadata.gz: fb3eeb08c1b3e00de3e9c19ceed3e3d3275c9e43b8e9b38bce8725788b00a951923bec225349eb8df1178810de31ccd914fe5663821f095f7fdcbc2c2692edc7
+  data.tar.gz: b7794879639fb64bab184ceca7763c716db6384cb36d814db091b6a2e2d77375fb51f47f2df6321b68f27c4f513318c509a5fd974a0d2ac54a2a5f06b8031cd2

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.2"
+services:
+  - redis-server
+before_install:
+  - gem install bundler

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
+gem 'classifier-reborn'
+

data/README.md

@@ -1,19 +1,22 @@
 # Coverband
 
+[![Build Status](https://travis-ci.org/danmayer/coverband.svg?branch=master)](https://travis-ci.org/danmayer/coverband)
+
 A gem to measure production code coverage. Coverband allows easy configuration to collect and report on production code coverage. It can be used as Rack middleware, wrapping a block with sampling, or manually configured to meet any need (like coverage on background jobs).
 
 * Allow sampling to avoid the performance overhead on every request.
 * Ignore directories to avoid overhead data collection on vendor, lib, etc.
 * Take a baseline to get initial app loading coverage.
 
-At the moment, Coverband relies on Ruby's `set_trace_func` hook. I attempted to use the standard lib's `Coverage` support but it proved buggy when sampling or stopping and starting collection. When [Coverage is patched](https://bugs.ruby-lang.org/issues/9572) in future Ruby versions it would likely be better. Using `set_trace_func` has some limitations where it doesn't collect covered lines, but I have been impressed with the coverage it shows for both Sinatra and Rails applications.
+coverband 1.1+ supports ruby 2.0+.  For ruby 1.9 use coverband 1.0.X.
+
 
 ###### Success:
-After running in production for 30 minutes, we were able very easily delete 2000 LOC after looking through the data. We expect to be able to clean up much more after it has collected more data. 
+After running in production for 30 minutes, we were able very easily delete 2000 LOC after looking through the data. We expect to be able to clean up much more after it has collected more data.
 
 ###### Performance Impact
 
-At the moment the performance impact of standard Ruby runtime coverage can be pretty large. Once getting things working. I highly recommend adding [coverband_ext](https://github.com/danmayer/coverband_ext) to the project which should shave the performance overhead down to something very reasonable. The two ways to deal with performance right now are lowering the sample rate and using the C extension. Often for smaller projects using the C extension makes 100% coverage possible. 
+Because coverband 2.0+ uses TracePoint which is much speedier than the ruby 1.9 set_trace_func, the performance impact is reasonable and there is no need for the c-ext [coverband_ext](https://github.com/danmayer/coverband_ext).  If you are stuck on ruby 1.9 and coverband 1.0.X, the [coverband_ext](https://github.com/danmayer/coverband_ext) is a must.
 
 ## Installation
 
@@ -37,7 +40,7 @@ $ gem install coverband
 
 ## Example Output
 
-Since Coverband is [Simplecov](https://github.com/colszowka/simplecov) output compatible it should work with any of the `SimpleCov::Formatter`'s available. The output below is produced using the default Simplecov HTML formatter. 
+Since Coverband is [Simplecov](https://github.com/colszowka/simplecov) output compatible it should work with any of the `SimpleCov::Formatter`'s available. The output below is produced using the default Simplecov HTML formatter.
 
 Index Page
 ![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_index.png)
@@ -55,22 +58,9 @@ Details on a example Sinatra app
     * Using Redis 2.x gem, while supported, is slow and not recommended. It will have a larger impact on overhead performance. Although the Ruby collection dwarfs the redis time, so it likely doesn't matter much.
     * Make sure to ignore any folders like `vendor` and possibly `lib` as it can help reduce performance overhead. Or ignore specific frequently hit in app files for better perf.
 
-## Usage
-
-After installing the gem. There are a few steps to gather data, view reports, and for cleaning up the data.
-
-See an [example Sinatra app](https://github.com/danmayer/churn-site) and example [non rack ruby app](https://github.com/danmayer/coverband_examples) configured with coverband.
-
-1. First configure cover band options using the config file, See the section below
-2. Then configure Rake, with helpful tasks. Make sure things are working by recording your Coverband baseline. See the section below
-3. Setup the rack middleware, the middleware is what makes Coverband gather metrics when your app runs. See below for details
-	* I setup Coverband in my rackup `config.ru` you can also set it up in rails middleware, but it may miss recording some code coverage early in the rails process. It does improve performance to have it later in the middleware stack. So there is a tradeoff there.
-	* To debug in development mode, I recommend turning verbose logging on `config.verbose           = true` and passing in the Rails.logger `config.logger = Rails.logger` to the Coverband config. This makes it easy to follow in development mode. Be careful to not leave these on in production as they will effect performance.
-4. Start your server with `rackup config.ru` If you use `rails s` make sure it is using your `config.ru` or Coverband won't be recording any data. 
-5. Hit your development server exercising the endpoints you want to verify Coverband is recording.
-6. Now to view changes in live coverage run `rake coverband:coverage` again, previously it should have only shown the baseline data of your app initializing. After using it in development it should show increased coverage from the actions you have exercised.
+## Configuration
 
-#### Configure Coverband Options
+### 1. Create Coverband config file
 
 You need to configure cover band you can either do that passing in all configuration options to `Coverband.configure` in block format, or a simpler style is to call `Coverband.configure` with nothing while will load `config/coverband.rb` expecting it to configure the app correctly. Below is an example config file for a Sinatra app:
 
@@ -88,15 +78,15 @@ Coverband.configure do |config|
   config.coverage_baseline = baseline
   config.root_paths        = ['/app/'] # /app/ is needed for heroku deployments
   # regex paths can help if you are seeing files duplicated for each capistrano deployment release
-  #config.root_paths       = ['/server/apps/my_app/releases/\d+/'] 
+  #config.root_paths       = ['/server/apps/my_app/releases/\d+/']
   config.ignore            = ['vendor','lib/scrazy_i18n_patch_thats_hit_all_the_time.rb']
   # Since rails and other frameworks lazy load code. I have found it is bad to allow
   # initial requests to record with coverband. This ignores first 15 requests
   config.startup_delay     = Rails.env.production? ? 15 : 2
   config.percentage        = Rails.env.production? ? 30.0 : 100.0
-  
+
   config.logger            = Rails.logger
-  
+
   #stats help you collect how often you are sampling requests and other info
   if defined? Statsd
     config.stats           = Statsd.new('statsd.host.com', 8125)
@@ -109,7 +99,7 @@ Coverband.configure do |config|
 end
 ```
 
-#### Configuring Rake
+### 2. Configuring Rake
 
 Either add the below to your `Rakefile` or to a file included in your Rakefile such as `lib/tasks/coverband` if you want to break it up that way.
 
@@ -143,22 +133,72 @@ end
 
 To verify that rake is working run `rake coverband:baseline`
 then run `rake coverband:coverage` to view what your baseline coverage looks like before any runtime traffic has been recorded.
-    
-#### Configure rack middleware
+
+### 3. Configure Rack to use the Coverband middleware
+
+The middleware is what makes Coverband gather metrics when your app runs.
+I setup Coverband in my rackup `config.ru` you can also set it up in rails middleware, but it may miss recording some code coverage early in the rails process. It does improve performance to have it later in the middleware stack. So there is a tradeoff there.
+
+#### For Sinatra apps
 
 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.
 
 ```ruby
 require File.dirname(__FILE__) + '/config/environment'
-	
+
 require 'coverband'
 Coverband.configure
 
 use Coverband::Middleware
 run ActionController::Dispatcher.new
 ```
-	
-#### Configure Manually (for example for background jobs)
+
+#### For Rails apps
+
+Create an initializer file
+
+```ruby
+# config/initializes/coverband_middleware.rb
+
+# Configure the Coverband Middleware
+require 'coverband'
+Coverband.configure
+```
+
+Then add the middleware to your Rails rake middle ware stack:
+
+```ruby
+# config/application.rb
+[...]
+
+module MyApplication
+  class Application < Rails::Application
+    [...]
+
+    # Coverband use Middleware
+    config.middleware.use Coverband::Middleware
+
+  end
+end
+```
+
+Note: To debug in development mode, I recommend turning verbose logging on `config.verbose = true` and passing in the Rails.logger `config.logger = Rails.logger` to the Coverband config. This makes it easy to follow in development mode. Be careful to not leave these on in production as they will effect performance.
+
+## Usage
+
+1. Start your server with `rails s` or `rackup config.ru`.
+2. Hit your development server exercising the endpoints you want to verify Coverband is recording (you should see debug outputs in your server console)
+3. Run `rake coverband:coverage` again, previously it should have only shown the baseline data of your app initializing. After using it in development it should show increased coverage from the actions you have exercised.
+
+Note: if you use `rails s` and data aren't reccorded, make sure it is using your `config.ru`.
+
+## Example apps
+
+- [Rails app](https://github.com/arnlen/rails-coverband-example-app)
+- [Sinatra app](https://github.com/danmayer/churn-site)
+- [Non rack ruby app](https://github.com/danmayer/coverband_examples)
+
+### Manual configuration (for example for background jobs)
 
 It is easy to use Coverband outside of a Rack environment. Make sure you configure Coverband in whatever environment you are using (such as `config/initializers/*.rb`). Then you can hook into before and after events to add coverage around background jobs, or for any non Rack code.
 
@@ -176,7 +216,7 @@ def before_perform(*args)
     @recording_samples = false
   end
 end
-      
+
 def after_perform(*args)
   if @recording_samples
     Coverband::Base.instance.stop
@@ -191,25 +231,25 @@ In general you can run Coverband anywhere by using the lines below. This can be
 ```ruby
 require "coverband"
 Coverband.configure
-  
+
 coverband = Coverband::Base.instance
-    
+
 #manual
 coverband.start
 coverband.stop
 coverband.save
-    
+
 #sampling
 coverband.sample {
   #code to sample coverband
 }
 ```
- 
-#### Clearing Line Coverage Data
 
-After a deploy where code has changed. 
-The line numbers previously recorded in Redis may no longer match the current state of the files. 
-If being slightly out of sync isn't as important as gathering data over a long period, 
+### Clearing Line Coverage Data
+
+After a deploy where code has changed.
+The line numbers previously recorded in Redis may no longer match the current state of the files.
+If being slightly out of sync isn't as important as gathering data over a long period,
 you can live with minor inconsistency 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.
@@ -225,10 +265,10 @@ You can also do this with the included rake tasks.
 
 ### Verbose debug mode for development
 
-If you are trying to debug locally wondering what code is being run during a request. The verbose modes `config.verbose = true` and `config.verbose = 'debug'` can be useful. With true set it will output the number of lines executed per file, to the passed in log. The files are sorted from least used file to most active file. I have even run that mode in production without much of a problem. The debug verbose mode outputs both file usage and provides the number of calls per line of code. For example if you see something like below which indicates that the `application_helper` has 43150 lines executed. That might seem odd. Then looking at the breakdown of `application_helper` we can see that line `516` was executed 38,577 times. That seems bad, and is likely worth investigating perhaps memoizing or cacheing is required. 
+If you are trying to debug locally wondering what code is being run during a request. The verbose modes `config.verbose = true` and `config.verbose = 'debug'` can be useful. With true set it will output the number of lines executed per file, to the passed in log. The files are sorted from least used file to most active file. I have even run that mode in production without much of a problem. The debug verbose mode outputs both file usage and provides the number of calls per line of code. For example if you see something like below which indicates that the `application_helper` has 43150 lines executed. That might seem odd. Then looking at the breakdown of `application_helper` we can see that line `516` was executed 38,577 times. That seems bad, and is likely worth investigating perhaps memoizing or cacheing is required.
 
     config.verbose = 'debug'
-    
+
     coverband file usage:
       [["/Users/danmayer/projects/app_name/lib/facebook.rb", 6],
       ["/Users/danmayer/projects/app_name/app/models/some_modules.rb", 9],
@@ -236,35 +276,34 @@ If you are trying to debug locally wondering what code is being run during a req
       ["/Users/danmayer/projects/app_name/app/models/user.rb", 2606],
       ["/Users/danmayer/projects/app_name/app/helpers/application_helper.rb",
       43150]]
-    
+
     file:
       /Users/danmayer/projects/app_name/app/helpers/application_helper.rb =>
       [[448, 1], [202, 1],
       ...
      [517, 1617], [516, 38577]]
-     
-### Merge coverage data over time     
+
+### Merge coverage data over time
 
 If you are clearing data on every deploy. You might want to write the data out to a file first. Then you could merge the data into the final results later.
 
 ```ruby
 data = JSON.generate Coverband::Reporter.get_current_scov_data
-File.write("blah.json", data)  
+File.write("blah.json", data)
 # Then later on, pass it in to the html reporter:
 data = JSON.parse(File.read("blah.json"))
-Coverband::Reporter.report :additional_scov_data => [data]   
+Coverband::Reporter.report :additional_scov_data => [data]
 ```
 
-#### Known issues
+### Known issues
 
-* `set_trace_func` isn't perfect in sending each line of code executed and can be a bit wonky in a few places. Such as missing the `end` lines in code blocks. If you notice examples of this send them to me.
 * If you don't have a baseline recorded your coverage can look odd like you are missing a bunch of data. It would be good if coverband gave a more actionable warning in this situation.
 * If you have simplecov filters, you need to clear them prior to generating your coverage report. As the filters will be applied to coverband as well and can often filter out everything we are recording.
 * the line numbers reported for `ERB` files are often off and aren't considered useful. I recommend filtering out .erb using the `config.ignore` option.
 
-### TODO
+## TODO
 
-* Fix network performance by logging to files that purge later (like NR) (far more time lost in set_trace_func than sending files, hence not a high priority, but would be cool)
+* Fix network performance by logging to files that purge later (like NR) (far more time lost in TracePoint than sending files, hence not a high priority, but would be cool)
 * Add support for [zadd](http://redis.io/topics/data-types-intro) so one could determine single call versus multiple calls on a line, letting us determine the most executed code in production.
 * Possibly add ability to record code run for a given route
 * Improve client code api, around manual usage of sampling (like event usage)

data/Rakefile

@@ -1,5 +1,7 @@
 require "bundler/gem_tasks"
 
+import 'test/benchmarks/benchmark.rake'
+
 task :default => :test
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|

data/coverband.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "mocha", "~> 0.14.0"
   spec.add_development_dependency "rack"
+  spec.add_development_dependency "test-unit"
   spec.add_runtime_dependency "simplecov"
   spec.add_runtime_dependency "json"
   spec.add_runtime_dependency "redis"

data/lib/coverband/base.rb

@@ -2,25 +2,28 @@ require 'singleton'
 
 module Coverband
   class Base
-    include Singleton
+
+    def self.instance
+      Thread.current[:coverband_instance] ||= Coverband::Base.new
+    end
 
     def start
       @enabled = true
       record_coverage
     end
-    
+
     def stop
       @enabled = false
       unset_tracer
     end
-    
+
     def sample
       configure_sampling
       record_coverage
       yield
       report_coverage
     end
-    
+
     def save
       @enabled = true
       report_coverage
@@ -39,12 +42,15 @@ module Coverband
       @file_usage = Hash.new(0)
       @file_line_usage = {}
       @startup_delay = Coverband.configuration.startup_delay
-      @ignore_patterns = Coverband.configuration.ignore
+      @ignore_patterns = Coverband.configuration.ignore + ["internal:prelude"]
+      @ignore_patterns += ['gems'] unless Coverband.configuration.include_gems
       @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
+      @current_thread = Thread.current
+      @trace = create_trace_point
       self
     end
 
@@ -79,7 +85,10 @@ module Coverband
 
       unset_tracer
 
+      @files.reject!{|file, lines| !track_file?(file) }
+
       if @verbose
+        @file_usage.reject!{|file, line_count| !track_file?(file) }
         @logger.info "coverband file usage: #{@file_usage.sort_by {|_key, value| value}.inspect}"
         if @verbose=="debug"
           output_file_line_usage
@@ -87,15 +96,19 @@ module Coverband
       end
 
       if @reporter
-        if @reporter.class.name.match(/redis/i)
-          before_time = Time.now
-          @stats.count "coverband.files.recorded_files", @files.length if @stats
-          @reporter.store_report(@files.dup)
-          time_spent = Time.now - before_time
-          @stats.timing "coverband.files.recorded_time", time_spent if @stats
-          @files = {}
-          @file_usage = Hash.new(0)
-          @file_line_usage = {}
+        if @stats
+          @before_time = Time.now
+          @stats.count "coverband.files.recorded_files", @files.length
+        end
+        @reporter.store_report(@files)
+        if @stats
+          @time_spent = Time.now - @before_time
+          @stats.timing "coverband.files.recorded_time", @time_spent
+        end
+        @files.clear
+        if @verbose
+          @file_usage.clear
+          @file_line_usage.clear
         end
       elsif @verbose
         @logger.info "coverage report: "
@@ -110,49 +123,21 @@ module Coverband
 
     protected
 
+    def track_file? file
+      !@ignore_patterns.any?{ |pattern| file.include?(pattern) } && file.start_with?(@project_directory)
+    end
+
+
     def set_tracer
       unless @tracer_set
-        set_trace_func proc { |event, file, line, id, binding, classname|
-          add_file(file, line)
-        }
+        @trace.enable
         @tracer_set = true
       end
     end
 
     def unset_tracer
-      if @tracer_set
-        set_trace_func(nil)
-        @tracer_set = false
-      end
-    end
-
-    def add_file(file, line)
-      if !file.match(/(\/gems\/|internal\:prelude)/) && file.match(@project_directory) && !@ignore_patterns.any?{|pattern| file.match(/#{pattern}/) } 
-        add_file_without_checks(file, line)
-      end
-    end
-
-    # file from ruby coverband at this method call is a full path
-    # file from native coverband is also a full path
-    #
-    # at the moment the full paths don't merge so the 'last' one wins and each deploy
-    # with a normal capistrano setup resets coverage.
-    #
-    # should we make it relative in this method (slows down collection)
-    # -- OR --
-    # we could have the reporter MERGE the results after normalizing the filenames
-    # (went with this route see report_scov previous_line_hash)
-    def add_file_without_checks(file, line)
-      if @verbose
-        @file_usage[file] += 1
-        @file_line_usage[file] = Hash.new(0) unless @file_line_usage.include?(file)
-        @file_line_usage[file][line] += 1
-      end
-      if @files.include?(file)
-        @files[file] << line unless @files.include?(line)
-      else
-        @files[file] = [line]
-      end
+      @trace.disable
+      @tracer_set = false
     end
 
     def output_file_line_usage
@@ -166,6 +151,22 @@ module Coverband
 
     private
 
+    def create_trace_point
+      TracePoint.new(*Coverband.configuration.trace_point_events) do |tp|
+        if Thread.current == @current_thread
+          file = tp.path
+          line = tp.lineno
+          if @verbose
+            @file_usage[file] += 1
+            @file_line_usage[file] = Hash.new(0) unless @file_line_usage.include?(file)
+            @file_line_usage[file][line] += 1
+          end
+          file_lines = (@files[file] ||= [])
+          file_lines << line
+        end
+      end
+    end
+
     def initialize
       reset_instance
     end

data/lib/coverband/configuration.rb

@@ -1,7 +1,7 @@
 module Coverband
   class Configuration
-    attr_accessor :redis, :coverage_baseline, :root_paths, :root, :ignore, :percentage, :verbose, :reporter, :stats, :logger, :startup_delay, :baseline_file
-    
+    attr_accessor :redis, :coverage_baseline, :root_paths, :root, :ignore, :percentage, :verbose, :reporter, :stats, :logger, :startup_delay, :baseline_file, :trace_point_events, :include_gems
+
     def initialize
       @root = Dir.pwd
       @redis = nil
@@ -10,11 +10,13 @@ module Coverband
       @baseline_file = './tmp/coverband_baseline.json'
       @root_paths = []
       @ignore = []
+      @include_gems = false
       @percentage = 0.0
       @verbose = false
       @reporter = 'scov'
       @logger = Logger.new(STDOUT)
       @startup_delay = 0
+      @trace_point_events = [:line]
     end
 
     def logger

data/lib/coverband/middleware.rb

@@ -1,6 +1,6 @@
 module Coverband
   class Middleware
-    
+
     def initialize(app)
       @app = app
     end
@@ -8,10 +8,10 @@ module Coverband
     def call(env)
       Coverband::Base.instance.configure_sampling
       Coverband::Base.instance.record_coverage
-      results = @app.call(env)
+      @app.call(env)
+    ensure
       Coverband::Base.instance.report_coverage
-      results
     end
-    
+
   end
 end

data/lib/coverband/version.rb

@@ -1,3 +1,3 @@
 module Coverband
-  VERSION = "1.0.3"
+  VERSION = "1.1"
 end

data/test/benchmarks/.gitignore

@@ -0,0 +1 @@
+classifier-reborn

data/test/benchmarks/benchmark.rake

@@ -0,0 +1,89 @@
+require 'coverband'
+require 'redis'
+
+namespace :benchmarks do
+
+  def classifier_dir
+    classifier_dir = File.join(File.dirname(__FILE__), 'classifier-reborn')
+  end
+
+  def clone_classifier
+    unless Dir.exist? classifier_dir
+      system "git clone git@github.com:jekyll/classifier-reborn.git #{classifier_dir}"
+    end
+  end
+
+  desc 'set up coverband'
+  task :setup do
+    clone_classifier
+    $LOAD_PATH.unshift(File.join(classifier_dir, 'lib'))
+    require 'benchmark'
+    require 'classifier-reborn'
+
+    Coverband.configure do |config|
+      config.redis             = Redis.new
+      config.root              = Dir.pwd
+      config.startup_delay     = 0
+      config.percentage        = 100.0
+      config.logger            = $stdout
+      config.verbose           = false
+    end
+
+  end
+
+
+  def bayes_classification
+    b = ClassifierReborn::Bayes.new 'Interesting', 'Uninteresting'
+    b.train_interesting "here are some good words. I hope you love them"
+    b.train_uninteresting "here are some bad words, I hate you"
+    b.classify "I hate bad words and you" # returns 'Uninteresting'
+  end
+
+  def lsi_classification
+    lsi = ClassifierReborn::LSI.new
+    strings = [ ["This text deals with dogs. Dogs.", :dog],
+                ["This text involves dogs too. Dogs! ", :dog],
+                ["This text revolves around cats. Cats.", :cat],
+                ["This text also involves cats. Cats!", :cat],
+                ["This text involves birds. Birds.",:bird ]]
+    strings.each {|x| lsi.add_item x.first, x.last}
+    lsi.search("dog", 3)
+    lsi.find_related(strings[2], 2)
+    lsi.classify "This text is also about dogs!"
+  end
+
+  def work
+    5.times do
+      bayes_classification
+      lsi_classification
+    end
+  end
+
+
+
+  desc 'runs benchmarks'
+  task :run => :setup do
+    SAMPLINGS = 3
+    bm = Benchmark.bm(15) do |x|
+
+      x.report 'coverband' do
+        SAMPLINGS.times do
+          Coverband::Base.instance.sample do
+            work
+          end
+        end
+      end
+
+      x.report "no coverband" do
+        SAMPLINGS.times do
+          work
+        end
+      end
+
+    end
+  end
+
+end
+
+desc "runs benchmarks"
+task benchmarks: [ "benchmarks:run" ]

data/test/unit/base_test.rb

@@ -1,4 +1,5 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
+require File.expand_path('./dog', File.dirname(__FILE__))
 
 class BaseTest < Test::Unit::TestCase
 
@@ -14,7 +15,7 @@ class BaseTest < Test::Unit::TestCase
     coverband = Coverband::Base.instance.reset_instance
     assert_equal false, coverband.extended?
   end
-  
+
   test "stop should disable coverage" do
     coverband = Coverband::Base.instance.reset_instance
     assert_equal false, coverband.instance_variable_get("@enabled")
@@ -25,7 +26,7 @@ class BaseTest < Test::Unit::TestCase
     assert_equal false, coverband.instance_variable_get("@enabled")
     assert_equal false, coverband.instance_variable_get("@tracer_set")
   end
-  
+
   test "allow for sampling with a block and enable when 100 percent sample" do
     logger = Logger.new(STDOUT)
     coverband = Coverband::Base.instance.reset_instance
@@ -38,7 +39,7 @@ class BaseTest < Test::Unit::TestCase
     coverband.sample { 1 + 1 }
     assert_equal true, coverband.instance_variable_get("@enabled")
   end
-  
+
   test "allow reporting with start stop save" do
     logger = Logger.new(STDOUT)
     coverband = Coverband::Base.instance.reset_instance
@@ -53,19 +54,18 @@ class BaseTest < Test::Unit::TestCase
     coverband.stop
     coverband.save
   end
-  
+
   test "allow reporting to redis start stop save" do
+    dog_file = File.expand_path('./dog.rb', File.dirname(__FILE__))
     coverband = Coverband::Base.instance.reset_instance
     coverband.instance_variable_set("@sample_percentage", 100.0)
     coverband.instance_variable_set("@verbose", true)
     store = Coverband::RedisStore.new(Redis.new)
     coverband.instance_variable_set("@reporter", store)
-    store.expects(:store_report).once.with { |files|
-      files.keys.include?("#{File.expand_path('../../../', __FILE__)}/lib/coverband/base.rb")
-    }
+    store.expects(:store_report).once.with(has_entries(dog_file => [3]) )
     assert_equal false, coverband.instance_variable_get("@enabled")
     coverband.start
-    1 + 1
+    Dog.new.bark
     coverband.stop
     coverband.save
   end

data/test/unit/configuration_test.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class BaseTest < Test::Unit::TestCase
+
+  test "defaults to line trace point event" do
+    assert_equal Coverband.configuration.trace_point_events, [:line]
+  end
+
+  test "defaults to ignore gems" do
+    assert_equal Coverband.configuration.include_gems, false
+    coverband = Coverband::Base.instance.reset_instance
+    assert_equal ['vendor', 'internal:prelude', 'gems'], coverband.instance_variable_get("@ignore_patterns")
+  end
+
+  test "doesn't ignore gems if include_gems = true" do
+    Coverband.configuration.include_gems = true
+    coverband = Coverband::Base.instance.reset_instance
+    assert_equal ['vendor', 'internal:prelude'], coverband.instance_variable_get("@ignore_patterns")
+  end
+
+end

data/test/unit/dog.rb

@@ -0,0 +1,5 @@
+class Dog
+  def bark
+    "woof"
+  end
+end

data/test/unit/middleware_test.rb

@@ -1,8 +1,8 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
+require File.expand_path('../fake_app/basic_rack', File.dirname(__FILE__))
 require 'rack'
 
 class MiddlewareTest < Test::Unit::TestCase
-  
   test "call app" do
     request = Rack::MockRequest.env_for("/anything.json")
     Coverband::Base.instance.reset_instance
@@ -64,37 +64,69 @@ class MiddlewareTest < Test::Unit::TestCase
     middleware = Coverband::Middleware.new(fake_app)
     assert_equal false, Coverband::Base.instance.instance_variable_get("@enabled")
     Coverband::Base.instance.instance_variable_set("@sample_percentage", 100.0)
-    Coverband::Base.instance.expects(:add_file).at_least_once
     results = middleware.call(request)
     assert_equal true, Coverband::Base.instance.instance_variable_get("@enabled")
   end
 
+  test 'reports coverage when an error is raised' do
+    request = Rack::MockRequest.env_for("/anything.json")
+    Coverband::Base.instance.reset_instance
+    Coverband::Base.instance.expects(:report_coverage).once
+    middleware = Coverband::Middleware.new(fake_app_raise_error)
+    middleware.call(request) rescue nil
+  end
+
+
   test 'always report coverage when sampling' do
     request = Rack::MockRequest.env_for("/anything.json")
     Coverband::Base.instance.reset_instance
+    middleware = Coverband::Middleware.new(fake_app_with_lines)
+    assert_equal false, Coverband::Base.instance.instance_variable_get("@enabled")
+    Coverband::Base.instance.instance_variable_set("@sample_percentage", 100.0)
+    fake_redis = Redis.new
+    Coverband::Base.instance.instance_variable_set("@reporter", Coverband::RedisStore.new(fake_redis))
+    fake_redis.stubs(:info).returns({'redis_version' => 3.0})
+    fake_redis.expects(:sadd).at_least_once
+    fake_redis.expects(:sadd).at_least_once.with("coverband.#{basic_rack_ruby_file}", [5])
+    results = middleware.call(request)
+    assert_equal true, Coverband::Base.instance.instance_variable_get("@enabled")
+  end
 
-    file_with_path = File.expand_path('../../lib/coverband/middleware.rb', File.dirname(__FILE__))
 
-    middleware = Coverband::Middleware.new(fake_app)
+  test 'report only on calls when configured' do
+    request = Rack::MockRequest.env_for("/anything.json")
+    Coverband.configuration.trace_point_events = [:call]
+    Coverband::Base.instance.reset_instance
+    middleware = Coverband::Middleware.new(fake_app_with_lines)
     assert_equal false, Coverband::Base.instance.instance_variable_get("@enabled")
     Coverband::Base.instance.instance_variable_set("@sample_percentage", 100.0)
     fake_redis = Redis.new
     Coverband::Base.instance.instance_variable_set("@reporter", Coverband::RedisStore.new(fake_redis))
     fake_redis.stubs(:info).returns({'redis_version' => 3.0})
     fake_redis.expects(:sadd).at_least_once
-    fake_redis.expects(:sadd).at_least_once.with("coverband.#{file_with_path}", [11, 11, 11, 12])
+    fake_redis.expects(:sadd).at_least_once.with("coverband.#{basic_rack_ruby_file}", [4])
     results = middleware.call(request)
     assert_equal true, Coverband::Base.instance.instance_variable_get("@enabled")
   end
 
+
+
   private
 
   def fake_app
     @app ||= lambda { |env| [200, {'Content-Type' => 'text/plain'}, env['PATH_INFO']] }
   end
 
+  def fake_app_raise_error
+    @fake_app_raise_error ||= lambda { raise "sh** happens" }
+  end
+
   def fake_app_with_lines
     @lines_app ||= ::HelloWorld.new
   end
 
+  def basic_rack_ruby_file
+    File.expand_path('../fake_app/basic_rack.rb', File.dirname(__FILE__))
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: '1.1'
 platform: ruby
 authors:
 - Dan Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-08 00:00:00.000000000 Z
+date: 2016-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -132,9 +147,13 @@ files:
 - lib/coverband/reporter.rb
 - lib/coverband/tasks.rb
 - lib/coverband/version.rb
+- test/benchmarks/.gitignore
+- test/benchmarks/benchmark.rake
 - test/fake_app/basic_rack.rb
 - test/test_helper.rb
 - test/unit/base_test.rb
+- test/unit/configuration_test.rb
+- test/unit/dog.rb
 - test/unit/middleware_test.rb
 - test/unit/redis_store_test.rb
 - test/unit/reporter_test.rb
@@ -158,14 +177,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Rack middleware to help measure production code coverage
 test_files:
+- test/benchmarks/.gitignore
+- test/benchmarks/benchmark.rake
 - test/fake_app/basic_rack.rb
 - test/test_helper.rb
 - test/unit/base_test.rb
+- test/unit/configuration_test.rb
+- test/unit/dog.rb
 - test/unit/middleware_test.rb
 - test/unit/redis_store_test.rb
 - test/unit/reporter_test.rb