relaton-bib 0.9.2 → 1.0.4

data/lib/relaton_bib/localized_string.rb

@@ -11,21 +11,35 @@ module RelatonBib
     # @return [Array<String>] script Iso15924 code
     attr_reader :script
 
-    # @return [String]
+    # @return [String, Array<RelatonBib::LocalizedString>]
     attr_accessor :content
 
-    # @param content [String]
+    # @param content [String, Array<RelatonBib::LocalizedString>]
     # @param language [String] language code Iso639
     # @param script [String] script code Iso15924
     def initialize(content, language = nil, script = nil)
+      unless content.is_a?(String) || content.is_a?(Array) &&
+          (inv = content.reject { |c| c.is_a?(LocalizedString) || c.is_a?(Hash) }).
+              none? && content.any?
+        klass = content.is_a?(Array) ? inv.first.class : content.class
+        raise ArgumentError, "invalid LocalizedString content type: #{klass}"
+      end
       @language = language.is_a?(String) ? [language] : language
       @script = script.is_a?(String) ? [script] : script
-      @content = content
+      @content = if content.is_a?(Array)
+                   content.map do |c|
+                     if c.is_a?(Hash)
+                       LocalizedString.new c[:content], c[:language], c[:script]
+                     else c
+                     end
+                   end
+                 else content
+                 end
     end
 
     # @return [String]
     def to_s
-      content
+      content.is_a?(String) ? content : content.first.to_s
     end
 
     # @return [TrueClass, FalseClass]
@@ -37,19 +51,26 @@ module RelatonBib
     def to_xml(builder)
       return unless content
 
-      builder.parent["language"] = language.join(",") if language&.any?
-      builder.parent["script"]   = script.join(",") if script&.any?
-      builder.text content.encode(xml: :text)
+      if content.is_a?(Array)
+        content.each { |c| builder.variant { c.to_xml builder } }
+      else
+        builder.parent["language"] = language.join(",") if language&.any?
+        builder.parent["script"]   = script.join(",") if script&.any?
+        builder.text content.encode(xml: :text)
+      end
     end
 
     # @return [Hash]
     def to_hash
-      return content unless language || script
+      if content.is_a? String
+        return content unless language || script
 
-      hash = { "content" => content }
-      hash["language"] = single_element_array(language) if language&.any?
-      hash["script"] = single_element_array(script) if script&.any?
-      hash
+        hash = { "content" => content }
+        hash["language"] = single_element_array(language) if language&.any?
+        hash["script"] = single_element_array(script) if script&.any?
+        hash
+      else content.map &:to_hash
+      end
     end
   end
 end

data/lib/relaton_bib/typed_title_string.rb

@@ -30,7 +30,7 @@ module RelatonBib
         @title = args[:title]
       else
         fsargs = args.select do |k, _v|
-          %i[content language script format].include? k 
+          %i[content language script format].include? k
         end
         @title = FormattedString.new(fsargs)
       end

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "0.9.2".freeze
+  VERSION = "1.0.4".freeze
 end

data/lib/relaton_bib/xml_parser.rb

@@ -8,9 +8,9 @@ module RelatonBib
         doc.remove_namespaces!
         bibitem = doc.at "/bibitem|/bibdata"
         if bibitem
-          BibliographicItem.new(item_data(bibitem))
+          bib_item item_data(bibitem)
         else
-          warn "[relato-bib] can't find bibitem or bibdata element in the XML"
+          warn "[relaton-bib] WARNING: can't find bibitem or bibdata element in the XML"
         end
       end
 
@@ -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,
@@ -155,8 +159,12 @@ module RelatonBib
       def ttitle(title)
         return unless title
 
+        variants = title.xpath("variant").map do |v|
+          LocalizedString.new v.text, v[:language], v[:script]
+        end
+        content = variants.any? ? variants : title.text
         TypedTitleString.new(
-          type: title[:type], content: title.text, language: title[:language],
+          type: title[:type], content: content, language: title[:language],
           script: title[:script], format: title[:format]
         )
       end
@@ -165,14 +173,22 @@ module RelatonBib
         status = item.at("./status")
         return unless status
 
-        stage = status.at "stage"
+        stg = status.at "stage"
         DocumentStatus.new(
-          stage: stage ? stage.text : status.text,
-          substage: status.at("substage")&.text,
+          stage: stg ? stage(stg) : status.text,
+          substage: stage(status.at("substage")),
           iteration: status.at("iteration")&.text,
         )
       end
 
+      # @param node [Nokogiri::XML::Elemen]
+      # @return [RelatonBib::DocumentStatus::Stage]
+      def stage(elm)
+        return unless elm
+
+        DocumentStatus::Stage.new value: elm.text, abbreviation: elm[:abbreviation]
+      end
+
       def fetch_dates(item)
         item.xpath("./date").reduce([]) do |a, d|
           type = d[:type].to_s.empty? ? "published" : d[:type]
@@ -257,6 +273,8 @@ module RelatonBib
         end
       end
 
+      # @param item [Nokogiri::XML::Element]
+      # @return [Array<RelatonBib::ContributionInfo>]
       def fetch_contributors(item)
         item.xpath("./contributor").map do |c|
           entity = if (org = c.at "./organization") then get_org(org)
@@ -269,6 +287,8 @@ module RelatonBib
         end
       end
 
+      # @param item [Nokogiri::XML::Element]
+      # @return [Array<RelatonBib::FormattedString>]
       def fetch_abstract(item)
         item.xpath("./abstract").map do |a|
           FormattedString.new(
@@ -277,6 +297,8 @@ module RelatonBib
         end
       end
 
+      # @param item [Nokogiri::XML::Element]
+      # @return [RelatonBib::CopyrightAssociation]
       def fetch_copyright(item)
         cp     = item.at("./copyright") || return
         org    = cp&.at("owner/organization")
@@ -290,30 +312,82 @@ module RelatonBib
         CopyrightAssociation.new(owner: owner, from: from, to: to)
       end
 
+      # @param item [Nokogiri::XML::Element]
+      # @return [Arra<RelatonBib::TypedUri>]
       def fetch_link(item)
         item.xpath("./uri").map do |l|
           TypedUri.new type: l[:type], content: l.text
         end
       end
 
+      # @param item [Nokogiri::XML::Element]
+      # @return [Array<RelatonBib::DocumentRelation>]
       def fetch_relations(item)
         item.xpath("./relation").map do |rel|
-          localities = rel.xpath("./locality").map do |l|
-            ref_to = (rt = l.at("./referenceTo")) ? LocalizedString.new(rt.text) : nil
-            BibItemLocality.new(
-              l[:type],
-              LocalizedString.new(l.at("./referenceFrom").text),
-              ref_to,
-            )
-          end
           DocumentRelation.new(
             type: rel[:type]&.empty? ? nil : rel[:type],
-            bibitem: BibliographicItem.new(item_data(rel.at("./bibitem"))),
-            bib_locality: localities,
+            description: relation_description(rel),
+            bibitem: bib_item(item_data(rel.at("./bibitem"))),
+            locality: localities(rel),
+            source_locality: source_localities(rel),
           )
         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)
+        BibliographicItem.new item_hash
+      end
+
+      # @param rel [Nokogiri::XML::Element]
+      # @return [Array<RelatonBib::Locality, RelatonBib::LocalityStack>]
+      def localities(rel)
+        rel.xpath("./locality|./localityStack").map do |lc|
+          if lc[:type]
+            LocalityStack.new [locality(lc)]
+          else
+            LocalityStack.new lc.xpath("./locality").map { |l| locality l }
+          end
+        end
+      end
+
+      # @param loc [Nokogiri::XML::Element]
+      # @return [RelatonBib::Locality]
+      def locality(loc, klass = Locality)
+        ref_to = (rt = loc.at("./referenceTo")) ? LocalizedString.new(rt.text) : nil
+        klass.new(
+          loc[:type],
+          LocalizedString.new(loc.at("./referenceFrom").text),
+          ref_to,
+        )
+      end
+
+      # @param rel [Nokogiri::XML::Element]
+      # @return [Array<RelatonBib::SourceLocality, RelatonBib::SourceLocalityStack>]
+      def source_localities(rel)
+        rel.xpath("./sourceLocality|./sourceLocalityStack").map do |lc|
+          if lc[:type]
+            SourceLocalityStack.new [locality(lc, SourceLocality)]
+          else
+            sls = lc.xpath("./sourceLocality").map { |l| locality l, SourceLocality }
+            SourceLocalityStack.new sls
+          end
+        end
+      end
+
+      # @param item [Nokogiri::XML::Element]
+      # @return [RelatonBib::FormattedRef, NilClass]
       def fref(item)
         ident = item&.at("./formattedref")
         return unless ident

data/relaton-bib.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "relaton_bib/version"
 
@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "debase"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "rake", "~> 10.0"
@@ -30,7 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "ruby-debug-ide"
   spec.add_development_dependency "ruby-jing"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "byebug"
 
   spec.add_dependency "addressable"
   spec.add_dependency "bibtex-ruby"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: debase
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +190,7 @@ files:
 - ".github/workflows/windows.yml"
 - ".gitignore"
 - ".gitmodules"
+- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile