gamefic 1.6.0 → 1.7.0

data/lib/gamefic/actor.rb

@@ -0,0 +1,5 @@
+module Gamefic
+  class Actor < Gamefic::Entity
+    include Gamefic::Active
+  end
+end

data/lib/gamefic/core_ext/string.rb

@@ -1,16 +1,16 @@
 class String
-	include Gamefic::Matchable
+  include Gamefic::Matchable
   # Capitalize the first letter without changing the rest of the string.
   # (String#capitalize makes the rest of the string lower-case.)
-	def capitalize_first
-		"#{self[0,1].upcase}#{self[1,self.length]}"
-	end
-	# @return [String]
-	def cap_first
-		self.capitalize_first
-	end
-	# @return [Array]
-	def split_words
-		self.gsub(/ +/, ' ').strip.split
-	end
+  def capitalize_first
+    "#{self[0,1].upcase}#{self[1,self.length]}"
+  end
+  # @return [String]
+  def cap_first
+    self.capitalize_first
+  end
+  # @return [Array]
+  def split_words
+    self.gsub(/ +/, ' ').strip.split
+  end
 end

data/lib/gamefic/describable.rb

@@ -9,15 +9,24 @@ module Gamefic
     include Grammar::Person, Grammar::Plural
     include Matchable
 
+    # Get the name of the object.
+    # The name is usually presented without articles (e.g., "object" instead
+    # of "an object" or "the object" unless the article is part of a proper
+    # name (e.g., "The Ohio State University").
+    #
     # @return [String]
     attr_reader :name
 
     # @return [String]
     attr_reader :synonyms
 
+    # Get the object's indefinite article (usually "a" or "an").
+    #
     # @return [String]
     attr_reader :indefinite_article
 
+    # Get the object's definite article (usually "the").
+    #
     # @return [String]
     attr_reader :definite_article
 
@@ -41,22 +50,30 @@ module Gamefic
     # Get the name of the object with a definite article.
     # Note: proper-named objects never append an article, though an article
     # may be included in its proper name.
+    #
+    # @return [String]
     def definitely
       ((proper_named? or definite_article == '') ? '' : "#{definite_article} ") + name.to_s
     end
     
-    # Get the definite article for this object.
+    # Get the definite article for this object (usually "the").
     #
     # @return [String]
     def definite_article
       @definite_article || "the"
     end
     
+    # Set the definite article.
+    #
+    # @param [String] article
     def definite_article= article
       @keywords = nil
       @definite_article = article
     end
 
+    # Set the indefinite article.
+    #
+    # @param [String] article
     def indefinite_article= article
       @keywords = nil
       @indefinite_article = article

data/lib/gamefic/element.rb

@@ -0,0 +1,31 @@
+module Gamefic
+  class Element
+    include Gamefic::Describable
+
+    def initialize(args = {})
+      self.class.default_attributes.merge(args).each { |key, value|
+        send "#{key}=", value
+      }
+      post_initialize
+      yield self if block_given?
+    end
+
+    def post_initialize
+      # raise NotImplementedError, "#{self.class} must implement post_initialize"
+    end
+
+    class << self
+      def set_default attrs = {}
+        default_attributes.merge! attrs
+      end
+
+      def default_attributes
+        @default_attributes ||= {}
+      end
+
+      def inherited subclass
+        subclass.set_default default_attributes
+      end
+    end
+  end
+end

data/lib/gamefic/engine/base.rb

@@ -3,7 +3,10 @@ module Gamefic
   # Basic functionality for running a single-player game from a console.
   #
   class Engine::Base
+    # @return [Class]
     attr_writer :user_class
+
+    # @return [Gamefic::Plot]
     attr_reader :plot
 
     def initialize(plot)
@@ -20,46 +23,36 @@ module Gamefic
     end
 
     def connect
