concurrent-ruby 0.2.0 → 0.2.1

data/lib/concurrent/thread_pool.rb

@@ -1,76 +1,76 @@
-require 'functional/behavior'
-
-require 'concurrent/event'
-require 'concurrent/utilities'
-
-behavior_info(:thread_pool,
-              running?: 0,
-              shutdown?: 0,
-              killed?: 0,
-              shutdown: 0,
-              kill: 0,
-              size: 0,
-              wait_for_termination: -1,
-              post: -1,
-              :<< => 1,
-              status: 0)
-
-behavior_info(:global_thread_pool,
-              post: -1,
-              :<< => 1)
-
-module Concurrent
-
-  class ThreadPool
-
-    def initialize
-      @status = :running
-      @queue = Queue.new
-      @termination = Event.new
-      @pool = []
-    end
-
-    def running?
-      return @status == :running
-    end
-
-    def shutdown?
-      return @status == :shutdown
-    end
-
-    def killed?
-      return @status == :killed
-    end
-
-    def shutdown
-      mutex.synchronize do
-        if @pool.empty?
-          @status = :shutdown
-        else
-          @status = :shuttingdown
-          @pool.size.times{ @queue << :stop }
-        end
-      end
-    end
-
-    def wait_for_termination(timeout = nil)
-      if shutdown? || killed?
-        return true
-      else
-        return @termination.wait(timeout)
-      end
-    end
-
-    def <<(block)
-      self.post(&block)
-      return self
-    end
-
-    protected
-
-    # @private
-    def mutex # :nodoc:
-      @mutex || Mutex.new
-    end
-  end
-end
+require 'functional/behavior'
+
+require 'concurrent/event'
+require 'concurrent/utilities'
+
+behavior_info(:thread_pool,
+              running?: 0,
+              shutdown?: 0,
+              killed?: 0,
+              shutdown: 0,
+              kill: 0,
+              size: 0,
+              wait_for_termination: -1,
+              post: -1,
+              :<< => 1,
+              status: 0)
+
+behavior_info(:global_thread_pool,
+              post: -1,
+              :<< => 1)
+
+module Concurrent
+
+  class ThreadPool
+
+    def initialize
+      @status = :running
+      @queue = Queue.new
+      @termination = Event.new
+      @pool = []
+    end
+
+    def running?
+      return @status == :running
+    end
+
+    def shutdown?
+      return @status == :shutdown
+    end
+
+    def killed?
+      return @status == :killed
+    end
+
+    def shutdown
+      mutex.synchronize do
+        if @pool.empty?
+          @status = :shutdown
+        else
+          @status = :shuttingdown
+          @pool.size.times{ @queue << :stop }
+        end
+      end
+    end
+
+    def wait_for_termination(timeout = nil)
+      if shutdown? || killed?
+        return true
+      else
+        return @termination.wait(timeout)
+      end
+    end
+
+    def <<(block)
+      self.post(&block)
+      return self
+    end
+
+    protected
+
+    # @private
+    def mutex # :nodoc:
+      @mutex || Mutex.new
+    end
+  end
+end

data/lib/concurrent/utilities.rb

@@ -1,32 +1,32 @@
-module Kernel
-
-  # Perform the given block as though it were an atomic operation. This means
-  # that the Ruby scheduler cannot premept the block and context switch to
-  # another thread. Basically a light wrapper around Ruby's Fiber class.
-  #
-  # @note Be very careful about what operations you perform within an atomic
-  # block. Blocking operations such as I/O should *never* occur within an
-  # atomic block. In those cases the entire Ruby VM will lock until the
-  # blocking operation is complete. This would be bad.
-  #
-  # @yield calls the block
-  # @yieldparam args an arbitrary set of block arguments
-  #
-  # @param [Array] zero more more optional arguments to pass to the block
-  def atomic(*args)
-    raise ArgumentError.new('no block given') unless block_given?
-    return Fiber.new {
-      yield(*args)
-    }.resume
-  end
-  module_function :atomic
-end
-
-class Mutex
-
-  def sync_with_timeout(timeout, &block)
-    Timeout::timeout(timeout) {
-      synchronize(&block)
-    }
-  end
-end
+module Kernel
+
+  # Perform the given block as though it were an atomic operation. This means
+  # that the Ruby scheduler cannot premept the block and context switch to
+  # another thread. Basically a light wrapper around Ruby's Fiber class.
+  #
+  # @note Be very careful about what operations you perform within an atomic
+  # block. Blocking operations such as I/O should *never* occur within an
+  # atomic block. In those cases the entire Ruby VM will lock until the
+  # blocking operation is complete. This would be bad.
+  #
+  # @yield calls the block
+  # @yieldparam args an arbitrary set of block arguments
+  #
+  # @param [Array] zero more more optional arguments to pass to the block
+  def atomic(*args)
+    raise ArgumentError.new('no block given') unless block_given?
+    return Fiber.new {
+      yield(*args)
+    }.resume
+  end
+  module_function :atomic
+end
+
+class Mutex
+
+  def sync_with_timeout(timeout, &block)
+    Timeout::timeout(timeout) {
+      synchronize(&block)
+    }
+  end
+end

data/lib/concurrent/version.rb

@@ -1,3 +1,3 @@
-module Concurrent
-  VERSION = '0.2.0'
-end
+module Concurrent
+  VERSION = '0.2.1'
+end

data/lib/concurrent_ruby.rb

@@ -1 +1 @@
-require 'concurrent'
+require 'concurrent'

data/md/agent.md

@@ -1,123 +1,123 @@
-# Secret Agent Man
-
-Agents are inspired by [Clojure's](http://clojure.org/) [agent](http://clojure.org/agents) keyword.
-An agent is a single atomic value that represents an identity. The current value
-of the agent can be requested at any time (`deref`). Each agent has a work queue and operates on
-the global thread pool (see below). Consumers can `post` code blocks to the
-agent. The code block (function) will receive the current value of the agent as its sole
-parameter. The return value of the block will become the new value of the agent. Agents support
-two error handling modes: fail and continue. A good example of an agent is a shared incrementing
-counter, such as the score in a video game.
-
-An agent must be initialize with an initial value. This value is always accessible via the `value`
-(or `deref`) methods. Code blocks sent to the agent will be processed in the order received. As
-each block is processed the current value is updated with the result from the block. This update
-is an atomic operation so a `deref` will never block and will always return the current value.
-
-When an agent is created it may be given an optional `validate` block and zero or more `rescue`
-blocks. When a new value is calculated the value will be checked against the validator, if present.
-If the validator returns `true` the new value will be accepted. If it returns `false` it will be
-rejected. If a block raises an exception during execution the list of `rescue` blocks will be
-seacrhed in order until one matching the current exception is found. That `rescue` block will
-then be called an passed the exception object. If no matching `rescue` block is found, or none
-were configured, then the exception will be suppressed.
-
-Agents also implement Ruby's [Observable](http://ruby-doc.org/stdlib-1.9.3/libdoc/observer/rdoc/Observable.html).
-Code that observes an agent will receive a callback with the new value any time the value
-is changed.
-
-## Examples
-
-A simple example:
-
-```ruby
-require 'concurrent'
-
-score = Concurrent::Agent.new(10)
-score.value #=> 10
-
-score << proc{|current| current + 100 }
-sleep(0.1)
-score.value #=> 110
-
-score << proc{|current| current * 2 }
-sleep(0.1)
-deref score #=> 220
-
-score << proc{|current| current - 50 }
-sleep(0.1)
-score.value #=> 170
-```
-
-With validation and error handling:
-
-```ruby
-score = agent(0).validate{|value| value <= 1024 }.
-          rescue(NoMethodError){|ex| puts "Bam!" }.
-          rescue(ArgumentError){|ex| puts "Pow!" }.
-          rescue{|ex| puts "Boom!" }
-score.value #=> 0
-
-score << proc{|current| current + 2048 }
-sleep(0.1)
-score.value #=> 0
-
-score << proc{|current| raise ArgumentError }
-sleep(0.1)
-#=> puts "Pow!"
-score.value #=> 0
-
-score << proc{|current| current + 100 }
-sleep(0.1)
-score.value #=> 100
-```
-
-With observation:
-
-```ruby
-bingo = Class.new{
-  def update(time, score)
-    puts "Bingo! [score: #{score}, time: #{time}]" if score >= 100
-  end
-}.new
-
-score = agent(0)
-score.add_observer(bingo)
-
-score << proc{|current| sleep(0.1); current += 30 }
-score << proc{|current| sleep(0.1); current += 30 }
-score << proc{|current| sleep(0.1); current += 30 }
-score << proc{|current| sleep(0.1); current += 30 }
-
-sleep(1)
-#=> Bingo! [score: 120, time: 2013-07-22 21:26:08 -0400]
-```
-
-## Copyright
-
-*Concurrent Ruby* is Copyright &copy; 2013 [Jerry D'Antonio](https://twitter.com/jerrydantonio).
-It is free software and may be redistributed under the terms specified in the LICENSE file.
-
-## License
-
-Released under the MIT license.
-
-http://www.opensource.org/licenses/mit-license.php  
-
-> Permission is hereby granted, free of charge, to any person obtaining a copy  
-> of this software and associated documentation files (the "Software"), to deal  
-> in the Software without restriction, including without limitation the rights  
-> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell  
-> copies of the Software, and to permit persons to whom the Software is  
-> furnished to do so, subject to the following conditions:  
-> 
-> The above copyright notice and this permission notice shall be included in  
-> all copies or substantial portions of the Software.  
-> 
-> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR  
-> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  
-> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE  
-> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER  
-> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  
-> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN  
-> THE SOFTWARE.  
+# Secret Agent Man
+
+Agents are inspired by [Clojure's](http://clojure.org/) [agent](http://clojure.org/agents) keyword.
+An agent is a single atomic value that represents an identity. The current value
+of the agent can be requested at any time (`deref`). Each agent has a work queue and operates on
+the global thread pool (see below). Consumers can `post` code blocks to the
+agent. The code block (function) will receive the current value of the agent as its sole
+parameter. The return value of the block will become the new value of the agent. Agents support
+two error handling modes: fail and continue. A good example of an agent is a shared incrementing
+counter, such as the score in a video game.
+
+An agent must be initialize with an initial value. This value is always accessible via the `value`
+(or `deref`) methods. Code blocks sent to the agent will be processed in the order received. As
+each block is processed the current value is updated with the result from the block. This update
+is an atomic operation so a `deref` will never block and will always return the current value.
+
+When an agent is created it may be given an optional `validate` block and zero or more `rescue`
+blocks. When a new value is calculated the value will be checked against the validator, if present.
+If the validator returns `true` the new value will be accepted. If it returns `false` it will be
+rejected. If a block raises an exception during execution the list of `rescue` blocks will be
+seacrhed in order until one matching the current exception is found. That `rescue` block will
+then be called an passed the exception object. If no matching `rescue` block is found, or none
+were configured, then the exception will be suppressed.
+
+Agents also implement Ruby's [Observable](http://ruby-doc.org/stdlib-1.9.3/libdoc/observer/rdoc/Observable.html).
+Code that observes an agent will receive a callback with the new value any time the value
+is changed.
+
+## Examples
+
+A simple example:
+
+```ruby
+require 'concurrent'
+
+score = Concurrent::Agent.new(10)
+score.value #=> 10
+
+score << proc{|current| current + 100 }
+sleep(0.1)
+score.value #=> 110
+
+score << proc{|current| current * 2 }
+sleep(0.1)
+deref score #=> 220
+
+score << proc{|current| current - 50 }
+sleep(0.1)
+score.value #=> 170
+```
+
+With validation and error handling:
+
+```ruby
+score = agent(0).validate{|value| value <= 1024 }.
+          rescue(NoMethodError){|ex| puts "Bam!" }.
+          rescue(ArgumentError){|ex| puts "Pow!" }.
+          rescue{|ex| puts "Boom!" }
+score.value #=> 0
+
+score << proc{|current| current + 2048 }
+sleep(0.1)
+score.value #=> 0
+
+score << proc{|current| raise ArgumentError }
+sleep(0.1)
+#=> puts "Pow!"
+score.value #=> 0
+
+score << proc{|current| current + 100 }
+sleep(0.1)
+score.value #=> 100
+```
+
+With observation:
+
+```ruby
+bingo = Class.new{
+  def update(time, score)
+    puts "Bingo! [score: #{score}, time: #{time}]" if score >= 100
+  end
+}.new
+
+score = agent(0)
+score.add_observer(bingo)
+
+score << proc{|current| sleep(0.1); current += 30 }
+score << proc{|current| sleep(0.1); current += 30 }
+score << proc{|current| sleep(0.1); current += 30 }
+score << proc{|current| sleep(0.1); current += 30 }
+
+sleep(1)
+#=> Bingo! [score: 120, time: 2013-07-22 21:26:08 -0400]
+```
+
+## Copyright
+
+*Concurrent Ruby* is Copyright &copy; 2013 [Jerry D'Antonio](https://twitter.com/jerrydantonio).
+It is free software and may be redistributed under the terms specified in the LICENSE file.
+
+## License
+
+Released under the MIT license.
+
+http://www.opensource.org/licenses/mit-license.php  
+
+> Permission is hereby granted, free of charge, to any person obtaining a copy  
+> of this software and associated documentation files (the "Software"), to deal  
+> in the Software without restriction, including without limitation the rights  
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell  
+> copies of the Software, and to permit persons to whom the Software is  
+> furnished to do so, subject to the following conditions:  
+> 
+> The above copyright notice and this permission notice shall be included in  
+> all copies or substantial portions of the Software.  
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR  
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE  
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER  
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN  
+> THE SOFTWARE.