inform-runtime 1.2.3 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8342db25700d881e383905faaf8c8d3029511a245b9cc1e4b49aec3ebf6a0149
-  data.tar.gz: dece3144963ca7775f4b8367047a30a883dbdaefe68df0e689a5f1f9a0482089
+  metadata.gz: 1a9737a28a03ce80dd3698d1fc2824b22cb3090d4f0db6c3b52c84134e17a04c
+  data.tar.gz: 30ea465986dd84a628280ffa63c83228e04689db657d26c1bf449a15a779165a
 SHA512:
-  metadata.gz: 5142ffd42f10634c007b7aa945bd68b1d653331be622bac0b83051ed9e57d64e8bd7d190954ac42c642b7208aad9eb2fa99f20f2355c1d3c2516a493d152dca2
-  data.tar.gz: ebda0189c7b38d24a1d02719756c7c5e5c7ab0c1384b33c19112636c764ad15e8aab22273fd7cf38afdf28543034a1b85fdc5baf0eeb9bb6aae6c0a387c04ace
+  metadata.gz: f0f82b48842ed1cb74515abf3e26d2aeadc1c29004177a556e819ff814c3ce7ee63cf8b4225f5a53a3bfa8102c6bfa2ad0a21ad4b2654518269535c9fc3eca0f
+  data.tar.gz: e6122d69fc1a5fbbe2640709f567889a7d70d303740796883bec8ffb3001abd243b91597c02f12a7d31e9aac61de7e08b288cd648c9f784140e935279a2fb085

data/README.md

@@ -1,16 +1,14 @@
-# StoryTeller
+# StoryTeller Engine
 
 [![License](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat)](license-gpl)
 
-
-
-**StoryTeller** is a runtime layer for use by software programs used to
+**StoryTeller Engine** is a runtime layer for use by software programs used to
 play interactive-fiction games which are built for the [Inform 6 Ruby Port].
 
-StoryTeller is intended to simply provide the barest minimum facilities
-required by the Inform 6 Library Ruby Port software to function in the
-context of a game play specified by a game directory or file. It does not
-attempt to replicate a byte code interpreter runtime like frotz.
+The StoryTeller Engine is intended to simply provide the barest minimum
+facilities required by the Inform 6 Library Ruby Port software to function
+in the context of a game play specified by a game directory or file. It
+does not attempt to replicate a byte code interpreter runtime like frotz.
 
 
 ## Install mise-en-place
@@ -97,81 +95,75 @@ bundle exec rake test
 Here is a bird's-eye view of the project layout.
 
 ```sh
-# date && tree -A -I "game|logs|vendor|tmp|Gemfile.lock"
-Sat Dec 13 22:05:24 CST 2025
+# $ date && tree -A -I "coverage|game|logs|vendor|tmp|Gemfile.lock"
+Sun May 10 09:36:13 CDT 2026
 .
-├── config
-│   └── database.yml
 ├── CONTRIBUTING.md
-├── exe
-│   └── inform.rb
 ├── Gemfile
+├── inform-runtime-1.2.3.gem
 ├── inform-runtime.gemspec
 ├── lib
-│   ├── runtime
+│   ├── story_teller
 │   │   ├── articles.rb
 │   │   ├── builtins.rb
 │   │   ├── color.rb
 │   │   ├── command.rb
-│   │   ├── config.rb
 │   │   ├── context.rb
 │   │   ├── daemon.rb
-│   │   ├── database.rb
+│   │   ├── engine.rb
 │   │   ├── events.rb
 │   │   ├── experimental
-│   │   │   └── handler_dsl.rb
-│   │   ├── game_loader.rb
-│   │   ├── game.rb
+│   │   │   ├── handler_dsl.rb
+│   │   │   └── reverse_engineer_class.rb
 │   │   ├── grammar_parser.rb
 │   │   ├── helpers.rb
 │   │   ├── history.rb
 │   │   ├── inflector.rb
+│   │   ├── inform
+│   │   │   ├── ephemeral
+│   │   │   │   ├── link.rb
+│   │   │   │   ├── module.rb
+│   │   │   │   ├── object.rb
+│   │   │   │   └── tag.rb
+│   │   │   └── models.rb
 │   │   ├── io.rb
 │   │   ├── kernel.rb
-│   │   ├── library_loader.rb
+│   │   ├── library
+│   │   │   ├── bootstrap.rb
+│   │   │   ├── declarations.rb
+│   │   │   ├── directives.rb
+│   │   │   ├── loader.rb
+│   │   │   └── location.rb
 │   │   ├── library.rb
-│   │   ├── link.rb
 │   │   ├── logging.rb
 │   │   ├── mixins.rb
-│   │   ├── module.rb
-│   │   ├── object.rb
-│   │   ├── options.rb
-│   │   ├── persistence.rb
 │   │   ├── plurals.rb
+│   │   ├── privileges.rb
 │   │   ├── prototype.rb
 │   │   ├── publication.rb
-│   │   ├── runtime.rb
 │   │   ├── session.rb
-│   │   ├── snapshots.rb
 │   │   ├── stdlib.rb
 │   │   ├── subscription.rb
-│   │   ├── tag.rb
 │   │   ├── tree.rb
 │   │   ├── version.rb
 │   │   └── world_tree.rb
-│   └── runtime.rb
+│   └── story_teller.rb
 ├── LICENSE
 ├── Rakefile
 ├── README.md
 ├── roller2.jpg
-├── scripts
-│   ├── backup.rb
-│   ├── clone.rb
-│   ├── delete.rb
-│   ├── init.rb
-│   ├── rebuild.rb
-│   └── restore.rb
 └── spec
-    ├── game_spec.rb
+    ├── engine_spec.rb
+    ├── inform_ephemeral_spec.rb
     ├── inform_spec.rb
-    ├── inform_system_spec.rb
-    ├── object_spec.rb
     ├── parser_spec.rb
+    ├── prototype_spec.rb
     ├── spec_helper.rb
+    ├── stdlib_spec.rb
     ├── verblib_spec.rb
     └── verify_gem_spec.rb
 
-7 directories, 63 files
+8 directories, 57 files
 ```
 
 Thanks!

data/lib/story_teller/articles.rb

@@ -1,7 +1,8 @@
+# lib/story_teller/articles.rb
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
 #
 # This file is part of the StoryTeller.
 #

data/lib/story_teller/builtins.rb

@@ -2,7 +2,7 @@
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
 #
 # This file is part of the StoryTeller.
 #
@@ -165,25 +165,78 @@ module Builtins
 
   def objectloop(*_args, &block)
     if self.is_a?(InformLibrary)
-      object_class = StoryTeller::ModelAdapter.object_class
-      object_class&.all&.each { |o| block.call(o) }
+      inform_object_collection.each { |object| block.call(object) }
     elsif self.respond_to?(:descendants)
-      self.descendants.each { |o| block.call(o) }
+      self.descendants.each { |object| block.call(object) }
     end
   end
 
   def getobject(id)
-    object_class = StoryTeller::ModelAdapter.object_class!
-    o = object_class[id]
-    o.refresh
+    object = inform_object_fetch(id)
+    object.refresh if object.respond_to?(:refresh)
+    object
   rescue StandardError
     raise NoSuchObject
   end
 
+  # rubocop: disable Metrics/AbcSize
+  # rubocop: disable Metrics/CyclomaticComplexity
+  # rubocop: disable Metrics/MethodLength
   def findobject(*args, &block)
-    object_class = StoryTeller::ModelAdapter.object_class!
-    return object_class.dataset.order(:name, :id).grep(:name, *args).to_a if args.first.is_a?(Regexp)
-    object_class.dataset.grep(&block).to_a
+    object_class = inform_object_class
+
+    if sequel_model?(object_class)
+      return object_class.dataset.order(:name, :id).grep(:name, *args).to_a if args.first.is_a?(Regexp)
+
+      return object_class.dataset.grep(&block).to_a
+    end
+
+    objects = inform_object_collection
+    if args.first.is_a?(Regexp)
+      return objects.select do |object|
+        object_name_matches?(object, args.first)
+      end
+    end
+
+    block.nil? ? objects : objects.select(&block)
+  end
+  # rubocop: enable Metrics/AbcSize
+  # rubocop: enable Metrics/CyclomaticComplexity
+  # rubocop: enable Metrics/MethodLength
+
+  def inform_object_class
+    if defined?(Inform::Object) && sequel_model?(Inform::Object)
+      Inform::Object
+    elsif defined?(Inform::Ephemeral::Object)
+      Inform::Ephemeral::Object
+    end
+  end
+
+  def sequel_model?(object_class)
+    !object_class.nil? && object_class.respond_to?(:dataset)
+  end
+
+  def inform_object_collection
+    object_class = inform_object_class
+    return Array::Empty if object_class.nil?
+    return object_class.all if object_class.respond_to?(:all)
+
+    Array::Empty
+  end
+
+  def inform_object_fetch(id)
+    object_class = inform_object_class
+    raise NoSuchObject if object_class.nil?
+
+    object = object_class[id] if object_class.respond_to?(:[])
+    raise NoSuchObject if object.nil?
+
+    object
+  end
+
+  def object_name_matches?(object, pattern)
+    name = object.name if object.respond_to?(:name)
+    Array(name).any? { |part| part.to_s.match?(pattern) } || name.to_s.match?(pattern)
   end
 
   def deadflag; @deadflag; end

data/lib/story_teller/color.rb

@@ -1,7 +1,8 @@
+# lib/story_teller/color.rb
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
 #
 # This file is part of the StoryTeller.
 #

data/lib/story_teller/command.rb

@@ -1,7 +1,8 @@
+# lib/story_teller/command.rb
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
 #
 # This file is part of the StoryTeller.
 #

data/lib/story_teller/context.rb

@@ -2,7 +2,7 @@
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
 #
 # This file is part of the StoryTeller.
 #
@@ -34,42 +34,38 @@ end
 module Inform
   # Define Context module
   module Context
-    module_function
-
     @definition = nil
 
-    def definition
-      @definition
-    end
-
-    alias get definition
-
     AttributeFieldReferenceTemplate = '@%<attribute>s'.freeze
+    AttributeSetterMethodTemplate = '%<attribute>s='.freeze
 
-    def get_value(from, attribute)
-      return from.send(attribute) if from.respond_to?(attribute)
-      from.instance_variable_get(format(AttributeFieldReferenceTemplate, attribute: attribute).to_sym)
-    end
+    class << self
+      attr_reader :definition
+      alias get definition
 
-    AttributeSetterMethodTemplate = '%<attribute>s='.freeze
+      def get_value(from, attribute)
+        return from.send(attribute) if from.respond_to?(attribute)
+        from.instance_variable_get(format(AttributeFieldReferenceTemplate, attribute: attribute).to_sym)
+      end
 
-    def setter_method(attribute)
-      format(AttributeSetterMethodTemplate, attribute: attribute).to_sym
-    end
+      def setter_method(attribute)
+        format(AttributeSetterMethodTemplate, attribute: attribute).to_sym
+      end
 
-    def each_attribute(obj)
-      @definition&.members&.each do |attribute|
-        yield(attribute, get_value(obj, attribute))
+      def each_attribute(obj)
+        @definition&.members&.each do |attribute|
+          yield(attribute, get_value(obj, attribute))
+        end
       end
-    end
 
-    def set(definition)
-      @definition = definition
-      @definition&.members&.each do |attribute|
-        StoryTeller::Command.send(:attr_accessor, attribute) unless StoryTeller::Command.respond_to? attribute
-        Inform::Event.send(:attr_accessor, attribute) unless Inform::Event.respond_to? attribute
+      def set(definition)
+        @definition = definition
+        @definition&.members&.each do |attribute|
+          StoryTeller::Command.send(:attr_accessor, attribute) unless StoryTeller::Command.respond_to? attribute
+          Inform::Event.send(:attr_accessor, attribute) unless Inform::Event.respond_to? attribute
+        end
+        @definition
       end
-      @definition
     end
   end
   # module Context

data/lib/story_teller/daemon.rb

@@ -1,8 +1,8 @@
-# src/lib/daemon.rb
+# lib/story_teller/daemon.rb
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
 #
 # This file is part of the StoryTeller.
 #

data/lib/story_teller/engine.rb

@@ -2,7 +2,7 @@
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
 #
 # This file is part of the StoryTeller.
 #
@@ -33,9 +33,7 @@ module StoryTeller
     module Library
       def play
         log.debug "Using engine-managed InformLibrary play method override"
-        inform_library = StoryTeller::Engine.library
-        inform_library.play
-        inform_library
+        StoryTeller::Engine.library.tap(&:play)
       end
     end
 
@@ -45,6 +43,7 @@ module StoryTeller
         environment: 'default',
         inform6lib_gem_code_prefix: 'inform',
         language: 'English',
+        persist_player_location: false,
         properties: 'player actor action action_to_be ' \
           'results parameters pattern ' \
           'noun second inp1 inp2 ' \
@@ -61,11 +60,42 @@ module StoryTeller
       @libraries ||= {}
     end
 
-    def library
-      selfobj = parser_selfobj
+    def persist_player_location?
+      return @persist_player_location unless @persist_player_location.nil?
+
+      default_config.fetch(:persist_player_location, false)
+    end
+
+    def persist_player_location=(value)
+      @persist_player_location = value
+    end
+
+    def player_object
+      @player_object || parser_selfobj
+    end
+
+    def player_object=(object)
+      raise ManagedLibraryError, "player object is nil" if object.nil?
+
+      @player_object = object
+      replace_parser_selfobj(object)
+      libraries.clear
+    end
+
+    def library(selfobj = player_object)
       return libraries[selfobj] if !selfobj.nil? && libraries.key?(selfobj)
 
