dataflow 0.2.1 → 0.3.0

data/HISTORY

@@ -1,4 +1,26 @@
-== trunk
+== 0.3.0 / 2009-08-29
+
+* Major enhancements
+ 
+  * "flow" abstraction for threading (use it to create threads and optionally 
+    pass it a variable to be bound output, or override it to modify need_later
+    for other threading strategies such as thread pools)
+
+  * Dataflow::FutureQueue
+
+  * Nested binding through variables possible
+ 
+* Minor enhancements
+  
+  * Better #inspect and UnificationError debugging output
+ 
+  * "barrier" abstraction for manually preventing execution until variable
+    arguments have been bound
+
+  * Use mixin methods as class/module methods optionally
+    e.g. Dataflow.local {|v| v }
+
+== 0.2.1 / 2009-07-29
 
  * Minor enhancements
    
@@ -21,8 +43,7 @@
  
 * Minor enhancements
  
-  * Got the "require_path" set correctly so rubygems can be used =)
- 
+  * Got the "require_path" set correctly so rubygems can be used =) 
 
 == 0.1.0 / 2009-06-13
  

data/dataflow.rb

@@ -1,7 +1,7 @@
 require 'monitor'
 
 module Dataflow
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
   
   def self.included(cls)
     class << cls
@@ -31,13 +31,26 @@ module Dataflow
     Variable.new &block
   end
 
+  def barrier(*variables)
+    variables.each{|v| v.__wait__ }
+  end
+
+  def flow(output=nil, &block)
+    Thread.new do
+      result = block.call
+      unify output, result if output
+    end
+  end
+
   def need_later(&block)
     local do |future|
-      Thread.new { unify future, block.call }
+      flow { unify future, block.call }
       future
     end
   end
 
+  extend self
+
   # Note that this class uses instance variables directly rather than nicely
   # initialized instance variables in get/set methods for memory and
   # performance reasons
@@ -53,7 +66,8 @@ module Dataflow
       LOCK.synchronize do
         __activate_trigger__ if @__trigger__
         if @__bound__
-          raise UnificationError if self != value
+          return @__value__.__unify__(value) if @__value__.__dataflow__? rescue nil
+          raise UnificationError, "#{@__value__.inspect} != #{value.inspect}" if self != value
         else
           @__value__ = value
           @__bound__ = true
@@ -70,10 +84,9 @@ module Dataflow
       @__trigger__ = nil # GC
     end
 
-    def method_missing(name, *args, &block)
+    def __wait__
       LOCK.synchronize do
-        unless @__bound__
-          return '#<Dataflow::Variable unbound>' if name == :inspect
+        unless @__bound__          
           if @__trigger__
             __activate_trigger__
           else
@@ -81,8 +94,17 @@ module Dataflow
           end
         end
       end unless @__bound__
+    end
+
+    def method_missing(name, *args, &block)
+      return "#<Dataflow::Variable:#{__id__} unbound>" if !@__bound__ && name == :inspect
+      __wait__
       @__value__.__send__(name, *args, &block)
     end
+
+    def __dataflow__?
+      true
+    end
   end
 
   UnificationError = Class.new StandardError
@@ -90,3 +112,4 @@ end
 
 require "#{File.dirname(__FILE__)}/dataflow/port"
 require "#{File.dirname(__FILE__)}/dataflow/actor"
+require "#{File.dirname(__FILE__)}/dataflow/future_queue"

data/dataflow/future_queue.rb

@@ -0,0 +1,24 @@
+module Dataflow
+  class FutureQueue
+    include Dataflow
+    declare :push_port, :pop_port
+    
+    def initialize
+      local do |pushed, popped|
+        unify push_port, Dataflow::Port.new(pushed)
+        unify pop_port, Dataflow::Port.new(popped)
+        
+        Thread.new {
+          loop do
+            barrier pushed.head, popped.head
+            unify popped.head, pushed.head
+            pushed, popped = pushed.tail, popped.tail
+          end
+        }
+      end
+    end
+
+    def push(x) push_port.send x end
+    def pop(x) pop_port.send x end
+  end
+end

data/spec/barrier_spec.rb

