Changeset 252

Timestamp:

01/27/06 15:07:23 (3 years ago)

Author:

ged

Message:

- Hooked up some of the volition stuff in Spirit.
- Added beginnings of the description-generation system.

Location:

trunk

Files:

• lib/fm/commandparser.rb (modified) (2 diffs)
• lib/fm/entity.rb (modified) (1 diff)
• lib/fm/gameobject.rb (modified) (1 diff)
• lib/fm/linguistics.rb (modified) (2 diffs)
• lib/fm/perception.rb (modified) (1 diff)
• lib/fm/spirit.rb (modified) (7 diffs)
• lib/fm/verb.rb (modified) (4 diffs)
• lib/fm/verbs (added)
• lib/fm/verbs/all.rb (added)
• lib/fm/verbs/simple.rb (added)
• tests/commandparser.tests.rb (modified) (6 diffs)
• tests/linguistics.tests.rb (modified) (4 diffs)
• tests/simpleverb.tests.rb (added)
• tests/spirit.tests.rb (modified) (6 diffs)
• tests/verb.tests.rb (modified) (6 diffs)

trunk/lib/fm/commandparser.rb

@@ -56 +56 @@
 
 
+    ### Return the set of FaerieMUD::Verb objects this parser knows about
+    def verbs
+        return @verbset.values.uniq
+    end
+
+
     ### Update the parser's verb set from the given +verbs+.
     def updateVerbSet( *verbs )
@@ -80 +86 @@
 
 
+    
+
 end # class FaerieMUD::CommandParser
 

trunk/lib/fm/entity.rb

@@ -130 +130 @@
 
 
+    #
+    #   Linguistics support
+    #
+
+    ### Returns +true+ if the entity should be considered plural for the
+    ### purposes of generating english text.
+    def plural?
+        return false
+    end
+
+
 
     #########

trunk/lib/fm/gameobject.rb

@@ -154 +154 @@
 
 
+    ### Create an example instance of the receiving class. This is used to ease
+    ### the complexity of creating example objects for experimentation. This
+    ### should be overridden by object classes which require instantiation
+    ### arguments.
+    def self::example( args={} )
+        self::new( args )
+    end
+
+
     #############################################################
     ### I N S T A N C E   M E T H O D S

trunk/lib/fm/linguistics.rb

@@ -97 +97 @@
         include FaerieMUD::Linguistics
 
-        ### Create the sentence with the given +subject+, +verb+, and
-        ### optional +direct_object+.
-        def initialize( subject, verb, direct_object=nil, *prep_phrases )
-            @subject = subject
-            @verb = verb
-            @direct_object = direct_object
-            @prep_phrases = prep_phrases
+        ### Create the sentence. Can be constructed either with an explicit
+        ### subject, verb, and optional direct object, or with a
+        ### FaerieMUD::Event that will provide these parts.
+        def initialize( *args )
+            if args.length == 1
+                init_from_event( args.first )
+            else
+                init_from_parts( *args )
+            end
         end
 
-        attr_reader :subject, :verb, :direct_object
+
+        # The subject of the sentence (a FaerieMUD::GameObject object)
+        attr_reader :subject
+
+        # The FaerieMUD;;Verb instance associated with the sentence
+        attr_reader :verb
+
+        # The FaerieMUD::GameObject which is the recipient of the action in the
+        # sentence, if any.
+        attr_reader :direct_object
 
 
@@ -113 +124 @@
             parts = [
                 makeNounPhrase( @subject ),
-                conjugateVerb( @verb, @subject )
+                @verb.inflect_for( @subject )
             ]
 
             parts << makeNounPhrase( @direct_object ) if @direct_object
-            parts.push( *(@prep_phrases.flatten.compact) )
 
             return parts.join( " " ) + "."
         end
+
+
+        #########
+        protected
+        #########
+
+        ### Set the members of the sentence from the parts of the given +event+
+        ### (a FaerieMUD::Event object).
+        def init_from_event( event )
+            init_from_parts( event.instigator, event.verb, event.target )
+        end
+
+        ### Set the members of the sentence from the given +subject+, +verb+,
+        ### and +direct_object+.
+        def init_from_parts( subject, verb, direct_object=nil )
+            @subject = subject
+            @verb = verb
+            @direct_object = direct_object
+        end
+
+
     end
 

trunk/lib/fm/perception.rb

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

trunk/lib/fm/spirit.rb

@@ -120 +120 @@
     ### Create a new FaerieMUD::Spirit object.
     def initialize( args={} )
-        @animatedObjects = []
+        @animatedObject = nil
         @parser = FaerieMUD::CommandParser::new
 
@@ -134 +134 @@
         }
 
+        @inputThread = nil
+        @running = false
+
         super
     end
@@ -145 +148 @@
     attr_locked_reader :parser
 
-    # The AnimatedObjects controlled by this Spirit.
-    attr_locked_reader :animatedObjects
+    # The AnimatedObject controlled by this Spirit.
+    attr_locked_reader :animatedObject
 
     # IO Callbacks
@@ -173 +176 @@
         self.writelocked do
             object.controller = self
-            @animatedObjects += [ object ]
-        end
-
-        self.updateParser
+            @animatedObject = object
+            self.updateParser
+        end
     end
 
@@ -182 +184 @@
     ### Remove the specified +object+ (FaerieMUD::AnimatedObject) from the
     ### list being controlled by the Spirit.
-    def deanimate( object )
+    def deanimate
+        return if @animatedObject.nil?
+
         self.writelocked do
-            object.controller = nil
-            @animatedObjects -= [ object ]
+            @animatedObject.controller = nil
+            @animatedObject = nil
         end
     end
@@ -194 +198 @@
     ### currently-animated objects.
     def updateParser
-        verbs = @animatedObjects.collect {|aobj| aobj.verbs}.flatten
+        verbs = @animatedObject.verbs
         @parser.updateVerbSet( *verbs )
     end
@@ -204 +208 @@
     end
 
+
+    #########
+    protected
+    #########
+
+    ### Start the input loop of the spirit to fetch use input.
+    def start
+        @inputThread = Thread::new( &inputLoop )
+    end
+
+
+    ### Wait for input from the Player and pass it to the CommandParser for
+    ### action.
+    def inputLoop
+        Thread.current.abort_on_exception = true
+
+        @running = true
+        while @running
+            rawInput = @ioHandlers[:input].call or next
+
+            
+        end
+
+    end
+
+
+
 end # class FaerieMUD::Spirit
 

trunk/lib/fm/verb.rb

@@ -1 +1 @@
 #!/usr/bin/ruby
 # 
-# This file contains the FaerieMUD::Verb class, a derivative of
-# FaerieMUD::GameObject. Verbs are objects which are used to generate game
-# events. They react to stimulus in the form of Events, timers, or other action,
-# generating events which should be propagated by the instigating object.
+# This file contains the FaerieMUD::Verb class. Verbs are objects which are used
+# to generate game events. They react to stimulus in the form of Events,
+# Activity timers, or other actions, generating events which should be propagated
+# by the instigating object.
 # 
 # == Subversion ID
@@ -28 +28 @@
 
 
-### Game verb class 
+### Game verb class.
 class FaerieMUD::Verb < FaerieMUD::GameObject
     contributors :ged
@@ -56 +56 @@
 
     ### Set up the verb's internal structure
-    def initialize # :notnew:
+    def initialize( args={} ) # :notnew:
         super
-        @words = self.class.generateWords()
+        @words ||= self.class.generateWords()
     end
 
@@ -66 +66 @@
     ######
 
-    ### CommandParser interface: query the verb for the word/s which cause it to
-    ### be invoked. By default this returns the name of the verb class with the
-    ### 'verb' part removed.
+    ### CommandParser interface: query the verb for the word/s which cause
+    ### it to be invoked. By default this returns the name of the verb class
+    ### with the 'verb' part removed.
     attr_reader :words
 
 
+    ### Return the primary English word for this noun.
+    def word
+        @words.first
+    end
+
+
     ### Event interface: "run" the verb, generating the event/s necessary to
-    ### express the action in the game world. The given +instigator+, +origin+,
-    ### and +target+ will be used when building event/s. See
+    ### express the action in the game world. The given +instigator+,
+    ### +origin+, and +target+ will be used when building event/s. See
     ### FaerieMUD::Event::new for definitions
-    def invoke( instigator, origin, target=nil )
+    def invoke( instigator, origin=nil, target=nil )
         raise NotImplementedError,
             "Required method #invoke not implemented in %s" %
-            [self.class.name]
+                [self.class.name]
+    end
+
+
+    ### Return the Verb's word inflected for the given +subject+, which should
+    ### be an object that responds to #plural?.
+    def inflect_for( subject )
+        word = self.words.first
+        return "#{self.word}s" unless subject.plural?
+        return word
     end
 

trunk/tests/commandparser.tests.rb

@@ -4 +4 @@
 # $Id$
 #
-# Copyright (c) 2003, 2004, 2005 The FaerieMUD Consortium.
+# Copyright (c) 2003-2006 The FaerieMUD Consortium.
 # 
 
@@ -19 +19 @@
 
 require 'fm/commandparser'
+require 'fm/verbs/all'
 
 ### This test suite tests the CommandParser of FaerieMUD.
@@ -30 +31 @@
 
 
+    def setup
+        @parser = FaerieMUD::CommandParser::new
+    end
+
 
     #################################################################
@@ -35 +40 @@
     #################################################################
 
-    ### Instance test
-    def test_Instance
-        printTestHeader "CommandParser: Instantiation"
-        rval = nil
-
-        assert_instance_of Class, FaerieMUD::CommandParser
-        assert_nothing_raised {
-            rval = FaerieMUD::CommandParser::new
-        }
-        assert_instance_of FaerieMUD::CommandParser, rval
-    end
-
-
     ### Parser should accept a list of verbs from which to derive its command
     ### table.
-    def test_UpdateVerbsShouldUpdateVerbset
-        printTestHeader "CommandParser: Updating the parser's verb list should " +
-            "update its verbset"
-        parser = FaerieMUD::CommandParser::new
+    def test_parser_should_update_its_command_table_from_given_verbs
         verb = MockVerb::new
 
@@ -62 +51 @@
 
         # Now add the verb to the parser
-        assert parser.verbset.empty?, "Parser's verbset should be empty initially"
+        assert @parser.verbset.empty?, "Parser's verbset should be empty initially"
         assert_nothing_raised do
-            parser.updateVerbSet( verb )
+            @parser.updateVerbSet( verb )
         end
 
         # Verify that everything went as planned.
         verb.verify
-        assert !parser.verbset.empty?,
-            "Parser's verbset should not be empty after updating"
-        assert parser.verbset.key?("test"),
+        assert @parser.verbset.key?("test"),
             "Parser should have the 'test' verb after updating"
-        assert parser.verbset.key?("try"),
+        assert @parser.verbset.key?("try"),
             "Parser should have the 'try' verb after updating"
     end
@@ -80 +67 @@
     ### Parser should raise an exception if two verbs try to register the same
     ### command.
-    def test_UpdateVerbsShouldRaiseOnCollision
-        printTestHeader "CommandParser: Updating the parser's verb list should " +
-            "raise an exception for command collisions"
-        parser = FaerieMUD::CommandParser::new
+    def test_parser_should_raise_an_exception_if_two_verbs_are_registered_with_the_same_command
         
         # Make two mock verbs with colliding wordsets
-        verb1 = MockVerb::new
-        verb1.setReturnValues( :words => [%w[test try]], :eql? => false )
-        verb2 = MockVerb::new
-        verb2.setReturnValues( :words => [%w[trim try]], :eql? => false )
+        verb1 = Class::new( FaerieMUD::SimpleVerb ) do
+            set_words %w[test try]
+        end.instance
+        verb2 = Class::new( FaerieMUD::SimpleVerb ) do
+            set_words %w[trim try]
+        end.instance
 
         assert_raises( FaerieMUD::CommandCollisionError ) do
-            parser.updateVerbSet( verb1, verb2 )
+            @parser.updateVerbSet( verb1, verb2 )
         end
     end
 
 
-    ### Parser should ignore verbs it already has
-    def test_UpdateVerbsShouldIgnoreDuplicates
-        printTestHeader "CommandParser: Updating the parser's verb list should " +
-            "ignore words it already has"
-
-        parser = FaerieMUD::CommandParser::new
-        
-        verb1 = MockVerb::new
-        verb1.setReturnValues( :words => [%w[test try]] )
+    ### Parser should ignore verbs it already knows about
+    def test_parser_should_ignore_verbs_it_already_knows_about_when_updating_its_verb_list
+        verb = Class::new( FaerieMUD::SimpleVerb ) do
+            set_words %w[test try]
+        end.instance
 
         # Add it once
         assert_nothing_raised do
-            parser.updateVerbSet( verb1 )
+            @parser.updateVerbSet( verb )
         end
+
+        # The parser's verbset should now contain the added verb
+        assert_equal 1, @parser.verbs.length
 
         # Add it again, which shouldn't fail
         assert_nothing_raised do
-            parser.updateVerbSet( verb1 )
+            @parser.updateVerbSet( verb )
         end
-        
+
+        # The parser's verbset shouldn't contain more than one verb still
+        assert_equal 1, @parser.verbs.length,
+            "Verbset expected to only contain one verb (%p)" % [@parser.verbset]
     end
 end

trunk/tests/linguistics.tests.rb

@@ -4 +4 @@
 # $Id$
 #
-# Copyright (c) 2005 The FaerieMUD Consortium.
+# Copyright (c) 2005, 2006 The FaerieMUD Consortium.
 # 
 
@@ -19 +19 @@
 
 require 'fm/linguistics'
+require 'fm/verbs/simple'
 
 
@@ -24 +25 @@
 class FaerieMUD::LinguisticsTestCase < FaerieMUD::TestCase
 
+    # For testing mixin functions
     class ThingerieThing
         include FaerieMUD::Linguistics
     end
 
+    # For testing sentence construction
     class TestingEntity < FaerieMUD::Entity; end
+    class DriveEvent < FaerieMUD::Event; end
+    class DriveVerb < FaerieMUD::SimpleVerb
+        set_event_class DriveEvent
+    end
 
 
+    ### Setup/teardown
     def setup
         @obj = ThingerieThing.new
         @entity = TestingEntity.new
+        @verb = DriveVerb.instance
     end
 
@@ -80 +89 @@
 
 
+    def test_sentence_created_with_subjectverb_event_creates_readable_text
+        rval = nil
+        event = @verb.invoke( @entity )
+        sentence = FaerieMUD::Linguistics::Sentence.new( event )
+
+        assert_nothing_raised do
+            rval = sentence.to_s
+        end
+
+        assert_equal "a testing entity drives.", rval
+    end
+
 end
 

trunk/tests/spirit.tests.rb

@@ -4 +4 @@
 # $Id$
 #
-# Copyright (c) 2003, 2004, 2005 The FaerieMUD Consortium.
+# Copyright (c) 2003-2006 The FaerieMUD Consortium.
 # 
 
@@ -18 +18 @@
 end
 
+require 'flexmock'
 require 'fm/spirit'
 require 'fm/animatedobject'
@@ -24 +25 @@
 class FaerieMUD::SpiritTestCase < FaerieMUD::TestCase
 
-    # Mock the classes that interact with the Spirit so it can be tested inside-
-    # out.
-    class MockAnimatedObject < Test::Unit::MockObject( FaerieMUD::AnimatedObject ); end
-
 
     ### Setup methods (aliased for older versions of Test::Unit)
     def setup 
