relaton-bib 1.13.12 → 1.13.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6ddb62c2750bc1f862980dfbe3c66e6e97db50b00550c794e1a9366265854e2
-  data.tar.gz: b170e48789567d8b97cb8f969a3afa6785e52ff5e0883a34f80ff09e52884cda
+  metadata.gz: 671f76b734663b36559289a0032f01224de697050deb9d46e151ee5542a8ed86
+  data.tar.gz: bdf85c3bb18e8e10f88ea50d887af27ed8db08721b2ca4ce070279bbb69ba818
 SHA512:
-  metadata.gz: 3a6125762169389c71b9c51ebc27e5a180d66281e5e634584167b3d210b129ae4771a4c624e12b4a90e4318da0278a4e6279e2926298a6026d549b69fe5b3497
-  data.tar.gz: 2fa41a845a293c0e8cc6ab5bd4720906b59290a700349c03a6af4d705610ddb9d4b115d8726d7de634f8421b569d8091a8e6c05530747f5f0fa79552cc56fe23
+  metadata.gz: 0c3e2181a16ad426ad10fb67cb2e2dbf87ba768866fbc17e7858f6692b1bf412a6b68679bf3803da1c41f9ccc97999d6d731d601a47676826ff4e49ce380aada
+  data.tar.gz: 3fbbfdad0615432ed971aabb7c2bd61b6cdc3739676aae090453fd2fd3a4674fa773e7a6958b681a65ee853704181f45e5e71746a896cdc95e6f4752a6af29ef

data/lib/relaton_bib/contributor.rb

@@ -8,65 +8,74 @@ module RelatonBib
     # @return [Array<String>]
     attr_reader :street
 
-    # @return [String]
-    attr_reader :city
-
-    # @return [String, NilClass]
-    attr_reader :state
-
-    # @return [String]
-    attr_reader :country
-
-    # @return [String, NilClass]
-    attr_reader :postcode
+    # @return [String, nil]
+    attr_reader :city, :state, :country, :postcode, :formatted_address
+
+    # @param street [Array<String>] streets
+    # @param city [String, nil] city, should be present or formatted address provided
+    # @param state [String, nil] state
+    # @param country [String, nil] country, should be present or formatted address provided
+    # @param postcode [String, nil] postcode
+    # @param formatted_address [String, nil] formatted address, should be present or city and country provided
+    def initialize(**args) # rubocop:disable Metrics/CyclomaticComplexity
+      unless args[:formatted_address] || (args[:city] && args[:country])
+        raise ArgumentError, "Either formatted address or city and country must be provided"
+      end
 
-    # @param street [Array<String>]
-    # @param city [String]
-    # @param state [String]
-    # @param country [String]
-    # @param postcode [String]
-    def initialize(street:, city:, country:, state: nil, postcode: nil)
-      @street   = street
-      @city     = city
-      @state    = state
-      @country  = country
-      @postcode = postcode
+      @street   = args[:street] || []
+      @city     = args[:city]
+      @state    = args[:state]
+      @country  = args[:country]
+      @postcode = args[:postcode]
+      @formatted_address = args[:formatted_address] unless args[:city] && args[:country]
     end
 
-    # @param builder [Nokogiri::XML::Document]
-    def to_xml(doc)
+    # @param doc [Nokogiri::XML::Document]
+    def to_xml(doc) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       doc.address do
-        street.each { |str| doc.street str }
-        doc.city city
-        doc.state state if state
-        doc.country country
-        doc.postcode postcode if postcode
+        if formatted_address
+          doc.formattedAddress formatted_address
+        else
+          street.each { |str| doc.street str }
+          doc.city city
+          doc.state state if state
+          doc.country country
+          doc.postcode postcode if postcode
+        end
       end
     end
 
     # @return [Hash]
