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

data/lib/metanorma/mirror/transformer.rb

@@ -1,110 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Mirror
-    class Transformer
-      attr_reader :registry, :id_strategy
-
-      def initialize(registry: Mirror.default_registry,
-                     id_strategy: Mirror::DEFAULT_ID_STRATEGY)
-        @registry = registry
-        @id_strategy = id_strategy
-      end
-
-      def call(root)
-        attrs = {}
-        attrs[:flavor] = root.flavor if root.flavor
-        attrs[:type] = root.type if root.type
-        attrs[:schema_version] = root.schema_version if root.schema_version
-
-        title = extract_root_title(root)
-        attrs[:title] = title if title
-
-        content = []
-
-        preface = root.preface
-        if preface
-          result = @registry.handle(preface, context: self)
-          result.append_to(content)
-        end
-
-        sections = root.sections
-        if sections
-          result = @registry.handle(sections, context: self)
-          result.append_to(content)
-        end
-
-        annex = root.annex
-        annex&.each do |a|
-          result = @registry.handle(a, context: self)
-          result.append_to(content)
-        end
-
-        bibliography = root.bibliography
-        if bibliography
-          result = @registry.handle(bibliography, context: self)
-          result.append_to(content)
-        end
-
-        Handlers.build_node("doc", attrs: attrs, content: content)
-      end
-
-      def from_metanorma(root)
-        document = call(root)
-        @id_strategy.finalize!(document)
-      end
-
-      def rewrite(mirror_node)
-        Rewriter.new.call(mirror_node)
-      end
-
-      def extract_blocks(element)
-        content = []
-
-        element.each_mixed_content do |node|
-          next if node.is_a?(String)
-
-          result = @registry.handle(node, context: self)
-          result.append_to(content)
-        end
-        content
-      end
-
-      def extract_section_children(element)
-        content = []
-        %i[clause terms definitions references floating_title].each do |attr|
-          collection = SafeAttr.read(element, attr)
-          next unless collection
-
-          collection.each do |child|
-            result = @registry.handle(child, context: self)
-            result.append_to(content)
-          end
-        end
-        content
-      end
-
-      def extract_named_collections(element, collection_attrs)
-        content = []
-        collection_attrs.each do |attr|
-          collection = SafeAttr.read(element, attr)
-          next unless collection
-
-          collection.each do |child|
-            result = @registry.handle(child, context: self)
-            result.append_to(content)
-          end
-        end
-        content
-      end
-
-      def text_node(text, marks: [])
-        Handlers.build_text(text, marks: marks)
-      end
-
-      def extract_root_title(root)
-        Metadata.title_from_bibdata(SafeAttr.read(root, :bibdata))
-      end
-    end
-  end
-end

data/lib/metanorma/mirror.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Mirror
-    class Error < StandardError; end
-
-    autoload :SafeAttr, "#{__dir__}/mirror/safe_attr"
-    autoload :MathUtil, "#{__dir__}/mirror/math_util"
-    autoload :Metadata, "#{__dir__}/mirror/metadata"
-    autoload :Model, "#{__dir__}/mirror/model"
-    autoload :HandlerResult, "#{__dir__}/mirror/handler_result"
-    autoload :Transformer, "#{__dir__}/mirror/transformer"
-    autoload :Rewriter, "#{__dir__}/mirror/rewriter"
-    autoload :HandlerRegistry, "#{__dir__}/mirror/handler_registry"
-    autoload :Handlers, "#{__dir__}/mirror/handlers"
-    autoload :IdStrategy, "#{__dir__}/mirror/id_strategy"
-    autoload :Output, "#{__dir__}/mirror/output"
-    autoload :Serialization, "#{__dir__}/mirror/serialization"
-    autoload :DefaultRegistry, "#{__dir__}/mirror/default_registry"
-
-    DEFAULT_ID_STRATEGY = IdStrategy::Preserve.new
-
-    def self.default_registry
-      @default_registry ||= build_default_registry
-    end
-
-    def self.build_default_registry
-      DefaultRegistry.build
-    end
-  end
-end

data/lib/metanorma/nist_document/metadata/nist_bib_data_extension_type.rb

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

data/lib/metanorma/nist_document/metadata/nist_bibliographic_item.rb

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

data/lib/metanorma/nist_document/metadata.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module NistDocument
-    module Metadata
-      autoload :NistBibDataExtensionType,
-               "#{__dir__}/metadata/nist_bib_data_extension_type"
-      autoload :NistBibliographicItem,
-               "#{__dir__}/metadata/nist_bibliographic_item"
-    end
-  end
-end

data/lib/metanorma/nist_document/root.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module NistDocument
-    class Root < Lutaml::Model::Serializable
-      include Metanorma::StandardDocument::RootAttributes
-
-      def self.lutaml_default_register
-        :nist_document
-      end
-
-      attribute :bibdata, Metadata::NistBibliographicItem
-      attribute :preface,
-                NistDocument::Sections::NistPreface
-      attribute :sections,
-                Metanorma::StandardDocument::Sections::Sections
-      attribute :annex,
-                Metanorma::StandardDocument::Sections::AnnexSection,
-                collection: true
-
-      xml do
-        element "metanorma"
-        namespace Metanorma::StandardDocument::Namespace
-
-        Metanorma::StandardDocument::RootXmlMapping.apply(self)
-      end
-    end
-  end
-end

data/lib/metanorma/nist_document/sections/errata.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module NistDocument
-    module Sections
-      class Errata < Lutaml::Model::Serializable
-        attribute :rows, ErrataRow, collection: true
-
-        xml do
-          element "errata"
-          map_element "row", to: :rows
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/nist_document/sections/errata_clause.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module NistDocument
-    module Sections
-      class ErrataClause < Metanorma::StandardDocument::Sections::ContentSection
-        attribute :errata, Errata
-
-        xml do
-          element "errata_clause"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
-          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_elements(self)
-          map_element "errata", to: :errata
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/nist_document/sections/errata_row.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module NistDocument
-    module Sections
-      class ErrataRow < Lutaml::Model::Serializable
-        attribute :date, :string
-        attribute :type, :string
-        attribute :change, :string, collection: true
-        attribute :pages, :string
-
-        xml do
-          element "row"
-          map_element "date",   to: :date
-          map_element "type",   to: :type
-          map_element "change", to: :change
-          map_element "pages",  to: :pages
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/nist_document/sections/nist_preface.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module NistDocument
-    module Sections
-      # NIST preface with errata and executivesummary support.
-      # Corresponds to nist.rnc:
-      #   preface = element preface {
-      #     abstract?, foreword?,
-      #     (clause | errata_clause | acknowledgements)*,
-      #     content*,
-      #     executivesummary?
-      #   }
-      class NistPreface < Metanorma::StandardDocument::Sections::Preface
-        attribute :errata_clause, ErrataClause, collection: true
-
-        xml do
-          element "preface"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_elements(self)
-          map_element "clause",            to: :content
-          map_element "errata_clause",     to: :errata_clause
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_attributes(self)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/nist_document/sections.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module NistDocument
-    module Sections
-      autoload :Errata, "#{__dir__}/sections/errata"
-      autoload :ErrataClause, "#{__dir__}/sections/errata_clause"
-      autoload :ErrataRow, "#{__dir__}/sections/errata_row"
-      autoload :NistPreface, "#{__dir__}/sections/nist_preface"
-    end
-  end
-end

data/lib/metanorma/nist_document.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module NistDocument
-    autoload :Metadata, "metanorma/nist_document/metadata"
-    autoload :Root, "metanorma/nist_document/root"
-    autoload :Sections, "metanorma/nist_document/sections"
-  end
-end
-
-Metanorma::Registers::Setup.setup_nist_register

data/lib/metanorma/ogc_document/metadata/ogc_bib_data_extension_type.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module OgcDocument
-    module Metadata
-      # Extension point for bibliographical definitions of OGC documents.
-      # Inherits all ISO extension fields; OGC adds nothing extra.
-      class OgcBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
-      end
-    end
-  end
-end

data/lib/metanorma/ogc_document/metadata/ogc_bibliographic_item.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module OgcDocument
-    module Metadata
-      # The bibliographical description of an OGC document.
-      # Adds keyword element; OGC uses the same ext as ISO.
-      class OgcBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
-        attribute :keyword, :string, collection: true
-        attribute :ext, OgcBibDataExtensionType
-
-        xml do
-          element "bibdata"
-          map_element "keyword", to: :keyword
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/ogc_document/metadata.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module OgcDocument
-    module Metadata
-      autoload :OgcBibDataExtensionType,
-               "#{__dir__}/metadata/ogc_bib_data_extension_type"
-      autoload :OgcBibliographicItem,
-               "#{__dir__}/metadata/ogc_bibliographic_item"
-    end
-  end
-end

data/lib/metanorma/ogc_document/root.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module OgcDocument
-    class Root < Lutaml::Model::Serializable
-      include Metanorma::StandardDocument::RootAttributes
-
-      attribute :bibdata, Metadata::OgcBibliographicItem
-      attribute :preface,
-                Metanorma::StandardDocument::Sections::Preface
-      attribute :sections,
-                Metanorma::StandardDocument::Sections::Sections
-      attribute :annex,
-                Metanorma::StandardDocument::Sections::AnnexSection,
-                collection: true
-
-      xml do
-        element "metanorma"
-        namespace Metanorma::StandardDocument::Namespace
-
-        Metanorma::StandardDocument::RootXmlMapping.apply(self)
-      end
-    end
-  end
-end

data/lib/metanorma/ogc_document.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module OgcDocument
-    autoload :Metadata, "metanorma/ogc_document/metadata"
-    autoload :Root, "metanorma/ogc_document/root"
-  end
-end

data/lib/metanorma/plateau_document/metadata/plateau_bibliographic_item.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module PlateauDocument
-    module Metadata
-      class PlateauBibliographicItem < Metanorma::JisDocument::Metadata::JisBibliographicItem
-        xml do
-          element "bibdata"
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/plateau_document/metadata.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module PlateauDocument
-    module Metadata
-      autoload :PlateauBibliographicItem,
-               "#{__dir__}/metadata/plateau_bibliographic_item"
-    end
-  end
-end

data/lib/metanorma/plateau_document/root.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module PlateauDocument
-    class Root < Lutaml::Model::Serializable
-      include Metanorma::StandardDocument::RootAttributes
-
-      def self.lutaml_default_register
-        :plateau_document
-      end
-
-      attribute :bibdata, Metadata::PlateauBibliographicItem
-      attribute :preface,
-                Metanorma::IsoDocument::Sections::IsoPreface
-      attribute :sections,
-                Metanorma::IsoDocument::Sections::IsoSections
-      attribute :annex,
-                Metanorma::JisDocument::Sections::JisAnnexSection,
-                collection: true
-
-      xml do
-        element "metanorma"
-        namespace Metanorma::StandardDocument::Namespace
-
-        Metanorma::StandardDocument::RootXmlMapping.apply(self)
-      end
-    end
-  end
-end

data/lib/metanorma/plateau_document.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module PlateauDocument
-    autoload :Metadata, "metanorma/plateau_document/metadata"
-    autoload :Root, "metanorma/plateau_document/root"
-  end
-end
-
-Metanorma::Registers::Setup.setup_plateau_register

data/lib/metanorma/registers/setup.rb

@@ -1,166 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Registers
-    module Setup
-      class << self
-        # ============================================================
-        # ISO-family registers — fallback to :iso_document
-        # ============================================================
-
-        def setup_iso_register
-          sd = Metanorma::StandardDocument
-          iso = Metanorma::IsoDocument
-          reg = Lutaml::Model::Register.new(:iso_document)
-          Lutaml::Model::GlobalRegister.register(reg)
-
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::ClauseSection,
-            to_type: iso::Sections::IsoClauseSection,
-          )
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::AnnexSection,
-            to_type: iso::Sections::IsoAnnexSection,
-          )
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::Sections,
-            to_type: iso::Sections::IsoSections,
-          )
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::Preface,
-            to_type: iso::Sections::IsoPreface,
-          )
-        end
-
-        def setup_iec_register
-          reg = Lutaml::Model::Register.new(:iec_document,
-                                            fallback: [:iso_document])
-          Lutaml::Model::GlobalRegister.register(reg)
-        end
-
-        def setup_csa_register
-          reg = Lutaml::Model::Register.new(:csa_document,
-                                            fallback: [:iso_document])
-          Lutaml::Model::GlobalRegister.register(reg)
-        end
-
-        def setup_bsi_register
-          iso = Metanorma::IsoDocument
-          reg = Lutaml::Model::Register.new(:bsi_document,
-                                            fallback: [:iso_document])
-          Lutaml::Model::GlobalRegister.register(reg)
-
-          reg.register_global_type_substitution(
-            from_type: iso::Sections::IsoSections,
-            to_type: Metanorma::BsiDocument::Sections::BsiSections,
-          )
-          reg.register_global_type_substitution(
-            from_type: iso::Sections::IsoClauseSection,
-            to_type: Metanorma::BsiDocument::Sections::BsiClauseSection,
-          )
-          reg.register_global_type_substitution(
-            from_type: iso::Sections::IsoAnnexSection,
-            to_type: Metanorma::BsiDocument::Sections::BsiAnnexSection,
-          )
-        end
-
-        def setup_jis_register
-          iso = Metanorma::IsoDocument
-          reg = Lutaml::Model::Register.new(:jis_document,
-                                            fallback: [:iso_document])
-          Lutaml::Model::GlobalRegister.register(reg)
-
-          reg.register_global_type_substitution(
-            from_type: iso::Sections::IsoAnnexSection,
-            to_type: Metanorma::JisDocument::Sections::JisAnnexSection,
-          )
-        end
-
-        def setup_gb_register
-          reg = Lutaml::Model::Register.new(:gb_document,
-                                            fallback: [:iso_document])
-          Lutaml::Model::GlobalRegister.register(reg)
-        end
-
-        def setup_m3d_register
-          reg = Lutaml::Model::Register.new(:m3d_document)
-          Lutaml::Model::GlobalRegister.register(reg)
-        end
-
-        def setup_plateau_register
-          reg = Lutaml::Model::Register.new(:plateau_document,
-                                            fallback: [:jis_document])
-          Lutaml::Model::GlobalRegister.register(reg)
-        end
-
-        # ============================================================
-        # Isodoc-family registers — no ISO fallback
-        # ============================================================
-
-        def setup_ieee_register
-          sd = Metanorma::StandardDocument
-          reg = Lutaml::Model::Register.new(:ieee_document)
-          Lutaml::Model::GlobalRegister.register(reg)
-
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::Sections,
-            to_type: Metanorma::IeeeDocument::Sections::IeeeSections,
-          )
-        end
-
-        def setup_ietf_register
-          sd = Metanorma::StandardDocument
-          reg = Lutaml::Model::Register.new(:ietf_document)
-          Lutaml::Model::GlobalRegister.register(reg)
-
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::Sections,
-            to_type: Metanorma::IetfDocument::Sections::IetfSections,
-          )
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::ContentSection,
-            to_type: Metanorma::IetfDocument::Sections::IetfContentSection,
-          )
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::ClauseSection,
-            to_type: Metanorma::IetfDocument::Sections::IetfClauseSection,
-          )
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::AnnexSection,
-            to_type: Metanorma::IetfDocument::Sections::IetfAnnexSection,
-          )
-        end
-
-        def setup_nist_register
-          sd = Metanorma::StandardDocument
-          reg = Lutaml::Model::Register.new(:nist_document)
-          Lutaml::Model::GlobalRegister.register(reg)
-
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::Preface,
-            to_type: Metanorma::NistDocument::Sections::NistPreface,
-          )
-        end
-
-        def setup_un_register
-          sd = Metanorma::StandardDocument
-          reg = Lutaml::Model::Register.new(:un_document)
-          Lutaml::Model::GlobalRegister.register(reg)
-
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::Sections,
-            to_type: Metanorma::UnDocument::Sections::UnSections,
-          )
-          reg.register_global_type_substitution(
-            from_type: sd::Sections::Preface,
-            to_type: Metanorma::UnDocument::Sections::UnPreface,
-          )
-          reg.register_global_type_substitution(
-            from_type: Metanorma::Document::Components::MultiParagraph::AdmonitionBlock,
-            to_type: Metanorma::UnDocument::Blocks::UnAdmonitionBlock,
-          )
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/registers.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module Registers
-    autoload :Setup, "#{__dir__}/registers/setup"
-  end
-end

data/lib/metanorma/ribose_document/metadata/ribose_bib_data_extension_type.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module RiboseDocument
-    module Metadata
-      # Extension point for bibliographical definitions of Ribose documents.
-      # Inherits all ISO extension fields; adds security and recipient.
-      class RiboseBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
-        attribute :security, :string
-        attribute :recipient, :string
-
-        xml do
-          element "ext"
-          map_element "security", to: :security
-          map_element "recipient", to: :recipient
-        end
-      end
-    end
-  end
-end