inform-runtime 1.2.2 → 1.3.1

data/lib/story_teller/stdlib.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.
 #
@@ -21,6 +21,16 @@
 
 require_relative 'version'
 
+# The Inform module
+module Inform
+  # Support WriteListFrom implementations that prefer to skip animate objects
+  NONANIMATE_BIT = 0x8000 unless defined?(NONANIMATE_BIT) # 32_768
+  # Support WriteListFrom implementations that color animate objects
+  COLORANIMATE_BIT = 0x1_0000 unless defined?(COLORANIMATE_BIT) # 65_536
+  # Support WriteListFrom implementations that prefer to skip door objects
+  NONDOOR_BIT = 0x2_0000 unless defined?(NONDOOR_BIT) # 131_072
+end
+
 # The Inform module
 module Inform
 # These are built-ins primarily found used in the InformLibrary.
@@ -432,7 +442,7 @@ module StdLib
     # appropriate.
     nil # false
   rescue StandardError => e
-    log.error "Error getting reaction from #{obj}", e
+    log.error "Error getting reaction from #{obj.identity}", e
     e.backtrace.each { |t| log.error t }
   ensure
     obj.inflib = si
@@ -606,3 +616,223 @@ end
 # module StdLib
 end
 # module Inform
+
+# The Inform module
+module Inform
+# The Rules module defines functional additions to the Session state
+# machine. The additional functionality supports user interface patterns
+# commonly found in interactive fiction games, specifically those created
+# using Inform.  Supporting the principle of least surprise mandates that
+# the expectations held by the users of such games should be satisfied.
+# TODO: Perhaps this should go in the mudlib
+module Rules
+  def ask(s = nil)
+    println s if s.is_a?(String)
+    if session
+      @previous ||= session.state
+      session.state = :asked
+    end
+    # true
+    session.state
+  end
+
+  def yesorno(s = nil)
+    print s.to_s unless s.nil? # rubocop: disable Lint/RedundantStringCoercion
+    unless session.nil?
+      @previous ||= session.state
+      session.state = :asked
+    end
+    session&.state || false
+  end
+
+  def asked
+    yesorno?
+  end
+
+  # rubocop: disable Metrics/MethodLength
+  def yesorno?
+    reset_io # TODO: Remove this. Why is the buffer getting a newline character added to it?
+    case @buffer.split.first
+    when /^(y|yes)$/i
+      println(resume)
+      responded
+    when /^(n|no)$/i
+      prompt
+      responded
+    else
+      L__M(:Quit, 1); print "> "
+      session&.state
+    end
+  end
+  # rubocop: enable Metrics/MethodLength
+
+  def disambiguate
+    session.state = :disambiguating unless session.nil?
+    false
+  end
+
+  def disambiguating
+    WhichOne() if @ambiguity
+    session.state = :playing unless session.nil?
+  end
+
+  def complete
+    session.state = :completing unless session.nil?
+    false
+  end
+
+  def completing
+    Incomplete() if @ambiguity
+    session.state = :playing unless session.nil?
+  end
+
+  SolicitedStates = %i[asked yesorno? solicited].freeze
+  def solicit(s = nil)
+    if !session.nil? && !SolicitedStates.include?(session.state)
+      prompt s if s.is_a?(String)
+      @previous ||= session.state
+    end
+    session.state = :solicited unless session.nil?
+  end
+
+  def disambiguated
+    session.state = :playing unless session.nil?
+    queue @input
+  end
+
+  def completed
+    session.state = :playing unless session.nil?
+    queue @input
+  end
+
+  def solicited
+    responded? @input
+  end
+
+  def responded
+    session&.state = previous_state = @previous
+    @previous = nil
+    session&.state || previous_state
+  end
+
+  def asked?
+    session&.state == :asked
+  end
+
+  def disambiguating?
+    session&.state == :disambiguating
+  end
+
+  def completing?
+    session&.state == :completing
+  end
+
+  def solicited?
+    session&.state == :solicited
+  end
+
+  # rubocop: disable Metrics/MethodLength
+  def responded?(_s)
+    reset_io # TODO: Remove this. Why is the buffer getting a newline character added to it?
+    if @buffer.empty?
+      prompt
+    else
+      responded
+      @consult_words = @input = @buffer.dup
+      result = resume
+      println(result)
+      if result == :playing
+        reset_prompt
+        prompt
+      end
+    end
+    session&.state
+  end
+  # rubocop: enable Metrics/MethodLength
+end
+# module Rules
+end
+# module Inform
+
+# module Inform
+module Inform
+# module Rules
+module Rules
+  More = Struct.new(:text, :page_index)
+
+  DefaultMoreParameters = {
+    page_index: 0, limit: 10, help: nil, done: :playing
+  }.freeze
+
+  # This method supports the MoreSub verb implementation.
+  # rubocop: disable Metrics/AbcSize
+  # rubocop: disable Metrics/CyclomaticComplexity
+  # rubocop: disable Metrics/MethodLength
+  # rubocop: disable Metrics/PerceivedComplexity
+  def more(text = nil, params = {})
+    params = DefaultMoreParameters.merge(params)
+    text = more_lines(text) unless text.nil?
+
+    if session.nil?
+      println text
+      return params[:done]
+    end
+    input = @buffer.dup
+    @more ||= More.new([], params[:page_index])
+
+    if text
+      @more.text = text
+    else
+      text = @more.text
+    end
+
+    case input
+    when /\?/
+      println params[:help] || "<Help for More goes here>"
+    when /^(q|quit)$/
+      @more = nil
+      @prompt = nil
+      return session.state = params[:done]
+    else
+      text = @more.text.lines(chomp: true) if @more.text.is_a? String
+      unless text.is_a?(Array)
+        println "[Error: Format problem using the more command -- cannot handle given text.]"
+        return session.state = params[:done]
+      end
+
+      println text[@more.page_index, params[:limit]].join("\n")
+
+      @more.page_index += params[:limit]
+    end
+
+    percent_complete = [100, (100 * (@more.page_index.to_f / text.length)).floor].min
+    @more = nil unless @more.page_index < @more.text.length
+
+    new_line
+    print "--More--(#{percent_complete}%)"
+
+    if percent_complete < 100
+      prompt " [?]: "
+      session.state = :more
+    else
+      new_line
+      prompt nil
+      session.state = params[:done]
+    end
+  end
+  # def more
+  # rubocop: enable Metrics/AbcSize
+  # rubocop: enable Metrics/CyclomaticComplexity
+  # rubocop: enable Metrics/MethodLength
+  # rubocop: enable Metrics/PerceivedComplexity
+
+  def more_lines(text)
+    return text if text.is_a?(Array)
+    return text.lines(chomp: true) if text.is_a?(String)
+
+    nil
+  end
+end
+# module Rules
+end
+# module Inform

