rfcxml 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5efe8a260bf98e3225ba28754c0fac980f1efb22d074086857215da8d3fda2e9
-  data.tar.gz: ab5895433c94c49a1f0f53a477d95a770713bdd43f6e5d52840a4008c9bd4ab0
+  metadata.gz: 53aebb436f8ea53c627fba3203b2fa9f0186b8f7ac0f4ffd794d2426728172ed
+  data.tar.gz: 7cac09e19781c1bbb31820aaa40bbc7df7f8cb35b7306fbc87496429cf1e7135
 SHA512:
-  metadata.gz: 2b96f27d45079fddbe254816477f7ca6d7a36e70271fbc54abe3d2d7aaafb27fd1dad991471dbbc847c5e3932f4d5f60bbd4c8aa72fc9718532fb89d123076a2
-  data.tar.gz: d50e0ecc6b2325dd398c2e43669e21d5ecca7437f083c894cea95f9710f2e5c4014fd37b5f92bae46db88949183e571ae08f43886dfd799ddea622e8c67587c9
+  metadata.gz: ea24ee3e3386a8907be82e4a54e6616900b75ec4143ff4bad0e6d79a6d6da8215d7350e778f8f07850156f4789ab010ebc5d0d82533fbaa3a6503496b3a50589
+  data.tar.gz: 3f3a69b7bfd73af3b56fac723256aabcc820c81b572003381ede682f41a0f84535f007465d0368a9644163f930673722f14817800b2e15986eeffcb3529c51c8

data/.rubocop_todo.yml

@@ -1,20 +1,42 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-01-07 10:02:25 UTC using RuboCop version 1.69.2.
+# on 2026-03-18 06:11:32 UTC using RuboCop version 1.85.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# Configuration parameters: Severity, Include.
-# Include: **/*.gemspec
+# This cop supports safe autocorrection (--autocorrect).
+Gemspec/RequireMFA:
+  Exclude:
+    - 'rfcxml.gemspec'
+
+# Offense count: 1
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'rfcxml.gemspec'
 
-# Offense count: 6
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 34
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: normal, indented_internal_methods
+Layout/IndentationConsistency:
+  Exclude:
+    - 'rfcxml.gemspec'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'lib/rfcxml/v3/li.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'rfcxml.gemspec'

data/Gemfile

@@ -2,11 +2,13 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in rfcxml.gemspec
+# Specify your gem's dependencies in genericode.gemspec
 gemspec
 
+gem "canon"
+gem "lutaml-model", github: "lutaml/lutaml-model", ref: "main"
+gem "nokogiri"
 gem "rake", "~> 13.0"
-
 gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+gem "rubocop"
+gem "rubocop-performance"

data/README.adoc

@@ -1,8 +1,27 @@
 = RFC XML Ruby library
 
-The `rfcxml` library is a parser and generator for RFC XML documents. It is
-intended to be used to parse and generate RFC XML v3 documents.
+The `rfcxml` library is a parser and generator for RFC XML v3 documents.
+It provides bidirectional XML serialization using the lutaml-model framework,
+enabling perfect round-trips with namespace preservation.
 
+== Features
+
+- Parse RFC XML v3 documents into Ruby objects
+- Generate RFC XML v3 documents from Ruby objects
+- Perfect round-trip preservation (namespaces, `xml:lang`, etc.)
+- Full support for all RFC XML v3 elements
+- Built on lutaml-model for declarative XML mapping
+
+== Requirements
+
+- Ruby >= 3.2.0
+- lutaml-model ~> 0.8.0 (required for namespace preservation and `xml:lang` support)
+
+The lutaml-model 0.8.0 dependency provides:
+
+- Automatic namespace declaration preservation (`xmlns:*` attributes)
+- Built-in `Lutaml::Xml::W3c::XmlLangType` for `xml:lang` attribute handling
+- Perfect XML round-trip support
 
 == Installation
 
@@ -27,47 +46,176 @@ Or install it yourself as:
 $ gem install rfcxml
 ----
 
+== Usage
 
+=== Parsing an RFC XML document
 
-== Usage
+[source,ruby]
+----
+require 'rfcxml'
 
-To parse an RFC XML document:
+# Parse from file
+xml = File.read('rfc8650.xml')
+rfc = Rfcxml::V3::Rfc.from_xml(xml)
+
+# Access document attributes
+puts rfc.number           # => "8650"
+puts rfc.category        # => "std"
+puts rfc.submission_type # => "IETF"
+
+# Access front matter
+puts rfc.front.title.to_s
+rfc.front.author.each do |author|
+  puts author.fullname
+end
+
+# Access sections
+rfc.middle.section.each do |section|
+  puts section.name
+end
+----
+
+=== Generating RFC XML
 
 [source,ruby]
 ----
 require 'rfcxml'
 
