spnet 0.1.4 → 0.1.5

data/spec/core/in_port_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::InPort do
+  describe '.new' do
+    it 'link should be nil' do
+      port = InPort.new :matching_class => OutPort
+      port.link.should be_nil
+    end
+  end
+
+  describe '#set_link' do
+    it 'should set link to given link' do
+      in_port = InPort.new(:matching_class => OutPort)
+      out_port = OutPort.new(:matching_class => InPort)
+      link = Link.new :from => out_port, :to => in_port
+      in_port.set_link link
+      in_port.link.should eq(link)
+    end
+  end
+  
+  describe '#clear_link' do
+    it 'should set link to nil' do
+      in_port = InPort.new(:matching_class => OutPort)
+      out_port = OutPort.new(:matching_class => InPort)
+      link = Link.new :from => out_port, :to => in_port
+      in_port.set_link link
+      in_port.link.should eq(link)
+      in_port.clear_link
+      in_port.link.should be_nil
+    end
+  end
+  
+  describe '#linked?' do
+    it 'should return false if port is not linked' do
+      in_port = InPort.new(:matching_class => OutPort)
+      in_port.linked?.should be_false
+    end
+    
+    it 'should return true if port is linked' do
+      in_port = InPort.new(:matching_class => OutPort)
+      out_port = OutPort.new(:matching_class => InPort)
+      Link.new(:from => out_port, :to => in_port).activate
+      in_port.linked?.should be_true
+    end
+  end
+end

data/spec/core/limiter_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::Limiter do
+  it 'should raise NotImplementedError if apply_limit is called' do
+    lambda { Limiter.new.apply_limit 5, 4 }.should raise_error(NotImplementedError)
+  end
+end

data/spec/core/link_spec.rb

@@ -0,0 +1,103 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::Link do
+  context '.new' do
+    it 'should contain the :to and :from given' do
+      out_port = SignalOutPort.new
+      in_port = SignalInPort.new
+      link = Link.new(:from => out_port,:to => in_port)
+      
+      link.to.should eq(in_port)
+      link.from.should eq(out_port)
+    end
+    
+    it 'should raise ArgumentError if to port does not match from port' do
+      out_port = ParamOutPort.new
+      in_port = SignalInPort.new
+      lambda { Link.new(:from => out_port, :in => in_port) }.should raise_error(ArgumentError)
+    end
+    
+    it 'should not set to and from link to eachother' do
+      out_port = SignalOutPort.new
+      in_port = SignalInPort.new
+      link = Link.new(:from => out_port,:to => in_port)
+      link.to.link.should be_nil
+      link.from.link.should be_nil
+    end
+  end
+
+  context '#activate' do
+    it 'should set.link to and from.link to self' do
+      out_port = SignalOutPort.new
+      in_port = SignalInPort.new
+      link = Link.new(:from => out_port,:to => in_port)
+      link.activate
+      link.to.link.should eq(link)
+      link.from.link.should eq(link)
+    end
+  end
+
+  context '#activate' do
+    it 'should set.link to and from.link to nil' do
+      out_port = SignalOutPort.new
+      in_port = SignalInPort.new
+      link = Link.new(:from => out_port,:to => in_port)
+      link.activate
+      link.deactivate
+      link.to.link.should eq(nil)
+      link.from.link.should eq(nil)
+    end
+  end
+
+  context '#active?' do
+    it 'should return true if activate has been called and deactivate has never been called' do
+      out_port = SignalOutPort.new
+      in_port = SignalInPort.new
+      link = Link.new(:from => out_port,:to => in_port)
+      link.activate
+      link.active?.should be_true
+    end
+
+    it 'should return false if activate has never been called' do
+      out_port = SignalOutPort.new
+      in_port = SignalInPort.new
+      link = Link.new(:from => out_port,:to => in_port)
+      link.active?.should be_false
+    end
+
+    it 'should return false if activate been called but deactivate was called later' do
+      out_port = SignalOutPort.new
+      in_port = SignalInPort.new
+      link = Link.new(:from => out_port,:to => in_port)
+      link.activate
+      link.deactivate
+      link.active?.should be_false
+    end
+  end
+  
+  context '#export_state' do
+    before :all do
+      blocks = {
+        "A" => TestBlock.new(:sample_rate => 2),
+        "B" => TestBlock.new(:sample_rate => 2),
+      }
+      link = Link.new(:from => blocks["A"].out_ports["OUT"], :to => blocks["B"].in_ports["IN"])
+      link.activate
+      @state = link.export_state blocks
+    end
+    
+    it 'should make a LinkState object' do
+      @state.should be_a(LinkState)
+    end
+      
+    it 'should be from "A.OUT"' do
+      @state.from.block_name.should eq("A")
+      @state.from.port_name.should eq("OUT")      
+    end
+    
+    it 'should be to "B.IN"' do
+      @state.to.block_name.should eq("B")
+      @state.to.port_name.should eq("IN")
+    end
+  end
+end

