gamefic 0.6.1 → 1.0.0

data/lib/gamefic/plot/scene_mount.rb

@@ -4,50 +4,25 @@ end
 module Gamefic
 
   module Plot::SceneMount
-    # Get a Hash of SceneManager objects.
-    #
-    # @return [Hash<Symbol, SceneManager>]
-    def scene_managers
-      if @scene_managers.nil?
-        @scene_managers ||= {}
-        @scene_managers[:active] = ActiveSceneManager.new
-        @scene_managers[:concluded] = ConcludedSceneManager.new
-      end
-      @scene_managers
-    end
-    
     # Create a multiple-choice scene.
     # The user will be required to make a valid choice to continue
     #
     # @yieldparam [Character]
-    # @yieldparam [MultipleChoiceSceneData]
-    def multiple_choice key, *args, &block
-      scene_managers[key] = MultipleChoiceSceneManager.new do |config|
-        config.start do |actor, data|
-          data.options = args
-        end
-        config.finish(&block)
-      end
+    # @yieldparam [String]
+    def multiple_choice key, options, &block
+      scenes[key] = Scene::MultipleChoice.new(
+        options: options,
+        finish: block
+      )
     end
     
     # Create a yes-or-no scene.
     # The user will be required to answer Yes or No to continue.
     #
     # @yieldparam [Character]
-    # @yieldparam [YesOrNoSceneData]
+    # @yieldparam [String] "yes" or "no"
     def yes_or_no key, prompt = nil, &block
-      manager = YesOrNoSceneManager.new do |config|
-        config.prompt = prompt
-        config.finish do |actor, data|
-          if data.answer.nil?
-            actor.tell "Please answer Yes or No."
-          else
-            data.next_cue ||= :active
-            block.call(actor, data)
-          end
-        end
-      end
-      scene_managers[key] = manager
+      scenes[key] = Scene::YesOrNo.new(prompt, &block)
     end
     
     # Create a scene with a prompt.
@@ -55,18 +30,11 @@ module Gamefic
     # from the user.
     #
     # @param key [Symbol] A unique name for the scene.
-    # @param prompt [String] The prompt message to display to the user.
+    # @param prompt [String] The input prompt to display to the user.
     # @yieldparam [Character]
-    # @yieldparam [SceneData]
-    def prompt key, prompt, &block
-      scene_managers[key] = SceneManager.new do |config|
-        config.prompt = prompt
-        config.finish do |actor, data|
-          data.next_cue ||= :active
-          block.call actor, data
-        end
-      end
-      scene_managers[key].state = "Prompted"
+    # @yieldparam [String]
+    def question key, prompt, &block
+      scenes[key] = Scene::Question.new prompt, &block
     end
     
     # Create a scene that pauses the game.
@@ -75,15 +43,8 @@ module Gamefic
     #
     # @param key [Symbol] A unique name for the scene.
     # @yieldparam [Character]
-    # @yieldparam [SceneData]
     def pause key, &block
-      manager = PausedSceneManager.new do |config|
-        config.start do |actor, data|
-          data.next_cue = :active
-          block.call actor, data
-        end
-      end
-      scene_managers[key] = manager
+      scenes[key] = Scene::Pause.new &block
     end
     
     # Create a conclusion.
@@ -91,32 +52,18 @@ module Gamefic
     #
     # @param key [Symbol] A unique name for the scene.
     # @yieldparam [Character]
-    # @yieldparam [SceneData]
     def conclusion key, &block
-      manager = ConcludedSceneManager.new do |config|
-        config.start(&block)
-      end
-      scene_managers[key] = manager
+      scenes[key] = Scene::Conclusion.new &block
     end
     
     # Create a generic scene.
-    # After the scene is complete, it will automatically start the next cue.
+    # After the scene is complete, it will automatically start the next
+    # prepared scene, or the :active scene if none is prepared.
     #
     # @param [Symbol] A unique name for the scene.
     # @yieldparam [Character]
