metanorma-document 0.2.12 → 0.2.13

data/lib/metanorma/document/components/blocks/requirement_base.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Blocks
-        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::Document::Components::Blocks::RequirementModel",
-                    collection: true
-          attribute :recommendation, "Metanorma::Document::Components::Blocks::RecommendationModel",
-                    collection: true
-          attribute :permission, "Metanorma::Document::Components::Blocks::PermissionModel",
-                    collection: true
-          attribute :example,
-                    Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
-                    collection: true
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/blocks/requirement_classification.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Blocks
-        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
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/blocks/requirement_description.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module 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
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/blocks/requirement_inherit.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Blocks
-        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
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/inline/location_element.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Inline
-        # A secondary target inside an `<xref>` for multi-target cross
-        # references (e.g. "see Figure 4, 5.1.6 and 5.1.7"). Carries the
-        # target id and the connective used to join it to the previous
-        # target.
-        class LocationElement < Lutaml::Model::Serializable
-          attribute :target, :string
-          attribute :connective, :string
-
-          xml do
-            element "location"
-            map_attribute "target", to: :target
-            map_attribute "connective", to: :connective
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/inline/rendered_display.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Inline
-        # Marker module for `fmt-*` element classes — the rendered
-        # counterparts of semantic elements. Including this module marks
-        # a class as a presentation-layer sibling (e.g. `FmtStemElement`
-        # is the rendered counterpart of `StemInlineElement`).
-        #
-        # Used by `SemanticContent#each_semantic_content` to filter out
-        # rendered siblings so consumers iterating semantic content don't
-        # see both forms of the same logical content.
-        #
-        # Adding a new `fmt-*` class means one `include RenderedDisplay`
-        # line — no edits to the filtering logic.
-        module RenderedDisplay
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/inline/rendered_math_element.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Inline
-        # Math content inside an `<fmt-stem><semx>` rendered-display
-        # element. Represents the locale-rendered form of the math —
-        # decimal commas, thousands separators, locale-specific
-        # digit grouping.
-        #
-        # Subclass of `MathElement` so consumers that don't care about the
-        # distinction continue to work via the base class. Consumers that
-        # need to distinguish semantic from rendered forms use
-        # `math.is_a?(RenderedMathElement)` vs `math.is_a?(SemanticMathElement)`.
-        class RenderedMathElement < MathElement
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/inline/semantic_content.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Inline
-        # Iterator that yields only the semantic (canonical) children of a
-        # mixed-content element, skipping any rendered-display (`fmt-*`)
-        # siblings.
-        #
-        # Background: in Metanorma presentation XML, every semantic
-        # element with locale-sensitive rendering has a `fmt-*` sibling
-        # (e.g. `<stem>` + `<fmt-stem>`). When both are present in the
-        # same parent, `each_mixed_content` yields both — duplicating
-        # the logical content.
-        #
-        # Usage:
-        #
-        #   SemanticContent.each(paragraph) do |node|
-        #     # yields semantic children only; fmt_* skipped
-        #   end
-        #
-        #   SemanticContent.each(paragraph).to_a   # => Enumerator
-        #
-        # Consumers that want the rendered form access it directly via
-        # `node.fmt_*` attributes — no iterator needed.
-        module SemanticContent
-          class << self
-            def each(element, &block)
-              return enum_for(:each, element) unless block
-
-              element.each_mixed_content do |node|
-                next if rendered_display?(node)
-
-                yield node
-              end
-            end
-
-            private
-
-            def rendered_display?(node)
-              return false unless node.is_a?(Lutaml::Model::Serializable)
-
-              node.is_a?(RenderedDisplay)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/inline/semantic_math_element.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Inline
-        # Math content inside a semantic `<stem>` element. Represents the
-        # canonical form of the math — decimal periods, no locale-specific
-        # thousands separators.
-        #
-        # Subclass of `MathElement` so consumers that don't care about the
-        # distinction continue to work via the base class. Consumers that
-        # need to distinguish semantic from rendered forms use
-        # `math.is_a?(SemanticMathElement)` vs `math.is_a?(RenderedMathElement)`.
-        class SemanticMathElement < MathElement
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/inline/vocabulary.rb

@@ -1,184 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Inline
-        # Shared vocabulary of inline child elements that may appear in any
-        # general-purpose inline-content container. Including this module
-        # in a `Lutaml::Model::Serializable` subclass declares every inline
-        # element type as a collection attribute, so that no inline child
-        # encountered during parsing is silently dropped.
-        #
-        # Use together with `VocabularyXmlMapping.apply_inline_mappings`
-        # inside the class's `xml do ... end` block.
-        #
-        # Restricted child sets (e.g. `XrefElement` with only `<location>`
-        # children) intentionally do NOT include this module — they have
-        # semantic reasons to exclude the general vocabulary.
-        module Vocabulary
-          def self.included(base)
-            declare_text_attributes_on(base)
-            declare_formatting_attributes_on(base)
-            declare_cross_reference_attributes_on(base)
-            declare_structural_attributes_on(base)
-            declare_rendered_display_attributes_on(base)
-          end
-
-          class << self
-            def declare_text_attributes_on(base)
-              base.attribute :text, :string, collection: true
-              base.attribute :semx,
-                             Metanorma::Document::Components::Inline::SemxElement,
-                             collection: true
-            end
-
-            def declare_formatting_attributes_on(base)
-              base.attribute :em,
-                             Metanorma::Document::Components::Inline::EmRawElement,
-                             collection: true
-              base.attribute :strong,
-                             Metanorma::Document::Components::Inline::StrongRawElement,
-                             collection: true
-              base.attribute :sub,
-                             Metanorma::Document::Components::Inline::SubElement,
-                             collection: true
-              base.attribute :sup,
-                             Metanorma::Document::Components::Inline::SupElement,
-                             collection: true
-              base.attribute :tt,
-                             Metanorma::Document::Components::Inline::TtElement,
-                             collection: true
-              base.attribute :underline,
-                             Metanorma::Document::Components::TextElements::UnderlineElement,
-                             collection: true
-              base.attribute :strike,
-                             Metanorma::Document::Components::TextElements::StrikeElement,
-                             collection: true
-              base.attribute :smallcap,
-                             Metanorma::Document::Components::Inline::SmallCapElement,
-                             collection: true
-            end
-
-            def declare_cross_reference_attributes_on(base)
-              base.attribute :xref,
-                             Metanorma::Document::Components::Inline::XrefElement,
-                             collection: true
-              base.attribute :eref,
-                             Metanorma::Document::Components::Inline::ErefElement,
-                             collection: true
-              base.attribute :link,
-                             Metanorma::Document::Components::Inline::LinkElement,
-                             collection: true
-              base.attribute :span,
-                             Metanorma::Document::Components::Inline::SpanElement,
-                             collection: true
-            end
-
-            def declare_structural_attributes_on(base)
-              base.attribute :stem,
-                             Metanorma::Document::Components::Inline::StemInlineElement,
-                             collection: true
-              base.attribute :concept,
-                             Metanorma::Document::Components::Inline::ConceptElement,
-                             collection: true
-              base.attribute :fn,
-                             Metanorma::Document::Components::Inline::FnElement,
-                             collection: true
-              base.attribute :bcp14,
-                             Metanorma::Document::Components::Inline::Bcp14Element,
-                             collection: true
-              base.attribute :br,
-                             Metanorma::Document::Components::Inline::BrElement,
-                             collection: true
-              base.attribute :tab,
-                             Metanorma::Document::Components::Inline::TabElement,
-                             collection: true
-              base.attribute :bookmark,
-                             Metanorma::Document::Components::IdElements::Bookmark,
-                             collection: true
-              base.attribute :image,
-                             Metanorma::Document::Components::IdElements::Image,
-                             collection: true
-              base.attribute :index,
-                             Metanorma::Document::Components::EmptyElements::IndexElement,
-                             collection: true
-              base.attribute :add, "Metanorma::Document::Elements::Add",
-                             collection: true
-              base.attribute :del, "Metanorma::Document::Elements::Del",
-                             collection: true
-            end
-
-            def declare_rendered_display_attributes_on(base)
-              base.attribute :fmt_stem,
-                             Metanorma::Document::Components::Inline::FmtStemElement,
-                             collection: true
-              base.attribute :fmt_concept,
-                             Metanorma::Document::Components::Inline::FmtConceptElement,
-                             collection: true
-              base.attribute :fmt_fn_label,
-                             Metanorma::Document::Components::Inline::FmtFnLabelElement,
-                             collection: true
-              base.attribute :fmt_annotation_start,
-                             Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
-                             collection: true
-              base.attribute :fmt_annotation_end,
-                             Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
-                             collection: true
-            end
-          end
-
-          # Adds the `map_element` calls corresponding to every vocabulary
-          # attribute. Call inside an `xml do ... end` block:
-          #
-          #   xml do
-          #     element "span"
-          #     mixed_content
-          #     map_attribute "class", to: :class_attr
-          #     map_content to: :text
-          #     VocabularyXmlMapping.apply_inline_mappings(self)
-          #   end
-          module VocabularyXmlMapping
-            INLINE_MAPPINGS = {
-              "semx" => :semx,
-              "em" => :em,
-              "strong" => :strong,
-              "sub" => :sub,
-              "sup" => :sup,
-              "tt" => :tt,
-              "underline" => :underline,
-              "strike" => :strike,
-              "smallcap" => :smallcap,
-              "br" => :br,
-              "tab" => :tab,
-              "xref" => :xref,
-              "eref" => :eref,
-              "link" => :link,
-              "span" => :span,
-              "stem" => :stem,
-              "concept" => :concept,
-              "fn" => :fn,
-              "bcp14" => :bcp14,
-              "bookmark" => :bookmark,
-              "image" => :image,
-              "index" => :index,
-              "add" => :add,
-              "del" => :del,
-              "fmt-stem" => :fmt_stem,
-              "fmt-concept" => :fmt_concept,
-              "fmt-fn-label" => :fmt_fn_label,
-              "fmt-annotation-start" => :fmt_annotation_start,
-              "fmt-annotation-end" => :fmt_annotation_end,
-            }.freeze
-
-            def self.apply_inline_mappings(mapping)
-              INLINE_MAPPINGS.each do |element_name, attr_name|
-                mapping.map_element(element_name, to: attr_name)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/multi_paragraph/quote_author_element.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module MultiParagraph
-        class QuoteAuthorElement < Lutaml::Model::Serializable
-          attribute :id, :string
-          attribute :text, :string
-
-          xml do
-            element "author"
-            map_attribute "id", to: :id
-            map_content to: :text
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/reference_elements/source_modification.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module ReferenceElements
-        class SourceModification < Lutaml::Model::Serializable
-          attribute :id, :string
-          attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                    collection: true
-
-          xml do
-            element "modification"
-            map_attribute "id", to: :id
-            map_element "p", to: :p
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/reference_elements/source_origin.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module ReferenceElements
-        class SourceOrigin < Lutaml::Model::Serializable
-          attribute :bibitemid, :string
-          attribute :type, :string
-          attribute :citeas, :string
-          attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
-                    collection: true
-          attribute :display_text,
-                    Metanorma::Document::Components::Inline::DisplayTextElement
-
-          xml do
-            element "origin"
-            map_attribute "bibitemid", to: :bibitemid
-            map_attribute "type", to: :type
-            map_attribute "citeas", to: :citeas
-            map_element "localityStack", to: :locality_stack
-            map_element "display-text", to: :display_text
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/tables/col_element.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Tables
-        class ColElement < Lutaml::Model::Serializable
-          attribute :width, :string
-
-          xml do
-            element "col"
-            map_attribute "width", to: :width
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/tables/col_group_element.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Tables
-        class ColGroupElement < Lutaml::Model::Serializable
-          attribute :col, ColElement, collection: true
-
-          xml do
-            element "colgroup"
-            map_element "col", to: :col
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/tables/table_body_section.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Tables
-        class TableBodySection < TableSection
-          xml do
-            element "tbody"
-            map_element "tr", to: :tr
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/tables/table_foot_section.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Tables
-        class TableFootSection < TableSection
-          xml do
-            element "tfoot"
-            map_element "tr", to: :tr
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/components/tables/table_head_section.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Components
-      module Tables
-        class TableHeadSection < TableSection
-          xml do
-            element "thead"
-            map_element "tr", to: :tr
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/relaton/copyright_owner.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Relaton
-      class CopyrightOwner < Lutaml::Model::Serializable
-        attribute :organization, Organization
-
-        xml do
-          element "owner"
-          map_element "organization", to: :organization
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/relaton/formatted_address.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Relaton
-      class FormattedAddress < Lutaml::Model::Serializable
-        attribute :content, :string, collection: true
-        attribute :br, Metanorma::Document::Components::Inline::BrElement,
-                  collection: true
-
-        xml do
-          element "formattedAddress"
-          mixed_content
-          map_content to: :content
-          map_element "br", to: :br
-        end
-
-        def self.from_lines(lines)
-          new.tap do |fa|
-            fa.content = lines
-            fa.br = lines[1..].map do
-              Metanorma::Document::Components::Inline::BrElement.new
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/document/relaton/logo_element.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Document
-    module Relaton
-      class LogoElement < Lutaml::Model::Serializable
-        attribute :type, :string
-        attribute :content, :string
-
-        xml do
-          element "logo"
-          map_attribute "type", to: :type
-          map_all_content to: :content
-        end
-      end
-    end
-  end
-end