blacklight 7.0.0.rc1 → 7.0.0.rc2

data/app/javascript/blacklight/core.js

@@ -19,21 +19,23 @@ Blacklight = function() {
           listeners.push('turbolinks:load');
         } else {
           // Turbolinks < 5
-          listeners.push('page:load', 'ready');
+          listeners.push('page:load', 'DOMContentLoaded');
         }
       } else {
-        listeners.push('ready');
+        listeners.push('DOMContentLoaded');
       }
 
-      return listeners.join(' ');
+      return listeners;
     }
   };
 }();
 
 // turbolinks triggers page:load events on page transition
 // If app isn't using turbolinks, this event will never be triggered, no prob.
-$(document).on(Blacklight.listeners(), function() {
-  Blacklight.activate();
-});
+Blacklight.listeners().forEach(function(listener) {
+  document.addEventListener(listener, function() {
+    Blacklight.activate()
+  })
+})
 
 $('.no-js').removeClass('no-js').addClass('js');

data/app/javascript/blacklight/modal.js

@@ -1,5 +1,3 @@
-//= require blacklight/core
-
 /*
   The blacklight modal plugin can display some interactions inside a Bootstrap
   modal window, including some multi-page interactions.
@@ -119,7 +117,7 @@ Blacklight.modal.receiveAjax = function (contents) {
     // code modelled off of JQuery ajax.load. https://github.com/jquery/jquery/blob/master/src/ajax/load.js?source=c#L62
     var container =  $('<div>').
       append( jQuery.parseHTML(contents) ).find( Blacklight.modal.containerSelector ).first();
-    if (container.size() !== 0) {
+    if (container.length !== 0) {
       contents = container.html();
     }
 

data/app/javascript/blacklight/search_context.js

@@ -1,4 +1,3 @@
-//= require blacklight/core
 (function($) {
   Blacklight.doSearchContextBehavior = function() {
     if (typeof Blacklight.do_search_context_behavior == 'function') {

data/app/models/blacklight/icon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   class Icon
     attr_reader :icon_name
@@ -35,6 +37,7 @@ module Blacklight
     # @return [String]
     def file_source
       raise Blacklight::Exceptions::IconNotFound, "Could not find #{path}" if file.blank?
+
       file.source.force_encoding('UTF-8')
     end
 

data/app/models/blacklight/suggest_search.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+
 module Blacklight
   class SuggestSearch
     attr_reader :request_params, :repository
 
     ##
     # @param [Hash] params
+    # @param [Blacklight::AbstractRepository] repository
     def initialize(params, repository)
       @request_params = { q: params[:q] }
       @repository = repository
@@ -15,20 +17,7 @@ module Blacklight
     # Blacklight::Suggest::Response
     # @return [Blacklight::Suggest::Response]
     def suggestions
-      Blacklight::Suggest::Response.new suggest_results, request_params, suggest_handler_path
-    end
-
-    ##
-    # Query the suggest handler using RSolr::Client::send_and_receive
-    # @return [RSolr::HashWithResponse]
-    def suggest_results
-      repository.connection.send_and_receive(suggest_handler_path, params: request_params)
-    end
-
-    ##
-    # @return [String]
-    def suggest_handler_path
-      repository.blacklight_config.autocomplete_path
+      repository.suggestions(request_params)
     end
   end
 end

data/app/models/bookmark.rb

@@ -13,7 +13,7 @@ class Bookmark < ApplicationRecord
   def document_type
     value = super if defined?(super)
     value &&= value.constantize
-    value ||= default_document_type
+    value || default_document_type
   end
 
   def default_document_type

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
-##
+
+require 'globalid'
+
 ##
 # = Introduction
 # Blacklight::Document is the module with logic for a class representing

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

@@ -25,6 +25,7 @@ module Blacklight::Solr::Document
 
   def has_highlight_field? k
     return false if response['highlighting'].blank? || response['highlighting'][id].blank?
+
     response['highlighting'][id].key? k.to_s
   end
 

data/app/models/concerns/blacklight/suggest/response.rb

@@ -2,17 +2,19 @@
 module Blacklight
   module Suggest
     class Response
-      attr_reader :response, :request_params, :suggest_path
+      attr_reader :response, :request_params, :suggest_path, :suggester_name
 
       ##
       # Creates a suggest response
       # @param [RSolr::HashWithResponse] response
       # @param [Hash] request_params
       # @param [String] suggest_path
-      def initialize(response, request_params, suggest_path)
+      # @param [String] suggester_name
+      def initialize(response, request_params, suggest_path, suggester_name)
         @response = response
         @request_params = request_params
         @suggest_path = suggest_path
+        @suggester_name = suggester_name
       end
 
       ##
@@ -20,7 +22,7 @@ module Blacklight
       # present
       # @return [Array]
       def suggestions
-        response.try(:[], suggest_path).try(:[], 'mySuggester').try(:[], request_params[:q]).try(:[], 'suggestions') || []
+        (response.try(:[], suggest_path).try(:[], suggester_name).try(:[], request_params[:q]).try(:[], 'suggestions') || []).uniq
       end
     end
   end

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

@@ -6,6 +6,7 @@ module Blacklight::User
   # is injected into the hosting application through ActiveRecord::Base extend
   def self.included(base)
     return unless base.respond_to? :has_many
+
     base.send :has_many, :bookmarks, dependent: :destroy, as: :user
     base.send :has_many, :searches,  dependent: :destroy, as: :user
   end

data/app/models/search.rb

@@ -14,6 +14,7 @@ class Search < ApplicationRecord
   def self.delete_old_searches(days_old)
     raise ArgumentError, 'days_old is expected to be a number' unless days_old.is_a?(Numeric)
     raise ArgumentError, 'days_old is expected to be greater than 0' if days_old <= 0
+
     where(['created_at < ? AND user_id IS NULL', Time.zone.today - days_old]).destroy_all
   end
 end

data/app/presenters/blacklight/document_presenter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # An abstract class that the view presenters for SolrDocuments descend from
+  class DocumentPresenter
+    attr_reader :document, :configuration, :view_context
+
+    # @return [Hash<String,Configuration::Field>]  all the fields for this index view that should be rendered
+    def fields_to_render
+      fields.select do |_name, field_config|
+        # rubocop:disable Style/PreferredHashMethods
+        render_field?(field_config) && has_value?(field_config)
+        # rubocop:enable Style/PreferredHashMethods
+      end
+    end
+
+    private
+
+    ##
+    # Check to see if the given field should be rendered in this context
+    # @param [Blacklight::Configuration::Field] field_config
+    # @return [Boolean]
+    def render_field?(field_config)
+      view_context.should_render_field?(field_config, document)
+    end
+
+    ##
+    # Check if a document has (or, might have, in the case of accessor methods) a value for
+    # the given solr field
+    # @param [Blacklight::Configuration::Field] field_config
+    # @return [Boolean]
+    def has_value? field_config
+      document.has?(field_config.field) ||
+        (document.has_highlight_field? field_config.field if field_config.highlight) ||
+        field_config.accessor
+    end
+  end
+end

data/app/presenters/blacklight/field_presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   # Renders a field and handles link_to_facet or helper_method if supplied
   class FieldPresenter

data/app/presenters/blacklight/index_presenter.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 module Blacklight
-  class IndexPresenter
+  class IndexPresenter < DocumentPresenter
     class_attribute :thumbnail_presenter
     self.thumbnail_presenter = ThumbnailPresenter
 
-    attr_reader :document, :configuration, :view_context, :view_config
+    attr_reader :view_config
 
     # @param [SolrDocument] document
     # @param [ActionView::Base] view_context scope for linking and generating urls
@@ -29,8 +29,12 @@ module Blacklight
                   config = field_config(field_or_string_or_proc)
                   document[field_or_string_or_proc]
                 when Proc
+                  Deprecation.warn(self, "calling IndexPresenter.label with a Proc is deprecated. " \
+                                         "First argument must be a symbol. This will be removed in Blacklight 8")
                   field_or_string_or_proc.call(document, opts)
                 when String
+                  Deprecation.warn(self, "calling IndexPresenter.label with a String is deprecated. " \
+                                         "First argument must be a symbol. This will be removed in Blacklight 8")
                   field_or_string_or_proc
               end
 
@@ -43,12 +47,11 @@ module Blacklight
     #
     # Allow an extention point where information in the document
     # may drive the value of the field
-    # @param [String] field
+    # @param [Configuration::Field] field
     # @param [Hash] options
     # @option options [String] :value
     def field_value field, options = {}
-      field_config = field_config(field)
-      field_values(field_config, options)
+      field_values(field, options)
     end
 
     def thumbnail
@@ -57,6 +60,11 @@ module Blacklight
 
     private
 
+    # @return [Hash<String,Configuration::Field>] all the fields for this index view
+    def fields
+      configuration.index_fields_for(document)
+    end
+
     ##
     # Get the value for a document's field, and prepare to render it.
     # - highlight_field

data/app/presenters/blacklight/json_presenter.rb

@@ -4,10 +4,9 @@ module Blacklight
     include Blacklight::Facet
 
     # @param [Solr::Response] response raw solr response.
-    # @param [Array] facets list of facets
-    def initialize(response, facets, blacklight_config)
+    # @param [Configuration] blacklight_config the configuration
+    def initialize(response, blacklight_config)
       @response = response
-      @facets = facets
       @blacklight_config = blacklight_config
     end
 
@@ -17,15 +16,9 @@ module Blacklight
       @response.documents
     end
 
-    def search_facets_as_json
-      @facets.as_json.each do |f|
-        f.stringify_keys!
-        f.delete "options"
-        f["label"] = facet_configuration_for_field(f["name"]).label
-        f["items"] = f["items"].as_json.each do |i|
-          i['label'] ||= i['value']
-        end
-      end
+    # @return [Array<Blacklight::Solr::Response::Facets::FacetField>]
+    def search_facets
+      facets_from_request.select { |display_facet| display_facet.items.present? }
     end
 
     # extract the pagination info from the response object

data/app/presenters/blacklight/link_alternate_presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   # Create <link rel="alternate"> links from a documents dynamically
   class LinkAlternatePresenter

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class AbstractStep

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class HelperMethod < AbstractStep

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class Join < AbstractStep

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

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class LinkToFacet < AbstractStep
       extend Deprecation
       def render
         return next_step(values) unless config.link_to_facet
+
         next_step(render_link)
       end
 
@@ -16,6 +19,7 @@ module Blacklight
 
       def link_field
         return config.key if config.link_to_facet == true
+
         config.link_to_facet
       end
 

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

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class Microdata < AbstractStep
       include ActionView::Helpers::TagHelper
       def render
         return next_step(values) unless config.itemprop
+
         next_step(values.map { |x| itemprop(x, config.itemprop) })
       end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     # The field rendering pipeline

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   module Rendering
     class Terminator < AbstractStep

data/app/presenters/blacklight/search_bar_presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   class SearchBarPresenter
     attr_reader :configuration, :view_context, :controller

data/app/presenters/blacklight/show_presenter.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 module Blacklight
-  class ShowPresenter
-    attr_reader :document, :configuration, :view_context
-
+  class ShowPresenter < DocumentPresenter
     # @param [SolrDocument] document
     # @param [ActionView::Base] view_context scope for linking and generating urls
     # @param [Blacklight::Configuration] configuration
@@ -58,15 +56,20 @@ module Blacklight
     #
     # Allow an extention point where information in the document
     # may drive the value of the field
-    # @param [String] field
+    # @param [Configuration::Field] field
     # @param [Hash] options
     # @option options [String] :value
     def field_value field, options = {}
-      field_values(field_config(field), options)
+      field_values(field, options)
     end
 
     private
 
+    # @return [Hash<String,Configuration::Field>]
+    def fields
+      configuration.show_fields_for(document)
+    end
+
     ##
     # Get the value for a document's field, and prepare to render it.
     # - highlight_field

data/app/presenters/blacklight/thumbnail_presenter.rb

@@ -6,6 +6,7 @@ module Blacklight
 
     # @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
@@ -33,6 +34,7 @@ module Blacklight
     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
 

data/app/services/blacklight/document_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   class DocumentFactory
     def self.build(data, response, options)