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

data/lib/metanorma/standard_document/terms/term.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Terms
-      # A term (`Term`) represents a terminology entry with
-      # its definition.
-      #
-      # NOTE: The `Term` definition fully aligns with the structure
-      # and requirements of terms in ISO/IEC DIR 2, 16.6.
-      class Term < Lutaml::Model::Serializable
-        attribute :language, :string
-        attribute :script, :string
-        attribute :tag, :string
-        attribute :multilingual_rendering, :string
-        attribute :id, :string
-        attribute :preferred, Metanorma::StandardDocument::Terms::Designation,
-                  collection: true
-        attribute :admitted, Metanorma::StandardDocument::Terms::Designation,
-                  collection: true
-        attribute :related, Metanorma::StandardDocument::Terms::RelatedTerm,
-                  collection: true
-        attribute :deprecates, Metanorma::StandardDocument::Terms::Designation,
-                  collection: true
-        attribute :domain, Metanorma::Document::Components::DataTypes::LocalizedString
-        attribute :subject, Metanorma::Document::Components::DataTypes::LocalizedString
-        attribute :usage_info,
-                  Metanorma::Document::Components::Blocks::BasicBlock, collection: true
-        attribute :definition, Metanorma::StandardDocument::Terms::TermDefinition,
-                  collection: true
-        attribute :note,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock, collection: true
-        attribute :example,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock, collection: true
-        attribute :source, Metanorma::StandardDocument::Terms::TermSource,
-                  collection: true
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-
-        xml do
-          element "term"
-          map_attribute "language", to: :language
-          map_attribute "script", to: :script
-          map_attribute "tag", to: :tag
-          map_attribute "multilingual-rendering", to: :multilingual_rendering
-          map_attribute "id", to: :id
-          map_element "preferred", to: :preferred
-          map_element "admitted", to: :admitted
-          map_element "related", to: :related
-          map_element "deprecates", to: :deprecates
-          map_element "domain", to: :domain
-          map_element "subject", to: :subject
-          map_element "usage-info", to: :usage_info
-          map_element "definition", to: :definition
-          map_element "termnote", to: :note
-          map_element "termexample", to: :example
-          map_element "source", to: :source
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/terms/term_collection.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Terms
-      # A collection of terms, constituting the main body of a Terms Section.
-      class TermCollection < Lutaml::Model::Serializable
-        attribute :term, Metanorma::StandardDocument::Terms::Term,
-                  collection: true
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-
-        xml do
-          element "terms"
-          map_element "term", to: :term
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/terms/term_definition.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Terms
-      # The definition of a term applied in the current
-      # document.
-      class TermDefinition < Lutaml::Model::Serializable
-        attribute :verbalexpression, Metanorma::StandardDocument::Terms::VerbalExpression
-        attribute :nonverbalrepresentation, Metanorma::StandardDocument::Terms::NonVerbalRepresentation
-        attribute :source, Metanorma::StandardDocument::Terms::TermSource,
-                  collection: true
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-
-        xml do
-          element "definition"
-          map_element "verbal-definition", to: :verbalexpression
-          map_element "nonverbalrepresentation", to: :nonverbalrepresentation
-          map_element "source", to: :source
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/terms/term_expression.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Terms
-      class TermExpression < Lutaml::Model::Serializable
-        attribute :name, TermNameElement, collection: true
-        attribute :usage, :string
-        attribute :abbreviation_type, :string
-
-        xml do
-          element "expression"
-          map_element "name", to: :name
-          map_element "usage", to: :usage
-          map_element "abbreviation-type", to: :abbreviation_type
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/terms/term_name_element.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Terms
-      # A `<name>` element contains the rendered form of a term's
-      # designation. It accepts arbitrary inline content (formatting,
-      # math symbols, footnotes) — see `Inline::Vocabulary` for the
-      # full set.
-      class TermNameElement < Lutaml::Model::Serializable
-        include Metanorma::Document::Components::Inline::Vocabulary
-
-        attribute :id, :string
-        attribute :semx_id, :string
-        attribute :lang, :string
-
-        xml do
-          element "name"
-          map_attribute "id", to: :id
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "lang", to: :lang
-          mixed_content
-          Metanorma::Document::Components::Inline::Vocabulary::VocabularyXmlMapping
-            .apply_inline_mappings(self)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/terms/term_source.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Terms
-      # The bibliographic source where a term is defined in the
-      # sense applicable in this _StandardDocument_.
-      class TermSource < Lutaml::Model::Serializable
-        attribute :status, Metanorma::StandardDocument::Terms::TermSourceStatus
-        attribute :status, :string
-        attribute :origin, Metanorma::Document::Components::ReferenceElements::Citation
-        attribute :modification, Metanorma::Document::Components::Paragraphs::ParagraphBlock
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-
-        xml do
-          element "termsource"
-          map_attribute "status", to: :status
-          map_element "origin", to: :origin
-          map_element "modification", to: :modification
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/terms/term_source_status.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Terms
-      # The status of a term as it is used in this document, relative to its definition in the original
-      # document.
-      class TermSourceStatus < Lutaml::Model::Serializable
-        attribute :value, :string
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-
-        def self.values
-          %w[identical modified restyled context-added generalisation
-             specialisation unspecified]
-        end
-
-        xml do
-          element "term-source-status"
-          map_content to: :value
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/terms/term_source_type.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Terms
-      # The type of the managed term in the present context.
-      class TermSourceType < Lutaml::Model::Serializable
-        attribute :value, :string
-
-        def self.values
-          %w[authoritative lineage]
-        end
-
-        xml do
-          element "term-source-type"
-          map_content to: :value
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/terms/verbal_expression.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Terms
-      # Verbal expression of the term.
-      class VerbalExpression < Lutaml::Model::Serializable
-        attribute :paragraph,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock, 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
-
-        # Presentation-specific attributes
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-
-        xml do
-          element "verbal-definition"
-          map_element "p", to: :paragraph
-          map_element "ol", to: :ol
-          map_element "ul", to: :ul
-          map_element "dl", to: :dl
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/terms.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Terms
-      autoload :AbbreviationType, "#{__dir__}/terms/abbreviation_type"
-      autoload :Concept, "#{__dir__}/terms/concept"
-      autoload :DefinitionCollection, "#{__dir__}/terms/definition_collection"
-      autoload :Designation, "#{__dir__}/terms/designation"
-      autoload :ExpressionDesignation, "#{__dir__}/terms/expression_designation"
-      autoload :ExpressionType, "#{__dir__}/terms/expression_type"
-      autoload :GrammarGender, "#{__dir__}/terms/grammar_gender"
-      autoload :GrammarInfo, "#{__dir__}/terms/grammar_info"
-      autoload :GraphicalSymbolDesignation,
-               "#{__dir__}/terms/graphical_symbol_designation"
-      autoload :LetterSymbolDesignation,
-               "#{__dir__}/terms/letter_symbol_designation"
-      autoload :NonVerbalRepresentation,
-               "#{__dir__}/terms/non_verbal_representation"
-      autoload :RelatedTerm, "#{__dir__}/terms/related_term"
-      autoload :RelatedTermType, "#{__dir__}/terms/related_term_type"
-      autoload :Term, "#{__dir__}/terms/term"
-      autoload :TermCollection, "#{__dir__}/terms/term_collection"
-      autoload :TermDefinition, "#{__dir__}/terms/term_definition"
-      autoload :TermExpression, "#{__dir__}/terms/term_expression"
-      autoload :TermNameElement, "#{__dir__}/terms/term_name_element"
-      autoload :TermSource, "#{__dir__}/terms/term_source"
-      autoload :TermSourceStatus, "#{__dir__}/terms/term_source_status"
-      autoload :TermSourceType, "#{__dir__}/terms/term_source_type"
-      autoload :VerbalExpression, "#{__dir__}/terms/verbal_expression"
-    end
-  end
-end

