blacklight 8.0.0.beta4 → 8.0.0.beta5

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.with_partial do %>
-      <%= render_document_partial document, partial, component: component, document_counter: document_counter %>
-    <% end %>
-  <% end %>
-<% end %>
+<% document_component = blacklight_config.view_config(:show).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/_show_main_content.html.erb

@@ -1,9 +1,9 @@
-<%= 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| %>
+<% 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) %>
@@ -11,10 +11,4 @@
       <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.with_partial do %>
-      <%= render_document_partial @document, partial, component: component %>
-    <% end %>
-  <% end %>
 <% end %>

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/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/config/locales/blacklight.ar.yml

@@ -101,10 +101,6 @@ ar:
         submit: 'إرسال'
       text:
         default_title: 'لا يوجد'
-        title: 'العنوان: %{value}'
-        author: 'المؤلف: %{value}'
-        format: 'الصيغة: %{value}'
-        language: 'اللغة: %{value}'
         subject:
           zero: 'لا يوجد سجل للمادة'
           one: 'سجل المادة: %{title}'
@@ -130,8 +126,6 @@ ar:
         carrier_prompt: 'يرجى تحديد شركة الاتصالات'
         submit: 'إرسال'
       text:
-        title: '%{value}'
-        author: ' بواسطة %{value}'
         url: 'الرابط: %{url}'
       success: "تم الإرسال كرسالة نصية قصيرة"
       errors:

data/config/locales/blacklight.ca.yml

@@ -96,10 +96,6 @@ ca:
         submit: 'Enviar-ho'
       text:
         default_title: 'N/A'
-        title: 'Títol: %{value}'
-        author: 'Autor: %{value}'
-        format: 'Format: %{value}'
-        language: 'Llengua: %{value}'
         subject:
           one: 'Registre: %{title}'
           other: 'Registres'
@@ -120,8 +116,6 @@ ca:
         carrier_prompt: 'Heu de seleccionar un operador'
         submit: 'Enviar'
       text:
-        title: '%{value}'
-        author: ' de %{value}'
         url: 'URL: %{url}'
       success: "SMS enviat"
       errors:

data/config/locales/blacklight.de.yml

@@ -96,10 +96,6 @@ de:
         submit: 'Senden'
       text:
         default_title: 'N/A'
-        title: 'Titel: %{value}'
-        author: 'Autor: %{value}'
-        format: 'Format: %{value}'
-        language: 'Sprache: %{value}'
         subject:
           one: 'Artikeldatensatz: %{title}'
           other: 'Artikeldatensätze'
@@ -120,8 +116,6 @@ de:
         carrier_prompt: 'Bitte wählen Sie Ihren Netzbetreiber aus'
         submit: 'Schicken'
       text:
-        title: '%{value}'
-        author: ' von %{value}'
         url: 'Link: %{url}'
       success: "SMS verschickt"
       errors:

data/config/locales/blacklight.en.yml

@@ -96,10 +96,6 @@ en:
         submit: 'Send'
       text:
         default_title: 'N/A'
-        title: 'Title: %{value}'
-        author: 'Author: %{value}'
-        format: 'Format: %{value}'
-        language: 'Language: %{value}'
         subject:
           one: 'Item Record: %{title}'
           other: 'Item records'
@@ -120,8 +116,6 @@ en:
         carrier_prompt: 'Please select your carrier'
         submit: 'Send'
       text:
-        title: '%{value}'
-        author: ' by %{value}'
         url: 'Link: %{url}'
       success: "SMS Sent"
       errors:

data/config/locales/blacklight.es.yml

@@ -96,10 +96,6 @@ es:
         submit: 'Enviar'
       text:
         default_title: 'N/A'
-        title: 'Titulo: %{value}'
-        author: 'Autor: %{value}'
-        format: 'Formato: %{value}'
-        language: 'Idioma: %{value}'
         subject:
           one: 'Ficha artículo: %{title}'
           other: 'Ficha artículos'
@@ -120,8 +116,6 @@ es:
         carrier_prompt: 'Por favor, seleccione su compañía telefónica'
         submit: 'Enviar'
       text:
-        title: '%{value}'
-        author: 'por %{value}'
         url: 'Link: %{url}'
       success: "SMS enviado"
       errors:

data/config/locales/blacklight.fr.yml

@@ -96,10 +96,6 @@ fr:
         submit: 'Envoyer'
       text:
         default_title: 'N/A'
