metanorma-document 0.2.5 → 0.2.7

data/lib/metanorma/itu_document/root.rb

@@ -1,64 +1,24 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module ItuDocument
-    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::ItuBibliographicItem
-
-      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/itu_document.rb

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

data/lib/metanorma/jis_document/metadata/jis_bib_data_extension_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module JisDocument
+    module Metadata
+      class JisBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
+      end
+    end
+  end
+end

data/lib/metanorma/jis_document/metadata/jis_bibliographic_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module JisDocument
+    module Metadata
+      class JisBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+        attribute :ext, JisBibDataExtensionType
+
+        xml do
+          element "bibdata"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/jis_document/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module JisDocument
+    module Metadata
+      autoload :JisBibDataExtensionType,
+               "#{__dir__}/metadata/jis_bib_data_extension_type"
+      autoload :JisBibliographicItem,
+               "#{__dir__}/metadata/jis_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/jis_document/root.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module JisDocument
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      def self.lutaml_default_register
+        :jis_document
+      end
+
+      attribute :bibdata, Metadata::JisBibliographicItem
+      attribute :preface,
+                Metanorma::IsoDocument::Sections::IsoPreface
+      attribute :sections,
+                Metanorma::IsoDocument::Sections::IsoSections
+      attribute :annex,
+                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/jis_document/sections/jis_annex_section.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module JisDocument
+    module Sections
+      class JisAnnexSection < Metanorma::IsoDocument::Sections::IsoAnnexSection
+        attribute :commentary, :string
+
+        xml do
+          element "annex"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_attributes(self)
+          map_attribute "commentary", to: :commentary
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_elements(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/jis_document/sections.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module JisDocument
+    module Sections
+      autoload :JisAnnexSection, "#{__dir__}/sections/jis_annex_section"
+    end
+  end
+end

data/lib/metanorma/jis_document.rb

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

data/lib/metanorma/m3d_document/metadata/m3d_bib_data_extension_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module M3dDocument
+    module Metadata
+      class M3dBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
+      end
+    end
+  end
+end

data/lib/metanorma/m3d_document/metadata/m3d_bibliographic_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module M3dDocument
+    module Metadata
+      class M3dBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+        attribute :ext, M3dBibDataExtensionType
+
+        xml do
+          element "bibdata"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/m3d_document/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module M3dDocument
+    module Metadata
+      autoload :M3dBibDataExtensionType,
+               "#{__dir__}/metadata/m3d_bib_data_extension_type"
+      autoload :M3dBibliographicItem,
+               "#{__dir__}/metadata/m3d_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/m3d_document/root.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module M3dDocument
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      def self.lutaml_default_register
+        :m3d_document
+      end
+
+      attribute :bibdata, Metadata::M3dBibliographicItem
+      attribute :preface,
+                Metanorma::StandardDocument::Sections::Preface
+      attribute :sections,
+                Metanorma::StandardDocument::Sections::Sections
+      attribute :annex,
+                Metanorma::StandardDocument::Sections::AnnexSection,
+                collection: true
+
+      xml do
+        element "metanorma"
+        namespace Metanorma::StandardDocument::Namespace
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
+      end
+    end
+  end
+end

data/lib/metanorma/m3d_document.rb

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

data/lib/metanorma/nist_document/metadata/nist_bib_data_extension_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    module Metadata
+      class NistBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
+      end
+    end
+  end
+end

data/lib/metanorma/nist_document/metadata/nist_bibliographic_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    module Metadata
+      class NistBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+        attribute :ext, NistBibDataExtensionType
+
+        xml do
+          element "bibdata"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/nist_document/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    module Metadata
+      autoload :NistBibDataExtensionType,
+               "#{__dir__}/metadata/nist_bib_data_extension_type"
+      autoload :NistBibliographicItem,
+               "#{__dir__}/metadata/nist_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/nist_document/root.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module NistDocument
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      def self.lutaml_default_register
+        :nist_document
+      end
+
+      attribute :bibdata, Metadata::NistBibliographicItem
+      attribute :preface,
+                NistDocument::Sections::NistPreface
+      attribute :sections,
+                Metanorma::StandardDocument::Sections::Sections
+      attribute :annex,
+                Metanorma::StandardDocument::Sections::AnnexSection,
+                collection: true
+
+      xml do
+        element "metanorma"
+        namespace Metanorma::StandardDocument::Namespace
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
+      end
+    end
+  end
+end

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