blacklight-spotlight 0.32.0 → 0.33.0

data/spec/models/spotlight/reindex_progress_spec.rb

@@ -1,32 +1,20 @@
 describe Spotlight::ReindexProgress, type: :model do
-  let(:reindexing_log_entries) do
-    [
-      # failed is the later of the two, and thus the return value for current_log_entry
-      FactoryGirl.create(:reindexing_log_entry, items_reindexed_estimate: 11),
-      FactoryGirl.create(:failed_reindexing_log_entry, items_reindexed_estimate: 12)
-    ]
+  let(:reindexing_log_entry) do
+    FactoryGirl.create(:failed_reindexing_log_entry, items_reindexed_estimate: 12)
   end
-  let(:exhibit) { FactoryGirl.create(:exhibit, reindexing_log_entries: reindexing_log_entries) }
 
-  let(:subject) { described_class.new(exhibit) }
+  let(:subject) { described_class.new(reindexing_log_entry) }
 
   describe '#started_at' do
     it 'returns start_time for current_log_entry' do
-      expect(subject.started_at).to eq(Time.zone.parse('2017-01-10 23:00:00'))
+      expect(subject.started_at).to eq reindexing_log_entry.start_time
     end
   end
 
   describe '#updated_at' do
-    # disable SkipsModelValidations cop for this test, because it complains about #touch, which is convenient here
-    # rubocop:disable Rails/SkipsModelValidations
     it 'returns the time of last update for current_log_entry' do
-      lower_bound = Time.zone.now
-      subject.send(:current_log_entry).touch
-      upper_bound = Time.zone.now
-
-      expect(subject.updated_at).to be_between(lower_bound, upper_bound)
+      expect(subject.updated_at).to eq reindexing_log_entry.updated_at
     end
-    # rubocop:enable Rails/SkipsModelValidations
   end
 
   describe '#finished?' do
@@ -37,7 +25,7 @@ describe Spotlight::ReindexProgress, type: :model do
 
   describe '#finished_at' do
     it 'returns end_time for current_log_entry' do
-      expect(subject.finished_at).to eq(Time.zone.parse('2017-01-10 23:05:00'))
+      expect(subject.finished_at).to eq(reindexing_log_entry.end_time)
     end
   end
 
@@ -55,7 +43,7 @@ describe Spotlight::ReindexProgress, type: :model do
 
   describe '#errored?' do
     it 'returns true for log entries marked as failed' do
-      expect(subject.errored?).to be true
+      expect(subject).to be_errored
     end
   end
 
@@ -63,88 +51,48 @@ describe Spotlight::ReindexProgress, type: :model do
     it 'returns a hash with values for current_log_entry via the various helper methods' do
       expect(subject.as_json).to eq(
         recently_in_progress: subject.recently_in_progress?,
-        started_at: subject.send(:localized_start_time),
-        finished_at: subject.send(:localized_finish_time),
-        updated_at: subject.send(:localized_updated_time),
+        started_at: I18n.l(reindexing_log_entry.start_time, format: :short),
+        finished_at: I18n.l(reindexing_log_entry.end_time, format: :short),
+        updated_at: I18n.l(reindexing_log_entry.updated_at, format: :short),
         total: subject.total,
         completed: subject.completed,
-        errored: subject.errored?
+        errored: subject.errored?,
+        finished: subject.finished?
       )
     end
   end
 
   describe '#recently_in_progress?' do
     context 'there is no end_time for current_log_entry' do
-      let(:current_log_entry) { FactoryGirl.create(:in_progress_reindexing_log_entry) }
-      let(:exhibit) { FactoryGirl.create(:exhibit, reindexing_log_entries: [current_log_entry]) }
+      let(:reindexing_log_entry) { FactoryGirl.create(:in_progress_reindexing_log_entry) }
 
       it 'returns true' do
-        expect(subject.recently_in_progress?).to be true
+        expect(subject).to be_recently_in_progress
       end
     end
 
     context 'current_log_entry has an end_time less than Spotlight::Engine.config.reindex_progress_window.minutes.ago' do
-      let(:current_log_entry) { FactoryGirl.create(:recent_reindexing_log_entry, end_time: Time.zone.now) }
-      let(:exhibit) { FactoryGirl.create(:exhibit, reindexing_log_entries: [current_log_entry]) }
+      let(:reindexing_log_entry) { FactoryGirl.create(:recent_reindexing_log_entry, end_time: Time.zone.now) }
 
       it 'returns true' do
-        expect(subject.recently_in_progress?).to be true
+        expect(subject).to be_recently_in_progress
       end
     end
 
     context 'current_log_entry is unstarted ' do
-      let(:current_log_entry) { FactoryGirl.create(:unstarted_reindexing_log_entry) }
-      let(:exhibit) { FactoryGirl.create(:exhibit, reindexing_log_entries: [current_log_entry]) }
+      let(:reindexing_log_entry) { FactoryGirl.create(:unstarted_reindexing_log_entry) }
 
       it 'returns false' do
-        expect(subject.recently_in_progress?).to be false
+        expect(subject).not_to be_recently_in_progress
       end
     end
   end
 
-  describe 'private methods' do
-    describe '#current_log_entry' do
-      let(:reindexing_log_entries) do
-        [
-          FactoryGirl.create(:unstarted_reindexing_log_entry),
-          FactoryGirl.create(:reindexing_log_entry),
-          FactoryGirl.create(:in_progress_reindexing_log_entry),
-          FactoryGirl.create(:failed_reindexing_log_entry),
-          FactoryGirl.create(:unstarted_reindexing_log_entry)
-        ]
-      end
-
-      it 'returns the latest log entry that is not unstarted' do
-        expect(subject.send(:current_log_entry)).to eq(reindexing_log_entries[2])
-      end
-    end
-
-    describe '#localized_start_time' do
-      it 'returns the short formatted start time' do
-        expect(subject.send(:localized_start_time)).to eq I18n.l(subject.started_at, format: :short)
-      end
-    end
-
-    describe '#localized_finish_time' do
-      it 'returns the short formatted end time' do
-        expect(subject.send(:localized_finish_time)).to eq I18n.l(subject.finished_at, format: :short)
-      end
-    end
-
-    describe '#localized_updated_time' do
-      it 'returns the short formatted last updated time' do
-        expect(subject.send(:localized_updated_time)).to eq I18n.l(subject.updated_at, format: :short)
-      end
-    end
-  end
-
-  context 'current_log_entry is nil' do
-    let(:reindexing_log_entries) { [] }
+  context 'current_log_entry is blan' do
+    let(:reindexing_log_entry) { Spotlight::ReindexingLogEntry.new }
 
     # rubocop:disable RSpec/MultipleExpectations
     it 'methods return gracefully' do
-      expect(subject.send(:current_log_entry)).to be nil
-
       expect(subject.recently_in_progress?).to be false
       expect(subject.started_at).to be nil
       expect(subject.updated_at).to be nil
@@ -163,7 +111,8 @@ describe Spotlight::ReindexProgress, type: :model do
         updated_at: nil,
         total: nil,
         completed: nil,
-        errored: false
+        errored: false,
+        finished: false
       )
     end
     # rubocop:enable RSpec/MultipleExpectations

data/spec/models/spotlight/resources/iiif_harvester_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Spotlight::Resources::IiifHarvester do
+  let(:exhibit) { FactoryGirl.create(:exhibit) }
+  let(:harvester) { described_class.create(exhibit_id: exhibit.id, url: url) }
+
+  describe 'Validation' do
+    subject { harvester }
+    context 'when given an invalid URL' do
+      let(:url) { 'http://example.com' }
+
+      it 'errors when the URL is not a IIIF URL' do
+        expect(subject).to_not be_valid
+        expect(subject.errors).to be_present
+        expect(subject.errors[:url]).to eq ['Invalid IIIF URL']
+      end
+    end
+  end
+
+  describe '#documents_to_index' do
+    let(:url) { 'uri://for-top-level-collection' }
+    before { stub_default_collection }
+    subject { harvester.document_builder }
+
+    it 'returns an Enumerator of all the solr documents' do
+      expect(subject.documents_to_index).to be_a(Enumerator)
+      expect(subject.documents_to_index.count).to eq 8
+    end
+  end
+end

data/spec/models/spotlight/resources/iiif_manifest_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+class TestMetadataClass
+  def initialize(*); end
+
+  def to_solr
+    { 'test_field' => 'metadata-to-solr' }
+  end
+end
+
+describe Spotlight::Resources::IiifManifest do
+  let(:url) { 'uri://to-manifest' }
+  subject { described_class.new(url: url, manifest: manifest, collection: collection) }
+  let(:collection) { double(compound_id: '1') }
+  before do
+    stub_iiif_response_for_url(url, test_manifest1)
+    subject.with_exhibit(exhibit)
+  end
+
+  describe '#to_solr' do
+    let(:manifest) { Spotlight::Resources::IiifService.new(url).send(:object) }
+    let(:exhibit) { FactoryGirl.create(:exhibit) }
+    describe 'id' do
+      it 'is an MD5 hexdigest of the exhibit id and the and the url' do
+        expected = Digest::MD5.hexdigest("#{exhibit.id}-#{url}")
+        expect(subject.to_solr[:id]).to eq expected
+      end
+    end
+
+    describe 'label' do
+      it 'is inlcuded in the solr document when present' do
+        expect(subject.to_solr['full_title_tesim']).to eq 'Test Manifest 1'
+      end
+    end
+
+    describe 'collection id' do
+      it 'is included when a collection is given' do
+        expect(subject.to_solr[:collection_id_ssim]).to eq ['1']
+      end
+    end
+
+    describe 'manifest url' do
+      it 'is inlcuded in the solr document when present' do
+        expect(subject.to_solr[:iiif_manifest_url_ssi]).to eq url
+      end
+    end
+
+    describe 'thumbnail url' do
+      it 'is inlcuded in the solr document when present' do
+        expect(subject.to_solr[:thumbnail_url_ssm]).to eq 'uri://to-thumbnail'
+      end
+    end
+
+    describe 'full size image url' do
+      it 'is included in the solr document' do
+        expect(subject.to_solr[:full_image_url_ssm]).to eq 'uri://full-image'
+      end
+    end
+
+    describe 'image urls' do
+      it 'is included in the solr document when present' do
+        expect(subject.to_solr[:content_metadata_image_iiif_info_ssm]).to eq ['uri://to-image-service/info.json']
+      end
+    end
+
+    describe 'metadata' do
+      it 'includes the top-level attribution' do
+        expect(subject.to_solr['readonly_attribution_tesim']).to eq ['Attribution Data']
+      end
+
+      it 'includes the top-level description' do
+        expect(subject.to_solr['readonly_description_tesim']).to eq ['A test IIIF manifest']
+      end
+
+      it 'includes the top-level license' do
+        expect(subject.to_solr['readonly_license_tesim']).to eq ['http://www.example.org/license.html']
+      end
+
+      it 'includes fields for each label/value pair in the metadata section' do
+        expect(subject.to_solr['readonly_author_tesim']).to include 'John Doe'
+        expect(subject.to_solr['readonly_another-field_tesim']).to eq ['Some data']
+      end
+
+      it 'collects items with the same label into an array' do
+        expect(subject.to_solr['readonly_author_tesim']).to eq ['John Doe', 'Jane Doe']
+      end
+
+      it 'exhibit custom fields are created for the necessary fields' do
+        expect { subject.to_solr }.to change(Spotlight::CustomField, :count).by(5)
+      end
+
+      it 'creates read-only custom fields' do
+        expect { subject.to_solr }.to change(Spotlight::CustomField.where(readonly_field: true), :count).by(5)
+      end
+
+      context 'custom class' do
+        before do
+          Spotlight::Engine.config.iiif_metadata_class = -> { TestMetadataClass }
+        end
+
+        it 'merges the solr hash from the configured custom metadata class' do
+          expect(subject.to_solr['readonly_test_field_tesim']).to eq 'metadata-to-solr'
+        end
+      end
+    end
+  end
+end

data/spec/models/spotlight/resources/iiif_service_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Spotlight::Resources::IiifService do
+  let(:url) { 'uri://for-top-level-collection' }
+  subject { described_class.new(url) }
+  before { stub_default_collection }
+
+  describe '#collections' do
+    it 'returns service objects for each top-level collection' do
+      expect(subject.collections.length).to eq 2
+      expect(subject.collections).to be_all { |s| s.is_a?(described_class) }
+    end
+
+    it 'returns service objects for nested collections' do
+      expect(subject.collections.first.collections.length).to eq 1
+      expect(subject.collections.last.collections).to be_blank
+      expect(subject.collections.first.collections.first).to be_a(described_class)
+      expect(
+        subject.collections.first.collections.first.collections
+      ).to be_blank
+    end
+  end
+
+  describe '#manifests' do
+    it 'returns manifests for the current service level' do
+      expect(subject.manifests.length).to eq 2
+      expect(subject.manifests.first).to be_a Spotlight::Resources::IiifManifest
+      expect(subject.collections.first.manifests.length).to eq 2
+      expect(
+        subject.collections.first.manifests.first
+      ).to be_a Spotlight::Resources::IiifManifest
+    end
+  end
+
+  describe '#parse' do
+    let(:manifests) { described_class.parse(url) }
+
+    it 'recursively traverses all all the collections and returns manifests' do
+      expect(manifests).to be_all do |manifest|
+        manifest.is_a?(Spotlight::Resources::IiifManifest)
+      end
+    end
+
+    it 'returns manifests representing collection documents' do
+      expect(manifests.count).to eq 8
+    end
+    it 'keeps track of the parent collection' do
+      arr = manifests.to_a
+      expect(arr[1].collection).to eq arr[0]
+    end
+  end
+end

data/spec/models/spotlight/resources/upload_spec.rb

@@ -16,15 +16,17 @@ describe Spotlight::Resources::Upload, type: :model do
       custom_field.field => 'Custom Field Data'
     }
   end
+  let(:featured_image) { FactoryGirl.create(:featured_image, image: File.open(File.join(FIXTURES_PATH, '800x600.png'))) }
 
   before do
+    Rails.cache.clear # wipes out any cached image info.
     allow(resource).to receive(:configured_fields).and_return configured_fields
     allow(described_class).to receive(:fields).and_return configured_fields
 
     allow(resource.send(:blacklight_solr)).to receive(:update)
     allow(Spotlight::Engine.config).to receive(:upload_title_field).and_return(title_field)
     resource.data = upload_data
-    resource.url = File.open(File.join(FIXTURES_PATH, '800x600.png'))
+    resource.upload = featured_image
     resource.save
   end
 
@@ -81,9 +83,7 @@ describe Spotlight::Resources::Upload, type: :model do
       expect(subject[:spotlight_resource_type_ssim]).to eq 'spotlight/resources/uploads'
     end
     it 'has the various image fields' do
-      expect(subject).to have_key Spotlight::Engine.config.full_image_field
       expect(subject).to have_key Spotlight::Engine.config.thumbnail_field
-      expect(subject).to have_key Spotlight::Engine.config.square_image_field
     end
     it 'has the full image dimensions fields' do
       expect(subject[:spotlight_full_image_height_ssm]).to eq 600
@@ -92,5 +92,9 @@ describe Spotlight::Resources::Upload, type: :model do
     it 'has fields representing exhibit specific custom fields' do
       expect(subject[custom_field.solr_field]).to eq 'Custom Field Data'
     end
+    it 'has a field for the iiif manifest url' do
+      manifest_path = Spotlight::Engine.routes.url_helpers.manifest_exhibit_solr_document_path(exhibit, resource.compound_id)
+      expect(subject[Spotlight::Engine.config.iiif_manifest_field]).to eq(manifest_path)
+    end
   end
 end

data/spec/models/spotlight/search_spec.rb

@@ -7,60 +7,15 @@ describe Spotlight::Search, type: :model do
   let(:blacklight_config) { ::CatalogController.blacklight_config }
   let(:document) do
     SolrDocument.new(id: 'dq287tq6352',
-                     blacklight_config.index.title_field => 'title',
-                     Spotlight::Engine.config.full_image_field => 'https://stacks.stanford.edu/image/iiif/dq287tq6352%2Fdq287tq6352_05_0001/full/!400,400/0/default.jpg')
-  end
-  let(:document_without_an_image) do
-    SolrDocument.new(id: 'ab123fd9876',
                      blacklight_config.index.title_field => 'title')
   end
 
-  context 'thumbnail' do
-    it 'calls DefaultThumbnailJob to fetch a default feature image' do
-      expect(Spotlight::DefaultThumbnailJob).to receive(:perform_later).with(subject)
-      subject.save!
-    end
-
-    context '#set_default_thumbnail' do
-      it 'has a default feature image' do
-        allow(subject).to receive_messages(documents: [document])
-        subject.set_default_thumbnail
-        expect(subject.thumbnail).not_to be_nil
-        expect(subject.thumbnail.image.path).to end_with 'default.jpg'
-      end
-
-      it 'uses a document with an image for the default feature image' do
-        allow(subject).to receive_messages(documents: [document_without_an_image, document])
-        subject.set_default_thumbnail
-        expect(subject.thumbnail).not_to be_nil
-        expect(subject.thumbnail.image.path).to end_with 'default.jpg'
-      end
-
-      context 'when full_image_field is nil' do
-        before do
-          allow(Spotlight::Engine.config).to receive_messages(full_image_field: nil)
-        end
-        it "doesn't query solr" do
-          expect(subject).not_to receive(:documents)
-          subject.set_default_thumbnail
-          expect(subject.thumbnail).to be_nil
-        end
-      end
-    end
-  end
-
   describe 'for a search matching all items' do
     let(:query_params) { {} }
 
     it 'has items' do
       expect(subject.documents.size).to eq 55
     end
-
-    it 'has images' do
-      expect(subject.images.size).to eq(55)
-      expect(subject.images.map(&:last)).to include 'https://stacks.stanford.edu/image/dq287tq6352/dq287tq6352_05_0001_thumb',
-                                                    'https://stacks.stanford.edu/image/jp266yb7109/jp266yb7109_05_0001_thumb'
-    end
   end
 
   describe 'default_scope' do