blacklight-spotlight 3.0.0.rc2 → 3.0.0.rc3

data/app/models/spotlight/feature_page.rb

@@ -6,7 +6,7 @@ module Spotlight
   class FeaturePage < Spotlight::Page
     extend FriendlyId
     friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale] do |config|
-      config.reserved_words.concat(%w[update_all])
+      config.reserved_words&.concat(%w[update_all])
     end
 
     has_many :child_pages, class_name: 'Spotlight::FeaturePage', inverse_of: :parent_page, foreign_key: 'parent_page_id'

data/app/models/spotlight/featured_image.rb

@@ -12,7 +12,7 @@ module Spotlight
       # copy the image from the temp upload
       temp_image = Spotlight::TemporaryImage.find(upload_id)
       self.image = CarrierWave::SanitizedFile.new tempfile: StringIO.new(temp_image.image.read),
-                                                  filename: temp_image.image.identifier,
+                                                  filename: temp_image.image.filename || temp_image.image.identifier,
                                                   content_type: temp_image.image.content_type
 
       # Unset the incoming iiif_tilesource, which points at the temp image

data/app/models/spotlight/group.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Exhibit saved searches
+  class Group < ActiveRecord::Base
+    include Spotlight::Translatables
+
+    extend FriendlyId
+    friendly_id :title, use: %i[slugged scoped finders history], scope: [:exhibit]
+    translates :title
+
+    self.table_name = 'spotlight_groups'
+    belongs_to :exhibit
+    has_many :group_members
+    has_many :searches, through: :group_members, source: :member, source_type: 'Spotlight::Search'
+    default_scope { order('weight ASC') }
+    scope :published, -> { where(published: true) }
+    accepts_nested_attributes_for :group_members
+    accepts_nested_attributes_for :searches
+  end
+end

data/app/models/spotlight/group_member.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Exhibit saved searches
+  class GroupMember < ActiveRecord::Base
+    self.table_name = 'spotlight_groups_members'
+    belongs_to :group
+    belongs_to :member, polymorphic: true
+  end
+end

data/app/models/spotlight/home_page.rb

@@ -6,7 +6,7 @@ module Spotlight
   class HomePage < Spotlight::Page
     extend FriendlyId
     friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale] do |config|
-      config.reserved_words.concat(%w[update_all])
+      config.reserved_words&.concat(%w[update_all])
     end
 
     before_save :publish

data/app/models/spotlight/page.rb

@@ -9,8 +9,8 @@ module Spotlight
     extend FriendlyId
     # Note: This configuration also needs to be duplicated on the
     # STI models ({Spotlight::AboutPage}, {Spotlight::FeaturePage}, {Spotlight::HomePage})
-    friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale] do |config|
-      config.reserved_words.concat(%w[update_all])
+    friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale], treat_reserved_as_conflict: true do |config|
+      config.reserved_words&.concat(%w[update_all contacts])
     end
 
     belongs_to :exhibit, touch: true

data/app/models/spotlight/page_configurations.rb

@@ -40,6 +40,7 @@ module Spotlight
         'attachment-endpoint': attachment_endpoint,
         'autocomplete-exhibit-catalog-path': exhibit_autocomplete_endpoint,
         'autocomplete-exhibit-pages-path': page_autocomplete_endpoint,
+        'autocomplete-exhibit-browse-groups-path': browse_groups_autocomplete_endpoint,
         'autocomplete-exhibit-searches-path': search_autocomplete_endpoint,
         'preview-url': page_preview_url
       }.merge(downstream_parameters)
@@ -62,6 +63,10 @@ module Spotlight
       spotlight.exhibit_attachments_path(current_exhibit)
     end
 
+    def browse_groups_autocomplete_endpoint
+      spotlight.exhibit_groups_path(current_exhibit)
+    end
+
     def exhibit_autocomplete_endpoint
       spotlight.autocomplete_exhibit_catalog_path(current_exhibit, q: '%QUERY', format: 'json')
     end

data/app/models/spotlight/resources/iiif_manifest.rb

@@ -69,7 +69,7 @@ module Spotlight
       end
 
       def add_label
-        return unless title_fields.present? && manifest.try(:label)
+        return unless title_fields.present? && manifest&.label
 
         Array.wrap(title_fields).each do |field|
           solr_hash[field] = metadata_class.new(manifest).label
@@ -144,7 +144,7 @@ module Spotlight
       end
 
       def thumbnail_field
-        blacklight_config.index.try(:thumbnail_field)
+        blacklight_config.index.thumbnail_field
       end
 
       def full_image_field
@@ -152,11 +152,11 @@ module Spotlight
       end
 
       def tile_source_field
-        blacklight_config.show.try(:tile_source_field)
+        blacklight_config.show.tile_source_field
       end
 
       def title_fields
-        Spotlight::Engine.config.iiif_title_fields || blacklight_config.index.try(:title_field)
+        Spotlight::Engine.config.iiif_title_fields || blacklight_config.index&.title_field
       end
 
       def sidecar
@@ -187,7 +187,7 @@ module Spotlight
         end
 
         def label
-          return unless manifest.try(:label)
+          return unless manifest&.label
 
           Array(json_ld_value(manifest.label)).map { |v| html_sanitize(v) }.first
         end
@@ -197,7 +197,7 @@ module Spotlight
         attr_reader :manifest
 
         def metadata
-          manifest.try(:metadata) || []
+          manifest&.metadata || []
         end
 
         def metadata_hash

data/app/models/spotlight/search.rb

@@ -12,9 +12,14 @@ module Spotlight
 
     self.table_name = 'spotlight_searches'
     belongs_to :exhibit
+    has_many :group_memberships, class_name: 'Spotlight::GroupMember', as: :member, dependent: :delete_all
+    has_many :groups, through: :group_memberships
+    accepts_nested_attributes_for :group_memberships
+    accepts_nested_attributes_for :groups
     serialize :query_params, Hash
     default_scope { order('weight ASC') }
     scope :published, -> { where(published: true) }
+    scope :unpublished, -> { where(published: [nil, false]) }
     validates :title, presence: true
 
     translates :title, :subtitle, :long_description

data/app/services/spotlight/exhibit_import_export_service.rb

@@ -11,6 +11,7 @@ module Spotlight
     class_attribute :serialization_pipeline, default: %i[
       raw_json
       add_feature_page_hierarchy
+      add_browse_group_hierarchy
       add_page_content
       attach_featured_images
       attach_attachments
@@ -37,34 +38,43 @@ module Spotlight
         attachments: {},
         languages: {},
         translations: {},
-        owned_taggings: {}
+        owned_taggings: {},
+        groups: {}
       )
 
       exhibit_attributes = hash.reject { |_k, v| v.is_a?(Array) || v.is_a?(Hash) }
-      exhibit.update_attributes(exhibit_attributes.except(:theme))
+      exhibit.update(exhibit_attributes.except(:theme))
       exhibit.theme = exhibit_attributes[:theme] if exhibit.themes.include? exhibit_attributes[:theme]
 
       deserialize_featured_image(exhibit, :masthead, hash[:masthead]) if hash[:masthead]
       deserialize_featured_image(exhibit, :thumbnail, hash[:thumbnail]) if hash[:thumbnail]
 
-      exhibit.blacklight_configuration.update_attributes hash[:blacklight_configuration].deep_stringify_keys if hash[:blacklight_configuration]
+      exhibit.blacklight_configuration.update hash[:blacklight_configuration].deep_stringify_keys if hash[:blacklight_configuration]
 
       hash[:main_navigations].each do |attr|
         ar = exhibit.main_navigations.find_or_initialize_by(nav_type: attr[:nav_type])
-        ar.update_attributes(attr)
+        ar.update(attr)
       end
 
       hash[:contact_emails].each do |attr|
         ar = exhibit.contact_emails.find_or_initialize_by(email: attr[:email])
-        ar.update_attributes(attr)
+        ar.update(attr)
+      end
+
+      hash[:groups].each do |attr|
+        gr = exhibit.groups.find_or_initialize_by(slug: attr[:slug])
+        gr.update(attr)
       end
 
       hash[:searches].each do |attr|
+        group_slugs = attr.delete(:group_slugs) || []
         masthead = attr.delete(:masthead)
         thumbnail = attr.delete(:thumbnail)
 
         ar = exhibit.searches.find_or_initialize_by(slug: attr[:slug])
-        ar.update_attributes(attr)
+        ar.update(attr)
+
+        ar.update(groups: exhibit.groups.select { |x| group_slugs.include? x.slug })
 
         deserialize_featured_image(ar, :masthead, masthead) if masthead
         deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -76,7 +86,7 @@ module Spotlight
         translated_pages = attr.delete(:translated_pages) || []
 
         ar = exhibit.about_pages.find_or_initialize_by(slug: attr[:slug])
-        ar.update_attributes(attr)
+        ar.update(attr)
 
         deserialize_featured_image(ar, :masthead, masthead) if masthead
         deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -86,7 +96,7 @@ module Spotlight
           thumbnail = tattr.delete(:thumbnail)
 
           tar = ar.translated_page_for(tattr[:locale]) || ar.clone_for_locale(tattr[:locale])
-          tar.update_attributes(tattr)
+          tar.update(tattr)
 
           deserialize_featured_image(ar, :masthead, masthead) if masthead
           deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -98,7 +108,7 @@ module Spotlight
         thumbnail = attr.delete(:thumbnail)
 
         ar = exhibit.feature_pages.find_or_initialize_by(slug: attr[:slug])
-        ar.update_attributes(attr.except(:parent_page_slug, :translated_pages))
+        ar.update(attr.except(:parent_page_slug, :translated_pages))
 
         deserialize_featured_image(ar, :masthead, masthead) if masthead
         deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -119,7 +129,7 @@ module Spotlight
           thumbnail = tattr.delete(:thumbnail)
 
           tar = ar.translated_page_for(tattr[:locale]) || ar.clone_for_locale(tattr[:locale])
-          tar.update_attributes(tattr)
+          tar.update(tattr)
 
           deserialize_featured_image(ar, :masthead, masthead) if masthead
           deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -128,7 +138,7 @@ module Spotlight
 
       if hash[:home_page]
         translated_pages = hash[:home_page].delete(:translated_pages) || []
-        exhibit.home_page.update_attributes(hash[:home_page].except(:thumbnail))
+        exhibit.home_page.update(hash[:home_page].except(:thumbnail))
         deserialize_featured_image(exhibit.home_page, :thumbnail, hash[:home_page][:thumbnail]) if hash[:home_page][:thumbnail]
 
         translated_pages.each do |tattr|
@@ -136,7 +146,7 @@ module Spotlight
           thumbnail = tattr.delete(:thumbnail)
 
           tar = exhibit.home_page.translated_page_for(tattr[:locale]) || exhibit.home_page.clone_for_locale(tattr[:locale])
-          tar.update_attributes(tattr)
+          tar.update(tattr)
 
           deserialize_featured_image(ar, :masthead, masthead) if masthead
           deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -147,26 +157,26 @@ module Spotlight
         avatar = attr.delete(:avatar)
 
         ar = exhibit.contacts.find_or_initialize_by(slug: attr[:slug])
-        ar.update_attributes(attr)
+        ar.update(attr)
 
         deserialize_featured_image(ar, :avatar, avatar) if avatar
       end
 
       hash[:custom_fields].each do |attr|
         ar = exhibit.custom_fields.find_or_initialize_by(slug: attr[:slug])
-        ar.update_attributes(attr)
+        ar.update(attr)
       end
 
       hash[:solr_document_sidecars].each do |attr|
         ar = exhibit.solr_document_sidecars.find_or_initialize_by(document_id: attr[:document_id])
-        ar.update_attributes(attr)
+        ar.update(attr)
       end
 
       hash[:resources].each do |attr|
         upload = attr.delete(:upload)
 
         ar = exhibit.resources.find_or_initialize_by(type: attr[:type], url: attr[:url])
-        ar.update_attributes(attr)
+        ar.update(attr)
 
         deserialize_featured_image(ar, :upload, upload) if upload
       end
@@ -183,12 +193,12 @@ module Spotlight
 
       hash[:languages].each do |attr|
         ar = exhibit.languages.find_or_initialize_by(locale: attr[:locale])
-        ar.update_attributes(attr)
+        ar.update(attr)
       end
 
       hash[:translations].each do |attr|
         ar = exhibit.translations.find_or_initialize_by(locale: attr[:locale], key: attr[:key])
-        ar.update_attributes(attr)
+        ar.update(attr)
       end
 
       hash[:owned_taggings].each do |attr|
@@ -200,18 +210,21 @@ module Spotlight
     def deserialize_featured_image(obj, method, data)
       file = data.delete(:image)
       image = obj.public_send("build_#{method}")
-      image.update_attributes(data)
+      image.update(data)
       if file
         image.image = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file[:content])),
                                                      filename: file[:filename],
                                                      content_type: file[:content_type]
+        # Unset the iiif_tilesource field as the new image should be different, because
+        # the source has been reloaded
+        image.iiif_tilesource = nil
       end
       image.save!
       obj.update(method => image)
     end
 
-    def as_json(**args)
-      self.class.serialization_pipeline.inject(args) do |memo, step|
+    def as_json(*_args)
+      self.class.serialization_pipeline.inject({}) do |memo, step|
         method(step).call(memo)
       end
     end
@@ -292,7 +305,7 @@ module Spotlight
       if file
         img = {
           image: {
-            filename: file.identifier, content_type: file.content_type, content: Base64.encode64(file.read)
+            filename: file.filename, content_type: file.content_type, content: Base64.encode64(file.read)
           }
         }
       end
@@ -335,6 +348,18 @@ module Spotlight
       json
     end
 
+    def add_browse_group_hierarchy(json)
+      return json unless json[:groups] && json[:searches]
+
+      json[:searches].each do |attr|
+        search = exhibit.searches.find_by(slug: attr[:slug])
+
+        attr[:group_slugs] = search.groups.pluck(:slug)
+      end
+
+      json
+    end
+
     def add_page_content(json)
       (json[:feature_pages] || []).each do |page|
         p = exhibit.feature_pages.find_by(slug: page[:slug])
@@ -382,6 +407,9 @@ module Spotlight
                         searches: { # thumbnail
                           except: %i[id scope exhibit_id]
                         },
+                        groups: {
+                          except: %i[id exhibit_id]
+                        },
                         about_pages: { # thumbnail
                           except: %i[id scope exhibit_id parent_page_id content],
                           include: {

data/app/views/spotlight/browse/_search.html.erb

@@ -1,6 +1,7 @@
 <%= cache [@exhibit, search, I18n.locale] do %>
+  <% group ||= @group %>
   <div class="col-md-4 col-12 category">
-    <%= link_to spotlight.exhibit_browse_path(@exhibit, search) do %>
+    <%= link_to group.present? ? spotlight.exhibit_browse_group_path(@exhibit, group, search) : spotlight.exhibit_browse_path(@exhibit, search) do %>
       <div class="image-overlay">
         <%= image_tag(search.thumbnail_image_url || 'spotlight/default_browse_thumbnail.jpg', class: 'img-responsive', alt: '') %>
         <div class="text-overlay">

data/app/views/spotlight/browse/index.html.erb

@@ -2,6 +2,19 @@
 <% set_html_page_title(title) %>
 <h1 class="sr-only"><%= title %></h1>
 
+<% if @groups.any? # active %>
+  <ul class="browse-group-navigation nav nav-pills justify-content-center">
+    <li class="nav-item">
+      <%= link_to t('spotlight.exhibits.groups.all'), exhibit_browse_index_path(current_exhibit), class: "nav-link #{'active' if @group.blank?}" %>
+    </li>
+    <% @groups.each do |group| %>
+      <li class="nav-item">
+        <%= link_to group.title, exhibit_browse_groups_path(current_exhibit, group), class: "nav-link #{'active' if @group.present? && @group.id == group.id}" %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>
+
 <div class="browse-landing row">
   <%= render collection: @searches, partial: 'spotlight/browse/search' %>
 </div>

data/app/views/spotlight/catalog/_document.html.erb

@@ -1,4 +1,2 @@
-<% # copied from blacklight; rails tries to render spotlight/catalog/document explicitly.. -%>
-<div class="document <%= render_document_class document %>" itemscope itemtype="<%= document.itemtype %>">
-  <%= render_document_partials document, blacklight_config.view_config(document_index_view_type).partials, :document_counter => document_counter %>
-</div>
+<% # try to render the blacklight provided catalog/document partial; rails tries to render spotlight/catalog/document explicitly.. -%>
+<%= render 'catalog/document', local_assigns  %>

data/app/views/spotlight/catalog/index.iiif_json.jbuilder

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+json.set! :@context, 'http://iiif.io/api/presentation/2/context.json'
+json.set! :@id, exhibit_iiif_collection_url(page: params[:page]&.to_i)
+json.set! :@type, 'sc:Collection'
+json.label current_exhibit.title
+json.viewingHint 'top'
+json.description current_exhibit.description if current_exhibit.description
+json.manifests do
+  json.array!(@response.documents) do |doc|
+    next unless doc.first(Spotlight::Engine.config.iiif_manifest_field)
+
+    json.set! :@id, doc.first(Spotlight::Engine.config.iiif_manifest_field)
+    json.set! :@type, 'sc:manifest'
+    json.label presenter(doc).label(document_show_link_field(doc)).to_str
+  end
+end
+
+json.total @response.total
+json.first exhibit_iiif_collection_url(page: nil)
+
+json.next exhibit_iiif_collection_url(page: @response.next_page) unless @response.last_page? || @response.out_of_range?

data/app/views/spotlight/searches/_form.html.erb

@@ -16,6 +16,10 @@
         <a href="#search-description" aria-controls="search-description" role="tab" data-toggle="tab" class="nav-link active"><%= t(:'.search_description') %></a>
       </li>
 
+      <li role="presentation" class="nav-item">
+        <a href="#search-group" aria-controls="search-group" role="tab" data-toggle="tab" class="nav-link"><%= t(:'.search_group') %></a>
+      </li>
+
       <li role="presentation" class="nav-item">
         <a href="#search-masthead" aria-controls="search-masthead" role="tab" data-toggle="tab" class="nav-link"><%= t(:'.search_masthead') %></a>
       </li>
@@ -50,6 +54,14 @@
           </div>
         <% end %>
       </div>
+      <div role="tabpanel" class="tab-pane" id="search-group">
+        <% if @groups.present? %>
+          <p class="instructions"><%= t(:'.group.help') %></p>
+          <%= f.collection_check_boxes(:group_ids, @groups, :id, :title, hide_label: true) %>
+        <% else %>
+          <p class="instructions"><%= t(:'.group.help_no_groups') %></p>
+        <% end %>
+      </div>
       <div role="tabpanel" class="tab-pane" id="search-masthead">
         <%= f.fields_for :masthead, (@search.masthead || @search.build_masthead) do |m| %>
           <p class="instructions"><%= t(:'.masthead.help') %></p>