blacklight-marc 7.1.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67e4c2b3e51422a3801fda3a61fe549e73889f43cdee3571c35368f44f10490e
-  data.tar.gz: dec3a61d6f54c91811d37afa6d9a4462255c224c33d1f7a0448d1de3028161ff
+  metadata.gz: 510b8f1ae8d1d7752d0dbeadf0db9e4cc5003d88dd25c7b4a9e76ba1757c2d4e
+  data.tar.gz: 61ffc549983a3e3ca3fe0497cfcac437bac64318fba45d7836ad0307d2f1a83a
 SHA512:
-  metadata.gz: 57f8a9949505a58970bae0a8aaf9f25a0d46c1d7d80272cf19c8a5ff43aa2833c3676e9f5246dd88c8954d33d6699601ddf463429ae30cb916a762616b7014eb
-  data.tar.gz: 959d4dae4de2e8f5378cd7379b3863a1ca70408f9d6e0ba95bed151651ec6bc5b4f052167782caf53f3d1c351e6747f68be5841825888a4be724ee3c02ad1330
+  metadata.gz: cc9bacb9622c2e4f68f2ff7058d9ce8495e2667ab7b8fae7c5495e571a11e82ccd9699bb73237aad5935f6d47a229e651671158eb22fe686816b14c520adaf09
+  data.tar.gz: b8127b909fd370507c3a7a59860ae395abe2f7b23828e18dfae1c54042507ee7c7c8f7b03f7986e58d308f855ca38fad0851b1f93b6d5aab7e3ef31c632555e7

data/.github/workflows/ruby.yml

@@ -1,36 +1,24 @@
+---
 name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [main]
   pull_request:
-    branches: [ master ]
+    branches: [main]
 
 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]
+        rails_version: [6.1.4.7, 7.0.2.3]
+        ruby: [2.7, '3.0']
+        include:
+          - rails_version: 5.2.4.4
+            ruby: 2.7
+          - rails_version: 6.0.3.4
+            ruby: 2.7
     env:
       RAILS_VERSION: ${{ matrix.rails_version }}
     steps:

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/projectblacklight/blacklight-marc.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight-marc)
+![Build Status](https://github.com/projectblacklight/blacklight-marc/actions/workflows/ruby.yml/badge.svg?branch=main)
 
 # Blacklight::Marc
 

data/app/assets/stylesheets/blacklight_marc.scss

@@ -1,25 +1,14 @@
 /* border between items on marc view */
 $marc_item_separator: 1px solid $text-muted !default;
 
-#librarian_view
-{
-	left:-17%;
-	text-align:left;
-	top:10%;
-	width:700px;
-}
-
-#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;
+.marc_view {
+	font-family: $font-family-monospace;
 
-  .field
-  {
+  .field {
+		align-items: flex-start;
     border-bottom: $marc_item_separator;
-    clear:both;
+		display: flex;
+		gap: 2em;
   }
 
   .ind1, .ind2
@@ -28,13 +17,7 @@ $marc_item_separator: 1px solid $text-muted !default;
     padding: 0 ($spacer / 2);
   }
 
-  .subfields
-  {
-    padding-left:5em;
-  }
-
-  .tag_ind
-  {
-    float:left;
-  }
+	.tag_ind {
+		flex-shrink: 0;
+	}
 }

data/{lib → app/controllers/concerns}/blacklight/marc/catalog.rb

@@ -9,13 +9,20 @@ module Blacklight::Marc
     end
 
     def librarian_view
-      @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")
+      if Blacklight::VERSION >= '8'
+        @document = search_service.fetch(params[:id])
+        @response = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(@document.response, "The @response instance variable is deprecated and will be removed in Blacklight-marc 8.0")
+
+      else
+        deprecated_response, @document = search_service.fetch(params[:id])
+        @response = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_response, "The @response instance variable is deprecated and will be removed in Blacklight-marc 8.0")
+      end
+
       respond_to do |format|
         format.html do
           return render layout: false if request.xhr?
           # Otherwise draw the full page
