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

data/lib/metanorma/iso_document/metadata/project_number.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      class ProjectNumber < Lutaml::Model::Serializable
-        attribute :part, :string
-        attribute :amendment, :string
-        attribute :origyr, :string
-        attribute :value, :string
-
-        xml do
-          element "project-number"
-          map_attribute "part", to: :part
-          map_attribute "amendment", to: :amendment
-          map_attribute "origyr", to: :origyr
-          map_content to: :value
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/script_element.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      class ScriptElement < Lutaml::Model::Serializable
-        attribute :current, :string
-        attribute :value, :string
-
-        xml do
-          element "script"
-          map_attribute "current", to: :current
-          map_content to: :value
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/stage_element.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      class StageElement < Lutaml::Model::Serializable
-        attribute :abbreviation, :string
-        attribute :language, :string
-        attribute :type, :string
-        attribute :value, :string, collection: true
-        attribute :br, Metanorma::Document::Components::Inline::BrElement,
-                  collection: true
-
-        xml do
-          element "stage"
-          mixed_content
-          map_attribute "abbreviation", to: :abbreviation
-          map_attribute "language", to: :language, render_empty: true
-          map_attribute "type", to: :type
-          map_content to: :value
-          map_element "br", to: :br
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/stagename_element.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      class StagenameElement < Lutaml::Model::Serializable
-        attribute :abbreviation, :string
-        attribute :value, :string
-
-        xml do
-          element "stagename"
-          map_attribute "abbreviation", to: :abbreviation
-          map_content to: :value
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/structured_identifier.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      class StructuredIdentifier < Lutaml::Model::Serializable
-        attribute :project_number, ProjectNumber
-
-        xml do
-          element "structuredidentifier"
-          map_element "project-number", to: :project_number
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/title_amd.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Title with type="title-amd" - amendment description text
-      class TitleAmd < AbstractTitle
-        attribute :semx_id, :string
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/title_amendment_prefix.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Title with type="title-amendment-prefix" - amendment prefix (e.g. "AMENDMENT 1")
-      class TitleAmendmentPrefix < AbstractTitle
-        attribute :semx_id, :string
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/title_collection.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Collection for title elements with consolidation mapping.
-      # Groups titles by language and routes by type to typed attributes.
-      #
-      # Usage:
-      #   bibdata.titles.items        # => All raw AbstractTitle instances
-      #   bibdata.titles.per_language # => Array of IsoLocalizedTitle grouped by language
-      #
-      class TitleCollection < Lutaml::Model::Collection
-        attribute :semx_id, :string
-        instances :items, AbstractTitle
-        organizes :per_language, IsoLocalizedTitle
-
-        xml do
-          root "titles"
-          map_instances to: :items
-
-          consolidate_map by: :language, to: :per_language do
-            gather :language, to: :language
-            dispatch_by :_type do
-              route "main" => :title_full
-              route "title-intro" => :title_intro
-              route "intro" => :title_intro
-              route "title-main" => :title_main
-              route "title-part" => :title_part
-              route "title-part-prefix" => :title_part_prefix
-              route "title-amd" => :title_amd
-              route "title-amendment-prefix" => :title_amendment_prefix
-              route "title-abbrev" => :title_full
-              route nil => :title_full
-            end
-          end
-          map_attribute "semx-id", to: :semx_id
-        end
-
-        # Find the localized title for a given language
-        def for_language(language = "en")
-          per_language.find { |g| g.language == language }
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/title_full.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Title with type="main" - full/complete title
-      class TitleFull < AbstractTitle
-        attribute :semx_id, :string
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/title_intro.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Title with type="title-intro" - introductory component
-      class TitleIntro < AbstractTitle
-        attribute :semx_id, :string
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/title_main.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Title with type="title-main" - main component
-      class TitleMain < AbstractTitle
-        attribute :semx_id, :string
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/title_part.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Title with type="title-part" - part component
-      class TitlePart < AbstractTitle
-        attribute :semx_id, :string
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata/title_part_prefix.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Title with type="title-part-prefix" - part prefix (e.g., "Part 1")
-      class TitlePartPrefix < AbstractTitle
-        attribute :semx_id, :string
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/metadata.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      autoload :AbstractTitle, "#{__dir__}/metadata/abstract_title"
-      autoload :DocIdentifier, "#{__dir__}/metadata/doc_identifier"
-      autoload :DoctypeElement, "#{__dir__}/metadata/doctype_element"
-      autoload :IecDocumentCategory, "#{__dir__}/metadata/iec_document_category"
-      autoload :IsoBibDataExtensionType,
-               "#{__dir__}/metadata/iso_bib_data_extension_type"
-      autoload :IsoBibliographicItem,
-               "#{__dir__}/metadata/iso_bibliographic_item"
-      autoload :IsoDocumentId, "#{__dir__}/metadata/iso_document_id"
-      autoload :IsoDocumentStageCodes,
-               "#{__dir__}/metadata/iso_document_stage_codes"
-      autoload :IsoDocumentStatus, "#{__dir__}/metadata/iso_document_status"
-      autoload :IsoDocumentSubstageCodes,
-               "#{__dir__}/metadata/iso_document_substage_codes"
-      autoload :IsoDocumentType, "#{__dir__}/metadata/iso_document_type"
-      autoload :IsoLocalizedTitle, "#{__dir__}/metadata/iso_localized_title"
-      autoload :TitleCollection, "#{__dir__}/metadata/title_collection"
-      autoload :IsoProjectGroup, "#{__dir__}/metadata/iso_project_group"
-      autoload :IsoSubGroup, "#{__dir__}/metadata/iso_sub_group"
-      autoload :LanguageElement, "#{__dir__}/metadata/language_element"
-      autoload :MetanormaExtension, "#{__dir__}/metadata/metanorma_extension"
-      autoload :ProjectNumber, "#{__dir__}/metadata/project_number"
-      autoload :ScriptElement, "#{__dir__}/metadata/script_element"
-      autoload :StagenameElement, "#{__dir__}/metadata/stagename_element"
-      autoload :StageElement, "#{__dir__}/metadata/stage_element"
-      autoload :StructuredIdentifier,
-               "#{__dir__}/metadata/structured_identifier"
-      autoload :TitleFull, "#{__dir__}/metadata/title_full"
-      autoload :TitleIntro, "#{__dir__}/metadata/title_intro"
-      autoload :TitleMain, "#{__dir__}/metadata/title_main"
-      autoload :TitlePart, "#{__dir__}/metadata/title_part"
-      autoload :TitlePartPrefix, "#{__dir__}/metadata/title_part_prefix"
-      autoload :TitleAmd, "#{__dir__}/metadata/title_amd"
-      autoload :TitleAmendmentPrefix,
-               "#{__dir__}/metadata/title_amendment_prefix"
-      autoload :Ics, "#{__dir__}/metadata/ics"
-    end
-  end
-end

data/lib/metanorma/iso_document/root.rb

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

data/lib/metanorma/iso_document/sections/colophon.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-Metanorma::IsoDocument::Sections::Colophon = Metanorma::StandardDocument::Sections::Colophon

data/lib/metanorma/iso_document/sections/iso_abstract_section.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Sections
-      # Abstract section in the preface. Same structure as a clause but maps
-      # to the "abstract" element.
-      class IsoAbstractSection < IsoClauseSection
-        xml do
-          element "abstract"
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/sections/iso_amendment_clause.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Sections
-      # Clause appearing in an ISO/IEC Amendment or Technical Corrigendum document.
-      class IsoAmendmentClause < Lutaml::Model::Serializable
-        # Block expressing a machine-readable change in a document.
-        attribute :amend, Metanorma::StandardDocument::Blocks::AmendBlock
-        attribute :semx_id, :string
-        attribute :autonum, :string
-        attribute :displayorder, :integer
-
-        xml do
-          element "clause"
-          map_element "amend", to: :amend
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "autonum", to: :autonum
-          map_attribute "displayorder", to: :displayorder
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/sections/iso_annex_section.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Sections
-      # Annex appearing in ISO/IEC document.
-      # Inherits structure from StandardDocument::AnnexSection and overrides
-      # clause/appendix/terms to use ISO-specific types.
-      class IsoAnnexSection < Metanorma::StandardDocument::Sections::AnnexSection
-        # Override: ISO sub-clauses are IsoClauseSection
-        attribute :clause, IsoClauseSection, collection: true
-
-        # Override: ISO appendixes are IsoClauseSection
-        attribute :appendix, IsoClauseSection, collection: true
-
-        # Override: ISO terms sections use IsoTermsSection
-        attribute :terms, IsoTermsSection, collection: true
-
-        xml do
-          element "annex"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_attributes(self)
-          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_elements(self)
-        end
-
-        json do
-          map "id", to: :id
-          map "number", to: :number
-          map "obligation", to: :obligation
-          map "title", to: :title
-          map "clause", to: :clause
-          map "appendix", to: :appendix
-          map "paragraphs", to: :paragraphs
-          map "unordered_lists", to: :unordered_lists
-          map "ordered_lists", to: :ordered_lists
-          map "tables", to: :tables
-          map "figures", to: :figures
-          map "formulas", to: :formulas
-          map "examples", to: :examples
-          map "notes", to: :notes
-          map "admonitions", to: :admonitions
-          map "sourcecode_blocks", to: :sourcecode_blocks
-          map "quote_blocks", to: :quote_blocks
-          map "definition_lists", to: :definition_lists
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/sections/iso_clause_section.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Sections
-      # A numbered clause in an ISO/IEC document body.
-      # Extends StandardDocument::ClauseSection with ISO-specific overrides:
-      #   - Recursive clauses are IsoClauseSection (not ClauseSection)
-      #   - Terms sections are IsoTermsSection (not TermsSection)
-      class IsoClauseSection < Metanorma::StandardDocument::Sections::ClauseSection
-        # Override: ISO sub-clauses are IsoClauseSection
-        attribute :clause, IsoClauseSection, collection: true
-
-        # Override: ISO terms sections use IsoTermsSection
-        attribute :terms, IsoTermsSection, collection: true
-
-        xml do
-          element "clause"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_attributes(self)
-          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_elements(self)
-        end
-
-        json do
-          map "id", to: :id
-          map "type", to: :type
-          map "number", to: :number
-          map "title", to: :title
-          map "inline_header", to: :inline_header
-          map "obligation", to: :obligation
-          map "paragraphs", to: :paragraphs
-          map "unordered_lists", to: :unordered_lists
-          map "ordered_lists", to: :ordered_lists
-          map "tables", to: :tables
-          map "figures", to: :figures
-          map "formulas", to: :formulas
-          map "examples", to: :examples
-          map "notes", to: :notes
-          map "admonitions", to: :admonitions
-          map "sourcecode_blocks", to: :sourcecode_blocks
-          map "quote_blocks", to: :quote_blocks
-          map "definition_lists", to: :definition_lists
-          map "clause", to: :clause
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/sections/iso_foreword_section.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Sections
-      # Foreword section of an ISO/IEC document.
-      # Extends ContentSection (blocks + optional subsections) but maps to
-      # the "foreword" element. ISO foreword typically has no subsections.
-      class IsoForewordSection < Metanorma::StandardDocument::Sections::ContentSection
-        xml do
-          element "foreword"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
-          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_elements(self)
-        end
-
-        json do
-          map "id", to: :id
-          map "title", to: :title
-          map "paragraphs", to: :paragraphs
-          map "unordered_lists", to: :unordered_lists
-          map "ordered_lists", to: :ordered_lists
-          map "tables", to: :tables
-          map "figures", to: :figures
-          map "formulas", to: :formulas
-          map "examples", to: :examples
-          map "notes", to: :notes
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/sections/iso_preface.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Sections
-      # Prefatory clauses in an ISO/IEC document.
-      # Corresponds to isostandard.rng:
-      #   preface = element preface { abstract?, foreword, introduction? }
-      #
-      # This class deliberately does NOT inherit StandardDocument::Preface:
-      # lutaml-model deep-duplicates a parent's XML mappings into subclasses,
-      # so inheriting would keep the isodoc-level acknowledgements and
-      # executivesummary mappings that the ISO grammar forbids. Attributes
-      # are composed directly instead.
-      #
-      # The `clause` mapping is a documented extension required by real ISO
-      # presentation output, which emits front-matter clauses such as
-      # `<clause type="toc">` ahead of the foreword. `content` mirrors
-      # `clause` for the generic preface-content consumers (e.g. the mirror
-      # renderer), matching the runtime behavior of the previous inherited
-      # dual mapping.
-      class IsoPreface < Lutaml::Model::Serializable
-        attribute :abstract, IsoAbstractSection
-        attribute :foreword, IsoForewordSection
-        attribute :introduction, IsoClauseSection
-
-        # Presentation front-matter clauses (e.g. table of contents placeholder)
-        attribute :clause, IsoClauseSection, collection: true
-        attribute :content, Metanorma::StandardDocument::Sections::ContentSection,
-                  collection: true
-
-        # Presentation-specific attributes
-        attribute :semx_id, :string
-        attribute :displayorder, :integer
-
-        xml do
-          element "preface"
-          ordered
-
-          map_element "abstract",     to: :abstract
-          map_element "foreword",     to: :foreword
-          map_element "introduction", to: :introduction
-          map_element "clause",       to: :clause
-          map_element "clause",       to: :content
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_attributes(self)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/sections/iso_sections.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Sections
-      # Main body of ISO/IEC document.
-      # Extends StandardDocument::Sections with ISO strict ordering:
-      #   (note | admonition)*, clause, (term-clause | terms)?, definitions?,
-      #   (clause | term-clause | terms)+
-      class IsoSections < Metanorma::StandardDocument::Sections::Sections
-        # Notes applicable to the entire document (appearing before clauses)
-        attribute :note,
-                  Metanorma::Document::Components::Blocks::NoteBlock,
-                  collection: true
-
-        # Admonitions applicable to the entire document
-        attribute :admonition,
-                  Metanorma::Document::Components::MultiParagraph::AdmonitionBlock,
-                  collection: true
-
-        # Override: ISO terms is singular (zero or one), uses IsoTermsSection
-        attribute :terms, IsoTermsSection
-
-        # Override: ISO definitions is singular (zero or one)
-        attribute :definitions,
-                  Metanorma::StandardDocument::Sections::DefinitionSection
-
-        # Override: ISO clauses use IsoClauseSection
-        attribute :clause, IsoClauseSection, collection: true
-
-        # Initial paragraphs (document title repeated at start of sections)
-        attribute :p,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                  collection: true
-
-        xml do
-          element "sections"
-          ordered
-
-          map_element "note",         to: :note
-          map_element "admonition",   to: :admonition
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_elements(self)
-          map_element "p", to: :p
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
-        end
-      end
-    end
-  end
-end