blacklight 8.0.0.beta1 → 8.0.0

data/app/javascript/blacklight/search_context.js

@@ -1,59 +1,53 @@
-import Blacklight from './core'
-
-const SearchContext = (() => {
-  Blacklight.doSearchContextBehavior = function() {
-    document.addEventListener('click', (e) => {
-      if (e.target.matches('[data-context-href]')) {
-        Blacklight.handleSearchContextMethod.call(e.target, e)
-      }
-    })
-  };
-
-  Blacklight.csrfToken = () => document.querySelector('meta[name=csrf-token]')?.content
-  Blacklight.csrfParam = () => document.querySelector('meta[name=csrf-param]')?.content
-
-  // this is the Rails.handleMethod with a couple adjustments, described inline:
-  // first, we're attaching this directly to the event handler, so we can check for meta-keys
-  Blacklight.handleSearchContextMethod = function(event) {
-    const link = this
-
-    // instead of using the normal href, we need to use the context href instead
-    let href = link.getAttribute('data-context-href')
-    let target = link.getAttribute('target')
-    let csrfToken = Blacklight.csrfToken()
-    let csrfParam = Blacklight.csrfParam()
-    let form = document.createElement('form')
-    form.method = 'post'
-    form.action = href
-
-
-    let formContent = `<input name="_method" value="post" type="hidden" />
-      <input name="redirect" value="${link.getAttribute('href')}" type="hidden" />`
-
-    // check for meta keys.. if set, we should open in a new tab
-    if(event.metaKey || event.ctrlKey) {
-      target = '_blank';
-    }
-
-    if (csrfParam !== undefined && csrfToken !== undefined) {
-      formContent += `<input name="${csrfParam}" value="${csrfToken}" type="hidden" />`
-    }
-
-    // Must trigger submit by click on a button, else "submit" event handler won't work!
-    // https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit
-    formContent += '<input type="submit" />'
-
-    if (target) { form.setAttribute('target', target); }
-
-    form.style.display = 'none'
-    form.innerHTML = formContent
-    document.body.appendChild(form)
-    form.querySelector('[type="submit"]').click()
-
-    event.preventDefault()
-  };
-
-  Blacklight.doSearchContextBehavior();
-})()
+const SearchContext = (e) => {
+  if (e.target.matches('[data-context-href]')) {
+    SearchContext.handleSearchContextMethod.call(e.target, e)
+  }
+}
+
+SearchContext.csrfToken = () => document.querySelector('meta[name=csrf-token]')?.content
+SearchContext.csrfParam = () => document.querySelector('meta[name=csrf-param]')?.content
+
+// this is the Rails.handleMethod with a couple adjustments, described inline:
+// first, we're attaching this directly to the event handler, so we can check for meta-keys
+SearchContext.handleSearchContextMethod = function(event) {
+  const link = this
+
+  // instead of using the normal href, we need to use the context href instead
+  let href = link.getAttribute('data-context-href')
+  let target = link.getAttribute('target')
+  let csrfToken = SearchContext.csrfToken()
+  let csrfParam = SearchContext.csrfParam()
+  let form = document.createElement('form')
+  form.method = 'post'
+  form.action = href
+
+
+  let formContent = `<input name="_method" value="post" type="hidden" />
+    <input name="redirect" value="${link.getAttribute('href')}" type="hidden" />`
+
+  // check for meta keys.. if set, we should open in a new tab
+  if(event.metaKey || event.ctrlKey) {
+    target = '_blank';
+  }
+
+  if (csrfParam !== undefined && csrfToken !== undefined) {
+    formContent += `<input name="${csrfParam}" value="${csrfToken}" type="hidden" />`
+  }
+
+  // Must trigger submit by click on a button, else "submit" event handler won't work!
+  // https://developer.mozilla.org/en-US/docs/Web/API/HTMLFormElement/submit
+  formContent += '<input type="submit" />'
+
+  if (target) { form.setAttribute('target', target); }
+
+  form.style.display = 'none'
+  form.innerHTML = formContent
+  document.body.appendChild(form)
+  form.querySelector('[type="submit"]').click()
+
+  event.preventDefault()
+};
+
+document.addEventListener('click', SearchContext)
 
 export default SearchContext

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

