blacklight-spotlight 6.0.0.rc1 → 6.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95ee8daf3a842b8230c41db5a322202457a2b6d5d6e59c86966d724915ef885d
-  data.tar.gz: fe5a12e8ecd14c9ee515d5c784e783ebc7861895ff1a07fe2c629e4c9ef1e989
+  metadata.gz: b2ccaa324ed47dd6da8761196f53797ba20acb7f6e4f608bde04232914893355
+  data.tar.gz: dba5c6c8b3321365e3f6e34fcabb02ff602076bc40db8e61d21e2030874af2c3
 SHA512:
-  metadata.gz: b2caff642a657a1f1d4c2cd2a3848325a11586840b8f2eda71dbf14b324710b5ae1d268f61c2ea4f23167ecffd5b72887e5c2c27e8d95ef287d3542b74bf9551
-  data.tar.gz: e1d5cbfc083e0f6c7f583cac20c64fb069076d4cd954c8a9d8c92cbfbb8baed7c527cad635e35aac9573871a31b22538111ee624509a244b45e1f9a85eac8a27
+  metadata.gz: 9bc205606b6d53e8550be7eb271ceb3521a26d37c611234eda479a9105d28f59be9b5738ff9543ade508726f80098f76c0d2c5858582e8bd1d590e2982e72969
+  data.tar.gz: 77e04246b8932d4b6a243090f4a56de2375437b988cbc13d96717db70f2979017cf13f004b895da9b2fc850ac1c09d2fc9ed8cd53e3ea51e3517761e96280803

data/README.md

@@ -75,6 +75,27 @@ Go to http://localhost:3000 in your browser.
 
 Spotlight introduces functionality that depends on being able to send emails to exhibit curators and contacts. Be sure to configure your application's environments appropriately (see the Rails Guide for [Action Mailer Configuration](https://guides.rubyonrails.org/v7.2/action_mailer_basics.html#action-mailer-configuration)).
 
+### Cleaning up job trackers
+
+Spotlight records a `Spotlight::JobTracker` row for each background job it runs (reindexing, CSV uploads, bulk updates, and so on) so curators can see the job's progress. These rows are never removed automatically, so the `spotlight_job_trackers` table grows over time.
+
+`Spotlight::CleanupJobTrackersJob` deletes completed job trackers that were last updated longer ago than `Spotlight::Engine.config.reindex_progress_window` (one hour by default). Failed and in-progress job trackers are kept. Spotlight does not enqueue this job itself, so schedule it to run periodically (for example, daily) with whatever scheduler your application uses.
+
+With [Solid Queue](https://github.com/rails/solid_queue), add it to `config/recurring.yml`:
+
+```yaml
+production:
+  cleanup_job_trackers:
+    class: Spotlight::CleanupJobTrackersJob
+    schedule: every day at 3am
+```
+
+Or, with cron:
+
+```sh
+0 3 * * * cd /path/to/app && bin/rails runner -e production 'Spotlight::CleanupJobTrackersJob.perform_later'
+```
+
 See the [Spotlight wiki](https://github.com/projectblacklight/spotlight/wiki) for more detailed information on configuring Spotlight.
 
 ## Translations

data/app/components/spotlight/custom_field_form_group_component.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Renders an exhibit custom field on the catalog edit and upload forms through its configured component
+  class CustomFieldFormGroupComponent < ViewComponent::Base
+    attr_reader :form, :field, :value, :inline
+
+    def initialize(form:, field:, value: nil, inline: false)
+      @form = form
+      @field = field
+      @value = value
+      @inline = inline
+      super()
+    end
+
+    def call
+      return render_deprecated_partial if deprecated_partial?
+
+      render field.component.new(form:, id: field.slug, label: field.label, value:, field_type: field.form_field_type,
+                                 multiple: field.is_multiple?, readonly: field.readonly_field?, inline:)
+    end
+
+    private
+
+    # Applications could previously customize custom field inputs by overriding these partials
+    def deprecated_partial
+      "spotlight/custom_fields/form_group/#{field.field_type}"
+    end
+
+    def deprecated_partial?
+      helpers.lookup_context.exists?(deprecated_partial, [], true)
+    end
+
+    def render_deprecated_partial
+      Spotlight.deprecator.warn "Rendering deprecated partial #{deprecated_partial}. " \
+                                'Configure a component in Spotlight::Engine.config.custom_field_types instead'
+      render(partial: deprecated_partial, locals: { inline:, f: form, field:, value: })
+    end
+  end
+end

data/app/components/spotlight/edit_sidecar_component.html.erb

@@ -0,0 +1,18 @@
+<%= form.fields_for :sidecar, sidecar do |c| %>
+  <%= c.fields_for :data do |d| %>
+    <% if document.uploaded_resource? %>
+      <%= d.fields_for :configured_fields do |e| %>
+        <% upload_fields.each do |config| %>
+          <%= render Spotlight::UploadFieldFormGroupComponent.new(form: e, config:, value: upload_field_value(config)) %>
+        <% end %>
+      <% end %>
+    <% end %>
+
+    <% custom_fields.each do |field| %>
+      <%= render Spotlight::CustomFieldFormGroupComponent.new(form: d, field:, value: custom_field_value(field)) %>
+      <% unless field.configured_to_display? %>
+        <p class="bg-warning form-text"><%= blank_field_warning %></p>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/spotlight/edit_sidecar_component.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Renders the sidecar (exhibit-specific metadata) fields on the catalog edit form
+  class EditSidecarComponent < ViewComponent::Base
+    attr_reader :form, :document, :exhibit
+
+    def initialize(form:, document:, exhibit:)
+      @form = form
+      @document = document
+      @exhibit = exhibit
+      super()
+    end
+
+    def upload_fields
+      Spotlight::Resources::Upload.fields(exhibit)
+    end
+
+    def sidecar
+      @sidecar ||= document.sidecar(exhibit)
+    end
+
+    # Using `includes(:exhibit)` to ensure all fields are using the same exhibit object to take advantage of memoization
+    def custom_fields
+      exhibit.custom_fields.includes(:exhibit)
+    end
+
+    def upload_field_value(config)
+      (sidecar.data['configured_fields'] || {})[config.field_name.to_s]
+    end
+
+    def custom_field_value(field)
+      sidecar.data[field.slug.to_s] || sidecar.data[field.field.to_s]
+    end
+
+    def blank_field_warning
+      t('spotlight.catalog.edit_sidecar.blank_field_warning_html',
+        link: link_to(t('spotlight.configuration.sidebar.metadata'), helpers.spotlight.edit_exhibit_metadata_configuration_path(exhibit)))
+    end
+  end
+end

data/app/components/spotlight/sidecar_form_field_component.html.erb

@@ -0,0 +1,18 @@
+<%= tag.div class: wrapper_class do %>
+  <% value_list.each_with_index do |v, index| %>
+    <%= form.label field_id, label, namespace: "f#{index}", class: label_class(hidden: index.positive?) %>
+    <%= tag.div class: value_wrapper_class(first: index.zero?) do %>
+      <%= render_input(value: v, namespace: "f#{index}") %>
+    <% end %>
+  <% end %>
+
+  <% if multiple && !readonly %>
+    <%= content_tag :template, id: template_id do %>
+      <%= form.label field_id, label, class: label_class(hidden: true) %>
+      <%= tag.div class: value_wrapper_class(first: false) do %>
+        <%= render_input %>
+      <% end %>
+    <% end %>
+    <%= content_tag :button, t('helpers.action.add_another'), class: 'btn btn-info btn-sm col-auto h-100', data: { action: 'add-another', template_id: template_id } %>
+  <% end %>
+<% end %>

data/app/components/spotlight/sidecar_form_field_component.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Allow for mulivalued field entry on catalog edit and upload forms
+  class SidecarFormFieldComponent < ViewComponent::Base
+    attr_reader :form, :field_id, :label, :value_list, :multiple, :readonly, :inline
+
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(form:, id:, label:, value: nil, field_type: 'text_field', multiple: false, readonly: false, inline: false)
+      super()
+      @form = form
+      @field_id = id
+      @label = label
+      @value_list = Array(value || '')
+      @field_type = field_type.to_s
+      @multiple = multiple
+      @readonly = readonly
+      @inline = inline
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    def render_input(value: nil, namespace: nil)
+      options = { value: value, class: "form-control field-#{field_id}" }
+
+      # Add multiple to options only if multiple is true
+      options[:multiple] = true if multiple
+      # Add readonly to options only if readonly is true
+      options[:readonly] = true if readonly
+      # Add namespace to options only if namespace is present
+      options[:namespace] = namespace if namespace.present?
+
+      form.send("#{@field_type}_without_bootstrap", field_id, **options)
+    end
+
+    def template_id
+      "spotlight-field-template-#{field_id}"
+    end
+
+    # add_another.js finds the field's existing values through the .form-group wrapper
+    def wrapper_class
+      inline ? 'form-group mb-3 row gy-2' : 'form-group mb-3'
+    end
+
+    def label_class(hidden: false)
+      classes = inline ? ['col-form-label', label_col] : ['form-label']
+      classes << 'visually-hidden' if hidden
+      classes.join(' ')
+    end
+
+    # In a horizontal form only the first input sits beside the label, so later inputs are offset to line up under it
+    def value_wrapper_class(first:)
+      if inline
+        first ? control_col : "#{offset_col} #{control_col}"
+      elsif multiple
+        'mb-2'
+      end
+    end
+
+    def label_col
+      form&.label_col
+    end
+
+    def control_col
+      form&.control_col
+    end
+
+    def offset_col
+      label_col.sub('col', 'offset')
+    end
+  end
+end

data/app/components/spotlight/upload_field_form_group_component.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Renders an upload field (Spotlight::UploadFieldConfig) on the catalog edit and upload forms through its configured component
+  class UploadFieldFormGroupComponent < ViewComponent::Base
+    attr_reader :form, :config, :value, :inline
+
+    def initialize(form:, config:, value: nil, inline: false)
+      @form = form
+      @config = config
+      @value = value
+      @inline = inline
+      super()
+    end
+
+    def call
+      render config.component.new(
+        form:,
+        id: config.field_name,
+        label:,
+        value:,
+        field_type: config.form_field_type,
+        multiple: config.is_multiple?,
+        inline:
+      )
+    end
+
+    def label
+      solr_field = Array(config.solr_field || config.field_name).first.to_s
+      helpers.blacklight_config.index_fields[solr_field]&.label || config.label || solr_field
+    end
+  end
+end

data/app/controllers/spotlight/browse_controller.rb

@@ -120,10 +120,6 @@ module Spotlight
       Spotlight::Engine.config.default_browse_index_view_type
     end
 
-    def render_save_this_search?
-      false
-    end
-
     def render_curator_actions?
       false
     end

data/app/controllers/spotlight/catalog_controller.rb

@@ -199,7 +199,7 @@ module Spotlight
 
     def uploaded_resource_params
       if @document.uploaded_resource?
-        [{ configured_fields: Spotlight::Resources::Upload.fields(current_exhibit).map(&:field_name) }]
+        [{ configured_fields: Spotlight::Resources::Upload.as_strong_params(current_exhibit) }]
       else
         []
       end

data/app/controllers/spotlight/resources/upload_controller.rb

@@ -48,7 +48,7 @@ module Spotlight
       end
 
       def data_param_keys
-        Spotlight::Resources::Upload.fields(current_exhibit).map(&:field_name) +
+        Spotlight::Resources::Upload.as_strong_params(current_exhibit) +
           current_exhibit.custom_fields.as_strong_params
       end
     end

data/app/controllers/spotlight/solr_controller.rb

@@ -50,7 +50,7 @@ module Spotlight
 
         create_or_update_solr_document_sidecar(doc, r)
 
-        doc.to_solr.merge(@exhibit.solr_data).merge(other_field_data)
+        doc.to_solr.stringify_keys.merge(@exhibit.solr_data.stringify_keys).merge(other_field_data)
       end
     end
 
@@ -69,6 +69,10 @@ module Spotlight
     end
 
     def create_or_update_solr_document_sidecar(doc, data)
+      # The sidecar already records the unique key as its document_id. (The payload is a raw
+      # Solr document, so here "id" is always the unique key; in other sidecar data it may be
+      # the slug of an "ID" custom field.)
+      data = data.except(doc.class.unique_key.to_s)
       return if data.blank?
 
       sidecar = doc.sidecar(@exhibit)

data/app/helpers/spotlight/application_helper.rb

@@ -136,13 +136,6 @@ module Spotlight
       selected_view || default_document_index_view_type
     end
 
-    # Return the list of views that are configured to display for a block
-    def selected_search_block_views(block)
-      block.as_json[:data].select do |_key, value|
-        value == 'on'
-      end.keys.map(&:to_s)
-    end
-
     # Create checkbox for selecting/deselecting metadata fields for a given view in metadata configuration
     def select_deselect_action(id)
       check_box_tag(
@@ -154,26 +147,10 @@ module Spotlight
       )
     end
 
-    def uploaded_field_label(config)
-      solr_field = Array(config.solr_field || config.field_name).first.to_s
-      blacklight_config.index_fields[solr_field]&.label || config.label || t(".#{solr_field}")
-    end
-
     def available_view_fields
       current_exhibit.blacklight_configuration.default_blacklight_config.view.to_h.reject { |_k, v| v.if == false }
     end
 
-    def render_search_bar
-      return super if defined?(super)
-
-      render((blacklight_config&.view_config(document_index_view_type)&.search_bar_component || Blacklight::SearchBarComponent).new(
-               url: search_action_url,
-               advanced_search_url: search_action_url(action: 'advanced_search'),
-               params: search_state.params_for_search.except(:qt),
-               autocomplete_path: suggest_index_catalog_path
-             ))
-    end
-
     def render_constraints(localized_params = nil, local_search_state = nil)
       return super if defined?(super)
 

data/app/helpers/spotlight/crud_link_helpers.rb

@@ -20,24 +20,12 @@ module Spotlight
       link_to action_default_value(model, :view), link, link_to_options
     end
 
-    def create_link(model, *args)
-      link_to_options = args.extract_options!
-      link = args.first || polymorphic_path([spotlight, model], action: :new)
-      link_to action_default_value(model), link, link_to_options
-    end
-
     def exhibit_create_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || polymorphic_path([spotlight, current_exhibit, model], action: :new)
       link_to action_default_value(model), link, link_to_options
     end
 
-    def edit_link(model, *args)
-      link_to_options = args.extract_options!
-      link = args.first || polymorphic_path([spotlight, model], action: :edit)
-      link_to action_default_value(model), link, link_to_options
-    end
-
     def exhibit_edit_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || polymorphic_path([spotlight, model.exhibit, model], action: :edit)

data/app/jobs/spotlight/add_uploads_from_csv.rb

@@ -79,7 +79,9 @@ module Spotlight
     end
 
     def multivalued_fields(exhibit)
-      exhibit.custom_fields.filter_map { |field| field.slug.to_s if field.is_multiple? }
+      upload_fields = Spotlight::Resources::Upload.fields(exhibit).filter_map { |field| field.field_name.to_s if field.is_multiple? }
+      custom_fields = exhibit.custom_fields.filter_map { |field| field.slug.to_s if field.is_multiple? }
+      upload_fields + custom_fields
     end
   end
 end

data/app/jobs/spotlight/cleanup_job_trackers_job.rb

@@ -2,12 +2,14 @@
 
 module Spotlight
   ###
-  # Calls the #set_default_thumbnail method
-  # on the object passed in and calls save
+  # Deletes completed job trackers that were last updated before
+  # Spotlight::Engine.config.reindex_progress_window. Spotlight does not
+  # enqueue this job itself; applications should schedule it to run
+  # periodically (see the README).
   ###
   class CleanupJobTrackersJob < Spotlight::ApplicationJob
     def perform
-      Spotlight::JobTracker.where(status: 'completed', updated_at: Time.zone.at(0)...Spotlight::Engine.config.reindex_progress_window.minutes.ago).delete_all
+      Spotlight::JobTracker.where(status: 'completed', updated_at: Time.zone.at(0)...Spotlight::Engine.config.reindex_progress_window.ago).delete_all
     end
   end
 end

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

@@ -54,7 +54,7 @@ module Spotlight
     end
 
     def update(current_exhibit, new_attributes)
-      attributes = convert_incoming_attributes(new_attributes)
+      attributes = new_attributes.stringify_keys
 
       custom_data = attributes.delete('sidecar')
       tags = attributes.delete('exhibit_tag_list')
@@ -117,10 +117,6 @@ module Spotlight
         self[self.class.resource_type_field].include?('spotlight/resources/uploads')
     end
 
-    def attribute_present?(*_args)
-      false
-    end
-
     protected
 
     def tags_to_solr
@@ -145,48 +141,6 @@ module Spotlight
         self.class.exhibit_slug_field => slugs
       }
     end
-
-    def convert_incoming_attributes(attributes)
-      attributes = attributes.stringify_keys
-
-      # convert blank strings to nil
-      attributes = deep_transform_values(attributes, &:presence)
-
-      # trim excess nils from arrays
-      deep_compact(attributes)
-    end
-
-    def deep_transform_values(object, &)
-      # Available in Rails 6
-      if object.respond_to?(:deep_transform_values)
-        object.deep_transform_values(&)
-      else
-        _deep_transform_values(object, &)
-      end
-    end
-
-    # Shimmed from Rails 6
-    def _deep_transform_values(object, &block)
-      case object
-      when Hash
-        object.transform_values { |value| deep_transform_values(value, &block) }
-      when Array
-        object.map { |e| deep_transform_values(e, &block) }
-      else
-        yield(object)
-      end
-    end
-
-    def deep_compact(object)
-      case object
-      when Hash
-        object.transform_values { |value| deep_compact(value) }
-      when Array
-        object.compact
-      else
-        object
-      end
-    end
   end
 end
 

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

@@ -13,10 +13,6 @@ module SirTrevorRails
         @solr_helper = solr_helper
       end
 
-      def search_options(id)
-        items.detect { |x| x[:id] == id } || {}
-      end
-
       def searches
         @searches ||= parent.exhibit.searches.published.where(slug: item_ids).sort do |a, b|
           ordered_items.index(a.slug) <=> ordered_items.index(b.slug)

data/app/models/spotlight/custom_field.rb

@@ -59,6 +59,19 @@ module Spotlight
         end
     end
 
+    # The component used to render the field on the upload and edit forms,
+    # from the `component` option of the field's entry in Spotlight::Engine.config.custom_field_types
+    def component
+      component = field_type_config[:component]
+      return Spotlight::SidecarFormFieldComponent if component.blank?
+
+      component.is_a?(String) ? component.constantize : component
+    end
+
+    def form_field_type
+      field_type_config.fetch(:form_field_type, :text_field)
+    end
+
     def solr_field
       if field&.starts_with?(solr_field_prefix)
         # backwards compatibility with pre-0.9 custom fields
@@ -70,6 +83,10 @@ module Spotlight
 
     protected
 
+    def field_type_config
+      Spotlight::Engine.config.custom_field_types.fetch(field_type.to_s.to_sym, {})
+    end
+
     def blacklight_configuration
       exhibit&.blacklight_configuration
     end

data/app/models/spotlight/job_tracker.rb

@@ -43,12 +43,6 @@ module Spotlight
       @job_status ||= ActiveJob::Status.get(job_id)
     end
 
-    def progress_label
-      return number_with_delimiter(progress) unless total?
-
-      "#{number_with_delimiter(progress)} / #{number_with_delimiter(total)}"
-    end
-
     def progress
       data[:progress] || job_status[:progress] || 0
     end
@@ -61,12 +55,6 @@ module Spotlight
       total(default: 0).positive?
     end
 
-    def percent
-      return nil unless total?
-
-      (100.0 * progress) / total
-    end
-
     def status
       @status ||= super
       @status ||= 'missing'
@@ -104,11 +92,5 @@ module Spotlight
         self
       end
     end
-
-    private
-
-    def number_with_delimiter(*)
-      ActiveSupport::NumberHelper.number_to_delimited(*)
-    end
   end
 end

data/app/models/spotlight/resources/iiif_manifest.rb

@@ -28,10 +28,6 @@ module Spotlight
         solr_hash
       end
 
-      def with_exhibit(e)
-        @exhibit = e
-      end
-
       def compound_id
         Digest::MD5.hexdigest("#{exhibit.id}-#{url}")
       end

data/app/models/spotlight/resources/upload.rb

@@ -23,6 +23,12 @@ module Spotlight
         end
       end
 
+      def self.as_strong_params(exhibit)
+        fields(exhibit).map do |field|
+          field.is_multiple? ? { field.field_name => [] } : field.field_name
+        end
+      end
+
       def self.indexing_pipeline
         @indexing_pipeline ||= super.dup.tap do |pipeline|
           pipeline.transforms = [

data/app/models/spotlight/search.rb

@@ -75,10 +75,6 @@ module Spotlight
 
     delegate :blacklight_config, to: :exhibit
 
-    def display_masthead?
-      masthead&.display?
-    end
-
     def search_params
       search_service.search_builder.with(search_state).merge(facet: false)
     end

data/app/models/spotlight/solr_document_sidecar.rb

@@ -22,6 +22,8 @@ module Spotlight
 
     delegate :has_key?, :key?, to: :data
 
+    before_save :strip_blank_values_from_data
+
     def to_solr
       { document.class.unique_key.to_sym => document.id,
         visibility_field => public? }
@@ -48,6 +50,22 @@ module Spotlight
 
     private
 
+    # Remove blank entries (e.g. from an empty "Add another value" input) from multivalued fields
+    def strip_blank_values_from_data
+      self.data = strip_blank_values(data)
+    end
+
+    def strip_blank_values(value)
+      case value
+      when Array
+        value.compact_blank
+      when Hash
+        value.transform_values { |v| strip_blank_values(v) }
+      else
+        value
+      end
+    end
+
     def document_type_class
       return default_document_type unless document_type.is_a?(String)
 

data/app/views/spotlight/catalog/_edit_default.html.erb

@@ -9,7 +9,7 @@
     <%= r.url_field :url, type: "file", help: t('.url-field.help', extensions: Spotlight::Engine.config.allowed_upload_extensions.join(' ')), label: "File" %>
   <% end if document.uploaded_resource? %>
 
-  <%= render partial: 'edit_sidecar', locals: { document: document, f: f } %>
+  <%= render Spotlight::EditSidecarComponent.new(form: f, document: document, exhibit: current_exhibit) %>
 
   <% if can? :tag, current_exhibit %>
   <div class="edit-tags">

data/app/views/spotlight/resources/upload/_form.html.erb

@@ -2,11 +2,11 @@
   <%= f.url_field :url, type: "file", help: t('.url-field.help', extensions: Spotlight::Engine.config.allowed_upload_extensions.join(' ')), label: "File" %>
   <%= f.fields_for :data do |d| %>
     <% Spotlight::Resources::Upload.fields(current_exhibit).each do |config| %>
-      <%= d.send(config.form_field_type, config.field_name, label: uploaded_field_label(config)) %>
+      <%= render Spotlight::UploadFieldFormGroupComponent.new(form: d, config:, inline: true) %>
     <% end %>
 
     <% current_exhibit.custom_fields.each do |custom_field| %>
-      <%= render partial: "spotlight/custom_fields/form_group/#{custom_field.field_type}", locals: { inline: true, f: d, field: custom_field, value: nil } %>
+      <%= render Spotlight::CustomFieldFormGroupComponent.new(form: d, field: custom_field, inline: true) %>
     <% end %>
   <% end %>
   <div class="form-actions">

data/config/i18n-tasks.yml

@@ -78,7 +78,7 @@ ignore_unused:
   # TODO Look into these as its unclear
   - activerecord.models.spotlight.page
   #- # perhaps removed here? https://github.com/projectblacklight/spotlight/commit/d4fdf04565ab3d648f0cb2a1238d84f262509fcd
-  - devise.mailer.*.* # Does this even work? https://github.com/projectblacklight/spotlight/blob/main/app/mailers/spotlight/invitation_mailer.rb#L16
+  - devise.mailer.*.*
   - helpers.submit.solr_document.{batch_error,batch_updated,create,created,destroyed,submit,update,updated} # Do we need this?
   - helpers.submit.user.{batch_error,batch_updated,create,created,destroyed,submit,update,updated} # Do we need this?
   - helpers.action.destroy # no idea here

data/config/locales/spotlight.en.yml

@@ -665,12 +665,10 @@ en:
         all: All
     exhibits_admin_invitation_mailer:
       invitation_instructions:
-        accept: Accept invitation
         accept_invitation: You can accept this invitation by selecting the link below.
         hello: Hello!
         ignore: If you don't want to accept the invitation, please ignore this email. Your exhibits administrator account won't be created until you access the link above.
         someone_invited_you: The Exhibits Administrator has invited you to help manage exhibits.
-        subject: Invitation to manage \"%{exhibit_name}\"
     feature_pages:
       page_options:
         published: Publish
@@ -724,8 +722,6 @@ en:
         hello: Hello!
         ignore: If you don't want to accept the invitation, please ignore this email. Your account won't be created until you access the link above.
         someone_invited_you: The Exhibits Administrator has invited you to help work on the "%{exhibit_name}" exhibit.
-        subject: Invitation to manage \"%{exhibit_name}\"
-        visit: Visit exhibit
     job_trackers:
       show:
         headers:

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

@@ -37,10 +37,18 @@
 # Spotlight::Engine.config.solr_fields.string_suffix = '_ssim'.freeze
 # Spotlight::Engine.config.solr_fields.text_suffix = '_tesim'.freeze
 # Spotlight::Engine.config.resource_global_id_field = :"#{config.solr_fields.prefix}spotlight_resource_id#{config.solr_fields.string_suffix}"
+# Exhibit custom field types; `form_field_type` and `component` control how the field renders on the upload and edit forms
+# Spotlight::Engine.config.custom_field_types = {
+#   vocab: { suffix: '_ssim', facetable: true },
+#   text: { suffix: '_tesim', form_field_type: :text_area, component: 'Spotlight::SidecarFormFieldComponent' }
+# }
 # Spotlight::Engine.config.full_image_field = :full_image_url_ssm
 # Spotlight::Engine.config.thumbnail_field = :thumbnail_url_ssm
 
 # ==> Uploaded item configuration
+# Add `is_multiple: true` to Spotlight::UploadFieldConfig arguments to allow for multivalued field data
+# Add `component: MyFieldComponent` to render the field with a custom component (default: Spotlight::SidecarFormFieldComponent)
+# If is_multiple is enabled, Spotlight will send the field to Solr as an array, so ensure that your Solr configurations support this
 # Spotlight::Engine.config.upload_fields = [
 #   Spotlight::UploadFieldConfig.new(
 #     field_name: Spotlight::Engine.config.upload_description_field,

data/lib/spotlight/engine.rb

@@ -117,10 +117,13 @@ module Spotlight
     config.solr_fields.string_suffix = '_ssim'
     config.solr_fields.text_suffix = '_tesim'
 
-    # Suffixes for exhibit-specific solr fields
+    # Suffixes for exhibit-specific solr fields. Each type may also set:
+    #   form_field_type: the form builder method used for the input (default: :text_field)
+    #   component: the component used to render the field on the upload and edit forms
+    #              (default: Spotlight::SidecarFormFieldComponent)
     config.custom_field_types = {
       vocab: { suffix: '_ssim', facetable: true },
-      text: { suffix: '_tesim' }
+      text: { suffix: '_tesim', form_field_type: :text_area }
     }
 
     config.resource_global_id_field = :"#{config.solr_fields.prefix}spotlight_resource_id#{config.solr_fields.string_suffix}"

data/lib/spotlight/upload_field_config.rb

@@ -9,13 +9,18 @@ module Spotlight
   class UploadFieldConfig
     attr_reader :blacklight_options, :field_name, :form_field_type
 
-    def initialize(field_name:, blacklight_options: {}, form_field_type: :text_field, label: nil, solr_fields: nil)
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(field_name:, blacklight_options: {}, form_field_type: :text_field, solr_fields: nil, label: nil, is_multiple: false,
+                   component: nil)
       @blacklight_options = blacklight_options
       @field_name = field_name
       @form_field_type = form_field_type
       @solr_fields = solr_fields
       @label = label || field_name
+      @is_multiple = is_multiple
+      @component = component
     end
+    # rubocop:enable Metrics/ParameterLists
 
     # Allows a proc to be set as the label
     def label
@@ -24,6 +29,19 @@ module Spotlight
       @label
     end
 
+    # rubocop:disable Naming/PredicatePrefix
+    def is_multiple?
+      @is_multiple
+    end
+    # rubocop:enable Naming/PredicatePrefix
+
+    # The component used to render the field on the upload and edit forms
+    def component
+      return Spotlight::SidecarFormFieldComponent if @component.blank?
+
+      @component.is_a?(String) ? @component.constantize : @component
+    end
+
     # aliasing for backwards compatability and consistency with blacklight config
     alias solr_field field_name
 

data/lib/spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotlight
-  VERSION = '6.0.0.rc1'
+  VERSION = '6.0.0.rc2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 6.0.0.rc1
+  version: 6.0.0.rc2
 platform: ruby
 authors:
 - Chris Beer
@@ -52,7 +52,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.7.0
+        version: 8.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '10'
@@ -62,7 +62,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.7.0
+        version: 8.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '10'
@@ -72,7 +72,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -432,22 +432,16 @@ dependencies:
   name: view_component
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.66'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.66'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: axe-core-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -793,12 +787,9 @@ files:
 - app/components/blacklight/icons/edit_component.rb
 - app/components/blacklight/icons/error_component.rb
 - app/components/blacklight/icons/highlight_off_component.rb
-- app/components/blacklight/icons/info_component.rb
 - app/components/blacklight/icons/pause_component.rb
 - app/components/blacklight/icons/play_arrow_component.rb
 - app/components/blacklight/icons/warning_component.rb
-- app/components/blacklight/icons/zoom_in_component.rb
-- app/components/blacklight/icons/zoom_out_component.rb
 - app/components/spotlight/admin_users/email_component.html.erb
 - app/components/spotlight/admin_users/email_component.rb
 - app/components/spotlight/admin_users/exhibit_roles_component.html.erb
@@ -813,9 +804,12 @@ files:
 - app/components/spotlight/breadcrumbs_component.rb
 - app/components/spotlight/bulk_action_component.html.erb
 - app/components/spotlight/bulk_action_component.rb
+- app/components/spotlight/custom_field_form_group_component.rb
 - app/components/spotlight/document_admin_table_component.html.erb
 - app/components/spotlight/document_admin_table_component.rb
 - app/components/spotlight/document_component.rb
+- app/components/spotlight/edit_sidecar_component.html.erb
+- app/components/spotlight/edit_sidecar_component.rb
 - app/components/spotlight/edit_view_links_component.html.erb
 - app/components/spotlight/edit_view_links_component.rb
 - app/components/spotlight/exhibit_navbar_component.html.erb
@@ -830,6 +824,8 @@ files:
 - app/components/spotlight/save_search_component.rb
 - app/components/spotlight/select_image_component.html.erb
 - app/components/spotlight/select_image_component.rb
+- app/components/spotlight/sidecar_form_field_component.html.erb
+- app/components/spotlight/sidecar_form_field_component.rb
 - app/components/spotlight/skip_link_component.rb
 - app/components/spotlight/solr_document_legacy_embed_component.html.erb
 - app/components/spotlight/solr_document_legacy_embed_component.rb
@@ -844,6 +840,7 @@ files:
 - app/components/spotlight/translations/subheading_component.rb
 - app/components/spotlight/uneditable_non_default_language_component.html.erb
 - app/components/spotlight/uneditable_non_default_language_component.rb
+- app/components/spotlight/upload_field_form_group_component.rb
 - app/controllers/concerns/spotlight/base.rb
 - app/controllers/concerns/spotlight/catalog.rb
 - app/controllers/concerns/spotlight/config.rb
@@ -986,7 +983,6 @@ files:
 - app/mailers/spotlight/confirmation_mailer.rb
 - app/mailers/spotlight/contact_mailer.rb
 - app/mailers/spotlight/indexing_complete_mailer.rb
-- app/mailers/spotlight/invitation_mailer.rb
 - app/models/ability.rb
 - app/models/breadcrumb.rb
 - app/models/concerns/spotlight/access_controls_enforcement_search_builder.rb
@@ -1093,7 +1089,6 @@ files:
 - app/views/catalog/_bulk_actions.html.erb
 - app/views/catalog/_change_visibility.html.erb
 - app/views/catalog/_curator_actions.html.erb
-- app/views/catalog/_image_default.html.erb
 - app/views/catalog/_remove_tags.html.erb
 - app/views/catalog/_save_search.html.erb
 - app/views/devise/confirmations/new.html.erb
@@ -1133,12 +1128,10 @@ files:
 - app/views/spotlight/bulk_updates/_upload.html.erb
 - app/views/spotlight/bulk_updates/edit.html.erb
 - app/views/spotlight/catalog/_admin_header.html.erb
-- app/views/spotlight/catalog/_curation_mode_toggle_default.html.erb
 - app/views/spotlight/catalog/_document.html.erb
 - app/views/spotlight/catalog/_document_admin_table.html.erb
 - app/views/spotlight/catalog/_document_visibility_control.html.erb
 - app/views/spotlight/catalog/_edit_default.html.erb
-- app/views/spotlight/catalog/_edit_sidecar.html.erb
 - app/views/spotlight/catalog/_reindex_progress_panel.html.erb
 - app/views/spotlight/catalog/admin.html.erb
 - app/views/spotlight/catalog/edit.html.erb
@@ -1152,8 +1145,6 @@ files:
 - app/views/spotlight/contacts/new.html.erb
 - app/views/spotlight/custom_fields/_form.html.erb
 - app/views/spotlight/custom_fields/edit.html.erb
-- app/views/spotlight/custom_fields/form_group/_text.html.erb
-- app/views/spotlight/custom_fields/form_group/_vocab.html.erb
 - app/views/spotlight/custom_fields/new.html.erb
 - app/views/spotlight/custom_search_fields/_form.html.erb
 - app/views/spotlight/custom_search_fields/edit.html.erb
@@ -1192,7 +1183,6 @@ files:
 - app/views/spotlight/home_pages/_page_options.html.erb
 - app/views/spotlight/home_pages/_sidebar.html.erb
 - app/views/spotlight/indexing_complete_mailer/documents_indexed.html.erb
-- app/views/spotlight/invitation_mailer/exhibit_invitation_notification.html.erb
 - app/views/spotlight/job_trackers/show.html.erb
 - app/views/spotlight/locks/_lock.html.erb
 - app/views/spotlight/metadata_configurations/_metadata_field.html.erb

data/app/components/blacklight/icons/info_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Blacklight
-  module Icons
-    # Icon for Info
-    class InfoComponent < Blacklight::Icons::IconComponent
-      self.svg = <<~SVG
-        <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
-          <path fill="none" d="M0 0h24v24H0V0z"/>
-          <path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm1 15h-2v-6h2v6zm0-8h-2V7h2v2z"/>
-        </svg>
-      SVG
-    end
-  end
-end

data/app/components/blacklight/icons/zoom_in_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Blacklight
-  module Icons
-    # Icon for ZoomIn
-    class ZoomInComponent < Blacklight::Icons::IconComponent
-      self.svg = <<~SVG
-        <svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24">
-          <path d="M0 0h24v24H0V0z" fill="none"/>
-          <path d="M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14zm.5-7H9v2H7v1h2v2h1v-2h2V9h-2z"/>
-        </svg>
-      SVG
-    end
-  end
-end

data/app/components/blacklight/icons/zoom_out_component.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Blacklight
-  module Icons
-    # Icon for ZoomOut
-    class ZoomOutComponent < Blacklight::Icons::IconComponent
-      self.svg = <<~SVG
-        <svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24">
-          <path d="M0 0h24v24H0V0z" fill="none"/>
-          <path d="M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14zM7 9h5v1H7V9z"/>
-        </svg>
-      SVG
-    end
-  end
-end

data/app/mailers/spotlight/invitation_mailer.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Spotlight
-  # Mailer for contacting new exhibit curators or administrators
-  class InvitationMailer < ActionMailer::Base
-    include Devise::Mailers::Helpers
-
-    def exhibit_invitation_notification(role)
-      initialize_from_record(role.user)
-      @role = role
-      @key = if @role.resource.is_a?(Spotlight::Site)
-               'exhibits_admin_invitation_mailer'
-             else
-               'invitation_mailer'
-             end
-      mail(to: role.user.email,
-           from: mailer_sender(devise_mapping),
-           subject: I18n.t("spotlight.#{@key}.invitation_instructions.subject", exhibit_name: @role.resource.title))
-    end
-  end
-end

data/app/views/catalog/_image_default.html.erb

@@ -1,6 +0,0 @@
-<%# looks suspiciously similar to blacklight's _thumbnail, but skips all the search context + linking -%>
-<%- if has_thumbnail?(document) && tn = render_thumbnail_tag(document, { alt: '' }, :suppress_link => true) %>
-<div class="img-thumbnail">
-  <%= tn %>
-</div>
-<%- end %>

data/app/views/spotlight/catalog/_curation_mode_toggle_default.html.erb

@@ -1 +0,0 @@
-<%= exhibit_edit_link document, [:edit, current_exhibit, document], class: 'float-end btn btn-primary' if can?(:curate, current_exhibit) and !current_page? [:edit, current_exhibit, document] %>

data/app/views/spotlight/catalog/_edit_sidecar.html.erb

@@ -1,24 +0,0 @@
-<%= f.fields_for :sidecar, document.sidecar(current_exhibit) do |c| %>
-  <%= c.fields_for :data do |d| %>
-    <% if document.uploaded_resource? %>
-      <%= d.fields_for :configured_fields do |e| %>
-        <% Spotlight::Resources::Upload.fields(current_exhibit).each do |config| %>
-          <%= e.send(config.form_field_type, config.field_name, value: (document.sidecar(current_exhibit).data["configured_fields"] || {})[config.field_name.to_s], label: uploaded_field_label(config)) %>
-        <% end %>
-      <% end %>
-    <% end %>
-
-    <%# Using `includes(:exhibit)` to ensure all fields are using the same exhibit object to take advantage of memoization %>
-    <% current_exhibit.custom_fields.includes(:exhibit).each do |field| %>
-      <% data = document.sidecar(current_exhibit).data %>
-      <%= render partial: "spotlight/custom_fields/form_group/#{field.field_type}", locals: { f: d, field: field, value: data[field.slug.to_s] || data[field.field.to_s] } %>
-
-      <% unless field.configured_to_display? %>
-        <p class="bg-warning form-text">
-          <%= t(:'.blank_field_warning_html',
-                link: link_to(t(:'spotlight.configuration.sidebar.metadata'), spotlight.edit_exhibit_metadata_configuration_path(current_exhibit))) %>
-        </p>
-      <% end %>
-    <% end %>
-  <% end %>
-<% end %>

data/app/views/spotlight/custom_fields/form_group/_text.html.erb

@@ -1,23 +0,0 @@
-<% inline = local_assigns[:inline].presence %>
-<% label_col = f&.label_col %>
-<% control_col = f&.control_col %>
-<% offset_col = label_col.sub('col', 'offset') %>
-
-<div class="form-group mb-3 <%= "row" if inline %>">
-  <% Array(value || '').each_with_index do |v, index| %>
-    <%= f.label field.slug, field.label, namespace: "f#{index}", class: "col-form-label #{label_col if inline} #{'visually-hidden' if index > 0}" %>
-    <div class="mb-3 <%= control_col if inline %>">
-      <%= f.text_area_without_bootstrap field.slug, namespace: "f#{index}",multiple: field.is_multiple?, value: v, class: "form-control field-#{field.slug}", readonly: field.readonly_field? %>
-    </div>
-  <% end %>
-
-  <% if field.is_multiple? && !field.readonly_field? %>
-    <%= content_tag :template, id: "spotlight-field-template-#{field.slug}" do %>
-      <%= f.label field.slug, field.label, class: "col-form-label #{label_col if inline} visually-hidden" %>
-      <div class="mb-3 <%= "#{offset_col} #{control_col}" if inline %>">
-        <%= f.text_area_without_bootstrap field.slug, multiple: field.is_multiple?, value: nil, class: "form-control field-#{field.slug}" %>
-      </div>
-    <% end %>
-    <%= content_tag :button, t('helpers.action.add_another'), class: 'btn btn-info btn-sm col-auto h-100', data: { action: 'add-another', template_id: "spotlight-field-template-#{field.slug}" } %>
-  <% end %>
-</div>

data/app/views/spotlight/custom_fields/form_group/_vocab.html.erb

@@ -1,23 +0,0 @@
-<% inline = local_assigns[:inline].presence %>
-<% label_col = f&.label_col %>
-<% control_col = f&.control_col %>
-<% offset_col = label_col.sub('col', 'offset') %>
-
-<div class="form-group mb-3 <%= "row" if inline %>">
-  <% Array(value || '').each_with_index do |v, index| %>
-    <%= f.label field.slug, field.label, namespace: "f#{index}", class: "col-form-label #{label_col if inline} #{'visually-hidden' if index > 0}" %>
-    <div class="mb-3 <%= control_col if inline %>">
-      <%= f.text_field_without_bootstrap field.slug, namespace: "f#{index}", multiple: field.is_multiple?, value: v, class: "form-control field-#{field.slug}", readonly: field.readonly_field? %>
-    </div>
-  <% end %>
-
-  <% if field.is_multiple? && !field.readonly_field? %>
-    <%= content_tag :template, id: "spotlight-field-template-#{field.slug}" do %>
-      <%= f.label field.slug, field.label, class: "col-form-label #{label_col if inline} visually-hidden" %>
-      <div class="mb-3 <%= "#{offset_col} #{control_col}" if inline %>">
-        <%= f.text_field_without_bootstrap field.slug, multiple: field.is_multiple?, value: nil, class: "form-control field-#{field.slug}" %>
-      </div>
-    <% end %>
-    <%= content_tag :button, t('helpers.action.add_another'), class: 'btn btn-info btn-sm col-auto h-100', data: { action: 'add-another', template_id: "spotlight-field-template-#{field.slug}" } %>
-  <% end %>
-</div>

data/app/views/spotlight/invitation_mailer/exhibit_invitation_notification.html.erb

@@ -1,12 +0,0 @@
-<p><%= t("spotlight.#{@key}.invitation_instructions.hello", email: @role.user.email) %></p>
-
-<p><%= t("spotlight.#{@key}.invitation_instructions.someone_invited_you", role: @role, exhibit_name: @role.resource.title) %></p>
-
-<% if @role.user.invite_pending? %>
-  <p><%= t("spotlight.#{@key}.invitation_instructions.accept_invitation") %></p>
-  <p><%= link_to t("spotlight.#{@key}.invitation_instructions.accept"), accept_invitation_url(@role.user, invitation_token: @role.user.invitation_token) %></p>
-<% elsif @role.resource.is_a? Spotlight::Exhibit %>
-  <p><%= link_to t("spotlight.#{@key}.invitation_instructions.visit"), url: spotlight.exhibit_home_page_url(@role.resource) %></p>
-<% end %>
-
-<p><%= t("spotlight.#{@key}.invitation_instructions.ignore") %></p>