coverband 0.0.26 → 0.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9024d421423749a38d48b51ffb2e649e4ef7b12
-  data.tar.gz: f2d9072445beb98a2399e82b282b321edbad21c1
+  metadata.gz: 9ab2f18c3f5f5663bb29a2335e7cd1cdac55f27d
+  data.tar.gz: 74eb1c7207c254af8c269906d40d8b069a83c8cd
 SHA512:
-  metadata.gz: bc67df5a997a1a11baed1f28641e19dfd72d7430fd64f64acb79d2ad67baa3e09a29a9112f5049b4221ccc2a7c805777a9af7bed85744e9a8d82d9f86517562c
-  data.tar.gz: ef6211e1506103bf8f7cce7efbad5580f9a58eeeb8c355bfc4a6f32e3f27b46dc9069a17fdb5ab51c1e877d3bc14af1845165fcc6ec8f11f46f061e91a8c285c
+  metadata.gz: 13f92b3215f32799e915997294e39b80773d08b6b31a2ec9ad31fee19e2bee9e29f9ef3ebbb8f06ae0da3ae1ecdecd04dc543cac41ce01e1a85d20f5270b980d
+  data.tar.gz: 59bb9f499b735e26e21c0d340f7d5cb2a3965446491001ea7a359fb0742d06fecec6cd0cb186f4b8a0e1300c09c12cf45a86a4556e031aee5b5789228772a559

data/README.md

