metanorma-document 0.3.0 → 0.5.0

data/lib/metanorma/un_document/un_text_element.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module UnDocument
+    # UN TextElement restriction, per the current UN grammar
+    # (metanorma-un, lib/metanorma/un/un.rng v1.2.1):
+    #
+    #   TextElement = text | em | eref | erefstack | strong | stem | sub |
+    #                 sup | tt | strike | smallcap | xref | br | hyperlink |
+    #                 bookmark
+    #
+    # UN allows only a strict subset of the isodoc inline vocabulary.
+    # Enforcing this structurally would require a UN-specific variant of every
+    # block type carrying inline content; instead this module validates the
+    # parsed model graph, flagging instances of excluded inline element
+    # classes found in inline content.
+    #
+    # Grammar-inline productions with no model class (date_inline) cannot be
+    # flagged here; the parser drops them before validation can see them.
+    module UnTextElement
+      # Inline element names (grammar names) permitted in UN inline content.
+      # `hyperlink` is the grammar production for the `<link>` element.
+      ALLOWED_ELEMENTS = %w[
+        em eref erefstack strong stem sub sup tt strike smallcap
+        xref br link bookmark
+      ].freeze
+
+      # Model classes of the isodoc TextElement productions the UN grammar
+      # excludes, mapped to their grammar (XML element) names.
+      EXCLUDED_ELEMENTS = {
+        Metanorma::Document::Components::TextElements::UnderlineElement => "underline",
+        Metanorma::Document::Components::TextElements::KeywordElement => "keyword",
+        Metanorma::Document::Components::TextElements::RubyElement => "ruby",
+        Metanorma::Document::Components::EmptyElements::HorizontalRuleElement => "hr",
+        Metanorma::Document::Components::EmptyElements::PageBreakElement => "pagebreak",
+        Metanorma::Document::Components::IdElements::Image => "image",
+        Metanorma::Document::Components::EmptyElements::IndexElement => "index",
+        Metanorma::Document::Components::ReferenceElements::IndexXrefElement => "index-xref",
+        Metanorma::Document::Components::Inline::ConceptElement => "concept",
+        Metanorma::Document::Elements::Add => "add",
+        Metanorma::Document::Elements::Del => "del",
+        Metanorma::Document::Components::Inline::SpanElement => "span",
+      }.freeze
+
+      # Model classes whose content model is inline text; an excluded instance
+      # under one of these is an inline use. Block-level occurrences (e.g.
+      # Image under FigureBlock, PageBreakElement under ClauseSection) are
+      # legal. ParagraphWithFootnote inherits from ParagraphBlock.
+      INLINE_CONTAINERS = [
+        Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+        Metanorma::Document::Components::Inline::TitleWithAnnotationElement,
+        Metanorma::Document::Components::Inline::VariantTitleElement,
+        Metanorma::Document::Components::TextElements::TextElement,
+        Metanorma::Document::Components::Lists::DtElement,
+        Metanorma::Document::Components::Tables::TableCell,
+      ].freeze
+
+      # fmt-* classes wrap presentation-rendered copies of content, where
+      # `<span>` is rendering furniture rather than semantic inline markup.
+      FURNITURE_CLASS_PATTERN = /(^|::)Fmt/
+
+      # Returns an array of human-readable error strings for every excluded
+      # inline element instance in the given model tree; empty when valid.
+      def self.validate(model)
+        errors = []
+        walk(model, false, errors, {}.compare_by_identity)
+        errors
+      end
+
+      def self.walk(node, inline, errors, visited)
+        return unless node.is_a?(Lutaml::Model::Serializable)
+        return if visited[node]
+
+        visited[node] = true
+
+        furniture = furniture?(node)
+        excluded = furniture ? nil : excluded_name(node)
+        if inline && excluded
+          errors << "UN grammar forbids <#{excluded}> in inline " \
+                    "content (#{node.class.name})"
+        end
+
+        child_inline = furniture ? false : inline || inline_container?(node)
+        each_child(node) { |child| walk(child, child_inline, errors, visited) }
+      end
+
+      # Iterates the model-valued children of a node. Attribute values are
+      # read via instance_variable_get, mirroring lutaml-model's own
+      # attribute access (Serialize#validate_attribute!) — the project's
+      # invariant specs forbid dynamic dispatch methods in model code.
+      def self.each_child(node)
+        node.class.attributes.each_key do |name|
+          value = node.instance_variable_get(:"@#{name}")
+          if value.is_a?(Enumerable) && !value.is_a?(String)
+            value.each { |item| yield item if item.is_a?(Lutaml::Model::Serializable) }
+          elsif value.is_a?(Lutaml::Model::Serializable)
+            yield value
+          end
+        end
+      end
+
+      def self.excluded_name(node)
+        pair = EXCLUDED_ELEMENTS.find { |klass, _| node.is_a?(klass) }
+        pair&.last
+      end
+
+      def self.inline_container?(node)
+        INLINE_CONTAINERS.any? { |klass| node.is_a?(klass) }
+      end
+
+      def self.furniture?(node)
+        FURNITURE_CLASS_PATTERN.match?(node.class.name)
+      end
+    end
+  end
+end

data/lib/metanorma/un_document.rb

@@ -2,9 +2,11 @@
 
 module Metanorma
   module UnDocument
+    autoload :Blocks, "metanorma/un_document/blocks"
     autoload :Metadata, "metanorma/un_document/metadata"
     autoload :Root, "metanorma/un_document/root"
     autoload :Sections, "metanorma/un_document/sections"
+    autoload :UnTextElement, "metanorma/un_document/un_text_element"
   end
 end
 

data/script/benchmark_render.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Benchmark: parse + HTML-render a presentation XML fixture.
+#
+# Usage:
+#   bundle install          # benchmark-ips is a dev dependency
+#   bundle exec ruby script/benchmark_render.rb [fixture.xml]
+
+require "benchmark/ips"
+require_relative "../lib/metanorma/document"
+require_relative "../lib/metanorma/html"
+
+fixture = ARGV[0] ||
+  File.expand_path("../spec/fixtures/iso/is/document-en.presentation.xml",
+                   __dir__)
+xml = File.read(fixture)
+puts "Fixture: #{fixture} (#{(xml.size / 1024.0).round(1)} KB)"
+
+doc = Metanorma::IsoDocument::Root.from_xml(xml)
+html = Metanorma::Html::Generator.generate(doc)
+puts "Sanity: rendered #{html.size} bytes of HTML"
+
+Benchmark.ips do |x|
+  x.config(time: 5, warmup: 1)
+
+  x.report("parse") do
+    Metanorma::IsoDocument::Root.from_xml(xml)
+  end
+
+  x.report("render") do
+    Metanorma::Html::Generator.generate(doc)
+  end
+
+  x.compare!
+end

data/tasks/roundtrip_samples.rake

@@ -37,11 +37,11 @@ module RoundtripSamples
 
   # Maps mn-samples-* repo name to the model class for round-tripping.
   # nil means no document model exists yet — reported as "no_model".
+  # OIML moved to the metanorma-oiml gem — its roundtrip lives there.
   FLAVOR_MODEL_MAP = {
     "iso"     => Metanorma::IsoDocument::Root,
     "iec"     => Metanorma::IecDocument::Root,
     "ieee"    => Metanorma::IeeeDocument::Root,
-    "oiml"    => Metanorma::OimlDocument::Root,
     "iho"     => Metanorma::IhoDocument::Root,
     "cc"      => Metanorma::CcDocument::Root,
     "bipm"    => Metanorma::BipmDocument::Root,
@@ -49,7 +49,7 @@ module RoundtripSamples
     "ogc"     => Metanorma::OgcDocument::Root,
     "ribose"  => Metanorma::RiboseDocument::Root,
     "ietf"    => Metanorma::IetfDocument::Root,
-    "csa"     => nil,
+    "csa"     => Metanorma::CsaDocument::Root,
     "un"      => nil,
   }.freeze
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-document
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-18 00:00:00.000000000 Z
+date: 2026-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lutaml-model
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: mml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: pubid
   requirement: !ruby/object:Gem::Requirement
@@ -68,28 +82,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop_todo.yml"
+- BUGS.sts/08-list-items-duplicate-bullets.md
 - CHANGELOG.md
 - CLAUDE.md
 - LICENSE.txt
 - README.adoc
 - Rakefile
-- TODO.finalize/01-split-multi-class-files.md
-- TODO.finalize/02-remove-data-dist-iso-document-frontend.md
-- TODO.finalize/03-align-frontend-iife-and-gha-build.md
-- TODO.finalize/04-theme-per-flavor-config-driven.md
-- TODO.finalize/05-migrate-all-html-to-liquid.md
-- TODO.finalize/06-integrate-pubid-library.md
-- TODO.finalize/07-replace-relaton-models-with-relaton-bib.md
-- TODO.finalize/08-refactor-renderer-architecture.md
-- TODO.finalize/09-eliminate-code-smells.md
-- TODO.finalize/10-comprehensive-spec-coverage.md
-- TODO.finalize/11-config-driven-flavor-metadata.md
-- TODO.finalize/12-add-frozen-string-literal.md
-- TODO.finalize/13-extract-composition-from-god-class.md
-- TODO.finalize/14-config-driven-section-ordering.md
-- TODO.finalize/15-theme-directories-per-flavor.md
-- TODO.finalize/16-theme-lutaml-model-schema.md
 - data/javascripts/components/mn-code-copy.js
 - data/javascripts/components/mn-footnotes.js
 - data/javascripts/components/mn-glossary.js
@@ -112,11 +110,6 @@ files:
 - data/logos/itu-logo.svg
 - data/logos/metanorma-logo.svg
 - data/logos/ogc-logo.svg
-- data/logos/oiml-logo-full-dark.svg
-- data/logos/oiml-logo-full-light.svg
-- data/logos/oiml-logo-icon-dark.svg
-- data/logos/oiml-logo-icon-light.svg
-- data/logos/oiml-logo.svg
 - data/logos/pdfa-logo.svg
 - data/stylesheets/base/_dark.css
 - data/stylesheets/base/_layout.css
@@ -136,6 +129,7 @@ files:
 - data/stylesheets/components/header.css
 - data/stylesheets/components/index.css
 - data/stylesheets/components/inline.css
+- data/stylesheets/components/lists.css
 - data/stylesheets/components/note.css
 - data/stylesheets/components/progress.css
 - data/stylesheets/components/search.css
@@ -155,11 +149,11 @@ files:
 - data/themes/iso.yaml
 - data/themes/itu.yaml
 - data/themes/ogc.yaml
-- data/themes/oiml.yaml
 - data/themes/pdfa.yaml
 - data/themes/ribose.yaml
-- docs/html-renderer.adoc
 - exe/metanorma-document
+- frontend/dist/app.css
+- frontend/dist/app.iife.js
 - frontend/e2e/sample-html.test.ts
 - frontend/index.html
 - frontend/package-lock.json
@@ -208,10 +202,6 @@ files:
 - frontend/tsconfig.node.json
 - frontend/vite.config.ts
 - frontend/vitest.e2e.config.ts
-- lib/data/dist/iso_document/frontend/assets/index-mwzbzmnK.js
-- lib/data/dist/iso_document/frontend/assets/index-pGvKTNid.css
-- lib/data/dist/iso_document/frontend/assets/iso-red.svg
-- lib/data/dist/iso_document/frontend/index.html
 - lib/metanorma/basic_document.rb
 - lib/metanorma/basic_document/ancillary_blocks.rb
 - lib/metanorma/basic_document/ancillary_blocks/example_block.rb
@@ -361,6 +351,8 @@ files:
 - lib/metanorma/collection/doc_container.rb
 - lib/metanorma/collection/entry.rb
 - lib/metanorma/collection/root.rb
+- lib/metanorma/csa_document.rb
+- lib/metanorma/csa_document/root.rb
 - lib/metanorma/document.rb
 - lib/metanorma/document/cli.rb
 - lib/metanorma/document/components.rb
@@ -570,15 +562,14 @@ files:
 - lib/metanorma/document/elements.rb
 - lib/metanorma/document/elements/add.rb
 - lib/metanorma/document/elements/del.rb
+- lib/metanorma/document/elements/input.rb
 - lib/metanorma/document/relaton.rb
 - lib/metanorma/document/relaton/address.rb
 - lib/metanorma/document/relaton/affiliation.rb
 - lib/metanorma/document/relaton/bib_item_locality.rb
 - lib/metanorma/document/relaton/bib_item_size.rb
-- lib/metanorma/document/relaton/bib_item_size_type.rb
 - lib/metanorma/document/relaton/bib_item_type.rb
 - lib/metanorma/document/relaton/bibliographic_date.rb
-- lib/metanorma/document/relaton/bibliographic_date_type.rb
 - lib/metanorma/document/relaton/contact_method.rb
 - lib/metanorma/document/relaton/contribution_info.rb
 - lib/metanorma/document/relaton/contributor.rb
@@ -588,13 +579,10 @@ files:
 - lib/metanorma/document/relaton/date_time.rb
 - lib/metanorma/document/relaton/document_identifier.rb
 - lib/metanorma/document/relaton/document_relation.rb
-- lib/metanorma/document/relaton/document_relation_type.rb
 - lib/metanorma/document/relaton/document_status.rb
 - lib/metanorma/document/relaton/edition.rb
 - lib/metanorma/document/relaton/formatted_address.rb
 - lib/metanorma/document/relaton/full_name.rb
-- lib/metanorma/document/relaton/iso4217_code.rb
-- lib/metanorma/document/relaton/iso8601_date.rb
 - lib/metanorma/document/relaton/keyword_type.rb
 - lib/metanorma/document/relaton/locality_stack.rb
 - lib/metanorma/document/relaton/localized_name.rb
@@ -606,17 +594,12 @@ files:
 - lib/metanorma/document/relaton/organization.rb
 - lib/metanorma/document/relaton/person.rb
 - lib/metanorma/document/relaton/person_identifier.rb
-- lib/metanorma/document/relaton/personal_identifier_type.rb
 - lib/metanorma/document/relaton/phone.rb
 - lib/metanorma/document/relaton/place_type.rb
 - lib/metanorma/document/relaton/price_type.rb
 - lib/metanorma/document/relaton/region_element.rb
-- lib/metanorma/document/relaton/region_type.rb
 - lib/metanorma/document/relaton/relaton_collection.rb
 - lib/metanorma/document/relaton/series_type.rb
-- lib/metanorma/document/relaton/series_type_type.rb
-- lib/metanorma/document/relaton/specific_locality_type.rb
-- lib/metanorma/document/relaton/title_type.rb
 - lib/metanorma/document/relaton/typed_note.rb
 - lib/metanorma/document/relaton/typed_title_string.rb
 - lib/metanorma/document/relaton/typed_uri.rb
@@ -644,6 +627,12 @@ files:
 - lib/metanorma/html/component/footnote_collector.rb
 - lib/metanorma/html/component/index_section.rb
 - lib/metanorma/html/component/index_term_collector.rb
+- lib/metanorma/html/concerns/metadata_extraction.rb
+- lib/metanorma/html/concerns/presentation_validation.rb
+- lib/metanorma/html/concerns/svg_processing.rb
+- lib/metanorma/html/concerns/text_extraction.rb
+- lib/metanorma/html/concerns/toc_registry.rb
+- lib/metanorma/html/csa_renderer.rb
 - lib/metanorma/html/drops.rb
 - lib/metanorma/html/drops/admonition_drop.rb
 - lib/metanorma/html/drops/biblio_entry_drop.rb
@@ -667,7 +656,6 @@ files:
 - lib/metanorma/html/iso_renderer.rb
 - lib/metanorma/html/itu_renderer.rb
 - lib/metanorma/html/ogc_renderer.rb
-- lib/metanorma/html/oiml_renderer.rb
 - lib/metanorma/html/pdfa_renderer.rb
 - lib/metanorma/html/renderer_delegation.rb
 - lib/metanorma/html/renderers.rb
@@ -884,15 +872,6 @@ files:
 - lib/metanorma/mirror/output/formats.rb
 - lib/metanorma/mirror/output/formats/base_format.rb
 - lib/metanorma/mirror/output/formats/inline_format.rb
-- lib/metanorma/mirror/output/html_renderer.rb
-- lib/metanorma/mirror/output/html_renderers.rb
-- lib/metanorma/mirror/output/html_renderers/block_renderers.rb
-- lib/metanorma/mirror/output/html_renderers/inline_renderer.rb
-- lib/metanorma/mirror/output/html_renderers/list_renderers.rb
-- lib/metanorma/mirror/output/html_renderers/mark_renderers.rb
-- lib/metanorma/mirror/output/html_renderers/section_renderers.rb
-- lib/metanorma/mirror/output/html_renderers/structural_renderers.rb
-- lib/metanorma/mirror/output/html_renderers/table_renderers.rb
 - lib/metanorma/mirror/output/pipeline.rb
 - lib/metanorma/mirror/output/pipeline_context.rb
 - lib/metanorma/mirror/rewriter.rb
@@ -916,8 +895,6 @@ files:
 - lib/metanorma/ogc_document/metadata/ogc_bib_data_extension_type.rb
 - lib/metanorma/ogc_document/metadata/ogc_bibliographic_item.rb
 - lib/metanorma/ogc_document/root.rb
-- lib/metanorma/oiml_document.rb
-- lib/metanorma/oiml_document/root.rb
 - lib/metanorma/plateau_document.rb
 - lib/metanorma/plateau_document/metadata.rb
 - lib/metanorma/plateau_document/metadata/plateau_bibliographic_item.rb
@@ -930,7 +907,6 @@ files:
 - lib/metanorma/ribose_document/metadata/ribose_bibliographic_item.rb
 - lib/metanorma/ribose_document/root.rb
 - lib/metanorma/standard_document.rb
-- lib/metanorma/standard_document/annotation.rb
 - lib/metanorma/standard_document/annotation_container.rb
 - lib/metanorma/standard_document/block_attributes.rb
 - lib/metanorma/standard_document/blocks.rb
@@ -988,10 +964,40 @@ files:
 - lib/metanorma/standard_document/metadata/editorial_group_type.rb
 - lib/metanorma/standard_document/metadata/ics_type.rb
 - lib/metanorma/standard_document/metadata/metanorma_extension.rb
+- lib/metanorma/standard_document/metadata/presentation_metadata.rb
+- lib/metanorma/standard_document/metadata/semantic_metadata.rb
 - lib/metanorma/standard_document/metadata/standard_bib_data.rb
 - lib/metanorma/standard_document/metadata/standard_bib_data_extension_type.rb
 - lib/metanorma/standard_document/metadata/structured_identifier_type.rb
 - lib/metanorma/standard_document/metadata/technical_committee_type.rb
+- lib/metanorma/standard_document/metadata/unitsml.rb
+- lib/metanorma/standard_document/metadata/unitsml/amount_of_substance.rb
+- lib/metanorma/standard_document/metadata/unitsml/base_quantity.rb
+- lib/metanorma/standard_document/metadata/unitsml/dimension.rb
+- lib/metanorma/standard_document/metadata/unitsml/dimension_set.rb
+- lib/metanorma/standard_document/metadata/unitsml/electric_current.rb
+- lib/metanorma/standard_document/metadata/unitsml/enumerated_root_unit.rb
+- lib/metanorma/standard_document/metadata/unitsml/length.rb
+- lib/metanorma/standard_document/metadata/unitsml/luminous_intensity.rb
+- lib/metanorma/standard_document/metadata/unitsml/mass.rb
+- lib/metanorma/standard_document/metadata/unitsml/namespace.rb
+- lib/metanorma/standard_document/metadata/unitsml/plane_angle.rb
+- lib/metanorma/standard_document/metadata/unitsml/prefix.rb
+- lib/metanorma/standard_document/metadata/unitsml/prefix_name.rb
+- lib/metanorma/standard_document/metadata/unitsml/prefix_set.rb
+- lib/metanorma/standard_document/metadata/unitsml/prefix_symbol.rb
+- lib/metanorma/standard_document/metadata/unitsml/quantity.rb
+- lib/metanorma/standard_document/metadata/unitsml/quantity_name.rb
+- lib/metanorma/standard_document/metadata/unitsml/quantity_set.rb
+- lib/metanorma/standard_document/metadata/unitsml/root_units.rb
+- lib/metanorma/standard_document/metadata/unitsml/thermodynamic_temperature.rb
+- lib/metanorma/standard_document/metadata/unitsml/time.rb
+- lib/metanorma/standard_document/metadata/unitsml/unit.rb
+- lib/metanorma/standard_document/metadata/unitsml/unit_name.rb
+- lib/metanorma/standard_document/metadata/unitsml/unit_set.rb
+- lib/metanorma/standard_document/metadata/unitsml/unit_symbol.rb
+- lib/metanorma/standard_document/metadata/unitsml/unit_system.rb
+- lib/metanorma/standard_document/metadata/unitsml/unitsml_root.rb
 - lib/metanorma/standard_document/namespace.rb
 - lib/metanorma/standard_document/refs.rb
 - lib/metanorma/standard_document/refs/reference_to_term.rb
@@ -1052,13 +1058,18 @@ files:
 - lib/metanorma/standard_document/terms/term_source_type.rb
 - lib/metanorma/standard_document/terms/verbal_expression.rb
 - lib/metanorma/un_document.rb
+- lib/metanorma/un_document/blocks.rb
+- lib/metanorma/un_document/blocks/un_admonition_block.rb
 - lib/metanorma/un_document/metadata.rb
 - lib/metanorma/un_document/metadata/un_bib_data_extension_type.rb
 - lib/metanorma/un_document/metadata/un_bibliographic_item.rb
 - lib/metanorma/un_document/root.rb
 - lib/metanorma/un_document/sections.rb
+- lib/metanorma/un_document/sections/un_abstract_section.rb
 - lib/metanorma/un_document/sections/un_preface.rb
 - lib/metanorma/un_document/sections/un_sections.rb
+- lib/metanorma/un_document/un_text_element.rb
+- script/benchmark_render.rb
 - script/render_both.rb
 - tasks/roundtrip_samples.rake
 homepage: https://github.com/metanorma/metanorma-document
@@ -1077,7 +1088,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="