@@ -0,0 +1,25 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe 'A barrier' do
+  it 'waits for variables to be bound before continuing' do
+    local do |x, y, barrier_broken|
+      Thread.new do 
+        barrier x, y
+        unify barrier_broken, true
+      end
+      Thread.new { unify x, :x }
+      Thread.new { unify y, :y }
+      barrier_broken.should be_true
+    end
+  end
+
+  it 'continues for variables that are already bound' do
+    local do |x, y, barrier_broken|
+      unify x, :x
+      unify y, :y
+      barrier x, y
+      unify barrier_broken, true
+      barrier_broken.should be_true
+    end
+  end
+end

data/spec/dataflow_spec.rb

@@ -126,3 +126,26 @@ context 'Using "declare" for object-specific read-only attributes' do
     end
   end
 end
+
+describe 'Binding a variable that proxies through another' do
+  it 'binds through successfully' do
+    local do |x, y|
+      lambda do
+        unify x, y
+        unify x, 1337
+        x.should == 1337
+        y.should == 1337
+      end.should_not raise_error
+    end
+  end
+end
+
+describe 'Using static/module method' do
+  it 'works like the mixin versions' do
+    Dataflow.local do |big_cat, small_cat|
+      Thread.new { Dataflow.unify big_cat, small_cat.upcase }
+      Dataflow.unify small_cat, 'cat'
+      big_cat.should == 'CAT'
+    end
+  end
+end

data/spec/flow_spec.rb

@@ -0,0 +1,25 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe 'Using flow without a parameter' do
+  it 'works like normal threads' do
+    local do |big_cat, small_cat|
+      flow { unify big_cat, small_cat.upcase }
+      unify small_cat, 'cat'
+      big_cat.should == 'CAT'
+    end
+  end
+end
+
+describe 'Using flow with a parameter' do
+  it 'binds the parameter to the last line of the block' do
+    local do |big_cat, small_cat, output|
+      flow(output) do
+        unify big_cat, small_cat.upcase
+        'returned'
+      end
+      unify small_cat, 'cat'
+      big_cat.should == 'CAT'
+      output.should == 'returned'
+    end
+  end
+end

data/spec/future_queue_spec.rb

@@ -0,0 +1,31 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+
+describe 'A future queue' do
+  it 'accepts synchronous pushes and pops' do
+    local do |queue, first, second, third|
+      unify queue, Dataflow::FutureQueue.new
+      queue.pop first
+      queue.pop second
+      queue.push 1
+      queue.push 2
+      queue.push 3
+      queue.pop third  
+
+      [first, second, third].should == [1, 2, 3]
+    end
+  end
+
+  it 'accepts asynchronous pushes and pops' do
+    local do |queue, first, second, third|
+      unify queue, Dataflow::FutureQueue.new
+      Thread.new { queue.pop first }
+      Thread.new { queue.pop second }
+      Thread.new { queue.push 1 }
+      Thread.new { queue.push 2 }
+      Thread.new { queue.push 3 }
+      Thread.new { queue.pop third }
+
+      [first, second, third].sort.should == [1, 2, 3]
+    end
+  end
+end

data/spec/inspect_spec.rb

@@ -3,7 +3,7 @@ require "#{File.dirname(__FILE__)}/spec_helper"
 describe "An unbound variable" do
   it "should be inspectable for debugging purposes" do
     local do |unbound|
-      unbound.inspect.should == "#<Dataflow::Variable unbound>"
+      unbound.inspect.should =~ /#<Dataflow::Variable:[0-9]+ unbound>/
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dataflow
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Larry Diehl
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-30 00:00:00 -07:00
+date: 2009-08-29 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,7 @@ files:
 - dataflow.rb
 - dataflow/actor.rb
 - dataflow/equality.rb
+- dataflow/future_queue.rb
 - dataflow/port.rb
 - examples/data_driven.rb
 - examples/dataflow_http_gets.rb
@@ -68,9 +69,12 @@ specification_version: 2
 summary: Dataflow concurrency for Ruby (inspired by the Oz language)
 test_files: 
 - spec/actor_spec.rb
+- spec/barrier_spec.rb
 - spec/by_need_spec.rb
 - spec/dataflow_spec.rb
 - spec/equality_spec.rb
+- spec/flow_spec.rb
+- spec/future_queue_spec.rb
 - spec/inspect_spec.rb
 - spec/need_later_spec.rb
 - spec/port_spec.rb