blacklight-spotlight 1.4.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 172e2e6207814ddb0e3aa36cc88491cce8653502
-  data.tar.gz: 16149c0f5d038f9d7b585de9a4d744567a0e276f
+  metadata.gz: 6283454c62ce693d7859d54abf0f6b8f231872a2
+  data.tar.gz: b3614482d805ac181bdd85908786897a83998413
 SHA512:
-  metadata.gz: 30641460fdd7f798c048815d2abf047539a0bbb243f0b0330e1e67b7f9affaeb9be7b2be45d341a6bb668b755f398881e7b7cf9d2a12cd03d7180276a92528cb
-  data.tar.gz: c1138b26c502cc3aacd0c6c45301d1794c28f5873a4afa2102482fdcd642efdd72221d4e789ea4ed9e64050b5ba870bc98f00f793092519e89537d33bdccb4b1
+  metadata.gz: bc6add80eb86ad87548c3c4b40c9f73dd15de59b8b0443b9fcbdec2860ea1ef5c820190f8c288e471f8e7c021f4fd611be103ac66a39640c9d5d80600aa7194f
+  data.tar.gz: ac68408582986b2115ea46832b6ee2271501ecf99311bb56c2a37bb7dfee7337679850264217e76948e1afd03956732c9a3d643a09f940569d41491dcc4752cc

data/Rakefile

@@ -25,7 +25,6 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
 require 'engine_cart/rake_task'
-EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
 
 require 'spotlight/version'
 
@@ -34,6 +33,11 @@ task ci: ['engine_cart:generate'] do
 
   SolrWrapper.wrap(port: '8983') do |solr|
     solr.with_collection(name: 'blacklight-core', dir: File.join(File.expand_path(File.dirname(__FILE__)), 'solr_conf', 'conf')) do
+      within_test_app do
+        system 'bundle install'
+        system 'bundle exec rake db:migrate'
+      end
+
       Rake::Task['spotlight:fixtures'].invoke
 
       # run the tests

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

@@ -33,9 +33,10 @@ Spotlight.Block.Resources = (function(){
       } else {
         checked = "";
       }
+      var resource_id = data.slug || data.id;
       var markup = [
-          '<li class="field form-inline dd-item dd3-item" data-id="' + index + '" id="' + this.formId("item_" + data.id) + '">',
-            '<input type="hidden" name="item[' + index + '][id]" value="' + (data.slug || data.id) + '" />',
+          '<li class="field form-inline dd-item dd3-item" data-resource-id="' + resource_id + '" data-id="' + index + '" id="' + this.formId("item_" + data.id) + '">',
+            '<input type="hidden" name="item[' + index + '][id]" value="' + resource_id + '" />',
             '<input type="hidden" name="item[' + index + '][title]" value="' + data.title + '" />',
             this._itemPanelIiifFields(index, data),
             '<input data-property="weight" type="hidden" name="item[' + index + '][weight]" value="' + data.weight + '" />',

data/app/assets/javascripts/spotlight/crop.es6

@@ -230,6 +230,8 @@ export default class Crop {
     tabs.on('shown.bs.tab', function() {
       if(self.cropArea.data('initiallyVisible') === false && self.cropArea.is(':visible')) {
         self.cropperMap.invalidateSize();
+        // Because the map size is 0,0 when image is loading (not visible) we need to refit the bounds of the layer
+        self.imageLayer._fitBounds();
         self.cropArea.data('initiallyVisible', null);
       }
     });

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

@@ -111,12 +111,16 @@
 
     function addThumbsToList(){
       $.each(image_versions, function(i){
-        var listItem = $('<li><a href="javascript:;"><img src="' + image_versions[i]['thumb'] +'" data-image-id="' + image_versions[i]['imageId'] +'" /></a></li>');
+        var listItem = $('<li data-index="' + i + '"><a href="javascript:;"><img src="' + image_versions[i]['thumb'] +'" data-image-id="' + image_versions[i]['imageId'] +'" /></a></li>');
         listItem.on('click', function(){
           // get the current image id
           var imageid = $('img', $(this)).data('image-id');
           var src = $('img', $(this)).attr('src');
 
+          if (typeof clickCallback === 'function' ) {
+            clickCallback(image_versions[i]);
+          }
+
           // mark the current selection as active
           $('li.active', thumbList).removeClass('active');
           $(this).addClass('active');
@@ -128,9 +132,6 @@
             $('li', thumbList).index($(this)) + 1
           );
           scrollToActiveThumb();
-          if (typeof clickCallback === 'function' ) {
-            clickCallback(image_versions[i]);
-          }
         });
         $("img", listItem).on('load', function() {
           updateThumbListWidth();

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

@@ -7,14 +7,27 @@ Spotlight.onLoad(function() {
     var monitorElements = this;
     var defaultRefreshRate = 3000;
     var panelContainer;
+    var pollers = [];
 
     $(monitorElements).each(function() {
       panelContainer = $(this);
       var monitorUrl = panelContainer.data('monitorUrl');
       var refreshRate = panelContainer.data('refreshRate') || defaultRefreshRate;
-      setInterval(function() {
-        checkMonitorUrl(monitorUrl);
-      }, refreshRate);
+      pollers.push(
+        setInterval(function() {
+          checkMonitorUrl(monitorUrl);
+        }, refreshRate)
+      );
+    });
+
+    // Clear the intervals on turbolink:click event (e.g. when the user navigates away from the page)
+    $(document).on('turbolinks:click', function() {
+      if (pollers.length > 0) {
+        $.each(pollers, function() {
+          clearInterval(this);
+        });
+        pollers = [];
+      }
     });
 
     function checkMonitorUrl(url) {

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

@@ -8,6 +8,11 @@ module Spotlight
 
     included do
       helper_method :current_site, :current_exhibit, :current_masthead, :exhibit_masthead?, :resource_masthead?
+      before_action :set_exhibit_locale_scope
+    end
+
+    def set_exhibit_locale_scope
+      Translation.current_exhibit = current_exhibit
     end
 
     def current_site
@@ -15,7 +20,7 @@ module Spotlight
     end
 
     def current_exhibit
-      @exhibit
+      @exhibit || (Spotlight::Exhibit.find(params[:exhibit_id]) if params[:exhibit_id].present?)
     end
 
     def current_masthead

data/app/controllers/spotlight/browse_controller.rb

@@ -83,5 +83,32 @@ module Spotlight
     def should_render_spotlight_search_bar?
       !resource_masthead?
     end
+
+    def document_index_view_type
+      return super if params[:view].present?
+      if @search && @search.default_index_view_type.present?
+        blacklight_config.view[@search.default_index_view_type].key
+      else
+        default_document_index_view_type
+      end
+    end
+
+    helper_method :document_index_view_type
+
+    def default_document_index_view_type
+      if view_available? default_browse_index_view_type
+        default_browse_index_view_type
+      else
+        super
+      end
+    end
+
+    def view_available?(view)
+      blacklight_config.view.key?(view) && blacklight_configuration_context.evaluate_if_unless_configuration(blacklight_config.view)
+    end
+
+    def default_browse_index_view_type
+      Spotlight::Engine.config.default_browse_index_view_type
+    end
   end
 end

data/app/controllers/spotlight/catalog_controller.rb

@@ -122,11 +122,11 @@ module Spotlight
     protected
 
     # TODO: move this out of app/helpers/blacklight/catalog_helper_behavior.rb and into blacklight/catalog.rb
-    # rubocop:disable Style/PredicateName
+    # rubocop:disable Naming/PredicateName
     def has_search_parameters?
       !params[:q].blank? || !params[:f].blank? || !params[:search_field].blank?
     end
-    # rubocop:enable Style/PredicateName
+    # rubocop:enable Naming/PredicateName
 
     def attach_breadcrumbs
       # The "q: ''" is necessary so that the breadcrumb builder recognizes that a path like this:

data/app/helpers/spotlight/browse_helper.rb

@@ -5,39 +5,10 @@ module Spotlight
     include ::BlacklightConfigurationHelper
     include Spotlight::RenderingHelper
 
-    def document_index_view_type
-      if @search && @search.default_index_view_type.present? && params[:view].blank?
-        blacklight_config.view[@search.default_index_view_type].key
-      else
-        super
-      end
-    end
-
-    ##
-    # Override Blacklight's #default_document_index_view_type helper to
-    # use a different default view when presenting browse categories
-    def default_document_index_view_type
-      if view_available? default_browse_index_view_type
-        default_browse_index_view_type
-      else
-        super
-      end
-    end
-
     ##
     # Get parent results count of a browse category search
     def parent_search_count
       @parent_search_count ||= Spotlight::Search.find(@search.id).count
     end
-
-    private
-
-    def view_available?(view)
-      blacklight_config.view.key?(view) && blacklight_configuration_context.evaluate_if_unless_configuration(blacklight_config.view)
-    end
-
-    def default_browse_index_view_type
-      Spotlight::Engine.config.default_browse_index_view_type
-    end
   end
 end

data/app/helpers/spotlight/title_helper.rb

@@ -15,10 +15,10 @@ module Spotlight
       content_tag(:h1, safe_join([section, content_tag(:small, title || t(:'.header'))], "\n"), class: 'page-header')
     end
 
-    # rubocop:disable Style/AccessorMethodName
+    # rubocop:disable Naming/AccessorMethodName
     def set_html_page_title(title = nil)
       @page_title = strip_tags(t(:'spotlight.html_title', title: title || t(:'.title', default: :'.header'), application_name: application_name)).html_safe
     end
-    # rubocop:enable Style/AccessorMethodName
+    # rubocop:enable Naming/AccessorMethodName
   end
 end

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

@@ -0,0 +1,23 @@
+module Spotlight
+  ##
+  # Module that extends I18n::Backend::ActiveRecord::Translation to provide
+  # additional Spotlight behavior, such as exhibit specific Translations
+  module CustomTranslationExtension
+    extend ActiveSupport::Concern
+
+    included do
+      default_scope { where(exhibit: current_exhibit) }
+      belongs_to :exhibit, class_name: 'Spotlight::Exhibit', inverse_of: :translations
+    end
+
+    class_methods do
+      def current_exhibit
+        Thread.current[:current_exhibit]
+      end
+
+      def current_exhibit=(exhibit)
+        Thread.current[:current_exhibit] = exhibit
+      end
+    end
+  end
+end

data/app/models/concerns/spotlight/solr_document/atomic_updates.rb

@@ -17,17 +17,19 @@ module Spotlight
       private
 
       def hash_for_solr_update(data)
-        Array.wrap(data).map { |doc| convert_document_to_atomic_update_hash(doc) }.reject { |x| x.length <= 1 }
+        Array.wrap(data).map { |doc| convert_document_to_atomic_update_hash(doc) }.reject { |x| x.length <= 2 }
       end
 
       def convert_document_to_atomic_update_hash(doc)
-        doc.each_with_object({}) do |(k, v), hash|
+        output = doc.each_with_object({}) do |(k, v), hash|
           hash[k] = if k.to_sym == self.class.unique_key.to_sym
                       v
                     else
                       { set: v }
                     end
         end
+        output[Blacklight::Configuration.default_values[:index].timestamp_field] ||= { set: nil }
+        output
       end
     end
   end

data/app/models/spotlight/blacklight_configuration.rb

@@ -314,7 +314,7 @@ module Spotlight
       ].flatten.join(' ')
     end
 
-    # rubocop:disable Style/AccessorMethodName
+    # rubocop:disable Naming/AccessorMethodName
     def set_index_field_defaults(field)
       return unless index_fields.blank?
 
@@ -341,7 +341,7 @@ module Spotlight
       field.show = true
       field.enabled = true
     end
-    # rubocop:enable Style/AccessorMethodName
+    # rubocop:enable Naming/AccessorMethodName
 
     # @return [Integer] the weight (sort order) for this field
     def field_weight(fields, index)

data/app/models/spotlight/exhibit.rb

@@ -34,7 +34,6 @@ module Spotlight
     has_many :custom_fields, dependent: :delete_all
     has_many :feature_pages, extend: FriendlyId::FinderMethods
     has_many :main_navigations, dependent: :delete_all
-    has_many :owned_taggings, class_name: 'ActsAsTaggableOn::Tagging', as: :tagger
     has_many :reindexing_log_entries, dependent: :destroy
     has_many :resources
     has_many :roles, as: :resource, dependent: :delete_all
@@ -43,6 +42,7 @@ module Spotlight
     has_many :users, through: :roles, class_name: Spotlight::Engine.config.user_class
     has_many :pages, dependent: :destroy
     has_many :filters, dependent: :delete_all
+    has_many :translations, class_name: 'I18n::Backend::ActiveRecord::Translation', dependent: :destroy, inverse_of: :exhibit
 
     has_one :blacklight_configuration, class_name: 'Spotlight::BlacklightConfiguration', dependent: :delete
     has_one :home_page

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

@@ -27,6 +27,7 @@
     <%= description %>
     <%= twitter_card %>
     <%= opengraph %>
+    <%= javascript_tag '$.fx.off = true;' if Rails.env.test? %>
 
     <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
     <!--[if lt IE 9]>

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

@@ -17,19 +17,19 @@
   <% page_analytics = current_exhibit.page_analytics(1.month, exhibit_root_path(current_exhibit)) %>
   <% unless page_analytics.empty? %>
   <h4><%= t :'.pages.header' %></h4>
-  <table class="table table-striped">
+  <table class="table table-striped popular-pages">
     <thead>
       <tr>
         <th><%= t(:".pagetitle") %></th>
-        <th><%= t(:".pageviews") %></th>
+        <th class="text-right"><%= t(:".pageviews") %></th>
       </tr>
     </thead>
     <% page_analytics.each do |p| %>
       <tr>
         <td><%= link_to p.pageTitle, p.pagePath %></td>
-        <td><%= p.pageviews %></td>
+        <td class="text-right"><%= p.pageviews %></td>
       </tr>
     <% end %>
   </table>
   <% end %>
-<% end %>
+<% end %>

data/app/views/spotlight/search_configurations/_search_fields.html.erb

@@ -1,6 +1,6 @@
 <% default_field = @blacklight_configuration.blacklight_config.default_search_field %>
 <div class="checkbox">
-  <label>
+  <label for="enable_feature">
     <%= check_box_tag :enable_feature, '1', @blacklight_configuration.blacklight_config.search_fields.select { |_k, v| v.enabled && v.include_in_simple_select != false }.any?, data: { behavior: 'enable-feature', target: '#search_fields' } %> <%= t(:'.enable_feature') %>
   </label>
 </div>

data/db/migrate/20180306142612_create_translations.rb

@@ -0,0 +1,18 @@
+class CreateTranslations < ActiveRecord::Migration[5.0]
+  def self.up
+    create_table :translations do |t|
+      t.string :locale
+      t.string :key
+      t.text   :value
+      t.text   :interpolations
+      t.boolean :is_proc, default: false
+      t.references :exhibit
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :translations
+  end
+end

data/lib/generators/spotlight/install_generator.rb

@@ -137,5 +137,9 @@ module Spotlight
       generate 'devise_invitable:install'
       generate 'devise_invitable', 'User'
     end
+
+    def add_translations
+      copy_file 'config/initializers/translation.rb'
+    end
   end
 end

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

@@ -0,0 +1,17 @@
+require 'i18n/backend/active_record'
+
+Translation = I18n::Backend::ActiveRecord::Translation
+
+if Translation.table_exists?
+  ##
+  # Sets up the new Spotlight Translation backend, backed by ActiveRecord. To
+  # turn on the ActiveRecord backend, uncomment the following lines.
+
+  # I18n.backend = I18n::Backend::ActiveRecord.new
+  I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Memoize)
+  Translation.send(:include, Spotlight::CustomTranslationExtension)
+  I18n::Backend::Simple.send(:include, I18n::Backend::Memoize)
+  I18n::Backend::Simple.send(:include, I18n::Backend::Pluralization)
+
+  # I18n.backend = I18n::Backend::Chain.new(I18n.backend, I18n::Backend::Simple.new)
+end

data/lib/spotlight/engine.rb

@@ -12,6 +12,7 @@ require 'tophat'
 require 'paper_trail'
 require 'clipboard/rails'
 require 'leaflet-rails'
+require 'i18n/active_record'
 
 module Spotlight
   ##

data/lib/spotlight/version.rb

@@ -1,3 +1,3 @@
 module Spotlight
-  VERSION = '1.4.1'.freeze
+  VERSION = '1.5.1'.freeze
 end

data/spec/controllers/spotlight/browse_controller_spec.rb

@@ -5,6 +5,38 @@ describe Spotlight::BrowseController, type: :controller do
   let!(:unpublished) { FactoryBot.create(:search, exhibit: exhibit) }
   let(:admin) { FactoryBot.create(:site_admin) }
 
+  describe 'protected methods' do
+    it 'uses the blacklight.browse configuration for the document actions when additional configuration layers are not defined' do
+      expect(controller).to receive(:view_available?).and_return true
+      expect(controller.send(:document_index_view_type)).to equal :gallery
+    end
+
+    it 'uses the blacklight_config view configuration when there are no params' do
+      allow(controller).to receive(:current_exhibit).and_return exhibit
+      expect(controller).to receive(:view_available?).and_return false
+      expect(controller.send(:document_index_view_type)).to equal :list
+    end
+
+    it 'returns document_index_view_type from a search object' do
+      allow(controller).to receive(:current_exhibit).and_return exhibit
+      expect(controller).to receive(:view_available?).and_return true
+      search.default_index_view_type = 'gallery'
+      controller.instance_variable_set(:@search, search)
+      expect(controller.send(:default_document_index_view_type)).to equal :gallery
+    end
+
+    it 'returns default_document_index_view_type from super when there is no view available' do
+      allow(controller).to receive(:current_exhibit).and_return exhibit
+      expect(controller).to receive(:view_available?).and_return false
+      expect(controller.send(:default_document_index_view_type)).to equal :list
+    end
+
+    it 'returns the default_browse_index_view_type from exhibit configuration' do
+      allow(controller).to receive(:current_exhibit).and_return exhibit
+      expect(controller.send(:default_browse_index_view_type)).to equal :gallery
+    end
+  end
+
   describe 'when authenticated as an admin' do
     before { sign_in admin }
     describe 'GET index' do