sts 0.5.3 → 0.5.5

data/TODO.sts-refactor/10-test-coverage.md

@@ -0,0 +1,164 @@
+# 10: Test Coverage Improvements
+
+**Priority**: ONGOING
+**Category**: Quality
+**Estimated Effort**: Ongoing
+**Files Affected**: `spec/`
+
+## Current Test Structure
+
+```
+spec/
+├── spec_helper.rb
+├── sts_spec.rb                   # Core parsing/serialization tests
+├── round_trip/
+│   └── reference_docs_spec.rb    # Round-trip tests with ISO doc fixtures
+└── fixtures/
+    └── *.xml                     # Test XML documents
+```
+
+## Test Categories Needed
+
+### 1. Unit Tests Per Element
+
+Each model class should have unit tests covering:
+
+```ruby
+# spec/sts/niso_sts/paragraph_spec.rb
+RSpec.describe Sts::NisoSts::Paragraph do
+  describe "XML parsing" do
+    it "parses <p> with text content"
+    it "parses <p> with mixed content"
+    it "parses <p> with @id attribute"
+    it "parses <p> with @content-type attribute"
+    it "parses <p> with @xml:lang attribute"
+  end
+
+  describe "XML serialization" do
+    it "round-trips text content"
+    it "round-trips mixed content"
+    it "round-trips all attributes"
+  end
+end
+```
+
+Priority elements for unit tests:
+- `Standard`, `Front`, `Body`, `Back` — structural
+- `Section`, `Paragraph` — high frequency
+- `Fig`, `TableWrap`, `Graphic` — media
+- `Ref`, `RefList`, `Xref` — references
+- `TermSec`, `TermDisplay` — terminology
+- `Permissions` — after model fix
+
+### 2. Schema Validation Tests
+
+```ruby
+# spec/schema_validation_spec.rb
+RSpec.describe "Schema compliance" do
+  context "NISO STS 1.0" do
+    it "validates against NISO STS Extended XSD"
+    it "validates against NISO STS Interchange XSD"
+  end
+
+  context "ISOSTS v1.1" do
+    it "validates against ISOSTS DTD"
+  end
+
+  context "NISO STS 1.2" do
+    it "validates against NISO STS 1.2 XSD"
+  end
+end
+```
+
+### 3. Version-Specific Tests (After TODO 04)
+
+```ruby
+# spec/versioning/register_spec.rb
+RSpec.describe "Schema versioning" do
+  it "loads ISOSTS v1.1 register independently"
+  it "loads NISO STS 1.0 register independently"
+  it "loads NISO STS 1.2 register independently"
+  it "prevents cross-register contamination"
+end
+```
+
+### 4. Profile Validation Tests (After TODO 08)
+
+```ruby
+# spec/profiles/iso_iec_validator_spec.rb
+RSpec.describe Sts::Profiles::IsoIec::Validator do
+  it "rejects document without <front>"
+  it "accepts valid ISO document"
+  it "validates ID scheme conventions"
+  it "validates metadata requirements"
+end
+```
+
+### 5. Anti-Pattern Regression Tests
+
+```ruby
+# spec/anti_patterns_spec.rb
+RSpec.describe "No anti-patterns in codebase" do
+  it "contains no method_missing definitions"
+  it "contains no respond_to_missing definitions"
+  it "contains no send calls"
+  it "contains no Object.const_get calls"
+end
+```
+
+### 6. Performance Tests
+
+```ruby
+# spec/performance_spec.rb
+RSpec.describe "Performance" do
+  it "parses large document within time budget"
+  it "serialization doesn't regress from baseline"
+end
+```
+
+## Test Fixtures Needed
+
+| Fixture | Purpose | Priority |
+|---------|---------|----------|
+| Simple standard (minimal) | Basic round-trip | HIGH |
+| IEC standard with license | Permissions testing | HIGH |
+| Document with index | Index hierarchy | HIGH |
+| Document with TOC | TOC hierarchy | HIGH |
+| Document with code blocks | Code element testing | HIGH |
+| Document with MathML | Formula testing | MEDIUM |
+| Document with TBX | Terminology testing | MEDIUM |
+| Document with OASIS tables | CALS table testing | LOW |
+| Multi-language document | xml:lang testing | MEDIUM |
+| Amendment/corrigendum | Amendment structure | MEDIUM |
+| National adoption | std-doc-meta testing | LOW |
+
+## Coverage Metrics
+
+Track coverage with:
+```bash
+COVERAGE=true bundle exec rspec
+```
+
+Target: >80% line coverage for `lib/sts/`
+
+## Dependencies
+
+All other TODOs feed into this — add tests as features are implemented.
+
+## TODO Checklist
+
+- [x] Add anti-pattern regression test
+- [x] Add unit tests for structural elements (Standard, Front, Body, Back)
+- [x] Add unit tests for Section and Paragraph
+- [x] Add unit tests for Fig, TableWrap, Graphic
+- [x] Add unit tests for Ref, RefList, Xref
+- [x] Add unit tests for TermSec, TermDisplay
+- [x] Add unit tests for Permissions (after model fix)
+- [x] Add unit tests for new elements (ProcessingMeta, Code, Legend, InlineMedia, TableWrapGroup, DefHead)
+- [x] Add unit tests for attribute additions (Title, Caption, Label, ExtLink, AwardId, DefItem)
+- [x] Add unit tests for Index and TOC hierarchy elements
+- [ ] Add schema validation tests
+- [ ] Add versioning tests (after TODO 04)
+- [x] Add profile validation tests (after TODO 08)
+- [x] Set up coverage tracking
+- [x] Achieve >80% line coverage target (achieved 99.8%)

data/TODO.sts-refactor/11-duplicate-models.md

@@ -0,0 +1,168 @@
+# 11: Duplicate Model Resolution
+
+**Priority**: MEDIUM
+**Category**: Architecture
+**Estimated Effort**: High
+**Files Affected**: `lib/sts/iso_sts/`, `lib/sts/niso_sts/`
+
+## Problem
+
+Many model classes exist in both `Sts::IsoSts` and `Sts::NisoSts` with the same XML element name but potentially different attributes. This creates:
+
+1. **Maintenance burden**: Changes must be duplicated
+2. **Divergence risk**: Models drift apart over time
+3. **Ambiguity**: Which class should be used?
+
+## Identified Duplicates
+
+### Confirmed Different (Must Stay Separate)
+
+These elements have genuinely different attribute sets between ISOSTS and NISO STS:
+
+| Element | IsoSts Version | NisoSts Version | Difference |
+|---------|---------------|----------------|------------|
+| `<p>` | Paragraph | Paragraph | ISOSTS: 4 attrs; NISO STS: 7 attrs (adds `@originator`, `@style-type`, `@xml:base`) |
+| `<standard>` | Standard | Standard | ISOSTS: DTD-based; NISO STS: XSD-based |
+
+### Potentially Identical (Audit Needed)
+
+These elements likely have the same model but are duplicated:
+
+| Element | IsoSts File | NisoSts File |
+|---------|-------------|--------------|
+| `<bold>` | Bold | Bold |
+| `<italic>` | Italic | Italic |
+| `<sub>` | Sub | Sub |
+| `<sup>` | Sup | Sup |
+| `<underline>` | Underline | Underline |
+| `<monospace>` | Monospace | Monospace |
+| `<styled-content>` | StyledContent | StyledContent |
+| `<named-content>` | NamedContent | NamedContent |
+| `<xref>` | Xref | Xref |
+| `<ext-link>` | ExtLink | ExtLink |
+| `<break>` | Break | Break |
+| `<list>` | List | List |
+| `<list-item>` | ListItem | ListItem |
+| `<def-list>` | DefList | DefList |
+| `<def-item>` | DefItem | DefItem |
+| `<table>` | Table | Table |
+| `<tr>` | Tr | Tr |
+| `<td>` | Td | Td |
+| `<th>` | Th | Th |
+| `<fig>` | Fig | Fig |
+| `<graphic>` | Graphic | Graphic |
+| `<caption>` | Caption | Caption |
+| `<title>` | Title | Title |
+| `<label>` | Label | Label |
+| `<disp-formula>` | DispFormula | DispFormula |
+| `<inline-formula>` | InlineFormula | InlineFormula |
+
+## Resolution Strategy
+
+### For Genuinely Different Models
+
+Keep separate but share a base class:
+
+```ruby
+# lib/sts/base/paragraph.rb
+module Sts
+  module Base
+    class Paragraph < Lutaml::Model::Serializable
+      # Shared attributes common to ISOSTS and NISO STS
+      attribute :id, :string
+      attribute :content_type, :string
+      attribute :specific_use, :string
+
+      xml do
+        element "p"
+        mixed_content
+        map_attribute "id", to: :id
+        map_attribute "content-type", to: :content_type
+        map_attribute "specific-use", to: :specific_use
+        # Children injected by content groups
+      end
+    end
+  end
+end
+
+# lib/sts/iso_sts/paragraph.rb
+module Sts
+  module IsoSts
+    class Paragraph < ::Sts::Base::Paragraph
+      # ISOSTS-specific: only 4 attrs
+      attribute :xml_lang, :string
+
+      xml do
+        root "p"
+        map_attribute "xml:lang", to: :xml_lang
+      end
+    end
+  end
+end
+
+# lib/sts/niso_sts/paragraph.rb
+module Sts
+  module NisoSts
+    class Paragraph < ::Sts::Base::Paragraph
+      # NISO STS Extended: 7 attrs
+      attribute :xml_lang, :string
+      attribute :xml_base, :string
+      attribute :originator, :string
+      attribute :style_type, :string
+
+      xml do
+        root "p"
+        map_attribute "xml:lang", to: :xml_lang
+        map_attribute "xml:base", to: :xml_base
+        map_attribute "originator", to: :originator
+        map_attribute "style-type", to: :style_type
+      end
+    end
+  end
+end
+```
+
+### For Identical Models
+
+Use the base class directly — no namespace-specific subclass needed:
+
+```ruby
+# Both IsoSts and NisoSts can use Sts::Base::Bold
+# Remove Sts::IsoSts::Bold and Sts::NisoSts::Bold
+# Add alias in each namespace if needed for API compatibility
+module Sts
+  module IsoSts
+    Bold = ::Sts::Base::Bold
+  end
+  module NisoSts
+    Bold = ::Sts::Base::Bold
+  end
+end
+```
+
+## Audit Process
+
+For each duplicate pair:
+
+1. Read ISOSTS DTD definition of the element
+2. Read NISO STS XSD definition of the element
+3. Compare attributes and children
+4. Categorize: identical, subset, or different
+5. Decide: share base, extend base, or keep separate
+
+## Dependencies
+
+- `03-namespace-coupling.md` — base type creation
+- `04-register-versioning.md` — versioned class hierarchy
+
+## TODO Checklist
+
+- [ ] Audit all duplicate model pairs (25+ elements)
+- [ ] Categorize each pair: identical / subset / different
+- [ ] Create base classes for genuinely shared types
+- [ ] Refactor ISOSTS versions to extend bases
+- [ ] Refactor NISO STS versions to extend bases
+- [ ] Replace direct references with namespace aliases where identical
+- [ ] Remove duplicate implementations
+- [ ] Run full round-trip test suite
+- [ ] Verify no behavioral changes

