inform-runtime 1.2.3 → 1.3.1

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

@@ -1,8 +1,8 @@
-# lib/story_teller/object.rb
+# lib/story_teller/inform/object.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.
 #
@@ -13,11 +13,11 @@
 #
 # 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
+# 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/>.
+# along with the StoryTeller. If not, see <http://www.gnu.org/licenses/>.
 
 # Object
 
@@ -28,7 +28,7 @@
 #   obj
 # end
 
-def Object(name, klass = Inform::Object, &block)
+def Object(name, klass = Inform::Ephemeral::Object, &block)
   obj = if klass.respond_to?(:fetch_or_create_by_name)
     klass.fetch_or_create_by_name(name)
   else
@@ -39,291 +39,278 @@ def Object(name, klass = Inform::Object, &block)
   obj
 end
 
-# The Inform module
+# module Inform
 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
+  # module Ephemeral
+  module Ephemeral
+    # class Object
+    # rubocop: disable Metrics/ClassLength
+    class Object
+      DefaultShortNameTemplate = '(%<short_name>s)'.freeze
+
+      attr_accessor :short_name, :display_name, :inflib,
+        :properties, :links, :modules, :tags, :created_at, :modified_at,
+        :visited
+
+      alias values properties
+
+      # rubocop: disable Metrics/AbcSize
+      # rubocop: disable Metrics/MethodLength
+      def initialize(textual_name = nil, *args, &block)
+        super(*args)
+        @name = textual_name || self.class.name
+        @short_name = textual_name || format(
+          DefaultShortNameTemplate, 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)
+        EphemeralObjects[self.identity] = self
+        EphemeralObjects[@display_name.to_s] = self unless @display_name.nil?
+        self.with(&block) unless block.nil?
+      end
+      # rubocop: enable Metrics/AbcSize
+      # rubocop: enable Metrics/MethodLength
+
+      def self.fetch_or_create_by_name(name)
+        key = name.to_s
+        object = EphemeralObjects[key]
+        return object if object.is_a?(self)
 
-    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)
+        new(key).tap { |created| EphemeralObjects[key] = created }
       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)
+      def self.all
+        EphemeralObjects.values.select { |object| object.is_a?(self) }.uniq
       end
-    end
 
-    def values
-      {
-        name: @name,
-        short_name: @short_name,
-        description: @description,
-        properties: @properties
-      }
-    end
+      def self.clear
+        EphemeralObjects.clear
+        EphemeralObjectsChildren.clear if defined?(EphemeralObjectsChildren)
+      end
 
-    def index_obj(obj)
-      if Instances.memo.respond_to?(:add)
-        Instances.memo.add(obj)
-      else
-        Instances.memo << obj
+      def self.[](id)
+        object = EphemeralObjects[id]
+        return object if object.is_a?(self)
+
+        all.find { |candidate| candidate.id == id || candidate.identity == id }
       end
-    end
 
-    def self.all
-      Instances.memo.dup
-    end
+      def [](property)
+        return description if property == :description
+        return name if property == :name
+        return short_name if property == :short_name
 
-    def self.clear
-      Instances.memo.clear
-    end
+        properties[property]
+      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 to_hash
-      properties.merge(
-        id: id,
-        name: name,
-        short_name: short_name,
-        description: description
-      )
-    end
+      def <=>(other)
+        self.name <=> other.name
+      end
 
-    def <=>(other)
-      self.name <=> other.name
-    end
+      def parse(s)
+        return if inflib.nil?
 
-    def parse(s)
-      return if inflib.nil?
-      inflib.semaphore.synchronize do
-        inflib.println(inflib.parse(s))
+        inflib.semaphore.synchronize { inflib.parse(s) }
       end
-    end
 
-    def id
-      self.object_id
-    end
+      def id
+        self.object_id
+      end
 
-    def object_type
-      self.class
-    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 args.first.object_name if args.first.respond_to?(:object_name)
+        return @name if args.empty?
 
-    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
+        @name = ([@name] | args).flatten.uniq
+        index_words if respond_to?(:index_words)
+        @name
+      end
 
-    def description(*args)
-      return @description if args.nil? || args.empty?
-      @description = args.length > 1 ? args.join(' ') : args.first
-      @description
-    end
+      def description(description = nil)
+        return @description if description.nil?
 
