metanorma-document 0.2.0

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Edition of a bibliographic item.
+      class Edition < Lutaml::Model::Serializable
+        attribute :number, :string
+        attribute :language, :string
+        attribute :content, :string
+
+        xml do
+          element "edition"
+          map_attribute "number", to: :number
+          map_attribute "language", to: :language, render_empty: true
+          map_content to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The name of a person.
+      class FullName < Lutaml::Model::Serializable
+        attribute :prefix, Metanorma::Document::Components::DataTypes::LocalizedString,
+                  collection: true
+        attribute :forename, Metanorma::Document::Components::DataTypes::LocalizedString,
+                  collection: true
+        attribute :initials, Metanorma::Document::Components::DataTypes::LocalizedString,
+                  collection: true
+        attribute :surname, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :addition, Metanorma::Document::Components::DataTypes::LocalizedString,
+                  collection: true
+        attribute :complete_name, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :note, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :variant, VariantFullName, collection: true
+
+        xml do
+          map_element "prefix", to: :prefix
+          map_element "forename", to: :forename
+          map_element "initials", to: :initials
+          map_element "surname", to: :surname
+          map_element "addition", to: :addition
+          map_element "completename", to: :complete_name
+          map_element "note", to: :note
+          map_element "variant", to: :variant
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Code for currencies, as specified in <<iso4217>>.
+      class Iso4217Code < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "iso4217-code"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Gregorian date, as specified in <<iso8601>>.
+      class Iso8601Date < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "iso8601-date"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Keyword for a bibliographic item.
+      class KeywordType < Lutaml::Model::Serializable
+        attribute :content, :string
+        attribute :vocab, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :taxon, :string, collection: true
+        attribute :vocabid, Metanorma::Document::Relaton::VocabIdType,
+                  collection: true
+
+        xml do
+          map_content to: :content
+          map_element "vocab", to: :vocab
+          map_element "taxon", to: :taxon
+          map_element "vocabid", to: :vocabid
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Hierarchical arrangement of bibliographic localities.
+      class LocalityStack < Lutaml::Model::Serializable
+        attribute :connective, :string
+        attribute :bib_locality, BibItemLocality, collection: true
+
+        xml do
+          element "localityStack"
+          map_attribute "connective", to: :connective
+          map_element "locality", to: :bib_locality
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # A name element with optional language and script attributes.
+      class LocalizedName < Lutaml::Model::Serializable
+        attribute :language, :string
+        attribute :script, :string
+        attribute :content, :string, collection: true
+
+        xml do
+          element "name"
+          mixed_content
+          map_attribute "language", to: :language
+          map_attribute "script", to: :script
+          map_content to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Information about the medium and transmission of a bibliographic item.
+      class MediumType < Lutaml::Model::Serializable
+        attribute :content, :string
+        attribute :genre, :string
+        attribute :form, :string
+        attribute :carrier, :string
+        attribute :size, :string
+        attribute :scale, :string
+
+        xml do
+          map_attribute "content", to: :content
+          map_attribute "genre", to: :genre
+          map_attribute "form", to: :form
+          map_attribute "carrier", to: :carrier
+          map_attribute "size", to: :size
+          map_attribute "scale", to: :scale
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # An identifier of an organization according to an international identifier scheme.
+      class OrgIdentifier < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :type, :string
+        attribute :value, :string
+
+        xml do
+          map_attribute "id", to: :id
+          map_attribute "type", to: :type
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # A subdivision of an organization (e.g. committee, subcommittee, workgroup).
+      class OrgSubdivision < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :subtype, :string
+        attribute :name, LocalizedName, collection: true
+        attribute :identifier, OrgSubdivisionIdentifier, collection: true
+        attribute :fmt_identifier, Metanorma::Document::Components::Inline::FmtIdentifierElement,
+                  collection: true
+        attribute :logo, LogoElement
+
+        xml do
+          element "subdivision"
+          map_attribute "type", to: :type
+          map_attribute "subtype", to: :subtype, render_empty: true
+          map_element "name", to: :name
+          map_element "identifier", to: :identifier
+          map_element "fmt-identifier", to: :fmt_identifier
+          map_element "logo", to: :logo
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # An identifier of an organization subdivision.
+      class OrgSubdivisionIdentifier < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :type, :string
+        attribute :value, :string
+
+        xml do
+          map_attribute "id", to: :id
+          map_attribute "type", to: :type
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Logo element with arbitrary SVG/image content. Uses map_all_content
+      # to preserve all child XML including <image>, <svg>, <path>, etc.
+      class LogoElement < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :content, :string
+
+        xml do
+          element "logo"
+          map_attribute "type", to: :type
+          map_all_content to: :content
+        end
+      end
+
+      # Organization associated with a bibliographic item.
+      class Organization < Contributor
+        attribute :name, LocalizedName, collection: true
+        attribute :variant, VariantOrgName, collection: true
+        attribute :subdivision, OrgSubdivision, collection: true
+        attribute :variant_subdivision, VariantOrgName, collection: true
+        attribute :abbreviation, :string
+        attribute :uri, TypedUri, collection: true
+        attribute :identifier, OrgIdentifier, collection: true
+        attribute :contact, ContactMethod, collection: true
+        attribute :logo, LogoElement, collection: true
+        attribute :address, Address, collection: true
+
+        xml do
+          element "organization"
+          map_element "name", to: :name
+          map_element "variant", to: :variant
+          map_element "subdivision", to: :subdivision
+          map_element "variant-subdivision", to: :variant_subdivision
+          map_element "abbreviation", to: :abbreviation
+          map_element "uri", to: :uri
+          map_element "identifier", to: :identifier
+          map_element "contact", to: :contact
+          map_element "logo", to: :logo
+          map_element "address", to: :address
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Person associated with a bibliographic item.
+      class Person < Contributor
+        attribute :name, FullName
+        attribute :affiliation, Affiliation, collection: true
+        attribute :identifier, PersonIdentifier, collection: true
+        attribute :contact, ContactMethod, collection: true
+        attribute :phone, Phone, collection: true
+        attribute :email, :string, collection: true
+        attribute :uri, TypedUri
+
+        xml do
+          map_element "name", to: :name
+          map_element "affiliation", to: :affiliation
+          map_element "identifier", to: :identifier
+          map_element "contact", to: :contact
+          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/person_identifier.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # An identifier of a person according to an international identifier scheme.
+      class PersonIdentifier < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :value, :string
+
+        xml do
+          map_attribute "type", to: :type
+          map_attribute "value", to: :value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The international identifier scheme for the identifier of a person.
+      class PersonalIdentifierType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "personal-identifier-type"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[Isni Orcid Uri]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The phone number associated with a person or organization.
+      class Phone < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :content, :string
+
+        xml do
+          map_attribute "type", to: :type
+          map_content to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Place associated with the production of a bibliographic item.
+      # Region element with iso attribute.
+      class RegionElement < Lutaml::Model::Serializable
+        attribute :iso, :string
+        attribute :content, :string
+
+        xml do
+          element "region"
+          map_attribute "iso", to: :iso
+          map_content to: :content
+        end
+      end
+
+      class PlaceType < Lutaml::Model::Serializable
+        attribute :region_attr, :string
+        attribute :region, RegionElement
+        attribute :city, :string
+        attribute :uri, :string
+        attribute :content, :string
+
+        xml do
+          map_attribute "region", to: :region_attr
+          map_attribute "uri", to: :uri
+          map_element "region", to: :region
+          map_element "city", to: :city
+          map_content to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The price set on accessing the bibliographic item.
+      class PriceType < Lutaml::Model::Serializable
+        attribute :currency, :string
+        attribute :content, :string
+
+        xml do
+          map_attribute "currency", to: :currency
+          map_content to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Encoding of region with ISO 3166 encoding.
+      class RegionType < Lutaml::Model::Serializable
+        attribute :iso, :string
+        attribute :recommended, :boolean
+        attribute :content, :string
+
+        xml do
+          map_attribute "iso", to: :iso
+          map_attribute "recommended", to: :recommended
+          map_content to: :content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Used to present a group of bibliographic items as a single group.
+      class RelatonCollection < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :title, Metanorma::Document::Relaton::TypedTitleString,
+                  collection: true
+        attribute :contributor, Metanorma::Document::Relaton::ContributionInfo,
+                  collection: true
+        attribute :relation, Metanorma::Document::Relaton::DocumentRelation,
+                  collection: true
+
+        xml do
+          map_attribute "type", to: :type
+          map_element "title", to: :title
+          map_element "contributor", to: :contributor
+          map_element "relation", to: :relation
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Series to which a bibliographic item belongs.
+      class SeriesType < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :formattedref, Metanorma::Document::Components::DataTypes::FormattedString
+        attribute :title, Metanorma::Document::Relaton::TypedTitleString
+        attribute :place, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :organization, Metanorma::Document::Relaton::Organization
+        attribute :abbrev, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :from, Metanorma::Document::Relaton::DateTime
+        attribute :to, Metanorma::Document::Relaton::DateTime
+        attribute :number, :string
+        attribute :partnumber, :string
+        attribute :run, :string
+
+        xml do
+          map_attribute "type", to: :type
+          map_element "formattedref", to: :formattedref
+          map_element "title", to: :title
+          map_element "place", to: :place
+          map_element "organization", to: :organization
+          map_element "abbrev", to: :abbrev
+          map_element "from", to: :from
+          map_element "to", to: :to
+          map_element "number", to: :number
+          map_attribute "partnumber", to: :partnumber
+          map_attribute "run", to: :run
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # The type of series description given.
+      class SeriesTypeType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "series-type-type"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[main alt]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Type of indicator of a location or extent within a bibliographic item.
+      #
+      # When the value `whole` or `title` is used, the corresponding `BibItemLocality`
+      # attribute `identifier` should be empty.
+      class SpecificLocalityType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "specific-locality-type"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[section clause part paragraph chapter page whole table annex figure
+             note list example volume issue time anchor title line localityString]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # Type of title given to a bibliographic item.
+      class TitleType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "title-type"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[alternative original unofficial subtitle main]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Relaton
+      # A note associated with the bibliographic item.
+      class TypedNote < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :format, :string
+        attribute :text, :string, collection: true
+        attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                  collection: true
+
+        xml do
+          element "note"
+          mixed_content
+          map_attribute "type", to: :type
+          map_attribute "format", to: :format
+          map_content to: :text
+          map_element "p", to: :p
+        end
+      end
+    end
+  end
+end