oasis-etm 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad71a9a5219cab7710a57ebe6b3424172a11c50deac97889692b01ac239511a7
-  data.tar.gz: 11521a92f66914b6afef831dcd34f5544f082a00abc9dbd8e08c00d2ba48a6fc
+  metadata.gz: 23be8f8415df8e3a0c5d31af9c565ed54e25fd715eeb3b1c6ef037723efd097e
+  data.tar.gz: c8b1345655a9a6c501751ff0df2b57c1677dfb31f616e6de469f55d807f2211f
 SHA512:
-  metadata.gz: 6ece8bcbd0b7914cbe9eea7bbc6a9b59c9fc9e88f95f1278a710fa59e13e900239fd5a020c62d9cbfd8412e24664a64b8bf6369e6e73bd047c3a44b4f460ec0a
-  data.tar.gz: bf7e7b5b1921b33599e1e28ea2b494784227cb07c787dcf7de9a8dbcde5adf84f34f05ac2f97ac09224d375b57d031367960f92fd2abe4543532183d10dca7e3
+  metadata.gz: 7b4cf291505d624c48af4611c65fca22e00fbb9b4f1dd996241c5be56a6c2c76563dd6e76a1f478314153ed546a8afb0abf6992a066397d84c92290f033690cf
+  data.tar.gz: b3c28b0012a7ff7da24ead1a827337aeb60921141ef263eb8e876eeffd545c31ba1df8eb067181da846ad9e82f224d72c98b9b8b678be29343799b472bf3dda4

data/.github/workflows/release.yml

@@ -13,6 +13,11 @@ on:
   repository_dispatch:
     types: [ do-release ]
 
+permissions:
+  contents: write
+  packages: write
+  id-token: write
+
 jobs:
   release:
     uses: metanorma/ci/.github/workflows/rubygems-release.yml@main

data/.gitignore

@@ -11,3 +11,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock

data/.rubocop.yml

@@ -1,14 +1,19 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 inherit_from:
-  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/main/ci/rubocop.yml
   - .rubocop_todo.yml
 
-require:
-- rubocop-performance
-- rubocop-rake
-- rubocop-rspec
+inherit_mode:
+  merge:
+    - Exclude
+
+# local repo-specific modifications
+# ...
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-rake
 
 AllCops:
   TargetRubyVersion: 3.0
-  NewCops: enable
-  Exclude:
-    - 'vendor/**/*'

data/.rubocop_todo.yml

@@ -1,24 +1,37 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-11-01 07:12:25 UTC using RuboCop version 1.68.0.
+# on 2026-04-05 03:49:01 UTC using RuboCop version 1.86.0.
 # 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: 2
+# Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation.
+Bundler/OrderedGems:
+  Exclude:
+    - 'Gemfile'
+
+# Offense count: 18
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
   Exclude:
     - 'spec/oasis/etm/entry_spec.rb'
+    - 'spec/oasis/etm_spec.rb'
 
-# Offense count: 6
+# Offense count: 9
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
-  Max: 10
+  Max: 16
 
 # Offense count: 12
 RSpec/MultipleExpectations:
   Max: 10
+
+# Offense count: 3
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 4

data/Gemfile

@@ -5,6 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in oasis-etm.gemspec
 gemspec
 
+gem "canon"
+gem "lutaml-model", "~> 0.8.0", github: "lutaml/lutaml-model", branch: "main"
 gem "nokogiri"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
@@ -12,4 +14,3 @@ gem "rubocop", "~> 1.21"
 gem "rubocop-performance"
 gem "rubocop-rake"
 gem "rubocop-rspec"
-gem "xml-c14n"

data/README.adoc

@@ -3,8 +3,8 @@
 :toclevels: 3
 
 image:https://img.shields.io/gem/v/oasis-etm.svg[Gem Version, link=https://rubygems.org/gems/oasis-etm]
