blacklight-spotlight 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f70d64ceee688642329ed7e806e8c7b65dfe180
-  data.tar.gz: 53170077f35be3b010e71ca3865d094886337050
+  metadata.gz: 6301051ced974a8d8437609d2dd11d82551a2dc0
+  data.tar.gz: 1a3d296988ee287cb7aa9575eb4e6a3936222fee
 SHA512:
-  metadata.gz: 59bce50a85d3172c19f268e91fb2fdc9400197ba8443d5eeb165131427d7cac455cf203ccd93f952fe4316b120af0e0dc3e6c820eea60eb0fd1f444a07ed2dff
-  data.tar.gz: b60c9a739d273bc57bfe25bc68e74bbb2aafd173eb4d0362dbaba4f7e84b8f7d5eb18b8cfb433be45ec91784b00494e3f60e7971e579001f8b172fe6770cc6a4
+  metadata.gz: 5deb0cdcfb5bd95631a649c14b2b45456ff2767977507e2cb87987512f18b06d40ecce3c87afc9af47e2b8a32e3ad45119bb70b13a1d98415ff0b11f7c2163e6
+  data.tar.gz: 200ae22837964033cfc064f50751085e1df04c3209100bacf89e9130a214d12a18d7d536a12469b98d9e436c359f2f619413d7ea91c9e641a1d45af5f0bf628f

data/README.md

@@ -81,10 +81,6 @@ Our `$ rake ci` and `$ rake spotlight:server` tasks utilize Solr and the testing
 
 ## Tests
 
-### Prerequisites
-
-PhantomJS (https://github.com/teampoltergeist/poltergeist#installing-phantomjs) is an addition requirement for testing javascript.
-
 ### Run all the tests:
 
 ```

data/app/assets/javascripts/spotlight/blocks/link_to_search_block.js

@@ -0,0 +1,16 @@
+//= require spotlight/blocks/browse_block
+
+SirTrevor.Blocks.LinkToSearch = (function(){
+
+  return SirTrevor.Blocks.Browse.extend({
+
+    type: "link_to_search",
+
+    icon_name: 'search_results',
+
+    searches_key: "slug",
+    view_key: "view",
+    plustextable: false,
+
+  });
+})();

data/app/assets/javascripts/spotlight/exhibits.js

@@ -16,21 +16,32 @@ Spotlight.onLoad(function() {
   $("#another-email").on("click", function() {
     var container = $(this).closest('.form-group');
     var contacts = container.find('.contact');
-    var input_container = contacts.first().clone();
+    var inputContainer = contacts.first().clone();
 
     // wipe out any values from the inputs
-    input_container.find('input').each(function() {
+    inputContainer.find('input').each(function() {
       $(this).val('');
       $(this).attr('id', $(this).attr('id').replace('0', contacts.length));
       $(this).attr('name', $(this).attr('name').replace('0', contacts.length));
     });
 
-    input_container.find('.first-row-only').remove();
+    inputContainer.find('.contact-email-delete-wrapper').remove();
+    inputContainer.find('.confirmation-status').remove();
 
     // bootstrap does not render input-groups with only one value in them correctly.
-    input_container.find('.input-group input:only-child').closest('.input-group').removeClass('input-group');
+    inputContainer.find('.input-group input:only-child').closest('.input-group').removeClass('input-group');
 
-    $(input_container).insertAfter(contacts.last());
+    $(inputContainer).insertAfter(contacts.last());
+  });
+
+  $('.contact-email-delete').on('ajax:success', function() {
+    $(this).closest('.contact').fadeOut(250, function() { $(this).remove(); });
+  });
+
+  $('.contact-email-delete').on('ajax:error', function(event, _xhr, _status, error) {
+    var errSpan = $(this).closest('.contact').find('.contact-email-delete-error');
+    errSpan.show();
+    errSpan.find('.error-msg').first().text(error || event.detail[1]);
   });
 
   $('.btn-with-tooltip').tooltip();

data/app/assets/javascripts/spotlight/form_observer.js

@@ -52,7 +52,7 @@ function observedFormsStatusHasChanged(){
 // Compare stored and current form serializations
 // to determine if the form has changed before
 // unload and before any turbolinks change event
-$(window).on('beforeunload page:before-change', function(event) {
+$(window).on('beforeunload page:before-change turbolinks:before-cache', function(event) {
   if ( observedFormsStatusHasChanged() ) {
     var message = "You have unsaved changes. Are you sure you want to leave this page?";
     if ( event.type == "beforeunload" ) {
@@ -61,4 +61,4 @@ $(window).on('beforeunload page:before-change', function(event) {
       return confirm(message)
     }
   }
-});
+});

data/app/assets/javascripts/spotlight/pages.js.erb

@@ -1,13 +1,14 @@
 // Place all the behaviors and hooks related to the matching controller here.
 // All this logic will automatically be available in application.js.
 Spotlight.onLoad(function(){
-
+  // Set a ujs adapter to support both rails-ujs and jquery-ujs
+  var ujs = typeof Rails === 'undefined' ? $.rails : Rails;
   SirTrevor.setDefaults({
     iconUrl: <%= asset_path('spotlight/blocks/sir-trevor-icons.svg').to_json %>,
     uploadUrl: $('[data-attachment-endpoint]').data('attachment-endpoint'),
     ajaxOptions: {
       headers: {
-        'X-CSRF-Token': (Rails || $.rails).csrfToken() || ''
+        'X-CSRF-Token': ujs.csrfToken() || ''
       },
       credentials: 'same-origin'
     }

data/app/assets/javascripts/spotlight/sir-trevor/locales.js

@@ -9,6 +9,12 @@ SirTrevor.Locales.en.blocks = $.extend(SirTrevor.Locales.en.blocks, {
     item_counts: "Include item counts?"
   },
 
+  link_to_search: {
+    title: "Saved Searches",
+    description: "This widget highlights saved searches. Each highlighted saved search links to the search results page generated by the saved search parameters. Any saved search listed on the Curation > Browse Categories page, whether published or not, can be highlighted as a saved search.",
+    item_counts: "Include item counts?"
+  },
+
   iframe: {
     title:  "IFrame",
     description: "This widget embeds iframe-based embed code into pages",

data/app/controllers/spotlight/concerns/application_controller.rb

@@ -27,9 +27,7 @@ module Spotlight
       end
 
       def enabled_in_spotlight_view_type_configuration?(config, *args)
-        if config.respond_to?(:upstream_if) &&
-           !config.upstream_if.nil? &&
-           !blacklight_configuration_context.evaluate_configuration_conditional(config.upstream_if, config, *args)
+        if config.respond_to?(:original) && !blacklight_configuration_context.evaluate_if_unless_configuration(config.original, *args)
           false
         elsif current_exhibit.nil? || is_a?(Spotlight::PagesController)
           true
@@ -38,13 +36,11 @@ module Spotlight
         end
       end
 
-      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/MethodLength
       def field_enabled?(field, *args)
         if !field.enabled
           false
-        elsif field.respond_to?(:upstream_if) &&
-              !field.upstream_if.nil? &&
-              !blacklight_configuration_context.evaluate_configuration_conditional(field.upstream_if, field, *args)
+        elsif field.respond_to?(:original) && !blacklight_configuration_context.evaluate_if_unless_configuration(field.original, *args)
           false
         elsif field.is_a?(Blacklight::Configuration::SortField) || field.is_a?(Blacklight::Configuration::SearchField)
           field.enabled
@@ -54,7 +50,7 @@ module Spotlight
           field.send(document_index_view_type)
         end
       end
-      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
       private
 

data/app/controllers/spotlight/contact_email_controller.rb

@@ -0,0 +1,22 @@
+module Spotlight
+  ##
+  # CRUD actions for exhibit contact emails
+  class ContactEmailController < Spotlight::ApplicationController
+    rescue_from ActiveRecord::RecordNotFound, with: :record_not_found
+
+    before_action :authenticate_user!
+    load_and_authorize_resource :exhibit, class: 'Spotlight::Exhibit'
+    load_and_authorize_resource through: :exhibit
+
+    def destroy
+      @contact_email.destroy
+      render json: { success: true, error: nil }
+    end
+
+    private
+
+    def record_not_found(_error)
+      render json: { success: false, error: 'Not Found' }, status: :not_found
+    end
+  end
+end

data/app/controllers/spotlight/searches_controller.rb

@@ -28,7 +28,9 @@ module Spotlight
     def index
       respond_to do |format|
         format.html
-        format.json { render json: @searches.published.as_json(methods: [:count, :thumbnail_image_url]), root: false }
+        format.json do
+          render json: @searches.as_json(methods: [:count, :thumbnail_image_url]), root: false
+        end
       end
     end
 

data/app/models/concerns/spotlight/blacklight_configuration_defaults.rb

@@ -26,8 +26,8 @@ module Spotlight
       # can't use default_blacklight_config until after the BlacklightConfiguration
       # is created or we run into a circular dependency.
       default_fields = Spotlight::Engine.blacklight_config.search_fields
-      self.search_fields = default_fields.each_with_object({}) do |(k, _v), obj|
-        obj[k] = { enabled: true }
+      self.search_fields = default_fields.each_with_object({}) do |(k, v), obj|
+        obj[k] = { enabled: v.fetch(:enabled, true) }
       end
     end
 
@@ -37,8 +37,8 @@ module Spotlight
       # can't use default_blacklight_config until after the BlacklightConfiguration
       # is created or we run into a circular dependency.
       default_fields = Spotlight::Engine.blacklight_config.sort_fields
-      self.sort_fields = default_fields.each_with_object({}) do |(k, _v), obj|
-        obj[k] = { enabled: true }
+      self.sort_fields = default_fields.each_with_object({}) do |(k, v), obj|
+        obj[k] = { enabled: v.fetch(:enabled, true) }
       end
     end
 

data/app/models/sir_trevor_rails/blocks/browse_block.rb

@@ -32,7 +32,13 @@ module SirTrevorRails
       def as_json
         result = super
 
-        result[:data][:item].each do |_k, v|
+        result[:data][:item] ||= {}
+
+        # TODO: This is a temporary fix that simply removes any item if the search identifier does not exist
+        #       We should have a more permanent solution that will allow browse blocks to be updated without erroring
+        result[:data][:item].select! { |_, v| parent.exhibit.searches.exists?(v['id']) }
+
+        result[:data][:item].each_value do |v|
           v['thumbnail_image_url'] = parent.exhibit.searches.find(v['id']).thumbnail_image_url
         end
 

data/app/models/sir_trevor_rails/blocks/featured_pages_block.rb

@@ -22,7 +22,9 @@ module SirTrevorRails
       def as_json
         result = super
 
-        result[:data][:item].each do |_k, v|
+        result[:data][:item] ||= {}
+
+        result[:data][:item].each_value do |v|
           v['thumbnail_image_url'] = parent.exhibit.pages.find(v['id']).thumbnail_image_url
         end
 

data/app/models/sir_trevor_rails/blocks/link_to_search_block.rb

@@ -0,0 +1,15 @@
+module SirTrevorRails
+  module Blocks
+    ##
+    # Embed search results (from a browse category) into the page
+    class LinkToSearchBlock < BrowseBlock
+      include Displayable
+
+      def searches
+        @searches ||= parent.exhibit.searches.where(slug: item_ids).sort do |a, b|
+          ordered_items.index(a.slug) <=> ordered_items.index(b.slug)
+        end
+      end
+    end
+  end
+end

data/app/models/spotlight/ability.rb

@@ -14,7 +14,7 @@ module Spotlight
 
       # exhibit admin
       can [:update, :import, :export, :destroy], Spotlight::Exhibit, id: user.admin_roles.pluck(:resource_id)
-      can :manage, Spotlight::BlacklightConfiguration, exhibit_id: user.admin_roles.pluck(:resource_id)
+      can :manage, [Spotlight::BlacklightConfiguration, Spotlight::ContactEmail], exhibit_id: user.admin_roles.pluck(:resource_id)
       can :manage, Spotlight::Role, resource_id: user.admin_roles.pluck(:resource_id), resource_type: 'Spotlight::Exhibit'
 
       can :manage, PaperTrail::Version if user.roles.any?

data/app/models/spotlight/blacklight_configuration.rb

@@ -5,6 +5,8 @@ module Spotlight
   # Exhibit-specific blacklight configuration model
   # rubocop:disable Metrics/ClassLength
   class BlacklightConfiguration < ActiveRecord::Base
+    has_paper_trail
+
     belongs_to :exhibit, touch: true, optional: true
     serialize :facet_fields, Hash
     serialize :index_fields, Hash
@@ -88,6 +90,7 @@ module Spotlight
 
         # Update with customizations
         config.index_fields.each do |k, v|
+          v.original = v.dup
           if index_fields[k]
             v.merge! index_fields[k].symbolize_keys
           elsif custom_index_fields[k]
@@ -99,7 +102,6 @@ module Spotlight
           v.immutable = Blacklight::OpenStructWithHashAccess.new(v.immutable)
           v.merge! v.immutable.to_h.symbolize_keys
 
-          v.upstream_if = v.if unless v.if.nil?
           v.if = :field_enabled? unless v.if == false
 
           v.normalize! config
@@ -109,6 +111,7 @@ module Spotlight
         config.show_fields.reject! { |_k, v| v.if == false }
 
         config.show_fields.reject { |k, _v| config.index_fields[k] }.each do |k, v|
+          v.original = v.dup
           config.index_fields[k] = v
 
           if index_fields[k]
@@ -120,7 +123,6 @@ module Spotlight
           v.immutable = Blacklight::OpenStructWithHashAccess.new(v.immutable)
           v.merge! v.immutable.to_h.symbolize_keys
 
-          v.upstream_if = v.if unless v.if.nil?
           v.if = :field_enabled? unless v.if == false
 
           v.normalize! config
@@ -133,7 +135,7 @@ module Spotlight
           config.search_fields = Hash[config.search_fields.sort_by { |k, _v| field_weight(search_fields, k) }]
 
           config.search_fields.each do |k, v|
-            v.upstream_if = v.if unless v.if.nil?
+            v.original = v.dup
             v.if = :field_enabled? unless v.if == false
             next if search_fields[k].blank?
 
@@ -147,7 +149,7 @@ module Spotlight
           config.sort_fields = Hash[config.sort_fields.sort_by { |k, _v| field_weight(sort_fields, k) }]
 
           config.sort_fields.each do |k, v|
-            v.upstream_if = v.if unless v.if.nil?
+            v.original = v.dup
             v.if = :field_enabled? unless v.if == false
             next if sort_fields[k].blank?
 
@@ -162,13 +164,12 @@ module Spotlight
           config.facet_fields = Hash[config.facet_fields.sort_by { |k, _v| field_weight(facet_fields, k) }]
 
           config.facet_fields.each do |k, v|
+            v.original = v.dup
             next if facet_fields[k].blank?
 
             v.merge! facet_fields[k].symbolize_keys
-            v.upstream_if = v.if unless v.if.nil?
             v.enabled = v.show
             v.if = :field_enabled? unless v.if == false
-            v.upstream_if = nil if v.upstream_if == v.if
             v.normalize! config
             v.validate!
           end
@@ -182,8 +183,8 @@ module Spotlight
         end
 
         config.view.each do |k, v|
+          v.original = v.dup
           v.key = k
-          v.upstream_if = v.if unless v.if.nil?
           v.if = :enabled_in_spotlight_view_type_configuration? unless v.if == false
         end unless document_index_view_types.blank?
 

data/app/models/spotlight/exhibit.rb

@@ -7,6 +7,8 @@ module Spotlight
     include Spotlight::ExhibitDefaults
     include Spotlight::ExhibitDocuments
 
+    has_paper_trail
+
     scope :published, -> { where(published: true) }
     scope :unpublished, -> { where(published: false) }
     scope :ordered_by_weight, -> { order('weight ASC') }

data/app/models/spotlight/resource.rb

@@ -80,9 +80,11 @@ module Spotlight
       end
 
       def write_to_index(batch)
-        return unless write?
+        documents = documents_that_have_ids(batch)
+        return unless write? && documents.present?
+
         blacklight_solr.update params: { commitWithin: 500 },
-                               data: batch.to_json,
+                               data: documents.to_json,
                                headers: { 'Content-Type' => 'application/json' }
       end
 
@@ -100,6 +102,10 @@ module Spotlight
       def write?
         Spotlight::Engine.config.writable_index
       end
+
+      def documents_that_have_ids(document_list)
+        document_list.reject { |d| d[document_builder.document_model.unique_key.to_sym].blank? }
+      end
     end
   end
 end

data/app/services/spotlight/carrierwave_file_resolver.rb

@@ -1,6 +1,11 @@
 module Spotlight
   # Used by RIIIF to find files uploaded by carrierwave
   class CarrierwaveFileResolver < Riiif::AbstractFileSystemResolver
+    # Override initialzer to avoid deprecation about not providing base path
+    def initializer
+      # nop
+    end
+
     def pattern(id)
       uploaded_file = Spotlight::FeaturedImage.find(id).image.file
       raise Riiif::ImageNotFoundError, "unable to find file for #{id}" if uploaded_file.nil?

data/app/services/spotlight/upload_solr_document_builder.rb

@@ -21,8 +21,8 @@ module Spotlight
 
     def add_image_dimensions(solr_hash)
       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]
+      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)

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

@@ -41,7 +41,7 @@
         <%= 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 %>
+              <%= image_tag "spotlight/themes/#{theme}_preview.png", width: 100, height: 100 %>
               <%= f.radio_button :theme, theme, label: t(:".site_theme.#{theme}", default: theme.to_s.titleize), inline: true %>
             </div>
           <% end %>

data/app/views/spotlight/exhibits/_confirmation_status.html.erb

@@ -1,4 +1,4 @@
-            <div class="col-md-4 confirmation-status <%= 'not-validated' unless contact_email.confirmed? or contact_email.recently_sent? %>">
+            <div class="confirmation-status <%= 'not-validated' unless contact_email.confirmed? or contact_email.recently_sent? %>">
               <% if contact_email.confirmed? %>
                 <span class="confirmed"><span class="glyphicon glyphicon-ok-sign"></span> <%= t('.confirmed') %></span>
               <% elsif contact_email.recently_sent? %>

data/app/views/spotlight/exhibits/_contact.html.erb

@@ -1,17 +1,22 @@
-        <%= contact.hidden_field :id %>
         <div class="row contact">
+          <%= contact.hidden_field :id %>
           <div class="col-md-8<%= ' has-error' if contact.object.errors[:email].present? %>">
-            <% if contact.index == 0 %>
-              <div class="input-group">
-                <%= text_field_tag "#{contact.object_name}[email]", contact.object.email, class: 'exhibit-contact form-control' %>
-                <span id='another-email' class="input-group-addon first-row-only">+</span>
-              </div>
-            <% else %>
-              <%= text_field_tag "#{contact.object_name}[email]", contact.object.email, class: 'exhibit-contact form-control' %>
-            <% end %>
+            <%= text_field_tag "#{contact.object_name}[email]", contact.object.email, class: 'exhibit-contact form-control' %>
             <% if contact.object.errors[:email].present? %>
               <span class="help-block"><%=contact.object.errors[:email].join(", ".html_safe) %></span>
             <% end %>
+            <p>
+              <span class="contact-email-delete-error text-danger callout-danger" style="display: none;"><%= t('.email_delete_error') %> <span class="error-msg"></span></span>
+            </p>
+          </div>
+          <div class="col-md-4">
+            <% if contact.object.id %>
+              <span class="contact-email-delete-wrapper">
+                <%= link_to exhibit_contact_email_path(exhibit_id: exhibit.id, id: contact.object.id), class: 'contact-email-delete btn btn-xs btn-danger', method: :delete, data: { confirm: t('.email_delete_confirmation'), remote: true } do %>
+                  <%= t('.email_delete_button') %>
+                <% end %>
+              </span>
+            <% end %>
+            <%= render partial: 'confirmation_status', locals: {contact_email: contact.object} unless contact.object.new_record? %>
           </div>
-          <%= render partial: 'confirmation_status', locals: {contact_email: contact.object} unless contact.object.new_record? %>
         </div>