metanorma-document 0.3.0 → 0.4.0

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

@@ -1,10 +1,18 @@
 # frozen_string_literal: true
 
+require "relaton/bib"
+
 module Metanorma
   module Document
     module Relaton
       # The name of a person.
-      class FullName < Lutaml::Model::Serializable
+      # Inherits relaton-bib's FullName, gaining the formatted-initials and
+      # abbreviation element mappings (formatted-initials was previously
+      # dropped on round-trip). The mappings below are re-declared with
+      # Metanorma's richer LocalizedString and variant wrapper — relaton-bib
+      # 2.2.0.pre.alpha.1 types note as a sanitized Note collection and
+      # inlines the variant name fields.
+      class FullName < ::Relaton::Bib::FullName
         attribute :prefix, Metanorma::Document::Components::DataTypes::LocalizedString,
                   collection: true
         attribute :forename, Metanorma::Document::Components::DataTypes::LocalizedString,
@@ -14,17 +22,20 @@ module Metanorma
         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 :completename, Metanorma::Document::Components::DataTypes::LocalizedString
         attribute :note, Metanorma::Document::Components::DataTypes::LocalizedString
         attribute :variant, VariantFullName, collection: true
 
+        # Compatibility reader: relaton-bib names the attribute completename.
+        def complete_name = completename
+
         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 "completename", to: :completename
           map_element "note", to: :note
           map_element "variant", to: :variant
         end

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

@@ -4,6 +4,9 @@ module Metanorma
   module Document
     module Relaton
       # Keyword for a bibliographic item.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Keyword has no
+      # map_content — the text of <keyword>RoIP</keyword> (83 of 125 fixture
+      # keyword elements carry text) would serialize as <keyword/>.
       class KeywordType < Lutaml::Model::Serializable
         attribute :content, :string
         attribute :vocab, Metanorma::Document::Components::DataTypes::LocalizedString

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

@@ -1,18 +1,15 @@
 # frozen_string_literal: true
 
+require "relaton/bib"
+
 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
+      class LocalityStack < ::Relaton::Bib::LocalityStack
+        # Compatibility alias: relaton-bib names the collection
+        # +locality+, this gem historically used +bib_locality+.
+        def bib_locality = locality
       end
     end
   end

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

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
+require "relaton/bib"
+
 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
+      # Inherits relaton-bib's TypedLocalizedString (gaining the type and
+      # locale attribute mappings); content stays a collection under
+      # mixed_content — this gem's organization and subdivision names allow
+      # mixed text runs, which relaton-bib 2.2.0.pre.alpha.1's singular
+      # content would flatten.
+      class LocalizedName < ::Relaton::Bib::TypedLocalizedString
         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

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

@@ -3,6 +3,11 @@
 module Metanorma
   module Document
     module Relaton
+      # Logo image of an organization, with its raw (e.g. inline SVG) payload.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Logo maps an
+      # attribute-only Image, dropping the inline <svg> payloads (over a
+      # thousand <path> elements) fixtures carry under <logo><image>;
+      # map_all_content preserves them raw.
       class LogoElement < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :content, :string

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

@@ -1,25 +1,14 @@
 # frozen_string_literal: true
 
+require "relaton/bib"
+
 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
+      # relaton-bib's element grammar matches metanorma biblio.rng; this gem's
+      # previous all-attribute mapping matched no valid metanorma document.
+      class MediumType < ::Relaton::Bib::Medium
       end
     end
   end

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

@@ -4,6 +4,8 @@ module Metanorma
   module Document
     module Relaton
       # An identifier of an organization according to an international identifier scheme.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1
+      # OrganizationType::Identifier lacks the @id attribute carried by fixtures.
       class OrgIdentifier < Lutaml::Model::Serializable
         attribute :id, :string
         attribute :type, :string

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

@@ -4,6 +4,8 @@ module Metanorma
   module Document
     module Relaton
       # A subdivision of an organization (e.g. committee, subcommittee, workgroup).
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Subdivision lacks
+      # identifier/@id and fmt-identifier, both carried by fixtures.
       class OrgSubdivision < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :subtype, :string

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

@@ -4,6 +4,8 @@ module Metanorma
   module Document
     module Relaton
       # An identifier of an organization subdivision.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1
+      # OrganizationType::Identifier lacks the @id attribute carried by fixtures.
       class OrgSubdivisionIdentifier < Lutaml::Model::Serializable
         attribute :id, :string
         attribute :type, :string

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

@@ -3,6 +3,9 @@
 module Metanorma
   module Document
     module Relaton
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Organization has
+      # no variant/variant-subdivision, its identifier lacks the @id attribute,
+      # and its Subdivision has no fmt-identifier — all carried by fixtures.
       class Organization < Contributor
         attribute :name, LocalizedName, collection: true
         attribute :variant, VariantOrgName, collection: true

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

@@ -1,10 +1,16 @@
 # frozen_string_literal: true
 
+require "relaton/bib"
+
 module Metanorma
   module Document
     module Relaton
       # Person associated with a bibliographic item.
-      class Person < Contributor
+      # Inherits relaton-bib's Person (gaining credential and address);
+      # all mappings are re-declared with Metanorma's richer model classes —
+      # relaton-bib 2.2.0.pre.alpha.1 sanitizes affiliation descriptions,
+      # has no contact wrapper, and types uri as a collection.
+      class Person < ::Relaton::Bib::Person
         attribute :name, FullName
         attribute :affiliation, Affiliation, collection: true
         attribute :identifier, PersonIdentifier, collection: true

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

@@ -4,6 +4,9 @@ module Metanorma
   module Document
     module Relaton
       # An identifier of a person according to an international identifier scheme.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Person::Identifier
+      # maps a type attribute plus element content, not our type/value
+      # attribute pair (no fixture coverage justifies a shape change).
       class PersonIdentifier < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :value, :string

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

@@ -3,6 +3,11 @@
 module Metanorma
   module Document
     module Relaton
+      # Geographic place of publication or production of a bibliographic item.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Place has no text
+      # content and no +region+ attribute — the text of <place>Geneva</place>
+      # (160 of 228 fixture place elements carry text) would serialize as
+      # <place/>.
       class PlaceType < Lutaml::Model::Serializable
         attribute :region_attr, :string
         attribute :region, RegionElement

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

@@ -1,17 +1,11 @@
 # frozen_string_literal: true
 
+require "relaton/bib"
+
 module Metanorma
   module Document
     module Relaton
-      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
+      class RegionElement < ::Relaton::Bib::Place::RegionType
       end
     end
   end

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

@@ -4,6 +4,8 @@ module Metanorma
   module Document
     module Relaton
       # Used to present a group of bibliographic items as a single group.
+      # Keep-forever (wave-5 sweep): collection-level grouping with no
+      # relaton-bib 2.2.0.pre.alpha.1 counterpart; not a migration candidate.
       class RelatonCollection < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :title, Metanorma::Document::Relaton::TypedTitleString,

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

@@ -4,6 +4,11 @@ module Metanorma
   module Document
     module Relaton
       # Series to which a bibliographic item belongs.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 maps partnumber/run
+      # as elements (ours are attributes; lutaml-model 0.8.17 cannot override an
+      # inherited element mapping with an attribute mapping without dropping the
+      # value on render), types title as a sanitized collection, and restricts
+      # type to main/alt while fixtures use stream/secondary/tertiary/intended.
       class SeriesType < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :formattedref, Metanorma::Document::Components::DataTypes::FormattedString
@@ -11,6 +16,7 @@ module Metanorma
         attribute :place, Metanorma::Document::Components::DataTypes::LocalizedString
         attribute :organization, Metanorma::Document::Relaton::Organization
         attribute :abbrev, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :abbreviation, Metanorma::Document::Components::DataTypes::LocalizedString
         attribute :from, Metanorma::Document::Relaton::DateTime
         attribute :to, Metanorma::Document::Relaton::DateTime
         attribute :number, :string
@@ -24,6 +30,7 @@ module Metanorma
           map_element "place", to: :place
           map_element "organization", to: :organization
           map_element "abbrev", to: :abbrev
+          map_element "abbreviation", to: :abbreviation
           map_element "from", to: :from
           map_element "to", to: :to
           map_element "number", to: :number

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

@@ -4,6 +4,10 @@ module Metanorma
   module Document
     module Relaton
       # A note associated with the bibliographic item.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Note lacks the
+      # +format+ attribute and sanitizes content to a raw string — fixtures
+      # carry <note format="text/plain"> and structured <p id="...">
+      # ParagraphBlocks.
       class TypedNote < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :format, :string

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

@@ -4,6 +4,10 @@ module Metanorma
   module Document
     module Relaton
       # A title of a bibliographic item, associated with a type of title.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Title sanitizes
+      # span/semx/link/fmt-* out of the content at assignment time and offers
+      # no structured inline elements (em/strong/sub/sup/tt/fn/stem/variant)
+      # as queryable readers.
       class TypedTitleString < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :format, :string

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

@@ -1,17 +1,12 @@
 # frozen_string_literal: true
 
+require "relaton/bib"
+
 module Metanorma
   module Document
     module Relaton
       # URI associated with a type.
-      class TypedUri < Metanorma::Document::Components::DataTypes::Uri
-        attribute :type, :string
-        attribute :content, :string
-
-        xml do
-          map_attribute "type", to: :type
-          map_content to: :content
-        end
+      class TypedUri < ::Relaton::Bib::Uri
       end
     end
   end

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

@@ -1,21 +1,19 @@
 # frozen_string_literal: true
 
+require "relaton/bib"
+
 module Metanorma
   module Document
     module Relaton
       # The time interval for which a bibliographic item
       # is determined valid, and the associated revision date.
-      class ValidityType < Lutaml::Model::Serializable
-        attribute :validity_begins, :string
-        attribute :validity_ends, :string
-        attribute :revision, :string
+      # Element names are identical; relaton-bib types the values :date_time
+      # per biblio.rng ISO8601Date (this gem previously used :string).
+      class ValidityType < ::Relaton::Bib::Validity
+        # Compatibility readers: relaton-bib names them +begins+/+ends+.
+        def validity_begins = begins
 
-        xml do
-          element "validity"
-          map_element "validityBegins", to: :validity_begins
-          map_element "validityEnds", to: :validity_ends
-          map_element "revision", to: :revision
-        end
+        def validity_ends = ends
       end
     end
   end

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

@@ -4,6 +4,9 @@ module Metanorma
   module Document
     module Relaton
       # A variant name of a person.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 inlines the name
+      # fields under variant; ours wraps a FullName in content (no fixture
+      # coverage justifies a shape change).
       class VariantFullName < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :content, Metanorma::Document::Relaton::FullName

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

@@ -4,6 +4,9 @@ module Metanorma
   module Document
     module Relaton
       # A variant name of an organization.
+      # Keep-forever (wave-5 sweep): relaton-bib 2.2.0.pre.alpha.1 inlines
+      # variant name fields and has no variant wrapper class; not a migration
+      # candidate.
       class VariantOrgName < Lutaml::Model::Serializable
         attribute :type, :string
         attribute :content, Metanorma::Document::Components::DataTypes::LocalizedString

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

@@ -4,6 +4,11 @@ module Metanorma
   module Document
     module Relaton
       # A version of the bibliographic item (within an edition). Can be used for drafts.
+      # Keeps its own mapping: relaton-bib 2.2.0.pre.alpha.1 Version folds
+      # draft and revision-date into a synthesized content string — its
+      # #revision_date and #draft readers return nil — while fixtures carry
+      # structured version elements (iso-is: revision-date) that must stay
+      # readable and round-trip as elements.
       class VersionInfo < Lutaml::Model::Serializable
         attribute :revision_date, :string
         attribute :draft, :string

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

@@ -1,21 +1,15 @@
 # frozen_string_literal: true
 
+require "relaton/bib"
+
 module Metanorma
   module Document
     module Relaton
       # Item in a controlled vocabulary.
-      class VocabIdType < Lutaml::Model::Serializable
-        attribute :type, :string
-        attribute :uri, :string
-        attribute :code, :string
-        attribute :term, Metanorma::Document::Relaton::VocabIdType
-
-        xml do
-          map_attribute "type", to: :type
-          map_attribute "uri", to: :uri
-          map_attribute "code", to: :code
-          map_element "term", to: :term
-        end
+      # relaton-bib's vocabid matches metanorma biblio.rng: +code+ and +term+
+      # are child elements (this gem previously had +code+ as an attribute
+      # and a recursive +term+).
+      class VocabIdType < ::Relaton::Bib::Keyword::Vocabid
       end
     end
   end

data/lib/metanorma/document/relaton.rb

@@ -10,11 +10,8 @@ module Metanorma
       autoload :Affiliation, "#{__dir__}/relaton/affiliation"
       autoload :BibItemLocality, "#{__dir__}/relaton/bib_item_locality"
       autoload :BibItemSize, "#{__dir__}/relaton/bib_item_size"
-      autoload :BibItemSizeType, "#{__dir__}/relaton/bib_item_size_type"
       autoload :BibItemType, "#{__dir__}/relaton/bib_item_type"
       autoload :BibliographicDate, "#{__dir__}/relaton/bibliographic_date"
-      autoload :BibliographicDateType,
-               "#{__dir__}/relaton/bibliographic_date_type"
       autoload :ContactMethod, "#{__dir__}/relaton/contact_method"
       autoload :ContributionInfo, "#{__dir__}/relaton/contribution_info"
       autoload :Contributor, "#{__dir__}/relaton/contributor"
@@ -24,13 +21,9 @@ module Metanorma
       autoload :DateTime, "#{__dir__}/relaton/date_time"
       autoload :DocumentIdentifier, "#{__dir__}/relaton/document_identifier"
       autoload :DocumentRelation, "#{__dir__}/relaton/document_relation"
-      autoload :DocumentRelationType,
-               "#{__dir__}/relaton/document_relation_type"
       autoload :DocumentStatus, "#{__dir__}/relaton/document_status"
       autoload :Edition, "#{__dir__}/relaton/edition"
       autoload :FullName, "#{__dir__}/relaton/full_name"
-      autoload :Iso4217Code, "#{__dir__}/relaton/iso4217_code"
-      autoload :Iso8601Date, "#{__dir__}/relaton/iso8601_date"
       autoload :KeywordType, "#{__dir__}/relaton/keyword_type"
       autoload :LocalizedName, "#{__dir__}/relaton/localized_name"
       autoload :LogoElement, "#{__dir__}/relaton/logo_element"
@@ -43,19 +36,12 @@ module Metanorma
       autoload :Organization, "#{__dir__}/relaton/organization"
       autoload :Person, "#{__dir__}/relaton/person"
       autoload :PersonIdentifier, "#{__dir__}/relaton/person_identifier"
-      autoload :PersonalIdentifierType,
-               "#{__dir__}/relaton/personal_identifier_type"
       autoload :Phone, "#{__dir__}/relaton/phone"
       autoload :PlaceType, "#{__dir__}/relaton/place_type"
       autoload :PriceType, "#{__dir__}/relaton/price_type"
-      autoload :RegionType, "#{__dir__}/relaton/region_type"
       autoload :RegionElement, "#{__dir__}/relaton/region_element"
       autoload :RelatonCollection, "#{__dir__}/relaton/relaton_collection"
       autoload :SeriesType, "#{__dir__}/relaton/series_type"
-      autoload :SeriesTypeType, "#{__dir__}/relaton/series_type_type"
-      autoload :SpecificLocalityType,
-               "#{__dir__}/relaton/specific_locality_type"
-      autoload :TitleType, "#{__dir__}/relaton/title_type"
       autoload :TypedNote, "#{__dir__}/relaton/typed_note"
       autoload :TypedTitleString, "#{__dir__}/relaton/typed_title_string"
       autoload :TypedUri, "#{__dir__}/relaton/typed_uri"

data/lib/metanorma/document/version.rb

@@ -2,7 +2,7 @@
 
 module Metanorma
   module Document
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
     Version = VERSION
   end
 end

data/lib/metanorma/document.rb

@@ -46,6 +46,7 @@ module Metanorma
   autoload :IhoDocument, "metanorma/iho_document"
   autoload :OimlDocument, "metanorma/oiml_document"
   autoload :CcDocument, "metanorma/cc_document"
+  autoload :CsaDocument, "metanorma/csa_document"
   autoload :BipmDocument, "metanorma/bipm_document"
   autoload :BsiDocument, "metanorma/bsi_document"
   autoload :GbDocument, "metanorma/gb_document"