blacklight-marc 6.3.0 → 7.0.0.rc1

data/app/views/bookmarks/_endnote.html.erb

@@ -1,4 +1,4 @@
-<% if @document_list.any? {|d| d.exports_as? :endnote } %>
+<% if @response.documents.any? {|d| d.exports_as? :endnote } %>
   <li class="endnote">
     <%= link_to t('blacklight.tools.endnote'), bookmarks_path(:endnote, search_state.params_for_search), :class => "btn btn-default", :id => "endnoteLink" %>
   </li>

data/app/views/bookmarks/_refworks.html.erb

@@ -1,4 +1,4 @@
-<% if @document_list.any? {|d| d.exports_as? :refworks_marc_txt } %>
+<% if @response.documents.any? {|d| d.exports_as? :refworks_marc_txt } %>
   <li class="refworks">
     <%= link_to t('blacklight.tools.refworks'), refworks_export_url(url: bookmarks_export_url(:refworks_marc_txt, search_state.params_for_search)), :class => "btn btn-default", :id => "refworksLink" %>
   </li>

data/app/views/catalog/_marc_view.html.erb

@@ -1,6 +1,6 @@
 <div id="marc_view" class="modal-body">
-  <% fields = @document.to_marc.find_all{|f| ('000'..'999') === f.tag }  %>
-  <div class="field"><%= t('blacklight.search.librarian_view.leader', :leader => @document.to_marc.leader) %></div>
+  <% fields = document.to_marc.find_all{|f| ('000'..'999') === f.tag }  %>
+  <div class="field"><%= t('blacklight.search.librarian_view.leader', :leader => document.to_marc.leader) %></div>
   <%- fields.each do |field| -%>
   <%- unless field.tag.to_s == "940" -%>
     <div class="field">
@@ -14,10 +14,10 @@
         </span>
       <%- else -%>
         <div class="ind1">
-          <%= !field.indicator1.blank? ? field.indicator1 : "&nbsp;&nbsp;".html_safe -%>
+          <%= !field.indicator1.blank? ? field.indicator1 : "&nbsp;".html_safe -%>
         </div>
         <div class="ind2">
-          <%= !field.indicator2.blank? ? field.indicator2 : "&nbsp;&nbsp;".html_safe -%>
+          <%= !field.indicator2.blank? ? field.indicator2 : "&nbsp;".html_safe -%>
         </div>
       </div>
       <div class="subfields">

data/app/views/catalog/endnote.endnote.erb

@@ -1 +1 @@
-<%= render_endnote_texts(@documents) %>
+<%= render_endnote_texts(@response.documents) %>

data/app/views/catalog/librarian_view.html.erb

@@ -1,10 +1,13 @@
 
 <div class="modal-header">
-  <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
-  <h3 class="modal-title"><%= t('blacklight.search.librarian_view.title') %></h3>
+  <h1 class="modal-title"><%= t('blacklight.search.librarian_view.title') %></h1>
+  <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="Close">
+    <span aria-hidden="true">×</span>
+  </button>
 </div>
-<%- if @document.respond_to?(:to_marc) -%>
-  <%= render "marc_view" %>
+<%- if @response.documents.first.respond_to?(:to_marc) -%>
+  <%= render "marc_view", document: @response.documents.first %>
 <%- else %>
   <%= t('blacklight.search.librarian_view.empty') %>
 <%- end -%>
+

data/blacklight-marc.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{MARC support for Blacklight}
   spec.summary       = %q{MARC support for Blacklight}
   spec.homepage      = "https://github.com/projectblacklight/blacklight-marc"
-  spec.license       = "Apache 2.0"
+  spec.license       = "Apache-2.0"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
@@ -18,14 +18,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'blacklight', '> 6.1', '< 8.a'
+  spec.add_dependency 'blacklight', '> 7.0.0.a', '< 8.a'
   spec.add_dependency "library_stdnums"
   spec.add_dependency "rails"
-  spec.add_dependency "marc",      ">= 0.4.3", "< 2.0"  # Marc record parser.
-  spec.add_dependency "traject", ">= 2.1", "< 4"
+  # Let's allow future versions of marc, count on
+  # them to be backwards compat until 1.1
+  spec.add_dependency "marc",      ">= 0.4.3", "< 1.1"  # Marc record parser.
+  spec.add_dependency "traject", "~>3.0"
   spec.add_dependency 'marc-fastxmlwriter' # NO REXML
 
