blacklight 7.12.1 → 7.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f595fd87d8dbfa6aec25b133ea695e0edfcf4762e8451e84fb26947b3f7b2c41
-  data.tar.gz: adf2c0528a386885de7a656a84a0a88f2a2c419f07a6235279d9adc2dbe65f35
+  metadata.gz: cc85c2e67bf13d0e9c856d53d545896d372495fc242fc3b69d43fdd738681af2
+  data.tar.gz: 573ca993f0519fdb53560d8c14443dc5dd6f092753ba2bcee7a933595234b957
 SHA512:
-  metadata.gz: 31e4a93e7e8b4f02ef3608743d0c3a44e9f08a1752ca4cb424b2f61b8bff9478f94a10ed2035c3090667bba4209ed2a89a19d993f16b6b03923616d044b7c122
-  data.tar.gz: 464311223c2591897ce1e1ec74493502a11b23c3f601a955df3496e0616152241eccced5345722756fee0653ae554573b7b1b962bc68ee1e8d29fc3263209e9b
+  metadata.gz: d08af97a62b30095f7c66ac49f829d0085ca7e2faa1c7cd96d961834031e4fab8eaf3ffb785c8e2d30c970837a27d2fdb0c03e75258ff8ff3f8e43571697948f
+  data.tar.gz: a18de70871cd90a83341a55ebf039b3fb007bd2b49dd27f0786415dc68a21115ddfbcc06a72c57e6043ed7e0a62b18f7cc0913b9e9cbb7eaec7d1d54eaa89106

data/.rubocop.yml

@@ -37,6 +37,8 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Exclude:
     - "lib/blacklight/configuration.rb"
+    - "lib/blacklight/search_builder.rb"
+    - "lib/blacklight/search_state.rb"
 
 Layout/LineLength:
   Max: 200
@@ -46,6 +48,7 @@ Layout/LineLength:
 Metrics/ModuleLength:
   Exclude:
     - 'app/controllers/concerns/blacklight/catalog.rb'
+    - 'lib/blacklight/solr/search_builder_behavior.rb'
 
 Naming/HeredocDelimiterNaming:
   Enabled: false

data/VERSION

@@ -1 +1 @@
-7.12.1
+7.13.0

data/app/components/blacklight/constraints_component.rb

@@ -47,13 +47,15 @@ module Blacklight
     private
 
     def facet_item_presenters
-      @search_state.filter_params.each_pair.flat_map do |facet, values|
-        facet_config = @view_context.facet_configuration_for_field(facet)
+      Deprecation.silence(Blacklight::SearchState) do
+        @search_state.filter_params.each_pair.flat_map do |facet, values|
+          facet_config = @view_context.facet_configuration_for_field(facet)
 
-        Array(values).map do |val|
-          next if val.blank? # skip empty string
+          Array(values).map do |val|
+            next if val.blank? # skip empty string
 
-          facet_item_presenter(facet_config, val, facet)
+            facet_item_presenter(facet_config, val, facet)
+          end
         end
       end
     end

data/app/components/blacklight/document_component.html.erb

@@ -19,6 +19,7 @@
         <%= actions %>
       </header>
 
+      <%= embed %>
       <%= content %>
       <%= metadata %>
     </div>

data/app/components/blacklight/document_component.rb

@@ -6,7 +6,7 @@ module Blacklight
     # the accessors below.
     with_content_areas :header, :body, :footer,
                        :before_title, :title, :after_title,
-                       :actions, :metadata, :thumbnail,
+                       :actions, :embed, :metadata, :thumbnail,
                        :partials
     with_collection_parameter :document
 
@@ -25,6 +25,7 @@ module Blacklight
     def initialize(document: nil, presenter: nil,
                    id: nil, classes: [], component: :article, title_component: :h4,
                    metadata_component: Blacklight::DocumentMetadataComponent,
+                   embed_component: nil,
                    counter: nil, document_counter: nil, counter_offset: 0,
                    show: false)
       if presenter.nil? && document.nil?
