Changeset 251

Timestamp:

01/04/06 05:06:22 (3 years ago)

Author:

ged

Message:

- A bit more work on the Observation epic.

Location:

trunk

Files:

• acceptance/epic5.rb (modified) (3 diffs)
• bin/faeriemud.rb (modified) (4 diffs)
• lib/fm/character.rb (modified) (3 diffs)
• lib/fm/entity.rb (modified) (1 diff)
• lib/fm/event.rb (modified) (1 diff)
• lib/fm/events/astronomical.rb (modified) (1 diff)
• lib/fm/events/meteorological.rb (modified) (1 diff)
• lib/fm/events/science.rb (modified) (1 diff)
• lib/fm/linguistics.rb (modified) (1 diff)
• lib/fm/perception.rb (modified) (1 diff)
• tests/entity.tests.rb (modified) (9 diffs)
• tests/verb.tests.rb (modified) (5 diffs)
• utils.rb (modified) (3 diffs)

trunk/acceptance/epic5.rb

@@ -1 +1 @@
 #!/usr/bin/env ruby
 #
-#   FaerieMUD - The Hidden Path - Epic 5: Volition
+#   FaerieMUD - The Hidden Path - Epic 5: Observation
+#
+#   As a player, I want to be able to observe the world around me, so that I can
+#   distinguish between myself and other things.
 #
 # == Authors
@@ -9 +12 @@
 # == Legal
 # 
-# Copyright (c) 2000-2005 The FaerieMUD Consortium. Some rights reserved.
+# Copyright (c) 2000-2006 The FaerieMUD Consortium. Some rights reserved.
 # 
 # This is free software. You may use, modify, and/or redistribute this software
@@ -31 +34 @@
 require "fm"
 
+

trunk/bin/faeriemud.rb

@@ -11 +11 @@
 end
 
-require 'optparse'
-require 'fm'
+verboseOff {
+    require 'optparse'
+    require 'fm'
+}
 
 
@@ -34 +36 @@
 }
 
+class SimpleVerb < FaerieMUD::Verb
+    @event_class = nil
+    class << self
+        attr_reader :event_class
+    end
+
+    def self::set_event_class( klass )
+        # $deferr.puts "Setting %s's event class to %p" % [ self, klass ]
+        @event_class = klass
+    end
+
+    def self::inherited( mod )
+        super
+        # $deferr.puts "Setting %s's event class to %p" % [ mod, @event_class ]
+        mod.instance_variable_set( :@event_class, @event_class )
+    end
+
+    def invoke( instigator, origin, target=nil )
+        eclass = self.class.event_class or
+            return super
+
+        return eclass.new(
+            :instigator => instigator, 
+            :origin => origin,
+            :target => target,
+            :verb => self )
+    end
+end
+
+# I know, I know -- at least I didn't call it a Heartbeat
+class TickEvent < FaerieMUD::Event
+end
+class TickVerb < SimpleVerb
+    set_event_class TickEvent
+end
+
+# Little world class
+class World < FaerieMUD::Area
+    def start
+        @thread = Thread::new do
+            Thread.current[:running] = true
+            Thread.current.abort_on_exception = true
+
+            while Thread.current[:running]
+                tick = TickVerb.instance.invoke( self, self )
+                immerseEvents( tick )
+                sleep 0.5
+            end
+        end
+
+        trap( 'INT' ) { stop }
+        trap( 'HUP' ) { stop }
+        trap( 'TERM' ) { stop }
+
+        @thread.join
+    end
+
+    def stop
+        return unless @thread
+        @thread[:running] = false
+    end
+
+end
+
+# Stuff for a Spark to do
+class TwinkleVerb < SimpleVerb
+    set_event_class FaerieMUD::VisualEvent
+end
+
+# An active object to occasionally generate observable events
+class Spark < FaerieMUD::Locus
+    def noun
+        'spark'
+    end
+
+    def handleTickEvent( event )
+        if ( rand(100) < 5 )
+            return TwinkleVerb.instance.invoke( self, self )
+        else
+            return []
+        end
+    end
+end
+
 
 # Create the world
 header "FaerieMUD Explorer"
