synchronizable 0.0.1 → 0.0.2

data/README.rdoc

@@ -15,6 +15,8 @@ Synchronizable is available as a RubyGem:
 
 == Examples
 
+=== Making an instance synchronizable
+
     class Foo
       def bar
       end
@@ -27,6 +29,8 @@ Synchronizable is available as a RubyGem:
     # the foo instance now has all methods synchronized / thread-safe
     foo.extend(Synchronizable)
 
+=== Making a class synchronizable
+
     # note that classes are objects in Ruby and can also be synchronized
     class Bar
       def self.foo
@@ -36,6 +40,17 @@ Synchronizable is available as a RubyGem:
     # only class/singleton methods will become synchronized
     Bar.extend(Synchronizable)
 
+=== Utilizing the #synchronize method to protect a block
+
+    # the synchronize method takes a block and executes it
+    # in a thread-safe manner
+    s = "this is a test"
+    s.extend(Synchronizable)
+    s.synchronize do
+      s.gsub!('i', 'x')
+      s.slice!(0, 5)
+    end
+
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/lib/synchronizable.rb

@@ -1,4 +1,4 @@
-require 'thread'
+require 'monitor'
 require 'synchronizable/version'
 
 # Synchronizable is intended to be injected into objects via Object#extend.
@@ -20,11 +20,19 @@ module Synchronizable
         end
       end
     end
+
+    # define synchronize method that executes a block
+    # protected with the internal instance lock
+    obj.define_singleton_method(:synchronize) do |&block|
+      __lock.synchronize(&block)
+    end
   end
 
   private
 
   def __lock
-    @__lock ||= Mutex.new
+    # Monitor is used instead of Mutex in order to support
+    # re-entrant locking
+    @__lock ||= Monitor.new
   end
 end

data/lib/synchronizable/version.rb

@@ -1,3 +1,3 @@
 module Synchronizable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/synchronizable/synchronizable_spec.rb

@@ -35,5 +35,31 @@ describe Synchronizable do
       object.size
       lock.sync_invoked.should == true
     end
+
+    it "allows re-entrant methods" do
+      class Test
+        def m1
+          10
+        end
+
+        def m2
+          m1
+        end
+      end
+
+      t = Test.new
+      t.extend(Synchronizable)
+      t.m2.should == 10
+    end
+  end
+
+  it "protects a block via #synchronize" do
+    s = ""
+    s.methods.should_not include(:synchronize)
+    s.extend(Synchronizable)
+    s.methods.should include(:synchronize)
+    s.synchronize do
+      s.split
+    end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ryan LeCompte
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-28 00:00:00 -04:00
+date: 2011-07-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency