inform-runtime 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a9737a28a03ce80dd3698d1fc2824b22cb3090d4f0db6c3b52c84134e17a04c
-  data.tar.gz: 30ea465986dd84a628280ffa63c83228e04689db657d26c1bf449a15a779165a
+  metadata.gz: 474087cc0143425969470924c1fe5e944b06f2d17ee76a097551345c4ca1959e
+  data.tar.gz: 8f933a9f47d17a247d804d226a32f8ff7d57e38698d0b0a262e40a796efd7972
 SHA512:
-  metadata.gz: f0f82b48842ed1cb74515abf3e26d2aeadc1c29004177a556e819ff814c3ce7ee63cf8b4225f5a53a3bfa8102c6bfa2ad0a21ad4b2654518269535c9fc3eca0f
-  data.tar.gz: e6122d69fc1a5fbbe2640709f567889a7d70d303740796883bec8ffb3001abd243b91597c02f12a7d31e9aac61de7e08b288cd648c9f784140e935279a2fb085
+  metadata.gz: 606603f0fa1048e8cf566204167646989a99b1fcc80746ec3c8a7490d737ced8cdfb09be0e0cc7b0674123ed96b8588b387f6ed010328963c700816c172167a1
+  data.tar.gz: 3bab288d8358fcf11ca366756a1e451f3cfab0b231aa7e35d144397b4cba04257b1a92f2406581611628c03521d986db01aa32501818fe059f85f439d2a34370

data/lib/story_teller/engine.rb

@@ -43,7 +43,6 @@ 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 ' \
@@ -60,16 +59,6 @@ module StoryTeller
       @libraries ||= {}
     end
 
-    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
@@ -107,26 +96,21 @@ module StoryTeller
       libraries[selfobj] = inform_library
       selfobj.inflib = inform_library if selfobj.respond_to?(:inflib=)
 
-      ensure_player_location(inform_library) if persist_player_location?
+      seed_library_location(inform_library) if location_unset?(inform_library)
 
       inform_library
     end
 
-    # 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)
-      return unless existing_location.nil?
-
-      player = inflib.selfobj
-      location = player.location if player.respond_to?(:location)
-      location ||= player.spawn_point if player.respond_to?(:spawn_point)
+    def seed_library_location(inflib)
+      player_obj = inflib.selfobj
+      location = player_obj.location if player_obj.respond_to?(:location)
 
       inflib.instance_variable_set(:@location, location) unless location.nil?
     end
-    # rubocop: enable Metrics/CyclomaticComplexity
+
+    def location_unset?(inflib)
+      inflib&.instance_variable_get(:@location).nil?
+    end
 
     def parser_selfobj
       return nil unless defined?(Inform::Parser::SelfObj)

data/lib/story_teller/grammar_parser.rb

@@ -362,6 +362,10 @@ module Inform
             !StoryTeller::Privileges.privileged?(obj, :builder))
       end
 
+      def visible_to?(verb, actor)
+        verb.grammars.any? { |grammar| !guarded?(grammar, actor) }
+      end
+
       def role(obj)
         return :admin if StoryTeller::Privileges.privileged?(obj, :admin)
         return :builder if StoryTeller::Privileges.privileged?(obj, :builder)

data/lib/story_teller/io.rb

@@ -27,7 +27,9 @@ module StoryTeller
       return @session if defined?(@session) && !@session.nil?
       return nil unless defined?(StoryTeller::IO::Session)
 
-      StoryTeller::IO::Session.of(self)
+      StoryTeller::IO::Session.of(self).tap do |session|
+        log.trace "self: #{self}, session: #{session.inspect}"
+      end
     end
 
     def noop; end
@@ -40,13 +42,11 @@ module StoryTeller
       subscribed_connections
     end
 
-    def read
-      $stdin.gets(chomp: true)
-    end
-
     def out(s)
       if defined?(Curses)
         Curses.addstr s
+      elsif session
+        session.write_output(s)
       else
         $stdout.write(s)
       end
@@ -64,13 +64,9 @@ module StoryTeller
     alias update inform
 
     def flush_io
-      $stdout.flush
-    end
+      return if session
 
-    def tidy_output(s, columns = 76)
-      s.gsub!(/^\n+/, "\n")
-      return s if s.length < columns || columns == 0
-      s.gsub(/(.{#{columns}}\S+)( +|$\n?)/, "\\1\n")
+      $stdout.flush
     end
 
     def new_line
@@ -128,59 +124,6 @@ module StoryTeller
       DefaultLineLength
     end
 
-    # def many_per_line(items)
-    #   max = 0
-
-    #   lines = []
-    #   prefs = @player.linkto :preferences
-    #   line_length = preferred_line_length
-    #   buffer = ''
-
-    #   items.each do |item|
-    #     max = [item.length, max].max
-    #   end
-    #   max += MinimumColumnPadding
-    #   width = (line_length - MinimumCellPadding) / max
-    #   height = (items.length / width).ceil - 1
-
-    #   return if width == 0
-
-    #   columns = []
-    #   i = 0
-    #   loop do
-    #     # Build a list of columns with nil padding
-    #     column = items[i, height]
-    #     columns << column + Array.new(height - column.length)
-    #     i += height
-    #     break if (i + height) >= (items.length + height)
-    #   end
-
-    #   m = []
-    #   loop do
-    #     m << []
-    #     for column in columns
-    #       m.last << column.shift
-    #     end
-    #     break if columns.last.empty?
-    #   end
-
-    #   m.each do |row|
-    #     buffer = "\e[51m"
-    #     row.each do |item|
-    #       next unless item
-    #       n = [max - item.length, MinimumColumnPadding].max
-    #       padding = " " * n unless item == row.last
-    #       buffer += format(ItemPaddingString, item: item, padding: padding)
-    #     end
-    #     buffer += "\e[56m"
-    #     lines << buffer.strip
-    #     buffer = ''
-    #   end
-
-    #   lines
-    # end
-    # # def many_per_line
-
     # rubocop: disable Metrics/AbcSize
     # rubocop: disable Metrics/CyclomaticComplexity
     # rubocop: disable Metrics/MethodLength

data/lib/story_teller/library/bootstrap.rb

@@ -38,7 +38,6 @@ module StoryTeller
         inflib = InformLibrary.new
         bind_inform_library(inflib, player)
         inflib.subscribe(inflib.selfobj)
-        ensure_player_location(inflib) if StoryTeller::Engine.persist_player_location?
         inflib
       end
     end

data/lib/story_teller/library/location.rb

@@ -26,17 +26,11 @@ module StoryTeller
     # module Location
     module Location
       def location
-        return @location unless StoryTeller::Engine.persist_player_location?
-
         @player&.location || @location
       end
 
       def location=(obj)
-        if StoryTeller::Engine.persist_player_location?
-          @player.location = obj
-        else
-          @location = obj
-        end
+        @player.location = @location = obj
       end
     end
 

data/lib/story_teller/library.rb

@@ -65,7 +65,6 @@ module StoryTeller
         library_methods.merge(mod.instance_methods(false))
       end
       @methods_index.concat(library_methods.to_a).sort
-      log.trace "Loaded library methods: #{@methods_index}"
     end
     # rubocop: enable Metrics/AbcSize
     # rubocop: enable Metrics/MethodLength

data/lib/story_teller/session.rb

@@ -144,6 +144,33 @@ end
 module StoryTeller
 # module IO
 module IO
+# The OutputBuffer class
+class OutputBuffer
+  def initialize
+    @content = String.new # rubocop: disable Style/EmptyLiteral
+    @mutex = Mutex.new
+  end
+
+  def write(value)
+    return if value.nil?
+
+    @mutex.synchronize { @content << value.to_s }
+  end
+
+  def drain
+    @mutex.synchronize do
+      content = @content.dup
+      @content.clear
+      content.strip.length.positive? ? content : ''
+    end
+  end
+
+  def reset
+    @mutex.synchronize { @content.clear }
+  end
+end
+# class OutputBuffer
+
 # The Session class
 # TODO: Refactor method implementations into modules
 # rubocop: disable Metrics/ClassLength
@@ -170,6 +197,7 @@ class Session
     @settings = settings
     @status = nil
     @last_activity = Time.now
+    @outbound = OutputBuffer.new
 
     self.class.register(channel, self) unless channel.nil?
     control(player) unless player.nil?
@@ -178,11 +206,73 @@ class Session
 
   alias preferences settings
 
+  def write_output(value)
+    @outbound.write(value)
+  end
+
+  def drain_output
+    tidy_output(@outbound.drain)
+  end
+
+  def tidy_output(value, columns = word_wrap_column)
+    output = value.to_s
+    return '' if output.empty?
+
+    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
+    end.join
+  end
+
+  # rubocop: disable Metrics/AbcSize
+  # rubocop: disable Metrics/MethodLength
+  def wrap_line(line, columns)
+    return line if line.length <= columns
+
+    indentation = line[/\A[ \t]*/].to_s
+    words = line.strip.split(/[ \t]+/)
+    return line if words.empty?
+
+    lines = []
+    current = indentation.dup
+
+    words.each do |word|
+      candidate = current == indentation ? "#{current}#{word}" : "#{current} #{word}"
+
+      if candidate.length <= columns || current == indentation
+        current = candidate
+      else
+        lines << current.rstrip
+        current = "#{indentation}#{word}"
+      end
+    end
+
+    lines << current.rstrip
+    lines.join("\n")
+  end
+  # rubocop: enable Metrics/AbcSize
+  # rubocop: enable Metrics/MethodLength
+
+  def word_wrap_column
+    value = preferences[:word_wrap]
+    return 76 if value.nil?
+
+    value.to_i
+  end
+
+  def reset_output
+    @outbound.reset
+  end
+
   def init_channel_session(channel)
     Session[channel] = self
     @channel = channel
-    @inbound = Inbound.new(self)
-    @outbound = Outbound.new(self)
+    @inbound = Inbound.new(self) if defined?(Inbound)
+    @outbound = OutputBuffer.new
     @last_activity = Time.now
   end
 
@@ -230,7 +320,7 @@ class Session
   end
 
   def process(message, machine = @machine)
-    raise ArgumentError, 'session machine is required' if machine.nil?
+    raise ArgumentError, 'Session machine is required' if machine.nil?
 
     @machine = machine
     @buffer = sanitize(message)
@@ -239,10 +329,11 @@ class Session
 
     expose_to(machine)
     update(machine)
+    drain_output
   end
 
   def respond
-    flush_io
+    drain_output
   end
 
   def safely_progress(machine = self)

data/lib/story_teller/stdlib.rb

@@ -49,7 +49,7 @@ module StdLib
   end
 
   def inversion
-    print Inform::VERSION
+    print Inform::VERSION.dup
   end
 
   def standard_interpreter
@@ -764,6 +764,10 @@ module Rules
     page_index: 0, limit: 10, help: nil, done: :playing
   }.freeze
 
+  MORE_HELP_STRING = "Press Enter to show the next page.\n" +
+    "Type q or quit to stop paging and return to the command prompt.\n" +
+    "Type ? to show this help."
+
   # This method supports the MoreSub verb implementation.
   # rubocop: disable Metrics/AbcSize
   # rubocop: disable Metrics/CyclomaticComplexity
@@ -788,7 +792,7 @@ module Rules
 
     case input
     when /\?/
-      println params[:help] || "<Help for More goes here>"
+      println params[:help] || MORE_HELP_STRING
     when /^(q|quit)$/
       @more = nil
       @prompt = nil
@@ -816,7 +820,6 @@ module Rules
       session.state = :more
     else
       new_line
-      prompt nil
       session.state = params[:done]
     end
   end

data/lib/story_teller/version.rb

@@ -23,7 +23,7 @@
 module StoryTeller
   # module Engine
   module Engine
-    VERSION = '1.3.1'.freeze
+    VERSION = '1.4.0'.freeze
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inform-runtime
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Nels Nelson