spnet 0.1.4 → 0.1.5

data/spec/limiters/upper_limiter_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::UpperLimiter do  
+  describe '.apply_limit' do
+    context 'non-inclusive' do
+      before :all do
+        @upper = 1
+        @limiter = UpperLimiter.new(@upper, false)
+      end
+
+      it 'should return the given value it it is below the upper limit' do
+        ok_values = [@upper - Float::EPSILON, @upper / 2.0]
+        limited_values = ok_values.map { |value| @limiter.apply_limit value }
+        limited_values.should eq(ok_values)
+      end
+      
+      it 'should return the upper limit + Float::EPSILON if the given value is at or below the upper limit' do
+        bad_values = [@upper, @upper + Float::EPSILON, @upper * 2.0]
+        limited_values = bad_values.map { |value| @limiter.apply_limit value }
+        limited_values.each do |value|
+          value.should eq(@upper - Float::EPSILON)
+        end
+      end
+    end
+    
+    context 'inclusive upper limit, non-inclusive upper limit' do
+      before :all do
+        @upper = 1
+        @limiter = UpperLimiter.new(@upper, true)
+      end
+
+      it 'should return the given value it it is at or below the upper limit' do
+        ok_values = [@upper, @upper - Float::EPSILON, @upper / 2.0]
+        limited_values = ok_values.map { |value| @limiter.apply_limit value }
+        limited_values.should eq(ok_values)
+      end
+      
+      it 'should return the upper limit if the given value is below the upper limit' do
+        bad_values = [@upper + Float::EPSILON, @upper * 2.0]
+        limited_values = bad_values.map { |value| @limiter.apply_limit value }
+        limited_values.each do |value|
+          value.should eq(@upper)
+        end
+      end
+    end
+  end
+end

data/spec/ports/command_out_port_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe SPNet::ValueOutPort do
+describe SPNet::ParamOutPort do
   before :each do
     @in_port = SPNet::CommandInPort.new(
       :command_map => {
@@ -13,27 +13,20 @@ describe SPNet::ValueOutPort do
     @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([[:add, :sub, :mul, :div]])
+      @out_port.set_link Link.new(:from => @out_port, :to => @in_port)
+      @out_port.list_commands.should eq([:add, :sub, :mul, :div])
     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])
