gamefic 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce1dd2ec32bb2872b9c18a40cfdf92ac745506a4
-  data.tar.gz: 264aa06dc79054f22d07fe4552b6341c05a4c82e
+  metadata.gz: f3811a2f448c91712eaa8eec46000577c7d38f7a
+  data.tar.gz: 6cb83cb93b14fd5c94401367e51828bad90a8960
 SHA512:
-  metadata.gz: ad1365b02676307134c0a141dbe9003989093b2e78f590affd2c5bbaa237758ae1357e3c156551e36f65b22c44bd0f81a06b940e655075bf529dcea59b75fc6a
-  data.tar.gz: fc741d054f2d4e187d6e51fc96ef4a59354dfc6bea21c39adfcf7a45a5e48195fcae2017c3543bd56d9e4dfbd89bfb584e4a3e8349145bb869878cbd178eb12b
+  metadata.gz: 12f2199a4d803e7a179b49e1d50f6e83571f21d601e67828546de918c65b3da0ee97790e66ee5f73f34b1a901d515284e3c8bd030ff0dc5d816678b7c9a0ba48
+  data.tar.gz: 31118c91be341821662fe8624b85924b196c52f9b2bcd0c758f5af13fc9d1dceaa76f204d6f6f3d2e274ef049153b416dcd2648a207e4ad07ea02ea4b9b440c4

data/lib/gamefic.rb

@@ -3,8 +3,11 @@ require 'gamefic/core_ext/array'
 require 'gamefic/core_ext/string'
 
 require 'gamefic/grammar'
+require 'gamefic/describable'
+require 'gamefic/element'
 require 'gamefic/entity'
-require 'gamefic/character'
+require 'gamefic/active'
+require 'gamefic/actor'
 require "gamefic/scene"
 require "gamefic/query"
 require "gamefic/action"

data/lib/gamefic/action.rb

@@ -90,6 +90,10 @@ module Gamefic
         "#{verb} #{queries.map{|m| m.signature}.join(',')}"
       end
 
+      def hidden?
+        verb.to_s.start_with?('_')
+      end
+
       def executor
         @executor
       end

data/lib/gamefic/{character.rb → active.rb}

@@ -1,232 +1,280 @@
-#require 'gamefic/director'
-
-
-module Gamefic
-  class NotConclusionError < Exception
-  end
-
-  class Character < Entity
-    autoload :State, 'gamefic/character/state'
-
-    attr_reader :queue, :user
-    # @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 = {})
-      super
-      @queue = Array.new
-      @messages = ''
-      @buffer_stack = 0
-      @buffer = ""
-    end
-    
-    # Connect a User.
-    #
-    # @param user [User]
-    def connect(user)
-      @user = user
-    end
-    
-    # Disconnect the current User.
-    #
-    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
-    # performance since it bypasses the parser.
-    #
-    # The command will be executed immediately regardless of game state.
-    #
-    # @example Send a command as a string
-    #   character.perform "take the key"
-    #
-    # @example Send a command as a set of tokens
-    #   character.perform :take, @key
-    #
-    def perform(*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.
-    # This method executes the command exactly as #perform does, except it
-    # buffers the resulting output instead of sending it to the user.
-    #
-    # @return [String] The output that resulted from performing the command.
-    def quietly(*command)
-      if @buffer_stack == 0
-        @buffer = ""
-      end
-      @buffer_stack += 1
-      self.perform *command
-      @buffer_stack -= 1
-      @buffer
-    end
-
-    # Proceed to the next Action in the current stack.
-    # This method is typically used in Action blocks to cascade through
-    # multiple implementations of the same verb.
-    #
-    # @example Proceed through two implementations of a verb
-    #   introduction do |actor|
-    #     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
-    #     if actor[:has_eaten]
-    #       actor.tell "You already ate."
-    #     else
-    #       actor.proceed # Execute the previous implementation
-    #     end
-    #   end
-    #
-    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
-
-    # 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
-      if new_scene.nil?
-        @scene = nil
-      else
-        @scene = new_scene.new(self)
-        @scene.start
-      end
-    end
-
-    # 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 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
-      order.freeze
-      @last_action = order
-    end
-
-    # 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
-
-    def delegate_stack
-      @delegate_stack ||= []
-    end
-
-    def performance_stack
-      @performance_stack ||= []
-    end
-  end
-
-end
+module Gamefic
+  class NotConclusionError < Exception
+  end
+
+  # The Active module gives entities the ability to perform actions and
+  # participate in scenes.
+  #
+  module Active
+    # @return [Gamefic::Action]
+    attr_reader :last_action
+
+    # @return [Gamefic::User::Base]
+    attr_reader :user
+
+    # @return [Gamefic::Scene::Base]
+    attr_reader :scene
+
+    attr_reader :next_scene
+
+    # @return [Gamefic::Plot::Playbook]
+    #attr_accessor :playbook
+
+    # @return [Array<Gamefic::Plot::Playbook>]
+    def playbooks
+      @playbooks ||= []
+    end
+
+    def connect user
+      @user = user
+    end
+
+    # An array of actions waiting to be performed.
+    #
+    # @return [Array<String>]
+    def queue
+      @queue ||= []
+    end
+
+    # A hash of values representing the state of a performing entity.
+    #
+    # @return [Hash]
+    def state
+      @state = {}
+      @state.merge! scene.state unless scene.nil?
+      @state[:output] = messages
+      @state
+    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
+        append_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
+        append_buffer message
+      else
+        super
+      end
+    end
+
+    # Perform a command.
+    # The command can be specified as a String or a verb with a list of
+    # parameters. Either form should yield the same result, but the
+    # verb/parameter form can yield better performance since it bypasses the
+    # parser.
+    #
+    # The command will be executed immediately regardless of the entity's
+    # state.
+    #
+    # @example Send a command as a string
+    #   character.perform "take the key"
+    #
+    # @example Send a command as a verb with parameters
+    #   character.perform :take, @key
+    #
+    # @return [Gamefic::Action]
+    def perform(*command)
+      actions = []
+      playbooks.reverse.each { |p| actions.concat p.dispatch(self, *command) }
+      execute_stack actions
+    end
+    
+    # Quietly perform a command.
+    # This method executes the command exactly as #perform does, except it
+    # buffers the resulting output instead of sending it to the user.
+    #
+    # @return [String] The output that resulted from performing the command.
+    def quietly(*command)
+      if buffer_stack == 0
+        clear_buffer
+      end
+      set_buffer_stack buffer_stack + 1
+      self.perform *command
+      set_buffer_stack buffer_stack - 1
+      buffer
+    end
+
+    # Perform an action.
+    # This is functionally identical to the `perform` method, except the
+    # action must be declared as a verb with a list of parameters. Use
+    # `perform` if you need to parse a string as a command.
+    #
+    # The command will be executed immediately regardless of the entity's
+    # state.
+    #
+    # @example
+    #   character.execute :take, @key
+    #
+    # @return [Gamefic::Action]
+    def execute(verb, *params, quietly: false)
+      actions = []
+      playbooks.reverse.each { |p| actions.concat p.dispatch_from_params(self, verb, params) }
+      execute_stack actions, quietly: quietly
+    end
+
+    # Proceed to the next Action in the current stack.
+    # This method is typically used in Action blocks to cascade through
+    # multiple implementations of the same verb.
+    #
+    # @example Proceed through two implementations of a verb
+    #   introduction do |actor|
+    #     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
+    #     if actor[:has_eaten]
+    #       actor.tell "You already ate."
+    #     else
+    #       actor.proceed # Execute the previous implementation
+    #     end
+    #   end
+    #
+    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
+
+    # 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
+      if new_scene.nil?
+        @scene = nil
+      else
+        @scene = new_scene.new(self)
+        @scene.start
+      end
+    end
+
+    # 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 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
+      order.freeze
+      @last_action = order
+    end
+
+    def accessible?
+      false
+    end
+
+    def inspect
+      to_s
+    end
+
+    private
+
+    def execute_stack actions, quietly: false
+      return nil if actions.empty?
+      a = actions.first
+      okay = true
+      unless a.meta?
+        playbooks.reverse.each do |playbook|
+          okay = validate_playbook playbook, a
+          break unless okay
+        end
+      end
+      if okay
+        performance_stack.push actions
+        proceed quietly: quietly
+        performance_stack.pop
+      end
+      a
+    end
+
+    def validate_playbook playbook, action
+      okay = true
+      playbook.validators.each { |v|
+        result = v.call(self, action.verb, action.parameters)
+        okay = (result != false)
+        break unless okay
+      }
+      okay
+    end
+
+    def buffer_stack
+      @buffer_stack ||= 0
+    end
+
+    def set_buffer_stack num
+      @buffer_stack = num
+    end
+
+    def buffer
+      @buffer ||= ''
+    end
+
+    def append_buffer str
+      @buffer += str
+    end
+
+    def clear_buffer
+      @buffer = '' unless @buffer.empty?
+    end
+
+    def performance_stack
+      @performance_stack ||= []
+    end
+  end
+end