blacklight 7.12.0 → 7.14.0

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

@@ -133,7 +133,7 @@ module Blacklight::Catalog
   # Check if any search parameters have been set
   # @return [Boolean]
   def has_search_parameters?
-    params[:q].present? || params[:f].present? || params[:search_field].present?
+    params[:search_field].present? || search_state.has_constraints?
   end
 
   # TODO: deprecate this constant with #facet_limit_for
@@ -316,11 +316,11 @@ module Blacklight::Catalog
     # If there are errors coming from the index page, we want to trap those sensibly
 
     if flash[:notice] == flash_notice
-      logger.error "Cowardly aborting rsolr_request_error exception handling, because we redirected to a page that raises another exception"
+      logger&.error "Cowardly aborting rsolr_request_error exception handling, because we redirected to a page that raises another exception"
       raise exception
     end
 
-    logger.error exception
+    logger&.error exception
 
     flash[:notice] = flash_notice
     redirect_to search_action_url

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

@@ -111,13 +111,13 @@ module Blacklight::SearchContext
   def setup_next_and_previous_documents
     if search_session['counter'] && current_search_session
       index = search_session['counter'].to_i - 1
-      response, documents = search_service.previous_and_next_documents_for_search index, search_state.reset(current_search_session.query_params).to_hash
+      response, documents = search_service.previous_and_next_documents_for_search index, search_state.reset(current_search_session.query_params)
 
       search_session['total'] = response.total
       { prev: documents.first, next: documents.last }
     end
   rescue Blacklight::Exceptions::InvalidRequest => e
-    logger.warn "Unable to setup next and previous documents: #{e}"
+    logger&.warn "Unable to setup next and previous documents: #{e}"
     nil
   end
 end

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

@@ -13,7 +13,7 @@
 module Blacklight::Searchable
   # @return [Blacklight::SearchService]
   def search_service
-    search_service_class.new(config: blacklight_config, user_params: search_state.to_h, **search_service_context)
+    search_service_class.new(config: blacklight_config, search_state: search_state, user_params: search_state.to_h, **search_service_context)
   end
 
   # @return [Hash] a hash of context information to pass through to the search service

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -408,7 +408,7 @@ module Blacklight::BlacklightHelperBehavior
   # @private
 
   def self.blacklight_path
-    @blacklight_path ||= Gem.loaded_specs["blacklight"].source.path.to_s
+    @blacklight_path ||= Gem.loaded_specs["blacklight"].full_gem_path
   end
 
   def partial_from_blacklight?(partial)

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -10,7 +10,7 @@ module Blacklight
     deprecation_deprecate :document_action_label
 
     # @deprecated
-    def document_action_path action_opts, url_opts = nil
+    def document_action_path action_opts, url_opts = {}
       if action_opts.path
         send(action_opts.path, url_opts)
       elsif url_opts[:id].class.respond_to?(:model_name)

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -103,15 +103,9 @@ module Blacklight::ConfigurationHelperBehavior
   # @return [String]
   def view_label view
     view_config = blacklight_config.view[view]
-    field_label(
-      :"blacklight.search.view_title.#{view}",
-      :"blacklight.search.view.#{view}",
-      view_config.label,
-      view_config.title,
-      view.to_s.humanize
-    )
-  end
-  deprecation_deprecate view_label: 'Moving to Blacklight::Response::ViewTypeComponent'
+    view_config.display_label(view)
+  end
+  deprecation_deprecate view_label: 'Moving to ViewConfig#display_label and Blacklight::Response::ViewTypeComponent'
 
   # Shortcut for commonly needed operation, look up display
   # label for the key specified.

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -254,7 +254,10 @@ module Blacklight::FacetsHelperBehavior
   # @return [Boolean]
   def facet_field_in_params? field
     config = facet_configuration_for_field(field)
-    search_state.has_facet? config
+
+    Deprecation.silence(Blacklight::SearchState) do
+      search_state.has_facet? config
+    end
   end
   # Left undeprecated for the sake of temporary backwards compatibility
   # deprecation_deprecate :facet_field_in_params?
@@ -269,7 +272,10 @@ module Blacklight::FacetsHelperBehavior
   # @return [Boolean]
   def facet_in_params?(field, item)
     config = facet_configuration_for_field(field)
-    search_state.has_facet? config, value: facet_value_for_facet_item(item)
+
+    Deprecation.silence(Blacklight::SearchState) do
+      search_state.has_facet? config, value: facet_value_for_facet_item(item)
+    end
   end
   deprecation_deprecate :facet_in_params?
 

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -21,43 +21,7 @@ module Blacklight::HashAsHiddenFieldsHelperBehavior
   # @param [Hash] hash
   # @return [String]
   def render_hash_as_hidden_fields(hash)
-    hidden_fields = []
-    flatten_hash(hash).each do |name, value|
-      value = Array.wrap(value)
-      value.each do |v|
-        hidden_fields << hidden_field_tag(name, v.to_s, id: nil)
-      end
-    end
-
-    safe_join(hidden_fields, "\n")
-  end
-  deprecation_deprecate render_hash_as_hidden_fields: 'Moving to a private method of Blacklight::SearchBarComponent'
-
-  private
-
-  def flatten_hash(hash = params, ancestor_names = [])
-    flat_hash = {}
-    hash.each do |k, v|
-      names = Array.new(ancestor_names)
-      names << k
-      if v.is_a?(Hash)
-        flat_hash.merge!(flatten_hash(v, names))
-      else
-        key = flat_hash_key(names)
-        key += "[]" if v.is_a?(Array)
-        flat_hash[key] = v
-      end
-    end
-
-    flat_hash
-  end
-
-  def flat_hash_key(names)
-    names = Array.new(names)
-    name = names.shift.to_s.dup
-    names.each do |n|
-      name << "[#{n}]"
-    end
-    name
+    render Blacklight::HiddenSearchStateComponent.new(params: hash)
   end
+  deprecation_deprecate render_hash_as_hidden_fields: 'Use Blacklight::HiddenSearchStateComponent instead'
 end

data/app/helpers/blacklight/icon_helper_behavior.rb

@@ -12,7 +12,7 @@ module Blacklight::IconHelperBehavior
   def blacklight_icon(icon_name, options = {})
     Rails.cache.fetch([:blacklight_icons, icon_name, options]) do
       icon = Blacklight::Icon.new(icon_name, **options)
-      tag.span(icon.svg.html_safe, icon.options)
+      tag.span(icon.svg.html_safe, **icon.options)
     end
   end
 end

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -84,12 +84,14 @@ module Blacklight::RenderConstraintsHelperBehavior
     Deprecation.warn(Blacklight::RenderConstraintsHelperBehavior, 'render_constraints_filters is deprecated')
     search_state = convert_to_search_state(params_or_search_state)
 
-    return "".html_safe if search_state.filter_params.blank?
+    Deprecation.silence(Blacklight::SearchState) do
+      return "".html_safe if search_state.filter_params.blank?
 
-    Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
-      safe_join(search_state.filter_params.each_pair.map do |facet, values|
-        render_filter_element(facet, values, search_state)
-      end, "\n")
+      Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
+        safe_join(search_state.filter_params.each_pair.map do |facet, values|
+          render_filter_element(facet, values, search_state)
+        end, "\n")
+      end
     end
   end
 

data/app/helpers/blacklight/render_partials_helper_behavior.rb

@@ -173,7 +173,7 @@ module Blacklight::RenderPartialsHelperBehavior
   def find_document_show_template_with_view view_type, base_name, format, locals
     document_partial_path_templates.each do |str|
       partial = format(str, action_name: base_name, format: format, index_view_type: view_type)
-      logger.debug "Looking for document partial #{partial}"
+      logger&.debug "Looking for document partial #{partial}"
       template = lookup_context.find_all(partial, lookup_context.prefixes + [""], true, locals.keys + [:document], {}).first
       return template if template
     end
@@ -183,7 +183,7 @@ module Blacklight::RenderPartialsHelperBehavior
   def find_document_index_template_with_view view_type, locals
     document_index_path_templates.each do |str|
       partial = format(str, index_view_type: view_type)
-      logger.debug "Looking for document index partial #{partial}"
+      logger&.debug "Looking for document index partial #{partial}"
       template = lookup_context.find_all(partial, lookup_context.prefixes + [""], true, locals.keys + [:documents], {}).first
       return template if template
     end

data/app/javascript/blacklight/button_focus.js

@@ -1,6 +1,7 @@
 Blacklight.onLoad(function() {
   // Button clicks should change focus. As of 10/3/19, Firefox for Mac and
   // Safari both do not set focus to a button on button click.
+  // See https://zellwk.com/blog/inconsistent-button-behavior/ for background information
   document.querySelectorAll('button.collapse-toggle').forEach((button) => {
     button.addEventListener('click', () => {
       event.target.focus();

data/app/javascript/blacklight/modal.js

@@ -101,12 +101,18 @@ Blacklight.modal.modalCloseSelector   = '[data-blacklight-modal~=close]';
 // Called on fatal failure of ajax load, function returns content
 // to show to user in modal.  Right now called only for extreme
 // network errors.
-Blacklight.modal.onFailure = function(data) {
-  var contents =  '<div class="modal-header">' +
-            '<div class="modal-title">Network Error</div>' +
+Blacklight.modal.onFailure = function(jqXHR, textStatus, errorThrown) {
+  console.error('Server error:', this.url, jqXHR.status, errorThrown);
+
+  var contents = '<div class="modal-header">' +
+            '<div class="modal-title">There was a problem with your request.</div>' +
             '<button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="Close">' +
             '  <span aria-hidden="true">&times;</span>' +
-            '</button>';
+            '</button></div>' +
+            ' <div class="modal-body"><p>Expected a successful response from the server, but got an error</p>' +
+            '<pre>' +
+            this.type + ' ' + this.url + "\n" + jqXHR.status + ': ' + errorThrown +
+            '</pre></div>';
   $(Blacklight.modal.modalSelector).find('.modal-content').html(contents);
   $(Blacklight.modal.modalSelector).modal('show');
 }

data/app/presenters/blacklight/document_presenter.rb

@@ -113,6 +113,10 @@ module Blacklight
       LinkAlternatePresenter.new(view_context, document, options).render
     end
 
+    def view_config
+      @view_config ||= configuration.view_config(:show)
+    end
+
     private
 
     def render_field?(field_config)

data/app/presenters/blacklight/facet_item_presenter.rb

@@ -18,7 +18,9 @@ module Blacklight
     # Check if the query parameters have the given facet field with the
     # given value.
     def selected?
-      search_state.has_facet? facet_config, value: facet_value
+      Deprecation.silence(Blacklight::SearchState) do
+        search_state.has_facet? facet_config, value: facet_value
+      end
     end
 
     def field_label
@@ -44,7 +46,7 @@ module Blacklight
         facet_config.query[value][:label]
       elsif facet_config.date
         localization_options = facet_config.date == true ? {} : facet_config.date
-        I18n.l(Time.zone.parse(value), localization_options)
+        I18n.l(Time.zone.parse(value), **localization_options)
       else
         value
       end
@@ -60,7 +62,9 @@ module Blacklight
 
     # @private
     def remove_href(path = search_state)
-      view_context.search_action_path(path.remove_facet_params(facet_config.key, facet_item))
+      Deprecation.silence(Blacklight::SearchState) do
+        view_context.search_action_path(path.remove_facet_params(facet_config.key, facet_item))
+      end
     end
 
     # @private

data/app/presenters/blacklight/index_presenter.rb

@@ -29,12 +29,12 @@ module Blacklight
 
     deprecation_deprecate label: 'Use #heading'
 
-    private
-
     def view_config
       @view_config ||= configuration.view_config(view_context.document_index_view_type)
     end
 
+    private
+
     # @return [Hash<String,Configuration::Field>] all the fields for this index view
     def fields
       configuration.index_fields_for(display_type)

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

@@ -32,7 +32,9 @@ module Blacklight
       end
 
       def facet_params(field, v)
-        context.search_state.reset.add_facet_params(field, v)
+        Deprecation.silence(Blacklight::SearchState) do
+          context.search_state.reset.add_facet_params(field, v)
+        end
       end
     end
   end

data/app/presenters/blacklight/show_presenter.rb

@@ -8,10 +8,6 @@ module Blacklight
       configuration.show_fields_for(display_type)
     end
 
-    def view_config
-      configuration.view_config(:show)
-    end
-
     def field_config(field)
       configuration.show_fields.fetch(field) { Configuration::NullField.new(field) }
     end

data/app/services/blacklight/search_service.rb

@@ -2,9 +2,10 @@
 # SearchService returns search results from the repository
 module Blacklight
   class SearchService
-    def initialize(config:, user_params: {}, search_builder_class: config.search_builder_class, **context)
+    def initialize(config:, search_state: nil, user_params: nil, search_builder_class: config.search_builder_class, **context)
       @blacklight_config = config
-      @user_params = user_params
+      @search_state = search_state || Blacklight::SearchState.new(user_params || {}, config)
+      @user_params = @search_state.params
       @search_builder_class = search_builder_class
       @context = context
     end
@@ -20,9 +21,9 @@ module Blacklight
     # @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 = search_builder.with(search_state)
+      builder.page = search_state.page
+      builder.rows = search_state.per_page
 
       builder = yield(builder) if block_given?
       response = repository.search(builder)
@@ -51,7 +52,7 @@ module Blacklight
     # 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)
+      query = search_builder.with(search_state).facet(facet_field)
       repository.search(query.merge(extra_controller_params))
     end
 
@@ -59,7 +60,8 @@ module Blacklight
     # @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)
+      new_state = request_params.is_a?(Blacklight::SearchState) ? request_params : Blacklight::SearchState.new(request_params, blacklight_config)
+      query = search_builder.with(new_state).start(p.delete(:start)).rows(p.delete(:rows)).merge(extra_controller_params).merge(p)
       response = repository.search(query)
       document_list = response.documents
 
@@ -78,15 +80,15 @@ module Blacklight
     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)
+      query = search_builder.with(search_state).merge(solr_opensearch_params(field)).merge(extra_controller_params)
       response = repository.search(query)
 
-      [user_params[:q], response.documents.flat_map { |doc| doc[field] }.uniq]
+      [search_state.query_param, response.documents.flat_map { |doc| doc[field] }.uniq]
     end
 
     private
 
-    attr_reader :search_builder_class, :user_params
+    attr_reader :search_builder_class, :user_params, :search_state
 
     delegate :repository, to: :blacklight_config
 
@@ -135,7 +137,7 @@ module Blacklight
       extra_controller_params ||= {}
 
       query = search_builder
-              .with(user_params)
+              .with(search_state)
               .where(blacklight_config.document_model.unique_key => ids)
               .merge(blacklight_config.fetch_many_document_params)
               .merge(extra_controller_params)

data/app/values/blacklight/types.rb

@@ -23,7 +23,7 @@ module Blacklight
         begin
           ::Date.parse(field)
         rescue ArgumentError
-          Rails.logger.info "Unable to parse date: #{field.first.inspect}"
+          Rails.logger&.info "Unable to parse date: #{field.first.inspect}"
         end
       end
     end

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

@@ -1,5 +1,5 @@
 <% if render_show_doc_actions_method_from_blacklight? %>
-  <%= render(Blacklight::Document::ActionsComponent.new(document: nil, tag: 'ul', classes: "#{controller_name}Tools nav nav-pills", wrapping_tag: 'li', wrapping_classes: 'nav-item', actions: document_actions(document_list), options: { document_list: @response.documents }, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h))) %>
+  <%= render(Blacklight::Document::ActionsComponent.new(document: nil, tag: 'ul', classes: "#{controller_name}Tools nav nav-pills", wrapping_tag: 'li', wrapping_classes: 'nav-item', actions: document_actions(document_list, options: { document: nil }), options: { document_list: @response.documents }, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h))) %>
 <% else %>
   <% Deprecation.warn(self, '#render_show_doc_actions is deprecated; use ActionComponents instead') %>
   <ul class="<%= controller_name %>Tools nav nav-pills">

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

@@ -1,6 +1,6 @@
 <%= render(Blacklight::SearchBarComponent.new(
       url: search_action_url,
       params: search_state.params_for_search.except(:qt),
-      search_fields: search_fields,
+      search_fields: Deprecation.silence(Blacklight::ConfigurationHelperBehavior) { search_fields },
       presenter: presenter,
       autocomplete_path: search_action_path(action: :suggest))) %>

data/app/views/catalog/index.json.jbuilder

@@ -51,7 +51,9 @@ json.included do
           json.links do
             Deprecation.silence(Blacklight::FacetsHelperBehavior) do
               if facet_in_params?(facet.name, item.value)
-                json.remove search_action_path(search_state.remove_facet_params(facet.name, item.value))
+                Deprecation.silence(Blacklight::SearchState) do
+                  json.remove search_action_path(search_state.remove_facet_params(facet.name, item.value))
+                end
               else
                 json.self path_for_facet(facet.name, item.value, only_path: false)
               end

data/blacklight.gemspec

@@ -23,22 +23,23 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = '~> 2.1'
+  s.required_ruby_version = '>= 2.3'
 
   s.add_dependency "rails", '>= 5.1', '< 7'
   s.add_dependency "globalid"
   s.add_dependency "jbuilder", '~> 2.7'
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "deprecation"
-  s.add_dependency "view_component"
+  s.add_dependency "i18n", '>= 1.7.0' # added named parameters
+  s.add_dependency "ostruct", '>= 0.3.2'
+  s.add_dependency "view_component", '>= 2.23.0'
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
   s.add_development_dependency "rspec-rails", "~> 4.0.0.beta2"
   s.add_development_dependency "rspec-its"
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency "capybara", '~> 3'
-  s.add_development_dependency 'webdrivers', '~> 3.0'
-  s.add_development_dependency "selenium-webdriver", '>= 3.13.1'
+  s.add_development_dependency 'apparition'
   s.add_development_dependency 'engine_cart', '~> 2.1'
   s.add_development_dependency "equivalent-xml"
   s.add_development_dependency "simplecov"