gamefic 3.6.0 → 4.0.0

data/lib/gamefic/scripting/hooks.rb

@@ -0,0 +1,45 @@
+module Gamefic
+  module Scripting
+    # Scripting hook methods are instance methods that return callbacks for
+    # execution in the context of a scriptable module or narrative. They
+    # collect the procs defined in Scriptable hook methods and bind them to the
+    # instance for execution.
+    #
+    module Hooks
+      # @return [Array<Binding>]
+      def before_commands
+        find_and_bind(:before_commands)
+      end
+
+      # @return [Array<Binding>]
+      def after_commands
+        find_and_bind(:after_commands)
+      end
+
+      # @return [Array<Binding>]
+      def ready_blocks
+        find_and_bind(:ready_blocks)
+      end
+
+      # @return [Array<Binding>]
+      def update_blocks
+        find_and_bind(:update_blocks)
+      end
+
+      # @return [Array<Binding>]
+      def player_output_blocks
+        find_and_bind(:player_output_blocks)
+      end
+
+      # @return [Array<Binding>]
+      def conclude_blocks
+        find_and_bind(:conclude_blocks)
+      end
+
+      # @return [Array<Binding>]
+      def player_conclude_blocks
+        find_and_bind(:player_conclude_blocks)
+      end
+    end
+  end
+end

data/lib/gamefic/{scriptable → scripting}/proxies.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Gamefic
-  module Scriptable
+  module Scripting
     # Methods for referencing entities from proxies.
     #
     module Proxies
@@ -14,14 +14,16 @@ module Gamefic
       #
       # @param object [Object]
       # @return [Object]
-      def unproxy object
+      def unproxy(object)
         case object
-        when Proxy, Proxy::Base
+        when Proxy::Base
           object.fetch self
         when Array
           object.map { |obj| unproxy obj }
         when Hash
           object.transform_values { |val| unproxy val }
+        when Response, Query::Base
+          object.bind(self)
         else
           object
         end

data/lib/gamefic/scripting/responses.rb

@@ -0,0 +1,21 @@
+module Gamefic
+  module Scripting
+    module Responses
+      # @return [Array<Response>]
+      def responses
+        included_scripts.flat_map(&:responses)
+                        .map { |response| response.bind(self) }
+      end
+
+      # @return [Array<Response>]
+      def responses_for *verbs
+        # @todo This double reversal is odd, but Gamefic::Standard fails in
+        #   Opal without it.
+        included_scripts.reverse
+                        .flat_map { |script| script.responses_for(*verbs) }
+                        .reverse
+                        .map { |response| response.bind(self) }
+      end
+    end
+  end
+end

data/lib/gamefic/scripting/scenes.rb

@@ -0,0 +1,57 @@
+module Gamefic
+  module Scripting
+    module Scenes
+      # @return [Scene::Base]
+      def default_scene
+        self.class.default_scene
+      end
+
+      # @return [Scene::Conclusion]
+      def default_conclusion
+        self.class.default_conclusion
+      end
+
+      # @return [Array<Binding>]
+      def introductions
+        included_scripts.reverse
+                        .flat_map(&:introductions)
+                        .map { |blk| Binding.new(self, blk) }
+      end
+
+      # @return [Hash]
+      def named_scenes
+        {}.merge(*included_scripts.flat_map(&:named_scenes))
+      end
+
+      # Prepare a scene to be executed. Scenes can be accessed by their class
+      # or by a symbolic name if one has been defined in this narrative.
+      #
+      # @param name_or_class [Symbol, Class<Scene::Base>]
+      # @param actor [Actor]
+      # @param props [Props::Default]
+      # @return [Scene::Base]
+      def prepare name_or_class, actor, props, **context
+        scene_classes_map[name_or_class]&.new(actor, self, props, **context).tap do |scene|
+          scene&.rename(name_or_class.to_s) if name_or_class.is_a?(Symbol)
+        end
+      end
+
+      # @return [Array<Scene::Base>]
+      def scenes
+        self.class.scenes
+      end
+
+      # @param name_or_class [Symbol, Class<Scene::Base>]
+      # @return [Scene::Base]
+      def scene_class(name_or_class)
+        scene_classes_map[name_or_class]
+      end
+
+      private
+
+      def scene_classes_map
+        {}.merge(*included_scripts.flat_map(&:scene_classes_map))
+      end
+    end
+  end
+end

