blacklight-spotlight 3.0.0.alpha.10 → 3.0.0.rc5

data/config/routes.rb

@@ -100,7 +100,24 @@ Spotlight::Engine.routes.draw do
       end
     end
     resources :browse, only: %i[index show]
-    resources :tags, only: %i[index destroy]
+    get 'browse/group/:group_id', to: 'browse#index', as: 'browse_groups'
+    get 'browse/group/:group_id/:id', to: 'browse#show', as: 'browse_group'
+
+    resources :groups, except: %i[show] do
+      collection do
+        patch :update_all
+      end
+    end
+
+    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]
 
@@ -132,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
@@ -149,6 +185,7 @@ Spotlight::Engine.routes.draw do
         patch 'import'
       end
     end
+    get 'iiif/collection' => 'catalog#index', defaults: { q: '*:*', format: :iiif_json }
   end
 
   get '/:exhibit_id' => 'home_pages#show', as: :exhibit_root

data/db/migrate/20210113092223_create_spotlight_groups.rb

@@ -0,0 +1,23 @@
+class CreateSpotlightGroups < ActiveRecord::Migration[5.2]
+  def self.up
+    create_table :spotlight_groups do |t|
+      t.string     :slug
+      t.text       :title
+      t.references :exhibit
+      t.integer    :weight, default: 50
+      t.boolean    :published
+
+      t.timestamps
+    end
+
+    create_table :spotlight_groups_members, id: false do |t|
+      t.references :group
+      t.references :member, polymorphic: true
+    end
+  end
+
+  def self.down
+    drop_table :spotlight_groups
+    drop_table :spotlight_groups_members
+  end
+end

data/db/migrate/20210122082032_create_job_trackers.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class CreateJobTrackers < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spotlight_job_trackers do |t|
+      t.references :on, null: false, polymorphic: true, index: true
+      t.references :resource, null: false, polymorphic: true, index: true
+      t.string :job_id
+      t.string :job_class
+      t.string :parent_job_id
+      t.string :parent_job_class
+      t.string :status
+      t.references :user
+      t.text :log
+      t.text :data
+
+      t.timestamps
+    end
+
+    add_index :spotlight_job_trackers, :job_id
+  end
+end

data/db/migrate/20210126123041_create_events.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateEvents < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spotlight_events do |t|
+      t.references :exhibit, null: true
+      t.references :resource, null: false, polymorphic: true, index: true
+      t.string :type
+      t.string :collation_key
+      t.text :data
+
+      t.timestamps
+    end
+  end
+end

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/install_generator.rb

@@ -10,6 +10,25 @@ module Spotlight
     class_option :solr_update_class, type: :string, default: 'Spotlight::SolrDocument::AtomicUpdates'
     class_option :mailer_default_url_host, type: :string, default: '' # e.g. localhost:3000
 
+    # we're not (yet) using webpacker, so we need to re-add sprockets functionality
+    def add_js
+      return unless Rails.version.to_i == 6
+
+      gem 'coffee-rails', '~> 4.2'
+      gem 'uglifier', '>= 1.3.0'
+
+      append_to_file 'app/assets/config/manifest.js', "\n//= link_directory ../javascripts .js\n"
+      append_to_file 'app/assets/javascripts/application.js', "\n//= require_tree .\n"
+      gsub_file 'app/views/layouts/application.html.erb', /pack/, 'include'
+      inject_into_file 'config/environments/production.rb', after: '  # config.assets.css_compressor = :sass' do
+        "\n  config.assets.js_compressor = :uglifier"
+      end
+
+      # but since webpacker exists in the gemfile, we still need to run the
+      # install before rails will start
+      run 'bundle exec rails webpacker:install'
+    end
+
     def inject_spotlight_routes
       route "mount Spotlight::Engine, at: 'spotlight'"
       gsub_file 'config/routes.rb', /^\s*root.*/ do |match|
@@ -53,7 +72,9 @@ module Spotlight
     end
 
     def add_roles_to_user
-      inject_into_class 'app/models/user.rb', User, '  include Spotlight::User'
+      inject_into_file 'app/models/user.rb', after: 'include Blacklight::User' do
+        "\n  include Spotlight::User\n"
+      end
     end
 
     def add_controller_mixin
@@ -104,7 +125,7 @@ module Spotlight
     end
 
     def add_osd_viewer
-      gem 'blacklight-gallery', '~> 1.1'
+      gem 'blacklight-gallery', '~> 3.0'
       generate 'blacklight_gallery:install'
     end
 

data/lib/generators/spotlight/scaffold_resource_generator.rb

@@ -7,23 +7,15 @@ module Spotlight
   # spotlight:scaffold_resource generator
   class ScaffoldResource < Rails::Generators::NamedBase
     source_root File.expand_path('templates', __dir__)
-    def create_document_builder
-      create_file "app/services/#{file_name}_builder.rb", <<-FILE.strip_heredoc
-        class #{class_name}Builder < Spotlight::SolrDocumentBuilder
-          def to_solr
-            return to_enum(:to_solr) unless block_given?
-
-            # TODO: your implementation here
-            # yield { id: resource.id }
-          end
-        end
-      FILE
-    end
 
     def create_model
       create_file "app/models/#{file_name}_resource.rb", <<-FILE.strip_heredoc
         class #{class_name}Resource < Spotlight::Resource
-          self.document_builder_class = #{class_name}Builder
+          def self.indexing_pipeline
+            @indexing_pipeline ||= super.dup.tap do |pipeline|
+              # your pipeline here...
+            end
+          end
         end
       FILE
     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/sir_trevor_rails.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Required for 0.6 and up:
+# https://github.com/madebymany/sir-trevor-rails#upgrade-guide-to-v060
+class SirTrevorRails::Block
+  def self.custom_block_types
+    # You can define your custom block types directly here or in your engine config.
+    Spotlight::Engine.config.sir_trevor_widgets
+  end
+end

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

@@ -70,8 +70,10 @@
 # Spotlight::Engine.config.ga_anonymize_ip = false # false for backwards compatibility
 
 # ==> Sir Trevor Widget Configuration
+# 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
+#   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

@@ -6,6 +6,7 @@
 require 'devise'
 require 'devise_invitable'
 
+require 'activejob-status'
 require 'blacklight'
 require 'autoprefixer-rails'
 require 'friendly_id'
@@ -16,6 +17,8 @@ require 'leaflet-rails'
 require 'i18n/active_record'
 require 'spotlight/upload_field_config'
 require 'riiif'
+require 'faraday'
+require 'faraday_middleware'
 
 module Spotlight
   ##
@@ -38,8 +41,8 @@ module Spotlight
     require 'github/markup'
     require 'sir_trevor_rails'
     require 'openseadragon'
+    require 'handlebars_assets'
     require 'sprockets/es6'
-    require 'almond-rails'
 
     config.assets.precompile += %w[spotlight/fallback/*.png]
 
@@ -55,6 +58,7 @@ module Spotlight
       require 'acts-as-taggable-on'
 
       Mime::Type.register 'application/solr+json', :solr_json
+      Mime::Type.register 'application/iiif+json', :iiif_json
     end
 
     initializer 'spotlight.factories', after: 'factory_bot.set_factory_paths' do
@@ -64,7 +68,7 @@ module Spotlight
     initializer 'spotlight.assets.precompile' do |app|
       app.config.assets.precompile += %w[spotlight/default_thumbnail.jpg spotlight/default_browse_thumbnail.jpg]
 
-      Sprockets::ES6.configuration = { 'modules' => 'amd', 'moduleIds' => true }
+      Sprockets::ES6.configuration = { 'modules' => 'umd', 'moduleIds' => true }
       # When we upgrade to Sprockets 4, we can ditch sprockets-es6 and config AMD
       # in this way:
       # https://github.com/rails/sprockets/issues/73#issuecomment-139113466
@@ -99,7 +103,7 @@ module Spotlight
     config.external_resources_partials = []
     config.solr_batch_size = 20
 
-    Spotlight::Engine.config.reindex_progress_window = 10
+    Spotlight::Engine.config.reindex_progress_window = 1.hour
 
     # Filter resources by exhibit by default
     config.filter_resources_by_exhibit = true
@@ -124,6 +128,7 @@ module Spotlight
     }
 
     config.resource_global_id_field = :"#{config.solr_fields.prefix}spotlight_resource_id#{config.solr_fields.string_suffix}"
+    config.job_tracker_id_field = :"#{config.solr_fields.prefix}spotlight_job_tracker_id#{config.solr_fields.string_suffix}"
 
     # Set to nil if you don't want to pull thumbnails from the index
     config.full_image_field = :full_image_url_ssm
@@ -263,8 +268,11 @@ module Spotlight
     config.exhibit_themes = ['default']
 
     config.default_page_content_type = 'SirTrevor'
+
+    # Added here for backwards compatability with SirTrevor 0.6
+    # and apps who have customized their avaialble widgets
     config.sir_trevor_widgets = %w[
-      Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse LinkToSearch
+      Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse BrowseGroupCategories LinkToSearch
       FeaturedPages SolrDocuments SolrDocumentsCarousel SolrDocumentsEmbed
       SolrDocumentsFeatures SolrDocumentsGrid SearchResults
     ]
@@ -281,5 +289,22 @@ module Spotlight
       pages: true,
       resources: true
     }
+
+    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/upload_field_config.rb

@@ -8,6 +8,7 @@ module Spotlight
   # We should look into changing this to a standard blacklight field config in Blacklight 7
   class UploadFieldConfig
     attr_reader :blacklight_options, :field_name, :form_field_type
+
     def initialize(blacklight_options: {}, field_name:, form_field_type: :text_field, label: nil, solr_fields: nil)
       @blacklight_options = blacklight_options
       @field_name = field_name

data/lib/spotlight/version.rb

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

data/spec/controllers/spotlight/about_pages_controller_spec.rb

@@ -112,7 +112,7 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
       describe 'on the main about page' do
         it 'is successful' do
           expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
-          expect(controller).to receive(:add_breadcrumb).with('About Pages', exhibit_about_pages_path(exhibit))
+          expect(controller).to receive(:add_breadcrumb).with('About pages', exhibit_about_pages_path(exhibit))
           get :edit, params: { id: page, exhibit_id: exhibit }
           expect(assigns(:page)).to eq page
           expect(assigns(:exhibit)).to eq exhibit
@@ -122,7 +122,7 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
       describe 'on a different about page' do
         it 'is successful' do
           expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
-          expect(controller).to receive(:add_breadcrumb).with('About Pages', exhibit_about_pages_path(exhibit))
+          expect(controller).to receive(:add_breadcrumb).with('About pages', exhibit_about_pages_path(exhibit))
           expect(controller).to receive(:add_breadcrumb).with(page2.title, [:edit, exhibit, page2])
           get :edit, params: { id: page2, exhibit_id: exhibit }
           expect(assigns(:page)).to eq page2
@@ -137,7 +137,7 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
-        expect(controller).to receive(:add_breadcrumb).with('About Pages', exhibit_about_pages_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('About pages', exhibit_about_pages_path(exhibit))
         get :index, params: { exhibit_id: exhibit }
         expect(assigns(:page)).to be_kind_of Spotlight::Page
         expect(assigns(:page)).to be_new_record