blacklight-spotlight 3.5.0.2 → 3.6.0.beta3

data/app/controllers/spotlight/searches_controller.rb

@@ -14,6 +14,26 @@ module Spotlight
     include Spotlight::Base
     include Spotlight::SearchHelper
 
+    def index
+      @groups = @exhibit.groups
+      respond_to do |format|
+        format.html
+        format.json do
+          render json: @searches.as_json(methods: %i[full_title count thumbnail_image_url]), root: false
+        end
+      end
+    end
+
+    def show
+      redirect_to exhibit_browse_url(@search.exhibit, @search)
+    end
+
+    def edit
+      @groups = @exhibit.groups
+      add_breadcrumb @search.full_title, edit_exhibit_search_path(@search.exhibit, @search)
+      @exhibit = @search.exhibit
+    end
+
     def create
       @search.assign_attributes(search_params.except((:title unless @search.new_record?)))
       @search.query_params = query_params
@@ -26,35 +46,19 @@ module Spotlight
       end
     end
 
-    def index
-      @groups = @exhibit.groups
-      respond_to do |format|
-        format.html
-        format.json do
-          render json: @searches.as_json(methods: %i[full_title count thumbnail_image_url]), root: false
-        end
-      end
-    end
-
     def autocomplete
       search_params = autocomplete_params.merge(search_field: Spotlight::Engine.config.autocomplete_search_field)
-      (_, document_list) = search_service.search_results do |builder|
+      (response, _document_list) = search_service.search_results do |builder|
         builder.with(search_params)
       end
 
       respond_to do |format|
         format.json do
-          render json: { docs: autocomplete_json_response(document_list) }
+          render json: { docs: autocomplete_json_response(response.documents) }
         end
       end
     end
 
-    def edit
-      @groups = @exhibit.groups
-      add_breadcrumb @search.full_title, edit_exhibit_search_path(@search.exhibit, @search)
-      @exhibit = @search.exhibit
-    end
-
     def update
       if @search.update search_params
         redirect_to exhibit_searches_path(@search.exhibit), notice: t(:'helpers.submit.search.updated', model: @search.class.model_name.human.downcase)
@@ -77,10 +81,6 @@ module Spotlight
       redirect_back fallback_location: fallback_url, notice: notice
     end
 
-    def show
-      redirect_to exhibit_browse_url(@search.exhibit, @search)
-    end
-
     protected
 
     def autocomplete_params

data/app/controllers/spotlight/solr_controller.rb

@@ -57,7 +57,7 @@ module Spotlight
     def validate_writable_index!
       return if Spotlight::Engine.config.writable_index
 
-      render plain: 'Spotlight is unable to write to solr', status: 409
+      render plain: 'Spotlight is unable to write to solr', status: :conflict
     end
 
     def create_or_update_solr_document_sidecar(doc, data)

data/app/controllers/spotlight/translations_controller.rb

@@ -7,6 +7,12 @@ module Spotlight
     before_action :authenticate_user!, :set_language, :set_tab
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
 
+    def show
+      respond_to do |format|
+        format.yaml
+      end
+    end
+
     def edit
       attach_breadcrumbs
     end
@@ -21,12 +27,6 @@ module Spotlight
       end
     end
 
-    def show
-      respond_to do |format|
-        format.yaml
-      end
-    end
-
     def import
       if current_exhibit.update(import_exhibit_params)
         I18n.reload! # reload since we're memoizing
@@ -72,15 +72,13 @@ module Spotlight
       @tab = params[:tab]
     end
 
-    def unfold(value, key = nil)
+    def unfold(value, key = nil, &block)
       return to_enum(:unfold, value, key) unless block_given?
 
       if value.is_a? Hash
         value.each do |k, v|
           arr = unfold(v, [key, k].compact.join('.'))
-          arr.each do |k1, v1|
-            yield k1, v1
-          end
+          arr.each(&block)
         end
       else
         yield key, value

data/app/controllers/spotlight/versions_controller.rb

@@ -32,7 +32,8 @@ module Spotlight
                     view_context.t(:'spotlight.versions.redo')
                   end
 
-      view_context.link_to(link_name, revert_version_path(@version.next, redo: !params[:redo]), method: :post)
+      view_context.link_to(link_name, revert_version_path(@version.next, redo: !params[:redo]),
+                           data: { method: :post, turbo_method: :post })
     end
   end
 end

data/app/helpers/spotlight/application_helper.rb

@@ -27,7 +27,7 @@ module Spotlight
     end
 
     def site_title
-      current_site.title if current_site.title.present?
+      current_site.title.presence
     end
 
     # Returns the url for the current page in the new locale. This may be
@@ -63,19 +63,6 @@ module Spotlight
       main_app_url_helper?(method) || super
     end
 
-    ##
-    # Override the Blacklight #url_for_document helper to add
-    # the current exhibit context
-    def url_for_document(document)
-      return nil if document.nil?
-
-      if current_exhibit
-        [spotlight, current_exhibit, document]
-      else
-        document
-      end
-    end
-
     ##
     # Override Blacklight's #document_action_path helper to add
     # the current exhibit context
@@ -139,12 +126,12 @@ module Spotlight
 
     def select_deselect_button
       button_tag(
-        t(:".deselect_all"),
+        t(:'.deselect_all'),
         class: 'btn btn-secondary btn-sm metadata-select',
         data: {
           behavior: 'metadata-select',
-          'deselect-text' => t(:".deselect_all"),
-          'select-text' => t(:".select_all")
+          'deselect-text' => t(:'.deselect_all'),
+          'select-text' => t(:'.select_all')
         }
       )
     end
@@ -171,8 +158,37 @@ module Spotlight
       current_exhibit.theme if current_exhibit && current_exhibit.theme.present? && current_exhibit.themes.include?(current_exhibit.theme)
     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)
+
+      local_search_state ||= convert_to_search_state(localized_params || search_state)
+      constraints_component = blacklight_config&.view_config(document_index_view_type)&.constraints_component
+      constraints_component ||= Blacklight::ConstraintsComponent
+      render(constraints_component.new(search_state: local_search_state))
+    end
+
     private
 
+    def convert_to_search_state(params_or_search_state)
+      if params_or_search_state.is_a? Blacklight::SearchState
+        params_or_search_state
+      else
+        # deprecated
+        controller.search_state_class.new(params_or_search_state, blacklight_config, controller)
+      end
+    end
+
     def main_app_url_helper?(method)
       method.to_s.end_with?('_path', '_url') && main_app.respond_to?(method)
     end

data/app/helpers/spotlight/crud_link_helpers.rb

@@ -47,14 +47,24 @@ module Spotlight
     def delete_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || [spotlight, model]
-      default_options = { method: :delete, data: { confirm: action_default_value(model, :destroy_are_you_sure) } }
+      default_options = { data: {
+        method: :delete,
+        turbo_method: :delete,
+        confirm: action_default_value(model, :destroy_are_you_sure),
+        turbo_confirm: action_default_value(model, :destroy_are_you_sure)
+      } }
       link_to action_default_value(model, :destroy), link, default_options.merge(link_to_options)
     end
 
     def exhibit_delete_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || [spotlight, model.exhibit, model]
-      default_options = { method: :delete, data: { confirm: action_default_value(model, :destroy_are_you_sure) } }
+      default_options = { data: {
+        method: :delete,
+        turbo_method: :delete,
+        confirm: action_default_value(model, :destroy_are_you_sure),
+        turbo_confirm: action_default_value(model, :destroy_are_you_sure)
+      } }
       link_to action_default_value(model, :destroy), link, default_options.merge(link_to_options)
     end
 

data/app/helpers/spotlight/pages_helper.rb

@@ -74,7 +74,7 @@ module Spotlight
 
     # Insert soft breaks into email addresses so they wrap nicely
     def render_contact_email_address(address)
-      mail_to address, sanitize(address).gsub(/([@\.])/, '\1<wbr />').html_safe
+      mail_to address, sanitize(address).gsub(/([@.])/, '\1<wbr />').html_safe
     end
 
     def configurations_for_current_page

data/app/helpers/spotlight/roles_helper.rb

@@ -7,8 +7,8 @@ module Spotlight
     ##
     # Format the available roles for a select_tag
     def roles_for_select
-      Spotlight::Engine.config.exhibit_roles.each_with_object({}) do |key, object|
-        object[t("spotlight.role.#{key}")] = key
+      Spotlight::Engine.config.exhibit_roles.index_by do |key|
+        t("spotlight.role.#{key}")
       end
     end
   end

data/app/helpers/spotlight/title_helper.rb

@@ -20,7 +20,7 @@ module Spotlight
       set_html_page_title(head_content)
 
       html_content = safe_join([
-        (section if section.present?),
+        section.presence,
         (content_tag(:small, title) if title.present?)
       ].compact, "\n")
 

data/app/helpers/spotlight/translations_helper.rb

@@ -7,9 +7,7 @@ module Spotlight
     def non_custom_metadata_fields
       custom_field_keys = current_exhibit.custom_fields.pluck(:field)
 