-      bind_managed_library(InformLibrary.new)
+      inflib = InformLibrary.new.tap { |inflib| inflib.selfobj = selfobj }
+      bind_managed_library(inflib)
+    end
+
+    def replace_parser_selfobj(object)
+      return object unless defined?(Inform::Parser)
+
+      Inform::Parser.send(:remove_const, :SelfObj) if Inform::Parser.const_defined?(:SelfObj, false)
+      Inform::Parser.const_set(:SelfObj, object)
+
+      object
     end
 
     def bind_managed_library(inform_library)
@@ -77,12 +107,14 @@ module StoryTeller
       libraries[selfobj] = inform_library
       selfobj.inflib = inform_library if selfobj.respond_to?(:inflib=)
 
-      ensure_location(inform_library)
+      ensure_player_location(inform_library) if persist_player_location?
 
       inform_library
     end
 
-    def ensure_location(inflib)
+    # rubocop: disable Metrics/CyclomaticComplexity
+    def ensure_player_location(inflib)
+      return unless persist_player_location?
       return if inflib.nil?
 
       existing_location = inflib.instance_variable_get(:@location)
@@ -94,6 +126,7 @@ module StoryTeller
 
       inflib.instance_variable_set(:@location, location) unless location.nil?
     end
+    # rubocop: enable Metrics/CyclomaticComplexity
 
     def parser_selfobj
       return nil unless defined?(Inform::Parser::SelfObj)
@@ -165,7 +198,9 @@ module StoryTeller
 
     def prime_dictionary
       Inform::Object.select_map(:name).compact.each do |n|
-        StoryTeller::Dictionary.merge(n.split(/[,\s]+/).grep_v(/[^a-z]/i).map(&:downcase).map(&:to_sym))
+        Array(n).join(' ').split(/[,\s]+/).grep_v(/[^a-z]/i).map(&:downcase).map(&:to_sym).each do |word|
+          StoryTeller::Dictionary.merge([word])
+        end
       end
     end
   end

data/lib/story_teller/events.rb

@@ -2,7 +2,7 @@
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
 #
 # This file is part of StoryTeller.
 #

data/lib/story_teller/experimental/handler_dsl.rb

@@ -2,7 +2,7 @@
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
 #
 # This file is part of the StoryTeller.
 #
@@ -21,21 +21,6 @@
 
 # The Inform module
 module Inform
-  # TODO: Testme
-  # class Object
-  #   def after_initialize
-  #     super
-  #     return if new?
-  #     Inform::Behavior.attach(self)
-  #     apply_instance_behavior!
-  #   end
-
-  #   def after_refresh
-  #     super
-  #     apply_instance_behavior!
-  #   end
-  # end
-
   # The Inform::Behavior module
   module Behavior
     class Registry < Hash; end

data/lib/story_teller/experimental/reverse_engineer_class.rb

@@ -2,7 +2,7 @@
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
 #
 # This file is part of StoryTeller.
 #

data/lib/story_teller/grammar_parser.rb

@@ -1,7 +1,8 @@
+# lib/story_teller/grammar_parser.rb
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
 #
 # This file is part of StoryTeller.
 #
@@ -90,7 +91,12 @@ module Inform
     EmoteString = 'emote'.freeze
     Newline = "\n".freeze
 
+    # rubocop: disable Metrics/AbcSize
+    # rubocop: disable Metrics/MethodLength
     def to_s
+      grammar_lines = grammars.map(&:to_s)
+      grammar_lines[-1] = "#{grammar_lines[-1]};" if grammar_lines.any?
+
       VerbString + SpaceString +
         if meta?
           MetaString + SpaceString
@@ -100,8 +106,10 @@ module Inform
           ''
         end +
         map { |verb| "'#{verb}'" }.join(SpaceString) + Newline +
-        grammars.join(Newline)
+        grammar_lines.join(Newline)
     end
+    # rubocop: enable Metrics/AbcSize
+    # rubocop: enable Metrics/MethodLength
     alias to_str to_s
 
     def hash
@@ -115,15 +123,22 @@ module Inform
       CustomScopePattern = %r{^(.*)=(.*)$}.freeze
       attr_reader :source, :action, :expected_tokens
 
+      # rubocop: disable Metrics/MethodLength
       def initialize(grammar, source, action, reverse = nil)
         super()
