metanorma-document 0.2.0

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # A title of a bibliographic item, associated with a type of title.
+      class TypedTitleString < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :format, :string
+        attribute :language, :string
+        attribute :script, :string
+        attribute :content, :string, collection: true
+        attribute :em, Metanorma::Document::Components::Inline::EmRawElement,
+                  collection: true
+        attribute :strong, Metanorma::Document::Components::Inline::StrongRawElement,
+                  collection: true
+        attribute :sub, Metanorma::Document::Components::Inline::SubElement,
+                  collection: true
+        attribute :sup, Metanorma::Document::Components::Inline::SupElement,
+                  collection: true
+        attribute :tt, Metanorma::Document::Components::Inline::TtElement,
+                  collection: true
+        attribute :fn, Metanorma::Document::Components::Inline::FnElement,
+                  collection: true
+        attribute :stem, Metanorma::Document::Components::Inline::StemInlineElement,
+                  collection: true
+        attribute :variant, Metanorma::Document::Components::DataTypes::LocalizedString,
+                  collection: true
+
+        xml do
+          element "title"
+          mixed_content
+          map_attribute "type", to: :type
+          map_attribute "format", to: :format
+          map_attribute "language", to: :language
+          map_attribute "script", to: :script
+          map_content to: :content
+          map_element "em", to: :em
+          map_element "strong", to: :strong
+          map_element "sub", to: :sub
+          map_element "sup", to: :sup
+          map_element "tt", to: :tt
+          map_element "fn", to: :fn
+          map_element "stem", to: :stem
+          map_element "variant", to: :variant
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # URI associated with a type.
+      class TypedUri < Metanorma::Document::Components::DataTypes::Uri
+        attribute :type, :string
+        attribute :content, :string
+
+        xml do
+          map_attribute "type", to: :type
+          map_content to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The time interval for which a bibliographic item
+      # is determined valid, and the associated revision date.
+      class ValidityType < Lutaml::Model::Serializable
+        attribute :validity_begins, :string
+        attribute :validity_ends, :string
+        attribute :revision, :string
+
+        xml do
+          element "validity"
+          map_element "validityBegins", to: :validity_begins
+          map_element "validityEnds", to: :validity_ends
+          map_element "revision", to: :revision
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # A variant name of a person.
+      class VariantFullName < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :content, Metanorma::Document::Relaton::FullName
+
+        xml do
+          map_attribute "type", to: :type
+          map_element "content", to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # A variant name of an organization.
+      class VariantOrgName < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :content, Metanorma::Document::Components::DataTypes::LocalizedString
+
+        xml do
+          map_attribute "type", to: :type
+          map_element "content", to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # A version of the bibliographic item (within an edition). Can be used for drafts.
+      class VersionInfo < Lutaml::Model::Serializable
+        attribute :revision_date, :string
+        attribute :draft, :string
+
+        xml do
+          element "version"
+          map_element "revision-date", to: :revision_date
+          map_element "draft", to: :draft
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Item in a controlled vocabulary.
+      class VocabIdType < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :uri, :string
+        attribute :code, :string
+        attribute :term, Metanorma::Document::Relaton::VocabIdType
+
+        xml do
+          map_attribute "type", to: :type
+          map_attribute "uri", to: :uri
+          map_attribute "code", to: :code
+          map_element "term", to: :term
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/relaton.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      autoload :Address, "#{__dir__}/relaton/address"
+      autoload :Affiliation, "#{__dir__}/relaton/affiliation"
+      autoload :BibItemLocality, "#{__dir__}/relaton/bib_item_locality"
+      autoload :BibItemSize, "#{__dir__}/relaton/bib_item_size"
+      autoload :BibItemSizeType, "#{__dir__}/relaton/bib_item_size_type"
+      autoload :BibItemType, "#{__dir__}/relaton/bib_item_type"
+      autoload :BibliographicDate, "#{__dir__}/relaton/bibliographic_date"
+      autoload :BibliographicDateType,
+               "#{__dir__}/relaton/bibliographic_date_type"
+      autoload :ContactMethod, "#{__dir__}/relaton/contact_method"
+      autoload :ContributionInfo, "#{__dir__}/relaton/contribution_info"
+      autoload :Contributor, "#{__dir__}/relaton/contributor"
+      autoload :ContributorRole, "#{__dir__}/relaton/contributor_role"
+      autoload :CopyrightAssociation, "#{__dir__}/relaton/copyright_association"
+      autoload :CopyrightOwner, "#{__dir__}/relaton/copyright_association"
+      autoload :DateTime, "#{__dir__}/relaton/date_time"
+      autoload :DocumentIdentifier, "#{__dir__}/relaton/document_identifier"
+      autoload :DocumentRelation, "#{__dir__}/relaton/document_relation"
+      autoload :DocumentRelationType,
+               "#{__dir__}/relaton/document_relation_type"
+      autoload :DocumentStatus, "#{__dir__}/relaton/document_status"
+      autoload :Edition, "#{__dir__}/relaton/edition"
+      autoload :FullName, "#{__dir__}/relaton/full_name"
+      autoload :Iso4217Code, "#{__dir__}/relaton/iso4217_code"
+      autoload :Iso8601Date, "#{__dir__}/relaton/iso8601_date"
+      autoload :KeywordType, "#{__dir__}/relaton/keyword_type"
+      autoload :LocalizedName, "#{__dir__}/relaton/localized_name"
+      autoload :LocalityStack, "#{__dir__}/relaton/locality_stack"
+      autoload :MediumType, "#{__dir__}/relaton/medium_type"
+      autoload :OrgIdentifier, "#{__dir__}/relaton/org_identifier"
+      autoload :OrgSubdivision, "#{__dir__}/relaton/org_subdivision"
+      autoload :OrgSubdivisionIdentifier,
+               "#{__dir__}/relaton/org_subdivision_identifier"
+      autoload :Organization, "#{__dir__}/relaton/organization"
+      autoload :Person, "#{__dir__}/relaton/person"
+      autoload :PersonIdentifier, "#{__dir__}/relaton/person_identifier"
+      autoload :PersonalIdentifierType,
+               "#{__dir__}/relaton/personal_identifier_type"
+      autoload :Phone, "#{__dir__}/relaton/phone"
+      autoload :PlaceType, "#{__dir__}/relaton/place_type"
+      autoload :PriceType, "#{__dir__}/relaton/price_type"
+      autoload :RegionType, "#{__dir__}/relaton/region_type"
+      autoload :RelatonCollection, "#{__dir__}/relaton/relaton_collection"
+      autoload :SeriesType, "#{__dir__}/relaton/series_type"
+      autoload :SeriesTypeType, "#{__dir__}/relaton/series_type_type"
+      autoload :SpecificLocalityType,
+               "#{__dir__}/relaton/specific_locality_type"
+      autoload :TitleType, "#{__dir__}/relaton/title_type"
+      autoload :TypedNote, "#{__dir__}/relaton/typed_note"
+      autoload :TypedTitleString, "#{__dir__}/relaton/typed_title_string"
+      autoload :TypedUri, "#{__dir__}/relaton/typed_uri"
+      autoload :ValidityType, "#{__dir__}/relaton/validity_type"
+      autoload :VariantFullName, "#{__dir__}/relaton/variant_full_name"
+      autoload :VariantOrgName, "#{__dir__}/relaton/variant_org_name"
+      autoload :VersionInfo, "#{__dir__}/relaton/version_info"
+      autoload :VocabIdType, "#{__dir__}/relaton/vocab_id_type"
+    end
+  end
+end

