gamefic 0.2.0 → 0.6.0

data/lib/gamefic/entity.rb

@@ -1,76 +1,103 @@
-require "digest/md5"
 require "gamefic/node"
 require "gamefic/describable"
-require "gamefic/plot"
+require "gamefic/serialized"
 
 module Gamefic
 
-	class Entity
-		include Branch
-		include Describable
-    include OptionSettings
-    attr_writer :option_array
-		attr_reader :session, :plot
-		def initialize(plot, args = {})
-			if (plot.kind_of?(Plot) == false)
-				raise "First argument must be a Plot"
-			end
-			pre_initialize
-			#self.state = State
-			#@story = Subplot.current
-			@plot = plot
-      @option_mapper = @plot
-			@plot.send :add_entity, self
-			#@story.add_entity self
-			args.each { |key, value|
-				send "#{key}=", value
-			}
-			@update_procs = Array.new
-			@session = Hash.new
-			post_initialize
-		end
-		#def self.present(args = {})
-		#	story = Plot.Loading
-		#	if story == nil
-		#		raise "No plot loading"
-		#	end
-		#	return self.new(story, args)
-		#end
-		def uid
-			if @uid == nil
-				@uid = Digest::MD5.hexdigest(self.object_id.to_s)[0,8]
-			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, refresh = false)
-			#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 update
-			@update_procs.each { |p|
-				p.call self
-			}
-		end
-		def on_update(&block)
-			@update_procs.push block
-		end
-		def parent=(node)
-			if node != nil and node.kind_of?(Entity) == false and node.kind_of?(Zone) == false
-				raise "Entity's parent must be an Entity or a Zone"
-			end
-			super
-		end
-		def destroy
-			self.parent = nil
-			# TODO: Need to call this private method here?
-			@plot.send(:rem_entity, self)
-		end
-	end
+  class Entity
+    include Node
+    include Describable
+    include Serialized
+    extend Serialized::ClassMethods
+    include Grammar::WordAdapter
+    
+    attr_reader :session, :plot
+    serialize :name, :parent, :description
+    
+    def initialize(plot, args = {})
+      if (plot.kind_of?(Plot) == false)
+        raise "First argument must be a Plot"
+      end
+      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.
+    #
+    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.
+    #
+    # @param node [Entity] The new parent.
+    def parent=(node)
+      if node != nil and node.kind_of?(Entity) == false
+        raise "Entity's parent must be an Entity"
+      end
+      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.
+    def [](key)
+      session[key]
+    end
+    
+    # Set an extended property.
+    #
+    # @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/conjugator.rb

@@ -0,0 +1,20 @@
+require 'gamefic'
+require 'gamefic/grammar'
+
+module Gamefic::Grammar
+  module Conjugator    
+    module ClassMethods
+      @@conjugated_verbs = {}
+      def conjugate infinitive, tense, *forms
+        @@conjugated_verbs[infinitive] ||= {}
+        @@conjugated_verbs[infinitive][tense] = VerbSet.new(infinitive, *forms)
+      end
+      def conjugated_verbs
+        @@conjugated_verbs
+      end
+    end
+    #def self.included(base)
+    #  base.extend ClassMethods
+    #end
+  end
+end

data/lib/gamefic/grammar/gender.rb

@@ -0,0 +1,11 @@
+require 'gamefic/grammar'
+
+module Gamefic::Grammar
+  module Gender
+    attr_writer :gender
+    def gender
+      # Supported values are "male", "female", "other", and "neutral"
+      @gender ||= "neutral"
+    end
+  end
+end

data/lib/gamefic/grammar/person.rb

@@ -0,0 +1,10 @@
+require 'gamefic/grammar'
+
+module Gamefic::Grammar
+  module Person
+    attr_writer :person
+    def person
+      @person ||= 3
+    end
+  end
+end

data/lib/gamefic/grammar/plural.rb

@@ -0,0 +1,13 @@
+require 'gamefic/grammar'
+
+module Gamefic::Grammar
+  module Plural
+    attr_writer :plural
+    def plural?
+      if @plural.nil?
+        @plural = false
+      end
+      @plural
+    end
+  end
+end

data/lib/gamefic/grammar/pronouns.rb