-    # @yieldparam [SceneData]
     def scene key, &block
-      scene = SceneManager.new do |manager|
-        manager.start do |actor, data|
-          data.next_cue = :active
-          block.call(actor, data) if !block.nil?
-          cue actor, data.next_cue
-          actor.scene.start actor
-        end
-        # Since generic scenes always cue a new scene, there's no reason to
-        # define a finish block.
-      end
-      scene_managers[key] = scene
+      scenes[key] = Scene::Passive.new &block
     end
     
     # Branch to a new scene based on a list of options.
@@ -132,50 +79,20 @@ module Gamefic
     #     actor.tell "You went to scene two"
     #   end
     #   introduction do |actor|
-    #     cue actor, :select_one_or_two # The actor will be prompted to select "one" or "two" and get sent to the corresponding scene
+    #     actor.cue, :select_one_or_two # The actor will be prompted to select "one" or "two" and get sent to the corresponding scene
     #   end
     #
     # @param key [Symbol] A unique name for the scene.
-    # @param options [Hash] A Hash of options and associated scene keys.
-    def branch key, options
-      multiple_choice key, *options.keys do |actor, data|
-        cue actor, options[data.selection]
-      end
-    end
-    
-    # Cue a Character's next scene
-    #
-    # @param actor [Character] The character being cued
-    # @param key [Symbol] The name of the scene
-    def cue actor, key
-      if !actor.scene.nil? and actor.scene.state == "Concluded"
-        return
-      end
-      if key.nil?
-        raise "Cueing scene with nil key"
-      end
-      manager = scene_managers[key]
-      if manager.nil?
-        raise "No '#{key}' scene found"
-      else
-        actor.scene = manager.prepare key
-      end
-      @scene
-    end
-    
-    # This is functionally identical to #cue, but it also raises an
-    # exception if the selected scene is not a Concluded state.
-    #
-    # @param actor [Character] The character being cued
-    # @param key [Symbol] The name of the scene
-    def conclude actor, key
-      key = :concluded if key.nil?
-      manager = scene_managers[key]
-      if manager.state != "Concluded"
-        raise NotConclusionError("Cued scene '#{key}' is not a conclusion")
-      end
-      cue actor, key
+    # @param map [Hash] A Hash of options and associated scene keys.
+    def branch key, map
+      scenes[key] = Scene::MultipleChoice.new(
+        options: map.keys,
+        finish: proc { |actor, input|
+          actor.cue map[input.choice]
+        }
+      )
     end
+
   end
 
 end

data/lib/gamefic/{snapshots.rb → plot/snapshot.rb}

@@ -1,13 +1,8 @@
 require 'json'
 
 module Gamefic
-  class Snapshots
-    attr_accessor :history
-    def initialize entities
-      @history = []
-      @entities = entities
-    end
-    def save entities
+  module Plot::Snapshot
+    def save
       store = []
       index = 0
       entities.each { |e|
@@ -19,11 +14,11 @@ module Gamefic
           end
           if e.respond_to?(m) == true
             begin
-              xxx = e.send(m)
-              if xxx == false
+              val = e.send(m)
+              if val == false
                 hash[con] = false
-              elsif xxx
-                hash[con] = serialize_obj(xxx)
+              elsif val
+                hash[con] = serialize_obj(val)
               else
                 hash[con] = nil
               end
@@ -32,6 +27,7 @@ module Gamefic
             end
           end
         }
+        hash[:class] = e.class.to_s
         hash[:session] = {}
         e.session.each_pair { |k, v|
           hash[:session][k] = serialize_obj(v)
@@ -39,29 +35,68 @@ module Gamefic
         store.push hash
         index += 1
       }
-      if @history.length > 10
-        @history.shift
+      if @initial_state.nil?
+        @initial_state = store
+        store = []
+        @initial_state.length.times do
+          store.push {}
+        end
+      else
+        store = reduce(store)
       end
