gamefic 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2e173d0a710f12b4d59089817ab6a060b394566
-  data.tar.gz: ef6fba6bffb3a7cc02d1d8ac281e6238b0d5e7d5
+  metadata.gz: 42ffeca62def8cbb07d70245a06be065a602c28d
+  data.tar.gz: 49c299be7bafa2aef310aeef08f84b17631b3ce4
 SHA512:
-  metadata.gz: ff108a8adea84779d6d60f7d57ce88010b8c983ff8607fe39a7fa87e0679ecb3ce11b8140b367da8f4814c9fcf23e3763ecdac1fe187d728ad1e065e432d7191
-  data.tar.gz: 18fd4dcd53803fa7167cc6d589fd85987e4c18fbe160e80859486a36f1221be44f75473562652acb7f4ca4bf6ae98876e61ba48d80c5cbc38a48e2fea62dff35
+  metadata.gz: a2b1a5142f260633c4b3d59f2c2cd48896926566554e67fe89f09ad0cdd15f98ff2305a09ca8022af3bbc1ae7d50108a9e6a7ead77a1aa48c2445837e918e8b4
+  data.tar.gz: 199e10aa6fd28ed8c4d29dbd17eb6420ff5350fa3689e23ba9f4468af75febf9a115af328e6652365a585c3df70bf2a81cf8b803270cf28ff4810a3346fdead0

data/bin/gamefic

@@ -4,4 +4,7 @@ require 'gamefic'
 require 'gamefic/shell'
 
 shell = Gamefic::Shell.new
+
+shell.register "play", Gamefic::Shell::Command::Play
+
 shell.execute

data/lib/gamefic/character.rb

@@ -7,7 +7,9 @@ module Gamefic
     attr_reader :last_order
     # @return [Entity,nil]
     attr_reader :last_object
-    attr_accessor :object_of_pronoun, :scene
+    attr_accessor :object_of_pronoun
+    
+    serialize :scene
     
     def initialize(plot, args = {})
       @queue = Array.new
@@ -87,7 +89,7 @@ module Gamefic
     #
     # @param message [String]
     def stream(message)
-      user.stream.send message
+      user.stream.send message if !user.nil?
     end
     
     def destroy
@@ -106,20 +108,54 @@ module Gamefic
     #     actor[:has_eaten] = false # Initial value
     #   end
     #   respond :eat do |actor|
+    #     actor.tell "You eat something."
     #     actor[:has_eaten] = true
     #   end
     #   respond :eat do |actor|
     #     # This version will be executed first because it was implemented last
-    #     actor.tell "You eat something."
-    #     actor[:has_eaten] # Will be false on the first run
-    #     actor.proceed # Execute the previous implementation
-    #     actor[:has_eaten] #=> true
+    #     if actor[:has_eaten]
+    #       actor.tell "You already ate."
+    #     else
+    #       actor.proceed # Execute the previous implementation
+    #     end
     #   end
     #
     def proceed
       return if delegate_stack.last.nil?
       delegate_stack.last.proceed
     end
+
+    def cue scene_name
+      @scene = scene_name
+      @next_scene = nil
+      plot.scenes[scene_name].start self
+    end
+    
+    def prepare scene_name
+      @next_scene = scene_name
+    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
+    end
+    
+    # Get the name of the character's current scene
+    #
+    # @return [Symbol] The name of the scene    
+    def scene
+      @scene
+    end
+
+    # Alias for Character#cue key
+    def scene= key
+      cue key.to_sym
+    end
+    
+    def next_scene
+      @next_scene
+    end
     
     private
     def delegate_stack

data/lib/gamefic/director/parser.rb

@@ -5,33 +5,33 @@ module Gamefic
   
     module Parser
       def self.from_tokens(actor, tokens)
-          options = []
-          command = tokens.shift
-          actions = actor.plot.actions_with_verb(command.to_sym)
-          actions.each { |action|
-            if action.queries.length == tokens.length
-              valid = true
-              index = 0
-              action.queries.each { |query|
-                if query.validate(actor, tokens[index]) == false
-                  valid = false
-                  break
-                end
-                index += 1
-              }
-              if valid
-                arguments = []
-                tokens.each { |token|
-                    arguments.push [token]
-                }
-                options.push Order.new(actor, action, arguments)
+        options = []
+        command = tokens.shift
+        actions = actor.plot.actions_with_verb(command.to_sym)
+        actions.each { |action|
+          if action.queries.length == tokens.length
+            valid = true
+            index = 0
+            action.queries.each { |query|
+              if query.validate(actor, tokens[index]) == false
+                valid = false
+                break
               end
+              index += 1
+            }
+            if valid
+              arguments = []
+              tokens.each { |token|
+                  arguments.push [token]
+              }
+              options.push Order.new(actor, action, arguments)
             end
-          }
-          if options.length == 0
-            tokens.unshift command
           end
-          options
+        }
+        if options.length == 0
+          tokens.unshift command
+        end
+        options.sort{ |a,b| b.action.specificity <=> a.action.specificity }
       end
       def self.from_string(actor, command)
         options = []
@@ -45,7 +45,7 @@ module Gamefic
             options.concat bind_contexts_in_result(actor, match.arguments, action)
           }
         }
-        options
+        options.sort{ |a,b| b.action.specificity <=> a.action.specificity }
       end
       class << self
         private

data/lib/gamefic/engine/tty.rb

@@ -2,6 +2,7 @@ require 'gamefic/engine'
 require 'rexml/document'
 require 'gamefic/ansi'
 require 'gamefic/html'
+require 'json'
 
 begin
   require 'io/console'
@@ -31,7 +32,12 @@ module Gamefic
       def ansi
         @stream.ansi
       end
-      def save filename, json
+      def save filename, snapshot
+        data = {
+          :metadata => @character.plot.metadata,
+          :entities => snapshot
+        }
+        json = JSON.generate data
         if json.nil?
           @character.tell "Nothing to save."
         end
@@ -53,11 +59,17 @@ module Gamefic
         end
         if filename != ''
           if File.exists?(filename)
-            return File.read(filename)
+            data = JSON.parse File.read(filename), symbolize_names: true
+            if (data[:metadata] != @character.plot.metadata)
+              @character.tell "The save file is not compatible with this version of the game."
+            else
+              return data[:entities]
+            end
           else
             @character.tell "File \"#{filename}\" not found."
           end
         end
+        nil
       end
     end
     class UserStream < Gamefic::UserStream

data/lib/gamefic/engine.rb

@@ -11,7 +11,7 @@ module Gamefic
     def run
       @plot.introduce @user.character
       print @user.state.output
-      while @user.character.scene.state != "Concluded"
+      while !@plot.concluded?(@user.character)
         turn
       end
       print @user.state.output
@@ -19,12 +19,13 @@ module Gamefic
     def turn
       @plot.ready
       print @user.state.output
-      # HACK Exception for test scenes
-      if @user.character.scene.key != :test
-        if @user.character.scene.state != "Concluded"
-          @user.stream.select @user.character.scene.data.prompt
-          @user.state.input
-        end
+      if !@user.character[:test_queue].nil? and @user.character[:test_queue].length > 0
+        test_command = @user.character[:test_queue].shift
+        @user.character.tell "[TESTING] #{@plot.scenes[@user.character.scene].prompt} #{test_command}"
+        @user.character.queue.push test_command 
+      else
+        @user.stream.select @plot.scenes[@user.character.scene].prompt
+        @user.state.input
       end
       @plot.update
       print @user.state.output

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 ||= "neutral"
+      @gender ||= (self.kind_of?(Character) ? "other" : "neutral")
     end
   end
 end

data/lib/gamefic/grammar/pronouns.rb

@@ -6,24 +6,68 @@ module Gamefic::Grammar
     def initialize object
       @object = object
     end
+    
+    # Get the subjective pronoun (I, you, we, etc.)
+    #
+    # @return [String]
     def subj
       Pronouns.get_pronoun_set(@object)[0]
     end
+    
+    # Get the objective pronoun (me, them, us, etc.)
+    #
+    # @return [String]
     def obj
       Pronouns.get_pronoun_set(@object)[1]
     end
+    
+    # Get the possessive pronoun (my, your, our, etc.)
+    #
+    # @return [String]
     def poss
       Pronouns.get_pronoun_set(@object)[2]
     end
+    
+    # Get the reflexive pronoun (myself, yourself, etc.)
+    #
+    # @return [String]
+    def reflex
+      Pronouns.get_pronoun_set(@object)[3]
+    end
+    
+    # Get the capitalized subjective pronoun
+    #
+    # @return [String]
     def Subj
       subj.cap_first
     end
+    
+    # Get the capitalized objective pronoun
+    #
+    # @return [String]
     def Obj
       obj.cap_first
     end
+    
+    # Get the capitalized possessive pronoun
+    #
+    # @return [String]
     def Poss
       obj.cap_first
     end
+    
+    # Get the capitalized reflexive pronoun
+    #
+    # @return [String]
+    def Reflex
+      reflex.cap_first
+    end
+    
+    # Get a an array of pronouns based on the person, gender, and plurality of
+    # the provided object.
+    #
+    # @param obj An object that responds to #person, #gender, and #plural
+    # @return [Array<String>]
     def self.get_pronoun_set(obj)
       set = Pronouns.sets["#{obj.person}"]
       if set.nil?
@@ -37,22 +81,23 @@ module Gamefic::Grammar
       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"]
+        @sets["1:singular"] = ["I", "me", "my", "myself"]
+        @sets["2"] = ["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
         # 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"]
+        @sets["3:singular:other"] = ["they", "them", "their", "themselves"]
+        @sets["3:singular:neutral"] = ["it", "it", "its", "itself"]
+        @sets["1:plural"] = ["we", "us", "our", "ourselves"]
+        @sets["3:plural"] = ["they", "them", "their", "themselves"]
       end
       @sets
     end

data/lib/gamefic/grammar/verbs.rb

@@ -21,5 +21,6 @@ module Gamefic::Grammar
     end
     conjugate :be,   :present, :am,   :are,  :is,  :are
     conjugate :have, :present, :have, :have, :has, :have
+    conjugate :can, :present, :can, :can, :can
   end
 end

data/lib/gamefic/grammar/word_adapter.rb

@@ -8,29 +8,42 @@ module Gamefic::Grammar
     include Plural
     # @return [Gamefic::Grammar::Pronouns]
     def pronoun
-      @pronoun ||= Grammar::Pronouns.new(self)
+      @pronoun ||= Gamefic::Grammar::Pronouns.new(self)
     end
     # @return [Gamefic::Grammar::Verbs]
     def verb
-      @verb ||= Grammar::Verbs.new(self)
+      @verb ||= Gamefic::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
+      contractions[words] || words
+    end
+    private
+    def contractions
+      if @contractions.nil?
+        @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",
+          "can not" => "can't"
+        }
+        capitalized = {}
+        @contractions.each_pair { |k,v |
+          if k[0] != k[0].capitalize
+            capitalized[k.cap_first] = v.cap_first
+          end
+        }
+        @contractions.merge! capitalized
+      end
+      @contractions
     end
   end
 end

data/lib/gamefic/html.rb

@@ -2,7 +2,11 @@
 
 module Gamefic
 
-  module Html
+  module Html
+    # Convert ampersands to &
+    #
+    # @param text [String]
+    # @return [String]
     def self.fix_ampersands(text)
       codes = []
       ENTITIES.keys.each { |e|
@@ -12,34 +16,44 @@ module Gamefic
       re = Regexp.new("&(?!(#{piped}))")
       text.gsub(re, '&\1')
     end
+    
+    # Encode a String with HTML entities
+    #
+    # @param text [String]
+    # @return [String]
     def self.encode(text)
       Gamefic::Html::ENTITIES.each { |k, v|
-        while text.include?(k)
-          text[v] = k
-        end
+        text = text.gsub(v, k)
       }
       text
     end
+    
+    # Decode a String's HTML entities
+    #
+    # @param text [String]
+    # @return [String]
     def self.decode(text)
       Gamefic::Html::ENTITIES.each { |k, v|
-        while text.include?(k)
-          text[k] = v
-        end
+        text = text.gsub(k, v)
       }
       text
     end
+    
+    # Parse a String into an XML document
+    #
+    # @param code [String]
+    # @return [REXML::Document]
     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
+        # Convert invalid < characters to &lt;
+        if e.source.buffer != last and 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
         raise e
       end

data/lib/gamefic/plot/article_mount.rb

@@ -1,5 +1,5 @@
 module Gamefic
-  module ArticleMount
+  module Plot::ArticleMount
     def a(entity)
       entity.indefinitely
     end