blacklight 7.0.0.rc1 → 7.0.0.rc2

data/app/controllers/concerns/blacklight/controller.rb

@@ -6,23 +6,25 @@ module Blacklight::Controller
 
   included do
     include Blacklight::SearchFields
-    helper Blacklight::SearchFields
+    helper Blacklight::SearchFields if respond_to? :helper
 
     include ActiveSupport::Callbacks
 
     # now in application.rb file under config.filter_parameters
     # filter_parameter_logging :password, :password_confirmation
-    helper_method :current_user_session, :current_user, :current_or_guest_user
-    after_action :discard_flash_if_xhr
 
     # handle basic authorization exception with #access_denied
     rescue_from Blacklight::Exceptions::AccessDenied, with: :access_denied
 
-    # extra head content
-    helper_method :has_user_authentication_provider?
-    helper_method :blacklight_config, :blacklight_configuration_context
-    helper_method :search_action_url, :search_action_path, :search_facet_path
-    helper_method :search_state
+    if respond_to? :helper_method
+      helper_method :current_user_session, :current_user, :current_or_guest_user
+
+      # extra head content
+      helper_method :has_user_authentication_provider?
+      helper_method :blacklight_config, :blacklight_configuration_context
+      helper_method :search_action_url, :search_action_path, :search_facet_path
+      helper_method :search_state
+    end
 
     # Which class to use for the search state. You can subclass SearchState if you
     # want to override any of the methods (e.g. SearchState#url_for_document)
@@ -38,8 +40,6 @@ module Blacklight::Controller
 
     define_callbacks :logging_in_user
     set_callback :logging_in_user, :before, :transfer_guest_user_actions_to_current_user
-
-    layout :determine_layout
   end
 
   def default_catalog_controller
@@ -95,7 +95,7 @@ module Blacklight::Controller
 
   # Returns a list of Searches from the ids in the user's history.
   def searches_from_history
-    session[:history].blank? ? Search.none : Search.where(id: session[:history]).order("updated_at desc")
+    session[:history].blank? ? ::Search.none : ::Search.where(id: session[:history]).order("updated_at desc")
   end
 
   # Should be provided by authentication provider
@@ -114,13 +114,6 @@ module Blacklight::Controller
   end
   alias blacklight_current_or_guest_user current_or_guest_user
 
-  ##
-  # We discard flash messages generated by the xhr requests to avoid
-  # confusing UX.
-  def discard_flash_if_xhr
-    flash.discard if request.xhr?
-  end
-
   ##
   #
   #
@@ -136,6 +129,7 @@ module Blacklight::Controller
   # When a user logs in, transfer any saved searches or bookmarks to the current_user
   def transfer_guest_user_actions_to_current_user
     return unless respond_to?(:current_user) && respond_to?(:guest_user) && current_user && guest_user
+
     current_user_searches = current_user.searches.pluck(:query_params)
     current_user_bookmarks = current_user.bookmarks.pluck(:document_id)
 

data/app/controllers/concerns/blacklight/facet.rb

@@ -16,10 +16,13 @@ module Blacklight
       )
     end
 
+    # @param fields [Array<String>] a list of facet field names
+    # @return [Array<Solr::Response::Facets::FacetField>]
     def facets_from_request(fields = facet_field_names)
       fields.map { |field| facet_by_field_name(field) }.compact
     end
 
+    # @return [Array<String>] a list of the facet field names from the configuration
     def facet_field_names
       blacklight_config.facet_fields.values.map(&:field)
     end

data/app/controllers/concerns/blacklight/search_context.rb

@@ -2,10 +2,12 @@
 module Blacklight::SearchContext
   extend ActiveSupport::Concern
 
-  # The following code is executed when someone includes blacklight::catalog::search_session in their
+  # The following code is executed when someone includes Blacklight::Catalog::SearchSession in their
   # own controller.
   included do
-    helper_method :current_search_session, :search_session
+    if respond_to? :helper_method
+      helper_method :current_search_session, :search_session
+    end
   end
 
   module ClassMethods
@@ -72,6 +74,7 @@ module Blacklight::SearchContext
   def agent_is_crawler?
     crawler_proc = blacklight_config.crawler_detector
     return false if crawler_proc.nil? || current_user.present?
+
     crawler_proc.call(request)
   end
 
@@ -82,7 +85,7 @@ module Blacklight::SearchContext
 
     saved_search = searches_from_history.find { |x| x.query_params == params_copy }
 
-    saved_search ||= Search.create(query_params: params_copy).tap do |s|
+    saved_search || Search.create(query_params: params_copy).tap do |s|
       add_to_search_history(s)
     end
   end
@@ -115,5 +118,6 @@ module Blacklight::SearchContext
     end
   rescue Blacklight::Exceptions::InvalidRequest => e
     logger.warn "Unable to setup next and previous documents: #{e}"
