gondorlibrary 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+== gondorlibrary
+
+Copyright (c) Mar 31, 2008 Phillip Gawlowski
+ 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/License

@@ -0,0 +1,21 @@
+== gondorlibrary
+
+Copyright (c) Mar 31, 2008 Phillip Gawlowski
+ 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/MANIFEST

@@ -0,0 +1,18 @@
+lib/entity.rb
+lib/exception.rb
+lib/messages.rb
+lib/queue.rb
+lib/relationships.rb
+gondorlibrary.rb
+html
+lib
+License
+MANIFEST
+nbproject
+Rakefile
+README
+test
+test/test_entity.rb
+test/test_messages.rb
+test/test_queue.rb
+test/test_relationships.rb

data/README

@@ -0,0 +1,40 @@
+=gondorlibrary
+
+The Gondor Library enables users of the Ruby language (on the MRI, JRuby or IronRuby)
+to quickly implement agents for all kinds of situations (for example game AI, or
+stock market modeling), while focusing on the task at hand, instead of writing a
+full agent simulation.
+
+It is currently fully implemented in Ruby itself, with no outside dependencies.
+
+=Installation and Usage
+
+gem install gondorlibrary
+
+require "rubygems"
+require "gondor"
+
+braveheart = Gondor::AI:Entity.new("William Wallace")
+braveheart.killed_english_men 100
+braveheart.update_killed_english_men 50
+puts braveheart.killed_english_men
+
+Get the source:
+
+svn checkout http://gondorlibrary.googlecode.com/svn/trunk/ gondorlibrary-read-only
+
+=About
+Milestone 1 (Version 0.1.0) contains a  very basic, but working Entity system, featuring message sending, queues, and flexible entity creation.
+
+=Features
+   
+  * Entity attributes, that can be changed over time, and can be arbitrarily defined at runtime (either at the first call, or beforehand).
+  * Simple message queuing and retrieval (nothing more implemented yet).
+  
+=The Near Future
+GL will receive its own language (a DSL, I guess), to create rules and messages for the entities, to make use as easy as possible.
+
+= Online
+  * Project home and source code and end user documentation: http://code.google.com/p/gondorlibrary/
+  * API and hacker's documentation: http://gondorlibrary.rubyforge.org/
+  * Discussion: http://groups.google.com/group/gondor-library-discussion

data/Rakefile