@@ -31,6 +31,17 @@ module Blacklight::Document
     class_attribute :inspector_fields, default: [:_source]
   end
 
+  Email = Module.new do
+    def self.included(mod)
+      Blacklight.deprecation.warn("Blacklight::Document::Email is deprecated and will be removed (included in #{mod}).")
+    end
+  end
+  Sms = Module.new do
+    def self.included(mod)
+      Blacklight.deprecation.warn("Blacklight::Document::Sms is deprecated and will be removed (included in #{mod}).")
+    end
+  end
+
   attr_reader :response, :_source
   alias_method :solr_response, :response
 

data/app/models/record_mailer.rb

@@ -2,27 +2,21 @@
 
 # Only works for documents with a #to_marc right now.
 class RecordMailer < ApplicationMailer
-  def email_record(documents, details, url_gen_params)
-    title = begin
-      title_field = details[:config].email.title_field
-      if title_field
-        [documents.first[title_field]].flatten.first
-      else
-        documents.first.to_semantic_values[:title]
-      end
-    rescue
-      I18n.t('blacklight.email.text.default_title')
-    end
-
-    subject = I18n.t('blacklight.email.text.subject',
-                     count: documents.length,
-                     title: Array(title).first)
+  helper CatalogHelper
+  helper_method :blacklight_config, :blacklight_configuration_context
 
+  def email_record(documents, details, url_gen_params)
     @documents      = documents
     @message        = details[:message]
     @config         = details[:config]
     @url_gen_params = url_gen_params
 
+    title = view_context.document_presenter(documents.first).html_title || I18n.t('blacklight.email.text.default_title')
+
+    subject = I18n.t('blacklight.email.text.subject',
+                     count: documents.length,
+                     title: Array(title).first)
+
     mail(to: details[:to], subject: subject)
   end
 
@@ -33,4 +27,14 @@ class RecordMailer < ApplicationMailer
 
     mail(to: details[:to], subject: "") # rubocop:disable Rails/I18nLocaleTexts
   end
+
+  def blacklight_config
+    @config || Blacklight.default_configuration
+  end
+
+  ##
+  # Context in which to evaluate blacklight configuration conditionals
+  def blacklight_configuration_context
+    @blacklight_configuration_context ||= Blacklight::Configuration::Context.new(self)
+  end
 end

data/app/presenters/blacklight/document_presenter.rb

@@ -11,18 +11,20 @@ module Blacklight
     # @param [SolrDocument] document
     # @param [ActionView::Base] view_context scope for linking and generating urls
     # @param [Blacklight::Configuration] configuration
-    def initialize(document, view_context, configuration = view_context.blacklight_config)
+    def initialize(document, view_context, configuration = view_context.blacklight_config, view_config: nil, field_presenter_options: {})
       @document = document
       @view_context = view_context
       @configuration = configuration
+      @view_config = view_config
+      @field_presenter_options = field_presenter_options
     end
 
     # @return [Hash<String,Configuration::Field>]  all the fields for this index view that should be rendered
-    def fields_to_render
-      return to_enum(:fields_to_render) unless block_given?
+    def fields_to_render(document_fields = fields, **kwargs)
+      return to_enum(:fields_to_render, document_fields, **kwargs) unless block_given?
 
-      fields.each do |name, field_config|
-        field_presenter = field_presenter(field_config)
+      document_fields.each do |name, field_config|
+        field_presenter = field_presenter(field_config, kwargs)
 
         next unless field_presenter.render_field? && field_presenter.any?
 
@@ -30,10 +32,10 @@ module Blacklight
       end
     end
 
-    def field_presenters
-      return to_enum(:field_presenters) unless block_given?
+    def field_presenters(document_fields = fields, **kwargs)
+      return to_enum(:field_presenters, document_fields, **kwargs) unless block_given?
 
-      fields_to_render.each { |_, _, config| yield config }
+      fields_to_render(document_fields, **kwargs).each { |_, _, config| yield config }
     end
 
     ##
@@ -116,11 +118,11 @@ module Blacklight
     end
 
     def view_config
-      show_view_config
+      @view_config ||= show_view_config
     end
 
     def show_view_config
-      configuration.view_config(:show)
+      configuration.view_config(:show, action_name: view_context.action_name)
     end
 
     def inspect
@@ -150,7 +152,7 @@ module Blacklight
     end
 
     def field_presenter_options
-      {}
+      @field_presenter_options ||= {}
     end
   end
 end

data/app/presenters/blacklight/index_presenter.rb

@@ -3,7 +3,7 @@
 module Blacklight
   class IndexPresenter < DocumentPresenter
     def view_config
-      configuration.view_config(view_context.document_index_view_type)
+      @view_config ||= configuration.view_config(view_context.document_index_view_type, action_name: view_context.action_name)
     end
   end
 end

data/app/presenters/blacklight/rendering/abstract_step.rb

@@ -20,6 +20,10 @@ module Blacklight
         first, *rest = *stack
         first.new(output_values, config, document, context, options, rest).render
       end
+
+      def html?
+        options[:format].nil? || options[:format].to_s == 'html'
+      end
     end
   end
 end

data/app/presenters/blacklight/rendering/join.rb

@@ -5,7 +5,13 @@ module Blacklight
     class Join < AbstractStep
       def render
         options = config.separator_options || {}
-        next_step(values.map { |x| x.html_safe? ? x : html_escape(x) }.to_sentence(options).html_safe)
+        if values.one? || values.none?
+          next_step(values.first)
+        elsif !html?
+          next_step(values.to_sentence(options))
+        else
+          next_step(values.map { |x| x.html_safe? ? x : html_escape(x) }.to_sentence(options).html_safe)
+        end
       end
 
       private

data/app/presenters/blacklight/rendering/link_to_facet.rb

@@ -4,7 +4,7 @@ module Blacklight
   module Rendering
     class LinkToFacet < AbstractStep
       def render
-        return next_step(values) unless config.link_to_facet
+        return next_step(values) unless config.link_to_facet && html?
 
         next_step(render_link)
       end

data/app/presenters/blacklight/rendering/microdata.rb

@@ -5,7 +5,7 @@ module Blacklight
     class Microdata < AbstractStep
       include ActionView::Helpers::TagHelper
       def render
-        return next_step(values) unless config.itemprop
+        return next_step(values) unless config.itemprop && html?
 
         next_step(values.map { |x| itemprop(x, config.itemprop) })
       end

data/app/services/blacklight/search_service.rb

@@ -44,7 +44,8 @@ module Blacklight
 
     # retrieve a document, given the doc id
     # @param [Array{#to_s},#to_s] id
-    # @return [Blacklight::SolrDocument] the solr response object and the first document
+    # @return [Blacklight::SolrDocument] the solr document (or array of
+    #   documents if an array of ids was given)
     def fetch(id = nil, extra_controller_params = {})
       if id.is_a? Array
         fetch_many(id, extra_controller_params)

data/app/views/catalog/_document.atom.builder

@@ -21,7 +21,7 @@ xml.entry do
   with_format(:html) do
     xml.summary "type" => "html" do
       document_component = blacklight_config.view_config(:atom).summary_component
-      xml.text! render document_component.new(presenter: document_presenter(document), component: :div, show: true)
+      xml.text! render document_component.new(document_component.collection_parameter => document_presenter(document), component: :div, show: true)
     end
   end
 

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

@@ -1,9 +1,4 @@
 <% # container for a single doc -%>
-<% view_config = local_assigns[:view_config] || blacklight_config.view_config(document_index_view_type) %>
-<%= render view_config.document_component.new(presenter: document_presenter(document), counter: document_counter_with_offset(document_counter)) do |component| %>
-  <% view_config.partials.each do |partial| %>
-    <% component.partial do %>
-      <%= render_document_partial document, partial, component: component, document_counter: document_counter %>
-    <% end %>
-  <% end %>
-<% end %>
+<% view_config = local_assigns[:view_config] || blacklight_config.view_config(document_index_view_type, action_name: action_name) %>
+<% document_component = view_config.document_component -%>
+<%= render document_component.new(document_component.collection_parameter => document_presenter(document), counter: document_counter_with_offset(document_counter), partials: view_config&.partials) %>

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

@@ -1,5 +1,6 @@
 <% # container for all documents in index list view -%>
 <% view_config = local_assigns[:view_config] || blacklight_config&.view_config(document_index_view_type) %>
 <div id="documents" class="documents-<%= view_config&.key || document_index_view_type %>">
-  <%= render documents, as: :document, view_config: view_config %>
+  <% document_presenters = documents.map { |doc| document_presenter(doc) } -%>
+  <%= render view_config.document_component.with_collection(document_presenters, partials: view_config.partials, counter_offset: @response&.start || 0) %>
 </div>

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

@@ -1,8 +1,8 @@
 <%= render(Blacklight::FacetFieldComponent.new(facet_field: facet_field_presenter(facet_field, nil))) do |component| %>
-  <% component.label do %>
+  <% component.with_label do %>
     <%= facet_field_label(facet_field.key) %>
   <% end %>
-  <% component.body do %>
+  <% component.with_body do %>
     <%= yield %>
   <% end %>
 <% end %>

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

@@ -1,20 +1,14 @@
-<%= render(Blacklight::SearchContextComponent.new(search_context: @search_context, search_session: search_session)) if search_session['document_id'] == @document.id %>
-
+<%= render blacklight_config.track_search_session.item_pagination_component.new(search_context: @search_context, search_session: search_session, current_document: @document) if blacklight_config.track_search_session.item_pagination_component %>
 <% @page_title = t('blacklight.search.show.title', document_title: document_presenter(@document).html_title, application_name: application_name).html_safe %>
 <% content_for(:head) { render_link_rel_alternates } %>
 
-<%= render (blacklight_config.view_config(:show).document_component).new(presenter: document_presenter(@document), component: :div, show: true) do |component| %>
-  <% component.title(as: 'h1', classes: '', link_to_document: false, actions: false) %>
-  <% component.footer do %>
+<% document_component = blacklight_config.view_config(:show).document_component -%>
+<%= render (document_component).new(document_component.collection_parameter => document_presenter(@document), component: :div, show: true, partials: blacklight_config.view_config(:show).partials) do |component| %>
+  <% component.with_title(as: 'h1', classes: '', link_to_document: false, actions: false) %>
+  <% component.with_footer do %>
     <% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
       <!-- COinS, for Zotero among others. -->
       <span class="Z3988" title="<%= @document.export_as_openurl_ctx_kev(document_presenter(@document).display_type) %>"></span>
     <% end %>
   <% end %>
-
-  <% blacklight_config.view_config(:show).partials.each do |partial| %>
-    <% component.partial do %>
-      <%= render_document_partial @document, partial, component: component %>
-    <% end %>
-  <% end %>
 <% end %>

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

@@ -1,14 +1 @@
-<% if show_doc_actions? %>
-  <div class="card show-tools">
-    <div class="card-header">
-      <h2 class="mb-0 h6"><%= t('blacklight.tools.title') %></h2>
-    </div>
-    <%= render Blacklight::Document::ActionsComponent.new(document: document,
-                                                          tag: 'ul',
-                                                          classes: 'list-group list-group-flush',
-                                                          wrapping_tag: 'li',
-                                                          wrapping_classes: 'list-group-item list-group-item-action',
-                                                          actions: document_actions(document),
-                                                          url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h)) %>
-  </div>
-<% end %>
+<%= render Blacklight::Document::ShowToolsComponent.new(document: document) %>

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

@@ -1,11 +1,11 @@
 <%= render Blacklight::System::ModalComponent.new do |component| %>
-  <% component.prefix do %>
+  <% component.with_prefix do %>
     <div class="facet-pagination top row justify-content-between">
       <%= render :partial=>'facet_pagination' %>
     </div>
   <% end %>
 
-  <% component.title { facet_field_label(@facet.key) } %>
+  <% component.with_title { facet_field_label(@facet.key) } %>
 
   <%= render partial: 'facet_index_navigation' if @facet.index_range && @display_facet.index? %>
 
@@ -15,7 +15,7 @@
                                               layout: false) %>
   </div>
 
-  <% component.footer do %>
+  <% component.with_footer do %>
     <div class="facet-pagination bottom flex-row justify-content-between">
       <%= render :partial=>'facet_pagination' %>
     </div>

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

@@ -1,3 +1,6 @@
+<% content_for(:head) do %>
+  <meta name="blacklight-search-storage" content="<%= blacklight_config.track_search_session.storage %>">
+<% end %>
 <% content_for(:sidebar) do %>
   <% conf = blacklight_config.view_config(document_index_view_type) %>
   <%= render conf.sidebar_component.new(blacklight_config: blacklight_config,

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

@@ -1,9 +1,4 @@
-<% if current_search_session %>
-  <div id="appliedParams" class="clearfix constraints-container">
-    <%= render 'start_over' %>
-    <%= link_back_to_catalog class: 'btn btn-outline-secondary' %>
-  </div>
-<% end %>
+<%= render blacklight_config.track_search_session.applied_params_component.new if blacklight_config.track_search_session.applied_params_component %>
 
 <%= render 'show_main_content' %>
 

data/app/views/layouts/blacklight/base.html.erb

@@ -15,21 +15,20 @@
     <%= opensearch_description_tag application_name, opensearch_catalog_url(format: 'xml') %>
     <%= favicon_link_tag %>
     <%= stylesheet_link_tag "application", media: "all", "data-turbo-track": "reload"  %>
-    <%= stylesheet_link_tag "https://ga.jspm.io/npm:dialog-polyfill@0.5.6/dist/dialog-polyfill.css" %>
     <% if defined? Importmap %>
       <%= javascript_importmap_tags %>
     <% elsif defined? Propshaft %>
       <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
-    <% else %>    
+    <% else %>
       <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
       <%= javascript_include_tag "blacklight/blacklight", type: 'module' %>
+      <script type="module">
+        import githubAutoCompleteElement from 'https://cdn.skypack.dev/@github/auto-complete-element';
+      </script>
     <% end %>
 
     <%= csrf_meta_tags %>
     <%= content_for(:head) %>
-    <script type="module">
-      import githubAutoCompleteElement from 'https://cdn.skypack.dev/@github/auto-complete-element';
-    </script>
   </head>
   <body class="<%= render_body_class %>">
     <nav id="skip-link" role="navigation" aria-label="<%= t('blacklight.skip_links.label') %>">

data/app/views/record_mailer/email_record.text.erb

@@ -1,6 +1,7 @@
+<%= t('blacklight.email.text.message', message: @message) %>
+
 <% @documents.each do |document| %>
-<%= document.to_email_text %>
-<%= t('blacklight.email.text.url', :url =>polymorphic_url(document, @url_gen_params)) %>
+  <%= render Blacklight::DocumentMetadataComponent.new(fields: document_presenter(document).field_presenters(blacklight_config.email_fields), tag: nil, field_layout: Blacklight::MetadataFieldPlainTextLayoutComponent, field_presenter_options: { format: 'text' }) %>
 
+  <%= t('blacklight.email.text.url', url: polymorphic_url(document, @url_gen_params)) %>
 <% end %>
-<%= t('blacklight.email.text.message', :message => @message) %>

data/app/views/record_mailer/sms_record.text.erb

@@ -1,4 +1,4 @@
-<% @documents.each do |document| %>
-<%= document.to_sms_text(@config) %>
-<%= t('blacklight.sms.text.url', :url => polymorphic_url(document, @url_gen_params) ) %>
-<% end %>
+<% @documents.each do |document| %>
+  <%= render Blacklight::DocumentMetadataComponent.new(fields: document_presenter(document).field_presenters(blacklight_config.sms_fields), tag: nil, field_layout: Blacklight::MetadataFieldPlainTextLayoutComponent, field_presenter_options: { format: 'text' }) %>
+  <%= t('blacklight.sms.text.url', url: polymorphic_url(document, @url_gen_params)) %>
+<% end %>

data/blacklight.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
     full text and/or metadata.)
   s.license     = "Apache 2.0"
 
-  s.files         = `git ls-files -z`.split("\x0")
+  s.files         = `git ls-files -z`.split("\x0") + Dir.glob("app/assets/javascripts/blacklight/**/*")
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.bindir        = 'exe'
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "i18n", '>= 1.7.0' # added named parameters
   s.add_dependency "ostruct", '>= 0.3.2'
-  s.add_dependency "view_component", '~> 2.66'
+  s.add_dependency "view_component", '>= 2.66', '< 3.1'
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
   s.add_development_dependency "rspec-rails", "~> 6.0"

data/config/importmap.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-pin_all_from File.expand_path("../app/javascript/blacklight", __dir__)
+pin_all_from File.expand_path("../app/javascript/blacklight", __dir__), under: "blacklight"