blacklight-spotlight 3.5.0.1 → 3.6.0.beta1

data/lib/spotlight/engine.rb

@@ -7,18 +7,19 @@ require 'devise'
 require 'devise_invitable'
 
 require 'activejob-status'
-require 'blacklight'
 require 'autoprefixer-rails'
-require 'friendly_id'
-require 'tophat'
-require 'paper_trail'
+require 'blacklight'
 require 'clipboard/rails'
-require 'leaflet-rails'
+require 'faraday'
+require 'faraday/follow_redirects'
+require 'friendly_id'
 require 'i18n/active_record'
-require 'spotlight/upload_field_config'
+require 'leaflet-rails'
+require 'paper_trail'
 require 'riiif'
-require 'faraday'
-require 'faraday_middleware'
+require 'spotlight/riiif_service'
+require 'spotlight/upload_field_config'
+require 'tophat'
 
 module Spotlight
   ##
@@ -37,12 +38,10 @@ module Spotlight
     end
 
     require 'carrierwave'
-    require 'underscore-rails'
     require 'redcarpet'
     require 'github/markup'
     require 'openseadragon'
     require 'handlebars_assets'
-    require 'sprockets/es6'
 
     config.assets.precompile += %w[spotlight/fallback/*.png]
 
@@ -67,11 +66,6 @@ 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' => '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
     end
 
     def self.user_class
@@ -114,6 +108,9 @@ module Spotlight
     # The allowed file extensions for uploading non-repository items.
     config.allowed_upload_extensions = %w[jpg jpeg png]
 
+    # IIIF integration
+    config.iiif_service = Spotlight::RiiifService
+
     # Suffixes for spotlight-created solr fields
     config.solr_fields = OpenStruct.new
     config.solr_fields.prefix = ''
@@ -254,12 +251,17 @@ module Spotlight
 
     config.spambot_honeypot_email_field = :email_address
 
-    initializer 'blacklight.configuration' do
+    config.to_prepare do
+      Blacklight::Configuration.try(:initialize_default_configuration) unless Blacklight::Configuration.try(:initialized_default_configuration?)
+
       # Field containing the last modified date for a Solr document
       Blacklight::Configuration.default_values[:index].timestamp_field ||= 'timestamp'
 
       # Default configuration for the browse view
       Blacklight::Configuration.default_values[:browse] ||= Blacklight::OpenStructWithHashAccess.new(document_actions: [])
+
+      Blacklight::Configuration.default_values[:search_state_fields] ||= []
+      Blacklight::Configuration.default_values[:search_state_fields] += %i[id exhibit_id]
     end
 
     # make blacklight configuration play nice with bootstrap_form

data/lib/spotlight/riiif_service.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # iiif_service module for when using the built-in riiif server
+  module RiiifService
+    # @param [Spotlight::FeaturedImage] image
+    # @return [String]
+    def self.thumbnail_url(image)
+      Riiif::Engine.routes.url_helpers.image_path(image, size: '!400,400')
+    end
+
+    # @param [Spotlight::FeaturedImage] image
+    # @return [String]
+    def self.info_url(image, _host = nil)
+      Riiif::Engine.routes.url_helpers.info_path(image)
+    end
+
+    # @param [Spotlight::Exhibit] exhibit
+    # @param [Spotlight::FeaturedImage] image
+    # @return [String]
+    def self.manifest_url(exhibit, image)
+      Spotlight::Engine.routes.url_helpers.manifest_exhibit_solr_document_path(exhibit, "#{exhibit.id}-#{image.id}")
+    end
+
+    # @param [String] id
+    # @return [Hash]
+    def self.info(id)
+      Riiif::Image.new(id).info
+    end
+  end
+end

data/lib/spotlight/search_state.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Override Blacklight::SearchState to use exhibit-specific routes for documents
+  class SearchState < SimpleDelegator
+    attr_reader :current_exhibit
+
+    def initialize(search_state, current_exhibit)
+      super(search_state)
+      @current_exhibit = current_exhibit
+    end
+
+    def url_for_document(document, options = {})
+      return super unless current_exhibit
+
+      [controller.spotlight, current_exhibit, document]
+    end
+  end
+end

data/lib/spotlight/upload_field_config.rb

@@ -9,7 +9,7 @@ module Spotlight
   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)
+    def initialize(field_name:, blacklight_options: {}, form_field_type: :text_field, label: nil, solr_fields: nil)
       @blacklight_options = blacklight_options
       @field_name = field_name
       @form_field_type = form_field_type

data/lib/spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotlight
-  VERSION = '3.5.0.1'
+  VERSION = '3.6.0.beta1'
 end

data/lib/tasks/spotlight_tasks.rake

@@ -70,7 +70,7 @@ namespace :spotlight do
   task :export, [:exhibit_slug] => :environment do |_, args|
     exhibit = Spotlight::Exhibit.find_by(slug: args[:exhibit_slug])
 
-    puts Spotlight::ExhibitExportSerializer.new(exhibit).to_json
+    puts Spotlight::ExhibitImportExportService.new(exhibit).to_json
   end
 
   desc 'Migrate to IIIF'

data/spec/fixtures/iiif_responses.rb

@@ -3,25 +3,25 @@
 module IiifResponses
   def complex_collection
     {
-      "@id": 'uri://for-top-level-collection',
-      "@type": 'sc:Collection',
+      '@id': 'uri://for-top-level-collection',
+      '@type': 'sc:Collection',
       label: 'Complex Collection',
       collections: [
         {
-          "@id": 'uri://for-child-collection1',
-          "@type": 'sc:Collection',
+          '@id': 'uri://for-child-collection1',
+          '@type': 'sc:Collection',
           label: 'Child Collection 1'
         },
         {
-          "@id": 'uri://for-child-collection2',
-          "@type": 'sc:Collection',
+          '@id': 'uri://for-child-collection2',
+          '@type': 'sc:Collection',
           label: 'Child Collection 2'
         }
       ],
       manifests: [
         {
-          "@id": 'uri://for-manifest1',
-          "@type": 'sc:Manifest',
+          '@id': 'uri://for-manifest1',
+          '@type': 'sc:Manifest',
           label: 'Test Manifest 1'
         }
       ]
@@ -30,20 +30,20 @@ module IiifResponses
 
   def child_collection1
     {
-      "@id": 'uri://for-child-collection1',
-      "@type": 'sc:Collection',
+      '@id': 'uri://for-child-collection1',
+      '@type': 'sc:Collection',
       label: 'Child Collection 1',
       collections: [
         {
-          "@id": 'uri://for-child-collection3',
-          "@type": 'sc:Collection',
+          '@id': 'uri://for-child-collection3',
+          '@type': 'sc:Collection',
           label: 'Child Collection 3'
         }
       ],
       manifests: [
         {
-          "@id": 'uri://for-manifest2',
-          "@type": 'sc:Manifest',
+          '@id': 'uri://for-manifest2',
+          '@type': 'sc:Manifest',
           label: 'Test Manifest 2'
         }
       ]
@@ -52,13 +52,13 @@ module IiifResponses
 
   def child_collection2
     {
-      "@id": 'uri://for-child-collection2',
-      "@type": 'sc:Collection',
+      '@id': 'uri://for-child-collection2',
+      '@type': 'sc:Collection',
       label: 'Child Collection 2',
       manifests: [
         {
-          "@id": 'uri://for-manifest4',
-          "@type": 'sc:Manifest',
+          '@id': 'uri://for-manifest4',
+          '@type': 'sc:Manifest',
           label: 'Test Manifest 4'
         }
       ]
@@ -67,13 +67,13 @@ module IiifResponses
 
   def child_collection3
     {
-      "@id": 'uri://for-child-collection3',
-      "@type": 'sc:Collection',
+      '@id': 'uri://for-child-collection3',
+      '@type': 'sc:Collection',
       label: 'Child Collection 3',
       manifests: [
         {
-          "@id": 'uri://for-manifest3',
-          "@type": 'sc:Manifest',
+          '@id': 'uri://for-manifest3',
+          '@type': 'sc:Manifest',
           label: 'Test Manifest 3'
         }
       ]
@@ -82,8 +82,8 @@ module IiifResponses
 
   def test_manifest1
     {
-      "@id": 'uri://for-manifest1',
-      "@type": 'sc:Manifest',
+      '@id': 'uri://for-manifest1',
+      '@type': 'sc:Manifest',
       label: 'Test Manifest 1',
       attribution: 'Attribution Data',
       description: 'A test IIIF manifest',
@@ -103,22 +103,22 @@ module IiifResponses
         }
       ],
       thumbnail: {
-        "@id": 'uri://to-thumbnail'
+        '@id': 'uri://to-thumbnail'
       },
       sequences: [
         {
-          "@type": 'sc:Sequence',
+          '@type': 'sc:Sequence',
           canvases: [
             {
-              "@type": 'sc:Canvas',
+              '@type': 'sc:Canvas',
               images: [
                 {
-                  "@type": 'oa:Annotation',
+                  '@type': 'oa:Annotation',
                   resource: {
-                    "@type": 'dcterms:Image',
-                    "@id": 'uri://full-image',
+                    '@type': 'dcterms:Image',
+                    '@id': 'uri://full-image',
                     service: {
-                      "@id": 'uri://to-image-service'
+                      '@id': 'uri://to-image-service'
                     }
                   }
                 }
@@ -132,11 +132,11 @@ module IiifResponses
 
   def test_manifest2
     {
-      "@id": 'uri://for-manifest2',
-      "@type": 'sc:Manifest',
+      '@id': 'uri://for-manifest2',
+      '@type': 'sc:Manifest',
       label: {
-        "@value": 'Test Manifest 2',
-        "@language": 'en'
+        '@value': 'Test Manifest 2',
+        '@language': 'en'
       },
       attribution: 'Attribution Data',
       description: 'A test IIIF manifest',
@@ -152,30 +152,30 @@ module IiifResponses
         }
       ],
       thumbnail: {
-        "@id": 'uri://to-thumbnail'
+        '@id': 'uri://to-thumbnail'
       },
       sequences: [
         {
-          "@type": 'sc:Sequence',
+          '@type': 'sc:Sequence',
           canvases: [
             {
-              "@type": 'sc:Canvas',
+              '@type': 'sc:Canvas',
               images: [
                 {
-                  "@type": 'oa:Annotation',
+                  '@type': 'oa:Annotation',
                   resource: {
-                    "@type": 'dcterms:Image',
+                    '@type': 'dcterms:Image',
                     service: {
-                      "@id": 'uri://to-image-service'
+                      '@id': 'uri://to-image-service'
                     }
                   }
                 },
                 {
-                  "@type": 'oa:Annotation',
+                  '@type': 'oa:Annotation',
                   resource: {
-                    "@type": 'dcterms:Image',
+                    '@type': 'dcterms:Image',
                     service: {
-                      "@id": 'uri://to-image-service2'
+                      '@id': 'uri://to-image-service2'
                     }
                   }
                 }
@@ -189,16 +189,16 @@ module IiifResponses
 
   def test_manifest3
     {
-      "@id": 'uri://for-manifest3',
-      "@type": 'sc:Manifest',
+      '@id': 'uri://for-manifest3',
+      '@type': 'sc:Manifest',
       label: [
         {
-          "@value": 'Test Manifest 3',
-          "@language": 'en'
+          '@value': 'Test Manifest 3',
+          '@language': 'en'
         },
         {
-          "@value": "Manifeste d'essai 3",
-          "@language": 'fr'
+          '@value': "Manifeste d'essai 3",
+          '@language': 'fr'
         }
       ],
       attribution: 'Attribution Data',
@@ -215,21 +215,21 @@ module IiifResponses
         }
       ],
       thumbnail: {
-        "@id": 'uri://to-thumbnail'
+        '@id': 'uri://to-thumbnail'
       },
       sequences: [
         {
-          "@type": 'sc:Sequence',
+          '@type': 'sc:Sequence',
           canvases: [
             {
-              "@type": 'sc:Canvas',
+              '@type': 'sc:Canvas',
               images: [
                 {
-                  "@type": 'oa:Annotation',
+                  '@type': 'oa:Annotation',
                   resource: {
-                    "@type": 'dcterms:Image',
+                    '@type': 'dcterms:Image',
                     service: {
-                      "@id": 'uri://to-image-service'
+                      '@id': 'uri://to-image-service'
                     }
                   }
                 }
@@ -243,8 +243,8 @@ module IiifResponses
 
   def test_manifest4
     {
-      "@id": 'uri://for-manifest4',
-      "@type": 'sc:Manifest',
+      '@id': 'uri://for-manifest4',
+      '@type': 'sc:Manifest',
       label: 'Test Manifest 4',
       attribution: 'Attribution Data',
       description: 'A test IIIF manifest',
@@ -260,21 +260,21 @@ module IiifResponses
         }
       ],
       thumbnail: {
-        "@id": 'uri://to-thumbnail'
+        '@id': 'uri://to-thumbnail'
       },
       sequences: [
         {
-          "@type": 'sc:Sequence',
+          '@type': 'sc:Sequence',
           canvases: [
             {
-              "@type": 'sc:Canvas',
+              '@type': 'sc:Canvas',
               images: [
                 {
-                  "@type": 'oa:Annotation',
+                  '@type': 'oa:Annotation',
                   resource: {
-                    "@type": 'dcterms:Image',
+                    '@type': 'dcterms:Image',
                     service: {
-                      "@id": 'uri://to-image-service'
+                      '@id': 'uri://to-image-service'
                     }
                   }
                 }

data/vendor/assets/javascripts/nestable.js

@@ -185,7 +185,7 @@
             var data,
                 depth = 0,
                 list  = this;
-                step  = function(level, depth)
+            const step  = function(level, depth)
                 {
                     var array = [ ],
                         items = level.children(list.options.itemNodeName);

data/vendor/assets/javascripts/parameterize.js

@@ -94,7 +94,7 @@ Downcoder.Initialize = function()
     Downcoder.regex = new RegExp('[' + Downcoder.chars + ']|[^' + Downcoder.chars + ']+','g') ;
   }
   
-  downcode= function( slug )
+const downcode = function( slug )
 {
   Downcoder.Initialize() ;
   var downcoded =""
@@ -134,4 +134,4 @@ function URLify(s, num_chars) {
   s = s.replace(/[-\s]+/g, '-');   // convert spaces to hyphens
   s = s.toLowerCase();             // convert to lowercase
   return s.substring(0, num_chars);// trim to first num_chars chars
-}
+}