-    def object_name
-      @display_name || @short_name || @name
-    end
+        @description = description
+      end
 
-    def name_words
-      @name.split(/[,\s]+/).join(', ')
-    end
+      alias description= description
 
-    def <<(o)
-      return if self == o
-      return unless o.object?
-      o.parent = self
-      @children << o
-    end
+      def object_name
+        @display_name || @short_name || @name
+      end
 
-    def remove
-      @children.clear
-      @parent = nil
-    end
+      def name_words
+        name_words = @name
+        name_words = name_words.split(/[,\s]+/) if name_words.respond_to?(:split)
+        name_words.join(', ') if name_words.respond_to?(:join)
+        name_words
+      end
 
-    def empty?(*args, &block)
-      self.children.empty?(*args, &block)
-    end
+      def <<(o)
+        return if self == o
+        return unless o.object?
 
-    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
+        o.parent = self
+        @children << o
+      end
 
-    # TODO: Remove if possible after unit test implementation
-    def location
-      self.parent
-    end
+      def remove
+        @children.clear
+        @parent = nil
+      end
 
-    def list_together
-      linkto :list_together
-    end
+      def empty?(...)
+        self.children.empty?(...)
+      end
 
-    def ancestors
-      self.parent.nil? ? [] : self.parent.ancestors + [self.parent]
-    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)
 
-    def descendants
-      @children + @children.map(&:descendants).flatten
-    end
+        o.children.length
+      end
 
-    def root
-      self.parent.nil? ? self : self.parent.root
-    end
+      def location
+        self.parent
+      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
+      def list_together
+        linkto :list_together
+      end
 
-    # rubocop: disable Style/TrivialAccessors
-    def parent=(o)
-      @parent = o
-    end
-    # rubocop: enable Style/TrivialAccessors
+      def ancestors
+        self.parent.nil? ? [] : self.parent.ancestors + [self.parent]
+      end
 
-    def _set_object(link_name, obj = nil)
-      link(link_name, obj).to
-    end
+      def descendants
+        @children + @children.map(&:descendants).flatten
+      end
 
-    def _get_object(link_name)
-      find_link(link_name)&.to
-    end
+      def root
+        self.parent.nil? ? self : self.parent.root
+      end
 
-    def find_link(link_name)
-      links.find { |x| x.name == link_name }
-    end
+      def parent(o = nil, &block)
+        return @parent if o.nil?
 
-    def link(link_name, obj = nil)
-      link = Inform::Ephemeral::Link.new(name: link_name, to: obj, from: self)
-      links << link
-      link
-    end
+        o.safe_refresh if o.respond_to? :safe_refresh
+        return unless o.respond_to? :parent
 
-    def linked?(link_name)
-      links.count { |x| x.name == link_name } > 0
-    end
-    alias _key? linked?
+        obj_parent = block_given? ? parent_selector(o, &block) : o.parent
+        return nil if obj_parent.nil?
 
-    def unlink(link_name)
-      links.delete_at(links.index { |x| x.name == link_name })
-    end
-    alias _unset_object unlink
+        obj_parent.safe_refresh if obj_parent.respond_to? :safe_refresh
+        obj_parent
+      end
 
-    def linkto(link_name)
-      _get_object(link_name)
-    end
+      # rubocop: disable Style/TrivialAccessors
+      def parent=(o)
+        @parent = o
+      end
+      # rubocop: enable Style/TrivialAccessors
 
-    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)
+      def _set_object(link_name, obj = nil)
+        link(link_name, obj).to
       end
-    end
 
-    def init
-      self
-    end
-    alias safe_init init
+      def _get_object(link_name)
+        find_link(link_name)&.to
+      end
 
-    def refresh
-      self
-    end
-    alias safe_refresh refresh
+      def find_link(link_name)
+        links.find { |x| x.name == link_name }
+      end
 
-    def save(*_args)
-      self
-    end
-    alias safe_save save
+      def link(link_name, obj = nil)
+        link = Inform::System::Link.new(name: link_name, to: obj, from: self)
+        links << link
+        link
+      end
 
-    def to_s
-      self.name
-    end
+      def linked?(link_name)
+        links.count { |x| x.name == link_name } > 0
+      end
+
+      alias _key? linked?
 
-    def inspect
-      identity
+      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
     end
+    # rubocop: enable Metrics/ClassLength
+    # class Object
   end
-  # rubocop: enable Metrics/ClassLength
-  # class Inform::Ephemeral::Object
-end
-# module Inform::Ephemeral
+  # module Ephemeral
 end
 # module Inform
 
 # The Inform module
 module Inform
-unless defined?(Inform::EphemeralObjects)
-  EphemeralObjects = if defined?(Java)
-    java.util.concurrent.ConcurrentHashMap.new
-  else
-    {}
+  unless defined?(Inform::EphemeralObjects)
+    EphemeralObjects = if defined?(Java)
+      java.util.concurrent.ConcurrentHashMap.new
+    else
+      {}
+    end
   end
-end
-unless defined?(Inform::EphemeralObjectsChildren)
-  EphemeralObjectsChildren = if defined?(Java)
-    java.util.concurrent.ConcurrentHashMap.new
-  else
-    {}
+
+  unless defined?(Inform::EphemeralObjectsChildren)
+    EphemeralObjectsChildren = if defined?(Java)
+      java.util.concurrent.ConcurrentHashMap.new
+    else
+      {}
+    end
   end
 end
-end

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

@@ -1,7 +1,8 @@
+# lib/story_teller/inform/tag.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 StoryTeller.
 #
@@ -25,7 +26,7 @@ module Inform
 # module Ephemeral
 module Ephemeral
   # class Tag
-  class Tag < Inform::Tag
+  class Tag
     attr_accessor :created_at, :modified_at, :name
 
     def initialize(name)
@@ -94,7 +95,7 @@ end
 end
 # module Inform
 
-# The Inform module
+# module Inform
 module Inform
   # The TagRegistry class
   class TagRegistry < Set
@@ -106,8 +107,8 @@ module Inform
     end
 
     def all_persisted_tags
-      return [] unless Inform::Tag.respond_to?(:map)
-      Inform::Tag.map { |a| a.name.to_sym }
+      return [] unless Inform.tag_klass.respond_to?(:map)
+      Inform.tag_klass.map { |a| a.name.to_sym }
     rescue Sequel::DatabaseError => e
       log.warn e.message
       return []
@@ -121,8 +122,18 @@ module Inform
     end
     alias reset init
   end
+end
+# module Inform
+
+# module Inform
+module Inform
+  module_function
 
-  def self.attributes
+  def tag_klass
+    Inform::Ephemeral::Tag
+  end
+
+  def attributes
     TagRegistry::SINGLETON.memo ||= TagRegistry.new
   end
 end
@@ -134,10 +145,9 @@ module Inform
 # module Ephemeral
 module Ephemeral
   # The Inform::Tagged class
-  class Tagged < Inform::Tagged; end
+  class Tagged; end
 end
 end
-# module Inform
 
 # Taggable
 
@@ -155,33 +165,36 @@ module Inform
   end
 end
 
-# The Inform module
+# module Inform
 module Inform
-  # The Inform::Taggable module
+  # module Taggable
   module Taggable
     include TagHelpers
 
     # rubocop: disable Metrics/AbcSize
+    # rubocop: disable Metrics/MethodLength
     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|
-        if Inform::Tag.respond_to?(:find_or_create)
-          add_tag(Inform::Tag.find_or_create(name: tag.to_s))
+        if Inform.tag_klass.respond_to?(:find_or_create)
+          add_tag(Inform.tag_klass.find_or_create(name: tag.to_s))
         else
-          add_tag(tags.find { |tag| tag.name == tag.to_s } || Inform::Tag.new(tag.to_s))
+          tag = tags.find { |tag| tag.name == tag.to_s } || Inform.tag_klass.new(tag.to_s)
+          add_tag(tag)
         end
       end
       self.save_changes if self.respond_to?(:save_changes)
     end
     # rubocop: enable Metrics/AbcSize
+    # rubocop: enable Metrics/MethodLength
 
     def untag(*args)
       # TODO: Generalize workflag to system flags
       workflags.delete(self.identity) if args.delete(:workflag)
       (self.nil_safe_tags & tag_names(args)).each do |tag|
-        remove_tag Inform::Tag.find(name: tag.to_s)
+        remove_tag(Inform.tag_klass.find(name: tag.to_s))
       end
       self.save_changes if self.respond_to?(:save_changes)
     end