-message "Setting up the world...\n"
-world = FaerieMUD::Area::new
 
 # Create the character
@@ -50 +134 @@
 spirit = FaerieMUD::Spirit::new
 
-# Hook up the CommandParser's IO callbacks
+# Hook up the Spirit's IO callbacks
 message "Setting the Spirit's IO callbacks...\n"
 spirit.onInputReady do |promptText|
@@ -65 +149 @@
 
 # Stick the character's body into the world Area
-message "Placing the Character's body in the World...\n"
+message "Setting up the world...\n"
+world = World::new
+spark = Spark::new
+world << spark
+
+message "Placing the Character's body in the world...\n"
 world << character.body
 
+$defout.sync = true
+$deferr.sync = true
+
+world.start
+
+

trunk/lib/fm/character.rb

@@ -74 +74 @@
     #############################################################
 
+    ### Create a new FaerieMUD::Character object.
+    def initialize( args={} )
+        @verbs = []
+
+        super
+    end
+
 
     ######
@@ -79 +86 @@
     ######
 
+    ### The Array of FaerieMUD::Verb objects which define this character's
+    ### abilities.
+    attr_reader :verbs
     
 
@@ -129 +139 @@
 
 
-    #########
-    protected
-    #########
-
-
 end # class FaerieMUD::Character
 

trunk/lib/fm/entity.rb

@@ -111 +111 @@
         debugMsg( 1, "Handling a #{event.class.name} event." )
         handler = self.getHandlerForEvent( event )
-        return handler.call( event )
+        result = handler.call( event )
+
+        return Array( result )
     end
 

trunk/lib/fm/event.rb

@@ -133 +133 @@
 
         return sentence.join( " " )
-        
     end
 

trunk/lib/fm/events/astronomical.rb

@@ -34 +34 @@
         # SVN Id
         SVNId = %q$Id$
-
-        # SVN URL
-        SVNURL = %q$URL$
 
     end # class AstronomicalEvent

trunk/lib/fm/events/meteorological.rb

@@ -37 +37 @@
 
 
+### Object which represents a timeslice of precipitation of some kind. They will
+### most probably be generated by a precipitation activity of a weather system,
+### which propagates these events to simulate the ongoing rainfall, snowfall,
+### etc.
+class FaerieMUD::PrecipitationEvent < FaerieMUD::MeteorologicalEvent
+    contributors :ged
+
+    # SVN Revision
+    SVNRev = %q$Rev$
+
+    # SVN Id
+    SVNId = %q$Id$
+
+    # The default amount of water in a slice of rainfall, in cubic meters.
+    DefaultAmount = 0.01
+
+    # The default temperature of a slice of rainfall
+    DefaultTemperature = 25
+
+
+    ### Create a RainEvent which represents the falling of a collection of
+    ### drops. The amount, temperature, and intensity can be specified with
+    ### optional hash +args+.
+    def initialize( args={} )
+        @amount = args[:amount] || DefaultAmount
+        @temperature = args[:temperature] || DefaultTemperature
+    end
+
+    
+    ######
+    public
+    ######
+
+    # The amount of water in this slice of rainfall.  Value may be between
+    # 0.01 (mist) to 1.0 (deluge).
+    attr_accessor :amount
+
+    # The temperature of the water in this slice of rainfall. Value may be between 
+    attr_accessor :temperature
+
+end

trunk/lib/fm/events/science.rb

@@ -34 +34 @@
     SVNId = %q$Id$
 
-    # SVN URL
-    SVNURL = %q$URL$
 
 end # class FaerieMUD::ScienceEvent

trunk/lib/fm/linguistics.rb

@@ -91 +91 @@
 
 
+    ### Linguistic sentence class -- instances of this class are used to
+    ### encapsulate single-sentence chunks of linguistic content in the
+    ### natural-language system.
     class Sentence
         include FaerieMUD::Linguistics

trunk/lib/fm/perception.rb

@@ -48 +48 @@
     #################################################################
 
-    # GWRN: 44975
-    ### Create a new Perception for the given +perceiver+, which 
+    ### Create a new Perception for the given +perceiver+, which will be the
+    ### deleated describer of any PerceptualEvents which are handled.
     def initialize( perceiver, args={} )
         @perceiver = perceiver

trunk/tests/entity.tests.rb

@@ -4 +4 @@
 # $Id$
 #
-# Copyright (c) 2003, 2004, 2005 The FaerieMUD Consortium.
+# Copyright (c) 2003-2006 The FaerieMUD Consortium.
 # 
 
@@ -38 +38 @@
     class DerivTestingEvent < TestingEvent; end
     class DerivDerivTestingEvent < DerivTestingEvent; end
+    class ResultEvent < FaerieMUD::Event
+        def initialize; end
+    end
+
 
 
@@ -43 +47 @@
     def setup
         @entity = TestingEntity::new
+        @testingEvent = TestingEvent::new
+        @derivTestingEvent = DerivTestingEvent::new
+        @derivDerivTestingEvent = DerivDerivTestingEvent::new
     end
 
@@ -58 +65 @@
     def test_unhandled_events_should_raise_an_exception
         rval = nil
-        te = TestingEvent::new
-        dte = DerivTestingEvent::new
 
         # Passing an event without a specific handler should cause an exception
         # to be raised.
         assert_raises( FaerieMUD::UnhandledEventError ) {
-            @entity.handleEvents( te )
+            @entity.handleEvents( @testingEvent )
         }
         assert_raises( FaerieMUD::UnhandledEventError ) {
-            @entity.handleEvents( dte )
+            @entity.handleEvents( @derivTestingEvent )
         }
     end
@@ -75 +80 @@
     def test_entities_which_define_fallback_handler_should_handle_any_event
         rval = nil
-        te = TestingEvent::new
-        dte = DerivTestingEvent::new
 
         # Add a fallback handler
@@ -86 +89 @@
         # Now try again -- both kinds of event should be handled by the fallback
         # handler now.
-        assert_nothing_raised { @entity.handleEvents( te ) }
-        assert_same te, @entity.lastSeenEvent, "last seen event"
+        assert_nothing_raised { @entity.handleEvents(@testingEvent) }
+        assert_same @testingEvent, @entity.lastSeenEvent, "last seen event"
         assert_equal :handleAnyEvent, @entity.lastHandler
-        assert_nothing_raised { @entity.handleEvents( dte ) }
-        assert_same dte, @entity.lastSeenEvent, "last seen event"
+        assert_nothing_raised { @entity.handleEvents(@derivTestingEvent) }
+        assert_same @derivTestingEvent, @entity.lastSeenEvent, "last seen event"
         assert_equal :handleAnyEvent, @entity.lastHandler
 
@@ -99 +102 @@
     def test_entities_should_handle_derivative_events_with_more_general_handlers
         rval = nil
-        te = TestingEvent::new
-        dte = DerivTestingEvent::new
-        ddte = DerivDerivTestingEvent::new
 
         def @entity.handleTestingEvent( ev )
@@ -108 +108 @@
         end
 
-        assert_nothing_raised { @entity.handleEvents(te) }
-        assert_same te, @entity.lastSeenEvent,
+        assert_nothing_raised { @entity.handleEvents(@testingEvent) }
+        assert_same @testingEvent, @entity.lastSeenEvent,
             "last seen event for TestingEvent"
         assert_equal :handleTestingEvent, @entity.lastHandler,
             "last handler for TestingEvent"
 