-      @character = @plot.make Character, name: 'yourself', synonyms: 'self myself you me', proper_named: true
-      @user = user_class.new
-      @character.connect @user
-      @character
+      raise 'Plot did not specify a player class' if @plot.player_class.nil?
+      # @todo The plot itself can define name, etc.
+      character = @plot.make @plot.player_class, name: 'yourself', synonyms: 'self myself you me', proper_named: true
+      @user = user_class.new(self)
+      @user.connect character
+      character.connect @user
     end
 
     def run
       connect
-      @plot.introduce @character
-      @user.update @character.state
-      turn until @character.concluded?
+      @plot.introduce @user.character
+      #@user.update @character.state
+      turn until @user.character.concluded?
+      @user.update
       #print @user.flush
     end
 
     def turn
       @plot.ready
-      unless @character.state[:options].nil?
-        list = '<ol class="multiple_choice">'
-        @character.state[:options].each { |o|
-          list += "<li><a href=\"#\" rel=\"gamefic\" data-command=\"#{o}\">#{o}</a></li>"
-        }
-        list += "</ol>"
-        @character.tell list
-      end
-      #print @user.flush
-      @user.update @character.state
-      #@character.flush
-      if @character.queue.empty?
+      @user.update
+      if @user.character.queue.empty?
         receive
       end
       @plot.update
-      #print @user.flush
-      @user.update @character.state
-      #@character.flush
     end
 
     def receive
-      print @character.scene.prompt + ' '
+      print @user.character.scene.prompt + ' '
       input = STDIN.gets
-      @character.queue.push input unless input.nil?
+      @user.character.queue.push input unless input.nil?
     end
   end
 

data/lib/gamefic/entity.rb

@@ -4,39 +4,11 @@ require 'gamefic/messaging'
 
 module Gamefic
 
-  class Entity
+  class Entity < Element
     include Node
-    include Describable
     include Messaging
     include Grammar::WordAdapter
 
-    attr_reader :session
-
-    def initialize(args = {})
-      pre_initialize
-      args.each { |key, value|
-        send "#{key}=", value
-      }
-      @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
-
     # 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.
@@ -53,22 +25,32 @@ module Gamefic
       end
       super
     end
-    
-    # Get an extended property.
+
+    # A freeform property dictionary.
+    # Authors can use the session hash to assign custom properties to the
+    # entity. It can also be referenced directly using [] without the method
+    # name, e.g., entity.session[:my_value] or entity[:my_value].
     #
-    # @param key [Symbol] The property's name.
+    # @return [Hash]
+    def session
+      @session ||= {}
+    end
+
+    # Get a custom property.
+    #
+    # @param key [Symbol] The property's name
+    # @return The value of the property
     def [](key)
       session[key]
     end
     
-    # Set an extended property.
+    # Set a custom property.
     #
-    # @param key [Symbol] The property's name.
-    # @param value The value to set.
+    # @param key [Symbol] The property's name
+    # @param value The value to set
     def []=(key, value)
       session[key] = value
     end
-    
   end
 
 end

data/lib/gamefic/grammar/gender.rb

@@ -5,7 +5,7 @@ module Gamefic::Grammar
     attr_writer :gender
     def gender
       # Supported values are "male", "female", "other", and "neutral"
-      @gender ||= (self.kind_of?(Character) ? "other" : "neutral")
+      @gender ||= "neutral"
     end
   end
 end

data/lib/gamefic/grammar/pronouns.rb

@@ -53,7 +53,7 @@ module Gamefic::Grammar
     #
     # @return [String]
     def Poss
-      obj.cap_first
+      poss.cap_first
     end
     
     # Get the capitalized reflexive pronoun
@@ -88,7 +88,7 @@ module Gamefic::Grammar
       if @sets.nil?
         @sets = {}
         @sets["1:singular"] = ["I", "me", "my", "myself"]
-        @sets["2"] = ["you", "you", "your", "yourself"]
+        @sets["2:singular"] = ["you", "you", "your", "yourself"]
         @sets["3:singular:male"] = ["he", "him", "his", "himself"]
         @sets["3:singular:female"] = ["she", "her", "her", "herself"]
         # "other" refers to a person or living being that is neither
