blacklight 7.25.3 → 7.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ed5074249090af28b69f617baadf69238599d64f387aae61ef71478ea501573
-  data.tar.gz: 03c767a4f628e2e09cd0afbbcb84a30cb0b4161013343f6fd45ab0a9653b58e6
+  metadata.gz: 61a8ce6dc6b7186a9facb02e2862cd9ab252992fd16ac8f3cfb52bb0dc414a0b
+  data.tar.gz: 8fca956b142ab7f1c446858320df1247bed718197ab499e826eb663406db95d9
 SHA512:
-  metadata.gz: 55bab7b3b6c79e06a946650fa0be87eb273b29ef7e2967a945b4222e58edb4da63781b6011d325c9de6377fe8fcb6c6678a651dc4afa6a2d86860a81fa81ebdb
-  data.tar.gz: ccafd10839a91ef7ec21bc5838da73f4cd31d6a17320e6e20b4e052c0414b9ca16c2e6347e1ca1f9dbdaacfed26e723bed9eb6289b5e8c7c887c3867a3cbf8b7
+  metadata.gz: 175534daee84446996871538ece0c562194b485d53b801cb8ab839569fe36c712d94c7629623dc5e32d4e58993d82bc4f899669dbdfaf30de5447235236728f4
+  data.tar.gz: 53c10ab08c741669511f9e77ea1d948968fc0b635b16a883c5c055ebeab45dfd9d7ab295838049f5ff27328f40bb66e06f919a28c649b4c3a89595c49812f176

data/VERSION

@@ -1 +1 @@
-7.25.3
+7.26.0

data/app/components/blacklight/facet_component.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Blacklight
+  ##
+  # Renders a single section for facet limit with a specified
+  # solr field used for faceting. This renders no UI of it's own, but renders
+  # the component that is configured for the facet.
+  class FacetComponent < ViewComponent::Base
+    with_collection_parameter :display_facet_or_field_config
+
+    # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
+    # @param [Blacklight::Configuration] blacklight_config
+    # @param [Boolean] layout
+    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
+        @field_config = display_facet_or_field_config || field_config
+        @display_facet = display_facet || (response && response.aggregations[@field_config.field])
+      elsif (display_facet || display_facet_or_field_config).respond_to?(:name)
+        @display_facet = display_facet || display_facet_or_field_config
+        @field_config = field_config || blacklight_config&.facet_configuration_for_field(@display_facet.name)
+      else
+        raise ArgumentError, 'You must provide one of display_facet or field_config' unless @field_config
+      end
+
+      @component_args = component_args
+    end
+
+    def render?
+      helpers.should_render_field?(@field_config, @display_facet)
+    end
+
+    def call
+      component = @field_config.component == true ? Blacklight::FacetFieldListComponent : @field_config.component
+
+      render(
+        component.new(
+          facet_field: helpers.facet_field_presenter(@field_config, @display_facet),
+          **@component_args
+        )
+      )
+    end
+  end
+end

data/app/components/blacklight/facet_field_list_component.rb

@@ -16,7 +16,7 @@ module Blacklight
     end
 
     def render?
-      @facet_field.paginator.items.any?
+      @facet_field.paginator&.items&.any?
     end
   end
 end

data/app/components/blacklight/facet_item_component.rb

@@ -4,6 +4,8 @@ module Blacklight
   class FacetItemComponent < Blacklight::Component
     extend Deprecation
 
+    attr_reader :label, :href, :hits
+
     with_collection_parameter :facet_item
 
     def initialize(facet_item:, wrapping_element: 'li', suppress_link: false)
@@ -48,9 +50,9 @@ module Blacklight
     def overridden_helper_methods?
       return false if explicit_component_configuration?
 
-      @view_context.method(:render_facet_item).owner != Blacklight::FacetsHelperBehavior ||
-        @view_context.method(:render_facet_value).owner != Blacklight::FacetsHelperBehavior ||
-        @view_context.method(:render_selected_facet_value).owner != Blacklight::FacetsHelperBehavior
+      helpers.method(:render_facet_item).owner != Blacklight::FacetsHelperBehavior ||
+        helpers.method(:render_facet_value).owner != Blacklight::FacetsHelperBehavior ||
+        helpers.method(:render_selected_facet_value).owner != Blacklight::FacetsHelperBehavior
     end
 
     # Call out to the helper method equivalent of this component
@@ -72,7 +74,7 @@ module Blacklight
     # @private
     def render_facet_value
       tag.span(class: "facet-label") do
-        link_to_unless(@suppress_link, @label, @href, class: "facet-select", rel: "nofollow")
+        link_to_unless(@suppress_link, label, href, class: "facet-select", rel: "nofollow")
       end + render_facet_count
     end
 
@@ -83,9 +85,9 @@ module Blacklight
     # @private
     def render_selected_facet_value
       tag.span(class: "facet-label") do
-        tag.span(@label, class: "selected") +
+        tag.span(label, class: "selected") +
           # remove link
-          link_to(@href, class: "remove", rel: "nofollow") do
+          link_to(href, class: "remove", rel: "nofollow") do
             tag.span('✖', class: "remove-icon", aria: { hidden: true }) +
               tag.span(helpers.t(:'blacklight.search.facets.selected.remove'), class: 'sr-only visually-hidden')
           end
@@ -101,12 +103,12 @@ module Blacklight
     # @return [String]
     # @private
     def render_facet_count(options = {})
-      return helpers.render_facet_count(@hits, options) unless helpers.method(:render_facet_count).owner == Blacklight::FacetsHelperBehavior || explicit_component_configuration?
+      return helpers.render_facet_count(hits, options) unless helpers.method(:render_facet_count).owner == Blacklight::FacetsHelperBehavior || explicit_component_configuration?
 
-      return '' if @hits.blank?
+      return '' if hits.blank?
 
       classes = (options[:classes] || []) << "facet-count"
-      tag.span(t('blacklight.search.facets.count', number: number_with_delimiter(@hits)), class: classes)
+      tag.span(t('blacklight.search.facets.count', number: number_with_delimiter(hits)), class: classes)
     end
 
     private

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -76,13 +76,10 @@ module Blacklight::FacetsHelperBehavior
     field_config = facet_configuration_for_field(display_facet.name)
 
     if field_config.component
-      return unless should_render_field?(field_config, display_facet)
-
-      component = field_config.component == true ? Blacklight::FacetFieldListComponent : field_config.component
-
       return render(
-        component.new(
-          facet_field: facet_field_presenter(field_config, display_facet),
+        Blacklight::FacetComponent.new(
+          display_facet: display_facet,
+          field_config: field_config,
           layout: (params[:action] == 'facet' ? false : options[:layout])
         )
       )

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -107,9 +107,13 @@ module Blacklight::RenderConstraintsHelperBehavior
     safe_join(Array(values).map do |val|
       next if val.blank? # skip empty string
 
-      presenter = facet_item_presenter(facet_config, val, facet)
-
       Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
+        presenter = if val.is_a? Array
+                      inclusive_facet_item_presenter(facet_config, val, facet)
+                    else
+                      facet_item_presenter(facet_config, val, facet)
+                    end
+
         render_constraint_element(presenter.field_label,
                                   presenter.label,
                                   remove: presenter.remove_href(search_state),
@@ -118,6 +122,10 @@ module Blacklight::RenderConstraintsHelperBehavior
     end, "\n")
   end
 
+  def inclusive_facet_item_presenter(facet_config, facet_item, facet_field)
+    Blacklight::InclusiveFacetItemPresenter.new(facet_item, facet_config, self, facet_field)
+  end
+
   # Render a label/value constraint on the screen. Can be called
   # by plugins and such to get application-defined rendering.
   #

data/spec/helpers/blacklight/facets_helper_behavior_spec.rb

@@ -199,7 +199,7 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
 
     it "lets you override the rendered partial for pivot facets" do
       mock_facet = double(name: 'component_field')
-      expect(helper).to receive(:render).with(an_instance_of(Blacklight::FacetFieldListComponent))
+      expect(helper).to receive(:render).with(an_instance_of(Blacklight::FacetComponent))
       helper.render_facet_limit(mock_facet)
     end
 

data/spec/helpers/blacklight/render_constraints_helper_behavior_spec.rb

@@ -54,6 +54,14 @@ RSpec.describe Blacklight::RenderConstraintsHelperBehavior do
         expect(subject).to have_link "Remove constraint Item Type: journal", href: "/catalog?q=biz"
       end
     end
+
+    context 'with multivalued facets' do
+      subject { helper.render_filter_element('type', [%w[journal book]], path) }
+
+      it "handles such values gracefully" do
+        expect(subject).to have_link "Remove constraint Item Type: journal OR book", href: "/catalog?q=biz"
+      end
+    end
   end
 
   describe "#render_constraints_filters" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.25.3
+  version: 7.26.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2022-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -453,6 +453,7 @@ files:
 - app/components/blacklight/document_metadata_component.rb
 - app/components/blacklight/document_title_component.html.erb
 - app/components/blacklight/document_title_component.rb
+- app/components/blacklight/facet_component.rb
 - app/components/blacklight/facet_field_checkboxes_component.html.erb
 - app/components/blacklight/facet_field_checkboxes_component.rb
 - app/components/blacklight/facet_field_component.html.erb