gamefic 1.5.1 → 1.6.0

data/lib/gamefic/character/state.rb

@@ -0,0 +1,12 @@
+module Gamefic
+  class Character
+    module State
+      def state
+        @state = {}
+        @state.merge! scene.state unless scene.nil?
+        @state.merge! output: messages
+        @state
+      end
+    end
+  end
+end

data/lib/gamefic/core_ext/array.rb

@@ -1,4 +1,15 @@
 class Array
+  # Get a subset of the array that matches the argument.
+  # If the argument is a Class or Module, the elements must be of the type.
+  # If the argument is a Symbol, it should be a method for which the elements must return true.
+  # If the argument is an Object, the elements must equal the object.
+  #
+  # @example
+  #   animals = ['dog', 'cat', nil]
+  #   animals.that_are(String) #=> ['dog', 'cat']
+  #   animals.that_are('dog')  #=> ['dog']
+  #   animals.that_are(:nil?)  #=> [nil]
+  #
   # @return [Array]
   def that_are(cls)
     if (cls.kind_of?(Class) or cls.kind_of?(Module))
@@ -12,6 +23,10 @@ class Array
       return Array.new
     end
   end
+
+  # Get a subset of the array that does not match the argument.
+  # See Array#that_are for information about how arguments are evaluated.
+  #
   # @return [Array]
   def that_are_not(cls)
     if (cls.kind_of?(Class) or cls.kind_of?(Module))
@@ -22,26 +37,50 @@ class Array
       return self.clone - [cls]
     end
   end
+
+  # Get a random element from the array.
+  # @deprecated Use Array#sample instead.
+  #
   def random
     return self[rand(self.length)]
   end
+
+  # Pop a random element from the array.
+  # @deprecated Use Array#pop_sample instead.
+  #
   def pop_random
+    pop_sample
+  end
+
+  # Pop a random element from the array.
+  #
+  def pop_sample
     delete_at(rand(self.length))
   end
+
+  # @todo Candidate for deprecation
   # @return [Array]
-  def shuffle
-    self.sort { |a, b|
-      rand(3) <=> rand(3)
-    }
-  end
+  #def shuffle
+  #  self.sort { |a, b|
+  #    rand(3) <=> rand(3)
+  #  }
+  #end
+
+  # @todo Candidate for deprecation
   # @return [Array]
-  def shuffle!
-    self.sort! { |a, b|
-      rand(3) <=> rand(3)
-    }
-  end
-  # Get a string representation of the array that separated elements with
+  #def shuffle!
+  #  self.sort! { |a, b|
+  #    rand(3) <=> rand(3)
+  #  }
+  #end
+
+  # Get a string representation of the array that separates elements with
   # commas and adds a conjunction before the last element.
+  #
+  # @example
+  #   animals = ['a dog', 'a cat', 'a mouse']
+  #   animals.join_and #=> 'a dog, a cat, and a mouse'
+  #
   # @return [String]
   def join_and(sep = ', ', andSep = ' and ', serial = true)
     if self.length < 3
@@ -51,6 +90,9 @@ class Array
       start.join(sep) + "#{serial ? sep.strip : ''}#{andSep}#{self.last}"
     end
   end
+
+  # @see Array#join_and
+  #
   # @return [String]
   def join_or(sep = ', ', orSep = ' or ', serial = true)
     join_and(sep, orSep, serial)

data/lib/gamefic/core_ext/string.rb

@@ -1,4 +1,5 @@
 class String
+	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

data/lib/gamefic/describable.rb

@@ -1,38 +1,48 @@
-require 'gamefic/keywords'
+#require 'gamefic/keywords'
 require 'gamefic/grammar'
 
 module Gamefic
 
-  # Add a variety of text properties for naming, describing, and properly
-  # referencing objects.
+  # Add a variety of text properties for naming, describing, and referencing
+  # objects.
   module Describable
     include Grammar::Person, Grammar::Plural
+    include Matchable
+
+    # @return [String]
     attr_reader :name