-        title: 'Titre : %{value}'
-        author: 'Auteur : %{value}'
-        format: 'Format : %{value}'
-        language: 'Langue : %{value}'
         subject:
           one: 'Une référence : %{title}'
           other: 'Des références bibliographiques'
@@ -121,8 +117,6 @@ fr:
         carrier_prompt: 'Veuillez choisir votre opérateur'
         submit: 'Envoyer'
       text:
-        title: '%{value}'
-        author: ' by %{value}'
         url: 'Lien : %{url}'
 
       success: "SMS envoyé"

data/config/locales/blacklight.hu.yml

@@ -96,10 +96,6 @@ hu:
         submit: 'Küldés'
       text:
         default_title: 'N/A'
-        title: 'Cím: %{value}'
-        author: 'Szerző: %{value}'
-        format: 'Formátum: %{value}'
-        language: 'Nyelv: %{value}'
         subject:
           one: 'Adatrekord: %{title}'
           other: 'Adatrekordok'
@@ -120,8 +116,6 @@ hu:
         carrier_prompt: 'Kérjük válassza ki a szolgáltatót'
         submit: 'Küldés'
       text:
-        title: '%{value}'
-        author: ' írta %{value}'
         url: 'Link: %{url}'
       success: "SMS elküldve"
       errors:

data/config/locales/blacklight.it.yml

@@ -96,10 +96,6 @@ it:
         submit: 'Invia'
       text:
         default_title: 'N/A'
-        title: 'Titolo: %{value}'
-        author: 'Autore: %{value}'
-        format: 'Formato: %{value}'
-        language: 'Lingua: %{value}'
         subject:
           one: 'Numero di scheda: %{title}'
           other: 'Numeri di scheda'
@@ -120,8 +116,6 @@ it:
         carrier_prompt: "Indicare l'operatore"
         submit: 'Inviare'
       text:
-        title: '%{value}'
-        author: ' da %{value}'
         url: 'Link: %{url}'
       success: "SMS inviato"
       errors:

data/config/locales/blacklight.nl.yml

@@ -96,10 +96,6 @@ nl:
         submit: 'Verzenden'
       text:
         default_title: 'N/A'
-        title: 'Titel: %{value}'
-        author: 'Auteur: %{value}'
-        format: 'Formaat: %{value}'
-        language: 'Taal: %{value}'
         subject:
           one: 'Item Record: %{title}'
           other: 'Item records'
@@ -120,8 +116,6 @@ nl:
         carrier_prompt: 'Gelieve uw carrier op te geven.'
         submit: 'Verzenden'
       text:
-        title: '%{value}'
-        author: ' door %{value}'
         url: 'Link: %{url}'
       success: "SMS Verzonden"
       errors:

data/config/locales/blacklight.pt-BR.yml

@@ -97,10 +97,6 @@ pt-BR:
         submit: 'Enviar'
       text:
         default_title: 'N/A'
-        title: 'Título: %{value}'
-        author: 'Autor: %{value}'
-        format: 'Formato: %{value}'
-        language: 'Idioma: %{value}'
         subject:
           one: 'Item: %{title}'
           other: 'Itens'
@@ -121,8 +117,6 @@ pt-BR:
         carrier_prompt: 'Selecione a Operadora'
         submit: 'Enviar'
       text:
-        title: '%{value}'
-        author: ' por %{value}'
         url: 'Link: %{url}'
       success: 'SMS Enviado'
       errors:

data/config/locales/blacklight.sq.yml

@@ -96,10 +96,6 @@ sq:
         submit: 'Dërgo'
       text:
         default_title: 'N/A'
-        title: 'Titulli: %{value}'
-        author: 'Autori: %{value}'
-        format: 'Formati: %{value}'
-        language: 'Gjuha: %{value}'
         subject:
           one: 'Item Record: %{title}'
           other: 'Item records'
@@ -120,8 +116,6 @@ sq:
         carrier_prompt: 'Ju lutemi zgjedheni operatorin'
         submit: 'Dërgo'
       text:
-        title: '%{value}'
-        author: ' nga %{value}'
         url: 'Link: %{url}'
       success: "SMS-i u dëgua"
       errors:

data/config/locales/blacklight.zh.yml

@@ -96,10 +96,6 @@ zh:
         submit: '发送'
       text:
         default_title: '无'
-        title: '标题: %{value}'
-        author: '作者: %{value}'
-        format: '格式: %{value}'
-        language: '语言: %{value}'
         subject:
           one: '记录: %{title}'
           other: '记录'
@@ -120,8 +116,6 @@ zh:
         carrier_prompt: '请选择运营商'
         submit: '发送'
       text:
-        title: '%{value}'
-        author: ' 来自 %{value}'
         url: '链接: %{url}'
       success: "已发送短信"
       errors:

data/lib/blacklight/configuration/session_tracking_config.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Blacklight::Configuration
+  class SessionTrackingConfig < Blacklight::OpenStructWithHashAccess
+    # @!attribute storage
+    #   @return [String, FalseClass] 'server': use server-side tracking; 'client': delegate search tracking and prev/next navigation to client
+    # @!attribute applied_params_component
+    #   @return [Class] component class used to render a facet group
+    # @!attribute item_pagination_component
+    #   @return [Class] component class used to render the constraints
+
+    def initialize(property_hash = {})
+      super({ storage: 'server' }.merge(property_hash))
+    end
+
+    def applied_params_component
+      super || default_applied_params_component(storage)
+    end
+
+    def item_pagination_component
+      super || default_item_pagination_component(storage)
+    end
+
+    def url_helper
+      super || default_url_helper(storage)
+    end
+
+    def default_applied_params_component(storage)
+      return Blacklight::SearchContext::ServerAppliedParamsComponent if storage == 'server'
+
+      nil
+    end
+
+    def default_item_pagination_component(storage)
+      return Blacklight::SearchContext::ServerItemPaginationComponent if storage == 'server'
+
+      nil
+    end
+
+    # extension point for alternative storage types
+    def default_url_helper(_storage)
+      nil
+    end
+  end
+end

data/lib/blacklight/configuration.rb

@@ -20,6 +20,7 @@ module Blacklight
       autoload :DisplayField
       autoload :IndexField
       autoload :ShowField
+      autoload :SessionTrackingConfig
     end
 
     class_attribute :default_values, default: {}
@@ -200,7 +201,9 @@ module Blacklight
         ViewConfig,
         default: { top_level_config: :index },
         show: { top_level_config: :show },
-        citation: { parent_config: :show }
+        citation: { parent_config: :show },
+        email_record: { top_level_config: :email },
+        sms_record: { top_level_config: :sms }
       )
 
       # @!attribute sms
@@ -279,9 +282,10 @@ module Blacklight
       property :raw_endpoint, default: OpenStructWithHashAccess.new(enabled: false)
 
       # @!attribute track_search_session
-      # @since v7.1.0
-      # @return [Boolean]
-      property :track_search_session, default: true
+      # { storage: false } value: do no tracking
+      # @since v8.0.0
+      # @return [Blacklight::Configuration::SessionTrackingConfig]
+      property :track_search_session, default: Blacklight::Configuration::SessionTrackingConfig.new
 
       # @!attribute advanced_search
       # @since v7.15.0

data/lib/blacklight/routes/searchable.rb

@@ -10,6 +10,7 @@ module Blacklight
       def call(mapper, _options = {})
         mapper.match '/', action: 'index', as: 'search', via: [:get, :post]
         mapper.get '/advanced', action: 'advanced_search', as: 'advanced_search'
+        mapper.get '/page_links', action: 'page_links', as: 'page_links'
 
         mapper.post ":id/track", action: 'track', as: 'track'
         mapper.get ":id/raw", action: 'raw', as: 'raw', defaults: { format: 'json' }

data/lib/generators/blacklight/templates/solr_document.rb

@@ -6,12 +6,6 @@ class <%= model_name.classify %>
 
   # self.unique_key = 'id'
 
-  # Email uses the semantic field mappings below to generate the body of an email.
-  SolrDocument.use_extension(Blacklight::Document::Email)
-
-  # SMS uses the semantic field mappings below to generate the body of an SMS email.
-  SolrDocument.use_extension(Blacklight::Document::Sms)
-
   # DublinCore uses the semantic field mappings below to assemble an OAI-compliant Dublin Core document
   # Semantic mappings of solr stored fields. Fields may be multi or
   # single valued. See Blacklight::Document::SemanticFields#field_semantics

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "8.0.0-beta.4",
+  "version": "8.0.0-beta.5",
   "description": "[![Build Status](https://travis-ci.com/projectblacklight/blacklight.png?branch=main)](https://travis-ci.com/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=main)](https://coveralls.io/github/projectblacklight/blacklight?branch=main)",
   "main": "app/assets/javascripts/blacklight",
   "scripts": {