blacklight-spotlight 2.13.0 → 3.0.0.alpha.1

data/app/controllers/spotlight/dashboards_controller.rb

@@ -8,11 +8,13 @@ module Spotlight
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
 
     include Spotlight::Base
+    include Spotlight::SearchHelper
 
     before_action only: [:show] do
       blacklight_config.view.reject! { |_k, _v| true }
       blacklight_config.view.admin_table.partials = ['index_compact']
       blacklight_config.view.admin_table.document_actions = []
+      blacklight_config.track_search_session = false
     end
 
     def show
@@ -49,7 +51,9 @@ module Spotlight
 
     def load_recent_solr_documents(count)
       solr_params = { sort: "#{blacklight_config.index.timestamp_field} desc" }
-      @response, docs = search_results(solr_params)
+      @response, docs = search_service.search_results do |builder|
+        builder.merge(solr_params)
+      end
       docs.take(count)
     end
   end

data/app/controllers/spotlight/exhibits_controller.rb

@@ -4,9 +4,9 @@ module Spotlight
   ##
   # Administrative CRUD actions for an exhibit
   class ExhibitsController < Spotlight::ApplicationController
+    include Spotlight::SearchHelper
     before_action :authenticate_user!, except: [:index]
     before_action :set_tab, only: [:edit, :update]
-    include Blacklight::SearchHelper
 
     load_and_authorize_resource
 

data/app/controllers/spotlight/home_pages_controller.rb

@@ -4,13 +4,14 @@ module Spotlight
   ##
   # CRUD actions for the exhibit home page
   class HomePagesController < Spotlight::PagesController
-    include Blacklight::SearchHelper
     include Spotlight::Catalog
 
     load_and_authorize_resource through: :exhibit, singleton: true, instance_name: 'page'
 
     before_action :attach_breadcrumbs, except: :show
 
+    helper_method :facet_limit_for
+
     def edit
       add_breadcrumb t(:'spotlight.curation.sidebar.feature_pages'), exhibit_feature_pages_path(@exhibit)
       add_breadcrumb @page.title, [:edit, @exhibit, @page]
@@ -22,7 +23,7 @@ module Spotlight
     end
 
     def show
-      @response, @document_list = search_results({}) if @page.display_sidebar?
+      @response, @document_list = search_service.search_results if @page.display_sidebar?
 
       if @page.nil? || !@page.published?
         render '/catalog/index'
@@ -37,10 +38,38 @@ module Spotlight
       super
     end
 
+    # Copied from blacklight to avoid bringing in all of Blacklight::Catalog
+    DEFAULT_FACET_LIMIT = 10
+
+    # Look up facet limit for given facet_field. Will look at config, and
+    # if config is 'true' will look up from Solr @response if available. If
+    # no limit is available, returns nil. Used from #add_facetting_to_solr
+    # to supply f.fieldname.facet.limit values in solr request (no @response
+    # available), and used in display (with @response available) to create
+    # a facet paginator with the right limit.
+    def facet_limit_for(facet_field)
+      facet = blacklight_config.facet_fields[facet_field]
+      return if facet.blank?
+
+      if facet.limit && @response && @response.aggregations[facet.field]
+        limit = @response.aggregations[facet.field].limit
+
+        if limit.nil? # we didn't get or a set a limit, so infer one.
+          facet.limit if facet.limit != true
+        elsif limit == -1 # limit -1 is solr-speak for unlimited
+          nil
+        else
+          limit.to_i - 1 # we added 1 to find out if we needed to paginate
+        end
+      elsif facet.limit
+        facet.limit == true ? DEFAULT_FACET_LIMIT : facet.limit
+      end
+    end
+
     private
 
     alias search_action_url exhibit_search_action_url
-    alias search_facet_url exhibit_search_facet_url
+    alias search_facet_path exhibit_search_facet_path
 
     def load_locale_specific_page
       @page = Spotlight::HomePage.for_locale.find_by(exhibit: current_exhibit)

data/app/controllers/spotlight/pages_controller.rb

@@ -13,10 +13,15 @@ module Spotlight
     load_and_authorize_resource through: :exhibit, instance_name: 'page', only: [:index]
 
     helper Openseadragon::OpenseadragonHelper
+    include Spotlight::SearchHelper
     include Spotlight::Base
     include Blacklight::SearchContext
 
-    helper_method :get_search_results, :search_results, :fetch, :page_collection_name
+    helper_method :get_search_results, :search_results, :fetch, :page_collection_name, :presenter
+
+    before_action do
+      blacklight_config.track_search_session = false
+    end
 
     # GET /exhibits/1/pages
     def index
@@ -111,8 +116,17 @@ module Spotlight
       @_prefixes ||= super + ['catalog']
     end
 
+    # Add a Page specific search_results method that takes user params as
+    # an option and passes that off to the search service to get results
+    # @param [Hash] the query parameters
+    # @return [Object] the search results object from the configured search service
+    def search_results(user_params)
+      search_service(user_params).search_results
+    end
+
     def undo_link
       return unless can? :manage, @page
+      return if @page.versions.blank?
 
       view_context.link_to(t(:'spotlight.versions.undo'), revert_version_path(@page.versions.last), method: :post)
     end
@@ -197,6 +211,10 @@ module Spotlight
         raise ActiveRecord::RecordNotFound
       end
     end
+
+    def presenter(document)
+      view_context.index_presenter(document)
+    end
   end
   # rubocop:enable Metrics/ClassLength
 end

data/app/controllers/spotlight/search_configurations_controller.rb

@@ -4,12 +4,12 @@ module Spotlight
   ##
   # CRUD actions for Blacklight search configuration
   class SearchConfigurationsController < Spotlight::ApplicationController
+    include Spotlight::SearchHelper
+
     before_action :authenticate_user!
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
     load_and_authorize_resource :blacklight_configuration, through: :exhibit, singleton: true, parent: false
 
-    include Blacklight::SearchHelper
-
     def show
       respond_to do |format|
         format.json do
@@ -23,7 +23,7 @@ module Spotlight
       add_breadcrumb t(:'spotlight.configuration.sidebar.header'), exhibit_dashboard_path(@exhibit)
       add_breadcrumb t(:'spotlight.configuration.sidebar.search_configuration'), edit_exhibit_search_configuration_path(@exhibit)
 
-      @field_metadata = Spotlight::FieldMetadata.new(current_exhibit, repository, @blacklight_configuration.blacklight_config)
+      @field_metadata = Spotlight::FieldMetadata.new(current_exhibit, blacklight_config.repository, @blacklight_configuration.blacklight_config)
     end
 
     def update

data/app/controllers/spotlight/searches_controller.rb

@@ -13,6 +13,7 @@ module Spotlight
     before_action :attach_breadcrumbs, only: [:index, :edit], unless: -> { request.format.json? }
 
     include Spotlight::Base
+    include Spotlight::SearchHelper
 
     def create
       @search.assign_attributes(search_params.except((:title unless @search.new_record?)))
@@ -37,7 +38,9 @@ module Spotlight
 
     def autocomplete
       search_params = autocomplete_params.merge(search_field: Spotlight::Engine.config.autocomplete_search_field)
-      (_, document_list) = search_results(search_params)
+      (_, document_list) = search_service.search_results do |builder|
+        builder.with(search_params)
+      end
 
       respond_to do |format|
         format.json do

data/app/controllers/spotlight/solr_controller.rb

@@ -8,8 +8,7 @@ module Spotlight
   # This is an example of how you could integrate external indexing
   # workflows with exhibit-specific content
   class SolrController < Spotlight::ApplicationController
-    include Blacklight::SearchHelper
-
+    include Spotlight::SearchHelper
     before_action :authenticate_user!
     before_action :validate_writable_index!
 

data/app/helpers/spotlight/application_helper.rb