-        assert_nothing_raised { @entity.handleEvents(dte) }
-        assert_same dte, @entity.lastSeenEvent,
+        assert_nothing_raised { @entity.handleEvents(@derivTestingEvent) }
+        assert_same @derivTestingEvent, @entity.lastSeenEvent,
             "last seen event for DerivTestingEvent"
         assert_equal :handleTestingEvent, @entity.lastHandler,
             "last handler for DerivTestingEvent"
 
-        assert_nothing_raised { @entity.handleEvents(ddte) }
-        assert_same ddte, @entity.lastSeenEvent,
+        assert_nothing_raised { @entity.handleEvents(@derivDerivTestingEvent) }
+        assert_same @derivDerivTestingEvent, @entity.lastSeenEvent,
             "last seen event for DerivDerivTestingEvent"
         assert_equal :handleTestingEvent, @entity.lastHandler,
@@ -128 +128 @@
 
 
+    def test_event_handler_should_be_able_to_handle_single_event_result
+        rval = nil
+
+        def @entity.handleTestingEvent( ev )
+            return ResultEvent::new
+        end
+
+        assert_nothing_raised { rval = @entity.handleEvents(@testingEvent) }
+        assert_instance_of Array, rval
+        assert_equal 1, rval.length
+        assert_instance_of ResultEvent, rval[0]
+
+        assert_nothing_raised { rval = @entity.handleEvent(@testingEvent) }
+        assert_instance_of Array, rval
+        assert_equal 1, rval.length
+        assert_instance_of ResultEvent, rval[0]
+    end
+
 end
 

trunk/tests/verb.tests.rb

@@ -4 +4 @@
 # $Id$
 #
-# Copyright (c) 2004, 2005 The FaerieMUD Consortium.
+# Copyright (c) 2004-2006 The FaerieMUD Consortium.
 # 
 
@@ -43 +43 @@
 
     ### Instance test
-    def test_00_Instance
-        printTestHeader "FaerieMUD::Verb: Class/instantiation"
+    def test_verb_class_should_be_defined_and_a_singleton
         rval = nil
 
@@ -60 +59 @@
 
 
-    ### Event-generation interface
-    def test_50_invoke
-        printTestHeader "FaerieMUD::Verb: Event-generation interface: invoke"
+    # Event interface: Things which employ verbs expect to be able to fire the
+    # verb and get back one or more appropriate events.
+    def test_verbs_should_be_able_to_be_invoked
         rval = nil
 
@@ -80 +79 @@
 
 
-    ### CommandParser interface
-    def test_60_words
-        printTestHeader "FaerieMUD::Verb: CommandParser interface: words"
+    # CommandParser interface: Verbs should be able to provide a list of
+    # commands they expect to be invoked for.
+    def test_verbs_should_be_able_to_provide_a_list_of_autogenerated_command_words
         rval = nil
         verb = TestVerb::instance
@@ -95 +94 @@
     end
 
+    # Subclasses of Verbs should be singletons, too.
+    def test_subclasses_should_be_singletons
+        rval = nil
+
+        assert_raises( NoMethodError ) { TestVerb.new }
+        assert_nothing_raised { rval = TestVerb.instance }
+
+        assert_instance_of TestVerb, rval
+    end
 
 end

trunk/utils.rb

@@ -3 +3 @@
 #   $Id: utils.rb,v 1.20 2003/11/23 04:37:57 stillflame Exp $
 #
-#   Copyright (c) 2001-2005, The FaerieMUD Consortium.
+#   Copyright (c) 2001-2006, The FaerieMUD Consortium.
 #
 #   This is free software. You may use, modify, and/or redistribute this
@@ -26 +26 @@
     end
 
-    begin
-        require 'yaml'
-        $yaml = true
-    rescue LoadError => e
-        $stderr.puts "No YAML; try() will use PrettyPrint instead."
-        $yaml = false
-    end
 }
 
@@ -642 +635 @@
             end
 
-            if $yaml
-                result = rval.to_yaml
-            else
-                PP.pp( rval, result )
-            end
+            PP.pp( rval, result )
 
         rescue Exception => err