inform-runtime 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474087cc0143425969470924c1fe5e944b06f2d17ee76a097551345c4ca1959e
-  data.tar.gz: 8f933a9f47d17a247d804d226a32f8ff7d57e38698d0b0a262e40a796efd7972
+  metadata.gz: a0411c83f9c461e9b8f2687c5f27aa49591933e786f74efa489ca111b3cf9b74
+  data.tar.gz: 582fa29d5e602c4e36a499dcc259e21391fa3982348f7fcb2196b8a740c028e3
 SHA512:
-  metadata.gz: 606603f0fa1048e8cf566204167646989a99b1fcc80746ec3c8a7490d737ced8cdfb09be0e0cc7b0674123ed96b8588b387f6ed010328963c700816c172167a1
-  data.tar.gz: 3bab288d8358fcf11ca366756a1e451f3cfab0b231aa7e35d144397b4cba04257b1a92f2406581611628c03521d986db01aa32501818fe059f85f439d2a34370
+  metadata.gz: 3ccb26de6ef43e0bedeaf044b964c30ecba16e09809a5c081f32aac1acacfe1644a321cc1f9b68483f1f70496a17e72892fd55a596ba95f83cdc72011f41fa44
+  data.tar.gz: ce1fb4b1b4993d8ff7ccd230ee141d1c5347b08c85cc9a074873ff7d66753f588289460dcf9fef0d4aababeb6c98cd09724ebb562f9dfe5381cb108ec2942c88

data/README.md

@@ -129,7 +129,6 @@ Sun May 10 09:36:13 CDT 2026
 │   │   ├── io.rb
 │   │   ├── kernel.rb
 │   │   ├── library
-│   │   │   ├── bootstrap.rb
 │   │   │   ├── declarations.rb
 │   │   │   ├── directives.rb
 │   │   │   ├── loader.rb

data/lib/story_teller/articles.rb

@@ -21,6 +21,8 @@
 
 # The StoryTeller module
 module StoryTeller
+# The English module
+module English
   # The Articles module
   # Support standard StoryTeller methods for dynamically applying appropriate
   # articles to nouns.
@@ -99,13 +101,15 @@ module StoryTeller
   end
   # module Articles
 end
+# module English
+end
 # module StoryTeller
 
 # module Inform
 module Inform
   # Re-open the Inform::Parser module
   module Parser
-    include StoryTeller::Articles
+    include StoryTeller::English::Articles
 
     VowelsOrHiPattern = %r{^([aeiou]|hi).+}.freeze
 
@@ -137,7 +141,7 @@ module Inform
   # module Parser
 
   module Verbs
-    include StoryTeller::Articles
+    include StoryTeller::English::Articles
   end
 end
 # module Inform

data/lib/story_teller/builtins.rb

@@ -30,7 +30,7 @@ require_relative 'plurals'
 module StoryTeller
 # module Builtins
 module Builtins
-  include StoryTeller::Articles
+  include StoryTeller::English::Articles
   include StoryTeller::Color
   include StoryTeller::Plurals
 
@@ -57,6 +57,7 @@ module Builtins
   # rubocop: disable Metrics/PerceivedComplexity
   def with(context = nil, &block)
     return self if block.nil?
+    self.instance_variable_set(:@defining_object, true)
     existing_methods = self.singleton_methods(false)
 
     if context.nil?
@@ -87,12 +88,19 @@ module Builtins
     end
     self.save_changes if self.respond_to?(:save_changes)
     self
+  ensure
+    self.remove_instance_variable(:@defining_object) if self.instance_variable_defined?(:@defining_object)
   end
   # rubocop: enable Metrics/AbcSize
   # rubocop: enable Metrics/CyclomaticComplexity
   # rubocop: enable Metrics/MethodLength
   # rubocop: enable Metrics/PerceivedComplexity
 
+  def defining_object?
+    self.instance_variable_defined?(:@defining_object) &&
+      self.instance_variable_get(:@defining_object) == true
+  end
+
   MethodDefinitionPattern = /\s*def\s+/.freeze
   MethodTerminationPattern = /\s*end$/.freeze
 
@@ -107,6 +115,7 @@ module Builtins
   end
 
   def apply_instance_behavior!
+    self.properties ||= {}
     source = self.properties[:instance_behavior]
     return if source.nil? || source.empty?
     return unless source.include?('def ')
@@ -138,7 +147,7 @@ module Builtins
 
   def react_after?(action_routine = action)
     return false if action_routine.nil?
-    self.apply_modules if self.respond_to?(:apply_modules)
+    self.apply_modules! if self.respond_to?(:apply_modules!)
     self.provides?('react_after_' + action_routine)
   rescue StandardError => e
     log.error "Error checking for after reaction: #{e.message}", e
@@ -147,7 +156,7 @@ module Builtins
 
   def react_before?(action_routine = action)
     return false if action_routine.nil?
-    self.apply_modules if self.respond_to?(:apply_modules)
+    self.apply_modules! if self.respond_to?(:apply_modules!)
     self.provides?('react_before_' + action_routine)
   rescue StandardError => e
     log.error "Error checking for before reaction: #{e.message}", e
@@ -156,7 +165,7 @@ module Builtins
 
   def life?(action_routine = action)
     return false if action_routine.nil?
-    self.apply_modules if self.respond_to?(:apply_modules)
+    self.apply_modules! if self.respond_to?(:apply_modules!)
     self.provides?('life_' + action_routine)
   rescue StandardError => e
     log.error "Error checking for life reaction: #{e.message}", e
@@ -182,15 +191,27 @@ module Builtins
   # rubocop: disable Metrics/AbcSize
   # rubocop: disable Metrics/CyclomaticComplexity
   # rubocop: disable Metrics/MethodLength
+  # rubocop: disable Metrics/PerceivedComplexity
   def findobject(*args, &block)
     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)
+      if args.first.is_a?(Regexp)
+        return object_class.dataset.order(:name, :id).all.select do |object|
+          object_name_matches?(object, args.first)
+        end
+      end
 
       return object_class.dataset.grep(&block).to_a
     end
 
+    # 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|
@@ -203,6 +224,7 @@ module Builtins
   # rubocop: enable Metrics/AbcSize
   # rubocop: enable Metrics/CyclomaticComplexity
   # rubocop: enable Metrics/MethodLength
+  # rubocop: enable Metrics/PerceivedComplexity
 
   def inform_object_class
     if defined?(Inform::Object) && sequel_model?(Inform::Object)
@@ -239,7 +261,7 @@ module Builtins
     Array(name).any? { |part| part.to_s.match?(pattern) } || name.to_s.match?(pattern)
   end
 
-  def deadflag; @deadflag; end
+  def deadflag; @deadflag ||= 0; end
 
   def deadflag=(flag); @deadflag = flag; end
 
@@ -267,6 +289,10 @@ module Builtins
   alias text topic
 
   def number(x = nil)
+    if !x.nil? && self.object? && self.defining_object?
+      self.properties[:number] = x
+      return
+    end
     return special_number1 if x.nil?
     LanguageNumber(x)
     ''
@@ -343,20 +369,20 @@ module Builtins
     publish :disconnect
   end
 
-  def __verify(*args)
-    StoryTeller::Runtime.instance.verify_game(*args)
+  def __verify(*args, &block)
+    StoryTeller::Runtime.instance.verify_game(*args, &block)
   end
 
-  def __restart(*args)
-    StoryTeller::Runtime.instance.restart_game(*args)
+  def __restart(*args, &block)
+    StoryTeller::Runtime.instance.restart_game(*args, &block)
   end
 
-  def __save(*args)
-    StoryTeller::Runtime.instance.save_game(*args)
+  def __save(*args, &block)
+    StoryTeller::Runtime.instance.save_game(*args, &block)
   end
 
-  def __restore(*args)
-    StoryTeller::Runtime.instance.restore_game(*args)
+  def __restore(*args, &block)
+    StoryTeller::Runtime.instance.restore_game(*args, &block)
   end
 
   # ----------------------------------------------------------------------------

data/lib/story_teller/engine.rb

@@ -33,7 +33,9 @@ module StoryTeller
     module Library
       def play
         log.debug "Using engine-managed InformLibrary play method override"
-        StoryTeller::Engine.library.tap(&:play)
+        runtime = StoryTeller::Runtime.instance
+        key = runtime&.player_object || Inform::Parser::SelfObj
+        StoryTeller::Engine.library(key).tap(&:play)
       end
     end
 
@@ -59,46 +61,14 @@ module StoryTeller
       @libraries ||= {}
     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)
-
-      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)
-      raise ManagedLibraryError, "InformLibrary is nil" if inform_library.nil?
-
-      selfobj = inform_library.selfobj
-      raise ManagedLibraryError, "InformLibrary selfobj is nil" if selfobj.nil?
-
-      libraries[selfobj] = inform_library
-      selfobj.inflib = inform_library if selfobj.respond_to?(:inflib=)
+    def library(key)
+      return libraries[key] if !key.nil? && libraries.key?(key)
 
+      inform_library = InformLibrary.new
+      inform_library.selfobj = key
+      key.inflib = inform_library if key.respond_to?(:inflib=)
       seed_library_location(inform_library) if location_unset?(inform_library)
-
-      inform_library
+      libraries[key] = inform_library
     end
 
     def seed_library_location(inflib)
@@ -112,10 +82,14 @@ module StoryTeller
       inflib&.instance_variable_get(:@location).nil?
     end
 
-    def parser_selfobj
-      return nil unless defined?(Inform::Parser::SelfObj)
+    def listeners
+      @listeners ||= []
+    end
 
-      Inform::Parser::SelfObj
+    def included_library(path)
+      listeners.each do |listener|
+        listener.after_library_included(path)
+      end
     end
 
     def main_object=(obj)
@@ -180,6 +154,12 @@ module StoryTeller
       StoryTeller::IO::Session.players.include?(obj)
     end
 
+    def ensure_models_ready
+      return unless defined? ObjectSetup
+
+      ObjectSetup.up if ObjectSetup.respond_to?(:up)
+    end
+
     def prime_dictionary
       Inform::Object.select_map(:name).compact.each do |n|
         Array(n).join(' ').split(/[,\s]+/).grep_v(/[^a-z]/i).map(&:downcase).map(&:to_sym).each do |word|

data/lib/story_teller/grammar_parser.rb

@@ -304,7 +304,7 @@ module Inform
       end
 
       def all(actor = nil, grammar_index = self)
-        return grammar_index.map(&:keys).flatten.sort if actor.nil?
+        return grammar_index.keys.flatten.sort if actor.nil?
         mode = role(actor)
         unless Inform::Grammar.partitions.include?(mode)
           init_all_verbs_by_mode(mode, grammar_index, actor)
@@ -335,7 +335,7 @@ module Inform
         verbs = grammar_index.each_with_object(set) do |(key, verb), memo|
           memo.add(key) unless Profanity.include?(key) || !visible_to?(verb, actor)
         end
-        Inform::Grammar.partitions[mode] = verbs.to_a
+        Inform::Grammar.partitions[mode] = verbs.to_a.sort
       end
 
       def init_verbs_filtered_by_mode(mode, grammar_index, set = verbs_set_instance)

data/lib/story_teller/inform/ephemeral/module.rb

@@ -94,7 +94,7 @@ module Inform
   # The Inform::Modular module
   module Modular
     def after_initialize
-      self.apply_modules
+      self.apply_modules!
       super
     end
 
@@ -110,7 +110,7 @@ module Inform
         add_module(Inform::Module.find_or_create(name: mod))
       end
       save
-      apply_modules
+      apply_modules!
       self
     end
 
@@ -133,7 +133,7 @@ module Inform
       modules.compact.map(&:to_s)
     end
 
-    def apply_modules(exceptions = [])
+    def apply_modules!(exceptions = [])
       nil_safe_modules.each do |module_name|
         next if exceptions.include?(module_name.to_sym)
         mod = find_module(module_name)

data/lib/story_teller/inform/ephemeral/object.rb

@@ -75,6 +75,7 @@ module Inform
         EphemeralObjects[self.identity] = self
         EphemeralObjects[@display_name.to_s] = self unless @display_name.nil?
         self.with(&block) unless block.nil?
+        log.debug "Initializing #{self}" unless textual_name.nil?
       end
       # rubocop: enable Metrics/AbcSize
       # rubocop: enable Metrics/MethodLength
@@ -174,6 +175,10 @@ module Inform
         @children << o
       end
 
+      def >(other)
+        self << other
+      end
+
       def remove
         @children.clear
         @parent = nil

data/lib/story_teller/io.rb

@@ -23,6 +23,10 @@
 module StoryTeller
   # The IO module
   module IO
+    class << self
+      attr_accessor :default_output
+    end
+
     def session
       return @session if defined?(@session) && !@session.nil?
       return nil unless defined?(StoryTeller::IO::Session)