-    attr_accessor :synonyms, :indefinite_article
-    attr_writer :definite_article
-    
+
+    # @return [String]
+    attr_reader :synonyms
+
+    # @return [String]
+    attr_reader :indefinite_article
+
+    # @return [String]
+    attr_reader :definite_article
+
     # Get a set of Keywords associated with the object.
     # Keywords are typically the words in the object's name plus its synonyms.
     #
     # @return [Keywords]
     def keywords
-      Keywords.new "#{name} #{synonyms}"
+      @keywords ||= "#{definite_article} #{indefinite_article} #{name} #{synonyms}".downcase.split(Matchable::SPLIT_REGEXP).uniq
     end
-    
+
     # Get the name of the object with an indefinite article.
     # Note: proper-named objects never append an article, though an article
     # may be included in its proper name.
     #
     # @return [String]
     def indefinitely
-      ((proper_named? or indefinite_article == '') ? '' : "#{indefinite_article} ") + name
+      ((proper_named? or indefinite_article == '') ? '' : "#{indefinite_article} ") + name.to_s
     end
     
     # 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.
     def definitely
-      ((proper_named? or definite_article == '') ? '' : "#{definite_article} ") + name
+      ((proper_named? or definite_article == '') ? '' : "#{definite_article} ") + name.to_s
     end
     
     # Get the definite article for this object.
@@ -42,6 +52,16 @@ module Gamefic
       @definite_article || "the"
     end
     
+    def definite_article= article
+      @keywords = nil
+      @definite_article = article
+    end
+
+    def indefinite_article= article
+      @keywords = nil
+      @indefinite_article = article
+    end
+    
     # Is the object proper-named?
     # Proper-named objects typically do not add articles to their names when
     # referenced #definitely or #indefinitely, e.g., "Jane Doe" instead of
@@ -54,7 +74,7 @@ module Gamefic
     
     # Set whether the object has a proper name.
     #
-    # @param [Boolean]
+    # @param bool [Boolean]
     def proper_named=(bool)
       if bool == true
         if @definite_article != nil
@@ -71,6 +91,7 @@ module Gamefic
     #
     # @param value [String]
     def name=(value)
+      @keywords = nil
       words = value.split_words
       if ['a','an'].include?(words[0].downcase)
         @indefinite_article = words[0].downcase
@@ -120,6 +141,11 @@ module Gamefic
       end
     end
     
+    def synonyms= text
+      @keywords = nil
+      @synonyms = text
+    end
+
     # Set the object's default description.
     # The default description is typically set in an object's initialization
     # to ensure that a non-empty string is available when a instance-specific

data/lib/gamefic/engine/base.rb

@@ -29,22 +29,35 @@ module Gamefic
     def run
       connect
       @plot.introduce @character
+      @user.update @character.state
       turn until @character.concluded?
-      print @user.flush
+      #print @user.flush
     end
 
     def turn
       @plot.ready
-      print @user.flush
+      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?
         receive
       end
       @plot.update
-      print @user.flush
+      #print @user.flush
+      @user.update @character.state
+      #@character.flush
     end
 
     def receive
-      print @character.scene.prompt_for(@character) + ' '
+      print @character.scene.prompt + ' '
       input = STDIN.gets
       @character.queue.push input unless input.nil?
     end

data/lib/gamefic/engine/tty.rb

@@ -5,6 +5,10 @@ module Gamefic
   # Extend Engine::Base to connect with User::Tty, which provides ANSI
   # formatting for HTML.
   #
+  # @note Due to their dependency on io/console, User::Tty and Engine::Tty are
+  #   not included in the core Gamefic library. `require gamefic/tty` if you
+  #   need them.
+  #
   class Engine::Tty < Engine::Base
     def post_initialize
       self.user_class = Gamefic::User::Tty

data/lib/gamefic/entity.rb

@@ -1,19 +1,17 @@
 require "gamefic/node"
 require "gamefic/describable"
