blacklight 7.41.0 → 8.0.0.beta1

data/spec/models/blacklight/solr/search_builder_spec.rb

@@ -3,8 +3,8 @@
 RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
   subject { search_builder.with(user_params) }
 
-  let(:single_facet) { { format: 'Book' } }
-  let(:multi_facets) { { format: 'Book', language_ssim: 'Tibetan' } }
+  let(:single_facet) { { format: ['Book'] } }
+  let(:multi_facets) { { format: ['Book'], language_ssim: ['Tibetan'] } }
   let(:mult_word_query) { 'tibetan history' }
   let(:subject_search_params) { { commit: "search", search_field: "subject", action: "index", controller: "catalog", rows: "10", q: "wome" } }
 
@@ -73,7 +73,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       expect(subject[:pf]).to eq ""
     end
 
-    describe "should respect proper precedence of settings, " do
+    describe "should respect proper precedence of settings," do
       it "does not put :search_field in produced params" do
         expect(subject[:search_field]).to be_nil
       end
@@ -108,7 +108,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
     end
 
     it "generates a facet limit" do
-      expect(subject[:"f.subject_ssim.facet.limit"]).to eq 21
+      expect(subject[:'f.subject_ssim.facet.limit']).to eq 21
     end
 
     context 'with a negative facet limit' do
@@ -117,7 +117,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       end
 
       it 'is negative' do
-        expect(subject[:"f.subject_ssim.facet.limit"]).to eq -1
+        expect(subject[:'f.subject_ssim.facet.limit']).to eq -1
       end
     end
 
@@ -127,13 +127,13 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       end
 
       it 'is negative' do
-        expect(subject[:"f.subject_ssim.facet.limit"]).to eq 0
+        expect(subject[:'f.subject_ssim.facet.limit']).to eq 0
       end
     end
 
     it "handles no facet_limits in config" do
       blacklight_config.facet_fields = {}
-      expect(subject).not_to have_key(:"f.subject_ssim.facet.limit")
+      expect(subject).not_to have_key(:'f.subject_ssim.facet.limit')
     end
 
     describe "with max per page enforced" do
@@ -178,7 +178,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
 
       it 'has default facet fields' do
         # remove local params from the facet.field
-        expect(subject[:"facet.field"].map { |x| x.gsub(/\{![^}]+\}/, '') }).to match_array %w[format subject_ssim pub_date_ssim language_ssim lc_1letter_ssim subject_geo_ssim subject_era_ssim]
+        expect(subject[:'facet.field'].map { |x| x.gsub(/\{![^}]+\}/, '') }).to match_array %w[format subject_ssim pub_date_ssim language_ssim lc_1letter_ssim subject_geo_ssim subject_era_ssim]
       end
 
       it "does not have a default qt" do
@@ -224,7 +224,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
         expect(subject["spellcheck.q"]).to be_blank
 
         single_facet.each_value do |value|
-          Array(value).each do |v|
+          value.each do |v|
             expect(subject[:fq]).to include("{!term f=#{single_facet.keys[0]}}#{v}")
           end
         end
@@ -335,7 +335,6 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
           qf: '$subject_qf',
           pf: '$subject_pf'
         }
-        blacklight_config.search_fields['subject'].clause_params = nil
       end
 
       it "looks up qt from field definition" do
@@ -364,29 +363,17 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       end
 
       it "includes spellcheck.dictionary from field def solr_parameters" do
-        expect(subject[:"spellcheck.dictionary"]).to eq "subject"
+        expect(subject[:'spellcheck.dictionary']).to eq "subject"
       end
 
       it "adds on :solr_local_parameters using Solr LocalParams style" do
         # q == "{!pf=$subject_pf $qf=subject_qf} wome", make sure
         # the LocalParams are really there
         subject[:q] =~ /^\{!([^}]+)\}/
-        key_value_pairs = Regexp.last_match(1).split(" ")
+        key_value_pairs = Regexp.last_match(1).split
         expect(key_value_pairs).to include("pf=$subject_pf")
         expect(key_value_pairs).to include("qf=$subject_qf")
       end
-
-      context 'when subject field uses JSON query DSL' do
-        before do
-          blacklight_config.search_fields['subject'].clause_params = {
-            edismax: {}
-          }
-        end
-
-        it "includes spellcheck.q, without LocalParams" do
-          expect(subject["spellcheck.q"]).to eq "wome"
-        end
-      end
     end
 
     describe "solr json query parameters from the fielded search" do
@@ -419,24 +406,6 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       it 'includes addtional clause parameters for the field' do
         expect(subject.dig(:json, :query, :bool, :must, 0, :edismax)).to include another: :parameter
       end
-
-      context 'with an empty search' do
-        let(:subject_search_params) { { commit: "search", search_field: "subject", action: "index", controller: "catalog", rows: "10", q: nil } }
-
-        it 'does not add nil query value clauses to json query' do
-          expect(subject).not_to have_key :json
-        end
-      end
-    end
-
-    describe "overriding of qt parameter" do
-      let(:user_params) do
-        { qt: 'overridden' }
-      end
-
-      it "returns the correct overriden parameter" do
-        expect(subject[:qt]).to eq "overridden"
-      end
     end
 
     describe "sorting" do
@@ -521,7 +490,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
     describe 'the search field query_builder config' do
       let(:blacklight_config) do
         Blacklight::Configuration.new do |config|
-          config.add_search_field('built_query', query_builder: ->(builder, *_args) { [builder.blacklight_params[:q].reverse, qq1: 'xyz'] })
+          config.add_search_field('built_query', query_builder: ->(builder, *_args) { [builder.blacklight_params[:q].reverse, { qq1: 'xyz' }] })
         end
       end
 
@@ -613,6 +582,17 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
 
       expect(solr_parameters[:fq]).to be_a_kind_of Array
     end
+
+    context "facet not defined in config" do
+      let(:single_facet) { { unknown_facet_field: "foo" } }
+      let(:user_params) { { f: single_facet } }
+
+      it "does not add facet to solr_parameters" do
+        solr_parameters = Blacklight::Solr::Request.new
+        subject.add_facet_fq_to_solr(solr_parameters)
+        expect(solr_parameters[:fq]).to be_blank
+      end
+    end
   end
 
   describe "#add_solr_fields_to_query" do
@@ -764,7 +744,7 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
     end
 
     it 'sets facets requested to facet_field argument' do
-      expect(solr_parameters["facet.field".to_sym]).to eq facet_field
+      expect(solr_parameters[:'facet.field']).to eq facet_field
     end
 
     it 'defaults offset to 0' do

data/spec/models/blacklight/user_spec.rb

@@ -45,4 +45,26 @@ RSpec.describe "Blacklight::User", api: true do
       expect(subject.existing_bookmark_for(SolrDocument.new(id: 1))).to eq subject.bookmarks.first
     end
   end
+
+  describe '#to_s' do
+    it 'is the email by default' do
+      expect(subject.to_s).to eq subject.email
+    end
+
+    context 'when no email method is provided' do
+      let(:old_method) { subject.class.instance_method(:email) }
+
+      before do
+        subject.class.send(:undef_method, old_method.name)
+      end
+
+      after do
+        subject.class.send(:define_method, old_method.name, old_method)
+      end
+
+      it 'still provides a string' do
+        expect(subject.to_s).to be_a String
+      end
+    end
+  end
 end

data/spec/models/solr_document_spec.rb

@@ -37,9 +37,7 @@ RSpec.describe SolrDocument, api: true do
                           title_tesim: ['Good Omens'])
     end
 
-    it 'ends with the expected information' do
-      expect(inspect).to match(/_source: {"id" ?=> ?"123", "title_tesim" ?=> ?\["Good Omens"\]\}>$/)
-    end
+    it { is_expected.to end_with "_source: {\"id\"=>\"123\", \"title_tesim\"=>[\"Good Omens\"]}>" }
   end
 
   describe '.attribute' do
@@ -51,7 +49,6 @@ RSpec.describe SolrDocument, api: true do
         attribute :author, :array, 'author_tesim', of: :string
         attribute :first_author, :select, 'author_tesim', by: :min
         attribute :date, :date, field: 'date_dtsi'
