blacklight 6.14.0 → 7.0.0

data/spec/presenters/thumbnail_presenter_spec.rb

@@ -0,0 +1,174 @@
+# 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: ->(_, _) { '<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

data/spec/routing/catalog_routing_spec.rb

@@ -1,54 +1,52 @@
 # frozen_string_literal: true
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe "Routing" do
+RSpec.describe "Routing" do
   describe "Paths Generated by Custom Routes:" do
     # paths generated by custom routes
     it "has a path for showing the email form" do
-      expect(:get => "/catalog/email").to route_to(:controller => 'catalog', :action => 'email')
+      expect(get: "/catalog/email").to route_to(controller: 'catalog', action: 'email')
     end
     it "has a path for sending the email" do
-      expect(:post => "/catalog/email").to route_to(:controller => 'catalog', :action => 'email')
+      expect(post: "/catalog/email").to route_to(controller: 'catalog', action: 'email')
     end
     it "maps GET {:controller => 'catalog', :action => 'sms'} to /catalog/sms" do
-      expect(:get => "/catalog/sms").to route_to(:controller => 'catalog', :action => 'sms')
+      expect(get: "/catalog/sms").to route_to(controller: 'catalog', action: 'sms')
     end
     it "maps POST {:controller => 'catalog', :action => 'sms'} to /catalog/sms" do
-      expect(:post => "/catalog/sms").to route_to(:controller => 'catalog', :action => 'sms')
+      expect(post: "/catalog/sms").to route_to(controller: 'catalog', action: 'sms')
     end
     it "maps { :controller => 'catalog', :action => 'show', :id => 666 } to /catalog/666" do
-      expect(:get => "/catalog/666").to route_to(:controller => 'catalog', :action => 'show', :id => "666")
+      expect(get: "/catalog/666").to route_to(controller: 'catalog', action: 'show', id: "666")
     end
   end
 
-
-  describe "solr_document_path for SolrDocument", :test => true do
+  describe "solr_document_path for SolrDocument", test: true do
     it "routes correctly" do
-      expect(:get => solr_document_path(SolrDocument.new(:id => 'asdf'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'asdf')
+      expect(get: solr_document_path(SolrDocument.new(id: 'asdf'))).to route_to(controller: 'catalog', action: 'show', id: 'asdf')
     end
 
     context "should escape solr document ids" do
-
       it "pass-throughs url-valid ids" do
-        expect(:get => solr_document_path(SolrDocument.new(:id => 'qwerty'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'qwerty')
+        expect(get: solr_document_path(SolrDocument.new(id: 'qwerty'))).to route_to(controller: 'catalog', action: 'show', id: 'qwerty')
       end
 
       it "routes url-like ids" do
         skip "This works if you configure your routing to have very liberal constraints on :id.. not sure how to go about testing it though"
-        expect(:get => solr_document_path(SolrDocument.new(:id => 'http://example.com'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'http://example.com')
+        expect(get: solr_document_path(SolrDocument.new(id: 'http://example.com'))).to route_to(controller: 'catalog', action: 'show', id: 'http://example.com')
       end
 
       it "routes ids with whitespace" do
-        expect(:get => solr_document_path(SolrDocument.new(:id => 'mm 123'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'mm 123')
+        expect(get: solr_document_path(SolrDocument.new(id: 'mm 123'))).to route_to(controller: 'catalog', action: 'show', id: 'mm 123')
       end
 
       it "routes ids with a literal '+'" do
-        expect(:get => solr_document_path(SolrDocument.new(:id => 'this+that'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'this+that')
+        expect(get: solr_document_path(SolrDocument.new(id: 'this+that'))).to route_to(controller: 'catalog', action: 'show', id: 'this+that')
       end
 
       it "routes ids with a literal '/" do
         skip "This works if you configure your routing to have very liberal constraints on :id.. not sure how to go about testing it though"
-        expect(:get => solr_document_path(SolrDocument.new(:id => 'and/or'))).to route_to(:controller => 'catalog', :action => 'show', :id => 'and/or')
+        expect(get: solr_document_path(SolrDocument.new(id: 'and/or'))).to route_to(controller: 'catalog', action: 'show', id: 'and/or')
       end
     end
   end