blacklight-spotlight 0.32.0 → 0.33.0

data/app/serializers/spotlight/exhibit_export_serializer.rb

@@ -25,7 +25,6 @@ module Spotlight
   ##
   # Serialize an exhibit with all the data needed to reconstruct it
   # in a different environment
-  # rubocop:disable Metrics/ClassLength
   class ExhibitExportSerializer < Roar::Decorator
     include Roar::JSON
 
@@ -59,7 +58,7 @@ module Spotlight
 
     property :masthead, class: Spotlight::Masthead, decorator: FeaturedImageRepresenter
 
-    property :thumbnail, class: Spotlight::FeaturedImage, decorator: FeaturedImageRepresenter
+    property :thumbnail, class: Spotlight::ExhibitThumbnail, decorator: FeaturedImageRepresenter
 
     collection :main_navigations, class: Spotlight::MainNavigation, decorator: MainNavigationRepresenter
 
@@ -74,25 +73,11 @@ module Spotlight
 
     collection :contacts, populator: ->(fragment, options) { options[:represented].contacts.find_or_initialize_by(slug: fragment['slug']) },
                           class: Spotlight::Contact do
-      (Spotlight::Contact.attribute_names - %w(id exhibit_id avatar)).each do |prop|
+      (Spotlight::Contact.attribute_names - %w(id exhibit_id)).each do |prop|
         property prop
       end
 
-      property :avatar, exec_context: :decorator
-
-      def avatar
-        file = represented.avatar.file
-
-        return unless file
-
-        { filename: file.filename, content_type: file.content_type, content: Base64.encode64(file.read) }
-      end
-
-      def avatar=(file)
-        represented.avatar = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file['content'])),
-                                                            filename: file['filename'],
-                                                            content_type: file['content_type']
-      end
+      property :avatar, class: Spotlight::ContactImage, decorator: FeaturedImageRepresenter
     end
 
     collection :contact_emails, class: Spotlight::ContactEmail do
@@ -151,39 +136,22 @@ module Spotlight
     end
 
     collection :resources, class: ->(options) { options[:fragment].key?('type') ? options[:fragment]['type'].constantize : Spotlight::Resource } do
-      (Spotlight::Resource.attribute_names - %w(id url exhibit_id)).each do |prop|
+      (Spotlight::Resource.attribute_names - %w(id upload_id exhibit_id)).each do |prop|
         property prop
       end
 
-      property :url, exec_context: :decorator
-      property :file, exec_context: :decorator
-
-      def url
-        return if represented.is_a? Spotlight::Resources::Upload
+      property :upload, exec_context: :decorator
 
-        represented.url
-      end
-
-      def url=(url)
-        return if represented.is_a? Spotlight::Resources::Upload
-
-        represented.url = url
-      end
-
-      def file
+      def upload
         return unless represented.is_a? Spotlight::Resources::Upload
-        file = represented.url.file
 
-        { filename: file.filename, content_type: file.content_type, content: Base64.encode64(file.read) }
+        FeaturedImageRepresenter.new(represented.upload).to_json
       end
 
-      def file=(file)
+      def upload=(json)
         return unless represented.is_a? Spotlight::Resources::Upload
-        represented.url = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file['content'])),
-                                                         filename: file['filename'],
-                                                         content_type: file['content_type']
+        FeaturedImageRepresenter.new(represented.build_upload).from_json(json)
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/app/services/spotlight/carrierwave_file_resolver.rb

@@ -2,7 +2,9 @@ module Spotlight
   # Used by RIIIF to find files uploaded by carrierwave
   class CarrierwaveFileResolver < Riiif::AbstractFileSystemResolver
     def pattern(id)
-      Spotlight::FeaturedImage.find(id).image.file.file
+      uploaded_file = Spotlight::FeaturedImage.find(id).image.file
+      raise Riiif::ImageNotFoundError, "unable to find file for #{id}" if uploaded_file.nil?
+      uploaded_file.file
     end
   end
 end

