metanorma-document 0.2.6 → 0.2.7

data/lib/metanorma/standard_document/block_attributes.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    # Mixin that declares individually-typed block collection attributes
+    # for section-level models (ClauseSection, AnnexSection, ContentSection, etc.).
+    #
+    # Include this module in any Serializable class that represents a section
+    # body containing heterogeneous block-level content (paragraphs, tables,
+    # figures, etc.).
+    module BlockAttributes
+      def self.included(base)
+        base.class_eval do
+          attribute :paragraphs,
+                    Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+          attribute :unordered_lists,
+                    Metanorma::Document::Components::Lists::UnorderedList,
+                    collection: true
+          attribute :ordered_lists,
+                    Metanorma::Document::Components::Lists::OrderedList,
+                    collection: true
+          attribute :tables,
+                    Metanorma::Document::Components::Tables::TableBlock,
+                    collection: true
+          attribute :figures,
+                    Metanorma::Document::Components::AncillaryBlocks::FigureBlock,
+                    collection: true
+          attribute :formulas,
+                    Metanorma::Document::Components::AncillaryBlocks::FormulaBlock,
+                    collection: true
+          attribute :examples,
+                    Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
+                    collection: true
+          attribute :notes,
+                    Metanorma::Document::Components::Blocks::NoteBlock,
+                    collection: true
+          attribute :admonitions,
+                    Metanorma::Document::Components::MultiParagraph::AdmonitionBlock,
+                    collection: true
+          attribute :sourcecode_blocks,
+                    Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock,
+                    collection: true
+          attribute :quote_blocks,
+                    Metanorma::Document::Components::MultiParagraph::QuoteBlock,
+                    collection: true
+          attribute :definition_lists,
+                    Metanorma::Document::Components::Lists::DefinitionList,
+                    collection: true
+        end
+      end
+    end
+
+    # Adds XML element mappings for block-level content to a mapping builder.
+    # Call inside an `xml do` block:
+    #
+    #   xml do
+    #     element "clause"
+    #     ordered
+    #     BlockXmlMapping.apply_block_mappings(self)
+    #     # ... additional mappings
+    #   end
+    module BlockXmlMapping
+      BLOCK_MAPPINGS = {
+        "p" => :paragraphs,
+        "ul" => :unordered_lists,
+        "ol" => :ordered_lists,
+        "table" => :tables,
+        "figure" => :figures,
+        "formula" => :formulas,
+        "example" => :examples,
+        "note" => :notes,
+        "admonition" => :admonitions,
+        "sourcecode" => :sourcecode_blocks,
+        "quote" => :quote_blocks,
+        "dl" => :definition_lists,
+      }.freeze
+
+      def self.apply_block_mappings(mapping)
+        BLOCK_MAPPINGS.each do |element_name, attr_name|
+          mapping.map_element(element_name, to: attr_name)
+        end
+      end
+    end
+
+    # Shared XML mapping helpers for section-level elements.
+    # Extracts the common attribute/element mappings duplicated across
+    # ClauseSection, AnnexSection, and their flavor-specific subclasses.
+    module SectionXmlMapping
+      # Common XML attribute mappings for clause sections.
+      def self.apply_clause_attributes(mapping)
+        mapping.map_attribute "id",            to: :id
+        mapping.map_attribute "anchor",        to: :anchor
+        mapping.map_attribute "type",          to: :type
+        mapping.map_attribute "number",        to: :number
+        mapping.map_attribute "obligation",    to: :obligation
+        mapping.map_attribute "inline-header", to: :inline_header
+        mapping.map_attribute "unnumbered",    to: :unnumbered
+        mapping.map_attribute "toc",           to: :toc
+        mapping.map_attribute "class",         to: :class_attr
+        mapping.map_attribute "semx-id",       to: :semx_id
+        mapping.map_attribute "autonum",       to: :autonum
+        mapping.map_attribute "displayorder",  to: :displayorder
+      end
+
+      # Common XML element mappings for clause sections.
+      def self.apply_clause_elements(mapping)
+        mapping.map_element "title",                to: :title
+        mapping.map_element "variant-title",        to: :variant_title
+        mapping.map_element "fmt-title",            to: :fmt_title
+        mapping.map_element "fmt-xref-label",       to: :fmt_xref_label
+
+        BlockXmlMapping.apply_block_mappings(mapping)
+
+        mapping.map_element "amend",                to: :amend
+        mapping.map_element "clause",               to: :clause
+        mapping.map_element "terms",                to: :terms
+        mapping.map_element "definitions",          to: :definitions
+        mapping.map_element "references",           to: :references
+        mapping.map_element "floating-title",       to: :floating_title
+        mapping.map_element "form",                 to: :form
+        mapping.map_element "requirement",          to: :requirement
+        mapping.map_element "recommendation",       to: :recommendation
+        mapping.map_element "permission",           to: :permission
+        mapping.map_element "pagebreak",            to: :pagebreak
+        mapping.map_element "bookmark",             to: :bookmark
+        mapping.map_element "fmt-annotation-start", to: :fmt_annotation_start
+        mapping.map_element "fmt-annotation-end",   to: :fmt_annotation_end
+      end
+
+      # Common XML attribute mappings for annex sections.
+      def self.apply_annex_attributes(mapping)
+        mapping.map_attribute "id",            to: :id
+        mapping.map_attribute "number",        to: :number
+        mapping.map_attribute "obligation",    to: :obligation,
+                                               render_empty: true
+        mapping.map_attribute "unnumbered",    to: :unnumbered
+        mapping.map_attribute "toc",           to: :toc
+        mapping.map_attribute "anchor",        to: :anchor
+        mapping.map_attribute "semx-id",       to: :semx_id
+        mapping.map_attribute "autonum",       to: :autonum
+        mapping.map_attribute "displayorder",  to: :displayorder
+        mapping.map_attribute "inline-header", to: :inline_header
+        mapping.map_attribute "language",      to: :language, render_empty: true
+        mapping.map_attribute "script",        to: :script, render_empty: true
+      end
+
+      # Common XML element mappings for annex sections.
+      def self.apply_annex_elements(mapping)
+        mapping.map_element "title",                to: :title
+        mapping.map_element "variant-title",        to: :variant_title
+        mapping.map_element "fmt-title",            to: :fmt_title
+        mapping.map_element "fmt-xref-label",       to: :fmt_xref_label
+
+        BlockXmlMapping.apply_block_mappings(mapping)
+
+        mapping.map_element "clause",               to: :clause
+        mapping.map_element "appendix",             to: :appendix
+        mapping.map_element "terms",                to: :terms
+        mapping.map_element "definitions",          to: :definitions
+        mapping.map_element "references",           to: :references
+        mapping.map_element "floating-title",       to: :floating_title
+        mapping.map_element "pagebreak",            to: :pagebreak
+        mapping.map_element "fmt-annotation-start", to: :fmt_annotation_start
+        mapping.map_element "fmt-annotation-end",   to: :fmt_annotation_end
+      end
+
+      # Common XML element/attribute mappings for the sections container.
+      def self.apply_sections_elements(mapping)
+        mapping.map_element "clause",         to: :clause
+        mapping.map_element "terms",          to: :terms
+        mapping.map_element "definitions",    to: :definitions
+        mapping.map_element "floating-title", to: :floating_title
+        mapping.map_element "references",     to: :references
+      end
+
+      def self.apply_sections_attributes(mapping)
+        mapping.map_attribute "semx-id",      to: :semx_id
+        mapping.map_attribute "displayorder", to: :displayorder
+      end
+
+      # Common XML element/attribute mappings for preface containers.
+      def self.apply_preface_elements(mapping)
+        mapping.map_element "abstract",          to: :abstract
+        mapping.map_element "foreword",          to: :foreword
+        mapping.map_element "introduction",      to: :introduction
+        mapping.map_element "acknowledgements",  to: :acknowledgements
+        mapping.map_element "executivesummary",  to: :executivesummary
+      end
+
+      def self.apply_preface_attributes(mapping)
+        mapping.map_attribute "semx-id",      to: :semx_id
+        mapping.map_attribute "displayorder", to: :displayorder
+      end
+
+      # Common XML attribute/element mappings for ContentSection subclasses.
+      def self.apply_content_section_attributes(mapping)
+        mapping.map_attribute "id",             to: :id
+        mapping.map_attribute "anchor",         to: :anchor
+        mapping.map_attribute "type",           to: :type
+        mapping.map_attribute "number",         to: :number
+        mapping.map_attribute "obligation",     to: :obligation
+        mapping.map_attribute "inline-header",  to: :inline_header
+        mapping.map_attribute "unnumbered",     to: :unnumbered
+        mapping.map_attribute "toc",            to: :toc
+        mapping.map_attribute "class",          to: :class_attr
+        mapping.map_attribute "semx-id",        to: :semx_id
+        mapping.map_attribute "autonum",        to: :autonum
+        mapping.map_attribute "displayorder",   to: :displayorder
+      end
+
+      def self.apply_content_section_elements(mapping)
+        mapping.map_element "title",                to: :title
+        mapping.map_element "variant-title",        to: :variant_title
+        mapping.map_element "fmt-title",            to: :fmt_title
+        mapping.map_element "fmt-xref-label",       to: :fmt_xref_label
+
+        BlockXmlMapping.apply_block_mappings(mapping)
+
+        mapping.map_element "clause",               to: :subsection
+        mapping.map_element "fmt-annotation-start", to: :fmt_annotation_start
+        mapping.map_element "fmt-annotation-end",   to: :fmt_annotation_end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/blocks/passthrough.rb

