blacklight-spotlight 3.0.0.rc2 → 3.0.0.rc3

data/app/builders/spotlight/bootstrap_breadcrumbs_builder.rb

@@ -31,8 +31,7 @@ module Spotlight
     private
 
     def element_label(element)
-      label = compute_name(element)
-      @context.truncate(label, escape: !label.html_safe?, length: 30, separator: ' ')
+      @context.content_tag(:span, class: 'truncated-value') { compute_name(element) }
     end
   end
 end

data/app/controllers/concerns/spotlight/search_helper.rb

@@ -4,15 +4,9 @@ module Spotlight
   # ...
   module SearchHelper
     def search_service(user_params = respond_to?(:search_state, true) ? search_state.to_h : {})
-      search_service_class.new(config: blacklight_config, user_params: user_params, **search_service_context)
-    end
+      klass = respond_to?(:search_service_class) ? search_service_class : Blacklight::SearchService
 
-    def search_service_class
-      if defined?(super)
-        super
-      else
-        Blacklight::SearchService
-      end
+      klass.new(config: blacklight_config, user_params: user_params, **search_service_context)
     end
 
     # @return [Hash] a hash of context information to pass through to the search service

data/app/controllers/spotlight/appearances_controller.rb

@@ -30,18 +30,5 @@ module Spotlight
                                       masthead_attributes: featured_image_params,
                                       thumbnail_attributes: featured_image_params)
     end
-
-    def featured_image_params
-      %i[
-        iiif_region iiif_tilesource
-        iiif_manifest_url iiif_canvas_id
-        iiif_image_id
-        display
-        source
-        image
-        document_global_id
-        upload_id
-      ]
-    end
   end
 end

data/app/controllers/spotlight/browse_controller.rb

@@ -9,7 +9,8 @@ module Spotlight
     include Spotlight::Catalog
     include Blacklight::Facet
 
-    load_and_authorize_resource :search, except: :index, through: :exhibit, parent: false
+    load_and_authorize_resource :group, through: :exhibit
+    load_and_authorize_resource :search, through: %i[group exhibit], parent: false
     before_action :attach_breadcrumbs
     before_action :attach_search_breadcrumb, only: :show
     record_search_parameters only: :show
@@ -20,10 +21,12 @@ module Spotlight
 
     before_action do
       blacklight_config.track_search_session = false
+      blacklight_config.view.gallery.classes = 'row-cols-2 row-cols-md-4'
     end
 
     def index
-      @searches = @exhibit.searches.published
+      @groups = @exhibit.groups.published
+      @searches = @searches.published
     end
 
     def show
@@ -66,10 +69,11 @@ module Spotlight
     def attach_breadcrumbs
       add_breadcrumb t(:'spotlight.curation.nav.home', title: @exhibit.title), @exhibit
       add_breadcrumb(@exhibit.main_navigations.browse.label_or_default, exhibit_browse_index_path(@exhibit))
+      add_breadcrumb(@group.title, exhibit_browse_groups_path(@exhibit, @group)) if @group.present?
     end
 
     def attach_search_breadcrumb
-      add_breadcrumb @search.full_title, exhibit_browse_path(@exhibit, @search)
+      add_breadcrumb @search.full_title, (@group.present? ? exhibit_browse_group_path(@exhibit, @group, @search) : exhibit_browse_path(@exhibit, @search))
     end
 
     def _prefixes

data/app/controllers/spotlight/catalog_controller.rb

@@ -127,7 +127,7 @@ module Spotlight
       # /exhibits/1?f%5Bgenre_sim%5D%5B%5D=map&q= is not the same as /exhibits/1
       # Otherwise the exhibit breadcrumb won't be a link.
       # see http://api.rubyonrails.org/classes/ActionView/Helpers/UrlHelper.html#method-i-current_page-3F
-      if view_context.current_page?(action: :admin)
+      if view_context.current_page?({ action: :admin })
         add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), exhibit_root_path(@exhibit, q: '')
       else
         # When not on the admin page, get the translated value for the "Home" breadcrumb

data/app/controllers/spotlight/concerns/application_controller.rb