+      @out_port.set_link Link.new(:from => @out_port, :to => @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
 

data/spec/ports/{value_in_port_spec.rb → param_in_port_spec.rb}

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe SPNet::ValueInPort do
+describe SPNet::ParamInPort do
   before :each do
     @value = 0
     
@@ -12,7 +12,7 @@ describe SPNet::ValueInPort do
       return @value
     end
     
-    @port = SPNet::ValueInPort.new :get_value_handler => get_value_handler, :set_value_handler => set_value_handler
+    @port = SPNet::ParamInPort.new :get_value_handler => get_value_handler, :set_value_handler => set_value_handler
   end
 
   describe '#set_value' do

data/spec/ports/param_out_port_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::ParamOutPort 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::ParamOutPort.new
+    @in_port = SPNet::ParamInPort.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 ParamInPort#set_value' do
+      @out_port.set_link Link.new(:to => @in_port, :from => @out_port)
+      @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 ParamInPort#get_value" do
+      @value = 7
+      @out_port.set_link Link.new(:to => @in_port, :from => @out_port)
+      @out_port.get_value.should eq(7)
+    end
+  end
+end

data/spec/ports/signal_in_port_spec.rb

@@ -18,7 +18,8 @@ describe SPNet::SignalInPort do
     end
   
     it 'should limit all values before queuing them' do
-      port = SPNet::SignalInPort.new(:limits => (2.5..5.0))
+      limiter = RangeLimiter.new(2.5, true, 5.0, true)
+      port = SPNet::SignalInPort.new(:limiter => limiter)
       port.enqueue_values([2.4, 2.6, 4.9, 5.1])
       port.queue.each do |value|
         value.should be_between(2.5, 5.0)

data/spec/ports/signal_out_port_spec.rb

@@ -6,44 +6,13 @@ describe SPNet::SignalOutPort do
     @in_port = SPNet::SignalInPort.new
   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 '#send_values' do
-    context 'single linked input port' do
-      it 'should enqueue the values on the linked input port' do
-        @out_port.add_link @in_port
-        
-        @in_port.queue.should be_empty
-        @out_port.send_values [1,2,3,4]
-        @in_port.queue.should eq([1,2,3,4])      
-      end
-    end
-
-    context 'several linked input ports' do
-      it 'should enqueue the values on each linked input port' do
-        in_port1 = SPNet::SignalInPort.new
-        in_port2 = SPNet::SignalInPort.new(:name => 'def')
-        in_port3 = SPNet::SignalInPort.new(:name => 'ghi')
-        
-        @out_port.add_link in_port1
-        @out_port.add_link in_port2
-        @out_port.add_link in_port3
-        
-        in_port1.queue.should be_empty
-        in_port2.queue.should be_empty
-        in_port3.queue.should be_empty
-        
-        @out_port.send_values [1,2,3,4]
-        
-        in_port1.queue.should eq([1,2,3,4])
-        in_port2.queue.should eq([1,2,3,4])
-        in_port3.queue.should eq([1,2,3,4])
-      end
+    it 'should enqueue the values on the linked input port' do
+      @out_port.set_link Link.new(:to => @in_port, :from => @out_port)
+      
+      @in_port.queue.should be_empty
+      @out_port.send_values [1,2,3,4]
+      @in_port.queue.should eq([1,2,3,4])
     end
   end
 

data/spec/spec_helper.rb

@@ -2,3 +2,46 @@ require 'rspec'
 require 'spnet'
 
 include SPNet
+
+class TestBlock < Block
+  attr_reader :value1, :value2
+  
+  def initialize args
+    raise ArgumentError, "args does not have :sample_rate key" unless args.has_key?(:sample_rate)
+    
+    @value1 = 1
+    @value2 = 2
+    @command_history = []
+    
+    input = SignalInPort.new
+    output = SignalOutPort.new
+
+    value1 = ParamInPort.new(
+      :get_value_handler => ->(){ @value1 },
+      :set_value_handler => ->(a){ @value1 = a},
+    )
+
+    value2 = ParamInPort.new(
+      :get_value_handler => ->(){ @value2 },
+      :set_value_handler => ->(a){ @value2 = a},
+    )
+    
+    command = CommandInPort.new(
+      :command_map => {
+        "SIT" => ->(a){ @command_history.push("SIT") },
+        "STAY" => ->(a){ @command_history.push("STAY") }
+      }
+    )
+
+    pass_through = lambda do |count|
+      output.send_values input.dequeue_values(count)
+    end
+    
+    super(
+      :sample_rate => args[:sample_rate],
+      :algorithm => pass_through,
+      :in_ports => { "IN" => input, "VALUE1" => value1, "VALUE2" => value2, "COMMAND" => command },
+      :out_ports => { "OUT" => output }
+    )
+  end
+end

data/spec/storage/block_state_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::BlockState do
+  describe '.new' do
+    it 'should assign block class' do
+      block_state = BlockState.new :class_sym => :TestBlock
+      block_state.class_sym.should eq(:TestBlock)
+    end
+    
+    it 'should assign port params' do
+      params = {
+        "VALUE1" => 0.0,
+        "VALUE2" => 1.0,
+      }
+      block_state = BlockState.new :class_sym => :TestBlock, :port_params => params
+      block_state.port_params.should eq(params)
+    end
+  end
+  
+  describe '#make_block' do
+    before :all do
+      @params = {
+        "VALUE1" => 0.1,
+        "VALUE2" => 0.9,
+      }
+      @class_sym = :TestBlock
+      block_state = BlockState.new :class_sym => @class_sym, :port_params => @params
+      @block = block_state.make_block :sample_rate => 2
+    end
+    
+    it 'should make a block of the given class type' do
+      @block.class.to_s.to_sym.should eq(@class_sym)
+    end
+
+    it 'should make a block using given port params' do
+      @block.value1.should eq(@params["VALUE1"])
+      @block.value2.should eq(@params["VALUE2"])
+    end
+  end
+end

data/spec/storage/link_state_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::LinkState do
+  describe '.new' do
+    it 'should assign from and to port locaters' do
+      output = PortLocater.new :block_name => "block_A", :port_name => "OUT"
+      input = PortLocater.new :block_name => "block_B", :port_name => "IN"
+      link_state = LinkState.new :from => output, :to => input
+      link_state.from.should eq(output)
+      link_state.to.should eq(input)
+    end
+  end
+  
+  describe '#make_link' do
+    it 'should make a Link object, given good blocks' do
+      blocks = {
+        "block_A" => TestBlock.new(:sample_rate => 2),
+        "block_B" => TestBlock.new(:sample_rate => 2),
+      }
+      output = PortLocater.new :block_name => "block_A", :port_name => "OUT"
+      input = PortLocater.new :block_name => "block_B", :port_name => "IN"
+      link_state = LinkState.new :from => output, :to => input
+      link = link_state.make_link blocks
+      link.from.should eq blocks["block_A"].out_ports["OUT"]
+      link.to.should eq blocks["block_B"].in_ports["IN"]
+    end
+  end
+end

data/spec/storage/network_state_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::NetworkState do 
+  describe '.make_network' do
+    before :all do
+      @network_state = NetworkState.new(
+        :block_states => {
+          "A" => BlockState.new(:class_sym => :TestBlock, :hashed_args => {}, :port_params => { "VALUE1" => 0.2}),
+          "B" => BlockState.new(:class_sym => :TestBlock, :hashed_args => {}, :port_params => { "VALUE1" => 0.4})
+        },
+        :link_states => [
+          LinkState.new(
+            :from => PortLocater.new(:block_name => "A", :port_name => "OUT"),
+            :to => PortLocater.new(:block_name => "B", :port_name => "IN")
+          )
+        ]
+      )
+    end
+
+    it 'should create blocks for the given block models' do
+      network = @network_state.make_network :sample_rate => 4
+      network.blocks.should have_key("A")
+      network.blocks["A"].class.should be(TestBlock)
+      network.blocks.should have_key("B")
+      network.blocks["B"].class.should be(TestBlock)
+    end
+    
+    it 'should assign values found in :port_params' do
+      network = @network_state.make_network :sample_rate => 4
+      network.blocks["A"].value1.should eq(0.2)
+      network.blocks["B"].value1.should eq(0.4)
+    end
+
+    it 'should create links from :link_states' do
+      network = @network_state.make_network :sample_rate => 4
+      network.links.count.should be 1
+      network.links.first.from.should eq(network.blocks["A"].out_ports["OUT"])
+      network.links.first.to.should eq(network.blocks["B"].in_ports["IN"])
+    end
+
+  end
+end

data/spec/storage/port_locater_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::PortLocater do
+  describe '.new' do
+    it 'should assign block and port name' do
+      locater = PortLocater.new :block_name => "block_A", :port_name => "port_A"
+      locater.block_name.should eq("block_A")
+      locater.port_name.should eq("port_A")
+    end
+  end
+end

data/spnet.gemspec

@@ -20,7 +20,6 @@ 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.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashmake
@@ -27,22 +27,6 @@ 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
@@ -141,27 +125,51 @@ files:
 - README.rdoc
 - Rakefile
 - lib/spnet.rb
-- lib/spnet/block.rb
-- lib/spnet/in_port.rb
-- lib/spnet/out_port.rb
+- lib/spnet/core/block.rb
+- lib/spnet/core/in_port.rb
+- lib/spnet/core/limiter.rb
+- lib/spnet/core/link.rb
+- lib/spnet/core/network.rb
+- lib/spnet/core/out_port.rb
+- lib/spnet/limiters/enum_limiter.rb
+- lib/spnet/limiters/lower_limiter.rb
+- lib/spnet/limiters/no_limiter.rb
+- lib/spnet/limiters/range_limiter.rb
+- lib/spnet/limiters/upper_limiter.rb
 - lib/spnet/ports/command_in_port.rb
 - lib/spnet/ports/command_out_port.rb
+- lib/spnet/ports/param_in_port.rb
+- lib/spnet/ports/param_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/storage/block_state.rb
+- lib/spnet/storage/link_state.rb
+- lib/spnet/storage/network_state.rb
+- lib/spnet/storage/port_locater.rb
 - lib/spnet/version.rb
-- spec/block_spec.rb
-- spec/in_port_spec.rb
-- spec/out_port_spec.rb
+- spec/core/block_spec.rb
+- spec/core/in_port_spec.rb
+- spec/core/limiter_spec.rb
+- spec/core/link_spec.rb
+- spec/core/network_spec.rb
+- spec/core/out_port_spec.rb
+- spec/limiters/enum_limiter_spec.rb
+- spec/limiters/lower_limiter_spec.rb
+- spec/limiters/no_limiter_spec.rb
+- spec/limiters/range_limiter_spec.rb
+- spec/limiters/upper_limiter_spec.rb
 - spec/ports/command_in_port_spec.rb
 - spec/ports/command_out_port_spec.rb
+- spec/ports/param_in_port_spec.rb
+- spec/ports/param_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/spnet_spec.rb
+- spec/storage/block_state_spec.rb
+- spec/storage/link_state_spec.rb
+- spec/storage/network_state_spec.rb
+- spec/storage/port_locater_spec.rb
 - spnet.gemspec
 homepage: https://rubygems.org/gems/spnet
 licenses:
@@ -178,7 +186,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -300528529
+      hash: -699340785
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -187,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -300528529
+      hash: -699340785
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -195,15 +203,27 @@ signing_key:
 specification_version: 3
 summary: Provide infrastructure for forming processing networks.
 test_files:
-- spec/block_spec.rb
-- spec/in_port_spec.rb
-- spec/out_port_spec.rb
+- spec/core/block_spec.rb
+- spec/core/in_port_spec.rb
+- spec/core/limiter_spec.rb
+- spec/core/link_spec.rb
+- spec/core/network_spec.rb
+- spec/core/out_port_spec.rb
+- spec/limiters/enum_limiter_spec.rb
+- spec/limiters/lower_limiter_spec.rb
+- spec/limiters/no_limiter_spec.rb
+- spec/limiters/range_limiter_spec.rb
+- spec/limiters/upper_limiter_spec.rb
 - spec/ports/command_in_port_spec.rb
 - spec/ports/command_out_port_spec.rb
+- spec/ports/param_in_port_spec.rb
+- spec/ports/param_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/spnet_spec.rb
+- spec/storage/block_state_spec.rb
+- spec/storage/link_state_spec.rb
+- spec/storage/network_state_spec.rb
+- spec/storage/port_locater_spec.rb
 has_rdoc: