blacklight-spotlight 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0e7cf4f1e70ba9c0eceafb312f984eaaec2f196
-  data.tar.gz: 0d312a6be60fefc15e1a01d6c46629b01368c643
+  metadata.gz: 6bff0876109f9e68d8dcadddb01e465330d67d25
+  data.tar.gz: 9f7f3daa3104c882c01e8edc24731d8e5fd9401f
 SHA512:
-  metadata.gz: ce5ec4536695fe29b7f2dc34dc346c71dfd1f84552a3b1e02fc06bb54af26ab0b4ab1d54591a1bffeb56f5d0d03092e6c841fdaa1e821731c88fd763bf5e7d1b
-  data.tar.gz: d12bb30e5e9757d7189ac856dec1e59e570adfb3f673dc48f42218d4f8277048d1e4759ad5971db2578f465e883130ac30d9339d1b688100d897d64c8b70d047
+  metadata.gz: f27a7aab2b68144eeecd58b51b98fbaf9d78bafb38a780eecdf5a7efe74c3aefe299e4e05f4da8f5fd0251d2422bf8a45e43b6c83b7379768280e6aa0edb72d5
+  data.tar.gz: 85db41321a6ba7e8baaa8db613bb149d88b6afaf9689bbb27c2c7538dba062e79d66a86902b6b8f9dfe0e2a519c9ad79e67a72ecb4009b454507027b288219c9

data/README.md

@@ -1,11 +1,11 @@
 spotlight
 =========
 
-[![Build Status](https://travis-ci.org/sul-dlss/spotlight.png?branch=master)](https://travis-ci.org/sul-dlss/spotlight) | [![Coverage Status](https://coveralls.io/repos/sul-dlss/spotlight/badge.png?branch=master)](https://coveralls.io/r/sul-dlss/spotlight) | [![Gem Version](https://badge.fury.io/rb/blacklight-spotlight.png)](http://badge.fury.io/rb/blacklight-spotlight) | [Release Notes](https://github.com/sul-dlss/spotlight/releases) | [Design Documents](https://github.com/sul-dlss/spotlight/releases/tag/v0.0.0)
+[![Build Status](https://travis-ci.org/projectblacklight/spotlight.png?branch=master)](https://travis-ci.org/projectblacklight/spotlight) | [![Coverage Status](https://coveralls.io/repos/projectblacklight/spotlight/badge.png?branch=master)](https://coveralls.io/r/projectblacklight/spotlight) | [![Gem Version](https://badge.fury.io/rb/blacklight-spotlight.png)](http://badge.fury.io/rb/blacklight-spotlight) | [Release Notes](https://github.com/projectblacklight/spotlight/releases) | [Design Documents](https://github.com/projectblacklight/spotlight/releases/tag/v0.0.0)
 
 Spotlight is open source software that enables librarians, curators, and other content experts to easily build feature-rich websites that showcase collections and objects from a digital repository, uploaded items, or a combination of the two. Spotlight is a plug-in for [Blacklight](https://github.com/projectblacklight/blacklight), an open source, Ruby on Rails Engine that provides a basic discovery interface for searching an Apache Solr index.
 
-Read more about what Spotlight is, our motivations for creating it, and how to install and configure it in the [wiki pages](https://github.com/sul-dlss/spotlight/wiki). You might also want to take a look at our demo videos, especially the [tour of a completed Spotlight exhibit](https://www.youtube.com/watch?v=_A7vTbbiF4g) and the walkthrough of [building an exhibit with Spotlight](https://www.youtube.com/watch?v=qPJtgajJ4ic).
+Read more about what Spotlight is, our motivations for creating it, and how to install and configure it in the [wiki pages](https://github.com/projectblacklight/spotlight/wiki). You might also want to take a look at our demo videos, especially the [tour of a completed Spotlight exhibit](https://www.youtube.com/watch?v=_A7vTbbiF4g) and the walkthrough of [building an exhibit with Spotlight](https://www.youtube.com/watch?v=qPJtgajJ4ic).
 
 ## Requirements
 
@@ -19,13 +19,13 @@ Read more about what Spotlight is, our motivations for creating it, and how to i
 To bootstrap a new Rails application:
 
 ```
-$ rails new app-name -m https://raw.githubusercontent.com/sul-dlss/spotlight/master/template.rb
+$ rails new app-name -m https://raw.githubusercontent.com/projectblacklight/spotlight/master/template.rb
 ```
 
 or from an existing Rails application:
 
 ```
-$ rake rails:template LOCATION=https://raw.githubusercontent.com/sul-dlss/spotlight/master/template.rb
+$ rake rails:template LOCATION=https://raw.githubusercontent.com/projectblacklight/spotlight/master/template.rb
 ```
 
 *During this process you will be prompted to enter an initial administrator email and password (this is a super-admin that can administer any exhibit in the installation).* If you choose not to create one, the first user will be given administrative privileges.
@@ -65,7 +65,7 @@ Spotlight introduces functionality that depends on being able to send emails to
 
 ### More
 
-See the [Spotlight wiki](https://github.com/sul-dlss/spotlight/wiki) for more detailed information on configuring Spotlight.
+See the [Spotlight wiki](https://github.com/projectblacklight/spotlight/wiki) for more detailed information on configuring Spotlight.
 
 # Developing Spotlight
 
@@ -78,8 +78,8 @@ Our `$ rake ci` and `$ rake spotlight:server` tasks utilize Solr and the testing
 
 ##  More Information for Developers
 
-* [Contributing to Spotlight](https://github.com/sul-dlss/spotlight/wiki/Contributing-to-Spotlight)
-* [Testing](https://github.com/sul-dlss/spotlight/wiki/Testing)
+* [Contributing to Spotlight](https://github.com/projectblacklight/spotlight/wiki/Contributing-to-Spotlight)
+* [Testing](https://github.com/projectblacklight/spotlight/wiki/Testing)
 
 ## Tests
 

data/Rakefile

@@ -4,8 +4,6 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-ZIP_URL = 'https://github.com/projectblacklight/blacklight-jetty/archive/v4.10.4.zip'.freeze
-
 require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
@@ -18,40 +16,33 @@ end
 
 Bundler::GemHelper.install_tasks
 
+require 'solr_wrapper'
+
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-require 'jettywrapper'
-
 require 'engine_cart/rake_task'
 EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
 
 require 'spotlight/version'
 
-task ci: ['engine_cart:generate', 'jetty:clean', 'spotlight:configure_jetty'] do
+task ci: ['engine_cart:generate'] do
   ENV['environment'] = 'test'
-  jetty_params = Jettywrapper.load_config
-  jetty_params[:startup_wait] = 60
 
-  Jettywrapper.wrap(jetty_params) do
-    Rake::Task['spotlight:fixtures'].invoke
+  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
+      Rake::Task['spotlight:fixtures'].invoke
 
-    # run the tests
-    Rake::Task['spec'].invoke
+      # run the tests
+      Rake::Task['spec'].invoke
+    end
   end
 end
 
 namespace :spotlight do
-  desc 'Copies the default SOLR config for the bundled Testing Server'
-  task :configure_jetty do
-    FileList['solr_conf/conf/*'].each do |f|
-      cp(f, 'jetty/solr/blacklight-core/conf/', verbose: true)
-    end
-  end
-
   desc 'Load fixtures'
   task fixtures: ['engine_cart:generate'] do
     within_test_app do
@@ -64,22 +55,16 @@ namespace :spotlight do
   task :server do
     Rake::Task['engine_cart:generate'].invoke
 
-    unless File.exist? 'jetty'
-      Rake::Task['jetty:clean'].invoke
-      Rake::Task['spotlight:configure_jetty'].invoke
-    end
-
-    jetty_params = Jettywrapper.load_config
-    jetty_params[:startup_wait] = 60
-
-    Jettywrapper.wrap(jetty_params) do
-      within_test_app do
-        unless File.exist? '.initialized'
-          system 'bundle exec rake spotlight:initialize'
-          system 'bundle exec rake spotlight_test:solr:seed'
-          File.open('.initialized', 'w') {}
+    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
+          unless File.exist? '.initialized'
+            system 'bundle exec rake spotlight:initialize'
+            system 'bundle exec rake spotlight_test:solr:seed'
+            File.open('.initialized', 'w') {}
+          end
+          system 'bundle exec rails s'
         end
-        system 'bundle exec rails s'
       end
     end
   end
@@ -111,9 +96,10 @@ namespace :spotlight do
             Bundler.with_clean_env do
               Dir.chdir('internal') do
                 APP_ROOT = Dir.pwd
-                jetty_params = Jettywrapper.load_config
-                Jettywrapper.wrap(jetty_params) do
-                  system 'bundle exec rails s'
+                SolrWrapper.wrap(port: '8983') do |solr|
+                  solr.with_collection(name: 'blacklight-core', dir: File.join(File.expand_path('..', File.dirname(__FILE__)), 'solr', 'conf')) do
+                    system 'bundle exec rails s'
+                  end
                 end
               end
             end

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

@@ -9,7 +9,7 @@ SirTrevor.Blocks.SolrDocuments = (function(){
 
     icon_name: "items",
 
-    autocomplete_url: function() { return this.$instance().closest('form[data-autocomplete-exhibit-catalog-index-path]').data('autocomplete-exhibit-catalog-index-path').replace("%25QUERY", "%QUERY"); },
+    autocomplete_url: function() { return this.$instance().closest('form[data-autocomplete-exhibit-catalog-path]').data('autocomplete-exhibit-catalog-path').replace("%25QUERY", "%QUERY"); },
     autocomplete_template: function() { return '<div class="autocomplete-item{{#if private}} blacklight-private{{/if}}">{{#if thumbnail}}<div class="document-thumbnail thumbnail"><img src="{{thumbnail}}" /></div>{{/if}}<span class="autocomplete-title">{{title}}</span><br/><small>&nbsp;&nbsp;{{description}}</small></div>' },
 
     transform_autocomplete_results: function(response) {

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

@@ -36,7 +36,7 @@ function itemsBloodhound() {
     queryTokenizer: Bloodhound.tokenizers.whitespace,
     limit: 10,
     remote: {
-      url: $('form[data-autocomplete-exhibit-catalog-index-path]').data('autocomplete-exhibit-catalog-index-path').replace("%25QUERY", "%QUERY"),
+      url: $('form[data-autocomplete-exhibit-catalog-path]').data('autocomplete-exhibit-catalog-path').replace("%25QUERY", "%QUERY"),
       filter: function(response) {
         return $.map(response['docs'], function(doc) {
           return doc;

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

@@ -1,5 +1,5 @@
 Spotlight = function() {
-  var buffer = new Array;
+  var buffer = [];
   return {
     onLoad: function(func) {
       buffer.push(func);
@@ -10,19 +10,13 @@ Spotlight = function() {
         buffer[i].call();
       }
     }
-  }
+  };
 }();
 
-if (typeof Turbolinks !== "undefined") {
-  $(document).on('page:load', function() {
-    Spotlight.activate();
-  });
-}
-$(document).ready(function() {
+Blacklight.onLoad(function() {
   Spotlight.activate();
 });
 
-
 Spotlight.onLoad(function(){
   SpotlightNestable.init();
   $.each($('.social-share-button a'), function() {

data/app/assets/stylesheets/spotlight/_footer.scss

@@ -14,30 +14,13 @@
     a {
       display: block;
       margin-bottom: 5px;
-      background: none;
-      width: 100%;
+      padding-left: 18px;
+      text-indent: 10px;
       color: $gray-light;
     }
     a:hover, a:focus {
       color: $gray;
       text-decoration: none;
     }
-    a:before {
-      content: '';
-      margin-right: 5px;
-      margin-bottom: -3px;
-      display: inline-block;
-      width: 16px;
-      height: 16px;
-    }
-    a.social-share-button-twitter:before {
-      background: image-url("sprites/social-share-button.png") -32px -48px no-repeat;
-    }
-    a.social-share-button-facebook:before {
-      background: image-url("sprites/social-share-button.png") -32px 0px no-repeat;
-    }
-    a.social-share-button-google_plus:before {
-      background: image-url("sprites/social-share-button.png") -16px -32px no-repeat;
-    }
   }
 }

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

@@ -22,14 +22,14 @@ module Spotlight
     def autocomplete_json_response_for_document(doc)
       {
         id: doc.id,
-        title: CGI.unescapeHTML(view_context.presenter(doc).document_heading.to_str),
+        title: CGI.unescapeHTML(view_context.presenter(doc).heading.to_str),
         thumbnail: doc.first(blacklight_config.index.thumbnail_field),
         thumbnails: doc.spotlight_image_versions.try(:thumb) || doc[blacklight_config.index.thumbnail_field],
         full_image_url: doc.spotlight_image_versions.try(:full).try(:first),
         full_images: doc.spotlight_image_versions.try(:full),
         image_versions: doc.spotlight_image_versions.image_versions(:thumb, :full),
         description: doc.id,
-        url: exhibit_catalog_path(current_exhibit, doc),
+        url: polymorphic_path([current_exhibit, doc]),
         private: doc.private?(current_exhibit),
         global_id: doc.to_global_id.to_s
       }

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

@@ -6,10 +6,6 @@ module Spotlight
     include Blacklight::Catalog
     include Spotlight::Base
 
-    require 'spotlight/catalog/access_controls_enforcement'
-
-    include Spotlight::Catalog::AccessControlsEnforcement
-
     included do
       before_action :add_facet_visibility_field
     end
@@ -23,8 +19,14 @@ module Spotlight
                                         query: {
                                           private: {
                                             label: I18n.t(:'spotlight.catalog.facets.exhibit_visibility.private'),
-                                            fq: "#{blacklight_config.document_model.visibility_field(current_exhibit)}:false" }
+                                            fq: "#{blacklight_config.document_model.visibility_field(current_exhibit)}:false"
+                                          }
                                         }
     end
+
+    def render_save_this_search?
+      (current_exhibit && can?(:curate, current_exhibit)) &&
+        !(params[:controller] == 'spotlight/catalog' && params[:action] == 'admin')
+    end
   end
 end

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

@@ -56,7 +56,7 @@ module Spotlight
       if current_exhibit
         exhibit_search_action_url(*args)
       else
-        main_app.catalog_index_url(*args)
+        main_app.search_catalog_url(*args)
       end
     end
 
@@ -74,9 +74,9 @@ module Spotlight
       options.except! :exhibit_id, :only_path
 
       if only_path
-        spotlight.exhibit_catalog_index_path(current_exhibit, *args, options)
+        spotlight.search_exhibit_catalog_path(current_exhibit, *args, options)
       else
-        spotlight.exhibit_catalog_index_url(current_exhibit, *args, options)
+        spotlight.search_exhibit_catalog_url(current_exhibit, *args, options)
       end
     end
 
@@ -84,7 +84,7 @@ module Spotlight
       options = args.extract_options!
       options = params.merge(options).except(:exhibit_id, :only_path)
 
-      spotlight.exhibit_catalog_facet_url(current_exhibit, *args, options)
+      spotlight.facet_exhibit_catalog_url(current_exhibit, *args, options)
     end
   end
 end

data/app/controllers/spotlight/application_controller.rb

@@ -10,5 +10,7 @@ module Spotlight
     before_action do
       flash.now[:notice] = flash[:notice].html_safe if flash[:html_safe] && flash[:notice]
     end
+
+    before_action :set_paper_trail_whodunnit
   end
 end

data/app/controllers/spotlight/browse_controller.rb

@@ -5,7 +5,6 @@ module Spotlight
   class BrowseController < Spotlight::ApplicationController
     load_and_authorize_resource :exhibit, class: 'Spotlight::Exhibit'
     include Spotlight::Base
-    include Spotlight::Catalog::AccessControlsEnforcement
 
     load_and_authorize_resource :search, except: :index, through: :exhibit, parent: false
     before_action :attach_breadcrumbs
@@ -21,7 +20,7 @@ module Spotlight
       blacklight_config.index.document_actions = blacklight_config.browse.document_actions
 
       add_breadcrumb @search.title, exhibit_browse_path(@exhibit, @search)
-      (@response, @document_list) = search_results(@search.query_params.with_indifferent_access.merge(params), search_params_logic)
+      (@response, @document_list) = search_results(@search.query_params.with_indifferent_access.merge(params))
     end
 
     protected

data/app/controllers/spotlight/catalog_controller.rb

@@ -52,7 +52,7 @@ module Spotlight
     # results when a partial match is passed in the "q" parameter.
     def autocomplete
       search_params = params.merge(search_field: Spotlight::Engine.config.autocomplete_search_field)
-      (_, @document_list) = search_results(search_params.merge(public: true), search_params_logic)
+      (_, @document_list) = search_results(search_params.merge(public: true))
 
       respond_to do |format|
         format.json do
@@ -63,8 +63,8 @@ module Spotlight
 
     def admin
       add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
-      add_breadcrumb t(:'spotlight.curation.sidebar.items'), admin_exhibit_catalog_index_path(@exhibit)
-      (@response, @document_list) = search_results(params, search_params_logic)
+      add_breadcrumb t(:'spotlight.curation.sidebar.items'), admin_exhibit_catalog_path(@exhibit)
+      (@response, @document_list) = search_results(params)
       @filters = params[:f] || []
 
       respond_to do |format|
@@ -79,7 +79,7 @@ module Spotlight
 
       try_solr_commit!
 
-      redirect_to exhibit_catalog_path(current_exhibit, @document)
+      redirect_to polymorphic_path([current_exhibit, @document])
     end
 
     def edit
@@ -87,7 +87,7 @@ module Spotlight
     end
 
     def make_private
-      @response, @document = fetch params[:catalog_id]
+      @response, @document = fetch params[:id]
       @document.make_private!(current_exhibit)
       @document.save
 
@@ -98,7 +98,7 @@ module Spotlight
     end
 
     def make_public
-      @response, @document = fetch params[:catalog_id]
+      @response, @document = fetch params[:id]
       @document.make_public!(current_exhibit)
       @document.save
 
@@ -179,7 +179,7 @@ module Spotlight
     end
 
     def custom_field_params
-      current_exhibit.custom_fields.pluck(:field)
+      current_exhibit.custom_fields.writeable.pluck(:field)
     end
 
     def check_authorization
@@ -205,7 +205,7 @@ module Spotlight
         add_breadcrumb t(:'spotlight.catalog.breadcrumb.index'), search_action_url(current_search_session.query_params)
       end
 
-      add_breadcrumb Array(document[blacklight_config.view_config(:show).title_field]).join(', '), exhibit_catalog_path(current_exhibit, document)
+      add_breadcrumb Array(document[blacklight_config.view_config(:show).title_field]).join(', '), polymorphic_path([current_exhibit, document])
     end
     # rubocop:enable Metrics/AbcSize
 

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

@@ -25,6 +25,65 @@ module Spotlight
           end
         end
       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)
+          false
+        elsif current_exhibit.nil? || is_a?(Spotlight::PagesController)
+          true
+        else
+          current_exhibit.blacklight_configuration.document_index_view_types.include? config.key.to_s
+        end
+      end
+
+      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize, 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)
+          false
+        elsif field.is_a?(Blacklight::Configuration::SortField) || field.is_a?(Blacklight::Configuration::SearchField)
+          field.enabled
+        elsif field.is_a?(Blacklight::Configuration::FacetField) || (is_a?(Blacklight::Catalog) && %w(edit show).include?(action_name))
+          field.show
+        else
+          field.send(document_index_view_type)
+        end
+      end
+      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
+
+      private
+
+      ##
+      # Get the current "view type" (and ensure it is a valid type)
+      #
+      # @param [Hash] the query parameters to check
+      # @return [Symbol]
+      def document_index_view_type
+        view_param = params[:view]
+        view_param ||= session[:preferred_view]
+        if view_param && document_index_views.keys.include?(view_param.to_sym)
+          view_param.to_sym
+        else
+          default_document_index_view_type
+        end
+      end
+
+      def document_index_views
+        blacklight_config.view.select do |_k, config|
+          blacklight_configuration_context.evaluate_if_unless_configuration config
+        end
+      end
+
+      ##
+      # Get the default index view type
+      def default_document_index_view_type
+        document_index_views.select { |_k, config| config.respond_to?(:default) && config.default }.keys.first || document_index_views.keys.first
+      end
     end
   end
 end