metanorma-document 0.5.1 → 0.5.2.pre.alpha.1

data/lib/metanorma/ribose_document/metadata/ribose_bibliographic_item.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module RiboseDocument
-    module Metadata
-      # Bibliographical description of a Ribose document.
-      # Inherits all ISO bibliographic fields; overrides ext for Ribose format.
-      class RiboseBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
-        attribute :ext, RiboseBibDataExtensionType
-
-        xml do
-          element "bibdata"
-          map_element "ext", to: :ext
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/ribose_document/metadata.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module RiboseDocument
-    module Metadata
-      autoload :RiboseBibDataExtensionType,
-               "#{__dir__}/metadata/ribose_bib_data_extension_type"
-      autoload :RiboseBibliographicItem,
-               "#{__dir__}/metadata/ribose_bibliographic_item"
-    end
-  end
-end

data/lib/metanorma/ribose_document/root.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module RiboseDocument
-    class Root < Lutaml::Model::Serializable
-      include Metanorma::StandardDocument::RootAttributes
-
-      attribute :bibdata,
-                Metanorma::RiboseDocument::Metadata::RiboseBibliographicItem
-      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/ribose_document.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module RiboseDocument
-    autoload :Metadata, "metanorma/ribose_document/metadata"
-    autoload :Root, "metanorma/ribose_document/root"
-  end
-end

data/lib/metanorma/standard_document/annotation_container.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    class AnnotationContainer < Lutaml::Model::Serializable
-      class Annotation < Lutaml::Model::Serializable
-        attribute :id, :string
-        attribute :reviewer, :string
-        attribute :from, :string
-        attribute :to, :string
-        attribute :type, :string
-        attribute :date, :string
-        attribute :semx_id, :string
-        attribute :paragraphs,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                  collection: true
-
-        xml do
-          element "annotation"
-          map_attribute "id", to: :id
-          map_attribute "reviewer", to: :reviewer
-          map_attribute "from", to: :from
-          map_attribute "to", to: :to
-          map_attribute "type", to: :type
-          map_attribute "date", to: :date
-          map_attribute "semx-id", to: :semx_id
-          map_element "p", to: :paragraphs
-        end
-      end
-
-      attribute :annotations, Annotation, collection: true
-
-      xml do
-        element "annotation-container"
-        map_element "annotation", to: :annotations
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/block_attributes.rb

