metanorma-document 0.2.5 → 0.2.7

data/lib/metanorma/document/components/contrib_metadata/contribution_element_metadata.rb

@@ -8,7 +8,9 @@ module Metanorma
         class ContributionElementMetadata < Lutaml::Model::Serializable
           attribute :date_time, :string
           attribute :contributor, Metanorma::Document::Relaton::Contributor
-          attribute :integrity_value, BasicObject, collection: true
+          attribute :integrity_value,
+                    Metanorma::Document::Components::ContribMetadata::IntegrityValue,
+                    collection: true
 
           xml do
             element "contribution-element-metadata"

data/lib/metanorma/document/components/id_elements/image.rb

@@ -8,12 +8,14 @@ module Metanorma
         class Image < Media
           attribute :height, :string
           attribute :width, :string
+          attribute :align, :string
           attribute :semx_id, :string
 
           xml do
             element "image"
             map_attribute "height", to: :height, render_empty: true
             map_attribute "width", to: :width, render_empty: true
+            map_attribute "align", to: :align
             map_attribute "semx-id", to: :semx_id
           end
         end

data/lib/metanorma/document/components/inline/xref_element.rb

@@ -7,6 +7,10 @@ module Metanorma
           attribute :target, :string
           attribute :style, :string
           attribute :format, :string
+          attribute :pagenumber, :string
+          attribute :nosee, :string
+          attribute :nopage, :string
+          attribute :alt, :string
           attribute :text, :string, collection: true
 
           xml do
@@ -15,6 +19,10 @@ module Metanorma
             map_attribute "target", to: :target
             map_attribute "style", to: :style
             map_attribute "format", to: :format
+            map_attribute "pagenumber", to: :pagenumber
+            map_attribute "nosee", to: :nosee
+            map_attribute "nopage", to: :nopage
+            map_attribute "alt", to: :alt
             map_content to: :text
           end
         end

data/lib/metanorma/document/components/lists/definition_list.rb

@@ -9,6 +9,9 @@ module Metanorma
           attribute :id, :string
           attribute :semx_id, :string
           attribute :key, :string
+          attribute :newline, :string
+          attribute :indent, :string
+          attribute :spacing, :string
           attribute :name, Metanorma::Document::Components::Inline::NameWithIdElement
           attribute :dt, DtElement, collection: true
           attribute :dd, DdElement, collection: true
@@ -32,6 +35,9 @@ module Metanorma
             map_attribute "id", to: :id
             map_attribute "semx-id", to: :semx_id
             map_attribute "key", to: :key
+            map_attribute "newline", to: :newline
+            map_attribute "indent", to: :indent
+            map_attribute "spacing", to: :spacing
             map_element "name", to: :name
             map_element "dt", to: :dt
             map_element "dd", to: :dd

data/lib/metanorma/document/components/lists/list_item.rb

@@ -92,7 +92,7 @@ module Metanorma
             end
 
             text&.filter_map do |t|
-              t.respond_to?(:text) ? t.text : t.to_s
+              t.is_a?(String) ? t : t.text
             end&.join
           end
         end

data/lib/metanorma/document/components/lists/ordered_list.rb

@@ -13,6 +13,9 @@ module Metanorma
           attribute :display, :string
           attribute :display_directives, :string
           attribute :class_attr, :string
+          attribute :group, :string
+          attribute :spacing, :string
+          attribute :indent, :string
 
           def json_type
             "ol"
@@ -34,6 +37,9 @@ module Metanorma
             map_attribute "display-directives", to: :display_directives
             map_attribute "class", to: :class_attr, render_empty: true
             map_attribute "start", to: :start
+            map_attribute "group", to: :group
+            map_attribute "spacing", to: :spacing
+            map_attribute "indent", to: :indent
           end
         end
       end

data/lib/metanorma/document/components/lists/unordered_list.rb

@@ -9,6 +9,10 @@ module Metanorma
           attribute :id, :string
           attribute :semx_id, :string
           attribute :original_id, :string
+          attribute :nobullet, :string
+          attribute :spacing, :string
+          attribute :indent, :string
+          attribute :bare, :string
           attribute :json_type, :string
 
           def json_type
@@ -26,6 +30,10 @@ module Metanorma
             map_attribute "id", to: :id
             map_attribute "semx-id", to: :semx_id
             map_attribute "original-id", to: :original_id
+            map_attribute "nobullet", to: :nobullet
+            map_attribute "spacing", to: :spacing
+            map_attribute "indent", to: :indent
+            map_attribute "bare", to: :bare
           end
         end
       end

data/lib/metanorma/document/components/multi_paragraph/admonition_block.rb

@@ -24,6 +24,12 @@ module Metanorma
           # Location where the content of the admonition is accessible as an external document.
           attribute :uri, :string
 
+          # Target cross-reference for the admonition (BSI).
+          attribute :target, :string
+
+          # Whether the admonition is excluded from automatic numbering (UN).
+          attribute :unnumbered, :string
+
           # Paragraphs within the admonition.
           attribute :paragraphs,
                     Metanorma::Document::Components::Paragraphs::ParagraphBlock,
@@ -51,6 +57,8 @@ module Metanorma
             map_attribute "type", to: :type
             map_element "name", to: :name
             map_attribute "class", to: :block_class
+            map_attribute "target", to: :target
+            map_attribute "unnumbered", to: :unnumbered
             map_element "uri", to: :uri
             map_element "p", to: :paragraphs
             map_element "fmt-name", to: :fmt_name

data/lib/metanorma/document/components/multi_paragraph/review_block.rb

@@ -20,12 +20,15 @@ module Metanorma
           # Identifier for the end of the text to which the comment applies.
           attribute :applies_to, :string
 
+          attribute :display, :string
+
           xml do
             element "review"
             map_attribute "reviewer", to: :reviewer
             map_attribute "date", to: :date
             map_attribute "from", to: :applies_from
             map_attribute "to", to: :applies_to
+            map_attribute "display", to: :display
           end
         end
       end

data/lib/metanorma/document/components/paragraphs/paragraph_block.rb

@@ -12,6 +12,8 @@ module Metanorma
           attribute :semx_id, :string
           attribute :original_id, :string
           attribute :keep_with_next, :string
+          attribute :keep_with_previous, :string
+          attribute :indent, :string
           attribute :class_attr, :string
           attribute :type_attr, :string
           attribute :displayorder, :integer
@@ -75,9 +77,9 @@ module Metanorma
                     collection: true
           attribute :image, Metanorma::Document::Components::IdElements::Image,
                     collection: true
-          attribute :add, "Metanorma::StandardDocument::Elements::Add",
+          attribute :add, "Metanorma::Document::Elements::Add",
                     collection: true
-          attribute :del, "Metanorma::StandardDocument::Elements::Del",
+          attribute :del, "Metanorma::Document::Elements::Del",
                     collection: true
 
           # JSON serialization attributes
@@ -99,6 +101,8 @@ module Metanorma
             map_attribute "semx-id", to: :semx_id
             map_attribute "original-id", to: :original_id
             map_attribute "keep-with-next", to: :keep_with_next
+            map_attribute "keep-with-previous", to: :keep_with_previous
+            map_attribute "indent", to: :indent
             map_attribute "class", to: :class_attr
             map_attribute "type", to: :type_attr
             map_attribute "displayorder", to: :displayorder

data/lib/metanorma/document/components/reference_elements/source_element.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        class SourceOrigin < Lutaml::Model::Serializable
+          attribute :bibitemid, :string
+          attribute :type, :string
+          attribute :citeas, :string
+          attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
+                    collection: true
+          attribute :display_text,
+                    Metanorma::Document::Components::Inline::DisplayTextElement
+
+          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
+            map_element "display-text", to: :display_text
+          end
+        end
+
+        class SourceModification < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+
+          xml do
+            element "modification"
+            map_attribute "id", to: :id
+            map_element "p", to: :p
+          end
+        end
+
+        class SourceElement < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :status, :string
+          attribute :type, :string
+          attribute :origin, SourceOrigin
+          attribute :modification, SourceModification
+
+          xml do
+            element "source"
+            map_attribute "id", to: :id
+            map_attribute "status", to: :status
+            map_attribute "type", to: :type
+            map_element "origin", to: :origin
+            map_element "modification", to: :modification
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/reference_elements.rb

