blacklight-spotlight 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8445fcedab2b6c93ecc559cb0ecc02c1c0d6e42c987d7467a7b17b1a04c86456
-  data.tar.gz: 63e9bc33643a7db25d6b3e875c3dae7374085389c42224bfb71572a8e7995221
+  metadata.gz: 2148d0879e24d68085e54c6fb9569af9900383d7bdb12c00f1568cf846e6b3c0
+  data.tar.gz: e2ff46720e4f722e64a47eeb29ceaf4cc7a981731942134b81ae0f94eb376b02
 SHA512:
-  metadata.gz: 0e7ecb7302c87a9006ffcd74aa4c2b3da56d17cded2cfd90f2803c9582fa11cb35385ad9edfbabee44bed698acb7191ee2dd22f48e19034c106d7bfa447071e7
-  data.tar.gz: 9417a9864e63890323ace42f0b5d1b8f1d63449b2d437f22d47df9f4d882e7037713aa097910b24fd58a80b20b4939a4d39c4b2aee2c2a3d77b3329bbfa90dfd
+  metadata.gz: 9a8590c2c12ab0c5df2e61ea8e5608a465564dd33ee7b6fb849578f98fb5aa5116b7706240ec2955065b6e0d1c65d1db4fa0837e2d73083fc4a0cf06cff7c0b6
+  data.tar.gz: 290494323ae7ccb37ccfd9e80df582df82814f6129025bc95d42dad2611ed7d105cb3cdc0c1cd40239edb05aa3dff4177ee784980209e8100cb0bf82351aba58

data/app/controllers/spotlight/custom_search_fields_controller.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # CRUD actions for exhibit custom search field management.
+  class CustomSearchFieldsController < ApplicationController
+    before_action :authenticate_user!
+
+    load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+    load_and_authorize_resource through: :exhibit
+    before_action :attach_breadcrumbs, only: [:new, :edit]
+
+    # GET /custom_search_fields/new
+    def new
+      add_breadcrumb t(:'helpers.action.spotlight/custom_search_field.create'), new_exhibit_custom_search_field_path(@exhibit)
+    end
+
+    # GET /custom_search_fields/1/edit
+    def edit
+      add_breadcrumb @custom_search_field.label, edit_exhibit_custom_search_field_path(@custom_search_field.exhibit, @custom_search_field)
+    end
+
+    # POST /custom_search_fields
+    def create
+      @custom_search_field.attributes = custom_search_field_params
+      @custom_search_field.exhibit = current_exhibit
+
+      if @custom_search_field.save
+        redirect_to edit_exhibit_search_configuration_path(@custom_search_field.exhibit),
+                    notice: t(:'helpers.submit.custom_search_field.created', model: @custom_search_field.class.model_name.human.downcase)
+      else
+        render action: 'new'
+      end
+    end
+
+    # PATCH/PUT /custom_search_fields/1
+    def update
+      if @custom_search_field.update(custom_search_field_params)
+        redirect_to edit_exhibit_search_configuration_path(@custom_search_field.exhibit),
+                    notice: t(:'helpers.submit.custom_search_field.updated', model: @custom_search_field.class.model_name.human.downcase)
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      @custom_search_field.destroy
+
+      redirect_to edit_exhibit_search_configuration_path(@custom_search_field.exhibit),
+                  notice: t(:'helpers.submit.custom_search_field.destroyed', model: @custom_search_field.class.model_name.human.downcase)
+    end
+
+    private
+
+    def attach_breadcrumbs
+      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
+      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)
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def custom_search_field_params
+      params.require(:custom_search_field).permit(:slug, :field, :label)
+    end
+  end
+end

data/app/controllers/spotlight/featured_images_controller.rb

@@ -16,7 +16,10 @@ module Spotlight
     private
 
     def tilesource
-      riiif.info_url(@featured_image.id)
+      Spotlight::Engine.config.iiif_url_helpers.info_url(
+        @featured_image.id,
+        host: request.host_with_port
+      )
     end
 
     # The create action can be called from a number of different forms, so

data/app/models/spotlight/ability.rb

@@ -29,6 +29,7 @@ module Spotlight
         Spotlight::Page,
         Spotlight::Contact,
         Spotlight::CustomField,
+        Spotlight::CustomSearchField,
         Translation
       ], exhibit_id: user.exhibit_roles.pluck(:resource_id)
 

data/app/models/spotlight/blacklight_configuration.rb

@@ -136,6 +136,7 @@ module Spotlight
 
         config.show_fields = config.index_fields
 
+        config.search_fields.merge! custom_search_fields(config)
         unless search_fields.blank?
           config.search_fields = Hash[config.search_fields.sort_by { |k, _v| field_weight(search_fields, k) }]
 
@@ -227,6 +228,18 @@ module Spotlight
       end]
     end
 