@@ -6,7 +6,7 @@ A gem to measure production code coverage. Coverband allows easy configuration t
 * 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 stoping and starting collection. When [Coverage is patched](https://www.ruby-forum.com/topic/1811306) 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.
+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 stoping 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.
 
 ###### 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. 
@@ -256,13 +256,19 @@ If you are trying to debug locally wondering what code is being run during a req
 
 ## Resources
 
+##### Ruby Std-lib Coverage
+
+* [Fixed bug causing segfaults on 1.9.X](https://www.ruby-forum.com/topic/1811306)
+* [Current Coverage Bug causing issues on 2.1.1](https://bugs.ruby-lang.org/issues/9572)
+* [Ruby Coverage docs](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/coverage/rdoc/Coverage.html)
+
+##### other
+
 * [erb code coverage](http://stackoverflow.com/questions/13030909/how-to-test-code-coverage-for-rails-erb-templates)
 * [more erb code coverage](https://github.com/colszowka/simplecov/issues/38)
 * [erb syntax](http://stackoverflow.com/questions/7996695/rails-erb-syntax) parse out and mark lines as important
 * [ruby 2 tracer](https://github.com/brightbox/deb-ruby2.0/blob/master/lib/tracer.rb)
 * [coveralls hosted code coverage tracking](https://coveralls.io/docs/ruby) currently for test coverage but might be a good partner for production coverage
-* [bug in Ruby's stl-lib Coverage, needs to be fixed to be more accurate](https://www.ruby-forum.com/topic/1811306)
-* [Ruby Coverage docs](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/coverage/rdoc/Coverage.html)
 * [simplecov walk through](http://www.tamingthemindmonkey.com/2011/09/27/ruby-code-coverage-using-simplecov) copy some of the syntax sugar setup for cover band
 * [Jruby coverage bug](http://jira.codehaus.org/browse/JRUBY-6106?page=com.atlassian.jira.plugin.system.issuetabpanels:changehistory-tabpanel)
 * [learn from oboe ruby code](https://github.com/appneta/oboe-ruby#writing-custom-instrumentation)

data/lib/coverband/base.rb

@@ -1,21 +1,6 @@
 module Coverband
   class Base
-
-    def initialize(options = {})
-      @project_directory = File.expand_path(Coverband.configuration.root)
-      @enabled = false
-      @tracer_set = false
-      @files = {}
-      @file_usage = Hash.new(0)
-      @file_line_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
+    include Singleton
 
     def start
       @enabled = true
@@ -40,7 +25,26 @@ module Coverband
       @enabled = false
     end
 
-    protected
+    def extended?
+      false
+    end
+
+    def reset_instance
+      @project_directory = File.expand_path(Coverband.configuration.root)
+      @enabled = false
+      @tracer_set = false
+      @files = {}
+      @file_usage = Hash.new(0)
+      @file_line_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)
+      self
+    end
 
     def configure_sampling
       if @startup_delay!=0 || (rand * 100.0) > @sample_percentage
@@ -65,46 +69,6 @@ module Coverband
       end
     end
 
-    def set_tracer
-      unless @tracer_set
-        set_trace_func proc { |event, file, line, id, binding, classname|
-          add_file(file, line)
-        }
-        @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}/) } 
-        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
-      end
-    end
-
-    def output_file_line_usage
-      @logger.info "coverband debug coverband file:line usage:"
-      @file_line_usage.sort_by {|_key, value| value.length}.each do |pair|
-                                                             file = pair.first
-                                                             lines = pair.last
-                                                             @logger.info "file: #{file} => #{lines.sort_by {|_key, value| value}}"
-                                                           end
-    end
-    
     def report_coverage
       unless @enabled
         @logger.info "coverage disabled" if @verbose
@@ -141,5 +105,62 @@ module Coverband
         @logger.info "error: #{err.inspect} #{err.message}"
       end
     end
+
+    protected
+
+    def set_tracer
+      unless @tracer_set
+        set_trace_func proc { |event, file, line, id, binding, classname|
+          add_file(file, line)
+        }
+        @tracer_set = true
+      end
+    end
+
+    def unset_tracer
+      if @tracer_set
+        set_trace_func(nil)
+        @tracer_set = false
+      end
+    end
+
+    def add_from_tracepoint(trace_point)
+      add_file(trace_point.path, trace_point.lineno)
+    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
+
+    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
+    end
+
+    def output_file_line_usage
+      @logger.info "coverband debug coverband file:line usage:"
+      @file_line_usage.sort_by {|_key, value| value.length}.each do |pair|
+                                                             file = pair.first
+                                                             lines = pair.last
+                                                             @logger.info "file: #{file} => #{lines.sort_by {|_key, value| value}}"
+                                                           end
+    end
+
+    private
+
+    def initialize
+      reset_instance
+    end
+
   end
 end

data/lib/coverband/middleware.rb

@@ -1,16 +1,15 @@
 module Coverband
-  class Middleware < Base
-
+  class Middleware
+    
     def initialize(app)
       @app = app
-      super
     end
 
     def call(env)
-      configure_sampling
-      record_coverage
+      Coverband::Base.instance.configure_sampling
+      Coverband::Base.instance.record_coverage
       results = @app.call(env)
-      report_coverage
+      Coverband::Base.instance.report_coverage
       results
     end
     

data/lib/coverband/version.rb

@@ -1,3 +1,3 @@
 module Coverband
-  VERSION = "0.0.26"
+  VERSION = "0.1.0.pre"
 end

data/test/unit/base_test.rb

@@ -3,7 +3,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
+    coverband = Coverband::Base.instance.reset_instance
     assert_equal false, coverband.instance_variable_get("@enabled")
     coverband.expects(:record_coverage).once
     coverband.start
@@ -11,7 +11,7 @@ class BaseTest < Test::Unit::TestCase
   end
   
   should "stop should disable coverage" do
-    coverband = Coverband::Base.new
+    coverband = Coverband::Base.instance.reset_instance
     assert_equal false, coverband.instance_variable_get("@enabled")
     coverband.expects(:record_coverage).once
     coverband.start
@@ -23,7 +23,7 @@ class BaseTest < Test::Unit::TestCase
   
   should "allow for sampling with a block and enable when 100 percent sample" do
     logger = Logger.new(STDOUT)
-    coverband = Coverband::Base.new
+    coverband = Coverband::Base.instance.reset_instance
     coverband.instance_variable_set("@sample_percentage", 100.0)
     coverband.instance_variable_set("@verbose", true)
     coverband.instance_variable_set("@logger", logger)
@@ -36,7 +36,7 @@ class BaseTest < Test::Unit::TestCase
   
   should "allow reporting with start stop save" do
     logger = Logger.new(STDOUT)
-    coverband = Coverband::Base.new
+    coverband = Coverband::Base.instance.reset_instance
     coverband.instance_variable_set("@sample_percentage", 100.0)
     coverband.instance_variable_set("@verbose", true)
     coverband.instance_variable_set("@logger", logger)
@@ -50,7 +50,7 @@ class BaseTest < Test::Unit::TestCase
   end
   
   should "allow reporting to redis start stop save" do
-    coverband = Coverband::Base.new
+    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)

data/test/unit/middleware_test.rb

@@ -1,18 +1,18 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
 require 'rack'
-FAKE_RACK_APP_PATH = File.expand_path('../fake_app/basic_rack.rb', File.dirname(__FILE__))
-require FAKE_RACK_APP_PATH
 
 class MiddlewareTest < Test::Unit::TestCase
   
   should "call app" do
     request = Rack::MockRequest.env_for("/anything.json")
+    Coverband::Base.instance.reset_instance
     middleware = Coverband::Middleware.new(fake_app)
     results = middleware.call(request)
     assert_equal "/anything.json", results.last
   end
 
   should 'pass all rack lint checks' do
+    Coverband::Base.instance.reset_instance
     app = Rack::Lint.new(Coverband::Middleware.new(fake_app))
     env = Rack::MockRequest.env_for('/hello')
     app.call(env)
@@ -20,62 +20,71 @@ class MiddlewareTest < Test::Unit::TestCase
 
   should 'always be enabled with sample percentage of 100' do
     request = Rack::MockRequest.env_for("/anything.json")
+    Coverband::Base.instance.reset_instance
     middleware = Coverband::Middleware.new(fake_app)
-    assert_equal false, middleware.instance_variable_get("@enabled")
-    middleware.instance_variable_set("@sample_percentage", 100.0)
+    assert_equal false, Coverband::Base.instance.instance_variable_get("@enabled")
+    Coverband::Base.instance.instance_variable_set("@sample_percentage", 100.0)
     results = middleware.call(request)
-    assert_equal true, middleware.instance_variable_get("@enabled")
+    assert_equal true, Coverband::Base.instance.instance_variable_get("@enabled")
   end
 
   should 'never be enabled with sample percentage of 0' do
     request = Rack::MockRequest.env_for("/anything.json")
+    Coverband::Base.instance.reset_instance
     middleware = Coverband::Middleware.new(fake_app)
-    assert_equal false, middleware.instance_variable_get("@enabled")
-    middleware.instance_variable_set("@sample_percentage", 0.0)
+    assert_equal false, Coverband::Base.instance.instance_variable_get("@enabled")
+    Coverband::Base.instance.instance_variable_set("@sample_percentage", 0.0)
     results = middleware.call(request)
-    assert_equal false, middleware.instance_variable_get("@enabled")
+    assert_equal false, Coverband::Base.instance.instance_variable_get("@enabled")
   end
 
   should 'always unset function when sampling' do
     request = Rack::MockRequest.env_for("/anything.json")
+    Coverband::Base.instance.reset_instance
     middleware = Coverband::Middleware.new(fake_app)
-    assert_equal false, middleware.instance_variable_get("@tracer_set")
-    middleware.instance_variable_set("@sample_percentage", 100.0)
+    assert_equal false, Coverband::Base.instance.instance_variable_get("@tracer_set")
+    Coverband::Base.instance.instance_variable_set("@sample_percentage", 100.0)
     results = middleware.call(request)
-    assert_equal false, middleware.instance_variable_get("@tracer_set")
+    assert_equal false, Coverband::Base.instance.instance_variable_get("@tracer_set")
   end
 
   should 'always unset function when not sampling' do
     request = Rack::MockRequest.env_for("/anything.json")
+    Coverband::Base.instance.reset_instance
     middleware = Coverband::Middleware.new(fake_app)
-    assert_equal false, middleware.instance_variable_get("@tracer_set")
+    assert_equal false, Coverband::Base.instance.instance_variable_get("@tracer_set")
     middleware.instance_variable_set("@sample_percentage", 0.0)
     results = middleware.call(request)
-    assert_equal false, middleware.instance_variable_get("@tracer_set")
+    assert_equal false, Coverband::Base.instance.instance_variable_get("@tracer_set")
   end
 
   should 'always record coverage, set trace func, and add_files when sampling' do
     request = Rack::MockRequest.env_for("/anything.json")
-    middleware = Coverband::Middleware.new(fake_app_with_lines)
-    assert_equal false, middleware.instance_variable_get("@enabled")
-    middleware.instance_variable_set("@sample_percentage", 100.0)
-    middleware.expects(:add_file).at_least_once
+    Coverband::Base.instance.reset_instance
+    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, middleware.instance_variable_get("@enabled")
+    assert_equal true, Coverband::Base.instance.instance_variable_get("@enabled")
   end
 
   should 'always report coverage when sampling' do
     request = Rack::MockRequest.env_for("/anything.json")
-    middleware = Coverband::Middleware.new(fake_app_with_lines)
-    assert_equal false, middleware.instance_variable_get("@enabled")
-    middleware.instance_variable_set("@sample_percentage", 100.0)
+    Coverband::Base.instance.reset_instance
+
+    file_with_path = File.expand_path('../../lib/coverband/middleware.rb', File.dirname(__FILE__))
+
+    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)
     fake_redis = Redis.new
-    middleware.instance_variable_set("@reporter", Coverband::RedisStore.new(fake_redis))
+    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.#{FAKE_RACK_APP_PATH}", [4,5,6])
+    fake_redis.expects(:sadd).at_least_once.with("coverband.#{file_with_path}", [11, 11, 11, 12])
     results = middleware.call(request)
-    assert_equal true, middleware.instance_variable_get("@enabled")
+    assert_equal true, Coverband::Base.instance.instance_variable_get("@enabled")
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 0.0.26
+  version: 0.1.0.pre
 platform: ruby
 authors:
 - Dan Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,9 +167,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       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.2.2