blacklight 7.7.0 → 7.8.0

data/spec/lib/blacklight/search_state_spec.rb

@@ -48,6 +48,44 @@ RSpec.describe Blacklight::SearchState do
     end
   end
 
+  describe '#query_param' do
+    let(:params) { parameter_class.new q: 'xyz' }
+
+    it 'returns the query param' do
+      expect(search_state.query_param).to eq 'xyz'
+    end
+  end
+
+  describe '#filter_params' do
+    let(:params) { parameter_class.new f: { ff: ['xyz'] } }
+
+    it 'returns the query param' do
+      expect(search_state.filter_params.deep_symbolize_keys).to eq(ff: ['xyz'])
+    end
+  end
+
+  describe '#has_constraints?' do
+    it 'is false' do
+      expect(search_state.has_constraints?).to eq false
+    end
+
+    context 'with a query param' do
+      let(:params) { parameter_class.new q: 'xyz' }
+
+      it 'is true' do
+        expect(search_state.has_constraints?).to eq true
+      end
+    end
+
+    context 'with a facet param' do
+      let(:params) { parameter_class.new f: { ff: ['xyz'] } }
+
+      it 'is true' do
+        expect(search_state.has_constraints?).to eq true
+      end
+    end
+  end
+
   describe "params_for_search" do
     let(:params) { parameter_class.new 'default' => 'params' }
 

data/spec/models/blacklight/solr/response/facets_spec.rb

@@ -168,9 +168,11 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
     let(:facet_config) do
       double(
         key: 'my_query_facet_field',
+        sort: nil,
         query: {
           'a_simple_query' => { fq: 'field:search', label: 'A Human Readable label' },
           'another_query' => { fq: 'field:different_search', label: 'Label' },
+          'query_with_many_results' => { fq: 'field:many_result_search', label: 'Yet another label' },
           'without_results' => { fq: 'field:without_results', label: 'No results for this facet' }
         }
       )
@@ -184,6 +186,7 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
           facet_queries: {
             'field:search' => 10,
             'field:different_search' => 2,
+            'field:many_result_search' => 100,
             'field:not_appearing_in_the_config' => 50,
             'field:without_results' => 0
           }
@@ -197,7 +200,7 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
       expect(field).to be_a_kind_of Blacklight::Solr::Response::Facets::FacetField
 
       expect(field.name).to eq 'my_query_facet_field'
-      expect(field.items.size).to eq 2
+      expect(field.items.size).to eq 3
       expect(field.items.map(&:value)).not_to include 'field:not_appearing_in_the_config'
 
       facet_item = field.items.find { |x| x.value == 'a_simple_query' }
@@ -206,6 +209,32 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
       expect(facet_item.hits).to eq 10
       expect(facet_item.label).to eq 'A Human Readable label'
     end
+
+    describe 'default/index sorting' do
+      it 'returns the results in the order they are requested by default' do
+        field = subject.aggregations['my_query_facet_field']
+        expect(field.items.map(&:value)).to eq %w[a_simple_query another_query query_with_many_results]
+        expect(field.items.map(&:hits)).to eq [10, 2, 100]
+      end
+
+      it 'returns the results in the order they are requested by when sort is explicitly set to "index"' do
+        allow(facet_config).to receive(:sort).and_return(:index)
+
+        field = subject.aggregations['my_query_facet_field']
+        expect(field.items.map(&:value)).to eq %w[a_simple_query another_query query_with_many_results]
+        expect(field.items.map(&:hits)).to eq [10, 2, 100]
+      end
+    end
+
+    describe 'count sorting' do
+      it 'returns the results sorted by count when requested' do
+        allow(facet_config).to receive(:sort).and_return(:count)
+
+        field = subject.aggregations['my_query_facet_field']
+        expect(field.items.map(&:value)).to eq %w[query_with_many_results a_simple_query another_query]
+        expect(field.items.map(&:hits)).to eq [100, 10, 2]
+      end
+    end
   end
 
   describe "pivot facets" do

