gamefic 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 148fd56ec0966aee6fe9af25f63b450b64ecdcc3
-  data.tar.gz: f0bee28dabd8400c7c350c5c8a8005b67ce01ebf
+  metadata.gz: 567c41f4ddc68dcf42fcb5952d6279250100f117
+  data.tar.gz: 7d2b9383cc049ab220917377ae7c76a7d4adc694
 SHA512:
-  metadata.gz: 913706c95e0814ec1b4d9f39358d5afcb2a09b3a4f9d683684e64e404154e4c5d7735ea837c40dd4433525d3734ad2ba2a312fc23d9376dfb7d5886497a99238
-  data.tar.gz: 9ac42568ffb6fc3247dbf386fd42aca1ad0e97d18b195a8ca3154ac8ac634525df10a120d7f28eeb182d8d31a63a9dfb121665640623fc569771b2243a16b0cc
+  metadata.gz: 3ce9c4b0051c2e64591b7a08ce693d2817b9c66e94240e3f4ae52ecb012b0e89355ca692efe01dbd502d1590d18e05755c93d96cd2c695e7a4ae068b6e5f8e66
+  data.tar.gz: 318903449d67116cf8da824a29c845180516de69ba4344d1f45499acef3f6cc5c728e3fb31641010dca3735a8a786835a4447a4dea5405a941dd482dcf014ce3

data/lib/gamefic.rb

@@ -10,11 +10,10 @@ require "gamefic/scene"
 require "gamefic/query"
 require "gamefic/action"
 require "gamefic/syntax"
-require "gamefic/rule"
 require "gamefic/director"
 require "gamefic/plot"
+require 'gamefic/subplot'
 require "gamefic/engine"
 require "gamefic/user"
-require "gamefic/direction"
 
 require 'gamefic/version'

data/lib/gamefic/character.rb

@@ -1,5 +1,8 @@
 require 'gamefic/director'
 
+class NotConclusionError < Exception
+end
+
 module Gamefic
   class Character < Entity
     attr_reader :queue, :user
@@ -8,10 +11,11 @@ module Gamefic
     # @return [Entity,nil]
     attr_reader :last_object
     attr_accessor :object_of_pronoun
-    
-    serialize :scene
-    
-    def initialize(plot, args = {})
+    attr_reader :scene
+    attr_reader :next_scene
+    attr_accessor :playbook
+
+    def initialize(args = {})
       @queue = Array.new
       super
       @buffer_stack = 0
@@ -38,20 +42,14 @@ module Gamefic
     #
     # The command will be executed immediately regardless of game state.
     #
-    # If the from_user argument is true, the command is assumed to have come
-    # directly from user input. The character's last_order and last_object
-    # will be updated with the result.
-    #
     # @example Send a command as a string
     #   character.perform "take the key"
     #
     # @example Send a command as a set of tokens
     #   character.perform :take, @key
     #
-    def perform(*command, from_user: false)
-      o = Director.dispatch(self, *command)
-      last_order = o if from_user
-      o
+    def perform(*command)
+      Director.dispatch(self, *command)
     end
     
     # Quietly perform a command.
@@ -97,14 +95,6 @@ module Gamefic
       user.send message.strip unless user.nil?
     end
 
-    # TODO This might not be necessary. The User#quit method was a noop anyway.
-    #def destroy
-    #  if @user != nil
-    #    @user.quit
-    #  end
-    #  super
-    #end
-    
     # Proceed to the next Action in the current stack.
     # This method is typically used in Action blocks to cascade through
     # multiple implementations of the same verb.
@@ -127,46 +117,42 @@ module Gamefic
     #   end
     #
     def proceed
-      return if delegate_stack.last.nil?
-      delegate_stack.last.proceed
+      Director::Delegate.proceed_for self
     end
 
-    def cue scene_name
-      @scene = scene_name
+    def cue scene
       @next_scene = nil
-      plot.scenes[scene_name].start self
+      @scene = scene
+      @scene.start self unless @scene.nil?
     end
-    
-    def prepare scene_name
-      @next_scene = scene_name
+
+    def prepare scene
+      @next_scene = scene
     end
 
-    def conclude scene_name
-      scene = plot.scenes[scene_name]
-      raise "#{scene_name} is not a conclusion" unless scene.kind_of?(Scene::Conclusion)
-      cue scene_name
+    def conclude scene
+      raise NotConclusionError if !scene.kind_of?(Scene::Conclusion)
+      cue scene
     end