-require "gamefic/serialized"
+require 'gamefic/messaging'
 
 module Gamefic
 
   class Entity
     include Node
     include Describable
-    include Serialized
-    extend Serialized::ClassMethods
+    include Messaging
     include Grammar::WordAdapter
-    
+
     attr_reader :session
-    serialize :name, :parent, :description
-    
+
     def initialize(args = {})
       pre_initialize
       args.each { |key, value|
@@ -39,15 +37,6 @@ module Gamefic
       # 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.

data/lib/gamefic/matchable.rb

@@ -0,0 +1,50 @@
+module Gamefic
+  module Matchable
+    SPLIT_REGEXP = /[\s]+/
+
+    # Get an array of keywords associated with this object.
+    # The default implementation splits the value of self.to_s into an array.
+    #
+    # @return [Array<String>]
+    def keywords
+      self.to_s.downcase.split(SPLIT_REGEXP).uniq
+    end
+
+    # Determine if this object matches the provided description.
+    # In a regular match, every word in the description must be a keyword.
+    # Fuzzy matches accept words if a keyword starts with it, e.g., "red"
+    # would be a fuzzy match for "reddish."
+    #
+    # @example
+    #   dog = "big red dog"
+    #   dog.extend Gamefic::Matchable
+    #
+    #   dog.match?("red dog")  #=> true
+    #   dog.match?("gray dog") #=> false
+    #   dog.match?("red do")   #=> false
+    #
+    #   dog.match?("re do", fuzzy: true)  #=> true
+    #   dog.match?("red og", fuzzy: true) #=> false
+    #
+    # @return [Boolean]
+    def match? description, fuzzy: false
+      words = description.split(SPLIT_REGEXP)
+      return false if words.empty?
+      matches = 0
+      available = keywords
+      words.each { |w|
+        if fuzzy
+          available.each { |k|
+            if k.gsub(/[^a-z0-9]/, '').start_with?(w.downcase.gsub(/[^a-z0-9]/, ''))
+              matches +=1
+              break
+            end
+          }
+        else
+          matches +=1 if available.include?(w.downcase)
+        end
+      }
+      matches == words.length
+    end
+  end
+end

data/lib/gamefic/messaging.rb

@@ -0,0 +1,45 @@
+module Gamefic
+  module Messaging
+    # Send a message to the entity.
+    # This method will automatically wrap the message in HTML paragraphs.
+    # To send a message without paragraph formatting, use #stream instead.
+    #
+    # @param message [String]
+    def tell(message)
+      message = "<p>#{message.strip}</p>"
+      # This method uses String#gsub instead of String#gsub! for
+      # 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
+
+    # Send a message to the Character as raw text.
+    # Unlike #tell, this method will not wrap the message in HTML paragraphs.
+    #
+    # @param message [String]
+    def stream(message)
+      p_set_messages messages + message.strip
+    end
+
+    # @return [String]
+    def messages
+      @messages ||= ''
+    end
+    
+    def output
+      messages
+    end
+
+    def flush
+      p_set_messages '' unless messages.empty?
+    end
+
+    private
+
+    def p_set_messages str
+      @messages = str
+    end
+  end
+end

data/lib/gamefic/node.rb

@@ -11,6 +11,8 @@ module Gamefic
       @children ||= []
       @children.clone
     end
+
+    # @return [Array]
     def flatten
       array = Array.new
       children.each { |child|
@@ -18,9 +20,12 @@ module Gamefic
       }
       return array
     end
+
+    # @return [Object]
     def parent
       @parent
     end
+
     def parent=(node)
       return if node == @parent 
       if node == self
@@ -43,19 +48,30 @@ module Gamefic
         end
       end
     end
+
+    # @return [Boolean]
+    def accessible?
+      true
+    end
+
     protected
+
     def add_child(node)
       children
       @children.push(node)
     end
+
     def rem_child(node)
       children
       @children.delete(node)
     end
+
     def concat_children(children)
       children.concat(children)
     end
+
     private
+
     def recurse_flatten(node)
       array = Array.new
       array.push(node)