clarion-builder 1.0.0

data/WORK-LOG.md

@@ -0,0 +1,133 @@
+# WORK LOG — builder (Jim Weirich, v3.2.2) keeper modernization
+
+Keeper: Steve Wagner. Builder: subagent session 2026-10-07.
+Jim Weirich's authorship and the MIT license are intact. Nothing renamed.
+No push to GitHub, no fork, no publish — changes are commit-ready in the
+working tree only.
+
+## Keeper's foundation (Steve's directive, 2026-10-07)
+
+- The keeper's mission statement was added verbatim to README.md as a
+  clearly-marked "Keeper's Note" section, above the original content.
+  All of Jim Weirich's content, authorship, and contact info untouched.
+- **Battery bar (release requirement):** every change ships only after
+  the full test suite passes. No release goes out on a red suite.
+- **Keeper's mark:** each release carries the keeper's mark. Steve
+  defines the mark at release time — none invented here.
+
+## Environment setup
+
+- VM had no Ruby (`ruby --version` → command not found; no ruby in apt
+  installed list).
+- `sudo apt-get install -y ruby ruby-dev` initially failed ("Unable to
+  locate package") — package lists were empty.
+- Ran `sudo apt-get update` (~74 MB at ~70 kB/s, ~18 min), then the
+  install succeeded.
+- Result: **ruby 3.2.3** (2024-01-18), gem 3.4.20, rake 13.0.6,
+  test-unit 3.5.7, rdoc 6.5.0 (Ubuntu noble packages).
+
+## What was broken (before: the suite could not run at all)
+
+`rake` aborted during Rakefile/rakelib load — zero tests executed:
+
+1. `lib/builder/xchar.rb` — `when Fixnum` in the `INVALID_XML_CHAR`
+   builder. `Fixnum` was removed in Ruby 3.0, so merely
+   `require "builder"` raised `NameError`. The whole library was
+   unloadable.
+2. `Rakefile` — `s.has_rdoc = true` (2×, builder + blankslate specs).
+   Removed in RubyGems 3.0 → `NoMethodError` at Rakefile load.
+3. `rakelib/publish.rake` — top-level `require 'rake/contrib/sshpublisher'`
+   (+ `rubyforgepublisher`); rake/contrib was removed from rake years ago
+   → `LoadError` at rake startup. (Task publishes to RubyForge, dead
+   since ~2014.)
+4. `rakelib/tags.rake` — backticked `` `rvm gemdir` `` at load with no rvm
+   binary → `Errno::ENOENT`; plus `File.exists?` (removed in Ruby 3.2).
+5. Ruby 3.x kwargs separation — `XmlMarkup.new(indent: 2)` and
+   `instruct!(:xml, encoding: "UTF-8")` (new-style keywords) raised
+   `ArgumentError`, because `initialize(options={})` / `instruct!(tag,
+   attrs={})` take no keywords. (The tag path — `method_missing` /
+   `tag!` / cached `define_method` — was already safe: all use `*args`,
+   and Ruby 3 still collapses trailing keywords into a positional Hash
+   for `*args` methods, which re-splats positionally. All existing tests
+   use hash-rockets, which are positional hashes in every Ruby.)
+6. `lib/blankslate.rb` (standalone BlankSlate component) —
+   `Module#append_features` hook only scanned includes into `Object`,
+   not `Kernel`. The code comment admitted Kernel includes "would have
+   to be removed as well" but relied on an old-Ruby "feature" that no
+   longer exists; late `Kernel.include` leaked methods onto BlankSlate
+   instances.
+
+## Changes made (minimal)
+
+- `lib/builder/xchar.rb`: `when Fixnum` → `when Integer` (1 line).
+- `lib/builder/xmlmarkup.rb`:
+  `def initialize(options={}, **kwargs)` — kwargs merged into options,
+  so `XmlMarkup.new(indent: 2, margin: 4)` works on Ruby 3 while
+  `new(:indent => 2)` keeps working.
+- `lib/builder/xmlmarkup.rb`:
+  `def instruct!(directive_tag=:xml, attrs={}, **kwargs)` — kwargs merged
+  into attrs, so `instruct!(:xml, encoding: "UTF-8")` works.
+- `Rakefile`: deleted the two `s.has_rdoc = true` lines (metadata only).
+- `rakelib/publish.rake`: wrapped the rake/contrib requires in
+  begin/rescue LoadError; the dead RubyForge publish task is defined only
+  when the contrib libraries exist.
+- `rakelib/tags.rake`: guarded the `` `rvm gemdir` `` probe with
+  rescue Errno::ENOENT; `File.exists?` → `File.exist?`.
+- `lib/blankslate.rb`: `Module#append_features` hook now also hides
+  methods from modules included into `Kernel` (was: `Object` only),
+  per the file's own comment.
+- `README.md`: added the "Keeper's Note" section with the mission
+  statement verbatim (Steve's directive). No other README changes.
+
+## Test results
+
+- BEFORE: `rake` aborted at load (items 2–4 above); after fixing load,
+  `require "builder"` raised NameError (item 1). Zero tests ran.
+- AFTER: `rake` → **113 tests, 192 assertions, 1 failure, 0 errors**
+  (99.1% pass).
+- The one failure is `test_targetted_private_methods_are_undefined_during_instance_eval`
+  (test/test_blankslate.rb, legacy standalone BlankSlate only —
+  Builder::XmlMarkup/XmlEvents use BasicObject on modern Ruby and are
+  fully green).
+- Also verified by hand: kwargs-style and hash-rocket-style calls for
+  `new`, tag attributes, and `instruct!`; XmlEvents event flow;
+  `rake -T` lists all tasks; `rake builder:gem` builds builder-3.2.2.gem
+  cleanly (pkg/ removed afterwards).
+
+## What remains — needs Steve's decision
+
+**The 1 failure is Ruby-language drift, not a library bug, and no
+correct library change can fix it.** Root cause, verified by experiment:
+BlankSlate never hid private methods (`Module#instance_methods` excludes
+privates, so `puts` was never undefined), and Ruby 2.7 deliberately
+legalized calling private methods with an explicit `self.` receiver.
+So `@bs.instance_eval { self.puts "HI" }` now succeeds where the 2004-era
+test expects NoMethodError. The library cannot distinguish `self.puts`
+from bare `puts` — and the sibling test
+`test_untargetted_private_methods_are_defined_during_instance_eval`
+*requires* bare `puts` to keep working. Undefining `puts` would fix this
+test and break that one; the two expectations are jointly unsatisfiable
+on Ruby ≥ 2.7.
+
+Options for Steve:
+  a. Accept the 1 known failure as documented Ruby drift in the dormant
+     blankslate component (it does not touch XML building), and ship with
+     the suite at 112/113.
+  b. Authorize updating that single test expectation to match Ruby ≥ 2.7
+     semantics (explicit-self private calls are legal now).
+  c. Drop the standalone blankslate gem from the keeper's tree entirely
+     (it was extracted upstream; builder itself doesn't use it on modern
+     Ruby).
+
+No action taken on the test — weakening a 2004 expectation without his
+word is not mine to do.
+
+## Notes
+
+- `git status`: 7 files modified (README.md, Rakefile, lib/blankslate.rb,
+  lib/builder/xchar.rb, lib/builder/xmlmarkup.rb, rakelib/publish.rake,
+  rakelib/tags.rake). No new files except this log. Nothing committed,
+  nothing pushed.
+- Authorship: all files still credit Jim Weirich; MIT-LICENSE untouched.
+  Keeper additions are marked "keeper" / "Keeper's Note" inline and in
+  this log only — never in gem metadata.

data/doc/jamis.rb

@@ -0,0 +1,591 @@
+module RDoc
+module Page
+
+FONTS = "\"Bitstream Vera Sans\", Verdana, Arial, Helvetica, sans-serif"
+
+STYLE = <<CSS
+a {
+  color: #00F;
+  text-decoration: none;
+}
+
+a:hover {
+  color: #77F;
+  text-decoration: underline;
+}
+
+body, td, p {
+  font-family: %fonts%;
+  background: #FFF;
+  color: #000;
+  margin: 0px;
+  font-size: small;
+}
+
+#content {
+  margin: 2em;
+}
+
+#description p {
+  margin-bottom: 0.5em;
+}
+
+.sectiontitle {
+  margin-top: 1em;
+  margin-bottom: 1em;
+  padding: 0.5em;
+  padding-left: 2em;
+  background: #005;
+  color: #FFF;
+  font-weight: bold;
+  border: 1px dotted black;
+}
+
+.attr-rw {
+  padding-left: 1em;
+  padding-right: 1em;
+  text-align: center;
+  color: #055;
+}
+
+.attr-name {
+  font-weight: bold;
+}
+
+.attr-desc {
+}
+
+.attr-value {
+  font-family: monospace;
+}
+
+.file-title-prefix {
+  font-size: large;
+}
+
+.file-title {
+  font-size: large;
+  font-weight: bold;
+  background: #005;
+  color: #FFF;
+}
+
+.banner {
+  background: #005;
+  color: #FFF;
+  border: 1px solid black;
+  padding: 1em;
+}
+
+.banner td {
+  background: transparent;
+  color: #FFF;
+}
+
+h1 a, h2 a, .sectiontitle a, .banner a {
+  color: #FF0;
+}
+
+h1 a:hover, h2 a:hover, .sectiontitle a:hover, .banner a:hover {
+  color: #FF7;
+}
+
+.dyn-source {
+  display: none;
+  background: #FFE;
+  color: #000;
+  border: 1px dotted black;
+  margin: 0.5em 2em 0.5em 2em;
+  padding: 0.5em;
+}
+
+.dyn-source .cmt {
+  color: #00F;
+  font-style: italic;
+}
+
+.dyn-source .kw {
+  color: #070;
+  font-weight: bold;
+}
+
+.method {
+  margin-left: 1em;
+  margin-right: 1em;
+  margin-bottom: 1em;
+}
+
+.description pre {
+  padding: 0.5em;
+  border: 1px dotted black;
+  background: #FFE;
+}
+
+.method .title {
+  font-family: monospace;
+  font-size: large;
+  border-bottom: 1px dashed black;
+  margin-bottom: 0.3em;
+  padding-bottom: 0.1em;
+}
+
+.method .description, .method .sourcecode {
+  margin-left: 1em;
+}
+
+.description p, .sourcecode p {
+  margin-bottom: 0.5em;
+}
+
+.method .sourcecode p.source-link {
+  text-indent: 0em;
+  margin-top: 0.5em;
+}
+
+.method .aka {
+  margin-top: 0.3em;
+  margin-left: 1em;
+  font-style: italic;
+  text-indent: 2em;
+}
+
+h1 {
+  padding: 1em;
+  border: 1px solid black;
+  font-size: x-large;
+  font-weight: bold;
+  color: #FFF;
+  background: #007;
+}
+
+h2 {
+  padding: 0.5em 1em 0.5em 1em;
+  border: 1px solid black;
+  font-size: large;
+  font-weight: bold;
+  color: #FFF;
+  background: #009;
+}
+
+h3, h4, h5, h6 {
+  padding: 0.2em 1em 0.2em 1em;
+  border: 1px dashed black;
+  color: #000;
+  background: #AAF;
+}
+
+.sourcecode > pre {
+  padding: 0.5em;
+  border: 1px dotted black;
+  background: #FFE;
+}
+
+CSS
+
+XHTML_PREAMBLE = %{<?xml version="1.0" encoding="%charset%"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+}
+
+HEADER = XHTML_PREAMBLE + <<ENDHEADER
+<html>
+  <head>
+    <title>%title%</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+    <link rel="stylesheet" href="%style_url%" type="text/css" media="screen" />
+
+    <script language="JavaScript" type="text/javascript">
+    // <![CDATA[
+
+        function toggleSource( id )
+        {
+          var elem
+          var link
+
+          if( document.getElementById )
+          {
+            elem = document.getElementById( id )
+            link = document.getElementById( "l_" + id )
+          }
+          else if ( document.all )
+          {
+            elem = eval( "document.all." + id )
+            link = eval( "document.all.l_" + id )
+          }
+          else
+            return false;
+
+          if( elem.style.display == "block" )
+          {
+            elem.style.display = "none"
+            link.innerHTML = "show source"
+          }
+          else
+          {
+            elem.style.display = "block"
+            link.innerHTML = "hide source"
+          }
+        }
+
+        function openCode( url )
+        {
+          window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
+        }
+      // ]]>
+    </script>
+  </head>
+
+  <body>
+ENDHEADER
+
+FILE_PAGE = <<HTML
+<table border='0' cellpadding='0' cellspacing='0' width="100%" class='banner'>
+  <tr><td>
+    <table width="100%" border='0' cellpadding='0' cellspacing='0'><tr>
+      <td class="file-title" colspan="2"><span class="file-title-prefix">File</span><br />%short_name%</td>
+      <td align="right">
+        <table border='0' cellspacing="0" cellpadding="2">
+          <tr>
+            <td>Path:</td>
+            <td>%full_path%
+IF:cvsurl
+				&nbsp;(<a href="%cvsurl%">CVS</a>)
+ENDIF:cvsurl
+            </td>
+          </tr>
+          <tr>
+            <td>Modified:</td>
+            <td>%dtm_modified%</td>
+          </tr>
+        </table>
+      </td></tr>
+    </table>
+  </td></tr>
+</table><br>
+HTML
+
+###################################################################
+
+CLASS_PAGE = <<HTML
+<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
+  <td class="file-title"><span class="file-title-prefix">%classmod%</span><br />%full_name%</td>
+  <td align="right">
+    <table cellspacing=0 cellpadding=2>
+      <tr valign="top">
+        <td>In:</td>
+        <td>
+START:infiles
+HREF:full_path_url:full_path:
+IF:cvsurl
+&nbsp;(<a href="%cvsurl%">CVS</a>)
+ENDIF:cvsurl
+END:infiles
+        </td>
+      </tr>
+IF:parent
+    <tr>
+      <td>Parent:</td>
+      <td>
+IF:par_url
+        <a href="%par_url%">
+ENDIF:par_url
+%parent%
+IF:par_url
+         </a>
+ENDIF:par_url
+     </td>
+   </tr>
+ENDIF:parent
+         </table>
+        </td>
+        </tr>
+      </table>
+HTML
+
+###################################################################
+
+METHOD_LIST = <<HTML
+  <div id="content">
+IF:diagram
+  <table cellpadding='0' cellspacing='0' border='0' width="100%"><tr><td align="center">
+    %diagram%
+  </td></tr></table>
+ENDIF:diagram
+
+IF:description
+  <div class="description">%description%</div>
+ENDIF:description
+
+IF:requires
+  <div class="sectiontitle">Required Files</div>
+  <ul>
+START:requires
+  <li>HREF:aref:name:</li>
+END:requires
+  </ul>
+ENDIF:requires
+
+IF:toc
+  <div class="sectiontitle">Contents</div>
+  <ul>
+START:toc
+  <li><a href="#%href%">%secname%</a></li>
+END:toc
+  </ul>
+ENDIF:toc
+
+IF:methods
+  <div class="sectiontitle">Methods</div>
+  <ul>
+START:methods
+  <li>HREF:aref:name:</li>
+END:methods
+  </ul>
+ENDIF:methods
+
+IF:includes
+<div class="sectiontitle">Included Modules</div>
+<ul>
+START:includes
+  <li>HREF:aref:name:</li>
+END:includes
+</ul>
+ENDIF:includes
+
+START:sections
+IF:sectitle
+<div class="sectiontitle"><a nem="%secsequence%">%sectitle%</a></div>
+IF:seccomment
+<div class="description">
+%seccomment%
+</div>
+ENDIF:seccomment
+ENDIF:sectitle
+
+IF:classlist
+  <div class="sectiontitle">Classes and Modules</div>
+  %classlist%
+ENDIF:classlist
+
+IF:constants
+  <div class="sectiontitle">Constants</div>
+  <table border='0' cellpadding='5'>
+START:constants
+  <tr valign='top'>
+    <td class="attr-name">%name%</td>
+    <td>=</td>
+    <td class="attr-value">%value%</td>
+  </tr>
+IF:desc
+  <tr valign='top'>
+    <td>&nbsp;</td>
+    <td colspan="2" class="attr-desc">%desc%</td>
+  </tr>
+ENDIF:desc
+END:constants
+  </table>
+ENDIF:constants
+
+IF:attributes
+  <div class="sectiontitle">Attributes</div>
+  <table border='0' cellpadding='5'>
+START:attributes
+  <tr valign='top'>
+    <td class='attr-rw'>
+IF:rw
+[%rw%]
+ENDIF:rw
+    </td>
+    <td class='attr-name'>%name%</td>
+    <td class='attr-desc'>%a_desc%</td>
+  </tr>
+END:attributes
+  </table>
+ENDIF:attributes
+
+IF:method_list
+START:method_list
+IF:methods
+<div class="sectiontitle">%type% %category% methods</div>
+START:methods
+<div class="method">
+  <div class="title">
+IF:callseq
+    <a name="%aref%"></a><b>%callseq%</b>
+ENDIF:callseq
+IFNOT:callseq
+    <a name="%aref%"></a><b>%name%</b>%params%
+ENDIF:callseq
+IF:codeurl
+[ <a href="javascript:openCode('%codeurl%')">source</a> ]
+ENDIF:codeurl
+  </div>
+IF:m_desc
+  <div class="description">
+  %m_desc%
+  </div>
+ENDIF:m_desc
+IF:aka
+<div class="aka">
+  This method is also aliased as
+START:aka
+  <a href="%aref%">%name%</a>
+END:aka
+</div>
+ENDIF:aka
+IF:sourcecode
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('%aref%_source')" id="l_%aref%_source">show source</a> ]</p>
+  <div id="%aref%_source" class="dyn-source">
+<pre>
+%sourcecode%
+</pre>
+  </div>
+</div>
+ENDIF:sourcecode
+</div>
+END:methods
+ENDIF:methods
+END:method_list
+ENDIF:method_list
+END:sections
+</div>
+HTML
+
+FOOTER = <<ENDFOOTER
+  </body>
+</html>
+ENDFOOTER
+
+BODY = HEADER + <<ENDBODY
+  !INCLUDE! <!-- banner header -->
+
+  <div id="bodyContent">
+    #{METHOD_LIST}
+  </div>
+
+  #{FOOTER}
+ENDBODY
+
+########################## Source code ##########################
+
+SRC_PAGE = XHTML_PREAMBLE + <<HTML
+<html>
+<head><title>%title%</title>
+<meta http-equiv="Content-Type" content="text/html; charset=%charset%">
+<style>
+.ruby-comment    { color: green; font-style: italic }
+.ruby-constant   { color: #4433aa; font-weight: bold; }
+.ruby-identifier { color: #222222;  }
+.ruby-ivar       { color: #2233dd; }
+.ruby-keyword    { color: #3333FF; font-weight: bold }
+.ruby-node       { color: #777777; }
+.ruby-operator   { color: #111111;  }
+.ruby-regexp     { color: #662222; }
+.ruby-value      { color: #662222; font-style: italic }
+  .kw { color: #3333FF; font-weight: bold }
+  .cmt { color: green; font-style: italic }
+  .str { color: #662222; font-style: italic }
+  .re  { color: #662222; }
+</style>
+</head>
+<body bgcolor="white">
+<pre>%code%</pre>
+</body>
+</html>
+HTML
+
+########################## Index ################################
+
+FR_INDEX_BODY = <<HTML
+!INCLUDE!
+HTML
+
+FILE_INDEX = XHTML_PREAMBLE + <<HTML
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=%charset%">
+<style>
+<!--
+  body {
+    background-color: #EEE;
+    font-family: #{FONTS}; 
+    color: #000;
+    margin: 0px;
+  }
+  .banner {
+    background: #005;
+    color: #FFF;
+    padding: 0.2em;
+    font-size: small;
+    font-weight: bold;
+    text-align: center;
+  }
+  .entries {
+    margin: 0.25em 1em 0 1em;
+    font-size: x-small;
+  }
+  a {
+    color: #00F;
+    text-decoration: none;
+    white-space: nowrap;
+  }
+  a:hover {
+    color: #77F;
+    text-decoration: underline;
+  }
+-->
+</style>
+<base target="docwin">
+</head>
+<body>
+<div class="banner">%list_title%</div>
+<div class="entries">
+START:entries
+<a href="%href%">%name%</a><br>
+END:entries
+</div>
+</body></html>
+HTML
+
+CLASS_INDEX = FILE_INDEX
+METHOD_INDEX = FILE_INDEX
+
+INDEX = XHTML_PREAMBLE + <<HTML
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>%title%</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=%charset%">
+</head>
+
+<frameset cols="20%,*">
+    <frameset rows="15%,35%,50%">
+        <frame src="fr_file_index.html"   title="Files" name="Files" />
+        <frame src="fr_class_index.html"  name="Classes" />
+        <frame src="fr_method_index.html" name="Methods" />
+    </frameset>
+IF:inline_source
+      <frame  src="%initial_page%" name="docwin">
+ENDIF:inline_source
+IFNOT:inline_source
+    <frameset rows="80%,20%">
+      <frame  src="%initial_page%" name="docwin">
+      <frame  src="blank.html" name="source">
+    </frameset>
+ENDIF:inline_source
+    <noframes>
+          <body bgcolor="white">
+            Click <a href="html/index.html">here</a> for a non-frames
+            version of this page.
+          </body>
+    </noframes>
+</frameset>
+
+</html>
+HTML
+
+end
+end
+
+