blacklight-spotlight 3.0.0.rc4 → 3.0.0.rc5

data/config/routes.rb

@@ -109,7 +109,15 @@ Spotlight::Engine.routes.draw do
       end
     end
 
-    resources :tags, only: %i[index destroy]
+    resources :tags, only: %i[index destroy] do
+      collection do
+        patch :update_all
+      end
+
+      member do
+        post :rename
+      end
+    end
 
     resources :contacts, only: %i[edit update destroy]
 
@@ -141,10 +149,29 @@ Spotlight::Engine.routes.draw do
         get :clone
       end
     end
+    resource :bulk_actions, only: [] do
+      member do
+        post :change_visibility
+        post :add_tags
+        post :remove_tags
+      end
+    end
+
+    resource :bulk_updates, only: %i[edit update] do
+      collection do
+        get :monitor
+      end
+
+      member do
+        post :download_template
+      end
+    end
+
     post '/pages/:id/preview' => 'pages#preview', as: :preview_block
     get '/pages' => 'pages#index', constraints: { format: 'json' }
 
     resources :lock, only: [:destroy]
+    resources :job_trackers, only: [:show]
 
     resources :roles, path: 'users', only: %i[index create destroy] do
       collection do

data/db/migrate/20210126123041_create_events.rb

@@ -3,7 +3,7 @@
 class CreateEvents < ActiveRecord::Migration[5.2]
   def change
     create_table :spotlight_events do |t|
-      t.references :exhibit, null: false, polymorphic: true
+      t.references :exhibit, null: true
       t.references :resource, null: false, polymorphic: true, index: true
       t.string :type
       t.string :collation_key

data/db/migrate/20210305070001_remove_class_from_sirtrevor_image_blocks.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Remove the class field from the block; ostruct 0.3 helpfully allows it to override
+# this field and that confuses sir trevor..
+class RemoveClassFromSirtrevorImageBlocks < ActiveRecord::Migration[5.2]
+  def up
+    Spotlight::Page.reset_column_information
+    image = SirTrevorRails::Block.block_class('image')
+
+    Spotlight::Page.find_each do |page|
+      next unless page.content.any? { |block| block.is_a? image }
+      page.content.select { |block| block.is_a?(image) && block.respond_to?(:class=) }.each do |block|
+        block.delete_field(:class)
+        block.attachment = Spotlight::Attachment.find(block.id).to_global_id rescue nil
+      end
+
+      page.update(content: page.content)
+    end
+  end
+end

data/db/migrate/20210305171150_create_bulk_updates.rb

@@ -0,0 +1,9 @@
+class CreateBulkUpdates < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spotlight_bulk_updates do |t|
+      t.string :file, null: false
+      t.references :exhibit
+      t.timestamps
+    end
+  end
+end

data/lib/generators/spotlight/templates/config/initializers/riiif.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-Riiif::Image.file_resolver = Spotlight::CarrierwaveFileResolver.new
+ActiveSupport::Reloader.to_prepare do
+  Riiif::Image.file_resolver = Spotlight::CarrierwaveFileResolver.new
 
-# Riiif::Image.authorization_service = IIIFAuthorizationService
+  # Riiif::Image.authorization_service = IIIFAuthorizationService
 
-# Riiif.not_found_image = 'app/assets/images/us_404.svg'
-#
-Riiif::Engine.config.cache_duration = 365.days
+  # Riiif.not_found_image = 'app/assets/images/us_404.svg'
+  #
+  Riiif::Engine.config.cache_duration = 365.days
+end

data/lib/generators/spotlight/templates/config/initializers/spotlight_initializer.rb

@@ -73,7 +73,7 @@
 # These are set by default by Spotlight's configuration,
 # but you can customize them here, or in the SirTrevorRails::Block#custom_block_types method
 # Spotlight::Engine.config.sir_trevor_widgets = %w(
