free 0.2.5 → 0.2.6

data/README.md

@@ -8,10 +8,17 @@ _force immediate garbage collection of Ruby objects_
 free provides the `Object#free` method enabling a user to garbage
 collect an object on demand and free all its internal structures.
 
-* Install the [gem](https://rubygems.org/gems/free)
+* Install the [gem](https://rubygems.org/gems/free): `gem install free`
 * Read the [documentation](http://rdoc.info/github/banister/free/master/file/README.md)
 * See the [source code](http://github.com/banister/free)
 
+`free` also has `rubygems-test` support; to participate, first install
+free, then:
+
+1. Install rubygems-test: `gem install rubygems-test`
+2. Run the test: `gem test free`
+3. Finally choose 'Yes' to upload the results. 
+
 Example: Freeing a String
 -------------------------
 
@@ -57,7 +64,22 @@ Features and limitations
 * Beta software, beware.
 * Supports MRI and YARV only.
 * Not complete protection from freeing silly things, e.g core classes. Be sensible :)
-* Can be dangerous - `free` will force garbage collection on an object even if references to it still exist. Trying to access an already freed object may result in unexpected behaviour or segfaults.
+* Can be dangerous - `free` will force garbage collection on an object
+* even if references to it still exist. Trying to access an already
+* freed object may result in unexpected behaviour or segfaults.
+
+### Caveats
+
+Benchmarks have shown that `free` can significantly improve performance, but only
+when the objects you free are very large (approximately > 50K
+in size).
+
+It is not recommended you free small or medium-sized objects as you will
+actually negatively impact performance - as the `free` process itself
+incurs some overhead.
+
+In general you should benchmark your application with and without
+`free` before you decide to use it.
   
 Contact
 -------

data/Rakefile

@@ -21,6 +21,7 @@ def apply_spec_defaults(s)
   s.email = 'jrmair@gmail.com'
   s.description = s.summary
   s.require_path = 'lib'
+  s.add_development_dependency("bacon",">=1.1.0")
   s.homepage = "http://banisterfiend.wordpress.com"
   s.has_rdoc = 'yard'
   s.files = Dir["ext/**/extconf.rb", "ext/**/*.h", "ext/**/*.c", "lib/**/*.rb",

data/lib/free/version.rb

@@ -1,3 +1,3 @@
 module Free
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end     

data/test/bench_base.rb

@@ -0,0 +1,7 @@
+require 'benchmark'
+require '../lib/free'
+
+TIMES = 900_00
+REPEATS = 50_000
+
+STR = "x" * REPEATS

data/test/bench_free.rb

@@ -0,0 +1,4 @@
+require './bench_base'
+
+puts "free #{Benchmark.measure { TIMES.times { j = STR.dup; j << rand(100).to_s ; j.free } }}"
+

data/test/bench_non_free.rb

@@ -0,0 +1,4 @@
+require './bench_base'
+
+puts "non free #{Benchmark.measure { TIMES.times { j = STR.dup; j << rand(100).to_s } }}"
+

data/test/test.rb

@@ -17,7 +17,7 @@ describe Free do
       c = v
 
       # grab the object id since referring to object directly (through
-      # c) will likely result in segfault, which can't be rescued.
+      # v) will likely result in segfault, which can't be rescued.
       id = v.object_id
 
       ObjectSpace._id2ref(id).should == v
@@ -27,7 +27,7 @@ describe Free do
 
       # Two things may happen if it is properly freed:
       # 1. The _id2ref resolves to another object (the free slot is
-      #   replace by a new object)
+      #   replaced by a new object)
       # 2. Calling _id2ref raises an exception, typically a RangeError
       (ObjectSpace._id2ref(id)  != v || lambda { ObjectSpace._id2ref(id) } rescue true).should == true
     end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: free
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -15,10 +14,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-04 00:00:00 +13:00
+date: 2011-01-27 00:00:00 +13:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id001
 description: Force immediate garbage collection of an object.
 email: jrmair@gmail.com
 executables: []
@@ -54,6 +67,9 @@ files:
 - ext/free/free.c
 - lib/free/version.rb
 - lib/free.rb
+- test/bench_base.rb
+- test/bench_free.rb
+- test/bench_non_free.rb
 - test/test.rb
 - HISTORY
 - README.md
@@ -72,7 +88,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -81,7 +96,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"