relaton-bib 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c556856365ed3b55dfead00fa129508a6d541aaa04fa96d4a37997761d77aaf
-  data.tar.gz: 1e819257d4ee84d00bd6a0634a6abbc91b19ed6d9854275c0b9c04db4bb43c1a
+  metadata.gz: 2d2e73e228a1e3d0b56ec177f3fa39a721dbd76ff99fd3f18e38c331672aca43
+  data.tar.gz: c9dab886bcffafd638735157419c904b88da2363048178fb8c458399d9a74909
 SHA512:
-  metadata.gz: a65cc8f9435f61a0313d744f3827a55a91e7ccb7edc1d143f318d38cb2fb07b7fa75b7cdb871133c631d4deee778ba1c552811b11aa4aec479370cfcbe28d87f
-  data.tar.gz: 3c105c0244fd7e2f3fbdca1a9fd0626560f9d6e5f754743ff23530311885f0fca8c31e70cfcaae1961cc0ee957908854063d2972390885bbe46a3beb8179d194
+  metadata.gz: 62292ca68783b8f5817807ca4b014ec0c782a81c3724ff7860562f7d4529cd3eac9e1f1dccddae7149d6bb56dbb114dd1bcd7393cbc797cb91b7beb02a3de953
+  data.tar.gz: ff58d4ed2c0bb448bca70e62e8a6d9252ffa02865bfcbbc31f0bf360e009f372e8bc292c59ee7c970f891e0ab496cf4e81df3241f967dbbde1968cebdccf8952

data/.github/workflows/ubuntu.yml

@@ -35,4 +35,5 @@ jobs:
           bundle install --jobs 4 --retry 3
       - name: Run specs
         run: |
+          unset JAVA_TOOL_OPTIONS
           bundle exec rake

data/.rubocop.yml

@@ -5,6 +5,6 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 Rails:
-  Enabled: true
+  Enabled: false

data/README.adoc

@@ -380,6 +380,22 @@ item.to_bibtex
   ...
 ----
 
+=== Exporting bibliographic item to AsciiBib
+
+[source,ruby]
+----
+item.to_asciibib
+[%bibitem]
+== {blank}
+id:: ISOTC211
+fetched:: 2020-08-19
+title::
+title.type:: title-main
+title.conten:: Geographic information
+title.format:: text/plain
+...
+----
+
 == Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/relaton_bib.rb

@@ -10,11 +10,9 @@ module RelatonBib
   class RequestError < StandardError; end
 
   class << self
-    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
-
     # @param date [String, Integer, Date]
     # @return [Date, NilClass]
-    def parse_date(date)
+    def parse_date(date) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
       return date if date.is_a?(Date)
 
       sdate = date.to_s
@@ -30,14 +28,13 @@ module RelatonBib
       when /(?<date>\d{4})/ then Date.strptime $~[:date], "%Y" # 2012
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
   end
 
   private
 
   # @param array [Array]
   # @return [Array<String>, String]
-  def single_element_array(array)
+  def single_element_array(array) # rubocop:disable Metrics/CyclomaticComplexity
     if array.size > 1
       array.map { |e| e.is_a?(String) ? e : e.to_hash }
     else

data/lib/relaton_bib/bib_item_locality.rb

@@ -17,7 +17,7 @@ module RelatonBib
       type_ptrn = %r{section|clause|part|paragraph|chapter|page|whole|table|
         annex|figure|note|list|example|volume|issue|time|
         locality:[a-zA-Z0-9_]+}x
-      unless type =~ type_ptrn
+      unless type.match? type_ptrn
         warn "[relaton-bib] WARNING: invalid locality type: #{type}"
       end
 
@@ -39,6 +39,18 @@ module RelatonBib
       hash["reference_to"] = reference_to if reference_to
       hash
     end
