blacklight 7.40.0 → 8.0.0.beta1

data/spec/lib/tasks/blacklight_task_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rake'
 
 RSpec.describe "blacklight:delete_old_searches" do

data/spec/models/blacklight/configuration_spec.rb

@@ -39,13 +39,13 @@ RSpec.describe "Blacklight::Configuration", api: true do
     end
 
     it "has ordered hashes for field configuration" do
-      expect(config.facet_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
-      expect(config.index_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
-      expect(config.show_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
-      expect(config.search_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
-      expect(config.show_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
-      expect(config.search_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
-      expect(config.sort_fields).to be_a_kind_of ActiveSupport::HashWithIndifferentAccess
+      expect(config.facet_fields).to be_a_kind_of Hash
+      expect(config.index_fields).to be_a_kind_of Hash
+      expect(config.show_fields).to be_a_kind_of Hash
+      expect(config.search_fields).to be_a_kind_of Hash
+      expect(config.show_fields).to be_a_kind_of Hash
+      expect(config.search_fields).to be_a_kind_of Hash
+      expect(config.sort_fields).to be_a_kind_of Hash
     end
   end
 
@@ -96,28 +96,6 @@ RSpec.describe "Blacklight::Configuration", api: true do
     let(:image) { SolrDocument.new(format: 'Image') }
     let(:sound) { SolrDocument.new(format: 'Sound') }
 
-    context 'with deprecated behavior' do
-      before do
-        allow(Deprecation).to receive(:warn)
-      end
-
-      it 'accepts documents as an argument to index_fields_for' do
-        config.for_display_type "Image" do |c|
-          c.add_index_field :dimensions
-        end
-        config.add_index_field :title
-        expect(config.index_fields_for(image)).to have_key 'dimensions'
-      end
-
-      it 'accepts documents as an argument to show_fields_for' do
-        config.for_display_type "Image" do |c|
-          c.add_show_field :dimensions
-        end
-        config.add_show_field :title
-        expect(config.show_fields_for(image)).to have_key 'dimensions'
-      end
-    end
-
     it "adds index fields just for a certain type" do
       config.for_display_type "Image" do |c|
         c.add_index_field :dimensions
@@ -183,18 +161,6 @@ RSpec.describe "Blacklight::Configuration", api: true do
       end
     end
 
-    context "when model classes are not set" do
-      it "leaves response_model and document_model empty" do
-        expect(config_copy.fetch(:response_model, nil)).to be_nil
-        expect(config_copy.fetch(:document_model, nil)).to be_nil
-      end
-
-      it "returns default classes" do
-        expect(config_copy.response_model).to eq Blacklight::Solr::Response
-        expect(config_copy.document_model).to eq SolrDocument
-      end
-    end
-
     it "provides cloned copies of mutable data structures" do
       config.a = { value: 1 }
       config.b = [1, 2, 3]
@@ -327,17 +293,17 @@ RSpec.describe "Blacklight::Configuration", api: true do
 
     describe "if/unless conditions with legacy show parameter" do
       it "is hidden if the if condition is false" do
-        expect(config.add_facet_field("hidden", if: false).if).to eq false
-        expect(config.add_facet_field("hidden_with_legacy", if: false, show: true).if).to eq false
+        expect(config.add_facet_field("hidden", if: false).if).to be false
+        expect(config.add_facet_field("hidden_with_legacy", if: false, show: true).if).to be false
       end
 
       it "is true if the if condition is true" do
-        expect(config.add_facet_field("hidden", if: true).if).to eq true
-        expect(config.add_facet_field("hidden_with_legacy", if: true, show: false).if).to eq true
+        expect(config.add_facet_field("hidden", if: true).if).to be true
+        expect(config.add_facet_field("hidden_with_legacy", if: true, show: false).if).to be true
       end
 
       it "is true if the if condition is missing" do
-        expect(config.add_facet_field("hidden", show: true).if).to eq true
+        expect(config.add_facet_field("hidden", show: true).if).to be true
       end
     end
   end
@@ -498,17 +464,17 @@ RSpec.describe "Blacklight::Configuration", api: true do
 
     describe "if/unless conditions with legacy include_in_simple_search" do
       it "is hidden if the if condition is false" do
-        expect(config.add_search_field("hidden", if: false).if).to eq false
-        expect(config.add_search_field("hidden_with_legacy", if: false, include_in_simple_search: true).if).to eq false
+        expect(config.add_search_field("hidden", if: false).if).to be false
+        expect(config.add_search_field("hidden_with_legacy", if: false, include_in_simple_search: true).if).to be false
       end
 
       it "is true if the if condition is true" do
-        expect(config.add_search_field("hidden", if: true).if).to eq true
-        expect(config.add_search_field("hidden_with_legacy", if: true, include_in_simple_search: false).if).to eq true
+        expect(config.add_search_field("hidden", if: true).if).to be true
+        expect(config.add_search_field("hidden_with_legacy", if: true, include_in_simple_search: false).if).to be true
       end
 
       it "is true if the if condition is missing" do
-        expect(config.add_search_field("hidden", include_in_simple_search: true).if).to eq true
+        expect(config.add_search_field("hidden", include_in_simple_search: true).if).to be true
       end
     end
   end

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,20 @@
 # 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
+    # FileUtils.mkdir_p '.internal_test_app/app/assets/images/blacklight'
+    # File.write '.internal_test_app/app/assets/images/blacklight/test.svg', Blacklight::Icons::SearchComponent.new.svg
+  end
 
   describe '#svg' do
     it 'returns a string' do
@@ -20,31 +33,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 +72,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

@@ -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/repository_spec.rb

@@ -73,24 +73,6 @@ RSpec.describe Blacklight::Solr::Repository, api: true do
     end
   end
 
-  describe '#find_many' do
-    context 'with a configured fetch_many_documents_path' do
-      it 'uses the path' do
-        blacklight_config.fetch_many_documents_path = 'documents'
-        allow(subject.connection).to receive(:send_and_receive).with('documents', anything).and_return(mock_response)
-        expect(subject.find_many({})).to be_a Blacklight::Solr::Response
-      end
-    end
-
-    context 'without a configured fetch_many_documents_path' do
-      it 'falls back to the search path' do
-        blacklight_config.solr_path = 'xyz'
-        allow(subject.connection).to receive(:send_and_receive).with('xyz', anything).and_return(mock_response)
-        expect(subject.find_many({})).to be_a Blacklight::Solr::Response
-      end
-    end
-  end
-
   describe "#search" do
     it "uses the search-specific solr path" do
       blacklight_config.solr_path = 'xyz'
@@ -171,33 +153,6 @@ RSpec.describe Blacklight::Solr::Repository, api: true do
         expect(JSON.parse(actual_params[:data]).with_indifferent_access).to include(query: { bool: {} })
         expect(actual_params[:headers]).to include({ 'Content-Type' => 'application/json' })
       end
-
-      context "without a json solr path configured" do
-        before do
-          blacklight_config.json_solr_path = nil
-        end
-
-        it "uses the default solr path" do
-          blacklight_config.solr_path = 'xyz'
-          allow(subject.connection).to receive(:send_and_receive) do |path|
-            expect(path).to eq 'xyz'
-          end
-          subject.search(input_params)
-        end
-      end
-
-      context "with a json solr path configured" do
-        before do
-          blacklight_config.json_solr_path = 'my-great-json'
-        end
-
-        it "uses the configured json_solr_path" do
-          allow(subject.connection).to receive(:send_and_receive) do |path|
-            expect(path).to eq 'my-great-json'
-          end
-          subject.search(input_params)
-        end
-      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