blacklight-spotlight 3.0.0.rc5 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e21e66d81a96d330d76726b9a41e44ea7495653b75d9d5b211f4a607cc4afec
-  data.tar.gz: 9f6cc613d234db387773a9b80ae7a72e7c3610ab01996a116df4997668dc0703
+  metadata.gz: 931e772ae7165aea85c6664c6c1fcbb615d0397d42d2000b2bc4f7038288ff91
+  data.tar.gz: 5eac236663178ff5476f8b58213f8da5757bd7120108b801792247cc194392b4
 SHA512:
-  metadata.gz: dc889b0bf136bde52dcb6e8d99776be47261cff5e4310ad3297018e77d5d25818f46df0d874ac379dfa91f8177a648135e84f4ef0ee5810c30bc3d87c90caed8
-  data.tar.gz: efe143a5c7125d9b6d18aa972d2a1c4357cf2c42f34ed62c0b2b402af4d16c6473087c63b3cb605a07127edb2f65a0d038772037bb7560ca5497a734f6b89bfd
+  metadata.gz: 528286f83609189237af8feef3e40048357b37de3770fdf772bc2672c3b0a52230cb1ab9f2ddfb31b59932aba9a0fafdc44ef2d2f79a333db9618ccf34746acf
+  data.tar.gz: 16900b7cbc3278b6be875cb0e91441f33860dc13200c36898e36f545d236557eddada90fe99536ed2fecd72538c076f6dd0edadeea9e481b5d7d025b470b93b6

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

@@ -32,7 +32,7 @@ module Spotlight
     def autocomplete_json_response_for_document(doc)
       {
         id: doc.id,
-        title: CGI.unescapeHTML(view_context.presenter(doc).heading.to_str),
+        title: CGI.unescapeHTML(view_context.document_presenter(doc).heading.to_str),
         thumbnail: doc.first(blacklight_config.index.thumbnail_field),
         full_image_url: doc.first(Spotlight::Engine.config.full_image_field),
         description: doc.id,

data/app/controllers/spotlight/browse_controller.rb

@@ -15,13 +15,15 @@ module Spotlight
     before_action :attach_search_breadcrumb, only: :show
     record_search_parameters only: :show
 
-    helper_method :should_render_spotlight_search_bar?, :presenter
+    helper_method :should_render_spotlight_search_bar?
 
     before_action :swap_actions_configuration, only: :show
 
     before_action do
       blacklight_config.track_search_session = false
-      blacklight_config.view.gallery.classes = 'row-cols-2 row-cols-md-4'
+      blacklight_config.view.gallery.classes = 'row-cols-2 row-cols-md-4' if blacklight_config.view.key? :gallery
+      blacklight_config.action_mapping.default = blacklight_config.index
+      blacklight_config.action_mapping.show = blacklight_config.index
     end
 
     def index
@@ -31,15 +33,11 @@ module Spotlight
 
     def show
       @response, @document_list = search_service.search_results do |builder|
-        builder.with(search_query)
+        builder.with(params.merge(browse_category_id: @search.id))
       end
 
       respond_to do |format|
         format.html
-        format.json do
-          @presenter = Blacklight::JsonPresenter.new(@response, blacklight_config)
-          render template: 'catalog/index'
-        end
       end
     end
 
@@ -50,11 +48,6 @@ module Spotlight
       blacklight_config.action_mapping.show.top_level_config = :index if blacklight_config.key?(:action_mapping)
     end
 
-    def search_query
-      @search.query_params['q'] = [@search.query_params['q'], params[:browse_q]].join(' ')
-      @search.merge_params_for_search(params, blacklight_config)
-    end
-
     ##
     # Browsing an exhibit should start a new search session
     def start_new_search_session?
@@ -128,10 +121,6 @@ module Spotlight
       Spotlight::Engine.config.default_browse_index_view_type
     end
 
-    def presenter(document)
-      view_context.index_presenter(document)
-    end
-
     def render_save_this_search?
       false
     end

data/app/controllers/spotlight/catalog_controller.rb

@@ -27,8 +27,7 @@ module Spotlight
 
     before_action only: :admin do
       blacklight_config.view.select! { |k, _v| k == :admin_table }
-      blacklight_config.view.admin_table.partials = [:index_compact]
-      blacklight_config.view.admin_table.document_actions = []
+      blacklight_config.view.admin_table(partials: [:index_compact], document_actions: []) unless blacklight_config.view.key? :admin_table
       blacklight_config.track_search_session = false
 
       unless blacklight_config.sort_fields.key? :timestamp
@@ -38,8 +37,7 @@ module Spotlight
     end
 
     before_action only: :edit do
-      blacklight_config.view.edit.partials = blacklight_config.view_config(:show).partials.dup
-      blacklight_config.view.edit.partials.insert(2, :edit)
+      blacklight_config.view.edit(partials: blacklight_config.view_config(:show).partials.dup.insert(2, :edit)) unless blacklight_config.view.key? :edit
     end
 
     def show
@@ -199,6 +197,10 @@ module Spotlight
       redirect_to spotlight.exhibit_root_path(@exhibit) unless has_search_parameters?
     end
 
+    def has_search_parameters? # rubocop:disable Naming/PredicateName
+      super || params[:browse_category_id].present?
+    end
+
     def add_breadcrumb_with_search_params
       return unless has_search_parameters?
 
@@ -216,7 +218,7 @@ module Spotlight
         add_breadcrumb t(:'spotlight.catalog.breadcrumb.index'), search_action_url(current_search_session.query_params)
       end
 
-      add_breadcrumb view_context.show_presenter(document).heading, polymorphic_path([current_exhibit, document])
+      add_breadcrumb view_context.document_presenter(document).heading, polymorphic_path([current_exhibit, document])
     end
     # rubocop:enable Metrics/AbcSize
 

data/app/controllers/spotlight/dashboards_controller.rb

@@ -11,9 +11,9 @@ module Spotlight
     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.action_mapping&.delete(:show)
+      blacklight_config.view.clear
+      blacklight_config.view.admin_table(partials: ['index_compact'], document_actions: [])
       blacklight_config.track_search_session = false
       blacklight_config.action_mapping.show.top_level_config = :index if blacklight_config.key?(:action_mapping)
     end

data/app/controllers/spotlight/pages_controller.rb

@@ -17,9 +17,11 @@ module Spotlight
     include Spotlight::Base
     include Blacklight::SearchContext
 
-    helper_method :get_search_results, :search_results, :fetch, :page_collection_name, :presenter
+    helper_method :get_search_results, :search_results, :fetch, :page_collection_name
 
     before_action do
+      blacklight_config.action_mapping.default = blacklight_config.index
+      blacklight_config.action_mapping.show = blacklight_config.index
       blacklight_config.view.gallery.classes = 'row-cols-2 row-cols-md-4' unless @page&.display_sidebar
     end
 
@@ -63,7 +65,8 @@ module Spotlight
       @page.last_edited_by = @page.created_by = current_user
 
       if @page.save
-        redirect_to [spotlight, @page.exhibit, page_collection_name], notice: t(:'helpers.submit.page.created', model: @page.class.model_name.human.downcase)
+        redirect_to [spotlight, @page.exhibit, page_collection_name.to_sym],
+                    notice: t(:'helpers.submit.page.created', model: @page.class.model_name.human.downcase)
       else
         render action: 'new'
       end
@@ -84,7 +87,7 @@ module Spotlight
     def destroy
       @page.destroy
 
-      redirect_to [spotlight, @page.exhibit, page_collection_name], flash: { html_safe: true }, notice: undo_notice(:destroyed)
+      redirect_to [spotlight, @page.exhibit, page_collection_name.to_sym], flash: { html_safe: true }, notice: undo_notice(:destroyed)
     end
 
     def update_all
@@ -204,10 +207,6 @@ module Spotlight
         raise ActiveRecord::RecordNotFound
       end
     end
-
-    def presenter(document)
-      view_context.index_presenter(document)
-    end
   end
   # rubocop:enable Metrics/ClassLength
 end

data/app/helpers/spotlight/application_helper.rb

@@ -92,7 +92,7 @@ module Spotlight
     # Helper to turn tag data into facets
     def url_to_tag_facet(tag)
       if current_exhibit
-        search_action_url(search_state.reset.add_facet_params(:exhibit_tags, tag))
+        search_action_url(search_state.reset.filter(:exhibit_tags).add(tag).params)
       else
         search_action_url(q: tag)
       end

data/app/helpers/spotlight/main_app_helpers.rb

@@ -28,12 +28,11 @@ module Spotlight
       super
     end
 
-    def presenter(document)
-      case action_name
-      when 'index'
+    def document_presenter_class(_document)
+      if action_name == 'index'
         super
       else
-        show_presenter(document)
+        blacklight_config.view_config(action_name: :show).document_presenter_class
       end
     end
 

data/app/helpers/spotlight/meta_helper.rb

@@ -81,7 +81,7 @@ module Spotlight
     end
 
     def document_twitter_card_content(document)
-      presenter = show_presenter(document)
+      presenter = document_presenter(document)
 
       twitter_card('summary_large_image') do |card|
         card.title presenter.heading
@@ -90,7 +90,7 @@ module Spotlight
     end
 
     def document_opengraph_content(document)
-      presenter = show_presenter(document)
+      presenter = document_presenter(document)
 
       opengraph do |graph|
         graph.site_name application_name

data/app/helpers/spotlight/searches_helper.rb

@@ -4,7 +4,7 @@ module Spotlight
   # Saved search helpers
   module SearchesHelper
     def available_document_index_views
-      blacklight_config.view.to_h.reject { |_k, v| v.if == false }.keys
+      blacklight_config.view.to_h.reject { |_k, v| v.if == false }
     end
   end
 end

data/app/jobs/spotlight/process_bulk_updates_csv_job.rb

@@ -43,7 +43,7 @@ module Spotlight
       needs_reindex = false
 
       begin
-        if sidecar.public != to_bool(row[config.csv_visibility])
+        if row.headers.include?(config.csv_visibility) && sidecar.public != to_bool(row[config.csv_visibility])
           sidecar.update(public: to_bool(row[config.csv_visibility]))
           needs_reindex = true
         end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Enforce exhibit visibility for index queries
+  module BrowseCategorySearchBuilder
+    extend ActiveSupport::Concern
+
+    included do
+      self.default_processor_chain = %i[apply_browse_category_defaults] +
+                                     default_processor_chain +
+                                     %i[fix_up_browse_category_defaults fix_up_browse_category_queries]
+    end
+
+    # Adds a filter that excludes resources that have been marked as not-visible
+    def apply_browse_category_defaults(solr_params)
+      return unless current_browse_category
+
+      solr_params.merge!(browse_category_search_builder.to_hash)
+    end
+
+    def fix_up_browse_category_defaults(solr_params)
+      return if current_browse_category.nil? || search_state.send(:sort_field_key).present?
+
+      solr_params[:sort] = browse_category_search_builder.sort
+    end
+
+    def fix_up_browse_category_queries(solr_params)
+      return unless solr_params.dig(:json, :query, :bool, :must) && blacklight_params[:q]
+
+      # This replicates existing spotlight 2.x search behavior, more or less. It
+      # doesn't take into account the possibility that the browse category query
+      # could use a different search field (which.. doesn't have an existing UI
+      # control.. and may require additional upstream work to properly encapsulate
+      # the two query parameters)
+      solr_params[:json][:query][:bool][:must].map! do |q|
+        q.is_a?(String) ? { edismax: { query: q } } : q
+      end
+    end
+
+    private
+
+    def current_exhibit
+      blacklight_config.current_exhibit
+    end
+
+    def current_browse_category
+      return unless current_exhibit && blacklight_params[:browse_category_id].present?
+
+      @current_browse_category ||= current_exhibit.searches.find(blacklight_params[:browse_category_id])
+    end
+
+    def browse_category_search_builder
+      @browse_category_search_builder ||= begin
+        search_builder = self.class.new(@processor_chain, @scope)
+        search_builder.with(current_browse_category.query_params)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Enforce exhibit visibility for index queries
+  module SearchBuilder
+    extend ActiveSupport::Concern
+
+    include Spotlight::AccessControlsEnforcementSearchBuilder
+    include Spotlight::BrowseCategorySearchBuilder
+  end
+end

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

@@ -31,7 +31,7 @@ module SirTrevorRails
         send(:'display-item-counts') == 'true'
       end
 
-      def as_json
+      def as_json(*)
         result = super
 
         result[:data][:item] ||= {}

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

@@ -22,7 +22,7 @@ module SirTrevorRails
       end
 
       # rubocop:disable Metrics/MethodLength
-      def as_json
+      def as_json(*)
         result = super
         result[:data][:item] ||= {}
 

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

@@ -43,6 +43,15 @@ module SirTrevorRails
         ActiveModel::Type::Boolean.new.cast(send(:'show-primary-caption'))
       end
 
+      def document_caption(presenter, caption_field, default: nil)
+        caption_field ||= default
+
+        return unless caption_field
+        return presenter.heading if caption_field == Spotlight::PageConfigurations::DOCUMENT_TITLE_KEY
+
+        presenter.field_value(solr_helper.blacklight_config.index_fields[caption_field] || Blacklight::Configuration::NullField.new(caption_field))
+      end
+
       def secondary_caption?
         secondary_caption_field.present? && show_secondary_caption?
       end

data/app/models/spotlight/blacklight_configuration.rb

@@ -74,6 +74,14 @@ module Spotlight
 
         config.current_exhibit = exhibit
 
+        config.document_presenter_class = lambda do |context|
+          if context.action_name == 'index'
+            config.index.document_presenter_class
+          else
+            config.show.document_presenter_class
+          end
+        end
+
         config.show.merge! show unless show.blank?
         config.index.merge! index unless index.blank?
         config.index.respond_to[:iiif_json] = true
@@ -84,22 +92,23 @@ module Spotlight
 
         unless config.curator_actions
           config.curator_actions ||= Blacklight::NestedOpenStructWithHashAccess.new(Blacklight::Configuration::ToolConfig)
-          config.curator_actions.save_search
-          config.curator_actions.bulk_actions
+          config.curator_actions.save_search!
+          config.curator_actions.bulk_actions!
         end
 
         unless config.bulk_actions
           config.bulk_actions ||= Blacklight::NestedOpenStructWithHashAccess.new(Blacklight::Configuration::ToolConfig)
 
-          config.bulk_actions.change_visibility
-          config.bulk_actions.add_tags
-          config.bulk_actions.remove_tags
+          config.bulk_actions.change_visibility!
+          config.bulk_actions.add_tags!
+          config.bulk_actions.remove_tags!
         end
 
         config.default_solr_params = config.default_solr_params.merge(default_solr_params)
 
         config.default_per_page = default_per_page if default_per_page
 
+        config.view.embed!
         config.view.embed.partials ||= ['openseadragon']
         config.view.embed.if = false
         config.view.embed.locals ||= { osd_container_class: '' }

data/app/models/spotlight/featured_image.rb

@@ -31,6 +31,8 @@ module Spotlight
       end
     end
 
+    after_save :bust_containing_resource_caches
+
     attr_accessor :upload_id
 
     def iiif_url
@@ -87,5 +89,36 @@ module Spotlight
     def iiif_service_base
       iiif_tilesource&.sub('/info.json', '')
     end
+
+    # This is an unfortunate work-around because:
+    #   - when this instance is updated through accepts_nested_attributes_for on a parent model,
+    #        the parent model is not necessarily updated (to bust caches, etc)
+    #   - this model doesn't have an association back to where it is being used
+    #   - these images can be used by multiple model instances (e.g. various translations of a feature page)
+    #   - this model is used by different types of models (polymorphic use), so belongs_to/has_many doesn't help
+    #   - potentially a problem with https://github.com/rails/rails/issues/26726
+    #
+    # Ideally, we might create a join table to connect this model to where it is used, but 🤷‍♂️
+    # Instead, we check each place this might be used and touch it
+    def bust_containing_resource_caches
+      if Rails.version > '6'
+        Spotlight::Search.where(thumbnail: self).or(Spotlight::Search.where(masthead: self)).touch_all
+        Spotlight::Page.where(thumbnail: self).touch_all
+        Spotlight::Exhibit.where(thumbnail: self).or(Spotlight::Exhibit.where(masthead: self)).touch_all
+        Spotlight::Contact.where(avatar: self).touch_all
+        Spotlight::Resources::Upload.where(upload: self).touch_all
+      else
+        bust_containing_resource_caches_rails5
+      end
+    end
+
+    # Rails 5 doesn't support touch_all.
+    def bust_containing_resource_caches_rails5
+      Spotlight::Search.where(thumbnail: self).or(Spotlight::Search.where(masthead: self)).find_each(&:touch)
+      Spotlight::Page.where(thumbnail: self).find_each(&:touch)
+      Spotlight::Exhibit.where(thumbnail: self).or(Spotlight::Exhibit.where(masthead: self)).find_each(&:touch)
+      Spotlight::Contact.where(avatar: self).find_each(&:touch)
+      Spotlight::Resources::Upload.where(upload: self).find_each(&:touch)
+    end
   end
 end

data/app/models/spotlight/page_configurations.rb

@@ -18,14 +18,12 @@ module Spotlight
     delegate :available_view_fields,
              :blacklight_config,
              :current_exhibit,
-             :document_show_link_field,
-             :index_fields,
-             :index_field_label,
              :spotlight,
              :t,
-             :view_label,
              to: :context
 
+    DOCUMENT_TITLE_KEY = '__spotlight_document_title___'
+
     attr_reader :context, :page
 
     def initialize(context:, page:)
@@ -35,7 +33,7 @@ module Spotlight
 
     def as_json(*)
       {
-        'blacklight-configuration-index-fields': available_index_fields,
+        'blacklight-configuration-index-fields': available_caption_fields,
         'blacklight-configuration-search-views': available_view_configs,
         'attachment-endpoint': attachment_endpoint,
         'autocomplete-exhibit-catalog-path': exhibit_autocomplete_endpoint,
@@ -48,15 +46,18 @@ module Spotlight
 
     private
 
-    def available_index_fields
-      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
+    def available_caption_fields
+      default_caption_fields + blacklight_config.index_fields.reject { |_k, v| v.caption == false }.map { |k, v| { key: k, label: v.display_label } }
+    end
 
+    def default_caption_fields
+      fields = []
+      fields << { key: DOCUMENT_TITLE_KEY, label: t(:'spotlight.pages.form.title_placeholder') } unless blacklight_config.index_fields.key? DOCUMENT_TITLE_KEY
       fields
     end
 
     def available_view_configs
-      available_view_fields.map { |k, _| { key: k, label: view_label(k) } }
+      available_view_fields.map { |k, v| { key: k, label: v.display_label(k) } }
     end
 
     def attachment_endpoint