Add chicago citation option (#1293)

* Add chicago citation option

* Refine chicago citation implementation

* Update citation_string_processor.rb

.rubocop.yml

@@ -19,6 +19,8 @@ Metrics/AbcSize:
         - 'app/models/concerns/blacklight/solr/document/marc_export.rb'
         - 'app/services/oai_processing_service.rb'
         - 'app/services/oai_processing_single_service.rb'
+        - 'lib/citation_formatter.rb'
+        - 'app/helpers/citation_modal_helper.rb'
 
 Metrics/BlockLength:
     Exclude:
@@ -48,8 +50,10 @@ Metrics/MethodLength:
         - 'app/models/concerns/blacklight/solr/document/marc_export.rb'
         - 'app/services/oai_processing_service.rb'
         - 'app/services/oai_processing_single_service.rb'
+        - 'app/helpers/citation_modal_helper.rb'
         - 'lib/traject/extract_publication_date.rb'
         - 'lib/traject/extract_url_fulltext.rb'
+        - 'lib/citation_formatter.rb'
         - 'app/controllers/sessions/social_login.rb'
         - 'config/initializers/bookmarks_index_override.rb'
         - 'config/initializers/catalog_index_override.rb'

Gemfile

@@ -17,7 +17,9 @@ gem 'blacklight_range_limit'
 gem 'bootstrap', '~> 4.0'
 gem 'bootstrap-select-rails', '>= 1.13'
 gem 'cancancan'
+gem 'citeproc-ruby'
 gem 'coffee-rails', '~> 4.2'
+gem 'csl-styles'
 gem 'devise'
 gem 'devise-guests', '~> 0.6'
 gem 'dotenv-rails'

Gemfile.lock

@@ -138,6 +138,11 @@ GEM
       xpath (~> 3.2)
     childprocess (3.0.0)
     chronic (0.10.2)
+    citeproc (1.0.10)
+      namae (~> 1.0)
+    citeproc-ruby (2.0.0)
+      citeproc (~> 1.0, >= 1.0.9)
+      csl (~> 2.0)
     coderay (1.1.3)
     coffee-rails (4.2.2)
       coffee-script (>= 2.2.0)
@@ -156,6 +161,11 @@ GEM
       tins (~> 1.6)
     crack (0.4.4)
     crass (1.0.6)
+    csl (2.0.0)
+      namae (~> 1.0)
+      rexml
+    csl-styles (2.0.1)
+      csl (~> 2.0)
     datetime_picker_rails (0.0.7)
       momentjs-rails (>= 2.8.1)
     deprecation (1.0.0)
@@ -271,6 +281,7 @@ GEM
       railties (>= 3.1)
     multipart-post (2.1.1)
     mysql2 (0.5.3)
+    namae (1.1.1)
     net-scp (3.0.0)
       net-ssh (>= 2.6.5, < 7.0.0)
     net-ssh (6.1.0)
@@ -550,8 +561,10 @@ DEPENDENCIES
   capistrano-rails (~> 1.6)
   capistrano-yarn
   capybara (>= 2.15)
+  citeproc-ruby
   coffee-rails (~> 4.2)
   coveralls
+  csl-styles
   devise
   devise-guests (~> 0.6)
   dotenv-rails

app/helpers/citation_modal_helper.rb

@@ -13,13 +13,18 @@ def process_mult_documents_citations(documents)
     apa_cit_arr = documents.inject([]) do |arr, doc|
       arr << tag.p(doc.send(:export_as_apa_citation_txt).html_safe, class: 'citation-text')
     end
+    chicago_cit_arr = documents.inject([]) do |arr, doc|
+      arr << tag.p(doc.send(:export_as_chicago_citation_txt).html_safe, class: 'citation-text')
+    end
 
     safe_join(
       [
         tag.h2(t('blacklight.citation.mla'), class: 'citation-header'),
         mla_cit_arr,
         tag.h2(t('blacklight.citation.apa'), class: 'citation-header'),
-        apa_cit_arr
+        apa_cit_arr,
+        tag.h2(t('blacklight.citation.chicago'), class: 'citation-header'),
+        chicago_cit_arr
       ].flatten, ''
     )
   end
@@ -30,12 +35,14 @@ def process_single_document_citations(documents)
         tag.h2(t('blacklight.citation.mla'), class: 'citation-header'),
         tag.p(documents.first.send(:export_as_mla_citation_txt).html_safe, class: 'citation-text'),
         tag.h2(t('blacklight.citation.apa'), class: 'citation-header'),
-        tag.p(documents.first.send(:export_as_apa_citation_txt).html_safe, class: 'citation-text')
+        tag.p(documents.first.send(:export_as_apa_citation_txt).html_safe, class: 'citation-text'),
+        tag.h2(t('blacklight.citation.chicago'), class: 'citation-header'),
+        tag.p(documents.first.send(:export_as_chicago_citation_txt).html_safe, class: 'citation-text')
       ].flatten, ''
     )
   end
 
   def cit_method_respond_test(documents)
-    documents.all? { |d| d.respond_to?(:export_as_mla_citation_txt) && d.respond_to?(:export_as_apa_citation_txt) }
+    documents.all? { |d| d.respond_to?(:export_as_mla_citation_txt) && d.respond_to?(:export_as_apa_citation_txt) && d.respond_to?(:export_as_chicago_citation_txt) }
   end
 end

app/models/concerns/blacklight/solr/document/marc_export.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'openurl'
+require './lib/citation_formatter'
 
 # Overwrites the apa_citation and mla_citation methods from module of same name
 #   v7.0.0, as well as adds new methods to assist the new logic.
@@ -40,7 +41,12 @@ def export_as_mla_citation_txt
   end
 
   def export_as_chicago_citation_txt
-    chicago_citation(to_marc)
+    generator = CitationFormatter.new(self)
+    begin
+      generator.citation_for('chicago-fullnote-bibliography')
+    rescue
+      chicago_citation(to_marc)
+    end
   end
 
   # Exports as an OpenURL KEV (key-encoded value) query string.

config/locales/blacklight.en.yml

@@ -17,6 +17,7 @@ en:
     citation:
       mla: 'MLA (8th Edition)'
       apa: 'APA (7th Edition)'
+      chicago: 'Chicago (17th Edition)'
     footer:
       links:
         about_library_search: 'About Library Search'

lib/citation_formatter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require 'citeproc'
+require 'csl/styles'
+require './lib/citation_string_processor'
+
+class CitationFormatter
+  include CitationStringProcessor
+  attr_accessor :obj, :default_citations
+
+  def initialize(obj)
+    @obj = obj
+  end
+
+  def citation_for(style)
+    CiteProc::Processor.new(style: style, format: 'html').import(item).render(:bibliography, id: :item).first
+  end
+
+  private
+
+  def item
+    CiteProc::Item.new({
+                         "id": :item,
+                         "author": chicago_author(obj),
+                         "issued": obj[:pub_date_isim].first,
+                         "publisher": chicago_publisher(obj),
+                         "publisher-place": obj[:publisher_location_ssim]&.join(', '),
+                         "title": obj[:title_citation_ssi],
+                         "type": obj[:format_ssim]&.first&.downcase,
+                         "DOI": chicago_doi(obj)
+                       })
+  end
+end

lib/citation_string_processor.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CitationStringProcessor
+  # Chicago Citation
+  def chicago_author(obj)
+    clean_end_punctuation(obj[:author_tesim]&.join(', '))
+  end
+
+  def chicago_publisher(obj)
+    publisher = obj[:published_tesim]&.first&.strip
+    return nil if publisher.blank?
+
+    publisher = publisher.gsub(/\[|\]/, '')
+    clean_end_punctuation(publisher) if publisher.present?
+  end
+
+  def chicago_doi(obj)
+    doi = obj['other_standard_ids_tesim']&.first&.strip
+    clean_end_punctuation(doi) if doi.present?
+  end
+
+  # Helper Methods
+  def clean_end_punctuation(text)
+    [".", ",", ":", ";", "/"].include?(text[-1]) ? text[0...-1] : text
+  end
+end