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

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

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      # <presentation-metadata> carries rendering hints for the document.
-      #
-      # Current serialization uses typed children (toc-heading-levels,
-      # document-scheme, the OGC color-* family, OIML doctype-alias/fonts,
-      # isodoc html-details-open). The legacy serialization (still emitted
-      # into misc-container by some flavors) uses <name>/<value> pairs
-      # instead. Both shapes are mapped here so either round-trips
-      # losslessly. map_element order matches the order emitted by
-      # metanorma across spec fixtures.
-      class PresentationMetadata < Lutaml::Model::Serializable
-        attribute :doctype_alias, :string
-        attribute :document_scheme, :string
-        attribute :color_admonition_caution, :string
-        attribute :color_admonition_editor, :string
-        attribute :color_admonition_important, :string
-        attribute :color_admonition_note, :string
-        attribute :color_admonition_safety_precaution, :string
-        attribute :color_admonition_tip, :string
-        attribute :color_admonition_todo, :string
-        attribute :color_admonition_warning, :string
-        attribute :color_background_definition_description, :string
-        attribute :color_background_definition_term, :string
-        attribute :color_background_page, :string
-        attribute :color_background_table_header, :string
-        attribute :color_background_table_row_even, :string
-        attribute :color_background_table_row_odd, :string
-        attribute :color_background_term_admitted_label, :string
-        attribute :color_background_term_deprecated_label, :string
-        attribute :color_background_term_preferred_label, :string
-        attribute :color_background_text_label_legacy, :string
-        attribute :color_secondary_shade1, :string
-        attribute :color_secondary_shade2, :string
-        attribute :color_text, :string
-        attribute :color_text_title, :string
-        attribute :toc_heading_levels, :string
-        attribute :html_toc_heading_levels, :string
-        attribute :doc_toc_heading_levels, :string
-        attribute :pdf_toc_heading_levels, :string
-        attribute :html_details_open, :string
-        attribute :fonts, :string, collection: true
-        attribute :name, :string
-        attribute :value, :string
-
-        xml do
-          element "presentation-metadata"
-          map_element "doctype-alias", to: :doctype_alias
-          map_element "document-scheme", to: :document_scheme
-          map_element "color-admonition-caution",
-                      to: :color_admonition_caution
-          map_element "color-admonition-editor",
-                      to: :color_admonition_editor
-          map_element "color-admonition-important",
-                      to: :color_admonition_important
-          map_element "color-admonition-note",
-                      to: :color_admonition_note
-          map_element "color-admonition-safety-precaution",
-                      to: :color_admonition_safety_precaution
-          map_element "color-admonition-tip",
-                      to: :color_admonition_tip
-          map_element "color-admonition-todo",
-                      to: :color_admonition_todo
-          map_element "color-admonition-warning",
-                      to: :color_admonition_warning
-          map_element "color-background-definition-description",
-                      to: :color_background_definition_description
-          map_element "color-background-definition-term",
-                      to: :color_background_definition_term
-          map_element "color-background-page",
-                      to: :color_background_page
-          map_element "color-background-table-header",
-                      to: :color_background_table_header
-          map_element "color-background-table-row-even",
-                      to: :color_background_table_row_even
-          map_element "color-background-table-row-odd",
-                      to: :color_background_table_row_odd
-          map_element "color-background-term-admitted-label",
-                      to: :color_background_term_admitted_label
-          map_element "color-background-term-deprecated-label",
-                      to: :color_background_term_deprecated_label
-          map_element "color-background-term-preferred-label",
-                      to: :color_background_term_preferred_label
-          map_element "color-background-text-label-legacy",
-                      to: :color_background_text_label_legacy
-          map_element "color-secondary-shade-1",
-                      to: :color_secondary_shade1
-          map_element "color-secondary-shade-2",
-                      to: :color_secondary_shade2
-          map_element "color-text", to: :color_text
-          map_element "color-text-title", to: :color_text_title
-          map_element "toc-heading-levels", to: :toc_heading_levels
-          map_element "html-toc-heading-levels", to: :html_toc_heading_levels
-          map_element "doc-toc-heading-levels", to: :doc_toc_heading_levels
-          map_element "pdf-toc-heading-levels", to: :pdf_toc_heading_levels
-          map_element "html-details-open", to: :html_details_open
-          map_element "fonts", to: :fonts
-          map_element "name", to: :name
-          map_element "value", to: :value
-        end
-      end
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      # <semantic-metadata> carries semantic flags about the document
-      # (only <stage-published> has been observed in the wild).
-      class SemanticMetadata < Lutaml::Model::Serializable
-        attribute :stage_published, :string
-
-        xml do
-          element "semantic-metadata"
-          map_element "stage-published", to: :stage_published
-        end
-      end
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      # The bibliographic description of a _StandardDocument_.
-      class StandardBibData < Metanorma::Document::Components::BibData::BibData
-        attribute :type, :string
-        attribute :ext, Metanorma::StandardDocument::Metadata::StandardBibDataExtensionType
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-
-        xml do
-          element "bibdata"
-          map_attribute "type", to: :type
-          map_element "ext", to: :ext
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      # The extension point of the bibliographic description of a _StandardDocument_.
-      class StandardBibDataExtensionType < Metanorma::Document::Components::BibData::BibDataExtensionType
-        attribute :doctype, :string
-        attribute :doctype_abbreviation, :string
-        attribute :subdoctype, :string
-        attribute :editorial_group, Metanorma::StandardDocument::Metadata::EditorialGroupType
-        attribute :ics, Metanorma::StandardDocument::Metadata::IcsType,
-                  collection: true
-        attribute :structuredidentifier, Metanorma::StandardDocument::Metadata::StructuredIdentifierType,
-                  collection: true
-
-        # Presentation-specific attributes
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-
-        xml do
-          element "ext"
-          map_attribute "doctype", to: :doctype
-          map_attribute "doctype-abbreviation", to: :doctype_abbreviation
-          map_element "subdoctype", to: :subdoctype
-          map_element "editorial-group", to: :editorial_group
-          map_element "ics", to: :ics
-          map_element "structuredidentifier", to: :structuredidentifier
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      # Representation of the identifier for a _StandardDocument_, giving its individual semantic
-      # components.
-      class StructuredIdentifierType < Lutaml::Model::Serializable
-        attribute :type, :string
-        attribute :agency, :string, collection: true
-        attribute :class, :string
-        attribute :docnumber, :string
-        attribute :partnumber, :string
-        attribute :edition, :string
-        attribute :version, :string
-        attribute :supplementtype, :string
-        attribute :supplementnumber, :string
-        attribute :year, :string
-        attribute :language, :string
-        attribute :part, :string
-        attribute :appendix, :string
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-
-        xml do
-          element "structuredidentifier"
-          map_attribute "type", to: :type
-          map_element "agency", to: :agency
-          map_attribute "class", to: :class
-          map_attribute "docnumber", to: :docnumber
-          map_attribute "partnumber", to: :partnumber
-          map_attribute "edition", to: :edition
-          map_attribute "version", to: :version
-          map_attribute "supplementtype", to: :supplementtype
-          map_attribute "supplementnumber", to: :supplementnumber
-          map_element "year", to: :year
-          map_attribute "language", to: :language
-          map_element "part", to: :part
-          map_element "appendix", to: :appendix
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      # Technical committee associated with the production of a standards document.
-      class TechnicalCommitteeType < Lutaml::Model::Serializable
-        attribute :number, :integer
-        attribute :type, :string
-        attribute :text, :string
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-
-        xml do
-          element "technical-committee"
-          map_attribute "number", to: :number
-          map_attribute "type", to: :type
-          map_attribute "text", to: :text
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/amount_of_substance.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class AmountOfSubstance < Lutaml::Model::Serializable
-          include BaseQuantityAttributes
-
-          xml do
-            element "AmountOfSubstance"
-            namespace Unitsml::Namespace
-            BaseQuantityXmlMapping.apply(self)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/base_quantity.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        # Shared attributes for the eight UnitsML base-quantity elements
-        # (Length, Mass, Time, ElectricCurrent, AmountOfSubstance,
-        # ThermodynamicTemperature, LuminousIntensity, PlaneAngle).
-        module BaseQuantityAttributes
-          def self.included(base)
-            base.class_eval do
-              attribute :symbol, :string
-              attribute :power_numerator, :integer
-              attribute :power_denominator, :integer
-            end
-          end
-        end
-
-        # Shared attribute mappings for the base-quantity elements.
-        # lutaml-model does not inherit xml mappings, so each per-tag class
-        # applies this inside its own `xml do` block (same pattern as
-        # StandardDocument::RootXmlMapping).
-        module BaseQuantityXmlMapping
-          def self.apply(mapping)
-            mapping.map_attribute "symbol", to: :symbol
-            mapping.map_attribute "powerNumerator", to: :power_numerator
-            mapping.map_attribute "powerDenominator", to: :power_denominator
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/dimension.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class Dimension < Lutaml::Model::Serializable
-          attribute :id, :string
-          attribute :semx_id, :string
-
-          attribute :length, Length
-          attribute :mass, Mass
-          attribute :time, Time
-          attribute :electric_current, ElectricCurrent
-          attribute :thermodynamic_temperature, ThermodynamicTemperature
-          attribute :amount_of_substance, AmountOfSubstance
-          attribute :luminous_intensity, LuminousIntensity
-          attribute :plane_angle, PlaneAngle
-
-          xml do
-            element "Dimension"
-            namespace Unitsml::Namespace
-            map_attribute "id", to: :id
-            map_attribute "semx-id", to: :semx_id
-            map_element "Length", to: :length
-            map_element "Mass", to: :mass
-            map_element "Time", to: :time
-            map_element "ElectricCurrent", to: :electric_current
-            map_element "ThermodynamicTemperature",
-                        to: :thermodynamic_temperature
-            map_element "AmountOfSubstance", to: :amount_of_substance
-            map_element "LuminousIntensity", to: :luminous_intensity
-            map_element "PlaneAngle", to: :plane_angle
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/dimension_set.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class DimensionSet < Lutaml::Model::Serializable
-          attribute :dimension, Dimension, collection: true
-
-          xml do
-            element "DimensionSet"
-            namespace Unitsml::Namespace
-            map_element "Dimension", to: :dimension
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/electric_current.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class ElectricCurrent < Lutaml::Model::Serializable
-          include BaseQuantityAttributes
-
-          xml do
-            element "ElectricCurrent"
-            namespace Unitsml::Namespace
-            BaseQuantityXmlMapping.apply(self)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/enumerated_root_unit.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class EnumeratedRootUnit < Lutaml::Model::Serializable
-          attribute :unit, :string
-          attribute :prefix, :string
-          attribute :power_numerator, :integer
-
-          xml do
-            element "EnumeratedRootUnit"
-            namespace Unitsml::Namespace
-            map_attribute "unit", to: :unit
-            map_attribute "prefix", to: :prefix
-            map_attribute "powerNumerator", to: :power_numerator
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/length.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class Length < Lutaml::Model::Serializable
-          include BaseQuantityAttributes
-
-          xml do
-            element "Length"
-            namespace Unitsml::Namespace
-            BaseQuantityXmlMapping.apply(self)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/luminous_intensity.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class LuminousIntensity < Lutaml::Model::Serializable
-          include BaseQuantityAttributes
-
-          xml do
-            element "LuminousIntensity"
-            namespace Unitsml::Namespace
-            BaseQuantityXmlMapping.apply(self)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/mass.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class Mass < Lutaml::Model::Serializable
-          include BaseQuantityAttributes
-
-          xml do
-            element "Mass"
-            namespace Unitsml::Namespace
-            BaseQuantityXmlMapping.apply(self)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/namespace.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        # UnitsML vocabulary namespace. Fixtures use the default-namespace
-        # form (<UnitsML xmlns="..."> with unprefixed children), so no
-        # prefix_default is declared.
-        class Namespace < Lutaml::Xml::Namespace
-          uri "https://schema.unitsml.org/unitsml/1.0"
-          element_form_default :qualified
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/plane_angle.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class PlaneAngle < Lutaml::Model::Serializable
-          include BaseQuantityAttributes
-
-          xml do
-            element "PlaneAngle"
-            namespace Unitsml::Namespace
-            BaseQuantityXmlMapping.apply(self)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/prefix.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class Prefix < Lutaml::Model::Serializable
-          attribute :prefix_base, :integer
-          attribute :prefix_power, :integer
-          attribute :id, :string
-          attribute :semx_id, :string
-
-          attribute :prefix_name, PrefixName
-          attribute :prefix_symbol, PrefixSymbol, collection: true
-
-          xml do
-            element "Prefix"
-            namespace Unitsml::Namespace
-            map_attribute "prefixBase", to: :prefix_base
-            map_attribute "prefixPower", to: :prefix_power
-            map_attribute "id", to: :id
-            map_attribute "semx-id", to: :semx_id
-            map_element "PrefixName", to: :prefix_name
-            map_element "PrefixSymbol", to: :prefix_symbol
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/prefix_name.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class PrefixName < Lutaml::Model::Serializable
-          attribute :lang, :string
-          attribute :text, :string
-
-          xml do
-            element "PrefixName"
-            namespace Unitsml::Namespace
-            map_attribute "lang", to: :lang
-            map_content to: :text
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/prefix_set.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class PrefixSet < Lutaml::Model::Serializable
-          attribute :prefix, Prefix, collection: true
-
-          xml do
-            element "PrefixSet"
-            namespace Unitsml::Namespace
-            map_element "Prefix", to: :prefix
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/prefix_symbol.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class PrefixSymbol < Lutaml::Model::Serializable
-          attribute :type, :string
-          attribute :text, :string
-
-          xml do
-            element "PrefixSymbol"
-            namespace Unitsml::Namespace
-            map_attribute "type", to: :type
-            map_content to: :text
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/quantity.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class Quantity < Lutaml::Model::Serializable
-          attribute :id, :string
-          attribute :quantity_type, :string
-          attribute :dimension_url, :string
-          attribute :semx_id, :string
-
-          attribute :quantity_name, QuantityName, collection: true
-
-          xml do
-            element "Quantity"
-            namespace Unitsml::Namespace
-            map_attribute "id", to: :id
-            map_attribute "quantityType", to: :quantity_type
-            map_attribute "dimensionURL", to: :dimension_url
-            map_attribute "semx-id", to: :semx_id
-            map_element "QuantityName", to: :quantity_name
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/metadata/unitsml/quantity_name.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Metadata
-      module Unitsml
-        class QuantityName < Lutaml::Model::Serializable
-          attribute :lang, :string
-          attribute :text, :string
-
-          xml do
-            element "QuantityName"
-            namespace Unitsml::Namespace
-            map_attribute "lang", to: :lang
-            map_content to: :text
-          end
-        end
-      end
-    end
-  end
-end