blacklight 6.25.0 → 7.0.0.rc1

data/spec/helpers/blacklight_helper_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-describe BlacklightHelper do
+RSpec.describe BlacklightHelper do
   before(:each) do
     allow(helper).to receive(:current_or_guest_user).and_return(User.new)
     allow(helper).to receive(:search_action_path) do |*args|
@@ -7,13 +7,37 @@ describe BlacklightHelper do
     end
   end
 
-  describe "#application_name", :test => true do
+  describe "#application_name" do
+    before do
+      allow(Rails).to receive(:cache).and_return(ActiveSupport::Cache::NullStore.new)
+    end
     it "defaults to 'Blacklight'" do
       expect(application_name).to eq "Blacklight"
     end
-    it "uses the Rails application config application_name if available" do
-      allow(Rails.application).to receive(:config).and_return(double(application_name: "asdf"))
-      expect(application_name).to eq "asdf"
+
+    context "when the language is not english " do
+      around do |example|
+        I18n.locale = :de
+        example.run
+        I18n.locale = :en
+      end
+
+      context "and no translation exists for that language" do
+        it "defaults to 'Blacklight'" do
+          expect(application_name).to eq "Blacklight"
+        end
+      end
+
+      context "and a translation exists for that language" do
+        around do |example|
+          I18n.backend.store_translations(:de, 'blacklight' => { 'application_name' => 'Schwarzlicht' } )
+          example.run
+          I18n.backend.reload!
+        end
+        it "uses the provided value" do
+          expect(application_name).to eq "Schwarzlicht"
+        end
+      end
     end
   end
 
@@ -34,10 +58,11 @@ describe BlacklightHelper do
   describe "render_link_rel_alternates" do
     let(:document) { instance_double(SolrDocument) }
     let(:result) { double }
-    let(:presenter) { Blacklight::DocumentPresenter.new(document, self) }
+    let(:view_context) { double(blacklight_config: blacklight_config, document_index_view_type: 'index') }
+    let(:presenter) { Blacklight::IndexPresenter.new(document, view_context) }
     let(:blacklight_config) do
       Blacklight::Configuration.new.configure do |config|
-        config.index.title_field = 'title_display'
+        config.index.title_field = 'title_tsim'
         config.index.display_type_field = 'format'
       end
     end
@@ -61,11 +86,11 @@ describe BlacklightHelper do
   describe "with a config" do
     let(:config) do
       Blacklight::Configuration.new.configure do |config|
-        config.index.title_field = 'title_display'
+        config.index.title_field = 'title_tsim'
         config.index.display_type_field = 'format'
       end
     end
-    let(:document) { SolrDocument.new('title_display' => "A Fake Document", 'id'=>'8') }
+    let(:document) { SolrDocument.new('title_tsim' => "A Fake Document", 'id'=>'8') }
 
     before do
       config.add_show_tools_partial(:bookmark, partial: 'catalog/bookmark_control')
@@ -88,7 +113,7 @@ describe BlacklightHelper do
       it "renders partials" do
         allow(controller).to receive(:render_bookmarks_control?).and_return(true)
         response = helper.render_index_doc_actions(document)
-        expect(response).to have_selector(".bookmark_toggle")
+        expect(response).to have_selector(".bookmark-toggle")
       end
 
       it "is nil if no partials are renderable" do
@@ -106,7 +131,7 @@ describe BlacklightHelper do
     describe "render_show_doc_actions" do
       it "renders partials" do
         response = helper.render_show_doc_actions(document)
-        expect(response).to have_selector(".bookmark_toggle")
+        expect(response).to have_selector(".bookmark-toggle")
       end
     end
   end
@@ -151,50 +176,6 @@ describe BlacklightHelper do
     end
   end
 
-  context "render methods" do
-    let(:field) { "some_field" }
-    let(:doc) { instance_double(SolrDocument) }
-    let(:presenter) { instance_double(Blacklight::ShowPresenter) }
-    before do
-      allow(Deprecation).to receive(:warn) # TODO: purge Deprecations
-      allow(helper).to receive(:presenter).with(doc).and_return(presenter)
-    end
-
-    describe "#render_index_field_value" do
-      it "passes the document and field through to the presenter" do
-        expect(presenter).to receive(:field_value).with(field, {})
-        helper.render_index_field_value(doc, field)
-      end
-
-      it "allows the document and field to be passed as hash arguments" do
-        expect(presenter).to receive(:field_value).with(field, {})
-        helper.render_index_field_value(document: doc, field: field)
-      end
-
-      it "allows additional options to be passed to the presenter" do
-        expect(presenter).to receive(:field_value).with(field, x: 1)
-        helper.render_index_field_value(document: doc, field: field, x: 1)
-      end
-    end
-
-    describe "#render_document_show_field_value" do
-      it "passes the document and field through to the presenter" do
-        expect(presenter).to receive(:field_value).with(field, {})
-        helper.render_document_show_field_value(doc, field)
-      end
-
-      it "allows the document and field to be passed as hash arguments" do
-        expect(presenter).to receive(:field_value).with(field, {})
-        helper.render_document_show_field_value(document: doc, field: field)
-      end
-
-      it "allows additional options to be passed to the presenter" do
-        expect(presenter).to receive(:field_value).with(field, x: 1)
-        helper.render_document_show_field_value(document: doc, field: field, x: 1)
-      end
-    end
-  end
-
   describe "#document_has_value?" do
     let(:doc) { double(SolrDocument) }
     it "ifs the document has the field value" do
@@ -254,79 +235,6 @@ describe BlacklightHelper do
     end
   end
 
-  describe "#render_document_partials" do
-    let(:doc) { double }
-    before do
-      allow(helper).to receive_messages(document_partial_path_templates: [])
-      allow(helper).to receive_messages(document_index_view_type: 'index_header')
-    end
-
-    it "gets the document format from document_partial_name" do
-      allow(helper).to receive(:document_partial_name).with(doc, :xyz)
-      helper.render_document_partial(doc, :xyz)
-    end
-  end
-
-  describe "#document_partial_name" do
-    let(:blacklight_config) { Blacklight::Configuration.new }
-    before do
-      allow(helper).to receive_messages(blacklight_config: blacklight_config)
-    end
-
-    context "with a solr document with empty fields" do
-      let(:document) { SolrDocument.new }
-      it "is the default value" do
-        expect(helper.document_partial_name(document)).to eq 'default'
-      end
-    end
-
-    context "with a solr document with the display type field set" do
-      let(:document) { SolrDocument.new 'my_field' => 'xyz'}
-      before do
-        blacklight_config.show.display_type_field = 'my_field'
-      end
-
-      it "uses the value in the configured display type field" do
-        expect(helper.document_partial_name(document)).to eq 'xyz'
-      end
-      it "uses the value in the configured display type field if the action-specific field is empty" do
-        expect(helper.document_partial_name(document, :some_action)).to eq 'xyz'
-      end
-    end
-
-    context "with a solr doucment with an action-specific field set" do
-      let(:document) { SolrDocument.new 'my_field' => 'xyz', 'other_field' => 'abc' }
-      before do
-        blacklight_config.show.media_display_type_field = 'my_field'
-        blacklight_config.show.metadata_display_type_field = 'other_field'
-      end
-      it "uses the value in the action-specific fields" do
-        expect(helper.document_partial_name(document, :media)).to eq 'xyz'
-        expect(helper.document_partial_name(document, :metadata)).to eq 'abc'
-      end
-    end
-  end
-
-  describe "#type_field_to_partial_name" do
-    let(:document) { double }
-    context "with default value" do
-      subject { helper.type_field_to_partial_name(document, 'default') }
-      it { should eq 'default' }
-    end
-    context "with spaces" do
-      subject { helper.type_field_to_partial_name(document, 'one two three') }
-      it { should eq 'one_two_three' }
-    end
-    context "with hyphens" do
-      subject { helper.type_field_to_partial_name(document, 'one-two-three') }
-      it { should eq 'one_two_three' }
-    end
-    context "an array" do
-      subject { helper.type_field_to_partial_name(document, ['one', 'two', 'three']) }
-      it { should eq 'one_two_three' }
-    end
-  end
-
   describe "#opensearch_description_tag" do
     subject { helper.opensearch_description_tag 'title', 'href' }
     it "has a search rel" do
@@ -417,19 +325,6 @@ describe BlacklightHelper do
       allow(helper).to receive(:blacklight_config).and_return(blacklight_config)
     end
 
-    describe "#presenter_class" do
-      it "uses the value defined in the blacklight configuration" do
-        expect(Deprecation).to receive(:warn).exactly(2).times
-        blacklight_config.document_presenter_class = presenter_class
-        expect(helper.presenter_class).to eq presenter_class
-      end
-
-      it "defaults to Blacklight::DocumentPresenter" do
-        expect(Deprecation).to receive(:warn)
-        expect(helper.presenter_class).to eq Blacklight::DocumentPresenter
-      end
-    end
-
     describe "#index_presenter_class" do
       it "uses the value defined in the blacklight configuration" do
         blacklight_config.index.document_presenter_class = presenter_class

data/spec/helpers/catalog_helper_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe CatalogHelper do
+RSpec.describe CatalogHelper do
   include ERB::Util
   include CatalogHelper
 
@@ -174,6 +174,9 @@ describe CatalogHelper do
   end
 
   describe "should_autofocus_on_search_box?" do
+    before do
+      expect(Deprecation).to receive(:warn)
+    end
     it "is focused if we're on a catalog-like index page without query or facet parameters" do
       allow(helper).to receive_messages(controller: CatalogController.new, action_name: "index", has_search_parameters?: false)
       expect(helper.should_autofocus_on_search_box?).to be true
@@ -196,89 +199,67 @@ describe CatalogHelper do
   end
 
   describe "has_thumbnail?" do
-    let(:document) { instance_double(SolrDocument) }
+    before do
+      expect(Deprecation).to receive(:warn)
+    end
+
+    let(:document) { SolrDocument.new(data) }
+    let(:data) { {} }
+
     it "has a thumbnail if a thumbnail_method is configured" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
+      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz, document_presenter_class: Blacklight::IndexPresenter) ))
       expect(helper.has_thumbnail? document).to be true
     end
 
-    it "has a thumbnail if a thumbnail_field is configured and it exists in the document" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
-      allow(document).to receive_messages(has?: true)
-      expect(helper.has_thumbnail? document).to be true
+    context "if a thumbnail_field is configured and it exists in the document" do
+      let(:data) { { xyz: 'abc' } }
+      it "has a thumbnail" do
+        allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz, document_presenter_class: Blacklight::IndexPresenter) ))
+        expect(helper.has_thumbnail? document).to be true
+      end
     end
-    
+
     it "does not have a thumbnail if the thumbnail_field is missing from the document" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
+      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz, document_presenter_class: Blacklight::IndexPresenter) ))
       allow(document).to receive_messages(has?: false)
       expect(helper.has_thumbnail? document).to be false
     end
 
     it "does not have a thumbnail if none of the fields are configured" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new() ))
+      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(document_presenter_class: Blacklight::IndexPresenter) ))
       expect(helper.has_thumbnail? document).to be_falsey
     end
   end
 
   describe "render_thumbnail_tag" do
-    let(:document) { instance_double(SolrDocument) }
-    it "calls the provided thumbnail method" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
-      expect(helper).to receive_messages(:xyz => "some-thumbnail")
-
-      allow(helper).to receive(:link_to_document).with(document, "some-thumbnail", {})
-      helper.render_thumbnail_tag document
+    let(:index_presenter) do
+      instance_double(Blacklight::IndexPresenter, thumbnail: thumbnail_presenter)
     end
+    let(:thumbnail_presenter){ instance_double(Blacklight::ThumbnailPresenter) }
 
-    it "creates an image tag from the given field" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
-
-      allow(document).to receive(:has?).with(:xyz).and_return(true)
-      allow(document).to receive(:first).with(:xyz).and_return("http://example.com/some.jpg")
-
-      expect(helper).to receive(:link_to_document).with(document, image_tag("http://example.com/some.jpg"), {})
-      helper.render_thumbnail_tag document
-    end
-
-    it "does not link to the document if the url options are false" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
-      allow(helper).to receive_messages(:xyz => "some-thumbnail")
+    before do
       expect(Deprecation).to receive(:warn)
-      result = helper.render_thumbnail_tag document, {}, false
-      expect(result).to eq "some-thumbnail"
+      allow(helper).to receive(:index_presenter).with(document).and_return(index_presenter)
     end
 
-    it "does not link to the document if the url options have :suppress_link" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
-      allow(helper).to receive_messages(:xyz => "some-thumbnail")
-
-      result = helper.render_thumbnail_tag document, {}, suppress_link: true
-      expect(result).to eq "some-thumbnail"
-    end
-
-
-    it "returns nil if no thumbnail is available" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new() ))
-      expect(helper.render_thumbnail_tag document).to be_nil
-    end
-
-    it "returns nil if no thumbnail is returned from the thumbnail method" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_method => :xyz) ))
-      allow(helper).to receive_messages(:xyz => nil)
+    let(:document) { instance_double(SolrDocument) }
 
-      expect(helper.render_thumbnail_tag document).to be_nil
+    it "calls thumbnail presenter with default values" do
+      expect(thumbnail_presenter).to receive(:thumbnail_tag).with({}, {})
+      helper.render_thumbnail_tag document
     end
 
-    it "returns nil if no thumbnail is in the document" do
-      allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
-
-      allow(document).to receive(:has?).with(:xyz).and_return(false)
-
-      expect(helper.render_thumbnail_tag document).to be_nil
+    it "calls thumbnail presenter with provided values" do
+      expect(thumbnail_presenter).to receive(:thumbnail_tag).with({}, suppress_link: true)
+      result = helper.render_thumbnail_tag document, {}, suppress_link: true
     end
   end
 
   describe "thumbnail_url" do
+    before do
+      expect(Deprecation).to receive(:warn)
+    end
+
     it "pulls the configured thumbnail field out of the document" do
       allow(helper).to receive_messages(:blacklight_config => Blacklight::Configuration.new(:index => Blacklight::OpenStructWithHashAccess.new(:thumbnail_field => :xyz) ))
       document = instance_double(SolrDocument)

data/spec/integration/generators/blacklight/{solr5_generator_spec.rb → solr_generator_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
-require 'generators/blacklight/solr5_generator'
+require 'generators/blacklight/solr_generator'
 
-describe Blacklight::Solr5Generator do
+RSpec.describe Blacklight::SolrGenerator do
   let(:destination) { Dir.mktmpdir }
 
   describe "#solr_wrapper_config" do
@@ -57,4 +57,4 @@ describe Blacklight::Solr5Generator do
       end
     end
   end
-end
+end

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

@@ -0,0 +1,11 @@
+RSpec.describe Blacklight::Configuration::FacetField do
+  describe 'link_to_search' do
+    subject { described_class.new(link_to_search: true) }
+
+    it 'is deprecated' do
+      expect(Deprecation).to receive(:warn)
+      expect(subject.normalize!)
+      expect(subject.link_to_facet).to eq true
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+RSpec.describe Blacklight::Configuration::Field do
+  subject { described_class.new(key: key, label: label) }
+  let(:key) { 'some_key' }
+  let(:label) { 'some label' }
+
+  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.fields.my_context.some_key", default: [:"blacklight.search.fields.some_key", label, subject.default_label]).and_return('x')
+      expect(subject.display_label('my_context')).to eq 'x'
+    end
+  end
+end

data/spec/lib/blacklight/nested_open_struct_with_hash_access_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::NestedOpenStructWithHashAccess do
+  describe "#deep_dup" do
+    it "preserves the current class" do
+      expect(described_class.new(described_class).deep_dup).to be_a_kind_of described_class
+    end
+
+    it "preserves the default proc" do
+      nested = described_class.new Hash
+
+      copy = nested.deep_dup
+      copy.a[:b] = 1
+      expect(copy.a[:b]).to eq 1
+    end
+  end
+end

data/spec/lib/blacklight/open_struct_with_hash_access_spec.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::OpenStructWithHashAccess do
+  it "provides hash-like accessors for OpenStruct data" do
+    a = described_class.new :foo => :bar, :baz => 1
+
+    expect(a[:foo]).to eq :bar
+    expect(a[:baz]).to eq 1
+    expect(a[:asdf]).to be_nil
+  end
+
+  it "provides hash-like writers for OpenStruct data" do
+    a = described_class.new :foo => :bar, :baz => 1
+
+    a[:asdf] = 'qwerty'
+    expect(a.asdf).to eq 'qwerty'
+
+  end
+
+  it "treats symbols and strings interchangeably in hash access" do
+    h = described_class.new
+
+    h["string"] = "value"
+    expect(h[:string]).to eq "value"
+    expect(h.string).to eq "value"
+
+    h[:symbol] = "value"
+    expect(h["symbol"]).to eq "value"
+    expect(h.symbol).to eq "value"
+  end
+
+  describe "internal hash table" do
+    before do
+      @h = described_class.new
+      @h[:a] = 1
+      @h[:b] = 2
+    end
+
+    it "exposes the internal hash table" do
+      expect(@h.to_h).to be_a_kind_of(Hash)
+      expect(@h.to_h[:a]).to eq 1
+    end
+
+    it "exposes keys" do
+      expect(@h.keys).to include(:a, :b)
+    end
+
+  end
+
+  describe "#key?" do
+    subject do
+      h = described_class.new
+      h[:a] = 1
+      h[:b] = 2
+      h
+    end
+
+    it "is true if the key exists" do
+      expect(subject.key? :a).to eq true
+    end
+
+    it "is false if the key does not exist" do
+      expect(subject.key? :c).to eq false
+    end
+  end
+
+  describe "#replace" do
+    subject { described_class.new a: 1 }
+
+    it "can use #replace to reorder the hash" do
+      subject.replace b: 1
+      expect(subject.b).to eq 1
+    end
+  end
+
+  describe "#sort_by" do
+    subject { described_class.new c: 3, b:1, a: 2 }
+
+    it "sorts the underlying hash" do
+      sorted = subject.sort_by { |k,v| v }
+      expect(sorted.keys).to match_array [:b, :a, :c]
+    end
+  end
+
+  describe "#sort_by!" do
+    subject { described_class.new c: 3, b:1, a: 2 }
+
+    it "sorts the underlying hash" do
+      subject.sort_by! { |k,v| v }
+      expect(subject.keys).to match_array [:b, :a, :c]
+    end
+  end
+
+  describe "#merge" do
+
+    before do
+      @h = described_class.new
+      @h[:a] = 1
+      @h[:b] = 2
+    end
+
+    it "merges the object with a hash" do
+      expect(@h.merge(:a => 'a')[:a]).to eq 'a'
+    end
+
+    it "merges the object with another struct" do
+      expect(@h.merge(described_class.new(:a => 'a'))[:a]).to eq 'a'
+    end
+  end
+
+
+  describe "#merge!" do
+
+    before do
+      @h = described_class.new
+      @h[:a] = 1
+      @h[:b] = 2
+    end
+
+    it "merges the object with a hash" do
+      @h.merge!(:a => 'a')
+      expect(@h[:a]).to eq 'a'
+    end
+
+    it "merges the object with another struct" do
+      @h.merge!(described_class.new(:a => 'a'))
+      expect(@h[:a]).to eq 'a'
+    end
+  end
+
+  describe "#to_json" do
+    subject { described_class.new a: 1, b: 2}
+
+    it "serializes as json" do
+      expect(subject.to_json).to eq ({a: 1, b:2}).to_json
+    end
+  end
+
+  describe "#deep_dup" do
+    subject { described_class.new a: 1, b: { c: 1} }
+
+    it "duplicates nested hashes" do
+      copy = subject.deep_dup
+      copy.a = 2
+      copy.b[:c] = 2
+
+      expect(subject.a).to eq 1
+      expect(subject.b[:c]).to eq 1
+      expect(copy.a).to eq 2
+      expect(copy.b[:c]).to eq 2
+    end
+  end
+end

data/spec/lib/blacklight/parameters_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Blacklight::Parameters do
+RSpec.describe Blacklight::Parameters do
   describe "sanitize_search_params" do
     subject { described_class.sanitize(params) }
 

data/spec/lib/blacklight/search_state_spec.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-describe Blacklight::SearchState do
+RSpec.describe Blacklight::SearchState do
   let(:blacklight_config) do
     Blacklight::Configuration.new.configure do |config|
-      config.index.title_field = 'title_display'
+      config.index.title_field = 'title_tsim'
       config.index.display_type_field = 'format'
     end
   end

data/spec/lib/blacklight_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Blacklight do
+RSpec.describe Blacklight do
   context 'root' do
     let(:blroot) { File.expand_path(File.join(__FILE__, '..', '..', '..' )) }
 

data/spec/lib/tasks/blacklight_task_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'rake'
 
-describe "blacklight:delete_old_searches" do
+RSpec.describe "blacklight:delete_old_searches" do
 
   before do
     @rake = Rake::Application.new