@@ -39,8 +40,10 @@ module Blacklight
       @id = id || ('document' if show)
       @classes = classes
 
+      @embed_component = embed_component
       @metadata_component = metadata_component
 
+      @document_counter = document_counter
       @counter = counter
       @counter ||= document_counter + 1 + counter_offset if document_counter.present?
 
@@ -101,6 +104,16 @@ module Blacklight
       @before_title || counter
     end
 
+    def embed
+      return @embed if @embed
+
+      component = @embed_component || presenter.view_config.embed_component
+
+      return unless component
+
+      @view_context.render(component.new(document: @document, presenter: presenter, document_counter: @document_counter))
+    end
+
     private
 
     def counter

data/app/components/blacklight/facet_field_component.html.erb

@@ -1,6 +1,7 @@
 <div class="card facet-limit blacklight-<%= @facet_field.key %> <%= 'facet-limit-active' if @facet_field.active? %>">
   <h3 class="card-header p-0 facet-field-heading" id="<%= @facet_field.html_id %>-header">
     <button
+      type="button"
       class="btn btn-block p-2 text-left collapse-toggle <%= "collapsed" if @facet_field.collapsed? %>"
       data-toggle="collapse"
       data-target="#<%= @facet_field.html_id %>"

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

@@ -111,7 +111,7 @@ 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 }

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/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/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/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
@@ -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/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/lib/blacklight/configuration/facet_field.rb

@@ -46,6 +46,13 @@ module Blacklight
     #      are a hash containing: label (a label to show the user in the facet interface), fq (a string passed into solr as an fq (when selected) or a facet.query)
     # @!attribute pivot
     #   @return []
+    # @!attribute filter_query_builder
+    #   @return [nil, #call] a Proc (or other object responding to #call) that receives as parameters: 1) the search builder, 2) this facet config
+    #     and 3) the solr parameters hash. The Proc returns a string suitable for e.g. Solr's fq parameter, or a 2-element array of the string and a hash of additional
+    #     parameters to include with the query (i.e. for referenced subqueries); note that implementations are responsible for ensuring
+    #     the additional parameter keys are unique.
+    # @!attribute filter_class
+    #  @ return [nil, Blacklight::SearchState::FilterField] a class that implements the `FilterField`'s' API to manage URL parameters for a facet
 
     ##
     # Rendering:

data/lib/blacklight/configuration/search_field.rb

@@ -3,6 +3,11 @@ module Blacklight
   class Configuration::SearchField < Blacklight::Configuration::Field
     # @!attribute include_in_simple_select
     # @!attribute qt
+    # @!attribute query_builder
+    #   @return [nil, #call] a Proc (or other object responding to #call) that receives as parameters: 1) the search builder, 2) this search field,
+    #     and 3) the solr_parameters hash.  The Proc returns a string suitable for e.g. Solr's q parameter, or a 2-element array of the
+    #     string and a hash of additional parameters to include with the query (i.e. for referenced subqueries); note that
+    #     implementations are responsible for ensuring the additional parameter keys are unique.
 
     def normalize! blacklight_config = nil
       self.if = include_in_simple_select if self.if.nil?

data/lib/blacklight/configuration/tool_config.rb

@@ -2,5 +2,9 @@
 module Blacklight
   class Configuration::ToolConfig < OpenStructWithHashAccess
     # @!attribute partial
+
+    def name
+      super || key
+    end
   end
 end

data/lib/blacklight/configuration/view_config.rb

@@ -17,6 +17,18 @@ class Blacklight::Configuration
       super || Blacklight::SearchBarPresenter
     end
 
+    def display_label(key)
+      I18n.t(
+        :"blacklight.search.view_title.#{key}",
+        default: [
+          :"blacklight.search.view.#{key}",
+          label,
+          title,
+          key.to_s.humanize
+        ]
+      )
+    end
+
     class Show < ViewConfig
       # @!attribute route
       #   @return [Hash] Default route parameters for 'show' requests.

