blacklight 7.6.0 → 7.10.0

data/lib/blacklight/solr/response/facets.rb

@@ -210,6 +210,8 @@ module Blacklight::Solr::Response::Facets
         Blacklight::Solr::Response::Facets::FacetItem.new(value: key, hits: hits, label: facet_field.query[key][:label])
       end
 
+      items = items.sort_by(&:hits).reverse if facet_field.sort && facet_field.sort.to_sym == :count
+
       hash[field_name] = Blacklight::Solr::Response::Facets::FacetField.new field_name, items
     end
   end

data/lib/generators/blacklight/assets_generator.rb

@@ -22,6 +22,16 @@ module Blacklight
       end
     end
 
+    ##
+    # Remove the empty generated app/assets/images directory. Without doing this,
+    # the default Sprockets 4 manifest will raise an exception.
+    def appease_sprockets4
+      return if !defined?(Sprockets::VERSION) || Sprockets::VERSION < '4'
+
+      append_to_file 'app/assets/config/manifest.js', "\n//= link application.js"
+      empty_directory 'app/assets/images'
+    end
+
     def assets
       copy_file "blacklight.scss", "app/assets/stylesheets/blacklight.scss"
 

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -84,7 +84,7 @@ class <%= controller_name.classify %>Controller < ApplicationController
     config.add_facet_field 'subject_geo_ssim', label: 'Region'
     config.add_facet_field 'subject_era_ssim', label: 'Era'
 
-    config.add_facet_field 'example_pivot_field', label: 'Pivot Field', :pivot => ['format', 'language_ssim']
+    config.add_facet_field 'example_pivot_field', label: 'Pivot Field', pivot: ['format', 'language_ssim'], collapsing: true
 
     config.add_facet_field 'example_query_facet_field', label: 'Publish Date', :query => {
        :years_5 => { label: 'within 5 Years', fq: "pub_date_ssim:[#{Time.zone.now.year - 5 } TO *]" },

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "7.5.1",
+  "version": "7.7.0",
   "description": "[![Build Status](https://travis-ci.org/projectblacklight/blacklight.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=master)](https://coveralls.io/github/projectblacklight/blacklight?branch=master)",
   "main": "app/assets/javascripts/blacklight",
   "scripts": {
@@ -24,7 +24,7 @@
   "dependencies": {
     "bloodhound-js": "^1.2.3",
     "bootstrap": "^4.3.1",
-    "jquery": "^3.4.1",
+    "jquery": "^3.5.1",
     "typeahead.js": "^0.11.1"
   }
 }

data/spec/{views/catalog/_constraints_element.html.erb_spec.rb → components/blacklight/constraint_layout_component_spec.rb}

@@ -1,24 +1,34 @@
 # frozen_string_literal: true
 
-RSpec.describe "catalog/_constraints_element.html.erb" do
+require 'spec_helper'
+
+RSpec.describe Blacklight::ConstraintLayoutComponent, type: :component do
+  subject(:render) do
+    render_inline(described_class.new(params))
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
   describe "for simple display" do
-    before do
-      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value" }
+    let(:params) do
+      { label: "my label", value: "my value" }
     end
 
     it "renders label and value" do
       expect(rendered).to have_selector("span.applied-filter.constraint") do |s|
         expect(s).to have_css("span.constraint-value")
         expect(s).not_to have_css("a.constraint-value")
-        expect(s).to have_selector "span.filter-name", content: "my label"
-        expect(s).to have_selector "span.filter-value", content: "my value"
+        expect(s).to have_selector "span.filter-name", text: "my label"
+        expect(s).to have_selector "span.filter-value", text: "my value"
       end
     end
   end
 
   describe "with remove link" do
-    before do
-      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value", options: { remove: "http://remove" } }
+    let(:params) do
+      { label: "my label", value: "my value", remove_path: "http://remove" }
     end
 
     it "includes remove link" do
@@ -28,14 +38,14 @@ RSpec.describe "catalog/_constraints_element.html.erb" do
     end
     it "has an accessible remove label" do
       expect(rendered).to have_selector(".remove") do |s|
-        expect(s).to have_content("Remove constraint my label: my value")
+        expect(s).to have_selector('.sr-only', text: 'Remove constraint my label: my value')
       end
     end
   end
 
   describe "with custom classes" do
-    before do
-      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value", options: { classes: %w[class1 class2] } }
+    let(:params) do
+      { label: "my label", value: "my value", classes: %w[class1 class2] }
     end
 
     it "includes them" do
@@ -44,8 +54,8 @@ RSpec.describe "catalog/_constraints_element.html.erb" do
   end
 
   describe "with no escaping" do
-    before do
-      render(partial: "catalog/constraints_element", locals: { label: "<span class='custom_label'>my label</span>".html_safe, value: "<span class='custom_value'>my value</span>".html_safe })
+    let(:params) do
+      { label: "<span class='custom_label'>my label</span>".html_safe, value: "<span class='custom_value'>my value</span>".html_safe }
     end
 
     it "does not escape key and value" do

data/spec/components/blacklight/facet_field_list_component_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
+  subject(:render) do
+    render_inline(described_class.new(facet_field: facet_field))
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
+  let(:facet_field) do
+    instance_double(
+      Blacklight::FacetFieldPresenter,
+      paginator: paginator,
+      key: 'field',
+      label: 'Field',
+      active?: false,
+      collapsed?: false,
+      modal_path: nil,
+      html_id: 'facet-field'
+    )
+  end
+
+  let(:paginator) do
+    instance_double(Blacklight::FacetPaginator, items: [
+                      double(label: 'x', hits: 10),
+                      double(label: 'y', hits: 33)
+                    ])
+  end
+
+  it 'renders a collapsible card' do
+    expect(rendered).to have_selector '.card'
+    expect(rendered).to have_button 'Field'
+    expect(rendered).to have_selector 'button[data-target="#facet-field"]'
+    expect(rendered).to have_selector '#facet-field.collapse.show'
+  end
+
+  it 'renders the facet items' do
+    expect(rendered).to have_selector 'ul.facet-values'
+    expect(rendered).to have_selector 'li', count: 2
+  end
+
+  context 'with an active facet' do
+    let(:facet_field) do
+      instance_double(
+        Blacklight::FacetFieldPresenter,
+        paginator: paginator,
+        key: 'field',
+        label: 'Field',
+        active?: true,
+        collapsed?: false,
+        modal_path: nil,
+        html_id: 'facet-field'
+      )
+    end
+
+    it 'adds the facet-limit-active class' do
+      expect(rendered).to have_selector 'div.facet-limit-active'
+    end
+  end
+
+  context 'with a collapsed facet' do
+    let(:facet_field) do
+      instance_double(
+        Blacklight::FacetFieldPresenter,
+        paginator: paginator,
+        key: 'field',
+        label: 'Field',
+        active?: false,
+        collapsed?: true,
+        modal_path: nil,
+        html_id: 'facet-field'
+      )
+    end
+
+    it 'renders a collapsed facet' do
+      expect(rendered).to have_selector '.facet-content.collapse'
+      expect(rendered).not_to have_selector '.facet-content.collapse.show'
+    end
+
+    it 'renders the toggle button in the collapsed state' do
+      expect(rendered).to have_selector '.btn.collapsed'
+      expect(rendered).to have_selector '.btn[aria-expanded="false"]'
+    end
+  end
+
+  context 'with a modal_path' do
+    let(:facet_field) do
+      instance_double(
+        Blacklight::FacetFieldPresenter,
+        paginator: paginator,
+        key: 'field',
+        label: 'Field',
+        active?: false,
+        collapsed?: false,
+        modal_path: '/catalog/facet/modal',
+        html_id: 'facet-field'
+      )
+    end
+
+    it 'renders a link to the modal' do
+      expect(rendered).to have_link 'more Field', href: '/catalog/facet/modal'
+    end
+  end
+end

data/spec/components/blacklight/facet_item_component_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::FacetItemComponent, type: :component do
+  subject(:render) do
+    render_inline(described_class.new(facet_item: facet_item))
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
+  let(:facet_item) do
+    instance_double(
+      Blacklight::FacetItemPresenter,
+      facet_config: Blacklight::Configuration::FacetField.new,
+      label: 'x',
+      hits: 10,
+      href: '/catalog?f=x',
+      selected?: false
+    )
+  end
+
+  it 'links to the facet and shows the number of hits' do
+    expect(rendered).to have_selector 'li'
+    expect(rendered).to have_link 'x', href: '/catalog?f=x'
+    expect(rendered).to have_selector '.facet-count', text: '10'
+  end
+
+  context 'with a selected facet' do
+    let(:facet_item) do
+      instance_double(
+        Blacklight::FacetItemPresenter,
+        facet_config: Blacklight::Configuration::FacetField.new,
+        label: 'x',
+        hits: 10,
+        href: '/catalog',
+        selected?: true
+      )
+    end
+
+    it 'links to the facet and shows the number of hits' do
+      expect(rendered).to have_selector 'li'
+      expect(rendered).to have_selector '.selected', text: 'x'
+      expect(rendered).to have_link '[remove]', href: '/catalog'
+      expect(rendered).to have_selector '.selected.facet-count', text: '10'
+    end
+  end
+end

data/spec/components/blacklight/facet_item_pivot_component_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::FacetItemPivotComponent, type: :component do
+  subject(:render) do
+    render_inline(described_class.new(facet_item: facet_item))
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
+  let(:search_state) do
+    Blacklight::SearchState.new({}, Blacklight::Configuration.new)
+  end
+
+  let(:facet_item) do
+    instance_double(
+      Blacklight::FacetItemPresenter,
+      facet_config: Blacklight::Configuration::FacetField.new(key: 'z'),
+      facet_field: 'z',
+      label: 'x',
+      hits: 10,
+      href: '/catalog?f[z]=x',
+      selected?: false,
+      search_state: search_state,
+      items: [OpenStruct.new(value: 'x:1', hits: 5)]
+    )
+  end
+
+  it 'links to the facet and shows the number of hits' do
+    expect(rendered).to have_selector 'li'
+    expect(rendered).to have_link 'x', href: '/catalog?f[z]=x'
+    expect(rendered).to have_selector '.facet-count', text: '10'
+  end
+
+  it 'has the facet hierarchy' do
+    puts render
+    expect(rendered).to have_selector 'li ul.pivot-facet'
+    expect(rendered).to have_link 'x:1', href: /f%5Bz%5D%5B%5D=x%3A1/
+  end
+
+  context 'with a selected facet' do
+    let(:facet_item) do
+      instance_double(
+        Blacklight::FacetItemPresenter,
+        facet_config: Blacklight::Configuration::FacetField.new,
+        facet_field: 'z',
+        label: 'x',
+        hits: 10,
+        href: '/catalog',
+        selected?: true,
+        search_state: search_state,
+        items: []
+      )
+    end
+
+    it 'links to the facet and shows the number of hits' do
+      expect(rendered).to have_selector 'li'
+      expect(rendered).to have_selector '.selected', text: 'x'
+      expect(rendered).to have_link '[remove]', href: '/catalog'
+      expect(rendered).to have_selector '.selected.facet-count', text: '10'
+    end
+  end
+end

data/spec/features/facets_spec.rb

@@ -67,6 +67,26 @@ RSpec.describe "Facets" do
     expect(page).to have_css('#facet-format', visible: true) # assert that it didn't re-collapse
   end
 
+  it 'is able to expand pivot facets when javascript is enabled', js: true do
+    visit root_path
+
+    within('#facets .facets-header') do
+      page.find('button.navbar-toggler').click
+    end
+
+    page.find('h3.facet-field-heading button', text: 'Pivot Field').click
+
+    within '#facet-example_pivot_field' do
+      expect(page).to have_css('.facet-leaf-node', text: 'Book 30')
+      expect(page).not_to have_css('.facet-select', text: 'Tibetan')
+      page.find('.facet-toggle-handle').click
+      click_link 'Tibetan'
+    end
+
+    expect(page).to have_css('.constraint-value', text: 'Format Book')
+    expect(page).to have_css('.constraint-value', text: 'Language Tibetan')
+  end
+
   describe 'heading button focus with Firefox' do
     before do
       Capybara.current_driver = :selenium_headless
@@ -88,7 +108,7 @@ RSpec.describe "Facets" do
     it 'has default more link with sr-only text' do
       visit root_path
       within '#facet-language_ssim' do
-        expect(page).to have_css 'li.more_facets', text: 'more Language'
+        expect(page).to have_css 'div.more_facets', text: 'more Language'
       end
     end
   end

data/spec/helpers/blacklight/configuration_helper_behavior_spec.rb

@@ -274,6 +274,9 @@ RSpec.describe Blacklight::ConfigurationHelperBehavior do
       it 'handles a missing key' do
         expect(helper.label_for_search_field('not-found')).to eq 'Not Found'
       end
+      it 'handles a missing field' do
+        expect(helper.label_for_search_field(nil)).to eq nil
+      end
     end
 
     describe '#sort_field_label' do

data/spec/helpers/blacklight/facets_helper_behavior_spec.rb

@@ -141,6 +141,8 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
     let(:blacklight_config) do
       Blacklight::Configuration.new do |config|
         config.add_facet_field 'basic_field'
+        config.add_facet_field 'component_field', component: true
+        config.add_facet_field 'non_rendering_component_field', component: true, if: false
         config.add_facet_field 'pivot_facet_field', pivot: %w[a b]
         config.add_facet_field 'my_pivot_facet_field_with_custom_partial', partial: 'custom_facet_partial', pivot: %w[a b]
         config.add_facet_field 'my_facet_field_with_custom_partial', partial: 'custom_facet_partial'
@@ -191,6 +193,17 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
       expect(helper).to receive(:render).with(hash_including(partial: 'custom_facet_partial'))
       helper.render_facet_limit(mock_facet)
     end
+
+    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))
+      helper.render_facet_limit(mock_facet)
+    end
+
+    it "lets you override the rendered partial for pivot facets" do
+      mock_facet = double(name: 'non_rendering_component_field')
+      expect(helper.render_facet_limit(mock_facet)).to be_blank
+    end
   end
 
   describe "render_facet_limit_list" do
@@ -214,7 +227,11 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
 
     context "when one of the facet items is rendered as nil" do
       # An app may override render_facet_item to filter out some undesired facet items by returning nil.
-      before { allow(helper).to receive(:render_facet_item).and_return('<a class="facet-select">Book</a>'.html_safe, nil) }
+      before do
+        allow(helper.method(:render_facet_item)).to receive(:owner).and_return(self.class)
+        # allow_any_instance_of(Blacklight::FacetItemComponent).to receive(:overridden_helper_methods?).and_return(true)
+        allow(helper).to receive(:render_facet_item).and_return('<a class="facet-select">Book</a>'.html_safe, nil)
+      end
 
       it "draws a list of elements" do
         expect(subject).to have_selector 'li', count: 1
@@ -246,36 +263,44 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
   end
 
   describe "facet_field_in_params?" do
+    let(:search_state) { double }
+
+    before do
+      allow(helper).to receive_messages(search_state: search_state)
+    end
+
     it "checks if any value is selected for a given facet" do
-      allow(helper).to receive_messages(facet_params: ["x"])
+      allow(search_state).to receive(:has_facet?).with(having_attributes(key: 'some-facet')).and_return(true)
       expect(helper.facet_field_in_params?("some-facet")).to eq true
     end
 
     it "is false if no value for facet is selected" do
-      allow(helper).to receive_messages(facet_params: nil)
+      allow(search_state).to receive(:has_facet?).with(having_attributes(key: 'some-facet')).and_return(false)
       expect(helper.facet_field_in_params?("some-facet")).to eq false
     end
   end
 
   describe "facet_in_params?" do
+    let(:search_state) { double }
+
+    before do
+      allow(helper).to receive_messages(search_state: search_state)
+      allow(search_state).to receive(:has_facet?).with(having_attributes(key: 'some-facet'), value: 'x').and_return(true)
+      allow(search_state).to receive(:has_facet?).with(having_attributes(key: 'some-facet'), value: 'y').and_return(false)
+    end
+
     it "checks if a particular value is set in the facet params" do
-      allow(helper).to receive_messages(facet_params: ["x"])
       expect(helper.facet_in_params?("some-facet", "x")).to eq true
       expect(helper.facet_in_params?("some-facet", "y")).to eq false
     end
-
-    it "is false if no value for facet is selected" do
-      allow(helper).to receive_messages(facet_params: nil)
-      expect(helper.facet_in_params?("some-facet", "x")).to eq false
-    end
   end
 
   describe "render_facet_value" do
     let(:item) { double(value: 'A', hits: 10) }
-    let(:search_state) { double(add_facet_params_and_redirect: { controller: 'catalog' }) }
+    let(:search_state) { double(has_facet?: false, add_facet_params_and_redirect: { controller: 'catalog' }) }
 
     before do
-      allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(double(query: nil, date: nil, helper_method: nil, single: false, url_method: nil))
+      allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(Blacklight::Configuration::FacetField.new(key: 'simple_field', query: nil, date: nil, helper_method: nil, single: false, url_method: nil))
       allow(helper).to receive(:facet_display_value).and_return('Z')
       allow(helper).to receive(:search_state).and_return(search_state)
       allow(helper).to receive(:search_action_path) do |*args|
@@ -296,7 +321,7 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
       let(:expected_html) { '<span class="facet-label"><a class="facet-select" href="/blabla">Z</a></span><span class="facet-count">10</span>' }
 
       it "uses that method" do
-        allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(double(query: nil, date: nil, helper_method: nil, single: false, url_method: :test_method))
+        allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(Blacklight::Configuration::FacetField.new(key: 'simple_field', query: nil, date: nil, helper_method: nil, single: false, url_method: :test_method))
         allow(helper).to receive(:test_method).with('simple_field', item).and_return('/blabla')
         result = helper.render_facet_value('simple_field', item)
         expect(result).to be_equivalent_to(expected_html).respecting_element_order
@@ -346,4 +371,24 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
       expect(helper.facet_field_id(double(key: 'some field'))).to eq "facet-some-field"
     end
   end
+
+  describe '#facet_field_presenter' do
+    let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'x').normalize! }
+    let(:display_facet) { double }
+
+    it 'wraps the facet data in a presenter' do
+      presenter = helper.facet_field_presenter(facet_config, display_facet)
+      expect(presenter).to be_a_kind_of Blacklight::FacetFieldPresenter
+      expect(presenter.facet_field).to eq facet_config
+      expect(presenter.display_facet).to eq display_facet
+      expect(presenter.view_context).to eq helper
+    end
+
+    it 'uses the facet config to determine the presenter class' do
+      stub_const('SomePresenter', Class.new(Blacklight::FacetFieldPresenter))
+      facet_config.presenter = SomePresenter
+      presenter = helper.facet_field_presenter(facet_config, display_facet)
+      expect(presenter).to be_a_kind_of SomePresenter
+    end
+  end
 end