threadlock 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5572ec2bfc12ce846c7ebedc66bd8e072dd7d96f
-  data.tar.gz: 49bae1342466bab33abec0830b028bb10cf1a4cd
+  metadata.gz: af828e08328bf0b3a7d811cacae465fd81f9a4ae
+  data.tar.gz: 3c6da6bc34e39ec90eb92a6cc6b64c688a58d18f
 SHA512:
-  metadata.gz: 7cbc19433166cb2688d8fb2b5562bbde9a844371e0c477692a1fbeaf232872c8092c2847ce3d75698ffb0dc11d80897d3cb65bf32519efddd94c17c0f4fb5bbe
-  data.tar.gz: b9796a59a4b08e96f3534cc56320c716ae39cf2ca6e028068d7de0a3898e198af7b109d8c2a569b6dab275aef26d82d9c560d2f07d9cd19a39f58250b74d6e80
+  metadata.gz: 4487deaa6998d99bee44689cd8d0e71c84f45b35e78e98eb1e375f5ec10613ffdb8c3f3c3e9044fadbcc310ba43b18533fe130932b130eedc5b14792c2d13cab
+  data.tar.gz: 920c155bf9445bfe699562563aa1b61ce25b12f77a5581bfd2927c005c345f379b970d4ff40c5fa6a2843feba5bfa95c882f2e28a8abad0f55bed6d805b0e2ff

data/USAGE.rb

@@ -0,0 +1,172 @@
+$LOAD_PATH.unshift(File.expand_path("./lib", File.dirname(__FILE__)))
+require 'threadlock'
+
+
+class Example1
+  
+  def foo
+    @foo = true
+    raise "not synchronized!" if @bar
+    sleep 0.2
+    raise "not synchronized!" if @bar
+    @foo = false
+  end
+  
+  def bar
+    @bar = true
+    raise "not synchronized!" if @foo
+    sleep 0.2
+    raise "not synchronized!" if @foo
+    @bar = false
+  end
+  
+  # Wrap foo and bar methods in a re-entrant lock
+  threadlock :foo
+  threadlock :bar
+  
+end
+
+
+class Example2
+  
+  def foo
+    @foo = true
+    raise "not synchronized!" if @bar
+    sleep 0.2
+    raise "not synchronized!" if @bar
+    @foo = false
+  end
+  
+  def bar
+    @bar = true
+    raise "not synchronized!" if @foo
+    sleep 0.2
+    raise "not synchronized!" if @foo
+    @bar = false
+  end
+  
+  # Wrap foo and bar methods in a re-entrant lock
+  threadlock :foo, :bar
+  
+end
+
+
+class Example3
+  
+  def foo
+    @foo = true
+    raise "not synchronized!" if @bar
+    sleep 0.2
+    raise "not synchronized!" if @bar
+    @foo = false
+  end
+  
+  def bar
+    @bar = true
+    raise "not synchronized!" if @foo
+    sleep 0.2
+    raise "not synchronized!" if @foo
+    @bar = false
+  end
+  
+  # Wrap all newly defined instance methods in a re-entrant lock
+  threadlock instance_methods(false)
+  
+end
+
+
+class Example4
+  
+  def foo
+    @foo = true
+    raise "not synchronized!" if @bar
+    sleep 0.2
+    raise "not synchronized!" if @bar
+    @foo = false
+  end
+  
+  def bar
+    @bar = true
+    raise "not synchronized!" if @foo
+    sleep 0.2
+    raise "not synchronized!" if @foo
+    @bar = false
+  end
+  
+  # Wrap foo and bar methods in a re-entrant lock named custom_lock_name
+  # (default lock name is :@__threadlock__)
+  threadlock :foo, :bar, :lock=>:@custom_lock_name
+  
+end
+
+
+class Example5
+  
+  def initialize
+    @custom_lock_name = Mutex.new
+  end
+  
+  def foo
+    @foo = true
+    raise "not synchronized!" if @bar
+    sleep 0.2
+    raise "not synchronized!" if @bar
+    @foo = false
+  end
+  
+  def bar
+    @bar = true
+    raise "not synchronized!" if @foo
+    sleep 0.2
+    raise "not synchronized!" if @foo
+    @bar = false
+  end
+  
+  # Wrap foo and bar methods in a mutex instead of a re-entrant lock
+  threadlock :foo, :bar, :lock=>:@custom_lock_name
+  
+end
+
+
+class Example6 # Ruby 2.1 only
+  
+  # Ruby 2.1 only: wrap new method foo in a re-entrant lock
+  threadlock def foo
+    @foo = true
+    raise "not synchronized!" if @bar
+    sleep 0.2
+    raise "not synchronized!" if @bar
+    @foo = false
+  end
+  
+  def bar
+    @bar = true
+    raise "not synchronized!" if @foo
+    sleep 0.2
+    raise "not synchronized!" if @foo
+    @bar = false
+  end
+  
+  # Wrap method bar in the same re-entrant lock
+  threadlock :bar
+  
+end if RUBY_VERSION>="2.1.0"
+
+
+# Run tests on Example classes - raise if error
+[
+  Example1,
+  Example2,
+  Example3,
+  Example4,
+  Example5,
+ (Example6 if RUBY_VERSION>="2.1.0"), # Ruby 2.1 only
+].each do |cls|
+  break unless cls
+  puts "testing #{cls}"
+  obj = cls.new
+  [Thread.new { obj.foo }, Thread.new { obj.bar }]
+    .each { |t| t.join }
+end
+
+puts "passed tests!"

