motel 0.2 → 0.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: motel
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  version: "0.3"
 platform: ruby
 authors: 
 - Mohammed Morsi
@@ -9,67 +9,69 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-04 00:00:00 -04:00
+date: 2010-03-14 00:00:00 -05:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activerecord
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.1.1
-    version: 
+dependencies: []
+
 description: Motel is a library to track and move the locations of objects in a 3D environment.
 email: movitto@yahoo.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
-- conf/amqp.yml
-- conf/database.yml
-- db/migrate/001_create_locations_and_movement_strategies.rb
-- db/migrate/002_create_linear_movement_strategy.rb
-- db/migrate/003_create_elliptical_movement_strategy.rb
-- lib/motel/models/location.rb
-- lib/motel/models/movement_strategy.rb
-- lib/motel/models/stopped.rb
-- lib/motel/models/linear.rb
-- lib/motel/models/elliptical.rb
+- bin/server/main.rb
+- bin/clients/simple/main.rb
+- conf/motel-schema.xml
+- lib/motel/movement_strategies/elliptical.rb
+- lib/motel/movement_strategies/stopped.rb
+- lib/motel/movement_strategies/linear.rb
+- lib/motel/dsl.rb
+- lib/motel/movement_strategy.rb
+- lib/motel/location.rb
 - lib/motel/common.rb
-- lib/motel/loader.rb
-- lib/motel/runner.rb
 - lib/motel/semaphore.rb
+- lib/motel/thread_pool.rb
+- lib/motel/runner.rb
+- lib/motel/exceptions.rb
+- lib/motel/simrpc.rb
 - lib/motel.rb
-- LICENSE
 - COPYING
-- README
+- LICENSE
+- Rakefile
+- README.rdoc
+- spec/movement_strategies/stopped_spec.rb
+- spec/movement_strategies/elliptical_spec.rb
+- spec/movement_strategies/linear_spec.rb
+- spec/common_spec.rb
+- spec/spec_helper.rb
+- spec/movement_strategy_spec.rb
+- spec/location_spec.rb
+- spec/simrpc_spec.rb
+- spec/runner_spec.rb
+- spec/dsl_spec.rb
 has_rdoc: true
 homepage: http://morsi.org/projects/motel
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --inline-source
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.8.1
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.3.1
+      version: 1.3.3
   version: 
 requirements: []
 

data/conf/amqp.yml

@@ -1,13 +0,0 @@
-# motel amqp config
-
-production:
-  broker: 127.0.0.1
-  port: 5672
-
-development:
-  broker: 127.0.0.1
-  port: 5672
-
-test:
-  broker: 127.0.0.1
-  port: 5672

data/conf/database.yml

@@ -1,41 +0,0 @@
-# motel database config
-#
-# Fedora Install Instructions:
-#   sudo yum install ruby-postgres postgresql-server
-#   sudo /sbin/service postgresql initdb
-#   sudo /sbin/service postgresql start
-#   sudo su - postgres
-#   createdb motel
-#   $   psql motel
-#   $-# CREATE USER motel WITH PASSWORD 'motel';
-#   $-# GRANT ALL PRIVILEGES ON DATABASE motel to motel;
-#   $-# CREATE DATABASE motel_test;
-#   $-# GRANT ALL PRIVILEGES ON DATABASE motel_test to motel;
-#   $-# CREATE DATABASE motel_development;
-#   $-# GRANT ALL PRIVILEGES ON DATABASE motel_development to motel;
-#   $-# \q
-#   $   exit
-
-production:
-  adapter: postgresql
-  database: motel
-  username: motel
-  password: motel
-  host: localhost
-  pool: 20
-
-development:
-  adapter: postgresql
-  database: motel_development
-  username: motel
-  password: motel
-  host: localhost
-  pool: 20
-
-test:
-  adapter: postgresql
-  database: motel_test
-  username: motel
-  password: motel
-  host: localhost
-  pool: 20

data/db/migrate/001_create_locations_and_movement_strategies.rb

@@ -1,45 +0,0 @@
-# creates the locations and movement_strategies tables
-#
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
-# See COPYING for the License of this software
-
-require 'motel'
-
-# ActiveRecord::Migration 001
-class CreateLocationsAndMovementStrategies < ActiveRecord::Migration
-  def self.up
-
-     create_table :movement_strategies do |t|
-        t.string  :type,        :null => false, :size => 50
-        t.float   :step_delay,  :null => false
-     end
-
-     create_table :locations do |t|
-        t.float :x, :default => nil
-        t.float :y, :default => nil
-        t.float :z, :default => nil
-        t.integer :movement_strategy_id, :null => false
-
-        t.integer :parent_id, :default => nil
-     end
-
-     execute "alter table locations add constraint fk_location_parent
-              foreign key(parent_id) references locations(id)"
-
-     execute "alter table locations add constraint fk_location_movement_strategy
-              foreign key(movement_strategy_id) references movement_strategies(id)"
-
-     execute "alter table locations add constraint root_or_child 
-              check (parent_id IS NULL AND x IS NULL AND y IS NULL AND z IS NULL OR
-                     parent_id IS NOT NULL AND x IS NOT NULL AND y IS NOT NULL AND z IS NOT NULL)"
-
-
-     # create the first / default movement strategy 'stopped'
-     Motel::Models::Stopped.new(:step_delay => 5).save!
-  end
-
-  def self.down
-     drop_table :locations
-     drop_table :movement_strategies
-  end
-end

data/db/migrate/002_create_linear_movement_strategy.rb

@@ -1,23 +0,0 @@
-# creates the neccessary fields for the Linear MovementStrategy
-#
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
-# See COPYING for the License of this software
-
-require 'motel'
-
-# ActiveRecord::Migration 002
-class CreateLinearMovementStrategy < ActiveRecord::Migration
-  def self.up
-     add_column :movement_strategies, :speed,              :float
-     add_column :movement_strategies, :direction_vector_x, :float
-     add_column :movement_strategies, :direction_vector_y, :float
-     add_column :movement_strategies, :direction_vector_z, :float
-  end
-
-  def self.down
-     remove_column :movement_strategies, :speed
-     remove_column :movement_strategies, :direction_vector_x
-     remove_column :movement_strategies, :direction_vector_y
-     remove_column :movement_strategies, :direction_vector_z
-  end
-end

data/db/migrate/003_create_elliptical_movement_strategy.rb

@@ -1,52 +0,0 @@
-# creates the neccessary fields for the Elliptical MovementStrategy
-#
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
-# See COPYING for the License of this software
-
-require 'motel'
-
-# ActiveRecord::Migration 003
-class CreateEllipticalMovementStrategy < ActiveRecord::Migration
-  def self.up
-     # we already have speed from linear
-     #add_column :movement_strategies, :speed,              :float
-
-     # relative_to field indicates what type of parent
-     # this movement stategy is relative to, for Ellilptical
-     # strategies, this can be 'center' indicating the parent
-     # is the center of the ellipse or 'foci' indicating the
-     # parent is on of the ellipse foci's
-     add_column :movement_strategies, :relative_to, :string, :size => 50
-
-     # eccentricity of the ellipse
-     add_column :movement_strategies, :eccentricity, :float
-
-     # semi_latus_rectum of the ellipse
-     add_column :movement_strategies, :semi_latus_rectum, :float
-
-     # unit direction vector of the major axis
-     add_column :movement_strategies, :direction_major_x, :float
-     add_column :movement_strategies, :direction_major_y, :float
-     add_column :movement_strategies, :direction_major_z, :float
-
-     # unit direction vector of the minor axis
-     add_column :movement_strategies, :direction_minor_x, :float
-     add_column :movement_strategies, :direction_minor_y, :float
-     add_column :movement_strategies, :direction_minor_z, :float
-  end
-
-  def self.down
-     # remove in linear strategy
-     #remove_column :movement_strategies, :speed
-
-     remove_column :movement_strategies, :relative_to
-     remove_column :movement_strategies, :eccentricity
-     remove_column :movement_strategies, :semi_latus_rectum
-     remove_column :movement_strategies, :direction_major_x
-     remove_column :movement_strategies, :direction_major_y
-     remove_column :movement_strategies, :direction_major_z
-     remove_column :movement_strategies, :direction_minor_x
-     remove_column :movement_strategies, :direction_minor_y
-     remove_column :movement_strategies, :direction_minor_z
-  end
-end

data/lib/motel/loader.rb

@@ -1,47 +0,0 @@
-# The Loader class definition
-#
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
-# See COPYING for the License of this software
-
-require 'motel/runner'
-
-module Motel
-
-# A Loader loads instances of Location from the db
-# according to any specified conditions, instantiates
-# a new Runner for each of those locations and returns them
-class Loader
-  
- public
-
-  # Default class constructor
-  def initialize
-  end
-
-  # Static member to load all locations that match a specified 
-  # condition (ala activerecord) and add it to the singleton Runner
-  # instance using it to run the locations.
-  def self.Load(conditions = 'parent_id IS NULL')
-     locations = Location.find(:all, :conditions => conditions)
-     return nil if locations.size == 0
-
-     locations.each { |location|
-       run_location(location)
-     }
-     return locations.size
-  end
-
- private
-
-  # Static internal helper method that adds a location and 
-  # all its children to the Runner
-  def self.run_location(location)
-    Runner.get.run location
-    location.children.each { |child|
-       run_location child
-    }
-  end
-
-end
-
-end

data/lib/motel/models/linear.rb

@@ -1,76 +0,0 @@
-# The Linear MovementStrategy model definition
-#
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
-# See COPYING for the License of this software
-
-require 'motel/common'
-require 'motel/models/movement_strategy'
-
-module Motel
-module Models
-
-# The Linear MovementStrategy moves a location
-# in a linear manner as defined by a 
-# unit direction vector and a floating point
-# speed
-class Linear < MovementStrategy
-
-   # Linear MovementStrategy must specify x,y,z components of 
-   # a unit direction vector
-   validates_presence_of [:direction_vector_x, 
-                          :direction_vector_y, 
-                          :direction_vector_z]
-
-   # make sure the unit direction vector is normal
-   before_validation :normalize_direction_vector
-   def normalize_direction_vector
-      dx, dy, dz =
-         normalize(direction_vector_x, direction_vector_y, direction_vector_z)
-      self.direction_vector_x, self.direction_vector_y, self.direction_vector_z = dx, dy, dz
-   end
-
-
-   # Linear MovementStrategy must specify the speed
-   # at which the location is moving
-   validates_presence_of :speed
-   validates_numericality_of :speed,
-      :greater_than_or_equal_to => 0
-
-   # Motel::Models::MovementStrategy::move
-   def move(location, elapsed_seconds)
-     unless valid?
-       Logger.warn "linear movement strategy not valid, not proceeding with move"
-       return
-     end
-
-     Logger.debug "moving location #{location.to_s} via linear movement strategy"
-
-     # calculate distance and update x,y,z accordingly
-     distance = speed * elapsed_seconds
-
-     location.x += distance * direction_vector_x
-     location.y += distance * direction_vector_y
-     location.z += distance * direction_vector_z
-
-     Logger.debug "moved location #{location} via linear movement strategy"
-   end
-
-   # convert non-nil linear movement strategy attributes to a hash
-   def to_h
-     result = {}
-     result[:speed] = speed unless speed.nil?
-     result[:direction_vector_x] = direction_vector_x unless direction_vector_x.nil?
-     result[:direction_vector_y] = direction_vector_y unless direction_vector_y.nil?
-     result[:direction_vector_z] = direction_vector_z unless direction_vector_z.nil?
-     return result
-   end
-
-   # convert linear movement strategy to a string
-   def to_s
-     super + "; speed: #{speed}; direction_vector_x:#{direction_vector_x}; " + 
-             "direction_vector_y:#{direction_vector_y}; direction_vector_z:#{direction_vector_z}"
-   end
-end
-
-end # module Models
-end # module Motel

data/lib/motel/models/location.rb

@@ -1,109 +0,0 @@
-# The Location model definition
-#
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
-# See COPYING for the License of this software
-
-require 'motel/models/movement_strategy'
-
-module Motel
-module Models
-
-# A Location defines an optional parent location and the x,y,z
-# cartesian  coordinates of the location relative to that parent.
-# If parent is not specified x,y,z are ignored and this location
-# is assumed to be the 'center' of the system to which it belongs
-# Also is related to a movable object defining the parameters
-# of the locations movement 
-class Location < ActiveRecord::Base
-   # a location may have a parent and/or act as a parent to others
-   belongs_to :location,  :foreign_key => :parent_id
-   has_many   :locations, :foreign_key => :parent_id, :dependent => :destroy
-
-   belongs_to :movement_strategy
-
-   # a generic association which this location can belong to
-   belongs_to :entity, :polymorphic => true
-   #validates_presense_of [ :entity_type, :entity_id ]
-
-   # FIXME add optional remote_location_server field
-
-   alias :parent    :location
-   alias :parent=   :location=
-   alias :children  :locations
-   alias :children=  :locations=
-
-   # return this location's root location
-   def root
-     return self if parent.nil?
-     return parent.root
-   end
-
-   # traverse all chilren recursively, calling block for each
-   def traverse_descendants(&bl)
-      children.each { |child|
-         bl.call child
-         child.traverse_descendants &bl
-      }
-   end
-
-   # default to the stopped movement strategy if not set on validation
-   before_validation :default_movement_strategy
-   def default_movement_strategy
-      self.movement_strategy = MovementStrategy.stopped if self.movement_strategy.nil?
-   end
-
-   public
-   validates_presence_of :movement_strategy
-
-   validates_presence_of [:x, :y, :z],
-   :unless => Proc.new { |location| location.location.nil? }
-
-   validates_presence_of :location,
-   :unless => Proc.new { |location| location.x.nil? &&
-                                    location.y.nil? &&
-                                    location.z.nil? }
-
-   public
-
-   # return non-nil attributes in hash
-   def to_h
-     result = {}
-     #result[:id] = id unless id.nil?
-     result[:parent_id] = parent_id unless parent_id.nil?
-     result[:x] = x unless x.nil?
-     result[:y] = y unless y.nil?
-     result[:z] = z unless z.nil?
-     return result
-   end
-
-   # convert location to a string
-   def to_s
-     "id:#{id}; parent_id:#{parent_id}; parent: #{parent.nil? ? "nil" : "notnil"}; entity type: #{entity_type}; x:#{x}; y:#{y}; z:#{z}; " +
-     "movement_strategy:#{movement_strategy.to_s}; children:#{locations.size}"
-   end
-
-   # return sum of the x values of this location and all its parents,
-   # eg the absolute 'x' of the location
-   def total_x
-     return 0 if location.nil?
-     return location.total_x + x
-   end
-
-   # return sum of the y values of this location and all its parents
-   # eg the absolute 'y' of the location
-   def total_y
-     return 0 if location.nil?
-     return location.total_y + y
-   end
-
-   # return sum of the z values of this location and all its parents
-   # eg the absolute 'z' of the location
-   def total_z
-     return 0 if location.nil?
-     return location.total_z + z
-   end
-
-end
-
-end # module Models
-end # module Motel

data/lib/motel/models/movement_strategy.rb

@@ -1,82 +0,0 @@
-# The MovementStrategy model definition
-#
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
-# See COPYING for the License of this software
-
-require 'motel/common'
-require 'motel/models/location'
-
-module Motel
-module Models
-
-# MovementStrategy subclasses define the rules and params which 
-# a location changes its position. 
-class MovementStrategy < ActiveRecord::Base
-   # strategy is associated with location to move it
-   has_many :locations, :dependent => :destroy
-
-   # callbacks invoked when this object is moved
-   attr_accessor :movement_callbacks
-
-   # every movement strategy needs a type
-   validates_presence_of :type
-
-   # as more types are supported, add them here
-   validates_inclusion_of :type, 
-     :in => %w( Stopped Linear Elliptical )
-
-   # step delay is recommended number of seconds 
-   # a runner should sleep for between move invocations
-   validates_presence_of :step_delay
-
-   # default step_delay if not set
-   before_validation :default_step_delay
-   def default_step_delay
-      self.step_delay = 5 if step_delay.nil?
-   end
-
-   # use after_initialize instead of initialize
-   # http://blog.dalethatcher.com/2008/03/rails-dont-override-initialize-on.html
-   def after_initialize
-     @movement_callbacks = []
-   end
-
-   # default movement strategy is to do nothing
-   def move(location, elapsed_seconds)
-   end
-
-   # retreive the 'stopped' movement strategy
-   def self.stopped
-     ms = MovementStrategy.find(:first, :conditions => "type = 'Stopped'")
-     ms.nil? ? Stopped.new(:step_delay => 5) : ms
-   end
-
-   # return subclass corresponding to specified strategy type
-   def self.factory(strategy_type)
-     return MovementStrategy if strategy_type.nil?
-
-     if strategy_type.downcase == "stopped" || strategy_type == "Motel::Models::Stopped"
-       return Stopped
-     elsif strategy_type.downcase == "linear" || strategy_type == "Motel::Models::Linear"
-       return Linear
-     elsif strategy_type.downcase == "elliptical" || strategy_type == "Motel::Models::Elliptical"
-       return Elliptical
-     end
-     
-     return MovementStrategy
-   end
-   
-   # convert movement strategy to a hash
-   def to_h
-     {}
-   end
-
-   # convert movement strategy to a string
-   def to_s
-     "id:#{id}; type:#{self.class}" # XXX should be self.type but ruby will complain, this works for now
-   end
-
-end
-
-end # module Models
-end # module Motel

data/lib/motel/models/stopped.rb

@@ -1,16 +0,0 @@
-# The Stopped MovementStrategy model definition
-#
-# Copyright (C) 2009 Mohammed Morsi <movitto@yahoo.com>
-# See COPYING for the License of this software
-
-require 'motel/models/movement_strategy'
-
-module Motel
-module Models
-
-# Stopped is the default MovementStrategy which does nothing 
-class Stopped < MovementStrategy
-end
-
-end # module Models
-end # module Motel