blacklight-spotlight 3.0.0.rc2 → 3.0.0

data/spec/helpers/spotlight/pages_helper_spec.rb

@@ -12,21 +12,6 @@ describe Spotlight::PagesHelper, type: :helper do
     allow(helper).to receive_messages(blacklight_config: blacklight_config)
   end
 
-  describe 'available_index_fields' do
-    before do
-      blacklight_config.index.title_field = :title_field
-      blacklight_config.add_index_field 'x', label: 'X'
-    end
-
-    it 'lists the configured index fields' do
-      expect(helper.available_index_fields).to include key: 'x', label: 'X'
-    end
-
-    it 'adds the title field if necessary' do
-      expect(helper.available_index_fields).to include key: :title_field, label: 'Title'
-    end
-  end
-
   describe 'disable_save_pages_button?' do
     it 'returns true if there are no pages and we are on the about pages page' do
       expect(helper).to receive(:page_collection_name).and_return('about_pages')
@@ -106,6 +91,14 @@ describe Spotlight::PagesHelper, type: :helper do
     it 'handles nil input' do
       expect(helper.sir_trevor_markdown(nil)).to be_blank
     end
+
+    it 'retains paragraphs' do
+      expect(helper.sir_trevor_markdown('<p>First Line</p><p>Second Line</p>').chomp).to match(%r{<p>First Line</p>\s*<p>Second Line</p>})
+    end
+
+    it 'replaces line breaks with paragraphs' do
+      expect(helper.sir_trevor_markdown('First Line<br>Second Line').chomp).to match(%r{<p>First Line</p>\s*<p>Second Line</p>})
+    end
   end
 
   describe '#content_editor_class' do

data/spec/helpers/spotlight/roles_helper_spec.rb

@@ -2,6 +2,6 @@
 
 describe Spotlight::RolesHelper, type: :helper do
   it 'is a list of options' do
-    expect(helper.roles_for_select).to eq('Admin' => 'admin', 'Curator' => 'curator')
+    expect(helper.roles_for_select).to eq('Admin' => 'admin', 'Curator' => 'curator', 'Viewer' => 'viewer')
   end
 end

data/spec/i18n_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe 'I18n' do
   end
 
   it 'does not have unused keys' do
+    puts unused_keys.inspect
     expect(unused_keys).to be_empty,
                            "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
   end

data/spec/jobs/spotlight/add_tags_job_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+describe Spotlight::AddTagsJob do
+  subject { described_class.new(solr_params: solr_params, exhibit: exhibit, tags: tags) }
+
+  let(:solr_params) { { q: 'map' } }
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+  let(:tags) { 'hello,world' }
+
+  before do
+    allow(Spotlight::Engine.config).to receive_messages(bulk_actions_batch_size: 5)
+  end
+
+  it 'adds tags to SolrDocumentSidecar objects' do
+    subject.perform_now
+    response = exhibit.blacklight_config.repository.search(solr_params.merge('rows' => 999_999_999))
+    expect(response.total).to eq 55
+    expect(Spotlight::JobTracker.last).to have_attributes(
+      status: 'completed',
+      total: 55,
+      progress: 55,
+      job_class: 'Spotlight::AddTagsJob'
+    )
+    response.documents.each do |document|
+      expect(document.sidecar(exhibit).all_tags_list).to include('hello', 'world')
+      exhibit.tag(document.sidecar(exhibit), with: [], on: :tags)
+    end
+    exhibit.owned_tags.destroy_all
+    response.documents.each do |document|
+      document.sidecar(exhibit).destroy
+      document.reindex
+    end
+  end
+end

data/spec/jobs/spotlight/add_uploads_from_csv_spec.rb

@@ -48,7 +48,10 @@ describe Spotlight::AddUploadsFromCsv do
       expect(Spotlight::IndexingCompleteMailer).to have_received(:documents_indexed).with(
         data, exhibit, user,
         indexed_count: 1,
-        errors: { 1 => array_including(match(/relative URI: x/)), 2 => array_including(match(/Upload is invalid/)) }
+        errors: {
+          1 => array_including(match(Regexp.union(/relative URI: x/, /URI scheme '' not in whitelist:/))),
+          2 => array_including(match(/Upload is invalid/))
+        }
       )
     end
   end

data/spec/jobs/spotlight/change_visibility_job_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+describe Spotlight::ChangeVisibilityJob do
+  subject { described_class.new(solr_params: solr_params, exhibit: exhibit, visibility: visibility) }
+
+  let(:solr_params) { { q: 'map' } }
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+  let(:visibility) { 'private' }
+
+  before do
+    allow(Spotlight::Engine.config).to receive_messages(bulk_actions_batch_size: 5)
+  end
+
+  it 'sets the items based off of the visibility' do
+    subject.perform_now
+    response = exhibit.blacklight_config.repository.search(solr_params.merge('rows' => 999_999_999))
+    expect(response.total).to eq 55
+    expect(Spotlight::JobTracker.last).to have_attributes(
+      status: 'completed',
+      total: 55,
+      progress: 55,
+      job_class: 'Spotlight::ChangeVisibilityJob'
+    )
+    response.documents.each do |document|
+      expect(document.private?(exhibit)).to be true
+      document.make_public!(exhibit)
+      document.reindex
+    end
+  end
+end

data/spec/jobs/spotlight/process_bulk_updates_csv_job_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+def tag_names(exhibit, id)
+  exhibit.blacklight_config.repository.find(id).documents.first.sidecar(exhibit).taggings.includes(:tag).map { |tagging| tagging&.tag&.name }
+end
+
+describe Spotlight::ProcessBulkUpdatesCsvJob do
+  subject { described_class.new(exhibit, bulk_update) }
+
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+
+  describe 'visibility' do
+    let(:bulk_update) { FactoryBot.create(:bulk_update, exhibit: exhibit) }
+
+    it 'is updated' do
+      allow(SolrDocument.index.connection).to receive(:update).and_call_original
+      expect(exhibit.blacklight_config.repository.find('dq287tq6352').documents.first).not_to be_private(exhibit)
+
+      subject.perform_now
+
+      expect(exhibit.blacklight_config.repository.find('dq287tq6352').documents.first).to be_private(exhibit)
+      expect(SolrDocument.index.connection).to have_received(:update)
+    end
+
+    context 'with a row that does not change visibility' do
+      before do
+        sidecar = exhibit.solr_document_sidecars.find_or_create_by(document_type: 'SolrDocument', document_id: 'dq287tq6352')
+        sidecar.private!
+      end
+
+      it 'does not update solr' do
+        allow(SolrDocument.index.connection).to receive(:update)
+
+        subject.perform_now
+
+        expect(SolrDocument.index.connection).not_to have_received(:update)
+      end
+    end
+  end
+
+  describe 'tags' do
+    let(:bulk_update) { FactoryBot.create(:tagged_bulk_update, exhibit: exhibit) }
+
+    before do
+      document = exhibit.blacklight_config.repository.find('cz507zk0531').documents.first
+      exhibit.tag(document.sidecar(exhibit), with: 'CSV Tag1', on: :tags)
+    end
+
+    it 'are added/removed' do
+      allow(SolrDocument.index.connection).to receive(:update).and_call_original
+      expect(tag_names(exhibit, 'bm387cy2596')).to be_empty
+      expect(tag_names(exhibit, 'cz507zk0531')).to eq(['CSV Tag1'])
+      expect(tag_names(exhibit, 'dq287tq6352')).to be_empty
+      subject.perform_now
+      expect(tag_names(exhibit, 'bm387cy2596')).to eq(['CSV Tag1', 'CSV Tag2'])
+      expect(tag_names(exhibit, 'cz507zk0531')).to eq(['CSV Tag2'])
+      expect(tag_names(exhibit, 'dq287tq6352')).to eq(['CSV Tag1', 'CSV Tag2'])
+
+      # 3 updates plus the final commit
+      expect(SolrDocument.index.connection).to have_received(:update).exactly(4).times
+    end
+
+    context 'with a row that does not change visibility' do
+      before do
+        # set up the documents to match what's the in the spreadsheet already
+        subject.perform_now
+      end
+
+      it 'does not update solr' do
+        allow(SolrDocument.index.connection).to receive(:update)
+
+        subject.perform_now
+
+        expect(SolrDocument.index.connection).not_to have_received(:update)
+      end
+    end
+  end
+end