@@ -0,0 +1,138 @@
+# 
+# ENV['svn']: SVN log message
+# ENV['version']: Gondor Library Version to release
+#
+ 
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rcov/rcovtask'
+require "rake/gempackagetask"
+require 'FileUtils'
+
+#Helper to make GMail work. 
+#See http://d.hatena.ne.jp/zorio/20060416 and
+#http://www.jamesbritt.com/2007/12/18/sending-mail-through-gmail-with-ruby-s-net-smtp
+#require 'smtp_tls'
+
+RCOV = "rcov"
+GL_DEFAULT_VERSION = "0.1.0"
+
+ENV['version'] = GL_DEFAULT_VERSION unless ENV['version']
+
+task :default => ["test"]
+task :all => ["coverage","rdoc"]
+task :gem => ["coverage"]
+
+desc "runs all tests without RCov"
+Rake::TestTask.new("test") do |test|
+  #test.name = "test"
+  test.warning = true
+  test.verbose = true
+  test.test_files = FileList['test/test*.rb']
+end
+
+desc "Runs tests with coverage by RCov"
+Rcov::RcovTask.new do |task|
+  task.libs << "test"
+  task.name = "coverage"
+  task.test_files = FileList["test/test*.rb"]
+  task.verbose = true
+end
+
+desc "create RDoc documentation"
+rd = Rake::RDocTask.new do |rdoc|
+  rdoc.name = "rdoc"
+  rdoc.main = "README"
+  rdoc.rdoc_files.include("README","LICENSE","lib/*.rb")
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--main' << 'README' <<
+    '--title' <<  "Gondor Library #{ENV['version']}" 
+end
+
+desc "write the MANIFEST out"
+task :manifest do
+  files = FileList['lib/**/*.rb', '[A-Z]*', 'test/**/*'].exclude('smtp_tls.rb').to_a
+  File.open("MANIFEST","w") do |f|
+    f.puts files
+  end
+end
+
+gem = Gem::Specification.new do |g|
+  g.platform = Gem::Platform::RUBY
+  g.summary = "A library for agent based computing"
+  g.name = "gondorlibrary"
+  g.version = ENV['version']
+  g.files = FileList['lib/**/*.rb', '[A-Z]*', 'test/**/*'].exclude('smtp_tls.rb').to_a
+  # This is needed to include files in ./ by RubyGems. Yes, they are included in FileList.
+  g.extra_rdoc_files = ["README", "LICENSE"]
+
+  g.description = <<EOF
+  Gondor Libraray provides a framework to work with agent based computing,
+from game AIs, to swarm simulations.
+EOF
+  g.rdoc_options = rd.options
+  g.has_rdoc = true
+  g.author = "Phillip Gawlowski"
+  g.homepage = "http://code.google.com/p/gondorlibrary/"
+  g.email = "p.gawlowski@gmail.com"
+  g.rubyforge_project = "gondorlibrary"
+end
+desc "Build the #{gem.name} gem"
+Rake::GemPackageTask.new(gem) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+desc "Publishes RDoc to Rubyforge"
+task :publishdoc => [:rdoc] do
+  system "cd html && pscp -load rubyforge -r * cynicalryan@rubyforge.org:/var/www/gforge-projects/gondorlibrary/"
+end
+
+desc "commit changes to svn"
+task :commit => [:test,:publishdoc] do
+  system "svn ci -m \"#{ENV['svn']}\""
+end
+
+Rake::PackageTask.new("gondorlibrary", ENV['version']) do |p|
+    p.need_tar = true
+    p.need_zip = true
+    p.package_files.include(FileList['lib/**/*.rb', '[A-Z]*', 'test/**/*'].exclude('smtp_tls.rb').to_a)
+end
+
+
+desc "Upload release to RubyForge"
+task :upload => [:test,:package]do
+  puts "Loggin into Rubyforge"
+  system "rubyforge login"
+  puts "Adding release"
+  bla = system "rubyforge -n README add_release 5933 7575 #{ENV['version']} pkg/gondorlibrary-#{ENV['version']}.gem"
+  puts bla
+  system "rubyforge -n README add_release 5933 7575 #{ENV['version']} pkg/gondorlibrary-#{ENV['version']}.tgz"
+  system "rubyforge -n README add_release 5933 7575 #{ENV['version']} pkg/gondorlibrary-#{ENV['version']}.zip"
+  puts "Adding File"
+  bla = system "rubyforgeadd_file 5933 7575 #{ENV['version']} pkg/gondorlibrary-#{ENV['version']}.gem"
+  puts bla
+  system "rubyforge add_file 5933 7575 #{ENV['version']} pkg/gondorlibrary-#{ENV['version']}.tgz"
+  system "rubyforge add_file 5933 7575 #{ENV['version']} pkg/gondorlibrary-#{ENV['version']}.zip"
+end  
+
+desc "Announce Release"
+#task :announce => [:commit,:upload] do
+#  require "net/smtp"
+#  from = "Phillip Gawlowski <cmdjackryan@gmail.com>"
+#  to = "Ruby Talk ML <ruby-talk@ruby-lang.org>, Gondor Library Discussion <gondor-library-discussion@googlegroups.com>"
+#  header =<<EOH
+#From: Phillip Gawlowski <cmdjackryan@gmail.com>
+#To: Ruby Talk ML <ruby-talk@ruby-lang.org>, Gondor Library Discussion <gondor-library-discussion@googlegroups.com>
+#Subject [ANN] Gondor Library #{ENV['version']}
+#EOH
+#  message = File.read("README")
+#  mail = header + message
+#  username = ENV['user']
+#     password = ENV['password']
+#     Net::SMTP.start('smtp.gmail.com', 597, 'localhost.localdomain', username, password, 'plain' ){|smtp|
+#        smtp.send_message(mail, from, to)
+#    }
+#end