-  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec-rails", '~> 3.0'
   spec.add_development_dependency "rspec-activemodel-mocks"

data/config/routes.rb

@@ -9,7 +9,7 @@ Rails.application.routes.draw do
   #
   # These routes can be injected into your Rails application by adding
   #     Blacklight.add_routes(self)
-  # to the application's ./config/routes.rb. The injected routes can be 
+  # to the application's ./config/routes.rb. The injected routes can be
   # customized as well, e.g.:
   #     Blacklight.add_routes(self, :only => [:bookmarks]) # will only look bookmark routes
   #     Blacklight.add_routes(self, :except => [:catalog]) # will not load catalog routes

data/lib/blacklight/marc/catalog.rb

@@ -3,25 +3,19 @@ module Blacklight::Marc
     extend ActiveSupport::Concern
 
     included do
-      add_show_tools_partial(:librarian_view, if: :render_librarian_view_control?, define_method: false)
-      add_show_tools_partial(:refworks, if: :render_refworks_action?, modal: false)
-      add_show_tools_partial(:endnote, if: :render_endnote_action?, modal: false, path: :single_endnote_catalog_path, define_method: false)
+      blacklight_config.add_show_tools_partial(:librarian_view, if: :render_librarian_view_control?, define_method: false)
+      blacklight_config.add_show_tools_partial(:refworks, if: :render_refworks_action?, modal: false)
+      blacklight_config.add_show_tools_partial(:endnote, if: :render_endnote_action?, modal: false, path: :single_endnote_catalog_path, define_method: false)
     end
 
     def librarian_view
-      @response, @document = fetch params[:id]
-
-      respond_to do |format|
-        format.html
-        format.js { render :layout => false }
-      end
-    end
-
-    # grabs a bunch of documents to export to endnote
-    def endnote
-      @response, @documents = fetch(Array(params[:id]))
+      @response, deprecated_document = search_service.fetch params[:id]
+      @document = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_document, "The @document instance variable is deprecated and will be removed in Blacklight-marc 8.0")
       respond_to do |format|
-        format.endnote { render :layout => false }
+        format.html do
+          return render layout: false if request.xhr?
+          # Otherwise draw the full page
+        end 
       end
     end
 

data/lib/blacklight/marc/indexer.rb

@@ -1,5 +1,6 @@
 require 'library_stdnums'
- require 'traject/null_writer'
+require 'traject'
+require 'traject/null_writer'
 require 'traject/macros/marc21_semantics'
 
 require 'traject/macros/marc_format_classifier'
@@ -8,12 +9,6 @@ require 'traject/solr_json_writer'
 require 'traject/marc_reader'
 require 'marc/fastxmlwriter'
 
-unless defined?(Traject::Indexer::MarcIndexer)
-  # shim to get traject 2 to act like traject 3
-  class Traject::Indexer::MarcIndexer < Traject::Indexer
-  end
-end
-
 class Blacklight::Marc::Indexer < Traject::Indexer::MarcIndexer
   autoload :Dewey, 'blacklight/marc/indexer/dewey'
   autoload :Formats, 'blacklight/marc/indexer/formats'
@@ -40,44 +35,13 @@ class Blacklight::Marc::Indexer < Traject::Indexer::MarcIndexer
       provide "log.batch_size", 10_000
     end
   end
-  def first_value block, options={}
-    lambda do |record, accumulator|
-      if block.arity == 3
-        block.call(record,accumulator,options)
-      else
-        block.call(record,accumulator)
-      end
-      accumulator.replace Array(accumulator[0]) # just take the first
-    end
-  end
-  def map_value block, options={}
-    if translation_map_arg  = options.delete(:translation_map)
-      translation_map = Traject::TranslationMap.new(translation_map_arg)
-    else
-      translation_map = nil
-    end
-    lambda do |record, accumulator|
-      if block.arity == 3
-        block.call(record,accumulator,options)
-      else
-        block.call(record,accumulator)
-      end
-      if translation_map
-        translation_map.translate_array! accumulator
-      end
-    end
-  end
-  def trim block, options={}
+
+  def trim
     lambda do |record, accumulator|
-      vals = []
-      if block.arity == 3
-        block.call(record,accumulator,options)
-      else
-        block.call(record,accumulator)
-      end
       accumulator.each {|x| x.strip!}
     end
   end
+
   def get_xml options={}
     lambda do |record, accumulator|
       accumulator << MARC::FastXMLWriter.encode(record)

data/lib/blacklight/marc/indexer/formats.rb

@@ -137,7 +137,7 @@ module Blacklight::Marc::Indexer::Formats
       when (f_000.start_with? 'A')
         if f_000 == 'AM'
           vals << ((field007hasC) ? "eBook" : "Book")
-        elsif f_000 == 'AS' 
+        elsif f_000 == 'AS'
           # Look in 008 to determine what type of Continuing Resource
           format_code = Traject::Macros::Marc21.extract_marc_from(record, "008[21]", first: true, default: "").first.upcase
           if format_code == 'N'

data/lib/blacklight/marc/routes.rb

@@ -1,43 +1,6 @@
 # -*- encoding : utf-8 -*-
 module Blacklight::Marc
-  class Routes
-
-    def initialize(router, options)
-      @router = router
-      @options = options
-    end
-
-    def draw
-      route_sets.each do |r|
-        self.send(r)
-      end
-    end
-
-    protected
-
-    def add_routes &blk
-      @router.instance_exec(@options, &blk)
-    end
-
-    def route_sets
-      (@options[:only] || default_route_sets) - (@options[:except] || [])
-    end
-
-    def default_route_sets
-      [:catalog]
-    end
-
-    module RouteSets
-      def catalog
-        add_routes do |options|
-          # Catalog stuff.
-          get 'catalog/:id/librarian_view', :to => "catalog#librarian_view", :as => "librarian_view_solr_document"
-          get "catalog/endnote", :as => "endnote_solr_document"
-          
-        end
-      end
-   end
-   
-  include RouteSets
+  module Routes
+    require 'blacklight/marc/routes/marc_viewable'
   end
 end

data/lib/blacklight/marc/routes/marc_viewable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Blacklight
+  module Marc
+    module Routes
+      class MarcViewable
+        def initialize(defaults = {})
+          @defaults = defaults
+        end
+
+        def call(mapper, options = {})
+          options = @defaults.merge(options)
+
+          mapper.member do
+            mapper.match 'librarian_view', via: :get
+          end
+        end
+      end
+    end
+  end
+end

data/lib/blacklight/marc/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Marc
-    VERSION = '6.3.0'
+    VERSION = '7.0.0.rc1'
   end
 end

data/lib/generators/blacklight/marc/install_generator.rb

@@ -36,18 +36,18 @@ EOF
     def add_marc_extension_to_solrdocument
 
       insert_into_file "app/models/solr_document.rb", :after => "include Blacklight::Solr::Document" do <<EOF
-    
+
       # The following shows how to setup this blacklight document to display marc documents
-  extension_parameters[:marc_source_field] = :marc_display
+  extension_parameters[:marc_source_field] = :marc_ss
   extension_parameters[:marc_format_type] = :marcxml
   use_extension( Blacklight::Solr::Document::Marc) do |document|
-    document.key?( :marc_display  )
+    document.key?( SolrDocument.extension_parameters[:marc_source_field] )
   end
   
   field_semantics.merge!(    
-                         :title => "title_display",
-                         :author => "author_display",
-                         :language => "language_facet",
+                         :title => "title_ssm",
+                         :author => "author_ssm",
+                         :language => "language_ssim",
                          :format => "format"
                          )
 
@@ -56,7 +56,7 @@ EOF
     end
 
     # Add MARC behaviors to the catalog controller
-  def inject_blacklight_controller_behavior    
+  def inject_blacklight_controller_behavior
     inject_into_file "app/controllers/catalog_controller.rb", after:"include Blacklight::Catalog" do
       "\n  include Blacklight::Marc::Catalog\n"
     end
@@ -64,7 +64,14 @@ EOF
 
 
   def inject_blacklight_marc_routes
-    route('Blacklight::Marc.add_routes(self)')
+    route <<-EOF
+    concern :marc_viewable, Blacklight::Marc::Routes::MarcViewable.new
+    EOF
+
+    inject_into_file "config/routes.rb", after: "resources :solr_documents, only: [:show], path: '/catalog', controller: 'catalog' do" do
+      "\n    concerns [:exportable, :marc_viewable]\nINJECT_FLAG"
+    end
+    gsub_file "config/routes.rb", /[\n]INJECT_FLAG\s+concerns \:exportable/,""
   end
 
   end

data/lib/generators/blacklight/marc/templates/app/models/marc_indexer.rb

@@ -13,39 +13,38 @@ class MarcIndexer < Blacklight::Marc::Indexer
       provide 'solr_writer.max_skipped', -1
     end
 
-    to_field "id", trim(extract_marc("001"), :first => true)
-    to_field 'marc_display', get_xml
-    to_field "text", extract_all_marc_values do |r, acc|
+    to_field "id", extract_marc("001"), trim, first_only
+    to_field 'marc_ss', get_xml
+    to_field "all_text_timv", extract_all_marc_values do |r, acc|
       acc.replace [acc.join(' ')] # turn it into a single string
     end
-     
-    to_field "language_facet", marc_languages("008[35-37]:041a:041d:")
+
+    to_field "language_ssim", marc_languages("008[35-37]:041a:041d:")
     to_field "format", get_format
-    to_field "isbn_t",  extract_marc('020a', :separator=>nil) do |rec, acc|
+    to_field "isbn_tsim",  extract_marc('020a', separator: nil) do |rec, acc|
          orig = acc.dup
          acc.map!{|x| StdNum::ISBN.allNormalizedValues(x)}
          acc << orig
          acc.flatten!
          acc.uniq!
     end
-     
-    to_field 'material_type_display', extract_marc('300a', :trim_punctuation => true)
-     
+
+    to_field 'material_type_ssm', extract_marc('300a'), trim_punctuation
+
     # Title fields
     #    primary title 
-     
-    to_field 'title_t', extract_marc('245a')
-    to_field 'title_display', extract_marc('245a', :trim_punctuation => true, :alternate_script=>false)
-    to_field 'title_vern_display', extract_marc('245a', :trim_punctuation => true, :alternate_script=>:only)
-     
+    to_field 'title_tsim', extract_marc('245a')
+    to_field 'title_ssm', extract_marc('245a', alternate_script: false), trim_punctuation
+    to_field 'title_vern_ssm', extract_marc('245a', alternate_script: :only), trim_punctuation
+
     #    subtitle
-     
-    to_field 'subtitle_t', extract_marc('245b')
-    to_field 'subtitle_display', extract_marc('245b', :trim_punctuation => true, :alternate_script=>false)
-    to_field 'subtitle_vern_display', extract_marc('245b', :trim_punctuation => true, :alternate_script=>:only)
-     
+
+    to_field 'subtitle_tsim', extract_marc('245b')
+    to_field 'subtitle_ssm', extract_marc('245b', alternate_script: false), trim_punctuation
+    to_field 'subtitle_vern_ssm', extract_marc('245b', alternate_script: :only), trim_punctuation
+
     #    additional title fields
-    to_field 'title_addl_t', 
+    to_field 'title_addl_tsim',
       extract_marc(%W{
         245abnps
         130#{ATOZ}
@@ -57,31 +56,31 @@ class MarcIndexer < Blacklight::Marc::Indexer
         246abcdefgnp
         247abcdefgnp
       }.join(':'))
-     
-    to_field 'title_added_entry_t', extract_marc(%W{
+
+    to_field 'title_added_entry_tsim', extract_marc(%W{
       700gklmnoprst
       710fgklmnopqrst
       711fgklnpst
       730abcdefgklmnopqrst
       740anp
     }.join(':'))
-     
-    to_field 'title_series_t', extract_marc("440anpv:490av")
-     
-    to_field 'title_sort', marc_sortable_title  
-     
+
+    to_field 'title_series_tsim', extract_marc("440anpv:490av")
+
+    to_field 'title_si', marc_sortable_title
+
     # Author fields
-     
-    to_field 'author_t', extract_marc("100abcegqu:110abcdegnu:111acdegjnqu")
-    to_field 'author_addl_t', extract_marc("700abcegqu:710abcdegnu:711acdegjnqu")
-    to_field 'author_display', extract_marc("100abcdq:110#{ATOZ}:111#{ATOZ}", :alternate_script=>false)
-    to_field 'author_vern_display', extract_marc("100abcdq:110#{ATOZ}:111#{ATOZ}", :alternate_script=>:only)
-     
+
+    to_field 'author_tsim', extract_marc("100abcegqu:110abcdegnu:111acdegjnqu")
+    to_field 'author_addl_tsim', extract_marc("700abcegqu:710abcdegnu:711acdegjnqu")
+    to_field 'author_ssm', extract_marc("100abcdq:110#{ATOZ}:111#{ATOZ}", alternate_script: false)
+    to_field 'author_vern_ssm', extract_marc("100abcdq:110#{ATOZ}:111#{ATOZ}", alternate_script: :only)
+
     # JSTOR isn't an author. Try to not use it as one
-    to_field 'author_sort', marc_sortable_author
-     
+    to_field 'author_si', marc_sortable_author
+
     # Subject fields
-    to_field 'subject_t', extract_marc(%W(
+    to_field 'subject_tsim', extract_marc(%W(
       600#{ATOU}
       610#{ATOU}
       611#{ATOU}
@@ -90,38 +89,39 @@ class MarcIndexer < Blacklight::Marc::Indexer
       651ae
       653a:654abcde:655abc
     ).join(':'))
-    to_field 'subject_addl_t', extract_marc("600vwxyz:610vwxyz:611vwxyz:630vwxyz:650vwxyz:651vwxyz:654vwxyz:655vwxyz")
-    to_field 'subject_topic_facet', extract_marc("600abcdq:610ab:611ab:630aa:650aa:653aa:654ab:655ab", :trim_punctuation => true)
-    to_field 'subject_era_facet',  extract_marc("650y:651y:654y:655y", :trim_punctuation => true)
-    to_field 'subject_geo_facet',  extract_marc("651a:650z",:trim_punctuation => true )
-     
+    to_field 'subject_addl_tsim', extract_marc("600vwxyz:610vwxyz:611vwxyz:630vwxyz:650vwxyz:651vwxyz:654vwxyz:655vwxyz")
+    to_field 'subject_ssim', extract_marc("600abcdq:610ab:611ab:630aa:650aa:653aa:654ab:655ab"), trim_punctuation
+    to_field 'subject_era_ssim',  extract_marc("650y:651y:654y:655y"), trim_punctuation
+    to_field 'subject_geo_ssim',  extract_marc("651a:650z"), trim_punctuation
+
     # Publication fields
-    to_field 'published_display', extract_marc('260a', :trim_punctuation => true, :alternate_script=>false)
-    to_field 'published_vern_display', extract_marc('260a', :trim_punctuation => true, :alternate_script=>:only)
-    to_field 'pub_date', marc_publication_date
-     
+    to_field 'published_ssm', extract_marc('260a', alternate_script: false), trim_punctuation
+    to_field 'published_vern_ssm', extract_marc('260a', alternate_script: :only), trim_punctuation
+    to_field 'pub_date_si', marc_publication_date
+    to_field 'pub_date_ssim', marc_publication_date
+
     # Call Number fields
-    to_field 'lc_callnum_display', extract_marc('050ab', :first => true)
-    to_field 'lc_1letter_facet', extract_marc('050ab', :first=>true, :translation_map=>'callnumber_map') do |rec, acc|
-      # Just get the first letter to send to the translation map
-      acc.map!{|x| x[0]}
-    end
+    to_field 'lc_callnum_ssm', extract_marc('050ab'), first_only
+
+    first_letter = lambda {|rec, acc| acc.map!{|x| x[0]} }
+    to_field 'lc_1letter_ssim', extract_marc('050ab'), first_only, first_letter, translation_map('callnumber_map')
 
     alpha_pat = /\A([A-Z]{1,3})\d.*\Z/
-    to_field 'lc_alpha_facet', extract_marc('050a', :first=>true) do |rec, acc|
+    alpha_only = lambda do |rec, acc|
       acc.map! do |x|
         (m = alpha_pat.match(x)) ? m[1] : nil
       end
       acc.compact! # eliminate nils
     end
+    to_field 'lc_alpha_ssim', extract_marc('050a'), alpha_only, first_only 
+
+    to_field 'lc_b4cutter_ssim', extract_marc('050a'), first_only
 
-    to_field 'lc_b4cutter_facet', extract_marc('050a', :first=>true)
-     
     # URL Fields
-     
+
     notfulltext = /abstract|description|sample text|table of contents|/i
-     
-    to_field('url_fulltext_display') do |rec, acc|
+
+    to_field('url_fulltext_ssm') do |rec, acc|
       rec.fields('856').each do |f|
         case f.indicator2
         when '0'
@@ -140,7 +140,7 @@ class MarcIndexer < Blacklight::Marc::Indexer
     end
 
     # Very similar to url_fulltext_display. Should DRY up.
-    to_field 'url_suppl_display' do |rec, acc|
+    to_field 'url_suppl_ssm' do |rec, acc|
       rec.fields('856').each do |f|
         case f.indicator2
         when '2'