obuf 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.0.1 / 2011-08-02
+
+* Fix the bug that was failing Obuf in Ruby 1.8.7 since Mutex is not loaded by default
+
 === 1.0.0 / 2011-08-02
 
 * 1 major enhancement

data/Rakefile

@@ -8,7 +8,7 @@ Hoe.spec 'obuf' do | p |
 
   p.readme_file   = 'README.rdoc'
   p.extra_rdoc_files  = FileList['*.rdoc'] + FileList['*.txt']
-  p.extra_dev_deps = {"flexmock" => "~> 0.8", "cli_test" => "~>1.0"}
+  p.extra_dev_deps = {"flexmock" => "~> 0.8"}
   p.clean_globs = File.read(File.dirname(__FILE__) + "/.gitignore").split(/\s/).to_a
 end
 

data/lib/obuf.rb

@@ -1,11 +1,11 @@
 require "tempfile"
+require "thread" # required for ruby 18
 
 # An object buffer for Ruby objects. Use it to sequentially store a shitload
 # of objects on disk and then retreive them one by one. Make sure to call clear when done
-# with it to discard the stored blob. It can be used like a disk-based object buffer.
-# (Tracksperanto stores parsed trackers into it)
+# with it to discard the stored blob. 
 #
-#  a = Tracksperanto::Accumulator.new
+#  a = Obuf.new
 #  parse_big_file do | one_node |
 #    a.push(one_node)
 #  end
@@ -17,9 +17,9 @@ require "tempfile"
 #
 #  a.clear # ensure that the file is deleted
 #
-# Both reading and writing aim to be threadsafe (writing operations will be locked with a mutex, and )
+# Both reading and writing aim to be threadsafe
 class Obuf
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
   
   include Enumerable
   
@@ -31,7 +31,7 @@ class Obuf
   
   def initialize
     @sem = Mutex.new
-    @store = create_store
+    @store = Tempfile.new("obuf")
     @store.set_encoding(Encoding::BINARY) if @store.respond_to?(:set_encoding)
     @store.binmode
     
@@ -69,13 +69,15 @@ class Obuf
   
   # Calls close! on the datastore and deletes the objects in it
   def clear
-    @store.close!
-    @size = 0
+    @sem.synchronize do
+      @store.close!
+      @size = 0
+    end
   end
   
-  # Retreive a concrete object at index
-  def [](idx)
-    idx.respond_to?(:each) ? idx.map{|i| recover_at(i) } : recover_at(idx)
+  # Retreive a slice of the enumerable at index
+  def [](slice)
+    slice.respond_to?(:each) ? slice.map{|i| recover_at(i) } : recover_at(slice)
   end
   
   private
@@ -100,7 +102,7 @@ class Obuf
     # Ensure all data is written before we read it
     @sem.synchronize { @store.flush }
     
-    iterable = File.open(@store.path, "r")
+    iterable = File.open(@store.path, "rb")
     begin
       yield(iterable)
     ensure
@@ -108,20 +110,24 @@ class Obuf
     end
   end
   
-  def marshal_object(object_to_store)
-    d = Marshal.dump(object_to_store)
-  end
-  
   def recover_object_from(io)
     # Up to the tab is the amount of bytes to read
     demarshal_bytes = io.gets("\t").to_i
     blob = io.read(demarshal_bytes)
-    
-    Marshal.load(blob)
+    demarshal_object(blob)
   end
   
-  # In case you need to use something else (say, a StringIO)
-  def create_store
-    Tempfile.new("obuf")
+  # This method is only used internally. 
+  # Override this if you need non-default marshalling 
+  # (don't forget to also override demarshal_object)
+  def marshal_object(object_to_store)
+    d = Marshal.dump(object_to_store)
+  end
+  
+  # This method is only used internally. 
+  # Override this if you need non-default demarshalling
+  # (don't forget to also override marshal_object)
+  def demarshal_object(blob)
+    Marshal.load(blob)
   end
 end

data/test/test_obuf.rb

@@ -2,6 +2,7 @@ require "test/unit"
 require "obuf"
 require "flexmock"
 require "flexmock/test_unit"
+require "stringio"
 
 # http://redmine.ruby-lang.org/issues/4882
 # https://github.com/jimweirich/flexmock/issues/4
@@ -13,6 +14,7 @@ class FlexMock::PartialMockProxy
 end
 
 class TestObuf < Test::Unit::TestCase
+  
   def test_accumulator_saves_objs
     a = Obuf.new
     values = [3, {:foo => "bar"}, "foo"]

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: obuf
 version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: 
-  version: 1.0.0
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -10,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-02 00:00:00 Z
+date: 2011-11-20 00:00:00 +01:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: flexmock
@@ -20,31 +26,29 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
         version: "0.8"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: cli_test
+  name: hoe
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: "1.0"
+        hash: 35
+        segments: 
+        - 2
+        - 9
+        - 4
+        version: 2.9.4
   type: :development
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.10"
-  type: :development
-  version_requirements: *id003
 description: A simple Ruby object buffer. Use this if you need to temporarily store alot of serializable Ruby objects.
 email: 
 - me@julik.nl
@@ -65,6 +69,7 @@ files:
 - lib/obuf.rb
 - test/test_obuf.rb
 - .gemtest
+has_rdoc: true
 homepage: http://github.com/julik/obuf
 licenses: []
 
@@ -79,17 +84,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: obuf
-rubygems_version: 1.8.5
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A simple Ruby object buffer