+    def custom_search_fields(blacklight_config)
+      Hash[exhibit.custom_search_fields.reject(&:new_record?).map do |custom_field|
+        original_config = blacklight_config.search_fields[custom_field.field] || {}
+        field = Blacklight::Configuration::SearchField.new original_config.merge(
+          custom_field.configuration.merge(
+            key: custom_field.slug, solr_parameters: { qf: custom_field.field }, custom_field: true
+          )
+        )
+        [custom_field.slug, field]
+      end]
+    end
+
     ##
     # Get the "upstream" blacklight configuration to use
     def default_blacklight_config

data/app/models/spotlight/custom_search_field.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Spotlight
+  # Exhibit-specific custom search fields
+  class CustomSearchField < ApplicationRecord
+    serialize :configuration, Hash
+    belongs_to :exhibit
+
+    def label=(label)
+      configuration['label'] = label
+
+      update_blacklight_configuration_label label
+    end
+
+    def label
+      conf = if slug && blacklight_configuration && blacklight_configuration.search_fields.key?(slug)
+               blacklight_configuration.search_fields[slug].reverse_merge(configuration)
+             else
+               configuration
+             end
+      conf['label']
+    end
+
+    protected
+
+    def blacklight_configuration
+      exhibit&.blacklight_configuration
+    end
+
+    def update_blacklight_configuration_label(label)
+      return unless slug && blacklight_configuration && blacklight_configuration.search_fields.key?(slug)
+
+      blacklight_configuration.search_fields[slug]['label'] = label
+      blacklight_configuration.save
+    end
+  end
+end

data/app/models/spotlight/exhibit.rb

@@ -46,6 +46,7 @@ module Spotlight
           end]
       end
     end
+    has_many :custom_search_fields, dependent: :delete_all
 
     has_many :feature_pages, -> { for_default_locale }, extend: FriendlyId::FinderMethods
     has_many :main_navigations, dependent: :delete_all

data/app/models/spotlight/featured_image.rb

@@ -53,8 +53,7 @@ module Spotlight
     def set_tilesource_from_uploaded_resource
       return if iiif_tilesource
 
-      riiif = Riiif::Engine.routes.url_helpers
-      self.iiif_tilesource = riiif.info_path(id)
+      self.iiif_tilesource = Spotlight::Engine.config.iiif_url_helpers.info_path(id)
       save
     end
 

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

@@ -70,7 +70,7 @@ module Spotlight
         return unless title_fields.present? && manifest.try(:label)
 
         Array.wrap(title_fields).each do |field|
-          solr_hash[field] = json_ld_value(manifest.label)
+          solr_hash[field] = metadata_class.new(manifest).label
         end
       end
 
@@ -96,13 +96,6 @@ module Spotlight
         end
       end
 
-      def json_ld_value(value)
-        return value['@value'] if value.is_a?(Hash)
-        return value.find { |v| v['@language'] == default_json_ld_language }.try(:[], '@value') if value.is_a?(Array)
-
-        value
-      end
-
       def create_sidecars_for(*keys)
         missing_keys(keys).each do |k|
           exhibit.custom_fields.create! label: k, readonly_field: true
@@ -164,10 +157,6 @@ module Spotlight
         Spotlight::Engine.config.iiif_title_fields || blacklight_config.index.try(:title_field)
       end
 
-      def default_json_ld_language
-        Spotlight::Engine.config.default_json_ld_language
-      end
-
       def sidecar
         @sidecar ||= document_model.new(id: compound_id).sidecar(exhibit)
       end
@@ -195,6 +184,12 @@ module Spotlight
           metadata_hash.merge(manifest_level_metadata)
         end
 
+        def label
+          return unless manifest.try(:label)
+
+          Array(json_ld_value(manifest.label)).map { |v| html_sanitize(v) }.first
+        end
+
         private
 
         attr_reader :manifest
@@ -210,8 +205,10 @@ module Spotlight
           metadata.each_with_object({}) do |md, hash|
             next unless md['label'] && md['value']
 
-            hash[md['label']] ||= []
-            hash[md['label']] += Array(md['value'])
+            label = Array(json_ld_value(md['label'])).first
+
+            hash[label] ||= []
+            hash[label] += Array(json_ld_value(md['value'])).map { |v| html_sanitize(v) }
           end
         end
 
@@ -221,13 +218,81 @@ module Spotlight
                         manifest.send(field).present?
 
             hash[field.capitalize] ||= []
-            hash[field.capitalize] += Array(manifest.send(field))
+            hash[field.capitalize] += Array(json_ld_value(manifest.send(field))).map { |v| html_sanitize(v) }
           end
         end
 
         def manifest_fields
           %w(attribution description license)
         end