@@ -38,7 +38,6 @@ module Spotlight
         end
       end
 
-      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       def field_enabled?(field, *args)
         if !field.enabled
           false
@@ -52,7 +51,6 @@ module Spotlight
           field.send(document_index_view_type)
         end
       end
-      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
       private
 
@@ -82,6 +80,19 @@ module Spotlight
       def default_document_index_view_type
         document_index_views.select { |_k, config| config.respond_to?(:default) && config.default }.keys.first || document_index_views.keys.first
       end
+
+      def featured_image_params
+        %i[
+          iiif_region iiif_tilesource
+          iiif_manifest_url iiif_canvas_id
+          iiif_image_id
+          display
+          source
+          image
+          document_global_id
+          upload_id
+        ]
+      end
     end
   end
 end

data/app/controllers/spotlight/groups_controller.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Spotlight
+  ##
+  # Base CRUD controller for groups
+  class GroupsController < Spotlight::ApplicationController
+    before_action :authenticate_user!
+    load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+    load_and_authorize_resource through: :exhibit
+
+    def index
+      respond_to do |format|
+        format.json do
+          render json: @groups.as_json, root: false
+        end
+      end
+    end
+
+    # POST /exhibits/1/groups
+    def create
+      @group.attributes = group_params
+
+      if @group.save
+        redirect_to(
+          spotlight.exhibit_searches_path(anchor: 'browse-groups'),
+          notice: t(:'helpers.submit.group.created', model: human_name)
+        )
+      else
+        redirect_to spotlight.exhibit_searches_path(anchor: 'browse-groups')
+      end
+    end
+
+    # PATCH/PUT /groups/1
+    def update
+      @group.update(group_params)
+
+      redirect_to spotlight.exhibit_searches_path(anchor: 'browse-groups'), notice: t(:'helpers.submit.group.updated', model: human_name)
+    end
+
+    # DELETE /groups/1
+    def destroy
+      @group.destroy
+
+      redirect_to spotlight.exhibit_searches_path(anchor: 'browse-groups'), alert: t(:'helpers.submit.group.destroyed', model: human_name)
+    end
+
+    def update_all
+      notice = if @exhibit.update update_all_group_params
+                 t(:'helpers.submit.group.batch_updated', model: human_name)
+               else
+                 t(:'helpers.submit.group.batch_error', model: human_name)
+               end
+      redirect_to spotlight.exhibit_searches_path(anchor: 'browse-groups'), notice: notice
+    end
+
+    protected
+
+    def allowed_group_params
+      [:title]
+    end
+
+    private
+
+    def human_name
+      @human_name ||= @group ? @group.class.model_name.human.downcase : Spotlight::Group.model_name.human.pluralize
+    end
+
+    alias group_collection_name controller_name
+
+    def update_all_group_params
+      params.require(:exhibit).permit(
+        groups_attributes: %i[id title published weight]
+      )
+    end
+
+    def group_params
+      params.require(controller_name.singularize).permit(allowed_group_params)
+    end
+  end
+end

data/app/controllers/spotlight/pages_controller.rb

@@ -19,6 +19,10 @@ module Spotlight
 
     helper_method :get_search_results, :search_results, :fetch, :page_collection_name, :presenter
 
+    before_action do
+      blacklight_config.view.gallery.classes = 'row-cols-2 row-cols-md-4' unless @page&.display_sidebar
+    end
+
     # GET /exhibits/1/pages
     def index
       # set up a model the inline "add a new page" form
@@ -146,14 +150,7 @@ module Spotlight
     end
 
     def allowed_page_params
-      [:title, :content, thumbnail_attributes: featured_image_attributes]
-    end
-
-    def featured_image_attributes
-      %i[
-        source image document_global_id iiif_region iiif_tilesource
-        iiif_manifest_url iiif_canvas_id iiif_image_id
-      ]
+      [:title, :content, thumbnail_attributes: featured_image_params]
     end
 
     def human_name

data/app/controllers/spotlight/searches_controller.rb

@@ -5,9 +5,8 @@ module Spotlight
   # CRUD actions for curating browse categories (see
   # {Spotlight::BrowseController} for the end-user read and index actions)
   class SearchesController < Spotlight::ApplicationController