data/lib/sts/iso_sts/annex_type.rb

@@ -3,12 +3,14 @@
 module Sts
   module IsoSts
     class AnnexType < Lutaml::Model::Serializable
+      attribute :id, :string
       attribute :content, :string, collection: true
       attribute :bold, ::Sts::IsoSts::Bold
       attribute :italic, ::Sts::IsoSts::Italic
 
       xml do
         element "annex-type"
+        map_attribute "id", to: :id
         mixed_content
 
         map_content to: :content

data/lib/sts/iso_sts/bold.rb

@@ -8,20 +8,20 @@ module Sts
       attribute :content, :string, collection: true
       attribute :bold, ::Sts::IsoSts::Bold, collection: true
       attribute :italic, ::Sts::IsoSts::Italic, collection: true
-      attribute :sub, ::Sts::NisoSts::Sub, collection: true
-      attribute :sup, ::Sts::NisoSts::Sup, collection: true
+      attribute :sub, ::Sts::IsoSts::Sub, collection: true
+      attribute :sup, ::Sts::IsoSts::Sup, collection: true
       attribute :xref, ::Sts::TbxIsoTml::Xref, collection: true
-      attribute :ext_link, ::Sts::NisoSts::ExtLink, collection: true
-      attribute :uri, ::Sts::NisoSts::Uri, collection: true
+      attribute :ext_link, ::Sts::IsoSts::ExtLink, collection: true
+      attribute :uri, ::Sts::IsoSts::Uri, collection: true
       attribute :inline_formula, ::Sts::IsoSts::InlineFormula, collection: true
-      attribute :named_content, ::Sts::NisoSts::NamedContent, collection: true
+      attribute :named_content, ::Sts::IsoSts::NamedContent, collection: true
       attribute :styled_content, ::Sts::IsoSts::StyledContent, collection: true
       attribute :break, ::Sts::IsoSts::Break, collection: true
       attribute :std_ref, ::Sts::IsoSts::StdRef, collection: true
-      attribute :monospace, ::Sts::NisoSts::Monospace, collection: true
-      attribute :sc, ::Sts::NisoSts::Sc, collection: true
-      attribute :strike, ::Sts::NisoSts::Strike, collection: true
-      attribute :underline, ::Sts::NisoSts::Underline, collection: true
+      attribute :monospace, ::Sts::IsoSts::Monospace, collection: true
+      attribute :sc, ::Sts::IsoSts::Sc, collection: true
+      attribute :strike, ::Sts::IsoSts::Strike, collection: true
+      attribute :underline, ::Sts::IsoSts::Underline, collection: true
       attribute :fn, ::Sts::TbxIsoTml::Fn, collection: true
 
       xml do

data/lib/sts/iso_sts/break.rb

@@ -3,8 +3,11 @@
 module Sts
   module IsoSts
     class Break < Lutaml::Model::Serializable
+      attribute :id, :string
       xml do
         element "break"
+
+        map_attribute "id", to: :id
       end
     end
   end

data/lib/sts/iso_sts/comm_ref.rb

@@ -3,9 +3,11 @@
 module Sts
   module IsoSts
     class CommRef < Lutaml::Model::Serializable
+      attribute :id, :string
       attribute :content, :string, collection: true
       xml do
         element "comm-ref"
+        map_attribute "id", to: :id
         mixed_content
 
         map_content to: :content

data/lib/sts/iso_sts/content_language.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sts
+  module IsoSts
+    class ContentLanguage < Lutaml::Model::Serializable
+      attribute :id, :string
+      attribute :content, :string, collection: true
+      attribute :lang, :string
+      attribute :specific_use, :string
+
+      xml do
+        element "content-language"
+        map_attribute "id", to: :id
+        mixed_content
+
+        map_content to: :content
+        map_attribute "lang", to: :lang
+        map_attribute "specific-use", to: :specific_use
+      end
+    end
+  end
+end

data/lib/sts/iso_sts/copyright_holder.rb

@@ -3,12 +3,14 @@
 module Sts
   module IsoSts
     class CopyrightHolder < Lutaml::Model::Serializable
+      attribute :id, :string
       attribute :content, :string, collection: true
-      attribute :sub, ::Sts::NisoSts::Sub
-      attribute :sup, ::Sts::NisoSts::Sup
+      attribute :sub, ::Sts::IsoSts::Sub
+      attribute :sup, ::Sts::IsoSts::Sup
 
       xml do
         element "copyright-holder"
+        map_attribute "id", to: :id
         mixed_content
 
         map_content to: :content

data/lib/sts/iso_sts/copyright_statement.rb

@@ -3,14 +3,16 @@
 module Sts
   module IsoSts
     class CopyrightStatement < Lutaml::Model::Serializable
+      attribute :id, :string
       attribute :content, :string, collection: true
       attribute :bold, ::Sts::IsoSts::Bold
       attribute :italic, ::Sts::IsoSts::Italic
-      attribute :ext_link, ::Sts::NisoSts::ExtLink
-      attribute :uri, ::Sts::NisoSts::Uri
+      attribute :ext_link, ::Sts::IsoSts::ExtLink
+      attribute :uri, ::Sts::IsoSts::Uri
 
       xml do
         element "copyright-statement"
+        map_attribute "id", to: :id
         mixed_content
 
         map_content to: :content

data/lib/sts/iso_sts/copyright_year.rb

@@ -3,11 +3,14 @@
 module Sts
   module IsoSts
     class CopyrightYear < Lutaml::Model::Serializable
+      attribute :id, :string
       attribute :content, :string
 
       xml do
         element "copyright-year"
 
+        map_attribute "id", to: :id
+
         map_content to: :content
       end
     end

data/lib/sts/iso_sts/doc_ref.rb

@@ -3,9 +3,11 @@
 module Sts
   module IsoSts
     class DocRef < Lutaml::Model::Serializable
+      attribute :id, :string
       attribute :content, :string, collection: true
       xml do
         element "doc-ref"
+        map_attribute "id", to: :id
         mixed_content
 
         map_content to: :content

data/lib/sts/iso_sts/document_identification.rb

@@ -3,6 +3,7 @@
 module Sts
   module IsoSts
     class DocumentIdentification < Lutaml::Model::Serializable
+      attribute :id, :string
       attribute :sdo, ::Sts::NisoSts::Sdo
       attribute :proj_id, ::Sts::NisoSts::ProjId
       attribute :language, ::Sts::IsoSts::Language
@@ -11,6 +12,7 @@ module Sts
 
       xml do
         element "doc-ident"
+        map_attribute "id", to: :id
         ordered
 
         map_element "sdo", to: :sdo

data/lib/sts/iso_sts/edition.rb

@@ -3,9 +3,11 @@
 module Sts
   module IsoSts
     class Edition < Lutaml::Model::Serializable
+      attribute :id, :string
       attribute :content, :string, collection: true
       xml do
         element "edition"
+        map_attribute "id", to: :id
         mixed_content
 
         map_content to: :content

data/lib/sts/iso_sts/ext_link.rb

@@ -11,7 +11,7 @@ module Sts
       attribute :content, :string
       attribute :bold, ::Sts::IsoSts::Bold
       attribute :italic, ::Sts::IsoSts::Italic
-      attribute :named_content, ::Sts::NisoSts::NamedContent
+      attribute :named_content, ::Sts::IsoSts::NamedContent
 
       xml do
         element "ext-link"

data/lib/sts/iso_sts/front.rb

@@ -3,6 +3,7 @@
 module Sts
   module IsoSts
     class Front < Lutaml::Model::Serializable
+      attribute :id, :string
       attribute :std_meta, ::Sts::NisoSts::MetadataStd
       attribute :iso_meta, ::Sts::IsoSts::IsoMeta
       attribute :reg_meta, ::Sts::IsoSts::RegMeta, collection: true
@@ -11,6 +12,7 @@ module Sts
 
       xml do
         element "front"
+        map_attribute "id", to: :id
         ordered
 
         map_element "std-meta", to: :std_meta

data/lib/sts/iso_sts/iso_meta.rb

@@ -7,7 +7,7 @@ module Sts
       attribute :title_wrap, ::Sts::IsoSts::TitleWrap, collection: true
       attribute :doc_ident, ::Sts::IsoSts::DocumentIdentification
       attribute :std_ident, ::Sts::IsoSts::StandardIdentification
-      attribute :content_language, ::Sts::NisoSts::ContentLanguage,
+      attribute :content_language, ::Sts::IsoSts::ContentLanguage,
                 collection: true
       attribute :std_ref, ::Sts::IsoSts::StdRef, collection: true
       attribute :doc_ref, ::Sts::IsoSts::DocRef
@@ -21,7 +21,7 @@ module Sts
                 collection: true
       attribute :custom_meta_group, ::Sts::NisoSts::CustomMetaGroup,
                 collection: true
-      attribute :meta_date, ::Sts::NisoSts::MetaDate, collection: true
+      attribute :meta_date, ::Sts::IsoSts::MetaDate, collection: true
       attribute :pub_date, ::Sts::NisoSts::PubDate
       attribute :is_proof, ::Sts::NisoSts::IsProof
 

data/lib/sts/iso_sts/italic.rb

@@ -8,20 +8,20 @@ module Sts
       attribute :content, :string, collection: true
       attribute :bold, ::Sts::IsoSts::Bold, collection: true
       attribute :italic, ::Sts::IsoSts::Italic, collection: true
-      attribute :sub, ::Sts::NisoSts::Sub, collection: true
-      attribute :sup, ::Sts::NisoSts::Sup, collection: true
+      attribute :sub, ::Sts::IsoSts::Sub, collection: true
+      attribute :sup, ::Sts::IsoSts::Sup, collection: true
       attribute :xref, ::Sts::TbxIsoTml::Xref, collection: true
-      attribute :ext_link, ::Sts::NisoSts::ExtLink, collection: true
-      attribute :uri, ::Sts::NisoSts::Uri, collection: true
+      attribute :ext_link, ::Sts::IsoSts::ExtLink, collection: true
+      attribute :uri, ::Sts::IsoSts::Uri, collection: true
       attribute :inline_formula, ::Sts::IsoSts::InlineFormula, collection: true
-      attribute :named_content, ::Sts::NisoSts::NamedContent, collection: true
+      attribute :named_content, ::Sts::IsoSts::NamedContent, collection: true
       attribute :styled_content, ::Sts::IsoSts::StyledContent, collection: true
       attribute :break, ::Sts::IsoSts::Break, collection: true
       attribute :std_ref, ::Sts::IsoSts::StdRef, collection: true
-      attribute :monospace, ::Sts::NisoSts::Monospace, collection: true
-      attribute :sc, ::Sts::NisoSts::Sc, collection: true
-      attribute :strike, ::Sts::NisoSts::Strike, collection: true
-      attribute :underline, ::Sts::NisoSts::Underline, collection: true
+      attribute :monospace, ::Sts::IsoSts::Monospace, collection: true
+      attribute :sc, ::Sts::IsoSts::Sc, collection: true
+      attribute :strike, ::Sts::IsoSts::Strike, collection: true
+      attribute :underline, ::Sts::IsoSts::Underline, collection: true
       attribute :fn, ::Sts::TbxIsoTml::Fn, collection: true
 
       xml do

data/lib/sts/iso_sts/label.rb

@@ -3,20 +3,22 @@
 module Sts
   module IsoSts
     class Label < Lutaml::Model::Serializable
+      attribute :id, :string
       attribute :content, :string, collection: true
       attribute :bold, ::Sts::IsoSts::Bold
       attribute :italic, ::Sts::IsoSts::Italic
-      attribute :sub, ::Sts::NisoSts::Sub
-      attribute :sup, ::Sts::NisoSts::Sup
+      attribute :sub, ::Sts::IsoSts::Sub
+      attribute :sup, ::Sts::IsoSts::Sup
       attribute :inline_formula, ::Sts::IsoSts::InlineFormula
       attribute :break, ::Sts::IsoSts::Break
       attribute :styled_content, ::Sts::IsoSts::StyledContent
-      attribute :ext_link, ::Sts::NisoSts::ExtLink
-      attribute :uri, ::Sts::NisoSts::Uri
-      attribute :named_content, ::Sts::NisoSts::NamedContent
+      attribute :ext_link, ::Sts::IsoSts::ExtLink
+      attribute :uri, ::Sts::IsoSts::Uri
+      attribute :named_content, ::Sts::IsoSts::NamedContent
 
       xml do
         element "label"
+        map_attribute "id", to: :id
         mixed_content
 
         map_content to: :content

data/lib/sts/iso_sts/language.rb

@@ -3,12 +3,14 @@
 module Sts
   module IsoSts
     class Language < Lutaml::Model::Serializable
+      attribute :id, :string
       attribute :content, :string, collection: true
       attribute :lang, :string
       attribute :specific_use, :string
 
       xml do
         element "language"
+        map_attribute "id", to: :id
         mixed_content
 
         map_content to: :content

data/lib/sts/iso_sts/meta_date.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sts
+  module IsoSts
+    class MetaDate < Lutaml::Model::Serializable
+      attribute :id, :string
+      attribute :content, :string
+      attribute :type, :string
+
+      xml do
+        element "meta-date"
+
+        map_content to: :content
+
+        map_attribute "id", to: :id
+        map_attribute :type, to: :type
+      end
+    end
+  end
+end