data/lib/blacklight/nested_open_struct_with_hash_access.rb

@@ -101,7 +101,7 @@ module Blacklight
 
     def set_default_proc!
       self.default_proc = lambda do |hash, key|
-        hash[key] = nested_class.new
+        hash[key] = nested_class.new(key: key)
       end
     end
   end

data/lib/blacklight/search_builder.rb

@@ -8,7 +8,7 @@ module Blacklight
     class_attribute :default_processor_chain
     self.default_processor_chain = []
 
-    attr_reader :processor_chain, :blacklight_params
+    attr_reader :processor_chain, :search_state, :blacklight_params
 
     # @overload initialize(scope)
     #   @param [Object] scope scope the scope where the filter methods reside in.
@@ -27,15 +27,17 @@ module Blacklight
       end
 
       @blacklight_params = {}
+      @search_state = Blacklight::SearchState.new(@blacklight_params, @scope&.blacklight_config, @scope)
       @merged_params = {}
       @reverse_merged_params = {}
     end
 
     ##
     # Set the parameters to pass through the processor chain
-    def with(blacklight_params = {})
+    def with(blacklight_params_or_search_state = {})
       params_will_change!
-      @blacklight_params = blacklight_params.dup
+      @search_state = blacklight_params_or_search_state.is_a?(Blacklight::SearchState) ? blacklight_params_or_search_state : @search_state.reset(blacklight_params_or_search_state)
+      @blacklight_params = @search_state.params.dup
       self
     end
 
@@ -43,7 +45,8 @@ module Blacklight
     # Update the :q (query) parameter
     def where(conditions)
       params_will_change!
-      @blacklight_params[:q] = conditions
+      @search_state = @search_state.reset(@search_state.params.merge(q: conditions))
+      @blacklight_params = @search_state.params.dup
       self
     end
 
@@ -52,7 +55,7 @@ module Blacklight
     def append(*addl_processor_chain)
       params_will_change!
       builder = self.class.new(processor_chain + addl_processor_chain, scope)
-          .with(blacklight_params)
+          .with(search_state)
           .merge(@merged_params)
           .reverse_merge(@reverse_merged_params)
 
@@ -72,7 +75,7 @@ module Blacklight
     # chain are ignored as no-ops, rather than raising.
     def except(*except_processor_chain)
       builder = self.class.new(processor_chain - except_processor_chain, scope)
-          .with(blacklight_params)
+          .with(search_state)
           .merge(@merged_params)
           .reverse_merge(@reverse_merged_params)
 
@@ -175,7 +178,7 @@ module Blacklight
         self.page = value
         return self
       end
-      @page ||= blacklight_params[:page].blank? ? 1 : blacklight_params[:page].to_i
+      @page ||= search_state.page
     end
 
     def rows=(value)
@@ -191,8 +194,7 @@ module Blacklight
       end
       @rows ||= begin
         # user-provided parameters should override any default row
-        r = [:rows, :per_page].map { |k| blacklight_params[k] }.reject(&:blank?).first
-        r ||= blacklight_config.default_per_page
+        r = search_state.per_page
         # ensure we don't excede the max page size
         r.nil? ? nil : [r, blacklight_config.max_per_page].map(&:to_i).min
       end
@@ -220,22 +222,10 @@ module Blacklight
     # configured search values are passed through to the search.
     # @return [String] the field/fields to sort by
     def sort
-      sort_field = if blacklight_params[:sort].blank?
-                     # no sort param provided, use default
-                     blacklight_config.default_sort_field
-                   else
-                     # check for sort field key
-                     blacklight_config.sort_fields[blacklight_params[:sort]]
-                   end
-      return sort_field.sort if sort_field.present?
-
-      Blacklight.logger.warn "Invalid sort field: '#{blacklight_params[:sort]}' was provided."
-      nil
+      search_state.sort_field&.sort
     end
 
-    def search_field
-      blacklight_config.search_fields[blacklight_params[:search_field]]
-    end
+    delegate :search_field, to: :search_state
 
     private