metanorma-document 0.2.0

data/lib/metanorma/document/components/text_elements/strong_element.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Strong text. Corresponds to HTML `strong`, `b`.
+        class StrongElement < TextElement
+          xml do
+            element "strong"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/subscript_element.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Subscript text. Corresponds to HTML `sub`.
+        class SubscriptElement < TextElement
+          xml do
+            element "sub"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/superscript_element.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Superscript text. Corresponds to HTML `sup`.
+        class SuperscriptElement < TextElement
+          xml do
+            element "sup"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/text_element.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Inline element containing text and associated formatting information,
+        # but which does not contain any associated identifiers or references to identifiers.
+        class TextElement < Metanorma::Document::Components::EmptyElements::BasicElement
+          attribute :content, TextElementType
+
+          xml do
+            element "text-element"
+            map_element "content", to: :content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/text_element_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Content of the Text Element.
+        class TextElementType < Lutaml::Model::Serializable
+          attribute :content, Metanorma::Document::Components::DataTypes::LocalizedString
+          attribute :elements, TextElement, collection: true
+
+          xml do
+            element "text-element-type"
+            map_element "content", to: :content
+            map_element "elements", to: :elements
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/underline_element.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Underlined text. Corresponds to HTML 4 `u`.
+        # Contains mixed content with inline elements.
+        class UnderlineElement < Lutaml::Model::Serializable
+          attribute :text, :string, collection: true
+          attribute :em, "Metanorma::Document::Components::Inline::EmRawElement",
+                    collection: true
+          attribute :strong, "Metanorma::Document::Components::Inline::StrongRawElement",
+                    collection: true
+          attribute :eref, "Metanorma::Document::Components::Inline::ErefElement",
+                    collection: true
+          attribute :link, "Metanorma::Document::Components::Inline::LinkElement",
+                    collection: true
+
+          xml do
+            element "underline"
+            mixed_content
+            map_content to: :text
+            map_element "em", to: :em
+            map_element "strong", to: :strong
+            map_element "eref", to: :eref
+            map_element "link", to: :link
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        autoload :Asciiml, "#{__dir__}/text_elements/asciiml"
+        autoload :EmphasisElement, "#{__dir__}/text_elements/emphasis_element"
+        autoload :KeywordElement, "#{__dir__}/text_elements/keyword_element"
+        autoload :Latex, "#{__dir__}/text_elements/latex"
+        autoload :LatexmathElement, "#{__dir__}/text_elements/latexmath_element"
+
+        autoload :MonospaceElement, "#{__dir__}/text_elements/monospace_element"
+        autoload :RubyElement, "#{__dir__}/text_elements/ruby_element"
+        autoload :SmallCapsElement,
+                 "#{__dir__}/text_elements/small_caps_element"
+        autoload :StemElement, "#{__dir__}/text_elements/stem_element"
+        autoload :StemType, "#{__dir__}/text_elements/stem_type"
+        autoload :StemValue, "#{__dir__}/text_elements/stem_value"
+        autoload :StrikeElement, "#{__dir__}/text_elements/strike_element"
+        autoload :StrongElement, "#{__dir__}/text_elements/strong_element"
+        autoload :SubscriptElement, "#{__dir__}/text_elements/subscript_element"
+        autoload :SuperscriptElement,
+                 "#{__dir__}/text_elements/superscript_element"
+        autoload :TextElement, "#{__dir__}/text_elements/text_element"
+        autoload :TextElementType, "#{__dir__}/text_elements/text_element_type"
+        autoload :UnderlineElement, "#{__dir__}/text_elements/underline_element"
+      end
+    end
+  end
+end

data/lib/metanorma/document/components.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      autoload :AncillaryBlocks,
+               "metanorma/document/components/ancillary_blocks"
+      autoload :BibData, "metanorma/document/components/bib_data"
+      autoload :Blocks, "metanorma/document/components/blocks"
+      autoload :Change, "metanorma/document/components/change"
+      autoload :ContribMetadata,
+               "metanorma/document/components/contrib_metadata"
+      autoload :DataTypes, "metanorma/document/components/data_types"
+      autoload :EmptyElements, "metanorma/document/components/empty_elements"
+      autoload :IdElements, "metanorma/document/components/id_elements"
+      autoload :Lists, "metanorma/document/components/lists"
+      autoload :MultiParagraph, "metanorma/document/components/multi_paragraph"
+      autoload :Paragraphs, "metanorma/document/components/paragraphs"
+      autoload :ReferenceElements,
+               "metanorma/document/components/reference_elements"
+      autoload :Sections, "metanorma/document/components/sections"
+      autoload :Tables, "metanorma/document/components/tables"
+      autoload :Inline, "metanorma/document/components/inline"
+      autoload :TextElements, "metanorma/document/components/text_elements"
+    end
+  end
+end

