blacklight-spotlight 2.13.0 → 3.0.0.alpha.1

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'legato'
+
+module Spotlight
+  module Analytics
+    ##
+    # Google Analytics data model for the Exhibit dashboard
+    class GaModel
+      extend Legato::Model
+
+      metrics :sessions, :users, :pageviews
+
+      def self.context(exhibit)
+        if exhibit.is_a? Spotlight::Exhibit
+          for_exhibit(exhibit)
+        else
+          path(exhibit)
+        end
+      end
+
+      def self.for_exhibit(exhibit)
+        path(Spotlight::Engine.routes.url_helpers.exhibit_path(exhibit))
+      end
+
+      filter :path, &->(path) { contains(:pagePath, "^#{path}") }
+    end
+  end
+end

data/app/models/spotlight/blacklight_configuration.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'blacklight/utils'
+require 'blacklight/open_struct_with_hash_access'
 
 module Spotlight
   ##
@@ -70,7 +70,9 @@ module Spotlight
     def blacklight_config
       @blacklight_config ||= begin
         # Create a new config based on the defaults
-        config = default_blacklight_config.inheritable_copy
+        config = default_blacklight_config.inheritable_copy(self.class)
+
+        config.current_exhibit = exhibit
 
         config.show.merge! show unless show.blank?
         config.index.merge! index unless index.blank?
@@ -291,7 +293,7 @@ module Spotlight
       # 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,
+                                             link_to_facet: true,
                                              separator_options: { words_connector: nil, two_words_connector: nil, last_word_connector: nil }
       end
 

data/app/models/spotlight/contact_form.rb