-      current_exhibit.blacklight_config.show_fields.reject do |key, _|
-        custom_field_keys.include?(key)
-      end
+      current_exhibit.blacklight_config.show_fields.except(*custom_field_keys)
     end
   end
 end

data/app/javascript/spotlight/admin/add_another.es6

@@ -0,0 +1,24 @@
+export default class {
+  connect() {
+    $("[data-action='add-another']").on("click", function(event) {
+      event.preventDefault();
+
+      var templateId = $(this).data('template-id');
+
+      var template = document.querySelector('#' + templateId);
+      var clone = document.importNode(template.content, true);
+
+      var count = $(this).closest('.form-group').find('[name="' + $(clone).find('[name]').attr('name') + '"]').length + 1;
+      $(clone).find('[id]').each(function(index, el) {
+        $(el).attr('id', $(el).attr('id') + '_' + String(count));
+      });
+
+      $(clone).find('[for]').each(function(index, el) {
+        $(el).attr('for', $(el).attr('for') + '_' + String(count));
+      });
+
+
+      $(clone).insertBefore(this);
+    });
+  }
+}

data/app/javascript/spotlight/admin/add_image_selector.es6

@@ -0,0 +1,38 @@
+import Iiif from 'iiif'
+
+export function addImageSelector(input, panel, manifestUrl, initialize) {
+  if (!manifestUrl) {
+    showNonIiifAlert(input);
+    return;
+  }
+  var cropper = input.data('iiifCropper');
+  $.ajax(manifestUrl).done(
+    function(manifest) {
+      var iiifManifest = new Iiif(manifestUrl, manifest);
+
+      var thumbs = iiifManifest.imagesArray();
+
+      hideNonIiifAlert(input);
+
+      if (initialize) {
+        cropper.setIiifFields(thumbs[0]);
+        panel.multiImageSelector(); // Clears out existing selector
+      }
+
+      if(thumbs.length > 1) {
+        panel.show();
+        panel.multiImageSelector(thumbs, function(selectorImage) {
+          cropper.setIiifFields(selectorImage);
+        }, cropper.iiifImageField.val());
+      }
+    }
+  );
+}
+
+function showNonIiifAlert(input){
+  input.parent().prev('[data-behavior="non-iiif-alert"]').show();
+}
+
+function hideNonIiifAlert(input){
+  input.parent().prev('[data-behavior="non-iiif-alert"]').hide();
+}

data/app/javascript/spotlight/admin/add_new_button.es6

@@ -0,0 +1,77 @@
+export default class {
+  connect() {
+    $("[data-expanded-add-button]").each((_i, el) => this.addExpandBehaviorToButton($(el)))
+  }
+
+  addExpandBehaviorToButton(button){
+    var settings = {
+      speed: (button.data('speed') || 450),
+      animate_width: (button.data('animate_width') || 425)
+    }
+    var target = $(button.data('field-target'));
+    var save   = $("input[data-behavior='save']", target);
+    var cancel = $("input[data-behavior='cancel']", target);
+    var input  = $("input[type='text']", target);
+    var original_width  = button.outerWidth();
+    var expanded = false;
+
+    // Animate button open when the mouse enters or
+    // the button is given focus (i.e. clicked/tabbed)
+    button.on("mouseenter focus", function(){
+      expandButton();
+    });
+
+    // Don't allow blank titles
+    save.on('click', function(){
+      if ( inputEmpty() ) {
+        return false;
+      }
+    });
+
+    // Empty input and collapse
+    // button on cancel click
+    cancel.on('click', function(e){
+      e.preventDefault();
+      input.val('');
+      collapseButton();
+    });
+
+    // Collapse the button on when
+    // an empty input loses focus
+    input.on("blur", function(){
+      if ( inputEmpty() ) {
+        collapseButton();
+      }
+    });
+    function expandButton(){
+      // If this has not yet been expanded, recalculate original_width to 
+      // handle things that may have been originally hidden.
+      if (!expanded) {
+        original_width  = button.outerWidth();
+      }
+      if(button.outerWidth() <= (original_width + 5)) {
+        expanded = true;
+        button.animate(
+          {width: settings.animate_width + 'px'}, settings.speed, function(){
+            target.show(0, function(){
+              input.focus();
+              // Set the button to auto width to make
+              // sure it has room for any inputs
+              button.width("auto");
+              // Explicitly set the width of the button
+              // so the close animation works properly
+              button.width(button.width());
+            });
+          }
+        )
+      }
+    }
+    function collapseButton(){
+      target.hide();
+      button.animate({width: original_width + 'px'}, settings.speed);
+    }
+    function inputEmpty(){
+      return $.trim(input.val()) == "";
+    }
+  }
+}

data/app/javascript/spotlight/admin/appearance.es6

@@ -0,0 +1,22 @@
+export default class {
+  connect(){
+    $("[data-behavior='restore-default']").each(function(){
+      var hidden = $("[data-default-value]", $(this));
+      var value = $($("[data-in-place-edit-target]", $(this)).data('in-place-edit-target'), $(this));
+      var button = $("[data-restore-default]", $(this));
+      hidden.on('blur', function(){
+        if( $(this).val() == $(this).data('default-value') ) {
+          button.addClass('d-none');
+        } else {
+          button.removeClass('d-none');
+        }
+      });
+      button.on('click', function(e){
+        e.preventDefault();
+        hidden.val(hidden.data('default-value'));
+        value.text(hidden.data('default-value'));
+        button.hide();
+      });
+    });
+  }
+}

data/app/javascript/spotlight/admin/blacklight_configuration.es6

@@ -0,0 +1,65 @@
+export default class {
+  connect() {
+    // Add Select/Deselect all button behavior
+    this.addCheckboxToggleBehavior();
+    this.addEnableToggleBehavior();
+  }
+  
+  // Add Select/Deselect all button behavior
+  addCheckboxToggleBehavior() {
+    $("[data-behavior='metadata-select']").each(function(){
+      var button = $(this)
+      var parentCell = button.parents("th");
+      var table = parentCell.closest("table");
+      var columnRows = $("tr td:nth-child(" + (parentCell.index() + 1) + ")", table);
+      var checkboxes = $("input[type='checkbox']", columnRows);
+      swapSelectAllButtonText(button, columnRows);
+      // Add the check/uncheck behavior to the button
+      // and swap the button text if necessary
+      button.on('click', function(e){
+        e.preventDefault();
+        var allChecked = allCheckboxesChecked(columnRows);
+        columnRows.each(function(){
+          $("input[type='checkbox']", $(this)).prop('checked', !allChecked);
+          swapSelectAllButtonText(button, columnRows);
+        });
+      });
+      // Swap button text when a checkbox value changes
+      checkboxes.each(function(){
+        $(this).on('change', function(){
+          swapSelectAllButtonText(button, columnRows);
+        });
+      });
+    });
+    // Check number of checkboxes against the number of checked
+    // checkboxes to determine if all of them are checked or not
+    function allCheckboxesChecked(elements) {
+      return ($("input[type='checkbox']", elements).length == $("input[type='checkbox']:checked", elements).length)
+    }
+    // Swap the button text to "Deselect all"
+    // when all the checkboxes are checked and
+    // "Select all" when any are unchecked
+    function swapSelectAllButtonText(button, elements) {
+      if ( allCheckboxesChecked(elements) ) {
+        button.text(button.data('deselect-text'));
+      } else {
+        button.text(button.data('select-text'));
+      }
+    }
+  }
+
+  addEnableToggleBehavior() {
+    $("[data-behavior='enable-feature']").each(function(){
+      var checkbox = $(this);
+      var target = $($(this).data('target'));
+
+      checkbox.on('change', function() {
+        if ($(this).is(':checked')) {
+          target.find('input:checkbox').not("[data-behavior='enable-feature']").prop('checked', true).attr('disabled', false);
+        } else {
+          target.find('input:checkbox').not("[data-behavior='enable-feature']").prop('checked', false).attr('disabled', true);
+        }
+      });
+    });
+  }
+}

data/app/{assets/javascripts → javascript}/spotlight/admin/block_mixins/autocompleteable.js

@@ -6,23 +6,23 @@
     initializeAutocompleteable: function() {
       this.on("onRender", this.addAutocompletetoSirTrevorForm);
 
-      if (_.isUndefined(this['autocomplete_url'])) {
+      if (this['autocomplete_url'] === undefined) {
         this.autocomplete_url = function() { return $('form[data-autocomplete-url]').data('autocomplete-url').replace("%25QUERY", "%QUERY"); };
       }
 
-      if (_.isUndefined(this['autocomplete_template'])) {
+      if (this['autocomplete_template'] === undefined) {
         this.autocomplete_url = function() { return '<div class="autocomplete-item{{#if private}} blacklight-private{{/if}}">{{#if thumbnail}}<div class="document-thumbnail"><img class="img-thumbnail" src="{{thumbnail}}" /></div>{{/if}}<span class="autocomplete-title">{{title}}</span><br/><small>&nbsp;&nbsp;{{description}}</small></div>' };
       }
 
-      if (_.isUndefined(this['transform_autocomplete_results'])) {
-        this.transform_autocomplete_results = _.identity;
+      if (this['transform_autocomplete_results'] === undefined) {
+        this.transform_autocomplete_results = (val) => val
       }
 
-      if (_.isUndefined(this['autocomplete_control'])) {
-        this.autocomplete_control = function() { return '<input type="text" class="st-input-string form-control item-input-field" data-twitter-typeahead="true" placeholder="<%= i18n.t("blocks:autocompleteable:placeholder")%>"/>' };
+      if (this['autocomplete_control'] === undefined) {
+        this.autocomplete_control = function() { return `<input type="text" class="st-input-string form-control item-input-field" data-twitter-typeahead="true" placeholder="${i18n.t("blocks:autocompleteable:placeholder")}"/>` };
       }
 
-      if (_.isUndefined(this['bloodhoundOptions'])) {
+      if (this['bloodhoundOptions'] === undefined) {
         this.bloodhoundOptions = function() {
           return {
             remote: {
@@ -55,7 +55,7 @@
 
     bloodhound: function() {
       var block = this;
-      var results = new Bloodhound(_.extend({
+      var results = new Bloodhound(Object.assign({
         datumTokenizer: function(d) {
           return Bloodhound.tokenizers.whitespace(d.title);
         },

data/app/{assets/javascripts → javascript}/spotlight/admin/block_mixins/formable.js

@@ -5,7 +5,7 @@
 
     initializeFormable: function() {
 
-      if (_.isUndefined(this['afterLoadData'])) {
+      if (this['afterLoadData'] === undefined) {
         this['afterLoadData'] = function(data) { };
       }
     },

data/app/javascript/spotlight/admin/block_mixins/plustextable.js

@@ -0,0 +1,58 @@
+(function ($){
+  SirTrevor.BlockMixins.Plustextable = {
+    mixinName: "Textable",
+    preload: true,
+
+    initializeTextable: function() {
+      if (this['formId'] === undefined) {
+        this.withMixin(SirTrevor.BlockMixins.Formable);
+      }
+      
+      if (this['show_heading'] === undefined) {
+        this.show_heading = true;
+      }
+    },
+    
+    align_key:"text-align",
+    text_key:"item-text",
+    heading_key: "title",
+    
+    text_area: function() { 
+      return `
+      <div class="row">
+        <div class="col-md-8">
+          <div class="form-group">
+            ${this.heading()}
+            <div class="field">
+              <label for="${this.formId(this.text_key)}" class="col-form-label">${i18n.t("blocks:textable:text")}</label>
+              <div id="${this.formId(this.text_key)}" class="st-text-block form-control" contenteditable="true"></div>
+            </div>
+          </div>
+        </div>
+        <div class="col-md-4">
+          <div class="text-align">
+            <p>${i18n.t("blocks:textable:align:title")}</p>
+            <input data-key="${this.align_key}" type="radio" name="${this.formId(this.align_key)}" id="${this.formId(this.align_key + "-left")}" value="left" checked="true">
+            <label for="${this.formId(this.align_key + "-left")}">${i18n.t("blocks:textable:align:left")}</label>
+            <input data-key="${this.align_key}" type="radio" name="${this.formId(this.align_key)}" id="${this.formId(this.align_key + "-right")}" value="right">
+            <label for="${this.formId(this.align_key + "-right")}">${i18n.t("blocks:textable:align:right")}</label>
+          </div>
+        </div>
+      </div>`
+    },
+    
+    heading: function() {
+      if(this.show_heading) {
+        return `<div class="field">
+          <label for="${this.formId(this.heading_key)}" class="col-form-label">${i18n.t("blocks:textable:heading")}</label>
+          <input type="text" class="form-control" id="${this.formId(this.heading_key)}" name="${this.heading_key}" />
+        </div>`
+      } else {
+        return "";
+      }
+    },
+  };
+  
+
+  SirTrevor.Block.prototype.availableMixins.push("plustextable");
+})(jQuery);

data/app/{assets/javascripts → javascript}/spotlight/admin/blocks/block.js

@@ -1,3 +1,4 @@
+import Spotlight from 'spotlight'
 (function ($){
   Spotlight.Block = SirTrevor.Block.extend({
     scribeOptions: {
@@ -6,7 +7,7 @@
     },
     formable: true,
     editorHTML: function() {
-      return _.template(this.template)(this);
+      return '';
     },
     beforeBlockRender: function() {
       this.availableMixins.forEach(function(mixin) {