-    
-    # Get the name of the character's current scene
-    #
-    # @return [Symbol] The name of the scene    
-    def scene
-      @scene
+
+    def concluded?
+      !scene.nil? and scene.kind_of?(Scene::Conclusion)
     end
 
-    # Alias for Character#cue key
-    def scene= key
-      cue key.to_sym
+    def performed order
+      @last_order = order
     end
-    
-    def next_scene
-      @next_scene
+
+    def prompt
+      scene.nil? ? '>' : scene.prompt_for(self)
     end
-    
+
     private
+
     def delegate_stack
       @delegate_stack ||= []
     end
+
     def last_order=(order)
       return if order.nil?
       @last_order = order

data/lib/gamefic/director/delegate.rb

@@ -1,46 +1,54 @@
 module Gamefic
   module Director
     class Delegate
-      # If we use Query::Base.new in the @disambiguator declaration, Opal
-      # passes the block to the query instead of the action.
-      base = Query::Base.new
-      @@disambiguator = Action.new nil, base do |actor, entities|
-        definites = []
-        entities.each { |entity|
-          definites.push entity.definitely
-        }
-        actor.tell "I don't know which you mean: #{definites.join_or}."
+
+      class << self
+        def proceed_for actor
+          return if stack_map[actor].nil?
+          stack_map[actor].last.proceed unless stack_map[actor].last.nil?
+        end
+
+        private
+
+        def stack_map
+          @stack_map ||= {}
+        end
       end
-      @@disambiguator.meta = true
+
       def initialize(actor, orders)
         @actor = actor
         @orders = orders
+        @did = []
+        @validated = false
       end
+
       def proceed
         return if @orders.length == 0
-        @actor.send(:delegate_stack).push self
         executed = false
         while !executed
           order = @orders.shift
           break if order.nil?
-          executed = try(order)
+          # HACK: Make sure Character#proceed does not repeat an action
+          next if @did.include?(order.action)
+          @did.push order.action
+          @last_action = order.action
+          executed = attempt(order)
+          return if order.canceled?
         end
-        @actor.send(:delegate_stack).pop
       end
+
       def execute
         return if @orders.length == 0
-        if !@orders[0].action.meta?
-          @actor.plot.asserts.each_pair { |name, rule|
-            result = rule.test(@actor, @orders[0].action.verb, @orders[0].arguments)
-            if result == false
-              return
-            end
-          }
-        end
+        stack_map[@actor] ||= []
+        stack_map[@actor].push self
         proceed
+        stack_map[@actor].pop
+        stack_map.delete @actor if stack_map[@actor].empty?
       end
+
       private
-      def try order
+
+      def attempt order
         executed = false
         arg_i = 0
         final_arguments = []
@@ -53,7 +61,7 @@ module Gamefic
             else
               ambiguous = argument
             end
-            order = Order.new(@actor, @@disambiguator, [])
+            order = Order.new(@actor, @actor.playbook.disambiguator, [])
             final_arguments = [ambiguous]
             break
           end
@@ -66,7 +74,7 @@ module Gamefic
               break
             end
           end
-          if order.action == @@disambiguator or final_arguments.nil?
+          if order.action == @actor.playbook.disambiguator or final_arguments.nil?
             break
           end
           if order.action.queries[arg_i].allow_many?
@@ -80,6 +88,13 @@ module Gamefic
           arg_i += 1
         }
         if !final_arguments.nil?
+          unless @validated or order.action.meta?
+            @actor.playbook.validators.each { |v|
+              v.call order
+              return false if order.canceled?
+            }
+          end
+          @validated = true
           # The actor is always the first argument to an Action proc
           final_arguments.unshift @actor
           order.action.execute(*final_arguments)
@@ -87,6 +102,7 @@ module Gamefic
         end
         executed
       end
+
       def validate argument, arg_i, order
         valid = []
         argument.each { |m|
@@ -99,6 +115,12 @@ module Gamefic
         }
         valid
       end
+
+      private
+
+      def stack_map
+        Delegate.send(:stack_map)
+      end
     end
   end
 end

data/lib/gamefic/director/order.rb

@@ -5,6 +5,13 @@ module Gamefic
       @actor = actor
       @action = action
       @arguments = arguments
+      @canceled = false
+    end
+    def cancel
+      @canceled = true
+    end
+    def canceled?
+      @canceled
     end
   end
 end

data/lib/gamefic/director/parser.rb

