inform-runtime 1.4.0 → 1.6.0

data/lib/story_teller/mixins.rb

@@ -243,6 +243,34 @@ class FalseClass
   end
 end
 
+# module Inform
+module Inform
+  # module English
+  module English
+    TensNumerals = {
+      20 => 'twenty', 30 => 'thirty', 40 => 'forty', 50 => 'fifty',
+      60 => 'sixty', 70 => 'seventy', 80 => 'eighty', 90 => 'ninety'
+    }.freeze
+    EnglishNumbersLanguage = {
+      1 => 'one', 2 => 'two', 3 => 'three', 4 => 'four', 5 => 'five',
+      6 => 'six', 7 => 'seven', 8 => 'eight', 9 => 'nine', 10 => 'ten',
+      11 => 'eleven', 12 => 'twelve', 13 => 'thirteen', 14 => 'fourteen', 15 => 'fifteen',
+      16 => 'sixteen', 17 => 'seventeen', 18 => 'eighteen', 19 => 'nineteen', 20 => 'twenty'
+    }.freeze
+    OrdinalNumerals = {
+      'zero' => 'zeroth', 'one' => 'first', 'two' => 'second', 'three' => 'third',
+      'four' => 'fourth', 'five' => 'fifth', 'six' => 'sixth', 'seven' => 'seventh',
+      'eight' => 'eighth', 'nine' => 'ninth', 'ten' => 'tenth', 'eleven' => 'eleventh',
+      'twelve' => 'twelfth', 'thirteen' => 'thirteenth', 'fourteen' => 'fourteenth',
+      'fifteen' => 'fifteenth', 'sixteen' => 'sixteenth', 'seventeen' => 'seventeenth',
+      'eighteen' => 'eighteenth', 'nineteen' => 'nineteenth', 'twenty' => 'twentieth',
+      'thirty' => 'thirtieth', 'forty' => 'fortieth', 'fifty' => 'fiftieth',
+      'sixty' => 'sixtieth', 'seventy' => 'seventieth', 'eighty' => 'eightieth',
+      'ninety' => 'ninetieth'
+    }.freeze
+  end
+end
+
 # The Numeric class
 class Numeric
   def commas(delimiter = ',')
@@ -250,6 +278,69 @@ class Numeric
     parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, format(JoinedTemplate, str: '\1', other: delimiter))
     parts.join('.')
   end
+
+  def to_cardinal_numerals(language: Inform::English)
+    return self.to_s unless is_a?(Integer) && self >= 0
+    cardinal_integer(self, language)
+  end
+
+  def to_ordinal_numerals(language: Inform::English)
+    parts = decimal_numeral_parts
+    return self.to_s if parts.nil?
+
+    integer, fraction = parts
+    ordinal = ordinal_integer(integer, language)
+    return ordinal if fraction.nil?
+    "#{ordinal} point #{decimal_digits(fraction, language)}"
+  end
+
+  private
+
+  def decimal_numeral_parts
+    integer, fraction = self.to_s.split('.', 2)
+    return unless /\A[+-]?\d+\z/.match?(integer)
+    return unless fraction.nil? || /\A\d+\z/.match?(fraction)
+    [integer, fraction]
+  end
+
+  def cardinal_integer(value, language)
+    return 'zero' if value == 0
+    return language::EnglishNumbersLanguage.fetch(value) if value <= 20
+    return cardinal_under_hundred(value, language) if value < 100
+    return cardinal_under_thousand(value, language) if value < 1000
+    cardinal_thousands(value, language)
+  end
+
+  def ordinal_integer(integer, language)
+    ordinal = cardinal_integer(integer.delete_prefix('-').delete_prefix('+').to_i, language)
+    ordinal = ordinal.sub(/([a-z]+)\z/) { |word| language::OrdinalNumerals.fetch(word, "#{word}th") }
+    integer.start_with?('-') ? "minus #{ordinal}" : ordinal
+  end
+
+  def decimal_digits(fraction, language)
+    fraction.chars.map { |digit| cardinal_integer(digit.to_i, language) }.join(' ')
+  end
+
+  def cardinal_under_hundred(value, language)
+    tens, ones = value.divmod(10)
+    return language::TensNumerals.fetch(tens * 10) if ones == 0
+    "#{language::TensNumerals.fetch(tens * 10)}-#{cardinal_integer(ones, language)}"
+  end
+
+  def cardinal_under_thousand(value, language)
+    hundreds, remainder = value.divmod(100)
+    result = "#{cardinal_integer(hundreds, language)} hundred"
+    return result if remainder == 0
+    "#{result} and #{cardinal_integer(remainder, language)}"
+  end
+
+  def cardinal_thousands(value, language)
+    thousands, remainder = value.divmod(1000)
+    result = "#{cardinal_integer(thousands, language)} thousand"
+    return result if remainder == 0
+    separator = remainder < 100 ? ' and ' : ', '
+    "#{result}#{separator}#{cardinal_integer(remainder, language)}"
+  end
 end
 
 # The Integer class
@@ -493,6 +584,10 @@ class Array
     end
   end
 
+  def second
+    self[1]
+  end
+
   def to_sentence(conjunction = 'and')
     case length
     when 0 then ''

data/lib/story_teller/prototype.rb

@@ -27,6 +27,12 @@ module Inform
       Thread.current[:event]
     end
 
+    def inflib
+      return @inflib unless @inflib.nil?
+
+      context_event&.cause
+    end
+
     def instance_variables_map
       instance_variables.each_with_object({}) do |key, memo|
         memo[key] = instance_variable_get(key)
@@ -134,8 +140,8 @@ module Inform
       frame = [object_id, method]
 
       if stack.include?(frame)
-        raise NoMethodError, "Aborting Prototypical missing method " \
-          "resolution #{self.class}##{method} on #{inspect}"
+        raise NoMethodError, "Aborting Prototypical missing method resolution " +
+          "#{self.class}##{method} on #{inspect}"
       end
 
       stack << frame
@@ -366,18 +372,18 @@ module Inform
       elsif values.first.nil? && self.respond_to?(:_key?) && self._key?(key)
         result = self._unset_object(key) if self.respond_to?(:_unset_object)
       elsif values.first.nil?
-        self.will_change_column(:properties) if self.respond_to?(:will_change_column)
         self.properties.delete(property_key_for(key))
+        self.modified!(:properties) if self.respond_to?(:modified!)
         self.save_changes if self.respond_to?(:save_changes)
       elsif values.length > 1
-        self.will_change_column(:properties) if self.respond_to?(:will_change_column)
         self.properties[key] = []
         self.properties[key].concat(values)
         values.clear
+        self.modified!(:properties) if self.respond_to?(:modified!)
         self.save_changes if self.respond_to?(:save_changes)
       else
-        self.will_change_column(:properties) if self.respond_to?(:will_change_column)
         self.properties[key] = values.first
+        self.modified!(:properties) if self.respond_to?(:modified!)
         self.save_changes if self.respond_to?(:save_changes)
       end
       result || self.properties.dup[property_key_for(key)]

data/lib/story_teller/session.rb

@@ -181,10 +181,11 @@ class Session
     include SessionManagementMethods
   end
   attr_accessor :channel, :machine, :player, :state, :status
-  attr_reader :last_good_state, :last_activity, :previous, :inbound, :outbound, :settings
+  attr_reader :last_good_state, :last_activity, :previous, :inbound, :outbound, :settings, :output
 
   # These states accept any input, including no input
   Promiscuous = Set.new
+  class BadStateError < StandardError; end
 
   # rubocop: disable Metrics/MethodLength
   def initialize(channel = nil, machine: nil, player: nil, state: :playing, settings: {})
@@ -197,7 +198,7 @@ class Session
     @settings = settings
     @status = nil
     @last_activity = Time.now
-    @outbound = OutputBuffer.new
+    self.output = OutputBuffer.new
 
     self.class.register(channel, self) unless channel.nil?
     control(player) unless player.nil?
@@ -206,8 +207,13 @@ class Session
 
   alias preferences settings
 
+  def output=(sink)
+    @output = sink
+    @outbound = sink
+  end
+
   def write_output(value)
-    @outbound.write(value)
+    @output.write(value)
   end
 
   def drain_output
@@ -221,7 +227,6 @@ class Session
     columns = columns.to_i
     return output if columns <= 0
 
-    # output = output.gsub(/^\n+/, "\n")
     output.each_line.map do |line|
       newline = line.end_with?("\n") ? "\n" : ''
       wrap_line(line.chomp, columns) + newline