+
+    # @param prefix [String]
+    # @param count [Integeg] number of localities
+    # @return [String]
+    def to_asciibib(prefix = "", count = 1)
+      pref = prefix.empty? ? prefix : prefix + "."
+      out = count > 1 ? "#{prefix}::\n" : ""
+      out += "#{pref}type:: #{type}\n"
+      out += "#{pref}reference_from:: #{reference_from}\n"
+      out += "#{pref}reference_to:: #{reference_to}\n" if reference_to
+      out
+    end
   end
 
   class Locality < BibItemLocality

data/lib/relaton_bib/biblio_note.rb

@@ -29,5 +29,16 @@ module RelatonBib
       hash["type"] = type
       hash
     end
+
+    # @param prefix [String]
+    # @param count [Integer] number of notes
+    # @return [String]
+    def to_asciibib(prefix = "", count = 1)
+      pref = prefix.empty? ? prefix : prefix + "."
+      out = count > 1 ? "#{pref}biblionote::\n" : ""
+      out + "#{pref}biblionote.type:: #{type}\n" if type
+      out += super "#{pref}biblionote"
+      out
+    end
   end
 end

data/lib/relaton_bib/biblio_version.rb

@@ -32,6 +32,18 @@ module RelatonBib
         hash["draft"] = single_element_array(draft) if draft&.any?
         hash
       end
+
+      # @param prefix [String]
+      # @return [String]
+      def to_asciibib(prefix = "")
+        pref = prefix.empty? ? prefix : prefix + "."
+        out = ""
+        if revision_date
+          out += "#{pref}version.revision_date:: #{revision_date}\n"
+        end
+        draft&.each { |d| out += "#{pref}version.draft:: #{d}\n" }
+        out
+      end
     end
   end
 end

data/lib/relaton_bib/bibliographic_date.rb

@@ -60,6 +60,19 @@ module RelatonBib
       hash
     end
 
+    # @param prefix [String]
+    # @param count [Integer] number of dates
+    # @return [String]
+    def to_asciibib(prefix = "", count = 1)
+      pref = prefix.empty? ? prefix : prefix + "."
+      out = count > 1 ? "#{pref}date::\n" : ""
+      out += "#{pref}date.type:: #{type}\n"
+      out += "#{pref}date.on:: #{on}\n" if on
+      out += "#{pref}date.from:: #{from}\n" if from
+      out += "#{pref}date.to:: #{to}\n" if to
+      out
+    end
+
     private
 
     # Formats date

data/lib/relaton_bib/bibliographic_item.rb

@@ -237,13 +237,18 @@ module RelatonBib
       end
       @series         = args.fetch :series, []
       @medium         = args[:medium]
-      @place          = args.fetch(:place, []).map { |pl| pl.is_a?(String) ? Place.new(name: pl) : pl }
+      @place          = args.fetch(:place, []).map do |pl|
+        pl.is_a?(String) ? Place.new(name: pl) : pl
+      end
       @extent         = args[:extent] || []
       @accesslocation = args.fetch :accesslocation, []
       @classification = args.fetch :classification, []
       @validity       = args[:validity]
-      @fetched        = args.fetch :fetched, nil # , Date.today # we should pass the fetched arg from scrappers
-      @keyword        = (args[:keyword] || []).map { |kw| LocalizedString.new(kw) }
+      # we should pass the fetched arg from scrappers
+      @fetched        = args.fetch :fetched, nil
+      @keyword        = (args[:keyword] || []).map do |kw|
+        LocalizedString.new(kw)
+      end
       @license        = args.fetch :license, []
       @doctype        = args[:doctype]
       @editorialgroup = args[:editorialgroup]
@@ -278,7 +283,7 @@ module RelatonBib
     end
 
     # @return [String]
-    def shortref(identifier, **opts)
+    def shortref(identifier, **opts) # rubocop:disable Metrics/CyclomaticComplexity
       pubdate = date.select { |d| d.type == "published" }
       year = if opts[:no_year] || pubdate.empty? then ""
              else ":" + pubdate&.first&.on&.year.to_s
@@ -300,10 +305,8 @@ module RelatonBib
       end
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-
     # @return [Hash]
-    def to_hash
+    def to_hash # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
       hash = {}
       hash["id"] = id if id
       hash["title"] = single_element_array(title) if title&.any?
@@ -312,7 +315,9 @@ module RelatonBib
       hash["docid"] = single_element_array(docidentifier) if docidentifier&.any?
       hash["docnumber"] = docnumber if docnumber
       hash["date"] = single_element_array(date) if date&.any?
-      hash["contributor"] = single_element_array(contributor) if contributor&.any?
+      if contributor&.any?
+        hash["contributor"] = single_element_array(contributor)
+      end
       hash["edition"] = edition if edition
       hash["version"] = version.to_hash if version
       hash["revdate"] = revdate if revdate
@@ -328,8 +333,12 @@ module RelatonBib
       hash["medium"] = medium.to_hash if medium
       hash["place"] = single_element_array(place) if place&.any?
       hash["extent"] = single_element_array(extent) if extent&.any?
-      hash["accesslocation"] = single_element_array(accesslocation) if accesslocation&.any?
-      hash["classification"] = single_element_array(classification) if classification&.any?
+      if accesslocation&.any?
+        hash["accesslocation"] = single_element_array(accesslocation)
+      end
+      if classification&.any?
+        hash["classification"] = single_element_array(classification)
+      end
       hash["validity"] = validity.to_hash if validity
       hash["fetched"] = fetched.to_s if fetched
       hash["keyword"] = single_element_array(keyword) if keyword&.any?
@@ -342,11 +351,10 @@ module RelatonBib
       end
       hash
     end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # @param bibtex [BibTeX::Bibliography, NilClass]
     # @return [String]
-    def to_bibtex(bibtex = nil)
+    def to_bibtex(bibtex = nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
       item = BibTeX::Entry.new
       item.type = bibtex_type
       item.key = id
@@ -369,7 +377,6 @@ module RelatonBib
       bibtex << item
       bibtex.to_s
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     # @param lang [String] language code Iso639
     # @return [Array<RelatonIsoBib::TypedTitleString>]
@@ -391,7 +398,7 @@ module RelatonBib
 
     def deep_clone
       dump = Marshal.dump self
-      Marshal.load dump
+      Marshal.load dump # rubocop:disable Security/MarshalLoad
     end
 
     def disable_id_attribute
@@ -399,17 +406,19 @@ module RelatonBib
     end
 
     # remove title part components and abstract
-    def to_all_parts
+    def to_all_parts # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
       me = deep_clone
       me.disable_id_attribute
-      me.relation << RelatonBib::DocumentRelation.new(
-        type: "instance", bibitem: self,
-      )
+      me.relation << DocumentRelation.new(type: "instance", bibitem: self)
       me.language.each do |l|
         me.title.delete_if { |t| t.type == "title-part" }
-        ttl = me.title.select { |t| t.type != "main" && t.title.language&.include?(l) }
+        ttl = me.title.select do |t|
+          t.type != "main" && t.title.language&.include?(l)
+        end
         tm_en = ttl.map { |t| t.title.content }.join " – "
-        me.title.detect { |t| t.type == "main" && t.title.language&.include?(l) }&.title&.content = tm_en
+        me.title.detect do |t|
+          t.type == "main" && t.title.language&.include?(l)
+        end&.title&.content = tm_en
       end
       me.abstract = []
       me.docidentifier.each(&:remove_part)
@@ -440,7 +449,7 @@ module RelatonBib
 
     # If revision_date exists then returns it else returns published date or nil
     # @return [String, NilClass]
-    def revdate
+    def revdate # rubocop:disable Metrics/CyclomaticComplexity
       @revdate ||= if version&.revision_date
                      version.revision_date
                    else
@@ -448,6 +457,53 @@ module RelatonBib
                    end
     end
 
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix = "") # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+      pref = prefix.empty? ? prefix : prefix + "."
+      out = prefix.empty? ? "[%bibitem]\n== {blank}\n" : ""
+      out += "#{pref}id:: #{id}\n" if id
+      out += "#{pref}fetched:: #{fetched}\n" if fetched
+      title.each { |t| out += t.to_asciibib(prefix, title.size) }
+      out += "#{pref}type:: #{type}\n" if type
+      docidentifier.each do |di|
+        out += di.to_asciibib prefix, docidentifier.size
+      end
+      out += "#{pref}docnumber:: #{docnumber}\n" if docnumber
+      out += "#{pref}edition:: #{edition}\n" if edition
+      language.each { |l| out += "#{pref}language:: #{l}\n" }
+      script.each { |s| out += "#{pref}script:: #{s}\n" }
+      out += version.to_asciibib prefix if version
+      biblionote&.each { |b| out += b.to_asciibib prefix, biblionote.size }
+      out += status.to_asciibib prefix if status
+      date.each { |d| out += d.to_asciibib prefix, date.size }
+      abstract.each do |a|
+        out += a.to_asciibib "#{pref}abstract", abstract.size
+      end
+      copyright.each { |c| out += c.to_asciibib prefix, copyright.size }
+      link.each { |l| out += l.to_asciibib prefix, link.size }
+      out += medium.to_asciibib prefix if medium
+      place.each { |pl| out += pl.to_asciibib prefix, place.size }
+      extent.each { |ex| out += ex.to_asciibib "#{pref}extent", extent.size }
+      accesslocation.each { |al| out += "#{pref}accesslocation:: #{al}\n" }
+      classification.each do |cl|
+        out += cl.to_asciibib prefix, classification.size
+      end
+      out += validity.to_asciibib prefix if validity
+      contributor.each do |c|
+        out += c.to_asciibib "contributor.*", contributor.size
+      end
+      out += relation.to_asciibib prefix if relation
+      series.each { |s| out += s.to_asciibib prefix, series.size }
+      out += "#{pref}doctype:: #{doctype}\n" if doctype
+      out += "#{pref}formattedref:: #{formattedref}\n" if formattedref
+      keyword.each { |kw| out += kw.to_asciibib "#{pref}keyword", keyword.size }
+      out += editorialgroup.to_asciibib prefix if editorialgroup
+      ics.each { |i| out += i.to_asciibib prefix, ics.size }
+      out += structuredidentifier.to_asciibib prefix if structuredidentifier
+      out
+    end
+
     private
 
     # @return [String]
@@ -470,7 +526,7 @@ module RelatonBib
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
 
     # @param [BibTeX::Entry]
-    def bibtex_author(item)
+    def bibtex_author(item) # rubocop:disable Metrics/CyclomaticComplexity
       authors = contributor.select do |c|
         c.entity.is_a?(Person) && c.role.map(&:type).include?("author")
       end.map &:entity
@@ -487,7 +543,7 @@ module RelatonBib
     end
 
     # @param [BibTeX::Entry]
-    def bibtex_contributor(item)
+    def bibtex_contributor(item) # rubocop:disable Metrics/CyclomaticComplexity
       contributor.each do |c|
         rls = c.role.map(&:type)
         if rls.include?("publisher") then item.publisher = c.entity.name
@@ -504,7 +560,7 @@ module RelatonBib
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     # @param [BibTeX::Entry]
-    def bibtex_note(item)
+    def bibtex_note(item) # rubocop:disable Metrics/CyclomaticComplexity
       biblionote.each do |n|
         case n.type
         when "annote" then item.annote = n.content

data/lib/relaton_bib/classification.rb

@@ -25,5 +25,16 @@ module RelatonBib
       hash["type"] = type if type
       hash
     end
+
+    # @param prefix [String]
+    # @param count [Integer] number of classifications
+    # @return [String]
+    def to_asciibib(prefix = "", count = 1)
+      pref = prefix.empty? ? "classification" : prefix + ".classification"
+      out = count > 1 ? "#{pref}::\n" : ""
+      out += "#{pref}.type:: #{type}\n" if type
+      out += "#{pref}.value:: #{value}\n"
+      out
+    end
   end
 end