data/gondorlibrary.rb

@@ -0,0 +1,26 @@
+# 
+#  Copyright (c) Apr 1, 2008 Phillip Gawlowski
+# 
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+# 
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+# 
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+ 
+
+require 'lib/entity'
+require 'lib/queue'
+require 'lib/relationships'
+require 'lib/messages'

data/lib/entity.rb

@@ -0,0 +1,163 @@
+#
+#  Copyright (c) Mar 31, 2008 Phillip Gawlowski
+# 
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+# 
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+# 
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+#
+# The Module Gondor::AI:Entity contains the methods related to +Entities+:
+# 
+# You can create a new Entity by passing some, non, or all of the arguments. If 
+# for all arguments provided, the instantiation will use the default falues
+# defined in Gondor::AI:Entity:DEFAULT_AI_OPTIONS. However, these options can be 
+# overriden at any time.
+# 
+# For exmaple:
+#
+# +irb(main):001:0> agent = Gondor::AI::Entity.new+
+# => #<Gondor::AI::Entity:0x2832fa0 @message_queue=[], @y=0, @courage=0, @x=0, 
+# @net_worth=0, @name="John Doe", @patience=100, @hunger=100, @z=0>
+# 
+# Default values:
+# DEFAULT_AI_OPTIONS = {
+#   :name => "John Doe",
+#   :hunger => 100,
+#   :patience => 100,
+#   :courage => 0,
+#   :net_worth => 0,
+#   :message_queue => [],
+#   :x => 0,
+#   :y => 0,
+#   :z => 0
+# }
+# 
+
+require "lib/exception"
+
+module Gondor
+  
+  module AI
+  
+    class Entity
+      # The default values for a new AI +Entity+.
+      DEFAULT_AI_OPTIONS = {
+        :name => "John Doe",
+        :hunger => 0,
+        :patience => 0,
+        :courage => 0,
+        :net_worth => 0,
+        :x => 0,
+        :y => 0,
+        :z => 0,
+        :parent => [],
+        :child => []
+      }
+      
+      attr_accessor :hunger,:name,:courage,:patience,:net_worth
+      attr_accessor :x,:y,:z
+      attr_reader :parent, :child
+      
+      # Initializes a new Entity with +DEFAULT_AI_OPTIONS+, unless these values
+      # are overridden when a new +Entity+ is created.
+      def initialize(options = {})
+        options = DEFAULT_AI_OPTIONS.merge(options)
+        @name = options[:name]
+        @hunger = options[:hunger]
+        @net_worth = options[:net_worth]
+        @courage = options[:courage]
+        @patience = options[:patience]
+        @x = options[:x]
+        @y = options[:y]
+        @z = options[:z]
+        @parent = options[:parent]
+        @child = options[:child]
+      end
+
+      # Modifies the patience value by +update_factor+.
+      def update_patience(update_factor)
+          @patience += update_factor
+      end
+      
+      # Updates the courage value by +update_factor+.
+      def update_courage(update_factor)
+          @courage += update_factor
+      end
+
+      # Updates the hunger value by +update_factor+.
+      def update_hunger(update_factor)
+          @hunger += update_factor
+      end
+      
+      # Updates the net_worth value by +update_factor+.
+      def update_net_worth(update_factor)
+          @net_worth += update_factor
+      end
+
+      # Moves the actor across a *spatial* axis for *distance* units.
+      def move(spatial,distance)
+        case spatial.downcase
+          when "x" then @x += distance
+          when "y" then @y += distance
+          when "z" then @z += distance
+          else raise ArgumentError("Axis not found")
+        end
+      end
+
+      # Returns the current +location+ as +String+
+      def entity_location
+        "x: #{@x} | y: #{@y} | z: #{@z}"
+      end
+      
+      
+      # Calculates the relative +distance_to+ an arbitrary actor
+      # Note: The algorithm is not yet optimized for speed.
+      # Hopefully, it is accurate, though.
+      def distance_to(actor)
+        # Stub, will use vector math or so to approximate the true distance
+        distance = (self.x - actor.x) ** 2 + (self.y - actor.y) ** 2 + (self.z - actor.z) ** 2
+        Math::sqrt(distance)
+      end
+
+      def stats #:nodoc:
+        puts "#{@name}'s Stats"
+        puts "Hunger: #{@hunger}"
+        puts "Courage: #{@courage}"
+        puts "Net worth: #{@net_worth}"
+        puts "Patience: #{@patience}"
+      end
+      
+      # +method_missing+ creates all these nifty little methods you need to grab 
+      # instance variables (nee attributes) of your actors. It uses a rather 
+      # specific format: You call the attribute you want to set with a value to 
+      # set it to. With this information, +method_missing+ creates an instance 
+      # variable for you, and sets it to the value you gave. After this, it 
+      # creates a *getter* and *setter* *method* (the method name you used),
+      # to pull the value of the attribute out, as well as set it. An update method
+      # method is created, called +update_methodname+, and allows you to update 
+      # the attribute.
+      # 
+      # TODO: Example for method_missing workflow.
+      # 
+      def method_missing symbol, *args
+        eval "self.instance_variable_set :@#{symbol},*args"
+        eval "def #{symbol}; @#{symbol};end"
+        eval "def #{symbol}=(update_value); @#{symbol} = update_value;end"
+        eval "def update_#{symbol} update_value; @#{symbol} += update_value;end"
+      end
+    end
+  end
+end

data/lib/exception.rb

@@ -0,0 +1,14 @@
+module Gondor
+  
+  # Gondor Library's Exceptions.
+  class ImplementationException < Exception 
+    def initialize(*args)
+      puts "Exception:\nThe method '#{args}' has to yet to be implemented"
+    end
+  end
+  class QueueException < Exception
+    def initialize(*args)
+      puts "Exception:\nThe queue '#{args}' does not exist"
+    end
+  end
+end

data/lib/messages.rb

@@ -0,0 +1,44 @@
+# 
+#  Copyright (c) Apr 3, 2008 Phillip Gawlowski
+# 
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+# 
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+# 
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+ 
+
+require 'queue'
+require 'exception'
+
+module Gondor
+  module AI
+    class Messages
+      # Collects the messages pending from sender in a given queue.
+      def initialize options
+        @sender = options[:from]
+        @in_queue = options[:in_queue]
+        @queue = nil
+        Gondor::Queues.each do |q|
+          @queue = q if q.name == @in_queue
+        end
+        @messages = @queue.queue[@sender]
+      end
+      def open
+        @messages
+      end
+    end
+  end
+end

data/lib/queue.rb

@@ -0,0 +1,80 @@
+# 
+#  This contains the logic for the Gondor Library Queues. All queues derive from
+#  this, and extend it, where necessary.
+#  
+#  The Queue takes its name as argument during initialization.
+
+require 'exception'
+
+module Gondor
+  
+  # Stores all the queues initialized during the usage.
+  Queues = []
+  
+    class Queue
+      attr_reader :name,:queue
+      
+      # Initializes a new Queue, with the +name+ "name", and adds the name of 
+      # the queue to +Queues+, a Module Constant, containing references 
+      # to the queues themselves, for future access.
+      def initialize(name)
+        @name = name
+        @content = {}
+        @queue = {}
+        store self
+      end
+      # Adds *one* message from one +sender+ to *multiple* *+recipients+* to the
+      # queue, with a given priority.
+      # 
+      # Currently, each receiver can have only *one* *message* from each sender!
+      # 
+      def add_message(options = {})
+        @receiver = []
+        @message = []
+        @sender = options[:sender]
+        @receiver.push options[:receiver]
+        @priority = options[:priority]
+        @message.push options[:message]
+        @placeholder = [] unless @placeholder
+        @placeholder.push options[:message]
+        if @queue.empty?
+          @receiver.each do |receiver_key|
+            @queue = { receiver_key => {@sender => {@priority => @message}}}
+          end
+        else
+          @receiver.each do |queue_key|
+            @priority_hash = @queue[queue_key]
+            priorities = @priority_hash.keys
+            priorities.each do ||
+              @new_message = {@sender => {@priority => @message}}
+              @priority_hash = @priority_hash.merge @new_message
+              @new_message.clear
+            end
+            @queue[queue_key] = @queue[queue_key].merge @priority_hash
+          end
+        end
+        @priorities = {@priority => @placeholder}
+        @receiver.clear
+        @sender = nil
+      end
+      
+      def receiver
+        @queue.keys
+      end
+      def senders
+        receivers = receiver
+        @temp = []
+        receivers.each{ |r| @temp = @queue[r]}
+        result =  @temp.keys
+        @temp.clear
+        return result.sort
+      end
+      def priority
+        @priorities
+      end
+      private
+      def store q
+        Gondor::Queues.push q
+      end
+    end
+end   

data/lib/relationships.rb

@@ -0,0 +1,40 @@
+# 
+#  Copyright (c) Apr 3, 2008 Phillip Gawlowski
+# 
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+# 
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+# 
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+ 
+module Gondor
+
+  class Relationships
+    attr_reader :name, :parents,:children
+    def initialize(name)
+      @name = name
+      @parents = []
+      @children = []
+    end
+    
+    def set_parent(name)
+      @parents.push name
+    end
+    def set_child(name)
+      @children.push name
+    end
+    
+  end
+end

data/test/test_entity.rb

@@ -0,0 +1,73 @@
+# 
+#  Copyright (c) Mar 31, 2008 Phillip Gawlowski
+# 
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+# 
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+# 
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+ 
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'entity'
+
+class TestGondorAI < Test::Unit::TestCase
+  def test_init
+    actor1 = Gondor::AI::Entity.new
+    assert(true, actor1)
+    actor2 = Gondor::AI::Entity.new(:name => "William", :patience => 100, :net_worth => 10000, :hunger => 50, :courage => -50)
+    assert_equal "William", actor2.name
+    assert_equal 100, actor2.patience
+    assert_equal 10000, actor2.net_worth
+    assert_equal 50, actor2.hunger
+    assert_equal(-50, actor2.courage)
+  end
+  def test_distance
+    actor1 = Gondor::AI::Entity.new(:x => 10, :y=>10, :z => 10)
+    actor2 = Gondor::AI::Entity.new(:x => 17, :y=>17, :z => 17)
+    assert_equal Math::sqrt(((actor1.x - actor2.x) ** 2 + (actor1.y - actor2.y) ** 2 + (actor1.z - actor2.z) ** 2)), actor1.distance_to(actor2)
+    actor1 = Gondor::AI::Entity.new(:x => 5, :y=>5, :z => 5)
+    actor2 = Gondor::AI::Entity.new(:x => 17, :y=>17, :z => 17)
+    assert_equal Math::sqrt(((actor1.x - actor2.x) ** 2 + (actor1.y - actor2.y) ** 2 + (actor1.z - actor2.z) ** 2)), actor1.distance_to(actor2)
+  end
+  def test_update_attributes
+    actor1 = Gondor::AI::Entity.new
+    assert_equal(-5,actor1.update_patience(-5))
+    assert_equal(900,actor1.update_hunger(900))
+    assert_equal(50,actor1.update_courage(50))
+    assert_equal(1,actor1.update_net_worth(1))
+  end
+  def test_spatial_movement_and_location
+    actor1 = Gondor::AI::Entity.new
+    actor1.move "x",10
+    assert_equal 10,actor1.x
+    actor1.move("y", -10)
+    assert_equal(-10,actor1.y)
+    actor1.move("z",5000)
+    assert_equal 5000,actor1.z
+    #assert_equal(ArgumentError("Axis not found"), actor1.move("d",50)) 
+    #TODO: code test for exception handling
+    assert_equal("x: 10 | y: -10 | z: 5000",actor1.entity_location)
+  end
+  def test_unhandled_methods
+    actor = Gondor::AI::Entity.new
+    actor.no_such_method 20
+    assert_equal 20,actor.no_such_method
+    actor.update_no_such_method(-10)
+    assert_equal 10,actor.no_such_method
+  end
+end

data/test/test_messages.rb

@@ -0,0 +1,40 @@
+# 
+#  Copyright (c) Apr 3, 2008 Phillip Gawlowski
+# 
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+# 
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+# 
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+ 
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'queue'
+require 'messages'
+
+class TestMessages < Test::Unit::TestCase
+  def test_init
+    # Create a queue
+    queue = Gondor::Queue.new("test_message")
+    # Populate the queue
+    queue.add_message(:sender => "Sender", :receiver => "Receiver", :priority => :one, :message => "A message")
+    # The actual test
+    messages = Gondor::AI::Messages.new(:from => "Receiver",:in_queue => "test_message")
+    assert(true, messages)
+    assert_equal({"Sender" => {:one => ["A message"]}}, messages.open)
+  end
+end

data/test/test_queue.rb

@@ -0,0 +1,50 @@
+# 
+#  Copyright (c) Apr 3, 2008 Phillip Gawlowski
+# 
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+# 
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+# 
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+ 
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'queue'
+
+class TestEntityQueue < Test::Unit::TestCase
+  def test_initialize
+    queue = Gondor::Queue.new("test_initialize")
+    assert(true, queue)
+    assert_equal "test_initialize", queue.name
+  end
+  def test_queue_content
+    queue = Gondor::Queue.new("test_queue_content")
+    assert_equal({},queue.queue)
+  end
+  def test_add_queue_message
+    queue = Gondor::Queue.new("test_add_queue_message")
+    queue.add_message(:sender => "Sender", :receiver => "Receiver", :priority => :one, :message => "A message")
+    queue.add_message(:sender => "Another Sender", :receiver => "Receiver", :priority => :one, :message => "Another message")
+    assert_equal ["Receiver"],queue.receiver
+    assert_equal ["Sender","Another Sender"].sort,queue.senders
+    assert_equal({:one => ["A message","Another message"]},queue.priority)
+  end
+  def test_store_queue
+    queue = Gondor::Queue.new("test_store_queue")
+    assert_equal(true,Gondor::Queues.include?(queue))
+  end
+end

data/test/test_relationships.rb

@@ -0,0 +1,44 @@
+# 
+#  Copyright (c) Apr 3, 2008 Phillip Gawlowski
+# 
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+# 
+#  The above copyright notice and this permission notice shall be included in
+#  all copies or substantial portions of the Software.
+# 
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#  THE SOFTWARE.
+ 
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'relationships'
+
+class TestRelationships < Test::Unit::TestCase
+  def test_init
+    relation = Gondor::Relationships.new("My Relations")
+    assert(true, relation)
+    assert_equal "My Relations",relation.name
+  end
+  def test_parents
+    relation = Gondor::Relationships.new("test_parents")
+    relation.set_parent("A Parent")
+    assert_equal ["A Parent"], relation.parents
+  end
+  def test_children
+    relation = Gondor::Relationships.new("test_children")
+    relation.set_child("A Child")
+    assert_equal ["A Child"],relation.children
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: gondorlibrary
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Phillip Gawlowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-05 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Gondor Libraray provides a framework to work with agent based computing, from game AIs, to swarm simulations.
+email: p.gawlowski@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- lib/entity.rb
+- lib/exception.rb
+- lib/messages.rb
+- lib/queue.rb
+- lib/relationships.rb
+- coverage
+- gondorlibrary.rb
+- lib
+- License
+- MANIFEST
+- nbproject
+- pkg
+- Rakefile
+- README
+- test
+- test/test_entity.rb
+- test/test_messages.rb
+- test/test_queue.rb
+- test/test_relationships.rb
+- LICENSE
+has_rdoc: true
+homepage: http://code.google.com/p/gondorlibrary/
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README
+- --title
+- Gondor Library 0.1.0
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: gondorlibrary
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: A library for agent based computing
+test_files: []
+