@@ -121,7 +121,7 @@ module Spotlight
     def select_deselect_button
       button_tag(
         t(:".deselect_all"),
-        class: 'btn btn-default btn-xs metadata-select',
+        class: 'btn btn-secondary btn-sm metadata-select',
         data: {
           behavior: 'metadata-select',
           'deselect-text' => t(:".deselect_all"),

data/app/helpers/spotlight/browse_helper.rb

@@ -4,7 +4,7 @@ module Spotlight
   ##
   # Helper for browse views
   module BrowseHelper
-    include ::BlacklightConfigurationHelper
+    include Blacklight::ConfigurationHelperBehavior
     include Spotlight::RenderingHelper
 
     ##

data/app/helpers/spotlight/crud_link_helpers.rb

@@ -62,6 +62,25 @@ module Spotlight
       action_default_value model, action
     end
 
+    def nav_link(name = nil, options = nil, html_options = nil, &block)
+      # rubocop:disable Style/ParallelAssignment
+      # (Note: this is copied from upstream in Rails)
+      html_options, options, name = options, name, block if block_given?
+      # rubocop:enable Style/ParallelAssignment
+
+      html_options ||= {}
+
+      nav_link_html_options = html_options.merge(class: [html_options[:class], 'nav-link', ('active' if current_page?(options))].join(' '))
+
+      content_tag(:li, class: 'nav-item') do
+        if block_given?
+          link_to(options, nav_link_html_options, &block)
+        else
+          link_to(name, options, nav_link_html_options, &block)
+        end
+      end
+    end
+
     private
 
     # rubocop:disable Metrics/MethodLength

data/app/helpers/spotlight/pages_helper.rb

@@ -30,7 +30,7 @@ module Spotlight
     end
 
     def available_index_fields
-      fields = blacklight_config.index_fields.map { |k, _v| { key: k, label: index_field_label(nil, k) } }
+      fields = blacklight_config.index_fields.map { |k, _v| { key: k, label: index_field_label(blacklight_config.document_model.new, k) } }
       fields.unshift(key: document_show_link_field, label: t(:'spotlight.pages.form.title_placeholder')) unless index_fields.include? document_show_link_field
 
       fields

data/app/mailers/spotlight/contact_mailer.rb

@@ -2,7 +2,7 @@
 
 module Spotlight
   # Mailer for reporting problems to the application contact and/or exhibit administrator
-  class ContactMailer < ActionMailer::Base
+  class ContactMailer < ApplicationMailer
     def report_problem(contact_form)
       @contact_form = contact_form
       mail(@contact_form.headers)

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

@@ -12,7 +12,7 @@ module Spotlight
     # Adds a filter that excludes resources that have been marked as not-visible
     def apply_permissive_visibility_filter(solr_params)
       return unless current_exhibit
-      return if scope.respond_to?(:can?) && scope.can?(:curate, current_exhibit) && !blacklight_params[:public]
+      return if !blacklight_params[:public] && scope&.context&.key?(:current_ability) && scope.context[:current_ability].can?(:curate, current_exhibit)
 
       solr_params.append_filter_query "-#{blacklight_config.document_model.visibility_field(current_exhibit)}:false"
     end
@@ -30,7 +30,7 @@ module Spotlight
     private
 
     def current_exhibit
-      scope.current_exhibit
+      blacklight_config.current_exhibit
     end
   end
 end

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

@@ -22,10 +22,8 @@ module Spotlight
       end
     end
 
-    private
-
     def analytics_provider
-      Spotlight::Engine.config.analytics_provider
+      @analytics_provider ||= Spotlight::Engine.config.analytics_provider.new
     end
   end
 end

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

@@ -30,7 +30,7 @@ module Spotlight
     end
 
     def exhibit_search_builder_context
-      OpenStruct.new(blacklight_config: blacklight_config, current_exhibit: self)
+      OpenStruct.new(blacklight_config: blacklight_config.tap { |x| x.current_exhibit = self })
     end
 
     def repository

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

@@ -26,7 +26,7 @@ module SirTrevorRails
       def documents
         @documents ||= begin
           doc_ids = items.map { |v| v[:id] }
-          _, documents = solr_helper.fetch(doc_ids)
+          _, documents = solr_helper.controller.send(:search_service).fetch(doc_ids)
           documents
         end
       end
@@ -36,11 +36,19 @@ module SirTrevorRails
       end
 
       def primary_caption?
-        primary_caption_field.present? && send(:'show-primary-caption')
+        primary_caption_field.present? && show_primary_caption?
+      end
+
+      def show_primary_caption?
+        ActiveModel::Type::Boolean.new.cast(send(:'show-primary-caption'))
       end
 
       def secondary_caption?
-        secondary_caption_field.present? && send(:'show-secondary-caption')
+        secondary_caption_field.present? && show_secondary_caption?
+      end
+
+      def show_secondary_caption?
+        ActiveModel::Type::Boolean.new.cast(send(:'show-secondary-caption'))
       end
 
       def zpr_link?

data/app/models/spotlight/ability.rb

@@ -19,7 +19,7 @@ module Spotlight
       can :manage, [Spotlight::BlacklightConfiguration, Spotlight::ContactEmail, Spotlight::Language], 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?
+      can :manage, [PaperTrail::Version, Spotlight::FeaturedImage] if user.roles.any?
 
       # exhibit curator
       can :manage, [

data/app/models/spotlight/analytics/ga.rb

@@ -10,21 +10,26 @@ module Spotlight
     class Ga
       extend Legato::Model
 
-      cattr_writer :user, :site
-
-      metrics :sessions, :users, :pageviews
-
-      def self.enabled?
+      def enabled?
         user && site
       end
 
-      def self.for_exhibit(exhibit)
-        path(Spotlight::Engine.routes.url_helpers.exhibit_path(exhibit))
+      delegate :metrics, to: :model
+
+      def exhibit_data(exhibit, options)
+        model.context(exhibit).results(site, Spotlight::Engine.config.ga_analytics_options.merge(options)).to_a.first || exhibit_data_unavailable
       end
 
-      filter :path, &->(path) { contains(:pagePath, "^#{path}") }
+      def page_data(exhibit, options)
+        options[:sort] ||= '-pageviews'
+        query = model.context(exhibit).results(site, Spotlight::Engine.config.ga_page_analytics_options.merge(options))
+        query.dimensions << :page_path
+        query.dimensions << :page_title
+
+        query.to_a
+      end
 
-      def self.user(scope = 'https://www.googleapis.com/auth/analytics.readonly')
+      def user(scope = 'https://www.googleapis.com/auth/analytics.readonly')
         @user ||= begin
                     Legato::User.new(oauth_token(scope))
                   rescue => e
@@ -33,52 +38,37 @@ module Spotlight
                   end
       end
 
-      def self.site
-        @site ||= user.accounts.first.profiles.first { |x| x.web_property_id = Spotlight::Engine.config.ga_web_property_id }
+      def site
+        @site ||= user.accounts.first.profiles.find { |x| x.web_property_id == Spotlight::Engine.config.ga_web_property_id }
       end
 
-      def self.exhibit_data(exhibit, options)
-        context(exhibit).results(site, Spotlight::Engine.config.ga_analytics_options.merge(options)).to_a.first || exhibit_data_unavailable
-      end
+      private
 
-      def self.exhibit_data_unavailable
-        OpenStruct.new(pageviews: 'n/a', users: 'n/a', sessions: 'n/a')
+      def model
+        Spotlight::Analytics::GaModel
       end
 
-      def self.page_data(exhibit, options)
-        options[:sort] ||= '-pageviews'
-        query = context(exhibit).results(site, Spotlight::Engine.config.ga_page_analytics_options.merge(options))
-        query.dimensions << :page_path
-        query.dimensions << :page_title
-
-        query.to_a
-      end
-
-      def self.context(exhibit)
-        if exhibit.is_a? Spotlight::Exhibit
-          for_exhibit(exhibit)
-        else
-          path(exhibit)
-        end
+      def exhibit_data_unavailable
+        OpenStruct.new(pageviews: 'n/a', users: 'n/a', sessions: 'n/a')
       end
 
-      def self.oauth_token(scope)
+      def oauth_token(scope)
         require 'oauth2'
 
         access_token = auth_client(scope).fetch_access_token!
         OAuth2::AccessToken.new(oauth_client, access_token['access_token'], expires_in: access_token['expires_in'])
       end
 
-      def self.oauth_client
+      def oauth_client
         OAuth2::Client.new('', '', authorize_url: 'https://accounts.google.com/o/oauth2/auth',
                                    token_url: 'https://accounts.google.com/o/oauth2/token')
       end
 
-      def self.signing_key
+      def signing_key
         @signing_key ||= OpenSSL::PKCS12.new(File.read(Spotlight::Engine.config.ga_pkcs12_key_path), 'notasecret').key
       end
 
-      def self.auth_client(scope)
+      def auth_client(scope)
         Signet::OAuth2::Client.new token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
                                    audience: 'https://accounts.google.com/o/oauth2/token',
                                    scope: scope,