uc3-dmp-citation 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33d3c1379d1dcfe500b123f98bc555913c3f72d76cad5df9d5bd8f6f03a39852
-  data.tar.gz: 39b8ac0b6b989c40f52bda21d14e6db32c7b11b6610f8e8a66c33ec48632749c
+  metadata.gz: 7c2817afd07293e08976bd32fad38b356079ef155ae14f4ebd7fba69110de83a
+  data.tar.gz: 6b985ed4cdf93d42d5ef1a6304c71c3094077ad4398bab1b853ef62ba07d4d99
 SHA512:
-  metadata.gz: 0f9625b4776712fe7090e0e3d98f274e1289a9322f8ca18a736f220038894ee5846f60fff6cca66c9eca2f715df9bc6ea6c9a1baf24d719d0534586ae03a43b1
-  data.tar.gz: 95f3b54d33d563547a49a4a0fb084112ce4122b5e34cd48aeac60dc82d57de79e8ff8380c5e7c04a81b9063a303cb261c5cb4f0334f3cd0ed69b15f16bcebf42
+  metadata.gz: aa6b47581cc57faa4bf79f9e079cf57e24054a58ba324ebff96b19c06d8625b593adbfd60337ed732d162c990ceb7fe581d6953f60d01a897c30c123ee1e7097
+  data.tar.gz: bd438167069b0f3ce62fc983c26d6ee9207b71a662b06a12ec0c301d49c5a21de87729094d869eb09f83bc689aa7c87ec0f10e2d420268ce365b0bf510287590

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

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

data/lib/uc3-dmp-citation.rb

@@ -10,6 +10,7 @@ require 'uc3-dmp-external-api'
 module Uc3DmpCitation
   class CiterError < StandardError; end
 
+  # Clas that fetches Citations for a given DOI
   class Citer
     DEFAULT_CITATION_STYLE = 'chicago-author-date'
     DEFAULT_DOI_URL = 'http://doi.org'
@@ -21,20 +22,22 @@ module Uc3DmpCitation
     MSG_UNABLE_TO_UPDATE = 'Unable to update the citations on the DMP ID.'
 
     class << self
+      # rubocop:disable Metrics/AbcSize
       def fetch_citation(doi:, work_type: DEFAULT_WORK_TYPE, style: DEFAULT_CITATION_STYLE, logger: nil)
-        uri = _doi_to_uri(doi: doi)
+        uri = _doi_to_uri(doi:)
         return nil if uri.nil? || uri.blank?
 
         headers = { Accept: 'application/x-bibtex' }
         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)
+        resp = Uc3DmpExternalApi::Client.call(url: uri, method: :get, additional_headers: headers, logger:)
         return nil if resp.nil? || resp.to_s.strip.empty?
 
         bibtex = BibTeX.parse(_cleanse_bibtex(text: resp))
-        work_type = work_type.nil? ? determine_work_type(bibtex: bibtex) :  work_type
-        style = style.nil? ? DEFAULT_CITATION_STYLE : style
-        _bibtex_to_citation(uri: uri, work_type: work_type, style: style, bibtex: bibtex)
+        work_type = work_type.nil? ? determine_work_type(bibtex:) : work_type
+        style = DEFAULT_CITATION_STYLE if style.nil?
+        _bibtex_to_citation(uri:, work_type:, style:, bibtex:)
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 
@@ -64,20 +67,21 @@ module Uc3DmpCitation
         # 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\}}, '"')
+        utf8 = utf8.gsub(/\$?\\(T|t)ext[a-zA-Z]+dash\$?/, '-').gsub(/\{(T|t)ext[a-zA-Z]+dash\}/, '-')
+                   .gsub(/\$?\\(M|m)athsemicolon\$?/, ':').gsub(/\{(M|m)semicolon\}/, ':')
+                   .gsub(/\$?\\(T|t)extquotesingle\$?/, "'").gsub(/\{(T|t)extquotesingle\}/, "'")
+                   .gsub(/\$?\\(T|t)extquotedouble\$?/, '"').gsub(/\{(T|t)extquotedouble\}/, '"')
         # Remove any remaining `\v` entries which attempt to construct an accented character
-        utf8.gsub(%r{\\v}, '')
+        utf8.gsub(/\\v/, '')
       end
 
       # Convert the BibTeX item to a citation
-      def _bibtex_to_citation(uri:, work_type: DEFAULT_WORK_TYPE, bibtex:, style: DEFAULT_CITATION_STYLE)
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def _bibtex_to_citation(uri:, bibtex:, work_type: DEFAULT_WORK_TYPE, 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 = CiteProc::Processor.new(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?
@@ -88,22 +92,21 @@ module Uc3DmpCitation
 
         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}]. ")
+          citation = citation.gsub(/\.”\s+/, ".” [#{work_type.gsub('_', ' ').capitalize}]. ")
+                             .gsub(%r{</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|
+        citation.gsub(URI::DEFAULT_PARSER.make_regexp) do |url|
           if url.start_with?('http')
-            '<a href="%{url}" target="_blank">%{url}</a>.' % {
-              url: url.end_with?('.') ? uri : "#{uri}."
-            }
+            format('<a href="%{url}" target="_blank">%{url}</a>.', url: url.end_with?('.') ? uri : "#{uri}.")
           else
             url
           end
         end
       end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uc3-dmp-citation
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Brian Riley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-18 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -81,7 +81,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'false'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,15 +89,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: DMPTool gem that provides support for fetching BibTex for a DOI and converting
   it into a citation