gamefic 3.6.0 → 4.0.0

data/lib/gamefic/scene/default.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Scene
-    # The base class for scenes. Authors can instantiate this class directly
-    # and customize it with on_start and on_finish blocks.
-    #
-    class Default
-      # @return [Symbol]
-      attr_reader :name
-
-      # @param name [Symbol]
-      # @param narrative [Narrative]
-      # @param on_start [Proc, nil]
-      # @param on_finish [Proc, nil]
-      # @yieldparam [self]
-      def initialize name, narrative, on_start: nil, on_finish: nil
-        @name = name
-        @narrative = narrative
-        @start_blocks = []
-        @finish_blocks = []
-        @start_blocks.push on_start if on_start
-        @finish_blocks.push on_finish if on_finish
-        yield(self) if block_given?
-      end
-
-      # @return [String]
-      def type
-        @type ||= self.class.to_s.sub(/^Gamefic::Scene::/, '')
-      end
-
-      def new_props(**context)
-        self.class.props_class.new(self, **context)
-      end
-
-      def on_start &block
-        @start_blocks.push block
-      end
-
-      def on_finish &block
-        @finish_blocks.push block
-      end
-
-      # @param actor [Gamefic::Actor]
-      # @param props [Props::Default]
-      # @return [void]
-      def start actor, props
-        props.output[:scene] = to_hash
-        props.output[:prompt] = props.prompt
-      end
-
-      # @param actor [Gamefic::Actor]
-      # @param props [Props::Default]
-      # @return [void]
-      def finish actor, props
-        props.input = actor.queue.shift&.strip
-      end
-
-      def run_start_blocks actor, props
-        @start_blocks.each { |blk| Stage.run(@narrative, actor, props, &blk) }
-      end
-
-      def run_finish_blocks actor, props
-        @finish_blocks.each { |blk| Stage.run(@narrative, actor, props, &blk) }
-      end
-
-      def self.props_class
-        @props_class ||= Props::Default
-      end
-
-      def conclusion?
-        is_a?(Conclusion)
-      end
-
-      def to_hash
-        { name: name, type: type }
-      end
-
-      class << self
-        protected
-
-        def use_props_class klass
-          @props_class = klass
-        end
-      end
-    end
-  end
-end

data/lib/gamefic/scope/base.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Scope
-    # The base class for a Scoped query's scope.
-    #
-    class Base
-      attr_reader :context
-
-      # @param [Gamefic::Entity]
-      def initialize context
-        @context = context
-      end
-
-      # @param [Array<Gamefic::Entity>]
-      def matches
-        []
-      end
-
-      # @param [Gamefic::Entity]
-      def self.matches context
-        new(context).matches
-      end
-
-      def self.precision
-        0
-      end
-
-      private
-
-      # Return an array of the entity's accessible descendants.
-      #
-      # @param [Entity]
-      # @return [Array<Entity>]
-      def subquery_accessible entity
-        return [] unless entity&.accessible?
-
-        entity.children.flat_map do |c|
-          [c] + subquery_accessible(c)
-        end
-      end
-    end
-  end
-end

data/lib/gamefic/scope/children.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Scope
-    # The Children scope returns an entity's children and all accessible
-    # descendants.
-    #
-    class Children < Base
-      def matches
-        context.children.flat_map do |c|
-          [c] + subquery_accessible(c)
-        end
-      end
-    end
-  end
-end

data/lib/gamefic/scope/descendants.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Scope
-    # The Descendants scope returns an entity's children and accessible
-    # descendants.
-    #
-    class Descendants < Base
-      def matches
-        context.children.flat_map do |child|
-          [child] + subquery_accessible(child)
-        end
-      end
-    end
-  end
-end

data/lib/gamefic/scope/family.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Scope
-    # The Family scope returns an entity's ascendants, descendants, siblings,
-    # and siblings' descendants.
-    #
-    class Family < Base
-      def matches
-        match_ascendants + match_descendants + match_siblings
-      end
-
-      private
-
-      def match_ascendants
-        [].tap do |result|
-          here = context.parent
-          while here
-            result.push here
-            here = here.parent
-          end
-        end
-      end
-
-      def match_descendants
-        context.children.flat_map do |child|
-          [child] + subquery_accessible(child)
-        end
-      end
-
-      def match_siblings
-        return [] unless context.parent
-
-        context.parent
-               .children
-               .that_are_not(context)
-               .flat_map do |child|
-                 [child] + subquery_accessible(child)
-               end
-      end
-    end
-  end
-end

data/lib/gamefic/scope/myself.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Scope
-    # The Myself scope returns the entity itself.
-    #
-    class Myself < Base
-      def matches
-        [context]
-      end
-    end
-  end
-end

data/lib/gamefic/scope/parent.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Scope
-    # A query scope that can only match the entity's parent.
-    #
-    class Parent < Base
-      def matches
-        [context.parent].compact
-      end
-    end
-  end
-end

data/lib/gamefic/scope/siblings.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Scope
-    # A query scope that matches the entity's siblings, i.e., the other
-    # entities that share its parent.
-    #
-    class Siblings < Base
-      def matches
-        context.parent.children - [context]
-      end
-    end
-  end
-end

data/lib/gamefic/scope.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require 'gamefic/scope/base'
-require 'gamefic/scope/children'
-require 'gamefic/scope/descendants'
-require 'gamefic/scope/family'
-require 'gamefic/scope/parent'
-require 'gamefic/scope/siblings'
-require 'gamefic/scope/myself'

data/lib/gamefic/scriptable/actions.rb

@@ -1,137 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Scriptable
-    # Scriptable methods related to creating actions.
-    #
-    module Actions
-      include Queries
-
-      # Create a response to a command.
-      # A Response uses the `verb` 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 is the proc to execute when the input
-      # matches all of the Response's criteria (i.e., verb and queries).
-      #
-      # @example A simple Response.
-      #   respond :wave do |actor|
-      #     actor.tell "Hello!"
-      #   end
-      #   # The command "wave" will respond "Hello!"
-      #
-      # @example A Response that accepts a Character
-      #   respond :salute, available(Character) do |actor, character|
-      #     actor.tell "#{The character} returns your salute."
-      #   end
-      #
-      # @param verb [Symbol] An imperative verb for the command
-      # @param args [Array<Object>] Filters for the command's tokens
-      # @yieldparam [Gamefic::Actor]
-      # @return [Symbol]
-      def respond(verb, *args, &proc)
-        rulebook.calls.add_response Response.new(verb, self, *args, &proc)
-        verb
-      end
-
-      # Create a meta response for a command.
-      # Meta responses are very similar to standard responses, except they're
-      # flagged as meta (`Response#meta?`) to indicate that they provide a
-      # feature that is not considered an in-game action, such as displaying
-      # help documentation or a scoreboard.
-      #
-      # @example A simple meta Response
-      #   meta :credits do |actor|
-      #     actor.tell "This game was written by John Smith."
-      #   end
-      #
-      # @param verb [Symbol] An imperative verb for the command
-      # @param args [Array<Object>] Filters for the command's tokens
-      # @yieldparam [Gamefic::Actor]
-      # @return [Symbol]
-      def meta(verb, *args, &proc)
-        rulebook.calls.add_response Response.new(verb, self, *args, meta: true, &proc)
-        verb
-      end
-
-      # Add a proc to be evaluated before a character executes an action.
-      # When verbs are specified, the proc will only be evaluated if the
-      # action's verb matches them.
-      #
-      # @param verbs [Array<Symbol>]
-      # @yieldparam [Gamefic::Action]
-      # @return [Action::Hook]
-      def before_action *verbs, &block
-        rulebook.hooks.before_action self, *verbs, &block
-      end
-
-      # Add a proc to be evaluated after a character executes an action.
-      # When a verbs are specified, the proc will only be evaluated if the
-      # action's verb matches them.
-      #
-      # @param verbs [Array<Symbol>]
-      # @yieldparam [Gamefic::Action]
-      # @return [Action::Hook]
-      def after_action *verbs, &block
-        rulebook.hooks.after_action self, *verbs, &block
-      end
-
-      # Create an alternate Syntax for a response.
-      # The command and its translation can be parameterized.
-      #
-      # @example Create a synonym for an `inventory` response.
-      #   interpret "catalogue", "inventory"
-      #   # The command "catalogue" will be translated to "inventory"
-      #
-      # @example Create a parameterized synonym for a `look` response.
-      #   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
-        rulebook.calls.add_syntax Syntax.new(command, translation)
-      end
-
-      # Verbs are the symbols that have responses defined in the rulebook.
-      #
-      # @example
-      #   class MyPlot < Gamefic::Plot
-      #     script do
-      #       respond :think { |actor| actor.tell 'You think.' }
-      #
-      #       verbs #=> [:think]
-      #     end
-      #   end
-      #
-      # @return [Array<Symbol>]
-      def verbs
-        rulebook.verbs
-      end
-
-      # Synonyms are a combination of the rulebook's concrete verbs plus the
-      # alternative variants defined in syntaxes.
-      #
-      # @example
-      #   class MyPlot < Gamefic::Plot
-      #       respond :think { |actor| actor.tell 'You think.' }
-      #       interpret 'ponder', 'think'
-      #
-      #       verbs #=> [:think]
-      #       synonyms #=> [:think, :ponder]
-      #     end
-      #   end
-      #
-      # @return [Array<Symbol>]
-      def synonyms
-        rulebook.synonyms
-      end
-
-      # @return [Array<Syntax>]
-      def syntaxes
-        rulebook.syntaxes
-      end
-    end
-  end
-end

data/lib/gamefic/scriptable/events.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Scriptable
-    # Scriptable methods related to creating event callbacks.
-    #
-    module Events
-      # 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
-        rulebook.events.on_ready(Callback.new(self, 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] ||= 1
-      #     player.tell "Turn #{player[:turns]}"
-      #     player[:turns] += 1
-      #   end
-      #
-      # @yieldparam [Gamefic::Actor]
-      def on_player_ready &block
-        wrapper = proc do
-          players.each { |player| Stage.run(self, player, &block) }
-        end
-        on_ready &wrapper
-      end
-
-      # Add a block to be executed after the Plot is finished updating a turn.
-      #
-      def on_update &block
-        rulebook.events.on_update(Callback.new(self, 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
-        wrapper = proc do
-          players.each { |player| Stage.run(self, player, &block) }
-        end
-        on_update &wrapper
-      end
-
-      def on_conclude &block
-        rulebook.events.on_conclude(Callback.new(self, block))
-      end
-
-      # @yieldparam [Actor]
-      # @return [Proc]
-      def on_player_conclude &block
-        rulebook.events.on_player_conclude(Callback.new(self, block))
-      end
-
-      # @yieldparam [Actor]
-      # @yieldparam [Hash]
-      # @return [Proc]
-      def on_player_output &block
-        rulebook.events.on_player_output Callback.new(self, block)
-      end
-    end
-  end
-end

data/lib/gamefic/scriptable/plot_proxies.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  module Scriptable
-    module PlotProxies
-      def lazy_plot key
-        Logging.logger.warn "#{caller.first ? "#{caller.first}: " : ''}`lazy_plot` is deprecated. Use `plot_pick`, `plot_pick!, or pass the entity from the plot in a `config` option instead."
-        Proxy.new(:attr, [:plot, key])
-      end
-      alias _plot lazy_plot
-
-      def attr_plot attr
-        define_method(attr) { plot.send(attr) }
-      end
-
-      def plot_pick *args
-        Proxy::PlotPick.new(*args)
-      end
-      alias lazy_plot_pick plot_pick
-      alias _plot_pick plot_pick
-
-      def plot_pick! *args
-        Proxy::PlotPick.new(*args)
-      end
-      alias lazy_plot_pick! plot_pick!
-      alias _plot_pick! plot_pick!
-    end
-  end
-end

data/lib/gamefic/snapshot.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require 'corelib/marshal' if RUBY_ENGINE == 'opal' # Required in browser
-require 'base64'
-
-module Gamefic
-  # Save and restore plots.
-  #
-  module Snapshot
-    # Save a base64-encoded snapshot of a plot.
-    #
-    # @param plot [Plot]
-    # @return [String]
-    def self.save plot
-      cache = plot.detach
-      binary = Marshal.dump(plot)
-      plot.attach cache
-      Base64.encode64(binary)
-    end
-
-    # Restore a plot from a base64-encoded string.
-    #
-    # @param snapshot [String]
-    # @return [Plot]
-    def self.restore snapshot
-      binary = Base64.decode64(snapshot)
-      Marshal.load(binary).tap do |plot|
-        plot.hydrate
-        # @todo Opal marshal dumps are not idempotent
-        next if RUBY_ENGINE == 'opal' || match?(plot, snapshot)
-
-        Logging.logger.warn "Scripts modified #{plot.class} data. Snapshot may not have restored properly"
-      end
-    end
-
-    # True if the plot's state matches the snapshot.
-    #
-    # @param plot [Plot]
-    # @param snapshot [String]
-    def self.match?(plot, snapshot)
-      save(plot) == snapshot
-    end
-  end
-end

data/lib/gamefic/stage.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  # A safe execution environment for narrative code.
-  #
-  module Stage
-    module_function
-
-    # @param narrative [Narrative]
-    def run(narrative, *args, &code)
-      container = narrative.clone
-      narrative.instance_exec(*args, &code).tap { validate_changes narrative, container, code }
-    end
-
-    OVERWRITEABLE_CLASSES = [String, Numeric, Symbol].freeze
-
-    SWAPPABLE_VALUES = [true, false].freeze
-
-    class << self
-      private
-
-      def validate_changes narrative, container, code
-        container.instance_variables.each do |var|
-          next unless narrative.instance_variables.include?(var)
-
-          cval = container.instance_variable_get(var)
-
-          nval = narrative.instance_variable_get(var)
-          next if cval == nval
-
-          validate_overwriteable(cval, nval, "Unsafe reassignment of #{var} in #{code}")
-        end
-      end
-
-      def validate_overwriteable cval, nval, error
-        raise error unless overwriteable?(cval, nval)
-      end
-
-      def overwriteable? cval, nval
-        return true if cval.nil? || swappable?(cval, nval)
-
-        allowed = OVERWRITEABLE_CLASSES.find { |klass| cval.is_a?(klass) }
-        allowed && cval.is_a?(allowed)
-      end
-
-      def swappable? *values
-        values.all? { |val| SWAPPABLE_VALUES.include?(val) }
-      end
-    end
-  end
-end

data/lib/gamefic/syntax/template.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-module Gamefic
-  class Syntax
-    # Template data for syntaxes.
-    #
-    class Template
-      PARAM_REGEXP = /^:[a-z0-9_]+$/i.freeze
-
-      # @return [String]
-      attr_reader :text
-
-      # @return [Array<String>]
-      attr_reader :params
-
-      def initialize text
-        @text = text.normalize
-        @params = @text.keywords.select { |word| word.start_with?(':') }
-      end
-
-      def keywords
-        text.keywords
-      end
-
-      def to_s
-        text
-      end
-
-      def regexp
-        @regexp ||= Regexp.new("^#{make_tokens.join(' ')}$", Regexp::IGNORECASE)
-      end
-
-      def verb
-        @verb ||= Syntax.literal_or_nil(keywords.first)
-      end
-
-      def compare other
-        if keywords.length == other.keywords.length
-          other.verb <=> verb
-        else
-          other.keywords.length <=> keywords.length
-        end
-      end
-
-      # @param tmpl_or_str [Template, String]
-      # @return [Template]
-      def self.to_template tmpl_or_str
-        return tmpl_or_str if tmpl_or_str.is_a?(Template)
-
-        Template.new(tmpl_or_str)
-      end
-
-      private
-
-      # @return [Array<String>]
-      def make_tokens
-        keywords.map.with_index do |word, idx|
-          next word unless word.match?(PARAM_REGEXP)
-
-          next nil if idx.positive? && keywords[idx - 1].match?(PARAM_REGEXP)
-
-          '([\w\W\s\S]*?)'
-        end.compact
-      end
-    end
-  end
-end