data/lib/metanorma/document/data_types.rb

@@ -0,0 +1,11 @@
+# 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/relaton/address.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Model for formattedAddress element which may contain mixed content with <br/> tags.
+      class FormattedAddress < Lutaml::Model::Serializable
+        attribute :content, :string, collection: true
+
+        xml do
+          element "formattedAddress"
+          map_content to: :content
+        end
+      end
+
+      # An address for a person or organization.
+      class Address < Lutaml::Model::Serializable
+        attribute :formatted_address_attr, :string
+        attribute :formatted_address, FormattedAddress
+        attribute :street, :string, collection: true
+        attribute :city, :string
+        attribute :state, :string
+        attribute :country, :string
+        attribute :postcode, :string
+
+        xml do
+          element "address"
+          map_attribute "formatted-address", to: :formatted_address_attr
+          map_element "formattedAddress", to: :formatted_address
+          map_element "street", to: :street
+          map_element "city", to: :city
+          map_element "state", to: :state
+          map_element "country", to: :country
+          map_element "postcode", to: :postcode
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The affiliation of a person with an organization.
+      class Affiliation < Lutaml::Model::Serializable
+        attribute :name, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :description,
+                  Metanorma::Document::Components::DataTypes::FormattedString, collection: true
+        attribute :organization, Organization
+
+        xml do
+          element "affiliation"
+          map_element "name", to: :name
+          map_element "description", to: :description
+          map_element "organization", to: :organization
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The extent or location of a bibliographic item being referred to.
+      class BibItemLocality < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :reference_from, :string
+        attribute :reference_to, :string
+
+        xml do
+          element "locality"
+          map_attribute "type", to: :type
+          map_element "referenceFrom", to: :reference_from
+          map_element "referenceTo", to: :reference_to
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The size of a bibliographic item being referred to.
+      class BibItemSize < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :value, Metanorma::Document::Components::DataTypes::LocalizedString
+
+        xml do
+          element "bib-item-size"
+          map_attribute "type", to: :type
+          map_element "value", to: :value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Type of size of a bibliographic item.
+      class BibItemSizeType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "bib-item-size-type"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[page volume time data value]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Type of bibliographic item.
+      class BibItemType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "bib-item-type"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[article book booklet manual proceedings presentation thesis techReport
+             standard unpublished map electronicResource audiovisual film video broadcast
+             graphicWork music patent inBook inCollection inProceedings journal
+             webResource website dataset archival software socialMedia alert message
+             conversation misc]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Significant date in the lifecycle of the bibliographic item.
+      class BibliographicDate < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :format, :string
+        attribute :text, :string
+        attribute :from, DateTime
+        attribute :to, DateTime
+        attribute :on, DateTime
+
+        xml do
+          element "date"
+          map_attribute "type", to: :type
+          map_attribute "format", to: :format
+          map_content to: :text
+          map_element "from", to: :from
+          map_element "to", to: :to
+          map_element "on", to: :on
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Indicates type of date within a bibliographic lifecycle.
+      class BibliographicDateType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "bibliographic-date-type"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[published accessed created implemented obsoleted confirmed updated issued
+             transmitted copied unchanged circulated adapted voteStarted voteEnded announced]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Contact information for a person or organization.
+      class ContactMethod < Lutaml::Model::Serializable
+        attribute :address, Metanorma::Document::Relaton::Address
+        attribute :phone, Metanorma::Document::Relaton::Phone, collection: true
+        attribute :email, :string
+        attribute :uri, Metanorma::Document::Relaton::TypedUri
+
+        xml do
+          map_element "address", to: :address
+          map_element "phone", to: :phone
+          map_element "email", to: :email
+          map_element "uri", to: :uri
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Description of a contributor to the production of the bibliographic item.
+      class ContributionInfo < Lutaml::Model::Serializable
+        attribute :role, ContributorRole, collection: true
+        attribute :organization, Organization
+        attribute :person, Person
+
+        xml do
+          element "contributor"
+          map_element "role", to: :role
+          map_element "organization", to: :organization
+          map_element "person", to: :person
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The contributor involved in the production of a bibliographic item; may be either a person or an
+      # organization.
+      class Contributor < Lutaml::Model::Serializable
+        xml do
+          element "contributor"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # A description of the role of the contributor in the production of a bibliographic item.
+      class ContributorRole < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :description,
+                  Metanorma::Document::Components::DataTypes::FormattedString, collection: true
+        attribute :text, :string, collection: true
+
+        xml do
+          element "role"
+          mixed_content
+          map_attribute "type", to: :type
+          map_content to: :text
+          map_element "description", to: :description
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The copyright status of a bibliographic item.
+      class CopyrightOwner < Lutaml::Model::Serializable
+        attribute :organization, Organization
+
+        xml do
+          element "owner"
+          map_element "organization", to: :organization
+        end
+      end
+
+      class CopyrightAssociation < Lutaml::Model::Serializable
+        attribute :from, Metanorma::Document::Relaton::DateTime
+        attribute :to, Metanorma::Document::Relaton::DateTime
+        attribute :owner, CopyrightOwner, collection: true
+        attribute :scope, :string
+
+        xml do
+          element "copyright"
+          map_element "from", to: :from
+          map_element "to", to: :to
+          map_element "owner", to: :owner
+          map_attribute "scope", to: :scope
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Type which allows date and time to be specified as either a Gregorian
+      # date and time, as specified in <<iso8601>>, as text, or as both.
+      class DateTime < Lutaml::Model::Serializable
+        attribute :text, :string
+        attribute :content, :string
+
+        xml do
+          map_attribute "text", to: :text
+          map_content to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # An identifier of a bibliographic item in an international standard scheme.
+      class DocumentIdentifier < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :type, :string
+        attribute :language, :string
+        attribute :primary, :boolean
+        attribute :scope, :string
+
+        xml do
+          element "docidentifier"
+          map_attribute "type", to: :type
+          map_attribute "language", to: :language
+          map_attribute "primary", to: :primary
+          map_attribute "scope", to: :scope
+          map_content to: :id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Relation between a bibliographic item and another bibliographic item.
+      class DocumentRelation < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :description,
+                  Metanorma::Document::Components::DataTypes::FormattedString, collection: true
+        attribute :bibitem, Metanorma::Document::Components::BibData::BibliographicItem
+        attribute :bib_locality, LocalityStack, collection: true
+        attribute :bib_source_locality, LocalityStack, collection: true
+
+        xml do
+          element "relation"
+          map_attribute "type", to: :type
+          map_element "description", to: :description
+          map_element "bibitem", to: :bibitem
+          map_element "localityStack", to: :bib_locality
+          map_element "sourceLocalityStack", to: :bib_source_locality
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Type of the relationship between a main document (described in `BibliographicItem`)
+      # and a target document.
+      class DocumentRelationType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "document-relation-type"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[includes includedIn hasPart partOf merges mergedInto splits splitInto
+             instanceOf hasInstance exemplarOf hasExemplar manifestationOf hasManifestation
+             reproductionOf hasReproduction reprintOf hasReprint expressionOf hasExpression
+             translatedFrom hasTranslation arrangementOf hasArrangement abridgementOf
+             hasAbridgement annotationOf hasAnnotation draftOf hasDraft editionOf
+             hasEdition updates updatedBy derivedFrom derives describes describedBy
+             catalogues cataloguedBy hasSuccessor successorOf adaptedFrom hasAdaptation
+             adoptedFrom adoptedAs reviewOf hasReview commentaryOf hasCommentary
+             identical nonequivalent equivalent related complements complementOf
+             obsoletes obsoletedBy cites isCitedIn]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The publication or preparation status of a document.
+      class DocumentStatus < Lutaml::Model::Serializable
+        attribute :stage, Metanorma::Document::Components::DataTypes::FormattedString,
+                  collection: true
+        attribute :stage_abbreviation, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :substage, Metanorma::Document::Components::DataTypes::FormattedString,
+                  collection: true
+        attribute :substage_abbreviation, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :iteration, Metanorma::Document::Components::DataTypes::LocalizedString
+
+        xml do
+          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
+        end
+      end
+    end
+  end
+end