@@ -21,6 +21,12 @@ module Metanorma
                  "#{__dir__}/reference_elements/reference_to_id_with_paragraph_element"
         autoload :ReferenceToLinkElement,
                  "#{__dir__}/reference_elements/reference_to_link_element"
+        autoload :SourceElement,
+                 "#{__dir__}/reference_elements/source_element"
+        autoload :SourceModification,
+                 "#{__dir__}/reference_elements/source_element"
+        autoload :SourceOrigin,
+                 "#{__dir__}/reference_elements/source_element"
       end
     end
   end

data/lib/metanorma/document/components/sections/references_section.rb

@@ -10,7 +10,7 @@ module Metanorma
           attribute :references, Metanorma::Document::Components::BibData::BibliographicItem,
                     collection: true
 
-          attribute :passthrough, Metanorma::StandardDocument::Blocks::Passthrough,
+          attribute :passthrough, Metanorma::Document::Components::Blocks::Passthrough,
                     collection: true
 
           xml do

data/lib/metanorma/document/components/tables/table_block.rb

@@ -44,6 +44,12 @@ module Metanorma
                     collection: true
           attribute :dl, Metanorma::Document::Components::Lists::DefinitionList
           attribute :key, Metanorma::Document::Components::AncillaryBlocks::KeyElement
+          attribute :example,
+                    Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
+                    collection: true
+          attribute :sourcecode,
+                    Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock,
+                    collection: true
           attribute :colgroup, ColGroupElement
 
           # Presentation-specific elements
@@ -54,6 +60,7 @@ module Metanorma
                     collection: true
 
           attribute :width, :string
+          attribute :align, :string
           attribute :json_type, :string
 
           def json_type
@@ -78,6 +85,7 @@ module Metanorma
             map_attribute "summary", to: :summary
             map_attribute "uri", to: :uri
             map_attribute "width", to: :width
+            map_attribute "align", to: :align
             map_attribute "semx-id", to: :semx_id
             map_attribute "autonum", to: :autonum
             map_attribute "displayorder", to: :displayorder
@@ -88,6 +96,8 @@ module Metanorma
             map_element "dl", to: :dl
             map_element "colgroup", to: :colgroup
             map_element "key", to: :key
+            map_element "example", to: :example
+            map_element "sourcecode", to: :sourcecode
             map_element "fmt-name", to: :fmt_name
             map_element "fmt-xref-label", to: :fmt_xref_label
             map_element "fmt-footnote-container", to: :fmt_footnote_container

data/lib/metanorma/document/components/tables/table_cell.rb

@@ -61,7 +61,8 @@ module Metanorma
                     collection: true
           attribute :sourcecode, "Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock",
                     collection: true
-          attribute :source, "Metanorma::IsoDocument::Terms::TermSource",
+          attribute :source,
+                    Metanorma::Document::Components::ReferenceElements::SourceElement,
                     collection: true
 
           # Nested tables (table inside td/th)

data/lib/metanorma/document/data_types.rb

@@ -1,11 +1,7 @@
 # frozen_string_literal: true
 
-# Redirect to Components::DataTypes for backwards compatibility
-require "metanorma/document/components/data_types"
-
 module Metanorma
   module Document
-    # @deprecated Use {Components::DataTypes} instead
     DataTypes = Metanorma::Document::Components::DataTypes
   end
 end

data/lib/metanorma/document/elements/add.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Elements
+      class Add < Metanorma::Document::Components::TextElements::TextElement
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        xml do
+          element "add"
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/elements/del.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Elements
+      class Del < Metanorma::Document::Components::TextElements::TextElement
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        xml do
+          element "del"
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/elements.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Elements
+      autoload :Add, "#{__dir__}/elements/add"
+      autoload :Del, "#{__dir__}/elements/del"
+    end
+  end
+end

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

@@ -6,10 +6,26 @@ module Metanorma
       # Model for formattedAddress element which may contain mixed content with <br/> tags.
       class FormattedAddress < Lutaml::Model::Serializable
         attribute :content, :string, collection: true
+        attribute :br, Metanorma::Document::Components::Inline::BrElement,
+                  collection: true
 
         xml do
           element "formattedAddress"
+          mixed_content
           map_content to: :content
+          map_element "br", to: :br
+        end
+
+        # Construct a FormattedAddress from an array of text lines,
+        # inserting <br/> elements between them for proper mixed-content
+        # serialization.
+        def self.from_lines(lines)
+          new.tap do |fa|
+            fa.content = lines
+            fa.br = lines[1..].map do
+              Metanorma::Document::Components::Inline::BrElement.new
+            end
+          end
         end
       end
 

data/lib/metanorma/document/root.rb

@@ -1,11 +1,9 @@
 # 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.
+    # All document types inherit from this.
     class Root < Lutaml::Model::Serializable
       attribute :autonum, :string
       attribute :fmt_xref_label, :string

data/lib/metanorma/document/version.rb

@@ -2,7 +2,7 @@
 
 module Metanorma
   module Document
-    VERSION = "0.2.5"
+    VERSION = "0.2.7"
     Version = VERSION
   end
 end

data/lib/metanorma/document.rb

@@ -17,6 +17,7 @@ module Metanorma
   module Document
     autoload :Components, "metanorma/document/components"
     autoload :DataTypes, "metanorma/document/data_types"
+    autoload :Elements, "metanorma/document/elements"
     autoload :Relaton, "metanorma/document/relaton"
     autoload :Root, "metanorma/document/root"
     autoload :Version, "metanorma/document/version"
@@ -40,15 +41,23 @@ module Metanorma
   autoload :IsoDocument, "metanorma/iso_document"
   autoload :IecDocument, "metanorma/iec_document"
   autoload :IeeeDocument, "metanorma/ieee_document"
+  autoload :IetfDocument, "metanorma/ietf_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 :BsiDocument, "metanorma/bsi_document"
+  autoload :GbDocument, "metanorma/gb_document"
+  autoload :GenericDocument, "metanorma/generic_document"
   autoload :ItuDocument, "metanorma/itu_document"
+  autoload :JisDocument, "metanorma/jis_document"
+  autoload :M3dDocument, "metanorma/m3d_document"
+  autoload :NistDocument, "metanorma/nist_document"
   autoload :OgcDocument, "metanorma/ogc_document"
+  autoload :PlateauDocument, "metanorma/plateau_document"
+  autoload :Registers, "metanorma/registers"
   autoload :RiboseDocument, "metanorma/ribose_document"
-  autoload :IetfDocument, "metanorma/ietf_document"
+  autoload :UnDocument, "metanorma/un_document"
   autoload :Collection, "metanorma/collection"
   autoload :Html, "metanorma/html"
 end

data/lib/metanorma/gb_document/metadata/gb_bib_data_extension_type.rb

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

data/lib/metanorma/gb_document/metadata/gb_bibliographic_item.rb

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

data/lib/metanorma/gb_document/metadata.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module GbDocument
+    module Metadata
+      autoload :GbBibDataExtensionType,
+               "#{__dir__}/metadata/gb_bib_data_extension_type"
+      autoload :GbBibliographicItem,
+               "#{__dir__}/metadata/gb_bibliographic_item"
+    end
+  end
+end

data/lib/metanorma/gb_document/root.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module GbDocument
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      def self.lutaml_default_register
+        :gb_document
+      end
+
+      attribute :bibdata, Metadata::GbBibliographicItem
+      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/gb_document.rb

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

data/lib/metanorma/generic_document/root.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module GenericDocument
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
+
+      attribute :bibdata,
+                Metanorma::StandardDocument::Metadata::StandardBibData
+      attribute :preface,
+                Metanorma::StandardDocument::Sections::Preface
+      attribute :sections,
+                Metanorma::StandardDocument::Sections::Sections,
+                collection: true
+      attribute :annex,
+                Metanorma::StandardDocument::Sections::AnnexSection,
+                collection: true
+      attribute :misccontainer,
+                Metanorma::StandardDocument::Sections::MiscContainer
+
+      xml do
+        element "metanorma"
+        namespace Metanorma::StandardDocument::Namespace
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
+
+        map_element "misc-container", to: :misccontainer
+      end
+    end
+  end
+end

data/lib/metanorma/generic_document.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module GenericDocument
+    autoload :Root, "metanorma/generic_document/root"
+  end
+end