-        concat(symbolize_grammar(grammar)) unless grammar.empty?
+        unless grammar.empty?
+          symbolized_grammar = symbolize_grammar(grammar)
+          concat(symbolized_grammar) unless symbolized_grammar.empty?
+        end
         push(:end)
         @action = action
-        @expected_tokens = grammar.map { |a| CustomScopePattern.match?(a) ? a.to_s.split('=').first.to_sym : a }
+        @expected_tokens = symbolized_grammar&.map do |a|
+          CustomScopePattern.match?(a) ? a.to_s.split('=').first.to_sym : a
+        end
         @reverse = reverse.nil? ? false : reverse
         @source = source
       end
+      # rubocop: enable Metrics/MethodLength
 
       def empty?
         length == (include?(:end) ? 1 : 0)
@@ -261,35 +276,64 @@ module Inform
       BuilderPattern = %r{builder}.freeze
       Profanity = %w[shit damn fuck sod].freeze
       ValidModes = %i[admin builder player].freeze
-      ModePatterns = ValidModes.each_with_object({}) { |key, memo| memo[key] = Regexp.new(key.to_s) }
+      ModePatterns = ValidModes.each_with_object({}) do |key, memo|
+        memo[key] = Regexp.new(key.to_s)
+      end
+
+      # TODO: Remove (2026-04-30) after confirming replacement below
+      # works better.
+      # def lookup(key, actor = nil, grammar_index = self)
+      #   return nil if key.nil? || !grammar_index.include?(key)
+      #   verb = grammar_index[key].dup
+      #   return verb if actor.nil?
+      #   return nil if guarded?(verb, actor)
+      #   filter_by_permission(verb, actor)
+      #   verb
+      # end
 
       def lookup(key, actor = nil, grammar_index = self)
         return nil if key.nil? || !grammar_index.include?(key)
+
         verb = grammar_index[key].dup
         return verb if actor.nil?
-        return nil if guarded?(verb, actor)
+
         filter_by_permission(verb, actor)
+        return nil if verb.grammars.empty?
+
         verb
       end
 
       def all(actor = nil, grammar_index = self)
         return grammar_index.map(&:keys).flatten.sort if actor.nil?
         mode = role(actor)
-        init_all_verbs_by_mode(mode, grammar_index, actor) unless Inform::Grammar.partitions.include?(mode)
+        unless Inform::Grammar.partitions.include?(mode)
+          init_all_verbs_by_mode(mode, grammar_index, actor)
+        end
         Inform::Grammar.partitions[mode]
       end
 
       def by_mode(mode = nil, grammar_index = self)
         mode = validate(mode)
-        init_verbs_filtered_by_mode(mode, grammar_index) unless Inform::Grammar.selections.include?(mode)
+        unless Inform::Grammar.selections.include?(mode)
+          init_verbs_filtered_by_mode(mode, grammar_index)
+        end
         Inform::Grammar.selections[mode]
       end
 
       private
 
+      # TODO: Remove (2026-04-30) after confirming replacement below
+      # works better.
+      # def init_all_verbs_by_mode(mode, grammar_index, actor, set = verbs_set_instance)
+      #   verbs = grammar_index.each_with_object(set) do |(key, verb), memo|
+      #     memo.add(key) unless Profanity.include?(key) || guarded?(verb, actor)
+      #   end
+      #   Inform::Grammar.partitions[mode] = verbs.to_a
+      # end
+
       def init_all_verbs_by_mode(mode, grammar_index, actor, set = verbs_set_instance)
         verbs = grammar_index.each_with_object(set) do |(key, verb), memo|
-          memo.add(key) unless Profanity.include?(key) || guarded?(verb, actor)
+          memo.add(key) unless Profanity.include?(key) || !visible_to?(verb, actor)
         end
         Inform::Grammar.partitions[mode] = verbs.to_a
       end
@@ -312,13 +356,16 @@ module Inform
       end
 
       def guarded?(resource, obj)
-        (AdminPattern.match?(resource.source) && !obj.admin?) ||
-          (BuilderPattern.match?(resource.source) && !obj.builder?)
+        (AdminPattern.match?(resource.source) &&
+          !StoryTeller::Privileges.privileged?(obj, :admin)) ||
+          (BuilderPattern.match?(resource.source) &&
+            !StoryTeller::Privileges.privileged?(obj, :builder))
       end
 
       def role(obj)
-        return :builder if obj.builder?
-        return :admin if obj.admin?
+        return :admin if StoryTeller::Privileges.privileged?(obj, :admin)
+        return :builder if StoryTeller::Privileges.privileged?(obj, :builder)
+
         :player
       end