data/lib/gamefic/scripting/seeds.rb

@@ -0,0 +1,10 @@
+module Gamefic
+  module Scripting
+    module Seeds
+      # @return [Array<Proc>]
+      def seeds
+        self.class.seeds
+      end
+    end
+  end
+end

data/lib/gamefic/scripting/syntaxes.rb

@@ -0,0 +1,13 @@
+module Gamefic
+  module Scripting
+    module Syntaxes
+      def syntaxes
+        included_scripts.flat_map(&:syntaxes)
+      end
+
+      def synonyms
+        syntaxes.map(&:synonym).uniq
+      end
+    end
+  end
+end

data/lib/gamefic/scripting.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Gamefic
+  # An instance module that enables scripting.
+  #
+  # Including `Gamefic::Scripting` also extends `Gamefic::Scriptable`.
+  #
+  module Scripting
+    require 'gamefic/scripting/proxies'
+    require 'gamefic/scripting/entities'
+    require 'gamefic/scripting/hooks'
+    require 'gamefic/scripting/responses'
+    require 'gamefic/scripting/syntaxes'
+    require 'gamefic/scripting/seeds'
+    require 'gamefic/scripting/scenes'
+
+    extend Scriptable
+    include Scriptable::Queries
+    include Entities
+    include Hooks
+    include Responses
+    include Seeds
+    include Scenes
+    include Syntaxes
+
+    # @return [Array<Module<Scriptable>>]
+    def included_scripts
+      self.class.included_scripts
+    end
+
+    # @param symbol [Symbol]
+    # @return [Array<Binding>]
+    def find_and_bind(symbol)
+      included_scripts.flat_map { |script| script.send(symbol) }
+                      .map { |blk| Binding.new(self, blk) }
+    end
+
+    def self.included other
+      super
+      other.extend Scriptable
+    end
+  end
+end

data/lib/gamefic/subplot.rb

@@ -7,8 +7,6 @@ module Gamefic
   # started and concluded at any time during the parent plot's runtime.
   #
   class Subplot < Narrative
-    extend Scriptable::PlotProxies
-
     # @return [Hash]
     attr_reader :config
 
@@ -28,6 +26,10 @@ module Gamefic
       [introduce].flatten.each { |plyr| self.introduce plyr }
     end
 
+    def seeds
+      super - plot.seeds
+    end
+
     def self.persist!
       @persistent = true
     end
@@ -40,33 +42,16 @@ module Gamefic
       self.class.persistent?
     end
 
-    def included_blocks
-      super - plot.included_blocks
-    end
-
-    def ready
-      super
-      conclude if concluding?
-    end
-
     def conclude
-      rulebook.run_conclude_blocks
+      conclude_blocks.each(&:call)
       players.each do |plyr|
-        rulebook.run_player_conclude_blocks plyr
+        player_conclude_blocks.each { |blk| blk[plyr] }
         uncast plyr
       end
       entities.each { |ent| destroy ent }
       @concluded = true
     end
 
-    # Make an entity that persists in the subplot's parent plot.
-    #
-    # @see Plot#make
-    #
-    def persist klass, **args
-      plot.make klass, *args
-    end
-
     # Start a new subplot based on the provided class.
     #
     # @note A subplot's host is always the base plot, regardless of whether
@@ -91,10 +76,14 @@ module Gamefic
       @concluded
     end
 
