blacklight-spotlight 3.0.0.alpha.9 → 3.0.0.rc4

data/config/routes.rb

@@ -100,6 +100,15 @@ Spotlight::Engine.routes.draw do
       end
     end
     resources :browse, only: %i[index show]
+    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]
 
     resources :contacts, only: %i[edit update destroy]
@@ -143,7 +152,13 @@ Spotlight::Engine.routes.draw do
       end
     end
     post 'solr/update' => 'solr#update'
-    resource :translations, only: %i[edit update]
+    resource :translations, only: %i[edit update show] do
+      collection do
+        post 'import'
+        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/20200403161512_add_subtitle_to_searches.rb

@@ -0,0 +1,7 @@
+class AddSubtitleToSearches < ActiveRecord::Migration[5.2]
+  def change
+    change_table :spotlight_searches do |t|
+      t.string :subtitle
+    end
+  end
+end

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: false, polymorphic: 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/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/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
 #   FeaturedPages SolrDocuments SolrDocumentsCarousel SolrDocumentsEmbed
 #   SolrDocumentsFeatures SolrDocumentsGrid SearchResults
 # )

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'
@@ -38,8 +39,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 +56,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 +66,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 +101,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 +126,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
@@ -160,6 +163,7 @@ module Spotlight
 
     # Configure the CarrierWave file storage mechanism
     config.uploader_storage = :file
+    config.featured_image_masthead_size = [1800, 180]
     config.featured_image_thumb_size = [400, 300]
     config.featured_image_square_size = [400, 400]
     config.contact_square_size = [70, 70]
@@ -214,6 +218,25 @@ module Spotlight
     # add could add an available locale which could break things if unexpected.
     config.i18n.available_locales = config.i18n_locales.keys
 
+    # Copy of JbuilderHandler tweaked to spit out YAML for translation exports
+    class TranslationYamlHandler
+      cattr_accessor :default_format
+      self.default_format = :yaml
+
+      def self.call(template, source = nil)
+        source ||= template.source
+        # this juggling is required to keep line numbers right in the error
+        %{__already_defined = defined?(json); json||=JbuilderTemplate.new(self); #{source}
+          json.attributes!.to_yaml unless (__already_defined && __already_defined != "method")}
+      end
+    end
+
+    initializer :yamlbuilder do
+      ActiveSupport.on_load :action_view do
+        ActionView::Template.register_template_handler :yamlbuilder, TranslationYamlHandler
+      end
+    end
+
     # Query parameters for autocomplete requests
     config.autocomplete_search_field = 'autocomplete'
     config.default_autocomplete_params = { qf: 'id^1000 full_title_tesim^100 id_ng full_title_ng',
@@ -243,8 +266,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
     ]
@@ -261,5 +287,10 @@ module Spotlight
       pages: true,
       resources: true
     }
+
+    config.reindexing_batch_size = nil
+    config.reindexing_batch_count = nil
+
+    config.assign_default_roles_to_first_user = true
   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.9'
+  VERSION = '3.0.0.rc4'
 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

data/spec/controllers/spotlight/browse_controller_spec.rb

@@ -4,6 +4,8 @@ describe Spotlight::BrowseController, type: :controller do
   routes { Spotlight::Engine.routes }
   let(:exhibit) { FactoryBot.create(:exhibit) }
   let!(:search) { FactoryBot.create(:published_search, exhibit: exhibit) }
+  let(:group) { FactoryBot.create(:group, published: true, title: 'Good group', exhibit: exhibit, searches: [search]) }
+  let(:group_unpublished) { FactoryBot.create(:group, title: 'Secret group', exhibit: exhibit, searches: [search]) }
   let!(:unpublished) { FactoryBot.create(:search, exhibit: exhibit) }
   let(:admin) { FactoryBot.create(:site_admin) }
 
@@ -53,6 +55,16 @@ describe Spotlight::BrowseController, type: :controller do
         expect(assigns[:exhibit]).to eq exhibit
         expect(response).to render_template 'spotlight/browse/index'
       end
+
+      it 'includes the browse groups' do
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
+        expect(controller).to receive(:add_breadcrumb).with('Browse', exhibit_browse_index_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Good group', exhibit_browse_groups_path(exhibit, group))
+        get :index, params: { exhibit_id: exhibit, group_id: group.id }
+        expect(response).to be_successful
+        expect(assigns[:groups]).to eq [group]
+        expect(response).to render_template 'spotlight/browse/index'
+      end
     end
   end
 
@@ -90,6 +102,17 @@ describe Spotlight::BrowseController, type: :controller do
         expect(response).to render_template 'spotlight/browse/show'
       end
 
+      it 'includes the browse group when a group_id is provided' do
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
+        expect(controller).to receive(:add_breadcrumb).with('Browse', exhibit_browse_index_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Good group', exhibit_browse_groups_path(exhibit, group))
+        expect(controller).to receive(:add_breadcrumb).with(search.title, exhibit_browse_group_path(exhibit, group, search))
+        get :show, params: { id: search, exhibit_id: exhibit, group_id: group.id }
+        expect(response).to be_successful
+        expect(assigns[:group]).to eq group
+        expect(response).to render_template 'spotlight/browse/show'
+      end
+
       it 'removes all the document actions' do
         get :show, params: { id: search, exhibit_id: exhibit }
         expect(controller.blacklight_config.index.document_actions).to be_blank
@@ -100,7 +123,7 @@ describe Spotlight::BrowseController, type: :controller do
           c.browse.document_actions = %i[a b c]
         end
 
-        allow(controller). to receive(:blacklight_config).and_return(config)
+        allow(controller).to receive(:blacklight_config).and_return(config)
 
         get :show, params: { id: search, exhibit_id: exhibit }
         expect(controller.blacklight_config.index.document_actions).to match_array %i[a b c]

data/spec/controllers/spotlight/catalog_controller_spec.rb

@@ -81,7 +81,7 @@ 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('Search results', search_exhibit_catalog_path(exhibit, q: 'map'))
         get :index, params: { exhibit_id: exhibit, q: 'map' }
         expect(response).to be_successful
       end
@@ -120,8 +120,9 @@ describe Spotlight::CatalogController, type: :controller do
 
     describe 'GET manifest' do
       context 'document is an uploaded resource' do
+        let(:uploaded_resource) { FactoryBot.create(:uploaded_resource) }
+
         it 'returns the json manifest produced by Spotlight::IiifManifestPresenter, based on the retrieved document and the controller' do
-          uploaded_resource = FactoryBot.create(:uploaded_resource)
           compound_id = uploaded_resource.compound_id
           slug = uploaded_resource.exhibit.slug
 
@@ -146,6 +147,7 @@ describe Spotlight::CatalogController, type: :controller do
           expect(image['resource']['@id']).to eq compound_id
           expect(image['resource']['format']).to eq 'image/jpeg'
 
+        ensure
           # clean up solr document created by save_and_index above
           Blacklight.default_index.connection.delete_by_id uploaded_resource.compound_id
           Blacklight.default_index.connection.commit

data/spec/controllers/spotlight/contacts_controller_spec.rb

@@ -24,7 +24,7 @@ describe Spotlight::ContactsController, type: :controller do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', 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))
         expect(controller).to receive(:add_breadcrumb).with(contact.name, edit_exhibit_contact_path(exhibit, contact))
         get :edit, params: { id: contact, exhibit_id: contact.exhibit }
         expect(response).to be_successful
@@ -76,7 +76,7 @@ describe Spotlight::ContactsController, type: :controller do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', 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))
         expect(controller).to receive(:add_breadcrumb).with('Add contact', new_exhibit_contact_path(exhibit))
         get :new, params: { exhibit_id: exhibit }
         expect(response).to be_successful