-image:https://github.com/yourusername/oasis-etm/actions/workflows/test.yml/badge.svg[Build Status, link=https://github.com/yourusername/oasis-etm/actions/workflows/test.yml]
-image:https://img.shields.io/github/license/yourusername/oasis-etm.svg[License, link=https://github.com/yourusername/oasis-etm/blob/main/LICENSE]
+image:https://github.com/lutaml/oasis-etm/actions/workflows/test.yml/badge.svg[Build Status, link=https://github.com/lutaml/oasis-etm/actions/workflows/test.yml]
+image:https://img.shields.io/github/license/lutaml/oasis-etm.svg[License, link=https://github.com/lutaml/oasis-etm/blob/main/LICENSE]
 
 toc::[]
 
@@ -16,6 +16,20 @@ exchange. It is used in the DocBook and NISO JATS standards.
 This library provides a Ruby implementation of the
 https://www.oasis-open.org/specs/a503.htm[OASIS Technical Resolution TR 9503:1995].
 
+== Features
+
+* Full implementation of the OASIS Exchange Table Model TR 9503:1995
+* Intentionally excludes CALS table features not part of the Exchange subset (like `tfoot`)
+* XML serialization and deserialization
+* Validation of attribute values
+* Support for all Exchange Table Model elements:
+** `table`
+** `tgroup`
+** `colspec`
+** `thead`
+** `tbody`
+** `row`
+** `entry`
 
 == Installation
 
@@ -115,22 +129,120 @@ The OASIS ETM format follows this basic structure:
 </table>
 ----
 
-== Development
+== Round-Trip Conversion Tests
 
-=== Test files
+The round-trip tests in `spec/oasis/etm_spec.rb` verify that XML files can be
+parsed into Ruby objects and then serialized back to XML without loss of
+semantic content.
 
-`spec/fixtures/native/docbook_example.xml`::
-https://tdg.docbook.org/tdg/4.5/table
+NOTE: These tests use the https://github.com/lutaml/canon[Canon gem] for XML
+comparison with the `spec_friendly` profile, which ignores non-semantic
+differences like attribute ordering and formatting.
 
-`spec/fixtures/niso-jats/niso-jats-table-wrap.xml`::
-https://jats.nlm.nih.gov/options/OASIS/tag-library/19990315/element/oasis-table.html
-This is to test the OASIS exchange table model when it is namespaced from
-another location.
+=== Purpose
 