-        end 
+        end
       end
     end
 

data/app/helpers/blacklight_marc_helper.rb

@@ -39,4 +39,12 @@ module BlacklightMarcHelper
     end
     val
   end
+
+  # A URL to refworks export, with an embedded callback URL to this app.
+  # the callback URL is to bookmarks#export, which delivers a list of
+  # user's bookmarks in 'refworks marc txt' format -- we tell refworks
+  # to expect that format.
+  def bookmarks_export_url(format, params = {})
+    bookmarks_url(params.merge(format: format, encrypted_user_id: encrypt_user_id(current_or_guest_user.id)))
+  end
 end

data/app/models/concerns/blacklight/{solr/document/marc_export.rb → marc/document_export.rb}

@@ -1,11 +1,12 @@
 # -*- encoding : utf-8 -*-
 # -*- coding: utf-8 -*-
-# Written for use with Blacklight::Solr::Document::Marc, but you can use
+
+# Written for use with Blacklight::Marc::DocumentExtension, but you can use
 # 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.
-module Blacklight::Solr::Document::MarcExport
+module Blacklight::Marc::DocumentExport
 
   def self.register_export_formats(document)
     document.will_export_as(:xml)

data/app/models/concerns/blacklight/{solr/document/marc.rb → marc/document_extension.rb}

@@ -9,7 +9,7 @@
 # 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 ) }
+# SolrDocument.use_extension( Blacklight::Marc::DocumentExtension ) { |document| my_logic_for_document_has_marc?( document ) }
 #
 # This extension also expects a :marc_source_field and :marc_format_type to
 # be registered with the hosting classes extension_parameters. In an initializer
@@ -18,15 +18,16 @@
 # SolrDocument.extension_parameters[:marc_format_type] = :marc21 # or :marcxml
 require 'marc'
 
-module Blacklight::Solr::Document::Marc
+module Blacklight::Marc
+  module DocumentExtension
 
-  include Blacklight::Solr::Document::MarcExport # All our export_as stuff based on to_marc.
+  include Blacklight::Marc::DocumentExport # 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
-    Blacklight::Solr::Document::MarcExport.register_export_formats( document )
+    Blacklight::Marc::DocumentExport.register_export_formats( document )
   end
 
   # ruby-marc object
@@ -59,7 +60,9 @@ module Blacklight::Solr::Document::Marc
   end
 
   def marc_record_from_marcxml
-    MARC::XMLReader.new(StringIO.new( fetch(_marc_source_field) )).to_a.first
+    marcxml = fetch(_marc_source_field)
+    marcxml = marcxml.first if marcxml.kind_of? Array
+    MARC::XMLReader.new(StringIO.new(marcxml)).to_a.first
   end
 
   def _marc_helper
@@ -76,4 +79,5 @@ module Blacklight::Solr::Document::Marc
     self.class.extension_parameters[:marc_format_type]
   end
 
+  end
 end

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

@@ -1,32 +1,30 @@
-<div id="marc_view" class="modal-body">
-  <% fields = document.to_marc.find_all{|f| ('000'..'999') === f.tag }  %>
+<div id="marc_view" class="marc_view">
   <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" -%>
+  <%- document.to_marc.each do |field| -%>
     <div class="field">
-      <div class="tag_ind">
-        <span class="tag">
-          <%= h(field.tag) %>
-        </span>
       <%- if field.is_a?(MARC::ControlField) -%>
-        <span class="control_field_values">
-          <%= h(field.value) %>
-        </span>
+      <div class="tag_ind">
+        <span class="tag"><%= field.tag %></span>
+      </div>
+      <span class="control_field_values">
+        <%= h(field.value) %>
+      </span>
       <%- else -%>
+      <div class="tag_ind">
+        <span class="tag"><%= field.tag %></span>
         <div class="ind1">