@@ -0,0 +1,60 @@
+require 'gamefic'
+require 'gamefic/grammar'
+
+module Gamefic::Grammar
+  class Pronouns
+    def initialize object
+      @object = object
+    end
+    def subj
+      Pronouns.get_pronoun_set(@object)[0]
+    end
+    def obj
+      Pronouns.get_pronoun_set(@object)[1]
+    end
+    def poss
+      Pronouns.get_pronoun_set(@object)[2]
+    end
+    def Subj
+      subj.cap_first
+    end
+    def Obj
+      obj.cap_first
+    end
+    def Poss
+      obj.cap_first
+    end
+    def self.get_pronoun_set(obj)
+      set = Pronouns.sets["#{obj.person}"]
+      if set.nil?
+        set = Pronouns.sets["#{obj.person}:#{obj.plural? ? 'plural' : 'singular'}"]
+      end
+      if set.nil?
+        set = Pronouns.sets["#{obj.person}:#{obj.plural? ? 'plural' : 'singular'}:#{obj.gender}"]
+      end
+      if set.nil?
+        raise "Pronoun set could not be determined"
+      end
+      set
+    end
+    # TODO Consider implementing method_missing to determine correct pronoun
+    # from example, e.g., "he" would change to "she" for female entities
+    def self.sets
+      if @sets.nil?
+        @sets = {}
+        @sets["1:singular"] = ["I", "me", "my"]
+        @sets["2"] = ["you", "you", "your"]
+        @sets["3:singular:male"] = ["he", "him", "his"]
+        @sets["3:singular:female"] = ["she", "her", "her"]
+        # "other" refers to a person or living being that is neither
+        # male or female or for whom gender is unspecified. It's
+        # typically used to avoid referring to a person as "it."
+        @sets["3:singular:other"] = ["they", "them", "their"]
+        @sets["3:singular:neutral"] = ["it", "it", "its"]
+        @sets["1:plural"] = ["we", "us", "our"]
+        @sets["3:plural"] = ["they", "them", "their"]
+      end
+      @sets
+    end
+  end
+end

data/lib/gamefic/grammar/tense.rb

@@ -0,0 +1,6 @@
+require 'gamefic/grammar'
+
+module Gamefic::Grammar::Tense
+  PRESENT = :present
+  PAST = :past
+end

data/lib/gamefic/grammar/verb_set.rb

@@ -0,0 +1,43 @@
+require 'gamefic/grammar'
+
+module Gamefic::Grammar
+    class VerbSet
+      def initialize infinitive, *forms
+        # TODO what to do with the tense?
+        @infinitive = infinitive.to_s
+        @forms = {}
+        form = forms[0]
+        @forms["1:singular"] = form.nil? ? @infinitive.to_s : form.to_s
+        form = forms[1]
+        @forms["2:singular"] = form.nil? ? @infinitive.to_s : form.to_s
+        form = forms[2]
+        @forms["3:singular"] = form.nil? ? generate_third_singular : form.to_s
+        form = forms[3]
+        @forms["1:plural"] = form.nil? ? @infinitive.to_s : form.to_s
+        form = forms[4]
+        @forms["2:plural"] = form.nil? ? @forms["1:plural"] : form.to_s
+        form = forms[5]
+        @forms["3:plural"] = form.nil? ? @forms["1:plural"] : form.to_s
+      end
+      def conjugate pronoun
+        form = @forms["#{pronoun.person}"]
+        if form.nil?
+          form = @forms["#{pronoun.person}:#{pronoun.plural? ? 'plural' : 'singular'}"]
+        end
+        if form.nil?
+          raise "Unable to conjugate #{@infinitive}"
+        end
+        form
+      end
+      private
+      def generate_third_singular
+        if @infinitive.end_with?('o')
+          @infinitive + "es"
+        elsif @infinitive.end_with?('ry')
+          @infinitive[0..-2] + "ies"
+        else
+          @infinitive + "s"
+        end
+      end
+    end
+end

data/lib/gamefic/grammar/verbs.rb

@@ -0,0 +1,25 @@
+require 'gamefic'
+require 'gamefic/grammar'
+
+module Gamefic::Grammar
+  class Verbs
+    extend Gamefic::Grammar::Conjugator::ClassMethods
+    def initialize obj
+      @pronoun = obj
+      self.class.conjugated_verbs.each_pair { |infinitive, verbset|
+        define_singleton_method infinitive do
+          verbset[:present].conjugate @pronoun
+        end
+      }
+    end
+    def method_missing infinitive, *args, &block
+      Gamefic::Grammar::VerbSet.new(infinitive, nil, *args).conjugate(@pronoun)
+    end
+    def [] infinitive
+      words = infinitive.split_words
+      Gamefic::Grammar::VerbSet.new(words[0], nil).conjugate(@pronoun) + (words.length > 1 ? ' ' + words[1..-1].join(' ') : '')
+    end
+    conjugate :be,   :present, :am,   :are,  :is,  :are
+    conjugate :have, :present, :have, :have, :has, :have
+  end
+end

data/lib/gamefic/grammar/word_adapter.rb

@@ -0,0 +1,36 @@
+require 'gamefic/grammar'
+require 'gamefic/grammar/gender'
+
+module Gamefic::Grammar
+  module WordAdapter
+    include Gender
+    include Person
+    include Plural
+    # @return [Gamefic::Grammar::Pronouns]
+    def pronoun
+      @pronoun ||= Grammar::Pronouns.new(self)
+    end
+    # @return [Gamefic::Grammar::Verbs]
+    def verb
+      @verb ||= Grammar::Verbs.new(self)
+    end
+    def contract words
+      @contractions ||= {
+        "I am" => "I'm",
+        "you are" => "you're",
+        "he is" => "he's",
+        "she is" => "she's",
+        "it is" => "it's",
+        "we are" => "we're",
+        "they are" => "they're",
+        "am not" => "am not",
+        "are not" => "aren't",
+        "is not" => "isn't",
+        "do not" => "don't",
+        "does not" => "doesn't"
+      }
+      src = pronoun.subj + " " + verb.send(words)
+      @contractions[src] || src
+    end
+  end
+end

data/lib/gamefic/grammar.rb

@@ -0,0 +1,13 @@
+module Gamefic
+  module Grammar
+    autoload :Tense, 'gamefic/grammar/tense'
+    autoload :Pronouns, 'gamefic/grammar/pronouns'
+    autoload :Conjugator, 'gamefic/grammar/conjugator'
+    autoload :Verbs, 'gamefic/grammar/verbs'
+    autoload :VerbSet, 'gamefic/grammar/verb_set'
+    autoload :Person, 'gamefic/grammar/person'
+    autoload :Plural, 'gamefic/grammar/plural'
+    autoload :Gender, 'gamefic/grammar/gender'
+    autoload :WordAdapter, 'gamefic/grammar/word_adapter'
+  end
+end

data/lib/gamefic/html.rb

@@ -0,0 +1,53 @@
+require 'rexml/document'
+
+module Gamefic
+
+  module Html
+    def self.fix_ampersands(text)
+      codes = []
+      ENTITIES.keys.each { |e|
+        codes.push e[1..-1]
+      }
+      piped = codes.join('|')
+      re = Regexp.new("&(?!(#{piped}))")
+      text.gsub(re, '&\1')
+    end
+    def self.encode(text)
+      Gamefic::Html::ENTITIES.each { |k, v|
+        while text.include?(k)
+          text[v] = k
+        end
+      }
+      text
+    end
+    def self.decode(text)
+      Gamefic::Html::ENTITIES.each { |k, v|
+        while text.include?(k)
+          text[k] = v
+        end
+      }
+      text
+    end
+    def self.parse(code)
+      code = fix_ampersands(code).strip
+      last = nil
+      begin
+        doc = REXML::Document.new code
+      rescue REXML::ParseException => e
+        if e.source.buffer != last
+          if e.source.buffer[0,1] == '<'
+            code = code[0,(code.length - e.source.buffer.length)] + '&lt;' + e.source.buffer[1..-1]
+            last = e.source.buffer
+            retry
+          end
+        end
+        raise e
+      end
+    end
+  end
+
+  module Html
+    ENTITIES = { "&quot;" => "\"", "&amp;" => "&", "&lt;" => "<", "&gt;" => ">", "&nbsp;" => " ", "&iexcl;" => "¡", "&cent;" => "¢", "&pound;" => "£", "&curren;" => "¤", "&yen;" => "¥", "&brvbar;" => "¦", "&sect;" => "§", "&uml;" => "¨", "&copy;" => "©", "&ordf;" => "ª", "&laquo;" => "«", "&not;" => "¬", "&shy;" => "­", "&reg;" => "®", "&macr;" => "¯", "&deg;" => "°", "&plusmn;" => "±", "&sup2;" => "²", "&sup3;" => "³", "&acute;" => "´", "&micro;" => "µ", "&para;" => "¶", "&middot;" => "·", "&cedil;" => "¸", "&sup1;" => "¹", "&ordm;" => "º", "&raquo;" => "»", "&frac14;" => "¼", "&frac12;" => "½", "&frac34;" => "¾", "&iquest;" => "¿", "&Agrave;" => "À", "&Aacute;" => "Á", "&Acirc;" => "Â", "&Atilde;" => "Ã", "&Auml;" => "Ä", "&Aring;" => "Å", "&AElig;" => "Æ", "&Ccedil;" => "Ç", "&Egrave;" => "È", "&Eacute;" => "É", "&Ecirc;" => "Ê", "&Euml;" => "Ë", "&Igrave;" => "Ì", "&Iacute;" => "Í", "&Icirc;" => "Î", "&Iuml;" => "Ï", "&ETH;" => "Ð", "&Ntilde;" => "Ñ", "&Ograve;" => "Ò", "&Oacute;" => "Ó", "&Ocirc;" => "Ô", "&Otilde;" => "Õ", "&Ouml;" => "Ö", "&times;" => "×", "&Oslash;" => "Ø", "&Ugrave;" => "Ù", "&Uacute;" => "Ú", "&Ucirc;" => "Û", "&Uuml;" => "Ü", "&Yacute;" => "Ý", "&THORN;" => "Þ", "&szlig;" => "ß", "&agrave;" => "à", "&aacute;" => "á", "&acirc;" => "â", "&atilde;" => "ã", "&auml;" => "ä", "&aring;" => "å", "&aelig;" => "æ", "&ccedil;" => "ç", "&egrave;" => "è", "&eacute;" => "é", "&ecirc;" => "ê", "&euml;" => "ë", "&igrave;" => "ì", "&iacute;" => "í", "&icirc;" => "î", "&iuml;" => "ï", "&eth;" => "ð", "&ntilde;" => "ñ", "&ograve;" => "ò", "&oacute;" => "ó", "&ocirc;" => "ô", "&otilde;" => "õ", "&ouml;" => "ö", "&divide;" => "÷", "&oslash;" => "ø", "&ugrave;" => "ù", "&uacute;" => "ú", "&ucirc;" => "û", "&uuml;" => "ü", "&yacute;" => "ý", "&thorn;" => "þ", "&yuml;" => "ÿ", "&OElig;" => "Œ", "&oelig;" => "œ", "&Scaron;" => "Š", "&scaron;" => "š", "&Yuml;" => "Ÿ", "&fnof;" => "ƒ", "&circ;" => "ˆ", "&tilde;" => "˜", "&Alpha;" => "Α", "&Beta;" => "Β", "&Gamma;" => "Γ", "&Delta;" => "Δ", "&Epsilon;" => "Ε", "&Zeta;" => "Ζ", "&Eta;" => "Η", "&Theta;" => "Θ", "&Iota;" => "Ι", "&Kappa;" => "Κ", "&Lambda;" => "Λ", "&Mu;" => "Μ", "&Nu;" => "Ν", "&Xi;" => "Ξ", "&Omicron;" => "Ο", "&Pi;" => "Π", "&Rho;" => "Ρ", "&Sigma;" => "Σ", "&Tau;" => "Τ", "&Upsilon;" => "Υ", "&Phi;" => "Φ", "&Chi;" => "Χ", "&Psi;" => "Ψ", "&Omega;" => "Ω", "&alpha;" => "α", "&beta;" => "β", "&gamma;" => "γ", "&delta;" => "δ", "&epsilon;" => "ε", "&zeta;" => "ζ", "&eta;" => "η", "&theta;" => "θ", "&iota;" => "ι", "&kappa;" => "κ", "&lambda;" => "λ", "&mu;" => "μ", "&nu;" => "ν", "&xi;" => "ξ", "&omicron;" => "ο", "&pi;" => "π", "&rho;" => "ρ", "&sigmaf;" => "ς", "&sigma;" => "σ", "&tau;" => "τ", "&upsilon;" => "υ", "&phi;" => "φ", "&chi;" => "χ", "&psi;" => "ψ", "&omega;" => "ω", "&thetasym;" => "ϑ", "&upsih;" => "ϒ", "&piv;" => "ϖ", "&ensp;" => " ", "&emsp;" => " ", "&thinsp;" => " ", "&zwnj;" => "‌", "&zwj;" => "‍", "&lrm;" => "‎", "&rlm;" => "‏", "&ndash;" => "–", "&mdash;" => "—", "&lsquo;" => "‘", "&rsquo;" => "’", "&sbquo;" => "‚", "&ldquo;" => "“", "&rdquo;" => "”", "&bdquo;" => "„", "&dagger;" => "†", "&Dagger;" => "‡", "&bull;" => "•", "&hellip;" => "…", "&permil;" => "‰", "&prime;" => "′", "&Prime;" => "″", "&lsaquo;" => "‹", "&rsaquo;" => "›", "&oline;" => "‾", "&frasl;" => "⁄", "&euro;" => "€", "&image;" => "ℑ", "&weierp;" => "℘", "&real;" => "ℜ", "&trade;" => "™", "&alefsym;" => "ℵ", "&larr;" => "←", "&uarr;" => "↑", "&rarr;" => "→", "&darr;" => "↓", "&harr;" => "↔", "&crarr;" => "↵", "&lArr;" => "⇐", "&uArr;" => "⇑", "&rArr;" => "⇒", "&dArr;" => "⇓", "&hArr;" => "⇔", "&forall;" => "∀", "&part;" => "∂", "&exist;" => "∃", "&empty;" => "∅", "&nabla;" => "∇", "&isin;" => "∈", "&notin;" => "∉", "&ni;" => "∋", "&prod;" => "∏", "&sum;" => "∑", "&minus;" => "−", "&lowast;" => "∗", "&radic;" => "√", "&prop;" => "∝", "&infin;" => "∞", "&ang;" => "∠", "&and;" => "∧", "&or;" => "∨", "&cap;" => "∩", "&cup;" => "∪", "&int;" => "∫", "&there4;" => "∴", "&sim;" => "∼", "&cong;" => "≅", "&asymp;" => "≈", "&ne;" => "≠", "&equiv;" => "≡", "&le;" => "≤", "&ge;" => "≥", "&sub;" => "⊂", "&sup;" => "⊃", "&nsub;" => "⊄", "&sube;" => "⊆", "&supe;" => "⊇", "&oplus;" => "⊕", "&otimes;" => "⊗", "&perp;" => "⊥", "&sdot;" => "⋅", "&lceil;" => "⌈", "&rceil;" => "⌉", "&lfloor;" => "⌊", "&rfloor;" => "⌋", "&lang;" => "〈", "&rang;" => "〉", "&loz;" => "◊", "&spades;" => "♠", "&clubs;" => "♣", "&hearts;" => "♥", "&diams;" => "♦" }
+  end
+
+end

data/lib/gamefic/keywords.rb

@@ -2,41 +2,59 @@
 
 module Gamefic
 
-	class Keywords < Array
-		def initialize(statement = '')
-			if statement.kind_of?(Keywords)
-				self.concat statement
-			else
+  class Keywords < Array
+    def initialize(statement = '')
+      if statement.kind_of?(Keywords)
+        self.concat statement
+      else
         if statement.kind_of?(Array)
           statement = statement.join(' ')
         end
-				self.concat statement.to_s.gsub(/[^a-z0-9]/i, ' ').strip.downcase.split(' ')
-			end
-			self.delete_if { |w|
-				w.length < 2 or w == 'an' or w == 'the'
-			}
-			self.uniq!
-		end
-		def found_in(other)
-			matches = 0.0
-			self.each { |my_word|
-				if (other.include?(my_word))
-					matches = matches + 1.0
-				else
-					other.each { |other_word|
-						if my_word.length < other_word.length
-							if other_word[0, my_word.length] == my_word
-								matches = matches + (my_word.length.to_f / other_word.length.to_f)
-							end
-						end
-					}
-				end
-			}
-			return matches
-		end
-		def to_s
-			self.join(' ')
-		end
-	end
+        self.concat statement.to_s.gsub(/[^a-z0-9]/i, ' ').strip.downcase.split(' ')
+      end
+      # TODO: This routine is stubbed to allow any combination of letters and
+      # numbers as a keyword. Since we're doing this, there's a distinct
+      # possibility that the Keywords class can be deprecated.
+      #self.delete_if { |w|
+      #  w.length < 2 or w == 'an' or w == 'the'
+      #}
+      #self.uniq!
+      self
+    end
+    def found_in(other, fuzzy = false)
+      matches = 0.0
+      self.each { |my_word|
+        if other.include?(my_word)
+          matches = matches + 1.0
+        else
+          other.each { |other_word|
+            if my_word.length < other_word.length
+              if other_word[0, my_word.length] == my_word and my_word.length > 2
+                matches = matches + (my_word.length.to_f / other_word.length.to_f)
+              end
+            elsif fuzzy
+              fuzzy_word = my_word
+              if fuzzy_word.end_with?('ies')
+                fuzzy_word = fuzzy_word[0..-4]
+              elsif fuzzy_word.end_with?('ae')
+                fuzzy_word = fuzzy_word[0..-3]
+              elsif fuzzy_word.end_with?('s') or fuzzy_word.end_with?('i')
+                fuzzy_word = fuzzy_word[0..-2]
+              end
+              if other_word[0, fuzzy_word.length] == fuzzy_word and fuzzy_word.length > 2
+                matches = matches + (fuzzy_word.length.to_f / other_word.length.to_f)
+              elsif fuzzy_word[0, other_word.length] == other_word and other_word.length > 2
+                matches = matches + (fuzzy_word.length.to_f / other_word.length.to_f)
+              end
+            end
+          }
+        end
+      }
+      return matches
+    end
+    def to_s
+      self.join(' ')
+    end
+  end
 
 end