-    def introduce player
+    def introduce(player)
       @concluded ? player : super
     end
 
+    def prepare(...)
+      super || plot.prepare(...)
+    end
+
     def inspect
       "#<#{self.class}>"
     end

data/lib/gamefic/syntax.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'gamefic/syntax/template'
+# require 'gamefic/syntax/template'
 
 module Gamefic
   # Syntaxes provide rules for matching input patterns to existing responses.
@@ -18,11 +18,14 @@ module Gamefic
   #     Syntax.new('search :container for :thing', 'look :thing :container')
   #
   class Syntax
-    # The pattern that matching input is expected to follow.
-    #
-    # @return [Template]
+    PARAM_REGEXP = /^:[a-z0-9_]+$/i.freeze
+
+    # @return [String]
     attr_reader :template
 
+    # @return [Array<String>]
+    attr_reader :params
+
     # The pattern that will be used to tokenize the input into a command.
     #
     # @return [String]
@@ -37,10 +40,11 @@ module Gamefic
     # @return [Symbol]
     attr_reader :verb
 
-    # @param template [Template, String]
+    # @param template [String]
     # @param command [String]
-    def initialize template, command
-      @template = Template.to_template(template)
+    def initialize(template, command)
+      @template = template.normalize
+      @params = @template.keywords.select { |word| word.start_with?(':') }
       @command = command.normalize
       @verb = Syntax.literal_or_nil(@command.keywords[0])
       @replace = parse_replace
@@ -55,15 +59,20 @@ module Gamefic
     #
     # @return [Symbol]
     def synonym
-      template.verb
+      @synonym ||= Syntax.literal_or_nil(template.keywords.first)
+    end
+
+    # @return [Regexp]
+    def regexp
+      @regexp ||= Regexp.new("^#{make_tokens.join(' ')}$", Regexp::IGNORECASE)
     end
 
     # Convert a String into a Command.
     #
     # @param text [String]
     # @return [Expression, nil]
-    def tokenize text
-      match = text&.match(template.regexp)
+    def tokenize(text)
+      match = text&.match(regexp)
       return nil unless match
 
       Expression.new(verb, match_to_args(match))
@@ -73,15 +82,15 @@ module Gamefic
     #
     # @param text [String]
     # @return [Boolean]
-    def accept? text
-      !!text.match(template.regexp)
+    def accept?(text)
+      !!text.match(regexp)
     end
 
     # Get a signature that identifies the form of the Syntax.
     # Signatures are used to compare Syntaxes to each other.
     #
     def signature
-      [template.regexp, replace]
+      [regexp, replace]
     end
 
     def ==(other)
@@ -95,22 +104,17 @@ module Gamefic
     # @param text [String] The text to tokenize.
     # @param syntaxes [Array<Syntax>] The syntaxes to use.
     # @return [Array<Expression>] The tokenized expressions.
-    def self.tokenize text, syntaxes
+    def self.tokenize(text, syntaxes)
       syntaxes
         .map { |syn| syn.tokenize(text) }
         .compact
-        .sort { |syn, other_syn| syn.compare other_syn }
-    end
-
-    # Compare two syntaxes for the purpose of ordering them in rulebooks.
-    #
-    def compare other
-      template.compare other.template
+        .uniq { |exp| [exp.verb, exp.tokens] }
+        .sort_by { |exp| [-exp.tokens.compact.length] }
     end
 
     # @param string [String]
     # @return [Symbol, nil]
-    def self.literal_or_nil string
+    def self.literal_or_nil(string)
       string.start_with?(':') ? nil : string.to_sym
     end
 
@@ -123,17 +127,28 @@ module Gamefic
       command.keywords.map do |word|
         next word unless word.start_with?(':')
 
-        index = template.params.index(word) ||
+        index = params.index(word) ||
                 raise(ArgumentError, "syntax command references undefined parameter `#{word}`")
         "{$#{index + 1}}"
       end.join(' ')
     end
 
