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

data/app/services/spotlight/validity_checker.rb

@@ -5,16 +5,16 @@ module Spotlight
   # check if a delayed job still needs to run
   class ValidityChecker
     # Return a validity token
-    # @param [ActiveModel::Model]
+    # @param [ActiveJob::Base]
     # @return [Object] any serializable object
-    def mint(_model); end
+    def mint(_job); end
 
     # Check if the token is still valid for the model
-    # @param [ActiveModel::Model]
+    # @param [ActiveJob::Base]
     # @param [Object] the serializable token minted by #mint
     # @return [boolean]
-    def check(_model, _token)
-      true
+    def check(_job, validity_token: nil)
+      validity_token || true
     end
   end
 end

data/app/values/custom_field_name.rb

@@ -5,6 +5,7 @@
 class CustomFieldName
   delegate :readonly_field?, :configuration, :field_type, to: :custom_field
   attr_reader :custom_field
+
   def initialize(custom_field)
     @custom_field = custom_field
   end

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

@@ -12,7 +12,7 @@
       <div class="modal-body">
         <%= f.text_field :title, label: t(:'spotlight.saved_search.title') %>
         <%= label_tag :id, t(:'spotlight.saved_search.id'), class: 'col-form-label' %>
-        <%= select_tag :id, options_for_select(current_exhibit.searches.map { |s| [s.title, s.id] }), include_blank: true, class: 'form-control' %>
+        <%= select_tag :id, options_for_select(current_exhibit.searches.map { |s| [s.full_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 d-flex flex-row-reverse justify-content-start">

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

@@ -4,23 +4,23 @@
 
     <ol>
       <li>
-        To add content to this page, click the Edit button above to enter Edit mode.
+        To add content to this page, select the Edit button above to enter edit mode.
       </li>
       <li>
-        In Edit mode, click the plus sign icon to display the widget selection panel. This panel displays a range of widgets, each of which adds a different type of content to the page.
+        In edit mode, select the plus sign icon to display the widget selection panel. This panel displays a range of widgets, each of which adds a different type of content to the page.
       </li>
       <li>
-        Select a widget to configure. Click <strong>Save changes</strong> when you're ready to add it to the page.
+        Select a widget to configure. Select <b>Save changes</b> when you're ready to add it to the page.
       </li>
       <li>
         Repeat the steps above to continue adding widgets to build out the page. To work more efficiently, you can configure multiple widgets before saving the page. Use the icons in the lower right of the widget configuration panel to preview, reorder, or delete widgets.
       </li>
       <li>
-        Use the checkbox in the <strong>Options</strong> tab to publish or unpublish the page.
+        Use the checkbox in the <b>Options</b> tab to publish or unpublish the page.
       </li>
       <li>
         Visit the Spotlight <%= link_to 'documentation pages', 'https://github.com/projectblacklight/spotlight/wiki' %> to learn more about creating exhibit pages.
       </li>
     </ol>
   </div>
-<% end %>
+<% end %>

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

@@ -1,12 +1,14 @@
 <%= 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">
            <h2 class="browse-category-title">
-             <%= search.title%>
-             <small><%= t :'spotlight.browse.search.item_count', count: search.count %></small>
+             <span class="title"><%= search.title%></span>
+             <% if search.subtitle.present? %><span class="category-subtitle"><%= search.subtitle %></span><% end %>
+             <small class="item-count"><%= t :'spotlight.browse.search.item_count', count: search.count %></small>
            </h2>
          </div>
       </div>

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

@@ -1,2 +1,3 @@
-<%= search.title %>
+<span class="title"><%= search.title %></span>
+<% if search.subtitle.present? %><span class="subtitle"><%= search.subtitle %></span><% end %>
 <small class="item-count"><%= t :'spotlight.browse.search.item_count', count: params[:browse_q] ? parent_search_count: search.count %></small>

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/contacts/_form.html.erb

@@ -9,7 +9,7 @@
   <%= f.fields_for :avatar, (@contact.avatar || @contact.build_avatar) do |af| %>
     <div data-cropper="<%= af.object.model_name.singular_route_key %>" data-form-prefix="<%= form_prefix(af) %>">
     <%= field_set_tag(t(:'.avatar.header')) do %>
-      <p class="instructions"><%= t(:'featured_images.form.crop_area.help', scope: [:spotlight], thing: 'contact photo') %></p>
+      <p class="instructions"><%= t(:'featured_images.form.crop_area.help_html', scope: [:spotlight], thing: 'contact photo') %></p>
 
       <div>
         <%= af.radio_button(:source, :remote, label: t(:'.source.remote.label')) %>

data/app/views/spotlight/dashboards/_reindexing_activity.html.erb

@@ -12,13 +12,13 @@
     </tr>
   </thead>
   <tbody>
-    <% @recent_reindexing.each do |log_entry| %>
+    <% @recent_reindexing.each do |tracker| %>
       <tr class="d-flex">
-        <td class="col-3"><%= l log_entry.start_time, format: :long if log_entry.start_time %></td>
-        <td class="col-3"><%= log_entry.user.email if log_entry.user %></td>
-        <td class="col-1"><%= log_entry.items_reindexed_count %></td>
-        <td class="col-3"><%= distance_of_time_in_words log_entry.duration, 0, include_seconds: true if log_entry.duration %></td>
-        <td class="col-2"><%= t "reindexing_log.status.#{log_entry.job_status}" %></td>
+        <td class="col-3"><%= l tracker.created_at, format: :long %></td>
+        <td class="col-3"><%= tracker.user.email if tracker.user %></td>
+        <td class="col-1"><%= tracker.progress %></td>
+        <td class="col-3"><%= distance_of_time_in_words tracker.created_at, tracker.updated_at, include_seconds: true if tracker.completed? || tracker.failed? %></td>
+        <td class="col-2"><%= t "reindexing_log.status.#{tracker.status}" %></td>
       </tr>
     <% end %>
   </tbody>

data/app/views/spotlight/feature_pages/_empty.html.erb

@@ -4,23 +4,23 @@
 
     <ol>
       <li>
-        To add content to this page, click the Edit button above to enter Edit mode.
+        To add content to this page, select the Edit button above to enter edit mode.
       </li>
       <li>
-        In Edit mode, click the plus sign icon to display the widget selection panel. This panel displays a range of widgets, each of which adds a different type of content to the page.
+        In edit mode, select the plus sign icon to display the widget selection panel. This panel displays a range of widgets, each of which adds a different type of content to the page.
       </li>
       <li>
-        Select a widget to configure. Click <strong>Save changes</strong> when you're ready to add it to the page.
+        Select a widget to configure. Select <b>Save changes</b> when you're ready to add it to the page.
       </li>
       <li>
         Repeat the steps above to continue adding widgets to build out the page. To work more efficiently, you can configure multiple widgets before saving the page. Use the icons in the lower right of the widget configuration panel to preview, reorder, or delete widgets.
       </li>
       <li>
-        Note the <strong>Options</strong> and <strong>Thumbnail</strong> tabs at the top of the page in Edit mode. Options in these tabs enable you to publish or unpublish the page, turn on or off the page sidebar, and create a thumbnail image to represent the page.
+        Note the <b>Options</b> and <b>Thumbnail</b> tabs at the top of the page in edit mode. Options in these tabs enable you to publish or unpublish the page, turn on or off the page sidebar, and create a thumbnail image to represent the page.
       </li>
       <li>
         Visit the Spotlight <%= link_to 'documentation pages', 'https://github.com/projectblacklight/spotlight/wiki' %> to learn more about creating exhibit pages.
       </li>
     </ol>
   </div>
-<% end %>
+<% end %>

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

@@ -30,7 +30,7 @@
   </div>
 <% end %>
 <%= field_set_tag(t(:'.source.remote.header')) do %>
-  <p class="instructions"><%= t(:'.crop_area.help', thing: crop_type) %></p>
+  <p class="instructions"><%= t(:'.crop_area.help_html', thing: crop_type) %></p>
   <%= iiif_cropper_tags f, initial_crop_selection: initial_crop_selection %>
 <% end %>
 </div>

data/app/views/spotlight/featured_images/_upload_form.html.erb

@@ -12,7 +12,7 @@
   </div>
 <% end %>
 <%= field_set_tag(t(:'.source.remote.header')) do %>
-  <p class="instructions"><%= t(:'.crop_area.help', thing: crop_type) %></p>
+  <p class="instructions"><%= t(:'.crop_area.help_html', thing: crop_type) %></p>
   <%= iiif_cropper_tags f, initial_crop_selection: initial_crop_selection %>
 <% end %>
 </div>

data/app/views/spotlight/home_pages/_empty.html.erb

@@ -20,14 +20,14 @@
       <% end %>
 
       <% if Spotlight::Engine.config.resource_partials.any? %>
-        <li>Add items to the exhibit. Go to the <%= link_to "Curation > Items", admin_exhibit_catalog_path(current_exhibit) %> page and click <strong>Add items</strong>. You can add items individually or in bulk via a CSV file.</li>
+        <li>Add items to the exhibit. Go to the <%= link_to "Curation > Items", admin_exhibit_catalog_path(current_exhibit) %> page and select <b>Add items</b>. You can add items individually or in bulk via a CSV file.</li>
       <% end %>
 
       <% if can? :update, current_exhibit.blacklight_configuration %>
-        <li>Use the other Curation pages, such as <%= link_to "Curation > Metadata", edit_exhibit_metadata_configuration_path(current_exhibit) %> and <%= link_to "Curation > Search", edit_exhibit_search_configuration_path(current_exhibit) %>, to customize the way various features are presented to exhibit visitors.</li>
+        <li>Use the other curation pages, such as <%= link_to "Curation > Metadata", edit_exhibit_metadata_configuration_path(current_exhibit) %> and <%= link_to "Curation > Search", edit_exhibit_search_configuration_path(current_exhibit) %>, to customize the way various features are presented to exhibit visitors.</li>
       <% end %>
 
       <li>Visit the Spotlight <%= link_to "documentation pages", "https://github.com/projectblacklight/spotlight/wiki" %> to learn how to add and edit feature pages, about pages, custom browse categories, and more.</li>
     </ol>
   <% end %>
-</div>
+</div>

data/app/views/spotlight/indexing_complete_mailer/documents_indexed.html.erb

@@ -1,3 +1,12 @@
 <p><%= t :".title" %></p>
 
 <p><%= t :".body", count: @number, title: @exhibit.title %></p>
+
+<% if @errors.length > 0 %>
+  <p><%= t :".errors",  default: :'spotlight.catalog.reindex_progress_panel.error' %></p>
+  <ul>
+    <% @errors.each do |index, message| %>
+      <li><%= t :'.error', index: index, message: message.to_sentence %>
+    <% end %>
+  </ul>
+<% end  %>

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

@@ -2,7 +2,7 @@
   # TODO: the "if @page.persisted?" business below could possibly be done w/ some clever polymorphic routing.
   # Leaving as-is for now since technically you can't get to the new page form anyway.
 %>
-<%= bootstrap_form_for([spotlight, @page.exhibit, @page], role: 'form', html: { data: configurations_for_current_page.merge('form-observer': true)}) do |f| %>
+<%= bootstrap_form_for(@page, url: url_for([spotlight, @page.exhibit, @page, format: nil]), role: 'form', html: { data: configurations_for_current_page.merge('form-observer': true)}) do |f| %>
   <%= render @page.lock if @page.lock and not @page.lock.stale? and not @page.lock.current_session? %>
   <% if @page.errors.any? %>
     <div id="error_explanation">
@@ -40,7 +40,7 @@
         </div>
         <div class="form-group">
           <%= f.label :content, class: 'sr-only' %>
-          <%= f.text_area_without_bootstrap :content, value: { data: f.object.content.as_json }.to_json, class: content_editor_class(f.object), data: { 'block-types': Spotlight::Engine.config.sir_trevor_widgets } %>
+          <%= f.text_area_without_bootstrap :content, value: { data: f.object.content.as_json }.to_json, class: content_editor_class(f.object), data: { 'block-types': SirTrevorRails::Block.custom_block_types } %>
         </div>
       </div>
 

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>
@@ -29,6 +33,7 @@
     <div class="tab-content">
       <div role="tabpanel" class="tab-pane active" id="search-description">
         <%= f.text_field :title, control_col: "col-sm-5" %>
+        <%= f.text_field :subtitle, control_col: "col-sm-5" %>
         <%= f.text_area :long_description, rows: 5 %>
         <%= f.form_group :search_box, label: { text: t(:'.search_box.label'), class: 'pt-0' }, help: t(:'.search_box.help_block') do %>
           <%= f.check_box :search_box, label: t(:'.search_box.checkbox_label') %>
@@ -49,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>

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

@@ -0,0 +1,27 @@
+<% group = f.object %>
+<%= render layout: 'spotlight/shared/dd3_item', locals: { id: group.id.to_s, field: f, dd3_content_classes: "group" , enabled_method: :published, label_method: :title, label: group.title } do |_, section| %>
+  <% case section when nil %>
+  <div class="d-flex flex-grow-1">
+    <div>
+      <%= f.check_box :published, inline: true, hide_label: true %>
+    </div>
+
+    <div class="flex-grow-1 mx-2 main">
+      <h4 class="card-title h6 mb-0" data-in-place-edit-target=".edit-in-place" data-in-place-edit-field-target="[data-edit-field-target='true']">
+        <a href="#edit-in-place" class="field-label edit-in-place"><%= group.title %></a>
+        <%= f.hidden_field :title, value: group.title , class: 'form-control form-control-sm title-field', data: {:"edit-field-target" => 'true'} %>
+      </h4>
+
+      <div class="card-text">
+        <div class=""><%= t :'spotlight.searches.group.category_count', count: group.searches.count %> <%= t :'spotlight.searches.group.unpublished_count', count: group.searches.unpublished.count %> &bull; <%= link_to t(:'helpers.action.view'), exhibit_browse_groups_path(current_exhibit, group) %></div>
+        <%= f.hidden_field :id %>
+        <%= f.hidden_field :weight, data: {property: "weight"} %>
+      </div>
+    </div>
+    <div class="flex m-2">
+      <div class="card-text">
+        <%= exhibit_delete_link(group) %>
+      </div>
+    </div>
+  <% end %>
+<% end %>

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

@@ -13,6 +13,7 @@
     <div class="flex-grow-1 mx-2 main">
       <h4 class="card-title h6 mb-0">
         <%= search.title %>
+        <% if search.subtitle.present? %><span class="subtitle"><%= search.subtitle %></span><% end %>
       </h4>
 
       <div class="card-text">

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

@@ -3,7 +3,6 @@
 <% end %>
 
 <%= curation_page_title %>
-<h2><%= t(:'.categories_header') %></h2>
 
 <% if @searches.empty? %>
   <%= t :'.no_saved_searches' %>
@@ -13,24 +12,66 @@
     </p>
   <% end %>
 <% else %>
-  <p class="instructions"><%= t(:'.instructions') %></p>
-  <% unless @exhibit.searchable? %>
-    <p class="instructions alert-warning">
-      <%= t(:'.not_searchable_html', href: link_to(t(:'spotlight.configuration.sidebar.search_configuration'), spotlight.edit_exhibit_search_configuration_path(@exhibit))) %>
-    </p>
-  <% end %>
-  <%= bootstrap_form_for @exhibit, url: update_all_exhibit_searches_path(@exhibit), layout: :horizontal, control_col: 'col-sm-10' do |f| %>
+  <div role="tabpanel">
+    <ul class="nav nav-tabs" role="tablist">
+      <li role="presentation" class="nav-item">
+        <a href="#browse-categories" aria-controls="browse-categories" role="tab" data-toggle="tab" class="nav-link active"><%= t(:'.categories_header') %></a>
+      </li>
 
-    <div class="panel-group dd search_admin" id="nested-pages" data-behavior="nestable" data-max-depth="1">
-      <ol class="dd-list">
-        <%= f.fields_for :searches do |p| %>
-          <%= render partial: 'search', locals: { f: p} %>
+      <li role="presentation" class="nav-item">
+        <a href="#browse-groups" aria-controls="browse-groups" role="tab" data-toggle="tab" class="nav-link"><%= t(:'.groups_header') %></a>
+      </li>
+    </ul>
+    <div class="tab-content">
+      <div role="tabpanel" class="tab-pane active" id="browse-categories">
+        <p class="instructions"><%= t(:'.categories_instructions') %></p>
+        <% unless @exhibit.searchable? %>
+          <p class="instructions alert-warning">
+            <%= t(:'.not_searchable_html', href: link_to(t(:'spotlight.configuration.sidebar.search_configuration'), spotlight.edit_exhibit_search_configuration_path(@exhibit))) %>
+          </p>
         <% end %>
-      </ol>
-    </div>
+        <%= bootstrap_form_for @exhibit, url: update_all_exhibit_searches_path(@exhibit), layout: :horizontal, control_col: 'col-sm-10' do |f| %>
 
-    <div class="float-right">
-      <%= submit_tag t(:'helpers.action.update_all'), class: "btn btn-primary" %>
+          <div class="panel-group dd search_admin" id="nested-pages" data-behavior="nestable" data-max-depth="1">
+            <ol class="dd-list">
+              <%= f.fields_for :searches do |p| %>
+                <%= render partial: 'search', locals: { f: p} %>
+              <% end %>
+            </ol>
+          </div>
+
+          <div class="float-right">
+            <%= submit_tag t(:'helpers.action.update_all'), class: "btn btn-primary" %>
+          </div>
+        <% end %>
+      </div>
+      <div role="tabpanel" class="tab-pane" id="browse-groups">
+        <div class="instructions"><%= t(:'.groups_instructions_html') %></div>
+        <%= bootstrap_form_for @exhibit, url: update_all_exhibit_groups_path(@exhibit), layout: :horizontal, control_col: 'col-sm-10' do |f| %>
+
+          <div class="panel-group dd search_admin" id="nested-pages" data-behavior="nestable" data-max-depth="1">
+            <ol class="dd-list">
+              <%= f.fields_for :groups do |p| %>
+                <%= render partial: 'group', locals: { f: p} %>
+              <% end %>
+            </ol>
+          </div>
+
+          <div class="float-right">
+            <%= submit_tag t(:'helpers.action.update_all'), class: "btn btn-primary" %>
+          </div>
+        <% end %>
+        <%= form_for :group, url: spotlight.exhibit_groups_path(current_exhibit), html: {class: "expanded-add-button"} do |f|%>
+          <a href='#add-new' class="btn btn-primary" data-turbolinks="false" data-expanded-add-button="true" data-field-target="[data-title-field]">
+            <%= t(:'.add_new_group') %> <%= blacklight_icon('chevron_right') %>
+            <span data-title-field="true" class="input-field">
+              <%= f.text_field(:title) %>
+              <%= f.submit t(:'.save'), data: {behavior: "save"} %>
+              <%= f.submit t(:'.cancel'), data: {behavior: "cancel"} %>
+            </span>
+          </a>
+        <%- end -%>
+      </div>
     </div>
-  <% end %>
+  </div>
 <% end %>