@@ -1,20 +1,3 @@
 # frozen_string_literal: true
 
-module Metanorma
-  module StandardDocument
-    module Blocks
-      # Wrapper around raw markup to be transferred into one or more nominated output formats
-      # during processing.
-      class Passthrough < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
-        attribute :formats, :string
-        attribute :content, :string
-
-        xml do
-          element "passthrough"
-          map_attribute "formats", to: :formats
-          map_content to: :content
-        end
-      end
-    end
-  end
-end
+Metanorma::StandardDocument::Blocks::Passthrough = Metanorma::Document::Components::Blocks::Passthrough

data/lib/metanorma/standard_document/blocks/requirement_model.rb

@@ -1,165 +1,20 @@
 # frozen_string_literal: true
 
-module Metanorma
-  module StandardDocument
-    module Blocks
-      # Value element inside classification — mixed content with link.
-      class ClassificationValue < Lutaml::Model::Serializable
-        attribute :text, :string, collection: true
-        attribute :link, Metanorma::Document::Components::Inline::LinkElement,
-                  collection: true
-
-        xml do
-          mixed_content
-          map_content to: :text
-          map_element "link", to: :link
-        end
-      end
-
-      # Classification element inside requirement with tag/value children.
-      class RequirementClassification < Lutaml::Model::Serializable
-        attribute :tag, :string
-        attribute :value, ClassificationValue
-
-        xml do
-          element "classification"
-          map_element "tag", to: :tag
-          map_element "value", to: :value
-        end
-      end
-
-      # Description wrapper inside requirements containing paragraphs and other blocks.
-      class RequirementDescription < Lutaml::Model::Serializable
-        attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                  collection: true
-        attribute :ul, Metanorma::Document::Components::Lists::UnorderedList,
-                  collection: true
-        attribute :ol, Metanorma::Document::Components::Lists::OrderedList,
-                  collection: true
-        attribute :sourcecode,
-                  Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock,
-                  collection: true
-        attribute :table, Metanorma::Document::Components::Tables::TableBlock,
-                  collection: true
-        attribute :example,
-                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
-                  collection: true
-        attribute :note, Metanorma::Document::Components::Blocks::NoteBlock,
-                  collection: true
-        attribute :figure,
-                  Metanorma::Document::Components::AncillaryBlocks::FigureBlock,
-                  collection: true
-
-        xml do
-          element "description"
-          map_element "p", to: :p
-          map_element "ul", to: :ul
-          map_element "ol", to: :ol
-          map_element "sourcecode", to: :sourcecode
-          map_element "table", to: :table
-          map_element "example", to: :example
-          map_element "note", to: :note
-          map_element "figure", to: :figure
-        end
-      end
-
-      # Inherit element — mixed content, can contain text, eref, or xref.
-      class RequirementInherit < Lutaml::Model::Serializable
-        attribute :text, :string, collection: true
-        attribute :eref, Metanorma::Document::Components::Inline::ErefElement,
-                  collection: true
-        attribute :xref, Metanorma::Document::Components::Inline::XrefElement,
-                  collection: true
-
-        xml do
-          mixed_content
-          map_content to: :text
-          map_element "eref", to: :eref
-          map_element "xref", to: :xref
-        end
-      end
-
-      # Base class for requirement/recommendation/permission with shared structure.
-      class RequirementBase < Lutaml::Model::Serializable
-        attribute :id, :string
-        attribute :model, :string
-        attribute :obligation, :string
-        attribute :type, :string
-        attribute :anchor, :string
-        attribute :subject, :string
-        attribute :classification, RequirementClassification, collection: true
-        attribute :description, RequirementDescription, collection: true
-        attribute :inherit, RequirementInherit, collection: true
-        attribute :requirement, "Metanorma::StandardDocument::Blocks::RequirementModel",
-                  collection: true
-        attribute :recommendation, "Metanorma::StandardDocument::Blocks::RecommendationModel",
-                  collection: true
-        attribute :permission, "Metanorma::StandardDocument::Blocks::PermissionModel",
-                  collection: true
-        attribute :example,
-                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
-                  collection: true
-      end
-
-      # Requirement element — prescriptive statement using "shall".
-      class RequirementModel < RequirementBase
-        xml do
-          element "requirement"
-          map_attribute "id", to: :id
-          map_attribute "model", to: :model
-          map_attribute "obligation", to: :obligation
-          map_attribute "type", to: :type
-          map_attribute "anchor", to: :anchor
-          map_element "subject", to: :subject
-          map_element "classification", to: :classification
-          map_element "description", to: :description
-          map_element "inherit", to: :inherit
-          map_element "requirement", to: :requirement
-          map_element "recommendation", to: :recommendation
-          map_element "permission", to: :permission
-          map_element "example", to: :example
-        end
-      end
-
-      # Recommendation element — prescriptive statement using "should".
-      class RecommendationModel < RequirementBase
-        xml do
-          element "recommendation"
-          map_attribute "id", to: :id
-          map_attribute "model", to: :model
-          map_attribute "obligation", to: :obligation
-          map_attribute "type", to: :type
-          map_attribute "anchor", to: :anchor
-          map_element "subject", to: :subject
-          map_element "classification", to: :classification
-          map_element "description", to: :description
-          map_element "inherit", to: :inherit
-          map_element "requirement", to: :requirement
-          map_element "recommendation", to: :recommendation
-          map_element "permission", to: :permission
-          map_element "example", to: :example
-        end
-      end
-
-      # Permission element — prescriptive statement using "may".
-      class PermissionModel < RequirementBase
-        xml do
-          element "permission"
-          map_attribute "id", to: :id
-          map_attribute "model", to: :model
-          map_attribute "obligation", to: :obligation
-          map_attribute "type", to: :type
-          map_attribute "anchor", to: :anchor
-          map_element "subject", to: :subject
-          map_element "classification", to: :classification
-          map_element "description", to: :description
-          map_element "inherit", to: :inherit
-          map_element "requirement", to: :requirement
-          map_element "recommendation", to: :recommendation
-          map_element "permission", to: :permission
-          map_element "example", to: :example
-        end
-      end
-    end
-  end
-end
+DOC = Metanorma::Document::Components::Blocks
+
+Metanorma::StandardDocument::Blocks::ClassificationValue =
+  DOC::ClassificationValue
+Metanorma::StandardDocument::Blocks::RequirementClassification =
+  DOC::RequirementClassification
+Metanorma::StandardDocument::Blocks::RequirementDescription =
+  DOC::RequirementDescription
+Metanorma::StandardDocument::Blocks::RequirementInherit =
+  DOC::RequirementInherit
+Metanorma::StandardDocument::Blocks::RequirementBase =
+  DOC::RequirementBase
+Metanorma::StandardDocument::Blocks::RequirementModel =
+  DOC::RequirementModel
+Metanorma::StandardDocument::Blocks::RecommendationModel =
+  DOC::RecommendationModel
+Metanorma::StandardDocument::Blocks::PermissionModel =
+  DOC::PermissionModel

data/lib/metanorma/standard_document/boilerplate.rb

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

data/lib/metanorma/standard_document/elements/add.rb

@@ -1,19 +1,3 @@
 # frozen_string_literal: true
 
-module Metanorma
-  module StandardDocument
-    module Elements
-      # Indication of text added through editorial intervention.
-      class Add < Metanorma::Document::Components::TextElements::TextElement
-        attribute :semx_id, :string
-        attribute :original_id, :string
-        xml do
-          element "add"
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end
+Metanorma::StandardDocument::Elements::Add = Metanorma::Document::Elements::Add

data/lib/metanorma/standard_document/elements/del.rb

@@ -1,19 +1,3 @@
 # frozen_string_literal: true
 
-module Metanorma
-  module StandardDocument
-    module Elements
-      # Indication of text deleted through editorial intervention.
-      class Del < Metanorma::Document::Components::TextElements::TextElement
-        attribute :semx_id, :string
-        attribute :original_id, :string
-        xml do
-          element "del"
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end
+Metanorma::StandardDocument::Elements::Del = Metanorma::Document::Elements::Del

data/lib/metanorma/standard_document/metadata/metanorma_extension.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      class MetanormaExtension < Lutaml::Model::Serializable
+        attribute :content, :string
+
+        xml do
+          element "metanorma-extension"
+          map_all_content to: :content
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata.rb