data/lib/story_teller/subscription.rb

@@ -1,7 +1,8 @@
+# lib/story_teller/subscription.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/tree.rb

@@ -1,7 +1,8 @@
+# lib/story_teller/tree.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/version.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.
 #
@@ -23,7 +23,7 @@
 module StoryTeller
   # module Engine
   module Engine
-    VERSION = '1.2.2'.freeze
+    VERSION = '1.3.1'.freeze
   end
 end
 

data/lib/story_teller/world_tree.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.
 #
@@ -19,24 +19,30 @@
 # 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 'inform/models'
 require_relative 'tree'
 require_relative 'daemon'
 
-# class Object
+# module Inform
 module Inform
-  # class Object
-  class Object
-    include StoryTeller::Builtins
-    include StoryTeller::IO if defined?(StoryTeller::IO)
-    include StoryTeller::Publisher if defined?(StoryTeller::Publisher)
-    include StoryTeller::Daemons if defined?(StoryTeller::Daemons)
-    include Inform::Context if defined?(Inform::Context)
-    include Inform::Events if defined?(Inform::Events)
-    include Inform::Prototypical if defined?(Inform::Prototypical)
-    include Inform::Linkable if defined?(Inform::Linkable)
-    include Inform::Taggable if defined?(Inform::Taggable)
-    include Inform::Modular if defined?(Inform::Modular)
-    include Inform::Genealogical if defined?(Inform::Genealogical)
+  include StoryTeller::Builtins unless include?(StoryTeller::Builtins)
+
+  # module Ephemeral
+  module Ephemeral
+    # class Object
+    class Object
+      include StoryTeller::Builtins
+      include StoryTeller::IO if defined?(StoryTeller::IO)
+      include StoryTeller::Publisher if defined?(StoryTeller::Publisher)
+      include StoryTeller::Daemons if defined?(StoryTeller::Daemons)
+      include Inform::Context if defined?(Inform::Context)
+      include Inform::Events if defined?(Inform::Events)
+      include Inform::Prototypical if defined?(Inform::Prototypical)
+      prepend Inform::Linkable if defined?(Inform::Linkable)
+      include Inform::Taggable if defined?(Inform::Taggable)
+      include Inform::Modular if defined?(Inform::Modular)
+      include Inform::Genealogical if defined?(Inform::Genealogical)
+    end
   end
 
   # class Event
@@ -44,11 +50,3 @@ module Inform
     include StoryTeller::Publisher
   end
 end
