motel 0.2 → 0.3

data/lib/motel/thread_pool.rb

@@ -0,0 +1,51 @@
+# copied unmodified from the ruby cookbook
+# http://codeidol.com/other/rubyckbk/Multitasking-and-Multithreading/Limiting-Multithreading-with-a-Thread-Pool/
+
+require 'thread'
+
+class ThreadPool
+  attr_reader :max_size
+
+  def initialize(max_size)
+    @pool = []
+    @max_size = max_size
+    @pool_mutex = Mutex.new
+    @pool_cv = ConditionVariable.new
+  end
+
+  def dispatch(*args)
+    Thread.new do
+      # Wait for space in the pool.
+      @pool_mutex.synchronize do
+        while @pool.size >= @max_size
+          print "Pool is full; waiting to run #{args.join(',')}…\n" if $DEBUG
+          # Sleep until some other thread calls @pool_cv.signal.
+          @pool_cv.wait(@pool_mutex)
+        end
+      end
+      @pool << Thread.current
+      begin
+        yield(*args)
+      rescue => e
+        exception(self, e, *args)
+      ensure
+        @pool_mutex.synchronize do
+          # Remove the thread from the pool.
+          @pool.delete(Thread.current)
+          # Signal the next waiting thread that there's a space in the pool.
+          @pool_cv.signal
+        end
+      end
+    end
+  end
+
+  def shutdown
+    @pool_mutex.synchronize { @pool_cv.wait(@pool_mutex) until @pool.empty? }
+  end
+
+  def exception(thread, exception, *original_args)
+    # Subclass this method to handle an exception within a thread.
+    puts "Exception in thread #{thread}: #{exception}"
+  end
+
+end

data/lib/motel.rb

@@ -1,13 +1,17 @@
 # include all motel modules
 #
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
-# See COPYING for the License of this software
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
 
 lib = File.dirname(__FILE__)
 
-require lib + '/motel/conf'
+require lib + '/motel/exceptions'
 require lib + '/motel/runner'
-require lib + '/motel/loader'
 require lib + '/motel/simrpc'
 
-Dir[lib + '/motel/models/*.rb'].each { |model| require model }
+require lib + '/motel/dsl'
+
+require lib + '/motel/location'
+require lib + '/motel/movement_strategy'
+
+Dir[lib + '/motel/movement_strategies/*.rb'].each { |model| require model }

data/spec/common_spec.rb

