metanorma-document 0.2.6 → 0.2.8

data/lib/metanorma/bsi_document/root.rb

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

data/lib/metanorma/bsi_document/sections/bsi_annex_section.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BsiDocument
+    module Sections
+      class BsiAnnexSection < Metanorma::IsoDocument::Sections::IsoAnnexSection
+        attribute :clause, BsiClauseSection, collection: true
+
+        attribute :floating_section_title,
+                  Metanorma::StandardDocument::Sections::FloatingSectionTitle,
+                  collection: true
+
+        xml do
+          element "annex"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_attributes(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_elements(self)
+
+          map_element "section-title", to: :floating_section_title
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/bsi_document/sections/bsi_clause_section.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BsiDocument
+    module Sections
+      class BsiClauseSection < Metanorma::IsoDocument::Sections::IsoClauseSection
+        attribute :clause, BsiClauseSection, collection: true
+
+        attribute :floating_section_title,
+                  Metanorma::StandardDocument::Sections::FloatingSectionTitle,
+                  collection: true
+
+        xml do
+          element "clause"
+          ordered
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_attributes(self)
+          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_elements(self)
+
+          map_element "section-title", to: :floating_section_title
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/bsi_document/sections/bsi_sections.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BsiDocument
+    module Sections
+      class BsiSections < Metanorma::IsoDocument::Sections::IsoSections
+        attribute :floating_section_title,
+                  Metanorma::StandardDocument::Sections::FloatingSectionTitle,
+                  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
+          map_element "section-title",  to: :floating_section_title
+
+          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/bsi_document/sections.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BsiDocument
+    module Sections
+      autoload :BsiAnnexSection, "#{__dir__}/sections/bsi_annex_section"
+      autoload :BsiClauseSection, "#{__dir__}/sections/bsi_clause_section"
+      autoload :BsiSections, "#{__dir__}/sections/bsi_sections"
+    end
+  end
+end

data/lib/metanorma/bsi_document.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BsiDocument
+    autoload :Metadata, "metanorma/bsi_document/metadata"
+    autoload :Root, "metanorma/bsi_document/root"
+    autoload :Sections, "metanorma/bsi_document/sections"
+  end
+end
+
+Metanorma::Registers::Setup.setup_bsi_register

data/lib/metanorma/cc_document/root.rb

@@ -1,64 +1,24 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-require "metanorma/iso_document"
-
 module Metanorma
   module CcDocument
-    class Root < Metanorma::StandardDocument::Root
-      attribute :version, :string
-      attribute :type, :string
-      attribute :schema_version, :string
-      attribute :flavor, :string
+    class Root < Lutaml::Model::Serializable
+      include Metanorma::StandardDocument::RootAttributes
 
       attribute :bibdata, Metadata::CcBibliographicItem
-
-      attribute :term_sources,
-                Metanorma::Document::Components::ReferenceElements::Citation,
+      attribute :preface,
+                Metanorma::StandardDocument::Sections::Preface
+      attribute :sections,
+                Metanorma::StandardDocument::Sections::Sections
+      attribute :annex,
+                Metanorma::StandardDocument::Sections::AnnexSection,
                 collection: true
 
-      attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
-      attribute :sections, Metanorma::IsoDocument::Sections::IsoSections
-      attribute :annex, Metanorma::IsoDocument::Sections::IsoAnnexSection,
-                collection: true
-      attribute :bibliography,
-                Metanorma::StandardDocument::Sections::BibliographySection
-      attribute :boilerplate, Metanorma::IsoDocument::Boilerplate
-      attribute :metanorma_extension,
-                Metanorma::IsoDocument::Metadata::MetanormaExtension
-      attribute :annotation_container, Metanorma::IsoDocument::AnnotationContainer
-      attribute :indexsect,
-                Metanorma::Document::Components::Sections::BasicSection
-      attribute :autonum, :string
-      attribute :fmt_xref_label, :string
-      attribute :localized_strings,
-                Metanorma::Document::Components::Inline::LocalizedStringsElement
-      attribute :fmt_footnote_container,
-                Metanorma::Document::Components::Inline::FmtFootnoteContainerElement
-      attribute :colophon, Metanorma::IsoDocument::Sections::Colophon
-
       xml do
         element "metanorma"
         namespace Metanorma::StandardDocument::Namespace
-        map_attribute "type", to: :type
-        map_attribute "version", to: :version
-        map_attribute "schema-version", to: :schema_version
-        map_attribute "flavor", to: :flavor
-        map_element "bibdata", to: :bibdata
-        map_element "termdocsource", to: :term_sources
-        map_element "metanorma-extension", to: :metanorma_extension
-        map_element "boilerplate", to: :boilerplate
-        map_element "preface", to: :preface
-        map_element "sections", to: :sections
-        map_element "annex", to: :annex
-        map_element "bibliography", to: :bibliography
-        map_element "annotation-container", to: :annotation_container
-        map_element "indexsect", to: :indexsect
-        map_element "localized-strings", to: :localized_strings
-        map_element "fmt-footnote-container", to: :fmt_footnote_container
-        map_element "colophon", to: :colophon
-        map_attribute "autonum", to: :autonum
-        map_attribute "fmt-xref-label", to: :fmt_xref_label
+
+        Metanorma::StandardDocument::RootXmlMapping.apply(self)
       end
     end
   end

data/lib/metanorma/cc_document.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "metanorma/standard_document"
-
 module Metanorma
   module CcDocument
     autoload :Metadata, "metanorma/cc_document/metadata"

data/lib/metanorma/collection.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "metanorma/iso_document"
-
 module Metanorma
   module Collection
     autoload :Root, "metanorma/collection/root"

data/lib/metanorma/document/components/ancillary_blocks/example_block.rb

@@ -59,11 +59,11 @@ module Metanorma
                     collection: true
 
           # Requirement/recommendation/permission blocks inside examples.
-          attribute :requirement, "Metanorma::StandardDocument::Blocks::RequirementModel",
+          attribute :requirement, "Metanorma::Document::Components::Blocks::RequirementModel",
                     collection: true
-          attribute :recommendation, "Metanorma::StandardDocument::Blocks::RecommendationModel",
+          attribute :recommendation, "Metanorma::Document::Components::Blocks::RecommendationModel",
                     collection: true
-          attribute :permission, "Metanorma::StandardDocument::Blocks::PermissionModel",
+          attribute :permission, "Metanorma::Document::Components::Blocks::PermissionModel",
                     collection: true
 
           # Paragraph blocks contributing to example content.

data/lib/metanorma/document/components/ancillary_blocks/figure_block.rb

@@ -31,6 +31,7 @@ module Metanorma
           attribute :displayorder, :integer
           attribute :height, :string
           attribute :width, :string
+          attribute :align, :string
 
           # The image file to be included in the figure as its main content.
           attribute :image, Metanorma::Document::Components::IdElements::Image
@@ -89,6 +90,7 @@ module Metanorma
             map_attribute "displayorder", to: :displayorder
             map_attribute "height", to: :height
             map_attribute "width", to: :width, render_empty: true
+            map_attribute "align", to: :align
             map_attribute "source", to: :source
             map_attribute "unnumbered", to: :unnumbered
             map_attribute "subsequence", to: :subsequence

data/lib/metanorma/document/components/ancillary_blocks/sourcecode_block.rb

@@ -61,6 +61,7 @@ module Metanorma
 
           # Whether callout markers are displayed
           attribute :markers, :string
+          attribute :alt, :string
 
           # The computer code or other such text presented in the block, as a single unformatted string. (The
           # string should be treated as pre-formatted text, with whitespace treated as significant.)
@@ -109,6 +110,7 @@ module Metanorma
             map_attribute "filename", to: :filename
             map_attribute "lang", to: :lang
             map_attribute "markers", to: :markers
+            map_attribute "alt", to: :alt
             map_content to: :content
             map_element "body", to: :body
             map_element "callout", to: :callouts

data/lib/metanorma/document/components/blocks/passthrough.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        class Passthrough < BasicBlockNoNotes
+          attribute :formats, :string
+          attribute :content, :string
+
+          xml do
+            element "passthrough"
+            map_attribute "id", to: :id
+            map_attribute "formats", to: :formats
+            map_content to: :content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/blocks/requirement_model.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        class ClassificationValue < Lutaml::Model::Serializable
+          attribute :text, :string, collection: true
+          attribute :link, Metanorma::Document::Components::Inline::LinkElement,
+                    collection: true
+
+          xml do
+            mixed_content
+            map_content to: :text
+            map_element "link", to: :link
+          end
+        end
+
+        class RequirementClassification < Lutaml::Model::Serializable
+          attribute :tag, :string
+          attribute :value, ClassificationValue
+
+          xml do
+            element "classification"
+            map_element "tag", to: :tag
+            map_element "value", to: :value
+          end
+        end
+
+        class RequirementDescription < Lutaml::Model::Serializable
+          attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+          attribute :ul, Metanorma::Document::Components::Lists::UnorderedList,
+                    collection: true
+          attribute :ol, Metanorma::Document::Components::Lists::OrderedList,
+                    collection: true
+          attribute :sourcecode,
+                    Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock,
+                    collection: true
+          attribute :table, Metanorma::Document::Components::Tables::TableBlock,
+                    collection: true
+          attribute :example,
+                    Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
+                    collection: true
+          attribute :note, Metanorma::Document::Components::Blocks::NoteBlock,
+                    collection: true
+          attribute :figure,
+                    Metanorma::Document::Components::AncillaryBlocks::FigureBlock,
+                    collection: true
+
+          xml do
+            element "description"
+            map_element "p", to: :p
+            map_element "ul", to: :ul
+            map_element "ol", to: :ol
+            map_element "sourcecode", to: :sourcecode
+            map_element "table", to: :table
+            map_element "example", to: :example
+            map_element "note", to: :note
+            map_element "figure", to: :figure
+          end
+        end
+
+        class RequirementInherit < Lutaml::Model::Serializable
+          attribute :text, :string, collection: true
+          attribute :eref, Metanorma::Document::Components::Inline::ErefElement,
+                    collection: true
+          attribute :xref, Metanorma::Document::Components::Inline::XrefElement,
+                    collection: true
+
+          xml do
+            mixed_content
+            map_content to: :text
+            map_element "eref", to: :eref
+            map_element "xref", to: :xref
+          end
+        end
+
+        class RequirementBase < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :model, :string
+          attribute :obligation, :string
+          attribute :type, :string
+          attribute :anchor, :string
+          attribute :subject, :string
+          attribute :classification, RequirementClassification, collection: true
+          attribute :description, RequirementDescription, collection: true
+          attribute :inherit, RequirementInherit, collection: true
+          attribute :requirement, "Metanorma::Document::Components::Blocks::RequirementModel",
+                    collection: true
+          attribute :recommendation, "Metanorma::Document::Components::Blocks::RecommendationModel",
+                    collection: true
+          attribute :permission, "Metanorma::Document::Components::Blocks::PermissionModel",
+                    collection: true
+          attribute :example,
+                    Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
+                    collection: true
+        end
+
+        class RequirementModel < RequirementBase
+          xml do
+            element "requirement"
+            map_attribute "id", to: :id
+            map_attribute "model", to: :model
+            map_attribute "obligation", to: :obligation
+            map_attribute "type", to: :type
+            map_attribute "anchor", to: :anchor
+            map_element "subject", to: :subject
+            map_element "classification", to: :classification
+            map_element "description", to: :description
+            map_element "inherit", to: :inherit
+            map_element "requirement", to: :requirement
+            map_element "recommendation", to: :recommendation
+            map_element "permission", to: :permission
+            map_element "example", to: :example
+          end
+        end
+
+        class RecommendationModel < RequirementBase
+          xml do
+            element "recommendation"
+            map_attribute "id", to: :id
+            map_attribute "model", to: :model
+            map_attribute "obligation", to: :obligation
+            map_attribute "type", to: :type
+            map_attribute "anchor", to: :anchor
+            map_element "subject", to: :subject
+            map_element "classification", to: :classification
+            map_element "description", to: :description
+            map_element "inherit", to: :inherit
+            map_element "requirement", to: :requirement
+            map_element "recommendation", to: :recommendation
+            map_element "permission", to: :permission
+            map_element "example", to: :example
+          end
+        end
+
+        class PermissionModel < RequirementBase
+          xml do
+            element "permission"
+            map_attribute "id", to: :id
+            map_attribute "model", to: :model
+            map_attribute "obligation", to: :obligation
+            map_attribute "type", to: :type
+            map_attribute "anchor", to: :anchor
+            map_element "subject", to: :subject
+            map_element "classification", to: :classification
+            map_element "description", to: :description
+            map_element "inherit", to: :inherit
+            map_element "requirement", to: :requirement
+            map_element "recommendation", to: :recommendation
+            map_element "permission", to: :permission
+            map_element "example", to: :example
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,6 +7,16 @@ module Metanorma
         autoload :BasicBlock, "#{__dir__}/blocks/basic_block"
         autoload :BasicBlockNoNotes, "#{__dir__}/blocks/basic_block_no_notes"
         autoload :NoteBlock, "#{__dir__}/blocks/note_block"
+        autoload :Passthrough, "#{__dir__}/blocks/passthrough"
+        autoload :ClassificationValue, "#{__dir__}/blocks/requirement_model"
+        autoload :RequirementClassification,
+                 "#{__dir__}/blocks/requirement_model"
+        autoload :RequirementDescription, "#{__dir__}/blocks/requirement_model"
+        autoload :RequirementInherit, "#{__dir__}/blocks/requirement_model"
+        autoload :RequirementBase, "#{__dir__}/blocks/requirement_model"
+        autoload :RequirementModel, "#{__dir__}/blocks/requirement_model"
+        autoload :RecommendationModel, "#{__dir__}/blocks/requirement_model"
+        autoload :PermissionModel, "#{__dir__}/blocks/requirement_model"
       end
     end
   end

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