-
-# The ExtendedProperties class
-class ExtendedProperties < Inform::Object
-  def init
-    has :proper
-    super
-  end
-end

data/lib/story_teller.rb

@@ -19,8 +19,21 @@
 # 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 'story_teller/inform/base'
-require_relative 'story_teller/model_adapter'
-require_relative 'story_teller/inform/models'
-require_relative 'story_teller/ephemeral_adapter'
-require_relative 'story_teller/core'
+require_relative 'story_teller/builtins'
+require_relative 'story_teller/stdlib'
+require_relative 'story_teller/logging'
+require_relative 'story_teller/prototype'
+require_relative 'story_teller/command'
+require_relative 'story_teller/history'
+require_relative 'story_teller/events'
+require_relative 'story_teller/grammar_parser'
+require_relative 'story_teller/kernel'
+require_relative 'story_teller/mixins'
+require_relative 'story_teller/helpers'
+require_relative 'story_teller/io'
+require_relative 'story_teller/publication'
+require_relative 'story_teller/context'
+require_relative 'story_teller/privileges'
+require_relative 'story_teller/world_tree'
+require_relative 'story_teller/library'
+require_relative 'story_teller/engine'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inform-runtime
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.1
 platform: ruby
 authors:
 - Nels Nelson
@@ -29,28 +29,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 4.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 4.1.2
 - !ruby/object:Gem::Dependency
   name: inform6lib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -95,10 +95,8 @@ files:
 - lib/story_teller/color.rb
 - lib/story_teller/command.rb
 - lib/story_teller/context.rb
-- lib/story_teller/core.rb
 - lib/story_teller/daemon.rb
 - lib/story_teller/engine.rb
-- lib/story_teller/ephemeral_adapter.rb
 - lib/story_teller/events.rb
 - lib/story_teller/experimental/handler_dsl.rb
 - lib/story_teller/experimental/reverse_engineer_class.rb
@@ -106,7 +104,6 @@ files:
 - lib/story_teller/helpers.rb
 - lib/story_teller/history.rb
 - lib/story_teller/inflector.rb
-- lib/story_teller/inform/base.rb
 - lib/story_teller/inform/ephemeral/link.rb
 - lib/story_teller/inform/ephemeral/module.rb
 - lib/story_teller/inform/ephemeral/object.rb
@@ -122,8 +119,8 @@ files:
 - lib/story_teller/library/location.rb
 - lib/story_teller/logging.rb
 - lib/story_teller/mixins.rb
-- lib/story_teller/model_adapter.rb
 - lib/story_teller/plurals.rb
+- lib/story_teller/privileges.rb
 - lib/story_teller/prototype.rb
 - lib/story_teller/publication.rb
 - lib/story_teller/session.rb
@@ -153,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.9
+rubygems_version: 4.0.11
 specification_version: 4
 summary: StoryTeller Engine for Ruby.
 test_files: []

data/lib/story_teller/core.rb

@@ -1,38 +0,0 @@
-# lib/story_teller/core.rb
-# encoding: utf-8
-# frozen_string_literal: false
-
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
-#
-# This file is part of the StoryTeller.
-#
-# The StoryTeller is free software: you can redistribute it and/or
-# modify it under the terms of the GNU General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# The StoryTeller is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# 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 'builtins'
-require_relative 'stdlib'
-require_relative 'logging'
-require_relative 'prototype'
-require_relative 'command'
-require_relative 'history'
-require_relative 'events'
-require_relative 'grammar_parser'
-require_relative 'kernel'
-require_relative 'mixins'
-require_relative 'helpers'
-require_relative 'io'
-require_relative 'publication'
-require_relative 'context'
-require_relative 'world_tree'
-require_relative 'library'
-require_relative 'engine'

data/lib/story_teller/ephemeral_adapter.rb

@@ -1,40 +0,0 @@
-# lib/story_teller/ephemeral_adapter.rb
-# encoding: utf-8
-# frozen_string_literal: false
-
-# Copyright Nels Nelson 2008-2025 but freely usable (see license)
-#
-# This file is part of StoryTeller.
-#
-# StoryTeller is free software: you can redistribute it and/or
-# modify it under the terms of the GNU General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# StoryTeller is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
-
-# module StoryTeller
-module StoryTeller
-  # module EphemeralAdapter
-  module EphemeralAdapter
-    Adapter = {
-      name: :ephemeral,
-      object_class: Inform::Ephemeral::Object,
-      tag_class: Inform::Ephemeral::Tag,
-      link_class: Inform::Ephemeral::Link,
-      module_class: Inform::Ephemeral::Module
-    }.freeze
-
-    module_function
-
-    def register!
-      StoryTeller::ModelAdapter.register!(Adapter)
-    end
-  end
-end