@@ -1,281 +0,0 @@
-# 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
-
-    # Provides `blocks` method for ordered-content section types.
-    # Returns child block-level nodes in document order via `each_mixed_content`,
-    # excluding metadata/inline elements like titles and annotations.
-    module OrderedContent
-      NON_BLOCK_TYPES = [
-        Metanorma::Document::Components::Inline::TitleWithAnnotationElement,
-        Metanorma::Document::Components::Inline::FmtTitleElement,
-        Metanorma::Document::Components::Inline::VariantTitleElement,
-        Metanorma::Document::Components::Inline::FmtXrefLabelElement,
-        Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
-        Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
-      ].freeze
-
-      def blocks
-        @blocks ||=
-          begin
-            result = []
-            each_mixed_content do |node|
-              next if node.is_a?(String)
-              next if NON_BLOCK_TYPES.any? { |t| node.is_a?(t) }
-
-              result << node
-            end
-            result
-          end
-      end
-    end
-
-    # Presentation/formatting attributes shared by all section types.
-    # Include in any section class that supports presentation metadata.
-    module PresentationAttributes
-      def self.included(base)
-        base.class_eval do
-          attribute :anchor, :string
-          attribute :semx_id, :string
-          attribute :autonum, :string
-          attribute :displayorder, :integer
-          attribute :fmt_title,
-                    Metanorma::Document::Components::Inline::FmtTitleElement
-          attribute :fmt_xref_label,
-                    Metanorma::Document::Components::Inline::FmtXrefLabelElement,
-                    collection: true
-          attribute :variant_title,
-                    Metanorma::Document::Components::Inline::VariantTitleElement,
-                    collection: true
-          attribute :fmt_annotation_start,
-                    Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
-                    collection: true
-          attribute :fmt_annotation_end,
-                    Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
-                    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/amend_block.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Blocks
-      # Block expressing a machine-readable change in a document.
-      class AmendBlock < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
-        attribute :change, :string
-        attribute :bib_locality, Metanorma::Document::Relaton::BibItemLocality,
-                  collection: true
-        attribute :path, :string
-        attribute :path_end, :string
-        attribute :position, :string
-        attribute :name, :string
-        attribute :description,
-                  AmendContentBlock, collection: true
-        attribute :auto_number, Metanorma::StandardDocument::Blocks::AutoNumber,
-                  collection: true
-        attribute :new_content,
-                  AmendContentBlock, collection: true
-
-        # Presentation-specific attributes
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-        attribute :autonum, :string
-        attribute :displayorder, :integer
-
-        xml do
-          element "amend"
-          mixed_content
-          map_attribute "change", to: :change
-          map_element "bib-locality", to: :bib_locality
-          map_attribute "path", to: :path
-          map_attribute "position", to: :position
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-          map_attribute "autonum", to: :autonum
-          map_attribute "displayorder", to: :displayorder
-          map_attribute "path-end", to: :path_end
-          map_attribute "name", to: :name
-          map_element "autonumber", to: :auto_number
-          map_element "description", to: :description
-          map_element "newcontent", to: :new_content
-        end
-      end
-    end
-  end
-end

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

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Blocks
-      # Content block for amend description and new-content elements.
-      # Contains block-level content: paragraphs, notes, lists, tables, etc.
-      class AmendContentBlock < Lutaml::Model::Serializable
-        attribute :paragraphs,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                  collection: true
-        attribute :note,
-                  Metanorma::Document::Components::Blocks::NoteBlock,
-                  collection: true
-        attribute :ol,
-                  Metanorma::Document::Components::Lists::OrderedList,
-                  collection: true
-        attribute :ul,
-                  Metanorma::Document::Components::Lists::UnorderedList,
-                  collection: true
-        attribute :dl,
-                  Metanorma::Document::Components::Lists::DefinitionList,
-                  collection: true
-
-        xml do
-          map_element "p", to: :paragraphs
-          map_element "note", to: :note
-          map_element "ol", to: :ol
-          map_element "ul", to: :ul
-          map_element "dl", to: :dl
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Blocks
-      # Specification of how blocks of a given class should be autonumbered
-      # within an AmendBlock newContent element.
-      class AutoNumber < Lutaml::Model::Serializable
-        attribute :type, :string
-        attribute :value, :string
-
-        xml do
-          element "autonumber"
-          map_attribute "type", to: :type
-          map_content to: :value
-        end
-      end
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Blocks
-      class BlockSourceElement < Lutaml::Model::Serializable
-        attribute :status, :string
-        attribute :type, :string
-        attribute :origin, SourceOriginElement
-        attribute :modification, Metanorma::Document::Components::Paragraphs::ParagraphBlock
-
-        xml do
-          element "source"
-          map_attribute "status", to: :status
-          map_attribute "type", to: :type
-          map_element "origin", to: :origin
-          map_element "modification", to: :modification
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Blocks
-      # The type of change described in AmendBlock.
-      class ChangeType < Lutaml::Model::Serializable
-        attribute :value, :string
-
-        xml do
-          element "change-type"
-          map_content to: :value
-        end
-
-        def self.values
-          %w[add modify delete]
-        end
-      end
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Blocks
-      # The classes of block subject to autonumbering within an `AmendBlock` `newContent` element.
-      class ElementName < Lutaml::Model::Serializable
-        attribute :value, :string
-
-        xml do
-          element "element-name"
-          map_content to: :value
-        end
-
-        def self.values
-          %w[requirement recommendation permission table figure admonition formula
-             sourcecode example note]
-        end
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Blocks
-      # Input form, for use under HTML.
-      class Form < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
-        attribute :id, :string
-        attribute :name, :string
-        attribute :action, :string
-        attribute :class_attr, :string
-        attribute :text,
-                  Metanorma::Document::Components::TextElements::TextElement, collection: true
-        attribute :input, Metanorma::StandardDocument::Elements::FormInput,
-                  collection: true
-        attribute :label, Metanorma::StandardDocument::Elements::Label,
-                  collection: true
-        attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                  collection: true
-        attribute :table, Metanorma::Document::Components::Tables::TableBlock,
-                  collection: true
-
-        xml do
-          element "form"
-          map_attribute "id", to: :id
-          map_attribute "name", to: :name
-          map_attribute "action", to: :action
-          map_attribute "class", to: :class_attr
-          map_element "text", to: :text
-          map_element "input", to: :input
-          map_element "label", to: :label
-          map_element "p", to: :p
-          map_element "table", to: :table
-        end
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Blocks
-      # Specification of an area of an image to be hyperlinked, as part of an image map.
-      class ImageMapAreaType < Lutaml::Model::Serializable
-        attribute :type, :string
-        attribute :element, Metanorma::Document::Components::ReferenceElements::ReferenceElement
-        attribute :coords, Metanorma::StandardDocument::Blocks::ImageMapCoords,
-                  collection: true
-        attribute :radius, Metanorma::StandardDocument::Blocks::ImageMapRadius
-
-        xml do
-          element "image-map-area-type"
-          map_attribute "type", to: :type
-          map_element "element", to: :element
-          map_element "coords", to: :coords
-          map_element "radius", to: :radius
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Blocks
-      # The type of area in an image map to be hyperlinked.
-      class ImageMapAreaTypeType < Lutaml::Model::Serializable
-        attribute :value, :string
-
-        xml do
-          element "image-map-area-type-type"
-          map_content to: :value
-        end
-
-        def self.values
-          %w[rect circle ellipse poly]
-        end
-      end
-    end
-  end
-end