data/lib/metanorma/document/root.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Metanorma
+  module Document
+    # Base root class for all Metanorma document flavors.
+    # All document types (StandardDocument, IsoDocument) inherit from this.
+    class Root < Lutaml::Model::Serializable
+      attribute :autonum, :string
+      attribute :fmt_xref_label, :string
+    end
+  end
+end

data/lib/metanorma/document/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    VERSION = "0.2.0"
+    Version = VERSION
+  end
+end

data/lib/metanorma/document.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+# See: https://metanorma.org
+module Metanorma
+  # Metanorma::Document is a class-based document model for Metanorma.
+  # It deals with creating a class-based document to be used for handling
+  # and converting Metanorma XML documents.
+  #
+  # It uses Lutaml::Model::Serializable as the base for all document elements,
+  # providing XML serialization/deserialization via a declarative DSL.
+  #
+  # It is intended to replace the current (previous?) system of Metanorma
+  # programs communicating with one another with XML files, but also allow
+  # for a seamless migration from/to those.
+  module Document
+    autoload :Components, "metanorma/document/components"
+    autoload :DataTypes, "metanorma/document/data_types"
+    autoload :Relaton, "metanorma/document/relaton"
+    autoload :Root, "metanorma/document/root"
+    autoload :Version, "metanorma/document/version"
+
+    module_function
+
+    def from_file(file)
+      # For now, we cannot parse arbitrary XML into Lutaml models without knowing
+      # the target class. This will be addressed in a future refactoring.
+      # BasicDocument does not have XML root mapping and cannot be used to parse
+      # documents directly. Use StandardDocument or IsoDocument for specific flavors.
+      raise NotImplementedError,
+            "BasicDocument cannot parse XML directly. " \
+            "Use StandardDocument or IsoDocument for specific document flavors, " \
+            "or implement a custom parser that determines the appropriate document class."
+    end
+  end
+
+  autoload :BasicDocument, "#{__dir__}/basic_document"
+  autoload :StandardDocument, "metanorma/standard_document"
+  autoload :IsoDocument, "metanorma/iso_document"
+  autoload :IecDocument, "metanorma/iec_document"
+  autoload :IeeeDocument, "metanorma/ieee_document"
+  autoload :IhoDocument, "metanorma/iho_document"
+  autoload :OimlDocument, "metanorma/oiml_document"
+  autoload :IetfDocument, "metanorma/ietf_document"
+  autoload :CcDocument, "metanorma/cc_document"
+  autoload :BipmDocument, "metanorma/bipm_document"
+  autoload :ItuDocument, "metanorma/itu_document"
+  autoload :OgcDocument, "metanorma/ogc_document"
+  autoload :RiboseDocument, "metanorma/ribose_document"
+  autoload :IetfDocument, "metanorma/ietf_document"
+  autoload :Collection, "metanorma/collection"
+  autoload :Html, "metanorma/html"
+end

data/lib/metanorma/html/asset_pipeline.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Html
+    class AssetPipeline
+      CSS_DIR = File.expand_path("../../../data/stylesheets", __dir__)
+      JS_DIR  = File.expand_path("../../../data/javascripts", __dir__)
+
+      CORE_JS = %w[
+        core/mn-reader
+        core/mn-theme
+        core/mn-scroll
+        core/mn-navigation
+        core/mn-reveal
+      ].freeze
+
+      COMPONENT_JS = %w[
+        components/mn-toc
+        components/mn-search
+        components/mn-lightbox
+        components/mn-code-copy
+        components/mn-index-panel
+        components/mn-stem-dropdown
+        components/mn-glossary
+        components/mn-shortcuts
+      ].freeze
+
+      BASE_CSS = %w[
+        base/_reset
+        base/_typography
+        base/_layout
+        base/_transitions
+        base/_dark
+        base/_print
+      ].freeze
+
+      COMPONENT_CSS = %w[
+        components/header
+        components/cover
+        components/toc
+        components/search
+        components/section
+        components/note
+        components/example
+        components/sourcecode
+        components/formula
+        components/admonition
+        components/table
+        components/footnote
+        components/figure
+        components/term
+        components/bibliography
+        components/inline
+        components/footer
+        components/progress
+        components/index
+        components/shortcuts
+        components/glossary
+      ].freeze
+
+      def compile_js(flavor_js: nil)
+        modules = CORE_JS + COMPONENT_JS
+        modules << "flavors/#{flavor_js}" if flavor_js
+
+        js_parts = modules.filter_map do |mod|
+          path = File.join(JS_DIR, "#{mod}.js")
+          next unless File.exist?(path)
+
+          wrap_iife(File.read(path), mod)
+        end
+
+        js_parts.join("\n")
+      end
+
+      def compile_css(flavor_css: nil)
+        modules = BASE_CSS + COMPONENT_CSS
+        modules << "flavors/#{flavor_css}" if flavor_css
+
+        css_parts = modules.filter_map do |mod|
+          path = File.join(CSS_DIR, "#{mod}.css")
+          File.exist?(path) ? File.read(path) : nil
+        end
+
+        css_parts.join("\n")
+      end
+
+      private
+
+      def wrap_iife(source, module_name)
+        <<~JS
+          (function() {
+          try {
+          #{source.strip}
+          } catch(e) { if (typeof console !== 'undefined') console.error('[#{module_name}]', e); }
+          })();
+        JS
+      end
+    end
+  end
+end