blacklight 7.26.1 → 7.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5943737d0e65f97d49929bd5e1698de5f42a3cea352150f56e2417834ef307ea
-  data.tar.gz: e2ddfa33c4e1cf788a22084e9465acad0a530ea9d714e820c91805f09a8a2b80
+  metadata.gz: 39fe32f4252deb7d8bb08a1d2781a8d1af7e387eb2bafc93fc083cd13eda9b21
+  data.tar.gz: f0b41d058163f54ca1f5a11b745077c8404eea4f8cea43d87c8ea4e6d6ed0d30
 SHA512:
-  metadata.gz: 2d8f7cfb29344d217c4f8f1929fa9ac422567b59ab47d893ccea78f425be5524f75e1456f19fc3bfc25b7211f17b152f7de0a02733bfe4c9bb7f9fd0b6044219
-  data.tar.gz: 6219cde27cd67bfb826532d2b08b6d50a720104a12525251dc79b59a35bb9be0ba5f776f5d6b2e09a3fcbecf410445ba827d4ba85b9106c00a52fe7424aea8f0
+  metadata.gz: e02cee90b4acb73a5b3fe4883c2a076f37146200fdec169bc3bbf0012ffcd79e5244019ee703c97c601f7100bdaecacf65617dccbc2050911b0fa4e7a24eefbd
+  data.tar.gz: 80036e1203a14f9d7f90e11a8fd02309e447d29be4f1deb4250d7628a3bcfad1ed00e43d57d9152fd1fff751e27e983af0adb0747978978039a6d1d81309e688

data/VERSION

@@ -1 +1 @@
-7.26.1
+7.27.0

data/app/components/blacklight/facet_component.rb

@@ -11,11 +11,19 @@ module Blacklight
     # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
     # @param [Blacklight::Configuration] blacklight_config
     # @param [Boolean] layout
+    # rubocop:disable Metrics/CyclomaticComplexity
     def initialize(display_facet_or_field_config: nil, display_facet: nil, field_config: nil, response: nil, blacklight_config: nil, **component_args)
-      if display_facet_or_field_config.is_a?(Blacklight::Configuration::Field) || field_config
+      if display_facet_or_field_config.is_a? Blacklight::FacetFieldPresenter
+        @facet_field_presenter = display_facet_or_field_config
+        @field_config = @facet_field_presenter.facet_field
+        @display_facet = @facet_field_presenter.display_facet
+      elsif display_facet_or_field_config.is_a?(Blacklight::Configuration::Field) || field_config
+        @facet_field_presenter = nil # we need the view context to generate this
         @field_config = display_facet_or_field_config || field_config
-        @display_facet = display_facet || (response && response.aggregations[@field_config.field])
+        @display_facet = display_facet ||
+                         response&.aggregations&.fetch(@field_config.field) { Blacklight::Solr::Response::Facets::NullFacetField.new(@field_config.field, response: response) }
       elsif (display_facet || display_facet_or_field_config).respond_to?(:name)
+        @facet_field_presenter = nil # we need the view context to generate this
         @display_facet = display_facet || display_facet_or_field_config
         @field_config = field_config || blacklight_config&.facet_configuration_for_field(@display_facet.name)
       else
@@ -24,20 +32,27 @@ module Blacklight
 
       @component_args = component_args
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def render?
       helpers.should_render_field?(@field_config, @display_facet)
     end
 
     def call
+      return render_partial if @field_config.partial
+
       component = @field_config.component == true ? Blacklight::FacetFieldListComponent : @field_config.component
 
       render(
         component.new(
-          facet_field: helpers.facet_field_presenter(@field_config, @display_facet),
+          facet_field: @facet_field_presenter || helpers.facet_field_presenter(@field_config, @display_facet),
           **@component_args
         )
       )
     end
+
+    def render_partial
+      helpers.render(@field_config.partial, locals: { field_name: @field_config.field, facet_field: @field_config, display_facet: @display_facet }.merge(@component_args))
+    end
   end
 end

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

@@ -60,9 +60,7 @@ module Blacklight::Catalog
   end
 
   def advanced_search
-    empty_service = search_service_class.new(config: blacklight_config, user_params: {}, **search_service_context)
-
-    (@response, _deprecated_document_list) = empty_service.search_results
+    (@response, _deprecated_document_list) = blacklight_advanced_search_form_search_service.search_results
   end
 
   # get a single document from the index
@@ -334,4 +332,14 @@ module Blacklight::Catalog
     flash[:notice] = flash_notice
     redirect_to search_action_url
   end