data/lib/relaton_bib/contribution_info.rb

@@ -26,7 +26,9 @@ module RelatonBib
       end
 
       @type = args[:type]
-      @description = args.fetch(:description, []).map { |d| FormattedString.new content: d, format: nil }
+      @description = args.fetch(:description, []).map do |d|
+        FormattedString.new content: d, format: nil
+      end
     end
 
     # @param builder [Nokogiri::XML::Builder]
@@ -48,6 +50,19 @@ module RelatonBib
         type
       end
     end
+
+    # @param prefix [String]
+    # @param count [Integer] number of contributors
+    # 2return [String]
+    def to_asciibib(prefix = "", count = 1)
+      pref = prefix.empty? ? prefix : prefix + "."
+      out = count > 1 ? "#{prefix}::\n" : ""
+      description.each do |d|
+        out += d.to_asciibib "#{pref}role.description", description.size
+      end
+      out += "#{pref}role.type:: #{type}\n" if type
+      out
+    end
   end
 
   # Contribution info.
@@ -79,5 +94,16 @@ module RelatonBib
       hash["role"] = single_element_array(role) if role&.any?
       hash
     end
+
+    # @param prefix [String]
+    # @param count [Integer] number of contributors
+    # @return [String]
+    def to_asciibib(prefix = "", count = 1)
+      pref = prefix.split(".").first
+      out = count > 1 ? "#{pref}::\n" : ""
+      out += entity.to_asciibib prefix
+      role.each { |r| out += r.to_asciibib pref, role.size }
+      out
+    end
   end
 end

data/lib/relaton_bib/contributor.rb

@@ -54,6 +54,20 @@ module RelatonBib
       hash["postcode"] = postcode if postcode
       hash
     end
+
+    # @param prefix [String]
+    # @param count [Integer] number of addresses
+    # @return [String]
+    def to_asciibib(prefix = "", count = 1) # rubocop:disable Metrics/AbcSize
+      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
+    end
   end
 
   # Contact class.
@@ -80,6 +94,17 @@ module RelatonBib
     def to_hash
       { "type" => type, "value" => value }
     end
+
+    # @param prefix [String]
+    # @param count [Integer] number of contacts
+    # @return [string]
+    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.value:: #{value}\n"
+      out
+    end
   end
 
   # Affiliation.
@@ -117,9 +142,25 @@ module RelatonBib
     def to_hash
       hash = organization.to_hash
       hash["name"] = name.to_hash if name
-      hash["description"] = single_element_array(description) if description&.any?
+      if description&.any?
+        hash["description"] = single_element_array(description)
+      end
       hash
     end
+
+    # @param prefix [String]
+    # @param count [Integer]
+    # @return [String]
+    def to_asciibib(prefix = "", count = 1)
+      pref = prefix.empty? ? prefix : prefix + "."
+      out = count > 1 ? "#{pref}affiliation::\n" : ""
+      out += name.to_asciibib "#{pref}affiliation.name" if name
+      description.each do |d|
+        out += d.to_asciibib "#{pref}affiliation.description", description.size
+      end
+      out += organization.to_asciibib "#{pref}affiliation.*"
+      out
+    end
   end
 
   # Contributor.
@@ -157,5 +198,18 @@ module RelatonBib
       hash["contact"] = single_element_array(contact) if contact&.any?
       hash
     end
+
+    # @param prefix [String]
+    # @return [String]
+    def to_asciibib(prefix = "") # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+      pref = prefix.empty? ? prefix : prefix + "."
+      out = ""
+      out += "#{pref}url:: #{uri}\n" if uri
+      addr = contact.select { |c| c.is_a? RelatonBib::Address }
+      addr.each { |ct| out += ct.to_asciibib prefix, addr.size }
+      cont = contact.select { |c| c.is_a? RelatonBib::Contact }
+      cont.each { |ct| out += ct.to_asciibib prefix, cont.size }
+      out
+    end
   end
 end