blacklight-spotlight 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c0fb43a8a3a60dd1e31fde7e191562200b1148d
-  data.tar.gz: 4c26246903d9d70696b89766028a164061962bae
+  metadata.gz: f7c4a7bf6db4fd61a7e41fdc1dd1fe6893ef2ce0
+  data.tar.gz: 6c51f46a9d55b5168a13634f4fabb88963ac7402
 SHA512:
-  metadata.gz: 7e3c2f5dac310fd1282fe465f927494aaee51b0fb3686cde48fbd347b4f77072cdb1f0d1052ad603eaca82cf8782f7f9c53f8a8625cb1e050e67e4c5e6f1bd78
-  data.tar.gz: de18c76cddbda5fec50711cdb3e677c8a01d15cd5b54bc8df07539c7b8bf118ed4c8b90c8e7d7c7f38d34efad26db3034fb9684b6ca05f715ac90ebbd21ddaef
+  metadata.gz: 1462c3e39927121d923fae715aa7d33fa0adc1637876471396d5aa06f9b274b42b076dd982ac60a00e9ccf8c4fd1fbc737c24074c61fa35dfeea522e4f730ed1
+  data.tar.gz: 7bd822f149c8c47af86cc28d6b6df759dc6e98f7e55396a426b731d55b93cadc3b8347933ad38b502e0a6a327c098267ecaf976395d9ff8350655056a312785e

data/app/assets/javascripts/spotlight/edit_in_place.js

@@ -29,7 +29,14 @@ Spotlight.onLoad(function() {
         });
 
         $input.on('blur.inplaceedit', function() {
-          $label.text($input.val());
+          var value = $input.val();
+
+          if ($.trim(value).length == 0) {
+            $input.val($label.text());
+          } else {
+            $label.text(value);
+          }
+
           $label.show();
           $input.attr('type', 'hidden');
           // when leaving edit mode, should no longer hide edit-in-place affordance icon

data/app/helpers/spotlight/pages_helper.rb

@@ -58,5 +58,9 @@ module Spotlight
     def render_contact_email_address(address)
       mail_to address, address
     end
+
+    def configurations_for_current_page
+      Spotlight::PageConfigurations.new(context: self, page: @page).as_json
+    end
   end
 end

data/app/models/spotlight/blacklight_configuration.rb

@@ -84,7 +84,7 @@ module Spotlight
         config.view.embed.locals ||= { osd_container_class: '' }
 
         # Add any custom fields
-        config.index_fields.merge! custom_index_fields
+        config.index_fields.merge! custom_index_fields(config)
         config.index_fields = Hash[config.index_fields.sort_by { |k, _v| field_weight(index_fields, k) }]
         config.index_fields.reject! { |_k, v| v.if == false }
 
@@ -93,7 +93,7 @@ module Spotlight
           v.original = v.dup
           if index_fields[k]
             v.merge! index_fields[k].symbolize_keys
-          elsif custom_index_fields[k]
+          elsif v.custom_field
             set_custom_field_defaults(v)
           else
             set_index_field_defaults(v)
@@ -198,12 +198,15 @@ module Spotlight
     end
     # rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
-    def custom_index_fields
-      Hash[exhibit.custom_fields.reject(&:new_record?).map do |x|
-        field = Blacklight::Configuration::IndexField.new x.configuration.merge(
-          key: x.field, field: x.solr_field, custom_field: true
+    def custom_index_fields(blacklight_config)
+      Hash[exhibit.custom_fields.reject(&:new_record?).map do |custom_field|
+        original_config = blacklight_config.index_fields[custom_field.field] || {}
+        field = Blacklight::Configuration::IndexField.new original_config.merge(
+          custom_field.configuration.merge(
+            key: custom_field.field, field: custom_field.solr_field, custom_field: true
+          )
         )
-        [x.field, field]
+        [custom_field.field, field]
       end]
     end
 
@@ -338,8 +341,8 @@ module Spotlight
     end
 
     def set_custom_field_defaults(field)
-      field.show = true
-      field.enabled = true
+      field.show = true if field.show.nil?
+      field.enabled = true if field.enabled.nil?
     end
     # rubocop:enable Naming/AccessorMethodName
 

data/app/models/spotlight/page_configurations.rb

@@ -0,0 +1,93 @@
+module Spotlight
+  ##
+  # PageConfigurations is a simple class to gather and return all
+  # configurations needed for the various SirTrevor widgets.
+  # A downstream application (or gem) can inject its own data through the Spotlight's engine config like so
+  # Spotlight::Engine.config.page_configurations = {
+  #   'my-key': 'my_val'
+  # }
+  # You can also pass anything that responds to #call (eg. a lambda or custom ruby class)
+  # as the value and it will be evaluted within the PageConfiguration context
+  # (which has access to the view context).
+  # Spotlight::Engine.config.page_configurations = {
+  #   'exhibit-path': ->(context) { context.spotlight.exhibit_path(context.current_exhibit) }
+  # }
+  class PageConfigurations
+    delegate :available_view_fields,
+             :blacklight_config,
+             :current_exhibit,
+             :document_show_link_field,
+             :index_fields,
+             :index_field_label,
+             :spotlight,
+             :t,
+             :view_label,
+             to: :context
+
+    attr_reader :context, :page
+    def initialize(context:, page:)
+      @context = context
+      @page = page
+    end
+
+    def as_json(*)
+      {
+        'blacklight-configuration-index-fields': available_index_fields,
+        'blacklight-configuration-search-views': available_view_configs,
+        'attachment-endpoint': attachment_endpoint,
+        'autocomplete-exhibit-catalog-path': exhibit_autocomplete_endpoint,
+        'autocomplete-exhibit-pages-path': page_autocomplete_endpoint,
+        'autocomplete-exhibit-searches-path': search_autocomplete_endpoint,
+        'preview-url': page_preview_url
+      }.merge(downstream_parameters)
+    end
+
+    private
+
+    def available_index_fields
+      fields = blacklight_config.index_fields.map { |k, _v| { key: k, label: index_field_label(nil, k) } }
+      fields.unshift(key: document_show_link_field, label: t(:'spotlight.pages.form.title_placeholder')) unless index_fields.include? document_show_link_field
+
+      fields
+    end
+
+    def available_view_configs
+      available_view_fields.map { |k, _| { key: k, label: view_label(k) } }
+    end
+
+    def attachment_endpoint
+      spotlight.exhibit_attachments_path(current_exhibit)
+    end
+
+    def exhibit_autocomplete_endpoint
+      spotlight.autocomplete_exhibit_catalog_path(current_exhibit, q: '%QUERY', format: 'json')
+    end
+
+    def page_autocomplete_endpoint
+      spotlight.exhibit_pages_path(current_exhibit, format: 'json')
+    end
+
+    def search_autocomplete_endpoint
+      spotlight.exhibit_searches_path(current_exhibit, format: 'json')
+    end
+
+    def page_preview_url
+      return unless page.persisted?
+      spotlight.exhibit_preview_block_path(current_exhibit, page)
+    end
+
+    def downstream_parameters
+      configured_params.each_with_object({}) do |(key, value), hsh|
+        hsh[key] = if value.respond_to?(:call)
+                     value.call(self)
+                   else
+                     value
+                   end
+      end
+    end
+
+    def configured_params
+      Spotlight::Engine.config.page_configurations || {}
+    end
+  end
+end

data/app/services/spotlight/clone_translated_page_from_locale.rb

@@ -17,10 +17,8 @@ module Spotlight
     end
 
     def clone
-      @clone ||= begin
-        destroy
-        page.clone_for_locale(locale)
-      end
+      destroy
+      page.clone_for_locale(locale)
     end
 
     private

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

@@ -2,18 +2,7 @@
   # TODO: the "if @page.persisted?" business below could possibly be done w/ some clever polymorphic routing.
   # Leaving as-is for now since technically you can't get to the new page form anyway.
 %>
-<%= bootstrap_form_for([spotlight, @page.exhibit, @page], role: 'form', html: {
-              data: {
-                :'form-observer' => true,
-                :'blacklight-configuration-index-fields' => available_index_fields,
-                :'blacklight-configuration-search-views' => available_view_fields.map { |k,v| { key: k, label: view_label(k) }},
-                :'attachment-endpoint' => spotlight.exhibit_attachments_path(@page.exhibit),
-                :'autocomplete-exhibit-catalog-path'=> spotlight.autocomplete_exhibit_catalog_path(@page.exhibit, q: "%QUERY", format: "json"),
-                :'autocomplete-exhibit-pages-path' => spotlight.exhibit_pages_path(@page.exhibit, format: "json"),
-                :'autocomplete-exhibit-searches-path' => spotlight.exhibit_searches_path(@page.exhibit, format: "json"),
-                :'preview-url' => (spotlight.exhibit_preview_block_url(@page.exhibit, @page) if @page.persisted?)
-              }
-            }) do |f| %>
+<%= bootstrap_form_for([spotlight, @page.exhibit, @page], role: 'form', html: { data: configurations_for_current_page.merge('form-observer': true)}) do |f| %>
   <%= render @page.lock if @page.lock and not @page.lock.stale? and not @page.lock.current_session? %>
   <% if @page.errors.any? %>
     <div id="error_explanation">

data/lib/generators/spotlight/install_generator.rb

@@ -33,16 +33,6 @@ module Spotlight
       generate 'paper_trail:install'
     end
 
-    # Overriding paper trail initializer to turn track_associations off
-    # This was off by default prior to paper trail 9.1.0 but is now generated as on
-    def override_paper_trail_initializer
-      gsub_file(
-        'config/initializers/paper_trail.rb',
-        'PaperTrail.config.track_associations = true',
-        'PaperTrail.config.track_associations = false'
-      )
-    end
-
     def sitemaps
       gem 'sitemap_generator'
 
@@ -126,7 +116,7 @@ module Spotlight
         insert_into_file 'config/application.rb', after: "< Rails::Application\n" do
           <<-EOF
           config.action_mailer.default_url_options = { host: "#{options[:mailer_default_url_host]}", from: "noreply@example.com" }
-        EOF
+          EOF
         end
       else
         say 'Please add a default configuration config.action_mailer.default_url_options for your environment', :red

data/lib/generators/spotlight/scaffold_resource_generator.rb

@@ -15,7 +15,7 @@ module Spotlight
             # yield { id: resource.id }
           end
         end
-    FILE
+      FILE
     end
 
     def create_model

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

@@ -72,3 +72,8 @@
 #   FeaturedPages SolrDocuments SolrDocumentsCarousel SolrDocumentsEmbed
 #   SolrDocumentsFeatures SolrDocumentsGrid SearchResults
 # )
+#
+# Page configurations made available to widgets
+# Spotlight::Engine.config.page_configurations = {
+#   'my-local-config': ->(context) { context.my_custom_data_path(context.current_exhibit) }
+# }

data/lib/spotlight/engine.rb

@@ -161,6 +161,10 @@ module Spotlight
     config.featured_image_square_size = [400, 400]
     config.contact_square_size = [70, 70]
 
+    # Additional page configurations to be made available to page editing widgets
+    # See Spotlight::PageConfigurations
+    config.page_configurations = {}
+
     # To present curators with analytics reports on the exhibit dashboard, you need to configure
     # an Analytics provider. Google Analytics support is provided out-of-the-box.
     config.analytics_provider = nil

data/lib/spotlight/version.rb

@@ -1,3 +1,3 @@
 module Spotlight
-  VERSION = '2.0.2'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/spec/controllers/spotlight/about_pages_controller_spec.rb

@@ -42,6 +42,7 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
           expect(assigns(:exhibit)).to eq exhibit
         end
       end
+
       describe 'on a different about page' do
         it 'is successful' do
           expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
@@ -110,6 +111,7 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
           expect(assigns(:exhibit)).to eq exhibit
         end
       end
+
       describe 'on a different about page' do
         it 'is successful' do
           expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
@@ -135,12 +137,14 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
         expect(assigns(:exhibit)).to eq exhibit
       end
     end
+
     describe 'POST create' do
       it 'redirects to the about page index' do
         post :create, params: { about_page: { title: 'MyString' }, exhibit_id: exhibit }
         expect(response).to redirect_to(exhibit_about_pages_path(exhibit))
       end
     end
+
     describe 'PUT update' do
       let!(:page) { FactoryBot.create(:about_page, exhibit: exhibit) }
       it 'redirects to the about page' do
@@ -150,11 +154,13 @@ describe Spotlight::AboutPagesController, type: :controller, versioning: true do
         expect(flash[:notice]).to have_link 'Undo changes'
       end
     end
+
     describe 'POST update_all' do
       let!(:page1) { FactoryBot.create(:about_page, exhibit: exhibit) }
       let!(:page2) { FactoryBot.create(:about_page, exhibit: exhibit, published: true) }
       let!(:page3) { FactoryBot.create(:about_page, exhibit: exhibit, published: true) }
       before { request.env['HTTP_REFERER'] = 'http://example.com' }
+
       it 'updates whether they are on the landing page' do
         post :update_all, params: {
           exhibit_id: page1.exhibit,

data/spec/controllers/spotlight/admin_users_controller_spec.rb

@@ -2,6 +2,7 @@ describe Spotlight::AdminUsersController, type: :controller do
   routes { Spotlight::Engine.routes }
 
   before { sign_in(user) }
+
   context 'by a non-admin' do
     let(:user) { FactoryBot.create(:exhibit_visitor) }
     it 'redirects with an error message' do
@@ -13,6 +14,7 @@ describe Spotlight::AdminUsersController, type: :controller do
 
   context 'by an admin user' do
     before { request.env['HTTP_REFERER'] = 'http://example.com' }
+
     let(:user) { FactoryBot.create(:site_admin) }
     describe 'GET index' do
       it 'is successful' do

data/spec/controllers/spotlight/browse_controller_spec.rb

@@ -39,6 +39,7 @@ describe Spotlight::BrowseController, type: :controller do
 
   describe 'when authenticated as an admin' do
     before { sign_in admin }
+
     describe 'GET index' do
       it 'does not show unpublished categories' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
@@ -73,6 +74,7 @@ describe Spotlight::BrowseController, type: :controller do
       before do
         allow(controller).to receive_messages(search_results: [mock_response, document_list])
       end
+
       it 'shows the items in the category' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
         expect(controller).to receive(:add_breadcrumb).with('Browse', exhibit_browse_index_path(exhibit))

data/spec/controllers/spotlight/catalog_controller_spec.rb

@@ -146,6 +146,7 @@ describe Spotlight::CatalogController, type: :controller do
           Blacklight.default_index.connection.commit
         end
       end
+
       context 'document is not an uploaded resource' do
         it 'returns a 404 when called on something other than an uploaded resource' do
           get :manifest, params: { exhibit_id: exhibit, id: 'dx157dh4345' }
@@ -234,6 +235,7 @@ describe Spotlight::CatalogController, type: :controller do
         expect(assigns[:document]).to be_kind_of SolrDocument
       end
     end
+
     describe 'PATCH update' do
       it 'is successful' do
         expect do
@@ -417,6 +419,7 @@ describe Spotlight::CatalogController, type: :controller do
       allow(controller).to receive(:document_index_view_type).and_return(nil)
       allow(field).to receive(:enabled).and_return(true)
     end
+
     context 'for sort fields' do
       let(:field) { Blacklight::Configuration::SortField.new enabled: true }
       it 'uses the enabled property for sort fields' do
@@ -473,6 +476,7 @@ describe Spotlight::CatalogController, type: :controller do
   describe 'save_search rendering' do
     let(:current_exhibit) { FactoryBot.create(:exhibit) }
     before { allow(controller).to receive_messages(current_exhibit: current_exhibit) }
+
     describe 'render_save_this_search?' do
       it 'returns false if we are on the items admin screen' do
         allow(controller).to receive(:can?).with(:curate, current_exhibit).and_return(true)
@@ -490,6 +494,7 @@ describe Spotlight::CatalogController, type: :controller do
       end
     end
   end
+
   describe '#setup_next_and_previous_documents_from_browse_category' do
     let(:search_session) { { 'counter' => '1' } }
     let(:current_browse_category) { FactoryBot.create(:search, exhibit: exhibit, query_params: { q: 'Search String' }) }

data/spec/controllers/spotlight/confirmations_controller_spec.rb

@@ -23,6 +23,7 @@ describe Spotlight::ConfirmationsController, type: :controller do
         expect(response).to be_successful
       end
     end
+
     describe 'when the token is valid' do
       it 'updates the user' do
         get :show, params: { confirmation_token: raw_token }

data/spec/controllers/spotlight/contact_forms_controller_spec.rb

@@ -15,6 +15,7 @@ describe Spotlight::ContactFormsController, type: :controller do
       end
     end
   end
+
   describe 'POST create' do
     it 'sends an email' do
       expect do

data/spec/controllers/spotlight/contacts_controller_spec.rb

@@ -26,6 +26,7 @@ describe Spotlight::ContactsController, type: :controller do
         expect(response).to be_successful
       end
     end
+
     describe 'PATCH update' do
       it 'is successful' do
         patch :update, params: { id: contact, contact: { name: 'Chester' }, exhibit_id: contact.exhibit }
@@ -56,6 +57,7 @@ describe Spotlight::ContactsController, type: :controller do
         expect(response).to render_template 'edit'
       end
     end
+
     describe 'DELETE destroy' do
       it 'is successful' do
         contact # force contact to be created
@@ -65,6 +67,7 @@ describe Spotlight::ContactsController, type: :controller do
         expect(response).to redirect_to exhibit_about_pages_path(exhibit)
       end
     end
+
     describe 'GET new' do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
@@ -75,6 +78,7 @@ describe Spotlight::ContactsController, type: :controller do
         expect(response).to be_successful
       end
     end
+
     describe 'POST create' do
       it 'fails by rendering new' do
         expect_any_instance_of(Spotlight::Contact).to receive(:update).and_return(false)

data/spec/controllers/spotlight/dashboards_controller_spec.rb

@@ -1,4 +1,3 @@
-
 describe Spotlight::DashboardsController, type: :controller do
   routes { Spotlight::Engine.routes }
   let(:exhibit) { FactoryBot.create(:exhibit) }
@@ -11,6 +10,7 @@ describe Spotlight::DashboardsController, type: :controller do
   describe 'when logged in' do
     let(:curator) { FactoryBot.create(:exhibit_curator, exhibit: exhibit) }
     before { sign_in curator }
+
     describe 'GET show' do
       it 'loads the exhibit' do
         exhibit.blacklight_configuration.index = { timestamp_field: 'timestamp_field' }
@@ -39,6 +39,7 @@ describe Spotlight::DashboardsController, type: :controller do
 
   describe 'when user does not have access' do
     before { sign_in FactoryBot.create(:exhibit_visitor) }
+
     it 'does not allow show' do
       get :show, params: { exhibit_id: exhibit.id }
       expect(response).to redirect_to main_app.root_path