coverband 0.0.14 → 0.0.15

data/README.md

@@ -65,11 +65,7 @@ Either add the below to your `Rakefile` or to a file included in your Rakefile
 
 	desc "report unused lines"
 	task :coverband => :environment do
-	  baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
-
-	  root_paths = ['/app/']
-	  coverband_options = {:existing_coverage => baseline, :roots => root_paths}
-	  Coverband::Reporter.report(Redis.new, coverband_options)
+	  Coverband::Reporter
 	end
 	
 	desc "get coverage baseline"

data/lib/coverband.rb

@@ -1,6 +1,7 @@
 require 'redis'
 
 require 'coverband/version'
+require 'coverband/redis_store'
 require 'coverband/base'
 require 'coverband/reporter'
 require 'coverband/middleware'
@@ -17,11 +18,12 @@ module Coverband
   end
 
   class Configuration
-    attr_accessor :redis, :coverage_baseline, :root_paths, :root, :ignore, :percentage, :verbose, :reporter
+    attr_accessor :redis, :coverage_baseline, :root_paths, :root, :ignore, :percentage, :verbose, :reporter, :stats
     
     def initialize
       @root = Dir.pwd
       @redis = nil
+      @stats = nil
       @coverage_baseline = {}
       @root_paths = []
       @ignore = []

data/lib/coverband/base.rb

@@ -4,12 +4,13 @@ module Coverband
     def initialize(options = {})
       @project_directory = File.expand_path(Coverband.configuration.root)
       @enabled = false
-      @function_set = false
+      @tracer_set = false
       @files = {}
       @ignore_patterns = Coverband.configuration.ignore
       @sample_percentage = Coverband.configuration.percentage
-      @reporter = Coverband.configuration.redis
-      @verbose = Coverband.configuration.verbose
+      @reporter = Coverband::RedisStore.new(Coverband.configuration.redis) if Coverband.configuration.redis
+      @stats    = Coverband.configuration.stats
+      @verbose  = Coverband.configuration.verbose
     end
 
     def start
@@ -19,10 +20,7 @@ module Coverband
     
     def stop
       @enabled = false
-      if @function_set
-        set_trace_func(nil)
-        @function_set = false
-      end
+      unset_tracer
     end
     
     def sample
@@ -50,17 +48,31 @@ module Coverband
 
     def record_coverage
       if @enabled
-        unless @function_set
-          set_trace_func proc { |event, file, line, id, binding, classname|
-            add_file(file, line)
-          }
-          @function_set = true
-        end
+        set_tracer
       else
-        if @function_set
-          set_trace_func(nil)
-          @function_set = false
-        end
+        unset_tracer
+      end
+      @stats.increment "coverband.request.recorded.#{@enabled}" if @stats
+    rescue RuntimeError => err
+      if @verbose
+        puts "error stating recording coverage"
+        puts "error: #{err.inspect} #{err.message}"
+      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
     
@@ -76,42 +88,31 @@ module Coverband
     end
     
     def report_coverage
-      begin
-        if @enabled
-          if @function_set
-            set_trace_func(nil)
-            @function_set = false
-          end
-          if @reporter
-            if @reporter.class.name.match(/redis/i)
-              #"/Users/danmayer/projects/cover_band_server/app.rb"=>[54, 55]
-              @files.each_pair do |key, values|
-                @reporter.sadd "coverband", key
-                #clean this up but redis gem v2.x doesn't allow sadd with a collection, this is slow
-                if @reporter.inspect.match(/v2/)
-                  values.each do |value|
-                    @reporter.sadd "coverband.#{key}", value
-                  end
-                else
-                  @reporter.sadd "coverband.#{key}", values
-                end
-              end
-              @files = {}
-            end
-          else
-            puts "coverage report: " if @verbose
-            puts @files.inspect if @verbose
-          end
-        else
-          puts "coverage disabled" if @verbose
-        end
-      rescue RuntimeError => err
-        if @verbose
-          puts "coverage missing" 
-          puts "error: #{err.inspect} #{err.message}"
+      unless @enabled
+        puts "coverage disabled" if @verbose
+        return
+      end
+
+      unset_tracer
+
+      if @reporter
+        if @reporter.class.name.match(/redis/i)
+          before_time = Time.now
+          @stats.increment "coverband.files.recorded.#{@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 = {}
         end
