rubysl-monitor 2.0.0 → 2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7362242f7582618baaf408e9c8eb46b1bc5c85e2
-  data.tar.gz: bb1f3e3984987a4143417554aa7526e59b76d54e
+  metadata.gz: 58131016ac8f1dad3c38a2e60589dabbf189495e
+  data.tar.gz: ef3fd837b8753599ae54ec05b174ba8045bfbf8f
 SHA512:
-  metadata.gz: 9f7a6cca87b357fc057709c176dfb7c7104d6fca0e6c3b446c4768c6045933111f88aa54184726f75467d8b9d9c8a0df00b8dc4eacb41e833c2419046e98b1fa
-  data.tar.gz: 94bc9048a65ea57066ef16059b37aa07b1d973ba795da46693acdfe0d43fffc2b033b8ebfe6c0f23bc36d6105ad38c6271c94214bd5bee4f9df6ae3507e21aa2
+  metadata.gz: ca0bfdd83ac029c99a1806a2b7b8591341846dfe63fe998f8f35642771735f60da0a076c2e29ac42e276d4e6952ed12e2cdbb427027edd850255275c001684dd
+  data.tar.gz: ce649beccca122344d9387a09203ca412ec40a6b6fb73f9124a04cba9d91b42284e1f4cf91c55544a94fe3043a6a9543e0e9c5327a2ea8b50cdcc4a86cdfd5d7

data/.travis.yml

@@ -1,7 +1,14 @@
 language: ruby
 env:
   - RUBYLIB=lib
-script: bundle exec mspec
+  - RUBYLIB=
+script: mspec spec
 rvm:
-  - 1.9.3
-  - rbx-nightly-19mode
+  - 2.0.0
+  - rbx-2.2.1
+matrix:
+  exclude:
+    - rvm: 2.0.0
+      env: RUBYLIB=lib
+    - rvm: rbx-2.2.1
+      env: RUBYLIB=

data/MRI_LICENSE

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/lib/monitor.rb

