blacklight 7.14.1 → 7.17.0

data/lib/generators/blacklight/assets_generator.rb

@@ -68,11 +68,15 @@ module Blacklight
     private
 
     def turbolinks?
-      @turbolinks ||= IO.read("app/assets/javascripts/application.js").include?('turbolinks')
+      @turbolinks ||= application_js.include?('turbolinks')
     end
 
     def has_blacklight_assets?
-      IO.read("app/assets/javascripts/application.js").include?('blacklight/blacklight')
+      application_js.include?('blacklight/blacklight')
+    end
+
+    def application_js
+      IO.read(File.expand_path("app/assets/javascripts/application.js", destination_root))
     end
   end
 end

data/lib/generators/blacklight/user_generator.rb

@@ -47,7 +47,7 @@ module Blacklight
     # Add Blacklight to the user model
     def inject_blacklight_user_behavior
       file_path = "app/models/#{model_name.underscore}.rb"
-      if File.exist?(file_path)
+      if File.exist?(File.expand_path(file_path, destination_root))
         inject_into_class file_path, model_name.classify do
           "\n  # Connects this user object to Blacklights Bookmarks." \
           "\n  include Blacklight::User\n"

data/spec/components/blacklight/advanced_search_form_component_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::AdvancedSearchFormComponent, type: :component do
+  subject(:render) do
+    component.render_in(view_context)
+  end
+
+  let(:component) { described_class.new(url: '/whatever', response: response, params: params) }
+  let(:response) { Blacklight::Solr::Response.new({ facet_counts: { facet_fields: { format: { 'Book' => 10, 'CD' => 5 } } } }.with_indifferent_access, {}) }
+  let(:params) { {} }
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
+  let(:view_context) { controller.view_context }
+
+  before do
+    allow(view_context).to receive(:facet_limit_for).and_return(nil)
+  end
+
+  context 'with additional parameters' do
+    let(:params) { { some: :parameter, an_array: [1, 2] } }
+
+    it 'adds additional parameters as hidden fields' do
+      expect(rendered).to have_field 'some', with: 'parameter', type: :hidden
+      expect(rendered).to have_field 'an_array[]', with: '1', type: :hidden
+      expect(rendered).to have_field 'an_array[]', with: '2', type: :hidden
+    end
+  end
+
+  it 'has text fields for each search field' do
+    expect(rendered).to have_selector '.advanced-search-field', count: 4
+    expect(rendered).to have_field 'clause_0_field', with: 'all_fields', type: :hidden
+    expect(rendered).to have_field 'clause_1_field', with: 'title', type: :hidden
+    expect(rendered).to have_field 'clause_2_field', with: 'author', type: :hidden
+    expect(rendered).to have_field 'clause_3_field', with: 'subject', type: :hidden
+  end
+
+  it 'has filters' do
+    expect(rendered).to have_selector '.blacklight-format'
+    expect(rendered).to have_field 'f_inclusive[format][]', with: 'Book'
+    expect(rendered).to have_field 'f_inclusive[format][]', with: 'CD'
+  end
+
+  it 'has a sort field' do
+    expect(rendered).to have_select 'sort', options: %w[relevance year author title]
+  end
+end

data/spec/components/blacklight/document_component_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 RSpec.describe Blacklight::DocumentComponent, type: :component do
-  subject(:component) { described_class.new(document: document, **attr) }
+  subject(:component) { described_class.new(document: document, presenter: view_context.document_presenter(document), **attr) }
 
   let(:attr) { {} }
   let(:view_context) { controller.view_context }
@@ -47,7 +47,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     component.with(:embed, 'Embed')
     component.with(:metadata, 'Metadata')
     component.with(:thumbnail, 'Thumbnail')
-    component.with(:actions, 'Actions')
+    component.with(:actions) { 'Actions' }
 
     expect(rendered).to have_content 'Title'
     expect(rendered).to have_content 'Embed'
@@ -65,7 +65,7 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
 
   context 'with a provided body' do
     it 'opts-out of normal component content' do
-      component.with(:body, 'Body content')
+      component.with(:body) { 'Body content' }
 
       expect(rendered).to have_content 'Body content'
       expect(rendered).not_to have_selector 'header'
@@ -151,4 +151,19 @@ RSpec.describe Blacklight::DocumentComponent, type: :component do
     expect(rendered).to have_selector 'dd', text: 'Title'
     expect(rendered).not_to have_selector 'dt', text: 'ISBN:'
   end
+
+  context 'with a thumbnail component' do
+    let(:attr) { { thumbnail_component: thumbnail_component_class } }
+    let(:thumbnail_component_class) do
+      Class.new(ViewComponent::Base) do
+        def render_in(view_context)
+          view_context.capture { 'Thumb!' }
+        end
+      end
+    end
+
+    it 'uses the provided thumbnail component' do
+      expect(rendered).to have_content 'Thumb!'
+    end
+  end
 end

data/spec/components/blacklight/facet_field_checkboxes_component_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::FacetFieldCheckboxesComponent, 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,
+      facet_field: Blacklight::Configuration::NullField.new(key: 'field'),
+      paginator: paginator,
+      key: 'field',
+      label: 'Field',
+      active?: false,
+      collapsed?: false,
+      modal_path: nil,
+      html_id: 'facet-field',
+      search_state: search_state
+    )
+  end
+
+  let(:paginator) do
+    instance_double(Blacklight::FacetPaginator, items: [
+                      double(label: 'a', hits: 10, value: 'a'),
+                      double(label: 'b', hits: 33, value: 'b'),
+                      double(label: 'c', hits: 3, value: 'c')
+                    ])
+  end
+
+  let(:search_state) { Blacklight::SearchState.new(params.with_indifferent_access, Blacklight::Configuration.new) }
+  let(:params) { { f: { field: ['a'] } } }
+
+  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: 3
+
+    expect(rendered).to have_field 'f_inclusive[field][]', with: 'a'
+    expect(rendered).to have_field 'f_inclusive[field][]', with: 'b'
+    expect(rendered).to have_field 'f_inclusive[field][]', with: 'c'
+  end
+end

data/spec/components/blacklight/facet_field_list_component_spec.rb

@@ -20,7 +20,8 @@ RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
       active?: false,
       collapsed?: false,
       modal_path: nil,
-      html_id: 'facet-field'
+      html_id: 'facet-field',
+      values: []
     )
   end
 
@@ -53,7 +54,8 @@ RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
         active?: true,
         collapsed?: false,
         modal_path: nil,
-        html_id: 'facet-field'
+        html_id: 'facet-field',
+        values: []
       )
     end
 
@@ -72,7 +74,8 @@ RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
         active?: false,
         collapsed?: true,
         modal_path: nil,
-        html_id: 'facet-field'
+        html_id: 'facet-field',
+        values: []
       )
     end
 
@@ -97,7 +100,8 @@ RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
         active?: false,
         collapsed?: false,
         modal_path: '/catalog/facet/modal',
-        html_id: 'facet-field'
+        html_id: 'facet-field',
+        values: []
       )
     end
 
@@ -105,4 +109,35 @@ RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
       expect(rendered).to have_link 'more Field', href: '/catalog/facet/modal'
     end
   end
+
+  context 'with inclusive facets' do
+    let(:facet_field) do
+      instance_double(
+        Blacklight::FacetFieldPresenter,
+        paginator: paginator,
+        facet_field: Blacklight::Configuration::NullField.new(key: 'field'),
+        key: 'field',
+        label: 'Field',
+        active?: false,
+        collapsed?: false,
+        modal_path: nil,
+        html_id: 'facet-field',
+        values: [%w[a b c]],
+        search_state: search_state
+      )
+    end
+
+    let(:search_state) { Blacklight::SearchState.new(params.with_indifferent_access, Blacklight::Configuration.new) }
+    let(:params) { { f_inclusive: { field: %w[a b c] } } }
+
+    it 'displays the constraint above the list' do
+      expect(rendered).to have_content 'Any of:'
+      expect(rendered).to have_selector '.inclusive_or .facet-label', text: 'a'
+      expect(rendered).to have_link '[remove]', href: 'http://test.host/catalog?f_inclusive%5Bfield%5D%5B%5D=b&f_inclusive%5Bfield%5D%5B%5D=c'
+      expect(rendered).to have_selector '.inclusive_or .facet-label', text: 'b'
+      expect(rendered).to have_link '[remove]', href: 'http://test.host/catalog?f_inclusive%5Bfield%5D%5B%5D=a&f_inclusive%5Bfield%5D%5B%5D=c'
+      expect(rendered).to have_selector '.inclusive_or .facet-label', text: 'c'
+      expect(rendered).to have_link '[remove]', href: 'http://test.host/catalog?f_inclusive%5Bfield%5D%5B%5D=a&f_inclusive%5Bfield%5D%5B%5D=b'
+    end
+  end
 end

data/spec/controllers/catalog_controller_spec.rb

@@ -301,6 +301,15 @@ RSpec.describe CatalogController, api: true do
     end
   end
 
+  describe 'GET advanced_search' do
+    it 'renders an advanced search form' do
+      get :advanced_search
+      expect(response).to be_successful
+
+      assert_facets_have_values(assigns(:response).aggregations)
+    end
+  end
+
   # SHOW ACTION
   describe "show action" do
     describe "with format :html" do

data/spec/features/advanced_search_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe "Blacklight Advanced Search Form" do
+  describe "advanced search form" do
+    before do
+      visit '/catalog/advanced?hypothetical_existing_param=true&q=ignore+this+existing+query'
+    end
+
+    it "has field and facet blocks" do
+      expect(page).to have_selector('.query-criteria')
+      expect(page).to have_selector('.limit-criteria')
+    end
+
+    describe "query column" do
+      it "gives the user a choice between and/or queries" do
+        expect(page).to have_selector('#op')
+        within('#op') do
+          expect(page).to have_selector('option[value="must"]')
+          expect(page).to have_selector('option[value="should"]')
+        end
+      end
+
+      it "lists the configured search fields" do
+        expect(page).to have_field 'All Fields'
+        expect(page).to have_field 'Title'
+        expect(page).to have_field 'Author'
+        expect(page).to have_field 'Subject'
+      end
+    end
+
+    describe "facet column" do
+      it "lists facets" do
+        expect(page).to have_selector('.blacklight-language_ssim')
+
+        within('.blacklight-language_ssim') do
+          expect(page).to have_content 'Language'
+        end
+      end
+    end
+
+    it 'scopes searches to fields' do
+      fill_in 'Title', with: 'Medicine'
+      click_on 'advanced-search-submit'
+      expect(page).to have_content 'Remove constraint Title: Medicine'
+      expect(page).to have_content 'Strong Medicine speaks'
+    end
+  end
+
+  describe "prepopulated advanced search form" do
+    before do
+      visit '/catalog/advanced?op=must&clause[0][field]=title&clause[0]query=medicine'
+    end
+
+    it "does not create hidden inputs for search fields" do
+      expect(page).to have_field 'Title', with: 'medicine'
+    end
+
+    it "does not have multiple parameters for a search field" do
+      fill_in 'Title', with: 'bread'
+      click_on 'advanced-search-submit'
+      expect(page.current_url).to match(/bread/)
+      expect(page.current_url).not_to match(/medicine/)
+    end
+  end
+end

data/spec/lib/blacklight/configuration/view_config_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Blacklight::Configuration::ViewConfig do
   describe '#display_label' do
     it "looks up the label to display for the given document and field" do
       allow(I18n).to receive(:t).with(:"blacklight.search.view_title.my_view", default: [:"blacklight.search.view.my_view", label, nil, "My view"]).and_return('x')
-      expect(subject.display_label(key)).to eq 'x'
+      expect(subject.display_label).to eq 'x'
     end
   end
 end

data/spec/lib/blacklight/open_struct_with_hash_access_spec.rb

@@ -123,6 +123,18 @@ RSpec.describe Blacklight::OpenStructWithHashAccess do
     end
   end
 
+  describe '#reverse_merge' do
+    before do
+      @h = described_class.new
+      @h[:a] = 1
+      @h[:b] = 2
+    end
+
+    it 'reverse merges the object with the hash, preserving the object class' do
+      expect(@h.reverse_merge(b: 3, c: 4)).to have_attributes a: 1, b: 2, c: 4
+    end
+  end
+
   describe "#to_json" do
     subject { described_class.new a: 1, b: 2 }
 
@@ -145,4 +157,12 @@ RSpec.describe Blacklight::OpenStructWithHashAccess do
       expect(copy.b[:c]).to eq 2
     end
   end
+
+  describe "#try" do
+    subject { described_class.new a: 1 }
+
+    it "works (and doesn't throw a stack error...)" do
+      expect(subject.try(:a)).to eq 1
+    end
+  end
 end

data/spec/lib/blacklight/search_state/filter_field_spec.rb

@@ -72,6 +72,33 @@ RSpec.describe Blacklight::SearchState::FilterField do
         expect(new_state.filter('some_field').values).to eq %w[1 2 4]
       end
     end
+
+    context 'with an array' do
+      let(:params) do
+        { f: { another_field: ['3'] }, f_inclusive: { some_field: %w[a b c] } }
+      end
+
+      it 'creates a new group with the new values' do
+        filter = search_state.filter('new_field')
+        new_state = filter.add(%w[x y z])
+
+        expect(new_state.filter('new_field').values).to eq [%w[x y z]]
+      end
+
+      it 'updates any existing groups with the new values' do
+        filter = search_state.filter('some_field')
+        new_state = filter.add(%w[x y z])
+
+        expect(new_state.filter('some_field').values).to eq [%w[x y z]]
+      end
+
+      it 'leaves existing filters alone' do
+        filter = search_state.filter('another_field')
+        new_state = filter.add(%w[x y z])
+
+        expect(new_state.filter('another_field').values).to eq ['3', %w[x y z]]
+      end
+    end
   end
 
   describe '#remove' do
@@ -104,12 +131,50 @@ RSpec.describe Blacklight::SearchState::FilterField do
 
       expect(new_state.filter('some_field').values).to eq ['2']
     end
+
+    context 'with an array' do
+      let(:params) do
+        { f: { another_field: ['3'] }, f_inclusive: { some_field: %w[a b c], another_field: %w[x y z] } }
+      end
+
+      it 'removes groups of values' do
+        filter = search_state.filter('some_field')
+        new_state = filter.remove(%w[a b c])
+
+        expect(new_state.params[:f_inclusive]).not_to include :some_field
+        expect(new_state.filter('some_field').values).to eq []
+      end
+
+      it 'can remove single values' do
+        filter = search_state.filter('some_field')
+        new_state = filter.remove(%w[a])
+
+        expect(new_state.filter('some_field').values).to eq [%w[b c]]
+      end
+
+      it 'leaves existing filters alone' do
+        filter = search_state.filter('another_field')
+        new_state = filter.remove(%w[x y z])
+
+        expect(new_state.filter('another_field').values).to eq ['3']
+      end
+    end
   end
 
   describe '#values' do
     it 'returns the currently selected values of the filter' do
       expect(search_state.filter('some_field').values).to eq %w[1 2]
     end
+
+    context 'with an array' do
+      let(:params) do
+        { f: { some_field: ['3'] }, f_inclusive: { some_field: %w[a b c] } }
+      end
+
+      it 'combines the exclusive and inclusive values' do
+        expect(search_state.filter('some_field').values).to eq ['3', %w[a b c]]
+      end
+    end
   end
 
   describe '#include?' do