@@ -7,7 +7,7 @@ module Gamefic
       def self.from_tokens(actor, tokens)
         options = []
         command = tokens.shift
-        actions = actor.plot.actions_with_verb(command.to_sym)
+        actions = actor.playbook.actions_for(command.to_sym)
         actions.each { |action|
           if action.queries.length == tokens.length
             valid = true
@@ -38,9 +38,9 @@ module Gamefic
         if command.to_s == ''
           return options
         end
-        matches = Syntax.tokenize(command, actor.plot.syntaxes)
+        matches = Syntax.tokenize(command, actor.playbook.syntaxes)
         matches.each { |match|
-          actions = actor.plot.actions_with_verb(match.verb)
+          actions = actor.playbook.actions_for(match.verb)
           actions.each { |action|
             options.concat bind_contexts_in_result(actor, match.arguments, action)
           }
@@ -53,18 +53,18 @@ module Gamefic
           queries = action.queries.clone
           objects = execute_query(actor, handler.clone, queries, action)
           num_nil = 0
-          while objects.length == 0 and queries.last.optional?
-            num_nil +=1
-            queries.pop
-            objects = execute_query(actor, handler.clone, queries, action, num_nil)
-          end
+          #while objects.length == 0 and queries.last.optional?
+          #  num_nil +=1
+          #  queries.pop
+          #  objects = execute_query(actor, handler.clone, queries, action, num_nil)
+          #end
           return objects
         end
         def execute_query(actor, arguments, queries, action, num_nil = 0)
           # If the action verb is nil, treat the first argument as a query
-          arguments.shift unless action.verb.nil?
-          prepared = Array.new
-          objects = Array.new
+          #arguments.shift unless action.verb.nil?
+          prepared = []
+          objects = []
           valid = true
           last_remainder = nil
           queries.clone.each { |context|

data/lib/gamefic/engine/base.rb

@@ -29,7 +29,7 @@ module Gamefic
     def run
       connect
       @plot.introduce @character
-      turn until @plot.concluded?(@character)
+      turn until @character.concluded?
       print @user.flush
     end
 
@@ -44,10 +44,9 @@ module Gamefic
     end
 
     def receive
-      print @plot.scenes[@character.scene].prompt_for(@character) + ' '
+      print @character.scene.prompt_for(@character) + ' '
       input = STDIN.gets
       @character.queue.push input unless input.nil?
-      puts ''
     end
   end
 

data/lib/gamefic/entity.rb

@@ -11,58 +11,48 @@ module Gamefic
     extend Serialized::ClassMethods
     include Grammar::WordAdapter
     
-    attr_reader :session, :plot
+    attr_reader :session
     serialize :name, :parent, :description
     
-    def initialize(plot, args = {})
-      if (plot.kind_of?(Plot) == false)
-        raise "First argument must be a Plot"
-      end
+    def initialize(args = {})
       pre_initialize
-      @plot = plot
-      @plot.send :add_entity, self
       args.each { |key, value|
         send "#{key}=", value
       }
-      @update_procs = Array.new
       @session = Hash.new
       yield self if block_given?
       post_initialize
     end
+
     def uid
       if @uid == nil
         @uid = self.object_id.to_s
       end
       @uid
     end
+
     def pre_initialize
       # raise NotImplementedError, "#{self.class} must implement post_initialize"    
     end
+
     def post_initialize
       # raise NotImplementedError, "#{self.class} must implement post_initialize"
     end
+
     def tell(message)
       #TODO: Should this even be here? In all likelihood, only Characters receive tells, right?
       #TODO: On second thought, it might be interesting to see logs from an npc point of view.
     end
+
     def stream(message)
       # Unlike tell, this method sends raw data without formatting.
     end
     
     # Execute the entity's on_update blocks.
     # This method is typically called by the Engine that manages game execution.
+    # The base method does nothing. Subclasses can override it.
     #
     def update
-      @update_procs.each { |p|
-        p.call self
-      }
-    end
-    
-    # Add a block to be executed when the game updates a turn.
-    #
-    # @yieldparam [Entity]
-    def on_update(&block)
-      @update_procs.push block
     end
     
     # Set the Entity's parent.
@@ -75,14 +65,6 @@ module Gamefic
       super
     end
     
-    # Remove this Entity from its current Plot.
-    #
-    def destroy
-      self.parent = nil
-      # TODO: Need to call this private method here?
-      @plot.send(:rem_entity, self)
-    end
-    
     # Get an extended property.
     #
     # @param key [Symbol] The property's name.