data/spec/core/network_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::Network do
+  context '.new' do
+    before :all do
+      @sample_rate =  1.0
+    end
+    
+    context 'no name, blocks, or links given' do
+      before :all do
+        @network = Network.new :sample_rate => @sample_rate
+      end
+      
+      it 'should have empty name' do
+        @network.name.should be_empty
+      end
+      
+      it 'should have no blocks' do
+        @network.blocks.should be_empty
+      end
+      
+      it 'should have no links' do
+        @network.links.should be_empty
+      end
+    end
+    
+    it 'should activate links' do
+      a = TestBlock.new(:sample_rate => @sample_rate)
+      b = TestBlock.new(:sample_rate => @sample_rate)
+      link = Link.new(:from => a.out_ports["OUT"], :to => b.in_ports["IN"])
+      network = Network.new(
+        :sample_rate => @sample_rate,
+        :blocks => { "A" => a, "B" => b },
+        :links => [ link ],
+      )
+      link.active?.should be_true
+    end
+  end
+  
+end

data/spec/core/out_port_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::OutPort do
+  describe '.new' do
+    it 'link should be nil' do
+      port = OutPort.new :matching_class => InPort
+      port.link.should be_nil
+    end
+  end
+
+  describe '#set_link' do
+    it 'should set link to given link' do
+      in_port = InPort.new(:matching_class => OutPort)
+      out_port = OutPort.new(:matching_class => InPort)
+      link = Link.new :from => out_port, :to => in_port
+      out_port.set_link link
+      out_port.link.should eq(link)
+    end
+  end
+  
+  describe '#clear_link' do
+    it 'should set link to nil' do
+      in_port = InPort.new(:matching_class => OutPort)
+      out_port = OutPort.new(:matching_class => InPort)
+      link = Link.new :from => out_port, :to => in_port
+      out_port.set_link link
+      out_port.link.should eq(link)
+      out_port.clear_link
+      out_port.link.should be_nil
+    end
+  end
+  
+  describe '#linked?' do
+    it 'should return false if port is not linked' do
+      out_port = OutPort.new(:matching_class => InPort)
+      out_port.linked?.should be_false
+    end
+    
+    it 'should return true if port is linked' do
+      in_port = InPort.new(:matching_class => OutPort)
+      out_port = OutPort.new(:matching_class => InPort)
+      Link.new(:from => out_port, :to => in_port).activate
+      out_port.linked?.should be_true
+    end
+  end
+end

data/spec/limiters/enum_limiter_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::EnumLimiter do
+  describe '.new' do
+    it 'should raise ArgumentError if non-Enumerable is given' do
+      lambda { EnumLimiter.new(5) }.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe '.apply_limit' do
+    it 'should return the given value if it is contained in @values' do
+      values = [1,3,5,7]
+      limiter = EnumLimiter.new values
+      values.each do |value|
+        limiter.apply_limit(value, 0).should eq(value)
+      end
+    end
+    
+    it 'should return the given current_value if the given value is not contained in @values' do
+      values = [1,3,5,7]
+      non_values = [2,4,6,8]
+      limiter = EnumLimiter.new values
+      non_values.each do |value|
+        limiter.apply_limit(value, 0).should eq(0)
+      end
+    end
+  end
+end

data/spec/limiters/lower_limiter_spec.rb

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

data/spec/limiters/no_limiter_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPNet::NoLimiter do
+  describe '.new' do
+    it 'should always return the given value' do
+      limiter = NoLimiter.new
+      [-1, 1, Float::MAX, Float::MIN, "horse"].each do |value|
+        value.should eq(limiter.apply_limit(value))
+      end
+    end
+  end
+end

data/spec/limiters/range_limiter_spec.rb

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