blacklight-spotlight 3.0.0.rc2 → 3.0.0.rc3

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/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 %>

data/app/views/spotlight/sir_trevor/blocks/_browse_group_categories_block.html.erb

@@ -0,0 +1,44 @@
+<% if browse_group_categories_block.groups? %>
+  <% browse_group_categories_block.groups.each do |group| %>
+    <div class="browse-group-categories-block" data-browse-group-categories-count="<%= group.searches.count %>">
+      <div class="d-flex flex-column flex-md-row py-2">
+        <div class="d-flex justify-content-between align-items-end">
+          <h2 class="m-0"><%= group.title %></h2>
+          <div class="pl-5">
+            <%= link_to 'View all', exhibit_browse_groups_path(current_exhibit, group) %>
+          </div>
+        </div>
+        <% if group.searches.count > 1 %>
+          <ul class="browse-group-categories-controls p-0 pt-2 pt-md-0 ml-md-auto mb-0 d-flex justify-content-center align-items-end">
+            <li class="prev px-1">
+              <%= blacklight_icon 'arrow-alt-circle-left' %>
+            </li>
+            <li class="next px-1">
+              <%= blacklight_icon 'arrow-alt-circle-right' %>
+            </li>
+          </ul>
+        <% end %>
+      </div>
+      <div class="spotlight-flexbox browse-categories categories-<%= [group.searches.count, (@page.display_sidebar? ? 3 : 4)].min %>" data-browse-group-categories-carousel data-sidebar='<%= @page.display_sidebar? %>' data-browse-group-categories-count="<%= group.searches.count %>">
+        <% group.searches.published.each_with_index do |search, index| %>
+          <div class="box category-1 justify-content-center justify-content-md-start">
+            <%= link_to spotlight.exhibit_browse_group_path(current_exhibit, group, search), class: 'justify-content-center' do %>
+              <div class="browse-category" style='background-image: linear-gradient(rgba(0, 0, 0, 0.0), rgba(0, 0, 0, 0.1), rgba(0, 0, 0, 0.5)), url("<%= search.thumbnail.iiif_url if search.thumbnail %>")'>
+                <div class="category-caption">
+                  <p class="category-title">
+                    <%= search.title %>
+                    <% if search.subtitle.present? %><span class="category-subtitle"><%= search.subtitle %></span><% end %>
+                  </p>
+
+                  <% if browse_group_categories_block.display_item_counts? %>
+                    <span class="item-count"><%= t(:'.items', count: search.count) %></span>
+                  <% end %>
+                </div>
+              </div>
+            <% end %>
+          </div>
+        <% end %>
+      </div>
+    </div>
+  <% end %>
+<% end %>

data/app/views/spotlight/translations/_groups.html.erb

@@ -0,0 +1,34 @@
+<div role="tabpanel" class="tab-pane <%= 'active' if @tab == 'groups' %>" id="groups">
+  <%= bootstrap_form_for current_exhibit, url: spotlight.exhibit_translations_path(current_exhibit), layout: :horizontal do |f| %>
+    <% # Add hidden fields for the language and tab so the redirect knows how to come back here %>
+    <%= hidden_field_tag :language, @language %>
+    <%= hidden_field_tag :tab, 'groups' %>
+
+    <% current_exhibit.groups.each do |group| %>
+      <% title_translation = Translation.find_or_initialize_by(exhibit: current_exhibit, key: "#{group.slug}.title", locale: @language) %>
+      <%= f.fields_for :translations, title_translation do |translation_fields| %>
+        <%= translation_fields.hidden_field :key %>
+        <%= translation_fields.hidden_field :locale %>
+        <div data-translation-progress-item="true" class="row form-group browse-group-title">
+          <%= translation_fields.label :value, group[:title], class: 'col-form-label col-12 col-sm-2' %>
+          <div class="col-11 col-sm-9">
+            <%= translation_fields.text_field_without_bootstrap :value, class: 'form-control' %>
+          </div>
+          <div class="col-1">
+            <% if title_translation.value.present? %>
+              <span data-translation-present="true">
+                <%= blacklight_icon('check', classes: 'translation-complete') %>
+              </span>
+            <% end %>
+          </div>
+        </div>
+      <% end %>
+    <% end %>
+
+    <div class="form-actions">
+      <div class="primary-actions">
+        <%= f.submit nil, class: 'btn btn-primary' %>
+      </div>
+    </div>
+  <% end %>
+</div>

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

@@ -41,6 +41,11 @@
           <%= t('spotlight.translations.browse_categories.label') %> <span class="badge"></span>
         </a>
       </li>
+      <li class="nav-item">
+        <a href="#groups" class="nav-link <%= 'active' if @tab == 'groups' %>" aria-controls="groups" role="tab" data-toggle="tab" data-behavior="translation-progress">
+          <%= t('spotlight.translations.groups.label') %> <span class="badge"></span>
+        </a>
+      </li>
       <li class="nav-item">
         <a href="#pages" class="nav-link <%= 'active' if @tab == 'pages' %>" aria-controls="pages" role="tab" data-toggle="tab" data-behavior="translation-progress">
           <%= t('spotlight.translations.pages.label') %> <span class="badge"></span>
@@ -54,6 +59,7 @@
       <%= render 'search_fields' %>
       <%= render 'browse_categories' %>
       <%= render 'pages' %>
+      <%= render 'groups' %>
     </div>
   </div>
 </div>

data/config/i18n-tasks.yml

@@ -39,6 +39,8 @@ ignore_unused:
   - activerecord.attributes.spotlight/masthead.display # app/views/spotlight/appearances/edit.html.erb
   - activerecord.attributes.spotlight/custom_field.is_multiple # app/views/spotlight/custom_fields/_form.html.erb
   - activerecord.attributes.spotlight/custom_search_field.field # app/views/spotlight/custom_search_fields/_form.html.erb
+  - activerecord.models.spotlight/group # Used in flash messages around the app to rename Group to Browse group
+  - activerecord.models.spotlight/search # Used in flash messages around the app to rename Search to Browse category
   - helpers.label.spotlight/filter.{field,value} # app/views/spotlight/filters/_form.html.erb
   - spotlight.catalog.admin.{title,header} # app/helpers/spotlight/title_helper.rb
   - spotlight.{contacts,pages,searches}.edit.{title,header} # app/helpers/spotlight/title_helper.rb
@@ -49,14 +51,17 @@ ignore_unused:
   - spotlight.featured_images.upload_form.{non_iiif_alert_html,source.exhibit.help,source.exhibit.label} # app/views/spotlight/featured_images/_form.html.erb
   - spotlight.feature_pages.page_options.published # app/views/spotlight/feature_pages/_page_options.html.erb
   - spotlight.{exhibits,custom_fields,custom_search_fields}.{new,edit}.header # configuration_page_title
+  - spotlight.{searches}.{group}.{view}
   - helpers.submit.custom_field.{batch_error,batch_updated,create,submit,update} # Generic repeated template
   - helpers.submit.custom_search_field.{batch_error,batch_updated,create,submit,update} # Generic repeated template
   - helpers.submit.exhibit.{batch_error,batch_updated,create,submit,update} # Generic repeated template
+  - helpers.submit.group.{destroyed,updated} # Generic helper that is used
   - helpers.submit.search.{create,submit,update} # Generic repeated template
   - helpers.submit.site.{batch_error,batch_updated,create,created,destroyed,submit,update} # Generic repeated template
   - helpers.submit.filter.{batch_error,batch_updated,create,created,destroyed,submit,update} # Generic repeated template
   - helpers.action.destroy_are_you_sure # app/helpers/spotlight/crud_link_helpers.rb
   - helpers.action.spotlight/role.{create,destroy} # app/views/spotlight/roles/index.html.erb
+  - helpers.action.spotlight/group.destroy # app/views/spotlight/searches/_group.html.erb
   - helpers.action.{edit,edit_long,new,view} # app/helpers/spotlight/crud_link_helpers.rb
   - helpers.action.spotlight/search.edit_long # app/views/spotlight/searches/_search.html.erb
   - spotlight.about_pages.page_options.published # app/views/spotlight/about_pages/_page_options.html.erb

data/config/locales/spotlight.en.yml

@@ -24,6 +24,8 @@ en:
     models:
       spotlight:
         page: Page
+      spotlight/group: Browse group
+      spotlight/search: Browse category
   cancel: Cancel
   drag: Drag
   helpers:
@@ -44,6 +46,8 @@ en:
         create: Add new field
       spotlight/custom_search_field:
         create: Add new field
+      spotlight/group:
+        destroy: Delete group
       spotlight/role:
         create: Add a new user
         destroy: Remove from site
@@ -101,6 +105,12 @@ en:
         created: The %{model} was created.
         destroyed: The %{model} was deleted.
         updated: The %{model} was successfully updated.
+      group:
+        batch_error: There was an error updating the requested %{model}.
+        batch_updated: "%{model} were successfully updated."
+        created: The %{model} was created.
+        destroyed: The %{model} was deleted.
+        updated: The %{model} was successfully updated.
       language:
         create: Add language
         created: The %{model} was created.
@@ -403,6 +413,8 @@ en:
           published:
             help_block: ''
         uneditable_non_default_language: This field is not editable in the current language. Switch to the default language to edit it.
+      groups:
+        all: All
       import:
         button: Import data
         heading: Import data
@@ -691,6 +703,9 @@ en:
         title: Curation - browse
       form:
         default_index_view_type: Default view
+        group:
+          help: You can add this browse category to any number of browse groups. When you add a browse category to a group it will be displayed when an exhibit visitor selects that browse group’s filter button on the Browse landing page.
+          help_no_groups: You cannot add this browse category to a browse group because no browse groups have been created. To create a browse group, use the Browse groups tab on the Curation > Browse page.
         masthead:
           help: You can select and crop an image to use as a browse category-specific masthead, instead of the default site masthead, for this browse category's detail page.
           help_secondary: To create a browse category-specific masthead, you should use an image that is at least 120 pixels tall and 1200 pixels wide. For best results use an image at least 1800 pixels wide. You can crop larger images using the cropping tool below.
@@ -700,16 +715,31 @@ en:
           help_block: Displays a search box that enables users to search within the browse category results
           label: Search box
         search_description: Description
+        search_group: Group
         search_masthead: Masthead
         search_thumbnail: Thumbnail
         thumbnail:
           help: You can select and crop an image to visually represent this search.
+      group:
+        category_count:
+          one: "%{count} category"
+          other: "%{count} categories"
+        unpublished_count:
+          one: "(%{count} unpublished)"
+          other: "(%{count} unpublished)"
+          zero: ''
+        view: View
       index:
+        add_new_group: Add new group
+        cancel: Cancel
         categories_header: Browse categories
+        categories_instructions: Use the Save search button on a search results page to create a new browse category. Select the categories you want to be displayed on the browse landing page. Drag and drop categories to change the order in which they appear on that page.
+        groups_header: Browse groups
+        groups_instructions_html: "<p>Optionally, you can create groups to organize your exhibits’ browse categories and enable exhibit visitors to filter browse categories by group. Drag and drop browse groups to change the order in which their filter buttons are displayed.</p><p>To add a browse category to a browse group, edit the browse category from the Browse categories tab.</p>"
         header: Browse
-        instructions: Use the Save search button on a search results page to create a new browse category. Select the categories you want to be displayed on the browse landing page. Drag and drop categories to change the order in which they appear on that page.
         no_saved_searches: You can save search results while in curation mode to create browse categories, which will be displayed here.
         not_searchable_html: This exhibit is not currently searchable. To perform searches that can be saved as additional browse categories, temporarily turn on the Display search box option in the Options section of the Configuration > %{href} page.
+        save: Save
         title: Curation - browse
       search:
         item_count:
@@ -731,6 +761,10 @@ en:
           items:
             one: "%{count} item"
             other: "%{count} items"
+        browse_group_categories_block:
+          items:
+            one: "%{count} item"
+            other: "%{count} items"
         link_to_search_block:
           items:
             one: "%{count} item"
@@ -784,6 +818,8 @@ en:
           curated_features: Curated features
           home: Home
           label: Main menu
+      groups:
+        label: Browse groups
       import:
         description: You can import and export Rails-based YAML files containing the translated label values for the currently selected language for use in internationalization tools such as Transifex and i18n-tools. This feature does not include importing or exporting translations for Pages.
         export_current_locale: Export %{language}

data/config/routes.rb

@@ -100,6 +100,15 @@ Spotlight::Engine.routes.draw do
       end
     end
     resources :browse, only: %i[index show]
+    get 'browse/group/:group_id', to: 'browse#index', as: 'browse_groups'
+    get 'browse/group/:group_id/:id', to: 'browse#show', as: 'browse_group'
+
+    resources :groups, except: %i[show] do
+      collection do
+        patch :update_all
+      end
+    end
+
     resources :tags, only: %i[index destroy]
 
     resources :contacts, only: %i[edit update destroy]
@@ -149,6 +158,7 @@ Spotlight::Engine.routes.draw do
         patch 'import'
       end
     end
+    get 'iiif/collection' => 'catalog#index', defaults: { q: '*:*', format: :iiif_json }
   end
 
   get '/:exhibit_id' => 'home_pages#show', as: :exhibit_root

data/db/migrate/20210113092223_create_spotlight_groups.rb

@@ -0,0 +1,23 @@
+class CreateSpotlightGroups < ActiveRecord::Migration[5.2]
+  def self.up
+    create_table :spotlight_groups do |t|
+      t.string     :slug
+      t.text       :title
+      t.references :exhibit
+      t.integer    :weight, default: 50
+      t.boolean    :published
+
+      t.timestamps
+    end
+
+    create_table :spotlight_groups_members, id: false do |t|
+      t.references :group
+      t.references :member, polymorphic: true
+    end
+  end
+
+  def self.down
+    drop_table :spotlight_groups
+    drop_table :spotlight_groups_members
+  end
+end

data/lib/generators/spotlight/install_generator.rb

@@ -17,8 +17,8 @@ module Spotlight
       gem 'coffee-rails', '~> 4.2'
       gem 'uglifier', '>= 1.3.0'
 
-      append_to_file 'app/assets/config/manifest.js', '//= link_directory ../javascripts .js'
-      append_to_file 'app/assets/javascripts/application.js', '//= require_tree .'
+      append_to_file 'app/assets/config/manifest.js', "\n//= link_directory ../javascripts .js\n"
+      append_to_file 'app/assets/javascripts/application.js', "\n//= require_tree .\n"
       gsub_file 'app/views/layouts/application.html.erb', /pack/, 'include'
       inject_into_file 'config/environments/production.rb', after: '  # config.assets.css_compressor = :sass' do
         "\n  config.assets.js_compressor = :uglifier"
@@ -125,7 +125,7 @@ module Spotlight
     end
 
     def add_osd_viewer
-      gem 'blacklight-gallery', '~> 1.1'
+      gem 'blacklight-gallery', '~> 3.0'
       generate 'blacklight_gallery:install'
     end
 

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

@@ -73,7 +73,7 @@
 # These are set by default by Spotlight's configuration,
 # but you can customize them here, or in the SirTrevorRails::Block#custom_block_types method
 # Spotlight::Engine.config.sir_trevor_widgets = %w(
-#   Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse
+#   Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse BrowseGroupCategories
 #   FeaturedPages SolrDocuments SolrDocumentsCarousel SolrDocumentsEmbed
 #   SolrDocumentsFeatures SolrDocumentsGrid SearchResults
 # )

data/lib/spotlight/engine.rb

@@ -38,8 +38,8 @@ module Spotlight
     require 'github/markup'
     require 'sir_trevor_rails'
     require 'openseadragon'
+    require 'handlebars_assets'
     require 'sprockets/es6'
-    require 'almond-rails'
 
     config.assets.precompile += %w[spotlight/fallback/*.png]
 
@@ -55,6 +55,7 @@ module Spotlight
       require 'acts-as-taggable-on'
 
       Mime::Type.register 'application/solr+json', :solr_json
+      Mime::Type.register 'application/iiif+json', :iiif_json
     end
 
     initializer 'spotlight.factories', after: 'factory_bot.set_factory_paths' do
@@ -64,7 +65,7 @@ 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' => 'amd', 'moduleIds' => true }
+      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
@@ -267,7 +268,7 @@ module Spotlight
     # Added here for backwards compatability with SirTrevor 0.6
     # and apps who have customized their avaialble widgets
     config.sir_trevor_widgets = %w[
-      Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse LinkToSearch
+      Heading Text List Quote Iframe Video Oembed Rule UploadedItems Browse BrowseGroupCategories LinkToSearch
       FeaturedPages SolrDocuments SolrDocumentsCarousel SolrDocumentsEmbed
       SolrDocumentsFeatures SolrDocumentsGrid SearchResults
     ]