@@ -43,13 +47,17 @@ module StoryTeller
     end
 
     def out(s)
-      if defined?(Curses)
-        Curses.addstr s
-      elsif session
-        session.write_output(s)
+      current_session = session
+      current_session ||= inflib.session if respond_to?(:inflib) && inflib
+
+      if current_session
+        current_session.write_output(s)
+      elsif StoryTeller::IO.default_output
+        StoryTeller::IO.default_output.write(s)
       else
         $stdout.write(s)
       end
+      true
     end
 
     def inform(s = '')
@@ -87,6 +95,14 @@ module StoryTeller
       out(s.to_s + "\n")
     end
 
+    def print_routine_result(value)
+      return value unless value.is_a?(String)
+
+      print value
+      new_line
+      true
+    end
+
     def output_stream(i, s); end
 
     def reset_prompt

data/lib/story_teller/kernel.rb

@@ -47,7 +47,7 @@ module Kernel
     StoryTeller::Library::Directives.Default(property, value)
   end
 
-  def Constant(property, value)
+  def Constant(property, value = nil)
     StoryTeller::Library::Directives.Constant(property, value)
   end
 
@@ -55,6 +55,18 @@ module Kernel
     StoryTeller::Library::Directives.Link(link)
   end
 
+  def Replace(subroutine_method_name)
+    StoryTeller::Library::VerbSubroutineReplacements << subroutine_method_name
+  end
+
+  def Release(release)
+    reset_constant :HDR_GAMERELEASE, release
+  end
+
+  def Serial(serial)
+    reset_constant :HDR_GAMESERIAL, serial
+  end
+
   def import_global(symbol)
     StoryTeller::Library::Directives.import_global(symbol)
   end
@@ -65,9 +77,9 @@ module Kernel
   end
 
   raise MethodAlreadyDefined, :reset_constant if respond_to?(:reset_constant)
-  def reset_constant(constant, value, target = Object)
+  def reset_constant(constant, value, target = ::Object)
     return if constant.nil?
-    silence_warnings do
+    with_warnings_silenced do
       target.instance_eval { const_set(constant.to_sym, value) }
     end
   rescue StandardError => e
@@ -77,7 +89,7 @@ module Kernel
 
   raise MethodAlreadyDefined, :toggle_constant if respond_to?(:toggle_constant)
   def toggle_constant(constant, target = ::Object)
-    silence_warnings do
+    with_warnings_silenced do
       if target.const_defined?(constant)
         target.instance_eval { remove_const(constant) }
       else
@@ -164,7 +176,7 @@ module Kernel
 
   raise MethodAlreadyDefined, :reload_feature if respond_to?(:reload_feature)
   def reload_feature(feature)
-    silence_warnings do
+    with_warnings_silenced do
       # Remove a loaded feature:
       load_service.remove_internal_loaded_feature(feature)
       # Supposedly, purge old compiled script code:
@@ -294,8 +306,8 @@ remove_method :original_rand
     new_method
   end
 
-  raise MethodAlreadyDefined, :silence_warnings if respond_to?(:silence_warnings)
-  def silence_warnings(&_block)
+  raise MethodAlreadyDefined, :with_warnings_silenced if respond_to?(:with_warnings_silenced)
+  def with_warnings_silenced
     old_verbose = $VERBOSE
     $VERBOSE = nil
     yield

data/lib/story_teller/library/directives.rb

@@ -23,6 +23,9 @@
 module StoryTeller
   # The StoryTeller::Library module
   module Library
+    class Memo < Array; end
+    VerbSubroutineReplacements = Memo.new
+
     # The StoryTeller::Library::Directives module
     module Directives
       InclusionGrammarGuessTemplate = '%<inclusion>s.h.inf.rb'.freeze
@@ -38,10 +41,12 @@ module StoryTeller
         # were ephemeral in nature.
       end
 
+      # rubocop: disable Metrics/AbcSize
+      # rubocop: disable Metrics/MethodLength
       def Include(inclusion)