data/spec/jobs/spotlight/reindex_exhibit_job_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+describe Spotlight::ReindexExhibitJob do
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+
+  before do
+    FactoryBot.create_list(:resource, 10, exhibit: exhibit)
+    allow(Spotlight::ReindexJob).to receive(:perform_now)
+    allow(Spotlight::ReindexJob).to receive(:perform_later)
+  end
+
+  context 'with a single batch' do
+    it 'runs the index job inline' do
+      described_class.perform_now(exhibit, batch_count: 1)
+
+      expect(Spotlight::ReindexJob).to have_received(:perform_now).once.with(exhibit, anything)
+    end
+  end
+
+  context 'with a fixed batch count' do
+    it 'enqueues that number of batches' do
+      described_class.perform_now(exhibit, batch_count: 2)
+
+      expect(Spotlight::ReindexJob).to have_received(:perform_later).twice.with(exhibit, hash_including(:start, :finish))
+    end
+  end
+
+  context 'with a dynamically generated batch count' do
+    it 'enqueues the right number of batches' do
+      described_class.perform_now(exhibit, batch_count: nil, batch_size: 2)
+
+      expect(Spotlight::ReindexJob).to have_received(:perform_later).exactly(5).times.with(exhibit, hash_including(:start, :finish))
+    end
+  end
+
+  context 'with a dynamically generated batch size' do
+    it 'figues out that number of batches' do
+      described_class.perform_now(exhibit, batch_count: nil, batch_size: nil)
+
+      expect(Spotlight::ReindexJob).to have_received(:perform_later).exactly(3).times.with(exhibit, hash_including(:start, :finish))
+    end
+  end
+end

data/spec/jobs/spotlight/reindex_job_spec.rb

@@ -4,67 +4,13 @@ describe Spotlight::ReindexJob do
   include ActiveJob::TestHelper
 
   let(:exhibit) { FactoryBot.create(:exhibit) }
-  let(:resource) { FactoryBot.create(:resource) }
+  let(:resource) { FactoryBot.create(:resource, exhibit: exhibit) }
   let(:user) { FactoryBot.create(:user) }
-  let(:log_entry) { Spotlight::ReindexingLogEntry.create(exhibit: exhibit, user: user) }
 
   before do
-    ActiveJob::Base.queue_adapter = :test
     allow_any_instance_of(Spotlight::Resource).to receive(:reindex)
   end
 
-  context 'with an exhibit' do
-    subject { described_class.new(exhibit) }
-
-    before do
-      exhibit.resources << resource
-      exhibit.save
-    end
-
-    it 'attempts to reindex every resource in the exhibit' do
-      # ActiveJob will reload the collection, so we go through a little trouble:
-      expect_any_instance_of(Spotlight::Resource).to receive(:reindex) do |thingy|
-        expect(exhibit.resources).to include thingy
-      end
-
-      subject.perform_now
-    end
-
-    context 'with a log_entry' do
-      subject { described_class.new(exhibit, log_entry) }
-
-      it 'marks the log entry as started' do
-        expect(log_entry).to receive(:in_progress!)
-        subject.perform_now
-      end
-
-      it 'marks the log entry as successful if there is no error' do
-        expect(log_entry).to receive(:succeeded!)
-        subject.perform_now
-      end
-
-      it 'marks the log entry as failed if there is an error' do
-        unexpected_error = StandardError.new
-        # it'd be more realistic to raise on resource#reindex, but that's already stubbed above, so this'll have to do
-        expect(subject).to receive(:perform).with(exhibit, log_entry).and_raise unexpected_error
-        expect(log_entry).to receive(:failed!)
-        expect { subject.perform_now }.to raise_error unexpected_error
-      end
-
-      it 'updates the items_reindexed_estimate field on the log entry' do
-        expect(log_entry).to receive(:update).with(items_reindexed_estimate: 1)
-        subject.perform_now
-      end
-
-      it 'passes log_entry to the resource.reindex call' do
-        # ActiveJob will reload the collection, so we go through a little trouble:
-        expect_any_instance_of(Spotlight::Resource).to receive(:reindex).with(log_entry).exactly(:once)
-        # expect(resource).to receive(:reindex).with(log_entry)
-        subject.perform_now
-      end
-    end
-  end
-
   context 'with a resource' do
     subject { described_class.new(resource) }
 
@@ -72,34 +18,62 @@ describe Spotlight::ReindexJob do
       expect(resource).to receive(:reindex)
       subject.perform_now
     end
+
+    it 'adds some job tracking events' do
+      expect { subject.perform_now }.to change(Spotlight::Event, :count).by(1)
+    end
   end
 
   describe 'validity' do
-    subject { described_class.new(resource, nil, 'xyz') }
+    subject { described_class.new(resource, 'validity_token' => 'xyz') }
 
     let(:mock_checker) { instance_double(Spotlight::ValidityChecker) }
 
     before do
       allow(described_class).to receive(:validity_checker).and_return(mock_checker)
-      allow(mock_checker).to receive(:mint).with(resource).and_return('xyz')
+      allow(mock_checker).to receive(:mint).with(anything).and_return('xyz')
     end
 
     it 'mints a new validity token' do
-      expect { described_class.perform_later(resource) }.to have_enqueued_job(described_class).with(resource, nil, 'xyz')
+      expect { described_class.perform_later(resource) }.to have_enqueued_job(described_class).with(resource, 'validity_token' => 'xyz')
     end
 
     it 'does nothing if the token is no longer valid' do
-      allow(mock_checker).to receive(:check).with(resource, 'xyz').and_return(false)
+      allow(mock_checker).to receive(:check).with(subject, validity_token: 'xyz').and_return(false)
       expect(resource).not_to receive(:reindex)
 
       subject.perform_now
     end
 
     it 'indexes the resource if the token is valid' do
-      allow(mock_checker).to receive(:check).with(resource, 'xyz').and_return(true)
+      allow(mock_checker).to receive(:check).with(subject, validity_token: 'xyz').and_return(true)
       expect(resource).to receive(:reindex)
 
       subject.perform_now
     end
   end
+
+  context 'with start and finish' do
+    it 'indexes the resources within that page' do
+      count = 0
+      allow_any_instance_of(Spotlight::Resource).to receive(:reindex) do
+        count += 1
+      end
+
+      described_class.perform_now(exhibit, start: 0, finish: resource.id)
+
+      expect(count).to eq 1
+    end
+
+    it 'does not index resources off that page' do
+      count = 0
+      allow_any_instance_of(Spotlight::Resource).to receive(:reindex) do
+        count += 1
+      end
+
+      described_class.perform_now(exhibit, start: resource.id + 1, finish: resource.id + 500)
+
+      expect(count).to eq 0
+    end
+  end
 end

data/spec/jobs/spotlight/remove_tags_job_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+describe Spotlight::RemoveTagsJob do
+  subject { described_class.new(solr_params: solr_params, exhibit: exhibit, tags: tags) }
+
+  let(:solr_params) { { q: 'map' } }
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+  let(:tags) { %w[hello world] }
+
+  before do
+    allow(Spotlight::Engine.config).to receive_messages(bulk_actions_batch_size: 5)
+  end
+
+  it 'removes tags from SolrDocumentSidecar objects' do
+    response = exhibit.blacklight_config.repository.search(solr_params.merge('rows' => 999_999_999))
+    expect(response.total).to eq 55
+    response.documents.each do |document|
+      exhibit.tag(document.sidecar(exhibit), with: %w[hello world], on: :tags)
+      document.reindex
+    end
+    subject.perform_now
+    response = exhibit.blacklight_config.repository.search(solr_params.merge('rows' => 999_999_999))
+    expect(response.total).to eq 55
+    expect(Spotlight::JobTracker.last).to have_attributes(
+      status: 'completed',
+      total: 55,
+      progress: 55,
+      job_class: 'Spotlight::RemoveTagsJob'
+    )
+    response.documents.each do |document|
+      expect(document.sidecar(exhibit).all_tags_list).to eq []
+    end
+    exhibit.owned_tags.destroy_all
+    response.documents.each do |document|
+      document.sidecar(exhibit).destroy
+      document.reindex
+    end
+  end
+end

data/spec/lib/migration/iiif_spec.rb

@@ -26,7 +26,7 @@ RSpec.describe Migration::IIIF do
     context "when it's any FeaturedImage" do
       it 'updates the iiif_tilesource attribute based on the given host and image resource' do
         instance.run
-        expect(updated_thumb.iiif_tilesource).to eq "http://test.host/images/#{updated_thumb.id}/info.json"
+        expect(updated_thumb.iiif_tilesource).to match %r{http://test.host/images/#{updated_thumb.id}-.*/info.json}
       end
 
       it 'returns a nil region if one was not set' do