inform-runtime 1.0.4

data/lib/runtime/tag.rb

@@ -0,0 +1,287 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# Copyright Nels Nelson 2008-2023 but freely usable (see license)
+#
+# This file is part of the Inform Runtime.
+#
+# The Inform Runtime 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,
+# 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/>.
+
+# 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
+  # The Inform::Tag class
+  class Tag < Sequel::Model
+    set_primary_key :id
+    def_column_accessor :created_at, :modified_at
+    def_column_accessor :name
+
+    def before_create
+      self.created_at ||= Time.now
+      super
+    end
+
+    def after_create
+      super
+      Inform.attributes.reset
+    end
+
+    def after_save
+      super
+      self.modified_at = Time.now.utc
+    end
+
+    def to_s
+      name
+    end
+    alias to_str to_s
+
+    def <=>(other)
+      self.name <=> other.name
+    end
+
+    def self.tidy
+      db << %(delete from tag where id in
+(select a.id from tag a group by a.id, a.name
+having ((select count(b.id) from tagged b
+where b.tag_id = a.id) = 0)))
+      Inform.attributes.reset
+      return nil
+    end
+
+    # rubocop: disable Style/FormatStringToken
+    def self.dirty
+      results = db.fetch %(select a.id, a.name from tag a group by a.id, a.name having
+((select count(b.id) from tagged b where b.tag_id = a.id) = 0))
+      return nil if results.empty?
+      s = [format('%5s %20s', *results.first.keys)]
+      s.concat(results.collect { |row| format('%5d %20s', *row.values) })
+      s.join("\n")
+    end
+    # rubocop: enable Style/FormatStringToken
+
+    # rubocop: disable Style/FormatStringToken
+    def self.stats
+      results = db.fetch %(select a.*, count(a.id) as "number tagged"
+from tag a, tagged b where b.tag_id = a.id group by a.id, a.name)
+      return nil if results.empty?
+      s = [format('%5s %20s %15s', *results.first.keys)]
+      s.concat(results.collect { |row| format('%5d %20s %15s', *row.values) })
+      s.join("\n")
+    end
+    # rubocop: enable Style/FormatStringToken
+  end
+end
+# module Inform
+
+# The Inform module
+module Inform
+  # The TagRegistry class
+  class TagRegistry < Set
+    SINGLETON = Struct.new(:memo).new
+
+    def initialize
+      super
+      init
+    end
+
+    def all_persisted_tags
+      return [] unless Inform::Tag.respond_to?(:map)
+      Inform::Tag.map { |a| a.name.to_sym }
+    rescue Sequel::DatabaseError => e
+      log.warn e.message
+      return []
+    end
+
+    def init
+      self.clear
+      self.merge(Inform::Library::DeclaredAttributes.memo)
+      self.merge(all_persisted_tags)
+      self
+    end
+    alias reset init
+  end
+
+  def self.attributes
+    TagRegistry::SINGLETON.memo ||= TagRegistry.new
+  end
+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
+  # The Inform::Tagged class
+  class Tagged < Sequel::Model
+    set_primary_key :id
+  end
+end
+# module Inform
+
+# Taggable
+
+# The Inform module
+module Inform
+  # The Inform::TagHelpers module
+  module TagHelpers
+    def attributes; tags; end
+    def has(*args); tag(*args); end
+    def hasnt(*args); untag(*args); end
+    def has?(*args); tagged_with_all?(*args); end
+    def hasany?(*args); tagged_with_any?(*args); end
+    def hasnt?(*args); tagged_with_none?(*args); end
+    alias has! hasnt
+  end
+end
+
+# The Inform module
+module Inform
+  # The Inform::Taggable module
+  module Taggable
+    include TagHelpers
+
+    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))
+      end
+      self.save_changes if self.respond_to?(:save_changes)
+    end
+
+    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)
+      end
+      self.save_changes if self.respond_to?(:save_changes)
+    end
+    alias tag! untag
+
+    def tagged_with?(tag)
+      tagged_with_any? tag
+    end
+
+    def tagged_with_all?(*args)
+      # TODO: Generalize workflag to system flags
+      return workflags.include?(self.identity) if args.delete(:workflag)
+      a = self.tag_names(args)
+      (self.nil_safe_tags & a).length == a.length
+    end
+
+    def tagged_with_any?(*args)
+      # TODO: Generalize workflag to system flags
+      (args.delete(:workflag) && workflags.include?(self.identity)) || !self.tagged_with_none?(*tag_names(args))
+    end
+
+    def tagged_with_none?(*args)
+      # 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?
+    end
+
+    def tag_names(a)
+      a.flatten.map(&:to_s).map(&:intern)
+    end
+
+    def nil_safe_tags
+      attempt_twice do
+        log.warn "The tags for #{self} is nil" if self.tags.nil?
+        # TODO: FIXME
+        # Perhaps try adding a semaphore lock here around tags
+        self.tags.compact.map(&:to_s).map(&:intern)
+      end || Array::Empty
+    end
+  end
+  # module Taggable
+end
+# module Inform
+
+# 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
+      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
+      end
+
+      def tags
+        @tags ||= []
+      end
+    end
+  end
+end

data/lib/runtime/tree.rb

@@ -0,0 +1,204 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# Copyright Nels Nelson 2008-2023 but freely usable (see license)
+#
+# This file is part of the Inform Runtime.
+#
+# The Inform Runtime 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,
+# 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/>.
+
+# Tree
+
+# The Inform module
+module Inform
+  # The Genealogical module
+  module Genealogical
+    def >(other)
+      self << other
+    end
+
+    # TODO: Refactor all of these to use Ruby Sequel dataset methods.
+
+    def include?(other)
+      other.refresh if other.respond_to?(:refresh)
+      return true if other.parent == self
+      self.children.include?(other)
+    end
+
+    def in?(*others)
+      return false unless self.respond_to?(:parent)
+      self.refresh if self.respond_to?(:refresh)
+      x = self.parent
+      x.refresh if x.respond_to?(:refresh)
+      return others.include?(x) if others.length > 1
+      y = others.first
+      return true if self.parent == y
+      return false unless y.respond_to?(:include?)
+      y.include?(self)
+    end
+
+    def within?(*others)
+      x = self
+      x.refresh if x.respond_to?(:refresh)
+      loop do
+        x = x.parent
+        break if x.nil?
+        return true if others.include?(x)
+        x.refresh if x.respond_to?(:refresh)
+      end
+      false
+    end
+
+    def notin?(*others)
+      !self.in?(*others)
+    end
+
+    def branch
+      [self] + self.descendants
+    end
+
+    def all?(*args, &block)
+      self.children.all?(*args, &block)
+    end
+
+    def any?(*args, &block)
+      self.children.any?(*args, &block)
+    end
+
+    def each(*args, &block)
+      self.children.each(*args, &block)
+    end
+
+    def each_with_object(*args, &block)
+      self.children.each_with_object(*args, &block)
+    end
+
+    def select(*args, &block)
+      self.children.select(*args, &block).to_a
+    end
+
+    def collect(*args, &block)
+      self.children.collect(*args, &block)
+    end
+
+    def reject(*args, &block)
+      self.children.reject(*args, &block)
+    end
+
+    def delete_if(*args, &block)
+      self.children.delete_if(*args, &block)
+    end
+
+    def count(*args, &block)
+      self.children.count(*args, &block)
+    end
+
+    def map(*args, &block)
+      self.children.map(*args, &block)
+    end
+
+    def find(*args, &block)
+      self.children.find(*args, &block)
+    end
+
+    def find_all(*args, &block)
+      self.children.find_all(*args, &block)
+    end
+
+    def concat(*args, &block)
+      self.children.concat(*args, &block)
+    end
+
+    def having(method)
+      self.children.having(method)
+    end
+
+    # rubocop: disable Metrics/AbcSize
+    def children(o = nil, prop = :@children)
+      # TODO: Remove
+      unless o.nil?
+        log.warn "In genealogical.children(#{o})"
+        log.warn "  #{o}.respond_to? :children_dataset #=> #{o.respond_to? :children_dataset}"
+        log.warn "  #{o}.instance_variable_defined?(#{prop}) #=> #{o.respond_to? :children_dataset}"
+      end
+      self.safe_refresh if self.respond_to?(:safe_refresh)
+      o.safe_refresh if o.respond_to?(:safe_refresh)
+      return children.length if o.respond_to? :children_dataset
+      return o.instance_variable_get(prop).length if o.instance_variable_defined?(prop)
+      super()
+    end
+    # rubocop: enable Metrics/AbcSize
+
+    # rubocop: disable Metrics/AbcSize
+    # rubocop: disable Metrics/CyclomaticComplexity
+    # rubocop: disable Metrics/MethodLength
+    # rubocop: disable Metrics/PerceivedComplexity
+    def child(o = self, prop = :@children)
+      if o.instance_variable_defined?(prop)
+        # The idea here is that o may be an Inform::System::Object.
+        children = o.instance_variable_get(prop)
+        return nil unless children.respond_to?(:first)
+        children.first
+      elsif o.respond_to?(:children_dataset)
+        # It may be necessary to find some way of caching
+        # the parent-children relationship.  Therefore,
+        # the following benchmarking is a way to gather
+        # data so that it might be determined whether
+        # enabling caching makes any difference in
+        # execution speed.
+        begin
+          # TODO: Remove:
+          if defined?(DEBUG) && @parser_trace >= 12
+            log.debug "#{indent}#{self}.children_dataset execution -- BEGIN"
+          end
+          # TODO: Remove:
+          start = Time.now
+          return o.children_dataset.first
+        ensure # TODO: Remove
+          # TODO: Remove
+          elapsed = Time.now - start if defined? DEBUG
+          # TODO: Remove:
+          if defined?(DEBUG) && @parser_trace >= 12
+            log.debug "#{indent}#{self}.children_dataset executed in #{elapsed.round(6)} milliseconds"
+          end
+        end
+      else
+        log.warn "Object #{o} <#{o.identity}> (#{o.class}) has no children accessor"
+        nil
+      end
+    end
+    # rubocop: enable Metrics/AbcSize
+    # rubocop: enable Metrics/CyclomaticComplexity
+    # rubocop: enable Metrics/MethodLength
+    # rubocop: enable Metrics/PerceivedComplexity
+
+    def sibling(o = self)
+      o.refresh if o.respond_to? :refresh
+      return nil if o.parent.nil?
+      parent = o.parent
+      return nil unless parent.respond_to?(:children)
+      children = o.parent.children
+      return nil if children.nil? || children.empty?
+      children[children.index(o) + 1]
+    end
+
+    def siblings(orphanage = false)
+      if self.parent.nil?
+        return orphanage ? Inform::Object.roots : []
+      end
+      self.refresh if self.respond_to? :refresh
+      self.parent.children - [self]
+    end
+  end
+end

data/lib/runtime/version.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# Copyright Nels Nelson 2008-2023 but freely usable (see license)
+#
+# This file is part of the Inform Runtime.
+#
+# The Inform Runtime 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,
+# 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/>.
+
+module Inform
+  VERSION = '1.0.4'.freeze
+  VN_1610 = '1610'.freeze
+end

data/lib/runtime/world_tree.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# Copyright Nels Nelson 2008-2023 but freely usable (see license)
+#
+# This file is part of the Inform Runtime.
+#
+# The Inform Runtime 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,
+# 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/>.
+
+require_relative 'object'
+require_relative 'link'
+require_relative 'tag'
+require_relative 'module'
+require_relative 'tree'
+require_relative 'daemon'
+
+# The Inform module to include additional
+# modules with Inform::Object, Inform::System::Object,
+# and Inform::Event
+module Inform
+  # The Inform::Object functionality
+  class Object
+    include Inform
+    include Inform::IO if defined?(Inform::IO)
+    include Inform::Events if defined?(Inform::Events)
+    include Inform::Publisher if defined?(Inform::Publisher)
+    include Inform::Prototypical if defined?(Inform::Prototypical)
+    include Inform::Linkable
+    include Inform::Taggable
+    include Inform::Modular
+    include Inform::Genealogical
+    include Inform::Daemons
+  end
+
+  # The Inform::Event class
+  class Event
+    include Inform::Publisher
+  end
+
+  # The Inform::System module to be used as
+  # a namespace differentiator from the Inform::Object
+  module System
+    # The Inform::System::Object functionality
+    class Object
+      include Inform
+      include Inform::IO if defined?(Inform::IO)
+      include Inform::Events if defined?(Inform::Events)
+      include Inform::Publisher if defined?(Inform::Publisher)
+      # TODO: I don't think there is any legitimate reason for
+      # System::Object instances to have prototypical functionality.
+      include Inform::Prototypical if defined?(Inform::Prototypical)
+      include Inform::Linkable
+      include Inform::Taggable
+      include Inform::Genealogical
+      include Inform::Daemons
+    end
+  end
+end

data/lib/runtime.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# Copyright Nels Nelson 2008-2023 but freely usable (see license)
+#
+# This file is part of the Inform Runtime.
+#
+# The Inform Runtime 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,
+# 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/>.
+
+require_relative 'runtime/builtins'
+require_relative 'runtime/stdlib'
+require_relative 'runtime/logging'
+require_relative 'runtime/prototype'
+require_relative 'runtime/command'
+require_relative 'runtime/runtime'
+require_relative 'runtime/persistence'
+require_relative 'runtime/history'
+require_relative 'runtime/events'
+require_relative 'runtime/grammar_parser'
+require_relative 'runtime/kernel'
+require_relative 'runtime/mixins'
+require_relative 'runtime/helpers'
+require_relative 'runtime/io'
+require_relative 'runtime/publication'