data/app/services/spotlight/iiif_resource_resolver.rb

@@ -0,0 +1,73 @@
+module Spotlight
+  ###
+  # Update an ActiveRecord resource that containes identifiers for all the
+  # levels of an image resource described in a IIIF manifest
+  #
+  class IiifResourceResolver
+    delegate :iiif_manifest_url, :iiif_canvas_id, :iiif_image_id, to: :resource
+    def initialize(resource)
+      @resource = resource
+    end
+
+    def resolve!
+      resource.iiif_tilesource = updated_tilesource
+      return resource.save if resource.changed?
+      Rails.logger.info("#{self.class.name} resolved #{iiif_manifest_url}, but nothing changed.")
+    end
+
+    private
+
+    attr_reader :resource
+
+    def updated_tilesource
+      "#{updated_image['resource']['service']['@id']}/info.json"
+    end
+
+    def updated_image
+      new_image = updated_canvas['images'].find do |image|
+        image['@id'] == iiif_image_id
+      end
+
+      raise(ManifestError, "No image with @id #{iiif_image_id} found in #{iiif_manifest_url}") unless new_image
+      new_image
+    end
+
+    def updated_canvas
+      new_canvas = canvases.find do |canvas|
+        canvas['@id'] == iiif_canvas_id
+      end
+
+      raise(ManifestError, "No canvas with @id #{iiif_canvas_id} found in #{iiif_manifest_url}") unless new_canvas
+      new_canvas
+    end
+
+    def canvases
+      sequence['canvases'] || []
+    end
+
+    # Currently only supporting a single sequence
+    def sequence
+      Array.wrap(manifest['sequences']).first || {}
+    end
+
+    def response
+      @response ||= begin
+        Faraday.get(iiif_manifest_url).body
+      rescue Faraday::Error => e
+        Rails.logger.warn("#{self.class.name} failed to fetch #{iiif_manifest_url} with: #{e}")
+        '{}'
+      end
+    end
+
+    def manifest
+      @manifest ||= begin
+        JSON.parse(response)
+      rescue JSON::ParserError => e
+        Rails.logger.warn("#{self.class.name} failed to parse #{iiif_manifest_url} with: #{e}")
+        {}
+      end
+    end
+
+    class ManifestError < RuntimeError; end
+  end
+end

data/app/services/spotlight/resources/iiif_builder.rb

@@ -0,0 +1,17 @@
+module Spotlight
+  module Resources
+    # transforms a IiifHarvester into solr documents
+    class IiifBuilder < Spotlight::SolrDocumentBuilder
+      def to_solr
+        return to_enum(:to_solr) { 0 } unless block_given?
+
+        base_doc = super
+        resource.iiif_manifests.each do |manifest|
+          manifest.with_exhibit(exhibit)
+          manifest_solr = manifest.to_solr
+          yield base_doc.merge(manifest_solr) if manifest_solr.present?
+        end
+      end
+    end
+  end
+end

data/app/services/spotlight/upload_solr_document_builder.rb

@@ -4,19 +4,13 @@ module Spotlight
     delegate :compound_id, to: :resource
 
     def to_solr
-      resource.store_url! # so that #url doesn't return the tmp directory
-
-      solr_hash = super
-
-      add_default_solr_fields solr_hash
-
-      add_image_dimensions solr_hash
-
-      add_file_versions solr_hash
-
-      add_sidecar_fields solr_hash
-
-      solr_hash
+      super.tap do |solr_hash|
+        add_default_solr_fields solr_hash
+        add_image_dimensions solr_hash
+        add_file_versions solr_hash
+        add_sidecar_fields solr_hash
+        add_manifest_path solr_hash
+      end
     end
 
     private
@@ -26,23 +20,29 @@ module Spotlight
     end
 
     def add_image_dimensions(solr_hash)
-      dimensions = ::MiniMagick::Image.open(resource.url.file.file)[:dimensions]
-      solr_hash[:spotlight_full_image_width_ssm] = dimensions.first
-      solr_hash[:spotlight_full_image_height_ssm] = dimensions.last
+      dimensions = Riiif::Image.new(resource.upload_id).info
+      solr_hash[:spotlight_full_image_width_ssm] = dimensions[:width]
+      solr_hash[:spotlight_full_image_height_ssm] = dimensions[:height]
     end
 
     def add_file_versions(solr_hash)
-      resource.spotlight_image_derivatives.each do |config|
-        solr_hash[config[:field]] = if config[:version]
-                                      resource.url.send(config[:version]).url
-                                    else
-                                      resource.url.url
-                                    end
-      end
+      solr_hash[Spotlight::Engine.config.thumbnail_field] = riiif.image_path(resource.upload_id, size: '400,400')
     end
 
     def add_sidecar_fields(solr_hash)
       solr_hash.merge! resource.sidecar.to_solr
     end
+
+    def add_manifest_path(solr_hash)
+      solr_hash[Spotlight::Engine.config.iiif_manifest_field] = spotlight_routes.manifest_exhibit_solr_document_path(exhibit, resource.compound_id)
+    end
+
+    def spotlight_routes
+      Spotlight::Engine.routes.url_helpers
+    end
+
+    def riiif
+      Riiif::Engine.routes.url_helpers
+    end
   end
 end

data/app/uploaders/spotlight/attachment_uploader.rb

@@ -3,10 +3,6 @@ module Spotlight
   ##
   # Sir-trevor image widget uploads
   class AttachmentUploader < CarrierWave::Uploader::Base
-    # Include RMagick or MiniMagick support:
-    # include CarrierWave::RMagick
-    include CarrierWave::MiniMagick
-
     storage Spotlight::Engine.config.uploader_storage
 
     # Override the directory where uploaded files will be stored.
@@ -14,49 +10,5 @@ module Spotlight
     def store_dir
       "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
     end
-
-    version :large do
-      process resize_to_limit: [850, nil]
-    end
-
-    version :medium do
-      process resize_to_limit: [640, nil]
-    end
-
-    version :small do
-      process resize_to_limit: [320, nil]
-    end
-
-    # Provide a default URL as a default if there hasn't been a file uploaded:
-    # def default_url
-    #   # For Rails 3.1+ asset pipeline compatibility:
-    #   # ActionController::Base.helpers.asset_path('fallback/' + [version_name, 'default.png'].compact.join('_'))
-    #
-    #   "/images/fallback/" + [version_name, 'default.png'].compact.join('_')
-    # end
-
-    # Process files as they are uploaded:
-    # process :scale => [200, 300]
-    #
-    # def scale(width, height)
-    #   # do something
-    # end
-
-    # Create different versions of your uploaded files:
-    # version :thumb do
-    #   process :scale => [50, 50]
-    # end
-
-    # Add a white list of extensions which are allowed to be uploaded.
-    # For images you might use something like this:
-    # def extension_white_list
-    #   %w(jpg jpeg gif png)
-    # end
-
-    # Override the filename of the uploaded files:
-    # Avoid using model.id or version_name here, see uploader/store.rb for details.
-    # def filename
-    #   "something.jpg" if original_filename
-    # end
   end
 end

data/app/uploaders/spotlight/featured_image_uploader.rb

@@ -2,28 +2,14 @@ module Spotlight
   ##
   # Page, browse category, and exhibit featured image thumbnails
   class FeaturedImageUploader < CarrierWave::Uploader::Base
-    include CarrierWave::MiniMagick
-
     storage Spotlight::Engine.config.uploader_storage
 
-    version :cropped do
-      process crop: :image ## Crops this version based on original image
-    end
-
-    version :thumb, from_version: :cropped do
-      process resize_to_fill: Spotlight::Engine.config.featured_image_thumb_size
-    end
-
-    version :square, from_version: :cropped do
-      process resize_to_fill: Spotlight::Engine.config.featured_image_square_size
+    def extension_white_list
+      Spotlight::Engine.config.allowed_upload_extensions
     end
 
     def store_dir
       "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
     end
