relaton-bib 1.14.4 → 1.14.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d516a0a4756006072259b99674e50cefab3405f8824761c50faeca40bac5c71
-  data.tar.gz: f349fc209e2f2f684e71ad1044b3c23d37dcf905f4852841509f0319bfcd42be
+  metadata.gz: b2ee0b39ee5595e61f628004eeff3f73bb136de969d1897911fb414dbafee43c
+  data.tar.gz: 76ebf35457db552b454bcad1ca85387338cd85a1cb78761b0a701065a21f56c9
 SHA512:
-  metadata.gz: 99f2a47867468501d678c7b3807eb3be541dfd522ebe5f373b48499b82a3c4095c4bfe572967cd1f871e87b98e58d66c8207dc339a06a91355f25f560b06c4ad
-  data.tar.gz: a69cad9aaee6bd53fb2e17dc55102e2c37738142d6f7a6978d5db3d4524b3b29a276df85ca9feb95567f173dfae6d574c46c2a5da97c771774c8de5de084dd24
+  metadata.gz: e9526cb48e9a8a36d71c0b1b560b15a4d20f53bda8836ec15f4d020314881c53791e2f9b5e59f8a27acd1191e1cb16a80e34dc3b7c0fb2823784be9b6ae992de
+  data.tar.gz: 7085340f765f6c27e588d79deefbaa72326a6b5f7c13130b880c0c2e2d97031d96668b4a88fe7d5dfcfd613c26a6434945e38f83558fe5ebed3fa3372b87ad64

data/lib/relaton_bib/bib_item_locality.rb

@@ -62,9 +62,10 @@ module RelatonBib
       when "chapter" then item.chapter = reference_from
       when "page"
         value = reference_from
-        value += "-#{reference_to}" if reference_to
+        value += "--#{reference_to}" if reference_to
         item.pages = value
       when "volume" then item.volume = reference_from
+      when "issue" then item.number = reference_from
       end
     end
   end

data/lib/relaton_bib/bibliographic_item.rb

@@ -448,7 +448,7 @@ module RelatonBib
     # @return [String]
     #
     def to_bibtex(bibtex = nil)
-      bibtext_item(bibtex).to_s
+      Renderer::BibtexBuilder.build(self, bibtex).to_s
     end
 
     #
@@ -459,7 +459,9 @@ module RelatonBib
     # @return [Hash] citeproc
     #
     def to_citeproc(bibtex = nil)
-      bibtext_item(bibtex).to_citeproc.map { |cp| cp.transform_keys(&:to_s) }
+      Renderer::BibtexBuilder.build(self, bibtex).to_citeproc.map do |cp|
+        cp.transform_keys(&:to_s)
+      end
     end
 
     # @param lang [String, nil] language code Iso639
@@ -590,162 +592,6 @@ module RelatonBib
 
     private
 
-    #
-    # Create BibTeX item for this document
-    #
-    # @param [BibTeX::Bibliography, nil] bibtex <description>
-    #
-    # @return [BibTeX::Bibliography] BibTeX bibliography
-    #
-    def bibtext_item(bibtex) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
-      item = BibTeX::Entry.new
-      item.type = bibtex_type
-      item.key = id
-      title.to_bibtex item
-      item.edition = edition.content if edition
-      bibtex_author item
-      bibtex_contributor item
-      item.address = place.first.name if place.any?
-      bibtex_note item
-      bibtex_relation item
-      bibtex_extent item
-      bibtex_date item
-      bibtex_series item
-      bibtex_classification item
-      item.keywords = keyword.map(&:content).join(", ") if keyword.any?
-      bibtex_docidentifier item
-      item.timestamp = fetched.to_s if fetched
-      bibtex_link item
-      bibtex ||= BibTeX::Bibliography.new
-      bibtex << item
-      bibtex
-    end
-
-    # @return [String]
-    def bibtex_type
-      case type
-      when "standard", nil then "misc"
-      else type
-      end
-    end
-
-    # @param [BibTeX::Entry]
-    def bibtex_author(item) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/AbcSize
-      authors = contributor.select do |c|
-        c.entity.is_a?(Person) && c.role.map(&:type).include?("author")
-      end.map &:entity
-
-      return unless authors.any?
-
-      item.author = authors.map do |a|
-        if a.name.surname
-          "#{a.name.surname}, #{a.name.forename.map(&:to_s).join(' ')}"
-        else
-          a.name.completename.to_s
-        end
-      end.join " and "
-    end
-
-    # @param [BibTeX::Entry]
-    def bibtex_contributor(item) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
-      contributor.each do |c|
-        rls = c.role.map(&:type)
-        if rls.include?("publisher") then item.publisher = c.entity.name
-        elsif rls.include?("distributor")
-          case type
-          when "techreport" then item.institution = c.entity.name
-          when "inproceedings", "conference", "manual", "proceedings"
-            item.organization = c.entity.name
-          when "mastersthesis", "phdthesis" then item.school = c.entity.name
-          end
-        end
-      end
-    end
-
-    # @param [BibTeX::Entry]
-    def bibtex_note(item) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize
-      biblionote.each do |n|
-        case n.type
-        when "annote" then item.annote = n.content
-        when "howpublished" then item.howpublished = n.content
-        when "comment" then item.comment = n.content
-        when "tableOfContents" then item.content = n.content
-        when nil then item.note = n.content
-        end
-      end
-    end
-
-    # @param [BibTeX::Entry]
-    def bibtex_relation(item)
-      rel = relation.detect { |r| r.type == "partOf" }
-      if rel
-        title_main = rel.bibitem.title.detect { |t| t.type == "main" }
-        item.booktitle = title_main.title.content
-      end
-    end
-
-    # @param [BibTeX::Entry]
-    def bibtex_extent(item)
-      extent.each { |e| e.to_bibtex(item) }
-    end
-
-    # @param [BibTeX::Entry]
-    def bibtex_date(item)
-      date.each do |d|
-        case d.type
-        when "published"
-          item.year = d.on :year
-          item.month = d.on :month
-        when "accessed" then item.urldate = d.on.to_s
-        end
-      end
-    end
-
-    # @param [BibTeX::Entry]
-    def bibtex_series(item)
-      series.each do |s|
-        case s.type
-        when "journal"
-          item.journal = s.title.title
-          item.number = s.number if s.number
-        when nil then item.series = s.title.title
-        end
-      end
-    end
-
-    # @param [BibTeX::Entry]
-    def bibtex_classification(item)
-      classification.each do |c|
-        case c.type
-        when "type" then item["type"] = c.value
-        # when "keyword" then item.keywords = c.value
-        when "mendeley" then item["mendeley-tags"] = c.value
-        end
-      end
-    end
-
-    # @param [BibTeX::Entry]
-    def bibtex_docidentifier(item)
-      docidentifier.each do |i|
-        case i.type
-        when "isbn" then item.isbn = i.id
-        when "lccn" then item.lccn = i.id
-        when "issn" then item.issn = i.id
-        end
-      end
-    end
-
-    # @param [BibTeX::Entry]
-    def bibtex_link(item)
-      link.each do |l|
-        case l.type
-        when "doi" then item.doi = l.content
-        when "file" then item.file2 = l.content
-        when "src" then item.url = l.content
-        end
-      end
-    end
-
     # @param opts [Hash]
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [Boolean] bibdata

data/lib/relaton_bib/bibtex_parser.rb

@@ -2,6 +2,7 @@ require "bibtex"
 require "iso639"
 
 module RelatonBib
+  # @todo: move this class to the RelatonBib::Bibtex module
   class BibtexParser
     class << self
       # @param bibtex [String]

data/lib/relaton_bib/renderer/bibtex_builder.rb

@@ -0,0 +1,312 @@
+# Monkey patch to fix the issue with month quotes in BibTeX
+module BibTeX
+  class Value
+    def to_s(options = {})
+      if options.key?(:filter)
+        opts = options.reject { |k,| k == :filter || (k == :quotes && (!atomic? || symbol?)) }
+        return convert(options[:filter]).to_s(opts)
+      end
+
+      return value.to_s unless options.key?(:quotes) && atomic?
+
+      q = Array(options[:quotes])
+      [q[0], value, q[-1]].compact.join
+    end
+  end
+end
+
+module RelatonBib
+  # BibTeX builder.
+  module Renderer
+    class BibtexBuilder
+      ATTRS = %i[
+        type id title author editor booktitle series number edition contributor
+        date address note relation extent classification keyword docidentifier
+        timestamp link
+      ].freeze
+
+      #
+      # Build BibTeX bibliography.
+      #
+      # @param bib [RelatonBib::BibliographicItem]
+      # @param bibtex [BibTeX::Bibliography, nil] BibTeX bibliography
+      #
+      # @return [BibTeX::Bibliography] BibTeX bibliography
+      #
+      def self.build(bib, bibtex = nil)
+        new(bib).build bibtex
+      end
+
+      #
+      # Initialize BibTeX builder.
+      #
+      # @param bib [RelatonBib::BibliographicItem]
+      def initialize(bib)
+        @bib = bib
+      end
+
+      #
+      # Build BibTeX bibliography.
+      #
+      # @param bibtex [BibTeX::Bibliography, nil] BibTeX bibliography
+      #
+      # @return [BibTeX::Bibliography] BibTeX bibliography
+      #
+      def build(bibtex = nil)
+        @item = BibTeX::Entry.new
+        ATTRS.each { |a| send("add_#{a}") }
+        bibtex ||= BibTeX::Bibliography.new
+        bibtex << @item
+        bibtex
+      end
+
+      private
+
+      #
+      # Add type to BibTeX item
+      #
+      def add_type
+        @item.type = bibtex_type
+      end
+
+      # @return [String] BibTeX type
+      def bibtex_type
+        case @bib.type
+        when "standard", nil then "misc"
+        else @bib.type
+        end
+      end
+
+      #
+      # Add ID to BibTeX item
+      #
+      def add_id
+        @item.key = @bib.id
+      end
+
+      #
+      # Add title to BibTeX item
+      #
+      def add_title
+        @bib.title.to_bibtex @item
+      end
+
+      #
+      # Add booktitle to BibTeX item
+      #
+      def add_booktitle
+        included_in = @bib.relation.detect { |r| r.type == "includedIn" }
+        return unless included_in
+
+        @item.booktitle = included_in.bibitem.title.first.title
+      end
+
+      #
+      # Add author to BibTeX item
+      #
+      def add_author
+        add_author_editor "author"
+      end
+
+      #
+      # Add editor to BibTeX item
+      #
+      def add_editor
+        add_author_editor "editor"
+      end
+
+      #
+      # Add author or editor to BibTeX item
+      #
+      # @param [String] type "author" or "editor"
+      #
+      def add_author_editor(type)
+        contribs = @bib.contributor.select do |c|
+          c.entity.is_a?(Person) && c.role.any? { |e| e.type == type }
+        end.map &:entity
+
+        return unless contribs.any?
+
+        @item.send "#{type}=", concat_names(contribs)
+      end
+
+      #
+      # Concatenate names of contributors
+      #
+      # @param [Array<RelatonBib::Person>] contribs contributors
+      #
+      # @return [String] concatenated names
+      #
+      def concat_names(contribs)
+        contribs.map do |p|
+          if p.name.surname
+            "#{p.name.surname}, #{p.name.forename.map(&:to_s).join(' ')}"
+          else
+            p.name.completename.to_s
+          end
+        end.join(" and ")
+      end
+
+      #
+      # Add series to BibTeX item
+      #
+      def add_series
+        @bib.series.each do |s|
+          case s.type
+          when "journal"
+            @item.journal = s.title.title
+            @item.number = s.number if s.number
+          when nil then @item.series = s.title.title
+          end
+        end
+      end
+
+      #
+      # Add number to BibTeX item
+      #
+      def add_number
+        return unless %w[techreport manual].include? @bib.type
+
+        did = @bib.docidentifier.detect { |i| i.primary == true }
+        did ||= @bib.docidentifier.first
+        @item.number = did.id if did
+      end
+
+      #
+      # Add edition to BibTeX item
+      #
+      def add_edition
+        @item.edition = @bib.edition.content if @bib.edition
+      end
+
+      #
+      # Add contributor to BibTeX item
+      #
+      def add_contributor # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        @bib.contributor.each do |c|
+          rls = c.role.map(&:type)
+          if rls.include?("publisher") then @item.publisher = c.entity.name
+          elsif rls.include?("distributor")
+            case @bib.type
+            when "techreport" then @item.institution = c.entity.name
+            when "inproceedings", "conference", "manual", "proceedings"
+              @item.organization = c.entity.name
+            when "mastersthesis", "phdthesis" then @item.school = c.entity.name
+            end
+          end
+        end
+      end
+
+      #
+      # Add date to BibTeX item
+      #
+      def add_date
+        @bib.date.each do |d|
+          case d.type
+          when "published"
+            @item.year = d.on :year
+            month = d.on :month
+            @item.month = month if month
+          when "accessed" then @item.urldate = d.on.to_s
+          end
+        end
+      end
+
+      #
+      # Add address to BibTeX item
+      #
+      def add_address # rubocop:disable Metrics/AbcSize
+        return unless @bib.place.any?
+
+        reg = @bib.place[0].region[0].name if @bib.place[0].region.any?
+        addr = [@bib.place[0].name, @bib.place[0].city, reg]
+        @item.address = addr.compact.join(", ")
+      end
+
+      #
+      # Add note to BibTeX item
+      #
+      def add_note # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        @bib.biblionote.each do |n|
+          case n.type
+          when "annote" then @item.annote = n.content
+          when "howpublished" then @item.howpublished = n.content
+          when "comment" then @item.comment = n.content
+          when "tableOfContents" then @item.content = n.content
+          when nil then @item.note = n.content
+          end
+        end
+      end
+
+      #
+      # Add relation to BibTeX item
+      #
+      def add_relation
+        rel = @bib.relation.detect { |r| r.type == "partOf" }
+        if rel
+          title_main = rel.bibitem.title.detect { |t| t.type == "main" }
+          @item.booktitle = title_main.title.content
+        end
+      end
+
+      #
+      # Add extent to BibTeX item
+      #
+      def add_extent
+        @bib.extent.each { |e| e.to_bibtex(@item) }
+      end
+
+      #
+      # Add classification to BibTeX item
+      #
+      def add_classification
+        @bib.classification.each do |c|
+          case c.type
+          when "type" then @item["type"] = c.value
+          when "mendeley" then @item["mendeley-tags"] = c.value
+          end
+        end
+      end
+
+      #
+      # Add keywords to BibTeX item
+      #
+      def add_keyword
+        @item.keywords = @bib.keyword.map(&:content).join(", ") if @bib.keyword.any?
+      end
+
+      #
+      # Add docidentifier to BibTeX item
+      #
+      def add_docidentifier
+        @bib.docidentifier.each do |i|
+          case i.type
+          when "isbn" then @item.isbn = i.id
+          when "lccn" then @item.lccn = i.id
+          when "issn" then @item.issn = i.id
+          end
+        end
+      end
+
+      #
+      # Add identifier to BibTeX item
+      #
+      def add_timestamp
+        @item.timestamp = @bib.fetched.to_s if @bib.fetched
+      end
+
+      #
+      # Add link to BibTeX item
+      #
+      def add_link
+        @bib.link.each do |l|
+          case l.type&.downcase
+          when "doi" then @item.doi = l.content
+          when "file" then @item.file2 = l.content
+          when "src" then @item.url = l.content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relaton_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonBib
-  VERSION = "1.14.4".freeze
+  VERSION = "1.14.5".freeze
 end

data/lib/relaton_bib.rb

@@ -11,6 +11,7 @@ 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"
 
 module RelatonBib
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 1.14.4
+  version: 1.14.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-07 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -266,6 +266,7 @@ files:
 - lib/relaton_bib/organization.rb
 - lib/relaton_bib/person.rb
 - lib/relaton_bib/place.rb
+- lib/relaton_bib/renderer/bibtex_builder.rb
 - lib/relaton_bib/series.rb
 - lib/relaton_bib/structured_identifier.rb
 - lib/relaton_bib/technical_committee.rb