-    def to_hash # rubocop:disable Metrics/AbcSize
+    def to_hash # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       hash = { "address" => {} }
-      hash["address"]["street"] = street if street&.any?
-      hash["address"]["city"] = city
-      hash["address"]["state"] = state if state
-      hash["address"]["country"] = country
-      hash["address"]["postcode"] = postcode if postcode
+      if formatted_address
+        hash["address"]["formatted_address"] = formatted_address
+      else
+        hash["address"]["street"] = street if street.any?
+        hash["address"]["city"] = city
+        hash["address"]["state"] = state if state
+        hash["address"]["country"] = country
+        hash["address"]["postcode"] = postcode if postcode
+      end
       hash
     end
 
     # @param prefix [String]
     # @param count [Integer] number of addresses
     # @return [String]
-    def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/AbcSize
+    def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       pref = prefix.empty? ? "address" : "#{prefix}.address"
-      out = count > 1 ? "#{pref}::\n" : ""
-      street.each { |st| out += "#{pref}.street:: #{st}\n" }
-      out += "#{pref}.city:: #{city}\n"
-      out += "#{pref}.state:: #{state}\n" if state
-      out += "#{pref}.country:: #{country}\n"
-      out += "#{pref}.postcode:: #{postcode}\n" if postcode
-      out
+      if formatted_address
+        "#{pref}.formatted_address:: #{formatted_address}\n"
+      else
+        out = count > 1 ? "#{pref}::\n" : ""
+        street.each { |st| out += "#{pref}.street:: #{st}\n" }
+        out += "#{pref}.city:: #{city}\n"
+        out += "#{pref}.state:: #{state}\n" if state
+        out += "#{pref}.country:: #{country}\n"
+        out += "#{pref}.postcode:: #{postcode}\n" if postcode
+        out
+      end
     end
   end
 

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "1.13.12".freeze
+  VERSION = "1.13.13".freeze
 end

data/lib/relaton_bib/xml_parser.rb

@@ -3,6 +3,13 @@ require "nokogiri"
 module RelatonBib
   class XMLParser
     class << self
+      #
+      # Parse XML bibdata
+      #
+      # @param [String] xml XML string
+      #
+      # @return [RelatonBib::BibliographicItem, nil] bibliographic item
+      #
       def from_xml(xml)
         doc = Nokogiri::XML(xml)
         doc.remove_namespaces!
@@ -17,10 +24,14 @@ module RelatonBib
 
       private
 
-      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-
-      # @return [Hash]
-      def item_data(bibitem) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      #
+      # Parse bibitem data
+      #
+      # @param bibitem [Nokogiri::XML::Element] bibitem element
+      #
+      # @return [Hash] bibitem data
+      #
+      def item_data(bibitem) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize, Metrics/MethodLength
         ext = bibitem.at "//ext"
         {
           id: bibitem[:id].nil? || bibitem[:id].empty? ? nil : bibitem[:id],
@@ -59,8 +70,14 @@ module RelatonBib
           structuredidentifier: fetch_structuredidentifier(ext),
         }
       end
-      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
+      #
+      # Fetch version.
+      #
+      # @param [Nokogiri::XML::Elemetn] item bibitem element
+      #
+      # @return [Array<RelatonBib::BibliographicItem::Version>] versions
+      #
       def fetch_version(item)
         item.xpath("./version").map do |v|
           revision_date = v.at("revision-date")&.text
@@ -69,6 +86,13 @@ module RelatonBib
         end
       end
 
+      #
+      # Fetch edition
+      #
+      # @param [Nokogiri::XML::Elemetn] item bibitem element
+      #
+      # @return [RelatonBib::Edition, nil] edition
+      #
       def fetch_edition(item)
         edt = item.at("./edition")
         return unless edt
@@ -76,6 +100,13 @@ module RelatonBib
         Edition.new content: edt.text, number: edt[:number]
       end
 
+      #
+      # Fetch place.
+      #
+      # @param [Nokogiri::XML::Element] item bibitem element
+      #
+      # @return [Array<RelatonBib::Place>] array of places
+      #
       def fetch_place(item)
         item.xpath("./place").map do |pl|
           if (city = pl.at("./city"))
