gamefic 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63846578f9f4d58fb35a150a601b8b5d16b197c8
-  data.tar.gz: 360676b4be22f3eb71661bf8ee9c63edd629207b
+  metadata.gz: ce1dd2ec32bb2872b9c18a40cfdf92ac745506a4
+  data.tar.gz: 264aa06dc79054f22d07fe4552b6341c05a4c82e
 SHA512:
-  metadata.gz: 6a1f09d1c998ddeca48c721c0d8336479b0f1762b98f6a57f1f440f08309b33f1993585ac386d9443a4b5d616012d85c285f5d4298bd64437e025d235d52cb1f
-  data.tar.gz: 3fd2d90bb464dc6c2ed83d9a72fba6d3177b7cdd65853b740fdc77a7414b8113a8b4a5e79466fc3e1e964f01d1427d0daf30f90abe93fca7b461459ff867b76b
+  metadata.gz: ad1365b02676307134c0a141dbe9003989093b2e78f590affd2c5bbaa237758ae1357e3c156551e36f65b22c44bd0f81a06b940e655075bf529dcea59b75fc6a
+  data.tar.gz: fc741d054f2d4e187d6e51fc96ef4a59354dfc6bea21c39adfcf7a45a5e48195fcae2017c3543bd56d9e4dfbd89bfb584e4a3e8349145bb869878cbd178eb12b

data/lib/gamefic.rb

@@ -1,16 +1,14 @@
+require 'gamefic/matchable'
 require 'gamefic/core_ext/array'
 require 'gamefic/core_ext/string'
 
 require 'gamefic/grammar'
-require 'gamefic/keywords'
-require 'gamefic/serialized'
 require 'gamefic/entity'
 require 'gamefic/character'
 require "gamefic/scene"
 require "gamefic/query"
 require "gamefic/action"
 require "gamefic/syntax"
-require "gamefic/director"
 require "gamefic/plot"
 require 'gamefic/subplot'
 require "gamefic/engine"

data/lib/gamefic/action.rb

@@ -1,95 +1,156 @@
 module Gamefic
-
   # Exception raised when the Action's proc arity is not compatible with the
   # number of queries
   class ActionArgumentError < ArgumentError
   end
-  
-  # Actions manage the execution of commands that Characters can perform.
-  # 
+
   class Action
-    attr_reader :order_key, :queries
-    attr_writer :meta
-    @@order_key_seed = 0
-    
-    def initialize(verb, *queries, &proc)
-      if !verb.kind_of?(Symbol)
-        verb = verb.to_s
-        verb = nil if verb == ''
-      end
-      @order_key = @@order_key_seed
-      @@order_key_seed += 1
-      @proc = proc
-      if (verb.kind_of?(Symbol) == false and !verb.nil?)
-        raise "Action verbs must be symbols #{verb}"
-      end
-      if !@proc.nil?
-        if (queries.length + 1 != @proc.arity) and (@proc.arity > 0)
-          raise ActionArgumentError.new("Number of queries is not compatible with proc arguments")
-        end
-      end
-      @verb = verb
-      @queries = queries
+    attr_reader :parameters
+
+    def initialize actor, parameters
+      @actor = actor
+      @parameters = parameters
+      @executed = false
     end
-    
-    # Get the specificity of the Action.
-    # Specificity indicates how narrowly the Action's queries filter matches.
-    # Actions with higher specificity are given higher priority when searching
-    # for the Action that matches a character command. For example, an Action
-    # with a Query that filters for a specific class of Entity has a higher
-    # specificity than an Action with a Query that accepts arbitrary text.
-    #
-    # @return [Fixnum]
-    def specificity
-      spec = 0
-      if verb.nil?
-        spec = -100
-      end
-      @queries.each { |q|
-        if q.kind_of?(Query::Base)
-          spec += q.specificity
-        else
-          spec += 1
-        end
-      }
-      return spec
+
+    # @todo Determine whether to call them parameters, arguments, or both.
+    def arguments
+      parameters
     end
-    
-    # Get the verb associated with this Action.
-    # The verb is represented by a Symbol in the imperative form, such as
-    # :take or :look_under.
-    #
-    # @return [Symbol] The Symbol representing the verb.
-    def verb
-      @verb
+
+    def execute
+      @executed = true
+      self.class.executor.call(@actor, *@parameters) unless self.class.executor.nil?
     end
-    
-    # Execute this Action. This method is typically called by the Plot when
-    # a Character performs a command.
-    def execute *args
-      @proc.call(*args)
+
+    def executed?
+      @executed
     end
-    
+
+    def verb
+      self.class.verb
+    end
+
     def signature
-      sig = ["#{@verb}"]
-      @queries.each { |q|
-        sig.push q.signature
-      }
-      "#{sig.join(', ').gsub(/Gamefic::(Query::)?/, '')}(#{specificity})"
+      self.class.signature
     end
-    
-    # Is this a meta Action?
-    # If an Action is flagged meta, it usually means that it provides
-    # information about the game or manages some aspect of the user interface.
-    # It shouldn't represent an Action that the player's character performs in
-    # the game world. Examples include Actions to display credits or
-    # instructions.
-    #
-    # @return [Boolean]
+
+    def rank
+      self.class.rank
+    end
+
     def meta?
-      @meta ||= false
+      self.class.meta?
     end
-    
-  end
 
+    def order_key
+      self.class.order_key
+    end
+
+    def self.subclass verb, *q, meta: false, order_key: 0, &block
+      act = Class.new(self) do
+        self.verb = verb
+        self.meta = meta
+        self.order_key = order_key
+        q.each { |q|
+          add_query q
+        }
+        on_execute &block
+      end
+      if !block.nil? and act.queries.length + 1 != block.arity and block.arity > 0
+        raise ActionArgumentError.new("Number of parameters is not compatible with proc arguments")
+      end
+      act
+    end
+
+    class << self
+      def verb
+        @verb
+      end
+
+      def meta?
+        @meta ||= false
+      end
+
+      def add_query q
+        @specificity = nil
+        queries.push q
+      end
+
+      def queries
+        @queries ||= []
+      end
+
+      def on_execute &block
+        @executor = block
+      end
+
+      def signature
+        # @todo This is clearly unfinished
+        "#{verb} #{queries.map{|m| m.signature}.join(',')}"
+      end
+
+      def executor
+        @executor
+      end
+
+      def order_key
+        @order_key ||= 0
+      end
+
+      def rank
+        if @rank.nil?
+          @rank = 0
+          queries.each { |q|
+            @rank += (q.rank + 1)
+          }
+          @rank -= 1000 if verb.nil?
+        end
+        @rank
+      end
+
+      def valid? actor, objects
+        return false if objects.length != queries.length
+        i = 0
+        queries.each { |p|
+          return false unless p.include?(actor, objects[i])
+          i += 1
+        }
+        true
+      end
+
+      def attempt actor, tokens
+        i = 0
+        result = []
+        matches = Gamefic::Query::Matches.new([], '', '')
+        queries.each { |p|
+          return nil if tokens[i].nil? and matches.remaining == ''
+          matches = p.resolve(actor, "#{matches.remaining} #{tokens[i]}".strip, continued: (i < queries.length - 1))
+          return nil if matches.objects.empty?
+          if p.ambiguous?
+            result.push matches.objects
+          else
+            return nil if matches.objects.length > 1
+            result.push matches.objects[0]
+          end
+          i += 1
+        }
+        self.new(actor, result)
+      end
+
+      protected
+
+      def verb= sym
+        @verb = sym
+      end
+
+      def meta= bool
+        @meta = bool
+      end
+
+      def order_key= num
+        @order_key = num
+      end
+    end
+  end
 end

data/lib/gamefic/character.rb

@@ -1,23 +1,29 @@
-require 'gamefic/director'
+#require 'gamefic/director'
 
-class NotConclusionError < Exception
-end
 
 module Gamefic
+  class NotConclusionError < Exception
+  end
+
   class Character < Entity
+    autoload :State, 'gamefic/character/state'
+
     attr_reader :queue, :user
-    # @return [Gamefic::Director::Order]
-    attr_reader :last_order
+    # @return [Gamefic::Action]
+    attr_reader :last_action
     # @return [Entity,nil]
     attr_reader :last_object
     attr_accessor :object_of_pronoun
     attr_reader :scene
     attr_reader :next_scene
     attr_accessor :playbook
+    
+    include Character::State
 
     def initialize(args = {})
-      @queue = Array.new
       super
+      @queue = Array.new
+      @messages = ''
       @buffer_stack = 0
       @buffer = ""
     end
@@ -34,7 +40,32 @@ module Gamefic
     def disconnect
       @user = nil
     end
-    
+
+    # 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)
+      if @buffer_stack > 0
+        @buffer += message
+      else
+        super
+      end
+    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)
+      if @buffer_stack > 0
+        @buffer += message
+      else
+        super
+      end
+    end
+
     # Perform a command.
     # The command can be specified as a String or a set of tokens. Either form
     # should yield the same result, but using tokens can yield better
@@ -49,7 +80,23 @@ module Gamefic
     #   character.perform :take, @key
     #
     def perform(*command)
-      Director.dispatch(self, *command)
+      #Director.dispatch(self, *command)
+      actions = playbook.dispatch(self, *command)
+      a = actions.first
+      okay = true
+      unless a.meta?
+        playbook.validators.each { |v|
+          result = v.call(self, a.verb, a.parameters)
+          okay = (result != false)
+          break if not okay
+        }
+      end
+      if okay
+        performance_stack.push actions
+        proceed
+        performance_stack.pop
+      end
+      a
     end
     
     # Quietly perform a command.
@@ -66,34 +113,6 @@ module Gamefic
       @buffer_stack -= 1
       @buffer
     end
-    
-    # Send a message to the Character.
-    # 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)
-      if user != nil and message.to_s != ''
-        if @buffer_stack > 0
-          @buffer += message
-        else
-          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
-        end
-      end
-    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)
-      user.send message.strip unless user.nil?
-    end
 
     # Proceed to the next Action in the current stack.
     # This method is typically used in Action blocks to cascade through
@@ -116,35 +135,87 @@ module Gamefic
     #     end
     #   end
     #
-    def proceed
-      Director::Delegate.proceed_for self
+    def proceed quietly: false
+      #Director::Delegate.proceed_for self
+      return if performance_stack.empty?
+      a = performance_stack.last.shift
+      unless a.nil?
+        if quietly
+          if @buffer_stack == 0
+            @buffer = ""
+          end
+          @buffer_stack += 1
+        end
+        a.execute
+        if quietly
+          @buffer_stack -= 1
+          @buffer
+        end
+      end
     end
 
-    def cue scene
+    # Immediately start a new scene for the character.
+    # Use #prepare if you want to declare a scene to be started at the
+    # beginning of the next turn.
+    #
+    def cue new_scene
       @next_scene = nil
-      @scene = scene
-      @scene.start self unless @scene.nil?
+      if new_scene.nil?
+        @scene = nil
+      else
+        @scene = new_scene.new(self)
+        @scene.start
+      end
     end
 
-    def prepare scene
-      @next_scene = scene
+    # Prepare a scene to be started for this character at the beginning of the
+    # next turn.
+    #
+    def prepare s
+      @next_scene = s
+    end
+
+    # Return true if the character is expected to be in the specified scene on
+    # the next turn.
+    #
+    # @return [Boolean]
+    def will_cue? scene
+      (@scene.class == scene and @next_scene.nil?) or @next_scene == scene
     end
 
+    # Cue a conclusion. This method works like #cue, except it will raise a
+    # NotConclusionError if the scene is not a Scene::Conclusion.
+    #
     def conclude scene
-      raise NotConclusionError if !scene.kind_of?(Scene::Conclusion)
+      raise NotConclusionError unless scene <= Scene::Conclusion
       cue scene
     end
 
+    # True if the character is in a conclusion.
+    #
+    # @return [Boolean]
     def concluded?
       !scene.nil? and scene.kind_of?(Scene::Conclusion)
     end
 
     def performed order
-      @last_order = order
+      order.freeze
+      @last_action = order
     end
 
-    def prompt
-      scene.nil? ? '>' : scene.prompt_for(self)
+    # Get the prompt that the user should see for the current scene.
+    #
+    # @return [String]
+    #def prompt
+    #  scene.nil? ? '>' : scene.prompt
+    #end
+
+    def accessible?
+      false
+    end
+
+    def inspect
+      to_s
     end
 
     private
@@ -153,12 +224,8 @@ module Gamefic
       @delegate_stack ||= []
     end
 
-    def last_order=(order)
-      return if order.nil?
-      @last_order = order
-      if !order.action.meta? and !order.arguments[0].nil? and !order.arguments[0][0].nil? and order.arguments[0][0].kind_of?(Entity)
-        @last_object = order.arguments[0][0]
-      end
+    def performance_stack
+      @performance_stack ||= []
     end
   end