+      elsif @verbose
+        puts "coverage report: "
+        puts @files.inspect
+      end
+    rescue RuntimeError => err
+      if @verbose
+        puts "coverage missing"
+        puts "error: #{err.inspect} #{err.message}"
       end
     end
-    
   end
 end

data/lib/coverband/redis_store.rb

@@ -0,0 +1,51 @@
+module Coverband
+  class RedisStore
+    def initialize(redis)
+      @redis = redis
+    end
+
+    def store_report(report)
+      store_array('coverband', report.keys)
+
+      report.each do |file, lines|
+        store_array("coverband.#{file}", lines)
+      end
+    end
+
+    def sadd_supports_array?
+      # if the value is false, ||= would reevaluate the right side
+      return @_sadd_supports_array if defined?(@_sadd_supports_array)
+
+      @_sadd_supports_array = recent_gem_version? && recent_server_version?
+    end
+
+    private
+
+    attr_reader :redis
+
+    def store_array(key, values)
+      if sadd_supports_array?
+        redis.sadd(key, values)
+      else
+        values.each do |value|
+          redis.sadd(key, value)
+        end
+      end
+      values
+    end
+
+    def recent_server_version?
+      info_data = redis.info
+      if info_data.is_a?(Hash)
+        Gem::Version.new(info_data['redis_version']) >= Gem::Version.new('2.4')
+      else
+        #guess supported
+        true
+      end
+    end
+
+    def recent_gem_version?
+      Gem::Version.new(Redis::VERSION) >= Gem::Version.new('3.0')
+    end
+  end
+end

data/lib/coverband/version.rb

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

data/test/unit/base_test.rb

@@ -18,7 +18,7 @@ class BaseTest < Test::Unit::TestCase
     assert_equal true, coverband.instance_variable_get("@enabled")
     coverband.stop
     assert_equal false, coverband.instance_variable_get("@enabled")
-    assert_equal false, coverband.instance_variable_get("@function_set")
+    assert_equal false, coverband.instance_variable_get("@tracer_set")
   end
   
   should "allow for sampling with a block and enable when 100 percent sample" do
@@ -49,10 +49,11 @@ class BaseTest < Test::Unit::TestCase
     coverband = Coverband::Base.new
     coverband.instance_variable_set("@sample_percentage", 100.0)
     coverband.instance_variable_set("@verbose", true)
-    fake_redis = Redis.new
-    coverband.instance_variable_set("@reporter", fake_redis)
-    fake_redis.expects(:sadd).at_least_once
-    fake_redis.expects(:sadd).at_least_once.with("coverband.#{File.expand_path('../../', File.dirname(__FILE__))}/lib/coverband/base.rb", anything)
+    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")
+    }
     assert_equal false, coverband.instance_variable_get("@enabled")
     coverband.start
     1 + 1

data/test/unit/middleware_test.rb

@@ -39,19 +39,19 @@ class MiddlewareTest < Test::Unit::TestCase
   should 'always unset function when sampling' do
     request = Rack::MockRequest.env_for("/anything.json")
     middleware = Coverband::Middleware.new(fake_app)
-    assert_equal false, middleware.instance_variable_get("@function_set")
+    assert_equal false, middleware.instance_variable_get("@tracer_set")
     middleware.instance_variable_set("@sample_percentage", 100.0)
     results = middleware.call(request)
-    assert_equal false, middleware.instance_variable_get("@function_set")
+    assert_equal false, middleware.instance_variable_get("@tracer_set")
   end
 
   should 'always unset function when not sampling' do
     request = Rack::MockRequest.env_for("/anything.json")
     middleware = Coverband::Middleware.new(fake_app)
-    assert_equal false, middleware.instance_variable_get("@function_set")
+    assert_equal false, middleware.instance_variable_get("@tracer_set")
     middleware.instance_variable_set("@sample_percentage", 0.0)
     results = middleware.call(request)
-    assert_equal false, middleware.instance_variable_get("@function_set")
+    assert_equal false, middleware.instance_variable_get("@tracer_set")
   end
 
   should 'always record coverage, set trace func, and add_files when sampling' do
@@ -70,7 +70,8 @@ class MiddlewareTest < Test::Unit::TestCase
     assert_equal false, middleware.instance_variable_get("@enabled")
     middleware.instance_variable_set("@sample_percentage", 100.0)
     fake_redis = Redis.new
-    middleware.instance_variable_set("@reporter", fake_redis)
+    middleware.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])
     results = middleware.call(request)

data/test/unit/redis_store_test.rb

@@ -0,0 +1,83 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class RedisStoreTest < Test::Unit::TestCase
+  context '#store_report' do
+    setup do
+      @redis = Redis.current.tap { |redis|
+        redis.stubs(:sadd).with(anything, anything)
+        redis.stubs(:info).returns({'redis_version' => 3.0})
+      }
+
+      @store = Coverband::RedisStore.new(@redis)
+    end
+
+    should "it stores the files into coverband" do
+      @redis.expects(:sadd).with('coverband', [
+        '/Users/danmayer/projects/cover_band_server/app.rb',
+        '/Users/danmayer/projects/cover_band_server/server.rb'
+      ])
+
+      @store.store_report(test_data)
+    end
+
+    should "it stores the file lines of the file app.rb" do
+      @redis.expects(:sadd).with(
+        'coverband./Users/danmayer/projects/cover_band_server/app.rb',
+        [54, 55]
+      )
+
+      @store.store_report(test_data)
+    end
+
+    should "it stores the file lines of the file server.rb" do
+      @redis.expects(:sadd).with(
+        'coverband./Users/danmayer/projects/cover_band_server/server.rb',
+        [5]
+      )
+
+      @store.store_report(test_data)
+    end
+
+    context 'when the redis server version is too old' do
+      setup do
+        @redis.stubs(:info).returns("redis_version"=>"2.2.3")
+      end
+
+      should "it store the files with separate calls into coverband" do
+        @redis.expects(:sadd).with('coverband', '/Users/danmayer/projects/cover_band_server/app.rb')
+        @redis.expects(:sadd).with('coverband', '/Users/danmayer/projects/cover_band_server/server.rb')
+
+        @store.store_report(test_data)
+      end
+    end
+
+    context 'when the redis gem version is too old' do
+      setup do
+        @gem_version = Redis::VERSION
+        Redis.send(:remove_const, :VERSION)
+        Redis::VERSION = '2.2.2'
+      end
+
+      teardown do
+        Redis.send(:remove_const, :VERSION)
+        Redis::VERSION = @gem_version
+      end
+
+      should "it store the files with separate calls into coverband" do
+        @redis.expects(:sadd).with('coverband', '/Users/danmayer/projects/cover_band_server/app.rb')
+        @redis.expects(:sadd).with('coverband', '/Users/danmayer/projects/cover_band_server/server.rb')
+
+        @store.store_report(test_data)
+      end
+    end
+  end
+
+  private
+
+  def test_data
+    {
+      "/Users/danmayer/projects/cover_band_server/app.rb"=>[54, 55],
+      "/Users/danmayer/projects/cover_band_server/server.rb"=>[5]
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-22 00:00:00.000000000 Z
+date: 2014-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,12 +158,14 @@ files:
 - lib/coverband.rb
 - lib/coverband/base.rb
 - lib/coverband/middleware.rb
+- lib/coverband/redis_store.rb
 - lib/coverband/reporter.rb
 - lib/coverband/version.rb
 - test/fake_app/basic_rack.rb
 - test/test_helper.rb
 - test/unit/base_test.rb
 - test/unit/middleware_test.rb
+- test/unit/redis_store_test.rb
 - test/unit/reporter_test.rb
 homepage: ''
 licenses:
@@ -180,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2729098440983801028
+      hash: -1687477973538567061
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -189,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2729098440983801028
+      hash: -1687477973538567061
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -201,4 +203,5 @@ test_files:
 - test/test_helper.rb
 - test/unit/base_test.rb
 - test/unit/middleware_test.rb
+- test/unit/redis_store_test.rb
 - test/unit/reporter_test.rb