-#   Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse BrowseGroupCategories
+#   Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse BrowseGroupCategories LinkToSearch
 #   FeaturedPages SolrDocuments SolrDocumentsCarousel SolrDocumentsEmbed
 #   SolrDocumentsFeatures SolrDocumentsGrid SearchResults
 # )

data/lib/generators/spotlight/templates/solr/config/schema.xml

@@ -306,7 +306,7 @@
         <filter class="solr.EdgeNGramFilterFactory" minGramSize="3" maxGramSize="15" />
       </analyzer>
 
-      <analyzer type="index">
+      <analyzer type="query">
         <tokenizer class="solr.ICUTokenizerFactory"/>
         <filter class="solr.ICUFoldingFilterFactory"/>  <!-- NFKC, case folding, diacritics removed -->
         <filter class="solr.EnglishPossessiveFilterFactory"/>

data/lib/migration/iiif.rb

@@ -73,7 +73,7 @@ module Migration
 
       old_file = File.new(filepath)
       image = contact.create_avatar { |i| i.image.store!(old_file) }
-      iiif_tilesource = riiif.info_path(image.id)
+      iiif_tilesource = riiif.info_path(image)
       image.update(iiif_tilesource: iiif_tilesource, iiif_region: avatar_coordinates(contact))
       image
     end
@@ -87,7 +87,7 @@ module Migration
 
       old_file = File.new(filepath)
       image = upload.create_upload { |i| i.image.store!(old_file) }
-      iiif_tilesource = riiif.info_path(image.id)
+      iiif_tilesource = riiif.info_path(image)
       image.update(iiif_tilesource: iiif_tilesource)
       upload.upload_id = image.id
       upload.save_and_index
@@ -95,7 +95,7 @@ module Migration
 
     def update_iiif_url(image)
       image.update(
-        iiif_tilesource: riiif.info_url(image.id, host: hostname),
+        iiif_tilesource: riiif.info_url(image, host: hostname),
         iiif_region: coordinates(image)
       )
     end

data/lib/spotlight/engine.rb

@@ -17,6 +17,8 @@ require 'leaflet-rails'
 require 'i18n/active_record'
 require 'spotlight/upload_field_config'
 require 'riiif'
+require 'faraday'
+require 'faraday_middleware'
 
 module Spotlight
   ##
@@ -290,7 +292,19 @@ module Spotlight
 
     config.reindexing_batch_size = nil
     config.reindexing_batch_count = nil
+    config.hidden_job_classes = %w[Spotlight::ReindexJob]
+
+    config.bulk_actions_batch_size = 1000
+
+    config.bulk_updates = OpenStruct.new
+    config.bulk_updates.csv_id = 'Item ID'
+    config.bulk_updates.csv_title = 'Item Title'
+    config.bulk_updates.csv_visibility = 'Visibility'
+    config.bulk_updates.csv_tags_prefix = 'Tag:'
+    config.bulk_updates.csv_tags = 'Tag: %s'
 
     config.assign_default_roles_to_first_user = true
+
+    config.exhibit_roles = %w[admin curator viewer]
   end
 end

data/lib/spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotlight
-  VERSION = '3.0.0.rc4'
+  VERSION = '3.0.0.rc5'
 end

data/spec/controllers/spotlight/bulk_actions_controller_spec.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+describe Spotlight::BulkActionsController, type: :controller do
+  routes { Spotlight::Engine.routes }
+  let(:exhibit) { FactoryBot.create(:skinny_exhibit) }
+
+  # rubocop:disable RSpec/BeforeAfterAll
+  before(:all) do
+    ActiveJob::Base.queue_adapter = :test
+  end
+
+  after(:all) do
+    ActiveJob::Base.queue_adapter = :inline
+  end
+  # rubocop:enable RSpec/BeforeAfterAll
+
+  describe 'when the user is not authorized' do
+    before do
+      sign_in FactoryBot.create(:exhibit_visitor)
+    end
+
+    describe 'POST change_visibility' do
+      it 'denies access' do
+        post :change_visibility, params: { exhibit_id: exhibit }
+        expect(response).to redirect_to main_app.root_path
+        expect(flash[:alert]).to be_present
+      end
+    end
+
+    describe 'POST add_tags' do
+      it 'denies access' do
+        post :add_tags, params: { exhibit_id: exhibit }
+        expect(response).to redirect_to main_app.root_path
+        expect(flash[:alert]).to be_present
+      end
+    end
+
+    describe 'POST remove_tags' do
+      it 'denies access' do
+        post :remove_tags, params: { exhibit_id: exhibit }
+        expect(response).to redirect_to main_app.root_path
+        expect(flash[:alert]).to be_present
+      end
+    end
+  end
+
+  describe 'when the user is a curator' do
+    before do
+      sign_in FactoryBot.create(:exhibit_curator, exhibit: exhibit)
+    end
+
+    let(:search) { FactoryBot.create(:search, exhibit: exhibit) }
+    let(:search_session) { instance_double('Blacklight::Search', query_params: { q: 'map' }) }
+
+    describe 'POST change_visibility' do
+      it 'redirects and sets a notice' do
+        allow(controller).to receive(:current_search_session).and_return(search_session)
+        request.env['HTTP_REFERER'] = '/referring_url'
+        post :change_visibility, params: { 'visibility' => 'private', 'q' => 'map', exhibit_id: exhibit }
+        expect(response).to redirect_to '/referring_url'
+        expect(flash[:notice]).to eq 'Visibility of 55 items is being updated.'
+      end
+
+      # rubocop:disable Style/MultilineBlockChain
+      it 'enqueues the job' do
+        allow(controller).to receive(:current_search_session).and_return(search_session)
+        expect do
+          post :change_visibility, params: { 'visibility' => 'private', 'q' => 'map', exhibit_id: exhibit }
+        end.to have_enqueued_job(Spotlight::ChangeVisibilityJob).with do |solr_params, exhb, visibility|
+          expect(solr_params).to.not be_nil
+          expect(exhb).to eq exhibit
+          expect(visibility).to eq 'private'
+        end
+      end
+      # rubocop:enable Style/MultilineBlockChain
+    end
+
+    describe 'POST add_tags' do
+      it 'redirects and sets a notice' do
+        allow(controller).to receive(:current_search_session).and_return(search_session)
+        request.env['HTTP_REFERER'] = '/referring_url'
+        post :add_tags, params: { 'tags' => 'howdy,planet', 'q' => 'map', exhibit_id: exhibit }
+        expect(response).to redirect_to '/referring_url'
+        expect(flash[:notice]).to eq 'Tags are being added for 55 items.'
+      end
+
+      # rubocop:disable Style/MultilineBlockChain
+      it 'enqueues the job' do
+        allow(controller).to receive(:current_search_session).and_return(search_session)
+        expect do
+          post :add_tags, params: { 'tags' => 'howdy,planet', 'q' => 'map', exhibit_id: exhibit }
+        end.to have_enqueued_job(Spotlight::AddTagsJob).with do |solr_params, exhb, tags|
+          expect(solr_params).to.not be_nil
+          expect(exhb).to eq exhibit
+          expect(tags).to eq %w[howdy planet]
+        end
+      end
+      # rubocop:enable Style/MultilineBlockChain
+    end
+
+    describe 'POST remove_tags' do
+      it 'redirects and sets a notice' do
+        allow(controller).to receive(:current_search_session).and_return(search_session)
+        request.env['HTTP_REFERER'] = '/referring_url'
+        post :remove_tags, params: { 'tags' => 'hello,world', 'q' => 'map', exhibit_id: exhibit }
+        expect(response).to redirect_to '/referring_url'
+        expect(flash[:notice]).to eq 'Tags are being removed for 55 items.'
+      end
+
+      # rubocop:disable Style/MultilineBlockChain
+      it 'enqueues the job' do
+        allow(controller).to receive(:current_search_session).and_return(search_session)
+        expect do
+          post :remove_tags, params: { 'tags' => 'howdy,planet', 'q' => 'map', exhibit_id: exhibit }
+        end.to have_enqueued_job(Spotlight::RemoveTagsJob).with do |solr_params, exhb, tags|
+          expect(solr_params).to.not be_nil
+          expect(exhb).to eq exhibit
+          expect(tags).to eq %w[howdy planet]
+        end
+      end
+      # rubocop:enable Style/MultilineBlockChain
+    end
+  end
+end

data/spec/controllers/spotlight/bulk_updates_controller_spec.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+describe Spotlight::BulkUpdatesController, type: :controller do
+  routes { Spotlight::Engine.routes }
+  let(:exhibit) { FactoryBot.create(:exhibit) }
+
+  describe 'when the user is not authorized' do
+    before do
+      sign_in FactoryBot.create(:exhibit_visitor)
+    end
+
+    describe 'GET edit' do
+      it 'denies access' do
+        get :edit, params: { exhibit_id: exhibit }
+        expect(response).to redirect_to main_app.root_path
+        expect(flash[:alert]).to be_present
+      end
+    end
+
+    describe 'POST download_template' do
+      it 'denies access' do
+        post :download_template, params: { exhibit_id: exhibit }
+        expect(response).to redirect_to main_app.root_path
+        expect(flash[:alert]).to be_present
+      end
+    end
+  end
+
+  describe 'when the user is a curator' do
+    before do
+      sign_in FactoryBot.create(:exhibit_curator, exhibit: exhibit)
+    end
+
+    describe 'GET edit' do
+      it 'is allowed' do
+        get :edit, params: { exhibit_id: exhibit }
+        expect(response).to be_successful
+      end
+    end
+
+    describe 'POST download_template' do
+      it 'downloads a CSV template' do
+        post :download_template, params: {
+          exhibit_id: exhibit,
+          reference_fields: { item_id: 1, item_title: 1 },
+          updatable_fields: { tags: 0, visibility: 1 }
+        }
+
+        content = CSV.parse(response.body)
+        expect(content.length).to eq 56
+        expect(content[0]).to eq ['Item ID', 'Item Title', 'Visibility']
+      end
+    end
+
+    describe 'PATCH download_template' do
+      before { ActiveJob::Base.queue_adapter = :test }
+
+      after { ActiveJob::Base.queue_adapter = :inline }
+
+      it 'uploads the given CSV template and passes it to a job' do
+        expect do
+          patch :update, params: {
+            exhibit_id: exhibit,
+            file: fixture_file_upload('spec/fixtures/bulk-update-template.csv', 'text/csv')
+          }
+        end.to(have_enqueued_job(Spotlight::ProcessBulkUpdatesCsvJob).with do |job_exhibit, uploader|
+          expect(job_exhibit).to eq exhibit
+          expect(uploader).to be_a Spotlight::BulkUpdate
+          expect(uploader.file_identifier).to eq 'bulk-update-template.csv'
+        end)
+
+        expect(flash[:notice]).to eq 'The CSV file was uploaded successfully.'
+        expect(response).to redirect_to(spotlight.edit_exhibit_bulk_updates_path(exhibit))
+      end
+    end
+  end
+end

data/spec/controllers/spotlight/catalog_controller_spec.rb

@@ -29,7 +29,7 @@ describe Spotlight::CatalogController, type: :controller do
       let(:search) { FactoryBot.create(:search, exhibit: exhibit) }
 
       it 'shows the item' do
-        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with('L'AMERIQUE', exhibit_solr_document_path(exhibit, document))
         get :show, params: { exhibit_id: exhibit, id: 'dq287tq6352' }
         expect(response).to be_successful
@@ -38,7 +38,7 @@ describe Spotlight::CatalogController, type: :controller do
       it 'shows the item with breadcrumbs to the browse page' do
         allow(controller).to receive_messages(current_browse_category: search)
 
-        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with('Browse', exhibit_browse_index_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with(search.title, exhibit_browse_path(exhibit, search))
         expect(controller).to receive(:add_breadcrumb).with('L'AMERIQUE', exhibit_solr_document_path(exhibit, document))
@@ -50,7 +50,7 @@ describe Spotlight::CatalogController, type: :controller do
         feature_page = FactoryBot.create(:feature_page, exhibit: exhibit)
         allow(controller).to receive_messages(current_page_context: feature_page)
 
-        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with(feature_page.title, [exhibit, feature_page])
         expect(controller).to receive(:add_breadcrumb).with('L'AMERIQUE', exhibit_solr_document_path(exhibit, document))
         get :show, params: { exhibit_id: exhibit, id: 'dq287tq6352' }
@@ -61,7 +61,7 @@ describe Spotlight::CatalogController, type: :controller do
         home_page = FactoryBot.create(:home_page)
         allow(controller).to receive_messages(current_page_context: home_page)
 
-        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with('L'AMERIQUE', exhibit_solr_document_path(exhibit, document))
         get :show, params: { exhibit_id: exhibit, id: 'dq287tq6352' }
         expect(response).to be_successful
@@ -80,8 +80,8 @@ describe Spotlight::CatalogController, type: :controller do
 
     describe 'GET index' do
       it 'shows the index when there are parameters' do
-        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
-        expect(controller).to receive(:add_breadcrumb).with('Search results', search_exhibit_catalog_path(exhibit, q: 'map'))
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Search results', search_exhibit_catalog_path(exhibit, q: 'map'), current: true)
         get :index, params: { exhibit_id: exhibit, q: 'map' }
         expect(response).to be_successful
       end
@@ -216,7 +216,7 @@ describe Spotlight::CatalogController, type: :controller do
     before { sign_in FactoryBot.create(:exhibit_curator, exhibit: exhibit) }
 
     it 'shows all the items' do
-      expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
+      expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit))
       expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
       expect(controller).to receive(:add_breadcrumb).with('Items', admin_exhibit_catalog_path(exhibit))
       get :admin, params: { exhibit_id: exhibit }
@@ -299,7 +299,7 @@ describe Spotlight::CatalogController, type: :controller do
   end
 
   describe 'when the user is a site admin' do
-    before { sign_in FactoryBot.create(:site_admin, exhibit: exhibit) }
+    before { sign_in FactoryBot.create(:site_admin) }
 
     describe 'GET show' do
       it 'has a solr_json serialization' do
@@ -499,22 +499,22 @@ describe Spotlight::CatalogController, type: :controller do
 
     before { allow(controller).to receive_messages(current_exhibit: current_exhibit) }
 
-    describe 'render_save_this_search?' do
+    describe 'render_curator_actions?' do
       it 'returns false if we are on the items admin screen' do
         allow(controller).to receive(:can?).with(:curate, current_exhibit).and_return(true)
         allow(controller).to receive(:params).and_return(controller: 'spotlight/catalog', action: 'admin')
-        expect(controller).not_to be_render_save_this_search
+        expect(controller).not_to be_render_curator_actions
       end
 
       it 'returns true if we are not on the items admin screen' do
         allow(controller).to receive(:can?).with(:curate, current_exhibit).and_return(true)
         allow(controller).to receive(:params).and_return(controller: 'spotlight/catalog', action: 'index')
-        expect(controller).to be_render_save_this_search
+        expect(controller).to be_render_curator_actions
       end
 
       it 'returns false if a user cannot curate the object' do
         allow(controller).to receive(:can?).with(:curate, current_exhibit).and_return(false)
-        expect(controller).not_to be_render_save_this_search
+        expect(controller).not_to be_render_curator_actions
       end
     end
   end