uc3-dmp-citation 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f168bafa37250b52f74453f1e9f044fd5ba07eab51632b650207514d7c9decd
-  data.tar.gz: b1f37ab91666d6356f29b6d5da6242947310df4fe5f7e337d75310b6ea78ec7c
+  metadata.gz: f294fbee4a95b3148dab60d1c48b56a67ee71dfdb3d103b11814c68802c1d522
+  data.tar.gz: f61d50ddf7597ba1300b373450d306d7ff982b133197e40e87dddb5c3e1404bf
 SHA512:
-  metadata.gz: d6fbdb819e93454d608a3f281e0be0839e2b7785b8072035b3a36192c5ae2be8fe79a6433174f37bdbaec8f99b836bce0a993d8189e966bd78f40a1a22f174dc
-  data.tar.gz: c56061f1ce9e204c97d05ddd03d385b0dcc4044e4f3bfc26e3f4ed436e26550059e8d44c0ba5b64e14ad941f4ffae74fb61d6bdaab6aaaa35cddbfc3a974b8c2
+  metadata.gz: b395c33034a154b1052aefaf7f02d5fd6fa50e35bdc0dfe143ae1a33c7d5cddd3fdcc5e7964f930441c1354341cf72fb75e92a18db602419ff2e4bea0a7fa431
+  data.tar.gz: 755a385577fd2ef925df4a4671d26e6925751462ec24995726cefe483adfe512f5c048c48f8419af4d6c9af595664f46a60ae54ac15704fe5d950345e36d761f

data/lib/uc3-dmp-citation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uc3DmpCitation
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/uc3-dmp-citation.rb

@@ -20,84 +20,86 @@ module Uc3DmpCitation
     MSG_BIBTEX_FAILURE = 'Unable to fetch Bibtex for the specified DOI.'
     MSG_UNABLE_TO_UPDATE = 'Unable to update the citations on the DMP ID.'
 
-    def fetch_citation(doi:, logger: nil)
-      uri = _doi_to_uri(doi: doi)
-      return nil if uri.nil? || uri.blank?
-
-      logger.debug(message: "Fetching BibTeX from: #{uri}") if logger.respond_to?(:debug)
-      resp = Uc3DmpExternalApi::Client.call(url: uri, method: :get, additional_headers: headers, logger: logger)
-      return nil if resp.nil? || resp.to_s.strip.empty?
-
-      bibtex = BibTeX.parse(_cleanse_bibtex(text: resp))
-      work_type = identifier['work_type'].nil? ? determine_work_type(bibtex: bibtex) :  identifier['work_type']
-      _bibtex_to_citation(uri: uri, work_type: work_type, bibtex: bibtex)
-    end
+    class << self
+      def fetch_citation(doi:, logger: nil)
+        uri = _doi_to_uri(doi: doi)
+        return nil if uri.nil? || uri.blank?
+
+        logger.debug(message: "Fetching BibTeX from: #{uri}") if logger.respond_to?(:debug)
+        resp = Uc3DmpExternalApi::Client.call(url: uri, method: :get, additional_headers: headers, logger: logger)
+        return nil if resp.nil? || resp.to_s.strip.empty?
+
+        bibtex = BibTeX.parse(_cleanse_bibtex(text: resp))
+        work_type = identifier['work_type'].nil? ? determine_work_type(bibtex: bibtex) :  identifier['work_type']
+        _bibtex_to_citation(uri: uri, work_type: work_type, bibtex: bibtex)
+      end
 
-    private
+      private
 
-    # Will convert 'doi:10.1234/abcdefg' to 'http://doi.org/10.1234/abcdefg'
-    def _doi_to_uri(doi:)
-      val = doi.match(DOI_REGEX).to_s
-      return nil if val.nil? || val.strip == ''
+      # Will convert 'doi:10.1234/abcdefg' to 'http://doi.org/10.1234/abcdefg'
+      def _doi_to_uri(doi:)
+        val = doi.match(DOI_REGEX).to_s
+        return nil if val.nil? || val.strip == ''
 
-      doi.start_with?('http') ? doi : "#{DEFAULT_DOI_URL}/#{doi.gsub('doi:', '')}"
-    end
+        doi.start_with?('http') ? doi : "#{DEFAULT_DOI_URL}/#{doi.gsub('doi:', '')}"
+      end
 
-    # If no :work_type was specified we can try to derive it from the BibTeX metadata
-    def _determine_work_type(bibtex:)
-      return '' if bibtex.nil? || bibtex.data.nil? || bibtex.data.first.nil?
+      # If no :work_type was specified we can try to derive it from the BibTeX metadata
+      def _determine_work_type(bibtex:)
+        return '' if bibtex.nil? || bibtex.data.nil? || bibtex.data.first.nil?
 
-      return 'article' unless bibtex.data.first.journal.nil?
+        return 'article' unless bibtex.data.first.journal.nil?
 
-      ''
-    end
+        ''
+      end
 
-    def _cleanse_bibtex(text:)
-      return nil if text.nil? || text.to_s.strip == ''
-
-      # Make sure we're working with UTF8
-      utf8 = text.force_encoding('UTF-8')
-
-      # Remove any encoded HTML (e.g. "Regular text $\\lt$strong$\\gt$Bold text$\\lt$/strong$\\gt$")
-      utf8 = utf8.gsub(%r{\$?\\\$?(less|lt|Lt)\$/?[a-zA-Z]+\$?\\\$?(greater|gt|Gt)\$}, '')
-      # Replace any special dash, semicolon and quote characters with a minus sign or single/double quote
-      utf8 = utf8.gsub(%r{\$?\\(T|t)ext[a-zA-Z]+dash\$?}, '-').gsub(%r{\{(T|t)ext[a-zA-Z]+dash\}}, '-')
-                 .gsub(%r{\$?\\(M|m)athsemicolon\$?}, ':').gsub(%r{\{(M|m)semicolon\}}, ':')
-                 .gsub(%r{\$?\\(T|t)extquotesingle\$?}, "'").gsub(%r{\{(T|t)extquotesingle\}}, "'")
-                 .gsub(%r{\$?\\(T|t)extquotedouble\$?}, '"').gsub(%r{\{(T|t)extquotedouble\}}, '"')
-      # Remove any remaining `\v` entries which attempt to construct an accented character
-      utf8.gsub(%r{\\v}, '')
-    end
+      def _cleanse_bibtex(text:)
+        return nil if text.nil? || text.to_s.strip == ''
+
+        # Make sure we're working with UTF8
+        utf8 = text.force_encoding('UTF-8')
+
+        # Remove any encoded HTML (e.g. "Regular text $\\lt$strong$\\gt$Bold text$\\lt$/strong$\\gt$")
+        utf8 = utf8.gsub(%r{\$?\\\$?(less|lt|Lt)\$/?[a-zA-Z]+\$?\\\$?(greater|gt|Gt)\$}, '')
+        # Replace any special dash, semicolon and quote characters with a minus sign or single/double quote
+        utf8 = utf8.gsub(%r{\$?\\(T|t)ext[a-zA-Z]+dash\$?}, '-').gsub(%r{\{(T|t)ext[a-zA-Z]+dash\}}, '-')
+                  .gsub(%r{\$?\\(M|m)athsemicolon\$?}, ':').gsub(%r{\{(M|m)semicolon\}}, ':')
+                  .gsub(%r{\$?\\(T|t)extquotesingle\$?}, "'").gsub(%r{\{(T|t)extquotesingle\}}, "'")
+                  .gsub(%r{\$?\\(T|t)extquotedouble\$?}, '"').gsub(%r{\{(T|t)extquotedouble\}}, '"')
+        # Remove any remaining `\v` entries which attempt to construct an accented character
+        utf8.gsub(%r{\\v}, '')
+      end
 
-    # Convert the BibTeX item to a citation
-    def _bibtex_to_citation(uri:, work_type: DEFAULT_WORK_TYPE, bibtex:, style: DEFAULT_CITATION_STYLE)
-      return nil unless uri.is_a?(String) && uri.strip != ''
-      return nil if bibtex.nil? || bibtex.data.nil? || bibtex.data.first.nil?
+      # Convert the BibTeX item to a citation
+      def _bibtex_to_citation(uri:, work_type: DEFAULT_WORK_TYPE, bibtex:, style: DEFAULT_CITATION_STYLE)
+        return nil unless uri.is_a?(String) && uri.strip != ''
+        return nil if bibtex.nil? || bibtex.data.nil? || bibtex.data.first.nil?
 
-      cp = CiteProc::Processor.new(style: style, format: 'html')
-      cp.import(bibtex.to_citeproc)
-      citation = cp.render(:bibliography, id: bibtex.data.first.id)
-      return nil unless citation.is_a?(Array) && citation.any?
+        cp = CiteProc::Processor.new(style: style, format: 'html')
+        cp.import(bibtex.to_citeproc)
+        citation = cp.render(:bibliography, id: bibtex.data.first.id)
+        return nil unless citation.is_a?(Array) && citation.any?
 
-      # The CiteProc renderer has trouble with some things so fix them here
-      #   - For some reason words in all caps in the title get wrapped in curl brackets
-      citation = citation.first.gsub('{', '').gsub('}', '')
+        # The CiteProc renderer has trouble with some things so fix them here
+        #   - For some reason words in all caps in the title get wrapped in curl brackets
+        citation = citation.first.gsub('{', '').gsub('}', '')
 
-      unless work_type.nil? || work_type.strip == ''
-        # This supports the :apa and :chicago-author-date styles
-        citation = citation.gsub(/\.”\s+/, "\.” [#{work_type.gsub('_', ' ').capitalize}]. ")
-                           .gsub(/<\/i>\.\s+/, "<\/i>\. [#{work_type.gsub('_', ' ').capitalize}]. ")
-      end
+        unless work_type.nil? || work_type.strip == ''
+          # This supports the :apa and :chicago-author-date styles
+          citation = citation.gsub(/\.”\s+/, "\.” [#{work_type.gsub('_', ' ').capitalize}]. ")
+                            .gsub(/<\/i>\.\s+/, "<\/i>\. [#{work_type.gsub('_', ' ').capitalize}]. ")
+        end
 
-      # Convert the URL into a link. Ensure that the trailing period is not a part of
-      # the link!
-      citation.gsub(URI.regexp) do |url|
-        if url.start_with?('http')
-          '<a href="%{url}" target="_blank">%{url}</a>.' % {
-            url: url.end_with?('.') ? uri : "#{uri}."
-          }
-        else
-          url
+        # Convert the URL into a link. Ensure that the trailing period is not a part of
+        # the link!
+        citation.gsub(URI.regexp) do |url|
+          if url.start_with?('http')
+            '<a href="%{url}" target="_blank">%{url}</a>.' % {
+              url: url.end_with?('.') ? uri : "#{uri}."
+            }
+          else
+            url
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uc3-dmp-citation
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Brian Riley