+
+  def blacklight_advanced_search_form_search_service
+    form_search_state = search_state_class.new(blacklight_advanced_search_form_params, blacklight_config, self)
+
+    search_service_class.new(config: blacklight_config, search_state: form_search_state, user_params: form_search_state.to_h, **search_service_context)
+  end
+
+  def blacklight_advanced_search_form_params
+    {}
+  end
 end

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -35,7 +35,7 @@ module Blacklight::RenderConstraintsHelperBehavior
                              end
 
     Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
-      render_constraints_query(params_or_search_state) + render_constraints_filters(params_or_search_state)
+      render_constraints_query(params_or_search_state) + render_constraints_clauses(params_or_search_state) + render_constraints_filters(params_or_search_state)
     end
   end
 
@@ -60,6 +60,24 @@ module Blacklight::RenderConstraintsHelperBehavior
     end
   end
 
+  ##
+  # Render the query constraints
+  #
+  # @deprecated
+  # @param [Blacklight::SearchState,ActionController::Parameters] params_or_search_state query parameters
+  # @return [String]
+  def render_constraints_clauses(params_or_search_state = search_state)
+    search_state = convert_to_search_state(params_or_search_state)
+
+    clause_presenters = search_state.clause_params.map do |key, clause|
+      field_config = blacklight_config.search_fields[clause[:field]]
+      Blacklight::ClausePresenter.new(key, clause, field_config, self, search_state)
+    end
+
+    render(Blacklight::ConstraintComponent.with_collection(clause_presenters))
+  end
+  deprecation_deprecate :render_constraints_clauses
+
   ##
   # Provide a url for removing a particular constraint. This can be overriden
   # in the case that you want parameters other than the defaults to be removed

data/app/presenters/blacklight/clause_presenter.rb

@@ -25,7 +25,7 @@ module Blacklight
     end
 
     def remove_href(path = search_state)
-      view_context.search_action_path(path.reset_search(clause: path.clause_params.except(key)))
+      view_context.search_action_path(path.reset_search(clause: path.clause_params.except(key)).to_h)
     end
 
     private

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: 'div', classes: "#{controller_name}Tools", wrapping_tag: 'span', wrapping_classes: 'btn btn-outline-primary', link_classes: '', actions: document_actions(document_list, options: { document: nil }), options: { document_list: @response.documents }, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h))) %>
+  <%= render(Blacklight::Document::ActionsComponent.new(document: nil, tag: 'div', classes: "#{controller_name}Tools", link_classes: 'btn btn-outline-primary', 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/lib/blacklight/solr/response/facets.rb

@@ -99,6 +99,12 @@ module Blacklight::Solr::Response::Facets
     end
   end
 
+  class NullFacetField < FacetField
+    def initialize name, items = [], response: nil, **kwargs
+      super(name, items, response: response, **kwargs)
+    end
+  end
+
   ##
   # Get all the Solr facet data (fields, queries, pivots) as a hash keyed by
   # both the Solr field name and/or by the blacklight field name

data/spec/components/blacklight/facet_component_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::FacetComponent, type: :component do
+  subject(:rendered) do
+    render_inline_to_capybara_node(component)
+  end
+
+  let(:component) { described_class.new(**component_kwargs) }
+  let(:component_kwargs) { { field_config: facet_config, display_facet: display_facet } }
+  let(:items) { [{ label: "Book", value: 'Book', hits: 20 }] }
+
+  let(:display_facet) do
+    instance_double(Blacklight::Solr::Response::Facets::FacetField, name: 'field', items: items, limit: nil, sort: :index, offset: 0, prefix: nil)
+  end
+
+  let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'field', component: Blacklight::FacetFieldListComponent).normalize! }
+
+  before do
+    allow(controller).to receive(:view_context).and_return(controller.view_context)
+    allow(controller.view_context).to receive(:facet_limit_for).and_return(20)
+  end
+
+  it 'delegates to the configured component to render something' do
+    expect(rendered).to have_selector 'ul.facet-values'
+  end
+
+  context 'with a facet configured to use a partial' do
+    let(:facet_config) do
+      Blacklight::Configuration::FacetField.new(key: 'field', partial: 'catalog/facet_partial').normalize!
+    end
+
+    before do
+      controller.view_context.view_paths.unshift(RSpec::Rails::ViewExampleGroup::StubResolverCache.resolver_for('catalog/_facet_partial.html.erb' => 'facet partial'))
+    end
+
+    it 'renders the partial' do
+      expect(rendered).to have_content 'facet partial'
+    end
+  end
+
+  context 'with a field and response' do
+    let(:component_kwargs) do
+      { display_facet_or_field_config: facet_config, response: response }
+    end
+
+    let(:response) { instance_double(Blacklight::Solr::Response, aggregations: { 'field' => display_facet }) }
+
+    it 'extracts the facet data from the response to pass on to the rendering component' do
+      allow(facet_config.component).to receive(:new).and_call_original
+
+      rendered
+
+      expect(facet_config.component).to have_received(:new).with(facet_field: have_attributes(facet_field: facet_config, display_facet: display_facet))
+    end
+
+    context 'when the field is not in the response' do
+      let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'some_other_field', component: Blacklight::FacetFieldListComponent).normalize! }
+
+      it 'uses a null field to pass through the response information anyway' do
+        allow(facet_config.component).to receive(:new).and_call_original
+
+        rendered
+
+        expect(facet_config.component).to have_received(:new).with(facet_field: have_attributes(facet_field: facet_config, display_facet: have_attributes(items: [], response: response)))
+      end
+    end
+  end
+
+  context 'with a display facet and configuration' do
+    let(:component_kwargs) do
+      { display_facet_or_field_config: display_facet, blacklight_config: blacklight_config }
+    end
+
+    let(:blacklight_config) { Blacklight::Configuration.new.tap { |config| config.facet_fields['field'] = facet_config } }
+
+    it 'pulls the facet config from the blacklight config' do
+      allow(facet_config.component).to receive(:new).and_call_original
+
+      rendered
+
+      expect(facet_config.component).to have_received(:new).with(facet_field: have_attributes(facet_field: facet_config, display_facet: display_facet))
+    end
+  end
+
+  context 'with a presenter' do
+    let(:component_kwargs) do
+      { display_facet_or_field_config: presenter }
+    end
+
+    let(:presenter) { Blacklight::FacetFieldPresenter.new(facet_config, display_facet, controller.view_context) }
+
+    it 'renders the component with the provided presenter' do
+      allow(facet_config.component).to receive(:new).and_call_original
+
+      rendered
+
+      expect(facet_config.component).to have_received(:new).with(facet_field: presenter)
+    end
+  end
+end

data/spec/helpers/blacklight/render_constraints_helper_behavior_spec.rb

@@ -6,6 +6,7 @@ RSpec.describe Blacklight::RenderConstraintsHelperBehavior do
   let(:config) do
     Blacklight::Configuration.new do |config|
       config.add_facet_field 'type'
+      config.add_search_field 'title'
     end
   end
 
@@ -31,6 +32,21 @@ RSpec.describe Blacklight::RenderConstraintsHelperBehavior do
     end
   end
 
+  describe '#render_constraints_clauses' do
+    subject { helper.render_constraints_clauses(params) }
+
+    let(:my_engine) { double("Engine") }
+    let(:params) { ActionController::Parameters.new(clause: { "0": { field: 'title', query: 'nature' } }, f: { type: 'journal' }) }
+
+    it 'renders the clause constraint' do
+      expect(subject).to have_selector '.constraint-value', text: /Title\s+nature/
+    end
+
+    it "has a link relative to the current url" do
+      expect(subject).to have_link 'Remove constraint Title: nature', href: '/catalog?f%5Btype%5D%5B%5D=journal'
+    end
+  end
+
   describe '#render_filter_element' do
     subject { helper.render_filter_element('type', ['journal'], path) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.26.1
+  version: 7.27.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -14,10 +14,10 @@ authors:
 - Dan Funk
 - Naomi Dushay
 - Justin Coyne
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-27 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -780,6 +780,7 @@ files:
 - spec/components/blacklight/document/group_component_spec.rb
 - spec/components/blacklight/document_component_spec.rb
 - spec/components/blacklight/document_metadata_component_spec.rb
+- spec/components/blacklight/facet_component_spec.rb
 - spec/components/blacklight/facet_field_checkboxes_component_spec.rb
 - spec/components/blacklight/facet_field_list_component_spec.rb
 - spec/components/blacklight/facet_item_component_spec.rb
@@ -932,7 +933,7 @@ homepage: http://projectblacklight.org/
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -947,8 +948,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
   index.
@@ -960,6 +961,7 @@ test_files:
 - spec/components/blacklight/document/group_component_spec.rb
 - spec/components/blacklight/document_component_spec.rb
 - spec/components/blacklight/document_metadata_component_spec.rb
+- spec/components/blacklight/facet_component_spec.rb
 - spec/components/blacklight/facet_field_checkboxes_component_spec.rb
 - spec/components/blacklight/facet_field_list_component_spec.rb
 - spec/components/blacklight/facet_item_component_spec.rb