@@ -97,6 +97,7 @@ module Gamefic::Grammar
         @sets["3:singular:other"] = ["they", "them", "their", "themselves"]
         @sets["3:singular:neutral"] = ["it", "it", "its", "itself"]
         @sets["1:plural"] = ["we", "us", "our", "ourselves"]
+        @sets["2:plural"] = ["you", "you", "your", "yourselves"]
         @sets["3:plural"] = ["they", "them", "their", "themselves"]
       end
       @sets

data/lib/gamefic/messaging.rb

@@ -11,7 +11,6 @@ module Gamefic
       # compatibility with Opal.
       message = message.gsub(/[ \t\r]*\n[ \t\r]*\n[ \t\r]*/, '</p><p>')
       message = message.gsub(/[ \t]*\n[ \t]*/, ' ')
-      #user.send message
       p_set_messages messages + message
     end
 

data/lib/gamefic/plot.rb

@@ -1,5 +1,3 @@
-# TODO: JSON support is currently experimental.
-#require 'gamefic/entityloader'
 require 'gamefic/tester'
 require 'gamefic/source'
 require 'gamefic/script'
@@ -14,6 +12,7 @@ module Gamefic
     autoload :Articles,  'gamefic/plot/articles'
     autoload :YouMount,  'gamefic/plot/you_mount'
     autoload :Snapshot,  'gamefic/plot/snapshot'
+    autoload :Darkroom,  'gamefic/plot/darkroom'
     autoload :Host,      'gamefic/plot/host'
     autoload :Players,   'gamefic/plot/players'
     autoload :Playbook,  'gamefic/plot/playbook'
@@ -21,6 +20,7 @@ module Gamefic
     autoload :Theater,   'gamefic/plot/theater'
 
     attr_reader :commands, :imported_scripts, :source
+
     # TODO: Metadata could use better protection
     attr_accessor :metadata
     include Theater
@@ -36,6 +36,11 @@ module Gamefic
       post_initialize
     end
 
+    def player_class cls = nil
+      @player_class = cls unless cls.nil?
+      @player_class
+    end
+
     # @return [Gamefic::Plot::Playbook]
     def playbook
       @playbook ||= Gamefic::Plot::Playbook.new
@@ -68,6 +73,8 @@ module Gamefic
     def ready
       playbook.freeze
       @running = true
+      # Call the initial state to make sure it's set
+      initial_state
       call_ready
       call_player_ready
       p_subplots.each { |s| s.ready }
@@ -78,7 +85,10 @@ module Gamefic
     def update
       entities.each { |e| e.flush }
       call_before_player_update
-      p_players.each { |p| p.scene.update }
+      p_players.each { |p|
+        p.performed nil
+        p.scene.update
+      }
       p_entities.each { |e| e.update }
       call_player_update
       call_update
@@ -117,7 +127,7 @@ module Gamefic
       else
         false
       end
-    end    
+    end
   end
 
 end

data/lib/gamefic/plot/callbacks.rb

@@ -30,7 +30,7 @@ module Gamefic
     #     player[:turns] += 1
     #   end
     #
-    # @yieldparam [Character]
+    # @yieldparam [Gamefic::Performance]
     def on_player_ready &block
       p_player_ready_procs.push block
     end
@@ -98,7 +98,6 @@ module Gamefic
     #
     def call_player_update
       p_players.each { |player|
-        #player.performed nil
         p_player_update_procs.each { |block| block.call player }
       }
     end

data/lib/gamefic/plot/commands.rb

@@ -103,11 +103,10 @@ module Gamefic
     end
 
     # Get an Array of available verbs.
-    # If the to_s parameter is true, convert Symbols to Strings.
     #
-    # @return [Array<Symbol|String>]
-    def verbs to_s: false
-      to_s ? playbook.verbs.map { |v| v.to_s } : playbook.verbs
+    # @return [Array<String>]
+    def verbs
+      playbook.verbs.map { |v| v.to_s }.reject{ |v| v.start_with?('_') }
     end
 
     # Get an Array of all Actions defined in the Plot.

data/lib/gamefic/plot/darkroom.rb

@@ -0,0 +1,264 @@
+module Gamefic
+  # Create and restore plot snapshots.
+  #
+  class Plot::Darkroom
+    attr_reader :plot
+
+    def initialize plot
+      @plot = plot
+    end
+
+    # Create a snapshot of the plot.
+    #
+    # @return [Hash]
+    def save
+      result = { entities: [], players: [], subplots: [], instance_variables: {} }
+      entity_store.clear
+      player_store.clear
+      entity_store.concat plot.entities
+      player_store.concat plot.players
+      plot.subplots.each { |s| entity_store.concat s.entities }
+      entity_store.uniq!
+      entity_store.each do |e|
+        result[:entities].push hash_entity(e)
+      end
+      player_store.each do |p|
+        result[:players].push hash_entity(p)
+      end
+      plot.theater.instance_variables.each { |i|
+        v = plot.theater.instance_variable_get(i)
+        result[:instance_variables][i] = serialize(v) if can_serialize?(v)
+      }
+      plot.subplots.each { |s|
+        result[:subplots].push hash_subplot(s)
+      }
+      result
+    end
+
+    # Restore a snapshot.
+    #
+    def restore snapshot
+      entity_store.clear
+      player_store.clear
+      plot.subplots.each { |s| s.conclude }
+      plot.entities[plot.initial_state[:entities].length..-1].each { |e| plot.destroy e }
+      entity_store.concat plot.entities[0..plot.initial_state[:entities].length-1]
+      entity_store.uniq!
+      player_store.concat plot.players
+      i = 0
+      snapshot[:entities].each { |h|
+        if entity_store[i].nil?
+          e = plot.stage do
+            cls = self.const_get(h[:class])
+            make cls
+          end
+          entity_store.push e
+        end
+        i += 1
+      }
+      snapshot[:subplots].each { |s|
+        sp = plot.stage do
+          cls = const_get(s[:class])
+          branch cls
+        end
+        # @todo Assuming one player
+        sp.introduce player_store[0] unless player_store.empty?
+        rebuild_subplot sp, s
+      }
+      i = 0
+      snapshot[:entities].each { |h|
+        rebuild1 entity_store[i], h
+        i += 1
+      }
+      i = 0
+      snapshot[:players].each { |p|
+        rebuild1 player_store[i], p
+        i += 1
+      }
+      i = 0
+      snapshot[:entities].each { |h|
+        rebuild2 entity_store[i], h
+        i += 1
+      }
+      i = 0
+      snapshot[:players].each { |h|
+        rebuild2 player_store[i], h
+        i += 1
+      }
+      snapshot[:instance_variables].each_pair { |k, v|
+        plot.theater.instance_variable_set(k, unserialize(v))
+      }
+    end
+
+    private
+
+    def hash_blacklist
+      [:@parent, :@children, :@last_action, :@scene, :@next_scene, :@playbook, :@performance_stack, :@buffer_stack, :@messages, :@state]
+    end
+
+    def can_serialize? v
+      return true if v.kind_of?(String) or v.kind_of?(Numeric) or v.kind_of?(Symbol) or v.kind_of?(Gamefic::Entity) or is_scene_class?(v) or v == true or v == false or v.nil?
+      if v.kind_of?(Array)
+        v.each do |e|
+          result = can_serialize?(e)
+          return false if result == false
+        end
+        true
+      elsif v.kind_of?(Hash)
+        v.each_pair do |k, v|
+          result = can_serialize?(k)
+          return false if result == false
+          result = can_serialize?(v)
+          return false if result == false
+        end
+        true
+      else
+        false
+      end
+    end
+
+    def is_scene_class?(v)
+      if v.kind_of?(Class)
+        s = v
+        until s.nil?
+          return true if s == Gamefic::Scene::Base
+          s = s.superclass
+        end
+        false
+      else
+        false
+      end
+    end
+
+    def serialize v
+      if v.kind_of?(Array)
+        result = []
+        v.each do |e|
+          result.push serialize(e)
+        end
+        result
+      elsif v.kind_of?(Hash)
+        result = {}
+        v.each_pair do |k, v|
+          result[serialize(k)] = serialize(v)
+        end
+        result
+      elsif is_scene_class?(v)
+        i = plot.scene_classes.index(v)
+        "#<SIN_#{i}>"
+      elsif v.kind_of?(Gamefic::Entity)
+        i = entity_store.index(v)
+        if i.nil?
+          i = player_store.index(v)
+          if i.nil?
+            raise "#{v} not found in plot"
+            nil
+          else
+            "#<PIN_#{i}>"
+          end
+        else
+          "#<EIN_#{i}>"
+        end
+      else
+        v
+      end
+    end
+
+    def unserialize v
+      if v.kind_of?(Array)
+        result = []
+        v.each do |e|
+          result.push unserialize(e)
+        end
+        result
+      elsif v.kind_of?(Hash)
+        result = {}
+        v.each_pair do |k, v|
+          result[unserialize(k)] = unserialize(v)
+        end
+        result
+      elsif v.kind_of?(String)
+        if m = v.match(/#<SIN_([0-9]+)>/)
+          plot.scene_classes[m[1].to_i]
+        elsif m = v.match(/#<EIN_([0-9]+)>/)
+          entity_store[m[1].to_i]
+        elsif m = v.match(/#<PIN_([0-9]+)>/)
+          player_store[m[1].to_i]
+        else
+          v
+        end
+      else
+        v
+      end
+    end
+
+    def rebuild1 e, h
+      h.each_pair do |k, v|
+        if k.to_s.start_with?('@')
+          e.instance_variable_set(k, unserialize(v))
+        end
+      end
+    end
+
+    def rebuild2 e, h
+      h.each_pair do |k, v|
+        if k.to_s != 'class' and !k.to_s.start_with?('@')
+          e.send("#{k}=", unserialize(v))
+        end
+      end
+    end
+
+    def hash_subplot s
+      result = { entities: [], instance_variables: {}, theater_instance_variables: {} }
+      s.instance_variables.each { |i|
+        v = s.instance_variable_get(i)
+        result[:instance_variables][i] = serialize(v) if can_serialize?(v)
+      }
+      s.theater.instance_variables.each { |i|
+        v = s.theater.instance_variable_get(i)
+        result[:theater_instance_variables][i] = serialize(v) if can_serialize?(v)
+      }
+      s.entities.each { |s|
+        result[:entities].push serialize(s)
+      }
+      result[:class] = s.class.to_s.split('::').last
+      result
+    end
+
+    def rebuild_subplot s, h
+      s.entities.each { |e|
+        s.destroy e
+      }
+      h[:instance_variables].each_pair { |k, v|
+        s.instance_variable_set(k, unserialize(v))
+      }
+      h[:theater_instance_variables].each_pair { |k, v|
+        s.theater.instance_variable_set(k, unserialize(v))
+      }
+      i = 0
+      h[:entities].each { |e|
+        s.add_entity unserialize(e)
+        i += 1
+      }
+    end
+
+    def entity_store
+      @entity_store ||= []
+    end
+
+    def player_store
+      @player_store ||= []
+    end
+
+    def hash_entity e
+      h = {}
+      e.instance_variables.each { |i|
+        v = e.instance_variable_get(i)
+        h[i] = serialize(v) unless hash_blacklist.include?(i) or !can_serialize?(v)
+      }
+      h[:class] = e.class.to_s.split('::').last
+      h[:parent] = serialize(e.parent)
+      h
+    end
+  end
+end