-rfc = Rfcxml::Document.new(File.read('rfc.xml'))
-puts rfc.title
-puts rfc.abstract
-puts rfc.sections
+# Create a new RFC document
+rfc = Rfcxml::V3::Rfc.new(
+  number: "1234",
+  category: "info",
+  submission_type: "IETF"
+)
+
+# Build front matter
+rfc.front = Rfcxml::V3::Front.new(
+  title: Rfcxml::V3::Title.new(content: "My RFC Title"),
+  author: [
+    Rfcxml::V3::Author.new(
+      fullname: "John Doe",
+      email: "john@example.com"
+    )
+  ]
+)
+
+# Build middle section
+rfc.middle = Rfcxml::V3::Middle.new(
+  section: [
+    Rfcxml::V3::Section.new(
+      name: Rfcxml::V3::Name.new(content: "Introduction"),
+      t: [
+        Rfcxml::V3::T.new(content: "This is the introduction.")
+      ]
+    )
+  ]
+)
+
+# Serialize to XML
+xml = rfc.to_xml(pretty: true, declaration: true, encoding: "utf-8")
+puts xml
 ----
 
-To generate an RFC XML document:
+=== Round-trip preservation
+
+The library preserves all XML structure during round-trips:
 
 [source,ruby]
 ----
 require 'rfcxml'
 
-rfc = Rfcxml::Document.new
-rfc.title = 'An RFC Title'
-rfc.abstract = 'An RFC Abstract'
-rfc.sections = [
-  Rfcxml::Section.new('Section 1', 'This is the first section'),
-  Rfcxml::Section.new('Section 2', 'This is the second section')
-]
+# Parse
+input = File.read('rfc.xml')
+rfc = Rfcxml::V3::Rfc.from_xml(input)
+
+# Serialize back
+output = rfc.to_xml(pretty: true, declaration: true, encoding: "utf-8")
 
-puts rfc.to_xml
+# The output preserves:
+# - xml:lang attribute
+# - xmlns:* namespace declarations (e.g., xmlns:xi for XInclude)
+# - All element structure and content
 ----
 
+== Document Structure
+
+The RFC XML v3 structure maps to these Ruby classes:
+
+[cols="2,3"]
+|===
+| Ruby Class | XML Element
+
+| `Rfcxml::V3::Rfc` | `<rfc>` (root)
+| `Rfcxml::V3::Front` | `<front>`
+| `Rfcxml::V3::Middle` | `<middle>`
+| `Rfcxml::V3::Back` | `<back>`
+| `Rfcxml::V3::Title` | `<title>`
+| `Rfcxml::V3::Author` | `<author>`
+| `Rfcxml::V3::Section` | `<section>`
+| `Rfcxml::V3::T` | `<t>`
+| `Rfcxml::V3::List` | `<ul>`, `<ol>`, `<dl>`
+| `Rfcxml::V3::Figure` | `<figure>`
+| `Rfcxml::V3::Table` | `<table>`
+| `Rfcxml::V3::References` | `<references>`
+| `Rfcxml::V3::Reference` | `<reference>`
+|===
+
+== Serialization Options
+
+The `to_xml` method supports these options:
+
+[cols="1,1,3"]
+|===
+| Option | Default | Description
+
+| `:pretty` | `false` | Pretty-print XML with indentation
+| `:declaration` | `false` | Include XML declaration
+| `:encoding` | `"utf-8"` | Set encoding in XML declaration
+| `:omit_doctype` | `false` | Omit DOCTYPE declaration
+|===
 
+Example:
+
+[source,ruby]
+----
+xml = rfc.to_xml(
+  pretty: true,
+  declaration: true,
+  encoding: "utf-8"
+)
+----
+
+== Development
+
+After checking out the repo, run:
+
+[source]
+----
+$ bundle install
+$ bundle exec rake
+----
+
+This runs tests + linting. To run tests only:
+
+[source]
+----
+$ bundle exec rake spec
+----
+
+== Architecture
+
+The library uses lutaml-model for XML serialization:
+
+- All elements inherit from `Lutaml::Model::Serializable`
+- Attributes are declared with `attribute` class method
+- XML mapping is defined in `xml do ... end` block
+- Circular references use string class names (e.g., `"Rfcxml::V3::Section"`)
 
 == Contributing
 
 Bug reports and pull requests are welcome on GitHub at
 https://github.com/metanorma/rfcxml.
 
-
 == Copyright and license
 
 The gem is available as open source under the terms of the BSD 2-clause license.

data/lib/rfcxml/v3/abstract.rb