data/lib/threadlock.rb

@@ -1,35 +1,14 @@
 require 'monitor'
 
-def threadlock(*funcs, lock: :@___threadlock___)
-  for f in funcs.flatten
-    f2 = f.to_s
-          .gsub(/\=/, "_eQUAL")
-          .gsub(/\!/, "_nOT")
-          .gsub(/\~/, "_tILDE")
-          .gsub(/\</, "_lESS")
-          .gsub(/\>/, "_mORE")
-          .gsub(/\+/, "_aDD")
-          .gsub(/\-/, "_sUB")
-          .gsub(/\*/, "_mULT")
-          .gsub(/\//, "_dIV")
-          .gsub(/\%/, "_mOD")
-          .gsub(/\[/, "_bRACKO")
-          .gsub(/\]/, "_bRACKC")
-          .gsub(/\@/, "_aTTR")
-          .gsub(/\&/, "_aMPER")
-          .gsub(/\|/, "_pIPE")
-          .gsub(/\^/, "_cARET")
-          .gsub(/^/, "___")
-    
-    class_eval\
-    ("
-      alias :#{f2} :#{f}
-      def #{f}(*args, &block)
-        #{lock.to_s} ||= Monitor.new
-        #{lock.to_s}.synchronize do
-          #{f2}(*args, &block)
-        end
+def threadlock(*meths, lock: :@___threadlock___)
+  meths.flatten.each do |meth|
+    m = instance_method(meth)
+    define_method(meth) do |*args|
+      (instance_variable_get(lock) or \
+       instance_variable_set(lock, Monitor.new))
+      .synchronize do
+        m.bind(self).call(*args)
       end
-    ")
+    end
   end
 end

metadata

@@ -1,23 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: threadlock
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Joe McIlvain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-22 00:00:00.000000000 Z
+date: 2013-09-24 00:00:00.000000000 Z
 dependencies: []
-description: "Use the threadlock function in your class definition to automatically
+description: 'Use the threadlock function in your class definition to automatically
   run instance methods inside of an instance-wide re-entrant lock (Monitor).  All
   locked methods in an instance are protect by a single lock.  You can protect all
-  or some of your methods from being run asynchronously.  The goal is to be able to
-  easily make basic objects threadsafe with as little thought and code as using the
-  attr_accessor family of functions to make your instance attributes accessible.  The
-  codebase is small and I intend to keep it that way, but bug reports and patches
-  are welcome.  \n Enjoy."
+  or some of your methods from being run asynchronously.  In Ruby>=2.1, threadlock
+  can also be syntactically used as a decorator. '
 email: joe.eli.mac@gmail.com
 executables: []
 extensions: []
@@ -26,6 +23,7 @@ files:
 - lib/threadlock.rb
 - LICENSE
 - README.md
+- USAGE.rb
 homepage: https://github.com/jemc/threadlock/
 licenses:
 - MIT License
@@ -37,17 +35,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: 'threadlock: Easy, featherweight thread protection for basic ruby objects.'