gamefic 2.4.0 → 3.0.0

data/lib/gamefic/serialize.rb

@@ -1,196 +0,0 @@
-require 'set'
-
-module Gamefic
-  module Serialize
-    def to_serial(index = [])
-      if index.include?(self)
-        {
-          'instance' => "#<ELE_#{index.index(self)}>",
-          'ivars' => {}
-        }
-      else
-        if self.class == Class && self.name
-          {
-            'class' => 'Class',
-            'name' => name
-          }
-        else
-          {
-            'class' => serialized_class(index),
-            'ivars' => serialize_instance_variables(index)
-          }
-        end
-      end
-    end
-
-    def serialized_class index
-      if index.include?(self.class)
-        "#<ELE_#{index.index(self.class)}>"
-      else
-        self.class.to_s
-      end
-    end
-
-    # @param string [String]
-    # @return [Object]
-    def self.string_to_constant string
-      space = Object
-      string.split('::').each do |part|
-        space = space.const_get(part)
-      end
-      space
-    end
-  end
-end
-
-class Object
-  class << self
-    def exclude_from_serial ary
-      @excluded_from_serial = ary
-    end
-
-    def excluded_from_serial
-      @excluded_from_serial ||= []
-    end
-  end
-
-  def to_serial(_index)
-    return self if [true, false, nil].include?(self)
-    # @todo This warning is a little too spammy. Set up a logger so it can be
-    # limited to an info or debug level.
-    # STDERR.puts "Unable to convert #{self} to element"
-    "#<UNKNOWN>"
-  end
-
-  def from_serial(index = [])
-    if self.is_a?(Hash)
-      if self['instance']
-        elematch = self['instance'].match(/^#<ELE_([\d]+)>$/)
-        object = index[elematch[1].to_i]
-        raise "Unable to load indexed element ##{elematch[1]} #{self}" if object.nil?
-      elsif self['class']
-        if self['class'] == 'Hash'
-          object = {}
-          self['data'].each do |arr|
-            object[arr[0].from_serial(index)] = arr[1].from_serial(index)
-          end
-          return object
-        elsif self['class'] == 'Class'
-          return Gamefic::Serialize.string_to_constant(self['name'])
-        elsif self['class'] == 'Set'
-          return Set.new(self['data'].map { |el| el.from_serial(index) })
-        else
-          elematch = self['class'].match(/^#<ELE_([\d]+)>$/)
-          if elematch
-            klass = index[elematch[1].to_i]
-          else
-            klass = Gamefic::Serialize.string_to_constant(self['class'])
-          end
-          raise "Unable to find class #{self['class']} #{self}" if klass.nil?
-          object = klass.allocate
-        end
-      end
-      self['ivars'].each_pair do |k, v|
-        object.instance_variable_set(k, v.from_serial(index))
-      end
-      object
-    elsif self.is_a?(Numeric)
-      self
-    elsif self.is_a?(String)
-      match = self.match(/#<ELE_([0-9]+)>/)
-      return index.index(match[1].to_i) if match
-      match = self.match(/#<SYM:([a-z0-9_\?\!]+)>/i)
-      return match[1].to_sym if match
-      self
-    else
-      # true, false, or nil
-      self
-    end
-  end
-
-  def serialize_instance_variables(index)
-    result = {}
-    instance_variables.each do |k|
-      next if self.class.excluded_from_serial.include?(k)
-      val = instance_variable_get(k)
-      if index.include?(val)
-        result[k.to_s] = {
-          'instance' => "#<ELE_#{index.index(val)}>",
-          'ivars' => {}
-        }
-      else
-        result[k.to_s] = val.to_serial(index)
-      end
-    end
-    result
-  end
-end
-
-class Class
-  def to_serial(index = [])
-    if name.nil?
-      super
-    else
-      {
-        'class' => 'Class',
-        'name' => name
-      }
-    end
-  end
-end
-
-class Symbol
-  def to_serial(_index = [])
-    "#<SYM:#{self}>"
-  end
-end
-
-class String
-  def to_serial(_index = [])
-    self
-  end
-end
-
-class Numeric
-  def to_serial(_index = [])
-    self
-  end
-end
-
-class Array
-  def to_serial(index = [])
-    map do |e|
-      s = e.to_serial(index)
-      return "#<UNKNOWN>" if s == "#<UNKNOWN>"
-      s
-    end
-  end
-
-  def from_serial(index = [])
-    result = map { |e| e.from_serial(index) }
-    result = "#<UNKNOWN>" if result.any? { |e| e == "#<UNKNOWN>" }
-    result
-  end
-end
-
-class Hash
-  def to_serial(index = [])
-    result = {'class' => 'Hash', 'data' => []}
-    each_pair do |key, value|
-      k2 = key.to_serial(index)
-      v2 = value.to_serial(index)
-      return "#<UNKNOWN>" if k2 == "#<UNKNOWN>" || v2 == "#<UNKNOWN>"
-      result['data'].push [k2, v2]
-    end
-    result
-  end
-end
-
-class Set
-  def to_serial(index = [])
-    {
-      'class' => 'Set',
-      'data' => to_a.map { |el| el.to_serial(index) }
-    }
-  end
-end

data/lib/gamefic/world/callbacks.rb

@@ -1,135 +0,0 @@
-module Gamefic
-  module World
-    module Callbacks
-      # Add a block to be executed on preparation of every turn.
-      #
-      # @example Increment a turn counter
-      #   turn = 0
-      #   on_ready do
-      #     turn += 1
-      #   end
-      #
-      def on_ready &block
-        ready_procs.push block
-      end
-
-      # Add a block to be executed after the Plot is finished updating a turn.
-      #
-      def on_update &block
-        update_procs.push block
-      end
-
-      # Add a block to be executed for each player at the beginning of a turn.
-      #
-      # @example Tell the player how many turns they've played.
-      #   on_player_ready do |player|
-      #     player[:turns] ||= 0
-      #     if player[:turns] > 0
-      #       player.tell "Turn #{player[:turns]}"
-      #     end
-      #     player[:turns] += 1
-      #   end
-      #
-      # @yieldparam [Gamefic::Actor]
-      def on_player_ready &block
-        player_ready_procs.push block
-      end
-
-      # Add a block to be executed for each player before an update.
-      #
-      # @yieldparam[Gamefic::Actor]
-      def before_player_update &block
-        before_player_update_procs.push block
-      end
-
-      # Add a block to be executed for each player at the end of a turn.
-      #
-      # @yieldparam [Gamefic::Actor]
-      def on_player_update &block
-        player_update_procs.push block
-      end
-
-      # Add a block to be executed at the conclusion of the plot.
-      #
-      # @yieldparam [Gamefic::Actor]
-      def on_player_conclude &block
-        player_conclude_procs.push block
-      end
-
-      def player_conclude_procs
-        @player_conclude_procs ||= []
-      end
-
-      def ready_procs
-        @ready_procs ||= []
-      end
-
-      def update_procs
-        @update_procs ||= []
-      end
-
-      def player_ready_procs
-        @player_ready_procs ||= []
-      end
-
-      def before_player_update_procs
-        @before_player_update_procs ||= []
-      end
-
-      def player_update_procs
-        @player_update_procs ||= []
-      end
-
-      private
-
-      # Execute the on_ready blocks. This method is typically called by the
-      # Plot while beginning a turn.
-      #
-      def call_ready
-        ready_procs.each { |p| p.call }
-      end
-
-      # Execute the on_update blocks. This method is typically called by the
-      # Plot while ending a turn.
-      #
-      def call_update
-        update_procs.each { |p| p.call }
-      end
-
-      # Execute the before_player_update blocks for each player. This method is
-      # typically called by the Plot while updating a turn, immediately before
-      # processing player input.
-      #
-      def call_before_player_update
-        players.each { |player|
-          player.flush
-          before_player_update_procs.each { |block| block.call player }
-        }
-      end
-
-      # Execute the on_player_ready blocks for each player. This method is
-      # typically called by the Plot while beginning a turn, immediately after
-      # the on_ready blocks.
-      #
-      def call_player_ready
-        players.each { |player|
-          unless player.next_scene.nil? || !player.scene.finished?
-            player.cue player.next_scene, **player.next_options
-          end
-          player.cue default_scene if player.scene.nil?
-          player_ready_procs.each { |block| block.call player }
-        }
-      end
-
-      # Execute the on_player_update blocks for each player. This method is
-      # typically called by the Plot while ending a turn, immediately before the
-      # on_ready blocks.
-      #
-      def call_player_update
-        players.each { |player|
-          player_update_procs.each { |block| block.call player }
-        }
-      end
-    end
-  end
-end

data/lib/gamefic/world/commands.rb

@@ -1,181 +0,0 @@
-# frozen_string_literal: true
-
-require 'gamefic/action'
-
-module Gamefic
-  module World
-    module Commands
-      include Gamefic::World::Entities
-
-      # @return [Gamefic::World::Playbook]
-      def playbook
-        @playbook ||= Gamefic::World::Playbook.new
-      end
-
-      # Create an Action that responds to a command.
-      # An Action uses the command argument to identify the imperative verb that
-      # triggers the action.
-      # It can also accept queries to tokenize the remainder of the input and
-      # filter for particular entities or properties.
-      # The block argument contains the code to be executed when the input
-      # matches all of the Action's criteria (i.e., verb and queries).
-      #
-      # @example A simple Action.
-      #   respond :salute do |actor|
-      #     actor.tell "Hello, sir!"
-      #   end
-      #   # The command "salute" will respond "Hello, sir!"
-      #
-      # @example An Action that accepts a Character
-      #   respond :salute, Use.visible(Character) do |actor, character|
-      #     actor.tell "#{The character} returns your salute."
-      #   end
-      #
-      # @param command [Symbol] An imperative verb for the command
-      # @param queries [Array<Query::Base>] Filters for the command's tokens
-      # @yieldparam [Gamefic::Actor]
-      # @return [Class] The resulting Action subclass
-      def respond(command, *queries, &proc)
-        playbook.respond(command, *map_response_args(queries), &proc)
-      end
-      alias action respond
-
-      # Parse a verb and a list of arguments into an action.
-      # This method serves as a shortcut to creating an action with one or more
-      # arguments that identify specific entities.
-      #
-      # @example
-      #   @thing = make Entity, name: 'a thing'
-      #   parse "use", "the thing" do |actor, thing|
-      #     actor.tell "You use it."
-      #   end
-      #
-      # @raise [ArgumentError] if tokens are unrecognized or ambiguous
-      #
-      # @param verb [String, Symbol] The command's verb
-      # @param tokens [Array<String>] The arguments passed to the action
-      # @return [Class] The resulting Action subclass
-      def parse verb, *tokens, &proc
-        query = Query::External.new(entities)
-        params = []
-        tokens.each do |arg|
-          matches = query.resolve(nil, arg)
-          raise ArgumentError, "Unable to resolve token '#{arg}'" if matches.objects.empty?
-          raise ArgumentError, "Ambiguous results for '#{arg}'" if matches.objects.length > 1
-          params.push Query::Family.new(matches.objects[0])
-        end
-        respond(verb.to_sym, *params, &proc)
-      end
-
-      # Tokenize and parse a command to create a new Action subclass.
-      #
-      # @param command [String] The command
-      # @yieldparam [Gamefic::Actor]
-      # @return [Class] the resulting Action subclass
-      def override(command, &proc)
-        cmd = Syntax.tokenize(command, playbook.syntaxes).first
-        raise "Unable to tokenize command '#{command}'" if cmd.nil?
-        parse cmd.verb, *cmd.arguments, &proc
-      end
-
-      # Create a Meta Action that responds to a command.
-      # Meta Actions are very similar to standard Actions, except the Plot
-      # understands them to be commands that operate above and/or outside of the
-      # actual game world. Examples of Meta Actions are commands that report the
-      # player's current score, save and restore saved games, or list the game's
-      # credits.
-      #
-      # @example A simple Meta Action
-      #   meta :credits do |actor|
-      #     actor.tell "This game was written by John Smith."
-      #   end
-      #
-      # @param command [Symbol] An imperative verb for the command
-      # @param queries [Array<Query::Base>] Filters for the command's tokens
-      # @yieldparam [Gamefic::Actor]
-      def meta(command, *queries, &block)
-        playbook.meta command, *queries, &block
-      end
-
-      # Add a proc to be evaluated before a character executes an action.
-      # When a verb is specified, the proc will only be evaluated if the
-      # action's verb matches it.
-      #
-      # @param verb [Symbol, nil]
-      # @yieldparam [Gamefic::Action]
-      def before_action verb = nil, &block
-        playbook.before_action verb, &block
-      end
-      alias validate before_action
-
-      # Add a proc to be evaluated after a character executes an action.
-      # When a verb is specified, the proc will only be evaluated if the
-      # action's verb matches it.
-      #
-      # @param [Symbol, nil]
-      # @yieldparam [Gamefic::Action]
-      def after_action verb = nil, &block
-        playbook.after_action verb, &block
-      end
-
-      # Create an alternate Syntax for an Action.
-      # The command and its translation can be parameterized.
-      #
-      # @example Create a synonym for the Inventory Action.
-      #   interpret "catalogue", "inventory"
-      #   # The command "catalogue" will be translated to "inventory"
-      #
-      # @example Create a parameterized synonym for the Look Action.
-      #   interpret "scrutinize :entity", "look :entity"
-      #   # The command "scrutinize chair" will be translated to "look chair"
-      #
-      # @param command [String] The format of the original command
-      # @param translation [String] The format of the translated command
-      # @return [Syntax] the Syntax object
-      def interpret command, translation
-        playbook.interpret command, translation
-      end
-      alias xlate interpret
-
-      # Get an Array of available verbs.
-      #
-      # @return [Array<String>]
-      def verbs
-        playbook.verbs.map(&:to_s).reject { |v| v.start_with?('_') }
-      end
-
-      # Get an Array of all Actions defined in the Plot.
-      #
-      # @return [Array<Action>]
-      def actions
-        playbook.actions
-      end
-
-      def get_default_query
-        @default_query_class ||= Gamefic::Query::Family
-      end
-
-      def set_default_query cls
-        @default_query_class = cls
-      end
-
-      private
-
-      # @param queries [Array]
-      # @return [Array<Query::Base>]
-      def map_response_args queries
-        queries.map do |q|
-          if q.is_a?(Regexp)
-            Gamefic::Query::Text.new(q)
-          elsif q.is_a?(Gamefic::Query::Base)
-            q
-          elsif q.is_a?(Gamefic::Element) || (q.is_a?(Class) && q <= Gamefic::Element)
-            get_default_query.new(q)
-          else
-            raise ArgumentError, "Invalid argument for response: #{q.inspect}"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/gamefic/world/entities.rb

@@ -1,98 +0,0 @@
-module Gamefic
-  module World
-    module Entities
-      # Make a new Entity with the provided properties.
-      #
-      # @example Create an Entity
-      #   chair = make Entity, name: 'red chair'
-      #   chair.name #=> 'red chair'
-      #
-      # @raise [ArgumentError] if class is not an Entity
-      #
-      # @param cls [Class] The Class of the Entity to be created.
-      # @param args [Hash] The entity's properties.
-      # @!macro [attach] make_entity
-      #   @return [$1]
-      def make cls, args = {}, &block
-        raise ArgumentError, "Invalid Entity class" unless cls.is_a?(Class) && cls <= Entity
-        ent = cls.new args, &block
-        entities.push ent
-        ent
-      end
-
-      # Cast an active entity.
-      # This method is similar to make, but it also provides the plot's
-      # playbook to the entity so it can perform actions. The entity should
-      # either be a kind of Gamefic::Actor or include the Gamefic::Active
-      # module.
-      #
-      # @return [Gamefic::Actor, Gamefic::Active]
-      def cast cls, args = {}, &block
-        ent = make cls, args, &block
-        ent.playbooks.push playbook
-        ent
-      end
-
-      # Safely remove an entity from a plot.
-      #
-      # If the entity is dynamic (e.g., created after a plot is already
-      # running), it is safe to delete it completely. Otherwise the entity
-      # will still be referenced in the entities array, but its parent will be
-      # set to nil.
-      #
-      # @param [Gamefic::Entity] The entity to remove
-      def destroy entity
-        entity.parent = nil
-        # index = entities.index(entity)
-        # return if index.nil? || index < static_entity_length - 1
-        # entities.delete_at index
-        # players.delete entity
-        # entity.destroy
-
-        # @todo It might make sense to destroy the entity completely now. It
-        #   will still have a reference in the index, but that shouldn't impact
-        #   the current state of the plot.
-        return if static.include?(entity)
-        entities.delete entity
-        players.delete entity
-      end
-
-      # Pick an entity based on its description.
-      # The description provided must match exactly one entity; otherwise
-      # an error is raised.
-      #
-      # @example Select the Entity that matches the description
-      #   red_chair = make Entity, :name => 'red chair'
-      #   blue_chair = make Entity, :name => 'blue chair'
-      #   pick "red chair" #=> red_chair
-      #   pick "blue chair" #=> blue_chair
-      #   pick "chair" #=> IndexError: description is ambiguous
-      #
-      # @param  description [String] The description of the entity
-      # @return [Gamefic::Entity] The entity that matches the description
-      def pick(description)
-        result = Query::Matches.execute(entities, description)
-        if result.objects.length == 0
-          raise IndexError.new("Unable to find entity from '#{description}'")
-        elsif result.objects.length > 1
-          raise IndexError.new("Ambiguous entities found from '#{description}'")
-        end
-        result.objects[0]
-      end
-
-      # Get an array of entities associated with this plot.
-      #
-      # @return [Array<Gamefic::Entity>]
-      def entities
-        @entities ||= []
-      end
-
-      # Get an array of players associated with this plot.
-      #
-      # @return [Array<Gamefic::Actor>]
-      def players
-        @players ||= []
-      end
-    end
-  end
-end