-`spec/fixtures/isosts/isosts_tables.cals.{nn}.xml`::
-Tables extracted from https://www.iso.org/schema/isosts/cals/test/isosts_tables.cals.xml.
-This is to test the OASIS exchange table model when it is namespaced from
-another location.
+Round-trip conversion testing ensures that:
+
+* The parser correctly interprets all supported XML elements and attributes
+* The serializer correctly produces XML that preserves semantic meaning
+* The model accurately represents the Exchange Table Model structure
+
+=== Test Fixtures and Sources
+
+The round-trip tests use real-world XML files from various standards:
+
+[cols="1,2,3",options="header"]
+|===
+|Fixture |Source |Purpose
+
+|`spec/fixtures/native/docbook_example.xml`
+|https://tdg.docbook.org/tdg/4.5/table[DocBook Table Specification]
+|Tests native ETM format (no namespace prefix)
+
+|`spec/fixtures/niso-jats/niso-jats-table-wrap.xml`
+|https://jats.nlm.nih.gov/options/OASIS/tag-library/19990315/element/oasis-table.html[NISO JATS Tag Library]
+|Tests ETM with standard OASIS namespace (`http://docs.oasis-open.org/ns/oasis-exchange/table`)
+
+|`spec/fixtures/isosts/isosts_tables.cals.{nn}.xml`
+|https://www.iso.org/schema/isosts/cals/test/isosts_tables.cals.xml[ISO ISOSTS Test Suite]
+|Tests ETM with alternative namespace URIs and CALS extensions
+|===
+
+=== Fixture Oddities
+
+The test fixtures contain elements and attributes that are not part of the
+Exchange Table Model specification but appear in real-world documents. The
+round-trip tests handle these as follows:
+
+Some fixtures contain elements from other namespaces that the model does not
+support. These are removed before parsing to focus on Exchange Table Model
+compatibility:
+
+.Foreign Elements (Removed Before Parsing)
+[cols="2,1"]
+|===
+|Element |Fixture
+
+|`+<xref>+` (NISO JATS cross-references)
+|`niso-jats-table-wrap.xml`
+
+|`+<para>+` (DocBook paragraph)
+|`docbook_example.xml`
+
+|`+<bold>+` (DocBook inline formatting)
+|`isosts_tables.cals.02.xml`
+|===
+
+The Exchange Table Model has evolved over time, resulting in multiple namespace
+URIs that refer to the same schema:
+
+.Namespace Variants
+[cols="2,1"]
+|===
+|Namespace URI |Used By
+
+|`http://docs.oasis-open.org/ns/oasis-exchange/table`
+|Canonical OASIS Exchange Table namespace
+
+|`urn:oasis:names:tc:xml:table`
+|ISO ISOSTS format
+
+|`-//OASIS//DTD XML Exchange Table Model 19990315//EN`
+|Legacy FPI (Formal Public Identifier) - used as namespace URI in older documents
+|===
+
+The model accepts all three namespace variants via `uri_aliases` for parsing.
+When serializing, the model uses the canonical namespace URI for output.
+
+The Exchange Table Model predates XML Schema and uses SGML-influenced attribute
+values:
+
+.Attribute Value Formats
+[cols="2,1"]
+|===
+|Values |Example
+
+|Integers (XML Schema)
+|`colsep="1" rowsep="1"`
+
+|Legacy strings (SGML)
+|`colsep="yes" rowsep="no"`
+|===
+
+The model accepts both integer (`0`, `1`) and string (`"yes"`, `"no"`) values
+for `colsep`, `rowsep`, and `pgwide` attributes to ensure backward
+compatibility with legacy documents.
+
+=== Why These Tests Matter
+
+Round-trip tests catch regressions that might otherwise go unnoticed:
+
+* A missing attribute mapping would cause data loss on serialization
+* An incorrect type coercion would change attribute values
+* Namespace handling bugs would produce invalid XML
+* Changes to element ordering could break downstream consumers
+
+By testing with real-world fixtures from established standards, we ensure compatibility with the broader XML table ecosystem.
 
 
 == Contributing

data/lib/oasis/etm/colspec.rb

@@ -2,17 +2,22 @@ module Oasis
   module Etm
     class Colspec < Lutaml::Model::Serializable
       # Optional attributes
+      # colsep/rowsep accept both integer (0/1) and string ("yes"/"no") values.
+      # The string form "yes"/"no" is a legacy SGML representation supported for
+      # backward compatibility with older Exchange Table Model documents.
       attribute :colnum, :integer
       attribute :colname, :string
       attribute :colwidth, :string
-      attribute :colsep, :integer, values: [0, 1]
-      attribute :rowsep, :integer, values: [0, 1]
+      attribute :colsep, :string, values: %w[0 1 yes no]
+      attribute :rowsep, :string, values: %w[0 1 yes no]
       attribute :align, :string, values: %w[left right center justify char]
       attribute :char, :string
       attribute :charoff, :string
 
       xml do
-        root "colspec"
+        element "colspec"
+        namespace Namespace
+        ordered
 
         map_attribute "colnum", to: :colnum
         map_attribute "colname", to: :colname

data/lib/oasis/etm/entry.rb

@@ -2,22 +2,27 @@ module Oasis
   module Etm
     class Entry < Lutaml::Model::Serializable
       # Optional attributes
+      # colsep/rowsep accept both integer (0/1) and string ("yes"/"no") values.
+      # The string form "yes"/"no" is a legacy SGML representation supported for
+      # backward compatibility with older Exchange Table Model documents.
       attribute :colname, :string
       attribute :namest, :string
       attribute :nameend, :string
       attribute :morerows, :integer
-      attribute :colsep, :integer, values: [0, 1]
-      attribute :rowsep, :integer, values: [0, 1]
+      attribute :colsep, :string, values: %w[0 1 yes no]
+      attribute :rowsep, :string, values: %w[0 1 yes no]
       attribute :align, :string, values: %w[left right center justify char]
       attribute :char, :string
       attribute :charoff, :string
       attribute :valign, :string, values: %w[top middle bottom]
 
       # Content
-      attribute :content, :string
+      attribute :content, :string, raw: true
 
       xml do
-        root "entry"
+        element "entry"
+        namespace Namespace
+        mixed_content
 
         # Attribute mappings
         map_attribute "colname", to: :colname

data/lib/oasis/etm/namespace.rb

@@ -0,0 +1,10 @@
+module Oasis
+  module Etm
+    class Namespace < Lutaml::Xml::Namespace
+      uri "http://docs.oasis-open.org/ns/oasis-exchange/table"
+      uri_aliases "urn:oasis:names:tc:xml:table",
+                  "-//OASIS//DTD XML Exchange Table Model 19990315//EN"
+      prefix_default "oasis"
+    end
+  end
+end

data/lib/oasis/etm/row.rb

@@ -1,17 +1,19 @@
-require_relative "entry"
-
 module Oasis
   module Etm
     class Row < Lutaml::Model::Serializable
       # Optional attributes
-      attribute :rowsep, :integer, values: [0, 1]
+      # rowsep accepts both integer (0/1) and string ("yes"/"no") values.
+      # The string form "yes"/"no" is a legacy SGML representation supported for
+      # backward compatibility with older Exchange Table Model documents.
+      attribute :rowsep, :string, values: %w[0 1 yes no]
       attribute :valign, :string, values: %w[top middle bottom]
 
       # Content
       attribute :entries, Entry, collection: true
 
       xml do
-        root "row"
+        element "row"
+        namespace Namespace
 
         map_attribute "rowsep", to: :rowsep
         map_attribute "valign", to: :valign

data/lib/oasis/etm/table.rb

@@ -1,20 +1,23 @@
-require_relative "tgroup"
-
 module Oasis
   module Etm
     class Table < Lutaml::Model::Serializable
       # Table attributes
+      # colsep/rowsep accept both integer (0/1) and string ("yes"/"no") values.
+      # The string form "yes"/"no" is a legacy SGML representation supported for
+      # backward compatibility with older Exchange Table Model documents.
       attribute :frame, :string, values: %w[top bottom topbot all sides none]
-      attribute :colsep, :integer, values: [0, 1]
-      attribute :rowsep, :integer, values: [0, 1]
-      attribute :pgwide, :integer, values: [0, 1]
+      attribute :colsep, :string, values: %w[0 1 yes no]
+      attribute :rowsep, :string, values: %w[0 1 yes no]
+      attribute :pgwide, :string, values: %w[0 1 yes no]
 
       # Table content
       attribute :title, :string
       attribute :tgroups, Tgroup, collection: true
 
       xml do
-        root "table"
+        element "table"
+        namespace Namespace
+        ordered
 
         # Frame mappings
         map_attribute "frame", to: :frame

data/lib/oasis/etm/tbody.rb

@@ -1,5 +1,3 @@
-require_relative "row"
-
 module Oasis
   module Etm
     class Tbody < Lutaml::Model::Serializable
@@ -10,7 +8,8 @@ module Oasis
       attribute :rows, Row, collection: true
 
       xml do
-        root "tbody"
+        element "tbody"
+        namespace Namespace
 
         map_attribute "valign", to: :valign
         map_element "row", to: :rows

data/lib/oasis/etm/tcol.rb

