blacklight-spotlight 3.0.0.rc5 → 3.0.0.rc6

data/spec/features/javascript/blocks/solr_documents_block_spec.rb

@@ -225,6 +225,6 @@ describe 'Solr Document Block', feature: true, versioning: true, default_max_wai
 
     # for some reason, the text area above isn't getting filled in
     # expect(page).to have_selector ".st-text-block", text: "zzz"
-    expect(find_field('primary-caption-field').value).to eq 'full_title_tesim'
+    expect(find_field('primary-caption-field').value).to eq Spotlight::PageConfigurations::DOCUMENT_TITLE_KEY
   end
 end

data/spec/helpers/spotlight/application_helper_spec.rb

@@ -155,8 +155,8 @@ describe Spotlight::ApplicationHelper, type: :helper do
     end
 
     it 'excludes view fields that are never visible (e.g. atom, rss)' do
-      blacklight_config.view.a.if = true
-      blacklight_config.view.b.if = false
+      blacklight_config.view.a(if: true)
+      blacklight_config.view.b(if: false)
 
       expect(helper.available_view_fields).to include :a
       expect(helper.available_view_fields).not_to include :b
@@ -172,9 +172,9 @@ describe Spotlight::ApplicationHelper, type: :helper do
       # clean out the default views
       blacklight_config.view.reject! { |_| true }
 
-      blacklight_config.view.a
-      blacklight_config.view.b
-      blacklight_config.view.c
+      blacklight_config.view.a!
+      blacklight_config.view.b!
+      blacklight_config.view.c!
       allow(helper).to receive(:blacklight_config).and_return(blacklight_config)
     end
 

data/spec/models/spotlight/blacklight_configuration_spec.rb

@@ -314,7 +314,7 @@ describe Spotlight::BlacklightConfiguration, type: :model do
     context 'title only configuration' do
       before do
         blacklight_config.configure do |config|
-          config.view.gallery.title_only_by_default = true
+          config.view.gallery(title_only_by_default: true)
           config.add_index_field 'a'
         end
       end
@@ -478,20 +478,20 @@ describe Spotlight::BlacklightConfiguration, type: :model do
     # rubocop:disable RSpec/PredicateMatcher
     it 'filters the upstream blacklight config' do
       subject.document_index_view_types = %w[list gallery unknown]
-      blacklight_config.view.list
-      blacklight_config.view.gallery
-      blacklight_config.view.something
+      blacklight_config.view.list!
+      blacklight_config.view.gallery!
+      blacklight_config.view.something!
 
       expect(subject.blacklight_config.view.keys).to include :list, :gallery, :something
-      expect(subject.blacklight_config.view.all? { |k, v| v.key == k && v.if == :enabled_in_spotlight_view_type_configuration? }).to be_truthy
+      expect(subject.blacklight_config.view.select { |k, v| v.key == k && v.if == :enabled_in_spotlight_view_type_configuration? }.any?).to be_truthy
     end
     # rubocop:enable RSpec/PredicateMatcher
 
     it 'passes through the blacklight configuration when not set' do
-      blacklight_config.view.list
-      blacklight_config.view.gallery
-      blacklight_config.view.something
-      expect(subject.blacklight_config.view.keys).to include(*blacklight_config.view.keys)
+      blacklight_config.view.list!
+      blacklight_config.view.gallery!
+      blacklight_config.view.something!
+      expect(subject.blacklight_config.view.keys.map(&:to_s)).to include(*blacklight_config.view.keys.map(&:to_s))
     end
   end
 
@@ -627,9 +627,9 @@ describe Spotlight::BlacklightConfiguration, type: :model do
 
   describe '#document_index_view_types_selected_hash' do
     before do
-      subject.default_blacklight_config.view.list
-      subject.default_blacklight_config.view.gallery
-      subject.default_blacklight_config.view.map
+      subject.default_blacklight_config.view.list!
+      subject.default_blacklight_config.view.gallery!
+      subject.default_blacklight_config.view.whatever!
       subject.default_blacklight_config.view.rss.if = false
       subject.document_index_view_types = %w[list gallery rss]
     end
@@ -638,8 +638,8 @@ describe Spotlight::BlacklightConfiguration, type: :model do
       expect(subject.document_index_view_types_selected_hash.to_h).to include list: true, gallery: true
     end
 
-    it 'disabled view types are not included' do
-      expect(subject.document_index_view_types_selected_hash.to_h).not_to include :map
+    it 'disabled view types use the value false' do
+      expect(subject.document_index_view_types_selected_hash.to_h).to include whatever: false
     end
 
     it 'excludes view types disabled by configuration (not by curator settings)' do

data/spec/models/spotlight/browse_category_search_builder_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+describe Spotlight::BrowseCategorySearchBuilder do
+  class BrowseCategoryMockSearchBuilder < Blacklight::SearchBuilder
+    include Blacklight::Solr::SearchBuilderBehavior
+    include Spotlight::BrowseCategorySearchBuilder
+  end
+
+  subject { BrowseCategoryMockSearchBuilder.new(scope).with(blacklight_params) }
+
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+  let(:scope) { double(blacklight_config: exhibit.blacklight_config, current_exhibit: exhibit) }
+  let(:solr_request) { Blacklight::Solr::Request.new }
+  let(:blacklight_params) { { browse_category_id: search.id } }
+  let(:search) { FactoryBot.create(:search, exhibit: exhibit, query_params: { sort: 'type', f: { genre_ssim: ['term'] }, q: 'search query' }) }
+
+  describe '#restrict_to_browse_category' do
+    it 'adds the search query parameters from the browse category' do
+      params = subject.to_hash.with_indifferent_access
+
+      expect(params).to include(
+        q: 'search query',
+        fq: ['{!term f=genre_ssim}term'],
+        sort: 'sort_type_ssi asc'
+      )
+    end
+
+    context 'with a user-provided query' do
+      let(:blacklight_params) { { browse_category_id: search.id, q: 'cats' } }
+
+      it 'uses the user-provided query to further restrict the search' do
+        params = subject.to_hash.with_indifferent_access
+        expect(params).not_to include(:q)
+        expect(params).to include(
+          json: {
+            query: {
+              bool: {
+                must: [
+                  { edismax: { query: 'cats' } },
+                  { edismax: { query: 'search query' } }
+                ]
+              }
+            }
+          }
+        )
+      end
+    end
+  end
+end

data/spec/presenters/spotlight/iiif_manifest_presenter_spec.rb

@@ -16,7 +16,7 @@ describe Spotlight::IiifManifestPresenter do
   end
 
   describe 'public methods' do
-    let(:helpers) { double(show_presenter: presenter) }
+    let(:helpers) { double(document_presenter: presenter) }
     let(:presenter) { instance_double(Blacklight::ShowPresenter, heading: title_field_value) }
 
     let(:iiif_url) { 'https://iiif.test/images/1-1' }

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -10,7 +10,7 @@ class TestAppGenerator < Rails::Generators::Base
   end
 
   def add_gems
-    gem 'blacklight', '~> 7.0'
+    gem 'blacklight', '~> 7.17'
     gem 'blacklight-gallery', '~> 3.0'
     Bundler.with_clean_env do
       run 'bundle install'

data/spec/views/spotlight/metadata_configurations/_metadata_field.html.erb_spec.rb

@@ -2,9 +2,9 @@
 
 describe 'spotlight/metadata_configurations/_metadata_field', type: :view do
   let(:exhibit) { FactoryBot.create(:exhibit) }
-  let(:field) { Blacklight::Configuration::Field.new immutable: OpenStruct.new(another_view_type: false) }
+  let(:field) { Blacklight::Configuration::Field.new label: 'Some label', immutable: OpenStruct.new(another_view_type: false) }
   let(:builder) { ActionView::Helpers::FormBuilder.new 'z', nil, view, {} }
-  let(:p) { 'spotlight/metadata_configurations/metadata_field.html.erb' }
+  let(:p) { 'spotlight/metadata_configurations/metadata_field' }
 
   before do
     assign(:exhibit, exhibit)
@@ -17,8 +17,7 @@ describe 'spotlight/metadata_configurations/_metadata_field', type: :view do
     )
   end
 
-  it 'uses the index_field_label helper to render the label' do
-    allow(view).to receive(:index_field_label).with(anything, 'some_key').and_return 'Some label'
+  it 'uses the metadata field label' do
     render partial: p, locals: { key: 'some_key', config: field, f: builder }
     expect(rendered).to have_selector '.field-label', text: 'Some label'
   end

data/spec/views/spotlight/sir_trevor/blocks/_browse_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_browse_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/browse_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/browse_block' }
   let(:page) { double('Page', display_sidebar?: true) }
   let(:search) { FactoryBot.create(:search) }
   let(:block) do

data/spec/views/spotlight/sir_trevor/blocks/_iframe_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_iframe_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/iframe_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/iframe_block' }
   let(:block) do
     OpenStruct.new
   end

data/spec/views/spotlight/sir_trevor/blocks/_link_to_search_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_link_to_search_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/link_to_search_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/link_to_search_block' }
   let(:page) { double('Page', display_sidebar?: true) }
   let(:search) { FactoryBot.create(:search, query_params: { a: 1 }) }
   let(:block) do

data/spec/views/spotlight/sir_trevor/blocks/_rule_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_rule_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/rule_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/rule_block' }
 
   it 'has an hr' do
     render partial: p

data/spec/views/spotlight/sir_trevor/blocks/_solr_documents_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_solr_documents_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_block' }
   let(:page) { double('Page') }
   let(:block) do
     SirTrevorRails::Blocks::SolrDocumentsBlock.new({ type: 'block', data: { title: 'Some title', text: 'Some text', 'text-align' => 'right' } }, page)
@@ -9,10 +9,14 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_block.html.erb', type: :vi
   let(:doc) { blacklight_config.document_model.new(id: 1) }
   let(:blacklight_config) do
     Blacklight::Configuration.new do |config|
-      config.view.embed.partials = %w[a b c]
-      config.view.embed.locals = { a: 1 }
+      config.view.embed(partials: %w[a b c], locals: { a: 1 })
     end
   end
+  let(:stub_presenter) do
+    instance_double(Blacklight::DocumentPresenter, heading: 'blah', thumbnail: thumbnail_presenter)
+  end
+
+  let(:thumbnail_presenter) { instance_double(Blacklight::ThumbnailPresenter, exists?: true, thumbnail_tag: 'thumb') }
 
   before do
     allow(block).to receive(:each_document).and_yield({}, doc)
@@ -21,7 +25,7 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_block.html.erb', type: :vi
 
   before do
     allow(view).to receive(:blacklight_config).and_return(blacklight_config)
-    allow(view).to receive_messages(has_thumbnail?: true, render_thumbnail_tag: 'thumb', document_link_params: {})
+    allow(view).to receive_messages(document_presenter: stub_presenter, document_link_params: {})
   end
 
   context 'with a multi-image object' do

data/spec/views/spotlight/sir_trevor/blocks/_solr_documents_carousel_block.html.erb_spec.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_solr_documents_carousel_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_carousel_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_carousel_block' }
   let(:block) do
     SirTrevorRails::Blocks::SolrDocumentsCarouselBlock.new({ type: 'block', data: {} }, page)
   end
+  let(:stub_presenter) do
+    instance_double(Blacklight::DocumentPresenter, heading: 'blah', thumbnail: thumbnail_presenter)
+  end
+
+  let(:thumbnail_presenter) { instance_double(Blacklight::ThumbnailPresenter, exists?: true, thumbnail_tag: 'thumb') }
 
   before do
     allow(block).to receive(:each_document).and_return([
@@ -14,7 +19,7 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_carousel_block.html.erb',
                                                        ])
     allow(block).to receive_messages(documents?: true)
     allow(view).to receive_messages(solr_documents_carousel_block: block)
-    allow(view).to receive_messages(has_thumbnail?: true, render_thumbnail_tag: 'thumb', blacklight_config: Blacklight::Configuration.new)
+    allow(view).to receive_messages(document_presenter: stub_presenter, blacklight_config: Blacklight::Configuration.new)
   end
 
   it 'has a slideshow block' do

data/spec/views/spotlight/sir_trevor/blocks/_solr_documents_embed_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_solr_documents_embed_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_embed_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_embed_block' }
   let(:page) { double('Page') }
   let(:block) do
     SirTrevorRails::Blocks::SolrDocumentsEmbedBlock.new({ type: 'block', data: { title: 'Some title', text: 'Some text', 'text-align' => 'right' } }, page)
@@ -9,10 +9,14 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_embed_block.html.erb', typ
   let(:doc) { blacklight_config.document_model.new(id: 1) }
   let(:blacklight_config) do
     Blacklight::Configuration.new do |config|
-      config.view.embed.partials = %w[a b c]
-      config.view.embed.locals = { a: 1 }
+      config.view.embed(partials: %w[a b c], locals: { a: 1 })
     end
   end
+  let(:stub_presenter) do
+    instance_double(Blacklight::DocumentPresenter, heading: 'blah', thumbnail: thumbnail_presenter)
+  end
+
+  let(:thumbnail_presenter) { instance_double(Blacklight::ThumbnailPresenter, exists?: true, thumbnail_tag: 'thumb') }
 
   before do
     allow(block).to receive(:each_document).and_yield({}, doc)
@@ -20,8 +24,7 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_embed_block.html.erb', typ
   end
 
   before do
-    allow(view).to receive(:blacklight_config).and_return(blacklight_config)
-    allow(view).to receive_messages(has_thumbnail?: true, render_thumbnail_tag: 'thumb')
+    allow(view).to receive_messages(blacklight_config: blacklight_config, document_presenter: stub_presenter)
   end
 
   it 'has a embed block' do

data/spec/views/spotlight/sir_trevor/blocks/_solr_documents_features_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 describe 'spotlight/sir_trevor/blocks/_solr_documents_features_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_features_block.html.erb' }
+  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_features_block' }
   let(:block) do
     SirTrevorRails::Blocks::SolrDocumentsFeaturesBlock.new({ type: 'block', data: { 'show-primary-caption' => true, 'primary-caption-field' => 'x' } }, page)
   end
