shoesgem 0.1424.0

data/shoes/ruby/lib/singleton.rb

@@ -0,0 +1,313 @@
+# The Singleton module implements the Singleton pattern.
+#
+# Usage:
+#    class Klass
+#       include Singleton
+#       # ...
+#    end
+#
+# *  this ensures that only one instance of Klass lets call it
+#    ``the instance'' can be created.
+#
+#      a,b  = Klass.instance, Klass.instance
+#      a == b    # => true
+#      Klass.new #  NoMethodError - new is private ...
+#
+# *  ``The instance'' is created at instantiation time, in other
+#    words the first call of Klass.instance(), thus
+#
+#      class OtherKlass
+#        include Singleton
+#        # ...
+#      end
+#      ObjectSpace.each_object(OtherKlass){} # => 0.
+#
+# *  This behavior is preserved under inheritance and cloning.
+#
+#
+#
+# This is achieved by marking
+# *  Klass.new and Klass.allocate - as private
+#
+# Providing (or modifying) the class methods
+# *  Klass.inherited(sub_klass) and Klass.clone()  -
+#    to ensure that the Singleton pattern is properly
+#    inherited and cloned.
+#
+# *  Klass.instance()  -  returning ``the instance''. After a
+#    successful self modifying (normally the first) call the
+#    method body is a simple:
+#
+#       def Klass.instance()
+#         return @singleton__instance__
+#       end
+#
+# *  Klass._load(str)  -  calling Klass.instance()
+#
+# *  Klass._instantiate?()  -  returning ``the instance'' or
+#    nil. This hook method puts a second (or nth) thread calling
+#    Klass.instance() on a waiting loop. The return value
+#    signifies the successful completion or premature termination
+#    of the first, or more generally, current "instantiation thread".
+#
+#
+# The instance method of Singleton are
+# * clone and dup - raising TypeErrors to prevent cloning or duping
+#
+# *  _dump(depth) - returning the empty string.  Marshalling strips
+#    by default all state information, e.g. instance variables and
+#    taint state, from ``the instance''.  Providing custom _load(str)
+#    and _dump(depth) hooks allows the (partially) resurrections of
+#    a previous state of ``the instance''.
+
+require 'thread'
+
+module Singleton
+  #  disable build-in copying methods
+  def clone
+    raise TypeError, "can't clone instance of singleton #{self.class}"
+  end
+  def dup
+    raise TypeError, "can't dup instance of singleton #{self.class}"
+  end
+
+  #  default marshalling strategy
+  def _dump(depth = -1)
+    ''
+  end
+
+  module SingletonClassMethods
+    # properly clone the Singleton pattern - did you know
+    # that duping doesn't copy class methods?
+    def clone
+      Singleton.__init__(super)
+    end
+
+    def _load(str)
+      instance
+    end
+
+    private
+
+    #  ensure that the Singleton pattern is properly inherited
+    def inherited(sub_klass)
+      super
+      Singleton.__init__(sub_klass)
+    end
+  end
+
+  class << Singleton
+    def __init__(klass)
+      klass.instance_eval {
+        @singleton__instance__ = nil
+        @singleton__mutex__ = Mutex.new
+      }
+      def klass.instance
+        return @singleton__instance__ if @singleton__instance__
+        @singleton__mutex__.synchronize {
+          return @singleton__instance__ if @singleton__instance__
+          @singleton__instance__ = new()
+        }
+        @singleton__instance__
+      end
+      klass
+    end
+
+    private
+
+    #  extending an object with Singleton is a bad idea
+    undef_method :extend_object
+
+    def append_features(mod)
+      #  help out people counting on transitive mixins
+      unless mod.instance_of?(Class)
+        raise TypeError, "Inclusion of the OO-Singleton module in module #{mod}"
+      end
+      super
+    end
+
+    def included(klass)
+      super
+      klass.private_class_method  :new, :allocate
+      klass.extend SingletonClassMethods
+      Singleton.__init__(klass)
+    end
+  end
+
+end
+
+
+if __FILE__ == $0
+
+def num_of_instances(klass)
+    "#{ObjectSpace.each_object(klass){}} #{klass} instance(s)"
+end
+
+# The basic and most important example.
+
+class SomeSingletonClass
+  include Singleton
+end
+puts "There are #{num_of_instances(SomeSingletonClass)}"
+
+a = SomeSingletonClass.instance
+b = SomeSingletonClass.instance # a and b are same object
+puts "basic test is #{a == b}"
+
+begin
+  SomeSingletonClass.new
+rescue  NoMethodError => mes
+  puts mes
+end
+
+
+
+puts "\nThreaded example with exception and customized #_instantiate?() hook"; p
+Thread.abort_on_exception = false
+
+class Ups < SomeSingletonClass
+  def initialize
+    self.class.__sleep
+    puts "initialize called by thread ##{Thread.current[:i]}"
+  end
+end
+
+class << Ups
+  def _instantiate?
+    @enter.push Thread.current[:i]
+    while false.equal?(@singleton__instance__)
+      @singleton__mutex__.unlock
+      sleep 0.08
+      @singleton__mutex__.lock
+    end
+    @leave.push Thread.current[:i]
+    @singleton__instance__
+  end
+
+  def __sleep
+    sleep(rand(0.08))
+  end
+
+  def new
+    begin
+      __sleep
+      raise  "boom - thread ##{Thread.current[:i]} failed to create instance"
+    ensure
+      # simple flip-flop
+      class << self
+        remove_method :new
+      end
+    end
+  end
+
+  def instantiate_all
+    @enter = []
+    @leave = []
+    1.upto(9) {|i|
+      Thread.new {
+        begin
+          Thread.current[:i] = i
+          __sleep
+          instance
+        rescue RuntimeError => mes
+          puts mes
+        end
+      }
+    }
+    puts "Before there were #{num_of_instances(self)}"
+    sleep 3
+    puts "Now there is #{num_of_instances(self)}"
+    puts "#{@enter.join '; '} was the order of threads entering the waiting loop"
+    puts "#{@leave.join '; '} was the order of threads leaving the waiting loop"
+  end
+end
+
+
+Ups.instantiate_all
+# results in message like
+# Before there were 0 Ups instance(s)
+# boom - thread #6 failed to create instance
+# initialize called by thread #3
+# Now there is 1 Ups instance(s)
+# 3; 2; 1; 8; 4; 7; 5 was the order of threads entering the waiting loop
+# 3; 2; 1; 7; 4; 8; 5 was the order of threads leaving the waiting loop
+
+
+puts "\nLets see if class level cloning really works"
+Yup = Ups.clone
+def Yup.new
+  begin
+    __sleep
+    raise  "boom - thread ##{Thread.current[:i]} failed to create instance"
+  ensure
+    # simple flip-flop
+    class << self
+      remove_method :new
+    end
+  end
+end
+Yup.instantiate_all
+
+
+puts "\n\n","Customized marshalling"
+class A
+  include Singleton
+  attr_accessor :persist, :die
+  def _dump(depth)
+    # this strips the @die information from the instance
+    Marshal.dump(@persist,depth)
+  end
+end
+
+def A._load(str)
+  instance.persist = Marshal.load(str)
+  instance
+end
+
+a = A.instance
+a.persist = ["persist"]
+a.die = "die"
+a.taint
+
+stored_state = Marshal.dump(a)
+# change state
+a.persist = nil
+a.die = nil
+b = Marshal.load(stored_state)
+p a == b  #  => true
+p a.persist  #  => ["persist"]
+p a.die      #  => nil
+
+
+puts "\n\nSingleton with overridden default #inherited() hook"
+class Up
+end
+def Up.inherited(sub_klass)
+  puts "#{sub_klass} subclasses #{self}"
+end
+
+
+class Middle < Up
+  include Singleton
+end
+
+class Down < Middle; end
+
+puts  "and basic \"Down test\" is #{Down.instance == Down.instance}\n
+Various exceptions"
+
+begin
+  module AModule
+    include Singleton
+  end
+rescue TypeError => mes
+  puts mes  #=> Inclusion of the OO-Singleton module in module AModule
+end
+
+begin
+  'aString'.extend Singleton
+rescue NoMethodError => mes
+  puts mes  #=> undefined method `extend_object' for Singleton:Module
+end
+
+end

data/shoes/ruby/lib/sync.rb

@@ -0,0 +1,307 @@
+#
+#   sync.rb - 2 phase lock with counter
+#   	$Release Version: 1.0$
+#   	$Revision: 19280 $
+#   	by Keiju ISHITSUKA(keiju@ishitsuka.com)
+#
+# --
+#  Sync_m, Synchronizer_m
+#  Usage:
+#   obj.extend(Sync_m)
+#   or
+#   class Foo
+#	include Sync_m
+#	:
+#   end
+#
+#   Sync_m#sync_mode
+#   Sync_m#sync_locked?, locked?
+#   Sync_m#sync_shared?, shared?
+#   Sync_m#sync_exclusive?, sync_exclusive?
+#   Sync_m#sync_try_lock, try_lock
+#   Sync_m#sync_lock, lock
+#   Sync_m#sync_unlock, unlock
+#
+#  Sync, Synchronizer:
+#  Usage:
+#   sync = Sync.new
+#
+#   Sync#mode
+#   Sync#locked?
+#   Sync#shared?
+#   Sync#exclusive?
+#   Sync#try_lock(mode) -- mode = :EX, :SH, :UN
+#   Sync#lock(mode)     -- mode = :EX, :SH, :UN
+#   Sync#unlock
+#   Sync#synchronize(mode) {...}
+#   
+#
+
+unless defined? Thread
+  raise "Thread not available for this ruby interpreter"
+end
+
+module Sync_m
+  RCS_ID='-$Header$-'
+  
+  # lock mode
+  UN = :UN
+  SH = :SH
+  EX = :EX
+  
+  # exceptions
+  class Err < StandardError
+    def Err.Fail(*opt)
+      fail self, sprintf(self::Message, *opt)
+    end
+    
+    class UnknownLocker < Err
+      Message = "Thread(%s) not locked."
+      def UnknownLocker.Fail(th)
+	super(th.inspect)
+      end
+    end
+    
+    class LockModeFailer < Err
+      Message = "Unknown lock mode(%s)"
+      def LockModeFailer.Fail(mode)
+	if mode.id2name
+	  mode = id2name
+	end
+	super(mode)
+      end
+    end
+  end
+  
+  def Sync_m.define_aliases(cl)
+    cl.module_eval %q{
+      alias locked? sync_locked?
+      alias shared? sync_shared?
+      alias exclusive? sync_exclusive?
+      alias lock sync_lock
+      alias unlock sync_unlock
+      alias try_lock sync_try_lock
+      alias synchronize sync_synchronize
+    }
+  end
+  
+  def Sync_m.append_features(cl)
+    super
+    # do nothing for Modules
+    # make aliases for Classes.
+    define_aliases(cl) unless cl.instance_of?(Module)
+    self
+  end
+  
+  def Sync_m.extend_object(obj)
+    super
+    obj.sync_extend
+  end
+  
+  def sync_extend
+    unless (defined? locked? and
+	    defined? shared? and
+	    defined? exclusive? and
+	    defined? lock and
+	    defined? unlock and
+	    defined? try_lock and
+	    defined? synchronize)
+      Sync_m.define_aliases(class<<self;self;end)
+    end
+    sync_initialize
+  end
+
+  # accessing
+  def sync_locked?
+    sync_mode != UN
+  end
+  
+  def sync_shared?
+    sync_mode == SH
+  end
+  
+  def sync_exclusive?
+    sync_mode == EX
+  end
+  
+  # locking methods.
+  def sync_try_lock(mode = EX)
+    return unlock if mode == UN
+    @sync_mutex.synchronize do
+      ret = sync_try_lock_sub(mode)
+    end
+    ret
+  end
+  
+  def sync_lock(m = EX)
+    return unlock if m == UN
+
+    while true
+      @sync_mutex.synchronize do
+	if sync_try_lock_sub(m)
+	  return self
+	else
+	  if sync_sh_locker[Thread.current]
+	    sync_upgrade_waiting.push [Thread.current, sync_sh_locker[Thread.current]]
+	    sync_sh_locker.delete(Thread.current)
+	  else
+	    sync_waiting.push Thread.current
+	  end
+	  @sync_mutex.sleep
+	end
+      end
+    end
+    self
+  end
+  
+  def sync_unlock(m = EX)
+    wakeup_threads = []
+    @sync_mutex.synchronize do
+      if sync_mode == UN
+	Err::UnknownLocker.Fail(Thread.current)
+      end
+      
+      m = sync_mode if m == EX and sync_mode == SH
+      
+      runnable = false
+      case m
+      when UN
+	Err::UnknownLocker.Fail(Thread.current)
+	
+      when EX
+	if sync_ex_locker == Thread.current
+	  if (self.sync_ex_count = sync_ex_count - 1) == 0
+	    self.sync_ex_locker = nil
+	    if sync_sh_locker.include?(Thread.current)
+	      self.sync_mode = SH
+	    else
+	      self.sync_mode = UN
+	    end
+	    runnable = true
+	  end
+	else
+	  Err::UnknownLocker.Fail(Thread.current)
+	end
+	
+      when SH
+	if (count = sync_sh_locker[Thread.current]).nil?
+	  Err::UnknownLocker.Fail(Thread.current)
+	else
+	  if (sync_sh_locker[Thread.current] = count - 1) == 0 
+	    sync_sh_locker.delete(Thread.current)
+	    if sync_sh_locker.empty? and sync_ex_count == 0
+	      self.sync_mode = UN
+	      runnable = true
+	    end
+	  end
+	end
+      end
+      
+      if runnable
+	if sync_upgrade_waiting.size > 0
+	  th, count = sync_upgrade_waiting.shift
+	  sync_sh_locker[th] = count
+	  th.wakeup
+	  wakeup_threads.push th
+	else
+	  wait = sync_waiting
+	  self.sync_waiting = []
+	  for th in wait
+	    th.wakeup
+	    wakeup_threads.push th
+	  end
+	end
+      end
+    end
+    for th in wakeup_threads
+      th.run
+    end
+    self
+  end
+  
+  def sync_synchronize(mode = EX)
+    sync_lock(mode)
+    begin
+      yield
+    ensure
+      sync_unlock
+    end
+  end
+
+  attr_accessor :sync_mode
+    
+  attr_accessor :sync_waiting
+  attr_accessor :sync_upgrade_waiting
+  attr_accessor :sync_sh_locker
+  attr_accessor :sync_ex_locker
+  attr_accessor :sync_ex_count
+
+  def sync_inspect
+    sync_iv = instance_variables.select{|iv| /^@sync_/ =~ iv.id2name}.collect{|iv| iv.id2name + '=' + instance_eval(iv.id2name).inspect}.join(",")
+    print "<#{self.class}.extend Sync_m: #{inspect}, <Sync_m: #{sync_iv}>"
+  end
+
+  private
+
+  def sync_initialize
+    @sync_mode = UN
+    @sync_waiting = []
+    @sync_upgrade_waiting = []
+    @sync_sh_locker = Hash.new
+    @sync_ex_locker = nil
+    @sync_ex_count = 0
+
+    @sync_mutex = Mutex.new
+  end
+
+  def initialize(*args)
+    super
+    sync_initialize
+  end
+    
+  def sync_try_lock_sub(m)
+    case m
+    when SH
+      case sync_mode
+      when UN
+	self.sync_mode = m
+	sync_sh_locker[Thread.current] = 1
+	ret = true
+      when SH
+	count = 0 unless count = sync_sh_locker[Thread.current]
+	sync_sh_locker[Thread.current] = count + 1
+	ret = true
+      when EX
+	# in EX mode, lock will upgrade to EX lock
+	if sync_ex_locker == Thread.current
+	  self.sync_ex_count = sync_ex_count + 1
+	  ret = true
+	else
+	  ret = false
+	end
+      end
+    when EX
+      if sync_mode == UN or
+	  sync_mode == SH && sync_sh_locker.size == 1 && sync_sh_locker.include?(Thread.current) 
+	self.sync_mode = m
+	self.sync_ex_locker = Thread.current
+	self.sync_ex_count = 1
+	ret = true
+      elsif sync_mode == EX && sync_ex_locker == Thread.current
+	self.sync_ex_count = sync_ex_count + 1
+	ret = true
+      else
+	ret = false
+      end
+    else
+      Err::LockModeFailer.Fail mode
+    end
+    return ret
+  end
+end
+Synchronizer_m = Sync_m
+
+class Sync
+  include Sync_m
+end
+Synchronizer = Sync