data/spec/presenters/blacklight/facet_field_presenter_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Blacklight::FacetFieldPresenter, type: :presenter do
+  subject(:presenter) do
+    described_class.new(facet_field, display_facet, view_context, search_state)
+  end
+
+  let(:facet_field) { Blacklight::Configuration::FacetField.new(key: 'key') }
+  let(:display_facet) do
+    instance_double(Blacklight::Solr::Response::Facets::FacetField, items: items, sort: :index, offset: 0, prefix: nil)
+  end
+  let(:items) { [] }
+  let(:view_context) { controller.view_context }
+  let(:search_state) { view_context.search_state }
+
+  before do
+    allow(view_context).to receive(:facet_limit_for).and_return(20)
+  end
+
+  describe '#collapsed?' do
+    it "is collapsed by default" do
+      facet_field.collapse = true
+      expect(presenter.collapsed?).to be true
+    end
+
+    it "does not be collapse if the configuration says so" do
+      facet_field.collapse = false
+      expect(presenter).not_to be_collapsed
+    end
+
+    it "does not be collapsed if it is in the params" do
+      controller.params[:f] = ActiveSupport::HashWithIndifferentAccess.new(key: [1])
+      expect(presenter.collapsed?).to be false
+    end
+  end
+
+  describe '#active?' do
+    it "checks if any value is selected for a given facet" do
+      controller.params[:f] = ActiveSupport::HashWithIndifferentAccess.new(key: [1])
+      expect(presenter.active?).to eq true
+    end
+
+    it "is false if no value for facet is selected" do
+      expect(presenter.active?).to eq false
+    end
+  end
+
+  describe '#in_modal?' do
+    context 'for a modal-like action' do
+      before do
+        controller.params[:action] = 'facet'
+      end
+
+      it 'is true' do
+        expect(presenter.in_modal?).to eq true
+      end
+    end
+
+    it 'is false' do
+      expect(presenter.in_modal?).to eq false
+    end
+  end
+
+  describe '#modal_path' do
+    let(:paginator) { Blacklight::FacetPaginator.new([{}, {}], limit: 1) }
+
+    before do
+      allow(view_context).to receive(:facet_paginator).and_return(paginator)
+    end
+
+    context 'with no additional data' do
+      let(:paginator) { Blacklight::FacetPaginator.new([{}, {}], limit: 10) }
+
+      it 'is nil' do
+        expect(presenter.modal_path).to be_nil
+      end
+    end
+
+    it 'returns the path to the facet view' do
+      allow(view_context).to receive(:search_facet_path).with(id: 'key').and_return('/catalog/facet/key')
+
+      expect(presenter.modal_path).to eq '/catalog/facet/key'
+    end
+  end
+
+  describe '#label' do
+    it 'gets the label from the helper' do
+      allow(view_context).to receive(:facet_field_label).with('key').and_return('Label')
+      expect(presenter.label).to eq 'Label'
+    end
+  end
+
+  describe '#html_id' do
+    it 'gets the id from a helper' do
+      allow(view_context).to receive(:html_id).with('key').and_return('facet-key')
+      expect(presenter.html_id).to eq 'facet-key'
+    end
+  end
+
+  describe '#paginator' do
+    subject(:paginator) { presenter.paginator }
+
+    it 'return a paginator for the facet data' do
+      expect(paginator.current_page).to eq 1
+      expect(paginator.total_count).to eq 0
+    end
+  end
+end

data/spec/presenters/blacklight/facet_item_presenter_spec.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Blacklight::FacetItemPresenter, type: :presenter do
+  subject(:presenter) do
+    described_class.new(facet_item, facet_config, view_context, facet_field, search_state)
+  end
+
+  let(:facet_item) { instance_double(Blacklight::Solr::Response::Facets::FacetItem) }
+  let(:facet_config) { Blacklight::Configuration::FacetField.new(key: 'key') }
+  let(:facet_field) { instance_double(Blacklight::Solr::Response::Facets::FacetField) }
+  let(:view_context) { controller.view_context }
+  let(:search_state) { instance_double(Blacklight::SearchState) }
+
+  describe '#selected?' do
+    it 'works' do
+      allow(search_state).to receive(:has_facet?).and_return(true)
+      expect(presenter.selected?).to be true
+    end
+  end
+
+  describe '#label' do
+    it "is the facet value for an ordinary facet" do
+      allow(facet_config).to receive_messages(query: nil, date: nil, helper_method: nil, url_method: nil)
+      expect(presenter.label).to eq facet_item
+    end
+
+    it "allows you to pass in a :helper_method argument to the configuration" do
+      allow(facet_config).to receive_messages(query: nil, date: nil, url_method: nil, helper_method: :my_facet_value_renderer)
+      allow(view_context).to receive(:my_facet_value_renderer).with(facet_item).and_return('abc')
+      expect(presenter.label).to eq 'abc'
+    end
+
+    context 'with a query facet' do
+      let(:facet_item) { :query_key }
+
+      it "extracts the configuration label for a query facet" do
+        allow(facet_config).to receive_messages(query: { query_key: { label: 'XYZ' } }, date: nil, helper_method: nil, url_method: nil)
+        expect(presenter.label).to eq 'XYZ'
+      end
+    end
+
+    context 'with a date facet' do
+      let(:facet_item) { '2012-01-01' }
+
+      it "localizes the label for date-type facets" do
+        allow(facet_config).to receive_messages('date' => true, :query => nil, :helper_method => nil, :url_method => nil)
+        expect(presenter.label).to eq 'Sun, 01 Jan 2012 00:00:00 +0000'
+      end
+
+      it "localizes the label for date-type facets with the supplied localization options" do
+        allow(facet_config).to receive_messages(date: { format: :short }, query: nil, helper_method: nil, url_method: nil)
+        expect(presenter.label).to eq '01 Jan 00:00'
+      end
+    end
+  end
+
+  describe '#href' do
+    before do
+      allow(search_state).to receive(:has_facet?).and_return(false)
+    end
+
+    it 'is the url to apply the facet' do
+      allow(search_state).to receive(:add_facet_params_and_redirect).with('key', facet_item).and_return(f: 'x')
+      allow(view_context).to receive(:search_action_path).with(f: 'x').and_return('/catalog?f=x')
+
+      expect(presenter.href).to eq '/catalog?f=x'
+    end
+
+    context 'with url_method configuration' do
+      before do
+        allow(facet_config).to receive_messages(url_method: :some_helper_method)
+      end
+
+      it 'calls out to a helper to determine the url' do
+        allow(view_context).to receive(:some_helper_method).and_return('/xyz').with('key', facet_item)
+
+        expect(presenter.href).to eq '/xyz'
+      end
+    end
+
+    context 'with a selected facet' do
+      it 'is the url to remove the facet' do
+        allow(search_state).to receive(:has_facet?).and_return(true)
+        allow(search_state).to receive(:remove_facet_params).with('key', facet_item).and_return({})
+        allow(view_context).to receive(:search_action_path).with({}).and_return('/catalog')
+
+        expect(presenter.href).to eq '/catalog'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -54,6 +54,8 @@ RSpec.configure do |config|
   end
 
   config.infer_spec_type_from_file_location!
+  config.include PresenterTestHelpers, type: :presenter
+  config.include ViewComponent::TestHelpers, type: :component
 
   config.include(ControllerLevelHelpers, type: :helper)
   config.before(:each, type: :helper) { initialize_controller_helpers(helper) }

data/spec/support/presenter_test_helpers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PresenterTestHelpers
+  def controller
+    @controller ||= ViewComponent::Base.test_controller.constantize.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
+  end
+
+  def request
+    @request ||= ActionDispatch::TestRequest.create
+  end
+end

data/spec/views/catalog/_facet_group.html.erb_spec.rb

@@ -6,6 +6,7 @@ RSpec.describe "catalog/_facet_group" do
   before do
     allow(view).to receive_messages(blacklight_config: blacklight_config)
     allow(view).to receive(:search_action_path).and_return('/catalog')
+    allow(view).to receive(:search_facet_path).and_return('/catalog')
   end
 
   context "without any facet fields" do

data/tasks/blacklight.rake

@@ -10,12 +10,26 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
+def with_solr
+  puts "Starting Solr"
+  system "docker-compose up -d solr"
+  yield
+ensure
+  puts "Stopping Solr"
+  system "docker-compose stop solr"
+end
+
 desc "Run test suite"
-task ci: ['blacklight:generate'] do
-  within_test_app do
-    system "RAILS_ENV=test rake blacklight:index:seed"
+task :ci do
+  with_solr do
+    Rake::Task['engine_cart:generate'].invoke
+
+    within_test_app do
+      system "RAILS_ENV=test bin/rake blacklight:index:seed"
+    end
+
+    Rake::Task['blacklight:coverage'].invoke
   end
-  Rake::Task['blacklight:coverage'].invoke
 end
 
 namespace :blacklight do
@@ -25,34 +39,27 @@ namespace :blacklight do
     Rake::Task["spec"].invoke
   end
 
-  desc "Create the test rails app"
-  task generate: ['engine_cart:generate'] do
-  end
-
   namespace :internal do
+    desc 'Index seed data in test app'
     task seed: ['engine_cart:generate'] do
       within_test_app do
-        system "bundle exec rake blacklight:index:seed"
+        system "bin/rake blacklight:index:seed"
       end
     end
   end
 
   desc 'Run Solr and Blacklight for interactive development'
-  task :server, [:rails_server_args] do |_t, args|
-    if File.exist? EngineCart.destination
-      within_test_app do
-        system "bundle update"
-      end
-    else
-      Rake::Task['engine_cart:generate'].invoke
-    end
-
-    SolrWrapper.wrap do |solr|
-      solr.with_collection do
-        Rake::Task['blacklight:internal:seed'].invoke
+  task :server, [:rails_server_args] => ['engine_cart:generate'] do |_t, args|
+    with_solr do
+      Rake::Task['blacklight:internal:seed'].invoke
 
-        within_test_app do
-          system "bundle exec rails s #{args[:rails_server_args]}"
+      within_test_app do
+        begin
+          puts "Starting Blacklight (Rails server)"
+          system "bin/rails s #{args[:rails_server_args]}"
+        rescue Interrupt
+          # We expect folks to Ctrl-c to stop the server so don't barf at them
+          puts "\nStopping Blacklight (Rails server)"
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.7.0
+  version: 7.8.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rsolr
   requirement: !ruby/object:Gem::Requirement
@@ -294,6 +308,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".docker/app/Dockerfile"
+- ".docker/app/entrypoint.sh"
+- ".env"
 - ".gitignore"
 - ".hound.yml"
 - ".jshintrc"
@@ -335,6 +352,14 @@ files:
 - app/assets/stylesheets/blacklight/blacklight.scss
 - app/assets/stylesheets/blacklight/blacklight_defaults.scss
 - app/builders/blacklight/action_builder.rb
+- app/components/blacklight/constraint_layout_component.html.erb
+- app/components/blacklight/constraint_layout_component.rb
+- app/components/blacklight/facet_field_component.html.erb
+- app/components/blacklight/facet_field_component.rb
+- app/components/blacklight/facet_field_list_component.html.erb
+- app/components/blacklight/facet_field_list_component.rb
+- app/components/blacklight/facet_field_no_layout_component.rb
+- app/components/blacklight/facet_item_component.rb
 - app/controllers/bookmarks_controller.rb
 - app/controllers/catalog_controller.rb
 - app/controllers/concerns/blacklight/base.rb
@@ -393,6 +418,8 @@ files:
 - app/models/search.rb
 - app/models/solr_document.rb
 - app/presenters/blacklight/document_presenter.rb
+- app/presenters/blacklight/facet_field_presenter.rb
+- app/presenters/blacklight/facet_item_presenter.rb
 - app/presenters/blacklight/field_presenter.rb
 - app/presenters/blacklight/index_presenter.rb
 - app/presenters/blacklight/json_presenter.rb
@@ -518,6 +545,7 @@ files:
 - db/migrate/20140202020201_create_searches.rb
 - db/migrate/20140202020202_create_bookmarks.rb
 - db/migrate/20140320000000_add_polymorphic_type_to_bookmarks.rb
+- docker-compose.yml
 - lib/blacklight.rb
 - lib/blacklight/abstract_repository.rb
 - lib/blacklight/configuration.rb
@@ -593,6 +621,9 @@ files:
 - lib/railties/blacklight.rake
 - package-lock.json
 - package.json
+- spec/components/blacklight/constraint_layout_component_spec.rb
+- spec/components/blacklight/facet_field_list_component_spec.rb
+- spec/components/blacklight/facet_item_component_spec.rb
 - spec/controllers/alternate_controller_spec.rb
 - spec/controllers/application_controller_spec.rb
 - spec/controllers/blacklight/base_spec.rb
@@ -670,6 +701,8 @@ files:
 - spec/models/search_spec.rb
 - spec/models/solr_document_spec.rb
 - spec/presenters/blacklight/document_presenter_spec.rb
+- spec/presenters/blacklight/facet_field_presenter_spec.rb
+- spec/presenters/blacklight/facet_item_presenter_spec.rb
 - spec/presenters/blacklight/field_presenter_spec.rb
 - spec/presenters/blacklight/index_presenter_spec.rb
 - spec/presenters/blacklight/json_presenter_spec.rb
@@ -684,10 +717,10 @@ files:
 - spec/support/controller_level_helpers.rb
 - spec/support/features.rb
 - spec/support/features/session_helpers.rb
+- spec/support/presenter_test_helpers.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/views/catalog/_constraints.html.erb_spec.rb
-- spec/views/catalog/_constraints_element.html.erb_spec.rb
 - spec/views/catalog/_document.html.erb_spec.rb
 - spec/views/catalog/_document_list.html.erb_spec.rb
 - spec/views/catalog/_facet_group.html.erb_spec.rb
@@ -738,12 +771,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
+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.
 test_files:
+- spec/components/blacklight/constraint_layout_component_spec.rb
+- spec/components/blacklight/facet_field_list_component_spec.rb
+- spec/components/blacklight/facet_item_component_spec.rb
 - spec/controllers/alternate_controller_spec.rb
 - spec/controllers/application_controller_spec.rb
 - spec/controllers/blacklight/base_spec.rb
@@ -821,6 +857,8 @@ test_files:
 - spec/models/search_spec.rb
 - spec/models/solr_document_spec.rb
 - spec/presenters/blacklight/document_presenter_spec.rb
+- spec/presenters/blacklight/facet_field_presenter_spec.rb
+- spec/presenters/blacklight/facet_item_presenter_spec.rb
 - spec/presenters/blacklight/field_presenter_spec.rb
 - spec/presenters/blacklight/index_presenter_spec.rb
 - spec/presenters/blacklight/json_presenter_spec.rb
@@ -835,10 +873,10 @@ test_files:
 - spec/support/controller_level_helpers.rb
 - spec/support/features.rb
 - spec/support/features/session_helpers.rb
+- spec/support/presenter_test_helpers.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - spec/views/catalog/_constraints.html.erb_spec.rb
-- spec/views/catalog/_constraints_element.html.erb_spec.rb
 - spec/views/catalog/_document.html.erb_spec.rb
 - spec/views/catalog/_document_list.html.erb_spec.rb
 - spec/views/catalog/_facet_group.html.erb_spec.rb