blacklight-spotlight 2.7.2 → 2.8.0

data/app/helpers/spotlight/pages_helper.rb

@@ -6,6 +6,16 @@ module Spotlight
   module PagesHelper
     include Spotlight::RenderingHelper
 
+    def content_editor_class(page)
+      page_content = page.content_type
+
+      if page_content == 'SirTrevor'
+        'js-st-instance'
+      else
+        "js-#{page_content.parameterize}-instance"
+      end
+    end
+
     ##
     # Override the default #sir_trevor_markdown so we can use
     # a more complete markdown rendered

data/app/jobs/spotlight/add_uploads_from_csv.rb

@@ -21,7 +21,7 @@ module Spotlight
           data: row,
           exhibit: exhibit
         )
-        resource.build_upload(remote_image_url: url)
+        resource.build_upload(remote_image_url: url) unless url == '~'
         resource.save_and_index
       end
     end

data/app/jobs/spotlight/rename_sidecar_field_job.rb

@@ -7,15 +7,29 @@ module Spotlight
   class RenameSidecarFieldJob < ActiveJob::Base
     queue_as :default
 
-    def perform(exhibit, old_field, new_field)
+    def perform(exhibit, old_field, new_field, old_slug = nil, new_slug = nil)
       exhibit.solr_document_sidecars.find_each do |s|
-        if s.data[old_field]
-          s.data_will_change!
-          s.data[new_field] = s.data.delete(old_field)
-          s.save
-          s.document.reindex
-        end
+        # this data migration should be relatively rare
+        migrate_data!(s, old_slug, new_slug)
+        migrate_data!(s, old_field, new_slug || new_field) # for backwards compatibility
+
+        # more likely, the indexing rules changed and we have to reindex
+        reindex_document!(s) if old_field != new_field && s.data[new_slug || new_field]
       end
     end
+
+    private
+
+    def migrate_data!(sidecar, old_field, new_field)
+      return if old_field == new_field || !sidecar.data.key?(old_field)
+
+      sidecar.data_will_change!
+      sidecar.data[new_field] = sidecar.data.delete(old_field)
+      sidecar.save
+    end
+
+    def reindex_document!(sidecar)
+      sidecar.document.reindex
+    end
   end
 end

data/app/models/spotlight/blacklight_configuration.rb

@@ -216,7 +216,7 @@ module Spotlight
     end
 
     def custom_facet_fields
-      Hash[exhibit.custom_fields.vocab.reject(&:new_record?).map do |x|
+      Hash[exhibit.custom_fields.facetable.reject(&:new_record?).map do |x|
         field = Blacklight::Configuration::FacetField.new x.configuration.merge(
           key: x.field, field: x.solr_field, show: false, custom_field: true
         )
@@ -277,7 +277,9 @@ module Spotlight
     def add_exhibit_tags_fields(config)
       # rubocop:disable Style/GuardClause
       unless config.show_fields.include? :exhibit_tags
-        config.add_show_field :exhibit_tags, field: config.document_model.solr_field_for_tagger(exhibit), link_to_search: true
+        config.add_show_field :exhibit_tags, field: config.document_model.solr_field_for_tagger(exhibit),
+                                             link_to_search: true,
+                                             separator_options: { words_connector: nil, two_words_connector: nil, last_word_connector: nil }
       end
 
       unless config.facet_fields.include? :exhibit_tags

data/app/models/spotlight/custom_field.rb

@@ -10,7 +10,7 @@ module Spotlight
     extend FriendlyId
     friendly_id :slug_candidates, use: [:slugged, :scoped, :finders], scope: :exhibit
 
-    scope :vocab, -> { where(field_type: 'vocab') }
+    scope :facetable, -> { where(field_type: Spotlight::Engine.config.custom_field_types.select { |_k, v| v[:facetable] }.keys) }
     scope :writeable, -> { where(readonly_field: false) }
 
     before_create do
@@ -18,9 +18,10 @@ module Spotlight
       self.field_type ||= 'text'
     end
 
-    before_save do
-      update_field_name(field_name) if update_field_name?
-    end
+    before_save :update_field_name, on: :update, if: -> { field_type_changed? || readonly_field_changed? }
+
+    after_commit :update_blacklight_configuration_after_field_name_change, on: :update, if: -> { saved_change_to_field? || saved_change_to_slug? }
+    after_commit :update_sidecar_data_after_field_name_change, on: :update, if: -> { saved_change_to_field? || saved_change_to_slug? }
 
     def label=(label)
       configuration['label'] = label
@@ -92,7 +93,7 @@ module Spotlight
     end
 
     def should_generate_new_friendly_id?
-      super || persisted?
+      new_record? && slug.blank?
     end
 
     # Try building a slug based on the following fields in
@@ -107,26 +108,25 @@ module Spotlight
     ##
     # Rename this custom field to new_name
     # @param [String] the new name for the field
-    def update_field_name(new_field)
-      old_field = field
-      self.field = new_field
-
-      if blacklight_configuration && blacklight_configuration.index_fields.key?(old_field)
-        blacklight_configuration.index_fields_will_change!
-        f = blacklight_configuration.index_fields.delete(old_field)
-        blacklight_configuration.index_fields[field] = f
-        blacklight_configuration.save
-      end
+    def update_field_name
+      self.field = field_name
+    end
+
+    def update_blacklight_configuration_after_field_name_change
+      return unless blacklight_configuration && blacklight_configuration.index_fields.key?(field_before_last_save)
 
-      Spotlight::RenameSidecarFieldJob.perform_later(exhibit, old_field, self.field)
+      blacklight_configuration.index_fields_will_change!
+      f = blacklight_configuration.index_fields.delete(field_before_last_save)
+      blacklight_configuration.index_fields[field] = f
+      blacklight_configuration.save
     end
 
-    def document_model
-      blacklight_configuration.document_model
+    def update_sidecar_data_after_field_name_change
+      Spotlight::RenameSidecarFieldJob.perform_later(exhibit, field_before_last_save, self.field, slug_before_last_save, slug)
     end
 
-    def update_field_name?
-      persisted? && (field_type_changed? || readonly_field_changed?)
+    def document_model
+      blacklight_configuration.document_model
     end
   end
 end

data/app/models/spotlight/exhibit.rb

@@ -36,7 +36,17 @@ module Spotlight
     has_many :attachments, dependent: :destroy
     has_many :contact_emails, dependent: :delete_all # These are the contacts who get "Contact us" emails
     has_many :contacts, dependent: :delete_all # These are the contacts who appear in the sidebar
-    has_many :custom_fields, dependent: :delete_all
+    has_many :custom_fields, dependent: :delete_all do
+      def as_strong_params
+        multivalued_params, single_valued_params = writeable.partition(&:is_multiple?)
+        single_valued_params.pluck(:slug, :field).flatten +
+          [multivalued_params.each_with_object({}) do |f, h|
+            h[f.slug] = []
+            h[f.field] = []
+          end]
+      end
+    end
+
     has_many :feature_pages, -> { for_default_locale }, extend: FriendlyId::FinderMethods
     has_many :main_navigations, dependent: :delete_all
     has_many :reindexing_log_entries, dependent: :destroy

data/app/models/spotlight/page.rb

@@ -3,7 +3,6 @@
 module Spotlight
   ##
   # Base page class. See {Spotlight::AboutPage}, {Spotlight::FeaturePage}, {Spotlight::HomePage}
-  # rubocop:disable Metrics/ClassLength
   class Page < ActiveRecord::Base
     MAX_PAGES = 1000
 
@@ -35,14 +34,12 @@ module Spotlight
     scope :for_default_locale, -> { for_locale(I18n.default_locale) }
 
     has_one :lock, as: :on, dependent: :destroy
-    sir_trevor_content :content
     has_paper_trail
 
     accepts_nested_attributes_for :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
 
     # display_sidebar should be set to true by default
     before_create do
-      self.content ||= [].to_json
       self.display_sidebar = true
     end
 
@@ -52,6 +49,16 @@ module Spotlight
       @content = nil
     end
 
+    def content
+      @content ||= begin
+        Spotlight::PageContent.for(self, :content)
+      end
+    end
+
+    def content_type
+      self[:content_type] || Spotlight::Engine.config.default_page_content_type
+    end
+
     def content=(content)
       if content.is_a? Array
         super content.to_json
@@ -160,5 +167,4 @@ module Spotlight
       translated_pages.update(weight: weight) if saved_change_to_weight?
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/app/models/spotlight/page_content.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Factory for picking the right page content renderer
+  module PageContent
+    def self.for(page, attribute)
+      content_type = page.content_type
+      content_class = Spotlight::PageContent.const_get(content_type) if Spotlight::PageContent.const_defined?(content_type)
+      content_class ||= default_page_content_class
+
+      content_class.parse(page, attribute)
+    end
+
+    def self.default_page_content_class
+      Spotlight::PageContent.const_get(Spotlight::Engine.config.default_page_content_type)
+    end
+  end
+end

data/app/models/spotlight/page_content/sir_trevor.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module PageContent
+    # Sir-Trevor created content
+    class SirTrevor
+      def self.parse(page, attribute)
+        content = page.read_attribute(attribute)
+        content ||= [].to_json
+
+        return SirTrevorRails::BlockArray.new if content.blank?
+
+        SirTrevorRails::BlockArray.from_json(content, page)
+      end
+    end
+  end
+end

data/app/models/spotlight/solr_document_sidecar.rb

@@ -88,6 +88,9 @@ module Spotlight
 
     def custom_fields
       exhibit.custom_fields.each_with_object({}) do |custom_field, hash|
+        hash[custom_field.slug] = custom_field
+
+        # for backwards compatibility
         hash[custom_field.field] = custom_field
       end
     end

data/app/presenters/spotlight/iiif_manifest_presenter.rb

@@ -27,8 +27,8 @@ module Spotlight
     # IIIFManifest expects leaf nodes to implement #display_image, which returns an instance of IIIFManifest::DisplayImage.
     def display_image
       IIIFManifest::DisplayImage.new(id,
-                                     width: resource.first(:spotlight_full_image_width_ssm),
-                                     height: resource.first(:spotlight_full_image_height_ssm),
+                                     width: resource.first(:spotlight_full_image_width_ssm)&.to_i,
+                                     height: resource.first(:spotlight_full_image_height_ssm)&.to_i,
                                      format: 'image/jpeg',
                                      iiif_endpoint: endpoint)
     end

data/app/serializers/spotlight/exhibit_export_serializer.rb

@@ -34,6 +34,10 @@ module Spotlight
       property prop
     end
 
+    property :theme, setter: lambda { |fragment:, represented:, **|
+      represented.theme = fragment if Spotlight::Engine.config.exhibit_themes.include? fragment
+    }
+
     collection :searches, populator: ->(fragment, options) { options[:represented].searches.find_or_initialize_by(slug: fragment['slug']) },
                           class: Spotlight::Search do
       (Spotlight::Search.attribute_names - %w(id scope exhibit_id masthead_id thumbnail_id)).each do |prop|

data/app/services/spotlight/upload_solr_document_builder.rb

@@ -8,10 +8,13 @@ module Spotlight
     def to_solr
       super.tap do |solr_hash|
         add_default_solr_fields solr_hash
-        add_image_dimensions solr_hash
-        add_file_versions solr_hash
         add_sidecar_fields solr_hash
-        add_manifest_path solr_hash
+
+        if attached_file?
+          add_image_dimensions solr_hash
+          add_file_versions solr_hash
+          add_manifest_path solr_hash
+        end
       end
     end
 
@@ -46,5 +49,9 @@ module Spotlight
     def riiif
       Riiif::Engine.routes.url_helpers
     end
+
+    def attached_file?
+      resource.upload&.file_present?
+    end
   end
 end

data/app/values/custom_field_name.rb

@@ -28,11 +28,11 @@ class CustomFieldName
   end
 
   def field_suffix
-    case field_type
-    when 'vocab'
-      Spotlight::Engine.config.solr_fields.string_suffix
-    else
-      Spotlight::Engine.config.solr_fields.text_suffix
-    end
+    (field_type && Spotlight::Engine.config.custom_field_types[field_type.to_sym][:suffix]) ||
+      default_field_suffix
+  end
+
+  def default_field_suffix
+    Spotlight::Engine.config.solr_fields.text_suffix
   end
 end

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

@@ -10,20 +10,15 @@
 
     <%# 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| %>
-      <div class="form-group">
-        <%= d.label field.field, field.label %>
-        <% if field.field_type == 'vocab' %>
-          <%= d.text_field_without_bootstrap field.field, value: document.sidecar(current_exhibit).data[field.field.to_s], class: "form-control field-#{field.slug}", readonly: field.readonly_field? %>
-        <% else %>
-          <%= d.text_area_without_bootstrap field.field, value: document.sidecar(current_exhibit).data[field.field.to_s], class: "form-control field-#{field.slug}", readonly: field.readonly_field? %>
-        <% end %>
-        <% unless field.configured_to_display? %>
-          <p class="bg-warning help-block">
-            <%= t(:'.blank_field_warning_html',
-                  link: link_to(t(:'spotlight.configuration.sidebar.metadata'), spotlight.edit_exhibit_metadata_configuration_path(current_exhibit))) %>
-          </p>
-        <% end %>
-      </div>
+      <% 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 help-block">
+          <%= 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.html.erb

@@ -4,8 +4,13 @@
   <%= f.text_area :short_description %>
 
   <%= f.form_group :field_type, label: { text: t(:'.field_type.label') } do %>
-    <%= f.radio_button :field_type, "text", label: t(:'.field_type.text') %>
-    <%= f.radio_button :field_type, "vocab", label: t(:'.field_type.vocab') %>
+    <% Spotlight::Engine.config.custom_field_types.each do |key, field_type| %>
+      <%= f.radio_button :field_type, key, label: t(:".field_type.#{key}") %>
+    <% end %>
+  <% end %>
+
+  <%= f.form_group :field_type, label: { text: t(:'.is_multiple.label') } do %>
+    <%= f.check_box :is_multiple, disabled: @custom_field.persisted? %>
   <% end %>
 
   <div class="form-actions">

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

@@ -0,0 +1,14 @@
+<div class="form-group">
+  <% Array(value || '').each_with_index do |v, index| %>
+    <%= f.label field.slug, field.label, namespace: "f#{index}",class: "control-label #{'sr-only' if index > 0}" %>
+    <%= 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? %>
+  <% 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: 'control-label sr-only' %>
+      <%= f.text_area_without_bootstrap field.slug, multiple: field.is_multiple?, value: nil, class: "form-control field-#{field.slug}" %>
+    <% end %>
+    <%= content_tag :button, t('helpers.action.add_another'), class: 'btn btn-info', data: { action: 'add-another', template_id: "spotlight-field-template-#{field.slug}" } %>
+  <% end %>
+</div>

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

@@ -0,0 +1,14 @@
+<div class="form-group">
+  <% Array(value || '').each_with_index do |v, index| %>
+    <%= f.label field.slug, field.label, namespace: "f#{index}", class: "control-label #{'sr-only' if index > 0}" %>
+    <%= 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? %>
+  <% 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: 'control-label sr-only' %>
+      <%= f.text_field_without_bootstrap field.slug, multiple: field.is_multiple?, value: nil, class: "form-control field-#{field.slug}" %>
+    <% end %>
+    <%= content_tag :button, t('helpers.action.add_another'), class: 'btn btn-info', data: { action: 'add-another', template_id: "spotlight-field-template-#{field.slug}" } %>
+  <% end %>
+</div>

data/app/views/spotlight/pages/_form.html.erb

@@ -40,7 +40,7 @@
         </div>
         <div class="form-group">
           <%= f.label :content, class: 'sr-only' %>
-          <%= f.text_area_without_bootstrap :content, value: { data: f.object.content.as_json }.to_json, class: 'js-st-instance', data: { 'block-types': Spotlight::Engine.config.sir_trevor_widgets } %>
+          <%= f.text_area_without_bootstrap :content, value: { data: f.object.content.as_json }.to_json, class: content_editor_class(f.object), data: { 'block-types': Spotlight::Engine.config.sir_trevor_widgets } %>
         </div>
       </div>
 

data/app/views/spotlight/resources/new.html.erb

@@ -4,14 +4,20 @@
   <div role="tabpanel">
     <ul class="nav nav-tabs" role="tablist">
       <% Spotlight::Engine.config.resource_partials.each_with_index do |p, i| %>
-        <li role="presentation" class="<%= "active" if i == 0 %>">
-          <%= link_to t("#{p.gsub('/', '.')}.title"), "#tab_#{i}", role: 'tab', 'data-toggle' => 'tab', 'aria-controls' => "tab_#{i}" %>
+        <% tab_name = p.split('/')[2] %>
+        <li role="presentation" class="<%= "active" if @tab == tab_name %>">
+          <%= link_to t("#{p.gsub('/', '.')}.title"),
+                      "##{tab_name}",
+                      role: 'tab',
+                      'data-toggle' => 'tab',
+                      'aria-controls' => "#{tab_name}" %>
         </li>
       <% end %>
     </ul>
     <div class="tab-content">
       <% Spotlight::Engine.config.resource_partials.each_with_index do |p, i| %>
-        <%= content_tag :div, id: "tab_#{i}", role: 'tabpanel', class: "tab-pane #{"active" if i == 0}" do %>
+        <% tab_name = p.split('/')[2] %>
+        <%= content_tag :div, id: "#{tab_name}", role: 'tabpanel', class: "tab-pane #{"active" if @tab == tab_name}" do %>
           <%= render p %>
         <% end %>
       <% end %>