@@ -2,17 +2,21 @@ module Oasis
   module Etm
     class Colspec < Lutaml::Model::Serializable
       # Optional attributes
+      # colsep/rowsep accept both integer (0/1) and string ("yes"/"no") values.
+      # The string form "yes"/"no" is a legacy SGML representation supported for
+      # backward compatibility with older Exchange Table Model documents.
       attribute :colnum, :integer
       attribute :colname, :string
       attribute :colwidth, :string
-      attribute :colsep, :integer, values: [0, 1]
-      attribute :rowsep, :integer, values: [0, 1]
+      attribute :colsep, :string, values: %w[0 1 yes no]
+      attribute :rowsep, :string, values: %w[0 1 yes no]
       attribute :align, :string, values: %w[left right center justify char]
       attribute :char, :string
       attribute :charoff, :string
 
       xml do
-        root "colspec"
+        element "colspec"
+        namespace Namespace
 
         map_attribute "colnum", to: :colnum
         map_attribute "colname", to: :colname

data/lib/oasis/etm/tgroup.rb

@@ -1,7 +1,3 @@
-require_relative "colspec"
-require_relative "thead"
-require_relative "tbody"
-
 module Oasis
   module Etm
     class Tgroup < Lutaml::Model::Serializable
@@ -9,8 +5,11 @@ module Oasis
       attribute :cols, :integer
 
       # Optional attributes
-      attribute :colsep, :integer, values: [0, 1]
-      attribute :rowsep, :integer, values: [0, 1]
+      # colsep/rowsep accept both integer (0/1) and string ("yes"/"no") values.
+      # The string form "yes"/"no" is a legacy SGML representation supported for
+      # backward compatibility with older Exchange Table Model documents.
+      attribute :colsep, :string, values: %w[0 1 yes no]
+      attribute :rowsep, :string, values: %w[0 1 yes no]
       attribute :align, :string, values: %w[left right center justify char]
 
       # Content
@@ -19,7 +18,9 @@ module Oasis
       attribute :tbody, Tbody
 
       xml do
-        root "tgroup"
+        element "tgroup"
+        namespace Namespace
+        ordered
 
         # Attribute mappings
         map_attribute "cols", to: :cols

data/lib/oasis/etm/thead.rb

@@ -1,5 +1,3 @@
-require_relative "row"
-
 module Oasis
   module Etm
     class Thead < Lutaml::Model::Serializable
@@ -10,7 +8,8 @@ module Oasis
       attribute :rows, Row, collection: true
 
       xml do
-        root "thead"
+        element "thead"
+        namespace Namespace
 
         map_attribute "valign", to: :valign
         map_element "row", to: :rows

data/lib/oasis/etm/version.rb

@@ -2,6 +2,6 @@
 
 module Oasis
   module Etm
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/oasis/etm.rb

@@ -1,13 +1,20 @@
 # frozen_string_literal: true
 
 require "lutaml/model"
-require_relative "etm/version"
-require_relative "etm/table"
 
 module Oasis
   module Etm
     class Error < StandardError; end
 
-    # Your code goes here...
+    autoload :Colspec, "oasis/etm/colspec"
+    autoload :Entry, "oasis/etm/entry"
+    autoload :Namespace, "oasis/etm/namespace"
+    autoload :Row, "oasis/etm/row"
+    autoload :Table, "oasis/etm/table"
+    autoload :Tbody, "oasis/etm/tbody"
+    autoload :Colspec, "oasis/etm/tcol"
+    autoload :Tgroup, "oasis/etm/tgroup"
+    autoload :Thead, "oasis/etm/thead"
+    autoload :VERSION, "oasis/etm/version"
   end
 end

data/spec/fixtures/native/docbook_example.xml

@@ -1,5 +1,6 @@
 <!-- <!DOCTYPE table PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
           "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -->
