inform-runtime 1.0.4 → 1.2.0

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

@@ -0,0 +1,329 @@
+# lib/story_teller/object.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/>.
+
+# Object
+
+# def Object(name, klass = Inform::Object, &block)
+#   obj = klass == Inform::Object ? Inform::Object.build(name) : klass.new(name)
+#   obj.with(&block) if block_given?
+#   obj.save_changes if obj.respond_to?(:save_changes)
+#   obj
+# end
+
+def Object(name, klass = Inform::Object, &block)
+  obj = if klass.respond_to?(:fetch_or_create_by_name)
+    klass.fetch_or_create_by_name(name)
+  else
+    klass.new(name)
+  end
+  obj.with(&block) if block_given?
+  obj.save_changes if obj.respond_to?(:save_changes)
+  obj
+end
+
+# The Inform module
+module Inform
+# module Ephemeral
+module Ephemeral
+  # The Inform::Ephemeral::Object class
+  # rubocop: disable Metrics/ClassLength
+  class Object < Inform::Object
+    Instances = Struct.new(:memo).new(defined?(Java) ? java.util.concurrent.CopyOnWriteArrayList.new : [])
+    attr_accessor :short_name, :display_name, :inflib, :properties, :links,
+      :modules, :tags, :created_at, :modified_at, :visited
+
+    attr_writer :description
+    attr_reader :original_description_method
+
+    # rubocop: disable Metrics/AbcSize
+    # rubocop: disable Metrics/MethodLength
+    def initialize(textual_name = nil, *args, &block)
+      super(*args)
+      @name = textual_name
+      @short_name = textual_name || format('(%<short_name>s)', short_name: self.class.name)
+      @display_name = textual_name
+      @description = nil
+      @adjectives = []
+      @properties = {}
+      @links = []
+      @modules = []
+      @tags = []
+      @children = []
+      @visited = []
+      @created_at = @modified_at = Time.now
+      index_words if respond_to?(:index_words)
+      index_obj(self)
+      @original_description_method = self.class.instance_method(:description)
+      self.with(&block) if block_given?
+    end
+    # rubocop: enable Metrics/AbcSize
+    # rubocop: enable Metrics/MethodLength
+
+    def self.fetch_or_create_by_name(object_name, klass = self)
+      Inform::EphemeralObjects.fetch(object_name) do
+        Inform::EphemeralObjects[object_name] = klass.create(object_name)
+      end
+    end
+
+    def self.create(name = nil, object_type: nil, parent_id: nil, properties: {}, klass: self)
+      klass.new(name).tap do |obj|
+        obj.object_type = object_type
+        obj.parent_id = parent_id
+        obj.properties.merge!(properties)
+      end
+    end
+
+    def values
+      {
+        name: @name,
+        short_name: @short_name,
+        description: @description,
+        properties: @properties
+      }
+    end
+
+    def index_obj(obj)
+      if Instances.memo.respond_to?(:add)
+        Instances.memo.add(obj)
+      else
+        Instances.memo << obj
+      end
+    end
+
+    def self.all
+      Instances.memo.dup
+    end
+
+    def self.clear
+      Instances.memo.clear
+    end
+
+    def [](property)
+      return description if property == :description
+      return name if property == :name
+      return short_name if property == :short_name
+      properties[property]
+    end
+
+    def to_hash
+      properties.merge(
+        id: id,
+        name: name,
+        short_name: short_name,
+        description: description
+      )
+    end
+
+    def <=>(other)
+      self.name <=> other.name
+    end
+
+    def parse(s)
+      return if inflib.nil?
+      inflib.semaphore.synchronize do
+        inflib.println(inflib.parse(s))
+      end
+    end
+
+    def id
+      self.object_id
+    end
+
+    def object_type
+      self.class
+    end
+
+    def name(*args)
+      return args.first.object_name if args.first.respond_to?(:object_name)
+      return @name if args.empty?
+      @name = ([@name] | args).flatten.uniq
+      index_words if respond_to?(:index_words)
+      @name
+    end
+
+    def name=(*args)
+      return if args.empty?
+      @name = args.first.object_name if args.first.respond_to?(:object_name)
+      @name = ([@name] | args).flatten.uniq
+      index_words if respond_to?(:index_words)
+      return
+    end
+
+    def description(*args)
+      return @description if args.nil? || args.empty?
+      @description = args.length > 1 ? args.join(' ') : args.first
+      @description
+    end
+
+    def object_name
+      @display_name || @short_name || @name
+    end
+
+    def name_words
+      @name.split(/[,\s]+/).join(', ')
+    end
+
+    def <<(o)
+      return if self == o
+      return unless o.object?
+      o.parent = self
+      @children << o
+    end
+
+    def remove
+      @children.clear
+      @parent = nil
+    end
+
+    def empty?(*args, &block)
+      self.children.empty?(*args, &block)
+    end
+
+    def children(o = nil, prop = :@children)
+      return @children if o.nil?
+      return o.instance_variable_get(prop).length if o.instance_variable_defined?(prop)
+      o.children.length
+    end
+
+    # TODO: Remove if possible after unit test implementation
+    def location
+      self.parent
+    end
+
+    def list_together
+      linkto :list_together
+    end
+
+    def ancestors
+      self.parent.nil? ? [] : self.parent.ancestors + [self.parent]
+    end
+
+    def descendants
+      @children + @children.map(&:descendants).flatten
+    end
+
+    def root
+      self.parent.nil? ? self : self.parent.root
+    end
+
+    def parent(o = nil, &block)
+      return @parent if o.nil?
+      o.safe_refresh if o.respond_to? :safe_refresh
+      return unless o.respond_to? :parent
+      obj_parent = block_given? ? parent_selector(o, &block) : o.parent
+      return nil if obj_parent.nil?
+      obj_parent.safe_refresh if obj_parent.respond_to? :safe_refresh
+      obj_parent
+    end
+
+    # rubocop: disable Style/TrivialAccessors
+    def parent=(o)
+      @parent = o
+    end
+    # rubocop: enable Style/TrivialAccessors
+
+    def _set_object(link_name, obj = nil)
+      link(link_name, obj).to
+    end
+
+    def _get_object(link_name)
+      find_link(link_name)&.to
+    end
+
+    def find_link(link_name)
+      links.find { |x| x.name == link_name }
+    end
+
+    def link(link_name, obj = nil)
+      link = Inform::Ephemeral::Link.new(name: link_name, to: obj, from: self)
+      links << link
+      link
+    end
+
+    def linked?(link_name)
+      links.count { |x| x.name == link_name } > 0
+    end
+    alias _key? linked?
+
+    def unlink(link_name)
+      links.delete_at(links.index { |x| x.name == link_name })
+    end
+    alias _unset_object unlink
+
+    def linkto(link_name)
+      _get_object(link_name)
+    end
+
+    def linksfrom(link_name = nil)
+      if link_name.nil?
+        links.select { |x| x.to == self }.map(&:from)
+      else
+        links.select { |x| x.name == link_name && x.to == self }.map(&:from)
+      end
+    end
+
+    def init
+      self
+    end
+    alias safe_init init
+
+    def refresh
+      self
+    end
+    alias safe_refresh refresh
+
+    def save(*_args)
+      self
+    end
+    alias safe_save save
+
+    def to_s
+      self.name
+    end
+
+    def inspect
+      identity
+    end
+  end
+  # rubocop: enable Metrics/ClassLength
+  # class Inform::Ephemeral::Object
+end
+# module Inform::Ephemeral
+end
+# module Inform
+
+# The Inform module
+module Inform
+unless defined?(Inform::EphemeralObjects)
+  EphemeralObjects = if defined?(Java)
+    java.util.concurrent.ConcurrentHashMap.new
+  else
+    {}
+  end
+end
+unless defined?(Inform::EphemeralObjectsChildren)
+  EphemeralObjectsChildren = if defined?(Java)
+    java.util.concurrent.ConcurrentHashMap.new
+  else
+    {}
+  end
+end
+end

