coverband_ext 0.0.2 → 1.0.0

data/README.md

@@ -1,12 +1,15 @@
 # CoverbandExt
 
-This is a native C extension to run coverband on Ruby 1.9.3 much much faster that with the pure Ruby version.
+This is a C extension to run coverband on Ruby 1.9.3+ much much faster that with the pure Ruby version. This has been tested with Ruby 1.9.3, 2.0,x, 2.1.x
+
+This gem does nothing on its own. So make sure you already have setup the [coverband](https://github.com/danmayer/coverband) gem. I recommend using just `coverband` to get run time code coverage working on your project. Then adding this gem once everything is configured and working to reduce the performance overhead of the original gem.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile, after the existing coverband line:
 
     gem 'coverband_ext'
+    gem 'coverband_ext'
 
 And then execute:
 
@@ -14,15 +17,19 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install coverband_ext
+    $ gem install coverband coverband_ext
 
 ## Usage
 
-Follow the normal Coverband usage... Include this gem below the coverband gem in your `Gemfile`. Make sure you are on Coverband 0.0.27 or above to have coverband detect and use this extension.
+Follow the normal Coverband usage... Include this gem below the coverband gem in your `Gemfile`. Make sure you are on Coverband 1.0.0 or above to have coverband detect and use this extension. With this gem loaded coverband will go ahead and use the available C extension methods to see a significant performance improvement.
+
+No other changes should be required to receive the additional perf improvements.
 
 ## Perf Improvements
 
-#### Example perf against small app with 100% coverband sampling
+I have actually slightly improved the perf again since the V2 version in the benchmarks below. 
+
+#### Example perf against smaller app with 100% coverband sampling
 
 `ab -n 100 -c5 http://small.app.com:80/`
 
@@ -32,10 +39,10 @@ Follow the normal Coverband usage... Include this gem below the coverband gem in
   * Time taken for tests:   31.489 seconds / 29.064 seconds
 * Ruby Coverband C Ext V1
   * Time taken for tests:   14.679 seconds / 12.033 seconds
-* Ruby Coverband C Ext V2 with Regex
+* Ruby Coverband C Ext V2 (which includes Regex support)
   * Time taken for tests:   6.131 seconds / 6.321 seconds
 
-##### Example perf against large rails app with 100% coverband sampling
+##### Example perf against a VERY large rails app with 100% coverband sampling
 
 `ab -n 50 -c5 http://pipeline.lsdev.co:80/pipeline/cities`
 
@@ -43,7 +50,7 @@ Follow the normal Coverband usage... Include this gem below the coverband gem in
   * Time taken for tests:   31.347 seconds / 31.298 seconds
 * Ruby Coverband
   * Time taken for tests:   336.53 seconds / 331.89 seconds
-* Ruby Coverband C Ext V2 with Regex
+* Ruby Coverband C Ext V2 (which includes Regex support)
   * Time taken for tests:   42.785 seconds / 43.343 seconds
 
 ## Contributing

data/lib/coverband_ext/version.rb

@@ -1,3 +1,3 @@
 module CoverbandExt
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/{example.rb → scripts/example.rb}

@@ -1,3 +1,9 @@
+###
+# This file is just for me to quickly test and verify a few things are working as expected.
+# Beyond testing that functionality works it makes it easy to override parts
+# of the coverband gem before making changes back in the host gem.
+###
+
 # bundle exec rake build
 # gem uninstall coverband_ext
 # gem install pkg/coverband_ext-0.0.1.gem

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband_ext
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2014-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,7 +73,6 @@ files:
 - README.md
 - Rakefile
 - coverband_ext.gemspec
-- example.rb
 - ext/coverband_ext/coverband_ext.c
 - ext/coverband_ext/extconf.rb
 - ext/coverband_ext/ruby_headers/192/debug.h
@@ -124,9 +123,10 @@ files:
 - ext/coverband_ext/ruby_headers/193/vm_exec.h
 - ext/coverband_ext/ruby_headers/193/vm_insnhelper.h
 - ext/coverband_ext/ruby_headers/193/vm_opts.h
-- install.rb
 - lib/coverband_ext.rb
 - lib/coverband_ext/version.rb
+- scripts/example.rb
+- scripts/install.rb
 homepage: ''
 licenses:
 - MIT
@@ -142,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 195866673644272167
+      hash: -1916411580250023859
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 195866673644272167
+      hash: -1916411580250023859
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23