rfcxml 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 503aee54b71c3f54fdb6b0fe202b6b4d444e6b8e9a37f9a764e4fe1c6a579bdb
-  data.tar.gz: 320c1c22d864595249496e13b7b65ed1d85c5dc39f9e2d3659a8d21b9189a911
+  metadata.gz: afc99ca4a6eb6ccc3fb1a220ac8a1945df6e823b15b86fd5003761c694e9e7be
+  data.tar.gz: 853d640f0e92ae96797e4bc79b0960f715e3a1d4bc4cc53c2e0763f62ce70c04
 SHA512:
-  metadata.gz: ffb1d8ec0b4fadc8e8935de090d0b4761f5b1a485d0327eaba7262368199fcac2fb49a6aafd019eecdbb0e6bf6436fc428faaef5eb3ce96d9f4a9b84a60145e4
-  data.tar.gz: c30eabc921018fbc976275e344c0e95c20607af406ab26c4e5edd0f6d73bae4d03a8b18da099e6d82648797c7b57bb15b9477c45558c84ad9ae23445ff46f1e4
+  metadata.gz: 15e6b2ba34f404d084620f9c8991733ad794c023773d566508c263d2941fd358b579b4011011d8ef22827398a8e46acf832e0717e8013dc670a1a7ec0269b589
+  data.tar.gz: '0021048cb9d05a37f21261f8c054cbf9bfc8a234e04fc39b47970efe4c13314126aaf27fa6695aeea3318da19a5a18985a3e58323172da729987705cad1d0328'

data/.github/workflows/roundtrip.yml

@@ -59,21 +59,12 @@ jobs:
         run: |
           echo "Testing all RFC XML files..."
           ruby scripts/roundtrip_test.rb "$XML_DIR"
-        continue-on-error: true
-        id: roundtrip
 
       - name: Upload test results
         if: always()
         uses: actions/upload-artifact@v4
         with:
           name: roundtrip-results
-          path: |
-            *.log
+          path: tmp/roundtrip-results-*/
           retention-days: 30
-          if-no-files-found: ignore
-
-      - name: Check results
-        if: steps.roundtrip.outcome == 'failure'
-        run: |
-          echo "::error::Some RFC XML files failed round-trip testing"
-          exit 1
+          if-no-files-found: warn

data/.gitignore

@@ -14,3 +14,4 @@
 .rspec_status
 
 Gemfile.lock
+TODO*

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-04-22 22:54:22 UTC using RuboCop version 1.86.1.
+# on 2026-05-01 09:55:57 UTC using RuboCop version 1.86.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
@@ -11,7 +11,40 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'rfcxml.gemspec'
 
-# Offense count: 20
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
+  Exclude:
+    - 'spec/v3/cref_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/BlockEndNewline:
+  Exclude:
+    - 'spec/v3/cref_spec.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Exclude:
+    - 'lib/rfcxml/v3/td.rb'
+    - 'spec/v3/rfc_pi_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Width, EnforcedStyleAlignWith, AllowedPatterns.
+# SupportedStylesAlignWith: start_of_line, relative_to_receiver
+Layout/IndentationWidth:
+  Exclude:
+    - 'spec/v3/cref_spec.rb'
+
+# Offense count: 28
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
@@ -20,7 +53,17 @@ Layout/LineLength:
     - 'lib/rfcxml/v3/li.rb'
     - 'lib/rfcxml/v3/rfc.rb'
     - 'scripts/roundtrip_test.rb'
+    - 'spec/v3/cref_spec.rb'
     - 'spec/v3/document_creation_spec.rb'
+    - 'spec/v3/rfc_pi_spec.rb'
+    - 'spec/v3/td_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'spec/v3/rfc_pi_spec.rb'
 
 # Offense count: 4
 Lint/NoReturnInBeginEndBlocks:
@@ -59,31 +102,51 @@ Metrics/PerceivedComplexity:
     - 'lib/rfcxml/v3/rfc.rb'
     - 'scripts/roundtrip_test.rb'
 
+# Offense count: 1
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'scripts/roundtrip_test.rb'
+
 # Offense count: 1
 # Configuration parameters: IgnoredMetadata.
 RSpec/DescribeClass:
   Exclude:
     - 'spec/v3/document_creation_spec.rb'
 
-# Offense count: 11
+# Offense count: 20
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 29
 
-# Offense count: 11
+# Offense count: 25
 RSpec/MultipleExpectations:
   Max: 9
 
-# Offense count: 3
+# Offense count: 6
 # Configuration parameters: CustomTransform, IgnoreMethods, IgnoreMetadata, InflectorPath, EnforcedInflector.
 # SupportedInflectors: default, active_support
 RSpec/SpecFilePathFormat:
   Exclude:
     - 'spec/v3/author_spec.rb'
+    - 'spec/v3/cref_spec.rb'
+    - 'spec/v3/rfc_pi_spec.rb'
     - 'spec/v3/rfc_spec.rb'
     - 'spec/v3/section_spec.rb'
+    - 'spec/v3/td_spec.rb'
 
 # Offense count: 1
 Security/Open:
   Exclude:
     - 'Rakefile'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# AllowedMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/v3/cref_spec.rb'

data/CLAUDE.md

