metanorma-document 0.2.12 → 0.2.13

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

@@ -3,11 +3,41 @@
 module Metanorma
   module IsoDocument
     module Metadata
+      # Publication status of an ISO/IEC document.
+      # Stage element in presentation XML: <stage abbreviation="..." language="..." type="...">value</stage>
+      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
+
       class IsoDocumentStatus < Lutaml::Model::Serializable
+        # Publication stage of the ISO/IEC document, expressed as an International Harmonized Stage Code.
         attribute :stage, StageElement, collection: true
+
+        # Standard abbreviation of the publication stage.
         attribute :stage_abbreviation, :string
+
+        # Substage code for the ISO/IEC document.
         attribute :substage, IsoDocumentSubstageCodes
+
+        # Standard abbreviation of the publication substage.
         attribute :substage_abbreviation, :string
+
+        # Number of the iteration of the publication stage that the document is in.
         attribute :iteration, :integer
         attribute :semx_id, :string
 

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

@@ -32,9 +32,6 @@ module Metanorma
         attribute :title_amendment_prefix, AbstractTitle
         attribute :semx_id, :string
 
-        # Fallback for plain titles without structured parts
-        attribute :content, :string
-
         # Compose all parts into a single title string
         def to_s
           parts = []
@@ -53,7 +50,7 @@ module Metanorma
           end
           return parts.join(" — ") unless parts.empty?
 
-          content.to_s
+          ""
         end
       end
     end

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

@@ -3,6 +3,23 @@
 module Metanorma
   module IsoDocument
     module Metadata
+      # Project number with optional part attribute.
+      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
+
+      # Structured identifier for an ISO document (project number, part, etc).
       class StructuredIdentifier < Lutaml::Model::Serializable
         attribute :project_number, ProjectNumber
 

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

@@ -31,7 +31,6 @@ module Metanorma
               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

data/lib/metanorma/iso_document/metadata.rb

@@ -5,7 +5,6 @@ module Metanorma
     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"
@@ -22,14 +21,6 @@ module Metanorma
       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"
@@ -39,6 +30,10 @@ module Metanorma
       autoload :TitleAmendmentPrefix,
                "#{__dir__}/metadata/title_amendment_prefix"
       autoload :Ics, "#{__dir__}/metadata/ics"
+      autoload :StructuredIdentifier,
+               "#{__dir__}/metadata/structured_identifier"
+      autoload :ProjectNumber, "#{__dir__}/metadata/structured_identifier"
+      autoload :MetanormaExtension, "#{__dir__}/metadata/metanorma_extension"
     end
   end
 end

data/lib/metanorma/iso_document/terms/iso_term.rb

@@ -3,6 +3,19 @@
 module Metanorma
   module IsoDocument
     module Terms
+      # Domain element with id attribute.
+      class TermDomainElement < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :text, :string
+
+        xml do
+          element "domain"
+          map_attribute "id", to: :id
+          map_content to: :text
+        end
+      end
+
+      # Term subclause specific to ISO/IEC documents.
       class IsoTerm < Lutaml::Model::Serializable
         attribute :id, :string
         attribute :anchor, :string

data/lib/metanorma/iso_document/terms.rb

@@ -7,7 +7,6 @@ module Metanorma
                "#{__dir__}/terms/iso_term_collection"
       autoload :IsoTerm, "#{__dir__}/terms/iso_term"
       autoload :TermDesignation, "#{__dir__}/terms/term_designation"
-      autoload :TermDomainElement, "#{__dir__}/terms/term_domain_element"
       autoload :TermExpression, "#{__dir__}/terms/term_expression"
       autoload :TermDefinition, "#{__dir__}/terms/term_definition"
       autoload :VerbalDefinition, "#{__dir__}/terms/verbal_definition"

data/lib/metanorma/itu_document/metadata/itu_bib_data_extension_type.rb

@@ -3,6 +3,43 @@
 module Metanorma
   module ItuDocument
     module Metadata
+      # Study period element with start/end years.
+      class StudyPeriod < Lutaml::Model::Serializable
+        attribute :start, :string
+        attribute :end_year, :string
+
+        xml do
+          element "studyperiod"
+          map_element "start", to: :start
+          map_element "end", to: :end_year
+        end
+      end
+
+      # Meeting date with from/to children.
+      class MeetingDate < Lutaml::Model::Serializable
+        attribute :from, :string
+        attribute :to, :string
+
+        xml do
+          element "meeting-date"
+          map_element "from", to: :from
+          map_element "to", to: :to
+        end
+      end
+
+      # Meeting element with acronym attribute.
+      class MeetingElement < Lutaml::Model::Serializable
+        attribute :acronym, :string
+        attribute :text, :string
+
+        xml do
+          element "meeting"
+          map_attribute "acronym", to: :acronym
+          map_content to: :text
+        end
+      end
+
+      # Extension point for bibliographical definitions of ITU documents.
       class ItuBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
         attribute :structuredidentifier, ItuStructuredIdentifier
         attribute :ip_notice_received, :string

data/lib/metanorma/itu_document/metadata.rb

@@ -10,9 +10,10 @@ module Metanorma
       autoload :ItuSeries, "#{__dir__}/metadata/itu_series"
       autoload :ItuStructuredIdentifier,
                "#{__dir__}/metadata/itu_structured_identifier"
-      autoload :StudyPeriod, "#{__dir__}/metadata/study_period"
-      autoload :MeetingDate, "#{__dir__}/metadata/meeting_date"
-      autoload :MeetingElement, "#{__dir__}/metadata/meeting_element"
+      autoload :StudyPeriod, "#{__dir__}/metadata/itu_bib_data_extension_type"
+      autoload :MeetingDate, "#{__dir__}/metadata/itu_bib_data_extension_type"
+      autoload :MeetingElement,
+               "#{__dir__}/metadata/itu_bib_data_extension_type"
     end
   end
 end

data/lib/metanorma/standard_document/block_attributes.rb

@@ -52,13 +52,15 @@ module Metanorma
     end
 
     # Provides `blocks` method for ordered-content section types.
-    # Returns child block-level nodes in document order via `each_mixed_content`,
-    # excluding metadata/inline elements like titles and annotations.
+    # Returns child nodes in document order via `each_mixed_content`.
     module OrderedContent
-      NON_BLOCK_TYPES = [
+      # Section metadata mapped by SectionXmlMapping (title machinery
+      # and annotation markers) precedes the content alternation in
+      # the grammar — `blocks` answers content children only.
+      SECTION_METADATA_ELEMENTS = [
         Metanorma::Document::Components::Inline::TitleWithAnnotationElement,
-        Metanorma::Document::Components::Inline::FmtTitleElement,
         Metanorma::Document::Components::Inline::VariantTitleElement,
+        Metanorma::Document::Components::Inline::FmtTitleElement,
         Metanorma::Document::Components::Inline::FmtXrefLabelElement,
         Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
         Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
@@ -70,7 +72,9 @@ module Metanorma
             result = []
             each_mixed_content do |node|
               next if node.is_a?(String)
-              next if NON_BLOCK_TYPES.any? { |t| node.is_a?(t) }
+              next if SECTION_METADATA_ELEMENTS.any? do |klass|
+                node.is_a?(klass)
+              end
 
               result << node
             end

data/lib/metanorma/standard_document/blocks/block_source.rb

@@ -3,6 +3,29 @@
 module Metanorma
   module StandardDocument
     module Blocks
+      # Reference origin within a block source: <origin bibitemid="..." citeas="...">
+      # Schema: isodoc.rnc — origin = element origin { erefType | termref }
+      class SourceOriginElement < Lutaml::Model::Serializable
+        attribute :bibitemid, :string
+        attribute :type, :string
+        attribute :citeas, :string
+        attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
+                  collection: true
+
+        xml do
+          element "origin"
+          map_attribute "bibitemid", to: :bibitemid
+          map_attribute "type", to: :type
+          map_attribute "citeas", to: :citeas
+          map_element "localityStack", to: :locality_stack
+        end
+      end
+
+      # Bibliographic source for a block: <source status="..." type="...">
+      #   <origin bibitemid="..." citeas="..."/>
+      #   <modification>...</modification>?
+      # </source>
+      # Schema: isodoc.rnc BlockSource = source*
       class BlockSourceElement < Lutaml::Model::Serializable
         attribute :status, :string
         attribute :type, :string

data/lib/metanorma/standard_document/blocks.rb

@@ -6,7 +6,7 @@ module Metanorma
       autoload :AmendBlock, "#{__dir__}/blocks/amend_block"
       autoload :AmendContentBlock, "#{__dir__}/blocks/amend_content_block"
       autoload :BlockSourceElement, "#{__dir__}/blocks/block_source"
-      autoload :SourceOriginElement, "#{__dir__}/blocks/source_origin_element"
+      autoload :SourceOriginElement, "#{__dir__}/blocks/block_source"
       autoload :AutoNumber, "#{__dir__}/blocks/auto_number"
       autoload :ChangeType, "#{__dir__}/blocks/change_type"
       autoload :ElementName, "#{__dir__}/blocks/element_name"

data/lib/metanorma/standard_document/terms/term_expression.rb

@@ -3,6 +3,37 @@
 module Metanorma
   module StandardDocument
     module Terms
+      class TermNameElement < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :semx_id, :string
+        attribute :lang, :string
+        attribute :text, :string, collection: true
+        attribute :strike, Metanorma::Document::Components::TextElements::StrikeElement,
+                  collection: true
+        attribute :em, Metanorma::Document::Components::Inline::EmRawElement,
+                  collection: true
+        attribute :strong, Metanorma::Document::Components::Inline::StrongRawElement,
+                  collection: true
+        attribute :sup, Metanorma::Document::Components::Inline::SupElement,
+                  collection: true
+        attribute :sub, Metanorma::Document::Components::Inline::SubElement,
+                  collection: true
+
+        xml do
+          element "name"
+          map_attribute "id", to: :id
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "lang", to: :lang
+          mixed_content
+          map_content to: :text
+          map_element "strike", to: :strike
+          map_element "em", to: :em
+          map_element "strong", to: :strong
+          map_element "sup", to: :sup
+          map_element "sub", to: :sub
+        end
+      end
+
       class TermExpression < Lutaml::Model::Serializable
         attribute :name, TermNameElement, collection: true
         attribute :usage, :string

data/lib/metanorma/standard_document/terms.rb

@@ -23,7 +23,6 @@ module Metanorma
       autoload :TermCollection, "#{__dir__}/terms/term_collection"
       autoload :TermDefinition, "#{__dir__}/terms/term_definition"
       autoload :TermExpression, "#{__dir__}/terms/term_expression"
-      autoload :TermNameElement, "#{__dir__}/terms/term_name_element"
       autoload :TermSource, "#{__dir__}/terms/term_source"
       autoload :TermSourceStatus, "#{__dir__}/terms/term_source_status"
       autoload :TermSourceType, "#{__dir__}/terms/term_source_type"

data/metanorma-document.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/metanorma/document/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "metanorma-document"
+  spec.version       = Metanorma::Document::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "Library for Metanorma document XML"
+  spec.description   = "A Ruby library for representing and processing Metanorma document XML, providing a comprehensive model for standards documents with support for various metadata, content blocks, and structured markup."
+  spec.homepage      = "https://github.com/metanorma/metanorma-document"
+  spec.license       = "BSD-2-Clause"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/metanorma/metanorma-document"
+  spec.metadata["changelog_uri"] = "https://github.com/metanorma/metanorma-document/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:test|spec|features)/})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "lutaml-model", "~> 0.8.0"
+end