@@ -19,7 +19,8 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_features_block.html.erb',
     allow(block).to receive(:each_document).and_return([doc1, doc2, doc3])
     allow(block).to receive_messages(documents?: true)
     allow(view).to receive_messages(solr_documents_features_block: block)
-    allow(view).to receive_messages(has_thumbnail?: true, render_thumbnail_tag: 'thumb', blacklight_config: blacklight_config)
+    allow(view).to receive_messages(blacklight_config: blacklight_config)
+    allow_any_instance_of(Blacklight::ThumbnailPresenter).to receive_messages(exists?: true, thumbnail_tag: 'thumb')
   end
 
   it 'has a slideshow block' do

data/spec/views/spotlight/sir_trevor/blocks/_solr_documents_grid_block.html.erb_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-describe 'spotlight/sir_trevor/blocks/_solr_documents_grid_block.html.erb', type: :view do
-  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_grid_block.html.erb' }
+describe 'spotlight/sir_trevor/blocks/_solr_documents_grid_block', type: :view do
+  let(:p) { 'spotlight/sir_trevor/blocks/solr_documents_grid_block' }
   let(:page) { double('Page') }
   let(:block) do
     SirTrevorRails::Blocks::SolrDocumentsGridBlock.new({ type: 'block', data: { title: 'Some title', text: 'Some text', 'text-align' => 'right' } }, page)
@@ -10,6 +10,12 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_grid_block.html.erb', type
     Blacklight::Configuration.new
   end
 
+  let(:stub_presenter) do
+    instance_double(Blacklight::DocumentPresenter, heading: 'blah', thumbnail: thumbnail_presenter)
+  end
+
+  let(:thumbnail_presenter) { instance_double(Blacklight::ThumbnailPresenter, exists?: true, thumbnail_tag: 'thumb') }
+
   before do
     allow(block).to receive(:each_document).and_return([
                                                          [{}, SolrDocument.new(id: 1)],
@@ -21,8 +27,7 @@ describe 'spotlight/sir_trevor/blocks/_solr_documents_grid_block.html.erb', type
   before do
     allow(view).to receive_messages(
       blacklight_config: blacklight_config,
-      has_thumbnail?: true,
-      render_thumbnail_tag: 'thumb'
+      document_presenter: stub_presenter
     )
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc5
+  version: 3.0.0.rc6
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob-status
@@ -67,14 +67,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.18'
 - !ruby/object:Gem::Dependency
   name: bootstrap_form
   requirement: !ruby/object:Gem::Requirement
@@ -1080,11 +1080,13 @@ files:
 - app/models/ability.rb
 - app/models/concerns/spotlight/access_controls_enforcement_search_builder.rb
 - app/models/concerns/spotlight/blacklight_configuration_defaults.rb
+- app/models/concerns/spotlight/browse_category_search_builder.rb
 - app/models/concerns/spotlight/custom_translation_extension.rb
 - app/models/concerns/spotlight/exhibit_analytics.rb
 - app/models/concerns/spotlight/exhibit_defaults.rb
 - app/models/concerns/spotlight/exhibit_documents.rb
 - app/models/concerns/spotlight/resources/web.rb
+- app/models/concerns/spotlight/search_builder.rb
 - app/models/concerns/spotlight/sitemap.rb
 - app/models/concerns/spotlight/solr_document.rb
 - app/models/concerns/spotlight/solr_document/atomic_updates.rb
@@ -1455,6 +1457,7 @@ files:
 - db/migrate/20210126123041_create_events.rb
 - db/migrate/20210305070001_remove_class_from_sirtrevor_image_blocks.rb
 - db/migrate/20210305171150_create_bulk_updates.rb
+- db/migrate/20210308090000_migrate_caption_values_for_title_key.rb
 - lib/blacklight/spotlight.rb
 - lib/generators/spotlight/install_generator.rb
 - lib/generators/spotlight/scaffold_resource_generator.rb
@@ -1650,6 +1653,7 @@ files:
 - spec/models/spotlight/analytics/ga_spec.rb
 - spec/models/spotlight/background_job_progress_spec.rb
 - spec/models/spotlight/blacklight_configuration_spec.rb
+- spec/models/spotlight/browse_category_search_builder_spec.rb
 - spec/models/spotlight/contact_email_spec.rb
 - spec/models/spotlight/contact_form_spec.rb
 - spec/models/spotlight/contact_image_spec.rb
@@ -2008,6 +2012,7 @@ test_files:
 - spec/models/spotlight/analytics/ga_spec.rb
 - spec/models/spotlight/background_job_progress_spec.rb
 - spec/models/spotlight/blacklight_configuration_spec.rb
+- spec/models/spotlight/browse_category_search_builder_spec.rb
 - spec/models/spotlight/contact_email_spec.rb
 - spec/models/spotlight/contact_form_spec.rb
 - spec/models/spotlight/contact_image_spec.rb