@@ -268,14 +273,6 @@ class Session
     @outbound.reset
   end
 
-  def init_channel_session(channel)
-    Session[channel] = self
-    @channel = channel
-    @inbound = Inbound.new(self) if defined?(Inbound)
-    @outbound = OutputBuffer.new
-    @last_activity = Time.now
-  end
-
   def control(player)
     self.class.release_player(@player, self)
     @player = player
@@ -336,8 +333,11 @@ class Session
     drain_output
   end
 
-  def safely_progress(machine = self)
-    @state = machine.public_send(@state)
+  # def safely_progress(machine = self, state = machine.public_send(@state))
+  def safely_progress(machine = self, state = nil)
+    state ||= machine.public_send(@state)
+    raise BadStateError, "Bad state: #{state}" unless state.is_a? Symbol
+    @state = state
     raise 'Bad state machine implementation: nil state' if @state.nil?
   rescue StandardError => e
     log.error "Error updating state: #{e.message}", e

data/lib/story_teller/stdlib.rb

@@ -21,6 +21,8 @@
 
 require_relative 'version'
 
+VN_1610 = '1610'.freeze
+
 # The Inform module
 module Inform
   # Support WriteListFrom implementations that prefer to skip animate objects
@@ -114,13 +116,13 @@ module StdLib
   end
 
   def location
-    @player.location
+    @location
   end
 
   def location=(o)
     log.warn "Trying to set the location directly"
     log.warn caller[1] and abort
-    @player.location = o
+    @location = @player.location = o
   end
 
   def area
@@ -145,10 +147,6 @@ module StdLib
     false
   end
 
-  def DisplayStatus
-    false
-  end
-
   def Message(*args)
     println(args[:fatalerror] || args.values.first)
   end
@@ -187,6 +185,7 @@ module StdLib
       ctx.results[2],
       ctx.results[3]
     ]
+    ctx.player = player
     ctx.actor = player
     ctx.special_number1 = ctx.special_number2 = nil
     ctx.special_number1 = ctx.results[2] if ctx.results[2].number?
@@ -202,50 +201,80 @@ module StdLib
   # rubocop: enable Metrics/AbcSize
   # rubocop: enable Metrics/MethodLength
 
-  # The invoke method executes without prompting afterward
+  # The perform_action method causes the given action to be executed
+  # while intending that the original action routine resumes
+  # execution where perform_action was called.
+  #
+  # The perform_action method executes without prompting afterward
   # but appends the output to the contextual event's buffer
   # which will be displayed upon completion of the contextual
   # event.
   #
+  # See: https://inform-fiction.org/manual/html/s6.html
+  #
   # TODO: Test: Does this mean that invoke must always be executed
   # within an event context to have its output displayed?
   # !rubocop: disable Metrics/AbcSize
-  def invoke(action, *args)
+  def perform_action(action, *args)
     raise "The action parameter may not be nil" if action.nil?
 
     # log.debug 'Invocation: ' + name(@player) + ' <' + action + (args.empty? ? '' : ' ') + args.to_s + '>'
     ctx = invocation_context(action, *args)
+
+    Inform::Context.get.members.each do |attr|
+      instance_variable_set("@#{attr}", ctx.send(attr))
+    end
+
     immediately(ctx) do
-      if BeforeRoutines(action) == false
-        send(VerbRoutine(action))
-      end
+    # elementally(ctx) do
+      R_Process(action, args.first, args.second)
     end
   end
   # !rubocop: enable Metrics/AbcSize
-
-  # Under invoke execute a routine but tries to prevent
-  # any output at all and does not provide other objects
-  # the opportunity to react to the action, like invoke
-  # does, above.
+  alias invoke perform_action
+
+  # Divert from the current action to the given action, and
+  # return true. The invoking routine method is also expected
+  # to also immediately return true, to maintain fidelity to
+  # the original Inform 6 functionality.  (Unfortunately, there
+  # is no way to implement this in Ruby, so every place where
+  # divert_to_action is called will have to return on its own.)
   #
   # This should be used to cause an action outcome during
   # the execution of another Verb action subroutine.  It
   # should appear as if the invoked action is part of the
   # original action.
