blacklight 7.7.0 → 7.8.0

data/docker-compose.yml

@@ -0,0 +1,35 @@
+version: "3.7"
+
+services:
+  app:
+    build:
+      context: .
+      dockerfile: .docker/app/Dockerfile
+      args:
+        - ALPINE_RUBY_VERSION
+    volumes:
+      - .:/app
+    depends_on:
+      - solr
+    ports:
+      - "3000:3000"
+    environment:
+      - SOLR_URL # Set via environment variable or use default defined in .env file
+      - RAILS_VERSION # Set via environment variable or use default defined in .env file
+
+  solr:
+    environment:
+      - SOLR_PORT # Set via environment variable or use default defined in .env file
+      - SOLR_VERSION # Set via environment variable or use default defined in .env file
+    image: "solr:${SOLR_VERSION}"
+    volumes:
+      - $PWD/lib/generators/blacklight/templates/solr/conf:/opt/solr/conf
+    ports:
+      - "${SOLR_PORT}:8983"
+    entrypoint:
+      - docker-entrypoint.sh
+      - solr-precreate
+      - blacklight-core
+      - /opt/solr/conf
+      - "-Xms256m"
+      - "-Xmx512m"

data/lib/blacklight/engine.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require 'view_component/engine'
+
 module Blacklight
   class Engine < Rails::Engine
     engine_name "blacklight"
@@ -9,12 +11,6 @@ module Blacklight
       ActionView::Base.send :include, BlacklightHelper
     end
 
-    config.autoload_paths += %W(
-      #{config.root}/app/presenters
-      #{config.root}/app/controllers/concerns
-      #{config.root}/app/models/concerns
-    )
-
     # This makes our rake tasks visible.
     rake_tasks do
       Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..'))) do

data/lib/blacklight/search_state.rb

@@ -37,6 +37,22 @@ module Blacklight
     end
     alias to_h to_hash
 
+    # Tiny shim to make it easier to migrate raw params access to using this class
+    delegate :[], to: :params
+    deprecation_deprecate :[]
+
+    def has_constraints?
+      !(query_param.blank? && filter_params.blank?)
+    end
+
+    def query_param
+      params[:q]
+    end
+
+    def filter_params
+      params[:f] || {}
+    end
+
     def reset(params = nil)
       self.class.new(params || ActionController::Parameters.new, blacklight_config, controller)
     end
@@ -57,6 +73,12 @@ module Blacklight
       end
     end
 
+    def remove_query_params
+      p = reset_search_params
+      p.delete(:q)
+      p
+    end
+
     # adds the value and/or field to params[:f]
     # Does NOT remove request keys and otherwise ensure that the hash
     # is suitable for a redirect. See
@@ -130,6 +152,16 @@ module Blacklight
       p
     end
 
+    def has_facet?(config, value: nil)
+      facet = params&.dig(:f, config.key)
+
+      if value
+        (facet || []).include? value
+      else
+        facet.present?
+      end
+    end
+
     # Merge the source params with the params_to_merge hash
     # @param [Hash] params_to_merge to merge into above
     # @return [ActionController::Parameters] the current search parameters after being sanitized by Blacklight::Parameters.sanitize

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/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
@@ -34,8 +44,8 @@ RSpec.describe "catalog/_constraints_element.html.erb" do
   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/features/facets_spec.rb

@@ -88,7 +88,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/facets_helper_behavior_spec.rb

@@ -214,7 +214,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 +250,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 +308,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

data/spec/helpers/blacklight/render_constraints_helper_behavior_spec.rb

@@ -13,6 +13,9 @@ RSpec.describe Blacklight::RenderConstraintsHelperBehavior do
     allow(helper).to receive(:search_action_path) do |*args|
       search_catalog_path *args
     end
+
+    allow(helper).to receive(:blacklight_config).and_return(config)
+    allow(controller).to receive(:search_state_class).and_return(Blacklight::SearchState)
   end
 
   describe '#render_constraints_query' do
@@ -22,24 +25,7 @@ RSpec.describe Blacklight::RenderConstraintsHelperBehavior do
     let(:params) { ActionController::Parameters.new(q: 'foobar', f: { type: 'journal' }) }
 
     it "has a link relative to the current url" do
-      expect(subject).to have_selector "a[href='/?f%5Btype%5D=journal']"
-    end
-
-    context 'with an ordinary hash' do
-      let(:params) { { q: 'foobar', f: { type: 'journal' } } }
-
-      it "has a link relative to the current url" do
-        expect(subject).to have_selector "a[href='/?f%5Btype%5D=journal']"
-      end
-    end
-
-    context "with a route_set" do
-      let(:params) { ActionController::Parameters.new(q: 'foobar', f: { type: 'journal' }, route_set: my_engine) }
-
-      it "accepts an optional route set" do
-        expect(my_engine).to receive(:url_for).and_return('/?f%5Btype%5D=journal')
-        expect(subject).to have_selector "a[href='/?f%5Btype%5D=journal']"
-      end
+      expect(subject).to have_link 'Remove constraint', href: '/catalog?f%5Btype%5D=journal'
     end
   end
 
@@ -73,11 +59,6 @@ RSpec.describe Blacklight::RenderConstraintsHelperBehavior do
 
     let(:params) { ActionController::Parameters.new f: { 'type' => [''] } }
 
-    before do
-      allow(helper).to receive(:blacklight_config).and_return(config)
-      allow(controller).to receive(:search_state_class).and_return(Blacklight::SearchState)
-    end
-
     it "renders nothing for empty facet limit param" do
       expect(subject).to be_blank
     end