coverband 0.0.16 → 0.0.17

data/README.md

@@ -52,7 +52,17 @@ Details on a example Sinatra app
 
 ## Usage
 
-After installing the gem, you likely want to get the rake tasks configured as well as the rack middleware.
+After installing the gem. There are a few steps to gather data, view reports, and cleaing up the data.
+
+1. First configure Rake, with helpful tasks. See the section below
+	* `rake coverband_baseline` helps you to record a baseline of your apps initialization process
+	*  `rake coverband` after you have setup coverband on a server and started recording data this generates the report and opens it in your browser.
+2. 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.
+3. 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. 
+4. Hit your development server exercising the endpoints you want to verify Coverband is recording.
+5. Now to view changes in live coverage run `rake coverband` again, previously it should have only shown the baseline data of your app initializing. After using it in development it hsould show increased coverage from the actions you have exercised.
 
 #### Configuring Rake
 
@@ -101,7 +111,11 @@ Coverband.configure do |config|
   config.coverage_baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
   config.root_paths        = ['/app/']
   config.ignore            = ['vendor']
-  config.percentage        = 100.0
+  # Since rails and other frameworks lazy load code. I have found it is bad to allow
+  # initial requests to record with coverband.
+  # This allows 10 requests prior to trying to record any activitly.
+  config.startup_delay     = 10
+  config.percentage        = 15.0
 end
 
 use Coverband::Middleware
@@ -183,7 +197,7 @@ Coverband::Reporter.clear_coverage(Redis.new(:host => 'target.com', :port => 678
 * Possibly add ability to record code run for a given route
 * Add default rake tasks so a project could just require the rake tasks
 * Improve client code api, particularly around configuration, but also around manual usage of sampling
-
+* Provide a better lighter example app, to show how to use coverband.
 
 ## Resources
 

data/coverband.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "mocha", "~> 0.14.0"
   spec.add_development_dependency "shoulda"
   spec.add_development_dependency "rack"
   spec.add_runtime_dependency "simplecov"

data/lib/coverband/version.rb

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

data/test/test_helper.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'simplecov'
 require 'test/unit'
 require 'shoulda'
-require 'mocha'
+require 'mocha/setup'
 require 'ostruct'
 require 'json'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -48,17 +48,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -182,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -615228549007876358
+      hash: -2201223091774651170
 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: -615228549007876358
+      hash: -2201223091774651170
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23