relaton-bib 1.20.7 → 2.0.0.pre.alpha.1

data/lib/{relaton_bib.rb → relaton/bib.rb}

@@ -1,33 +1,42 @@
 require "relaton/logger"
 require "forwardable"
-require "yaml"
-require "htmlentities"
-require "relaton_bib/version"
-require "relaton_bib/deep_dup"
-require "relaton_bib/util"
-require "relaton_bib/localized_string"
-require "relaton_bib/forename"
-require "relaton_bib/full_name"
-require "relaton_bib/contributor"
-require "relaton_bib/document_type"
-require "relaton_bib/image"
-require "relaton_bib/bibliographic_item"
-require "relaton_bib/hit_collection"
-require "relaton_bib/hit"
-require "relaton_bib/bibxml_parser"
-require "relaton_bib/renderer/bibtex_builder"
-require "relaton_bib/renderer/bibxml"
+# require "htmlentities"
+require "bibtex"
+require "iso639"
+require "rfcxml"
+require_relative "bib/version"
+require_relative "bib/util"
+require_relative "bib/item_data"
+require_relative "bib/model/item"
+require_relative "bib/model/item_base"
+require_relative "bib/model/bibitem"
+require_relative "bib/model/bibdata"
+require_relative "bibxml_parser"
+require_relative "bib/renderer/bibtex_builder"
+require_relative "bib/renderer/rfc"
+require_relative "bib/parser/rfc_reference"
+require_relative "bib/parser/rfc_referencegroup"
+require_relative "bib/model/relation"
 
-module RelatonBib
-  class Error < StandardError; end
+module Relaton
+  # class Error < StandardError; end
 
   class RequestError < StandardError; end
 
   class << self
+    #
+    # Read schema versions from file
+    #
+    # @return [Hash{String=>String}] schema versions
+    #
+    def schema_versions
+      @@schema_versions ||= JSON.parse File.read(File.join(__dir__, "../../grammars/versions.json"))
+    end
+
     # @param date [String, Integer, Date] date
     # @param str [Boolean] return string or Date
     # @return [Date, String, nil] date
-    def parse_date(date, str = true) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity,Metrics/AbcSize
+    def parse_date(date, str: true) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
       return date if date.is_a?(Date)
 
       case date.to_s
@@ -58,7 +67,7 @@ module RelatonBib
       date = Date.strptime(date, format)
       str ? date.strftime(outformat || format) : date
     rescue Date::Error => e
-      Util.warn "#{date} #{e.message}"
+      Bib::Util.warn "#{date} #{e.message}"
       date
     end
 
@@ -90,22 +99,24 @@ module RelatonBib
     end
   end
 
-  def self.grammar_hash
-    # gem_path = File.expand_path "..", __dir__
-    # grammars_path = File.join gem_path, "grammars", "*"
-    # grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
-    Digest::MD5.hexdigest RelatonBib::VERSION # grammars
+  module Bib
+    def self.grammar_hash
+      # gem_path = File.expand_path "..", __dir__
+      # grammars_path = File.join gem_path, "grammars", "*"
+      # grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
+      Digest::MD5.hexdigest Relaton::Bib::VERSION # grammars
+    end
   end
 
-  private
+  # private
 
-  # @param array [Array]
-  # @return [Array<String>, String]
-  def single_element_array(array)
-    # if array.size > 1
-    array.map { |e| e.is_a?(String) ? e : e.to_hash }
-    # else
-    #   array.first.is_a?(String) ? array[0] : array.first&.to_hash
-    # end
-  end
+  # # @param array [Array]
+  # # @return [Array<String>, String]
+  # def single_element_array(array)
+  #   # if array.size > 1
+  #   array.map { |e| e.is_a?(String) ? e : e.to_hash }
+  #   # else
+  #   #   array.first.is_a?(String) ? array[0] : array.first&.to_hash
+  #   # end
+  # end
 end

data/lib/{relaton_bib → relaton}/bibtex_parser.rb

@@ -1,15 +1,12 @@
-require "bibtex"
-require "iso639"
-
-module RelatonBib
-  # @todo: move this class to the RelatonBib::Bibtex module
+module Relaton
+  # @todo: move this class to the Relaton::Bib::Bibtex module
   class BibtexParser
     class << self
       # @param bibtex [String]
-      # @return [Hash{String=>RelatonBib::BibliographicItem}]
+      # @return [Hash{String=>Relaton::Bib::Item}]
       def from_bibtex(bibtex) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
         BibTeX.parse(bibtex).reduce({}) do |h, bt|
-          h[bt.key] = BibliographicItem.new(
+          h[bt.key] = Item.new(
             id: bt.key,
             docid: fetch_docid(bt),
             fetched: fetch_fetched(bt),
@@ -35,12 +32,12 @@ module RelatonBib
       private
 
       # @param bibtex [BibTeX::Entry]
-      # @return [Array<RelatonBib::DocumentIdentifier>]
+      # @return [Array<Relaton::Bib::Docidentifier>]
       def fetch_docid(bibtex) # rubocop:disable Metrics/AbcSize
         docid = []
-        docid << DocumentIdentifier.new(id: bibtex.isbn.to_s, type: "isbn") if bibtex["isbn"]
-        docid << DocumentIdentifier.new(id: bibtex.lccn.to_s, type: "lccn") if bibtex["lccn"]
-        docid << DocumentIdentifier.new(id: bibtex.issn.to_s, type: "issn") if bibtex["issn"]
+        docid << Docidentifier.new(id: bibtex.isbn.to_s, type: "isbn") if bibtex["isbn"]
+        docid << Docidentifier.new(id: bibtex.lccn.to_s, type: "lccn") if bibtex["lccn"]
+        docid << Docidentifier.new(id: bibtex.issn.to_s, type: "issn") if bibtex["issn"]
         docid
       end
 
@@ -68,12 +65,12 @@ module RelatonBib
       end
 
       # @param bibtex [BibTeX::Entry]
-      # @return [RelatonBib::TypedTitleStringCollection]
+      # @return [Relaton::Bib::TitleCollection]
       def fetch_title(bibtex)
         title = []
         title << { type: "main", content: bibtex.convert(:latex).title.to_s } if bibtex["title"]
         title << { type: "main", content: bibtex.convert(:latex).subtitle.to_s } if bibtex["subtitle"]
-        TypedTitleStringCollection.new title
+        TitleCollection.new title
       end
 
       # @param bibtex [BibTeX::Entry]
@@ -113,7 +110,7 @@ module RelatonBib
       end
 
       # @param bibtex [BibTeX::Entry]
-      # @return [Array<RelatonBib::Person>]
+      # @return [Array<Relaton::Bib::Person>]
       def fetch_person(bibtex, role, &_) # rubocop:disable Metrics/AbcSize
         bibtex[role]&.each do |name|
           parts = name.split ", "
@@ -142,7 +139,7 @@ module RelatonBib
       end
 
       # @param bibtex [BibTeX::Entry]
-      # @return [RelatonBib::BiblioNoteCollection]
+      # @return [Relaton::Bib::BiblioNoteCollection]
       def fetch_note(bibtex) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
         bibtex.select do |k, _v|
           %i[annote howpublished comment note content].include? k
@@ -163,9 +160,9 @@ module RelatonBib
       def fetch_relation(bibtex)
         return [] unless bibtex["booktitle"]
 
-        ttl = TypedTitleString.new(type: "main", content: bibtex.booktitle.to_s)
-        title = TypedTitleStringCollection.new [ttl]
-        [{ type: "partOf", bibitem: BibliographicItem.new(title: title) }]
+        ttl = Title.new(type: "main", content: bibtex.booktitle.to_s)
+        title = TitleCollection.new [ttl]
+        [{ type: "partOf", bibitem: Item.new(title: title) }]
       end
 
       # @param bibtex [BibTeX::Entry]
@@ -188,31 +185,31 @@ module RelatonBib
       end
 
       # @param bibtex [BibTeX::Entry]
-      # @return [Array<RelatonBib::Series>]
+      # @return [Array<Relaton::Bib::Series>]
       def fetch_series(bibtex) # rubocop:disable Metrics/MethodLength
         series = []
         if bibtex["journal"]
           series << Series.new(
             type: "journal",
-            title: TypedTitleString.new(content: bibtex.journal.to_s),
-            number: bibtex["number"]&.to_s
+            title: Title.new(content: bibtex.journal.to_s),
+            number: bibtex["number"]&.to_s,
           )
         end
 
         if bibtex["series"]
-          title = TypedTitleString.new content: bibtex.series.to_s
+          title = Title.new content: bibtex.series.to_s
           series << Series.new(title: title)
         end
         series
       end
 
       # @param bibtex [BibTeX::Entry]
-      # @return [Array<RelatonBib::TypedUri>]
+      # @return [Array<Relaton::Bib::Bsource>]
       def fetch_link(bibtex) # rubocop:disable Metrics/AbcSize
         link = []
-        link << TypedUri.new(type: "src", content: bibtex.url.to_s) if bibtex["url"]
-        link << TypedUri.new(type: "doi", content: bibtex.doi.to_s) if bibtex["doi"]
-        link << TypedUri.new(type: "file", content: bibtex.file2.to_s) if bibtex["file2"]
+        link << Bsource.new(type: "src", content: bibtex.url.to_s) if bibtex["url"]
+        link << Bsource.new(type: "doi", content: bibtex.doi.to_s) if bibtex["doi"]
+        link << Bsource.new(type: "file", content: bibtex.file2.to_s) if bibtex["file2"]
         link
       end
 
@@ -225,7 +222,7 @@ module RelatonBib
       end
 
       # @param bibtex [BibTeX::Entry]
-      # @return [RelatonBib::Classification, nil]
+      # @return [Relaton::Bib::Classification, nil]
       def fetch_classification(bibtex)
         cls = []
         cls << Classification.new(type: "type", value: bibtex["type"].to_s) if bibtex["type"]

data/lib/{relaton_bib → relaton}/bibxml_parser.rb

@@ -1,4 +1,4 @@
-module RelatonBib
+module Relaton
   module BibXMLParser
     # SeriesInfo what should be saved as docidentifiers in the Relaton model.
     SERIESINFONAMES = ["DOI"].freeze
@@ -31,7 +31,7 @@ module RelatonBib
     # @param is_relation [Boolean] don't add fetched date for relation if true
     # @param url [String, nil]
     # @param ver [String, nil] Internet Draft version
-    # @return [RelatonBib::BibliographicItem]
+    # @return [Relaton::Bib::Item]
     def fetch_rfc(reference, is_relation: false, url: nil, ver: nil) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       return unless reference
 
@@ -64,10 +64,10 @@ module RelatonBib
     end
 
     # @param attrs [Hash]
-    # @return [RelatonBib::BibliographicItem]
+    # @return [Relaton::Bib::Item]
     def bib_item(**attrs)
       # attrs[:place] = ["Fremont, CA"]
-      BibliographicItem.new(**attrs)
+      Item.new(**attrs)
     end
 
     # @param reference [Nokogiri::XML::Element]
@@ -82,7 +82,7 @@ module RelatonBib
     # @param reference [Nokogiri::XML::Element]
     # @param ver [String, nil] Internet Draft version
     #
-    # @return [Array<RelatonBib::DocumentIdentifier>]
+    # @return [Array<Relaton::Bib::Docidentifier>]
     #
     def docids(reference, ver) # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/AbcSize
       ret = []
@@ -91,7 +91,7 @@ module RelatonBib
       if si
         id = si[:value]
         id.sub!(/(?<=-)\d{2}$/, ver) if ver
-        ret << DocumentIdentifier.new(type: "Internet-Draft", id: id, primary: true)
+        ret << Bib::Docidentifier.new(type: "Internet-Draft", id: id, primary: true)
       else
         id = reference[:anchor] || reference[:docName] || reference[:number]
         ret << create_docid(id, ver) if id
@@ -106,7 +106,7 @@ module RelatonBib
                     reference[atr]
                   end
           type = pubid_type id
-          ret << DocumentIdentifier.new(id: atrid, type: type, scope: atr)
+          ret << Bib::Docidentifier.new(id: atrid, type: type, scope: atr)
         end
       end
 
@@ -115,7 +115,7 @@ module RelatonBib
 
         id = si[:value]
         # id.sub!(/(?<=-)\d{2}$/, ver) if ver && si[:name] == "Internet-Draft"
-        DocumentIdentifier.new(id: id, type: si[:name])
+        Bib::Docidentifier.new(id: id, type: si[:name])
       end.compact
     end
 
@@ -132,7 +132,7 @@ module RelatonBib
         pid = pref ? "#{pref} #{num}" : id
         type = pubid_type id
       end
-      DocumentIdentifier.new(type: type, id: pid, primary: true)
+      Docidentifier.new(type: type, id: pid, primary: true)
     end
 
     def id_to_pref_num(id)
@@ -155,7 +155,7 @@ module RelatonBib
     # extract status
     # @param reference [Nokogiri::XML::Element]
     #
-    # @return [RelatonBib::DocumentStatus]
+    # @return [Relaton::Bib::DocumentStatus]
     #
     def status(reference)
       st = reference.at("./seriesinfo[@status]")
@@ -188,26 +188,24 @@ module RelatonBib
     end
 
     # @param reference [Nokogiri::XML::Element]
-    # @return [RelatonBib::FormattedRef, nil]
+    # @return [Relaton::Bib::Formattedref, nil]
     def formattedref(reference)
       return if reference.at "./front/title"
 
-      cont = (reference[:anchor] || reference[:docName] || reference[:number])
+      cont = reference[:anchor] || reference[:docName] || reference[:number]
       if cont
-        FormattedRef.new(
+        Formattedref.new(
           content: cont, language: language(reference), script: "Latn",
         )
       end
     end
 
     # @param reference [Nokogiri::XML::Element]
-    # @return [Array<RelatonBib::FormattedString>]
+    # @return [Array<Relaton::Bib::FormattedString>]
     def abstracts(ref)
       ref.xpath("./front/abstract").map do |a|
-        c = a.inner_html.gsub(/\s*(<\/?)t(>)\s*/, '\1p\2')
-          .gsub(/[\t\n]/, " ").squeeze " "
-        FormattedString.new(content: c, language: language(ref), script: "Latn",
-                            format: "text/html")
+        c = a.inner_html.gsub(/\s*(<\/?)t(>)\s*/, '\1p\2').gsub(/[\t\n]/, " ").squeeze " "
+        Bib::FormattedString.new(content: c, language: language(ref), script: "Latn", format: "text/html")
       end
     end
 
@@ -225,17 +223,16 @@ module RelatonBib
 
     # @param author [Nokogiri::XML::Element]
     # @param lang [String]
-    # @return [RelatonBib::Person, nil]
+    # @return [Relaton::Bib::Person, nil]
     def person(author, lang)
       return unless author[:fullname] || author[:surname]
 
       name = full_name(author[:fullname], author[:surname], author[:initials], lang)
-      Person.new(name: name, affiliation: affiliation(author),
-                 contact: contacts(author.at("./address")))
+      Bib::Person.new(name: name, affiliation: affiliation(author), contact: contacts(author.at("./address")))
     end
 
     # @param contrib [Nokogiri::XML::Element]
-    # @return [RelatonBib::Organization, nil]
+    # @return [Relaton::Bib::Organization, nil]
     def organization(contrib)
       org = contrib.at("./organization")
       return unless org
@@ -251,10 +248,10 @@ module RelatonBib
     # @param sname [String] surname
     # @param inits [String] initials
     # @param lang [String] language
-    # @return [RelatonBib::FullName]
+    # @return [Relaton::Bib::FullName]
     def full_name(fname, sname, inits, lang)
       initials = localized_string(inits, lang) if inits
-      FullName.new(
+      Bib::FullName.new(
         completename: localized_string(fname, lang), initials: initials,
         forename: forename(inits, lang), surname: localized_string(sname, lang)
       )
@@ -266,43 +263,43 @@ module RelatonBib
     # @param [String] initials initials
     # @param [String] lang language
     #
-    # @return [Array<RelatonBib::Forename>] forenames
+    # @return [Array<Relaton::Bib::Forename>] forenames
     #
     def forename(initials, lang = nil, script = nil)
       return [] unless initials
 
       initials.split(/\.-?\s?|\s/).map do |i|
-        Forename.new(initial: i, language: lang, script: script)
+        Bib::Forename.new(initial: i, language: lang, script: script)
       end
     end
 
     # @param author [Nokogiri::XML::Element]
-    # @return [Array<RelatonBib::Affiliation>]
+    # @return [Array<Relaton::Bib::Affiliation>]
     def affiliation(author)
       o = author.at("./organization")
       return [] if o.nil? || o.text.empty?
 
       org = new_org o.text, o[:abbrev]
-      [Affiliation.new(organization: org)]
+      [Bib::Affiliation.new(organization: org)]
     end
 
     # @param name [String]
     # @param abbr [String, nil]
-    # @return [RelatonBib::Organization]
+    # @return [Relaton::Bib::Organization]
     def new_org(name, abbr = nil)
-      Organization.new name: name, abbreviation: abbr
+      Bib::Organization.new name: name, abbreviation: abbr
     end
 
     # @param content [String, nil]
     # @param lang [String, nil]
     # @param script [String, nil]
-    # @return [RelatonBib::LocalizedString, nil]
+    # @return [Relaton::Bib::LocalizedString, nil]
     def localized_string(content, lang, script = nil)
-      LocalizedString.new(content, lang, script) if content
+      Bib::LocalizedString.new(content: content, laguage: lang, script: script) if content
     end
 
     # @param postal [Nokogiri::XML::Element]
-    # @return [Array<RelatonBib::Address, RelatonBib::Phone>]
+    # @return [Array<Relaton::Bib::Address, Relaton::Bib::Phone>]
     def contacts(addr)
       conts = []
       return conts unless addr
@@ -316,10 +313,10 @@ module RelatonBib
     end
 
     # @param postal [Nokogiri::XML::Element]
-    # @rerurn [RelatonBib::Address]
+    # @return [Relaton::Bib::Address]
     def address(postal) # rubocop:disable Metrics/CyclomaticComplexity
       street = [postal.at("./postalLine | ./street")&.text].compact
-      Address.new(
+      Bib::Address.new(
         street: street,
         city: postal.at("./city")&.text,
         postcode: postal.at("./code")&.text,
@@ -328,11 +325,11 @@ module RelatonBib
       )
     end
 
-    # @param conts [Array<RelatonBib::Address, RelatonBib::Contact>]
+    # @param conts [Array<Relaton::Bib::Address, Relaton::Bib::Contact>]
     # @param type [String] allowed "phone", "email" or "uri"
     # @param value [String]
     def add_contact(conts, type, value)
-      conts << Contact.new(type: type, value: value.text) if value
+      conts << Bib::Contact.new(type: type, value: value.text) if value
     end
 
     # @param author [Nokogiri::XML::Document]
@@ -353,7 +350,7 @@ module RelatonBib
     # Extract date from reference.
     #
     # @param reference [Nokogiri::XML::Element]
-    # @return [Array<RelatonBib::BibliographicDate>] published data.
+    # @return [Array<Relaton::Bib::Bdate>] published data.
     #
     def dates(reference) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
       date = reference.at "./front/date"
@@ -363,23 +360,23 @@ module RelatonBib
       d += "-#{month(date[:month])}" if date[:month] && !date[:month].empty?
       d += "-#{date[:day]}" if date[:day]
       # date = Time.parse(d).strftime "%Y-%m-%d"
-      [BibliographicDate.new(type: "published", on: d)]
+      [Bib::Date.new(type: "published", on: d)]
     end
 
     # @param reference [Nokogiri::XML::Element]
-    # @return [RelatonBib::EditorialGroup, nil]
+    # @return [Relaton::Bib::EditorialGroup, nil]
     def editorialgroup(reference)
       tc = reference.xpath("./front/workgroup").map do |ed|
-        wg = WorkGroup.new name: ed.text
+        wg = Bib::WorkGroup.new name: ed.text
         committee wg
       end
       EditorialGroup.new tc if tc.any?
     end
 
-    # @param [RelatonBib::WorkGroup]
-    # @return [RelatonBib::TechnicalCommittee]
+    # @param [Relaton::Bib::WorkGroup]
+    # @return [Relaton::Bib::TechnicalCommittee]
     def committee(wgr)
-      TechnicalCommittee.new wgr
+      Bib::TechnicalCommittee.new wgr
     end
 
     def month(mon)
@@ -393,13 +390,13 @@ module RelatonBib
     # Extract series form reference
     # @param reference [Nokogiri::XML::Element]
     #
-    # @return [Array<RelatonBib::Series>]
+    # @return [Array<Relaton::Bib::Series>]
     #
     def series(reference)
       reference.xpath("./seriesInfo", "./front/seriesInfo").map do |si|
         next if SERIESINFONAMES.include?(si[:name]) || si[:stream] || si[:status]
 
-        t = TypedTitleString.new(
+        t = Title.new(
           content: si[:name], language: language(reference), script: "Latn",
         )
         Series.new(title: t, number: si[:value], type: "main")

data/lib/{relaton_bib → relaton}/hit.rb

@@ -1,15 +1,15 @@
 require "weakref"
 
-module RelatonBib
+module Relaton
   class Hit
-    # @return [RelatonBib::HitCollection]
+    # @return [Relaton::HitCollection]
     attr_accessor :hit_collection
 
     # @return [Array<Hash>]
     attr_reader :hit
 
     # @param hit [Hash]
-    # @param hit_collection [RelatonBib::HitCollection]
+    # @param hit_collection [Relaton::HitCollection]
     def initialize(hit, hit_collection = nil)
       @hit            = hit
       @hit_collection = WeakRef.new hit_collection if hit_collection

data/lib/{relaton_bib → relaton}/hit_collection.rb

@@ -1,6 +1,6 @@
 require "forwardable"
 
-module RelatonBib
+module Relaton
   class HitCollection
     extend Forwardable
 
@@ -68,7 +68,7 @@ module RelatonBib
     #
     # @param [Proc] &block proc to select hits
     #
-    # @return [RelatonBib::HitCollection] new hit collection
+    # @return [Relaton::Bib::HitCollection] new hit collection
     #
     def select(&block)
       me = deep_dup

data/lib/{relaton_bib → relaton}/workers_pool.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module RelatonBib
+module Relaton
   # Workers poll.
   class WorkersPool
     attr_accessor :nb_hits