relaton-bib 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cf0aacc339840ecc4607d6b87e625eaef60ba12ab0fbeffba5876898518f138
-  data.tar.gz: e41a599b99baaa6d1002cd3ad13803bcffeaa6949840a8cd757db3689716f06b
+  metadata.gz: 2f93b20bcbcbd2d652863860202263c53c18c3434dbcb25dadacd6df3215bd07
+  data.tar.gz: 58213431b368fdcf86f6391f3a4c5c807379885f8265ab11eaf032256d2c9308
 SHA512:
-  metadata.gz: 4f8e1bfe3c6ca8d2ec19733f7ea0f018bae2a102ad92d05bb0983ddf9b7e8715c86c56980ffa106500c2a6971a625143cb6bec2ae9b9a2dd0190fc8b605539c1
-  data.tar.gz: 721ba6235c7cabc380825ce184f0b2874f1ba519b2f6b9dc44fea52ae061b3bdd18ab56c5db94698535b8db10fe365a88aaf23bcd32a25fa5ce7de96bb8a93b6
+  metadata.gz: fb175953b587708dbf1b7ca6b56249ed32a4a14b9b1107eb302cd9578d0a2ed178b8d048a14c20735bf591f9b6f9534b93fd205149b837295754762f2956b63e
+  data.tar.gz: 0fc9fa117bd8d87a3ee1f2a9be33e03e6e189f72ceb3194fe39a4e8ad6f8ccee2461f7d378995e11a7f2ff2675ee67ad2ddefbdbb105d59465e9221f0b7e2d7e

data/lib/relaton_bib/document_relation.rb

@@ -1,24 +1,22 @@
 module RelatonBib
-  # module DocumentRelationType
-  #   PARENT        = 'parent'
-  #   CHILD         = 'child'
-  #   OBSOLETES     = 'obsoletes'
-  #   UPDATES       = 'updates'
-  #   COMPLEMENTS   = 'complements'
-  #   DERIVED_FORM  = 'derivedForm'
-  #   ADOPTED_FORM  = 'adoptedForm'
-  #   EQUIVALENT    = 'equivalent'
-  #   IDENTICAL     = 'identical'
-  #   NONEQUIVALENT = 'nonequivalent'
-  # end
-
   # Documett relation
   class DocumentRelation
     include RelatonBib
 
+    TYPES = %w[
+      obsoletes obsoletedBy supersedes supersededBy updates updatedBy
+      complements derivedFrom translatedFrom hasTranslation adoptedFrom
+      equivalent identical nonequivalent includedIn includes instance
+      instanceOf partOf hasPart hasDraft draftOf merges splits amends amendedBy
+      corrects correctedBy revises revisedBy describes describedBy
+    ].freeze
+
     # @return [String]
     attr_reader :type
 
+    # @return [RelatonBib::FormattedString, NilClass]
+    attr_reader :description
+
     # @return [String]
     # attr_reader :identifier, :url
 
@@ -32,12 +30,17 @@ module RelatonBib
     attr_reader :source_locality
 
     # @param type [String]
+    # @parma description [RelatonBib::FormattedString, NilClass]
     # @param bibitem [RelatonBib::BibliographicItem, RelatonIso::IsoBibliographicItem]
     # @param locality [Array<RelatonBib::Locality, RelatonBib::LocalityStack>]
     # @param source_locality [Array<RelatonBib::SourceLocality, RelatonBib::SourceLocalityStack>]
-    def initialize(type:, bibitem:, locality: [], source_locality: [])
+    def initialize(type:, description: nil, bibitem:, locality: [], source_locality: [])
       type             = "obsoletes" if type == "Now withdrawn"
+      unless TYPES.include? type
+        warn "[relaton-bib] WARNING: invalid relation type: #{type}"
+      end
       @type            = type
+      @description     = description
       @locality        = locality
       @source_locality = source_locality
       @bibitem         = bibitem
@@ -48,6 +51,7 @@ module RelatonBib
       opts.delete :bibdata
       opts.delete :note
       builder.relation(type: type) do
+        builder.description { description.to_xml builder } if description
         bibitem.to_xml(builder, **opts.merge(embedded: true))
         locality.each { |l| l.to_xml builder }
         source_locality.each { |l| l.to_xml builder }
@@ -57,6 +61,7 @@ module RelatonBib
     # @return [Hash]
     def to_hash
       hash = { "type" => type, "bibitem" => bibitem.to_hash }
+      hash["description"] = description.to_hash if description
       hash["locality"] = single_element_array(locality) if locality&.any?
       if source_locality&.any?
         hash["source_locality"] = single_element_array(source_locality)

data/lib/relaton_bib/document_relation_collection.rb

@@ -23,9 +23,12 @@ module RelatonBib
       @array =  relation.map { |r| r.is_a?(Hash) ? DocumentRelation.new(r) : r }
     end
 
+    # @todo We don't have replace type anymore. Suppose we should update this
+    #   method or delete it.
+    #
     # @return [RelatonBib::DocRelationCollection]
-    def replaces
-      DocRelationCollection.new @array.select { |r| r.type == "replace" }
-    end
+    # def replaces
+    #   DocRelationCollection.new @array.select { |r| r.type == "replace" }
+    # end
   end
 end

data/lib/relaton_bib/hash_converter.rb

@@ -258,6 +258,9 @@ module RelatonBib
 
         ret[:relation] = array(ret[:relation])
         ret[:relation]&.each do |r|
+          if r[:description]
+            r[:description] = FormattedString.new r[:description]
+          end
           relation_bibitem_hash_to_bib(r)
           relation_locality_hash_to_bib(r)
           relation_source_locality_hash_to_bib(r)

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "1.0.0".freeze
+  VERSION = "1.0.1".freeze
 end

data/lib/relaton_bib/xml_parser.rb

@@ -91,12 +91,16 @@ module RelatonBib
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
 
       def fetch_series(item)
-        item.xpath("./series").map do |sr|
+        item.xpath("./series").reduce([]) do |mem, sr|
           abbr = sr.at "abbreviation"
           abbreviation = abbr ? LocalizedString.new(abbr.text, abbr[:language], abbr[:script]) : nil
-          Series.new(
-            type: sr[:type], formattedref: fref(sr),
-            title: ttitle(sr.at("title")), place: sr.at("place")&.text,
+          formattedref = fref(sr)
+          title = ttitle(sr.at("title"))
+          next mem unless formattedref || title
+
+          mem << Series.new(
+            type: sr[:type], formattedref: formattedref,
+            title: title, place: sr.at("place")&.text,
             organization: sr.at("organization")&.text,
             abbreviation: abbreviation, from: sr.at("from")&.text,
             to: sr.at("to")&.text, number: sr.at("number")&.text,
@@ -310,6 +314,7 @@ module RelatonBib
         item.xpath("./relation").map do |rel|
           DocumentRelation.new(
             type: rel[:type]&.empty? ? nil : rel[:type],
+            description: relation_description(rel),
             bibitem: bib_item(item_data(rel.at("./bibitem"))),
             locality: localities(rel),
             source_locality: source_localities(rel),
@@ -317,6 +322,16 @@ module RelatonBib
         end
       end
 
+      # @param rel [Nokogiri::XML::Element]
+      # @return [RelatonBib::FormattedString, NilClass]
+      def relation_description(rel)
+        d = rel.at "./description"
+        return unless d
+
+        FormattedString.new(content: d.text, language: d[:language],
+                            script: d[:script], format: d[:format])
+      end
+
       # @param item_hash [Hash]
       # @return [RelatonBib::BibliographicItem]
       def bib_item(item_hash)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-25 00:00:00.000000000 Z
+date: 2020-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debase