data/lib/{runtime → story_teller/inform/ephemeral}/tag.rb

@@ -1,57 +1,37 @@
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2023 but freely usable (see license)
+# Copyright Nels Nelson 2008-2025 but freely usable (see license)
 #
-# This file is part of the Inform Runtime.
+# This file is part of StoryTeller.
 #
-# The Inform Runtime is free software: you can redistribute it and/or
+# 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 Inform Runtime is distributed in the hope that it will be useful,
+# 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 Inform Runtime.  If not, see <http://www.gnu.org/licenses/>.
+# along with StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
 
 # Tag
 
-if defined?(Sequel::Migration)
-# The TagSetup class
-class TagSetup < Sequel::Migration
-  def up
-    # return if table_exists? :tag
-    log.debug "#up"
-    create_table? :tag do
-      primary_key :id
-      index :name
-      index :created_at
-
-      String :name, unique: true, null: false
-      DateTime :created_at
-      DateTime :modified_at
-    end
-  end
-
-  def down
-    drop_table(:tag, cascade: true) if table_exists? :tag
-  end
-end
-# class TagSetup
-end
-# defined?(Sequel::Migration)
-
-# The Inform module
+# module Inform
 module Inform
-  # The Inform::Tag class
-  class Tag < Sequel::Model
-    set_primary_key :id
-    def_column_accessor :created_at, :modified_at
-    def_column_accessor :name
+# module Ephemeral
+module Ephemeral
+  # class Tag
+  class Tag < Inform::Tag
+    attr_accessor :created_at, :modified_at, :name
+
+    def initialize(name)
+      super()
+      @name = name
+    end
 
     def before_create
       self.created_at ||= Time.now
@@ -108,6 +88,9 @@ from tag a, tagged b where b.tag_id = a.id group by a.id, a.name)
     end
     # rubocop: enable Style/FormatStringToken
   end
+  # class Tag
+end
+# module Ephemeral
 end
 # module Inform
 
@@ -132,7 +115,7 @@ module Inform
 
     def init
       self.clear
-      self.merge(Inform::Library::DeclaredAttributes.memo)
+      self.merge(StoryTeller::Library.declarations.attributes)
       self.merge(all_persisted_tags)
       self
     end
@@ -146,32 +129,13 @@ end
 
 # Tagged
 
-if defined?(Sequel::Migration)
-# The TaggedSetup class
-class TaggedSetup < Sequel::Migration
-  def up
-    log.debug "#up"
-    create_table? :tagged do
-      primary_key :id
-      foreign_key :object_id, :object, on_delete: :cascade
-      foreign_key :tag_id, :tag, on_delete: :cascade
-    end
-  end
-
-  def down
-    drop_table(:tagged, cascade: true) if table_exists? :tagged
-  end
-end
-# class TaggedSetup
-end
-# defined?(Sequel::Migration)
-
 # The Inform module
 module Inform
+# module Ephemeral
+module Ephemeral
   # The Inform::Tagged class
-  class Tagged < Sequel::Model
-    set_primary_key :id
-  end
+  class Tagged < Inform::Tagged; end
+end
 end
 # module Inform
 
@@ -197,15 +161,21 @@ module Inform
   module Taggable
     include TagHelpers
 
+    # rubocop: disable Metrics/AbcSize
     def tag(*args)
       # TODO: Generalize workflag to system flags
       workflags.add(self.identity) if args.delete(:workflag)
       a = self.tag_names args
       (a - (self.nil_safe_tags & a)).each do |tag|
-        add_tag(Inform::Tag.find_or_create(name: tag.to_s))
+        if Inform::Tag.respond_to?(:find_or_create)
+          add_tag(Inform::Tag.find_or_create(name: tag.to_s))
+        else
+          add_tag(tags.find { |tag| tag.name == tag.to_s } || Inform::Tag.new(tag.to_s))
+        end
       end
       self.save_changes if self.respond_to?(:save_changes)
     end
+    # rubocop: enable Metrics/AbcSize
 
     def untag(*args)
       # TODO: Generalize workflag to system flags
@@ -237,7 +207,7 @@ module Inform
       # TODO: Generalize workflag to system flags
       # puts "workflags: #{workflags}" if args.include?(:workflag)
       return false if args.delete(:workflag) && workflags.include?(self.identity)
-      (nil_safe_tags & tag_names(args)).empty?
+      !nil_safe_tags.intersect?(tag_names(args))
     end
 
     def tag_names(a)
@@ -259,29 +229,32 @@ end
 
 # The Inform module
 module Inform
-  # The Inform::System module
-  module System
-    # The Inform::System::Object class
-    class Object
-      def tag(*args)
-        workflags.add self.identity if args.delete :workflag
-        tag_names(args).each do |tag|
-          tags << tag.to_sym
-        end
-        self
+# The Inform::Ephemeral module
+module Ephemeral
+  # The Inform::Ephemeral::Object class
+  class Object
+    def tag(*args)
+      workflags.add self.identity if args.delete :workflag
+      tag_names(args).each do |tag|
+        tags << tag.to_sym
       end
+      self
+    end
 
-      def untag(*args)
-        workflags.delete self.identity if args.delete :workflag
-        (nil_safe_tags & tag_names(args)).each do |tag|
-          tags.delete tag
-        end
-        self
+    def untag(*args)
+      workflags.delete self.identity if args.delete :workflag
+      (nil_safe_tags & tag_names(args)).each do |tag|
+        tags.delete tag
       end
+      self
+    end
 
-      def tags
-        @tags ||= []
-      end
+    def tags
+      @tags ||= []
     end
   end
+  # class Object
 end
+# module Ephemeral
+end
+# module Inform

data/lib/story_teller/inform/models.rb

@@ -0,0 +1,25 @@
+# lib/story_teller/inform/models.rb
+# encoding: utf-8
+# frozen_string_literal: false
+
+# Copyright Nels Nelson 2008-2026 but freely usable (see license)
+#
+# This file is part of 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 'ephemeral/link'
+require_relative 'ephemeral/module'
+require_relative 'ephemeral/object'
+require_relative 'ephemeral/tag'

data/lib/{runtime → story_teller}/io.rb

@@ -1,30 +1,30 @@
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2023 but freely usable (see license)
+# Copyright Nels Nelson 2008-2025 but freely usable (see license)
 #
-# This file is part of the Inform Runtime.
+# This file is part of the StoryTeller.
 #
-# The Inform Runtime is free software: you can redistribute it and/or
+# 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 Inform Runtime is distributed in the hope that it will be useful,
+# 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 Inform Runtime.  If not, see <http://www.gnu.org/licenses/>.
+# along with the StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
 
-# The Inform module
-module Inform
+# The StoryTeller module
+module StoryTeller
   # The IO module
   module IO
     def session
-      return unless defined?(Inform::IO::Session) && Inform::IO::Session.respond_to?(:of)
-      @session ||= Inform::IO::Session.of(self)
+      return unless defined?(StoryTeller::IO::Session) && StoryTeller::IO::Session.respond_to?(:of)
+      @session ||= StoryTeller::IO::Session.of(self)
     end
 
     def noop; end
@@ -171,4 +171,4 @@ module Inform
   end
   # module IO
 end
-# module Inform
+# module StoryTeller

data/lib/{runtime → story_teller}/kernel.rb

@@ -1,22 +1,23 @@
+# lib/story_teller/kernel.rb
 # encoding: utf-8
 # frozen_string_literal: false
 
-# Copyright Nels Nelson 2008-2023 but freely usable (see license)
+# Copyright Nels Nelson 2008-2025 but freely usable (see license)
 #
-# This file is part of the Inform Runtime.
+# This file is part of StoryTeller.
 #
-# The Inform Runtime is free software: you can redistribute it and/or
+# 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 Inform Runtime is distributed in the hope that it will be useful,
+# 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 Inform Runtime.  If not, see <http://www.gnu.org/licenses/>.
+# along with StoryTeller.  If not, see <http://www.gnu.org/licenses/>.
 
 # Define a class inheriting from StandardError to raise when
 # a method is already defined
@@ -29,45 +30,34 @@ end
 
 # The Kernel module
 module Kernel
-  def import_global(symbol)
-    Inform::Runtime.import_global(symbol)
-  end
-
-  def Link(link)
-    Inform::Runtime.Link(link)
-  end
-
   def Include(inclusion)
-    Inform::Runtime.instance.main_object = self if inclusion == "Parser"
-    Inform::Runtime.Include(inclusion)
+    StoryTeller::Engine.main_object = self if inclusion == "Parser"
+    StoryTeller::Library::Directives.Include(inclusion)
   end
 
   def Attribute(attribute)
-    Inform::Runtime.Attribute(attribute)
+    StoryTeller::Library::Directives.Attribute(attribute)
   end
 
   def Property(property_or_modifier, modifier = nil, value = nil)
-    Inform::Runtime.Property(property_or_modifier, modifier, value)
+    StoryTeller::Library::Directives.Property(property_or_modifier, modifier, value)
   end
 
   def Default(property, value)
-    Inform::Runtime.Default(property, value)
+    StoryTeller::Library::Directives.Default(property, value)
   end
 
   def Constant(property, value)
-    Inform::Runtime.Constant(property, value)
-  end
-
-  # TODO: Remove
-  # def with(context = nil, &block)
-  #   if context.nil?
-  #     self.instance_eval(&block)
-  #   else
-  #     self.instance_exec(context, &block)
-  #   end
-  #   self.save if self.respond_to?(:save)
-  #   self
-  # end
+    StoryTeller::Library::Directives.Constant(property, value)
+  end
+
+  def Link(link)
+    StoryTeller::Library::Directives.Link(link)
+  end
+
+  def import_global(symbol)
+    StoryTeller::Library::Directives.import_global(symbol)
+  end
 
   def return_after(*args, &block)
     block.call