+<!-- tfoot commented out to comply with ETM (it is a CALS thing -->
 <table frame='all'><title>Sample Table</title>
 <tgroup cols='5' align='left' colsep='1' rowsep='1'>
 <colspec colname='c1'/>
@@ -14,7 +15,7 @@
   <entry>a5</entry>
 </row>
 </thead>
-<tfoot>
+<!-- <tfoot>
 <row>
   <entry>f1</entry>
   <entry>f2</entry>
@@ -22,7 +23,7 @@
   <entry>f4</entry>
   <entry>f5</entry>
 </row>
-</tfoot>
+</tfoot> -->
 <tbody>
 <row>
   <entry>b1</entry>

data/spec/oasis/etm/colspec_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe Oasis::Etm::Colspec do
   let(:xml) do
     <<~XML
-      <colspec
+      <colspec xmlns="http://docs.oasis-open.org/ns/oasis-exchange/table"
         colnum="1"
         colname="col1"
         colwidth="1*"
@@ -20,8 +20,8 @@ RSpec.describe Oasis::Etm::Colspec do
       expect(colspec.colnum).to eq(1)
       expect(colspec.colname).to eq("col1")
       expect(colspec.colwidth).to eq("1*")
-      expect(colspec.colsep).to eq(1)
-      expect(colspec.rowsep).to eq(1)
+      expect(colspec.colsep).to eq("1")
+      expect(colspec.rowsep).to eq("1")
       expect(colspec.align).to eq("center")
       expect(colspec.char).to eq(".")
       expect(colspec.charoff).to eq("50")
@@ -43,7 +43,7 @@ RSpec.describe Oasis::Etm::Colspec do
     end
 
     it "generates valid XML" do
-      expect(colspec.to_xml).to be_analogous_with(xml)
+      expect(colspec.to_xml).to be_xml_equivalent_to(xml)
     end
   end
 end

data/spec/oasis/etm/entry_spec.rb

@@ -2,7 +2,7 @@
 RSpec.describe Oasis::Etm::Entry do
   let(:xml) do
     <<~XML
-      <entry
+      <entry xmlns="http://docs.oasis-open.org/ns/oasis-exchange/table"
         colname="col1"
         namest="col1"
         nameend="col2"
@@ -24,8 +24,8 @@ RSpec.describe Oasis::Etm::Entry do
       expect(entry.namest).to eq("col1")
       expect(entry.nameend).to eq("col2")
       expect(entry.morerows).to eq(1)
-      expect(entry.colsep).to eq(1)
-      expect(entry.rowsep).to eq(1)
+      expect(entry.colsep).to eq("1")
+      expect(entry.rowsep).to eq("1")
       expect(entry.align).to eq("center")
       expect(entry.char).to eq(".")
       expect(entry.charoff).to eq("50")
@@ -55,7 +55,7 @@ RSpec.describe Oasis::Etm::Entry do
     end
 
     it "generates valid XML" do
-      expect(entry.to_xml).to be_analogous_with(xml)
+      expect(entry.to_xml).to be_xml_equivalent_to(xml)
     end
   end
 
@@ -81,21 +81,21 @@ RSpec.describe Oasis::Etm::Entry do
     end
 
     it "validates colsep values" do
-      entry = described_class.new(colsep: 2)
+      entry = described_class.new(colsep: "2")
       errors = entry.validate
       expect(errors).to match_array(
         have_attributes(
-          message: /colsep is `2`, must be one of the following \[0, 1\]/,
+          message: /colsep is `2`, must be one of the following \[0, 1, yes, no\]/,
         ),
       )
     end
 
     it "validates rowsep values" do
-      entry = described_class.new(rowsep: 2)
+      entry = described_class.new(rowsep: "2")
       errors = entry.validate
       expect(errors).to match_array(
         have_attributes(
-          message: /rowsep is `2`, must be one of the following \[0, 1\]/,
+          message: /rowsep is `2`, must be one of the following \[0, 1, yes, no\]/,
         ),
       )
     end