+  #
+  # The Inform 6 designer's manual explains using the example of
+  # a "steps" object which defines a before Search rule, so that
+  # the statement <<Enter self>> will generate the action Enter
+  # steps instead, and return true to stop the original Search
+  # action from going any further. The net effect is that one
+  # action has been diverted into another.
+  #
+  # See: https://inform-fiction.org/manual/html/s6.html
+  #
   # !rubocop: disable Metrics/AbcSize
-  def _invoke(action, *args)
+  def divert_to_action(action, *args)
     raise "The action parameter may not be nil" if action.nil?
 
-    # log.debug 'Invocation: ' + name(@player) + ' <<' + action + (args.empty? ? '' : ' ') + args.to_s + '>>'
+    # log.debug 'Diverting to action: ' + name(@player) + ' <<' + action + (args.empty? ? '' : ' ') + args.to_s + '>>'
+    perform_action(action, *args)
+    true
+  end
+  alias _invoke divert_to_action
+  # !rubocop: enable Metrics/AbcSize
+
+  # TODO: Testme (2026-09-13)
+  # It's unclear if this method is needed, but if it is, it is
+  # almost certainly only required within a multiplayer realtime
+  # context.
+  def proxy(action, *args)
     ctx = invocation_context(action, *args)
-    elementally(ctx) do
-      silently do
-        send(VerbRoutine(action))
-      end
+    immediately(ctx) do
+      perform_action(action, *args)
     end
   end
-  # !rubocop: enable Metrics/AbcSize
-  alias silently_invoke _invoke
 
   # rubocop: disable Metrics/AbcSize
   # rubocop: disable Metrics/CyclomaticComplexity
@@ -321,7 +350,7 @@ module StdLib
     return false unless ReactionHandlers.include?(prop)
     # TODO: Only apply Behavior modules if object is not being controlled
     # by a player.
-    obj.apply_modules if obj.respond_to?(:apply_modules)
+    obj.apply_modules! if obj.respond_to?(:apply_modules!)
     si = obj.inflib
     obj.inflib = self
 
@@ -452,6 +481,16 @@ module StdLib
   # rubocop: enable Metrics/CyclomaticComplexity
   # rubocop: enable Metrics/PerceivedComplexity
   # rubocop: enable Style/ReturnNilInPredicateMethodDefinition
+
+  def parser_error(e, message)
+    log.error "Error parsing user command: #{e.class}: #{e}"
+    e.backtrace.each { |t| log.error t }
+    log.error "  parser: #{self.identity}"
+    log.error "  input: #{@input}"
+    log.error "  actor: #{@actor}"
+    log.error "  action: #{@action}"
+    message
+  end
 end
 # module StdLib
 
@@ -651,7 +690,7 @@ module Rules
 
   # rubocop: disable Metrics/MethodLength
   def yesorno?
-    reset_io # TODO: Remove this. Why is the buffer getting a newline character added to it?
+    # 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)

data/lib/story_teller/version.rb

@@ -23,12 +23,11 @@
 module StoryTeller
   # module Engine
   module Engine
-    VERSION = '1.4.0'.freeze
+    VERSION = '1.6.0'.freeze
   end
 end
 
 # module Inform
 module Inform
   VERSION = StoryTeller::Engine::VERSION
-  VN_1610 = '1610'.freeze
 end

data/lib/story_teller/world_tree.rb

@@ -21,7 +21,6 @@
 
 require_relative 'inform/models'
 require_relative 'tree'
-require_relative 'daemon'
 
 # module Inform
 module Inform
@@ -34,7 +33,6 @@ module Inform
       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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inform-runtime
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Nels Nelson
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +95,6 @@ files:
 - lib/story_teller/color.rb
 - lib/story_teller/command.rb
 - lib/story_teller/context.rb
-- lib/story_teller/daemon.rb
 - lib/story_teller/engine.rb
 - lib/story_teller/events.rb
 - lib/story_teller/experimental/handler_dsl.rb
@@ -112,7 +111,6 @@ files:
 - lib/story_teller/io.rb
 - lib/story_teller/kernel.rb
 - lib/story_teller/library.rb
-- lib/story_teller/library/bootstrap.rb
 - lib/story_teller/library/declarations.rb
 - lib/story_teller/library/directives.rb
 - lib/story_teller/library/loader.rb
@@ -150,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 4.0.17
 specification_version: 4
 summary: StoryTeller Engine for Ruby.
 test_files: []