blacklight 7.33.0 → 8.0.0

data/spec/models/blacklight/document/active_model_shim_spec.rb

@@ -32,11 +32,11 @@ RSpec.describe 'Blacklight::Document::ActiveModelShim', api: true do
 
   describe "#==" do
     it 'is equal for the same id' do
-      expect(MockDocument.new(id: 1) == MockDocument.new(id: 1)).to eq true
+      expect(MockDocument.new(id: 1) == MockDocument.new(id: 1)).to be true
     end
 
     it 'is not equal if the ids differ' do
-      expect(MockDocument.new(id: 1) == MockDocument.new(id: 2)).to eq false
+      expect(MockDocument.new(id: 1) == MockDocument.new(id: 2)).to be false
     end
   end
 end

data/spec/models/blacklight/icon_spec.rb

@@ -1,7 +1,18 @@
 # frozen_string_literal: true
 
 RSpec.describe Blacklight::Icon do
-  subject { described_class.new(:search, classes: 'awesome', aria_hidden: true) }
+  subject(:instance) { described_class.new(:test, classes: 'awesome', aria_hidden: true) }
+
+  let(:svg) { String.new(Blacklight::Icons::SearchComponent.new.svg) }
+  let(:asset) { double(source: svg) }
+
+  before do
+    if defined?(Sprockets)
+      allow(Rails.application.assets).to receive(:find_asset).and_return(asset)
+    elsif defined?(Propshaft)
+      allow(Rails.application.assets.load_path).to receive(:find).and_return(asset)
+    end
+  end
 
   describe '#svg' do
     it 'returns a string' do
@@ -20,31 +31,31 @@ RSpec.describe Blacklight::Icon do
 
     it 'adds title' do
       expect(Capybara.string(subject.svg))
-        .to have_css 'title', text: 'Search'
+        .to have_css 'title', text: 'Test'
     end
 
     context 'when label is false' do
-      subject { described_class.new(:search, classes: 'awesome', aria_hidden: true, label: false) }
+      subject { described_class.new(:test, classes: 'awesome', aria_hidden: true, label: false) }
 
       it 'does not add title' do
         expect(Capybara.string(subject.svg))
-          .not_to have_css 'title', text: 'Search'
+          .not_to have_css 'title', text: 'Test'
       end
     end
 
-    context ' with a label context' do
-      subject { described_class.new(:search, classes: 'awesome', aria_hidden: true, additional_options: { label_context: 'foo' }) }
+    context 'with a label context' do
+      subject { described_class.new(:test, classes: 'awesome', aria_hidden: true, additional_options: { label_context: 'foo' }) }
 
       it 'adds title' do
         expect(Capybara.string(subject.svg))
-          .to have_css 'title', text: 'Search'
+          .to have_css 'title', text: 'Test'
       end
     end
   end
 
   describe '#options' do
     it 'applies options classes and default class' do
-      expect(subject.options[:class]).to eq 'blacklight-icons blacklight-icon-search awesome'
+      expect(subject.options[:class]).to eq 'blacklight-icons blacklight-icon-test awesome'
     end
 
     it 'applies options aria-hidden=true' do
@@ -59,30 +70,33 @@ RSpec.describe Blacklight::Icon do
       end
 
       it 'has no aria-hidden attribute with no options' do
-        expect(subject.options[:'aria-hidden']).to be nil
+        expect(subject.options[:'aria-hidden']).to be_nil
       end
     end
   end
 
   describe '#path' do
     it 'prepends blacklight and sufixes .svg' do
-      expect(subject.path).to eq 'blacklight/search.svg'
+      expect(subject.path).to eq 'blacklight/test.svg'
     end
   end
 
   describe 'file_source' do
+    subject(:file_source) { instance.file_source }
+
     context 'file is not available' do
       subject { described_class.new(:yolo) }
 
-      it {
-        expect { subject.file_source }
-          .to raise_error(Blacklight::Exceptions::IconNotFound)
-      }
+      let(:asset) { nil }
+
+      it 'raises an error when not found' do
+        expect { file_source }.to raise_error(Blacklight::Exceptions::IconNotFound)
+      end
     end
 
     context 'file is available' do
       it 'returns the filesource' do
-        expect(subject.file_source).to include '<svg'
+        expect(file_source).to include '<svg'
       end
     end
   end

data/spec/models/blacklight/search_builder_spec.rb

@@ -45,7 +45,7 @@ RSpec.describe Blacklight::SearchBuilder, api: true do
 
     it "is mutable" do
       subject.processor_chain.insert(-1, :d)
-      expect(subject.processor_chain).to match_array [:a, :b, :c, :d]
+      expect(subject.processor_chain).to contain_exactly(:a, :b, :c, :d)
     end
   end
 
@@ -56,7 +56,7 @@ RSpec.describe Blacklight::SearchBuilder, api: true do
       builder = subject.append(:d, :e)
       expect(subject.processor_chain).to eq processor_chain
       expect(builder.processor_chain).not_to eq subject.processor_chain
-      expect(builder.processor_chain).to match_array [:a, :b, :c, :d, :e]
+      expect(builder.processor_chain).to contain_exactly(:a, :b, :c, :d, :e)
     end
   end
 
@@ -68,7 +68,7 @@ RSpec.describe Blacklight::SearchBuilder, api: true do
       expect(builder).not_to equal(subject)
       expect(subject.processor_chain).to eq processor_chain
       expect(builder.processor_chain).not_to eq subject.processor_chain
-      expect(builder.processor_chain).to match_array [:a, :c, :e]
+      expect(builder.processor_chain).to contain_exactly(:a, :c, :e)
     end
   end
 
@@ -234,50 +234,50 @@ RSpec.describe Blacklight::SearchBuilder, api: true do
 
   describe "#params_changed?" do
     it "is false" do
-      expect(subject.send(:params_changed?)).to eq false
+      expect(subject.send(:params_changed?)).to be false
     end
 
     it "is marked as changed when with() changes" do
       subject.with(a: 1)
-      expect(subject.send(:params_changed?)).to eq true
+      expect(subject.send(:params_changed?)).to be true
     end
 
     it "is marked as changed when where() changes" do
       subject.where(a: 1)
-      expect(subject.send(:params_changed?)).to eq true
+      expect(subject.send(:params_changed?)).to be true
     end
 
     it "is marked as changed when the processor chain changes" do
       subject.append(:a)
-      expect(subject.send(:params_changed?)).to eq true
+      expect(subject.send(:params_changed?)).to be true
     end
 
     it "is marked as changed when merged parameters are added" do
       subject.merge(a: 1)
-      expect(subject.send(:params_changed?)).to eq true
+      expect(subject.send(:params_changed?)).to be true
     end
 
     it "is marked as changed when reverse merged parameters are added" do
       subject.reverse_merge(a: 1)
-      expect(subject.send(:params_changed?)).to eq true
+      expect(subject.send(:params_changed?)).to be true
     end
 
     it "is marked as changed when pagination changes" do
       expect(subject).to receive(:page=).with(1).and_call_original
       subject.page(1)
-      expect(subject.send(:params_changed?)).to eq true
+      expect(subject.send(:params_changed?)).to be true
     end
 
     it "is marked as changed when rows changes" do
       expect(subject).to receive(:rows=).with(1).and_call_original
       subject.rows(1)
-      expect(subject.send(:params_changed?)).to eq true
+      expect(subject.send(:params_changed?)).to be true
     end
 
     it "is marked as changed when start offset changes" do
       expect(subject).to receive(:start=).with(1).and_call_original
       subject.start(1)
-      expect(subject.send(:params_changed?)).to eq true
+      expect(subject.send(:params_changed?)).to be true
     end
   end
 end

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

@@ -21,9 +21,9 @@ RSpec.describe "Blacklight::Solr::Document", api: true do
     it 'creates a doc with hashy methods' do
       doc = SolrDocument.new('id' => 'SP2514N', 'inStock' => true, 'manu' => 'Samsung Electronics Co. Ltd.', 'name' => 'Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133', 'popularity' => 6, 'price' => 92.0, 'sku' => 'SP2514N', 'timestamp' => '2009-03-20T14:42:49.795Z', 'cat' => ['electronics', 'hard drive'], 'spell' => ['Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133'], 'features' => ['7200RPM, 8MB cache, IDE Ultra ATA-133', 'NoiseGuard, SilentSeek technology, Fluid Dynamic Bearing (FDB) motor'])
 
-      expect(doc.has?(:cat, /^elec/)).to eq true
-      expect(doc.has?(:cat, 'elec')).not_to eq true
-      expect(doc.has?(:cat, 'electronics')).to eq true
+      expect(doc.has?(:cat, /^elec/)).to be true
+      expect(doc.has?(:cat, 'elec')).not_to be true
+      expect(doc.has?(:cat, 'electronics')).to be true
 
       expect(doc.fetch(:cat)).to eq ['electronics', 'hard drive']
       expect(doc.fetch(:xyz, nil)).to be_nil

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

@@ -45,7 +45,7 @@ RSpec.describe Blacklight::Solr::Request, api: true do
       subject.append_query 'this is my query'
       subject.append_query 'another:query'
       expect(subject).not_to have_key 'q'
-      expect(subject.dig('json', 'query', 'bool', 'must')).to match_array ['this is my query', 'another:query']
+      expect(subject.dig('json', 'query', 'bool', 'must')).to contain_exactly('this is my query', 'another:query')
     end
   end
 
@@ -62,7 +62,7 @@ RSpec.describe Blacklight::Solr::Request, api: true do
       subject['q'] = 'some query'
       subject.append_boolean_query :must, 'also required'
 
-      expect(subject.dig('json', 'query', 'bool', 'must')).to match_array ['some query', 'also required']
+      expect(subject.dig('json', 'query', 'bool', 'must')).to contain_exactly('some query', 'also required')
     end
   end
 end

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

@@ -114,13 +114,13 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
 
       it "defaults to count if no value is found and the default limit is used" do
         expect(subject.aggregations['my_field'].sort).to eq 'count'
-        expect(subject.aggregations['my_field'].count?).to eq true
+        expect(subject.aggregations['my_field'].count?).to be true
       end
 
       it "defaults to index if no value is found and the limit is unlimited" do
         request_params['facet.limit'] = -1
         expect(subject.aggregations['my_field'].sort).to eq 'index'
-        expect(subject.aggregations['my_field'].index?).to eq true
+        expect(subject.aggregations['my_field'].index?).to be true
       end
     end
 
@@ -335,21 +335,21 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
     let(:response) do
       {
         facets: {
-          "count": 32,
-          "categories": {
-            "buckets": [
+          count: 32,
+          categories: {
+            buckets: [
               {
-                "val": "electronics",
-                "count": 12,
-                "max_price": 60
+                val: "electronics",
+                count: 12,
+                max_price: 60
               },
               {
-                "val": "currency",
-                "count": 4
+                val: "currency",
+                count: 4
               },
               {
-                "val": "memory",
-                "count": 3
+                val: "memory",
+                count: 3
               }
             ]
           }
@@ -375,25 +375,25 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
       let(:response) do
         {
           facets: {
-            "categories": {
-              "buckets": [
+            categories: {
+              buckets: [
                 {
-                  "val": "electronics",
-                  "count": 12,
-                  "top_manufacturer": {
-                    "buckets": [{
-                      "val": "corsair",
-                      "count": 3
+                  val: "electronics",
+                  count: 12,
+                  top_manufacturer: {
+                    buckets: [{
+                      val: "corsair",
+                      count: 3
                     }]
                   }
                 },
                 {
-                  "val": "currency",
-                  "count": 4,
-                  "top_manufacturer": {
-                    "buckets": [{
-                      "val": "boa",
-                      "count": 1
+                  val: "currency",
+                  count: 4,
+                  top_manufacturer: {
+                    buckets: [{
+                      val: "boa",
+                      count: 1
                     }]
                   }
                 }
@@ -413,7 +413,7 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
       let(:response) do
         {
           facets: {
-            "categories": {
+            categories: {
               "missing" => { "count" => 13 },
               "buckets" => [{ "val" => "India", "count" => 2 }, { "val" => "Iran", "count" => 2 }]
             }

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "spec_helper"
 
 RSpec.describe Blacklight::Solr::Response::GroupResponse, api: true do

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "spec_helper"
 
 RSpec.describe Blacklight::Solr::Response::Group, api: true do

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

@@ -43,7 +43,7 @@ RSpec.describe Blacklight::Solr::Response, api: true do
 
     expected = "electronics - 14, memory - 3, card - 2, connector - 2, drive - 2, graphics - 2, hard - 2, monitor - 2, search - 2, software - 2"
     received = first_facet.items.collect do |item|
-      item.value + ' - ' + item.hits.to_s
+      "#{item.value} - #{item.hits}"
     end.join(', ')
 
     expect(received).to eq expected
@@ -60,12 +60,19 @@ RSpec.describe Blacklight::Solr::Response, api: true do
     end
   end
 
+  it 'provides a null-object for facets that are not in the response' do
+    expect(r.aggregations).not_to include :some_null_object
+
+    expect(r.aggregations[:some_null_object]).to be_a Blacklight::Solr::Response::FacetField
+    expect(r.aggregations[:some_null_object].items).to be_blank
+  end
+
   it "provides kaminari pagination helpers" do
     expect(r.limit_value).to eq(r.rows)
     expect(r.offset_value).to eq(r.start)
     expect(r.total_count).to eq(r.total)
     expect(r.next_page).to eq(r.current_page + 1)
-    expect(r.prev_page).to eq(nil)
+    expect(r.prev_page).to be_nil
     expect(r.entry_name(count: 1)).to eq 'entry'
     expect(r.entry_name(count: 2)).to eq 'entries'
     expect(r.size).to eq 26

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
@@ -191,6 +191,14 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       end
     end
 
+    describe "for a missing string search" do
+      let(:user_params) { { q: nil } }
+
+      it "does not populate the q parameter in solr parameters" do
+        expect(subject).not_to have_key :q
+      end
+    end
+
     describe "for an empty string search" do
       let(:user_params) { { q: "" } }
 
@@ -216,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
@@ -355,14 +363,14 @@ 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
@@ -400,16 +408,6 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       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
       context 'when the user has not provided a value' do
         it 'sends the default sort parameter to solr' do
@@ -492,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
 
@@ -584,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
@@ -735,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