@@ -5,6 +5,8 @@ module Metanorma
     module Metadata
       autoload :EditorialGroupType, "#{__dir__}/metadata/editorial_group_type"
       autoload :IcsType, "#{__dir__}/metadata/ics_type"
+      autoload :MetanormaExtension,
+               "#{__dir__}/metadata/metanorma_extension"
       autoload :StandardBibData, "#{__dir__}/metadata/standard_bib_data"
       autoload :StandardBibDataExtensionType,
                "#{__dir__}/metadata/standard_bib_data_extension_type"

data/lib/metanorma/standard_document/refs/reference_to_term.rb

@@ -5,7 +5,8 @@ module Metanorma
     module Refs
       # Cross-reference to a term.
       class ReferenceToTerm < Metanorma::Document::Components::ReferenceElements::ReferenceElement
-        attribute :source, BasicObject
+        attribute :source,
+                  Metanorma::Document::Components::ReferenceElements::SourceElement
         attribute :term, :string, collection: true
 
         attribute :semx_id, :string

data/lib/metanorma/standard_document/root_attributes.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    # Mixin that declares the common attributes for every <metanorma> Root class.
+    #
+    # Every flavor Root class includes this module and adds its own
+    # flavor-specific attributes (e.g. bibdata type, preface/sections types).
+    module RootAttributes
+      def self.included(base)
+        base.class_eval do
+          attribute :version,             :string
+          attribute :type,                :string
+          attribute :schema_version,      :string
+          attribute :flavor,              :string
+
+          attribute :bibliography,
+                    Metanorma::StandardDocument::Sections::BibliographySection
+          attribute :boilerplate,
+                    Metanorma::StandardDocument::Boilerplate
+          attribute :metanorma_extension,
+                    Metanorma::StandardDocument::Metadata::MetanormaExtension
+          attribute :annotation_container,
+                    Metanorma::StandardDocument::AnnotationContainer
+          attribute :localized_strings,
+                    Metanorma::Document::Components::Inline::LocalizedStringsElement
+          attribute :fmt_footnote_container,
+                    Metanorma::Document::Components::Inline::FmtFootnoteContainerElement
+          attribute :colophon,
+                    Metanorma::StandardDocument::Sections::Colophon
+
+          attribute :term_sources,
+                    Metanorma::Document::Components::ReferenceElements::Citation,
+                    collection: true
+          attribute :indexsect,
+                    Metanorma::Document::Components::Sections::BasicSection
+
+          attribute :autonum,             :string
+          attribute :fmt_xref_label,      :string
+        end
+      end
+    end
+
+    # Adds common XML root element mappings for all flavor Root classes.
+    # Call inside an `xml do` block:
+    #
+    #   xml do
+    #     element "metanorma"
+    #     namespace StandardDocument::Namespace
+    #     RootXmlMapping.apply(self)
+    #     # ... flavor-specific mappings (bibdata, preface, sections, annex)
+    #   end
+    module RootXmlMapping
+      def self.apply(mapping)
+        mapping.map_attribute "type",               to: :type
+        mapping.map_attribute "version",            to: :version
+        mapping.map_attribute "schema-version",     to: :schema_version
+        mapping.map_attribute "flavor",             to: :flavor
+        mapping.map_attribute "autonum",            to: :autonum
+        mapping.map_attribute "fmt-xref-label",     to: :fmt_xref_label
+        mapping.map_element   "bibdata",            to: :bibdata
+        mapping.map_element   "preface",            to: :preface
+        mapping.map_element   "sections",           to: :sections
+        mapping.map_element   "annex",              to: :annex
+        mapping.map_element   "bibliography",       to: :bibliography
+        mapping.map_element   "boilerplate",        to: :boilerplate
+        mapping.map_element   "metanorma-extension", to: :metanorma_extension
+        mapping.map_element   "annotation-container", to: :annotation_container
+        mapping.map_element   "localized-strings", to: :localized_strings
+        mapping.map_element   "fmt-footnote-container",
+                              to: :fmt_footnote_container
+        mapping.map_element   "colophon",           to: :colophon
+        mapping.map_element   "termdocsource",      to: :term_sources
+        mapping.map_element   "indexsect",          to: :indexsect
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/abstract.rb

@@ -4,10 +4,8 @@ module Metanorma
   module StandardDocument
     module Sections
       # Abstract of the document.
-      class Abstract < Metanorma::StandardDocument::Sections::StandardContentSection
-        attribute :semx_id, :string
+      class Abstract < Metanorma::StandardDocument::Sections::ContentSection
         attribute :original_id, :string
-        attribute :displayorder, :integer
         xml do
           element "abstract"
 

data/lib/metanorma/standard_document/sections/acknowledgements.rb

@@ -4,10 +4,8 @@ module Metanorma
   module StandardDocument
     module Sections
       # Acknowledgements for the document.
-      class Acknowledgements < Metanorma::StandardDocument::Sections::StandardContentSection
-        attribute :semx_id, :string
+      class Acknowledgements < Metanorma::StandardDocument::Sections::ContentSection
         attribute :original_id, :string
-        attribute :displayorder, :integer
         xml do
           element "acknowledgements"