@@ -0,0 +1,84 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+**rfcxml** is a Ruby gem for parsing and generating IETF RFC XML v3 documents. It is part of the Metanorma ecosystem and provides bidirectional XML serialization using the lutaml-model framework.
+
+## Development Commands
+
+```bash
+# Install dependencies
+bundle install
+
+# Run all checks (tests + linting)
+bundle exec rake
+
+# Run tests only
+bundle exec rake spec
+bundle exec rspec                  # Run specific test file
+bundle exec rspec spec/v3/rfc_spec.rb
+
+# Run linting only
+bundle exec rake rubocop
+bundle exec rubocop --autocorrect  # Auto-fix violations
+
+# Interactive development console
+bin/console
+```
+
+## Architecture
+
+### Core Framework: lutaml-model
+
+All XML elements are modeled as classes inheriting from `Lutaml::Model::Serializable`. This provides ActiveRecord-like serialization for XML with a declarative DSL:
+
+```ruby
+class SomeElement < Lutaml::Model::Serializable
+  attribute :name, :string
+  attribute :child, ChildClass, collection: true
+
+  xml do
+    element "element-name"
+    map_attribute "name", to: :name
+    map_element "child", to: :child
+  end
+end
+```
+
+### Module Structure
+
+- `Rfcxml::V3` namespace contains all RFC XML v3 element models
+- Each XML element has its own file in `lib/rfcxml/v3/`
+- Models require their dependencies directly (e.g., `Rfc` requires `Front`, `Middle`, `Back`)
+
+### Document Hierarchy
+
+```
+Rfc (root)
+├── Front (metadata: title, authors, date, abstract)
+├── Middle (body: sections)
+└── Back (references, appendices)
+```
+
+### Mixed Content
+
+Some elements like `Section` support mixed content (text interspersed with child elements). Use `mixed: true` in the root declaration:
+
+```ruby
+xml do
+  element "section"
+mixed_content
+end
+```
+
+## Reference Schema
+
+The `reference-docs/` directory contains the official RFC XML v3 schema files:
+- `v3.rnc` - RelaxNG compact syntax (authoritative)
+- `v3.xsd` - XML Schema Definition
+
+## Testing
+
+Tests perform round-trip parsing: parse XML → serialize back → verify valid XML structure using the `canon` gem for semantic comparison.

data/lib/rfcxml/v3/cref.rb

@@ -13,10 +13,10 @@ module Rfcxml
       attribute :em, Em, collection: true
       attribute :eref, Eref, collection: true
       attribute :relref, Relref, collection: true
-      attribute :strong, Strong, collection: true
-      attribute :sub, Sub, collection: true
-      attribute :sup, Sup, collection: true
-      attribute :tt, Tt, 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
       attribute :xref, Xref, collection: true
 
       xml do

data/lib/rfcxml/v3/rfc.rb

@@ -48,6 +48,7 @@ module Rfcxml
       attribute :front, Front
       attribute :middle, Middle
       attribute :back, Back
+      attribute :pi_settings, :hash
 
       xml do
         element "rfc"
@@ -80,6 +81,8 @@ module Rfcxml
         %w[link front middle back].each do |element|
           map_element element, to: element.to_sym
         end
+
+        map_processing_instruction "rfc", to: :pi_settings
       end
 
       # Override to_xml to fix SVG elements

data/lib/rfcxml/v3/td.rb

@@ -12,22 +12,6 @@ module Rfcxml
       attribute :align, :string,
                 values: %w[left center right]
 
-      # Normalize empty string colspan/rowspan to nil.
-      # Schema default for colspan/rowspan is "1", so empty string should not
-      # be serialized as an attribute. This ensures round-trip comparison
-      # treats rowspan="" (in source) as equivalent to absent rowspan.
-      module ColspanRowspanNormalizer
-        def colspan=(value)
-          super(value.to_s.empty? ? nil : value)
-        end
-
-        def rowspan=(value)
-          super(value.to_s.empty? ? nil : value)
-        end
-      end
-
-      prepend ColspanRowspanNormalizer
-
       attribute :artset, Artset, collection: true
       attribute :artwork, Artwork, collection: true
       attribute :dl, Dl, collection: true
@@ -56,8 +40,10 @@ module Rfcxml
 
         map_content to: :content
         map_attribute "anchor", to: :anchor
-        map_attribute "colspan", to: :colspan
-        map_attribute "rowspan", to: :rowspan
+        map_attribute "colspan", to: :colspan,
+                                 value_map: { to: { empty: :empty } }
+        map_attribute "rowspan", to: :rowspan,
+                                 value_map: { to: { empty: :empty } }
         map_attribute "align", to: :align
 
         %w[artset artwork dl figure ol sourcecode t ul bcp14 br cref em eref

data/lib/rfcxml/version.rb

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

data/scripts/roundtrip_test.rb

@@ -38,6 +38,10 @@ class RoundTripTester
 
   attr_reader :results_dir
 
+  def failed?
+    @results.any? { |r| %i[fail error].include?(r[:status]) }
+  end
+
   def initialize(files:, threads: DEFAULT_THREADS, verbose: false)
     @files = files
     @threads = threads
@@ -358,4 +362,6 @@ if __FILE__ == $PROGRAM_NAME
 
   tester = RoundTripTester.new(**options)
   tester.run
+
+  exit 1 if tester.failed?
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfcxml
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-27 00:00:00.000000000 Z
+date: 2026-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lutaml-model
@@ -52,6 +52,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CLAUDE.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.adoc