blacklight-spotlight 4.1.1 → 4.2.0

data/app/controllers/spotlight/sites_controller.rb

@@ -9,13 +9,13 @@ module Spotlight
     load_and_authorize_resource
 
     def edit
-      add_breadcrumb t(:'spotlight.sites.home'), root_url
-      add_breadcrumb t(:'spotlight.sites.edit.page_title')
+      add_breadcrumb(t(:'spotlight.sites.home'), root_url)
+      add_breadcrumb(t(:'spotlight.sites.edit.page_title'))
     end
 
     def edit_exhibits
-      add_breadcrumb t(:'spotlight.sites.home'), root_url
-      add_breadcrumb t(:'spotlight.sites.edit_exhibits.page_title')
+      add_breadcrumb(t(:'spotlight.sites.home'), root_url)
+      add_breadcrumb(t(:'spotlight.sites.edit_exhibits.page_title'))
     end
 
     def update

data/app/controllers/spotlight/tags_controller.rb

@@ -14,9 +14,9 @@ module Spotlight
 
     def index
       @tags = @exhibit.owned_tags
-      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
-      add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
-      add_breadcrumb t(:'spotlight.curation.sidebar.tags'), exhibit_tags_path(@exhibit)
+      add_breadcrumb(t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit)
+      add_breadcrumb(t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit))
+      add_breadcrumb(t(:'spotlight.curation.sidebar.tags'), exhibit_tags_path(@exhibit))
 
       respond_to do |format|
         format.html

data/app/controllers/spotlight/translations_controller.rb

@@ -40,9 +40,9 @@ module Spotlight
     private
 
     def attach_breadcrumbs
-      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
-      add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
-      add_breadcrumb t(:'spotlight.curation.sidebar.translations')
+      add_breadcrumb(t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit)
+      add_breadcrumb(t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit))
+      add_breadcrumb(t(:'spotlight.curation.sidebar.translations'))
     end
 
     def exhibit_params

data/app/javascript/spotlight/admin/edit_in_place.js

@@ -43,5 +43,32 @@ export default class {
         return false;
       });
     })
+
+    $("[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('keypress', function(e) {
+        if(e.which == 13) {
+          hidden.trigger('blur');
+          return false;
+        }
+      });
+
+      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/index.js

@@ -8,7 +8,6 @@ import 'Path.Drag'
 
 import AddAnother from 'spotlight/admin/add_another'
 import AddNewButton from 'spotlight/admin/add_new_button'
-import Appearance from 'spotlight/admin/appearance'
 import BlacklightConfiguration from 'spotlight/admin/blacklight_configuration'
 import CopyEmailAddress from 'spotlight/admin/copy_email_addresses'
 import Croppable from 'spotlight/admin/croppable'
@@ -60,7 +59,6 @@ export default class {
   connect() {
     new AddAnother().connect()
     new AddNewButton().connect()
-    new Appearance().connect()
     new CopyEmailAddress().connect()
     new Croppable().connect()
     new EditInPlace().connect()

data/app/models/breadcrumb.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Breadcrumb model
+class Breadcrumb
+  attr_reader :name, :path
+
+  def initialize(name, path)
+    @name = name
+    @path = path
+  end
+
+  def link?
+    @path.present?
+  end
+end

data/app/models/spotlight/analytics/ga.rb

@@ -37,8 +37,8 @@ module Spotlight
           filter: Google::Analytics::Data::V1beta::Filter.new(
             field_name: 'pagePath',
             string_filter: Google::Analytics::Data::V1beta::Filter::StringFilter.new(
-              match_type: :BEGINS_WITH,
-              value: path.to_s
+              match_type: :PARTIAL_REGEXP,
+              value: "^#{path}(/.*)?$"
             )
           )
         )

data/app/views/shared/_exhibit_navbar.html.erb

@@ -1,24 +1,2 @@
-<div id="exhibit-navbar" class="exhibit-navbar navbar navbar-light navbar-expand-md" role="navigation" aria-label="<%= t('spotlight.exhibitnavbar.label') %>">
-  <div class="container flex-column flex-md-row">
-    <% if resource_masthead? %>
-      <%= link_to(current_exhibit.title, spotlight.exhibit_path(current_exhibit), class: 'navbar-brand') %>
-    <% end %>
-
-    <ul class="navbar-nav <%= resource_masthead? ? 'justify-content-md-end' : 'mr-auto me-auto' %>">
-      <li class="nav-item <%= "active" if current_page?([spotlight, current_exhibit]) %>"><%= link_to t(:'spotlight.curation.nav.home'), [spotlight, current_exhibit], class: 'nav-link' %></li>
-      <% current_exhibit.main_navigations.displayable.each do |navigation| %>
-        <%= render partial: "shared/#{navigation.nav_type}_navbar", locals: { navigation: navigation } %>
-      <% end %>
-    </ul>
-    <% if should_render_spotlight_search_bar? %>
-      <div class="navbar-right navbar-nav exhibit-search-form mt-3 mt-md-0">
-        <%= render 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
-        ) %>
-      </div>
-    <% end %>
-  </div>
-</div>
+<%- Spotlight.deprecator.warn("_exhibit_navbar.html.erb will be removed.  Customize the exhibit navbar using components instead.") %>
+<%= render (blacklight_config&.exhibit_navbar_component || Spotlight::ExhibitNavbarComponent).new %>

data/app/views/shared/_masthead.html.erb

@@ -42,4 +42,4 @@
   <%= masthead_navbar unless resource_masthead? %>
 </header>
 
-<%= render 'shared/breadcrumbs' unless resource_masthead? %>
+<%= render Spotlight::BreadcrumbsComponent.new(breadcrumbs:) %>

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

@@ -11,7 +11,7 @@
   </thead>
 
   <% if Blacklight.version < '8.0' %>
-    <%= render view_config.document_component.with_collection(documents) %>
+    <%= render (view_config.document_component || Spotlight::DocumentAdminTableComponent).with_collection(documents) %>
   <% else %>
     <% document_presenters = documents.map { |doc| document_presenter(doc) } -%>
     <%= render view_config.document_component.with_collection(document_presenters) %>

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

@@ -1,7 +1,7 @@
 <div class="container">
   <div class="row">
     <%- view_config = blacklight_config.view_config(action_name: :edit) %>
-    <%= render (view_config.document_component || Blacklight::DocumentComponent).new(presenter: document_presenter(@document), classes: ['col-md-8'], component: :div, show: true, actions: false, partials: view_config.partials) do |component| %>
+    <%= render (view_config.document_component || Blacklight::DocumentComponent).new((Blacklight.version > '8.0' ? :document : :presenter) => document_presenter(@document), classes: ['col-md-8'], component: :div, show: true, actions: false, partials: view_config.partials) do |component| %>
       <% component.with_title(as: 'h1', classes: '', link_to_document: false) %>
       <% component.with_body do %>
         <% view_config.partials.each do |view_partial| %>

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

@@ -3,7 +3,7 @@
   <%= f.text_field :title, disabled: !default_language?, help: !default_language? ? t('.uneditable_non_default_language') : '' %>
   <%= f.text_field :subtitle %>
   <%= f.text_area :description %>
-  <%= f.text_field :tag_list, value: f.object.tag_list.to_s %>
+  <%= render Spotlight::TagListFormComponent.new(form: f) %>
   <%= f.form_group(:contact_emails, label: { text: nil, class: nil, for: 'exhibit_contact_email_0' }, class: 'form-group mb-3', help: nil) do %>
     <%= f.fields_for :contact_emails do |contact| %> 
       <%= render partial: 'contact', locals: {exhibit: @exhibit, contact: contact} %>

data/app/views/spotlight/exhibits/_new_exhibit_form.html.erb

@@ -1,7 +1,7 @@
 <%= bootstrap_form_for @exhibit, url: ((spotlight.exhibit_path(@exhibit) if @exhibit.persisted?) || spotlight.exhibits_path), layout: :horizontal, label_col: 'col-md-2', control_col: 'col-md-10' do |f| %>
   <%= f.text_field :title, label: t(:'.fields.title.label'), help: t(:'.fields.title.help_block') %>
   <%= f.text_field :slug, label: t(:'.fields.slug.label'), help: t(:'.fields.slug.help_block') %>
-  <%= f.text_field :tag_list %>
+  <%= render Spotlight::TagListFormComponent.new(form: f) %>
 
   <%= render 'initial_resources_form', locals: { f: f } %>
 

data/app/views/spotlight/metadata_configurations/_metadata_field.html.erb

@@ -1,12 +1,23 @@
-<tr data-id="<%= key.parameterize %>" class="dd-item">
+<% default_field_label = local_assigns.dig(:config, :original, :label) %>
+
+<tr data-id="<%= key.parameterize %>" class="dd-item" data-behavior="restore-default">
   <%= f.fields_for key do |field| %>
     <td>
       <%= field.hidden_field :weight, 'data-property' => 'weight' %>
-      <div class="handle-wrap" data-in-place-edit-target=".edit-in-place" data-in-place-edit-field-target="[data-edit-field-target='true']">
+      <div class="handle-wrap d-flex">
         <div class="dd-handle dd3-handle"><%= t :drag %></div>
-        <a href="#edit-in-place" class="field-label edit-in-place"><%= config.display_label %></a>
-        <%= field.hidden_field :label, value: config.display_label, class: 'form-control form-control-sm', data: {:"edit-field-target" => 'true'} %>
-       </div>
+        <div class="flex-grow-1 align-self-center">
+          <span data-in-place-edit-target=".edit-in-place" data-in-place-edit-field-target="[data-edit-field-target='true']">
+            <a href="#edit-in-place" class="field-label edit-in-place align-self-center"><%= config.display_label %></a>
+            <%= field.hidden_field :label, value: config.display_label, class: 'metadata-label-edit form-control form-control-sm', data: {:"edit-field-target" => 'true', default_value: default_field_label} %>
+          </span>
+        </div>
+        <% if default_field_label %>
+          <div class="restore-default">
+            <%= button_tag t(:'.restore_default'), data: {:"restore-default" => true}, class: "btn btn-secondary btn-sm #{'d-none' if config.display_label == default_field_label}" %>
+          </div>
+        <% end %>
+      </div>
     </td>
     <td class="checkbox-cell text-center">
       <%= field.check_box_without_bootstrap :show, checked: config.show, disabled: !config.immutable.show.nil?, hide_label: true %>

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

@@ -8,10 +8,10 @@
 
     <p class="instructions"><%= t :'.instructions' %></p>
 
-    <table id="nested-fields" class="table table-striped dd-table">
+    <table id="nested-fields" class="metadata-configuration table table-striped dd-table">
       <thead>
         <tr>
-          <th><%= t :'.field.label' %></th>
+          <th class="w-50"><%= t :'.field.label' %></th>
           <th class="text-center">
             <div>
               <%= t :'.view.show' %>

data/config/locales/spotlight.en.yml

@@ -707,6 +707,8 @@ en:
         select_all: Select all
         view:
           show: Item details
+      metadata_field:
+        restore_default: Restore default
     pages:
       edit:
         header: Edit page
@@ -721,6 +723,8 @@ en:
       index:
         about_pages:
           header: About pages
+        bulk_updates:
+          header: Bulk updates
         feature_pages:
           header: Feature pages
           home_pages_header: Homepage

data/lib/generators/spotlight/templates/catalog_controller.rb

@@ -16,6 +16,7 @@ class CatalogController < ApplicationController
     # Blacklight 8 sets a default value to 'advanced'
     config.json_solr_path = nil
     config.header_component = Spotlight::HeaderComponent
+    config.exhibit_navbar_component = Spotlight::ExhibitNavbarComponent
     config.document_solr_path = 'get'
     config.document_unique_id_param = 'ids'
 

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

@@ -83,6 +83,10 @@
 #   Spotlight::Engine.config.ga_debug_mode = false
 # end
 
+# ==> Customizable settings for site tags
+# When set the free text tag list field becomes multiple selection checklist
+# Spotlight::Engine.config.site_tags = []
+
 # ==> Sir Trevor Widget Configuration
 # These are set by default by Spotlight's configuration,
 # but you can customize them here, or in the SirTrevorRails::Block#custom_block_types method

data/lib/spotlight/engine.rb

@@ -27,15 +27,6 @@ module Spotlight
   # rubocop:disable Metrics/ClassLength
   class Engine < ::Rails::Engine
     isolate_namespace Spotlight
-    # Breadcrumbs on rails must be required outside of an initializer or it doesn't get loaded.
-    require 'breadcrumbs_on_rails/breadcrumbs'
-    require 'breadcrumbs_on_rails/action_controller'
-
-    initializer 'breadcrumbs_on_rails.initialize' do
-      ActiveSupport.on_load(:action_controller) do
-        include BreadcrumbsOnRails::ActionController
-      end
-    end
 
     require 'carrierwave'
     require 'redcarpet' # required for markdown support in github/markup https://github.com/github/markup#markups
@@ -145,6 +136,8 @@ module Spotlight
     config.full_image_field = :full_image_url_ssm
     config.thumbnail_field = :thumbnail_url_ssm
 
+    Spotlight::Engine.config.site_tags = nil
+
     # Defaults to the blacklight_config.index.title_field:
     config.upload_title_field = nil # UploadFieldConfig.new(...)
     config.upload_description_field = :spotlight_upload_description_tesim

data/lib/spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spotlight
-  VERSION = '4.1.1'
+  VERSION = '4.2.0'
 end

data/spec/support/views/test_view_helpers.rb

@@ -14,7 +14,6 @@ module Spotlight
         view.send(:extend, Spotlight::CropHelper)
         view.send(:extend, Spotlight::PagesHelper)
         view.send(:extend, Blacklight::ComponentHelperBehavior)
-        view.send(:extend, BreadcrumbsOnRails::ActionController::HelperMethods)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 2024-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob-status
@@ -121,26 +121,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
-- !ruby/object:Gem::Dependency
-  name: breadcrumbs_on_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
 - !ruby/object:Gem::Dependency
   name: cancancan
   requirement: !ruby/object:Gem::Requirement
@@ -921,7 +901,6 @@ files:
 - app/assets/stylesheets/spotlight/_view_larger.scss
 - app/assets/stylesheets/spotlight/browse_group_categories_block.scss
 - app/assets/stylesheets/spotlight/typeahead.scss
-- app/builders/spotlight/bootstrap_breadcrumbs_builder.rb
 - app/components/blacklight/icons/arrow_alt_circle_left_component.rb
 - app/components/blacklight/icons/arrow_alt_circle_right_component.rb
 - app/components/blacklight/icons/arrow_back_ios_component.rb
@@ -941,14 +920,20 @@ files:
 - app/components/spotlight/analytics/aggregation_component.rb
 - app/components/spotlight/analytics/dashboard_component.html.erb
 - app/components/spotlight/analytics/dashboard_component.rb
+- app/components/spotlight/breadcrumbs_component.html.erb
+- app/components/spotlight/breadcrumbs_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/exhibit_navbar_component.html.erb
+- app/components/spotlight/exhibit_navbar_component.rb
 - app/components/spotlight/header_component.html.erb
 - app/components/spotlight/header_component.rb
 - app/components/spotlight/icon_component.rb
 - app/components/spotlight/solr_document_legacy_embed_component.html.erb
 - app/components/spotlight/solr_document_legacy_embed_component.rb
+- app/components/spotlight/tag_list_form_component.html.erb
+- app/components/spotlight/tag_list_form_component.rb
 - app/controllers/concerns/spotlight/base.rb
 - app/controllers/concerns/spotlight/catalog.rb
 - app/controllers/concerns/spotlight/config.rb
@@ -1016,7 +1001,6 @@ files:
 - app/javascript/spotlight/admin/add_another.js
 - app/javascript/spotlight/admin/add_image_selector.js
 - app/javascript/spotlight/admin/add_new_button.js
-- app/javascript/spotlight/admin/appearance.js
 - app/javascript/spotlight/admin/blacklight_configuration.js
 - app/javascript/spotlight/admin/block_mixins/autocompleteable.js
 - app/javascript/spotlight/admin/block_mixins/formable.js
@@ -1092,6 +1076,7 @@ files:
 - 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
 - app/models/concerns/spotlight/blacklight_configuration_defaults.rb
 - app/models/concerns/spotlight/browse_category_search_builder.rb
@@ -1207,7 +1192,6 @@ files:
 - app/views/shared/_about_navbar.html.erb
 - app/views/shared/_analytics.html.erb
 - app/views/shared/_body_preamble.html.erb
-- app/views/shared/_breadcrumbs.html.erb
 - app/views/shared/_browse_navbar.html.erb
 - app/views/shared/_curated_features_navbar.html.erb
 - app/views/shared/_exhibit_navbar.html.erb

data/app/builders/spotlight/bootstrap_breadcrumbs_builder.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Spotlight
-  # The BootstrapBreadcrumbsBuilder is a Bootstrap compatible breadcrumb builder.
-  # It provides basic functionalities to render a breadcrumb navigation according to Bootstrap's conventions.
-  #
-  # BootstrapBreadcrumbsBuilder accepts a limited set of options:
-  #
-  # You can use it with the :builder option on render_breadcrumbs:
-  #     <%= render_breadcrumbs :builder => Spotlight::BootstrapBreadcrumbsBuilder %>
-  #
-  class BootstrapBreadcrumbsBuilder < BreadcrumbsOnRails::Breadcrumbs::Builder
-    include ActionView::Helpers::OutputSafetyHelper
-
-    def render
-      return '' if @elements.blank?
-
-      @context.content_tag(:ul, class: 'breadcrumb') do
-        safe_join(@elements.uniq.map { |e| render_element(e) })
-      end
-    end
-
-    def render_element(element)
-      current = @context.current_page?(compute_path(element)) || element.options&.dig(:current)
-
-      html_class = 'active' if current
-
-      @context.content_tag(:li, class: "breadcrumb-item truncated-value #{html_class}") do
-        @context.link_to_unless(current, element_label(element), compute_path(element), element.options&.except(:current))
-      end
-    end
-
-    private
-
-    def element_label(element)
-      @context.content_tag(:span) { compute_name(element) }
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-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/views/shared/_breadcrumbs.html.erb

@@ -1,7 +0,0 @@
-<div class="container breadcrumbs-container" role="navigation" aria-label="<%= t('spotlight.breadcrumb.label') %>">
-  <div class="row">
-    <div class="col-md-12">
-      <%= render_breadcrumbs builder: Spotlight::BootstrapBreadcrumbsBuilder %>
-    </div>
-  </div>
-</div>