metanorma-document 0.2.9 → 0.2.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.rubocop_todo.yml +164 -66
- data/CLAUDE.md +26 -0
- data/README.adoc +144 -0
- data/Rakefile +14 -2
- data/TODO.finalize/01-split-multi-class-files.md +8 -0
- data/TODO.finalize/02-remove-data-dist-iso-document-frontend.md +6 -0
- data/TODO.finalize/03-align-frontend-iife-and-gha-build.md +11 -0
- data/TODO.finalize/04-theme-per-flavor-config-driven.md +9 -0
- data/TODO.finalize/05-migrate-all-html-to-liquid.md +16 -0
- data/TODO.finalize/06-integrate-pubid-library.md +16 -0
- data/TODO.finalize/07-replace-relaton-models-with-relaton-bib.md +39 -0
- data/TODO.finalize/08-refactor-renderer-architecture.md +25 -0
- data/TODO.finalize/09-eliminate-code-smells.md +14 -0
- data/TODO.finalize/10-comprehensive-spec-coverage.md +24 -0
- data/TODO.finalize/11-config-driven-flavor-metadata.md +20 -0
- data/TODO.finalize/12-add-frozen-string-literal.md +6 -0
- data/TODO.finalize/13-extract-composition-from-god-class.md +96 -0
- data/TODO.finalize/14-config-driven-section-ordering.md +31 -0
- data/TODO.finalize/15-theme-directories-per-flavor.md +46 -0
- data/TODO.finalize/16-theme-lutaml-model-schema.md +44 -0
- data/data/javascripts/components/mn-footnotes.js +68 -0
- data/data/javascripts/components/mn-lightbox.js +18 -2
- data/data/javascripts/components/mn-shortcuts.js +2 -0
- data/data/javascripts/core/mn-navigation.js +8 -0
- data/data/javascripts/core/mn-theme.js +9 -9
- data/data/logos/oiml-logo-full-dark.svg +1 -0
- data/data/logos/oiml-logo-full-light.svg +1 -0
- data/data/logos/oiml-logo-icon-dark.svg +1 -0
- data/data/logos/oiml-logo-icon-light.svg +1 -0
- data/data/logos/oiml-logo.svg +1 -0
- data/data/logos/pdfa-logo.svg +31 -94
- data/data/stylesheets/base/_layout.css +3 -0
- data/data/stylesheets/base/_reset.css +3 -3
- data/data/stylesheets/base/_typography.css +0 -5
- data/data/stylesheets/components/bibliography.css +3 -3
- data/data/stylesheets/components/cover.css +3 -1
- data/data/stylesheets/components/figure.css +13 -1
- data/data/stylesheets/components/footnote.css +65 -5
- data/data/stylesheets/components/formula.css +44 -0
- data/data/stylesheets/components/header.css +17 -2
- data/data/stylesheets/components/inline.css +1 -1
- data/data/stylesheets/components/table.css +15 -2
- data/data/stylesheets/components/term.css +0 -1
- data/data/themes/bipm.yaml +60 -0
- data/data/themes/cc.yaml +43 -0
- data/data/themes/icc.yaml +39 -0
- data/data/themes/iec.yaml +44 -0
- data/data/themes/ieee.yaml +43 -0
- data/data/themes/ietf.yaml +45 -0
- data/data/themes/iho.yaml +46 -0
- data/data/themes/iso.yaml +40 -0
- data/data/themes/itu.yaml +45 -0
- data/data/themes/ogc.yaml +51 -0
- data/data/themes/oiml.yaml +56 -0
- data/data/themes/pdfa.yaml +44 -0
- data/data/themes/ribose.yaml +43 -0
- data/exe/metanorma-document +11 -0
- data/frontend/e2e/sample-html.test.ts +256 -0
- data/frontend/index.html +12 -0
- data/frontend/package-lock.json +4725 -0
- data/frontend/package.json +32 -0
- data/frontend/postcss.config.js +6 -0
- data/frontend/src/App.vue +79 -0
- data/frontend/src/app.ts +21 -0
- data/frontend/src/components/AppSidebar.vue +77 -0
- data/frontend/src/components/DocumentReader.vue +180 -0
- data/frontend/src/components/MirrorRenderer.vue +23 -0
- data/frontend/src/components/ReadingProgressBar.vue +29 -0
- data/frontend/src/components/TextRenderer.vue +131 -0
- data/frontend/src/components/TocItem.vue +57 -0
- data/frontend/src/components/TopBar.vue +49 -0
- data/frontend/src/components/__tests__/MirrorRenderer.test.ts +178 -0
- data/frontend/src/components/blocks/AdmonitionBlock.vue +74 -0
- data/frontend/src/components/blocks/ClauseBlock.vue +53 -0
- data/frontend/src/components/blocks/ExampleBlock.vue +21 -0
- data/frontend/src/components/blocks/FallbackBlock.vue +18 -0
- data/frontend/src/components/blocks/FigureBlock.vue +26 -0
- data/frontend/src/components/blocks/FootnotesBlock.vue +25 -0
- data/frontend/src/components/blocks/ListBlocks.vue +62 -0
- data/frontend/src/components/blocks/NoteBlock.vue +21 -0
- data/frontend/src/components/blocks/ParagraphBlock.vue +25 -0
- data/frontend/src/components/blocks/QuoteBlock.vue +25 -0
- data/frontend/src/components/blocks/ReviewBlock.vue +39 -0
- data/frontend/src/components/blocks/SourcecodeBlock.vue +52 -0
- data/frontend/src/components/blocks/TableBlock.vue +48 -0
- data/frontend/src/components/blocks/index.ts +36 -0
- data/frontend/src/stores/__tests__/documentStore.fixture.test.ts +272 -0
- data/frontend/src/stores/__tests__/documentStore.test.ts +143 -0
- data/frontend/src/stores/__tests__/ebookStore.test.ts +145 -0
- data/frontend/src/stores/__tests__/uiStore.test.ts +42 -0
- data/frontend/src/stores/documentStore.ts +153 -0
- data/frontend/src/stores/ebookStore.ts +179 -0
- data/frontend/src/stores/uiStore.ts +32 -0
- data/frontend/src/styles.css +156 -0
- data/frontend/src/types/__tests__/rendering-contract.test.ts +172 -0
- data/frontend/src/types/rendering-contract.ts +209 -0
- data/frontend/src/utils/__tests__/typeMetadata.test.ts +102 -0
- data/frontend/src/utils/typeMetadata.ts +121 -0
- data/frontend/tailwind.config.js +18 -0
- data/frontend/test/fixtures/iso-document.json +271 -0
- data/frontend/tmp/debug_e2e.cjs +46 -0
- data/frontend/tsconfig.json +25 -0
- data/frontend/tsconfig.node.json +11 -0
- data/frontend/vite.config.ts +37 -0
- data/frontend/vitest.e2e.config.ts +9 -0
- data/lib/metanorma/bipm_document/metadata/bipm_bibliographic_item.rb +0 -14
- data/lib/metanorma/bipm_document/metadata/depiction_element.rb +18 -0
- data/lib/metanorma/bipm_document/metadata.rb +1 -1
- data/lib/metanorma/document/cli.rb +116 -0
- data/lib/metanorma/document/components/ancillary_blocks/callout_annotation.rb +27 -0
- data/lib/metanorma/document/components/ancillary_blocks/sourcecode_block.rb +0 -65
- data/lib/metanorma/document/components/ancillary_blocks/sourcecode_body.rb +18 -0
- data/lib/metanorma/document/components/ancillary_blocks.rb +4 -0
- data/lib/metanorma/document/components/bib_data/bib_data.rb +7 -0
- data/lib/metanorma/document/components/blocks/classification_value.rb +21 -0
- data/lib/metanorma/document/components/blocks/permission_model.rb +28 -0
- data/lib/metanorma/document/components/blocks/recommendation_model.rb +28 -0
- data/lib/metanorma/document/components/blocks/requirement_base.rb +30 -0
- data/lib/metanorma/document/components/blocks/requirement_classification.rb +20 -0
- data/lib/metanorma/document/components/blocks/requirement_description.rb +43 -0
- data/lib/metanorma/document/components/blocks/requirement_inherit.rb +24 -0
- data/lib/metanorma/document/components/blocks/requirement_model.rb +0 -131
- data/lib/metanorma/document/components/blocks.rb +8 -7
- data/lib/metanorma/document/components/id_elements/image.rb +2 -0
- data/lib/metanorma/document/components/inline/asciimath_element.rb +2 -0
- data/lib/metanorma/document/components/inline/attribution_element.rb +2 -0
- data/lib/metanorma/document/components/inline/bcp14_element.rb +2 -0
- data/lib/metanorma/document/components/inline/biblio_tag_element.rb +2 -0
- data/lib/metanorma/document/components/inline/br_element.rb +2 -0
- data/lib/metanorma/document/components/inline/comma_element.rb +2 -0
- data/lib/metanorma/document/components/inline/concept_element.rb +2 -0
- data/lib/metanorma/document/components/inline/display_text_element.rb +2 -0
- data/lib/metanorma/document/components/inline/em_raw_element.rb +2 -0
- data/lib/metanorma/document/components/inline/enum_comma_element.rb +2 -0
- data/lib/metanorma/document/components/inline/eref_element.rb +2 -0
- data/lib/metanorma/document/components/inline/fmt_admitted_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_annotation_body_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_annotation_end_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_annotation_start_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_concept_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_definition_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_fn_body_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_fn_label_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_footnote_container_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_identifier_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_name_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_preferred_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_sourcecode_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_stem_element.rb +10 -0
- data/lib/metanorma/document/components/inline/fmt_termsource_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_title_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_xref_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fmt_xref_label_element.rb +4 -0
- data/lib/metanorma/document/components/inline/fn_element.rb +2 -0
- data/lib/metanorma/document/components/inline/link_element.rb +2 -0
- data/lib/metanorma/document/components/inline/localized_string_element.rb +2 -0
- data/lib/metanorma/document/components/inline/localized_strings_element.rb +2 -0
- data/lib/metanorma/document/components/inline/location_element.rb +24 -0
- data/lib/metanorma/document/components/inline/math_element.rb +2 -0
- data/lib/metanorma/document/components/inline/name_with_id_element.rb +4 -0
- data/lib/metanorma/document/components/inline/rendered_display.rb +23 -0
- data/lib/metanorma/document/components/inline/rendered_math_element.rb +21 -0
- data/lib/metanorma/document/components/inline/semantic_content.rb +51 -0
- data/lib/metanorma/document/components/inline/semantic_math_element.rb +20 -0
- data/lib/metanorma/document/components/inline/semx_child_element.rb +2 -0
- data/lib/metanorma/document/components/inline/semx_element.rb +13 -1
- data/lib/metanorma/document/components/inline/small_cap_element.rb +2 -0
- data/lib/metanorma/document/components/inline/span_element.rb +10 -15
- data/lib/metanorma/document/components/inline/stem_inline_element.rb +7 -1
- data/lib/metanorma/document/components/inline/strong_raw_element.rb +2 -0
- data/lib/metanorma/document/components/inline/sub_element.rb +2 -0
- data/lib/metanorma/document/components/inline/sup_element.rb +2 -0
- data/lib/metanorma/document/components/inline/tab_element.rb +2 -0
- data/lib/metanorma/document/components/inline/title_with_annotation_element.rb +4 -0
- data/lib/metanorma/document/components/inline/tt_element.rb +2 -0
- data/lib/metanorma/document/components/inline/variant_title_element.rb +2 -0
- data/lib/metanorma/document/components/inline/vocabulary.rb +184 -0
- data/lib/metanorma/document/components/inline/xref_element.rb +10 -0
- data/lib/metanorma/document/components/inline.rb +12 -0
- data/lib/metanorma/document/components/multi_paragraph/quote_author_element.rb +20 -0
- data/lib/metanorma/document/components/multi_paragraph/quote_block.rb +0 -29
- data/lib/metanorma/document/components/multi_paragraph.rb +2 -0
- data/lib/metanorma/document/components/reference_elements/source_element.rb +0 -31
- data/lib/metanorma/document/components/reference_elements/source_modification.rb +21 -0
- data/lib/metanorma/document/components/reference_elements/source_origin.rb +28 -0
- data/lib/metanorma/document/components/reference_elements.rb +2 -2
- data/lib/metanorma/document/components/tables/col_element.rb +18 -0
- data/lib/metanorma/document/components/tables/col_group_element.rb +18 -0
- data/lib/metanorma/document/components/tables/table_block.rb +0 -22
- data/lib/metanorma/document/components/tables/table_body_section.rb +16 -0
- data/lib/metanorma/document/components/tables/table_foot_section.rb +16 -0
- data/lib/metanorma/document/components/tables/table_head_section.rb +16 -0
- data/lib/metanorma/document/components/tables/table_section.rb +0 -25
- data/lib/metanorma/document/components/tables.rb +5 -3
- data/lib/metanorma/document/relaton/address.rb +0 -27
- data/lib/metanorma/document/relaton/bib_item_locality.rb +3 -12
- data/lib/metanorma/document/relaton/copyright_association.rb +0 -10
- data/lib/metanorma/document/relaton/copyright_owner.rb +16 -0
- data/lib/metanorma/document/relaton/edition.rb +4 -7
- data/lib/metanorma/document/relaton/formatted_address.rb +29 -0
- data/lib/metanorma/document/relaton/logo_element.rb +18 -0
- data/lib/metanorma/document/relaton/organization.rb +0 -14
- data/lib/metanorma/document/relaton/phone.rb +3 -9
- data/lib/metanorma/document/relaton/place_type.rb +0 -13
- data/lib/metanorma/document/relaton/price_type.rb +3 -9
- data/lib/metanorma/document/relaton/region_element.rb +18 -0
- data/lib/metanorma/document/relaton.rb +6 -1
- data/lib/metanorma/document/version.rb +1 -1
- data/lib/metanorma/document.rb +2 -0
- data/lib/metanorma/html/asset_pipeline.rb +1 -0
- data/lib/metanorma/html/base_renderer.rb +261 -1008
- data/lib/metanorma/html/bipm_renderer.rb +15 -144
- data/lib/metanorma/html/cc_renderer.rb +1 -45
- data/lib/metanorma/html/component/base.rb +2 -7
- data/lib/metanorma/html/component/index_section.rb +41 -43
- data/lib/metanorma/html/drops/admonition_drop.rb +1 -4
- data/lib/metanorma/html/drops/biblio_entry_drop.rb +50 -0
- data/lib/metanorma/html/drops/block_element_drop.rb +7 -2
- data/lib/metanorma/html/drops/example_drop.rb +1 -4
- data/lib/metanorma/html/drops/figure_drop.rb +31 -22
- data/lib/metanorma/html/drops/footnote_drop.rb +1 -1
- data/lib/metanorma/html/drops/formula_drop.rb +45 -16
- data/lib/metanorma/html/drops/note_drop.rb +9 -7
- data/lib/metanorma/html/drops/sourcecode_drop.rb +12 -5
- data/lib/metanorma/html/drops.rb +2 -0
- data/lib/metanorma/html/generator.rb +2 -2
- data/lib/metanorma/html/icc_renderer.rb +0 -39
- data/lib/metanorma/html/iec_renderer.rb +1 -44
- data/lib/metanorma/html/ieee_renderer.rb +1 -45
- data/lib/metanorma/html/ietf_renderer.rb +1 -48
- data/lib/metanorma/html/iho_renderer.rb +1 -46
- data/lib/metanorma/html/iso_renderer.rb +290 -343
- data/lib/metanorma/html/itu_renderer.rb +1 -45
- data/lib/metanorma/html/ogc_renderer.rb +15 -76
- data/lib/metanorma/html/oiml_renderer.rb +18 -38
- data/lib/metanorma/html/pdfa_renderer.rb +0 -39
- data/lib/metanorma/html/renderers/block_renderer.rb +372 -0
- data/lib/metanorma/html/renderers/inline_renderer.rb +655 -0
- data/lib/metanorma/html/renderers/pubid_renderer.rb +69 -0
- data/lib/metanorma/html/renderers/section_renderer.rb +193 -0
- data/lib/metanorma/html/renderers.rb +8 -0
- data/lib/metanorma/html/ribose_renderer.rb +1 -45
- data/lib/metanorma/html/standard_renderer.rb +341 -229
- data/lib/metanorma/html/templates/_audio.html.liquid +1 -0
- data/lib/metanorma/html/templates/_biblio_entry.html.liquid +1 -0
- data/lib/metanorma/html/templates/_bipm_cover.html.liquid +27 -0
- data/lib/metanorma/html/templates/_boilerplate.html.liquid +1 -0
- data/lib/metanorma/html/templates/_bookmark.html.liquid +1 -0
- data/lib/metanorma/html/templates/_br.html.liquid +1 -0
- data/lib/metanorma/html/templates/_definition_list.html.liquid +6 -0
- data/lib/metanorma/html/templates/_element.html.liquid +1 -0
- data/lib/metanorma/html/templates/_fn_marker.html.liquid +1 -0
- data/lib/metanorma/html/templates/_footnotes.html.liquid +6 -6
- data/lib/metanorma/html/templates/_formula.html.liquid +1 -1
- data/lib/metanorma/html/templates/_header.html.liquid +1 -1
- data/lib/metanorma/html/templates/_heading.html.liquid +1 -0
- data/lib/metanorma/html/templates/_image.html.liquid +1 -0
- data/lib/metanorma/html/templates/_inline_span.html.liquid +1 -0
- data/lib/metanorma/html/templates/_iso_cover.html.liquid +1 -1
- data/lib/metanorma/html/templates/_link.html.liquid +1 -0
- data/lib/metanorma/html/templates/_list.html.liquid +3 -0
- data/lib/metanorma/html/templates/_list_item.html.liquid +1 -0
- data/lib/metanorma/html/templates/_main_content.html.liquid +1 -0
- data/lib/metanorma/html/templates/_math_container.html.liquid +1 -0
- data/lib/metanorma/html/templates/_paragraph.html.liquid +1 -0
- data/lib/metanorma/html/templates/_prefatory_section.html.liquid +1 -0
- data/lib/metanorma/html/templates/_pubid_identifier.html.liquid +1 -0
- data/lib/metanorma/html/templates/_quote.html.liquid +4 -0
- data/lib/metanorma/html/templates/_ref_date.html.liquid +1 -0
- data/lib/metanorma/html/templates/_ref_title.html.liquid +1 -0
- data/lib/metanorma/html/templates/_section.html.liquid +5 -0
- data/lib/metanorma/html/templates/_standard_cover.html.liquid +31 -0
- data/lib/metanorma/html/templates/_standard_doc_title.html.liquid +3 -0
- data/lib/metanorma/html/templates/_stem_span.html.liquid +1 -0
- data/lib/metanorma/html/templates/_table.html.liquid +9 -0
- data/lib/metanorma/html/templates/_term_domain.html.liquid +1 -0
- data/lib/metanorma/html/templates/_term_example.html.liquid +1 -0
- data/lib/metanorma/html/templates/_term_note.html.liquid +1 -0
- data/lib/metanorma/html/templates/_term_number.html.liquid +1 -0
- data/lib/metanorma/html/templates/_term_source.html.liquid +1 -0
- data/lib/metanorma/html/templates/_term_text_note.html.liquid +1 -0
- data/lib/metanorma/html/templates/_video.html.liquid +1 -0
- data/lib/metanorma/html/templates/_wrapped_preface.html.liquid +1 -0
- data/lib/metanorma/html/templates/document.html.liquid +4 -0
- data/lib/metanorma/html/theme.rb +180 -107
- data/lib/metanorma/html.rb +13 -0
- data/lib/metanorma/ietf_document/metadata/ietf_bib_data_extension_type.rb +0 -25
- data/lib/metanorma/ietf_document/metadata/pi_settings.rb +32 -0
- data/lib/metanorma/ietf_document/metadata.rb +2 -0
- data/lib/metanorma/iso_document/metadata/doctype_element.rb +20 -0
- data/lib/metanorma/iso_document/metadata/iso_bib_data_extension_type.rb +0 -48
- data/lib/metanorma/iso_document/metadata/iso_bibliographic_item.rb +0 -72
- data/lib/metanorma/iso_document/metadata/iso_document_status.rb +0 -30
- data/lib/metanorma/iso_document/metadata/iso_localized_title.rb +4 -1
- data/lib/metanorma/iso_document/metadata/language_element.rb +18 -0
- data/lib/metanorma/iso_document/metadata/project_number.rb +22 -0
- data/lib/metanorma/iso_document/metadata/script_element.rb +18 -0
- data/lib/metanorma/iso_document/metadata/stage_element.rb +26 -0
- data/lib/metanorma/iso_document/metadata/stagename_element.rb +18 -0
- data/lib/metanorma/iso_document/metadata/structured_identifier.rb +0 -17
- data/lib/metanorma/iso_document/metadata/title_collection.rb +1 -0
- data/lib/metanorma/iso_document/metadata.rb +9 -4
- data/lib/metanorma/iso_document/terms/iso_term.rb +0 -13
- data/lib/metanorma/iso_document/terms/term_domain_element.rb +18 -0
- data/lib/metanorma/iso_document/terms.rb +1 -0
- data/lib/metanorma/itu_document/metadata/itu_bib_data_extension_type.rb +0 -37
- data/lib/metanorma/itu_document/metadata/meeting_date.rb +18 -0
- data/lib/metanorma/itu_document/metadata/meeting_element.rb +18 -0
- data/lib/metanorma/itu_document/metadata/study_period.rb +18 -0
- data/lib/metanorma/itu_document/metadata.rb +3 -4
- data/lib/metanorma/mirror/default_registry.rb +170 -0
- data/lib/metanorma/mirror/handler_registry.rb +60 -0
- data/lib/metanorma/mirror/handler_result.rb +37 -0
- data/lib/metanorma/mirror/handlers/admonition.rb +18 -0
- data/lib/metanorma/mirror/handlers/example.rb +21 -0
- data/lib/metanorma/mirror/handlers/figure.rb +53 -0
- data/lib/metanorma/mirror/handlers/formula.rb +35 -0
- data/lib/metanorma/mirror/handlers/inline/rich_html_renderer.rb +159 -0
- data/lib/metanorma/mirror/handlers/inline/text_extractor.rb +116 -0
- data/lib/metanorma/mirror/handlers/inline.rb +225 -0
- data/lib/metanorma/mirror/handlers/list.rb +110 -0
- data/lib/metanorma/mirror/handlers/note.rb +26 -0
- data/lib/metanorma/mirror/handlers/paragraph.rb +19 -0
- data/lib/metanorma/mirror/handlers/quote.rb +16 -0
- data/lib/metanorma/mirror/handlers/review.rb +19 -0
- data/lib/metanorma/mirror/handlers/section.rb +149 -0
- data/lib/metanorma/mirror/handlers/sourcecode.rb +27 -0
- data/lib/metanorma/mirror/handlers/structural.rb +68 -0
- data/lib/metanorma/mirror/handlers/table.rb +81 -0
- data/lib/metanorma/mirror/handlers/term.rb +100 -0
- data/lib/metanorma/mirror/handlers.rb +60 -0
- data/lib/metanorma/mirror/id_strategy/positional.rb +166 -0
- data/lib/metanorma/mirror/id_strategy/preserve.rb +12 -0
- data/lib/metanorma/mirror/id_strategy.rb +34 -0
- data/lib/metanorma/mirror/math_util.rb +53 -0
- data/lib/metanorma/mirror/metadata.rb +37 -0
- data/lib/metanorma/mirror/metanorma_to_mirror.rb +101 -0
- data/lib/metanorma/mirror/model/container.rb +47 -0
- data/lib/metanorma/mirror/model/factory.rb +52 -0
- data/lib/metanorma/mirror/model/guide.rb +25 -0
- data/lib/metanorma/mirror/model/leaf.rb +17 -0
- data/lib/metanorma/mirror/model/mark.rb +53 -0
- data/lib/metanorma/mirror/model/node.rb +47 -0
- data/lib/metanorma/mirror/model/soft_break.rb +33 -0
- data/lib/metanorma/mirror/model/text.rb +34 -0
- data/lib/metanorma/mirror/model.rb +16 -0
- data/lib/metanorma/mirror/output/builder.rb +39 -0
- data/lib/metanorma/mirror/output/formats/base_format.rb +90 -0
- data/lib/metanorma/mirror/output/formats/inline_format.rb +81 -0
- data/lib/metanorma/mirror/output/formats.rb +53 -0
- data/lib/metanorma/mirror/output/html_renderer.rb +95 -0
- data/lib/metanorma/mirror/output/html_renderers/block_renderers.rb +178 -0
- data/lib/metanorma/mirror/output/html_renderers/inline_renderer.rb +61 -0
- data/lib/metanorma/mirror/output/html_renderers/list_renderers.rb +96 -0
- data/lib/metanorma/mirror/output/html_renderers/mark_renderers.rb +64 -0
- data/lib/metanorma/mirror/output/html_renderers/section_renderers.rb +129 -0
- data/lib/metanorma/mirror/output/html_renderers/structural_renderers.rb +80 -0
- data/lib/metanorma/mirror/output/html_renderers/table_renderers.rb +87 -0
- data/lib/metanorma/mirror/output/html_renderers.rb +76 -0
- data/lib/metanorma/mirror/output/pipeline.rb +92 -0
- data/lib/metanorma/mirror/output/pipeline_context.rb +22 -0
- data/lib/metanorma/mirror/output.rb +14 -0
- data/lib/metanorma/mirror/rewriter.rb +121 -0
- data/lib/metanorma/mirror/safe_attr.rb +16 -0
- data/lib/metanorma/mirror/serialization/json_serializer.rb +25 -0
- data/lib/metanorma/mirror/serialization/yaml_serializer.rb +20 -0
- data/lib/metanorma/mirror/serialization.rb +10 -0
- data/lib/metanorma/mirror/transformer.rb +22 -0
- data/lib/metanorma/mirror.rb +32 -0
- data/lib/metanorma/standard_document/annotation.rb +37 -0
- data/lib/metanorma/standard_document/block_attributes.rb +15 -2
- data/lib/metanorma/standard_document/blocks/block_source.rb +0 -23
- data/lib/metanorma/standard_document/blocks/source_origin_element.rb +23 -0
- data/lib/metanorma/standard_document/blocks.rb +1 -1
- data/lib/metanorma/standard_document/terms/term_expression.rb +0 -31
- data/lib/metanorma/standard_document/terms/term_name_element.rb +29 -0
- data/lib/metanorma/standard_document/terms.rb +1 -0
- data/script/render_both.rb +18 -0
- metadata +262 -13
- data/.github/workflows/rake.yml +0 -21
- data/.github/workflows/release.yml +0 -25
- data/.github/workflows/roundtrip-samples.yml +0 -132
- data/.gitignore +0 -19
- data/.rspec +0 -3
- data/.rubocop.yml +0 -22
- data/Gemfile +0 -28
- data/bin/console +0 -15
- data/bin/setup +0 -8
- data/metanorma-document.gemspec +0 -35
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
import { describe, it, expect, beforeAll, afterAll } from 'vitest'
|
|
2
|
+
import puppeteer, { type Browser, type Page } from 'puppeteer'
|
|
3
|
+
import { readFileSync } from 'fs'
|
|
4
|
+
import { resolve } from 'path'
|
|
5
|
+
|
|
6
|
+
describe('sample.html E2E', () => {
|
|
7
|
+
let browser: Browser
|
|
8
|
+
let page: Page
|
|
9
|
+
const samplePath = resolve(__dirname, '../dist/sample.html')
|
|
10
|
+
|
|
11
|
+
beforeAll(async () => {
|
|
12
|
+
browser = await puppeteer.launch({
|
|
13
|
+
headless: true,
|
|
14
|
+
args: ['--no-sandbox', '--disable-setuid-sandbox'],
|
|
15
|
+
})
|
|
16
|
+
page = await browser.newPage()
|
|
17
|
+
await page.setViewport({ width: 1280, height: 900 })
|
|
18
|
+
|
|
19
|
+
// Collect console errors
|
|
20
|
+
page.on('pageerror', (err) => {
|
|
21
|
+
console.error('PAGE ERROR:', err.message)
|
|
22
|
+
})
|
|
23
|
+
})
|
|
24
|
+
|
|
25
|
+
afterAll(async () => {
|
|
26
|
+
await browser.close()
|
|
27
|
+
})
|
|
28
|
+
|
|
29
|
+
it('file exists and is non-empty', () => {
|
|
30
|
+
const content = readFileSync(samplePath, 'utf-8')
|
|
31
|
+
expect(content.length).toBeGreaterThan(1000)
|
|
32
|
+
})
|
|
33
|
+
|
|
34
|
+
it('loads without JavaScript errors', async () => {
|
|
35
|
+
const errors: string[] = []
|
|
36
|
+
page.on('console', (msg) => {
|
|
37
|
+
if (msg.type() === 'error') errors.push(msg.text())
|
|
38
|
+
})
|
|
39
|
+
|
|
40
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
41
|
+
|
|
42
|
+
// Filter out benign errors (e.g. ERR_FILE_NOT_FOUND for fonts/data on file:// protocol)
|
|
43
|
+
const realErrors = errors.filter(e =>
|
|
44
|
+
!e.includes('ERR_FILE_NOT_FOUND') &&
|
|
45
|
+
!e.includes('service worker') &&
|
|
46
|
+
!e.includes('favicon')
|
|
47
|
+
)
|
|
48
|
+
expect(realErrors).toHaveLength(0)
|
|
49
|
+
})
|
|
50
|
+
|
|
51
|
+
it('Vue app mounts and replaces SSR content', async () => {
|
|
52
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
53
|
+
await page.waitForSelector('#metanorma-app', { timeout: 5000 })
|
|
54
|
+
|
|
55
|
+
// The Vue app should have mounted — check for Vue-generated content
|
|
56
|
+
const appHtml = await page.$eval('#metanorma-app', (el) => el.innerHTML)
|
|
57
|
+
expect(appHtml.length).toBeGreaterThan(100)
|
|
58
|
+
})
|
|
59
|
+
|
|
60
|
+
it('document title is visible', async () => {
|
|
61
|
+
const title = await page.$eval('title', (el) => el.textContent)
|
|
62
|
+
expect(title).toContain('ISO 17301-1:2016')
|
|
63
|
+
})
|
|
64
|
+
|
|
65
|
+
it('renders clause headings with numbering', async () => {
|
|
66
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
67
|
+
await page.waitForSelector('.mn-clause, .mn-foreword', { timeout: 5000 })
|
|
68
|
+
|
|
69
|
+
const headings = await page.$$eval('h2', (els) =>
|
|
70
|
+
els.map((el) => el.textContent?.trim() || '')
|
|
71
|
+
)
|
|
72
|
+
|
|
73
|
+
expect(headings.some(h => h.includes('Scope'))).toBe(true)
|
|
74
|
+
expect(headings.some(h => h.includes('Foreword'))).toBe(true)
|
|
75
|
+
expect(headings.some(h => h.includes('Test methods'))).toBe(true)
|
|
76
|
+
expect(headings.some(h => h.includes('Terms and definitions'))).toBe(true)
|
|
77
|
+
})
|
|
78
|
+
|
|
79
|
+
it('renders paragraphs with text content', async () => {
|
|
80
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
81
|
+
await page.waitForSelector('p', { timeout: 5000 })
|
|
82
|
+
|
|
83
|
+
const paragraphs = await page.$$eval('p', (els) =>
|
|
84
|
+
els.map((el) => el.textContent?.trim() || '')
|
|
85
|
+
)
|
|
86
|
+
|
|
87
|
+
expect(paragraphs.some(p => p.includes('ISO (the International Organization'))).toBe(true)
|
|
88
|
+
expect(paragraphs.some(p => p.includes('test methods'))).toBe(true)
|
|
89
|
+
})
|
|
90
|
+
|
|
91
|
+
it('renders inline marks (strong, emphasis)', async () => {
|
|
92
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
93
|
+
|
|
94
|
+
const strongText = await page.$eval('strong', (el) => el.textContent)
|
|
95
|
+
expect(strongText).toBe('the test methods')
|
|
96
|
+
|
|
97
|
+
const emTexts = await page.$$eval('em', (els) =>
|
|
98
|
+
els.map((el) => el.textContent?.trim() || '')
|
|
99
|
+
)
|
|
100
|
+
expect(emTexts).toContain('Oryza sativa L.')
|
|
101
|
+
expect(emTexts).toContain('Oryza glaberrima')
|
|
102
|
+
})
|
|
103
|
+
|
|
104
|
+
it('renders bullet list with list items', async () => {
|
|
105
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
106
|
+
|
|
107
|
+
const listItems = await page.$$eval('ul li', (els) =>
|
|
108
|
+
els.map((el) => el.textContent?.trim() || '')
|
|
109
|
+
)
|
|
110
|
+
expect(listItems.length).toBeGreaterThanOrEqual(3)
|
|
111
|
+
expect(listItems).toContain('Milling quality assessment')
|
|
112
|
+
expect(listItems).toContain('Moisture content determination')
|
|
113
|
+
})
|
|
114
|
+
|
|
115
|
+
it('renders ordered list', async () => {
|
|
116
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
117
|
+
|
|
118
|
+
const olItems = await page.$$eval('ol li', (els) =>
|
|
119
|
+
els.map((el) => el.textContent?.trim() || '')
|
|
120
|
+
)
|
|
121
|
+
expect(olItems).toContain('Weigh the sample')
|
|
122
|
+
expect(olItems).toContain('Dry at 130 °C')
|
|
123
|
+
expect(olItems).toContain('Re-weigh and calculate')
|
|
124
|
+
})
|
|
125
|
+
|
|
126
|
+
it('renders table with header and body', async () => {
|
|
127
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
128
|
+
await page.waitForSelector('table', { timeout: 5000 })
|
|
129
|
+
|
|
130
|
+
const headers = await page.$$eval('th', (els) =>
|
|
131
|
+
els.map((el) => el.textContent?.trim() || '')
|
|
132
|
+
)
|
|
133
|
+
expect(headers).toContain('Parameter')
|
|
134
|
+
expect(headers).toContain('Method')
|
|
135
|
+
expect(headers).toContain('Unit')
|
|
136
|
+
|
|
137
|
+
const cells = await page.$$eval('td', (els) =>
|
|
138
|
+
els.map((el) => el.textContent?.trim() || '')
|
|
139
|
+
)
|
|
140
|
+
expect(cells).toContain('Moisture content')
|
|
141
|
+
expect(cells).toContain('ISO 712')
|
|
142
|
+
})
|
|
143
|
+
|
|
144
|
+
it('renders admonition with warning type', async () => {
|
|
145
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
146
|
+
|
|
147
|
+
// Vue uses "admonition-warning" class (SSR uses "mn-admonition--warning")
|
|
148
|
+
const hasWarning = await page.$eval('.admonition-warning', () => true).catch(() => false)
|
|
149
|
+
expect(hasWarning).toBe(true)
|
|
150
|
+
|
|
151
|
+
const warningText = await page.$eval('.admonition-warning', (el) => el.textContent)
|
|
152
|
+
expect(warningText).toContain('(20 ± 2) °C')
|
|
153
|
+
})
|
|
154
|
+
|
|
155
|
+
it('renders sourcecode block with language badge', async () => {
|
|
156
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
157
|
+
|
|
158
|
+
const hasSourcecode = await page.$eval('.mn-sourcecode', () => true).catch(() => false)
|
|
159
|
+
expect(hasSourcecode).toBe(true)
|
|
160
|
+
|
|
161
|
+
const codeText = await page.$eval('.mn-sourcecode code', (el) => el.textContent)
|
|
162
|
+
expect(codeText).toContain('moisture_content')
|
|
163
|
+
})
|
|
164
|
+
|
|
165
|
+
it('renders figure with image and caption', async () => {
|
|
166
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
167
|
+
|
|
168
|
+
const hasFigure = await page.$eval('figure', () => true).catch(() => false)
|
|
169
|
+
expect(hasFigure).toBe(true)
|
|
170
|
+
|
|
171
|
+
const imgAlt = await page.$eval('figure img', (el) => (el as HTMLImageElement).alt)
|
|
172
|
+
expect(imgAlt).toBe('Grain structure diagram')
|
|
173
|
+
|
|
174
|
+
const caption = await page.$eval('figcaption', (el) => el.textContent)
|
|
175
|
+
expect(caption).toContain('Grain structure')
|
|
176
|
+
})
|
|
177
|
+
|
|
178
|
+
it('renders nested clause (term entry)', async () => {
|
|
179
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
180
|
+
|
|
181
|
+
const termHeading = await page.$eval('#term-rice', (el) => el.textContent)
|
|
182
|
+
expect(termHeading).toContain('rice')
|
|
183
|
+
|
|
184
|
+
const hasExample = await page.$eval('.mn-example', () => true).catch(() => false)
|
|
185
|
+
expect(hasExample).toBe(true)
|
|
186
|
+
|
|
187
|
+
const hasNote = await page.$eval('.mn-note', () => true).catch(() => false)
|
|
188
|
+
expect(hasNote).toBe(true)
|
|
189
|
+
})
|
|
190
|
+
|
|
191
|
+
it('renders blockquote', async () => {
|
|
192
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
193
|
+
|
|
194
|
+
const quote = await page.$eval('blockquote', (el) => el.textContent)
|
|
195
|
+
expect(quote).toContain('Precision is the soul of science')
|
|
196
|
+
})
|
|
197
|
+
|
|
198
|
+
it('CSS variables are applied (theme renders)', async () => {
|
|
199
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
200
|
+
|
|
201
|
+
// CSS variables should be defined on :root
|
|
202
|
+
const rootVars = await page.evaluate(() => {
|
|
203
|
+
const s = getComputedStyle(document.documentElement)
|
|
204
|
+
return {
|
|
205
|
+
ebookBg: s.getPropertyValue('--ebook-bg').trim(),
|
|
206
|
+
ebookText: s.getPropertyValue('--ebook-text').trim(),
|
|
207
|
+
ebookBorder: s.getPropertyValue('--ebook-border').trim(),
|
|
208
|
+
}
|
|
209
|
+
})
|
|
210
|
+
expect(rootVars.ebookBg).toBeTruthy()
|
|
211
|
+
expect(rootVars.ebookText).toBeTruthy()
|
|
212
|
+
expect(rootVars.ebookBorder).toBeTruthy()
|
|
213
|
+
|
|
214
|
+
// Body should have the themed background color
|
|
215
|
+
const bodyBg = await page.$eval('body', (el) => {
|
|
216
|
+
return window.getComputedStyle(el).backgroundColor
|
|
217
|
+
})
|
|
218
|
+
expect(bodyBg).not.toBe('rgba(0, 0, 0, 0)')
|
|
219
|
+
})
|
|
220
|
+
|
|
221
|
+
it('xref links render correctly', async () => {
|
|
222
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
223
|
+
|
|
224
|
+
const xrefLink = await page.$eval('a[href="#iso712"]', (el) => ({
|
|
225
|
+
text: el.textContent,
|
|
226
|
+
href: el.getAttribute('href'),
|
|
227
|
+
}))
|
|
228
|
+
expect(xrefLink.text).toBe('ISO 712')
|
|
229
|
+
expect(xrefLink.href).toBe('#iso712')
|
|
230
|
+
})
|
|
231
|
+
|
|
232
|
+
it('sidebar TOC is populated', async () => {
|
|
233
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
234
|
+
|
|
235
|
+
// The Vue app should have rendered the sidebar with TOC items
|
|
236
|
+
const sidebarExists = await page.$eval('.sidebar', () => true).catch(() => false)
|
|
237
|
+
if (sidebarExists) {
|
|
238
|
+
const tocTitle = await page.$eval('.sidebar-title', (el) => el.textContent)
|
|
239
|
+
expect(tocTitle).toContain('ISO 17301-1:2016')
|
|
240
|
+
}
|
|
241
|
+
})
|
|
242
|
+
|
|
243
|
+
it('no duplicate IDs in the document', async () => {
|
|
244
|
+
await page.goto(`file://${samplePath}`, { waitUntil: 'networkidle0', timeout: 15000 })
|
|
245
|
+
|
|
246
|
+
const ids = await page.$$eval('[id]', (els) =>
|
|
247
|
+
els.map((el) => el.id).filter(Boolean)
|
|
248
|
+
)
|
|
249
|
+
const uniqueIds = new Set(ids)
|
|
250
|
+
if (ids.length !== uniqueIds.size) {
|
|
251
|
+
const dupes = ids.filter((id, i) => ids.indexOf(id) !== i)
|
|
252
|
+
console.error('Duplicate IDs:', [...new Set(dupes)])
|
|
253
|
+
}
|
|
254
|
+
expect(uniqueIds.size).toBe(ids.length)
|
|
255
|
+
})
|
|
256
|
+
})
|
data/frontend/index.html
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8" />
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
6
|
+
<title>Metanorma Document Viewer</title>
|
|
7
|
+
</head>
|
|
8
|
+
<body>
|
|
9
|
+
<div id="metanorma-app"></div>
|
|
10
|
+
<script type="module" src="/src/app.ts"></script>
|
|
11
|
+
</body>
|
|
12
|
+
</html>
|