metanorma-document 0.2.0

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        # Note block, modelled to consist only of paragraphs.
+        class NoteBlock < BasicBlockNoNotes
+          attribute :content, "Metanorma::Document::Components::Paragraphs::ParagraphBlock",
+                    collection: true
+
+          attribute :formula,
+                    "Metanorma::Document::Components::AncillaryBlocks::FormulaBlock",
+                    collection: true
+
+          attribute :dl,
+                    "Metanorma::Document::Components::Lists::DefinitionList"
+
+          attribute :ul,
+                    "Metanorma::Document::Components::Lists::UnorderedList",
+                    collection: true
+          attribute :ol,
+                    "Metanorma::Document::Components::Lists::OrderedList",
+                    collection: true
+
+          attribute :quote,
+                    "Metanorma::Document::Components::MultiParagraph::QuoteBlock",
+                    collection: true
+
+          attribute :json_type, :string
+          attribute :type_attr, :string
+          attribute :format, :string
+          attribute :semx_id, :string
+          attribute :autonum, :string
+
+          def json_type
+            "note"
+          end
+
+          json do
+            map "type", to: :json_type
+            map "id", to: :id
+            map "content", to: :content
+          end
+
+          attribute :anchor, :string
+
+          attribute :remove_in_rfc, :string
+
+          attribute :name, Metanorma::Document::Components::Inline::NameWithIdElement,
+                    collection: true
+
+          attribute :fmt_xref_label,
+                    Metanorma::Document::Components::Inline::FmtXrefLabelElement, collection: true
+          attribute :fmt_name, Metanorma::Document::Components::Inline::FmtNameElement
+
+          xml do
+            element "note"
+            map_attribute "type", to: :type_attr
+            map_attribute "format", to: :format
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "autonum", to: :autonum, render_empty: true
+            map_attribute "anchor", to: :anchor
+            map_attribute "removeInRFC", to: :remove_in_rfc
+            map_element "name", to: :name
+            map_element "p", to: :content
+            map_element "formula", to: :formula
+            map_element "dl", to: :dl
+            map_element "ul", to: :ul
+            map_element "ol", to: :ol
+            map_element "quote", to: :quote
+            map_element "fmt-xref-label", to: :fmt_xref_label
+            map_element "fmt-name", to: :fmt_name
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        autoload :BasicBlock, "#{__dir__}/blocks/basic_block"
+        autoload :BasicBlockNoNotes, "#{__dir__}/blocks/basic_block_no_notes"
+        autoload :NoteBlock, "#{__dir__}/blocks/note_block"
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/attribute_change_action.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # Possible actions
+        # that involve modification of an attribute within a BasicDocument
+        # data element.
+        class AttributeChangeAction < ContentChangeAction
+          attribute :attribute_id, :string
+
+          xml do
+            element "attribute-change-action"
+            map_attribute "attribute-id", to: :attribute_id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/attribute_modify.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # A container for a multiple _AttributeChangeAction_ data.
+        # Add attribute; Remove attribute; Modify attribute.
+        class AttributeModify < ContentModify
+          attribute :actions, AttributeChangeAction, collection: true
+
+          xml do
+            element "attribute-modify"
+            map_element "actions", to: :actions
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # Specification of an update action to be performed incrementally on an element within a
+        # BasicDocument.
+        class Change < Lutaml::Model::Serializable
+          attribute :target, Metanorma::Document::Components::ReferenceElements::ReferenceToIdElement
+          attribute :identifier, UniqueIdentifier
+          attribute :parent_identifier, UniqueIdentifier
+          attribute :contrib_metadata, Metanorma::Document::Components::ContribMetadata::ContributionElementMetadata,
+                    collection: true
+
+          xml do
+            element "change"
+            map_element "target", to: :target
+            map_element "identifier", to: :identifier
+            map_element "parent-identifier", to: :parent_identifier
+            map_element "contrib-metadata", to: :contrib_metadata
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/change_set.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # A collection of _Change_ data, specifying the document they should be applied to.
+        class ChangeSet < Lutaml::Model::Serializable
+          attribute :changes, Change, collection: true
+          attribute :document_identifier, UniqueIdentifier
+
+          xml do
+            element "change-set"
+            map_element "changes", to: :changes
+            map_element "document-identifier", to: :document_identifier
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/content_action.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # Specifies the kind of textual change to be undertaken.
+        class ContentAction < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "content-action"
+            map_content to: :value
+
+            def self.values
+              %w[insert delete]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/content_change.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # Possible actions
+        # that involve modification of content within a BasicDocument
+        # data element.
+        # Add text; Delete text; Modify text.
+        class ContentChange < Change
+          xml do
+            element "content-change"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/content_change_action.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # The actual content
+        # changes that applies to the specified portion of textual content.
+        # This is used both by the _ContentModify_ and _AttributeModify_ models
+        # as their content are treated as pure text.
+        class ContentChangeAction < Lutaml::Model::Serializable
+          attribute :action, :string
+          attribute :from, :integer
+          attribute :to, :integer
+          attribute :text, :string
+          attribute :length, :integer
+
+          xml do
+            element "content-change-action"
+            map_attribute "action", to: :action
+            map_attribute "from", to: :from
+            map_attribute "to", to: :to
+            map_attribute "text", to: :text
+            map_attribute "length", to: :length
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/content_modify.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # Container for a multiple _ContentChangeAction_ data
+        class ContentModify < ContentChange
+          attribute :actions, ContentChangeAction, collection: true
+
+          xml do
+            element "content-modify"
+            map_element "actions", to: :actions
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/node_change.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # Possible actions that involve
+        # modification of data elements at the node level within a
+        # BasicDocument. Add/remove node; Move node.
+        class NodeChange < Change
+          xml do
+            element "node-change"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/node_delete.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # Specification of the deletion of a data node in a BasicDocument.
+        class NodeDelete < NodeChange
+          attribute :hash_value, :string
+
+          xml do
+            element "node-delete"
+            map_attribute "hash-value", to: :hash_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/node_insert.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # Specification of the insertion
+        # of a data node in a BasicDocument.
+        class NodeInsert < NodeChange
+          attribute :content, Metanorma::Document::Components::EmptyElements::BasicElement
+
+          xml do
+            element "node-insert"
+            map_element "content", to: :content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/node_move.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # Specification of moving a particular node in a BasicDocument
+        # to another location within the same BasicDocument.
+        class NodeMove < NodeChange
+          attribute :position_old, Metanorma::Document::Components::ReferenceElements::ReferenceToIdElement
+          attribute :position_new, Metanorma::Document::Components::ReferenceElements::ReferenceToIdElement
+
+          xml do
+            element "node-move"
+            map_element "position-old", to: :position_old
+            map_element "position-new", to: :position_new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/change/unique_identifier.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        # Identifier used to uniquely identify a BasicDocument.
+        class UniqueIdentifier < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "unique-identifier"
+            map_content to: :value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Change
+        autoload :AttributeChangeAction,
+                 "#{__dir__}/change/attribute_change_action"
+        autoload :AttributeModify, "#{__dir__}/change/attribute_modify"
+        autoload :Change, "#{__dir__}/change/change"
+        autoload :ChangeSet, "#{__dir__}/change/change_set"
+        autoload :ContentAction, "#{__dir__}/change/content_action"
+        autoload :ContentChange, "#{__dir__}/change/content_change"
+        autoload :ContentChangeAction, "#{__dir__}/change/content_change_action"
+        autoload :ContentModify, "#{__dir__}/change/content_modify"
+        autoload :NodeChange, "#{__dir__}/change/node_change"
+        autoload :NodeDelete, "#{__dir__}/change/node_delete"
+        autoload :NodeInsert, "#{__dir__}/change/node_insert"
+        autoload :NodeMove, "#{__dir__}/change/node_move"
+        autoload :UniqueIdentifier, "#{__dir__}/change/unique_identifier"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ContribMetadata
+        # Container encoding the contribution made by a party towards a particular element in the document
+        class ContributionElementMetadata < Lutaml::Model::Serializable
+          attribute :date_time, :string
+          attribute :contributor, Metanorma::Document::Relaton::Contributor
+          attribute :integrity_value, BasicObject, collection: true
+
+          xml do
+            element "contribution-element-metadata"
+            map_attribute "date-time", to: :date_time
+            map_element "contributor", to: :contributor
+            map_element "integrity-value", to: :integrity_value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ContribMetadata
+        # Hash value for a digital signature.
+        class Hash < IntegrityValue
+          attribute :algorithm, :string
+          attribute :value, :string
+
+          xml do
+            element "hash"
+            map_attribute "algorithm", to: :algorithm
+            map_content to: :value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ContribMetadata
+        # A digital signature of the contribution, consisting of a `hash` value and a `signature`, with an
+        # associated `publicKey`.
+        class IntegrityValue < Lutaml::Model::Serializable
+          xml do
+            element "integrity-value"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ContribMetadata
+        # Identifier of hash algorithm defined in ISO 10118.
+        class Iso10118Oid < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "iso10118-oid"
+            map_content to: :value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ContribMetadata
+        # Identifier of digital signature algorithm defined in ISO 14888.
+        class Iso14888Oid < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "iso14888-oid"
+            map_content to: :value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ContribMetadata
+        # Digital signature.
+        class Signature < IntegrityValue
+          attribute :algorithm, :string
+          attribute :public_key, :string
+          attribute :signature, :string
+
+          xml do
+            element "signature"
+            map_attribute "algorithm", to: :algorithm
+            map_attribute "public-key", to: :public_key
+            map_content to: :signature
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ContribMetadata
+        autoload :ContributionElementMetadata,
+                 "#{__dir__}/contrib_metadata/contribution_element_metadata"
+        autoload :Hash, "#{__dir__}/contrib_metadata/hash"
+        autoload :IntegrityValue, "#{__dir__}/contrib_metadata/integrity_value"
+        autoload :Iso10118Oid, "#{__dir__}/contrib_metadata/iso10118_oid"
+        autoload :Iso14888Oid, "#{__dir__}/contrib_metadata/iso14888_oid"
+        autoload :Signature, "#{__dir__}/contrib_metadata/signature"
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/data_types/formatted_string.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module DataTypes
+        # String which is formatted according to conventions specified
+        # in a named MIME type (<<rfc2046>>).
+        class FormattedString < Lutaml::Model::Serializable
+          attribute :language, :string
+          attribute :script, :string
+          attribute :value, :string, collection: true
+          attribute :type, :string
+          attribute :format, :string
+          attribute :abbreviation, :string
+          attribute :semx, Metanorma::Document::Components::Inline::SemxElement,
+                    collection: true
+          attribute :span, Metanorma::Document::Components::Inline::SpanElement,
+                    collection: true
+          attribute :em, Metanorma::Document::Components::Inline::EmRawElement,
+                    collection: true
+          attribute :strong, Metanorma::Document::Components::Inline::StrongRawElement,
+                    collection: true
+          attribute :smallcap, Metanorma::Document::Components::Inline::SmallCapElement,
+                    collection: true
+          attribute :link, Metanorma::Document::Components::Inline::LinkElement,
+                    collection: true
+          attribute :br, Metanorma::Document::Components::Inline::BrElement,
+                    collection: true
+          attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+          attribute :sup, Metanorma::Document::Components::Inline::SupElement,
+                    collection: true
+          attribute :sub, Metanorma::Document::Components::Inline::SubElement,
+                    collection: true
+          attribute :fn, Metanorma::Document::Components::Inline::FnElement,
+                    collection: true
+          attribute :stem, Metanorma::Document::Components::Inline::StemInlineElement,
+                    collection: true
+          attribute :fmt_stem, Metanorma::Document::Components::Inline::FmtStemElement,
+                    collection: true
+          attribute :eref, Metanorma::Document::Components::Inline::ErefElement,
+                    collection: true
+          attribute :xref, Metanorma::Document::Components::Inline::XrefElement,
+                    collection: true
+          attribute :strike, Metanorma::Document::Components::TextElements::StrikeElement,
+                    collection: true
+          attribute :dl, Metanorma::Document::Components::Lists::DefinitionList
+          attribute :ul, Metanorma::Document::Components::Lists::UnorderedList,
+                    collection: true
+          attribute :ol, Metanorma::Document::Components::Lists::OrderedList,
+                    collection: true
+          attribute :table, Metanorma::Document::Components::Tables::TableBlock,
+                    collection: true
+          attribute :tt, Metanorma::Document::Components::Inline::TtElement,
+                    collection: true
+          attribute :underline, Metanorma::Document::Components::TextElements::UnderlineElement,
+                    collection: true
+
+          xml do
+            mixed_content
+            map_attribute "language", to: :language
+            map_attribute "script", to: :script
+            map_attribute "type", to: :type
+            map_attribute "format", to: :format
+            map_attribute "abbreviation", to: :abbreviation
+            map_content to: :value
+            map_element "semx", to: :semx
+            map_element "span", to: :span
+            map_element "em", to: :em
+            map_element "strong", to: :strong
+            map_element "smallcap", to: :smallcap
+            map_element "link", to: :link
+            map_element "br", to: :br
+            map_element "p", to: :p
+            map_element "sup", to: :sup
+            map_element "sub", to: :sub
+            map_element "fn", to: :fn
+            map_element "stem", to: :stem
+            map_element "fmt-stem", to: :fmt_stem
+            map_element "eref", to: :eref
+            map_element "xref", to: :xref
+            map_element "strike", to: :strike
+            map_element "dl", to: :dl
+            map_element "ul", to: :ul
+            map_element "ol", to: :ol
+            map_element "table", to: :table
+            map_element "tt", to: :tt
+            map_element "underline", to: :underline
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/data_types/iso15924_code.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module DataTypes
+        # Script identifier, as defined in ISO 15924.
+        class Iso15924Code < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "iso15924-code"
+            map_content to: :value
+          end
+        end
+      end
+    end
+  end
+end