@@ -2,11 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "dl"
-require_relative "ol"
-require_relative "text"
-require_relative "ul"
-
 module Rfcxml
   module V3
     class Abstract < Lutaml::Model::Serializable

data/lib/rfcxml/v3/address.rb

@@ -2,12 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "email"
-require_relative "facsimile"
-require_relative "phone"
-require_relative "postal"
-require_relative "uri"
-
 module Rfcxml
   module V3
     class Address < Lutaml::Model::Serializable

data/lib/rfcxml/v3/annotation.rb

@@ -2,20 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "bcp14"
-require_relative "cref"
-require_relative "em"
-require_relative "eref"
-require_relative "iref"
-require_relative "relref"
-require_relative "spanx"
-require_relative "strong"
-require_relative "sub"
-require_relative "sup"
-require_relative "tt"
-require_relative "u"
-require_relative "xref"
-
 module Rfcxml
   module V3
     class Annotation < Lutaml::Model::Serializable

data/lib/rfcxml/v3/artset.rb

@@ -2,8 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "artwork"
-
 module Rfcxml
   module V3
     class Artset < Lutaml::Model::Serializable

data/lib/rfcxml/v3/artwork.rb

@@ -23,11 +23,11 @@ module Rfcxml
         map_content to: :content
         map_attribute "anchor", to: :anchor
         map_attribute "pn", to: :pn
-        map_attribute "name", to: :name
-        map_attribute "type", to: :type
+        map_attribute "name", to: :name, value_map: { to: { empty: :empty } }
+        map_attribute "type", to: :type, value_map: { to: { empty: :empty } }
         map_attribute "src", to: :src
         map_attribute "align", to: :align
-        map_attribute "alt", to: :alt
+        map_attribute "alt", to: :alt, value_map: { to: { empty: :empty } }
         map_attribute "width", to: :width
         map_attribute "height", to: :height
         map_attribute "originalSrc", to: :original_src

data/lib/rfcxml/v3/aside.rb

@@ -2,17 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "artset"
-require_relative "artwork"
-require_relative "blockquote"
-require_relative "dl"
-require_relative "figure"
-require_relative "iref"
-require_relative "ol"
-require_relative "text"
-require_relative "table"
-require_relative "ul"
-
 module Rfcxml
   module V3
     class Aside < Lutaml::Model::Serializable

data/lib/rfcxml/v3/author.rb

@@ -2,9 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "address"
-require_relative "organization"
-
 module Rfcxml
   module V3
     class Author < Lutaml::Model::Serializable

data/lib/rfcxml/v3/back.rb

@@ -2,10 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "displayreference"
-require_relative "references"
-require_relative "section"
-
 module Rfcxml
   module V3
     class Back < Lutaml::Model::Serializable

data/lib/rfcxml/v3/blockquote.rb

@@ -2,33 +2,8 @@
 
 require "lutaml/model"
 
-require_relative "artset"
-require_relative "artwork"
-require_relative "bcp14"
-require_relative "br"
-require_relative "cref"
-require_relative "dl"
-require_relative "em"
-require_relative "eref"
-require_relative "figure"
-require_relative "iref"
-# require_relative "ol"
-require_relative "relref"
-require_relative "sourcecode"
-require_relative "strong"
-require_relative "sub"
-require_relative "sup"
-require_relative "text"
-require_relative "tt"
-require_relative "u"
-require_relative "ul"
-require_relative "xref"
-
 module Rfcxml
   module V3
-    class Ol < Lutaml::Model::Serializable; end
-    class Dl < Lutaml::Model::Serializable; end
-
     class Blockquote < Lutaml::Model::Serializable
       attribute :content, :string
       attribute :anchor, :string
@@ -65,27 +40,11 @@ module Rfcxml
         map_attribute "pn", to: :pn
         map_attribute "cite", to: :cite
         map_attribute "quotedFrom", to: :quoted_from
-        map_element "artset", to: :artset
-        map_element "artwork", to: :artwork
-        map_element "dl", to: :dl
-        map_element "figure", to: :figure
-        map_element "ol", to: :ol
-        map_element "sourcecode", to: :sourcecode
-        map_element "t", to: :t
-        map_element "ul", to: :ul
-        map_element "bcp14", to: :bcp14
-        map_element "br", to: :br
-        map_element "cref", to: :cref
-        map_element "em", to: :em
-        map_element "eref", to: :eref
-        map_element "iref", to: :iref
-        map_element "relref", to: :relref
-        map_element "strong", to: :strong
-        map_element "sub", to: :sub
-        map_element "sup", to: :sup
-        map_element "tt", to: :tt
-        map_element "u", to: :u
-        map_element "xref", to: :xref
+
+        %w[artset artwork dl figure ol sourcecode t ul bcp14 br cref em eref
+           iref relref strong sub sup tt u xref].each do |element|
+          map_element element, to: element.to_sym
+        end
       end
     end
   end