-    def match_to_args match
+    def match_to_args(match)
       start = replace.start_with?('{') ? 0 : 1
       replace.keywords[start..].map do |str|
         str.match?(/^\{\$[0-9]+\}$/) ? match[str[2..-2].to_i] : str
       end
     end
+
+    # @return [Array<String>]
+    def make_tokens
+      template.keywords.map.with_index do |word, idx|
+        next word unless word.match?(PARAM_REGEXP)
+
+        next nil if idx.positive? && template.keywords[idx - 1].match?(PARAM_REGEXP)
+
+        '([\w\W\s\S]*?)'
+      end.compact
+    end
   end
 end

data/lib/gamefic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gamefic
-  VERSION = '3.6.0'
+  VERSION = '4.0.0'
 end

data/lib/gamefic.rb

@@ -7,11 +7,11 @@ require 'gamefic/core_ext/array'
 require 'gamefic/core_ext/string'
 require 'gamefic/syntax'
 require 'gamefic/response'
-require 'gamefic/rulebook'
-require 'gamefic/callback'
+require 'gamefic/match'
+require 'gamefic/request'
+require 'gamefic/order'
 require 'gamefic/query'
 require 'gamefic/scanner'
-require 'gamefic/scope'
 require 'gamefic/expression'
 require 'gamefic/command'
 require 'gamefic/action'
@@ -19,14 +19,12 @@ require 'gamefic/props'
 require 'gamefic/scene'
 require 'gamefic/proxy'
 require 'gamefic/scriptable'
-require 'gamefic/block'
-require 'gamefic/stage'
-require 'gamefic/vault'
+require 'gamefic/scripting'
+require 'gamefic/binding'
 require 'gamefic/narrative'
 require 'gamefic/plot'
 require 'gamefic/chapter'
 require 'gamefic/subplot'
-require 'gamefic/snapshot'
 require 'gamefic/node'
 require 'gamefic/describable'
 require 'gamefic/messenger'
@@ -35,3 +33,4 @@ require 'gamefic/dispatcher'
 require 'gamefic/active'
 require 'gamefic/active/cue'
 require 'gamefic/actor'
+require 'gamefic/narrator'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-06 00:00:00.000000000 Z
+date: 2025-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -58,20 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -130,12 +124,10 @@ files:
 - lib/gamefic/action.rb
 - lib/gamefic/active.rb
 - lib/gamefic/active/cue.rb
-- lib/gamefic/active/epic.rb
 - lib/gamefic/active/messaging.rb
-- lib/gamefic/active/take.rb
+- lib/gamefic/active/narratives.rb
 - lib/gamefic/actor.rb
-- lib/gamefic/block.rb
-- lib/gamefic/callback.rb
+- lib/gamefic/binding.rb
 - lib/gamefic/chapter.rb
 - lib/gamefic/command.rb
 - lib/gamefic/core_ext/array.rb
@@ -145,34 +137,43 @@ files:
 - lib/gamefic/entity.rb
 - lib/gamefic/expression.rb
 - lib/gamefic/logging.rb
+- lib/gamefic/match.rb
 - lib/gamefic/messenger.rb
 - lib/gamefic/narrative.rb
+- lib/gamefic/narrator.rb
 - lib/gamefic/node.rb
+- lib/gamefic/order.rb
 - lib/gamefic/plot.rb
 - lib/gamefic/props.rb
 - lib/gamefic/props/default.rb
 - lib/gamefic/props/multiple_choice.rb
+- lib/gamefic/props/multiple_partial.rb
 - lib/gamefic/props/output.rb
 - lib/gamefic/props/pause.rb
 - lib/gamefic/props/yes_or_no.rb
 - lib/gamefic/proxy.rb
+- lib/gamefic/proxy/attr.rb
 - lib/gamefic/proxy/base.rb
 - lib/gamefic/proxy/config.rb
 - lib/gamefic/proxy/pick.rb