@@ -1 +1,300 @@
-require "rubysl/monitor"
+# = monitor.rb
+#
+# Copyright (C) 2001  Shugo Maeda <shugo@ruby-lang.org>
+#
+# This library is distributed under the terms of the Ruby license.
+# You can freely distribute/modify this library.
+#
+
+require 'thread'
+
+#
+# In concurrent programming, a monitor is an object or module intended to be
+# used safely by more than one thread.  The defining characteristic of a
+# monitor is that its methods are executed with mutual exclusion.  That is, at
+# each point in time, at most one thread may be executing any of its methods.
+# This mutual exclusion greatly simplifies reasoning about the implementation
+# of monitors compared to reasoning about parallel code that updates a data
+# structure.
+#
+# You can read more about the general principles on the Wikipedia page for
+# Monitors[http://en.wikipedia.org/wiki/Monitor_%28synchronization%29]
+#
+# == Examples
+#
+# === Simple object.extend
+#
+#   require 'monitor.rb'
+#
+#   buf = []
+#   buf.extend(MonitorMixin)
+#   empty_cond = buf.new_cond
+#
+#   # consumer
+#   Thread.start do
+#     loop do
+#       buf.synchronize do
+#         empty_cond.wait_while { buf.empty? }
+#         print buf.shift
+#       end
+#     end
+#   end
+#
+#   # producer
+#   while line = ARGF.gets
+#     buf.synchronize do
+#       buf.push(line)
+#       empty_cond.signal
+#     end
+#   end
+#
+# The consumer thread waits for the producer thread to push a line to buf
+# while <tt>buf.empty?</tt>.  The producer thread (main thread) reads a
+# line from ARGF and pushes it into buf then calls <tt>empty_cond.signal</tt>
+# to notify the consumer thread of new data.
+#
+# === Simple Class include
+#
+#   require 'monitor'
+#
+#   class SynchronizedArray < Array
+#
+#     include MonitorMixin
+#
+#     def initialize(*args)
+#       super(*args)
+#     end
+#
+#     alias :old_shift :shift
+#     alias :old_unshift :unshift
+#
+#     def shift(n=1)
+#       self.synchronize do
+#         self.old_shift(n)
+#       end
+#     end
+#
+#     def unshift(item)
+#       self.synchronize do
+#         self.old_unshift(item)
+#       end
+#     end
+#
+#     # other methods ...
+#   end
+#
+# +SynchronizedArray+ implements an Array with synchronized access to items.
+# This Class is implemented as subclass of Array which includes the
+# MonitorMixin module.
+#
+module MonitorMixin
+  #
+  # FIXME: This isn't documented in Nutshell.
+  #
+  # Since MonitorMixin.new_cond returns a ConditionVariable, and the example
+  # above calls while_wait and signal, this class should be documented.
+  #
+  class ConditionVariable
+    class Timeout < Exception; end
+
+    #
+    # Releases the lock held in the associated monitor and waits; reacquires the lock on wakeup.
+    #
+    # If +timeout+ is given, this method returns after +timeout+ seconds passed,
+    # even if no other thread doesn't signal.
+    #
+    def wait(timeout = nil)
+      @monitor.__send__(:mon_check_owner)
+      count = @monitor.__send__(:mon_exit_for_cond)
+      begin
+        @cond.wait(@monitor.instance_variable_get(:@mon_mutex), timeout)
+        return true
+      ensure
+        @monitor.__send__(:mon_enter_for_cond, count)
+      end
+    end
+
+    #
+    # Calls wait repeatedly while the given block yields a truthy value.
+    #
+    def wait_while
+      while yield
+        wait
+      end
+    end
+
+    #
+    # Calls wait repeatedly until the given block yields a truthy value.
+    #
+    def wait_until
+      until yield
+        wait
+      end
+    end
+
+    #
+    # Wakes up the first thread in line waiting for this lock.
+    #
+    def signal
+      @monitor.__send__(:mon_check_owner)
+      @cond.signal
+    end
+
+    #
+    # Wakes up all threads waiting for this lock.
+    #
+    def broadcast
+      @monitor.__send__(:mon_check_owner)
+      @cond.broadcast
+    end
+
+    private
+
+    def initialize(monitor)
+      @monitor = monitor
+      @cond = ::ConditionVariable.new
+    end
+  end
+
+  def self.extend_object(obj)
+    super(obj)
+    obj.__send__(:mon_initialize)
+  end
+
+  #
+  # Attempts to enter exclusive section.  Returns +false+ if lock fails.
+  #
+  def mon_try_enter
+    if @mon_owner != Thread.current
+      unless @mon_mutex.try_lock
+        return false
+      end
+      @mon_owner = Thread.current
+    end
+    @mon_count += 1
+    return true
+  end
+  # For backward compatibility
+  alias try_mon_enter mon_try_enter
+
+  #
+  # Enters exclusive section.
+  #
+  def mon_enter
+    if @mon_owner != Thread.current
+      @mon_mutex.lock
+      @mon_owner = Thread.current
+    end
+    @mon_count += 1
+  end
+
+  #
+  # Leaves exclusive section.
+  #
+  def mon_exit
+    mon_check_owner
+    @mon_count -=1
+    if @mon_count == 0
+      @mon_owner = nil
+      @mon_mutex.unlock
+    end
+  end
+
+  #
+  # Enters exclusive section and executes the block.  Leaves the exclusive
+  # section automatically when the block exits.  See example under
+  # +MonitorMixin+.
+  #
+  def mon_synchronize
+    mon_enter
+    begin
+      yield
+    ensure
+      mon_exit
+    end
+  end
+  alias synchronize mon_synchronize
+
+  #
+  # Creates a new MonitorMixin::ConditionVariable associated with the
+  # receiver.
+  #
+  def new_cond
+    return ConditionVariable.new(self)
+  end
+
+  private
+
+  # Use <tt>extend MonitorMixin</tt> or <tt>include MonitorMixin</tt> instead
+  # of this constructor.  Have look at the examples above to understand how to
+  # use this module.
+  def initialize(*args)
+    super
+    mon_initialize
+  end
+
+  # Initializes the MonitorMixin after being included in a class or when an
+  # object has been extended with the MonitorMixin
+  def mon_initialize
+    @mon_owner = nil
+    @mon_count = 0
+    @mon_mutex = Mutex.new
+  end
+
+  def mon_check_owner
+    if @mon_owner != Thread.current
+      raise ThreadError, "current thread not owner"
+    end
+  end
+
+  def mon_enter_for_cond(count)
+    @mon_owner = Thread.current
+    @mon_count = count
+  end
+
+  def mon_exit_for_cond
+    count = @mon_count
+    @mon_owner = nil
+    @mon_count = 0
+    return count
+  end
+end
+
+# Use the Monitor class when you want to have a lock object for blocks with
+# mutual exclusion.
+#
+#   require 'monitor'
+#
+#   lock = Monitor.new
+#   lock.synchronize do
+#     # exclusive access
+#   end
+#
+class Monitor
+  include MonitorMixin
+  alias try_enter try_mon_enter
+  alias enter mon_enter
+  alias exit mon_exit
+end
+
+
+# Documentation comments:
+#  - All documentation comes from Nutshell.
+#  - MonitorMixin.new_cond appears in the example, but is not documented in
+#    Nutshell.
+#  - All the internals (internal modules Accessible and Initializable, class
+#    ConditionVariable) appear in RDoc.  It might be good to hide them, by
+#    making them private, or marking them :nodoc:, etc.
+#  - RDoc doesn't recognise aliases, so we have mon_synchronize documented, but
+#    not synchronize.
+#  - mon_owner is in Nutshell, but appears as an accessor in a separate module
+#    here, so is hard/impossible to RDoc.  Some other useful accessors
+#    (mon_count and some queue stuff) are also in this module, and don't appear
+#    directly in the RDoc output.
+#  - in short, it may be worth changing the code layout in this file to make the
+#    documentation easier
+
+# Local variables:
+# mode: Ruby
+# tab-width: 8
+# End:

data/lib/rubysl/monitor.rb

@@ -1,2 +1,3 @@
 require "rubysl/monitor/version"
 require "rubysl/monitor/monitor"
+require "monitor"

data/lib/rubysl/monitor/version.rb

@@ -1,5 +1,5 @@
 module RubySL
   module Monitor
-    VERSION = "2.0.0"
+    VERSION = "2.1"
   end
 end

data/rubysl-monitor.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "rubysl-prettyprint", "~> 2.0"
 end

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: rubysl-monitor
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: '2.1'
 platform: ruby
 authors:
 - Brian Shirai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-17 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: mspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubysl-prettyprint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Ruby standard library Monitor.
 email:
 - brixen@gmail.com
@@ -59,15 +73,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
+- MRI_LICENSE
 - README.md
 - Rakefile
 - lib/monitor.rb
 - lib/rubysl/monitor.rb
-- lib/rubysl/monitor/monitor.rb
 - lib/rubysl/monitor/version.rb
 - rubysl-monitor.gemspec
 homepage: https://github.com/rubysl/rubysl-monitor
@@ -80,17 +94,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby standard library Monitor.

data/lib/rubysl/monitor/monitor.rb

@@ -1,300 +0,0 @@
-# = monitor.rb
-#
-# Copyright (C) 2001  Shugo Maeda <shugo@ruby-lang.org>
-#
-# This library is distributed under the terms of the Ruby license.
-# You can freely distribute/modify this library.
-#
-
-require 'thread'
-
-#
-# In concurrent programming, a monitor is an object or module intended to be
-# used safely by more than one thread.  The defining characteristic of a
-# monitor is that its methods are executed with mutual exclusion.  That is, at
-# each point in time, at most one thread may be executing any of its methods.
-# This mutual exclusion greatly simplifies reasoning about the implementation
-# of monitors compared to reasoning about parallel code that updates a data
-# structure.
-#
-# You can read more about the general principles on the Wikipedia page for
-# Monitors[http://en.wikipedia.org/wiki/Monitor_%28synchronization%29]
-#
-# == Examples
-#
-# === Simple object.extend
-#
-#   require 'monitor.rb'
-#
-#   buf = []
-#   buf.extend(MonitorMixin)
-#   empty_cond = buf.new_cond
-#
-#   # consumer
-#   Thread.start do
-#     loop do
-#       buf.synchronize do
-#         empty_cond.wait_while { buf.empty? }
-#         print buf.shift
-#       end
-#     end
-#   end
-#
-#   # producer
-#   while line = ARGF.gets
-#     buf.synchronize do
-#       buf.push(line)
-#       empty_cond.signal
-#     end
-#   end
-#
-# The consumer thread waits for the producer thread to push a line to buf
-# while <tt>buf.empty?</tt>.  The producer thread (main thread) reads a
-# line from ARGF and pushes it into buf then calls <tt>empty_cond.signal</tt>
-# to notify the consumer thread of new data.
-#
-# === Simple Class include
-#
-#   require 'monitor'
-#
-#   class SynchronizedArray < Array
-#
-#     include MonitorMixin
-#
-#     def initialize(*args)
-#       super(*args)
-#     end
-#
-#     alias :old_shift :shift
-#     alias :old_unshift :unshift
-#
-#     def shift(n=1)
-#       self.synchronize do
-#         self.old_shift(n)
-#       end
-#     end
-#
-#     def unshift(item)
-#       self.synchronize do
-#         self.old_unshift(item)
-#       end
-#     end
-#
-#     # other methods ...
-#   end
-#
-# +SynchronizedArray+ implements an Array with synchronized access to items.
-# This Class is implemented as subclass of Array which includes the
-# MonitorMixin module.
-#
-module MonitorMixin
-  #
-  # FIXME: This isn't documented in Nutshell.
-  #
-  # Since MonitorMixin.new_cond returns a ConditionVariable, and the example
-  # above calls while_wait and signal, this class should be documented.
-  #
-  class ConditionVariable
-    class Timeout < Exception; end
-
-    #
-    # Releases the lock held in the associated monitor and waits; reacquires the lock on wakeup.
-    #
-    # If +timeout+ is given, this method returns after +timeout+ seconds passed,
-    # even if no other thread doesn't signal.
-    #
-    def wait(timeout = nil)
-      @monitor.__send__(:mon_check_owner)
-      count = @monitor.__send__(:mon_exit_for_cond)
-      begin
-        @cond.wait(@monitor.instance_variable_get(:@mon_mutex), timeout)
-        return true
-      ensure
-        @monitor.__send__(:mon_enter_for_cond, count)
-      end
-    end
-
-    #
-    # Calls wait repeatedly while the given block yields a truthy value.
-    #
-    def wait_while
-      while yield
-        wait
-      end
-    end
-
-    #
-    # Calls wait repeatedly until the given block yields a truthy value.
-    #
-    def wait_until
-      until yield
-        wait
-      end
-    end
-
-    #
-    # Wakes up the first thread in line waiting for this lock.
-    #
-    def signal
-      @monitor.__send__(:mon_check_owner)
-      @cond.signal
-    end
-
-    #
-    # Wakes up all threads waiting for this lock.
-    #
-    def broadcast
-      @monitor.__send__(:mon_check_owner)
-      @cond.broadcast
-    end
-
-    private
-
-    def initialize(monitor)
-      @monitor = monitor
-      @cond = ::ConditionVariable.new
-    end
-  end
-
-  def self.extend_object(obj)
-    super(obj)
-    obj.__send__(:mon_initialize)
-  end
-
-  #
-  # Attempts to enter exclusive section.  Returns +false+ if lock fails.
-  #
-  def mon_try_enter
-    if @mon_owner != Thread.current
-      unless @mon_mutex.try_lock
-        return false
-      end
-      @mon_owner = Thread.current
-    end
-    @mon_count += 1
-    return true
-  end
-  # For backward compatibility
-  alias try_mon_enter mon_try_enter
-
-  #
-  # Enters exclusive section.
-  #
-  def mon_enter
-    if @mon_owner != Thread.current
-      @mon_mutex.lock
-      @mon_owner = Thread.current
-    end
-    @mon_count += 1
-  end
-
-  #
-  # Leaves exclusive section.
-  #
-  def mon_exit
-    mon_check_owner
-    @mon_count -=1
-    if @mon_count == 0
-      @mon_owner = nil
-      @mon_mutex.unlock
-    end
-  end
-
-  #
-  # Enters exclusive section and executes the block.  Leaves the exclusive
-  # section automatically when the block exits.  See example under
-  # +MonitorMixin+.
-  #
-  def mon_synchronize
-    mon_enter
-    begin
-      yield
-    ensure
-      mon_exit
-    end
-  end
-  alias synchronize mon_synchronize
-
-  #
-  # Creates a new MonitorMixin::ConditionVariable associated with the
-  # receiver.
-  #
-  def new_cond
-    return ConditionVariable.new(self)
-  end
-
-  private
-
-  # Use <tt>extend MonitorMixin</tt> or <tt>include MonitorMixin</tt> instead
-  # of this constructor.  Have look at the examples above to understand how to
-  # use this module.
-  def initialize(*args)
-    super
-    mon_initialize
-  end
-
-  # Initializes the MonitorMixin after being included in a class or when an
-  # object has been extended with the MonitorMixin
-  def mon_initialize
-    @mon_owner = nil
-    @mon_count = 0
-    @mon_mutex = Mutex.new
-  end
-
-  def mon_check_owner
-    if @mon_owner != Thread.current
-      raise ThreadError, "current thread not owner"
-    end
-  end
-
-  def mon_enter_for_cond(count)
-    @mon_owner = Thread.current
-    @mon_count = count
-  end
-
-  def mon_exit_for_cond
-    count = @mon_count
-    @mon_owner = nil
-    @mon_count = 0
-    return count
-  end
-end
-
-# Use the Monitor class when you want to have a lock object for blocks with
-# mutual exclusion.
-#
-#   require 'monitor'
-#
-#   lock = Monitor.new
-#   lock.synchronize do
-#     # exclusive access
-#   end
-#
-class Monitor
-  include MonitorMixin
-  alias try_enter try_mon_enter
-  alias enter mon_enter
-  alias exit mon_exit
-end
-
-
-# Documentation comments:
-#  - All documentation comes from Nutshell.
-#  - MonitorMixin.new_cond appears in the example, but is not documented in
-#    Nutshell.
-#  - All the internals (internal modules Accessible and Initializable, class
-#    ConditionVariable) appear in RDoc.  It might be good to hide them, by
-#    making them private, or marking them :nodoc:, etc.
-#  - RDoc doesn't recognise aliases, so we have mon_synchronize documented, but
-#    not synchronize.
-#  - mon_owner is in Nutshell, but appears as an accessor in a separate module
-#    here, so is hard/impossible to RDoc.  Some other useful accessors
-#    (mon_count and some queue stuff) are also in this module, and don't appear
-#    directly in the RDoc output.
-#  - in short, it may be worth changing the code layout in this file to make the
-#    documentation easier
-
-# Local variables:
-# mode: Ruby
-# tab-width: 8
-# End: