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

data/lib/metanorma/iso_document/blocks/iso_admonition_block.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Blocks
-      class IsoAdmonitionBlock < Lutaml::Model::Serializable
-        # Types of admonition specific to ISO/IEC.
-        attribute :type, :string
-        attribute :semx_id, :string
-        attribute :autonum, :string
-        attribute :fmt_name, :string
-        attribute :fmt_xref_label, :string
-        attribute :displayorder, :integer
-
-        xml do
-          element "admonition"
-          map_attribute "type", to: :type
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "autonum", to: :autonum
-          map_element "fmt-name", to: :fmt_name
-          map_element "fmt-xref-label", to: :fmt_xref_label
-          map_attribute "displayorder", to: :displayorder
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/blocks/iso_admonition_type.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Blocks
-      # Types of admonition specific to ISO/IEC.
-      class IsoAdmonitionType < Lutaml::Model::Serializable
-        attribute :value, :string
-        attribute :semx_id, :string
-        attribute :displayorder, :integer
-
-        def self.values
-          %w[danger caution warning important safetyPrecautions]
-        end
-
-        xml do
-          element "iso-admonition-type"
-          map_content to: :value
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "displayorder", to: :displayorder
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/iso_document/blocks.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Blocks
-      autoload :IsoAdmonitionBlock,
-               "#{__dir__}/blocks/iso_admonition_block"
-      autoload :IsoAdmonitionType,
-               "#{__dir__}/blocks/iso_admonition_type"
-    end
-  end
-end

data/lib/metanorma/iso_document/boilerplate.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    Boilerplate = Metanorma::StandardDocument::Boilerplate
-  end
-end

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Abstract base class for typed title elements.
-      # Subclasses correspond to different title types in ISO XML:
-      # - TitleFull: type="main"
-      # - TitleIntro: type="title-intro"
-      # - TitleMain: type="title-main"
-      # - TitlePart: type="title-part"
-      # - TitlePartPrefix: type="title-part-prefix"
-      class AbstractTitle < Lutaml::Model::Serializable
-        attribute :_type, :string
-        attribute :language, :string
-        attribute :format, :string
-        attribute :value, :string
-        attribute :semx_id, :string
-
-        xml do
-          map_attribute "language", to: :language
-          map_attribute "type", to: :_type
-          map_attribute "format", to: :format
-          map_content to: :value
-          map_attribute "semx-id", to: :semx_id
-        end
-
-        json do
-          map "_type", to: :_type
-          map "language", to: :language
-          map "value", to: :value
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Simple document identifier with type attribute and text content.
-      # Used for the multiple <docidentifier> elements in bibdata/bibitem.
-      class DocIdentifier < Lutaml::Model::Serializable
-        attribute :type, :string
-        attribute :primary, :boolean
-        attribute :scope, :string
-        attribute :language, :string
-        attribute :value, :string
-
-        xml do
-          element "docidentifier"
-          map_attribute "type", to: :type
-          map_attribute "primary", to: :primary
-          map_attribute "scope", to: :scope
-          map_attribute "language", to: :language
-          map_content to: :value
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      class DoctypeElement < Lutaml::Model::Serializable
-        attribute :language, :string
-        attribute :abbreviation, :string
-        attribute :value, :string
-
-        xml do
-          element "doctype"
-          map_attribute "language", to: :language, render_empty: true
-          map_attribute "abbreviation", to: :abbreviation
-          map_content to: :value
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # ICS (International Classification for Standards) code entry.
-      class Ics < Lutaml::Model::Serializable
-        attribute :code, :string
-        attribute :text, :string
-
-        xml do
-          element "ics"
-          map_element "code", to: :code
-          map_element "text", to: :text
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Categories of IEC standards document.
-      class IecDocumentCategory < Lutaml::Model::Serializable
-        attribute :value, :string
-        attribute :semx_id, :string
-
-        def self.values
-          %w[emc safety environment quality-assurance]
-        end
-
-        xml do
-          element "iec-document-category"
-          map_content to: :value
-          map_attribute "semx-id", to: :semx_id
-        end
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      class IsoBibDataExtensionType < Lutaml::Model::Serializable
-        attribute :horizontal, :boolean
-        attribute :editorial_group, IsoProjectGroup
-        attribute :stage_name, :string
-        attribute :category, :string
-        attribute :updates_document_type, :string
-        attribute :semx_id, :string
-        attribute :doctype, DoctypeElement, collection: true
-        attribute :flavor, :string
-        attribute :ics, Ics, collection: true
-        attribute :structuredidentifier, StructuredIdentifier
-        attribute :stagename, StagenameElement
-        attribute :subdoctype, :string
-
-        xml do
-          element "ext"
-          map_attribute "horizontal", to: :horizontal
-          map_element "editorial-group", to: :editorial_group
-          map_attribute "stage-name", to: :stage_name
-          map_attribute "category", to: :category
-          map_attribute "semx-id", to: :semx_id
-          map_element "doctype", to: :doctype
-          map_element "flavor", to: :flavor
-          map_element "ics", to: :ics
-          map_element "structuredidentifier", to: :structuredidentifier
-          map_element "stagename", to: :stagename
-          map_element "updates-document-type", to: :updates_document_type
-          map_element "subdoctype", to: :subdoctype
-        end
-      end
-    end
-  end
-end

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

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      class IsoBibliographicItem < Lutaml::Model::Serializable
-        attribute :doc_identifier, DocIdentifier, collection: true
-        attribute :titles, AbstractTitle, collection: TitleCollection
-        attribute :type, :string
-        attribute :fetched, Metanorma::Document::Relaton::DateTime
-        attribute :uri, Metanorma::Document::Relaton::TypedUri, collection: true
-        attribute :source, :string, collection: true
-        attribute :docnumber, :string
-        attribute :contributor, Metanorma::Document::Relaton::ContributionInfo,
-                  collection: true
-        attribute :edition, Metanorma::Document::Relaton::Edition,
-                  collection: true
-        attribute :version, Metanorma::Document::Relaton::VersionInfo
-        attribute :note, Metanorma::Document::Relaton::TypedNote,
-                  collection: true
-        attribute :language, LanguageElement, collection: true
-        attribute :script, ScriptElement, collection: true
-        attribute :abstract, Metanorma::Document::Components::DataTypes::FormattedString,
-                  collection: true
-        attribute :status, IsoDocumentStatus
-        attribute :copyright, Metanorma::Document::Relaton::CopyrightAssociation,
-                  collection: true
-        attribute :relation, Metanorma::Document::Relaton::DocumentRelation,
-                  collection: true
-        attribute :formattedref, Metanorma::Document::Components::DataTypes::FormattedString
-        attribute :date, Metanorma::Document::Relaton::BibliographicDate,
-                  collection: true
-        attribute :place, :string, collection: true
-        attribute :ext, IsoBibDataExtensionType
-        attribute :keyword, Metanorma::Document::Relaton::KeywordType,
-                  collection: true
-        attribute :series, Metanorma::Document::Relaton::SeriesType,
-                  collection: true
-        attribute :editorialgroup, Metanorma::StandardDocument::Metadata::EditorialGroupType
-        attribute :semx_id, :string
-        attribute :schema_version, :string
-
-        xml do
-          element "bibdata"
-          ordered
-          map_attribute "type", to: :type
-          map_attribute "schema-version", to: :schema_version
-          map_element "fetched", to: :fetched
-          map_element "title", to: :titles
-          map_element "uri", to: :uri
-          map_element "link", to: :source
-          map_element "docidentifier", to: :doc_identifier
-          map_element "docnumber", to: :docnumber
-          map_element "contributor", to: :contributor
-          map_element "edition", to: :edition
-          map_element "version", to: :version
-          map_element "note", to: :note
-          map_element "language", to: :language
-          map_element "script", to: :script
-          map_element "abstract", to: :abstract
-          map_element "status", to: :status
-          map_element "copyright", to: :copyright
-          map_element "relation", to: :relation
-          map_element "formattedref", to: :formattedref
-          map_element "date", to: :date
-          map_element "place", to: :place
-          map_element "ext", to: :ext
-          map_element "keyword", to: :keyword
-          map_element "series", to: :series
-          map_element "editorial-group", to: :editorialgroup
-          map_attribute "semx-id", to: :semx_id
-        end
-
-        json do
-          map "doc_identifier", to: :doc_identifier
-          map "titles", to: :titles
-          map "type", to: :type
-          map "status", to: :status
-          map "source", to: :source
-          map "abstract", to: :abstract
-          map "ext", to: :ext
-        end
-
-        def title_for(language = "en")
-          return nil unless titles
-
-          if titles.is_a?(TitleCollection)
-            titles.for_language(language)
-          elsif titles.is_a?(Array)
-            titles.find do |t|
-              lang = safe_attr(t, :language) || safe_attr(t, :lang)
-              lang == language
-            end
-          end
-        end
-
-        def title
-          @title ||= title_for("en")
-        end
-      end
-    end
-  end
-end

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Representation of the identifier for an ISO/IEC document, giving its individual semantic components.
-      class IsoDocumentId < Lutaml::Model::Serializable
-        # N-numbers assigned to the document by technical committees.
-        attribute :tc_document_number, :integer, collection: true
-
-        # Numerical component uniquely identifying the document.
-        attribute :project_number, :integer
-
-        # Representation in the identifier of the document part, if this is a document part.
-        attribute :part_number, :integer
-
-        # Representation in the identifier of the document subpart, if this is a document subpart.
-        # Only applicable to IEC documents.
-        attribute :subpart_number, :integer
-
-        # Representation in the identifier of the type of document amendment, if this is a document amendment.
-        attribute :amendment_number, :integer
-
-        # Representation in the identifier of the type of document technical corrigendum, if this is a
-        # document technical corrigendum.
-        attribute :corrigendum_number, :integer
-
-        # Year of publication of the document in its current version or edition.
-        attribute :originalyear, :integer
-        attribute :semx_id, :string
-
-        xml do
-          element "docidentifier"
-          map_element "tc-document-number", to: :tc_document_number
-          map_element "project-number", to: :project_number
-          map_element "part-number", to: :part_number
-          map_element "subpart-number", to: :subpart_number
-          map_element "amendment-number", to: :amendment_number
-          map_element "corrigendum-number", to: :corrigendum_number
-          map_element "originalyear", to: :originalyear
-          map_attribute "semx-id", to: :semx_id
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Stage-level code in the International Harmonized Stage Codes
-      # used by ISO/IEC for their documents.
-      #
-      # NOTE: See https://www.iso.org/stage-codes.html
-      class IsoDocumentStageCodes < Lutaml::Model::Serializable
-        attribute :value, :string
-        attribute :semx_id, :string
-
-        def self.values
-          %w[00 10 20 30 40 50 60 90 95]
-        end
-
-        xml do
-          element "iso-document-stage-codes"
-          map_content to: :value
-          map_attribute "semx-id", to: :semx_id
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      class IsoDocumentStatus < Lutaml::Model::Serializable
-        attribute :stage, StageElement, collection: true
-        attribute :stage_abbreviation, :string
-        attribute :substage, IsoDocumentSubstageCodes
-        attribute :substage_abbreviation, :string
-        attribute :iteration, :integer
-        attribute :semx_id, :string
-
-        xml do
-          element "status"
-          map_element "stage", to: :stage
-          map_element "stage-abbreviation", to: :stage_abbreviation
-          map_element "substage", to: :substage
-          map_element "substage-abbreviation", to: :substage_abbreviation
-          map_element "iteration", to: :iteration
-          map_attribute "semx-id", to: :semx_id
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Substage-level code in the International Harmonized Stage Codes.
-      # These codes are used by ISO and IEC to indicate development stage.
-      #
-      # NOTE: See https://www.iso.org/stage-codes.html for the full list.
-      class IsoDocumentSubstageCodes < Lutaml::Model::Serializable
-        attribute :value, :string
-        attribute :semx_id, :string
-
-        def self.values
-          %w[00 20 60 90 92 93 98 99]
-        end
-
-        xml do
-          element "iso-document-substage-codes"
-          map_content to: :value
-          map_attribute "semx-id", to: :semx_id
-        end
-      end
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Type of ISO/IEC document.
-      class IsoDocumentType < Lutaml::Model::Serializable
-        attribute :value, :string
-        attribute :semx_id, :string
-
-        def self.values
-          %w[internationalStandard technicalSpecification technicalReport
-             publiclyAvailableSpecification internationalWorkshopAgreement guide
-             interpretationSheet amendment technical-corrigendum]
-        end
-
-        xml do
-          element "iso-document-type"
-          map_content to: :value
-          map_attribute "semx-id", to: :semx_id
-        end
-      end
-    end
-  end
-end

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

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Title of ISO/IEC document for a single language.
-      # Groups all title parts (title_intro, title_main, title_part, etc.) for one language.
-      # This is the GroupClass used by TitleCollection's consolidation mapping.
-      class IsoLocalizedTitle < Lutaml::Model::Serializable
-        # Language code (en, fr, ru, etc.)
-        attribute :language, :string
-
-        # Full title (type="main")
-        attribute :title_full, AbstractTitle
-
-        # Introductory component of title.
-        attribute :title_intro, AbstractTitle
-
-        # Main component of title.
-        attribute :title_main, AbstractTitle
-
-        # Title of document part, if applicable.
-        attribute :title_part, AbstractTitle
-
-        # Title part prefix (e.g., "Part 1")
-        attribute :title_part_prefix, AbstractTitle
-
-        # Amendment description text
-        attribute :title_amd, AbstractTitle
-
-        # Amendment prefix (e.g., "AMENDMENT 1")
-        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 = []
-          parts << title_intro&.value if title_intro
-          parts << title_main&.value if title_main
-          parts << title_full&.value if title_full && !title_main
-          if title_part
-            prefix = title_part_prefix&.value.to_s.strip
-            part_val = title_part.value
-            if prefix.empty?
-              parts << part_val
-            else
-              sep = prefix.end_with?(":") ? " " : ": "
-              parts << "#{prefix}#{sep}#{part_val}"
-            end
-          end
-          return parts.join(" — ") unless parts.empty?
-
-          content.to_s
-        end
-      end
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Editorial groups associated with the production of an ISO/IEC document.
-      class IsoProjectGroup < Lutaml::Model::Serializable
-        # Technical committees.
-        attribute :technical_committee, IsoSubGroup, collection: true
-
-        # Subcommittees.
-        attribute :subcommittee, IsoSubGroup, collection: true
-
-        # Workgroups.
-        attribute :workgroup, IsoSubGroup, collection: true
-
-        # Secretariat.
-        attribute :secretariat, :string
-        attribute :semx_id, :string
-
-        xml do
-          element "editorial-group"
-          map_element "technical-committee", to: :technical_committee
-          map_element "subcommittee", to: :subcommittee
-          map_element "workgroup", to: :workgroup
-          map_attribute "secretariat", to: :secretariat
-          map_attribute "semx-id", to: :semx_id
-        end
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      # Editorial group set up in ISO or IEC to work on producing documents.
-      class IsoSubGroup < Lutaml::Model::Serializable
-        # Type of editorial group.
-        attribute :type, :string
-
-        # Number used to identify editorial group.
-        attribute :number, :integer
-
-        # Prefix used to differentiate editorial group for others of its class.
-        attribute :prefix, :string
-
-        # Full identifier used to identify editorial group.
-        attribute :identifier, :string
-
-        # Name of editorial group.
-        attribute :name, :string
-        attribute :semx_id, :string
-        attribute :text, :string
-
-        xml do
-          element "subgroup"
-          map_attribute "type", to: :type
-          map_attribute "number", to: :number
-          map_attribute "prefix", to: :prefix
-          map_attribute "identifier", to: :identifier
-          map_attribute "name", to: :name
-          map_attribute "semx-id", to: :semx_id
-          map_content to: :text
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module IsoDocument
-    module Metadata
-      MetanormaExtension = Metanorma::StandardDocument::Metadata::MetanormaExtension
-    end
-  end
-end