-- lib/gamefic/proxy/plot_pick.rb
+- lib/gamefic/proxy/pick_ex.rb
 - lib/gamefic/query.rb
-- lib/gamefic/query/abstract.rb
+- lib/gamefic/query/ascendants.rb
 - lib/gamefic/query/base.rb
-- lib/gamefic/query/general.rb
+- lib/gamefic/query/children.rb
+- lib/gamefic/query/descendants.rb
+- lib/gamefic/query/extended.rb
+- lib/gamefic/query/family.rb
+- lib/gamefic/query/global.rb
+- lib/gamefic/query/integer.rb
+- lib/gamefic/query/myself.rb
+- lib/gamefic/query/parent.rb
 - lib/gamefic/query/result.rb
-- lib/gamefic/query/scoped.rb
+- lib/gamefic/query/siblings.rb
+- lib/gamefic/query/subqueries.rb
 - lib/gamefic/query/text.rb
+- lib/gamefic/request.rb
 - lib/gamefic/response.rb
-- lib/gamefic/rulebook.rb
-- lib/gamefic/rulebook/calls.rb
-- lib/gamefic/rulebook/events.rb
-- lib/gamefic/rulebook/hooks.rb
-- lib/gamefic/rulebook/scenes.rb
 - lib/gamefic/scanner.rb
 - lib/gamefic/scanner/base.rb
 - lib/gamefic/scanner/fuzzy.rb
@@ -181,34 +182,30 @@ files:
 - lib/gamefic/scanner/result.rb
 - lib/gamefic/scanner/strict.rb
 - lib/gamefic/scene.rb
+- lib/gamefic/scene/active_choice.rb
 - lib/gamefic/scene/activity.rb
+- lib/gamefic/scene/base.rb
 - lib/gamefic/scene/conclusion.rb
-- lib/gamefic/scene/default.rb
 - lib/gamefic/scene/multiple_choice.rb
 - lib/gamefic/scene/pause.rb
 - lib/gamefic/scene/yes_or_no.rb
-- lib/gamefic/scope.rb
-- lib/gamefic/scope/base.rb
-- lib/gamefic/scope/children.rb
-- lib/gamefic/scope/descendants.rb
-- lib/gamefic/scope/family.rb
-- lib/gamefic/scope/myself.rb
-- lib/gamefic/scope/parent.rb
-- lib/gamefic/scope/siblings.rb
 - lib/gamefic/scriptable.rb
-- lib/gamefic/scriptable/actions.rb
-- lib/gamefic/scriptable/entities.rb
-- lib/gamefic/scriptable/events.rb
-- lib/gamefic/scriptable/plot_proxies.rb
-- lib/gamefic/scriptable/proxies.rb
+- lib/gamefic/scriptable/hooks.rb
 - lib/gamefic/scriptable/queries.rb
+- lib/gamefic/scriptable/responses.rb
 - lib/gamefic/scriptable/scenes.rb
-- lib/gamefic/snapshot.rb
-- lib/gamefic/stage.rb
+- lib/gamefic/scriptable/seeds.rb
+- lib/gamefic/scriptable/syntaxes.rb
+- lib/gamefic/scripting.rb
+- lib/gamefic/scripting/entities.rb
+- lib/gamefic/scripting/hooks.rb
+- lib/gamefic/scripting/proxies.rb
+- lib/gamefic/scripting/responses.rb
+- lib/gamefic/scripting/scenes.rb
+- lib/gamefic/scripting/seeds.rb
+- lib/gamefic/scripting/syntaxes.rb
 - lib/gamefic/subplot.rb
 - lib/gamefic/syntax.rb
-- lib/gamefic/syntax/template.rb
-- lib/gamefic/vault.rb
 - lib/gamefic/version.rb
 homepage: https://gamefic.com
 licenses: