blacklight 6.21.0 → 7.3.0

data/app/presenters/blacklight/thumbnail_presenter.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class ThumbnailPresenter
+    attr_reader :document, :view_context, :view_config
+
+    # @param [SolrDocument] document
+    # @param [ActionView::Base] view_context scope for linking and generating urls
+    #                                        as well as for invoking "thumbnail_method"
+    # @param [Blacklight::Configuration::ViewConfig] view_config
+    def initialize(document, view_context, view_config)
+      @document = document
+      @view_context = view_context
+      @view_config = view_config
+    end
+
+    ##
+    # Does the document have a thumbnail to render?
+    #
+    # @return [Boolean]
+    def exists?
+      thumbnail_method.present? ||
+        (thumbnail_field && thumbnail_value_from_document(document).present?) ||
+        default_thumbnail.present?
+    end
+
+    ##
+    # Render the thumbnail, if available, for a document and
+    # link it to the document record.
+    #
+    # @param [Hash] image_options to pass to the image tag
+    # @param [Hash] url_options to pass to #link_to_document
+    # @return [String]
+    def thumbnail_tag image_options = {}, url_options = {}
+      value = thumbnail_value(image_options)
+      return value if value.nil? || url_options[:suppress_link]
+
+      view_context.link_to_document document, value, url_options
+    end
+
+    private
+
+    delegate :thumbnail_field, :thumbnail_method, :default_thumbnail, to: :view_config
+
+    # @param [Hash] image_options to pass to the image tag
+    def thumbnail_value(image_options)
+      value = if thumbnail_method
+                view_context.send(thumbnail_method, document, image_options)
+              elsif thumbnail_field
+                image_url = thumbnail_value_from_document(document)
+                view_context.image_tag image_url, image_options if image_url.present?
+              end
+
+      value || default_thumbnail_value(image_options)
+    end
+
+    def default_thumbnail_value(image_options)
+      return unless default_thumbnail
+
+      case default_thumbnail
+      when Symbol
+        view_context.send(default_thumbnail, document, image_options)
+      when Proc
+        default_thumbnail.call(document, image_options)
+      else
+        view_context.image_tag default_thumbnail, image_options
+      end
+    end
+
+    def thumbnail_value_from_document(document)
+      Array(thumbnail_field).lazy.map { |field| document.first(field) }.reject(&:blank?).first
+    end
+  end
+end

data/app/services/blacklight/document_factory.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class DocumentFactory
+    def self.build(data, response, options)
+      document_model(data, options).new(data, response)
+    end
+
+    def self.document_model(_data, options)
+      options[:solr_document_model] || options[:document_model] || SolrDocument
+    end
+  end
+end

data/app/services/blacklight/field_retriever.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   class FieldRetriever
     # @param [SolrDocument] document
@@ -9,7 +11,7 @@ module Blacklight
 
     attr_reader :document, :field_config
     delegate :field, to: :field_config
-    
+
     # @return [Array]
     def fetch
       Array.wrap(
@@ -25,33 +27,33 @@ module Blacklight
 
     private
 
-      def retrieve_simple
-        # regular document field
-        if field_config.default and field_config.default.is_a? Proc
-          document.fetch(field_config.field, &field_config.default)
-        else
-          document.fetch(field_config.field, field_config.default)
-        end
+    def retrieve_simple
+      # regular document field
+      if field_config.default && field_config.default.is_a?(Proc)
+        document.fetch(field_config.field, &field_config.default)
+      else
+        document.fetch(field_config.field, field_config.default)
       end
+    end
 
-      def retieve_using_accessor
-        # implicit method call
-        if field_config.accessor == true
-          document.send(field)
-        # arity-1 method call (include the field name in the call)
-        elsif !field_config.accessor.is_a?(Array) && document.method(field_config.accessor).arity.nonzero?
-          document.send(field_config.accessor, field)
-        # chained method calls
-        else
-          Array(field_config.accessor).inject(document) do |result, method|
-            result.send(method)
-          end
+    def retieve_using_accessor
+      # implicit method call
+      if field_config.accessor == true
+        document.send(field)
+      # arity-1 method call (include the field name in the call)
+      elsif !field_config.accessor.is_a?(Array) && document.method(field_config.accessor).arity.nonzero?
+        document.send(field_config.accessor, field)
+      # chained method calls
+      else
+        Array(field_config.accessor).inject(document) do |result, method|
+          result.send(method)
         end
       end
+    end
 
-      def retrieve_highlight
-        # retrieve the document value from the highlighting response
-        document.highlight_field(field_config.field).map(&:html_safe) if document.has_highlight_field? field_config.field
-      end
+    def retrieve_highlight
+      # retrieve the document value from the highlighting response
+      document.highlight_field(field_config.field).map(&:html_safe) if document.has_highlight_field? field_config.field
+    end
   end
 end

data/app/services/blacklight/search_service.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+# SearchService returns search results from the repository
+module Blacklight
+  class SearchService
+    def initialize(config:, user_params: {}, search_builder_class: config.search_builder_class, **context)
+      @blacklight_config = config
+      @user_params = user_params
+      @search_builder_class = search_builder_class
+      @context = context
+    end
+
+    # The blacklight_config + controller are accessed by the search_builder
+    attr_reader :blacklight_config, :context
+
+    def search_builder
+      search_builder_class.new(self)
+    end
+
+    # a solr query method
+    # @param [Hash] user_params ({}) the user provided parameters (e.g. query, facets, sort, etc)
+    # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used.
+    # @return [Blacklight::Solr::Response] the solr response object
+    def search_results
+      builder = search_builder.with(user_params)
+      builder.page = user_params[:page] if user_params[:page]
+      builder.rows = (user_params[:per_page] || user_params[:rows]) if user_params[:per_page] || user_params[:rows]
+
+      builder = yield(builder) if block_given?
+      response = repository.search(builder)
+
+      if response.grouped? && grouped_key_for_results
+        [response.group(grouped_key_for_results), []]
+      elsif response.grouped? && response.grouped.length == 1
+        [response.grouped.first, []]
+      else
+        [response, response.documents]
+      end
+    end
+
+    # retrieve a document, given the doc id
+    # @param [Array{#to_s},#to_s] id
+    # @return [Blacklight::Solr::Response, Blacklight::SolrDocument] the solr response object and the first document
+    def fetch(id = nil, extra_controller_params = {})
+      if id.is_a? Array
+        fetch_many(id, extra_controller_params)
+      else
+        fetch_one(id, extra_controller_params)
+      end
+    end
+
+    ##
+    # Get the solr response when retrieving only a single facet field
+    # @return [Blacklight::Solr::Response] the solr response
+    def facet_field_response(facet_field, extra_controller_params = {})
+      query = search_builder.with(user_params).facet(facet_field)
+      repository.search(query.merge(extra_controller_params))
+    end
+
+    # Get the previous and next document from a search result
+    # @return [Blacklight::Solr::Response, Array<Blacklight::SolrDocument>] the solr response and a list of the first and last document
+    def previous_and_next_documents_for_search(index, request_params, extra_controller_params = {})
+      p = previous_and_next_document_params(index)
+      query = search_builder.with(request_params).start(p.delete(:start)).rows(p.delete(:rows)).merge(extra_controller_params).merge(p)
+      response = repository.search(query)
+      document_list = response.documents
+
+      # only get the previous doc if there is one
+      prev_doc = document_list.first if index > 0
+      next_doc = document_list.last if (index + 1) < response.total
+      [response, [prev_doc, next_doc]]
+    end
+
+    # a solr query method
+    # does a standard search but returns a simplified object.
+    # an array is returned, the first item is the query string,
+    # the second item is an other array. This second array contains
+    # all of the field values for each of the documents...
+    # where the field is the "field" argument passed in.
+    def opensearch_response(field = nil, extra_controller_params = {})
+      field ||= blacklight_config.view_config(:opensearch).title_field
+
+      query = search_builder.with(user_params).merge(solr_opensearch_params(field)).merge(extra_controller_params)
+      response = repository.search(query)
+
+      [user_params[:q], response.documents.flat_map { |doc| doc[field] }.uniq]
+    end
+
+    private
+
+    attr_reader :search_builder_class, :user_params
+    delegate :repository, to: :blacklight_config
+
+    ##
+    # The key to use to retrieve the grouped field to display
+    def grouped_key_for_results
+      blacklight_config.index.group
+    end
+
+    ##
+    # Opensearch autocomplete parameters for plucking a field's value from the results
+    def solr_opensearch_params(field)
+      solr_params = {}
+      solr_params[:rows] ||= 10
+      solr_params[:fl] = field || blacklight_config.view_config(:opensearch).title_field
+      solr_params
+    end
+
+    ##
+    # Pagination parameters for selecting the previous and next documents
+    # out of a result set.
+    def previous_and_next_document_params(index, window = 1)
+      solr_params = blacklight_config.document_pagination_params.dup
+
+      if solr_params.empty?
+        solr_params[:fl] = blacklight_config.document_model.unique_key
+      end
+
+      if index > 0
+        solr_params[:start] = index - window # get one before
+        solr_params[:rows] = 2 * window + 1 # and one after
+      else
+        solr_params[:start] = 0 # there is no previous doc
+        solr_params[:rows] = 2 * window # but there should be one after
+      end
+
+      solr_params[:facet] = false
+      solr_params
+    end
+
+    ##
+    # Retrieve a set of documents by id
+    # @param [Array] ids
+    # @param [HashWithIndifferentAccess] extra_controller_params
+    def fetch_many(ids, extra_controller_params)
+      extra_controller_params ||= {}
+
+      query = search_builder
+              .with(user_params)
+              .where(blacklight_config.document_model.unique_key => ids)
+              .merge(blacklight_config.fetch_many_document_params)
+              .merge(extra_controller_params)
+
+      solr_response = repository.search(query)
+
+      [solr_response, solr_response.documents]
+    end
+
+    def fetch_one(id, extra_controller_params)
+      solr_response = repository.find id, extra_controller_params
+      [solr_response, solr_response.documents.first]
+    end
+  end
+end

data/app/values/blacklight/types.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # These are data types that blacklight can use to coerce values from the index
+  module Types
+    class Array
+      def self.coerce(input)
+        ::Array.wrap(input)
+      end
+    end
+
+    class String
+      def self.coerce(input)
+        ::Array.wrap(input).first
+      end
+    end
+
+    class Date
+      def self.coerce(input)
+        field = String.coerce(input)
+        return if field.blank?
+
+        begin
+          ::Date.parse(field)
+        rescue ArgumentError
+          Rails.logger.info "Unable to parse date: #{field.first.inspect}"
+        end
+      end
+    end
+  end
+end

data/app/views/blacklight/nav/_bookmark.html.erb

@@ -1,4 +1,4 @@
-<%= link_to bookmarks_path, id:'bookmarks_nav' do %>
+<%= link_to bookmarks_path, id:'bookmarks_nav', class: 'nav-link' do %>
   <%= t('blacklight.header_links.bookmarks') %>
-(<span data-role='bookmark-counter'><%= current_or_guest_user.bookmarks.count %></span>)
+<span class="badge badge-secondary" data-role='bookmark-counter'><%= current_or_guest_user.bookmarks.count %></span>
 <% end %>

data/app/views/blacklight/nav/_search_history.html.erb

@@ -1 +1 @@
-<%= link_to t('blacklight.header_links.search_history'), blacklight.search_history_path %>
+<%= link_to t('blacklight.header_links.search_history'), blacklight.search_history_path, class: 'nav-link' %>

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

@@ -1,6 +1,6 @@
 <ul class="<%= controller_name %>Tools nav nav-pills">
-  <%= render_show_doc_actions document_list, document: nil, document_list: @document_list, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h) do |config, inner| %>
-    <li>
+  <%= render_show_doc_actions document_list, document: nil, document_list: @response.documents, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h) do |config, inner| %>
+    <li class="nav-item">
       <%= inner %>
     </li>
   <% end %>

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

@@ -1,21 +1,20 @@
 <% @page_title = t('blacklight.bookmarks.page_title', :application_name => application_name) %>
 
 <div id="content" class="col-md-12">
-<h2 class='page-heading'><%= t('blacklight.bookmarks.title') %></h2>
+  <h1 class='page-heading'><%= t('blacklight.bookmarks.title') %></h1>
 
-<%- if current_or_guest_user.blank? -%>
+  <%- if current_or_guest_user.blank? -%>
 
-  <h3 class='section-heading'><%= t('blacklight.bookmarks.need_login') %></h3>
+    <h2 class='section-heading'><%= t('blacklight.bookmarks.need_login') %></h2>
 
-<%- elsif @document_list.blank? -%>
+  <%- elsif @response.documents.blank? -%>
 
-  <h3 class='section-heading'><%= t('blacklight.bookmarks.no_bookmarks') %></h3>
-<% else %>
-  <%= render 'sort_and_per_page' %>
-  <%= render partial: 'tools', locals: { document_list: @document_list } %>
-
-  <%= render_document_index %>
-  <%= render 'results_pagination' %>
-<% end %>
+    <h2 class='section-heading'><%= t('blacklight.bookmarks.no_bookmarks') %></h2>
+  <% else %>
+    <%= render 'sort_and_per_page' %>
+    <%= render partial: 'tools', locals: { document_list: @response.documents } %>
+    <h2 class='section-heading sr-only'><%= t('blacklight.bookmarks.list_title') %></h2>
+    <%= render_document_index %>
+    <%= render 'results_pagination' %>
+  <% end %>
 </div>
-

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

@@ -4,19 +4,33 @@
   # but it was simpler to leave them seperate instead of DRYing them, got confusing trying that.
   # the data-doc-id attribute is used by our JS that converts to a checkbox/label.
   -%>
-  <% unless bookmarked? document %>
-
-      <%= form_tag( bookmark_path( document ), :method => :put, :class => "bookmark_toggle", "data-doc-id" => document.id, :'data-present' => t('blacklight.search.bookmarks.present'), :'data-absent' => t('blacklight.search.bookmarks.absent'), :'data-inprogress' => t('blacklight.search.bookmarks.inprogress')) do %>
-        <%= submit_tag(t('blacklight.bookmarks.add.button'), :id => "bookmark_toggle_#{document.id.to_s.parameterize}", :class => "bookmark_add btn btn-default") %>
-      <% end %>
-
+  <% if bookmarked? document %>
+    <%= form_tag(bookmark_path(document),
+                 method: :delete,
+                 class: "bookmark-toggle",
+                 data: {
+                   'doc-id' => document.id,
+                   present: t('blacklight.search.bookmarks.present'),
+                   absent: t('blacklight.search.bookmarks.absent'),
+                   inprogress: t('blacklight.search.bookmarks.inprogress')
+                }) do %>
+      <%= submit_tag(t('blacklight.bookmarks.remove.button'),
+                     id: "bookmark_toggle_#{document.id.to_s.parameterize}",
+                     class: "bookmark-remove btn btn-outline-secondary") %>
+    <% end %>
   <% else %>
-
-      <%= form_tag( bookmark_path( document ), :method => :delete, :class => "bookmark_toggle", "data-doc-id" => document.id, :'data-present' => t('blacklight.search.bookmarks.present'), :'data-absent' => t('blacklight.search.bookmarks.absent'), :'data-inprogress' => t('blacklight.search.bookmarks.inprogress')) do %>
-        <%= submit_tag(t('blacklight.bookmarks.remove.button'), :id => "bookmark_toggle_#{document.id.to_s.parameterize}", :class => "bookmark_remove btn btn-default") %>
-      <% end %>
-
+    <%= form_tag(bookmark_path(document),
+                 method: :put,
+                 class: 'bookmark-toggle',
+                 data: {
+                   'doc-id' => document.id,
+                   present: t('blacklight.search.bookmarks.present'),
+                   absent: t('blacklight.search.bookmarks.absent'),
+                   inprogress: t('blacklight.search.bookmarks.inprogress')
+                 }) do %>
+       <%= submit_tag(t('blacklight.bookmarks.add.button'),
+                      id: "bookmark_toggle_#{document.id.to_s.parameterize}",
+                      class: "bookmark-add btn btn-outline-secondary") %>
+    <% end %>
   <% end %>
-<% else %>
-  &nbsp;
 <% end %>