relaton-bib 1.17.1 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a507a7fa74bc5be4e5148c8f80f91dc77a602b356187168d412beb958d30ad67
-  data.tar.gz: 41d821df9469b709f76d98288d6ec80fa0959d3d6e7ab867f08095283ed3eaf9
+  metadata.gz: 197eed529f341b3a7ab7a6338c16d8710368b98c92895bdc821e26b3957d73d3
+  data.tar.gz: be9700cd1bbe4c537d4e2f70069ce3e53d3ebd6beaca7b2cde9a267734babf5c
 SHA512:
-  metadata.gz: 0d1daace14ed81e05633e2340d26c1f591afcb8d5ea8b742c3cabe66e74f92def40966a20fadbd182b1b4808e6cbfa3cae9f1abb3dd40035ad2c2bc118392d85
-  data.tar.gz: a08ae4ae1f9c3563c242d8940172cf44bd23e182237b39d91a37f572719694695bbaf9b5805bfcafb76e201eaead8506a8bd878ec8f0aed7722c7d6815e19441
+  metadata.gz: 0b32e72e09b9be3d0baeec2d45ef8bc8923d042c6280743edd6544204e6a67f0ad0af3aede78b48149cfcd308ef0a262978e1077a5ba02c0ca94114401c0ca5b
+  data.tar.gz: 8367c7d376ebbae8a555cb135bd14f0b1fc3d16bb3aa2233f39b015c81d68118701540655139c6922137487e7bd59701c44d8d9763072a21f5065b7064db2db7

data/.github/workflows/rake.yml

@@ -10,4 +10,4 @@ on:
 
 jobs:
   rake:
-    uses: relaton/support/.github/workflows/rake.yml@master
+    uses: relaton/support/.github/workflows/rake.yml@main

data/.github/workflows/release.yml

@@ -17,7 +17,7 @@ on:
 
 jobs:
   release:
-    uses: relaton/support/.github/workflows/release.yml@master
+    uses: relaton/support/.github/workflows/release.yml@main
     with:
       next_version: ${{ github.event.inputs.next_version }}
     secrets:

data/grammars/basicdoc.rng

@@ -95,8 +95,89 @@
       <ref name="pagebreak"/>
       <ref name="hr"/>
       <ref name="bookmark"/>
+      <ref name="amend"/>
     </choice>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <ref name="AmendType"/>
+    </element>
+  </define>
+  <define name="AmendType">
+    <optional>
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+    </optional>
+    <attribute name="change">
+      <choice>
+        <value>add</value>
+        <value>modify</value>
+        <value>delete</value>
+        <value>replace</value>
+      </choice>
+    </attribute>
+    <optional>
+      <attribute name="path"/>
+    </optional>
+    <optional>
+      <attribute name="path_end"/>
+    </optional>
+    <optional>
+      <attribute name="title"/>
+    </optional>
+    <optional>
+      <element name="location">
+        <zeroOrMore>
+          <choice>
+            <ref name="locality"/>
+            <ref name="localityStack"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="description">
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="newcontent">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="contributor"/>
+    </zeroOrMore>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
   <define name="paragraph">
     <element name="p">
       <ref name="ParagraphType"/>
@@ -715,27 +796,36 @@
   </define>
   <define name="ruby">
     <element name="ruby">
-      <zeroOrMore>
-        <choice>
-          <ref name="PureTextElement"/>
-          <ref name="rp"/>
-          <ref name="rt"/>
-        </choice>
-      </zeroOrMore>
+      <choice>
+        <ref name="ruby_pronunciation"/>
+        <ref name="ruby_annotation"/>
+      </choice>
+      <choice>
+        <text/>
+        <ref name="ruby"/>
+      </choice>
     </element>
   </define>
-  <define name="rp">
-    <element name="rp">
-      <zeroOrMore>
-        <ref name="PureTextElement"/>
-      </zeroOrMore>
+  <define name="ruby_pronunciation">
+    <element name="pronunciation">
+      <attribute name="value"/>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="lang"/>
+      </optional>
     </element>
   </define>
-  <define name="rt">
-    <element name="rt">
-      <zeroOrMore>
-        <ref name="PureTextElement"/>
-      </zeroOrMore>
+  <define name="ruby_annotation">
+    <element name="annotation">
+      <attribute name="value"/>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="lang"/>
+      </optional>
     </element>
   </define>
   <define name="br">