-    load_resource :exhibit, class: 'Spotlight::Exhibit'
+    load_and_authorize_resource :exhibit, class: 'Spotlight::Exhibit', parent_action: :curate
     before_action :authenticate_user!
-    before_action :only_curators!
     before_action :create_or_load_resource, only: [:create]
     load_and_authorize_resource through: :exhibit
     before_action :attach_breadcrumbs, only: %i[index edit], unless: -> { request.format.json? }
@@ -28,6 +27,7 @@ module Spotlight
     end
 
     def index
+      @groups = @exhibit.groups
       respond_to do |format|
         format.html
         format.json do
@@ -50,6 +50,7 @@ module Spotlight
     end
 
     def edit
+      @groups = @exhibit.groups
       add_breadcrumb @search.full_title, edit_exhibit_search_path(@search.exhibit, @search)
       @exhibit = @search.exhibit
     end
@@ -109,6 +110,7 @@ module Spotlight
         :long_description,
         :search_box,
         :default_index_view_type,
+        group_ids: [],
         masthead_attributes: featured_image_params,
         thumbnail_attributes: featured_image_params
       )
@@ -118,21 +120,6 @@ module Spotlight
       params.to_unsafe_h.with_indifferent_access.except(:exhibit_id, :search, *blacklisted_search_session_params).reject { |_k, v| v.blank? }
     end
 
-    def featured_image_params
-      %i[
-        iiif_region iiif_tilesource
-        iiif_manifest_url iiif_canvas_id iiif_image_id
-        display
-        source
-        image
-        document_global_id
-      ]
-    end
-
-    def only_curators!
-      authorize! :curate, @exhibit if @exhibit
-    end
-
     def blacklisted_search_session_params
       %i[id commit counter total search_id page per_page authenticity_token utf8 action controller]
     end

data/app/helpers/spotlight/application_helper.rb

@@ -132,7 +132,7 @@ module Spotlight
 
     def uploaded_field_label(config)
       solr_field = Array(config.solr_field || config.field_name).first.to_s
-      blacklight_config.index_fields[solr_field].try(:label) || config.label || t(".#{solr_field}")
+      blacklight_config.index_fields[solr_field]&.label || config.label || t(".#{solr_field}")
     end
 
     def available_view_fields

data/app/helpers/spotlight/crud_link_helpers.rb

@@ -112,7 +112,7 @@ module Spotlight
       defaults << :"helpers.action.#{object_name}.#{key}"
       defaults << :"helpers.action.#{key}"
       defaults << "#{key.to_s.humanize} #{model}"
-      I18n.t(defaults.shift, model: model, default: defaults)
+      I18n.t(defaults.shift, model: model.downcase, default: defaults)
     end
     # rubocop:enable Metrics/MethodLength
   end

data/app/helpers/spotlight/main_app_helpers.rb

@@ -24,7 +24,7 @@ module Spotlight
     end
 
     def link_back_to_catalog(opts = { label: nil })
-      opts[:route_set] ||= spotlight if (current_search_session.try(:query_params) || {}).fetch(:controller, '').starts_with? 'spotlight'
+      opts[:route_set] ||= spotlight if (current_search_session&.query_params || {}).fetch(:controller, '').starts_with? 'spotlight'
       super
     end
 

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SirTrevorRails
+  module Blocks
+    ##
+    # Browese Group Categories
+    class BrowseGroupCategoriesBlock < SirTrevorRails::Block
+      include Displayable
+
+      def display_item_counts?
+        send(:'display-item-counts') == 'true'
+      end
+
+      def groups
+        @groups ||= parent.exhibit.groups.published.where(slug: item_ids).sort do |a, b|
+          ordered_items.index(a.slug) <=> ordered_items.index(b.slug)
+        end
+      end
+
+      def groups?
+        !groups.empty?
+      end
+    end
+  end
+end

data/app/models/spotlight/ability.rb

@@ -25,6 +25,7 @@ module Spotlight
       can :manage, [
         Spotlight::Attachment,
         Spotlight::Search,
+        Spotlight::Group,
         Spotlight::Resource,
         Spotlight::Page,
         Spotlight::Contact,
@@ -43,6 +44,7 @@ module Spotlight
       can :read, Spotlight::Exhibit, published: true
       can :read, Spotlight::Page, published: true
       can :read, Spotlight::Search, published: true
+      can :read, Spotlight::Group, published: true
       can :read, Spotlight::Language, public: true
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength

data/app/models/spotlight/about_page.rb

@@ -6,7 +6,7 @@ module Spotlight
   class AboutPage < Spotlight::Page
     extend FriendlyId
     friendly_id :title, use: %i[slugged scoped finders history], scope: %i[exhibit locale] do |config|
-      config.reserved_words.concat(%w[update_all contacts])
+      config.reserved_words&.concat(%w[update_all contacts])
     end
   end
 end

data/app/models/spotlight/blacklight_configuration.rb

@@ -76,6 +76,7 @@ module Spotlight
 
         config.show.merge! show unless show.blank?
         config.index.merge! index unless index.blank?
+        config.index.respond_to[:iiif_json] = true
 
         config.index.thumbnail_field ||= Spotlight::Engine.config.thumbnail_field
 
@@ -353,7 +354,7 @@ module Spotlight
     def title_only_by_default?(view)
       return false if %i[show enabled].include?(view)
 
-      title_only = default_blacklight_config.view.send(:[], view).try(:title_only_by_default)
+      title_only = default_blacklight_config.view.send(:[], view)&.title_only_by_default
       title_only.nil? ? false : title_only
     end
 

data/app/models/spotlight/exhibit.rb

@@ -4,6 +4,7 @@ require 'mail'
 module Spotlight
   ##
   # Spotlight exhibit
+  # rubocop:disable Metrics/ClassLength
   class Exhibit < ActiveRecord::Base
     class_attribute :themes_selector
     include Spotlight::ExhibitAnalytics
@@ -22,11 +23,16 @@ module Spotlight
     paginates_per 48
 
     extend FriendlyId
-    friendly_id :title, use: %i[slugged finders]
+    friendly_id :title, use: %i[slugged finders] do |config|
+      config.reserved_words&.concat(%w[site])
+    end
+
     validates :title, presence: true, if: -> { I18n.locale == I18n.default_locale }
     validates :slug, uniqueness: true
     validates :theme, inclusion: { in: Spotlight::Engine.config.exhibit_themes }, allow_blank: true
 
+    after_validation :move_friendly_id_error_to_slug
+
     acts_as_tagger
     acts_as_taggable
     delegate :blacklight_config, to: :blacklight_configuration
@@ -50,6 +56,7 @@ module Spotlight
     has_many :custom_search_fields, dependent: :delete_all
 
     has_many :feature_pages, -> { for_default_locale }, extend: FriendlyId::FinderMethods
+    has_many :groups, dependent: :delete_all
     has_many :main_navigations, dependent: :delete_all
     has_many :reindexing_log_entries, dependent: :destroy
     has_many :resources
@@ -70,7 +77,7 @@ module Spotlight
     belongs_to :masthead, dependent: :destroy, optional: true
     belongs_to :thumbnail, class_name: 'Spotlight::ExhibitThumbnail', dependent: :destroy, optional: true
 
-    accepts_nested_attributes_for :about_pages, :attachments, :contacts, :custom_fields, :feature_pages, :languages,
+    accepts_nested_attributes_for :about_pages, :attachments, :contacts, :custom_fields, :feature_pages, :groups, :languages,
                                   :main_navigations, :owned_taggings, :pages, :resources, :searches, :solr_document_sidecars, :translations
     accepts_nested_attributes_for :blacklight_configuration, :home_page, :filters, update_only: true
     accepts_nested_attributes_for :masthead, :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
@@ -151,5 +158,10 @@ module Spotlight
     def current_reindexing_log_entry
       reindexing_log_entries.started_or_completed.first || reindexing_log_entries.build
     end
+
+    def move_friendly_id_error_to_slug
+      errors.add :slug, *errors.delete(:friendly_id) if errors[:friendly_id].present?
+    end
   end
+  # rubocop:enable Metrics/ClassLength
 end