blacklight-spotlight 0.32.0 → 0.33.0

data/db/migrate/20160714144125_add_iiif_urls_to_featured_image.rb

@@ -0,0 +1,9 @@
+class AddIiifUrlsToFeaturedImage < ActiveRecord::Migration
+  def change
+    add_column :spotlight_featured_images, :iiif_region, :string
+    add_column :spotlight_featured_images, :iiif_manifest_url, :string
+    add_column :spotlight_featured_images, :iiif_canvas_id, :string
+    add_column :spotlight_featured_images, :iiif_image_id, :string
+    add_column :spotlight_featured_images, :iiif_tilesource, :string
+  end
+end

data/db/migrate/20160718194010_add_iiif_url_to_contact.rb

@@ -0,0 +1,6 @@
+class AddIiifUrlToContact < ActiveRecord::Migration
+  def change
+    add_column :spotlight_contacts, :avatar_id, :integer
+    add_index :spotlight_contacts, :avatar_id
+  end
+end

data/db/migrate/20160805143841_add_upload_id_to_resources.rb

@@ -0,0 +1,6 @@
+class AddUploadIdToResources < ActiveRecord::Migration
+  def change
+    add_column :spotlight_resources, :upload_id, :integer
+    add_index :spotlight_resources, :upload_id
+  end
+end

data/db/migrate/20170204091234_add_theme_to_spotlight_exhibits.rb

@@ -0,0 +1,5 @@
+class AddThemeToSpotlightExhibits < ActiveRecord::Migration
+  def change
+    add_column :spotlight_exhibits, :theme, :string
+  end
+end

data/lib/generators/spotlight/install_generator.rb

@@ -17,14 +17,14 @@ module Spotlight
     end
 
     def friendly_id
-      gem 'friendly_id', github: 'norman/friendly_id'
+      gem 'friendly_id'
       # we need to immediately run `bundle install` while pointing at github.
       Bundler.with_clean_env { run 'bundle install' }
       generate 'friendly_id'
     end
 
     def riiif
-      gem 'riiif', '~> 0.4.0'
+      gem 'riiif', '~> 1.0'
       route "mount Riiif::Engine => '/images', as: 'riiif'"
       copy_file 'config/initializers/riiif.rb'
     end
@@ -35,6 +35,9 @@ module Spotlight
 
     def sitemaps
       gem 'sitemap_generator'
+
+      Bundler.with_clean_env { run 'bundle install' }
+
       copy_file 'config/sitemap.rb', 'config/sitemap.rb'
 
       say <<-EOS.strip_heredoc, :red

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

@@ -34,7 +34,6 @@
 # Spotlight::Engine.config.resource_global_id_field = :"#{config.solr_fields.prefix}spotlight_resource_id#{config.solr_fields.string_suffix}"
 # Spotlight::Engine.config.full_image_field = :full_image_url_ssm
 # Spotlight::Engine.config.thumbnail_field = :thumbnail_url_ssm
-# Spotlight::Engine.config.square_image_field = :thumbnail_square_url_ssm
 
 # ==> Uploaded item configuration
 # Spotlight::Engine.config.upload_fields = [

data/lib/generators/spotlight/templates/spotlight.scss

@@ -1,9 +1,10 @@
 /*
 *= require bootstrap-tagsinput
-*= require jquery.jcrop
 */
 @import 'spotlight/variables_bootstrap';
 @import 'bootstrap-sprockets';
 @import 'bootstrap';
 @import 'sir-trevor/main';
-@import 'spotlight/spotlight';
+@import 'leaflet';
+@import 'leaflet-areaselect';
+@import 'spotlight/spotlight';

data/lib/migration/iiif.rb

@@ -0,0 +1,82 @@
+module Migration
+  # This migrates FeaturedImages with crop coordinates into IIIF urls which
+  # are stored in the `iiif_url' field.
+  class IIIF
+    def self.run(hostname)
+      new(hostname).run
+    end
+
+    def initialize(hostname)
+      @hostname = hostname
+    end
+
+    def run
+      migrate_featured_images
+      migrate_contact_avatars
+    end
+
+    attr_reader :hostname
+
+    private
+
+    def riiif
+      Riiif::Engine.routes.url_helpers
+    end
+
+    def migrate_featured_images
+      Spotlight::FeaturedImage.all.each do |image|
+        update_iiif_url(image)
+        copy_exhibit_thumbnail_from_featured_image(image)
+      end
+    end
+
+    def migrate_contact_avatars
+      Spotlight::Contact.all.each do |contact|
+        avatar = copy_contact_image_to_avatar(contact)
+        contact.update(avatar: avatar) if avatar
+      end
+    end
+
+    # Checks if the image was associated as a thumbnail.
+    # If so, this will update the STI type column of the FeaturedImage as well
+    # as copy the file over to the correct directory given the new class name
+    def copy_exhibit_thumbnail_from_featured_image(image)
+      return unless Spotlight::Exhibit.where(thumbnail_id: image.id).any?
+      filename = image.read_attribute_before_type_cast('image')
+      old_file = "public/#{image.image.store_dir}/#{filename}"
+      image.becomes!(Spotlight::ExhibitThumbnail)
+      image.save
+      # AR + STI seems to require that we re-query for this
+      # otherwise we get an association miss-match
+      reloaded_image = Spotlight::ExhibitThumbnail.find(image.id)
+      reloaded_image.image.store!(File.new(old_file))
+    end
+
+    # Looks for a file at the old uploader location and copies it to a FeaturedImage
+    def copy_contact_image_to_avatar(contact)
+      filename = contact.read_attribute_before_type_cast('avatar')
+      filepath = "public/uploads/spotlight/contact/avatar/#{contact.id}/#{filename}"
+      old_file = File.new(filepath)
+      image = contact.create_avatar { |i| i.image.store!(old_file) }
+      iiif_tilesource = riiif.info_path(image.id)
+      image.update(iiif_tilesource: iiif_tilesource, iiif_region: avatar_coordinates(contact))
+      image
+    end
+
+    def update_iiif_url(image)
+      image.update(
+        iiif_tilesource: riiif.info_url(image.id, host: hostname),
+        iiif_region: coordinates(image)
+      )
+    end
+
+    def coordinates(image)
+      return unless image.image_crop_x.present?
+      [image.image_crop_x, image.image_crop_y, image.image_crop_w, image.image_crop_h].join(',')
+    end
+
+    def avatar_coordinates(contact)
+      [contact.avatar_crop_x, contact.avatar_crop_y, contact.avatar_crop_w, contact.avatar_crop_h].join(',')
+    end
+  end
+end

data/lib/spotlight/engine.rb

@@ -29,11 +29,12 @@ module Spotlight
     end
 
     require 'carrierwave'
-    require 'carrierwave/crop'
     require 'underscore-rails'
     require 'github/markup'
     require 'sir_trevor_rails'
     require 'openseadragon'
+    require 'sprockets/es6'
+    require 'almond-rails'
 
     config.assets.precompile += %w(spotlight/fallback/*.png)
 
@@ -61,7 +62,12 @@ module Spotlight
     end
 
     initializer 'spotlight.assets.precompile' do |app|
-      app.config.assets.precompile += %w(spotlight/default_thumbnail.jpg)
+      app.config.assets.precompile += %w(spotlight/default_thumbnail.jpg spotlight/default_browse_thumbnail.jpg)
+
+      Sprockets::ES6.configuration = { 'modules' => 'amd', '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
@@ -87,7 +93,8 @@ module Spotlight
       'spotlight/resources/external_resources_form',
       'spotlight/resources/upload/form',
       'spotlight/resources/csv_upload/form',
-      'spotlight/resources/json_upload/form'
+      'spotlight/resources/json_upload/form',
+      'spotlight/resources/iiif/form'
     ]
     config.external_resources_partials = []
     config.solr_batch_size = 20
@@ -112,29 +119,32 @@ module Spotlight
 
     config.resource_global_id_field = :"#{config.solr_fields.prefix}spotlight_resource_id#{config.solr_fields.string_suffix}"
 
-    # The solr field that original (largest) images will be stored.
     # Set to nil if you don't want to pull thumbnails from the index
     config.full_image_field = :full_image_url_ssm
     config.thumbnail_field = :thumbnail_url_ssm
-    config.square_image_field = :thumbnail_square_url_ssm
 
     # Defaults to the blacklight_config.index.title_field:
     config.upload_title_field = nil # OpenStruct.new(...)
+    config.upload_description_field = :spotlight_upload_description_tesim
 
     config.upload_fields = [
-      OpenStruct.new(field_name: :spotlight_upload_description_tesim, label: 'Description', form_field_type: :text_area),
+      OpenStruct.new(field_name: config.upload_description_field, label: 'Description', form_field_type: :text_area),
       OpenStruct.new(field_name: :spotlight_upload_attribution_tesim, label: 'Attribution'),
       OpenStruct.new(field_name: :spotlight_upload_date_tesim, label: 'Date')
     ]
 
+    config.iiif_manifest_field = :iiif_manifest_url_ssi
+    config.iiif_metadata_class = -> { Spotlight::Resources::IiifManifest::Metadata }
+    config.iiif_collection_id_field = :collection_id_ssim
+
+    config.masthead_initial_crop_selection = [1200, 120]
+    config.thumbnail_initial_crop_selection = [120, 120]
+
     # Configure the CarrierWave file storage mechanism
     config.uploader_storage = :file
     config.featured_image_thumb_size = [400, 300]
     config.featured_image_square_size = [400, 400]
-
-    initializer 'spotlight-assets.initialize' do
-      Rails.application.config.assets.precompile += %w(Jcrop.gif)
-    end
+    config.contact_square_size = [70, 70]
 
     # To present curators with analytics reports on the exhibit dashboard, you need to configure
     # an Analytics provider. Google Analytics support is provided out-of-the-box.
@@ -185,5 +195,7 @@ module Spotlight
 
     # make blacklight configuration play nice with bootstrap_form
     Blacklight::OpenStructWithHashAccess.send(:extend, ActiveModel::Translation)
+
+    config.exhibit_themes = ['default']
   end
 end

data/lib/spotlight/version.rb

@@ -1,3 +1,3 @@
 module Spotlight
-  VERSION = '0.32.0'.freeze
+  VERSION = '0.33.0'.freeze
 end

data/lib/tasks/spotlight_tasks.rake

@@ -59,6 +59,16 @@ namespace :spotlight do
     puts Spotlight::ExhibitExportSerializer.new(exhibit).to_json
   end
 
+  desc 'Migrate to IIIF'
+  task :migrate_to_iiif, [:hostname] => :environment do |_, args|
+    if args[:hostname]
+      require 'migration/iiif'
+      Migration::IIIF.run args[:hostname]
+    else
+      STDERR.puts "\nUsage: rake spotlight:migrate_to_iiif[hostname]\n\n  Example: rake spotlight:migrate_to_iiif[https://exhibits.stanford.edu]\n\n"
+    end
+  end
+
   def prompt_to_create_user
     Spotlight::Engine.user_class.find_or_create_by!(email: prompt_for_email) do |u|
       puts 'User not found. Enter a password to create the user.'

data/spec/controllers/spotlight/about_pages_controller_spec.rb

@@ -1,6 +1,6 @@
 describe Spotlight::AboutPagesController, type: :controller do
   routes { Spotlight::Engine.routes }
-  let(:valid_attributes) { { 'title' => 'MyString' } }
+  let(:valid_attributes) { { 'title' => 'MyString', thumbnail: { iiif_url: '' } } }
 
   describe 'when not logged in' do
     describe 'POST update_all' do

data/spec/controllers/spotlight/appearances_controller_spec.rb

@@ -43,34 +43,47 @@ describe Spotlight::AppearancesController, type: :controller do
     describe 'PATCH update' do
       let(:first_nav) { exhibit.main_navigations.first }
       let(:last_nav) { exhibit.main_navigations.last }
-      it 'updates the navigation' do
+      let(:submitted) do
+        {
+          exhibit_id: exhibit,
+          exhibit: {
+            masthead_attributes: {
+              iiif_tilesource: 'http://test.host/1/foo',
+              iiif_region: '0,0,2000,200'
+            },
+            thumbnail_attributes: {
+              iiif_tilesource: 'http://test.host/2/foo',
+              iiif_region: '0,0,600,600'
+            },
+            main_navigations_attributes: main_navigation_attributes
+          }
+        }
+      end
+      let(:main_navigation_attributes) do
         if Rails::VERSION::MAJOR >= 5
-          patch :update, params: {
-            exhibit_id: exhibit,
-            exhibit: {
-              main_navigations_attributes: {
-                0 => { id: first_nav.id, label: 'Some Label', weight: 500 },
-                1 => { id: last_nav.id, display: false }
-              }
-            }
+          {
+            0 => { id: first_nav.id, label: 'Some Label', weight: 500 },
+            1 => { id: last_nav.id, display: false }
           }
         else
-          patch :update, params: {
-            exhibit_id: exhibit,
-            exhibit: {
-              main_navigations_attributes: [
-                { id: first_nav.id, label: 'Some Label', weight: 500 },
-                { id: last_nav.id, display: false }
-              ]
-            }
-          }
+          [
+            { id: first_nav.id, label: 'Some Label', weight: 500 },
+            { id: last_nav.id, display: false }
+          ]
         end
+      end
+      it 'updates the navigation' do
+        patch :update, params: submitted
         expect(flash[:notice]).to eq 'The exhibit was successfully updated.'
         expect(response).to redirect_to edit_exhibit_appearance_path(exhibit)
         assigns[:exhibit].tap do |saved|
           expect(saved.main_navigations.find(first_nav.id).label).to eq 'Some Label'
           expect(saved.main_navigations.find(first_nav.id).weight).to eq 500
           expect(saved.main_navigations.find(last_nav.id)).not_to be_displayable
+          expect(saved.masthead.iiif_tilesource).to eq 'http://test.host/1/foo'
+          expect(saved.thumbnail.iiif_region).to eq '0,0,600,600'
+          expect(saved.masthead.iiif_url).to eq 'http://test.host/1/foo/0,0,2000,200/1800,180/0/default.jpg'
+          expect(saved.thumbnail.iiif_url).to eq 'http://test.host/2/foo/0,0,600,600/400,400/0/default.jpg'
         end
       end
     end

data/spec/controllers/spotlight/catalog_controller_spec.rb

@@ -111,6 +111,46 @@ describe Spotlight::CatalogController, type: :controller do
         expect(json['docs'].first['title']).to eq 'KAART der REYZE van drie Schepen naar het ZUYDLAND in de Jaaren 1721 en 1722'
       end
     end
+
+    describe 'GET manifest' do
+      context 'document is an uploaded resource' do
+        it 'returns the json manifest produced by Spotlight::IiifManifestPresenter, based on the retrieved document and the controller' do
+          uploaded_resource = FactoryGirl.create(:uploaded_resource)
+          compound_id = uploaded_resource.compound_id
+          slug = uploaded_resource.exhibit.slug
+
+          uploaded_resource.save_and_index
+
+          get :manifest, params: { exhibit_id: uploaded_resource.exhibit, id: compound_id }
+
+          expect(response).to be_successful
+
+          json = JSON.parse(response.body)
+          expect(json['@context']).to eq 'http://iiif.io/api/presentation/2/context.json'
+          expect(json['@id']).to eq "http://test.host/spotlight/#{slug}/catalog/#{compound_id}/manifest"
+          expect(json['@type']).to eq 'sc:Manifest'
+
+          canvas = json['sequences'].first['canvases'].first
+          expect(canvas['@id']).to eq "http://test.host/spotlight/#{slug}/catalog/#{compound_id}/manifest/canvas/#{compound_id}"
+          expect(canvas['@type']).to eq 'sc:Canvas'
+
+          image = canvas['images'].first
+          expect(image['resource']['@id']).to eq compound_id
+          expect(image['resource']['format']).to eq 'image/jpeg'
+
+          # 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
+        end
+      end
+      context 'document is not an uploaded resource' do
+        it 'returns a 404 when called on something other than an uploaded resource' do
+          get :manifest, params: { exhibit_id: exhibit, id: 'dx157dh4345' }
+          expect(response).not_to be_successful
+          expect(response.status).to eq(404)
+        end
+      end
+    end
   end
 
   describe 'when the user is not authorized' do

data/spec/controllers/spotlight/contacts_controller_spec.rb

@@ -32,6 +32,24 @@ describe Spotlight::ContactsController, type: :controller do
         expect(response).to redirect_to exhibit_about_pages_path(exhibit)
         expect(contact.reload.name).to eq 'Chester'
       end
+
+      it 'allows thumbnails to be updated' do
+        contact = FactoryGirl.create(:contact, exhibit: exhibit, name: 'Andrew Carnegie')
+        patch :update, params: {
+          id: contact,
+          contact: {
+            avatar_attributes: {
+              iiif_tilesource: 'https://example.com/iiif',
+              iiif_region: '0,0,200,200'
+            }
+          },
+          exhibit_id: contact.exhibit
+        }
+
+        expect(response).to redirect_to exhibit_about_pages_path(exhibit)
+        expect(contact.reload.avatar.iiif_url).to eq 'https://example.com/iiif/0,0,200,200/70,70/0/default.jpg'
+      end
+
       it 'fails by rendering edit' do
         expect_any_instance_of(Spotlight::Contact).to receive(:update).and_return(false)
         patch :update, params: { id: contact, contact: { name: 'Chester' }, exhibit_id: contact.exhibit }
@@ -65,10 +83,11 @@ describe Spotlight::ContactsController, type: :controller do
       end
       it 'is successful' do
         expect do
-          post :create, params: { exhibit_id: exhibit, contact: { name: 'Chester' } }
+          post :create, params: { exhibit_id: exhibit, contact: { name: 'Chester', avatar_attributes: { iiif_tilesource: 'someurl' } } }
         end.to change { Spotlight::Contact.count }.by(1)
         expect(response).to redirect_to exhibit_about_pages_path(exhibit)
         expect(Spotlight::Contact.last.show_in_sidebar).to be_truthy
+        expect(Spotlight::Contact.last.avatar.iiif_url).to be_present
       end
     end
   end

data/spec/controllers/spotlight/feature_pages_controller_spec.rb

@@ -4,7 +4,7 @@ describe Spotlight::FeaturePagesController, type: :controller do
   # This should return the minimal set of attributes required to create a valid
   # Page. As you add validations to Page, be sure to
   # adjust the attributes here as well.
-  let(:valid_attributes) { { 'title' => 'MyString' } }
+  let(:valid_attributes) { { 'title' => 'MyString', thumbnail_attributes: { iiif_url: '' } } }
   describe 'when signed in as a curator' do
     let(:exhibit) { FactoryGirl.create(:exhibit) }
     let(:user) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
@@ -104,11 +104,7 @@ describe Spotlight::FeaturePagesController, type: :controller do
       let(:page) { FactoryGirl.create(:feature_page, exhibit: exhibit) }
       describe 'with valid params' do
         it 'updates the requested page' do
-          # Assuming there are no other pages in the database, this
-          # specifies that the Page created on the previous line
-          # receives the :update_attributes message with whatever params are
-          # submitted in the request.
-          expect_any_instance_of(Spotlight::FeaturePage).to receive(:update).with(hash_including(valid_attributes))
+          expect_any_instance_of(Spotlight::FeaturePage).to receive(:update)
           put :update, params: { id: page, exhibit_id: page.exhibit.id, feature_page: valid_attributes }
         end