@@ -20,16 +20,23 @@ module Spotlight
     def headers
       {
         to: to,
-        subject: "#{I18n.t(:'blacklight.application_name')} Contact Form",
-        from: %("#{name}" <#{email}>),
-        cc: current_exhibit.contact_emails.join(', ')
+        subject: I18n.t(:'spotlight.contact_form.subject', application_name: application_name),
+        cc: contact_emails.join(', ')
       }
     end
 
     private
 
+    def application_name
+      current_exhibit&.title || Spotlight::Site.instance.title || I18n.t(:'blacklight.application_name')
+    end
+
     def to
-      Spotlight::Engine.config.default_contact_email || current_exhibit.contact_emails.first.to_s
+      Spotlight::Engine.config.default_contact_email || contact_emails.first.to_s
+    end
+
+    def contact_emails
+      current_exhibit&.contact_emails || []
     end
   end
 end

data/app/models/spotlight/exhibit.rb

@@ -55,11 +55,7 @@ module Spotlight
     has_many :roles, as: :resource, dependent: :delete_all
     has_many :searches, dependent: :destroy, extend: FriendlyId::FinderMethods
     has_many :solr_document_sidecars, dependent: :delete_all
-
-    # Ignoring for https://github.com/rubocop-hq/rubocop/issues/6764
-    # rubocop:disable Rails/ReflectionClassName
     has_many :users, through: :roles, class_name: Spotlight::Engine.config.user_class
-    # rubocop:enable Rails/ReflectionClassName
 
     has_many :pages, dependent: :destroy
     has_many :filters, dependent: :delete_all

data/app/models/spotlight/field_metadata.rb

@@ -6,6 +6,8 @@ module Spotlight
   class FieldMetadata
     FACET_LIMIT = 20
 
+    include Spotlight::SearchHelper
+
     attr_reader :exhibit, :repository, :blacklight_config
 
     def initialize(exhibit, repository, blacklight_config)
@@ -23,7 +25,7 @@ module Spotlight
     end
 
     def search_params
-      search_builder.merge(rows: 0, 'facet.limit' => FACET_LIMIT + 1)
+      search_service.search_builder.merge(rows: 0, 'facet.limit' => FACET_LIMIT + 1)
     end
 
     private
@@ -36,14 +38,6 @@ module Spotlight
       end
     end
 
-    def search_builder_class
-      blacklight_config.search_builder_class
-    end
-
-    def search_builder
-      search_builder_class.new(self)
-    end
-
     def solr_response
       @solr_response ||= repository.search(search_params.merge('facet.query' => facet_fields.map { |_key, fields| "#{fields.field}:[* TO *]" },
                                                                'rows' => 0,

data/app/models/spotlight/page.rb

@@ -10,11 +10,8 @@ module Spotlight
     friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: [:exhibit, :locale]
 
     belongs_to :exhibit, touch: true
-    # Ignoring for https://github.com/rubocop-hq/rubocop/issues/6764
-    # rubocop:disable Rails/ReflectionClassName
     belongs_to :created_by, class_name: Spotlight::Engine.config.user_class, optional: true
     belongs_to :last_edited_by, class_name: Spotlight::Engine.config.user_class, optional: true
-    # rubocop:enable Rails/ReflectionClassName
 
     belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy, optional: true
     belongs_to :default_locale_page, class_name: 'Spotlight::Page', optional: true, inverse_of: :translated_pages

data/app/models/spotlight/page_configurations.rb

@@ -47,7 +47,7 @@ module Spotlight
     private
 
     def available_index_fields
-      fields = blacklight_config.index_fields.map { |k, _v| { key: k, label: index_field_label(nil, k) } }
+      fields = blacklight_config.index_fields.map { |k, _v| { key: k, label: index_field_label(blacklight_config.document_model.new, k) } }
       fields.unshift(key: document_show_link_field, label: t(:'spotlight.pages.form.title_placeholder')) unless index_fields.include? document_show_link_field
 
       fields

data/app/models/spotlight/role.rb

@@ -6,11 +6,7 @@ module Spotlight
   class Role < ActiveRecord::Base
     ROLES = %w(admin curator).freeze
     belongs_to :resource, polymorphic: true, optional: true
-
-    # Ignoring for https://github.com/rubocop-hq/rubocop/issues/6764
-    # rubocop:disable Rails/ReflectionClassName
     belongs_to :user, class_name: Spotlight::Engine.config.user_class, autosave: true, optional: false
-    # rubocop:enable Rails/ReflectionClassName
 
     validates :role, inclusion: { in: ROLES }
     validate :user_must_be_unique, if: :user

data/app/models/spotlight/search.rb

@@ -5,6 +5,8 @@ module Spotlight
   # Exhibit saved searches
   class Search < ActiveRecord::Base
     include Spotlight::Translatables
+    include Spotlight::SearchHelper
+
     extend FriendlyId
     friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: :exhibit
 
@@ -54,7 +56,7 @@ module Spotlight
     end
 
     def search_params
-      search_builder.with(query_params.with_indifferent_access).merge(facet: false, fl: default_search_fields)
+      search_service.search_builder.with(query_params.with_indifferent_access).merge(facet: false)
     end
 
     def merge_params_for_search(params, blacklight_config)
@@ -65,26 +67,10 @@ module Spotlight
 
     private
 
-    def search_builder_class
-      blacklight_config.search_builder_class
-    end
-
-    def search_builder
-      search_builder_class.new(self)
-    end
-
     def repository
       @repository ||= Blacklight::Solr::Repository.new(blacklight_config)
     end
 
-    def default_search_fields
-      [
-        blacklight_config.document_model.unique_key,
-        blacklight_config.index.title_field,
-        blacklight_config.index.thumbnail_field
-      ].compact
-    end
-
     def should_generate_new_friendly_id?
       return false if new_record? && slug.present?
 

data/app/presenters/spotlight/iiif_manifest_presenter.rb

@@ -56,7 +56,7 @@ module Spotlight
 
     # IIIFManifest will call #to_s on each leaf node to get its respective label (not called out in README).
     def to_s
-      resource.first(blacklight_config.view_config(:show).title_field)
+      presenter.heading
     end
 
     def iiif_manifest
@@ -69,6 +69,10 @@ module Spotlight
 
     private
 
+    def presenter
+      controller.view_context.show_presenter(resource)
+    end
+
     def endpoint
       IIIFManifest::IIIFEndpoint.new(iiif_url, profile: 'http://iiif.io/api/image/2/level2.json')
     end

data/app/serializers/spotlight/exhibit_export_serializer.rb

@@ -28,57 +28,64 @@ module Spotlight
   # Serialize an exhibit with all the data needed to reconstruct it
   # in a different environment
   class ExhibitExportSerializer < Roar::Decorator
+    def self.config?(config)
+      lambda do |**_args|
+        Spotlight::Engine.config.exports[config]
+      end
+    end
+
     include Roar::JSON
 
     (Spotlight::Exhibit.attribute_names - %w(id slug masthead_id thumbnail_id)).each do |prop|
-      property prop
+      property prop, if: config?(:config)
     end
 
-    property :theme, setter: lambda { |fragment:, represented:, **|
+    property :theme, if: config?(:config), setter: lambda { |fragment:, represented:, **|
       represented.theme = fragment if Spotlight::Engine.config.exhibit_themes.include? fragment
     }
 
+    collection :main_navigations, class: Spotlight::MainNavigation, decorator: MainNavigationRepresenter, if: config?(:config)
+    collection :contact_emails, class: Spotlight::ContactEmail, if: config?(:config) do
+      (Spotlight::ContactEmail.attribute_names - %w(id exhibit_id confirmation_token)).each do |prop|
+        property prop
+      end
+    end
+
     collection :searches, populator: ->(fragment, options) { options[:represented].searches.find_or_initialize_by(slug: fragment['slug']) },
+                          if: config?(:pages),
                           class: Spotlight::Search do
       (Spotlight::Search.attribute_names - %w(id scope exhibit_id masthead_id thumbnail_id)).each do |prop|
         property prop
       end
 
-      property :masthead, class: Spotlight::Masthead, decorator: FeaturedImageRepresenter
+      property :masthead, class: Spotlight::Masthead,
+                          decorator: FeaturedImageRepresenter,
+                          if: Spotlight::ExhibitExportSerializer.config?(:attachments)
 
-      property :thumbnail, class: Spotlight::FeaturedImage, decorator: FeaturedImageRepresenter
+      property :thumbnail, class: Spotlight::FeaturedImage,
+                           decorator: FeaturedImageRepresenter,
+                           if: Spotlight::ExhibitExportSerializer.config?(:attachments)
     end
 
     collection :about_pages, populator: ->(fragment, options) { options[:represented].about_pages.find_or_initialize_by(slug: fragment['slug']) },
+                             if: config?(:pages),
                              class: Spotlight::AboutPage,
                              decorator: PageRepresenter
 
     collection :feature_pages, populator: ->(fragment, options) { options[:represented].feature_pages.find_or_initialize_by(slug: fragment['slug']) },
                                getter: ->(_opts) { feature_pages.at_top_level },
                                class: Spotlight::FeaturePage,
-                               decorator: NestedPageRepresenter
+                               decorator: NestedPageRepresenter,
+                               if: config?(:pages)
 
     property :home_page, populator: ->(_fragment, options) { options[:represented].home_page },
                          class: Spotlight::HomePage,
-                         decorator: PageRepresenter
-
-    property :masthead, class: Spotlight::Masthead, decorator: FeaturedImageRepresenter
-
-    property :thumbnail, class: Spotlight::ExhibitThumbnail, decorator: FeaturedImageRepresenter
-
-    collection :main_navigations, class: Spotlight::MainNavigation, decorator: MainNavigationRepresenter
-
-    property :blacklight_configuration, class: Spotlight::BlacklightConfiguration, decorator: ConfigurationRepresenter
-
-    collection :custom_fields, populator: ->(fragment, options) { options[:represented].custom_fields.find_or_initialize_by(slug: fragment['slug']) },
-                               class: Spotlight::CustomField do
-      (Spotlight::CustomField.attribute_names - %w(id exhibit_id)).each do |prop|
-        property prop
-      end
-    end
+                         decorator: PageRepresenter,
+                         if: config?(:pages)
 
     collection :contacts, populator: ->(fragment, options) { options[:represented].contacts.find_or_initialize_by(slug: fragment['slug']) },
-                          class: Spotlight::Contact do
+                          class: Spotlight::Contact,
+                          if: config?(:pages) do
       (Spotlight::Contact.attribute_names - %w(id exhibit_id)).each do |prop|
         property prop
       end
@@ -86,13 +93,22 @@ module Spotlight
       property :avatar, class: Spotlight::ContactImage, decorator: FeaturedImageRepresenter
     end
 
-    collection :contact_emails, class: Spotlight::ContactEmail do
-      (Spotlight::ContactEmail.attribute_names - %w(id exhibit_id confirmation_token)).each do |prop|
+    property :masthead, class: Spotlight::Masthead, decorator: FeaturedImageRepresenter, if: config?(:attachments)
+
+    property :thumbnail, class: Spotlight::ExhibitThumbnail, decorator: FeaturedImageRepresenter, if: config?(:attachments)
+
+    property :blacklight_configuration, class: Spotlight::BlacklightConfiguration, decorator: ConfigurationRepresenter, if: config?(:blacklight_configuration)
+
+    collection :custom_fields, populator: ->(fragment, options) { options[:represented].custom_fields.find_or_initialize_by(slug: fragment['slug']) },
+                               class: Spotlight::CustomField,
+                               if: config?(:blacklight_configuration) do
+      (Spotlight::CustomField.attribute_names - %w(id exhibit_id)).each do |prop|
         property prop
       end
     end
 
-    collection :solr_document_sidecars, class: Spotlight::SolrDocumentSidecar do
+    collection :solr_document_sidecars, class: Spotlight::SolrDocumentSidecar,
+                                        if: config?(:resources) do
       (Spotlight::SolrDocumentSidecar.attribute_names - %w(id document_type exhibit_id)).each do |prop|
         property prop
       end
@@ -106,7 +122,8 @@ module Spotlight
       delegate :document_type=, to: :represented
     end
 
-    collection :owned_taggings, class: ActsAsTaggableOn::Tagging do
+    collection :owned_taggings, class: ActsAsTaggableOn::Tagging,
+                                if: config?(:resources) do
       property :taggable_id
       property :taggable_type
       property :context
@@ -121,7 +138,7 @@ module Spotlight
       end
     end
 
-    collection :attachments, class: Spotlight::Attachment do
+    collection :attachments, class: Spotlight::Attachment, if: config?(:attachments) do
       (Spotlight::Attachment.attribute_names - %w(id exhibit_id file)).each do |prop|
         property prop
       end
@@ -141,7 +158,8 @@ module Spotlight
       end
     end
 
-    collection :resources, class: ->(options) { options[:fragment].key?('type') ? options[:fragment]['type'].constantize : Spotlight::Resource } do
+    collection :resources, class: ->(options) { options[:fragment].key?('type') ? options[:fragment]['type'].constantize : Spotlight::Resource },
+                           if: config?(:resources) do
       (Spotlight::Resource.attribute_names - %w(id upload_id exhibit_id)).each do |prop|
         property prop
       end
@@ -160,5 +178,28 @@ module Spotlight
         FeaturedImageRepresenter.new(represented.build_upload).from_json(json)
       end
     end
+
+    collection :languages, class: Spotlight::Language,
+                           populator: ->(fragment, options) { options[:represented].languages.find_or_initialize_by(locale: fragment['locale']) },
+                           if: config?(:config) do
+      (Spotlight::Language.attribute_names - %w(id exhibit_id)).each do |prop|
+        property prop
+      end
+    end
+
+    collection :translations, getter: ->(represented:, **) { represented.translations.unscope(where: :locale) },
+                              populator: (lambda do |fragment, options|
+                                            options[:represented].translations
+                                                                 .unscope(where: :locale)
+                                                                 .find_or_initialize_by(locale: fragment['locale'], key: fragment['key'])
+                                          end),
+                              class: I18n::Backend::ActiveRecord::Translation,
+                              if: config?(:config) do
+      property :locale
+      property :key
+      property :value
+      property :interpolations
+      property :is_proc
+    end
   end
 end

data/app/serializers/spotlight/page_representer.rb

@@ -28,6 +28,6 @@ module Spotlight
                              class: Spotlight::FeaturePage,
                              extend: NestedPageRepresenter
 
-    property :thumbnail, class: Spotlight::FeaturedImage, decorator: FeaturedImageRepresenter
+    property :thumbnail, class: Spotlight::FeaturedImage, decorator: FeaturedImageRepresenter, if: Spotlight::ExhibitExportSerializer.config?(:attachments)
   end
 end

data/app/views/catalog/_save_search.html.erb

@@ -1,20 +1,22 @@
-<%= button_tag t(:'spotlight.saved_search.label'), id: "save-this-search", class: 'btn btn-default',  data: {toggle:"modal", target:"#save-modal"} %>
+<%= button_tag t(:'spotlight.saved_search.label'), id: "save-this-search", class: 'btn btn-secondary',  data: {toggle:"modal", target:"#save-modal"} %>
 <div class="modal fade" id="save-modal" tabindex="-1" role="dialog" aria-labelledby="save-modal-label" aria-hidden="true">
   <div class="modal-dialog">
   <%= bootstrap_form_for [spotlight, current_exhibit, Spotlight::Search.new] do |f| %>
     <div class="modal-content">
       <div class="modal-header">
-        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
         <h4 class="modal-title" id="save-modal-label"><%= t(:'spotlight.saved_search.label') %></h4>
+        <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
+          <span aria-hidden="true">&times;</span>
+        </button>
       </div>
       <div class="modal-body">
         <%= f.text_field :title, label: t(:'spotlight.saved_search.title') %>
-        <%= label_tag :id, t(:'spotlight.saved_search.id'), class: 'control-label' %>
+        <%= label_tag :id, t(:'spotlight.saved_search.id'), class: 'col-form-label' %>
         <%= select_tag :id, options_for_select(current_exhibit.searches.map { |s| [s.title, s.id] }), include_blank: true, class: 'form-control' %>
         <%= render_hash_as_hidden_fields(search_state.params_for_search.except(:qt, :page, :utf8)) %>
       </div>
       <div class="modal-footer">
-        <%= f.submit nil, class: 'btn btn-primary pull-right' %>
+        <%= f.submit nil, class: 'btn btn-primary float-right' %>
         <button type="button" class="btn btn-link" data-dismiss="modal"><%= t :cancel %></button>
       </div>
     </div>

data/app/views/devise/mailer/invitation_instructions.html.erb

@@ -7,7 +7,7 @@
 %>
 <p><%= t("spotlight.#{key}.invitation_instructions.hello", email: @resource.email) %></p>
 
-<p><%= t("spotlight.#{key}.invitation_instructions.someone_invited_you", role: @resource.roles.first.role, exhibit_name: @resource.roles.first.resource.title, url: spotlight.exhibit_home_page_url(@resource.roles.first.resource)) %></p>
+<p><%= t("spotlight.#{key}.invitation_instructions.someone_invited_you", role: @resource.roles.first.role, exhibit_name: @resource.roles.first.resource.title, url: spotlight.exhibit_home_page_url(@resource.roles.first.resource, locale: nil)) %></p>
 
 <p><%= link_to t("spotlight.#{key}.invitation_instructions.accept_invitation"), accept_invitation_url(@resource, :invitation_token => @token) %></p>
 

data/app/views/layouts/spotlight/base.html.erb

@@ -0,0 +1,48 @@
+<!DOCTYPE html>
+<%= content_tag :html, class: 'no-js', **(try(:html_tag_attributes) || {}) do %>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+
+    <title><%= h(@page_title || application_name.to_s) %></title>
+    <link href="<%= current_exhibit ? spotlight.opensearch_exhibit_catalog_url(current_exhibit, format: 'xml') : main_app.opensearch_catalog_url(format: 'xml') %>" title="<%= h(@page_title || application_name.to_str) %>" type="application/opensearchdescription+xml" rel="search"/>
+    <%= favicon_link_tag 'favicon.ico' %>
+    <% if current_exhibit %>
+      <%= exhibit_stylesheet_link_tag "application" %>
+    <% else %>
+      <%= stylesheet_link_tag "application" %>
+    <% end %>
+    <%= javascript_include_tag "application" %>
+    <%= csrf_meta_tags %>
+    <%= content_for(:head) %>
+    <%= description %>
+    <%= twitter_card %>
+    <%= opengraph %>
+    <%= javascript_tag '$.fx.off = true;' if Rails.env.test? %>
+  </head>
+  <body class="<%= render_body_class %>">
+    <div id="skip-link">
+      <%= link_to t('blacklight.skip_links.search_field'), '#search_field', class: 'element-invisible element-focusable rounded-bottom py-2 px-3', data: { turbolinks: 'false' } %>
+      <%= link_to t('blacklight.skip_links.main_content'), '#main-container', class: 'element-invisible element-focusable rounded-bottom py-2 px-3', data: { turbolinks: 'false' } %>
+      <%= content_for(:skip_links) %>
+    </div>
+
+    <%= render partial: 'shared/header_navbar' %>
+    <%= render partial: 'shared/masthead' %>
+    <%= content_for?(:header_content) ? yield(:header_content) : "" %>
+
+    <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">
+      <%= content_for(:container_header) %>
+
+      <%= render partial: 'shared/flash_msg', layout: 'shared/flash_messages' %>
+
+      <div class="row">
+        <%= content_for?(:content) ? yield(:content) : yield %>
+      </div>
+    </main>
+
+    <%= render partial: 'shared/footer' %>
+    <%= render partial: 'shared/modal' %>
+  </body>
+<% end %>