-        # warn "StoryTeller::Engine.Include(#{inclusion}) from #{caller_locations(1, 5).map { |l|
-        #   "#{l.path}:#{l.lineno}"
-        # }.join(' | ')}"
+        log.debug "StoryTeller::Engine.Include(#{inclusion}) from #{caller_locations(1, 5).map do |l|
+          "#{l.path}:#{l.lineno}"
+        end.join(' | ')}"
         inclusion = StoryTeller::Engine.language_name if /^language__$/.match(inclusion)
         grammar_guess = format(InclusionGrammarGuessTemplate, inclusion: inclusion)
         guess = File.expand_path(
@@ -50,9 +55,13 @@ module StoryTeller
             StoryTeller::Engine.inform_code_prefix,
             grammar_guess))
         return StoryTeller::Library::Loader.load_grammar_by_path(guess) if File.exist?(guess)
-        StoryTeller::Library::Loader.require_first_existing(
+        loaded_path = StoryTeller::Library::Loader.require_first_existing(
           format(InclusionGuessesTemplate, inclusion: inclusion).split)
+        StoryTeller::Engine.included_library(loaded_path)
+        loaded_path
       end
+      # rubocop: enable Metrics/AbcSize
+      # rubocop: enable Metrics/MethodLength
 
       def Attribute(attribute)
         StoryTeller::Library.declarations.add_attribute(attribute)
@@ -66,19 +75,64 @@ module StoryTeller
         end
       end
 
-      def Default(property, value)
-        Constant(property, value)
+      # rubocop: disable Metrics/MethodLength
+      def Default(property, value, target = ::Object)
+        inform_name = property.to_sym
+        ruby_name = if property.to_s.match?(/\A[A-Z][A-Za-z0-9_]*\z/)
+          inform_name
+        else
+          property.to_s.upcase.to_sym
+        end
+
+        value = begin
+          target.const_get(ruby_name)
+        rescue RuntimeError => _e
+          # Ignore error
+        rescue StandardError => _e
+          # Ignore error
+        end
+
+        reset_constant(ruby_name, value, target) if value.nil?
+
+        return value if inform_name == ruby_name
+
+        install_global_reader(inform_name, ruby_name, target)
+      rescue StandardError => e
+        log.error "Unexpected error resetting default #{property}", e
+        nil
       end
+      # rubocop: enable Metrics/MethodLength
 
-      def Constant(constant, value, target = ::Object)
-        return if constant.nil?
-        silence_warnings do
-          target.instance_eval { const_set(constant.to_sym, value) }
+      # rubocop: disable Metrics/MethodLength
+      def Constant(constant, value = nil, target = ::Object)
+        inform_name = constant.to_sym
+        ruby_name = if constant.to_s.match?(/\A[A-Z][A-Za-z0-9_]*\z/)
+          inform_name
+        else
+          constant.to_s.upcase.to_sym
         end
+
+        log.debug "Setting constant #{target}.#{ruby_name} to #{value}"
+        log.debug "  inform_name: #{inform_name}"
+        reset_constant(ruby_name, value, target)
+
+        return value if inform_name == ruby_name
+
+        install_global_reader(inform_name, ruby_name, target)
       rescue StandardError => e
         log.error "Unexpected error resetting constant #{constant}", e
         nil
       end
+      # rubocop: enable Metrics/MethodLength
+
+      def install_global_reader(inform_name, ruby_name, target = ::Object)
+        reader = -> { target.target.instance_eval { const_get(ruby_name) } }
+
+        Kernel.define_method(inform_name, &reader)
+        Kernel.send(:private, inform_name)
+
+        InformLibrary.define_method(inform_name, &reader) if defined?(InformLibrary)
+      end
 
       def import_global(symbol)
         StoryTeller::Library.declarations.add_global(symbol)

data/lib/story_teller/library/loader.rb

@@ -55,9 +55,11 @@ module StoryTeller
         if File.exist?(guessed_local_file_path)
           log.debug "Loading local library file: #{guessed_local_file_path}"
           require_relative guessed_local_file_path
+          return guessed_local_file_path
         else
           log.debug "Loading library: #{guessed_file_path}"
           require guessed_file_path
+          return guessed_file_path
         end
       rescue StandardError => e
         log.error e.message

data/lib/story_teller/library/location.rb

@@ -26,7 +26,7 @@ module StoryTeller
     # module Location
     module Location
       def location
-        @player&.location || @location
+        @location
       end
 
       def location=(obj)

data/lib/story_teller/library.rb

@@ -19,7 +19,6 @@
 # You should have received a copy of the GNU General Public License
 # along with the StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
 
-require_relative 'library/bootstrap'
 require_relative 'library/declarations'
 require_relative 'library/directives'
 require_relative 'library/loader'