+
+        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
+        def json_ld_value(value)
+          case value
+          # In the case where multiple values are supplied, clients must use the following algorithm to determine which values to display to the user.
+          when Array
+            # IIIF v2, multivalued monolingual, or multivalued multilingual values
+
+            # If none of the values have a language associated with them, the client must display all of the values.
+            if value.none? { |v| v.is_a?(Hash) && v.key?('@language') }
+              value.map { |v| json_ld_value(v) }
+            # If any of the values have a language associated with them, the client must display all of the values associated with the language that best
+            # matches the language preference.
+            elsif value.any? { |v| v.is_a?(Hash) && v['@language'] == default_json_ld_language }
+              value.select { |v| v.is_a?(Hash) && v['@language'] == default_json_ld_language }.map { |v| v['@value'] }
+            # If all of the values have a language associated with them, and none match the language preference, the client must select a language
+            # and display all of the values associated with that language.
+            elsif value.all? { |v| v.is_a?(Hash) && v.key?('@language') }
+              selected_json_ld_language = value.find { |v| v.is_a?(Hash) && v.key?('@language') }
+
+              value.select { |v| v.is_a?(Hash) && v['@language'] == selected_json_ld_language['@language'] }
+                   .map { |v| v['@value'] }
+            # If some of the values have a language associated with them, but none match the language preference, the client must display all of the values
+            # that do not have a language associated with them.
+            else
+              value.select { |v| !v.is_a?(Hash) || !v.key?('@language') }.map { |v| json_ld_value(v) }
+            end
+          when Hash
+            # IIIF v2 single-valued value
+            if value.key? '@value'
+              value['@value']
+            # IIIF v3 multilingual(?), multivalued(?) values
+            # If all of the values are associated with the none key, the client must display all of those values.
+            elsif value.keys == ['none']
+              value['none']
+            # If any of the values have a language associated with them, the client must display all of the values associated with the language
+            # that best matches the language preference.
+            elsif value.key? default_json_ld_language
+              value[default_json_ld_language]
+            # If some of the values have a language associated with them, but none match the language preference, the client must display all
+            # of the values that do not have a language associated with them.
+            elsif value.key? 'none'
+              value['none']
+            # If all of the values have a language associated with them, and none match the language preference, the client must select a
+            # language and display all of the values associated with that language.
+            else
+              value.values.first
+            end
+          else
+            # plain old string/number/boolean
+            value
+          end
+        end
+        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
+
+        def html_sanitize(value)
+          return value unless value.is_a? String
+
+          html_sanitizer.sanitize(value)
+        end
+
+        def html_sanitizer
+          @html_sanitizer ||= Rails::Html::FullSanitizer.new
+        end
+
+        def default_json_ld_language
+          Spotlight::Engine.config.default_json_ld_language
+        end
       end
     end
   end

data/app/models/spotlight/solr_document_sidecar.rb

@@ -74,11 +74,11 @@ module Spotlight
         field_name = field.field_name.to_s
         next unless configured_fields && configured_fields[field_name].present?
 
-        solr_fields = field.solr_fields || Array(field.solr_field || field.field_name)
+        value = configured_fields[field_name]
+        field_data = field.data_to_solr(value)
 
-        solr_fields.each do |solr_field|
-          solr_hash[solr_field] = configured_fields[field_name]
-        end
+        # merge duplicate field mappings into a multivalued field
+        solr_hash.merge!(field_data) { |_key, v1, v2| Array(v1) + Array(v2) }
       end
     end
 

data/app/presenters/spotlight/iiif_manifest_presenter.rb

@@ -74,8 +74,10 @@ module Spotlight
     end
 
     def iiif_url
-      # yes this is hacky, and we are appropriately ashamed.
-      controller.riiif.info_url(uploaded_resource.upload.id).sub(%r{/info\.json\Z}, '')
+      Spotlight::Engine.config.iiif_url_helpers.info_url(
+        uploaded_resource.upload.id,
+        host: controller.request.host_with_port
+      ).sub(%r{/info\.json\Z}, '')
     end
   end
 end

data/app/services/spotlight/upload_solr_document_builder.rb

@@ -31,7 +31,8 @@ module Spotlight
     end
 
     def add_file_versions(solr_hash)
-      solr_hash[Spotlight::Engine.config.thumbnail_field] = riiif.image_path(resource.upload_id, size: '!400,400')
+      solr_hash[Spotlight::Engine.config.thumbnail_field] =
+        Spotlight::Engine.config.iiif_url_helpers.image_path(resource.upload_id, size: '!400,400')
     end
 
     def add_sidecar_fields(solr_hash)
@@ -47,7 +48,7 @@ module Spotlight
     end
 
     def riiif
-      Riiif::Engine.routes.url_helpers
+      Spotlight::Engine.config.iiif_url_helpers
     end
 
     def attached_file?

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

@@ -0,0 +1,13 @@
+<%= bootstrap_form_for @custom_search_field.new_record? ? [current_exhibit, @custom_search_field] : [@custom_search_field.exhibit, @custom_search_field], layout: :horizontal, label_col: 'col-md-3', control_col: 'col-md-9', html: {class: 'col-md-9', id: 'edit-search-field'} do |f| %>
+
+  <%= f.text_field :slug %>
+  <%= f.text_field :field, help: t('.field.help') %>
+  <%= f.text_field :label %>
+
+  <div class="form-actions">
+    <div class="primary-actions">
+      <%= link_to t(:"cancel"), edit_exhibit_search_configuration_path(current_exhibit), class: "btn btn-link" %>
+      <%= f.submit nil, class: 'btn btn-primary' %>
+    </div>
+  </div>
+<% end %>

data/app/views/spotlight/custom_search_fields/edit.html.erb

@@ -0,0 +1,5 @@
+<%= render 'spotlight/shared/exhibit_sidebar' %>
+<div id="content" class="col-md-9">
+  <%= configuration_page_title %>
+  <%= render 'form' %>
+</div>

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

@@ -0,0 +1,5 @@
+<%= render 'spotlight/shared/exhibit_sidebar' %>
+<div id="content" class="col-md-9">
+  <%= configuration_page_title %>
+  <%= render 'form' %>
+</div>

data/app/views/spotlight/search_configurations/_search_fields.html.erb

@@ -55,3 +55,30 @@
     </div>
   <% end %>
 <% end %>
+
+<% if can? :manage, Spotlight::CustomSearchField.new(exhibit: current_exhibit) %>
+  <h3><%= t(:'.exhibit_specific.header') %></h3>
+  <p class="instructions"><%= t(:'.exhibit_specific.instructions') %></p>
+
+  <table class="table table-striped" id="exhibit-specific-fields">
+    <tbody>
+      <% @exhibit.custom_search_fields.each do |field| %>
+        <tr>
+          <td>
+            <div class="field-label"><%= field.label %></div>
+            <div class="actions">
+              <%= exhibit_edit_link field, class: 'btn btn-link' %> &middot;
+              <%= exhibit_delete_link field, class: 'btn btn-link' %>
+            </div>
+          </td>
+          <td class="field-description">
+            <%= field.field %>
+          </td>
+        </tr>
+      <% end %>
+
+    </tbody>
+  </table>
+
+  <%= exhibit_create_link Spotlight::CustomSearchField.new, class: 'btn btn-primary' %>
+<% end %>

data/app/views/spotlight/search_configurations/edit.html.erb

@@ -41,6 +41,5 @@
         <%= f.submit nil, class: 'btn btn-primary' %>
       </div>
     </div>
-
   <% end %>
 </div>

data/config/i18n-tasks.yml

@@ -37,6 +37,7 @@ ignore_unused:
   - activerecord.attributes.spotlight/exhibit.published # app/views/spotlight/sites/_exhibit.html.erb
   - activerecord.attributes.spotlight/masthead.display # app/views/spotlight/appearances/edit.html.erb
   - activerecord.attributes.spotlight/custom_field.is_multiple # app/views/spotlight/custom_fields/_form.html.erb
+  - activerecord.attributes.spotlight/custom_search_field.field # app/views/spotlight/custom_search_fields/_form.html.erb
   - helpers.label.spotlight/filter.{field,value} # app/views/spotlight/filters/_form.html.erb
   - spotlight.catalog.admin.{title,header} # app/helpers/spotlight/title_helper.rb
   - spotlight.{contacts,pages,searches}.edit.{title,header} # app/helpers/spotlight/title_helper.rb
@@ -46,8 +47,9 @@ ignore_unused:
   - spotlight.metadata_configurations.edit.{select_all,deselect_all} # app/helpers/spotlight/application_helper.rb
   - spotlight.featured_images.upload_form.{non_iiif_alert_html,source.exhibit.help,source.exhibit.label} # app/views/spotlight/featured_images/_form.html.erb
   - spotlight.feature_pages.page_options.published # app/views/spotlight/feature_pages/_page_options.html.erb
-  - spotlight.{exhibits,custom_fields}.{new,edit}.header # configuration_page_title
+  - spotlight.{exhibits,custom_fields,custom_search_fields}.{new,edit}.header # configuration_page_title
   - helpers.submit.custom_field.{batch_error,batch_updated,create,submit,update} # Generic repeated template
+  - helpers.submit.custom_search_field.{batch_error,batch_updated,create,submit,update} # Generic repeated template
   - helpers.submit.exhibit.{batch_error,batch_updated,create,submit,update} # Generic repeated template
   - helpers.submit.search.{create,submit,update} # Generic repeated template
   - helpers.submit.site.{batch_error,batch_updated,create,created,destroyed,submit,update} # Generic repeated template