inform-runtime 1.0.4

data/README.md

@@ -0,0 +1,185 @@
+# Inform Runtime
+
+[![License](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat)](license-gpl)
+
+
+
+**The Inform Runtime** for Ruby is a command-line interface software
+runtime program for playing interactive-fiction games which use the
+[Inform 6 Ruby Port].
+
+The Inform Runtime for Ruby is intended to simply provide the barest
+minimum facilities required by the Inform 6 Library Ruby Port software to
+function in the context of a game play specified by a game directory or
+file. It does not attempt to replicate a byte code interpreter runtime
+like frotz.
+
+
+## Install mise-en-place
+
+The [mise] CLI tool used to manage multiple runtime versions.
+
+See: https://mise.jdx.dev/getting-started.html
+
+```sh
+curl https://mise.run/zsh | sh
+mise --version
+```
+
+
+## Install required runtime software
+
+```sh
+mise install
+```
+
+Now install the `bundler` for managing project dependencies.
+
+```sh
+gem install bundler
+gem update --system
+```
+
+
+Download and install the latest version of [PostgreSQL].
+
+
+## Setup
+
+Install some gem dependencies.
+
+```sh
+bundle update --bundler
+bundle install
+```
+
+
+## Run
+
+Execute the `inform.rb` program. It will play the included example game.
+
+```sh
+bundle exec inform.rb
+```
+
+```
+Welcome to...
+
+EXAMPLE
+An Interactive Example
+Copyright (c) 2025 by Nels N. Nelson.
+Release 1 / Serial number 251006 / inform.rb v1.0.3 Library 6/11N 
+
+Field
+You are standing in a field in front of a small 19th century house which stands just to the east of you. The house hardly stands up to the stiff wind rolling down from the north.
+You can see a small toy top here.
+
+>quit
+Are you sure you want to quit? yes
+[Hit enter to exit.]
+```
+
+
+## Linting
+
+```sh
+bundle exec rake lint
+```
+
+
+## Testing
+
+```sh
+bundle exec rake test
+```
+
+
+## Project file tree
+
+Here is a bird's-eye view of the project layout.
+
+```sh
+# date && tree -A -I "game|logs|vendor|tmp|Gemfile.lock"
+Tue Oct 14 19:01:27 CDT 2025
+.
+├── config
+│   └── database.yml
+├── CONTRIBUTING.md
+├── exe
+│   └── inform.rb
+├── Gemfile
+├── inform-runtime-1.0.3.gem
+├── inform-runtime.gemspec
+├── lib
+│   ├── runtime
+│   │   ├── articles.rb
+│   │   ├── builtins.rb
+│   │   ├── color.rb
+│   │   ├── command.rb
+│   │   ├── config.rb
+│   │   ├── context.rb
+│   │   ├── daemon.rb
+│   │   ├── database.rb
+│   │   ├── events.rb
+│   │   ├── experimental
+│   │   │   └── handler_dsl.rb
+│   │   ├── game_loader.rb
+│   │   ├── game.rb
+│   │   ├── grammar_parser.rb
+│   │   ├── helpers.rb
+│   │   ├── history.rb
+│   │   ├── inflector.rb
+│   │   ├── io.rb
+│   │   ├── kernel.rb
+│   │   ├── library_loader.rb
+│   │   ├── library.rb
+│   │   ├── link.rb
+│   │   ├── logging.rb
+│   │   ├── mixins.rb
+│   │   ├── module.rb
+│   │   ├── object.rb
+│   │   ├── options.rb
+│   │   ├── persistence.rb
+│   │   ├── plurals.rb
+│   │   ├── prototype.rb
+│   │   ├── publication.rb
+│   │   ├── runtime.rb
+│   │   ├── session.rb
+│   │   ├── stdlib.rb
+│   │   ├── subscription.rb
+│   │   ├── tag.rb
+│   │   ├── tree.rb
+│   │   ├── version.rb
+│   │   └── world_tree.rb
+│   └── runtime.rb
+├── LICENSE
+├── Rakefile
+├── README.md
+├── roller2.jpg
+├── scripts
+│   ├── backup.rb
+│   ├── clone.rb
+│   ├── delete.rb
+│   ├── init.rb
+│   ├── rebuild.rb
+│   └── restore.rb
+└── spec
+    ├── game_spec.rb
+    ├── inform_spec.rb
+    ├── inform_system_spec.rb
+    ├── object_spec.rb
+    ├── parser_spec.rb
+    ├── spec_helper.rb
+    ├── verblib_spec.rb
+    └── verify_gem_spec.rb
+
+7 directories, 63 files
+```
+
+Thanks!
+
+[Inform 6 Ruby Port]: https://gitlab.com/nelsnelson/inform6-ruby
+[license-gpl]: https://gitlab.com/nelsnelson/inform6/blob/master/LICENSE
+[mise]: https://mise.jdx.dev/
+[PostgreSQL]: https://postgresql.org/download
+

data/Rakefile

@@ -0,0 +1,65 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+require 'rake'
+require 'rake/clean'
+
+unless defined?(InformRuntime::PROJECT)
+# Ensure InformRuntime module constants
+module InformRuntime
+  PROJECT = File.basename(__dir__)
+end
+end
+
+load "#{InformRuntime::PROJECT}.gemspec"
+
+CLEAN.add File.join('tmp', '**', '*'), 'tmp'
+CLOBBER.add '*.gem', 'pkg'
+
+task default: %i[package]
+
+desc 'Run the rubocop linter'
+task :lint do
+  system('bundle', 'exec', 'rubocop') or abort
+end
+
+desc 'Run the spec tests'
+task :test do
+  system('bundle', 'exec', 'rspec', '--format=documentation') or abort
+end
+task test: :lint
+
+desc 'Explode the gem'
+task :explode do
+  puts "Installing gem into the ./tmp directory..."
+  gems = Dir['*.gem']
+  raise 'No .gem files found; to build, run: bundle exec rake' if gems.empty?
+  system('gem', 'install', '--no-document', '--install-dir=tmp', *gems) or abort
+end
+task explode: :clean
+
+desc 'Package the gem'
+task :package do
+  system('gem', 'build') or abort
+end
+task package: %i[clean clobber test]
+
+desc 'Verify the gem'
+task :verify do
+  system('bundle', 'exec', 'rspec', 'spec/verify_gem_spec.rb') or abort
+  system('bundle', 'exec', 'rake', 'clean')
+end
+task verify: :explode
+
+desc 'Publish the gem'
+task :publish do
+  system('gem', 'push', latest_gem) or abort
+end
+task publish: :verify
+
+def latest_gem
+  Dir["#{InformRuntime::PROJECT}*.gem"].max_by { |p| File.mtime(p) }
+end

data/config/database.yml

@@ -0,0 +1,37 @@
+
+default:
+  adapter: postgres
+  database: postgres
+  username: postgres
+  host: localhost
+  pool: 5
+
+development:
+  adapter: postgres
+  database: example
+  username: example
+  password: example
+  host: localhost
+  pool: 5
+  timeout: 5000
+
+test:
+  adapter: sqlite
+
+docker:
+  adapter: postgres
+  database: example
+  username: example
+  password: example
+  host: postgres
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: postgres
+  database: example
+  username: example
+  password: example
+  host: localhost
+  pool: 5
+  timeout: 5000

data/exe/inform.rb

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+require_relative '../lib/runtime'
+
+Object.new.extend(Inform::App).main

data/game/config.yml

@@ -0,0 +1,5 @@
+# Configuration for game module
+
+---
+database_name: example
+environment: production

data/game/example.inf

@@ -0,0 +1,76 @@
+
+! ----------------------------------------------------------------------------
+!  Example
+! ----------------------------------------------------------------------------
+
+! DEBUG = true
+Constant Story = "EXAMPLE";
+Constant Headline = "^An Interactive Example^
+  Copyright (c) 2025 by Nels N. Nelson.^";
+
+Replace DrawStatusLine;
+
+Include "Parser";
+Include "VerbLib";
+
+Object Field "Field"
+  with description
+           "You are standing in a field.  A small 19th century house stands 
+           to the east, hardly standing up to the stiff wind rolling down 
+           from the north.",
+       e_to HouseFoyer,
+       w_to Shingle
+  has  light;
+
+Object -> "small toy top"
+  with name 'small' 'toy' 'top',
+       before [;
+         Examine:
+           print "A totem, somehow familiar, made of brass";
+           if (self in player) {
+             print " and heavy in your hand";
+           }
+           ".";
+       ];
+
+Object HouseFoyer "Foyer"
+  with description
+           "You stand in the foyer of this
+           ancient structure.  A draft swirls through
+           the hallway to the east.",
+    out_to Field,
+    w_to Field
+  has light;
+
+Object Shingle "Shingle"
+  with description
+           "You seem to be only a small child
+           playing on a sea-shore, and diverting yourself
+           in finding a smoother pebble or a prettier shell
+           than ordinary, whilst the great ocean of
+           truth lies all undiscovered before you.",
+    e_to Field
+  has light;
+
+[ Initialise;
+  location = Field;
+  "^^^^^Welcome to...^";
+];
+
+[ DrawStatusLine;
+   @split_window 1; @set_window 1; @set_cursor 1 1; style reverse;
+   spaces (0->33)-1;
+   @set_cursor 1 2;  PrintShortName(location);
+   @set_cursor 1 60; print "(as ";
+   @print_obj player;
+   print ")"; ! There ya are.
+   @set_cursor 1 1; style roman; @set_window 0;
+];
+
+Include "Grammar";
+
+Verb meta 'example'
+    *                                           -> Example;
+Verb 'smile'
+    *                                           -> Smile;
+

data/game/example.rb

@@ -0,0 +1,90 @@
+
+# ----------------------------------------------------------------------------
+#  Example
+# ----------------------------------------------------------------------------
+
+# DEBUG = true
+Story = "EXAMPLE"
+Headline = "\nAn Interactive Example\n" \
+           "Copyright (c) 2025 by Nels N. Nelson.\n"
+Release = 1
+
+def DrawStatusLine; end
+
+Include "Parser"
+Include "VerbLib"
+
+Field = Object("Field") {
+  with {
+    description "You are standing in a field in " \
+      "front of a small 19th century house which " \
+      "stands just to the east of you. The house " \
+      "hardly stands up to the stiff wind rolling " \
+      "down from the north."
+    e_to :HouseFoyer
+    w_to :Shingle
+  }
+  has :light
+}
+
+# Note that the "with" directive here is vestigial and
+# can be discarded altogether, but is supported for
+# ease of transition/adoption.
+#
+# Field > Object("small toy top") {
+#   with {
+#     def before_examine
+#       "A totem, somehow familiar, made of brass" +
+#       (self.parent == player ? " and heavy in your hand" : '') + "."
+#     end
+#     weight 15 # grams
+#   }
+# }
+Field > Object("small toy top") {
+  def before_examine
+    print "A totem, somehow familiar, made of brass"
+    print " and heavy in your hand" if self.parent == player
+    "."
+  end
+  weight 15 # grams
+}
+
+HouseFoyer = Object("Foyer") {
+  with {
+    description "You stand in the foyer of this " \
+      "ancient structure.  A draft swirls through " \
+      "the hallway to the east."
+    out_to :Field; w_to :Field
+  }
+  has :light
+}
+
+Shingle = Object("Shingle") {
+  with {
+    description "You seem to be only a small child " \
+      "playing on a sea-shore, and diverting yourself " \
+      "in finding a smoother pebble or a prettier shell " \
+      "than ordinary, whilst the great ocean of " \
+      "truth lies all undiscovered before you."
+    e_to :Field
+  }
+  has :light
+}
+
+class InformLibrary
+def Initialise
+  @location = Field
+  "\n\n\n\n\nWelcome to...\n"
+end
+end
+
+Include "Grammar"
+
+Inform::Grammar <<~EOT
+Verb meta 'example'
+    *                                           -> Example;
+Verb 'smile'
+    *                                           -> Smile;
+EOT
+
+# log.info "Finished loading example game file: #{__FILE__} #<#{self.class}:#{self.object_id}>"

data/game/forms/example_form.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+# frozen_string_literal: false

data/game/grammar/game_grammar.inf.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+Verb meta 'library'
+    * 'methods'                                 -> LibraryMethods;
+
+Verb meta 'test'
+    *                                           -> Test
+    * special                                   -> Test
+    * number special                            -> Test;
+

data/game/languages/english.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+# frozen_string_literal: false

data/game/models/example_model.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+# frozen_string_literal: false

data/game/modules/example_module.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# The Huggable module
+module Huggable
+  def life_hug
+    ":-)"
+  end
+end

data/game/rules/example_state.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+# frozen_string_literal: false

data/game/scripts/example_script.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+# frozen_string_literal: false

data/game/topics/example_topic.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+# frozen_string_literal: false

data/game/verbs/game_verbs.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# The Inform module
+module Inform
+# The Verb module
+module Verbs
+  def ExampleSub
+    "This is just an example."
+  end
+  def SmileSub
+    "You smile."
+  end
+end
+end