blacklight-marc 6.3.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5b4577a4b98e98e1980bd542b762839999648a3bb630f74c91c0601d942930
-  data.tar.gz: 6bfcd917cafe69f71d2585426e2dfff361321c87d832ac046a649a45e5800e7d
+  metadata.gz: 67e4c2b3e51422a3801fda3a61fe549e73889f43cdee3571c35368f44f10490e
+  data.tar.gz: dec3a61d6f54c91811d37afa6d9a4462255c224c33d1f7a0448d1de3028161ff
 SHA512:
-  metadata.gz: f43a53f1aeea6010586d31d3a11412cbcbd66e6f209734fde7501cfca444c894154b9d226d276331d7f8d91c06b9a49253bc35a7f118b25d79d869161114241f
-  data.tar.gz: 63794ad1115771f67c7e4d736e7e5991987add27ddaa59c250afe2352a64259a4132a374f2acbed700d6439daf6db826b9872d0e91dd61fd5ef268af4aa641a1
+  metadata.gz: 57f8a9949505a58970bae0a8aaf9f25a0d46c1d7d80272cf19c8a5ff43aa2833c3676e9f5246dd88c8954d33d6699601ddf463429ae30cb916a762616b7014eb
+  data.tar.gz: 959d4dae4de2e8f5378cd7379b3863a1ca70408f9d6e0ba95bed151651ec6bc5b4f052167782caf53f3d1c351e6747f68be5841825888a4be724ee3c02ad1330

data/.github/workflows/ruby.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        rails_version: [6.1.1]
+        ruby: [2.7, 3.0]
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies with Rails ${{ matrix.rails_version }}
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake
+  test_rails52:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        rails_version: [5.2.4.4, 6.0.3.4]
+        ruby: [2.7]
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies with Rails ${{ matrix.rails_version }}
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile

@@ -1,5 +1,10 @@
 source 'https://rubygems.org'
 
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
 # Please see blacklight_marc.gemspec for dependency information.
 gemspec path: File.expand_path('..', __FILE__)
 
@@ -28,6 +33,11 @@ else
   end
 
   case ENV['RAILS_VERSION']
+  when /^6.0/
+    gem 'sass-rails', '>= 6'
+    gem 'webpacker', '~> 4.0'
+  when /^5.[12]/
+    gem 'sass-rails', '~> 5.0'
   when /^4.2/
     gem 'responders', '~> 2.0'
     gem 'sass-rails', '>= 5.0'
@@ -37,3 +47,5 @@ else
   end
 end
 # END ENGINE_CART BLOCK
+
+eval_gemfile File.expand_path("spec/test_app_templates/Gemfile.extra", File.dirname(__FILE__))

data/README.md

@@ -1,9 +1,15 @@
-[![Build Status](https://travis-ci.org/projectblacklight/blacklight_marc.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight_marc)
+[![Build Status](https://travis-ci.org/projectblacklight/blacklight-marc.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight-marc)
 
 # Blacklight::Marc
 
 MARC-specific enhancements for [Blacklight](https://github.com/projectblacklight/blacklight)
 
+## Features
+* Rake task `solr:marc:index` to import .mrc files using Traject and app/models/marc_indexer
+* "Librarian View" at `catalog/:id/librarian_view`
+* Export records to refworks and endnote
+* Blacklight::Solr::Document mixins for exporting and transforming MARC data from a stored Solr field
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,6 +24,27 @@ After running the blacklight generator, run the blacklight_marc generator:
 
     $ rails generate blacklight:marc:install
 
+
+## How does it work?
+This generator injects an include into CatalogController (parent class of BookmarksController):
+
+```ruby
+include Blacklight::Marc::Catalog
+```
+
+and the following code is generated into SolrDocument:
+
+```ruby
+use_extension( Blacklight::Solr::Document::Marc) do |document|
+  document.key?( :marc_display  )
+end
+```
+
+This means, the extension will be applied on the instance if the backing hash
+has a field called `marc_display`.
+
+
+## Indexing
 The generator will create a model called MarcIndexer. This model can be customized by modifying
 the field configurations in its initializer as a Traject 2 indexer; new indexing behaviors can
 be added to it via mixins or inline methods. Two example mixins are provided:
@@ -35,12 +62,6 @@ MarcIndexer
   end
 end
 ```
-## Features
-* Rake task `solr:marc:index` to import .mrc files using Traject and app/models/marc_indexer
-* Librarian view at `catalog/:id/librarian_view`
-* Export records to refworks and endnote
-* Blacklight::Solr::Document mixins for exporting and transforming MARC data from a stored Solr field
-
 
 ## Documentation, Information and Support
 

data/app/assets/stylesheets/blacklight_marc.scss

@@ -12,6 +12,9 @@ $marc_item_separator: 1px solid $text-muted !default;
 #marc_view
 {
 	text-align:left;
+	/* https://meyerweb.com/eric/thoughts/2010/02/12/fixed-monospace-sizing/ */
+	font-family: "Courier New", monospace, serif;
+	font-size: 1em;
 
   .field
   {
@@ -22,7 +25,7 @@ $marc_item_separator: 1px solid $text-muted !default;
   .ind1, .ind2
   {
     display:inline;
-    padding:0 $padding-xs-horizontal;
+    padding: 0 ($spacer / 2);
   }
 
   .subfields
@@ -35,8 +38,3 @@ $marc_item_separator: 1px solid $text-muted !default;
     float:left;
   }
 }
-
-/* refworks uses a form; we need to give it some additional padding to make it look like a link */
-#refworks-form .btn {
-  padding: $nav-link-padding;
-}

data/app/helpers/blacklight_marc_helper.rb

@@ -1,18 +1,18 @@
 module BlacklightMarcHelper
 
   # This method should move to BlacklightMarc in Blacklight 6.x
-  def refworks_export_url params = {}
+  def refworks_export_url params = {}, *_
     "http://www.refworks.com/express/expressimport.asp?vendor=#{CGI.escape(params[:vendor] || application_name)}&filter=#{CGI.escape(params[:filter] || "MARC Format")}&encoding=65001" + (("&url=#{CGI.escape(params[:url])}" if params[:url]) || "")
   end
 
-  def refworks_solr_document_path opts = {}
+  def refworks_solr_document_path opts = {}, *_
     if opts[:id]
       refworks_export_url(url: solr_document_url(opts[:id], format: :refworks_marc_txt))
     end
   end
 
   # For exporting a single endnote document. (endnote_catalog_path is defined by blacklight-marc and it is used for multiple document export)
-  def single_endnote_catalog_path opts = {}
+  def single_endnote_catalog_path opts = {}, *_
     solr_document_path(opts.merge(format: 'endnote'))
   end
 
@@ -33,7 +33,8 @@ module BlacklightMarcHelper
     val = ''
     documents.each do |doc|
       if doc.exports_as? :endnote
-        val += doc.export_as(:endnote) + "\n"
+        endnote = doc.export_as(:endnote)
+        val += "#{endnote}\n" if endnote
       end
     end
     val

data/app/models/concerns/blacklight/solr/document/marc.rb

@@ -6,7 +6,7 @@
 # then provides various transformations/exports of that Marc via the included
 # Blacklight::Solr::Document::MarcExport module.
 #
-# This extension would normally be registered using 
+# This extension would normally be registered using
 # Blacklight::Solr::Document#use_extension.  eg:
 #
 # SolrDocument.use_extension( Blacklight::Solr::Document::Marc ) { |document| my_logic_for_document_has_marc?( document ) }
@@ -20,15 +20,15 @@ require 'marc'
 
 module Blacklight::Solr::Document::Marc
 
-  include Blacklight::Solr::Document::MarcExport # All our export_as stuff based on to_marc. 
-  
+  include Blacklight::Solr::Document::MarcExport # All our export_as stuff based on to_marc.
+
   class UnsupportedMarcFormatType < RuntimeError; end
-    
+
   def self.extended(document)
-    # Register our exportable formats, we inherit these from MarcExport    
+    # Register our exportable formats, we inherit these from MarcExport
     Blacklight::Solr::Document::MarcExport.register_export_formats( document )
   end
-  
+
   # ruby-marc object
   def to_marc
     @_ruby_marc_obj ||= load_marc
@@ -50,29 +50,30 @@ module Blacklight::Solr::Document::Marc
       return MARC::Record.new_from_hash( JSON.parse( fetch(_marc_source_field) ) )
     else
       raise UnsupportedMarcFormatType.new("Only marcxml, marc21, and json are supported, this documents format is #{_marc_format_type} and the current extension parameters are #{self.class.extension_parameters.inspect}")
-    end      
+    end
   rescue Exception => e
     raise e if e.is_a? UnsupportedMarcFormatType
 
     Rails.logger.error("Blacklight failed to parse MARC record. Exception was: #{e}")
+    nil
   end
-  
+
   def marc_record_from_marcxml
     MARC::XMLReader.new(StringIO.new( fetch(_marc_source_field) )).to_a.first
   end
-  
+
   def _marc_helper
     @_marc_helper ||= (
       Blacklight::Marc::Document.new fetch(_marc_source_field), _marc_format_type )
   end
 
-  def _marc_source_field    
+  def _marc_source_field
     self.class.extension_parameters[:marc_source_field]
   end
 
   def _marc_format_type
         #TODO: Raise if not present
-    self.class.extension_parameters[:marc_format_type]    
+    self.class.extension_parameters[:marc_format_type]
   end
-  
+
 end

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

@@ -4,13 +4,13 @@
 # it for your own custom Blacklight document Marc extension too -- just
 # include this module in any document extension (or any other class)
 # that provides a #to_marc returning a ruby-marc object.  This module will add
-# in export_as translation methods for a variety of formats. 
+# in export_as translation methods for a variety of formats.
 module Blacklight::Solr::Document::MarcExport
-  
+
   def self.register_export_formats(document)
     document.will_export_as(:xml)
     document.will_export_as(:marc, "application/marc")
-    # marcxml content type: 
+    # marcxml content type:
     # http://tools.ietf.org/html/draft-denenberg-mods-etc-media-types-00
     document.will_export_as(:marcxml, "application/marcxml+xml")
     document.will_export_as(:openurl_ctx_kev, "application/x-openurl-ctx-kev")
@@ -27,20 +27,20 @@ module Blacklight::Solr::Document::MarcExport
     to_marc.to_xml.to_s
   end
   alias_method :export_as_xml, :export_as_marcxml
-  
-  
+
+
   # TODO This exporting as formatted citation thing should be re-thought
   # redesigned at some point to be more general purpose, but this
   # is in-line with what we had before, but at least now attached
-  # to the document extension where it belongs. 
+  # to the document extension where it belongs.
   def export_as_apa_citation_txt
     apa_citation( to_marc )
   end
-  
+
   def export_as_mla_citation_txt
     mla_citation( to_marc )
   end
-  
+
   def export_as_chicago_citation_txt
     chicago_citation( to_marc )
   end
@@ -52,8 +52,8 @@ module Blacklight::Solr::Document::MarcExport
   # more sensibly. The "format" argument was in the old marc.marc.to_zotero
   # call, but didn't neccesarily do what it thought it did anyway. Left in
   # for now for backwards compatibilty, but should be replaced by
-  # just ruby OpenURL. 
-  def export_as_openurl_ctx_kev(format = nil)  
+  # just ruby OpenURL.
+  def export_as_openurl_ctx_kev(format = nil)
     title = to_marc.find{|field| field.tag == '245'}
     author = to_marc.find{|field| field.tag == '100'}
     corp_author = to_marc.find{|field| field.tag == '110'}
@@ -100,11 +100,13 @@ module Blacklight::Solr::Document::MarcExport
 
   # This format used to be called 'refworks', which wasn't really
   # accurate, sounds more like 'refworks tagged format'. Which this
-  # is not, it's instead some weird under-documented Refworks 
+  # is not, it's instead some weird under-documented Refworks
   # proprietary marc-ish in text/plain format. See
-  # http://robotlibrarian.billdueber.com/sending-marcish-data-to-refworks/
+  # http://robotlibrarian.billdueber.com/2009/05/sending-marcish-data-to-refworks/
   def export_as_refworks_marc_txt
-    fields = to_marc.find_all { |f| ('000'..'999') === f.tag }
+    marc_obj = to_marc
+    return unless marc_obj
+    fields = marc_obj.find_all { |f| ('000'..'999') === f.tag }
     text = "LEADER #{to_marc.leader}"
     fields.each do |field|
     unless ["940","999"].include?(field.tag)
@@ -124,10 +126,8 @@ module Blacklight::Solr::Document::MarcExport
     # As of 11 May 2010, Refworks has a problem with UTF-8 if it's decomposed,
     # it seems to want C form normalization, although RefWorks support
     # couldn't tell me that. -jrochkind
-    text = ActiveSupport::Multibyte::Unicode.normalize(text, :c)
-    
-    return text
-  end 
+    text.unicode_normalize(:nfc)
+  end
 
   # Endnote Import Format. See the EndNote User Guide at:
   # http://www.endnote.com/support/enx3man-terms-win.asp
@@ -138,7 +138,7 @@ module Blacklight::Solr::Document::MarcExport
   # endnote import format; the %0 is likely to be entirely illegal, the
   # rest of the data is barely correct but messy. TODO, a new version of this,
   # or better yet just an export_as_ris instead, which will be more general
-  # purpose. 
+  # purpose.
   def export_as_endnote()
     end_note_format = {
       "%A" => "100.a",
@@ -154,10 +154,12 @@ module Blacklight::Solr::Document::MarcExport
       "%7" => "250.a"
     }
     marc_obj = to_marc
+    return unless marc_obj
+
     # TODO. This should be rewritten to guess
     # from actual Marc instead, probably.
     format_str = 'Generic'
-    
+
     text = ''
     text << "%0 #{ format_str }\n"
     # If there is some reliable way of getting the language of a record we can add it here
@@ -170,7 +172,7 @@ module Blacklight::Solr::Document::MarcExport
       else
         second_value = []
       end
-      
+
       if marc_obj[first_value[0].to_s]
         marc_obj.find_all{|f| (first_value[0].to_s) === f.tag}.each do |field|
           if field[first_value[1]].to_s or field[second_value[1]].to_s
@@ -190,11 +192,11 @@ module Blacklight::Solr::Document::MarcExport
   end
 
   protected
-  
+
   # Main method for defining chicago style citation.  If we don't end up converting to using a citation formatting service
   # we should make this receive a semantic document and not MARC so we can use this with other formats.
   def chicago_citation(marc)
-    authors = get_all_authors(marc)    
+    authors = get_all_authors(marc)
     author_text = ""
     unless authors[:primary_authors].blank?
       if authors[:primary_authors].length > 10
@@ -226,7 +228,7 @@ module Blacklight::Solr::Document::MarcExport
             author_text << "and #{name_reverse(author)}."
           else
             author_text << "#{name_reverse(author)}, "
-          end 
+          end
         end
       else
         author_text << authors[:primary_authors].first
@@ -242,7 +244,7 @@ module Blacklight::Solr::Document::MarcExport
       authors[:compilers].each do |compiler|
         temp_authors << [compiler, "comp."]
       end
-      
+
       unless temp_authors.blank?
         if temp_authors.length > 10
           temp_authors.each_with_index do |author,index|
@@ -281,18 +283,18 @@ module Blacklight::Solr::Document::MarcExport
         section_title << "."
       end
     end
-    
+
     if !authors[:primary_authors].blank? and (!authors[:translators].blank? or !authors[:editors].blank? or !authors[:compilers].blank?)
         additional_title << "Translated by #{authors[:translators].collect{|name| name_reverse(name)}.join(" and ")}. " unless authors[:translators].blank?
         additional_title << "Edited by #{authors[:editors].collect{|name| name_reverse(name)}.join(" and ")}. " unless authors[:editors].blank?
         additional_title << "Compiled by #{authors[:compilers].collect{|name| name_reverse(name)}.join(" and ")}. " unless authors[:compilers].blank?
     end
-    
+
     edition = ""
     edition << setup_edition(marc) unless setup_edition(marc).nil?
-    
+
     pub_info = ""
-    if marc["260"] and (marc["260"]["a"] or marc["260"]["b"]) 
+    if marc["260"] and (marc["260"]["a"] or marc["260"]["b"])
       pub_info << clean_end_punctuation(marc["260"]["a"]).strip if marc["260"]["a"]
       pub_info << ": #{clean_end_punctuation(marc["260"]["b"]).strip}" if marc["260"]["b"]
       pub_info << ", #{setup_pub_date(marc)}" if marc["260"]["c"]
@@ -301,7 +303,7 @@ module Blacklight::Solr::Document::MarcExport
     elsif marc["502"] and (marc["502"]["b"] or marc["502"]["c"] or marc["502"]["d"]) #sometimes the dissertation note is encoded in pieces in the $b $c and $d sub fields instead of lumped into the $a
       pub_info << "#{marc["502"]["b"]}, #{marc["502"]["c"]}, #{clean_end_punctuation(marc["502"]["d"])}"
     end
-    
+
     citation = ""
     citation << "#{author_text} " unless author_text.blank?
     citation << "<i>#{title}.</i> " unless title.blank?
@@ -311,13 +313,13 @@ module Blacklight::Solr::Document::MarcExport
     citation << "#{pub_info}." unless pub_info.blank?
     citation
   end
-  
-  
-  
+
+
+
   def mla_citation(record)
     text = ''
     authors_final = []
-    
+
     #setup formatted author list
     authors = get_author_list(record)
 
@@ -351,10 +353,10 @@ module Blacklight::Solr::Document::MarcExport
     # Edition
     edition_data = setup_edition(record)
     text += edition_data + " " unless edition_data.nil?
-    
+
     # Publication
     text += setup_pub_info(record) + ", " unless setup_pub_info(record).nil?
-    
+
     # Get Pub Date
     text += setup_pub_date(record) unless setup_pub_date(record).nil?
     if text[-1,1] != "."
@@ -367,7 +369,7 @@ module Blacklight::Solr::Document::MarcExport
     text = ''
     authors_list = []
     authors_list_final = []
-    
+
     #setup formatted author list
     authors = get_author_list(record)
     authors.each do |l|
@@ -392,15 +394,15 @@ module Blacklight::Solr::Document::MarcExport
     end
     # Get Pub Date
     text += "(" + setup_pub_date(record) + "). " unless setup_pub_date(record).nil?
-    
+
     # setup title info
     title = setup_title_info(record)
     text += "<i>" + title + "</i> " unless title.nil?
-    
+
     # Edition
     edition_data = setup_edition(record)
     text += edition_data + " " unless edition_data.nil?
-    
+
     # Publisher info
     text += setup_pub_info(record) unless setup_pub_info(record).nil?
     unless text.blank?
@@ -451,7 +453,7 @@ module Blacklight::Solr::Document::MarcExport
     end
     new_text.join(" ")
   end
-  
+
   # This will replace the mla_citation_title method with a better understanding of how MLA and Chicago citation titles are formatted.
   # This method will take in a string and capitalize all of the non-prepositions.
   def citation_title(title_text)
@@ -482,18 +484,18 @@ module Blacklight::Solr::Document::MarcExport
       end
       text += b_title_info unless b_title_info.nil?
     end
-    
+
     return nil if text.strip.blank?
     clean_end_punctuation(text.strip) + "."
-    
+
   end
-  
+
   def clean_end_punctuation(text)
     if [".",",",":",";","/"].include? text[-1,1]
       return text[0,text.length-1]
     end
     text
-  end  
+  end
 
   def setup_edition(record)
     edition_field = record.find{|f| f.tag == '250'}
@@ -503,9 +505,9 @@ module Blacklight::Solr::Document::MarcExport
       return nil
     else
       return edition_data
-    end    
+    end
   end
-  
+
   def get_author_list(record)
     author_list = []
     authors_primary = record.find{|f| f.tag == '100'}
@@ -517,11 +519,11 @@ module Blacklight::Solr::Document::MarcExport
         author_list.push(clean_end_punctuation(l.find{|s| s.code == 'a'}.value)) unless l.find{|s| s.code == 'a'}.value.nil?
       end
     end
-    
+
     author_list.uniq!
     author_list
   end
-  
+
   # This is a replacement method for the get_author_list method.  This new method will break authors out into primary authors, translators, editors, and compilers
   def get_all_authors(record)
     translator_code = "trl"; editor_code = "edt"; compiler_code = "com"
@@ -547,7 +549,7 @@ module Blacklight::Solr::Document::MarcExport
     end
     {:primary_authors => primary_authors, :translators => translators, :editors => editors, :compilers => compilers}
   end
-  
+
   def abbreviate_name(name)
     name_parts = name.split(", ")
     first_name_parts = name_parts.last.split(" ")
@@ -562,6 +564,5 @@ module Blacklight::Solr::Document::MarcExport
     return name unless name =~ /,/
     temp_name = name.split(", ")
     return temp_name.last + " " + temp_name.first
-  end 
-  
-end
+  end
+end