relaton-bib 1.2.4 → 1.5.pre

data/lib/relaton_bib.rb

@@ -1,3 +1,4 @@
+require "forwardable"
 require "relaton_bib/version"
 require "relaton_bib/deep_dup"
 require "relaton_bib/bibliographic_item"
@@ -10,11 +11,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 +29,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,Metrics/PerceivedComplexity
     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

@@ -1,4 +1,31 @@
 module RelatonBib
+  class BiblioNoteCollection
+    extend Forwardable
+
+    def_delegators :@array, :[], :first, :last, :empty?, :any?, :size,
+                   :each, :map, :detect, :length
+
+    def initialize(notes)
+      @array = notes
+    end
+
+    # @param bibnote [RelatonBib::BiblioNote]
+    # @return [self]
+    def <<(bibnote)
+      @array << bibnote
+      self
+    end
+
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] XML builder
+    # @option opts [String] :lang language
+    def to_xml(**opts)
+      bnc = @array.select { |bn| bn.language&.include? opts[:lang] }
+      bnc = @array unless bnc.any?
+      bnc.each { |bn| bn.to_xml opts[:builder] }
+    end
+  end
+
   class BiblioNote < FormattedString
     # @return [String, NilClass]
     attr_reader :type
@@ -29,5 +56,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

@@ -6,7 +6,8 @@ module RelatonBib
   # Bibliographic date.
   class BibliographicDate
     TYPES = %w[published accessed created implemented obsoleted confirmed
-               updated issued transmitted copied unchanged circulated adapted].freeze
+               updated issued transmitted copied unchanged circulated adapted
+               vote-started vote-ended].freeze
 
     # @return [String]
     attr_reader :type
@@ -60,6 +61,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

@@ -45,7 +45,7 @@ module RelatonBib
     attr_reader :id, :type, :docnumber, :edition, :doctype
 
     # @!attribute [r] title
-    # @return [Array<RelatonBib::TypedTitleString>]
+    # @return [RelatonBib::TypedTitleStringCollection]
 
     # @return [Array<RelatonBib::TypedUri>]
     attr_reader :link
@@ -59,10 +59,10 @@ module RelatonBib
     # @return [Array<RelatonBib::ContributionInfo>]
     attr_reader :contributor
 
-    # @return [RelatonBib::BibliongraphicItem::Version, NilClass]
+    # @return [RelatonBib::BibliographicItem::Version, NilClass]
     attr_reader :version
 
-    # @return [Array<RelatonBib::BiblioNote>]
+    # @return [RelatonBib::BiblioNoteCollection]
     attr_reader :biblionote
 
     # @return [Array<String>] language Iso639 code
@@ -126,7 +126,8 @@ module RelatonBib
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # @param id [String, NilClass]
-    # @param title [Array<RelatonBib::TypedTitleString>]
+    # @param title [RelatonBib::TypedTitleStringCollection,
+    #   Array<Hash, RelatonBib::TypedTitleString>]
     # @param formattedref [RelatonBib::FormattedRef, NilClass]
     # @param type [String, NilClass]
     # @param docid [Array<RelatonBib::DocumentIdentifier>]
@@ -136,7 +137,7 @@ module RelatonBib
     # @param docstatus [RelatonBib::DocumentStatus, NilClass]
     # @param edition [String, NilClass]
     # @param version [RelatonBib::BibliographicItem::Version, NilClass]
-    # @param biblionote [Array<RelatonBib::BiblioNote>]
+    # @param biblionote [RelatonBib::BiblioNoteCollection]
     # @param series [Array<RelatonBib::Series>]
     # @param medium [RelatonBib::Medium, NilClas]
     # @param place [Array<String, RelatonBib::Place>]
@@ -193,9 +194,7 @@ module RelatonBib
         warn %{[relaton-bib] document type "#{args[:type]}" is invalid.}
       end
 
-      @title = (args[:title] || []).map do |t|
-        t.is_a?(Hash) ? TypedTitleString.new(t) : t
-      end
+      @title = TypedTitleStringCollection.new(args[:title])
 
       @date = (args[:date] || []).map do |d|
         d.is_a?(Hash) ? BibliographicDate.new(d) : d
@@ -224,7 +223,7 @@ module RelatonBib
       @docnumber      = args[:docnumber]
       @edition        = args[:edition]
       @version        = args[:version]
-      @biblionote     = args.fetch :biblionote, []
+      @biblionote     = args.fetch :biblionote, BiblioNoteCollection.new([])
       @language       = args.fetch :language, []
       @script         = args.fetch :script, []
       @status         = args[:docstatus]
@@ -237,13 +236,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]
@@ -257,12 +261,15 @@ module RelatonBib
     # @return [RelatonBib::FormattedString, Array<RelatonBib::FormattedString>]
     def abstract(lang: nil)
       if lang
-        @abstract.detect { |a| a.language.include? lang }
+        @abstract.detect { |a| a.language&.include? lang }
       else
         @abstract
       end
     end
 
+    # @param id [RelatonBib::DocumentIdentifier]
+    # @param attribute [boolean, nil]
+    # @return [String]
     def makeid(id, attribute)
       return nil if attribute && !@id_attribute
 
@@ -277,8 +284,12 @@ module RelatonBib
       idstr.strip
     end
 
+    # @param identifier [RelatonBib::DocumentIdentifier]
+    # @param options [Hash]
+    # @option options [boolean, nil] :no_year
+    # @option options [boolean, nil] :all_parts
     # @return [String]
-    def shortref(identifier, **opts)
+    def shortref(identifier, **opts) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize,Metrics/PerceivedComplexity
       pubdate = date.select { |d| d.type == "published" }
       year = if opts[:no_year] || pubdate.empty? then ""
              else ":" + pubdate&.first&.on&.year.to_s
@@ -288,22 +299,24 @@ module RelatonBib
       "#{makeid(identifier, false)}#{year}"
     end
 
-    # @param builder [Nokogiri::XML::Builder, NillClass] (nil)
-    # @return [String]
-    def to_xml(builder = nil, **opts, &block)
-      if builder
-        render_xml builder, **opts, &block
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
+    # @option opts [Boolean] :bibdata
+    # @option opts [Symbol, NilClass] :date_format (:short), :full
+    # @option opts [String, Symbol] :lang language
+    # @return [String] XML
+    def to_xml(**opts, &block)
+      if opts[:builder]
+        render_xml **opts, &block
       else
         Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
-          render_xml xml, **opts, &block
+          render_xml builder: xml, **opts, &block
         end.doc.root.to_xml
       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 +325,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,25 +343,30 @@ 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?
       hash["license"] = single_element_array(license) if license&.any?
       hash["doctype"] = doctype if doctype
-      hash["editorialgroup"] = editorialgroup.to_hash if editorialgroup
+      if editorialgroup&.presence?
+        hash["editorialgroup"] = editorialgroup.to_hash
+      end
       hash["ics"] = single_element_array ics if ics.any?
       if structuredidentifier&.presence?
         hash["structuredidentifier"] = structuredidentifier.to_hash
       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,14 +389,11 @@ module RelatonBib
       bibtex << item
       bibtex.to_s
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-    # @param lang [String] language code Iso639
-    # @return [Array<RelatonIsoBib::TypedTitleString>]
+    # @param lang [String, nil] language code Iso639
+    # @return [RelatonIsoBib::TypedTitleStringCollection]
     def title(lang: nil)
-      if lang then @title.select { |t| t.title.language&.include? lang }
-      else @title
-      end
+      @title.lang lang
     end
 
     # @param type [Symbol] type of url, can be :src/:obp/:rss
@@ -391,7 +408,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 +416,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,Metrics/PerceivedComplexity
       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) }
+        me.title.delete_title_part!
+        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 +459,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,Metrics/PerceivedComplexity
       @revdate ||= if version&.revision_date
                      version.revision_date
                    else
@@ -448,6 +467,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 +536,7 @@ module RelatonBib
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
 
     # @param [BibTeX::Entry]
-    def bibtex_author(item)
+    def bibtex_author(item) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       authors = contributor.select do |c|
         c.entity.is_a?(Person) && c.role.map(&:type).include?("author")
       end.map &:entity
@@ -487,7 +553,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 +570,7 @@ module RelatonBib
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     # @param [BibTeX::Entry]
-    def bibtex_note(item)
+    def bibtex_note(item) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize
       biblionote.each do |n|
         case n.type
         when "annote" then item.annote = n.content
@@ -600,13 +666,16 @@ module RelatonBib
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     # rubocop:disable Style/NestedParenthesizedCalls, Metrics/BlockLength
 
-    # @param builder [Nokogiri::XML::Builder]
-    # @return [String]
-    def render_xml(builder, **opts)
+    # @param opts [Hash]
+    # @option opts [Nokogiri::XML::Builder] :builder XML builder
+    # @option opts [Boolean] bibdata
+    # @option opts [Symbol, NilClass] :date_format (:short), :full
+    # @option opts [String] :lang language
+    def render_xml(**opts)
       root = opts[:bibdata] ? :bibdata : :bibitem
-      xml = builder.send(root) do
+      xml = opts[:builder].send(root) do |builder|
         builder.fetched fetched if fetched
-        title.each { |t| builder.title { t.to_xml builder } }
+        title.to_xml **opts
         formattedref&.to_xml builder
         link.each { |s| s.to_xml builder }
         docidentifier.each { |di| di.to_xml builder }
@@ -614,18 +683,23 @@ module RelatonBib
         date.each { |d| d.to_xml builder, **opts }
         contributor.each do |c|
           builder.contributor do
-            c.role.each { |r| r.to_xml builder }
-            c.to_xml builder
+            c.role.each { |r| r.to_xml **opts }
+            c.to_xml **opts
           end
         end
         builder.edition edition if edition
         version&.to_xml builder
-        biblionote.each { |n| n.to_xml builder }
+        biblionote.to_xml **opts
+        opts[:note]&.each do |n|
+          builder.note(n[:text], format: "text/plain", type: n[:type])
+        end
         language.each { |l| builder.language l }
         script.each { |s| builder.script s }
-        abstract.each { |a| builder.abstract { a.to_xml(builder) } }
+        abstr = abstract.select { |ab| ab.language&.include? opts[:lang] }
+        abstr = abstract unless abstr.any?
+        abstr.each { |a| builder.abstract { a.to_xml(builder) } }
         status&.to_xml builder
-        copyright&.each { |c| c.to_xml builder }
+        copyright&.each { |c| c.to_xml **opts }
         relation.each { |r| r.to_xml builder, **opts }
         series.each { |s| s.to_xml builder }
         medium&.to_xml builder
@@ -634,7 +708,9 @@ module RelatonBib
         accesslocation.each { |al| builder.accesslocation al }
         license.each { |l| builder.license l }
         classification.each { |cls| cls.to_xml builder }
-        keyword.each { |kw| builder.keyword { kw.to_xml(builder) } }
+        kwrd = keyword.select { |kw| kw.language&.include? opts[:lang] }
+        kwrd = keyword unless kwrd.any?
+        kwrd.each { |kw| builder.keyword { kw.to_xml(builder) } }
         validity&.to_xml builder
         if block_given? then yield builder
         elsif opts[:bibdata] && (doctype || editorialgroup || ics&.any? ||