-
-    def default_url
-      ActionController::Base.helpers.image_path('spotlight/fallback/' + [version_name, 'default.png'].compact.join('_'))
-    end
   end
 end

data/app/views/_user_util_links.html.erb

@@ -11,15 +11,18 @@
       <li class="dropdown">
       <a href="#" class="dropdown-toggle" data-toggle="dropdown"><%=current_user%> <b class="caret"></b></a>
         <ul class="dropdown-menu">
-          <% if current_exhibit and can? :curate, current_exhibit %>
+          <% if can? :manage, Spotlight::Site.instance %>
+            <li><%= link_to t(:'spotlight.header_links.edit_site'), spotlight.edit_site_path %></li>
+          <% end %>
+          <% if can? :create, Spotlight::Exhibit %>
             <li>
-              <%= link_to t('spotlight.dashboards.show.header'), spotlight.exhibit_dashboard_path(current_exhibit) %>
+              <%= link_to t(:'spotlight.header_links.create_exhibit'), spotlight.new_exhibit_path %>
             </li>
             <li class="divider"></li>
           <% end %>
-          <% if can? :create, Spotlight::Exhibit %>
+          <% if current_exhibit && can?(:curate, current_exhibit) %>
             <li>
-              <%= link_to t(:'helpers.action.spotlight/exhibit.create'), spotlight.new_exhibit_path %>
+              <%= link_to t('spotlight.header_links.dashboard'), spotlight.exhibit_dashboard_path(current_exhibit) %>
             </li>
             <li class="divider"></li>
           <% end %>
@@ -43,4 +46,4 @@
       </li>
     <% end %>
   </ul>
-</div>
+</div>

data/app/views/catalog/_save_search.html.erb

@@ -8,7 +8,9 @@
         <h4 class="modal-title" id="save-modal-label"><%= t(:'spotlight.saved_search.label') %></h4>
       </div>
       <div class="modal-body">
-        <%=f.text_field :title, label: t(:'spotlight.saved_search.title'), required: true %>
+        <%= f.text_field :title, label: t(:'spotlight.saved_search.title') %>
+        <%= label_tag :id, t(:'spotlight.saved_search.id'), class: 'control-label' %>
+        <%= select_tag :id, options_for_select(current_exhibit.searches.map { |s| [s.title, s.id] }), include_blank: true, class: 'form-control' %>
         <%= render_hash_as_hidden_fields(search_state.params_for_search.except(:qt, :page, :utf8)) %>
       </div>
       <div class="modal-footer">
@@ -18,4 +20,4 @@
     </div>
     <% end %>
   </div>
-</div>
+</div>

data/app/views/layouts/spotlight/spotlight.html.erb

@@ -16,7 +16,11 @@
     <title><%= h(@page_title || application_name) %></title>
     <link href="<%= current_exhibit ? spotlight.opensearch_exhibit_catalog_url(current_exhibit, format: 'xml') : main_app.opensearch_catalog_url(format: 'xml') %>" title="<%= application_name %>" type="application/opensearchdescription+xml" rel="search"/>
     <%= favicon_link_tag 'favicon.ico' %>
-    <%= stylesheet_link_tag    "application" %>
+    <% if current_exhibit %>
+      <%= exhibit_stylesheet_link_tag "application" %>
+    <% else %>
+      <%= stylesheet_link_tag "application" %>
+    <% end %>
     <%= javascript_include_tag "application" %>
     <%= csrf_meta_tags %>
     <%= content_for(:head) %>

data/app/views/shared/_masthead.html.erb

@@ -2,7 +2,7 @@
 
 <div class="masthead <%= 'image-masthead' if current_masthead %> <%= 'resource-masthead' if resource_masthead? %>">
   <% if current_masthead %>
-    <span class='background-container' style="background-image: url('<%= image_path(current_masthead.image.cropped) %>')"></span>
+    <span class='background-container' style="background-image: url('<%= current_masthead.iiif_url %>')"></span>
     <span class='background-container-gradient'></span>
   <% end %>
   

data/app/views/spotlight/about_pages/_contact_properties.html.erb

@@ -1,4 +1,4 @@
-<%= image_tag contact.avatar.thumb.url, class: 'contact-photo' if contact.avatar.present? %>
+<%= image_tag contact.avatar.iiif_url, class: 'contact-photo' if contact.avatar && contact.avatar.iiif_url.present? %>
 <div itemprop="name" class="name"><%= contact.name %></div>
 <% Spotlight::Contact.fields.each do |field, options| %>
   <% if (value = contact.contact_info[field]).present? %>

data/app/views/spotlight/appearances/edit.html.erb

@@ -16,10 +16,16 @@
   <% end %>
   <div role="tabpanel">
     <ul class="nav nav-tabs" role="tablist">
-      <li role="presentation" class="active">
+      <% if Spotlight::Engine.config.exhibit_themes.many? %>
+        <li role="presentation" class="active">
+          <a href="#site-theme" aria-controls="site-theme" role="tab" data-toggle="tab"><%= t(:'.site_theme.heading') %></a>
+        </li>
+      <% end %>
+
+      <li role="presentation" <%= 'class="active"'.html_safe unless Spotlight::Engine.config.exhibit_themes.many? %>>
         <a href="#site-masthead" aria-controls="site-masthead" role="tab" data-toggle="tab"><%= t(:'.site_masthead.heading') %></a>
       </li>
-      
+
       <li role="presentation">
         <a href="#site-thumbnail" aria-controls="site-thumbnail" role="tab" data-toggle="tab"><%= t(:'.site_thumbnail.heading') %></a>
       </li>
@@ -29,17 +35,31 @@
       </li>
     </ul>
     <div class="tab-content">
-      <div role="tabpanel" class="tab-pane active" id="site-masthead">
+      <% if Spotlight::Engine.config.exhibit_themes.many? %>
+      <div role="tabpanel" class="tab-pane active" id="site-theme">
+        <p class="instructions"><%= t(:'.site_theme.help') %></p>
+        <%= f.form_group :theme, label: { text: t(:'.site_theme.label') } do %>
+          <% Spotlight::Engine.config.exhibit_themes.each do |theme| %>
+            <div class="col-md-6">
+              <%= image_tag "spotlight/themes/#{theme}_preview", width: 100, height: 100 %>
+              <%= f.radio_button :theme, theme, label: t(:".site_theme.#{theme}", default: theme.to_s.titleize), inline: true %>
+            </div>
+          <% end %>
+        <% end %>
+      </div>
+      <% end %>
+
+      <div role="tabpanel" class="tab-pane <%= 'active' unless Spotlight::Engine.config.exhibit_themes.many? %>" id="site-masthead">
         <p class="instructions"><%= t(:'.site_masthead.help') %></p>
         <%= f.fields_for(:masthead, current_exhibit.masthead || current_exhibit.build_masthead) do |m| %>
-          <%= render '/spotlight/featured_images/form', f: m, jcrop_options: default_masthead_jcrop_options %>
+          <%= render '/spotlight/featured_images/form', f: m, initial_crop_selection: Spotlight::Engine.config.masthead_initial_crop_selection, crop_type: :masthead %>
         <% end %>
       </div>
-      
+
       <div role="tabpanel" class="tab-pane" id="site-thumbnail">
         <p class="instructions"><%= t(:'.site_thumbnail.help') %></p>
         <%= f.fields_for(:thumbnail, current_exhibit.thumbnail || current_exhibit.build_thumbnail) do |m| %>
-          <%= render '/spotlight/featured_images/form', f: m, jcrop_options: default_site_thumbnail_jcrop_options %>
+          <%= render '/spotlight/featured_images/form', f: m, initial_crop_selection: Spotlight::Engine.config.thumbnail_initial_crop_selection, crop_type: :thumbnail %>
         <% end %>
       </div>