-      json = JSON.generate(store)
-      #puts json
-      json
+      store
     end
     def restore snapshot
-      data = JSON.parse(snapshot)
+      internal_restore snapshot, true
+    end
+    private
+    def internal_restore snapshot, with_restore = true
+      if with_restore
+        @entities[@initial_state.length..-1].each { |e|
+          e.parent = nil
+        }
+        @entities.slice! @initial_state.length..-1
+        internal_restore @initial_state, false
+      end
       index = 0
-      data.each { |hash|
+      snapshot.each { |hash|
+        if entities[index].nil?
+          if with_restore
+            cls = Kernel.const_get(hash[:class])
+            entities[index] = make cls
+          else
+            break
+          end
+        end 
         hash.each_pair { |k, v|
-          @entities[index].send("#{k}=", unserialize(v)) if k.to_s != "session"
-        }
-        #unser = unserialize(hash["session"])
-        hash["session"].each_pair { |k, v|
-            @entities[index].session[k.to_sym] = unserialize(v)
+          if k == :scene
+            entities[index].cue v.to_sym
+          else
+            entities[index].send("#{k}=", unserialize(v)) if k != :session and k != :class
+          end
         }
+        unless hash[:session].nil?
+          hash[:session].each_pair { |k, v|
+            entities[index].session[k.to_sym] = unserialize(v)
+          }
+        end
         index += 1
       }
     end
-    def blacklist
-      [:children, :session, :scene, :object_of_pronoun, :test_queue, :test_queue_scene, :test_queue_length, :testing]
+    def reduce entities
+      reduced = []
+      index = 0
+      entities.each { |e|
+        r = {}
+        e.each_pair { |k, v|
+          if index >= @initial_state.length or @initial_state[index][k] != v
+            r[k] = v
+          end
+        }
+        reduced.push r
+        index += 1
+      }
+      reduced
     end
     private
     def can_serialize? obj
@@ -98,8 +133,6 @@ module Gamefic
           return "#<EIN_#{@entities.index(obj)}>"
         elsif obj.kind_of?(Direction)
           return "#<DIR_#{obj.name}>"
-        #elsif obj.kind_of?(Symbol)
-        #  return "#<SYM_#{obj.to_s}>"
         end
       end
       return obj
@@ -123,8 +156,6 @@ module Gamefic
           @entities[i]
         elsif obj.to_s.match(/^#<DIR_[a-z]+>$/)
           Direction.find(obj[6..-2])
-        #elsif obj.to_s.match(/^#<SYM_[a-z]+>$/)
-        #  Direction.find(obj[6..-2].to_sym)
         else
           obj
         end

data/lib/gamefic/plot/you_mount.rb

@@ -2,7 +2,7 @@ require 'gamefic'
 require 'gamefic/grammar'
 
 module Gamefic
-  module YouMount
+  module Plot::YouMount
     class YouGrammarSet
       include Grammar::Gender
       include Grammar::Person

data/lib/gamefic/plot.rb

@@ -5,8 +5,6 @@ require 'gamefic/tester'
 require 'gamefic/source'
 require 'gamefic/script'
 require 'gamefic/query'
-require 'gamefic/plot/article_mount'
-require 'gamefic/plot/you_mount'
 
 module Gamefic
 
@@ -15,35 +13,52 @@ module Gamefic
     autoload :CommandMount, 'gamefic/plot/command_mount'
     autoload :EntityMount, 'gamefic/plot/entity_mount'
     autoload :QueryMount, 'gamefic/plot/query_mount'
-    #autoload :ArticleMount, 'gamefic/plot/article_mount'
-    #autoload :YouMount, 'gamefic/plot/you_mount'
+    autoload :ArticleMount, 'gamefic/plot/article_mount'
+    autoload :YouMount, 'gamefic/plot/you_mount'
+    autoload :Snapshot, 'gamefic/plot/snapshot'
+    
     attr_reader :commands, :imported_scripts, :rules, :asserts, :source
-    attr_accessor :default_scene
+    # TODO Metadata could use better protection
+    attr_accessor :default_scene, :metadata
     include Stage
     # TODO This include is only here to make the module's methods visible in the IDE.
     # Gamefic Studio has a PlotStageMetaMapper that handles it, but it doesn't run if
     # the plugin isn't activated.
-    include Gamefic, Tester, SceneMount, CommandMount, EntityMount, QueryMount, ArticleMount, YouMount
-    mount Gamefic, Tester, SceneMount, CommandMount, EntityMount, QueryMount, ArticleMount, YouMount
-    expose :script, :introduction, :assert_action, :on_update, :on_player_update, :entities, :on_ready, :on_player_ready, :players
+    #include Gamefic, Tester, SceneMount, CommandMount, EntityMount, QueryMount, ArticleMount, YouMount, Snapshot
+    mount Gamefic, Tester, SceneMount, CommandMount, EntityMount, QueryMount, ArticleMount, YouMount, Snapshot
+    expose :script, :introduction, :assert_action, :before_player_update, :on_update, :on_player_update, :entities, :on_ready, :on_player_ready, :players, :scenes, :metadata
     
     # @param [Source::Base]
     def initialize(source = nil)
       @source = source || Source::Text.new({})
-      @commands = Hash.new
-      @syntaxes = Array.new
-      @ready_procs = Array.new
-      @update_procs = Array.new
-      @player_ready = Array.new
-      @player_procs = Array.new
-      @working_scripts = Array.new
-      @imported_scripts = Array.new
-      @entities = Array.new
-      @players = Array.new
-      @asserts = Hash.new
+      @commands = {}
+      @syntaxes = []
+      @ready_procs = []
+      @before_player_update_procs = []
+      @update_procs = []
+      @player_ready = []
+      @player_procs = []
+      @working_scripts = []
+      @imported_scripts = []
+      @entities = []
+      @players = []
+      @asserts = {}
       @default_scene = :active
       post_initialize
     end
+
+    def scenes
+      if @scenes.nil?
+        @scenes = {}
+        @scenes[:active] = Scene::Active.new
+        @scenes[:concluded] = Scene::Conclusion.new
+      end
+      @scenes
+    end
+    
+    def concluded?(actor)
+      scenes[actor.scene].kind_of?(Scene::Conclusion)
+    end
     
     # Get an Array of all Actions defined in the Plot.
     #
@@ -158,7 +173,7 @@ module Gamefic
       # by the plot, which would be :active by default. We could
       # get it like player.cue nil.
       if player.scene.nil?
-        cue player, default_scene
+        player.cue :active
         ready
         update
       end
@@ -175,7 +190,6 @@ module Gamefic
         @player_ready.each { |block|
           block.call player
         }
-        player.scene.start player
       }
     end
     
@@ -184,14 +198,24 @@ module Gamefic
     def update
       # Update the plot.
       @players.each { |player|
-        process_input player
+        # TODO: This really doesn't belong here. We need a before_update in the plot.
+        @before_player_update_procs.each { |p|
+          p.call player
+        }
+	      this_scene = player.next_scene || player.scene
+	      player.prepare nil
+	      if this_scene != player.scene
+	        player.cue this_scene
+	        player.queue.shift
+	      else
+          process_input player
+        end
       }
       @entities.each { |e|
         e.update
       }
       @players.each { |player|
         update_player player
-        cue player, player.scene.data.next_cue if !player.scene.data.next_cue.nil?
       }
       @update_procs.each { |p|
         p.call
@@ -242,22 +266,25 @@ module Gamefic
       @player_procs.push block
     end
 
+    # Add a block to  be executed for each player before the turn's update is
+    # performed.
+    #
+    # @yieldparam [Character]
+    def before_player_update &block
+      @before_player_update_procs.push block
+    end
+    
     private
     def process_input player
       line = player.queue.shift
       if !line.nil?
-        player.scene.finish player, line
-        #cue player, player.scene.data.next_cue if !player.scene.data.next_cue.nil?
+        scenes[player.scene].finish player, line
       end
     end
     def update_player player
       @player_procs.each { |proc|
         proc.call player
       }
-      # HACK Exception for running tests
-      if player[:testing] == true
-        cue player, :test
-      end
     end
     def rem_entity(entity)
       @entities.delete(entity)

data/lib/gamefic/query/base.rb

@@ -16,6 +16,8 @@ module Gamefic::Query
       @arguments = arguments
       @match_hash = Hash.new
     end
+    # Check whether the query allows ambiguous matches.
+    # If allowed, this query's 
     def allow_ambiguous?
       false
     end
@@ -110,7 +112,7 @@ module Gamefic::Query
       arguments.each { |a|
         if a.kind_of?(Class) or a.kind_of?(Module)
           my_classes.push a
-        elsif a.kind_of?(Entity)
+        elsif a.kind_of?(Gamefic::Entity)
           my_objects.push a
         elsif a.kind_of?(Symbol)
           if my_classes.length == 0 and my_objects.length == 0

data/lib/gamefic/scene/active.rb

@@ -1,25 +1,18 @@
 module Gamefic
 
-  class ActiveSceneManager < SceneManager
-    def scene_class
-      ActiveScene
+  # Active Scenes handle the default command prompt, where input is parsed
+  # into an Action performed by the Character. This is the default scene in
+  # a Plot.
+  #
+  class Scene::Active < Scene::Base
+    def start actor
+      # TODO Anything necessary here?
     end
-    def state
-      @state ||= "Active"
-    end
-  end
-  
-  class ActiveScene < Scene
     def finish actor, input
-      @data.input = input
-      if @finish.nil?
-        last_order = actor.perform data.input
-        # HACK Set the last_order here so inline performs don't set it
-        actor.send(:last_order=, last_order)
-      else
-        @finish.call actor, data
-      end
+      last_order = actor.perform input
+      # HACK Set the last_order here so inline performs don't set it
+      actor.send(:last_order=, last_order)
     end
   end
-
+  
 end

data/lib/gamefic/scene/base.rb

@@ -0,0 +1,21 @@
+module Gamefic::Scene
+  
+  # The Base Scene is not intended for instantiation. Other Scene classes
+  # should inherit from it.
+  #
+  class Base
+    def prompt
+      @prompt ||= '>'
+    end
+    def start actor
+      
+    end
+    def finish actor, input
+      
+    end
+    def state
+      self.class.to_s.split('::').last
+    end
+  end
+  
+end

data/lib/gamefic/scene/conclusion.rb

@@ -0,0 +1,11 @@
+module Gamefic
+
+  # A Conclusion ends the Plot (or the character's participation in it).
+  #
+  class Scene::Conclusion < Scene::Custom
+    def initialize &block
+      @start = block
+    end
+  end
+  
+end

data/lib/gamefic/scene/custom.rb

@@ -0,0 +1,21 @@
+module Gamefic
+  
+  # A Custom Scene is a generic scene that allows for complete configuration
+  # of its behavior upon instantiation. It is suitable for direct instantion
+  # or extension by other Scene classes.
+  #
+  class Scene::Custom < Scene::Base
+    def initialize config = {}
+      @start = config[:start]
+      @finish = config[:finish]
+      @prompt = config[:prompt]
+    end
+    def start actor
+      @start.call(actor) unless @start.nil?
+    end
+    def finish actor, input
+      @finish.call(actor, input) unless @finish.nil?
+    end
+  end
+  
+end

data/lib/gamefic/scene/multiple_choice/input.rb

@@ -0,0 +1,11 @@
+module Gamefic
+  class Gamefic::Scene::MultipleChoice::Input
+    attr_reader :raw, :number, :index, :choice
+    def initialize raw, index, choice
+      @raw = raw
+      @index = index
+      @number = index + 1
+      @choice = choice
+    end
+  end
+end