-        attribute :time, :time, field: 'date_dtsi'
         attribute :whatever, :string, default: ->(*) { 'default_value' }
       end
     end
@@ -59,17 +56,14 @@ RSpec.describe SolrDocument, api: true do
       doc_class.new(id: '123',
                     title_tesim: ['Good Omens'],
                     author_tesim: ['Neil Gaiman', 'Terry Pratchett'],
-                    date_dtsi: '1990-01-01T17:23:13Z')
+                    date_dtsi: '1990-01-01T00:00:00Z')
     end
 
     it "casts the attributes" do
       expect(document.title).to eq 'Good Omens'
       expect(document.author).to eq ['Neil Gaiman', 'Terry Pratchett']
       expect(document.first_author).to eq 'Neil Gaiman'
-      expect(document.date).to be_a Date
-      expect(document.date.to_s).to eq '1990-01-01'
-      expect(document.time).to be_a Time
-      expect(document.time.to_s).to eq '1990-01-01 17:23:13 UTC'
+      expect(document.date).to eq Date.new(1990)
       expect(document.whatever).to eq 'default_value'
     end
 

data/spec/presenters/blacklight/clause_presenter_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Blacklight::ClausePresenter, type: :presenter do

data/spec/presenters/blacklight/document_presenter_spec.rb

@@ -12,13 +12,12 @@ RSpec.describe Blacklight::DocumentPresenter do
 
   before do
     allow(request_context).to receive(:search_state).and_return(search_state)
-    allow(request_context).to receive(:action_name).and_return(:show)
   end
 
   describe '#fields_to_render' do
     subject { presenter.fields_to_render.to_a }
 
-    let(:field_config) { Blacklight::Configuration::Field.new(field: 'asdf') }
+    let(:field_config) { Blacklight::Configuration::DisplayField.new(field: 'asdf') }
 
     context 'when all of the fields have values' do
       before do
@@ -31,7 +30,7 @@ RSpec.describe Blacklight::DocumentPresenter do
 
   describe '#field_value' do
     let(:field_presenter) { instance_double(Blacklight::FieldPresenter, render: 'xyz') }
-    let(:field_config) { Blacklight::Configuration::Field.new }
+    let(:field_config) { Blacklight::Configuration::DisplayField.new }
     let(:options) { { a: 1 } }
 
     it 'calls the field presenter' do

data/spec/presenters/blacklight/facet_field_presenter_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Blacklight::FacetFieldPresenter, type: :presenter do
@@ -44,11 +45,11 @@ RSpec.describe Blacklight::FacetFieldPresenter, type: :presenter do
   describe '#active?' do
     it "checks if any value is selected for a given facet" do
       search_state.params[:f] = ActiveSupport::HashWithIndifferentAccess.new(key: [1])
-      expect(presenter.active?).to eq true
+      expect(presenter.active?).to be true
     end
 
     it "is false if no value for facet is selected" do
-      expect(presenter.active?).to eq false
+      expect(presenter.active?).to be false
     end
   end
 
@@ -59,12 +60,12 @@ RSpec.describe Blacklight::FacetFieldPresenter, type: :presenter do
       end
 
       it 'is true' do
-        expect(presenter.in_modal?).to eq true
+        expect(presenter.in_modal?).to be true
       end
     end
 
     it 'is false' do
-      expect(presenter.in_modal?).to eq false
+      expect(presenter.in_modal?).to be false
     end
   end
 
@@ -72,7 +73,9 @@ RSpec.describe Blacklight::FacetFieldPresenter, type: :presenter do
     let(:paginator) { Blacklight::FacetPaginator.new([{}, {}], limit: 1) }
 
     before do
-      allow(view_context).to receive(:facet_paginator).and_return(paginator)
+      # rubocop:disable RSpec/SubjectStub
+      allow(presenter).to receive(:paginator).and_return(paginator)
+      # rubocop:enable RSpec/SubjectStub
     end
 
     context 'with no additional data' do
@@ -97,13 +100,6 @@ RSpec.describe Blacklight::FacetFieldPresenter, type: :presenter do
     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 }
 
@@ -112,4 +108,81 @@ RSpec.describe Blacklight::FacetFieldPresenter, type: :presenter do
       expect(paginator.total_count).to eq 0
     end
   end
+
+  describe "#facet_limit" do
+    subject(:facet_limit) { presenter.facet_limit }
+
+    let(:search_state) { Blacklight::SearchState.new({}, blacklight_config, controller) }
+    let(:blacklight_config) { CatalogController.blacklight_config }
+    let(:facet_field) { blacklight_config.facet_fields['subject_ssim'] }
+    let(:display_facet) do
+      instance_double(Blacklight::Solr::Response::Facets::FacetField, items: items, limit: nil, sort: :index, offset: 0, prefix: nil)
+    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
+
+    it "returns specified value for facet_field specified" do
+      expect(facet_limit).to eq facet_field.limit
+    end
+
+    describe "for 'true' configured values" do
+      let(:blacklight_config) do
+        Blacklight::Configuration.new do |config|
+          config.add_facet_field "language_facet", limit: true
+        end
+      end
+      let(:facet_field) { blacklight_config.facet_fields['language_facet'] }
+
+      context 'when the limit in the response is nil' do
+        let(:display_facet) do
+          instance_double(Blacklight::Solr::Response::Facets::FacetField, items: items, limit: nil, sort: :index, offset: 0, prefix: nil)
+        end
+
+        it "uses the config setting" do
+          blacklight_config.facet_fields['language_facet'].limit = 10
+          expect(facet_limit).to eq 10
+        end
+      end
+
+      context 'when the limit in the response is provided' do
+        let(:display_facet) do
+          instance_double(Blacklight::Solr::Response::Facets::FacetField, items: items, limit: 16, sort: :index, offset: 0, prefix: nil)
+        end
+
+        it "gets the limit from the facet field in @response" do
+          expect(facet_limit).to eq 15
+        end
+      end
+
+      context 'when not in the display_facet' do
+        let(:display_facet) { nil }
+
+        it "defaults to 10" do
+          expect(facet_limit).to eq 10
+        end
+      end
+    end
+
+    context 'for facet fields with a key that is different from the field name' do
+      before do
+        allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
+      end
+
+      let(:blacklight_config) do
+        Blacklight::Configuration.new do |config|
+          config.add_facet_field 'some_key', field: 'x', limit: true
+        end
+      end
+      let(:facet_field) { blacklight_config.facet_fields['some_key'] }
+      let(:display_facet) do
+        instance_double(Blacklight::Solr::Response::Facets::FacetField, items: items, limit: 16, sort: :index, offset: 0, prefix: nil)
+      end
+
+      it 'gets the limit from the facet field in the @response' do
+        expect(facet_limit).to eq 15
+      end
+    end
+  end
 end

data/spec/presenters/blacklight/facet_grouped_item_presenter_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Blacklight::FacetGroupedItemPresenter, type: :presenter do

data/spec/presenters/blacklight/facet_item_presenter_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Blacklight::FacetItemPresenter, type: :presenter do
@@ -7,22 +8,22 @@ RSpec.describe Blacklight::FacetItemPresenter, type: :presenter do
   end
 
   let(:facet_item) { instance_double(Blacklight::Solr::Response::Facets::FacetItem) }
+  let(:filter_field) { instance_double(Blacklight::SearchState::FilterField, include?: true) }
   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) }
+  let(:search_state) { instance_double(Blacklight::SearchState, filter: filter_field) }
 
   describe '#selected?' do
-    it 'works' do
-      allow(search_state).to receive(:has_facet?).and_return(true)
-      expect(presenter.selected?).to be true
-    end
+    subject { presenter.selected? }
+
+    it { is_expected.to be true }
   end
 
   describe '#label' do
-    it "is the facet value for an ordinary facet" do
+    it "is the stringified 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
+      expect(presenter.label).to eq facet_item.to_s
     end
 
     it "allows you to pass in a :helper_method argument to the configuration" do
@@ -63,9 +64,7 @@ RSpec.describe Blacklight::FacetItemPresenter, type: :presenter do
   end
 
   describe '#href' do
-    before do
-      allow(search_state).to receive(:has_facet?).and_return(false)
-    end
+    let(:filter_field) { instance_double(Blacklight::SearchState::FilterField, include?: false) }
 
     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')
@@ -87,11 +86,13 @@ RSpec.describe Blacklight::FacetItemPresenter, type: :presenter do
     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({})
+      let(:filter_field) { instance_double(Blacklight::SearchState::FilterField, include?: true, remove: {}) }
+
+      before do
         allow(view_context).to receive(:search_action_path).with({}).and_return('/catalog')
+      end
 
+      it 'is the url to remove the facet' do
         expect(presenter.href).to eq '/catalog'
       end
     end

data/spec/presenters/blacklight/field_presenter_spec.rb

@@ -36,7 +36,6 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
       config.add_index_field 'solr_doc_accessor', accessor: true
       config.add_index_field 'explicit_accessor', accessor: :solr_doc_accessor
       config.add_index_field 'explicit_array_accessor', accessor: [:solr_doc_accessor, :some_method]
-      config.add_index_field 'explicit_values', values: ->(_config, _doc) { ['some-value'] }
       config.add_index_field 'explicit_values_with_context', values: ->(_config, _doc, view_context) { [view_context.params[:x]] }
       config.add_index_field 'alias', field: 'qwer'
       config.add_index_field 'with_default', default: 'value'
@@ -162,15 +161,6 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
       end
     end
 
-    context 'when the values lambda is provided' do
-      let(:field_name) { 'explicit_values' }
-
-      it 'calls the accessors on the return of the preceeding' do
-        allow(Deprecation).to receive(:warn)
-        expect(subject).to eq 'some-value'
-      end
-    end
-
     context 'when the values lambda is provided and accepts the view contexts' do
       let(:field_name) { 'explicit_values_with_context' }
 
@@ -241,10 +231,6 @@ RSpec.describe Blacklight::FieldPresenter, api: true do
 
     let(:field_config) { double('field config', if: true, unless: false, except_operations: nil) }
 
-    before do
-      allow(presenter).to receive_messages(document_has_value?: true)
-    end
-
     it { is_expected.to be true }
 
     context 'when the view context says not to render the field' do

data/spec/presenters/blacklight/index_presenter_spec.rb

@@ -22,18 +22,15 @@ RSpec.describe Blacklight::IndexPresenter, api: true do
 
   before do
     allow(request_context).to receive(:search_state).and_return(search_state)
-    allow(request_context).to receive(:action_name).and_return(:index)
   end
 
   describe '#fields' do
-    let(:field) { instance_double(Blacklight::Configuration::Field) }
-
     before do
-      allow(config).to receive(:index_fields_for).and_return(title: field)
+      config.add_index_field 'title'
     end
 
     it 'returns the list from the configs' do
-      expect(subject.send(:fields)).to eq(title: field)
+      expect(subject.send(:fields).keys).to eq ['title']
     end
   end
 

data/spec/presenters/blacklight/json_presenter_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Blacklight::JsonPresenter, api: true do

data/spec/presenters/blacklight/link_alternate_presenter_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Blacklight::LinkAlternatePresenter do
@@ -25,8 +26,8 @@ RSpec.describe Blacklight::LinkAlternatePresenter do
 
     let(:expected_html) do
       '<link rel="alternate" title="xml" type="application/xml" href="http://test.host/catalog/9999.xml" />' \
-      '<link rel="alternate" title="dc_xml" type="text/xml" href="http://test.host/catalog/9999.dc_xml" />' \
-      '<link rel="alternate" title="oai_dc_xml" type="text/xml" href="http://test.host/catalog/9999.oai_dc_xml" />'
+        '<link rel="alternate" title="dc_xml" type="text/xml" href="http://test.host/catalog/9999.dc_xml" />' \
+        '<link rel="alternate" title="oai_dc_xml" type="text/xml" href="http://test.host/catalog/9999.oai_dc_xml" />'
     end
 
     it { is_expected.to be_equivalent_to expected_html }