-          <%= !field.indicator1.blank? ? field.indicator1 : "&nbsp;".html_safe -%>
+          <%= field.try(:indicator1).present? ? field.indicator1 : "&nbsp;".html_safe -%>
         </div>
         <div class="ind2">
-          <%= !field.indicator2.blank? ? field.indicator2 : "&nbsp;".html_safe -%>
+          <%= field.try(:indicator2).present? ? field.indicator2 : "&nbsp;".html_safe -%>
         </div>
       </div>
       <div class="subfields">
         <%- field.each do |sub| -%>
-        <span class="sub_code"><%= h(sub.code) %>|</span> <%= h(sub.value) %>
-      <%- end -%>
-      <%- end -%>
+        <span class="sub_code"><%= sub.code %>|</span> <%= sub.value %>
+        <%- end -%>
       </div>
+      <%- end -%>
     </div>
-  <%- end-%>
   <%- end -%>
 </div>

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

@@ -1,13 +1,8 @@
-
-<div class="modal-header">
-  <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 @response.documents.first.respond_to?(:to_marc) -%>
-  <%= render "marc_view", document: @response.documents.first %>
-<%- else %>
-  <%= t('blacklight.search.librarian_view.empty') %>
-<%- end -%>
-
+<%= render Blacklight::System::ModalComponent.new do |component| %>
+  <% component.title { t('blacklight.search.librarian_view.title') } %>
+  <%- if @document.respond_to?(:to_marc) -%>
+    <%= render "marc_view", document: @document %>
+  <%- else %>
+    <%= t('blacklight.search.librarian_view.empty') %>
+  <%- end -%>
+<% end %>

data/blacklight-marc.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'blacklight', '~> 7.0'
+  spec.add_dependency 'blacklight', '>= 7.11', '< 9'
   spec.add_dependency "library_stdnums"
   spec.add_dependency "rails"
   spec.add_dependency "marc",      ">= 0.4.3", "< 2.0"  # Marc record parser.

data/lib/blacklight/marc/engine.rb

@@ -1,21 +1,10 @@
-require "blacklight/marc"
-require "rails"
-
 module Blacklight::Marc
   class Engine < Rails::Engine
-    config.autoload_paths += %W(
-      #{config.root}/app/presenters
-      #{config.root}/app/controllers/concerns
-      #{config.root}/app/models/concerns
-    )
-
     rake_tasks do
       load "railties/solr_marc.rake"
     end
 
     initializer 'blacklight_marc.initialize' do |app|
-      require 'blacklight/solr/document'
-
       Mime::Type.register_alias "text/plain", :refworks_marc_txt
       Mime::Type.register_alias "text/plain", :openurl_kev
       Mime::Type.register "application/x-endnote-refer", :endnote
@@ -23,6 +12,13 @@ module Blacklight::Marc
       Mime::Type.register "application/marcxml+xml", :marcxml,
       ["application/x-marc+xml", "application/x-marcxml+xml",
        "application/marc+xml"]
+
+       # these are here for backwards compatibility with the old class names,
+       # which zeitwerk didn't care for
+       config.after_initialize do
+         Blacklight::Solr::Document::Marc = Blacklight::Marc::DocumentExtension
+         Blacklight::Solr::Document::MarcExport = Blacklight::Marc::DocumentExport
+       end
      end
   end
 end

data/lib/blacklight/marc/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Marc
-    VERSION = '7.1.0'
+    VERSION = '8.0.0'
   end
 end

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

@@ -40,11 +40,11 @@ EOF
       # The following shows how to setup this blacklight document to display marc documents
   extension_parameters[:marc_source_field] = :marc_ss
   extension_parameters[:marc_format_type] = :marcxml
-  use_extension( Blacklight::Solr::Document::Marc) do |document|
-    document.key?( SolrDocument.extension_parameters[:marc_source_field] )
+  use_extension(Blacklight::Marc::DocumentExtension) do |document|
+    document.key?(SolrDocument.extension_parameters[:marc_source_field])
   end
-  
-  field_semantics.merge!(    
+
+  field_semantics.merge!(
                          :title => "title_ssm",
                          :author => "author_ssm",
                          :language => "language_ssim",

data/solr/conf/solrconfig.xml

@@ -17,6 +17,7 @@
   </updateHandler>
 
   <!-- solr lib dirs -->
+  <lib dir="${solr.install.dir:../../../..}/modules/analysis-extras/lib" />
   <lib dir="${solr.install.dir:../../../..}/contrib/analysis-extras/lib" />
   <lib dir="${solr.install.dir:../../../..}/contrib/analysis-extras/lucene-libs" />
 

data/spec/helpers/blacklight_marc_helper_spec.rb

@@ -43,4 +43,11 @@ describe BlacklightMarcHelper do
     end
   end
 
+  describe "#bookmarks_export_url" do
+    it "is the bookmark url with an encrypted user token" do
+      allow(helper).to receive_messages(encrypt_user_id: 'xyz', current_or_guest_user: double(id: 123))
+      url = helper.bookmarks_export_url(:html)
+      expect(url).to eq helper.bookmarks_url(format: :html, encrypted_user_id: 'xyz')
+    end
+  end
 end

data/spec/test_app_templates/Gemfile.extra

@@ -1,2 +1 @@
-gem 'blacklight', github: 'projectblacklight/blacklight'
 gem "traject", '~>3.0'

data/spec/views/bookmarks/_endnote.html.erb_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe 'bookmarks/_endnote.html.erb' do
+RSpec.describe 'bookmarks/_endnote' do
   before do
     allow(controller).to receive(:blacklight_config)
       .and_return(CatalogController.blacklight_config)

data/spec/views/bookmarks/_refworks.html.erb_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe 'bookmarks/_refworks.html.erb' do
+RSpec.describe 'bookmarks/_refworks' do
   before do
     allow(controller).to receive(:blacklight_config)
       .and_return(CatalogController.blacklight_config)

data/spec/views/catalog/index.atom.builder_spec.rb

@@ -29,7 +29,7 @@ describe "catalog/index" do
     params.merge!( @params )
     allow(view).to receive(:blacklight_config).and_return(@config)
     allow(view).to receive(:search_field_options_for_select).and_return([])
-
+    allow(controller).to receive(:search_state_class).and_return(Blacklight::SearchState)
     render :template => 'catalog/index', :formats => [:atom]
 
     # We need to use rexml to test certain things that have_tag wont' test

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-marc
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Justin Coyne
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-17 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.11'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.11'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: library_stdnums
   requirement: !ruby/object:Gem::Requirement
@@ -227,9 +233,10 @@ files:
 - README.md
 - Rakefile
 - app/assets/stylesheets/blacklight_marc.scss
+- app/controllers/concerns/blacklight/marc/catalog.rb
 - app/helpers/blacklight_marc_helper.rb
-- app/models/concerns/blacklight/solr/document/marc.rb
-- app/models/concerns/blacklight/solr/document/marc_export.rb
+- app/models/concerns/blacklight/marc/document_export.rb
+- app/models/concerns/blacklight/marc/document_extension.rb
 - app/views/bookmarks/_endnote.html.erb
 - app/views/bookmarks/_marc_tools.html.erb
 - app/views/bookmarks/_refworks.html.erb
@@ -247,7 +254,6 @@ files:
 - config/locales/blacklight_marc.pt-BR.yml
 - config/routes.rb
 - lib/blacklight/marc.rb
-- lib/blacklight/marc/catalog.rb
 - lib/blacklight/marc/engine.rb
 - lib/blacklight/marc/indexer.rb
 - lib/blacklight/marc/indexer/dewey.rb
@@ -310,7 +316,7 @@ homepage: https://github.com/projectblacklight/blacklight-marc
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -325,8 +331,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: MARC support for Blacklight
 test_files: