blacklight 6.24.0 → 7.0.0.rc1

data/spec/presenters/pipeline_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Blacklight::Rendering::Pipeline do
+RSpec.describe Blacklight::Rendering::Pipeline do
   include Capybara::RSpecMatchers
   let(:document) { instance_double(SolrDocument) }
   let(:context) { double }
@@ -10,18 +10,18 @@ describe Blacklight::Rendering::Pipeline do
   describe "render" do
     subject { presenter.render }
     let(:values) { ['a', 'b'] }
-    let(:field_config) { Blacklight::Configuration::NullField.new } 
+    let(:field_config) { Blacklight::Configuration::NullField.new }
     it { is_expected.to eq "a and b" }
 
     context "when separator_options are in the config" do
       let(:values) { ['c', 'd'] }
-      let(:field_config) { Blacklight::Configuration::NullField.new(separator: nil, itemprop: nil, separator_options: { two_words_connector: '; '}) } 
+      let(:field_config) { Blacklight::Configuration::NullField.new(itemprop: nil, separator_options: { two_words_connector: '; '}) }
       it { is_expected.to eq "c; d" }
     end
 
     context "when itemprop is in the config" do
       let(:values) { ['a'] }
-      let(:field_config) { Blacklight::Configuration::NullField.new(separator: nil, itemprop: 'some-prop', separator_options: nil) } 
+      let(:field_config) { Blacklight::Configuration::NullField.new(itemprop: 'some-prop', separator_options: nil) }
       it { is_expected.to have_selector("span[@itemprop='some-prop']", :text => "a") }
     end
   end

data/spec/presenters/show_presenter_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Blacklight::ShowPresenter do
+RSpec.describe Blacklight::ShowPresenter do
   include Capybara::RSpecMatchers
   let(:request_context) { double }
   let(:config) { Blacklight::Configuration.new }
@@ -14,9 +14,10 @@ describe Blacklight::ShowPresenter do
 
   let(:document) do
     SolrDocument.new(id: 1,
-                     'link_to_search_true' => 'x',
-                     'link_to_search_named' => 'x',
-                     'qwer' => 'document qwer value')
+                     'link_to_facet_true' => 'x',
+                     'link_to_facet_named' => 'x',
+                     'qwer' => 'document qwer value',
+                     'mnbv' => 'document mnbv value')
   end
 
   before do
@@ -96,155 +97,118 @@ describe Blacklight::ShowPresenter do
     end
   end
 
-  describe '#field_value' do
-    subject { presenter.field_value field }
-
-    let(:field) { config.show_fields[field_name] }
-    let(:field_name) { 'asdf' }
+  describe "field_value" do
     let(:config) do
       Blacklight::Configuration.new.configure do |config|
         config.add_show_field 'qwer'
-        config.add_show_field 'asdf', helper_method: :render_asdf_document_show_field
-        config.add_show_field 'link_to_search_true', link_to_search: true
-        config.add_show_field 'link_to_search_named', link_to_search: :some_field
-        config.add_show_field 'highlight', highlight: true
-        config.add_show_field 'solr_doc_accessor', accessor: true
-        config.add_show_field 'explicit_accessor', accessor: :solr_doc_accessor
-        config.add_show_field 'explicit_array_accessor', accessor: [:solr_doc_accessor, :some_method]
+        config.add_show_field 'asdf', :helper_method => :render_asdf_document_show_field
+        config.add_show_field 'link_to_facet_true', :link_to_facet => true
+        config.add_show_field 'link_to_facet_named', :link_to_facet => :some_field
+        config.add_show_field 'highlight', :highlight => true
+        config.add_show_field 'solr_doc_accessor', :accessor => true
+        config.add_show_field 'explicit_accessor', :accessor => :solr_doc_accessor
+        config.add_show_field 'explicit_array_accessor', :accessor => [:solr_doc_accessor, :some_method]
+        config.add_show_field 'explicit_accessor_with_arg', :accessor => :solr_doc_accessor_with_arg
       end
     end
 
-    context 'when a name is provided' do
-      subject { presenter.field_value 'qwer' }
-
-      it 'raises a deprecation' do
-        expect(Deprecation).to receive(:warn)
-        expect(subject).to eq 'document qwer value'
-      end
+    it 'html-escapes values' do
+      value = subject.field_value 'asdf', value: '<b>val1</b>'
+      expect(value).to eq '&lt;b&gt;val1&lt;/b&gt;'
     end
 
-    context 'when an explicit html value is provided' do
-      subject { presenter.field_value field, value: '<b>val1</b>' }
-
-      it { is_expected.to eq '&lt;b&gt;val1&lt;/b&gt;' }
+    it 'joins multivalued valued fields' do
+      value = subject.field_value 'asdf', value: ['<a', 'b']
+      expect(value).to eq '&lt;a and b'
     end
 
-    context 'when an explicit array value with unsafe characters is provided' do
-      subject { presenter.field_value field, value: ['<a', 'b'] }
-
-      it { is_expected.to eq '&lt;a and b' }
+    it 'joins multivalued valued fields' do
+      value = subject.field_value 'asdf', value: ['a', 'b', 'c']
+      expect(value).to eq 'a, b, and c'
     end
 
-    context 'when an explicit array value is provided' do
-      subject { presenter.field_value field, value: %w[a b c] }
-
-      it { is_expected.to eq 'a, b, and c' }
+    it "checks for an explicit value" do
+      expect(request_context).to_not receive(:render_asdf_document_show_field)
+      value = subject.field_value 'asdf', :value => 'val1'
+      expect(value).to eq 'val1'
     end
 
-    context 'when an explicit value is provided' do
-      subject { presenter.field_value field, value: 'val1' }
-
-      it { is_expected.to eq 'val1' }
+    it "checks for a helper method to call" do
+      allow(request_context).to receive(:render_asdf_document_show_field).and_return('custom asdf value')
+      value = subject.field_value 'asdf'
+      expect(value).to eq 'custom asdf value'
     end
 
-    context 'when field has a helper method' do
-      before do
-        allow(request_context).to receive(:render_asdf_document_show_field).and_return('custom asdf value')
-      end
-
-      it { is_expected.to eq 'custom asdf value' }
-    end
-
-    context 'when field has link_to_search with true' do
-      before do
-        allow(request_context).to receive(:search_action_path).with('f' => { 'link_to_search_true' => ['x'] }).and_return('/foo')
-        allow(request_context).to receive(:link_to).with("x", '/foo').and_return('bar')
-      end
-
-      let(:field_name) { 'link_to_search_true' }
-
-      it { is_expected.to eq 'bar' }
+    it "checks for a link_to_facet" do
+      allow(request_context).to receive(:search_action_path).and_return('/foo')
+      allow(request_context).to receive(:link_to).with("x", '/foo').and_return('bar')
+      value = subject.field_value 'link_to_facet_true'
+      expect(value).to eq 'bar'
     end
 
-    context 'when field has link_to_search with a field name' do
-      before do
-        allow(request_context).to receive(:search_action_path).with('f' => { 'some_field' => ['x'] }).and_return('/foo')
-        allow(request_context).to receive(:link_to).with("x", '/foo').and_return('bar')
-      end
-
-      let(:field_name) { 'link_to_search_named' }
-
-      it { is_expected.to eq 'bar' }
+    it "checks for a link_to_facet with a field name" do
+      allow(request_context).to receive(:search_action_path).and_return('/foo')
+      allow(request_context).to receive(:link_to).with("x", '/foo').and_return('bar')
+      value = subject.field_value 'link_to_facet_named'
+      expect(value).to eq 'bar'
     end
 
-    context 'when no highlight field is available' do
+    context "when no highlight field is available" do
       before do
         allow(document).to receive(:has_highlight_field?).and_return(false)
       end
-
-      let(:field_name) { 'highlight' }
-
-      it { is_expected.to be_blank }
-    end
-
-    context 'when highlight field is available' do
-      before do
-        allow(document).to receive(:has_highlight_field?).and_return(true)
-        allow(document).to receive(:highlight_field).with('highlight').and_return(['<em>highlight</em>'.html_safe])
+      let(:value) { subject.field_value 'highlight' }
+      it "is blank" do
+        expect(value).to be_blank
       end
-
-      let(:field_name) { 'highlight' }
-
-      it { is_expected.to eq '<em>highlight</em>' }
     end
 
-    context 'when highlight returns multiple values' do
-      before do
-        allow(document).to receive(:has_highlight_field?).and_return(true)
-        allow(document).to receive(:highlight_field).with('highlight').and_return(['<em>highlight</em>'.html_safe, '<em>other highlight</em>'.html_safe])
-      end
-
-      let(:field_name) { 'highlight' }
-
-      it { is_expected.to eq '<em>highlight</em> and <em>other highlight</em>' }
+    it "checks for a highlighted field" do
+      allow(document).to receive(:has_highlight_field?).and_return(true)
+      allow(document).to receive(:highlight_field).with('highlight').and_return(['<em>highlight</em>'.html_safe])
+      value = subject.field_value 'highlight'
+      expect(value).to eq '<em>highlight</em>'
     end
 
-    context 'when no options are provided' do
-      let(:field_name) { 'qwer' }
-
-      it "checks the document field value" do
-        expect(subject).to eq 'document qwer value'
-      end
+    it 'respects the HTML-safeness of multivalued highlight fields' do
+      allow(document).to receive(:has_highlight_field?).and_return(true)
+      allow(document).to receive(:highlight_field).with('highlight').and_return(['<em>highlight</em>'.html_safe, '<em>other highlight</em>'.html_safe])
+      value = subject.field_value 'highlight'
+      expect(value).to eq '<em>highlight</em> and <em>other highlight</em>'
     end
 
-    context 'when accessor is true' do
-      before do
-        allow(document).to receive_messages(solr_doc_accessor: "123")
-      end
-
-      let(:field_name) { 'solr_doc_accessor' }
-
-      it { is_expected.to eq '123' }
+    it "checks the document field value" do
+      value = subject.field_value 'qwer'
+      expect(value).to eq 'document qwer value'
     end
 
-    context 'when accessor is set to a value' do
-      let(:field_name) { 'explicit_accessor' }
-
-      it 'calls the accessor with the field_name as the argument' do
-        expect(document).to receive(:solr_doc_accessor).with('explicit_accessor').and_return("123")
+    it "works with show fields that aren't explicitly defined" do
+      value = subject.field_value 'mnbv'
+      expect(value).to eq 'document mnbv value'
+    end
 
-        expect(subject).to eq '123'
-      end
+    it "calls an accessor on the solr document" do
+      allow(document).to receive_messages(solr_doc_accessor: "123")
+      value = subject.field_value 'solr_doc_accessor'
+      expect(value).to eq "123"
     end
 
-    context 'when accessor is set to an array' do
-      let(:field_name) { 'explicit_array_accessor' }
+    it "calls an explicit accessor on the solr document" do
+      allow(document).to receive_messages(solr_doc_accessor: "123")
+      value = subject.field_value 'explicit_accessor'
+      expect(value).to eq "123"
+    end
 
-      it 'calls the accessors on the return of the preceeding' do
-        allow(document).to receive_message_chain(:solr_doc_accessor, some_method: "123")
+    it "calls an explicit array-style accessor on the solr document" do
+      allow(document).to receive_message_chain(:solr_doc_accessor, some_method: "123")
+      value = subject.field_value 'explicit_array_accessor'
+      expect(value).to eq "123"
+    end
 
-        expect(subject).to eq '123'
-      end
+    it "calls an accessor on the solr document with the field as an argument" do
+      allow(document).to receive(:solr_doc_accessor_with_arg).with('explicit_accessor_with_arg').and_return("123")
+      value = subject.field_value 'explicit_accessor_with_arg'
+      expect(value).to eq "123"
     end
   end
 
@@ -296,9 +260,8 @@ describe Blacklight::ShowPresenter do
     context 'for a field with the helper_method option' do
       let(:field_name) { 'field_with_helper' }
       let(:field_config) { config.add_facet_field 'field_with_helper', helper_method: 'render_field_with_helper' }
-
-      before do
-        document['field_with_helper'] = 'value'
+      let(:document) do
+        SolrDocument.new(id: 1, 'field_with_helper' => 'value')
       end
 
       it "checks call the helper method with arguments" do
@@ -319,30 +282,5 @@ describe Blacklight::ShowPresenter do
       end
     end
   end
-
-  describe 'deprecated methods' do
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-
-    let(:field_config) { config.add_index_field 'qwerty' }
-
-    describe '#get_field_values' do
-      it 'renders values for the given field' do
-        expect(subject.get_field_values(field_config, value: ['x', 'y'])).to eq 'x and y'
-      end
-    end
-
-    describe '#render_field_values' do
-      it 'renders values for the given field' do
-        expect(subject.render_field_values('x')).to eq 'x'
-      end
-    end
-
-    describe '#render_values' do
-      it 'renders values for the given field' do
-        expect(subject.render_values(['x', 'y', 'z'])).to eq 'x, y, and z'
-      end
-    end
-  end
 end
+

data/spec/presenters/thumbnail_presenter_spec.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+RSpec.describe Blacklight::ThumbnailPresenter do
+  include Capybara::RSpecMatchers
+  let(:view_context) { double "View context" }
+  let(:config) { Blacklight::Configuration.new.view_config(:index) }
+  let(:presenter) { described_class.new(document, view_context, config) }
+  let(:document) { SolrDocument.new }
+
+  describe "#exists?" do
+    subject { presenter.exists? }
+
+    context "when thumbnail_method is configured" do
+      let(:config) do
+        Blacklight::OpenStructWithHashAccess.new(thumbnail_method: :xyz)
+      end
+      it { is_expected.to be true }
+    end
+
+    context "when thumbnail_field is configured as a single field" do
+      let(:config) do
+        Blacklight::OpenStructWithHashAccess.new(thumbnail_field: :xyz)
+      end
+
+      context "and the field exists in the document" do
+        let(:document) { SolrDocument.new('xyz' => 'image.png') }
+
+        it { is_expected.to be true }
+      end
+
+      context "and the field is missing from the document" do
+        it { is_expected.to be false }
+      end
+    end
+
+    context "when thumbnail_field is configured as an array of fields" do
+      let(:config) do
+        Blacklight::OpenStructWithHashAccess.new(thumbnail_field: [:rst, :uvw, :xyz])
+      end
+
+      context "and the field exists in the document" do
+        let(:document) { SolrDocument.new('xyz' => 'image.png') }
+
+        it { is_expected.to be true }
+      end
+    end
+
+    context "when default_thumbnail is configured" do
+      let(:config) do
+        Blacklight::OpenStructWithHashAccess.new(default_thumbnail: 'image.png')
+      end
+
+      context "and the field exists in the document" do
+        it { is_expected.to be true }
+      end
+    end
+
+    context "without any configured options" do
+      it { is_expected.to be_falsey }
+    end
+  end
+
+  describe "#thumbnail_tag" do
+    subject { presenter.thumbnail_tag }
+    context "when thumbnail_method is configured" do
+      let(:config) do
+        Blacklight::OpenStructWithHashAccess.new(thumbnail_method: :xyz)
+      end
+
+      context "and the method returns a value" do
+        before do
+          allow(view_context).to receive_messages(xyz: "some-thumbnail")
+        end
+
+        it "calls the provided thumbnail method" do
+          expect(view_context).to receive_messages(xyz: "some-thumbnail")
+          allow(view_context).to receive(:link_to_document).with(document, "some-thumbnail", {})
+            .and_return("link")
+          expect(subject).to eq "link"
+        end
+
+        context "and url options have :suppress_link" do
+          subject { presenter.thumbnail_tag({}, suppress_link: true) }
+
+          it "does not link to the document" do
+            expect(subject).to eq "some-thumbnail"
+          end
+        end
+      end
+
+      context "and no value is returned from the thumbnail method" do
+        before do
+          allow(view_context).to receive_messages(xyz: nil)
+        end
+        it { is_expected.to be nil }
+      end
+    end
+
+    context "when thumbnail_field is configured" do
+      let(:config) do
+        Blacklight::OpenStructWithHashAccess.new(thumbnail_field: :xyz)
+      end
+
+      it "creates an image tag from the given field" do
+        allow(document).to receive(:first).with(:xyz).and_return("http://example.com/some.jpg")
+        allow(view_context).to receive(:image_tag).with("http://example.com/some.jpg", {}).and_return('<img src="image.jpg">')
+        expect(view_context).to receive(:link_to_document).with(document, '<img src="image.jpg">', {})
+        subject
+      end
+
+      it "returns nil if no thumbnail is in the document" do
+        allow(document).to receive(:first).with(:xyz).and_return(nil)
+        expect(subject).to be_nil
+      end
+    end
+
+    context "when thumbnail_field is configured as an array of fields" do
+      let(:config) do
+        Blacklight::OpenStructWithHashAccess.new(thumbnail_field: [:rst, :uvw, :xyz])
+      end
+
+      context "and the field exists in the document" do
+        let(:document) { SolrDocument.new(xyz: 'http://example.com/some.jpg') }
+
+        it "creates an image tag from the given field" do
+          allow(view_context).to receive(:image_tag).with("http://example.com/some.jpg", {}).and_return('<img src="image.jpg">')
+          expect(view_context).to receive(:link_to_document).with(document, '<img src="image.jpg">', {}).and_return('<a><img></a>')
+          expect(presenter.thumbnail_tag).to eq '<a><img></a>'
+        end
+      end
+    end
+
+    context "when default_thumbnail is configured" do
+      context "and is a string" do
+        let(:config) do
+          Blacklight::OpenStructWithHashAccess.new(default_thumbnail: 'image.png')
+        end
+
+        it "creates an image tag for the given asset" do
+          allow(view_context).to receive(:image_tag).with('image.png', {}).and_return('<img src="image.jpg">')
+          expect(presenter.thumbnail_tag({}, suppress_link: true)).to eq '<img src="image.jpg">'
+        end
+      end
+
+      context "and is a symbol" do
+        let(:config) do
+          Blacklight::OpenStructWithHashAccess.new(default_thumbnail: :get_a_default_thumbnail)
+        end
+
+        it "calls that helper method" do
+          allow(view_context).to receive(:get_a_default_thumbnail).with(document, {}).and_return('<img src="image.jpg">')
+          expect(presenter.thumbnail_tag({}, suppress_link: true)).to eq '<img src="image.jpg">'
+        end
+      end
+
+      context "and is a proc" do
+        let(:config) do
+          Blacklight::OpenStructWithHashAccess.new(default_thumbnail: lambda { |_, _| '<img src="image.jpg">' })
+        end
+
+        it "calls that lambda" do
+          expect(presenter.thumbnail_tag({}, suppress_link: true)).to eq '<img src="image.jpg">'
+        end
+      end
+    end
+
+    context "when no thumbnail is configured" do
+      it { is_expected.to be_nil }
+    end
+  end
+end