@@ -0,0 +1,77 @@
+# common module tests
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "gen_uuid" do
+
+  it "should generate valid uuid" do
+    uuid = gen_uuid 
+    uuid.size.should == 36
+    uuid.should =~ /[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/
+  end
+
+end
+
+describe "normalize" do
+
+  it "shoud not affect a normalized vector" do
+    x,y,z = normalize 1,0,0
+    x.should be(1)
+    y.should be(0)
+    z.should be(0)
+
+    x,y,z = normalize 0,1,0
+    x.should be(0)
+    y.should be(1)
+    z.should be(0)
+
+    x,y,z = normalize 0,0,1
+    x.should be(0)
+    y.should be(0)
+    z.should be(1)
+  end
+
+  it "should correctly normalize vector" do
+    x,y,z = normalize 0.5,0.5,0.5
+    (x - 0.577350269189626).should < 0.000000000000001
+    (y - 0.577350269189626).should < 0.000000000000001
+    (z - 0.577350269189626).should < 0.000000000000001
+
+    x,y,z = normalize 0.75,0.6,0.12
+    (x - 0.77484465921718).should   < 0.000000000000001
+    (y - 0.619875727373744).should  < 0.000000000000001
+    (z - 0.123975145474749).should  < 0.000000000000001
+  end
+
+end
+
+describe "orthogonal?" do
+ it "should return true for orthoginal vectors" do
+    orthogonal?(1,0,0, 0,1,0).should == true
+    orthogonal?(1,0,0, 0,0,1).should == true
+    orthogonal?(0,1,0, 0,0,1).should == true
+
+    orthogonal?(-1,0,0, 0,-1,0).should == true
+    orthogonal?(1,0,0, 0,0,-1).should  == true
+    orthogonal?(0,-1,0, 0,0,1).should  == true
+
+    orthogonal?(1,3,2, 3,-1,0).should  == true
+ end
+
+ it "should return false for nonorthoginal vectors" do
+    orthogonal?(1,0,0, -1,0,0).should == false
+    orthogonal?(1,0,0, 1,0,0).should  == false
+    orthogonal?(0.5,0.14,0.98, 7.1,-6.5,0).should  == false
+ end
+end
+
+describe Float do
+  it "should correctly round to specified percision" do
+      5.12345.round_to(1).should == 5.1
+      -5.12345.round_to(2).should == -5.12
+      5.12345.round_to(6).should == 5.12345
+  end
+end

data/spec/dsl_spec.rb

@@ -0,0 +1,27 @@
+# dsl module tests
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+
+dir = File.dirname(__FILE__) 
+require dir + '/spec_helper'
+
+SIMRPC_SPEC = dir + '/../conf/motel-schema.xml'
+
+describe "Motel::dsl" do
+
+  it "should permit simple connections" do
+    # setup simrpc server endpoint
+    server = Motel::Server.new :schema_file => SIMRPC_SPEC
+
+    # use dsl to connect to server and issue a few requests
+    connect :schema_file => SIMRPC_SPEC do |client|
+       location_id = 100
+       client.create_location(location_id).should be(true)
+       loc = client.get_location(location_id)
+       loc.should_not be_nil
+       loc.id.should be(location_id)
+    end
+  end
+
+end

data/spec/location_spec.rb

@@ -0,0 +1,109 @@
+# location module tests
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Location do
+
+  it "should successfully accept and set location params" do
+     parent = Location.new
+     location = Location.new :id => 1, :parent_id => 2, :parent => parent, :x => 3, :y => 4, :z => 5
+     location.id.should == 1
+     location.parent_id.should == 2
+     location.x.should == 3
+     location.y.should == 4
+     location.z.should == 5
+     location.parent.should == parent
+     location.children.should == []
+     location.movement_callbacks.should == []
+     location.movement_strategy.should == MovementStrategies::Stopped.instance
+
+     ms = TestMovementStrategy.new
+     location = Location.new :movement_strategy => ms
+     location.movement_strategy.should == ms
+  end
+
+  it "should default to origin coordinates" do
+     loc = Location.new
+     loc.x.should == 0
+     loc.y.should == 0
+     loc.z.should == 0
+  end
+
+  it "should be updatable given another location to copy" do
+     p1 = Location.new
+     p2 = Location.new
+
+     orig = Location.new :x => 1, :y => 2, :movement_strategy => 'foobar', :parent_id => 5, :parent => p1
+     new  = Location.new :x => 5, :movement_strategy => 'foomoney', :parent_id => 10, :parent => p2
+     orig.update(new)
+     orig.x.should be(5)
+     orig.y.should be(0)
+     orig.y.should be(0)
+     orig.movement_strategy.should == "foomoney"
+     orig.parent_id.should be(10)
+     orig.parent.should be(p2)
+
+     orig.y = 6
+     new.y  = nil
+     orig.update(new)
+     orig.y.should be(6)
+  end
+
+  it "retrieve root location" do
+    ggp = Location.new
+    gp  = Location.new :parent => ggp
+    p   = Location.new :parent => gp
+    l   = Location.new :parent => p
+    c   = Location.new :parent => l
+    gc  = Location.new  :parent => c
+
+    gp.root.should == ggp
+    p.root.should == ggp
+    l.root.should == ggp
+    c.root.should == ggp
+    gc.root.should == ggp
+  end
+
+  it "should provide means to traverse all descendants, invoking optional block arg" do
+   greatgrandparent = Location.new
+   grandparent = Location.new
+   greatgrandparent.children.push grandparent
+   grampy   = Location.new
+   greatgrandparent.children.push grampy
+   parent = Location.new
+   grandparent.children.push parent
+   parent2 = Location.new
+   grandparent.children.push parent2
+   child1 = Location.new
+   parent.children.push child1
+   child2 = Location.new
+   parent.children.push child2
+
+   i = 0 
+   greatgrandparent.traverse_descendants { |desc|
+     i += 1
+   }   
+
+   i.should == 6
+  end
+
+  it "should return total position from root origin" do
+    grandparent = Location.new
+    parent = Location.new :parent => grandparent,
+                          :x      => 14,
+                          :y      => 24,
+                          :z      => 42 
+    child = Location.new  :parent => parent,
+                          :x      => 123,
+                          :y      => -846,
+                          :z      => -93
+
+    child.total_x.should == 14 + 123
+    child.total_y.should == 24 - 846
+    child.total_z.should == 42 - 93
+  end
+
+end

data/spec/movement_strategies/elliptical_spec.rb

@@ -0,0 +1,90 @@
+# elliptical movement strategy tests
+#
+# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# See COPYING for the License of this software
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Motel::MovementStrategies::Elliptical" do
+
+  it "should successfully accept and set elliptical params" do
+     elliptical = Elliptical.new :relative_to => Elliptical::RELATIVE_TO_CENTER, :speed => 5,
+                                 :eccentricity => 0.5, :semi_latus_rectum => 10,
+                                 :direction_major_x => 1, :direction_major_y => 3,  :direction_major_z => 2,
+                                 :direction_minor_x => 3, :direction_minor_y => -1, :direction_minor_z => 0
+                                 
+     # the orthogonal direction vectors get normalized                                  
+     (elliptical.direction_major_x - 0.267261241912424).abs.should < 0.0000000001
+     (elliptical.direction_major_y - 0.801783725737273).abs.should < 0.0000000001
+     (elliptical.direction_major_z - 0.534522483824849).abs.should < 0.0000000001
+     (elliptical.direction_minor_x - 0.948683298050514).abs.should < 0.0000000001
+     (elliptical.direction_minor_y - -0.316227766016838).abs.should < 0.0000000001
+     elliptical.direction_minor_z.should == 0
+
+     elliptical.speed.should == 5
+     elliptical.relative_to.should == Elliptical::RELATIVE_TO_CENTER
+     elliptical.eccentricity.should == 0.5
+     elliptical.semi_latus_rectum.should == 10
+  end
+
+  it "should default to standard cartesian direction axis" do
+     elliptical = Elliptical.new
+     elliptical.direction_major_x.should == 1
+     elliptical.direction_major_y.should == 0
+     elliptical.direction_major_z.should == 0
+     elliptical.direction_minor_x.should == 0
+     elliptical.direction_minor_y.should == 1
+     elliptical.direction_minor_z.should == 0
+  end
+
+  it "should raise exception if direction vectors are orthogonal" do
+     lambda { 
+       elliptical = Elliptical.new :direction_major_x => 0.75, :direction_major_y => -0.33,  :direction_major_z => -0.21,
+                                   :direction_minor_x => -0.41, :direction_minor_y => 0, :direction_minor_z => 0.64
+     }.should raise_error(InvalidMovementStrategy, "elliptical direction vectors not orthogonal")
+  end
+
+
+  it "should move location correctly" do
+     elliptical = Elliptical.new(:step_delay        => 5,
+                                 :relative_to       => Elliptical::RELATIVE_TO_CENTER,
+                                 :speed             => 1.57,
+                                 :eccentricity      => 0, # circle
+                                 :semi_latus_rectum => 1,
+                                 :direction_major_x => 1,
+                                 :direction_major_y => 0,
+                                 :direction_major_z => 0,
+                                 :direction_minor_x => 0,
+                                 :direction_minor_y => 1,
+                                 :direction_minor_z => 0)
+
+     parent   = Location.new
+     x = 1
+     y = z = 0
+     location = Location.new(:parent => parent,
+                             :movement_strategy => elliptical,
+                             :x => x, :y => y, :z => z)
+
+     # move and validate
+     elliptical.move location, 1
+     (0 - location.x).abs.round_to(2).should == 0
+     (1 - location.y).abs.round_to(2).should == 0
+     (0 - location.z).abs.round_to(2).should == 0
+
+     elliptical.move location, 1
+     (-1 - location.x).abs.round_to(2).should == 0
+     (0  - location.y).abs.round_to(2).should == 0
+     (0  - location.z).abs.round_to(2).should == 0
+
+     elliptical.move location, 1
+     (0  - location.x).abs.round_to(2).should == 0
+     (-1 - location.y).abs.round_to(2).should == 0
+     (0  - location.z).abs.round_to(2).should == 0
+
+     elliptical.move location, 1
+     (1  - location.x).abs.round_to(2).should == 0
+     (0 - location.y).abs.round_to(2).should == 0
+     (0  - location.z).abs.round_to(2).should == 0
+  end
+
+end

data/spec/movement_strategies/linear_spec.rb

@@ -0,0 +1,51 @@
+# linear movement strategy tests
+#
+# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# See COPYING for the License of this software
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Motel::MovementStrategies::Linear" do
+
+  it "should successfully accept and set linear params" do
+     linear = Linear.new :direction_vector_x => 1, :direction_vector_y => 2, :direction_vector_z => 3, :speed => 5
+
+     # ensure linear vector gets automatically normailized
+     dx,dy,dz = normalize 1,2,3
+     linear.direction_vector_x.should == dx
+     linear.direction_vector_y.should == dy
+     linear.direction_vector_z.should == dz
+
+     linear.speed.should == 5
+  end
+
+
+  it "should move location correctly" do
+     linear = Linear.new :step_delay => 5, :speed => 20, 
+                         :direction_vector_x => 5, :direction_vector_y => 5, :direction_vector_z => 5
+     dx,dy,dz = linear.direction_vector_x, linear.direction_vector_y, linear.direction_vector_z
+
+     parent   = Location.new
+     x = y = z = 20
+     location = Location.new(:parent => parent,
+                             :movement_strategy => linear,
+                             :x => x, :y => y, :z => z)
+
+     # move and validate
+     linear.move location, 1
+     location.x.should == x + dx * linear.speed
+     location.y.should == y + dy * linear.speed
+     location.z.should == z + dz * linear.speed
+
+     x = location.x
+     y = location.y
+     z = location.z
+
+     linear.move location, 5
+     location.x.should == x + dx * linear.speed * 5
+     location.y.should == y + dy * linear.speed * 5
+     location.z.should == z + dz * linear.speed * 5
+ 
+  end
+
+end

data/spec/movement_strategies/stopped_spec.rb

@@ -0,0 +1,39 @@
+# stopped movement strategy tests
+#
+# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
+# See COPYING for the License of this software
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Motel::MovementStrategies::Stopped" do
+
+  it "should not move location" do
+     # setup test
+     stopped = Stopped.instance
+     parent   = Location.new
+     x = 50
+     y = 100 
+     z = 200 
+     location = Location.new(:parent => parent,
+                             :movement_strategy => stopped,
+                             :x => 50, :y => 100, :z => 200)
+
+     # make sure location does not move
+     stopped.move location, 10
+     location.x.should == x
+     location.y.should == y
+     location.z.should == z
+
+     stopped.move location, 50
+     location.x.should == x
+     location.y.should == y
+     location.z.should == z
+
+     stopped.move location, 0
+     location.x.should == x
+     location.y.should == y
+     location.z.should == z
+
+  end
+
+end

data/spec/movement_strategy_spec.rb

@@ -0,0 +1,24 @@
+# movement strategy module tests
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe MovementStrategy do
+
+  it "should successfully accept and set movement strategy params" do
+     ms = MovementStrategy.new :step_delay => 10
+     ms.step_delay.should == 10
+  end
+
+  it "should default to no movement" do
+     loc = Location.new :x => 100, :y => -200, :z => 300
+     ms = MovementStrategy.new
+     ms.move loc, 2000
+     loc.x.should == 100
+     loc.y.should == -200
+     loc.z.should == 300
+  end
+
+end

data/spec/runner_spec.rb

@@ -0,0 +1,45 @@
+# runner module tests
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Runner do
+
+  it "manage array of locations to be run" do
+    loc = Location.new
+    Runner.instance.locations.clear
+    Runner.instance.locations.should == []
+    Runner.instance.run loc
+    Runner.instance.locations.should == [loc]
+    Runner.instance.locations.clear
+  end
+
+  it "should run managed locations" do
+    loc1 = Location.new :movement_strategy => TestMovementStrategy.new
+    loc2 = Location.new :movement_strategy => TestMovementStrategy.new
+    Runner.instance.locations.clear
+    Runner.instance.run loc1
+    Runner.instance.run loc2
+    Runner.instance.locations.size.should == 2
+
+    Runner.instance.start :async => true, :num_threads => 10
+    Runner.instance.thread_pool.should_not == nil
+    Runner.instance.thread_pool.max_size.should == 10
+    Runner.instance.terminate.should == false
+
+    # TODO should we sleep here for a fixed time, to allow 
+    # move to be called multiple times ?
+
+    Runner.instance.stop
+    Runner.instance.terminate.should == true
+
+    Runner.instance.join
+    Runner.instance.run_thread.should == nil
+
+    loc1.movement_strategy.times_moved.should be > 0
+    loc2.movement_strategy.times_moved.should be > 0
+  end
+
+end

data/spec/simrpc_spec.rb

@@ -0,0 +1,85 @@
+# simrpc module tests
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+
+dir = File.dirname(__FILE__) 
+require dir + '/spec_helper'
+
+describe "Motel::Simrpc" do
+
+  before(:each) do
+    # setup simrpc endpoints
+    @server = Motel::Server.new :schema_file => dir + '/../conf/motel-schema.xml'
+    @client = Motel::Client.new :schema_file => dir + '/../conf/motel-schema.xml'
+  end
+
+  it "should fail to retreive invalid location" do
+    @client.get_location(-500).should be_nil
+  end
+
+  it "should permit location creation and retrieval" do
+    locations = Runner.instance.locations.size
+    location_id = 10
+    @client.create_location(location_id).should be(true)
+    Runner.instance.locations.size.should == locations + 1
+
+    loc = @client.get_location(location_id)
+    loc.should_not be_nil
+    loc.id.should be(location_id)
+  end
+
+  it "should permit updating a location" do
+    location_id = 20
+    @client.create_location(location_id).should be(true)
+    @client.update_location(Location.new(:id => location_id, :x => 150, :y => 300, :z => -600)).should be(true)
+
+    loc = @client.get_location(location_id)
+    loc.should_not be_nil
+    loc.x.should be(150)
+    loc.y.should be(300)
+    loc.z.should be(-600)
+
+    loc = @client.request :get_location, location_id
+    loc.should_not be_nil
+    loc.x.should be(150)
+  end
+
+  it "should permit receiving location updates" do
+    # start the runner here, to actual move location / process callbacks
+    Runner.instance.start :async => true
+
+    # create the location
+    location_id = 30
+    @client.create_location(location_id).should be(true)
+
+    ## set a linear movement strategy
+    location = Location.new
+    location.id = location_id
+    location.movement_strategy = Linear.new(:step_delay => 1,
+                                            :speed      => 15, 
+                                            :direction_vector_x => 1,
+                                            :direction_vector_y => 0,
+                                            :direction_vector_z => 0)
+    @client.update_location(location).should be(true)
+
+    times_moved = 0 
+
+    # handle location_moved method
+    @client.on_location_received = lambda { |location|
+      times_moved += 1
+    }   
+
+    ## subscribe to updates
+    @client.subscribe_to_location(location_id).should be(true)
+
+    ## delay briefly allowing for updates
+    sleep 5
+
+    times_moved.should be > 0 
+
+    # stop the runner
+    Runner.instance.stop
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# loads and runs all tests for the motel project
+#
+# Copyright (C) 2010 Mohammed Morsi <movitto@yahoo.com>
+# Licensed under the AGPLv3+ http://www.gnu.org/licenses/agpl.txt
+
+require 'rubygems'
+require 'spec'
+
+CURRENT_DIR=File.dirname(__FILE__)
+$: << File.expand_path(CURRENT_DIR + "/../lib")
+
+require 'motel'
+include Motel
+include Motel::MovementStrategies
+
+class TestMovementStrategy < MovementStrategy
+   attr_accessor :times_moved
+
+   def initialize
+     @times_moved = 0
+   end
+
+   def move(loc, elapsed_time)
+     @times_moved += 1
+   end
+end