spnet 0.1.2 → 0.1.3

data/ChangeLog.rdoc

@@ -11,4 +11,11 @@ Updated to use hashmake 0.1.1 gem.
 * Update project files, including:
 ** Removing README.md so that YARD can run without needing the redcarpet gem.
 ** Removing unnecessary lines from .gitignore
-** Remove specific hashmake version in hashmake.gemspec
+** Remove specific hashmake version in hashmake.gemspec
+
+=== 0.1.3 / 2013-02-06
+
+Replace messages and message ports with more specific ports, like value ports and command ports, and use a base InPort and OutPort to share code for linking ports.
+Each kind of port can only connect to its opposite (e.g. SignaInPort to SignalOutPort).
+Instead of different messages for different actions, each kind of port will just have specific methods (e.g. SignalInPort#enqueue_values or ValueInPort#set_value).
+In Block, contain all InPort objects in @in_ports, and all OutPort objects in @out_ports.

data/README.rdoc

@@ -6,10 +6,16 @@
 
 == Description
 
-TODO: Description
+Provide infrastructure for forming processing networks.
 
 == Features
 
+Signal ports: Used to pass a stream of data through a block.
+
+Value ports: Used to get/set a value within a block (usually to control a parameter), with optional range limiting.
+
+Command ports: Used to trigger the execution a command within a block, with optional data as well.
+
 == Examples
 
   require 'spnet'

data/lib/spnet/block.rb

@@ -3,17 +3,15 @@ module SPNet
 class Block
   include Hashmake::HashMakeable
   
-  attr_reader :name, :signal_in_ports, :signal_out_ports, :message_in_ports, :message_out_ports
+  attr_reader :name, :in_ports, :out_ports
   
   DO_NOTHING = ->(){}
   
   HASHED_ARG_SPECS = [
     Hashmake::ArgSpec.new(:reqd => false, :key => :name, :type => String, :default => "UNNAMED"),
     Hashmake::ArgSpec.new(:reqd => false, :key => :algorithm, :type => Proc, :default => DO_NOTHING),
-    Hashmake::ArgSpec.new(:reqd => false, :key => :signal_in_ports, :type => SignalInPort, :array => true, :default => ->(){ Array.new } ),
-    Hashmake::ArgSpec.new(:reqd => false, :key => :signal_out_ports, :type => SignalOutPort, :array => true, :default => ->(){ Array.new }),
-    Hashmake::ArgSpec.new(:reqd => false, :key => :message_in_ports, :type => MessageInPort, :array => true, :default => ->(){ Array.new }),
-    Hashmake::ArgSpec.new(:reqd => false, :key => :message_out_ports, :type => MessageOutPort, :array => true, :default => ->(){ Array.new })
+    Hashmake::ArgSpec.new(:reqd => false, :key => :in_ports, :type => InPort, :array => true, :default => ->(){ Array.new } ),
+    Hashmake::ArgSpec.new(:reqd => false, :key => :out_ports, :type => OutPort, :array => true, :default => ->(){ Array.new }),
   ]
   
   def initialize args = {}
@@ -21,7 +19,7 @@ class Block
   end
   
   def find_ports name, ignore_case = true
-    matches = (@signal_in_ports + @signal_out_ports + @message_in_ports + @message_out_ports).select do |port|
+    matches = (@in_ports + @out_ports).select do |port|
       if ignore_case
         port.name.casecmp(name) == 0
       else

data/lib/spnet/in_port.rb

@@ -0,0 +1,29 @@
+require 'hashmake'
+
+module SPNet
+class InPort
+  
+  include Hashmake::HashMakeable
+    
+  ARG_SPECS = [
+    Hashmake::ArgSpec.new(:reqd => false, :key => :name, :type => String, :default => "UNNAMED"),
+    Hashmake::ArgSpec.new(:reqd => true, :key => :matching_port_class, :type => Class),
+  ]
+
+  attr_reader :name, :link
+  
+  def initialize args
+    hash_make InPort::ARG_SPECS, args
+    @link = nil
+  end
+  
+  def clear_link
+    @link = nil
+  end
+  
+  def set_link link
+    raise ArgumentError, "link #{link} is not a #{@matching_port_class}" unless link.is_a?(@matching_port_class)
+    @link = link
+  end
+end
+end

data/lib/spnet/out_port.rb

@@ -0,0 +1,64 @@
+require 'set'
+require 'hashmake'
+
+module SPNet
+class OutPort
+
+  include Hashmake::HashMakeable
+  
+  ARG_SPECS = [
+    Hashmake::ArgSpec.new(:reqd => false, :key => :name, :type => String, :default => "UNNAMED"),
+    Hashmake::ArgSpec.new(:reqd => true, :key => :matching_port_class, :type => Class),
+  ]
+
+  attr_reader :name, :links
+
+  def initialize hashed_args = {}
+    hash_make OutPort::ARG_SPECS, hashed_args
+    @links = Set.new
+  end
+  
+  def add_link link
+    raise ArgumentError, "link #{link} is not a #{@matching_port_class}" unless link.is_a?(@matching_port_class)
+    raise ArgumentError, "link #{link} is already linked" if link.link
+    @links.add link
+    link.set_link self
+  end
+  
+  def remove_link link
+    raise ArgumentError, "@links does not include link #{link}" unless @links.include? link
+    @links.delete link
+    link.clear_link
+  end
+  
+  def remove_bad_links
+    find_bad_links_and :remove
+  end
+  
+  def correct_bad_links
+    find_bad_links_and :correct
+  end
+  
+  private
+  
+  def find_bad_links_and action
+    marked = []
+    
+    @links.each do |link|
+      bad = (link.link == nil) or (link.link != self)
+      if bad
+        marked.push link
+      end
+    end
+    
+    marked.each do |link|
+      if action == :remove
+        @links.delete link
+      elsif action == :correct
+        link.set_link self
+      end
+    end
+  end
+
+end
+end

data/lib/spnet/ports/command_in_port.rb

@@ -0,0 +1,27 @@
+require 'hashmake'
+
+module SPNet
+class CommandInPort < InPort
+  
+  include Hashmake::HashMakeable
+
+  ARG_SPECS = [
+    Hashmake::ArgSpec.new(:key => :list_commands_handler, :reqd => true, :type => Proc),
+    Hashmake::ArgSpec.new(:key => :exec_command_handler, :reqd => true, :type => Proc)
+  ]
+
+  def initialize hashed_args
+    hash_make(CommandInPort::ARG_SPECS, hashed_args)
+    hashed_args.merge!(:matching_port_class => CommandOutPort)
+    super(hashed_args)
+  end
+  
+  def list_commands
+    @list_commands_handler.call
+  end
+  
+  def exec_command command, data
+    @exec_command_handler.call command, data
+  end  
+end
+end

data/lib/spnet/ports/command_out_port.rb

@@ -0,0 +1,26 @@
+module SPNet
+class CommandOutPort < OutPort
+
+  def initialize hashed_args = {}
+    hashed_args.merge!(:matching_port_class => CommandInPort)
+    super(hashed_args)
+  end
+  
+  def list_commands
+    rvs = []
+    @links.each do |link|
+      rvs.push link.list_commands
+    end
+    return rvs
+  end
+
+  def exec_command command, data = nil
+    rvs = []
+    @links.each do |link|
+      rvs.push link.exec_command(command, data)
+    end
+    return rvs
+  end
+
+end
+end

data/lib/spnet/ports/signal_in_port.rb

@@ -0,0 +1,43 @@
+require 'hashmake'
+require 'spcore'
+
+module SPNet
+class SignalInPort < InPort
+
+  include Hashmake::HashMakeable
+  
+  DEFAULT_LIMITS = (-Float::MAX..Float::MAX)
+  
+  ARG_SPECS = [
+    Hashmake::ArgSpec.new(:reqd => false, :key => :limits, :type => Range, :default => DEFAULT_LIMITS)
+  ]
+  
+  attr_reader :limits, :queue
+
+  def initialize hashed_args = {}
+    hash_make(SignalInPort::ARG_SPECS, hashed_args)
+    @queue = []
+    @skip_limiting = (@limits == DEFAULT_LIMITS)
+    @limiter = SPCore::Limiters.make_range_limiter @limits
+
+    hashed_args.merge!(:matching_port_class => SignalOutPort)
+    super(hashed_args)
+  end
+
+  def enqueue_values values
+    unless @skip_limiting
+      for i in 0...values.count
+        values[i] = @limiter.call(values[i])
+      end
+    end
+    
+    @queue.concat values
+  end
+  
+  def dequeue_values count = @queue.count
+    raise ArgumentError, "count is greater than @queue.count" if count > @queue.count
+    @queue.slice!(0...count)
+  end
+  
+end
+end

data/lib/spnet/ports/signal_out_port.rb

@@ -0,0 +1,18 @@
+require 'set'
+
+module SPNet
+class SignalOutPort < OutPort
+
+  def initialize hashed_args = {}
+    hashed_args.merge!(:matching_port_class => SignalInPort)
+    super(hashed_args)
+  end
+  
+  def send_values values
+    @links.each do |link|
+      link.enqueue_values values
+    end
+  end
+
+end
+end

data/lib/spnet/ports/value_in_port.rb

@@ -0,0 +1,27 @@
+require 'hashmake'
+
+module SPNet
+class ValueInPort < InPort
+  
+  include Hashmake::HashMakeable
+
+  ARG_SPECS = [
+    Hashmake::ArgSpec.new(:key => :get_value_handler, :reqd => true, :type => Proc),
+    Hashmake::ArgSpec.new(:key => :set_value_handler, :reqd => true, :type => Proc)
+  ]
+
+  def initialize hashed_args = {}
+    hash_make(ValueInPort::ARG_SPECS, hashed_args)
+    hashed_args.merge!(:matching_port_class => ValueOutPort)
+    super(hashed_args)
+  end
+  
+  def set_value value
+    @set_value_handler.call value
+  end
+  
+  def get_value
+    @get_value_handler.call
+  end
+end
+end

data/lib/spnet/ports/value_out_port.rb

@@ -0,0 +1,28 @@
+require 'set'
+
+module SPNet
+class ValueOutPort < OutPort
+
+  def initialize hashed_args = {}
+    hashed_args.merge!(:matching_port_class => ValueInPort)
+    super(hashed_args)
+  end
+  
+  def set_value value
+    rvs = []
+    @links.each do |link|
+      rvs.push link.set_value value
+    end
+    return rvs
+  end
+
+  def get_value
+    rvs = []
+    @links.each do |link|
+      rvs.push link.get_value
+    end
+    return rvs
+  end
+
+end
+end

data/lib/spnet/version.rb

@@ -1,4 +1,4 @@
 module SPNet
   # spnet version
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/spnet.rb

@@ -1,9 +1,11 @@
 require 'spnet/version'
-
-require 'spnet/signal_in_port'
-require 'spnet/signal_out_port'
-require 'spnet/message'
-require 'spnet/control_message'
-require 'spnet/message_in_port'
-require 'spnet/message_out_port'
+require 'spnet/in_port'
+require 'spnet/out_port'
 require 'spnet/block'
+
+require 'spnet/ports/signal_in_port'
+require 'spnet/ports/signal_out_port'
+require 'spnet/ports/value_in_port'
+require 'spnet/ports/value_out_port'
+require 'spnet/ports/command_in_port'
+require 'spnet/ports/command_out_port'

data/spec/block_spec.rb

@@ -8,30 +8,30 @@ describe SPNet::Block do
       end
       
       it 'should have no input ports' do
-        @block.signal_in_ports.should be_empty
+        @block.in_ports.should be_empty
       end
 
       it 'should have no output ports' do
-        @block.signal_out_ports.should be_empty
+        @block.out_ports.should be_empty
       end
     end
     
-    context '1 signal in and 1 signal out port given' do
+    context '1 in and 1 out port given' do
       before :all do
         @block = SPNet::Block.new(
-          :signal_in_ports => [SPNet::SignalInPort.new(:name => "IN")],
-          :signal_out_ports => [SPNet::SignalOutPort.new(:name => "OUT")],
+          :in_ports => [SPNet::SignalInPort.new(:name => "IN")],
+          :out_ports => [SPNet::SignalOutPort.new(:name => "OUT")],
         )
       end
       
-      it 'should have no input ports' do
-        @block.signal_in_ports.count.should be 1
-        @block.signal_in_ports.first.name.should eq("IN")
+      it 'should have 1 input port' do
+        @block.in_ports.count.should be 1
+        @block.in_ports.first.name.should eq("IN")
       end
 
-      it 'should have no output ports' do
-        @block.signal_out_ports.count.should be 1
-        @block.signal_out_ports.first.name.should eq("OUT")
+      it 'should have 1 output port' do
+        @block.out_ports.count.should be 1
+        @block.out_ports.first.name.should eq("OUT")
       end      
     end
   end

data/spec/in_port_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe SPNet::InPort do
+  describe '.new' do
+    it 'should not have any links' do
+      port = SPNet::InPort.new :matching_port_class => SPNet::OutPort
+      port.link.should be_nil
+    end
+  end
+
+  describe '#set_link' do
+    it 'should set link to given OutPort' do
+      in_port = SPNet::InPort.new :matching_port_class => SPNet::OutPort
+      out_port = SPNet::OutPort.new :matching_port_class => SPNet::InPort
+      in_port.set_link out_port
+      in_port.link.should eq(out_port)
+    end
+  end
+  
+  describe '#clear_link' do
+    it 'should set link to given OutPort' do
+      in_port = SPNet::InPort.new :matching_port_class => SPNet::OutPort
+      out_port = SPNet::OutPort.new :matching_port_class => SPNet::InPort
+      in_port.set_link out_port
+      in_port.clear_link
+      in_port.link.should be_nil
+    end
+  end
+end

data/spec/{message_out_port_spec.rb → out_port_spec.rb}

@@ -1,21 +1,17 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe SPNet::MessageOutPort do
-  before :all do
-    processor = lambda do |message|
-      return message
-    end
-    @in_port = SPNet::MessageInPort.new :processor => processor, :message_type => SPNet::Message::CONTROL
-  end
-
+describe SPNet::OutPort do
   before :each do
-    processor = lambda do |message|
-      return message
-    end
-    @in_port = SPNet::MessageInPort.new :processor => processor, :message_type => SPNet::Message::CONTROL
-    @out_port = SPNet::MessageOutPort.new
+    @in_port = SPNet::InPort.new :matching_port_class => SPNet::OutPort
+    @out_port = SPNet::OutPort.new :matching_port_class => SPNet::InPort
   end
-
+  
+  describe '.new' do
+    it 'should have no links' do
+      @out_port.links.should be_empty
+    end    
+  end
+  
   describe '#add_link' do
     it 'should add the given input port to links' do
       @out_port.add_link @in_port
@@ -34,8 +30,8 @@ describe SPNet::MessageOutPort do
     end
     
     it 'should raise ArgumentError if port is not input port' do
-      @out_port2 = SPNet::MessageOutPort.new
-      lambda { @out_port.add_link(@out_port2) }.should raise_error(ArgumentError)
+      out_port2 = SPNet::OutPort.new :matching_port_class => SPNet::InPort
+      lambda { @out_port.add_link(out_port2) }.should raise_error(ArgumentError)
     end
   end
 
@@ -46,12 +42,5 @@ describe SPNet::MessageOutPort do
       @out_port.links.should be_empty
     end
   end
-  
-  describe '#send_message' do
-    it 'should pass the given message via recv_message to the processing callback' do
-      @out_port.add_link @in_port
-      rv = @out_port.send_message SPNet::ControlMessage.make_set_message(5)
-      rv.first.data.should eq(5)
-    end
-  end
+
 end

data/spec/ports/command_in_port_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::CommandInPort do
+  before :each do
+    @commands = ["add", "sub", "mul", "div"]
+
+    list_commands_handler = lambda { return @commands }
+
+    exec_command_handler = lambda do |command, data|
+      x = data[0]
+      y = data[1]
+      
+      case command
+      when "add"
+        return x + y
+      when "sub"
+        return x - y
+      when "mul"
+        return x * y
+      when "div"
+        return x / y
+      end
+    end
+    
+    @port = SPNet::CommandInPort.new :list_commands_handler => list_commands_handler, :exec_command_handler => exec_command_handler
+  end
+
+  describe '#list_commands' do
+    it 'should pass back the return value from the list_commands handler' do
+      @port.list_commands.should eq(@commands)
+    end
+  end
+  
+  describe '#exec_command' do
+    it 'should pass the command and data to the exec_command handler, and pass back the return value' do
+      @port.exec_command("add", [1,2]).should eq(3)
+      @port.exec_command("sub", [5,4]).should eq(1)
+      @port.exec_command("mul", [3,2]).should eq(6)
+      @port.exec_command("div", [9,3]).should eq(3)
+    end
+  end
+end

data/spec/ports/command_out_port_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::ValueOutPort do
+  before :each do
+    @commands = ["add", "sub", "mul", "div"]
+
+    list_commands_handler = lambda { return @commands }
+
+    exec_command_handler = lambda do |command, data|
+      x = data[0]
+      y = data[1]
+      
+      case command
+      when "add"
+        return x + y
+      when "sub"
+        return x - y
+      when "mul"
+        return x * y
+      when "div"
+        return x / y
+      end
+    end
+    
+    @in_port = SPNet::CommandInPort.new :list_commands_handler => list_commands_handler, :exec_command_handler => exec_command_handler
+    @out_port = SPNet::CommandOutPort.new
+  end
+
+  describe '#add_link' do
+    it 'should raise ArgumentError if port is not ValueInPort' do
+      @in_port2 = SPNet::SignalInPort.new
+      lambda { @out_port.add_link(@in_port2) }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe '#list_commands' do
+    it 'should pass back the return value from the list_commands handler' do
+      @out_port.add_link @in_port
+      @out_port.list_commands.should eq([@commands])
+    end
+  end
+  
+  describe '#exec_command' do
+    it 'should pass the command and data to the exec_command handler, and pass back the return value' do
+      @out_port.add_link @in_port
+      @out_port.exec_command("add", [1,2]).should eq([3])
+      @out_port.exec_command("sub", [5,4]).should eq([1])
+      @out_port.exec_command("mul", [3,2]).should eq([6])
+      @out_port.exec_command("div", [9,3]).should eq([3])
+    end
+  end
+
+end

data/spec/{signal_in_port_spec.rb → ports/signal_in_port_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe SPNet::SignalInPort do
   describe '.new' do

data/spec/{signal_out_port_spec.rb → ports/signal_out_port_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe SPNet::SignalOutPort do
   before :each do
@@ -6,44 +6,13 @@ describe SPNet::SignalOutPort do
     @in_port = SPNet::SignalInPort.new
   end
   
-  describe '.new' do
-    it 'should have no links' do
-      @out_port = SPNet::SignalOutPort.new
-      @out_port.links.should be_empty
-    end    
-  end
-  
-  describe '#add_link' do
-    it 'should add the given input port to links' do
-      @out_port.add_link @in_port
-      @out_port.links.count.should be 1
-      @out_port.links.first.should eq(@in_port)
-    end
-
-    it 'should also link the output port to the given input port' do
-      @out_port.add_link @in_port
-      @in_port.link.should eq(@out_port)
-    end
-
-    it 'should raise ArgumentError if the given input port is already linked' do
-      @out_port.add_link @in_port
-      lambda { @out_port.add_link(@in_port) }.should raise_error(ArgumentError)
-    end
-    
+  describe '#add_link' do    
     it 'should raise ArgumentError if port is not input port' do
       out_port2 = SPNet::SignalOutPort.new
       lambda { @out_port.add_link(out_port2) }.should raise_error(ArgumentError)
     end
   end
 
-  describe '#remove_link' do
-    it 'should remove the given input port (if it is already linked to the output port)' do
-      @out_port.add_link @in_port
-      @out_port.remove_link @in_port
-      @out_port.links.should be_empty
-    end
-  end
-
   describe '#send_values' do
     context 'single linked input port' do
       it 'should enqueue the values on the linked input port' do

data/spec/ports/value_in_port_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::ValueInPort do
+  before :each do
+    @value = 0
+    
+    set_value_handler = lambda do |value|
+      return @value = value
+    end
+    
+    get_value_handler = lambda do
+      return @value
+    end
+    
+    @port = SPNet::ValueInPort.new :get_value_handler => get_value_handler, :set_value_handler => set_value_handler
+  end
+
+  describe '#set_value' do
+    it 'should pass the given value through the set_value handler' do
+      rv = @port.set_value 5
+      @value.should eq(5)
+    end
+  end
+  
+  describe '#get_value' do
+    it 'should return the value from the get_value handler' do
+      @value = 7
+      @port.get_value.should eq(7)
+    end
+  end
+end

data/spec/ports/value_out_port_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::ValueOutPort do
+  before :each do
+    @value = 0
+    
+    set_value_handler = lambda do |value|
+      return @value = value
+    end
+    
+    get_value_handler = lambda do
+      return @value
+    end
+    
+    @out_port = SPNet::ValueOutPort.new
+    @in_port = SPNet::ValueInPort.new :get_value_handler => get_value_handler, :set_value_handler => set_value_handler
+  end
+
+  describe '#add_link' do
+    it 'should raise ArgumentError if port is not ValueInPort' do
+      @in_port2 = SPNet::SignalInPort.new
+      lambda { @out_port.add_link(@in_port2) }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe '#set_value' do
+    it 'should pass the given value through ValueInPort#set_value' do
+      @out_port.add_link @in_port
+      rv = @out_port.set_value 5
+      @value.should eq(5)
+    end
+  end
+  
+  describe '#get_value' do
+    it "should return the value from each linked port's ValueInPort#get_value" do
+      @value = 7
+      @out_port.add_link @in_port
+      @out_port.get_value.first.should eq(7)
+    end
+  end
+end

data/spnet.gemspec

@@ -20,6 +20,7 @@ DESCRIPTION
   gem.require_paths = ['lib']
 
   gem.add_dependency 'hashmake'
+  gem.add_dependency 'spcore'
 
   gem.add_development_dependency 'bundler', '~> 1.0'
   gem.add_development_dependency 'rake', '~> 0.8'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spnet
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashmake
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: spcore
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -126,22 +142,26 @@ files:
 - Rakefile
 - lib/spnet.rb
 - lib/spnet/block.rb
-- lib/spnet/control_message.rb
-- lib/spnet/message.rb
-- lib/spnet/message_in_port.rb
-- lib/spnet/message_out_port.rb
-- lib/spnet/signal_in_port.rb
-- lib/spnet/signal_out_port.rb
+- lib/spnet/in_port.rb
+- lib/spnet/out_port.rb
+- lib/spnet/ports/command_in_port.rb
+- lib/spnet/ports/command_out_port.rb
+- lib/spnet/ports/signal_in_port.rb
+- lib/spnet/ports/signal_out_port.rb
+- lib/spnet/ports/value_in_port.rb
+- lib/spnet/ports/value_out_port.rb
 - lib/spnet/version.rb
 - spec/block_spec.rb
-- spec/control_message_spec.rb
-- spec/message_in_port_spec.rb
-- spec/message_out_port_spec.rb
-- spec/message_spec.rb
-- spec/signal_in_port_spec.rb
-- spec/signal_out_port_spec.rb
+- spec/in_port_spec.rb
+- spec/out_port_spec.rb
+- spec/ports/command_in_port_spec.rb
+- spec/ports/command_out_port_spec.rb
+- spec/ports/signal_in_port_spec.rb
+- spec/ports/signal_out_port_spec.rb
+- spec/ports/value_in_port_spec.rb
+- spec/ports/value_out_port_spec.rb
 - spec/spec_helper.rb
-- spec/spnetwork_spec.rb
+- spec/spnet_spec.rb
 - spnet.gemspec
 homepage: https://rubygems.org/gems/spnet
 licenses:
@@ -158,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 402444883
+      hash: -270931181
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -167,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 402444883
+      hash: -270931181
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -176,12 +196,14 @@ specification_version: 3
 summary: Provide infrastructure for forming processing networks.
 test_files:
 - spec/block_spec.rb
-- spec/control_message_spec.rb
-- spec/message_in_port_spec.rb
-- spec/message_out_port_spec.rb
-- spec/message_spec.rb
-- spec/signal_in_port_spec.rb
-- spec/signal_out_port_spec.rb
+- spec/in_port_spec.rb
+- spec/out_port_spec.rb
+- spec/ports/command_in_port_spec.rb
+- spec/ports/command_out_port_spec.rb
+- spec/ports/signal_in_port_spec.rb
+- spec/ports/signal_out_port_spec.rb
+- spec/ports/value_in_port_spec.rb
+- spec/ports/value_out_port_spec.rb
 - spec/spec_helper.rb
-- spec/spnetwork_spec.rb
+- spec/spnet_spec.rb
 has_rdoc: 

data/lib/spnet/control_message.rb

@@ -1,52 +0,0 @@
-require 'hashmake'
-
-module SPNet
-class ControlMessage < Message
-
-  include Hashmake::HashMakeable
-  
-  GET = :controlMessageSubtypeGet
-  SET = :controlMessageSubtypeSet
-  
-  SUBTYPES = [
-    GET,
-    SET
-  ]
-  
-  HASHED_ARGS_SPECS = [
-    Hashmake::ArgSpec.new(:reqd => true, :key => :subtype, :type => Symbol, :validator => ->(a){ SUBTYPES.include?(a) } )
-  ]
-  
-  attr_reader :subtype
-  
-  def initialize hashed_args
-    hash_make ControlMessage::HASHED_ARGS_SPECS, hashed_args
-    super_hashed_args = hashed_args.merge! :type => Message::CONTROL
-    super(super_hashed_args)
-  end
-  
-  def self.make_handler get_handler, set_handler
-    handler = lambda do |message|
-      raise ArgumentError, "message is not a ControlMessage" unless message.is_a?(ControlMessage)
-      
-      if message.subtype == GET
-        return get_handler.call message
-      elsif message.subtype == SET
-        return set_handler.call message
-      else
-        raise ArgumentError, "message subtype #{message.subtype} is not valid"
-      end
-      
-    end
-    return handler
-  end
-  
-  def self.make_set_message data
-    ControlMessage.new :subtype => SET, :data => data
-  end
-
-  def self.make_get_message
-    ControlMessage.new :subtype => GET
-  end
-end
-end

data/lib/spnet/message.rb

@@ -1,25 +0,0 @@
-require 'hashmake'
-
-module SPNet
-class Message
-  
-  include Hashmake::HashMakeable
-  
-  CONTROL = :messageTypeControl
-  COMMAND = :messageTypeCommand
-  
-  TYPES = [ CONTROL, COMMAND ]
-  
-  HASHED_ARGS_SPECS = [
-    Hashmake::ArgSpec.new(:reqd => true, :key => :type, :type => Symbol, :validator => ->(a){ TYPES.include?(a) } ),
-    Hashmake::ArgSpec.new(:reqd => false, :key => :data, :type => Object, :default => nil),
-  ]
-  
-  attr_accessor :data
-  attr_reader :type
-  
-  def initialize hashed_args = {}
-    hash_make Message::HASHED_ARGS_SPECS, hashed_args
-  end
-end
-end

data/lib/spnet/message_in_port.rb

@@ -1,43 +0,0 @@
-require 'hashmake'
-
-module SPNet
-class MessageInPort
-  include Hashmake::HashMakeable
-  
-  DEFAULT_VALIDATOR = ->(a){ true }
-  
-  ARG_SPECS = [
-    Hashmake::ArgSpec.new(:reqd => false, :key => :name, :type => String, :default => "UNNAMED"),
-    Hashmake::ArgSpec.new(:reqd => true, :key => :processor, :type => Proc),
-    Hashmake::ArgSpec.new(:reqd => true, :key => :message_type, :type => Symbol, :validator => ->(a){ Message::TYPES.include?(a) })
-  ]
-  
-  attr_reader :name, :link
-  
-  def initialize args
-    hash_make MessageInPort::ARG_SPECS, args
-    @queue = []
-    @link = nil
-  end
-  
-  def recv_message message
-    raise ArgumentError, "message is not a Message" unless message.is_a?(Message)
-    if message.type == @message_type
-      return @processor.call(message)
-    else
-      raise ArgumentError, "message.type #{message.type} is not supported on this port"
-    end
-    
-  end
-  
-  def clear_link
-    @link = nil
-  end
-  
-  def set_link link
-    raise ArgumentError, "link #{link} is not a MessageOutPort" unless link.is_a?(MessageOutPort)
-    @link = link
-  end
-
-end
-end

data/lib/spnet/message_out_port.rb

@@ -1,56 +0,0 @@
-require 'set'
-require 'hashmake'
-
-module SPNet
-class MessageOutPort
-  include Hashmake::HashMakeable
-  
-  ARG_SPECS = [
-    Hashmake::ArgSpec.new(:reqd => false, :key => :name, :type => String, :default => "UNNAMED"),
-  ]
-  
-  attr_reader :name, :links
-  
-  def initialize args = {}
-    hash_make MessageOutPort::ARG_SPECS, args
-    @links = Set.new
-  end
-  
-  def send_message message
-    rvs = []
-    @links.each do |link|
-      rvs.push link.recv_message message
-    end
-    return rvs
-  end
-  
-  def add_link link
-    raise ArgumentError, "link #{link} is not a MessageInPort" unless link.is_a?(MessageInPort)
-    raise ArgumentError, "link #{link} is already linked to a MessageInPort" if link.link
-    @links.add link
-    link.set_link self
-  end
-  
-  def remove_link link
-    raise ArgumentError, "link #{link} is not a MessageInPort" unless link.is_a?(MessageInPort)
-    raise ArgumentError, "@links does not include link #{link}" unless @links.include? link
-    @links.delete link
-    link.clear_link
-  end
-  
-  def remove_bad_links
-    marked_for_removal = []
-    
-    @links.each do |link|
-      bad = (link.link == nil) or (link.link != self)
-      if bad
-        marked_for_removal.push link
-      end
-    end
-    
-    marked_for_removal.each do |link|
-      @links.delete link
-    end
-  end
-end
-end

data/lib/spnet/signal_in_port.rb

@@ -1,60 +0,0 @@
-require 'hashmake'
-
-module SPNet
-class SignalInPort
-  include Hashmake::HashMakeable
-  
-  DEFAULT_LIMITS = (-Float::MAX..Float::MAX)
-  
-  ARG_SPECS = [
-    Hashmake::ArgSpec.new(:reqd => false, :key => :name, :type => String, :default => "UNNAMED"),
-    Hashmake::ArgSpec.new(:reqd => false, :key => :limits, :type => Range, :default => DEFAULT_LIMITS)
-  ]
-  
-  attr_reader :name, :limits, :link, :queue
-  
-  def make_range_limiter range
-    return lambda do |input|
-      if input < range.first
-        return range.first
-      elsif input > range.last
-        return range.last
-      else
-        return input
-      end
-    end
-  end
-  
-  def initialize args = {}
-    hash_make SignalInPort::ARG_SPECS, args
-    @queue = []
-    @skip_limiting = (@limits == DEFAULT_LIMITS)
-    @limiter = make_range_limiter @limits
-    @link = nil
-  end
-  
-  def enqueue_values values
-    unless @skip_limiting
-      for i in 0...values.count
-        values[i] = @limiter.call(values[i])
-      end
-    end
-    
-    @queue.concat values
-  end
-  
-  def dequeue_values count = @queue.count
-    raise ArgumentError, "count is greater than @queue.count" if count > @queue.count
-    @queue.slice!(0...count)
-  end
-  
-  def clear_link
-    @link = nil
-  end
-  
-  def set_link link
-    raise ArgumentError, "link #{link} is not a SignalOutPort" unless link.is_a?(SignalOutPort)
-    @link = link
-  end
-end
-end

data/lib/spnet/signal_out_port.rb

@@ -1,54 +0,0 @@
-require 'set'
-require 'hashmake'
-
-module SPNet
-class SignalOutPort
-  include Hashmake::HashMakeable
-  
-  ARG_SPECS = [
-    Hashmake::ArgSpec.new(:reqd => false, :key => :name, :type => String, :default => "UNNAMED"),
-  ]
-  
-  attr_reader :name, :links
-  
-  def initialize args = {}
-    hash_make SignalOutPort::ARG_SPECS, args
-    @links = Set.new
-  end
-  
-  def send_values values
-    @links.each do |link|
-      link.enqueue_values values
-    end
-  end
-  
-  def add_link link
-    raise ArgumentError, "link #{link} is not a SignalInPort" unless link.is_a?(SignalInPort)
-    raise ArgumentError, "link #{link} is already linked to a SignalOutPort" if link.link
-    @links.add link
-    link.set_link self
-  end
-  
-  def remove_link link
-    raise ArgumentError, "link #{link} is not a SignalInPort" unless link.is_a?(SignalInPort)
-    raise ArgumentError, "@links does not include link #{link}" unless @links.include? link
-    @links.delete link
-    link.clear_link
-  end
-  
-  def remove_bad_links
-    marked_for_removal = []
-    
-    @links.each do |link|
-      bad = (link.link == nil) or (link.link != self)
-      if bad
-        marked_for_removal.push link
-      end
-    end
-    
-    marked_for_removal.each do |link|
-      @links.delete link
-    end
-  end
-end
-end

data/spec/control_message_spec.rb

@@ -1,40 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe SPNet::ControlMessage do
-  describe '.new' do
-    it 'should set type to Message::CONTROL' do
-      message = SPNet::ControlMessage.new :subtype => SPNet::ControlMessage::GET
-      message.type.should eq(SPNet::Message::CONTROL)
-    end
-    
-    it 'should ignore attempt to override type' do
-      message = SPNet::ControlMessage.new :subtype => SPNet::ControlMessage::GET, :type => :fakeType
-      message.type.should eq(SPNet::Message::CONTROL)
-    end
-    
-    it 'should allow data to be set' do
-      message = SPNet::ControlMessage.new :subtype => SPNet::ControlMessage::GET, :data => 17
-      message.data.should eq(17)
-    end
-  end
-  
-  describe '.make_set_message' do
-    it 'should set data' do
-      message = SPNet::ControlMessage.make_set_message 18
-      message.data.should eq(18)
-    end
-    
-    it 'should set subtype to ControlMessage::SET' do
-      message = SPNet::ControlMessage.make_set_message 18
-      message.subtype.should eq(SPNet::ControlMessage::SET)
-    end
-  end
-
-  describe '.make_get_message' do
-    it 'should set subtype to ControlMessage::GET' do
-      message = SPNet::ControlMessage.make_get_message
-      message.subtype.should eq(SPNet::ControlMessage::GET)
-    end
-  end
-
-end

data/spec/message_in_port_spec.rb

@@ -1,17 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe SPNet::MessageInPort do
-  describe '#recv_message' do
-    before :all do
-      processor = lambda do |message|
-        return message
-      end
-      @port = SPNet::MessageInPort.new :processor => processor, :message_type => SPNet::Message::CONTROL
-    end
-    
-    it 'should pass the given message to the processing callback' do
-      rv = @port.recv_message SPNet::ControlMessage.make_set_message(5)
-      rv.data.should eq(5)
-    end
-  end
-end

data/spec/message_spec.rb

@@ -1,11 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe SPNet::Message do
-  describe '.new' do
-    it 'should set data and type' do
-      message = SPNet::Message.new :type => SPNet::Message::CONTROL, :data => 9
-      message.type.should eq(SPNet::Message::CONTROL)
-      message.data.should eq(9)
-    end
-  end
-end