+    nil
   end
 end

data/app/controllers/concerns/blacklight/search_history.rb

@@ -21,12 +21,7 @@ module Blacklight
         flash[:error] = I18n.t('blacklight.search_history.clear.failure')
       end
 
-      if respond_to? :redirect_back
-        redirect_back fallback_location: blacklight.search_history_path
-      else
-        # Deprecated in Rails 5.0
-        redirect_to :back
-      end
+      redirect_back fallback_location: blacklight.search_history_path
     end
   end
 end

data/app/controllers/concerns/blacklight/token_based_user.rb

@@ -3,7 +3,9 @@ module Blacklight::TokenBasedUser
   extend ActiveSupport::Concern
 
   included do
-    helper_method :encrypt_user_id
+    if respond_to? :helper_method
+      helper_method :encrypt_user_id
+    end
 
     rescue_from Blacklight::Exceptions::ExpiredSessionToken do
       head :unauthorized

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -42,6 +42,7 @@ module Blacklight::BlacklightHelperBehavior
   # @option options [Array<String>] :exclude array of format shortnames to not include in the output
   def render_link_rel_alternates(document = @document, options = {})
     return if document.nil?
+
     presenter(document).link_rel_alternates(options)
   end
 
@@ -85,6 +86,7 @@ module Blacklight::BlacklightHelperBehavior
   # @param [Blacklight::Configuration::Field] field_config
   # @return [Boolean]
   def should_render_index_field? document, field_config
+    Deprecation.warn self, "should_render_index_field? is deprecated and will be removed in Blacklight 8. Use IndexPresenter#render_field? instead."
     should_render_field?(field_config, document) && document_has_value?(document, field_config)
   end
 
@@ -95,6 +97,7 @@ module Blacklight::BlacklightHelperBehavior
   # @param [Blacklight::Configuration::Field] field_config
   # @return [Boolean]
   def should_render_show_field? document, field_config
+    Deprecation.warn self, "should_render_show_field? is deprecated and will be removed in Blacklight 8. Use ShowPresenter#render_field? instead."
     should_render_field?(field_config, document) && document_has_value?(document, field_config)
   end
 
@@ -105,6 +108,7 @@ module Blacklight::BlacklightHelperBehavior
   # @param [Blacklight::Configuration::Field] field_config
   # @return [Boolean]
   def document_has_value? document, field_config
+    Deprecation.warn self, "document_has_value? is deprecated and will be removed in Blacklight 8. Use DocumentPresenter#has_value? instead."
     document.has?(field_config.field) ||
       (document.has_highlight_field? field_config.field if field_config.highlight) ||
       field_config.accessor
@@ -218,7 +222,7 @@ module Blacklight::BlacklightHelperBehavior
   def document_index_view_type query_params = params
     view_param = query_params[:view]
     view_param ||= session[:preferred_view]
-    if view_param && document_index_views.keys.include?(view_param.to_sym)
+    if view_param && document_index_views.key?(view_param.to_sym)
       view_param.to_sym
     else
       default_document_index_view_type

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -6,6 +6,7 @@ module Blacklight::ConfigurationHelperBehavior
   # @param [SolrDocument] document
   # @return [Array<Blacklight::Configuration::Field>]
   def index_fields _document = nil
+    Deprecation.warn(self, "index_fields is deprecated and will be removed in Blacklight 8. Use IndexPresenter#fields instead")
     blacklight_config.index_fields
   end
 
@@ -27,8 +28,9 @@ module Blacklight::ConfigurationHelperBehavior
     end.compact
   end
 
-  # used in the catalog/_show/_default partial
+  # used in the catalog/_show partial
   def document_show_fields _document = nil
+    Deprecation.warn(self, "document_show_fields is deprecated and will be removed in Blacklight 8. Use ShowPresenter#fields instead")
     blacklight_config.show_fields
   end
 
@@ -53,7 +55,7 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # Look up the label for the index field
   def index_field_label document, field
-    field_config = index_fields(document)[field]
+    field_config = blacklight_config.index_fields_for(document)[field]
     field_config ||= Blacklight::Configuration::NullField.new(key: field)
 
     field_config.display_label('index')
@@ -62,7 +64,7 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # Look up the label for the show field
   def document_show_field_label document, field
-    field_config = document_show_fields(document)[field]
+    field_config = blacklight_config.show_fields_for(document)[field]
     field_config ||= Blacklight::Configuration::NullField.new(key: field)
 
     field_config.display_label('show')

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -8,7 +8,7 @@ module Blacklight::FacetsHelperBehavior
   # @param [Array<String>] fields
   # @return [Boolean]
   def has_facet_values? fields = facet_field_names
-    facets_from_request(fields).any? { |display_facet| !display_facet.items.empty? && should_render_facet?(display_facet) }
+    facets_from_request(fields).any? { |display_facet| should_render_facet?(display_facet) }
   end
 
   ##
@@ -36,13 +36,15 @@ module Blacklight::FacetsHelperBehavior
   # @option options [Hash] :locals locals to pass to the partial
   # @return [String]
   def render_facet_limit(display_facet, options = {})
-    return unless should_render_facet?(display_facet)
+    field_config = facet_configuration_for_field(display_facet.name)
+    return unless should_render_facet?(display_facet, field_config)
+
     options = options.dup
     options[:partial] ||= facet_partial_name(display_facet)
     options[:layout] ||= "facet_layout" unless options.key?(:layout)
     options[:locals] ||= {}
     options[:locals][:field_name] ||= display_facet.name
-    options[:locals][:facet_field] ||= facet_configuration_for_field(display_facet.name)
+    options[:locals][:facet_field] ||= field_config
     options[:locals][:display_facet] ||= display_facet
 
     render(options)
@@ -72,12 +74,14 @@ module Blacklight::FacetsHelperBehavior
   # By default, only render facets with items.
   #
   # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
+  # @param [Blacklight::Configuration::FacetField] facet_config
   # @return [Boolean]
-  def should_render_facet? display_facet
+  def should_render_facet? display_facet, facet_config = nil
+    return false if display_facet.items.blank?
+
     # display when show is nil or true
-    facet_config = facet_configuration_for_field(display_facet.name)
-    display = should_render_field?(facet_config, display_facet)
-    display && display_facet.items.present?
+    facet_config ||= facet_configuration_for_field(display_facet.name)
+    should_render_field?(facet_config, display_facet)
   end
 
   ##
@@ -103,7 +107,7 @@ module Blacklight::FacetsHelperBehavior
     config = facet_configuration_for_field(display_facet.name)
     name = config.try(:partial)
     name ||= "facet_pivot" if config.pivot
-    name ||= "facet_limit"
+    name || "facet_limit"
   end
 
   ##
@@ -183,8 +187,8 @@ module Blacklight::FacetsHelperBehavior
   # Check if the query parameters have the given facet field with the
   # given value.
   #
-  # @param [Object] field
-  # @param [Object] item facet value
+  # @param [String] field
+  # @param [String] item facet value
   # @return [Boolean]
   def facet_in_params?(field, item)
     value = facet_value_for_facet_item(item)
@@ -221,8 +225,7 @@ module Blacklight::FacetsHelperBehavior
       facet_config.query[value][:label]
     elsif facet_config.date
       localization_options = facet_config.date == true ? {} : facet_config.date
-
-      l(value.to_datetime, localization_options)
+      l(Time.zone.parse(value), localization_options)
     else
       value
     end

data/app/helpers/blacklight/icon_helper_behavior.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # Module to help generate icon helpers for SVG images
 module Blacklight::IconHelperBehavior

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -65,6 +65,7 @@ module Blacklight::RenderConstraintsHelperBehavior
   # @return [String]
   def render_constraints_filters(localized_params = params)
     return "".html_safe unless localized_params[:f]
+
     path = controller.search_state_class.new(localized_params, blacklight_config, controller)
     content = []
     localized_params[:f].each_pair do |facet, values|
@@ -85,6 +86,7 @@ module Blacklight::RenderConstraintsHelperBehavior
 
     safe_join(Array(values).map do |val|
       next if val.blank? # skip empty string
+
       render_constraint_element(facet_field_label(facet_config.key),
                                 facet_display_value(facet, val),
                                 remove: search_action_path(path.remove_facet_params(facet, val)),

data/app/helpers/blacklight/render_partials_helper_behavior.rb

@@ -132,8 +132,8 @@ module Blacklight::RenderPartialsHelperBehavior
   def type_field_to_partial_name(_document, display_type)
     # using "_" as sep. to more closely follow the views file naming conventions
     # parameterize uses "-" as the default sep. which throws errors
-    underscore = '_'.freeze
-    Array(display_type).join(' '.freeze).tr('-'.freeze, underscore).parameterize(separator: underscore)
+    underscore = '_'
+    Array(display_type).join(' ').tr('-', underscore).parameterize(separator: underscore)
   end
 
   ##

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -52,6 +52,7 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
   # Render the name of the facet
   def render_filter_name name
     return "".html_safe if name.blank?
+
     content_tag(:span,
                 t('blacklight.search.filters.label', label: name),
                 class: 'filter-name')

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -6,20 +6,34 @@ module Blacklight::UrlHelperBehavior
     search_state.url_for_document(doc, options)
   end
 
-  # link_to_document(doc, 'VIEW', :counter => 3)
-  # Use the catalog_path RESTful route to create a link to the show page for a specific item.
+  # Uses the catalog_path route to create a link to the show page for an item.
   # catalog_path accepts a hash. The solr query params are stored in the session,
   # so we only need the +counter+ param here. We also need to know if we are viewing to document as part of search results.
   # TODO: move this to the IndexPresenter
+  # @param doc [SolrDocument] the document
+  # @param field_or_opts [Hash, String] either a string to render as the link text or options
+  # @param opts [Hash] the options to create the link with
+  # @option opts [Number] :counter (nil) the count to set in the session (for paging through a query result)
+  # @example Passing in an image
+  #   link_to_document(doc, '<img src="thumbnail.png">', counter: 3) #=> "<a href=\"catalog/123\" data-tracker-href=\"/catalog/123/track?counter=3&search_id=999\"><img src="thumbnail.png"></a>
+  # @example With the default document link field
+  #   link_to_document(doc, counter: 3) #=> "<a href=\"catalog/123\" data-tracker-href=\"/catalog/123/track?counter=3&search_id=999\">My Title</a>
   def link_to_document(doc, field_or_opts = nil, opts = { counter: nil })
-    if field_or_opts.is_a? Hash
-      opts = field_or_opts
-    else
-      field = field_or_opts
-    end
+    label = case field_or_opts
+            when NilClass
+              index_presenter(doc).label document_show_link_field(doc), opts
+            when Hash
+              opts = field_or_opts
+              index_presenter(doc).label document_show_link_field(doc), opts
+            when Proc, Symbol
+              Deprecation.warn(self, "passing a #{field_or_opts.class} to link_to_document is deprecated and will be removed in Blacklight 8")
+              Deprecation.silence(Blacklight::IndexPresenter) do
+                index_presenter(doc).label field_or_opts, opts
+              end
+            else # String
+              field_or_opts
+            end
 
-    field ||= document_show_link_field(doc)
-    label = index_presenter(doc).label field, opts
     link_to label, url_for_document(doc), document_link_params(doc, opts)
   end
 
@@ -67,13 +81,14 @@ module Blacklight::UrlHelperBehavior
   ##
   # Get the URL for tracking search sessions across pages using polymorphic routing
   def session_tracking_path document, params = {}
-    return if document.nil?
+    return if document.nil? || controller_name == 'bookmarks'
 
-    if respond_to?(controller_tracking_method)
-      send(controller_tracking_method, params.merge(id: document))
-    else
-      blacklight.track_search_context_path(params.merge(id: document))
+    if main_app.respond_to?(controller_tracking_method)
+      return main_app.public_send(controller_tracking_method, params.merge(id: document))
     end
+
+    raise "Unable to find #{controller_tracking_method} route helper. " \
+    "Did you add `concerns :searchable` routing mixin to your `config/routes.rb`?"
   end
 
   def controller_tracking_method

data/app/javascript/blacklight/checkbox_submit.js

@@ -18,11 +18,11 @@
 
    Pass in options for your class name and labels:
    $("form.something").blCheckboxSubmit({
-        checked_label: "Selected",
-        unchecked_label: "Select",
-        progress_label: "Saving...",
         //cssClass is added to elements added, plus used for id base
         cssClass: "toggle_my_kinda_form",
+        error: function() {
+          #optional callback
+        },
         success: function(after_success_check_state) {
           #optional callback
         }
@@ -47,7 +47,7 @@
         var uniqueId = form.attr('data-doc-id') || Math.random();
         // if form is currently using method delete to change state,
         // then checkbox is currently checked
-        var checked = (form.find('input[name=_method][value=delete]').size() != 0);
+        var checked = (form.find('input[name=_method][value=delete]').length != 0);
 
         var checkbox = $('<input type="checkbox">')
           .addClass( options.cssClass )
@@ -94,10 +94,9 @@
                 type: form.attr('method').toUpperCase(),
                 data: form.serialize(),
                 error: function() {
-                   alert('Error');
-                   updateStateFor(checked);
                    label.removeAttr('disabled');
                    checkbox.removeAttr('disabled');
+                   options.error.call();
                 },
                 success: function(data, status, xhr) {
                   //if app isn't running at all, xhr annoyingly
@@ -109,10 +108,9 @@
                     checkbox.removeAttr('disabled');
                     options.success.call(form, checked, xhr.responseJSON);
                   } else {
-                    alert('Error');
-                    updateStateFor(checked);
                     label.removeAttr('disabled');
                     checkbox.removeAttr('disabled');
+                    options.error.call();
                   }
                 }
             });
@@ -128,6 +126,9 @@
   $.fn.blCheckboxSubmit.defaults =  {
             //cssClass is added to elements added, plus used for id base
             cssClass: 'blCheckboxSubmit',
+            error: function() {
+              alert("Error");
+            },
             success: function() {} //callback
   };
 })(jQuery);