@@ -930,18 +1020,12 @@
     </optional>
     <optional>
       <attribute name="width">
-        <choice>
-          <data type="int"/>
-          <value>auto</value>
-        </choice>
+        <ref name="ImageSize"/>
       </attribute>
     </optional>
     <optional>
       <attribute name="height">
-        <choice>
-          <data type="int"/>
-          <value>auto</value>
-        </choice>
+        <ref name="ImageSize"/>
       </attribute>
     </optional>
     <optional>
@@ -956,6 +1040,14 @@
       </attribute>
     </optional>
   </define>
+  <define name="ImageSize">
+    <choice>
+      <data type="string">
+        <param name="pattern">\d+([.]\d+)?(%?)</param>
+      </data>
+      <value>auto</value>
+    </choice>
+  </define>
   <define name="video">
     <element name="video">
       <attribute name="id">

data/grammars/biblio-standoc.rng

@@ -9,11 +9,42 @@
   -->
   <include href="biblio.rng">
     <define name="BibData">
-      <ref name="BibliographicItem"/>
+      <ref name="StandardBibliographicItem"/>
       <optional>
         <ref name="ext"/>
       </optional>
     </define>
+    <define name="docrelation">
+      <element name="relation">
+        <attribute name="type">
+          <ref name="DocRelationType"/>
+        </attribute>
+        <optional>
+          <element name="description">
+            <ref name="FormattedString"/>
+          </element>
+        </optional>
+        <element name="bibitem">
+          <ref name="StandardReducedBibliographicItem"/>
+        </element>
+        <choice>
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="localityStack"/>
+          </zeroOrMore>
+        </choice>
+        <choice>
+          <zeroOrMore>
+            <ref name="sourceLocality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="sourceLocalityStack"/>
+          </zeroOrMore>
+        </choice>
+      </element>
+    </define>
   </include>
   <define name="ext">
     <element name="ext">
@@ -161,4 +192,16 @@
       </optional>
     </element>
   </define>
+  <define name="StandardBibliographicItem">
+    <ref name="BibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
+  <define name="StandardReducedBibliographicItem">
+    <ref name="ReducedBibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
 </grammar>

data/grammars/biblio.rng

@@ -241,6 +241,9 @@
     </element>
   </define>
   <define name="FullNameType">
+    <optional>
+      <ref name="name_abbreviation"/>
+    </optional>
     <choice>
       <group>
         <zeroOrMore>
@@ -266,6 +269,11 @@
       <ref name="variantname"/>
     </zeroOrMore>
   </define>
+  <define name="name_abbreviation">
+    <element name="abbreviation">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
   <define name="prefix">
     <element name="prefix">
       <ref name="LocalizedString"/>
@@ -870,6 +878,9 @@
     <optional>
       <ref name="validity"/>
     </optional>
+    <optional>
+      <ref name="depiction"/>
+    </optional>
   </define>
   <define name="btitle">
     <element name="title">

data/grammars/versions.json

@@ -1,7 +1,7 @@
 {
-"relaton-models": "v1.2.7",
-"basicdoc-models": "v1.0.3",
-"metanorma-requirements-models": "v1.0.0",
+"relaton-models": "v1.2.8",
+"basicdoc-models": "v1.1.2",
+"metanorma-requirements-models": "v1.0.1",
 "relaton-model-ieee": "v1.0.1",
 "relaton-model-iso": "v1.0.0",
 "relaton-model-iec": "v1.0.0",
@@ -29,6 +29,6 @@
 "relaton-model-oasis": "v1.0.1",
 "relaton-model-jis": "v0.0.1",
 "relaton-model-etsi": "v0.0.3",
-"metanorma-model": "v1.2.9",
-"date": "2023-12-02T16:19:25Z"
+"metanorma-model": "v1.2.11",
+"date": "2024-01-04T03:55:06Z"
 }

data/lib/relaton_bib/bibtex_parser.rb

@@ -78,54 +78,50 @@ module RelatonBib
 
       # @param bibtex [BibTeX::Entry]
       # @return [Array<Hash>]
-      def fetch_contributor(bibtex) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
-        contributor = []
-        fetch_person(bibtex["author"]).each do |entity|
-          contributor << { entity: entity, role: [{ type: "author" }] }
-        end
+      def fetch_contributor(bibtex) # rubocop:disable Metrics/AbcSize
+        contribs = []
+        fetch_person(bibtex, "author") { |author| contribs << author }
+        fetch_person(bibtex, "editor") { |editor| contribs << editor }
 
-        fetch_person(bibtex["editor"]).each do |entity|
-          contributor << { entity: entity, role: [{ type: "editor" }] }
-        end
+        fetch_org(bibtex["publisher"], "publisher") { |pub| contribs << pub }
+        fetch_org(bibtex["institution"], "distributor", "sponsor") { |distr| contribs << distr }
+        fetch_org(bibtex["organization"], "distributor", "sponsor") { |org| contribs << org }
+        fetch_org(bibtex["school"], "distributor", "sponsor") { |school| contribs << school }
 
-        if bibtex["publisher"]
-          contributor << { entity: { name: bibtex.publisher.to_s }, role: [{ type: "publisher" }] }
-        end
+        fetch_howpublished(bibtex) { |pub| contribs << pub }
 
-        if bibtex["institution"]
-          contributor << {
-            entity: { name: bibtex.institution.to_s },
-            role: [{ type: "distributor", description: ["sponsor"] }],
-          }
-        end
+        contribs
+      end
 
-        if bibtex["organization"]
-          contributor << {
-            entity: { name: bibtex.organization.to_s },
-            role: [{ type: "distributor", description: ["sponsor"] }],
-          }
-        end
+      def fetch_howpublished(bibtex, &_)
+        return unless bibtex["howpublished"]
 
-        if bibtex["school"]
-          contributor << {
-            entity: { name: bibtex.school.to_s },
-            role: [{ type: "distributor", description: ["sponsor"] }],
-          }
-        end
-        contributor
+        /\\publisher\{(?<name>.+)\},\\url\{(?<url>.+)\}/ =~ bibtex.howpublished.to_s
+        return unless name && url
+
+        name.gsub!(/\{\\?([^\\]+)\}/, '\1')
+        org = Organization.new(name: name, url: url)
+        yield entity: org, role: [{ type: "publisher" }]
+      end
+
+      def fetch_org(org, type, desc = nil, &_)
+        return unless org
+
+        role = { type: type }
+        role[:description] = [desc] if desc
+        yield entity: Organization.new(name: org.to_s), role: [role]
       end
 
       # @param bibtex [BibTeX::Entry]
       # @return [Array<RelatonBib::Person>]
-      def fetch_person(person)
-        return [] unless person
-
-        person.map do |name|
+      def fetch_person(bibtex, role, &_) # rubocop:disable Metrics/AbcSize
+        bibtex[role]&.each do |name|
           parts = name.split ", "
           surname = LocalizedString.new parts.first
           fname = parts.size > 1 ? parts[1].split : []
           forename = fname.map { |fn| Forename.new content: fn }
-          Person.new name: FullName.new(surname: surname, forename: forename)
+          name = FullName.new(surname: surname, forename: forename)
+          yield entity: Person.new(name: name), role: [{ type: role }]
         end
       end
 
@@ -147,7 +143,7 @@ module RelatonBib
 
       # @param bibtex [BibTeX::Entry]
       # @return [RelatonBib::BiblioNoteCollection]
-      def fetch_note(bibtex)
+      def fetch_note(bibtex) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
         bibtex.select do |k, _v|
           %i[annote howpublished comment note content].include? k
         end.reduce(BiblioNoteCollection.new([])) do |mem, note|
@@ -156,6 +152,8 @@ module RelatonBib
                  when :content then "tableOfContents"
                  else note[0].to_s
                  end
+          next mem if type == "howpublished" && note[1].to_s.match?(/^\\publisher\{.+\},\\url\{.+\}$/)
+
           mem << BiblioNote.new(type: type, content: note[1].to_s)
         end
       end

data/lib/relaton_bib/contributor.rb

@@ -84,24 +84,33 @@ module RelatonBib
     # @return [String] allowed "phone", "email" or "uri"
     attr_reader :type
 
+    # @return [String, nil]
+    attr_reader :subtype
+
     # @return [String]
     attr_reader :value
 
     # @param type [String] allowed "phone", "email" or "uri"
+    # @param subtype [String, nil] i.e. "fax", "mobile", "landline" for "phone"
+    #                              or "work", "personal" for "uri" type
     # @param value [String]
-    def initialize(type:, value:)
-      @type  = type
-      @value = value
+    def initialize(type:, value:, subtype: nil)
+      @type     = type
+      @subtype  = subtype
+      @value    = value
     end
 
     # @param builder [Nokogiri::XML::Document]
-    def to_xml(doc)
-      doc.send type, value
+    def to_xml(builder)
+      node = builder.send type, value
+      node["type"] = subtype if subtype
     end
 
     # @return [Hash]
     def to_hash
-      { type => value }
+      hash = { type => value }
+      hash["type"] = subtype if subtype
+      hash
     end
 
     # @param prefix [String]
@@ -110,8 +119,8 @@ module RelatonBib
     def to_asciibib(prefix = "", count = 1)
       pref = prefix.empty? ? prefix : "#{prefix}."
       out = count > 1 ? "#{pref}contact::\n" : ""
-      # out += "#{pref}contact.type:: #{type}\n"
       out += "#{pref}contact.#{type}:: #{value}\n"
+      out += "#{pref}contact.type:: #{subtype}\n" if subtype
       out
     end
   end

data/lib/relaton_bib/document_type.rb

@@ -42,7 +42,7 @@ module RelatonBib
     # @return [String] AsciiBib representation
     #
     def to_asciibib(prefix = "")
-      pref = prefix.empty? ? prefix : prefix + "."
+      pref = prefix.empty? ? prefix : "#{prefix}."
       pref += "doctype."
       out = "#{pref}type:: #{@type}\n"
       out += "#{pref}abbreviation:: #{@abbreviation}\n" if @abbreviation

data/lib/relaton_bib/full_name.rb

@@ -7,35 +7,29 @@ module RelatonBib
     attr_accessor :forename
 
     # @return [Array<RelatonBib::LocalizedString>]
-    attr_accessor :initials
+    attr_accessor :initials, :addition, :prefix
 
     # @return [RelatonBib::LocalizedString, nil]
-    attr_accessor :surname, :completename
-
-    # @return [Array<RelatonBib::LocalizedString>]
-    attr_accessor :addition
-
-    # @return [Array<RelatonBib::LocalizedString>]
-    attr_accessor :prefix
+    attr_accessor :surname, :abbreviation, :completename
 
     #
     # Initialize FullName instance
     #
-    # @param surname [RelatonBib::LocalizedString, nil] surname or completename
-    #   should be present
+    # @param surname [RelatonBib::LocalizedString, nil] surname or completename should be present
+    # @param abbreviation [RelatonBib::LocalizedString, nil] abbreviation
     # @param forename [Array<RelatonBib::Forename>] forename
     # @param initials [RelatonBib::LocalizedString, String, nil] string of initials
     # @param addition [Array<RelatonBib::LocalizedString>] array of additions
     # @param prefix [Array<RelatonBib::LocalizedString>] array of prefixes
-    # @param completename [RelatonBib::LocalizedString, nil] completename or
-    #   surname should be present
+    # @param completename [RelatonBib::LocalizedString, nil] completename or surname should be present
     #
-    def initialize(**args)
+    def initialize(**args) # rubocop:disable Metrics/AbcSize
       unless args[:surname] || args[:completename]
         raise ArgumentError, "Should be given :surname or :completename"
       end
 
       @surname      = args[:surname]
+      @abbreviation = args[:abbreviation]
       @forename     = args.fetch :forename, []
       @initials     = args[:initials].is_a?(String) ? LocalizedString.new(args[:initials]) : args[:initials]
       @addition     = args.fetch :addition, []
@@ -48,6 +42,7 @@ module RelatonBib
     # @option opts [String] :lang language
     def to_xml(**opts) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       opts[:builder].name do |builder|
+        builder.abbreviation { abbreviation.to_xml builder } if abbreviation
         if completename
           builder.completename { completename.to_xml builder }
         else
@@ -69,6 +64,7 @@ module RelatonBib
     # @return [Hash]
     def to_hash # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
       hash = {}
+      hash["abbreviation"] = abbreviation.to_hash if abbreviation
       if forename.any? || initials
         hash["given"] = {}
         hash["given"]["forename"] = single_element_array(forename) if forename&.any?
@@ -86,8 +82,10 @@ module RelatonBib
     def to_asciibib(pref) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
       prf = pref.empty? ? pref : "#{pref}."
       prf += "name"
+      out = ""
+      out += abbreviation.to_asciibib "#{prf}.abbreviation" if abbreviation
       given = "#{pref}.given"
-      out = forename.map do |fn|
+      out += forename.map do |fn|
         fn.to_asciibib given, forename.size
       end.join
       out += initials.to_asciibib "#{given}.formatted-initials" if initials

data/lib/relaton_bib/hash_converter.rb

@@ -232,12 +232,14 @@ module RelatonBib
         LocalizedString.new sd
       end
       org[:contact] = contacts_hash_to_bib(org)
+      org[:logo] = Image.new(**org[:logo][:image]) if org[:logo]
       org
     end
 
     def person_hash_to_bib(person)
       Person.new(
         name: fullname_hash_to_bib(person),
+        credential: RelatonBib.array(person[:credential]),
         affiliation: affiliation_hash_to_bib(person),
         contact: contacts_hash_to_bib(person),
         identifier: person_identifiers_hash_to_bib(person),
@@ -248,6 +250,7 @@ module RelatonBib
       n = person[:name]
       fname, inits = given_hash_to_bib n[:given] || n # `n` is for backward compatibility
       FullName.new(
+        abbreviation: localizedstring(n[:abbreviation]),
         forename: fname, initials: inits,
         addition: RelatonBib.array(n[:addition])&.map { |f| localizedstring(f) },
         prefix: RelatonBib.array(n[:prefix])&.map { |f| localizedstring(f) },
@@ -289,31 +292,29 @@ module RelatonBib
                 end
           FormattedString.new(**cnt)
         end
-        name = LocalizedString.new(a[:name][:content], a[:name][:language], a[:name][:script]) if a[:name]
         Affiliation.new(
           organization: Organization.new(**org_hash_to_bib(a[:organization])),
-          description: a[:description], name: name
+          description: a[:description], name: localizedstring(a[:name])
         )
       end
     end
 
-    def contacts_hash_to_bib(entity) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength,Metrics/PerceivedComplexity,Metrics/CyclomaticComplexity
+    def contacts_hash_to_bib(entity) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity
       return [] unless entity[:contact]
 
       RelatonBib.array(entity[:contact]).map do |a|
-        if a[:city] || a[:country] # it's for old version compatibility, should be removed in the future
-          RelatonBib::Address.new(
-            street: Array(a[:street]), city: a[:city], postcode: a[:postcode],
-            country: a[:country], state: a[:state]
-          )
-        elsif a[:address]
+        type, value = a.reject { |k, _| k == :type }.flatten
+        case type
+        when :street, :city, :state, :country, :postcode # it's for old version compatibility, should be removed in the future
+          a[:street] = RelatonBib.array(a[:street])
+          Address.new(**a)
+        when :address
           a[:address][:street] = RelatonBib.array(a[:address][:street])
-          RelatonBib::Address.new(**a[:address])
-        elsif a[:type] # it's for old version compatibility, should be removed in the future
-          RelatonBib::Contact.new(type: a[:type], value: a[:value])
-        else
-          type, value = a.flatten
-          RelatonBib::Contact.new(type: type.to_s, value: value)
+          Address.new(**a[:address])
+        when :phone, :email, :uri
+          Contact.new(type: type.to_s, value: value, subtype: a[:type])
+        else # it's for old version compatibility, should be removed in the future
+          Contact.new(**a)
         end
       end
     end

data/lib/relaton_bib/image.rb

@@ -0,0 +1,90 @@
+module RelatonBib
+  class Image
+    # @return [String]
+    attr_reader :id, :src, :mimetype, :filename, :width, :height, :alt, :title, :longdesc
+
+    #
+    # Initializes a new Image object.
+    #
+    # @param id [String] the ID of the image
+    # @param src [String] the source URL of the image
+    # @param mimetype [String] the MIME type of the image
+    # @param args [Hash] additional arguments
+    # @option args [String] :filename the filename of the image
+    # @option args [String] :width the width of the image
+    # @option args [String] :height the height of the image
+    # @option args [String] :alt the alternative text for the image
+    # @option args [String] :title the title of the image
+    # @option args [String] :longdesc the long description of the image
+    #
+    def initialize(id:, src:, mimetype:, **args)
+      @id = id
+      @src = src
+      @mimetype = mimetype
+      @filename = args[:filename]
+      @width = args[:width]
+      @height = args[:height]
+      @alt = args[:alt]
+      @title = args[:title]
+      @longdesc = args[:longdesc]
+    end
+
+    #
+    # Converts the image object to XML format.
+    #
+    # @param [Nokogiri::XML::Builder] builder The XML builder object.
+    #
+    # @return [void]
+    #
+    def to_xml(builder) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
+      builder.image do
+        builder.parent[:id] = id
+        builder.parent[:src] = src
+        builder.parent[:mimetype] = mimetype
+        builder.parent[:filename] = filename if filename
+        builder.parent[:width] = width if width
+        builder.parent[:height] = height if height
+        builder.parent[:alt] = alt if alt
+        builder.parent[:title] = title if title
+        builder.parent[:longdesc] = longdesc if longdesc
+      end
+    end
+
+    #
+    # Converts the Image object to a hash representation.
+    #
+    # @return [Hash] The hash representation of the Image object.
+    #
+    def to_hash # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity
+      hash = { "image" => { "id" => id, "src" => src, "mimetype" => mimetype } }
+      hash["image"]["filename"] = filename if filename
+      hash["image"]["width"] = width if width
+      hash["image"]["height"] = height if height
+      hash["image"]["alt"] = alt if alt
+      hash["image"]["title"] = title if title
+      hash["image"]["longdesc"] = longdesc if longdesc
+      hash
+    end
+
+    #
+    # Converts the image object to AsciiBib format.
+    #
+    # @param prefix [String] The prefix to be added to the AsciiBib output.
+    #
+    # @return [String] The image object converted to AsciiBib format.
+    #
+    def to_asciibib(prefix = "") # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength
+      pref = prefix.empty? ? "image." : "#{prefix}.image."
+      out = "#{pref}id:: #{id}\n"
+      out += "#{pref}src:: #{src}\n"
+      out += "#{pref}mimetype:: #{mimetype}\n"
+      out += "#{pref}filename:: #{filename}\n" if filename
+      out += "#{pref}width:: #{width}\n" if width
+      out += "#{pref}height:: #{height}\n" if height
+      out += "#{pref}alt:: #{alt}\n" if alt
+      out += "#{pref}title:: #{title}\n" if title
+      out += "#{pref}longdesc:: #{longdesc}\n" if longdesc
+      out
+    end
+  end
+end

data/lib/relaton_bib/organization.rb

@@ -61,12 +61,16 @@ module RelatonBib
     # @return [Array<RelatonBib::OrgIdentifier>]
     attr_reader :identifier
 
+    # @return [RelatonBib::Image, nil]
+    attr_reader :logo
+
     # @param name [String, Hash, Array<String, Hash>]
     # @param abbreviation [RelatoBib::LocalizedString, String]
     # @param subdivision [Array<RelatoBib::LocalizedString>]
     # @param url [String]
     # @param identifier [Array<RelatonBib::OrgIdentifier>]
     # @param contact [Array<RelatonBib::Address, RelatonBib::Contact>]
+    # @param logo [RelatonBib::Image, nil]
     def initialize(**args) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       raise ArgumentError, "missing keyword: name" unless args[:name]
 
@@ -83,6 +87,7 @@ module RelatonBib
         localized_string sd
       end
       @identifier = args.fetch(:identifier, [])
+      @logo = args[:logo]
     end
 
     # @param opts [Hash]
@@ -100,24 +105,26 @@ module RelatonBib
         builder.uri url if uri
         identifier.each { |identifier| identifier.to_xml builder }
         super builder
+        builder.logo { |b| logo.to_xml b } if logo
       end
     end
 
     # @return [Hash]
-    def to_hash # rubocop:disable Metrics/AbcSize
+    def to_hash # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity
       hash = { "name" => single_element_array(name) }
       hash["abbreviation"] = abbreviation.to_hash if abbreviation
       hash["identifier"] = single_element_array(identifier) if identifier&.any?
       if subdivision&.any?
         hash["subdivision"] = single_element_array(subdivision)
       end
+      hash["logo"] = logo.to_hash if logo
       { "organization" => hash.merge(super) }
     end
 
     # @param prefix [String]
     # @param count [Integer]
     # @return [String]
-    def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
+    def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
       pref = prefix.sub(/\*$/, "organization")
       out = count > 1 ? "#{pref}::\n" : ""
       name.each { |n| out += n.to_asciibib "#{pref}.name", name.size }
@@ -128,6 +135,7 @@ module RelatonBib
       end
       identifier.each { |n| out += n.to_asciibib pref, identifier.size }
       out += super pref
+      out += logo.to_asciibib "#{pref}.logo" if logo
       out
     end
 

data/lib/relaton_bib/person.rb

@@ -66,6 +66,9 @@ module RelatonBib
     # @return [RelatonBib::FullName]
     attr_accessor :name
 
+    # @return [Array<String>]
+    attr_reader :credential
+
     # @return [Array<RelatonBib::Affiliation>]
     attr_accessor :affiliation
 
@@ -73,24 +76,27 @@ module RelatonBib
     attr_accessor :identifier
 
     # @param name [RelatonBib::FullName]
+    # @param credential [Array<String>]
     # @param affiliation [Array<RelatonBib::Affiliation>]
     # @param contact [Array<RelatonBib::Address, RelatonBib::Contact>]
     # @param identifier [Array<RelatonBib::PersonIdentifier>]
     # @param url [String, nil]
-    def initialize(name:, affiliation: [], contact: [], identifier: [],
-                   url: nil)
-      super(contact: contact, url: url)
+    def initialize(name:, **args)
+      contact = args[:contact] || []
+      super(contact: contact, url: args[:url])
       @name        = name
-      @affiliation = affiliation
-      @identifier = identifier
+      @credential  = args[:credential] || []
+      @affiliation = args[:affiliation] || []
+      @identifier = args[:identifier] || []
     end
 
     # @param opts [Hash]
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [String, Symbol] :lang language
-    def to_xml(**opts)
+    def to_xml(**opts) # rubocop:disable Metrics/AbcSize
       opts[:builder].person do |builder|
         name.to_xml(**opts)
+        credential.each { |c| builder.credential c }
         affiliation.each { |a| a.to_xml(**opts) }
         identifier.each { |id| id.to_xml builder }
         contact.each { |contact| contact.to_xml builder }
@@ -98,12 +104,11 @@ module RelatonBib
     end
 
     # @return [Hash]
-    def to_hash
+    def to_hash # rubocop:disable Metrics/AbcSize
       hash = { "name" => name.to_hash }
-      if affiliation&.any?
-        hash["affiliation"] = single_element_array(affiliation)
-      end
-      hash["identifier"] = single_element_array(identifier) if identifier&.any?
+      hash["credential"] = credential if credential.any?
+      hash["affiliation"] = affiliation.map &:to_hash if affiliation.any?
+      hash["identifier"] = identifier.map &:to_hash if identifier.any?
       { "person" => hash.merge(super) }
     end
 
@@ -114,6 +119,7 @@ module RelatonBib
       pref = prefix.sub(/\*$/, "person")
       out = count > 1 ? "#{pref}::\n" : ""
       out += name.to_asciibib pref
+      credential.each { |c| out += "#{pref}.credential:: #{c}\n" }
       affiliation.each { |af| out += af.to_asciibib pref, affiliation.size }
       identifier.each { |id| out += id.to_asciibib pref, identifier.size }
       out += super pref

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "1.17.1".freeze
+  VERSION = "1.18.0".freeze
 end

data/lib/relaton_bib/xml_parser.rb

@@ -379,13 +379,20 @@ module RelatonBib
         end
         subdiv = org.xpath("subdivision").map &:text
         contact = parse_contact org
+        logo = fetch_image org.at("./logo/image")
         Organization.new(
           name: names, abbreviation: org.at("abbreviation")&.text,
           subdivision: subdiv, # url: org.at("uri")&.text,
-          identifier: identifier, contact: contact
+          identifier: identifier, contact: contact, logo: logo
         )
       end
 
+      def fetch_image(elm)
+        return unless elm
+
+        Image.new(**elm.to_h.transform_keys(&:to_sym))
+      end
+
       #
       # Parse person from XML
       #
@@ -403,25 +410,27 @@ module RelatonBib
           PersonIdentifier.new pi[:type], pi.text
         end
 
-        cname = localized_string person.at("./name/completename")
-        sname = localized_string person.at("./name/surname")
-
-        name = FullName.new(
-          completename: cname, surname: sname,
-          initials: parse_initials(person),
-          forename: parse_forename(person),
-          addition: name_part(person, "addition"),
-          prefix: name_part(person, "prefix")
-        )
-
         Person.new(
-          name: name,
+          name: full_name(person.at("./name")),
+          credential: person.xpath("./credential").map(&:text),
           affiliation: affiliations,
           contact: contact,
           identifier: identifier,
         )
       end
 
+      def full_name(name)
+        cname = localized_string name.at("./completename")
+        sname = localized_string name.at("./surname")
+        abbreviation = localized_string name.at("./abbreviation")
+
+        FullName.new(
+          completename: cname, surname: sname, abbreviation: abbreviation,
+          initials: parse_initials(name), forename: parse_forename(name),
+          addition: name_part(name, "addition"), prefix: name_part(name, "prefix")
+        )
+      end
+
       def fetch_affiliation(elm)
         org = get_org elm.at("./organization")
         desc = elm.xpath("./description").map do |e|
@@ -447,7 +456,7 @@ module RelatonBib
       #
       def parse_contact(contrib)
         contrib.xpath("./address|./phone|./email|./uri").map do |c|
-          parse_address(c) || Contact.new(type: c.name, value: c.text)
+          parse_address(c) || Contact.new(type: c.name, value: c.text, subtype: c[:type])
         end
       end
 
@@ -474,23 +483,23 @@ module RelatonBib
       #
       # Parse initials
       #
-      # @param [Nokogiri::XML::Element] person person element
+      # @param [Nokogiri::XML::Element] name person name element
       #
       # @return [RelatonBib::LocalizedString, nil] initials
       #
-      def parse_initials(person)
-        localized_string person.at("./name/formatted-initials")
+      def parse_initials(name)
+        localized_string name.at("./formatted-initials")
       end
 
       #
       # Parse forename
       #
-      # @param [Nokogiri::XML::Element] person person element
+      # @param [Nokogiri::XML::Element] name person name element
       #
       # @return [Array<RelatonBib::Forename>] forenames
       #
-      def parse_forename(person)
-        person.xpath("./name/forename").map do |np|
+      def parse_forename(name)
+        name.xpath("./forename").map do |np|
           args = np.attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_s }
           args[:content] = np.text
           Forename.new(**args)
@@ -500,13 +509,13 @@ module RelatonBib
       #
       # Parse name part
       #
-      # @param [Nokogiri::XML::Element] person person element
+      # @param [Nokogiri::XML::Element] name person name element
       # @param [String] part name part
       #
       # @return [Array<RelatonBib::LocalizedString>] name parts
       #
-      def name_part(person, part)
-        person.xpath("./name/#{part}").map { |np| localized_string np }
+      def name_part(name, part)
+        name.xpath("./#{part}").map { |np| localized_string np }
       end
 
       # @param item [Nokogiri::XML::Element]

data/lib/relaton_bib.rb

@@ -10,6 +10,7 @@ require "relaton_bib/forename"
 require "relaton_bib/full_name"
 require "relaton_bib/contributor"
 require "relaton_bib/document_type"
+require "relaton_bib/image"
 require "relaton_bib/bibliographic_item"
 require "relaton_bib/hit_collection"
 require "relaton_bib/hit"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 1.17.1
+  version: 1.18.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-03 00:00:00.000000000 Z
+date: 2024-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -138,6 +138,7 @@ files:
 - lib/relaton_bib/hit.rb
 - lib/relaton_bib/hit_collection.rb
 - lib/relaton_bib/ics.rb
+- lib/relaton_bib/image.rb
 - lib/relaton_bib/localized_string.rb
 - lib/relaton_bib/medium.rb
 - lib/relaton_bib/organization.rb