@@ -114,18 +145,39 @@ module RelatonBib
         BiblioNoteCollection.new bnotes
       end
 
+      #
+      # Fetch language
+      #
+      # @param [Nokogiri::XML::Element] item bibitem element
+      #
+      # @return [Array<String>] language en, fr, etc.
+      #
       def fetch_language(item)
         item.xpath("./language").reduce([]) do |a, l|
           l.text.empty? ? a : a << l.text
         end
       end
 
+      #
+      # Fetch script
+      #
+      # @param [Nokogiri::XML::Element] item XML element
+      #
+      # @return [Array<String>] scripts Latn, Cyr, etc.
+      #
       def fetch_script(item)
         item.xpath("./script").reduce([]) do |a, s|
           s.text.empty? ? a : a << s.text
         end
       end
 
+      #
+      # Fetch series
+      #
+      # @param [Nokogiri::XML::Element] item bibitem element
+      #
+      # @return [Array<RelatonBib::Series>] series
+      #
       def fetch_series(item) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize,Metrics/MethodLength,Metrics/PerceivedComplexity
         item.xpath("./series").reduce([]) do |mem, sr|
           abbr = sr.at "abbreviation"
@@ -146,6 +198,13 @@ module RelatonBib
         end
       end
 
+      #
+      # Fetch medium
+      #
+      # @param [Nokogiri::XML::Element] item item element
+      #
+      # @return [RelatonBib::Medium, nil] medium
+      #
       def fetch_medium(item) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize,Metrics/PerceivedComplexity
         medium = item.at("./medium")
         return unless medium
@@ -157,12 +216,26 @@ module RelatonBib
         )
       end
 
+      #
+      # Fetch extent
+      #
+      # @param [Nokogiri::XML::Element] item item element
+      #
+      # @return [Array<RelatonBib::Locality, RelatonBib::LocalityStack>] extent
+      #
       def fetch_extent(item)
         item.xpath("./extent").reduce([]) do |a, ex|
           a + localities(ex)
         end
       end
 
+      #
+      # Fetch size
+      #
+      # @param [Nokogiri::XML::Element] item item element
+      #
+      # @return [RelatonBib::BibliographicSize, nil] size
+      #
       def fetch_size(item)
         size = item.xpath("./size/value").map do |sz|
           BibliographicSize::Value.new type: sz[:type], value: sz.text
@@ -170,12 +243,26 @@ module RelatonBib
         BibliographicSize.new size if size.any?
       end
 
+      #
+      # Fetch classification
+      #
+      # @param [Nokogiri::XML::Element] item bibitem element
+      #
+      # @return [Array<RelatonBib::Classification>] classifications
+      #
       def fetch_classification(item)
         item.xpath("classification").map do |cls|
           Classification.new type: cls[:type], value: cls.text
         end
       end
 
+      #
+      # Parse validity
+      #
+      # @param [Nokogiri::XML::Element] item bibitem element
+      #
+      # @return [RelatonBib::Validity, nil] validity
+      #
       def fetch_validity(item)
         vl = item.at("./validity")
         return unless vl
@@ -228,6 +315,13 @@ module RelatonBib
         end
       end
 
+      #
+      # Parse status
+      #
+      # @param [Nokogiri::XML::Element] item XML element
+      #
+      # @return [RelatonBib::DocumentStatus, nil] status
+      #
       def fetch_status(item)
         status = item.at("./status")
         return unless status
@@ -264,6 +358,13 @@ module RelatonBib
         end
       end
 
+      #
+      # Parse organization
+      #
+      # @param [Nokogiri::XML::Element] org XML element
+      #
+      # @return [RelatonBib::Organization] organization
+      #
       def get_org(org) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         names = org.xpath("name").map do |n|
           { content: n.text, language: n[:language], script: n[:script] }
@@ -280,6 +381,13 @@ module RelatonBib
         )
       end
 
