rfcxml 0.2.1 → 0.4.0

data/lib/rfcxml/v3/tt.rb

@@ -2,38 +2,24 @@
 
 require "lutaml/model"
 
-require_relative "bcp14"
-require_relative "br"
-require_relative "cref"
-require_relative "em"
-require_relative "eref"
-require_relative "iref"
-require_relative "relref"
-require_relative "strong"
-require_relative "sub"
-require_relative "sup"
-require_relative "xref"
-
 module Rfcxml
   module V3
-    class Cref < Lutaml::Model::Serializable; end
-
     class Tt < Lutaml::Model::Serializable
       attribute :content, :string
       attribute :bcp14, Bcp14, collection: true
       attribute :br, Br, collection: true
       attribute :cref, Cref, collection: true
-      attribute :em, Em, collection: true
+      attribute :em, "Rfcxml::V3::Em", collection: true
       attribute :eref, Eref, collection: true
       attribute :iref, Iref, collection: true
       attribute :relref, Relref, collection: true
-      attribute :strong, Strong, collection: true
-      attribute :sub, Sub, collection: true
-      attribute :sup, Sup, collection: true
+      attribute :strong, "Rfcxml::V3::Strong", collection: true
+      attribute :sub, "Rfcxml::V3::Sub", collection: true
+      attribute :sup, "Rfcxml::V3::Sup", collection: true
       attribute :xref, Xref, collection: true
 
       xml do
-        root "tt"
+        element "tt"
 
         map_content to: :content
         map_element "bcp14", to: :bcp14

data/lib/rfcxml/v3/ttcol.rb

@@ -2,24 +2,21 @@
 
 require "lutaml/model"
 
-require_relative "cref"
-require_relative "eref"
-require_relative "iref"
-require_relative "xref"
-
 module Rfcxml
   module V3
     class Ttcol < Lutaml::Model::Serializable
       attribute :content, :string
       attribute :width, :string
-      attribute :align, :string, default: -> { "left" }
+      attribute :align, :string,
+                values: %w[left center right],
+                default: -> { "left" }
       attribute :cref, Cref, collection: true
       attribute :eref, Eref, collection: true
       attribute :iref, Iref, collection: true
       attribute :xref, Xref, collection: true
 
       xml do
-        root "ttcol"
+        element "ttcol"
 
         map_content to: :content
         map_attribute "width", to: :width

data/lib/rfcxml/v3/u.rb

@@ -12,7 +12,7 @@ module Rfcxml
       attribute :pn, :string
 
       xml do
-        root "u"
+        element "u"
 
         map_content to: :content
         map_attribute "anchor", to: :anchor

data/lib/rfcxml/v3/ul.rb

@@ -4,19 +4,23 @@ require "lutaml/model"
 
 module Rfcxml
   module V3
-    class Li < Lutaml::Model::Serializable; end
-
     class Ul < Lutaml::Model::Serializable
       attribute :anchor, :string
-      attribute :spacing, :string, default: -> { "normal" }
-      attribute :empty, :string, default: -> { "false" }
-      attribute :bare, :string, default: -> { "false" }
+      attribute :spacing, :string,
+                values: %w[normal compact],
+                default: -> { "normal" }
+      attribute :empty, :string,
+                values: %w[true false],
+                default: -> { "false" }
+      attribute :bare, :string,
+                values: %w[true false],
+                default: -> { "false" }
       attribute :indent, :string, default: -> { "3" }
       attribute :pn, :string
       attribute :li, Li, collection: true
 
       xml do
-        root "ul"
+        element "ul"
 
         map_attribute "anchor", to: :anchor
         map_attribute "spacing", to: :spacing

data/lib/rfcxml/v3/uri.rb

@@ -8,7 +8,7 @@ module Rfcxml
       attribute :content, :string
 
       xml do
-        root "uri"
+        element "uri"
 
         map_content to: :content
       end

data/lib/rfcxml/v3/vspace.rb

@@ -8,7 +8,7 @@ module Rfcxml
       attribute :blank_lines, :string, default: -> { "0" }
 
       xml do
-        root "vspace"
+        element "vspace"
 
         map_attribute "blankLines", to: :blank_lines
       end

data/lib/rfcxml/v3/workgroup.rb

@@ -8,7 +8,7 @@ module Rfcxml
       attribute :content, :string
 
       xml do
-        root "workgroup"
+        element "workgroup"
 
         map_content to: :content
       end

data/lib/rfcxml/v3/xref.rb

@@ -2,8 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "xref_text"
-
 module Rfcxml
   module V3
     class Xref < Lutaml::Model::Serializable
@@ -19,7 +17,8 @@ module Rfcxml
       include XrefText
 
       xml do
-        root "xref"
+        element "xref"
+        mixed_content
 
         map_content to: :content
         map_attribute "target", to: :target

data/lib/rfcxml/v3/xref_text.rb

@@ -1,28 +1,19 @@
 # frozen_string_literal: true
 
-# require_relative "em"
-# require_relative "strong"
-# require_relative "sub"
-# require_relative "sup"
-# require_relative "tt"
 require "lutaml/model"
 
 module Rfcxml
   module V3
-    class Strong < Lutaml::Model::Serializable; end
-    class Em < Strong; end
-    class Sub < Lutaml::Model::Serializable; end
-    class Sup < Sub; end
-    class Tt < Lutaml::Model::Serializable; end
-
+    # Mixin module for common text formatting elements
+    # Included by Xref, Refcontent, and other elements
     module XrefText
       def self.included(base)
         base.class_eval do
-          attribute :em, ::Rfcxml::V3::Em, collection: true
-          attribute :strong, V3::Strong, collection: true
-          attribute :sub, V3::Sub, collection: true
-          attribute :sup, V3::Sup, collection: true
-          attribute :tt, V3::Tt, collection: true
+          attribute :em, "Rfcxml::V3::Em", collection: true
+          attribute :strong, "Rfcxml::V3::Strong", collection: true
+          attribute :sub, "Rfcxml::V3::Sub", collection: true
+          attribute :sup, "Rfcxml::V3::Sup", collection: true
+          attribute :tt, "Rfcxml::V3::Tt", collection: true
         end
       end
     end

data/lib/rfcxml/v3.rb

@@ -1,8 +1,106 @@
 # frozen_string_literal: true
 
-require_relative "v3/rfc"
-
 module Rfcxml
   module V3
+    # Core document structure
+    autoload :Rfc, "#{__dir__}/v3/rfc"
+    autoload :Front, "#{__dir__}/v3/front"
+    autoload :Middle, "#{__dir__}/v3/middle"
+    autoload :Back, "#{__dir__}/v3/back"
+
+    # Front matter elements
+    autoload :Abstract, "#{__dir__}/v3/abstract"
+    autoload :Annotation, "#{__dir__}/v3/annotation"
+    autoload :Area, "#{__dir__}/v3/area"
+    autoload :Author, "#{__dir__}/v3/author"
+    autoload :Contact, "#{__dir__}/v3/contact"
+    autoload :Date, "#{__dir__}/v3/date"
+    autoload :Keyword, "#{__dir__}/v3/keyword"
+    autoload :Note, "#{__dir__}/v3/note"
+    autoload :Organization, "#{__dir__}/v3/organization"
+    autoload :Title, "#{__dir__}/v3/title"
+    autoload :Workgroup, "#{__dir__}/v3/workgroup"
+
+    # Address elements
+    autoload :Address, "#{__dir__}/v3/address"
+    autoload :City, "#{__dir__}/v3/city"
+    autoload :Cityarea, "#{__dir__}/v3/cityarea"
+    autoload :Country, "#{__dir__}/v3/country"
+    autoload :Email, "#{__dir__}/v3/email"
+    autoload :Extaddr, "#{__dir__}/v3/extaddr"
+    autoload :Facsimile, "#{__dir__}/v3/facsimile"
+    autoload :Phone, "#{__dir__}/v3/phone"
+    autoload :Pobox, "#{__dir__}/v3/pobox"
+    autoload :Postal, "#{__dir__}/v3/postal"
+    autoload :PostalLine, "#{__dir__}/v3/postal_line"
+    autoload :Region, "#{__dir__}/v3/region"
+    autoload :Sortingcode, "#{__dir__}/v3/sortingcode"
+    autoload :Street, "#{__dir__}/v3/street"
+    autoload :Uri, "#{__dir__}/v3/uri"
+
+    # Body elements
+    autoload :Section, "#{__dir__}/v3/section"
+    autoload :Aside, "#{__dir__}/v3/aside"
+    autoload :Blockquote, "#{__dir__}/v3/blockquote"
+    autoload :Boilerplate, "#{__dir__}/v3/boilerplate"
+    autoload :Figure, "#{__dir__}/v3/figure"
+    autoload :Ol, "#{__dir__}/v3/ol"
+    autoload :Ul, "#{__dir__}/v3/ul"
+    autoload :Li, "#{__dir__}/v3/li"
+    autoload :Dl, "#{__dir__}/v3/dl"
+    autoload :Dt, "#{__dir__}/v3/dt"
+    autoload :Dd, "#{__dir__}/v3/dd"
+    autoload :Table, "#{__dir__}/v3/table"
+    autoload :Tbody, "#{__dir__}/v3/tbody"
+    autoload :Tfoot, "#{__dir__}/v3/tfoot"
+    autoload :Thead, "#{__dir__}/v3/thead"
+    autoload :Tr, "#{__dir__}/v3/tr"
+    autoload :Td, "#{__dir__}/v3/td"
+    autoload :Th, "#{__dir__}/v3/th"
+
+    # Inline text elements
+    autoload :Bcp14, "#{__dir__}/v3/bcp14"
+    autoload :Br, "#{__dir__}/v3/br"
+    autoload :C, "#{__dir__}/v3/c"
+    autoload :Code, "#{__dir__}/v3/code"
+    autoload :Cref, "#{__dir__}/v3/cref"
+    autoload :Em, "#{__dir__}/v3/strong" # Em is defined in strong.rb
+    autoload :Eref, "#{__dir__}/v3/eref"
+    autoload :Iref, "#{__dir__}/v3/iref"
+    autoload :Name, "#{__dir__}/v3/name"
+    autoload :Postamble, "#{__dir__}/v3/postamble"
+    autoload :Preamble, "#{__dir__}/v3/preamble"
+    autoload :Relref, "#{__dir__}/v3/relref"
+    autoload :Spanx, "#{__dir__}/v3/spanx"
+    autoload :Strong, "#{__dir__}/v3/strong"
+    autoload :Sub, "#{__dir__}/v3/sub"
+    autoload :Sup, "#{__dir__}/v3/sup"
+    autoload :Tt, "#{__dir__}/v3/tt"
+    autoload :U, "#{__dir__}/v3/u"
+    autoload :Xref, "#{__dir__}/v3/xref"
+    autoload :XrefText, "#{__dir__}/v3/xref_text"
+
+    # Artwork and code elements
+    autoload :Artset, "#{__dir__}/v3/artset"
+    autoload :Artwork, "#{__dir__}/v3/artwork"
+    autoload :Sourcecode, "#{__dir__}/v3/sourcecode"
+
+    # References
+    autoload :Displayreference, "#{__dir__}/v3/displayreference"
+    autoload :Refcontent, "#{__dir__}/v3/refcontent"
+    autoload :Reference, "#{__dir__}/v3/reference"
+    autoload :Referencegroup, "#{__dir__}/v3/referencegroup"
+    autoload :References, "#{__dir__}/v3/references"
+
+    # Other elements
+    autoload :Format, "#{__dir__}/v3/format"
+    autoload :Link, "#{__dir__}/v3/link"
+    autoload :List, "#{__dir__}/v3/list"
+    autoload :SeriesInfo, "#{__dir__}/v3/series_info"
+    autoload :Text, "#{__dir__}/v3/text"
+    autoload :Texttable, "#{__dir__}/v3/texttable"
+    autoload :Toc, "#{__dir__}/v3/toc"
+    autoload :Ttcol, "#{__dir__}/v3/ttcol"
+    autoload :Vspace, "#{__dir__}/v3/vspace"
   end
 end

data/lib/rfcxml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rfcxml
-  VERSION = "0.2.1"
+  VERSION = "0.4.0"
 end

data/lib/rfcxml.rb

@@ -1,17 +1,16 @@
 # frozen_string_literal: true
 
 require "lutaml/model"
+require "lutaml/xml"
 
 Lutaml::Model::Config.configure do |config|
-  require "lutaml/model/xml_adapter/nokogiri_adapter"
-  config.xml_adapter = Lutaml::Model::XmlAdapter::NokogiriAdapter
+  config.xml_adapter_type = :nokogiri
 end
 
 module Rfcxml
   class Error < StandardError; end
 
-  # Your code goes here...
+  autoload :Version, "#{__dir__}/rfcxml/version"
 end
 
-require_relative "rfcxml/version"
 require_relative "rfcxml/v3"

data/rfcxml.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "https://github.com/metanorma/rfcxml/releases"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`
@@ -26,8 +27,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.2.0"
 
-  spec.add_dependency "lutaml-model", "~> 0.7"
+  spec.add_dependency "lutaml-model", "~> 0.8.0"
   spec.add_dependency "nokogiri"
 end

data/scripts/README.md

@@ -0,0 +1,110 @@
+# RFC XML Round-Trip Test Script
+
+## Purpose
+
+Test round-trip parsing of RFC XML v3 files using Canon gem for semantic comparison.
+
+**Process:** XML → Parse → Serialize → Compare
+
+## Usage
+
+```bash
+# Test single file
+ruby scripts/roundtrip_test.rb spec/xmlsource-rfc8650-latest/rfc8704.xml
+
+# Test multiple files
+ruby scripts/roundtrip_test.rb file1.xml file2.xml file3.xml
+
+# Test all files in directory
+ruby scripts/roundtrip_test.rb spec/xmlsource-rfc8650-latest/
+
+# Test with glob pattern
+ruby scripts/roundtrip_test.rb "spec/xmlsource-rfc8650-latest/rfc87*.xml"
+
+# Test all 920 files (default)
+ruby scripts/roundtrip_test.rb
+```
+
+## Environment Variables
+
+| Variable  | Default | Description                    |
+|-----------|---------|--------------------------------|
+| `THREADS` | 8       | Number of worker threads       |
+| `VERBOSE` | false   | Show per-file progress         |
+
+```bash
+THREADS=1 VERBOSE=1 ruby scripts/roundtrip_test.rb file.xml
+```
+
+## Output
+
+Test results are written to `tmp/roundtrip-results-{timestamp}/`:
+
+```
+tmp/roundtrip-results-20260318_200000/
+  SUMMARY.yml              # Overall summary (YAML)
+  PASS_{filename}          # Empty marker for passed tests
+  FAIL_{filename}.yml      # Structured failure details
+  ERROR_{filename}.yml     # Structured error details
+  SOURCE_{filename}        # Round-tripped output for debugging
+```
+
+### SUMMARY.yml Structure
+
+```yaml
+timestamp: "2026-03-18T20:00:00+08:00"
+configuration:
+  threads: 8
+  files_tested: 920
+  elapsed_seconds: 664.75
+results:
+  passed: 833
+  failed: 83
+  errors: 4
+  pass_rate: "90.5%"
+failed_files:
+  - rfc8704.xml
+  - rfc8705.xml
+error_files:
+  - rfc8650.xml
+```
+
+### FAIL_*.yml Structure
+
+```yaml
+source_file: spec/xmlsource-rfc8650-latest/rfc8704.xml
+status: failed
+normative_differences: 1
+total_differences: 267
+differences:
+  - path: /rfc[1]/back[1]/references/reference/front/author
+    dimension: attribute_presence
+    reason: "only in first: initials, surname"
+    normative: true
+    formatting:
+    attributes_before: { initials: "", surname: "" }
+    attributes_after: {}
+```
+
+## Known Issues
+
+### Threading Bug (4 files)
+
+When using `THREADS > 1`, some files fail with:
+```
+NoMethodError: undefined method 'transform' for nil
+```
+
+Affected files: rfc8650.xml, rfc8651.xml, rfc8654.xml, rfc8657.xml
+
+**Workaround:** Use `THREADS=1` for these files.
+
+### Empty Attribute Handling
+
+Some models need `value_map: { to: { empty: :empty } }` to preserve empty string attributes during round-trip.
+
+## Dependencies
+
+- `rfcxml` gem - RFC XML parsing
+- `canon` gem - Semantic XML comparison
+- `lutaml-model` - XML serialization