data/lib/rfcxml/v3/boilerplate.rb

@@ -2,8 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "section"
-
 module Rfcxml
   module V3
     class Boilerplate < Lutaml::Model::Serializable

data/lib/rfcxml/v3/c.rb

@@ -2,12 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "cref"
-require_relative "eref"
-require_relative "iref"
-require_relative "spanx"
-require_relative "xref"
-
 module Rfcxml
   module V3
     class C < Lutaml::Model::Serializable

data/lib/rfcxml/v3/contact.rb

@@ -2,9 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "address"
-require_relative "organization"
-
 module Rfcxml
   module V3
     class Contact < Lutaml::Model::Serializable

data/lib/rfcxml/v3/cref.rb

@@ -2,16 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "br"
-require_relative "em"
-require_relative "eref"
-require_relative "relref"
-require_relative "strong"
-require_relative "sub"
-require_relative "sup"
-require_relative "tt"
-require_relative "xref"
-
 module Rfcxml
   module V3
     class Cref < Lutaml::Model::Serializable

data/lib/rfcxml/v3/dd.rb

@@ -2,30 +2,6 @@
 
 require "lutaml/model"
 
-require_relative "artset"
-require_relative "artwork"
-require_relative "aside"
-require_relative "bcp14"
-require_relative "br"
-require_relative "cref"
-require_relative "dl"
-require_relative "em"
-require_relative "eref"
-require_relative "figure"
-require_relative "iref"
-require_relative "ol"
-require_relative "relref"
-require_relative "sourcecode"
-require_relative "strong"
-require_relative "sub"
-require_relative "sup"
-require_relative "text"
-require_relative "table"
-require_relative "tt"
-require_relative "u"
-require_relative "ul"
-require_relative "xref"
-
 module Rfcxml
   module V3
     class Dd < Lutaml::Model::Serializable
@@ -63,29 +39,11 @@ module Rfcxml
         map_content to: :content
         map_attribute "anchor", to: :anchor
         map_attribute "pn", to: :pn
-        map_element "artset", to: :artset
-        map_element "artwork", to: :artwork
-        map_element "aside", to: :aside
-        map_element "dl", to: :dl
-        map_element "figure", to: :figure
-        map_element "ol", to: :ol
-        map_element "sourcecode", to: :sourcecode
-        map_element "t", to: :t
-        map_element "table", to: :table
-        map_element "ul", to: :ul
-        map_element "bcp14", to: :bcp14
-        map_element "br", to: :br
-        map_element "cref", to: :cref
-        map_element "em", to: :em
-        map_element "eref", to: :eref
-        map_element "iref", to: :iref
-        map_element "relref", to: :relref
-        map_element "strong", to: :strong
-        map_element "sub", to: :sub
-        map_element "sup", to: :sup
-        map_element "tt", to: :tt
-        map_element "u", to: :u
-        map_element "xref", to: :xref
+
+        %w[artset artwork aside dl figure ol sourcecode t table ul bcp14 br
+           cref em eref iref relref strong sub sup tt u xref].each do |element|
+          map_element element, to: element.to_sym
+        end
       end
     end
   end

data/lib/rfcxml/v3/dl.rb

@@ -2,14 +2,8 @@
 
 require "lutaml/model"
 
-require_relative "dd"
-require_relative "dt"
-
 module Rfcxml
   module V3
-    # class Dd < Lutaml::Model::Serializable; end
-    # class Dt < Lutaml::Model::Serializable; end
-
     class Dl < Lutaml::Model::Serializable
       attribute :anchor, :string
       attribute :spacing, :string, default: -> { "normal" }

data/lib/rfcxml/v3/dt.rb

@@ -2,19 +2,6 @@
 
 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 "tt"
-require_relative "xref"
-
 module Rfcxml
   module V3
     class Dt < Lutaml::Model::Serializable
@@ -40,18 +27,11 @@ module Rfcxml
         map_content to: :content
         map_attribute "anchor", to: :anchor
         map_attribute "pn", to: :pn
-        map_element "bcp14", to: :bcp14
-        map_element "br", to: :br
-        map_element "cref", to: :cref
-        map_element "em", to: :em
-        map_element "eref", to: :eref
-        map_element "iref", to: :iref
-        map_element "relref", to: :relref
-        map_element "strong", to: :strong
-        map_element "sub", to: :sub
-        map_element "sup", to: :sup
-        map_element "tt", to: :tt
-        map_element "xref", to: :xref
+
+        %w[bcp14 br cref em eref iref relref strong sub sup tt
+           xref].each do |element|
+          map_element element, to: element.to_sym
+        end
       end
     end
   end