+      #
+      # Parse person from XML
+      #
+      # @param [Nokogiri::XML::Element] person XML element
+      #
+      # @return [RelatonBib::Person] person
+      #
       def get_person(person) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
         affiliations = person.xpath("./affiliation").map do |a|
           org = a.at "./organization"
@@ -316,23 +424,46 @@ module RelatonBib
         )
       end
 
-      def parse_contact(contrib) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/MethodLength,Metrics/AbcSize
+      #
+      # Parse contact information
+      #
+      # @param [Nokogiri::XML::Element] contrib contributor element
+      #
+      # @return [Array<RelatonBib::Address, RelatonBib::Contact>] contacts
+      #
+      def parse_contact(contrib)
         contrib.xpath("./address|./phone|./email|./uri").map do |c|
-          if c.name == "address"
-            streets = c.xpath("./street").map(&:text)
-            Address.new(
-              street: streets,
-              city: c.at("./city")&.text,
-              state: c.at("./state")&.text,
-              country: c.at("./country")&.text,
-              postcode: c.at("./postcode")&.text,
-            )
-          else
-            Contact.new(type: c.name, value: c.text)
-          end
+          parse_address(c) || Contact.new(type: c.name, value: c.text)
         end
       end
 
+      #
+      # Parse address
+      #
+      # @param [Nokogiri::XML::Element] contact contact element
+      #
+      # @return [RelatonBib::Address] address
+      #
+      def parse_address(contact) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+        return unless contact.name == "address"
+
+        Address.new(
+          street: contact.xpath("./street").map(&:text),
+          city: contact.at("./city")&.text,
+          state: contact.at("./state")&.text,
+          country: contact.at("./country")&.text,
+          postcode: contact.at("./postcode")&.text,
+          formatted_address: contact.at("./formattedAddress")&.text,
+        )
+      end
+
+      #
+      # Parse initials
+      #
+      # @param [Nokogiri::XML::Element] person person element
+      #
+      # @return [RelatonBib::LocalizedString, nil] initials
+      #
       def parse_initials(person)
         inits = person.at "./name/formatted-initials"
         return unless inits
@@ -340,6 +471,13 @@ module RelatonBib
         LocalizedString.new(inits.text, inits[:language], inits[:script])
       end
 
+      #
+      # Parse forename
+      #
+      # @param [Nokogiri::XML::Element] person person element
+      #
+      # @return [Array<RelatonBib::Forename>] forenames
+      #
       def parse_forename(person)
         person.xpath("./name/forename").map do |np|
           args = np.attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v.to_s }
@@ -348,6 +486,14 @@ module RelatonBib
         end
       end
 
+      #
+      # Parse name part
+      #
+      # @param [Nokogiri::XML::Element] person person element
+      # @param [String] part name part
+      #
+      # @return [Array<RelatonBib::LocalizedString>] name parts
+      #
       def name_part(person, part)
         person.xpath("./name/#{part}").map do |np|
           LocalizedString.new np.text, np[:language], np[:script]
@@ -429,14 +575,24 @@ module RelatonBib
                             script: d[:script], format: d[:format])
       end
 
-      # @param item_hash [Hash]
-      # @return [RelatonBib::BibliographicItem]
+      #
+      # Create bibliographic item
+      #
+      # @param item_hash [Hash] bibliographic item hash
+      #
+      # @return [RelatonBib::BibliographicItem] bibliographic item
+      #
       def bib_item(item_hash)
         BibliographicItem.new(**item_hash)
       end
 
-      # @param rel [Nokogiri::XML::Element]
-      # @return [Array<RelatonBib::Locality, RelatonBib::LocalityStack>]
+      #
+      # Parse locality
+      #
+      # @param rel [Nokogiri::XML::Element] relation element
+      #
+      # @return [Array<RelatonBib::Locality, RelatonBib::LocalityStack>] localities
+      #
       def localities(rel)
         rel.xpath("./locality|./localityStack").map do |lc|
           if lc.name == "locality"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 1.13.12
+  version: 1.13.13
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug