metanorma-document 0.2.6 → 0.2.7

data/lib/metanorma/nist_document/sections/errata.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    module Sections
+      class Errata < Lutaml::Model::Serializable
+        attribute :rows, ErrataRow, collection: true
+
+        xml do
+          element "errata"
+          map_element "row", to: :rows
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/nist_document/sections/errata_clause.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    module Sections
+      class ErrataClause < Metanorma::StandardDocument::Sections::ContentSection
+        attribute :errata, Errata
+
+        xml do
+          element "errata_clause"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_elements(self)
+          map_element "errata", to: :errata
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/nist_document/sections/errata_row.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    module Sections
+      class ErrataRow < Lutaml::Model::Serializable
+        attribute :date, :string
+        attribute :type, :string
+        attribute :change, :string, collection: true
+        attribute :pages, :string
+
+        xml do
+          element "row"
+          map_element "date",   to: :date
+          map_element "type",   to: :type
+          map_element "change", to: :change
+          map_element "pages",  to: :pages
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/nist_document/sections/nist_preface.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    module Sections
+      # NIST preface with errata and executivesummary support.
+      # Corresponds to nist.rnc:
+      #   preface = element preface {
+      #     abstract?, foreword?,
+      #     (clause | errata_clause | acknowledgements)*,
+      #     content*,
+      #     executivesummary?
+      #   }
+      class NistPreface < Metanorma::StandardDocument::Sections::Preface
+        attribute :errata_clause, ErrataClause, collection: true
+
+        xml do
+          element "preface"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_elements(self)
+          map_element "clause",            to: :content
+          map_element "errata_clause",     to: :errata_clause
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_attributes(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/nist_document/sections.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    module Sections
+      autoload :Errata, "#{__dir__}/sections/errata"
+      autoload :ErrataClause, "#{__dir__}/sections/errata_clause"
+      autoload :ErrataRow, "#{__dir__}/sections/errata_row"
+      autoload :NistPreface, "#{__dir__}/sections/nist_preface"
+    end
+  end
+end

data/lib/metanorma/nist_document.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    autoload :Metadata, "metanorma/nist_document/metadata"
+    autoload :Root, "metanorma/nist_document/root"
+    autoload :Sections, "metanorma/nist_document/sections"
+  end
+end
+
+Metanorma::Registers::Setup.setup_nist_register

data/lib/metanorma/ogc_document/root.rb

@@ -1,64 +1,24 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module OgcDocument
-    class Root < Metanorma::StandardDocument::Root
-      attribute :version, :string
-      attribute :type, :string
-      attribute :schema_version, :string
-      attribute :flavor, :string
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
 
       attribute :bibdata, Metadata::OgcBibliographicItem
-
-      attribute :term_sources,
-                Metanorma::Document::Components::ReferenceElements::Citation,
+      attribute :preface,
+                Metanorma::StandardDocument::Sections::Preface
+      attribute :sections,
+                Metanorma::StandardDocument::Sections::Sections
+      attribute :annex,
+                Metanorma::StandardDocument::Sections::AnnexSection,
                 collection: true
 
-      attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
-      attribute :sections, Metanorma::IsoDocument::Sections::IsoSections
-      attribute :annex, Metanorma::IsoDocument::Sections::IsoAnnexSection,
-                collection: true
-      attribute :bibliography,
-                Metanorma::StandardDocument::Sections::BibliographySection
-      attribute :boilerplate, Metanorma::IsoDocument::Boilerplate
-      attribute :metanorma_extension,
-                Metanorma::IsoDocument::Metadata::MetanormaExtension
-      attribute :annotation_container, Metanorma::IsoDocument::AnnotationContainer
-      attribute :indexsect,
-                Metanorma::Document::Components::Sections::BasicSection
-      attribute :autonum, :string
-      attribute :fmt_xref_label, :string
-      attribute :localized_strings,
-                Metanorma::Document::Components::Inline::LocalizedStringsElement
-      attribute :fmt_footnote_container,
-                Metanorma::Document::Components::Inline::FmtFootnoteContainerElement
-      attribute :colophon, Metanorma::IsoDocument::Sections::Colophon
-
       xml do
         element "metanorma"
         namespace Metanorma::StandardDocument::Namespace
-        map_attribute "type", to: :type
-        map_attribute "version", to: :version
-        map_attribute "schema-version", to: :schema_version
-        map_attribute "flavor", to: :flavor
-        map_element "bibdata", to: :bibdata
-        map_element "termdocsource", to: :term_sources
-        map_element "metanorma-extension", to: :metanorma_extension
-        map_element "boilerplate", to: :boilerplate
-        map_element "preface", to: :preface
-        map_element "sections", to: :sections
-        map_element "annex", to: :annex
-        map_element "bibliography", to: :bibliography
-        map_element "annotation-container", to: :annotation_container
-        map_element "indexsect", to: :indexsect
-        map_element "localized-strings", to: :localized_strings
-        map_element "fmt-footnote-container", to: :fmt_footnote_container
-        map_element "colophon", to: :colophon
-        map_attribute "autonum", to: :autonum
-        map_attribute "fmt-xref-label", to: :fmt_xref_label
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
       end
     end
   end

data/lib/metanorma/ogc_document.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-
 module Metanorma
   module OgcDocument
     autoload :Metadata, "metanorma/ogc_document/metadata"

data/lib/metanorma/oiml_document/root.rb

@@ -1,65 +1,26 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module OimlDocument
-    class Root < Metanorma::StandardDocument::Root
-      attribute :version, :string
-      attribute :type, :string
-      attribute :schema_version, :string
-      attribute :flavor, :string
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      def self.lutaml_default_register
+        :oiml_document
+      end
 
       attribute :bibdata,
                 Metanorma::IsoDocument::Metadata::IsoBibliographicItem
-
-      attribute :term_sources,
-                Metanorma::Document::Components::ReferenceElements::Citation,
-                collection: true
-
       attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
       attribute :sections, Metanorma::IsoDocument::Sections::IsoSections
       attribute :annex, Metanorma::IsoDocument::Sections::IsoAnnexSection,
                 collection: true
-      attribute :bibliography,
-                Metanorma::StandardDocument::Sections::BibliographySection
-      attribute :boilerplate, Metanorma::IsoDocument::Boilerplate
-      attribute :metanorma_extension,
-                Metanorma::IsoDocument::Metadata::MetanormaExtension
-      attribute :annotation_container, Metanorma::IsoDocument::AnnotationContainer
-      attribute :indexsect,
-                Metanorma::Document::Components::Sections::BasicSection
-      attribute :autonum, :string
-      attribute :fmt_xref_label, :string
-      attribute :localized_strings,
-                Metanorma::Document::Components::Inline::LocalizedStringsElement
-      attribute :fmt_footnote_container,
-                Metanorma::Document::Components::Inline::FmtFootnoteContainerElement
-      attribute :colophon, Metanorma::IsoDocument::Sections::Colophon
 
       xml do
         element "metanorma"
         namespace Metanorma::StandardDocument::Namespace
-        map_attribute "type", to: :type
-        map_attribute "version", to: :version
-        map_attribute "schema-version", to: :schema_version
-        map_attribute "flavor", to: :flavor
-        map_element "bibdata", to: :bibdata
-        map_element "termdocsource", to: :term_sources
-        map_element "metanorma-extension", to: :metanorma_extension
-        map_element "boilerplate", to: :boilerplate
-        map_element "preface", to: :preface
-        map_element "sections", to: :sections
-        map_element "annex", to: :annex
-        map_element "bibliography", to: :bibliography
-        map_element "annotation-container", to: :annotation_container
-        map_element "indexsect", to: :indexsect
-        map_element "localized-strings", to: :localized_strings
-        map_element "fmt-footnote-container", to: :fmt_footnote_container
-        map_element "colophon", to: :colophon
-        map_attribute "autonum", to: :autonum
-        map_attribute "fmt-xref-label", to: :fmt_xref_label
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
       end
     end
   end

data/lib/metanorma/oiml_document.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module OimlDocument
     autoload :Root, "metanorma/oiml_document/root"
   end
 end
+
+Metanorma::Registers::Setup.setup_oiml_register

data/lib/metanorma/plateau_document/metadata/plateau_bibliographic_item.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module PlateauDocument
+    module Metadata
+      class PlateauBibliographicItem < Metanorma::JisDocument::Metadata::JisBibliographicItem
+        xml do
+          element "bibdata"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/plateau_document/metadata.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module PlateauDocument
+    module Metadata
+      autoload :PlateauBibliographicItem,
+               "#{__dir__}/metadata/plateau_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/plateau_document/root.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module PlateauDocument
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      def self.lutaml_default_register
+        :plateau_document
+      end
+
+      attribute :bibdata, Metadata::PlateauBibliographicItem
+      attribute :preface,
+                Metanorma::IsoDocument::Sections::IsoPreface
+      attribute :sections,
+                Metanorma::IsoDocument::Sections::IsoSections
+      attribute :annex,
+                Metanorma::JisDocument::Sections::JisAnnexSection,
+                collection: true
+
+      xml do
+        element "metanorma"
+        namespace Metanorma::StandardDocument::Namespace
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
+      end
+    end
+  end
+end

data/lib/metanorma/plateau_document.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module PlateauDocument
+    autoload :Metadata, "metanorma/plateau_document/metadata"
+    autoload :Root, "metanorma/plateau_document/root"
+  end
+end
+
+Metanorma::Registers::Setup.setup_plateau_register

data/lib/metanorma/registers/setup.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Registers
+    module Setup
+      class << self
+        # ============================================================
+        # ISO-family registers — fallback to :iso_document
+        # ============================================================
+
+        def setup_iso_register
+          sd = Metanorma::StandardDocument
+          iso = Metanorma::IsoDocument
+          reg = Lutaml::Model::Register.new(:iso_document)
+          Lutaml::Model::GlobalRegister.register(reg)
+
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::ClauseSection,
+            to_type: iso::Sections::IsoClauseSection,
+          )
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::AnnexSection,
+            to_type: iso::Sections::IsoAnnexSection,
+          )
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::Sections,
+            to_type: iso::Sections::IsoSections,
+          )
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::Preface,
+            to_type: iso::Sections::IsoPreface,
+          )
+        end
+
+        def setup_iec_register
+          reg = Lutaml::Model::Register.new(:iec_document,
+                                            fallback: [:iso_document])
+          Lutaml::Model::GlobalRegister.register(reg)
+        end
+
+        def setup_oiml_register
+          reg = Lutaml::Model::Register.new(:oiml_document,
+                                            fallback: [:iso_document])
+          Lutaml::Model::GlobalRegister.register(reg)
+        end
+
+        def setup_bsi_register
+          iso = Metanorma::IsoDocument
+          reg = Lutaml::Model::Register.new(:bsi_document,
+                                            fallback: [:iso_document])
+          Lutaml::Model::GlobalRegister.register(reg)
+
+          reg.register_global_type_substitution(
+            from_type: iso::Sections::IsoSections,
+            to_type: Metanorma::BsiDocument::Sections::BsiSections,
+          )
+          reg.register_global_type_substitution(
+            from_type: iso::Sections::IsoClauseSection,
+            to_type: Metanorma::BsiDocument::Sections::BsiClauseSection,
+          )
+          reg.register_global_type_substitution(
+            from_type: iso::Sections::IsoAnnexSection,
+            to_type: Metanorma::BsiDocument::Sections::BsiAnnexSection,
+          )
+        end
+
+        def setup_jis_register
+          iso = Metanorma::IsoDocument
+          reg = Lutaml::Model::Register.new(:jis_document,
+                                            fallback: [:iso_document])
+          Lutaml::Model::GlobalRegister.register(reg)
+
+          reg.register_global_type_substitution(
+            from_type: iso::Sections::IsoAnnexSection,
+            to_type: Metanorma::JisDocument::Sections::JisAnnexSection,
+          )
+        end
+
+        def setup_gb_register
+          reg = Lutaml::Model::Register.new(:gb_document,
+                                            fallback: [:iso_document])
+          Lutaml::Model::GlobalRegister.register(reg)
+        end
+
+        def setup_m3d_register
+          reg = Lutaml::Model::Register.new(:m3d_document)
+          Lutaml::Model::GlobalRegister.register(reg)
+        end
+
+        def setup_plateau_register
+          reg = Lutaml::Model::Register.new(:plateau_document,
+                                            fallback: [:jis_document])
+          Lutaml::Model::GlobalRegister.register(reg)
+        end
+
+        # ============================================================
+        # Isodoc-family registers — no ISO fallback
+        # ============================================================
+
+        def setup_ieee_register
+          sd = Metanorma::StandardDocument
+          reg = Lutaml::Model::Register.new(:ieee_document)
+          Lutaml::Model::GlobalRegister.register(reg)
+
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::Sections,
+            to_type: Metanorma::IeeeDocument::Sections::IeeeSections,
+          )
+        end
+
+        def setup_ietf_register
+          sd = Metanorma::StandardDocument
+          reg = Lutaml::Model::Register.new(:ietf_document)
+          Lutaml::Model::GlobalRegister.register(reg)
+
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::Sections,
+            to_type: Metanorma::IetfDocument::Sections::IetfSections,
+          )
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::ContentSection,
+            to_type: Metanorma::IetfDocument::Sections::IetfContentSection,
+          )
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::ClauseSection,
+            to_type: Metanorma::IetfDocument::Sections::IetfClauseSection,
+          )
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::AnnexSection,
+            to_type: Metanorma::IetfDocument::Sections::IetfAnnexSection,
+          )
+        end
+
+        def setup_nist_register
+          sd = Metanorma::StandardDocument
+          reg = Lutaml::Model::Register.new(:nist_document)
+          Lutaml::Model::GlobalRegister.register(reg)
+
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::Preface,
+            to_type: Metanorma::NistDocument::Sections::NistPreface,
+          )
+        end
+
+        def setup_un_register
+          sd = Metanorma::StandardDocument
+          reg = Lutaml::Model::Register.new(:un_document)
+          Lutaml::Model::GlobalRegister.register(reg)
+
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::Sections,
+            to_type: Metanorma::UnDocument::Sections::UnSections,
+          )
+          reg.register_global_type_substitution(
+            from_type: sd::Sections::Preface,
+            to_type: Metanorma::UnDocument::Sections::UnPreface,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/registers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Registers
+    autoload :Setup, "#{__dir__}/registers/setup"
+  end
+end

data/lib/metanorma/ribose_document/root.rb

@@ -1,67 +1,25 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module RiboseDocument
-    # Most basic document flavor — uses StandardDocument metadata
-    # but ISO document structure for sections/blocks.
-    class Root < Metanorma::StandardDocument::Root
-      attribute :version, :string
-      attribute :type, :string
-      attribute :schema_version, :string
-      attribute :flavor, :string
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
 
       attribute :bibdata,
                 Metanorma::RiboseDocument::Metadata::RiboseBibliographicItem
-
-      attribute :term_sources,
-                Metanorma::Document::Components::ReferenceElements::Citation,
+      attribute :preface,
+                Metanorma::StandardDocument::Sections::Preface
+      attribute :sections,
+                Metanorma::StandardDocument::Sections::Sections
+      attribute :annex,
+                Metanorma::StandardDocument::Sections::AnnexSection,
                 collection: true
 
-      attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
-      attribute :sections, Metanorma::IsoDocument::Sections::IsoSections
-      attribute :annex, Metanorma::IsoDocument::Sections::IsoAnnexSection,
-                collection: true
-      attribute :bibliography,
-                Metanorma::StandardDocument::Sections::BibliographySection
-      attribute :boilerplate, Metanorma::IsoDocument::Boilerplate
-      attribute :metanorma_extension,
-                Metanorma::IsoDocument::Metadata::MetanormaExtension
-      attribute :annotation_container, Metanorma::IsoDocument::AnnotationContainer
-      attribute :indexsect,
-                Metanorma::Document::Components::Sections::BasicSection
-      attribute :autonum, :string
-      attribute :fmt_xref_label, :string
-      attribute :localized_strings,
-                Metanorma::Document::Components::Inline::LocalizedStringsElement
-      attribute :fmt_footnote_container,
-                Metanorma::Document::Components::Inline::FmtFootnoteContainerElement
-      attribute :colophon, Metanorma::IsoDocument::Sections::Colophon
-
       xml do
         element "metanorma"
         namespace Metanorma::StandardDocument::Namespace
-        map_attribute "type", to: :type
-        map_attribute "version", to: :version
-        map_attribute "schema-version", to: :schema_version
-        map_attribute "flavor", to: :flavor
-        map_element "bibdata", to: :bibdata
-        map_element "termdocsource", to: :term_sources
-        map_element "metanorma-extension", to: :metanorma_extension
-        map_element "boilerplate", to: :boilerplate
-        map_element "preface", to: :preface
-        map_element "sections", to: :sections
-        map_element "annex", to: :annex
-        map_element "bibliography", to: :bibliography
-        map_element "annotation-container", to: :annotation_container
-        map_element "indexsect", to: :indexsect
-        map_element "localized-strings", to: :localized_strings
-        map_element "fmt-footnote-container", to: :fmt_footnote_container
-        map_element "colophon", to: :colophon
-        map_attribute "autonum", to: :autonum
-        map_attribute "fmt-xref-label", to: :fmt_xref_label
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
       end
     end
   end

data/lib/metanorma/ribose_document.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-
 module Metanorma
   module RiboseDocument
     autoload :Metadata, "metanorma/ribose_document/metadata"

data/lib/metanorma/standard_document/annotation_container.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    class AnnotationContainer < Lutaml::Model::Serializable
+      attribute :content, :string
+
+      xml do
+        element "annotation-container"
+        map_all_content to: :content
+      end
+    end
+  end
+end