-        @testAnimObj = MockAnimatedObject::new
+        @spirit = FaerieMUD::Spirit.new
         super
     end
-    alias_method :set_up, :setup
-
-    ### Teardown methods (aliased for older versions of Test::Unit)
-    def teardown 
-        @testAnimObj = nil
-        super
-    end
-    alias_method :tear_down, :teardown
 
 
@@ -48 +37 @@
     #################################################################
 
-    ### Instance test
-    def test_00_Instance
+    def test_spirit_objects_should_have_aspects_of_immortality
         rval = nil
-        printTestHeader "Spirit: Instantiation"
-
-        assert_instance_of Class, FaerieMUD::Spirit
-
-        # Test with a valid argument list
-        assert_nothing_raised {
-            rval = FaerieMUD::Spirit::new
-        }
-        assert_instance_of FaerieMUD::Spirit, rval
-
-        # Make Spirit objects for each further test
-        self.class.addSetupBlock {
-            @testSpirit = FaerieMUD::Spirit::new
-        }
-        self.class.addTeardownBlock {
-            @testSpirit = nil
-        }
-    end
-
-
-    ### Test the aspects of immortality (proxies for constituents of animated
-    ### objects)
-    def test_10_AspectsOfImmortality
-        rval = nil
-        printTestHeader "Spirit: Aspects of Immortality"
 
         # Aspect accessors (ComposedObject::Constituents)
         %w{physical mental creative}.each do |atype|
             meth = atype
-            assert_respond_to @testSpirit, meth
-            assert_nothing_raised { rval = @testSpirit.send(meth) }
+            assert_respond_to @spirit, meth
+            assert_nothing_raised { rval = @spirit.send(meth) }
             assert_kind_of FaerieMUD::ComposedObject::Constituent, rval
         end
@@ -87 +50 @@
         # Statistic accessors -- developmental
         %w{incarnativity kenning divinity}.each do |aspect|
-            assert_respond_to @testSpirit, aspect
-            assert_nothing_raised { rval = @testSpirit.send(aspect) }
+            assert_respond_to @spirit, aspect
+            assert_nothing_raised { rval = @spirit.send(aspect) }
             assert_instance_of FaerieMUD::DevelopmentalObject, rval
         end 
@@ -94 +57 @@
         # Statistic accessors -- linear
         %w{presence cognizance influence}.each do |aspect|
-            assert_respond_to @testSpirit, aspect.intern
-            assert_nothing_raised { rval = @testSpirit.send(aspect) }
+            assert_respond_to @spirit, aspect.intern
+            assert_nothing_raised { rval = @spirit.send(aspect) }
             assert_instance_of Fixnum, rval
         end 
     end
+
+    def test_animating_should_set_the_animated_objects_controller
+        FlexMock.use( "animated object" ) do |mockAnimObj|
+            mockAnimObj = FlexMock.new
+            mockAnimObj.should_receive( :controller= ).with( @spirit )
+            mockAnimObj.should_receive( :verbs ).returns( [] )
+
+            assert_nothing_raised do
+                @spirit.animate( mockAnimObj )
+            end
+        end
+    end
+
+    def test_should_unset_previous_animated_objects_controller_when_animating_a_new_object
+        FlexMock.use( "original animated object", "second animated object" ) do |mockAnimObj, mockAnimObj2|
+            mockAnimObj = FlexMock.new
+            mockAnimObj.should_receive( :controller= ).with( @spirit )
+            mockAnimObj.should_receive( :verbs ).returns( [] )
+            mockAnimObj.should_receive( :controller= ).with( nil )
+
+            mockAnimObj2 = FlexMock.new
+            mockAnimObj2.should_receive( :controller= ).with( @spirit )
+            mockAnimObj2.should_receive( :verbs ).returns( [] )
+
+            assert_nothing_raised do
+                @spirit.animate( mockAnimObj )
+                @spirit.animate( mockAnimObj2 )
+            end
+        end
+
+    end
+
+
 end