data/lib/metanorma/standard_document.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    autoload :AnnotationContainer,
-             "metanorma/standard_document/annotation_container"
-    autoload :BlockAttributes, "metanorma/standard_document/block_attributes"
-    autoload :BlockXmlMapping, "metanorma/standard_document/block_attributes"
-    autoload :SectionXmlMapping, "metanorma/standard_document/block_attributes"
-    autoload :PresentationAttributes,
-             "metanorma/standard_document/block_attributes"
-    autoload :OrderedContent, "metanorma/standard_document/block_attributes"
-    autoload :Blocks, "metanorma/standard_document/blocks"
-    autoload :Boilerplate, "metanorma/standard_document/boilerplate"
-    autoload :Elements, "metanorma/standard_document/elements"
-    autoload :Lists, "metanorma/standard_document/lists"
-    autoload :Metadata, "metanorma/standard_document/metadata"
-    autoload :Namespace, "metanorma/standard_document/namespace"
-    autoload :Refs, "metanorma/standard_document/refs"
-    autoload :Root, "metanorma/standard_document/root"
-    autoload :RootAttributes, "metanorma/standard_document/root_attributes"
-    autoload :Sections, "metanorma/standard_document/sections"
-    autoload :StandardDocumentType,
-             "metanorma/standard_document/standard_document_type"
-    autoload :Terms, "metanorma/standard_document/terms"
-  end
-end

data/lib/metanorma/un_document/blocks/un_admonition_block.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module UnDocument
-    module Blocks
-      # Admonition block of a UN document.
-      # Corresponds to un.rng:
-      #   AdmonitionType = danger | caution | warning | important |
-      #                    "safety precautions"
-      #   AdmonitionBody = tname?,
-      #     ( paragraph-with-footnote | table | formula | ol | ul | dl |
-      #       figure | quote | sourcecode | example | review )+,
-      #     note*
-      # The UN grammar widens the isodoc admonition body from paragraphs only
-      # to most block types, with notes permitted after the body.
-      # `uri` keeps the base model's element mapping (the current basicdoc
-      # grammar declares it an attribute — a base-level divergence affecting
-      # all flavors, left as-is here).
-      class UnAdmonitionBlock < Metanorma::Document::Components::MultiParagraph::AdmonitionBlock
-        # UN restricts AdmonitionType to five values.
-        attribute :type, :string,
-                  values: ["danger", "caution", "warning", "important",
-                           "safety precautions"]
-
-        attribute :tables,
-                  Metanorma::Document::Components::Tables::TableBlock,
-                  collection: true
-        attribute :formulas,
-                  Metanorma::Document::Components::AncillaryBlocks::FormulaBlock,
-                  collection: true
-        attribute :ordered_lists,
-                  Metanorma::Document::Components::Lists::OrderedList,
-                  collection: true
-        attribute :unordered_lists,
-                  Metanorma::Document::Components::Lists::UnorderedList,
-                  collection: true
-        attribute :definition_lists,
-                  Metanorma::Document::Components::Lists::DefinitionList,
-                  collection: true
-        attribute :figures,
-                  Metanorma::Document::Components::AncillaryBlocks::FigureBlock,
-                  collection: true
-        attribute :quote_blocks,
-                  Metanorma::Document::Components::MultiParagraph::QuoteBlock,
-                  collection: true
-        attribute :sourcecode_blocks,
-                  Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock,
-                  collection: true
-        attribute :examples,
-                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
-                  collection: true
-        attribute :reviews,
-                  Metanorma::Document::Components::MultiParagraph::ReviewBlock,
-                  collection: true
-        attribute :notes,
-                  Metanorma::Document::Components::Blocks::NoteBlock,
-                  collection: true
-
-        xml do
-          element "admonition"
-          ordered
-
-          map_attribute "id",         to: :id
-          map_attribute "type",       to: :type
-          map_attribute "class",      to: :block_class
-          map_attribute "unnumbered", to: :unnumbered
-
-          map_element "name",         to: :name
-          map_element "fmt-name",     to: :fmt_name
-          map_element "p",            to: :paragraphs
-          map_element "table",        to: :tables
-          map_element "formula",      to: :formulas
-          map_element "ol",           to: :ordered_lists
-          map_element "ul",           to: :unordered_lists
-          map_element "dl",           to: :definition_lists
-          map_element "figure",       to: :figures
-          map_element "quote",        to: :quote_blocks
-          map_element "sourcecode",   to: :sourcecode_blocks
-          map_element "example",      to: :examples
-          map_element "review",       to: :reviews
-          map_element "note",         to: :notes
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/un_document/blocks.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module UnDocument
-    module Blocks
-      autoload :UnAdmonitionBlock, "#{__dir__}/blocks/un_admonition_block"
-    end
-  end
-end

data/lib/metanorma/un_document/metadata/un_bib_data_extension_type.rb

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

data/lib/metanorma/un_document/metadata/un_bibliographic_item.rb

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

data/lib/metanorma/un_document/metadata.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module UnDocument
-    module Metadata
-      autoload :UnBibDataExtensionType,
-               "#{__dir__}/metadata/un_bib_data_extension_type"
-      autoload :UnBibliographicItem,
-               "#{__dir__}/metadata/un_bibliographic_item"
-    end
-  end
-end

data/lib/metanorma/un_document/root.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module UnDocument
-    class Root < Lutaml::Model::Serializable
-      include Metanorma::StandardDocument::RootAttributes
-
-      def self.lutaml_default_register
-        :un_document
-      end
-
-      attribute :bibdata, Metadata::UnBibliographicItem
-      attribute :preface,
-                UnDocument::Sections::UnPreface
-      attribute :sections,
-                UnDocument::Sections::UnSections
-      attribute :annex,
-                Metanorma::StandardDocument::Sections::AnnexSection,
-                collection: true
-
-      # Validates the parsed document against the UN grammar restrictions
-      # the model does not enforce structurally (currently: the UN
-      # TextElement inline subset). Walks the model graph and returns an
-      # array of error strings; empty when the document is valid.
-      def grammar_errors
-        Metanorma::UnDocument::UnTextElement.validate(self)
-      end
-
-      xml do
-        element "metanorma"
-        namespace Metanorma::StandardDocument::Namespace
-
-        Metanorma::StandardDocument::RootXmlMapping.apply(self)
-      end
-    end
-  end
-end

data/lib/metanorma/un_document/sections/un_abstract_section.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module UnDocument
-    module Sections
-      # Abstract of a UN document.
-      # Corresponds to un.rng:
-      #   abstract = element abstract { Basic-Section }
-      #   Basic-Section = Basic-Section-Attributes, section-title?, BasicBlock+
-      # Unlike the isodoc default (Content-Section), a UN abstract contains
-      # no subsections, so no `clause` mapping is declared. Composed from the
-      # shared mixins rather than inheriting ContentSection, because
-      # lutaml-model deep-duplicates a parent's XML mappings into subclasses
-      # (inheriting would keep the Content-Section `clause` mapping).
-      class UnAbstractSection < Lutaml::Model::Serializable
-        include Metanorma::StandardDocument::BlockAttributes
-        include Metanorma::StandardDocument::PresentationAttributes
-
-        attribute :id, :string
-        attribute :obligation, :string
-        attribute :title,
-                  Metanorma::Document::Components::Inline::TitleWithAnnotationElement
-
-        xml do
-          element "abstract"
-          ordered
-
-          map_attribute "id",           to: :id
-          map_attribute "obligation",   to: :obligation
-          map_attribute "anchor",       to: :anchor
-          map_attribute "semx-id",      to: :semx_id
-          map_attribute "autonum",      to: :autonum
-          map_attribute "displayorder", to: :displayorder
-
-          map_element "title",                to: :title
-          map_element "variant-title",        to: :variant_title
-          map_element "fmt-title",            to: :fmt_title
-          map_element "fmt-xref-label",       to: :fmt_xref_label
-
-          Metanorma::StandardDocument::BlockXmlMapping.apply_block_mappings(self)
-
-          map_element "fmt-annotation-start", to: :fmt_annotation_start
-          map_element "fmt-annotation-end",   to: :fmt_annotation_end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/un_document/sections/un_preface.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module UnDocument
-    module Sections
-      # UN preface with only abstract, foreword, introduction.
-      # Corresponds to un.rng:
-      #   preface = element preface { abstract?, foreword?, introduction? }
-      #
-      # This class deliberately does NOT inherit StandardDocument::Preface:
-      # lutaml-model deep-duplicates a parent's XML mappings into subclasses,
-      # so inheriting would keep the isodoc-level acknowledgements,
-      # executivesummary and clause mappings that the UN grammar forbids.
-      # Attributes are composed directly instead.
-      #
-      # The UN abstract is a Basic-Section (UnAbstractSection); foreword and
-      # introduction keep the isodoc Content-Section model.
-      class UnPreface < Lutaml::Model::Serializable
-        attribute :abstract, UnAbstractSection
-        attribute :foreword, Metanorma::StandardDocument::Sections::ContentSection
-        attribute :introduction, Metanorma::StandardDocument::Sections::ContentSection
-
-        # Presentation-specific attributes
-        attribute :semx_id, :string
-        attribute :displayorder, :integer
-
-        xml do
-          element "preface"
-          ordered
-
-          map_element "abstract",      to: :abstract
-          map_element "foreword",      to: :foreword
-          map_element "introduction",  to: :introduction
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_attributes(self)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/un_document/sections/un_sections.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module UnDocument
-    module Sections
-      # UN sections container.
-      # Corresponds to un.rnc:
-      #   sections = element sections { (clause | floating-title)+ }
-      #
-      # UN does not allow terms/definitions at top level of sections.
-      class UnSections < Metanorma::StandardDocument::Sections::Sections
-        xml do
-          element "sections"
-          ordered
-
-          map_element "clause",         to: :clause
-          map_element "floating-title", to: :floating_title
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/un_document/sections.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module UnDocument
-    module Sections
-      autoload :UnAbstractSection, "#{__dir__}/sections/un_abstract_section"
-      autoload :UnPreface, "#{__dir__}/sections/un_preface"
-      autoload :UnSections, "#{__dir__}/sections/un_sections"
-    end
-  end
-end