blacklight-spotlight 3.0.0.rc2 → 3.0.0

data/app/services/spotlight/etl/sources.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module Etl
+    # Basic ETL source implementations
+    module Sources
+      # A simple source that just returns the original resource(s)
+      IdentitySource = lambda do |context|
+        Array.wrap(context.resource)
+      end
+
+      # A transform step that calls a method on the resource to generate a source
+      def self.SourceMethodSource(method) # rubocop:disable Naming/MethodName
+        lambda do |context|
+          context.resource.public_send(method)
+        end
+      end
+
+      # A simple source that retrieves the stored data from a Spotlight::Resource
+      StoredData = lambda do |context, **|
+        Array.wrap(context.resource.data)
+      end
+    end
+  end
+end

data/app/services/spotlight/etl/step.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module Etl
+    # ETL pipeline step
+    class Step
+      attr_reader :definition, :context, :executor
+
+      # @param [Class, Proc] definition the step to run
+      # @param [String] label
+      # @param [Spotlight::Etl::Executor] executor the execution environment
+      def initialize(definition, label: nil, executor: nil)
+        @definition = definition
+        @executor = executor
+        @label = label
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def call(*args)
+        with_logger do |logger|
+          logger.debug { "Called with #{transform_data_for_debugging(args.first)}" }
+
+          catch :skip do
+            return action.call(*args).tap do |result|
+              logger.debug { "   => Returning #{transform_data_for_debugging(result)}" } if $VERBOSE
+            end
+          end
+
+          logger.debug '  => Caught skip.'
+          throw :skip
+        end
+      rescue StandardError => e
+        with_logger do |logger|
+          logger.error("Caught exception #{e}")
+        end
+        raise(e)
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def finalize(*args)
+        action.finalize(*args) if action.respond_to? :finalize
+      end
+
+      private
+
+      # @return [#call]
+      def action
+        case definition
+        when Class
+          # memoize the class' instance for the lifetime of the step
+          @memoized_action ||= definition.new
+        else # Proc, etc
+          definition
+        end
+      end
+
+      # @return [#to_string]
+      def label
+        @label || definition
+      end
+
+      # NOTE: this is super weird to support Rails 5.2
+      # @return [Logger]
+      def with_logger
+        yield(Rails.logger) && return unless executor
+
+        executor.with_logger do |logger|
+          logger.tagged(label) do
+            yield logger
+          end
+        end
+      end
+
+      ##
+      # @param [Hash] data
+      # @return [String] a simplified + truncated version of the data hash for debugging
+      def transform_data_for_debugging(data)
+        executor&.transform_data_for_debugging(data) || data.inspect.truncate(100)
+      end
+    end
+  end
+end

data/app/services/spotlight/etl/transforms.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Spotlight
+  module Etl
+    # Basic + default transform steps
+    module Transforms
+      # A transform step that "transforms" the source into the data element
+      IdentityTransform = lambda do |data, pipeline|
+        data.merge(pipeline.source)
+      end
+
+      # A transform step that calls a method on the source to generate a document
+      def self.SourceMethodTransform(method) # rubocop:disable Naming/MethodName
+        lambda do |data, pipeline|
+          data.merge(pipeline.source.public_send(method))
+        end
+      end
+
+      # A transform step that throws away blank data
+      RejectBlank = lambda do |data, _|
+        throw :skip if data.blank?
+        data
+      end
+
+      # A trasnform step that ensures data has a unique key attribute
+      RejectMissingUniqueId = lambda do |data, pipeline|
+        id = pipeline.context.unique_key(data)
+
+        throw :skip if id.blank?
+        data
+      end
+
+      # A transform that adds exhibit-specific metadata (like Spotlight sidecar data)
+      # to the document
+      ApplyExhibitMetadata = lambda do |data, pipeline|
+        resource = pipeline.context.resource
+        document_model = pipeline.context.document_model
+        id = pipeline.context.unique_key(data)
+
+        next data unless document_model && id.present?
+
+        exhibit_metadata = document_model.build_for_exhibit(id, resource.exhibit, resource: (resource if resource.persisted?))
+
+        data.reverse_merge(exhibit_metadata.to_solr)
+      end
+
+      # A transform that adds application-specific metadata (like what resource generated the solr document)
+      ApplyApplicationMetadata = lambda do |data, pipeline|
+        resource = pipeline.context.resource
+        document_model = pipeline.context.document_model
+
+        data.reverse_merge(
+          Spotlight::Engine.config.resource_global_id_field => (resource.to_global_id.to_s if resource.persisted?),
+          document_model.resource_type_field => resource.class.to_s.tableize
+        )
+      end
+
+      # A transform that adds externally-provided metadata to the document
+      ApplyPipelineMetadata = lambda do |data, pipeline|
+        data.reverse_merge(pipeline.context.additional_metadata)
+      end
+    end
+  end
+end

data/app/services/spotlight/exhibit_import_export_service.rb

@@ -11,6 +11,7 @@ module Spotlight
     class_attribute :serialization_pipeline, default: %i[
       raw_json
       add_feature_page_hierarchy
+      add_browse_group_hierarchy
       add_page_content
       attach_featured_images
       attach_attachments
@@ -37,34 +38,43 @@ module Spotlight
         attachments: {},
         languages: {},
         translations: {},
-        owned_taggings: {}
+        owned_taggings: {},
+        groups: {}
       )
 
       exhibit_attributes = hash.reject { |_k, v| v.is_a?(Array) || v.is_a?(Hash) }
-      exhibit.update_attributes(exhibit_attributes.except(:theme))
+      exhibit.update(exhibit_attributes.except(:theme))
       exhibit.theme = exhibit_attributes[:theme] if exhibit.themes.include? exhibit_attributes[:theme]
 
       deserialize_featured_image(exhibit, :masthead, hash[:masthead]) if hash[:masthead]
       deserialize_featured_image(exhibit, :thumbnail, hash[:thumbnail]) if hash[:thumbnail]
 
-      exhibit.blacklight_configuration.update_attributes hash[:blacklight_configuration].deep_stringify_keys if hash[:blacklight_configuration]
+      exhibit.blacklight_configuration.update hash[:blacklight_configuration].deep_stringify_keys if hash[:blacklight_configuration]
 
       hash[:main_navigations].each do |attr|
         ar = exhibit.main_navigations.find_or_initialize_by(nav_type: attr[:nav_type])
-        ar.update_attributes(attr)
+        ar.update(attr)
       end
 
       hash[:contact_emails].each do |attr|
         ar = exhibit.contact_emails.find_or_initialize_by(email: attr[:email])
-        ar.update_attributes(attr)
+        ar.update(attr)
+      end
+
+      hash[:groups].each do |attr|
+        gr = exhibit.groups.find_or_initialize_by(slug: attr[:slug])
+        gr.update(attr)
       end
 
       hash[:searches].each do |attr|
+        group_slugs = attr.delete(:group_slugs) || []
         masthead = attr.delete(:masthead)
         thumbnail = attr.delete(:thumbnail)
 
         ar = exhibit.searches.find_or_initialize_by(slug: attr[:slug])
-        ar.update_attributes(attr)
+        ar.update(attr)
+
+        ar.update(groups: exhibit.groups.select { |x| group_slugs.include? x.slug })
 
         deserialize_featured_image(ar, :masthead, masthead) if masthead
         deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -76,7 +86,7 @@ module Spotlight
         translated_pages = attr.delete(:translated_pages) || []
 
         ar = exhibit.about_pages.find_or_initialize_by(slug: attr[:slug])
-        ar.update_attributes(attr)
+        ar.update(attr)
 
         deserialize_featured_image(ar, :masthead, masthead) if masthead
         deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -86,7 +96,7 @@ module Spotlight
           thumbnail = tattr.delete(:thumbnail)
 
           tar = ar.translated_page_for(tattr[:locale]) || ar.clone_for_locale(tattr[:locale])
-          tar.update_attributes(tattr)
+          tar.update(tattr)
 
           deserialize_featured_image(ar, :masthead, masthead) if masthead
           deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -98,7 +108,7 @@ module Spotlight
         thumbnail = attr.delete(:thumbnail)
 
         ar = exhibit.feature_pages.find_or_initialize_by(slug: attr[:slug])
-        ar.update_attributes(attr.except(:parent_page_slug, :translated_pages))
+        ar.update(attr.except(:parent_page_slug, :translated_pages))
 
         deserialize_featured_image(ar, :masthead, masthead) if masthead
         deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -119,7 +129,7 @@ module Spotlight
           thumbnail = tattr.delete(:thumbnail)
 
           tar = ar.translated_page_for(tattr[:locale]) || ar.clone_for_locale(tattr[:locale])
-          tar.update_attributes(tattr)
+          tar.update(tattr)
 
           deserialize_featured_image(ar, :masthead, masthead) if masthead
           deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -128,7 +138,7 @@ module Spotlight
 
       if hash[:home_page]
         translated_pages = hash[:home_page].delete(:translated_pages) || []
-        exhibit.home_page.update_attributes(hash[:home_page].except(:thumbnail))
+        exhibit.home_page.update(hash[:home_page].except(:thumbnail))
         deserialize_featured_image(exhibit.home_page, :thumbnail, hash[:home_page][:thumbnail]) if hash[:home_page][:thumbnail]
 
         translated_pages.each do |tattr|
@@ -136,7 +146,7 @@ module Spotlight
           thumbnail = tattr.delete(:thumbnail)
 
           tar = exhibit.home_page.translated_page_for(tattr[:locale]) || exhibit.home_page.clone_for_locale(tattr[:locale])
-          tar.update_attributes(tattr)
+          tar.update(tattr)
 
           deserialize_featured_image(ar, :masthead, masthead) if masthead
           deserialize_featured_image(ar, :thumbnail, thumbnail) if thumbnail
@@ -147,26 +157,26 @@ module Spotlight
         avatar = attr.delete(:avatar)
 
         ar = exhibit.contacts.find_or_initialize_by(slug: attr[:slug])
-        ar.update_attributes(attr)
+        ar.update(attr)
 
         deserialize_featured_image(ar, :avatar, avatar) if avatar
       end
 
       hash[:custom_fields].each do |attr|
         ar = exhibit.custom_fields.find_or_initialize_by(slug: attr[:slug])
-        ar.update_attributes(attr)
+        ar.update(attr)
       end
 
       hash[:solr_document_sidecars].each do |attr|
         ar = exhibit.solr_document_sidecars.find_or_initialize_by(document_id: attr[:document_id])
-        ar.update_attributes(attr)
+        ar.update(attr)
       end
 
       hash[:resources].each do |attr|
         upload = attr.delete(:upload)
 
         ar = exhibit.resources.find_or_initialize_by(type: attr[:type], url: attr[:url])
-        ar.update_attributes(attr)
+        ar.update(attr)
 
         deserialize_featured_image(ar, :upload, upload) if upload
       end
@@ -183,12 +193,12 @@ module Spotlight
 
       hash[:languages].each do |attr|
         ar = exhibit.languages.find_or_initialize_by(locale: attr[:locale])
-        ar.update_attributes(attr)
+        ar.update(attr)
       end
 
       hash[:translations].each do |attr|
         ar = exhibit.translations.find_or_initialize_by(locale: attr[:locale], key: attr[:key])
-        ar.update_attributes(attr)
+        ar.update(attr)
       end
 
       hash[:owned_taggings].each do |attr|
@@ -200,18 +210,21 @@ module Spotlight
     def deserialize_featured_image(obj, method, data)
       file = data.delete(:image)
       image = obj.public_send("build_#{method}")
-      image.update_attributes(data)
+      image.update(data)
       if file
         image.image = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file[:content])),
                                                      filename: file[:filename],
                                                      content_type: file[:content_type]
+        # Unset the iiif_tilesource field as the new image should be different, because
+        # the source has been reloaded
+        image.iiif_tilesource = nil
       end
       image.save!
       obj.update(method => image)
     end
 
-    def as_json(**args)
-      self.class.serialization_pipeline.inject(args) do |memo, step|
+    def as_json(*_args)
+      self.class.serialization_pipeline.inject({}) do |memo, step|
         method(step).call(memo)
       end
     end
@@ -292,7 +305,7 @@ module Spotlight
       if file
         img = {
           image: {
-            filename: file.identifier, content_type: file.content_type, content: Base64.encode64(file.read)
+            filename: file.filename, content_type: file.content_type, content: Base64.encode64(file.read)
           }
         }
       end
@@ -335,6 +348,18 @@ module Spotlight
       json
     end
 
+    def add_browse_group_hierarchy(json)
+      return json unless json[:groups] && json[:searches]
+
+      json[:searches].each do |attr|
+        search = exhibit.searches.find_by(slug: attr[:slug])
+
+        attr[:group_slugs] = search.groups.pluck(:slug)
+      end
+
+      json
+    end
+
     def add_page_content(json)
       (json[:feature_pages] || []).each do |page|
         p = exhibit.feature_pages.find_by(slug: page[:slug])
@@ -382,6 +407,9 @@ module Spotlight
                         searches: { # thumbnail
                           except: %i[id scope exhibit_id]
                         },
+                        groups: {
+                          except: %i[id exhibit_id]
+                        },
                         about_pages: { # thumbnail
                           except: %i[id scope exhibit_id parent_page_id content],
                           include: {

data/app/services/spotlight/iiif_resource_resolver.rb

@@ -57,7 +57,7 @@ module Spotlight
 
     def response
       @response ||= begin
-                      Faraday.get(iiif_manifest_url).body
+                      Spotlight::Resources::IiifService.http_client.get(iiif_manifest_url).body
                     rescue Faraday::Error => e
                       Rails.logger.warn("#{self.class.name} failed to fetch #{iiif_manifest_url} with: #{e}")
                       '{}'

data/app/services/spotlight/validity_checker.rb

@@ -5,16 +5,16 @@ module Spotlight
   # check if a delayed job still needs to run
   class ValidityChecker
     # Return a validity token
-    # @param [ActiveModel::Model]
+    # @param [ActiveJob::Base]
     # @return [Object] any serializable object
-    def mint(_model); end
+    def mint(_job); end
 
     # Check if the token is still valid for the model
-    # @param [ActiveModel::Model]
+    # @param [ActiveJob::Base]
     # @param [Object] the serializable token minted by #mint
     # @return [boolean]
-    def check(_model, _token)
-      true
+    def check(_job, validity_token: nil)
+      validity_token || true
     end
   end
 end

data/app/uploaders/spotlight/bulk_updates_uploader.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Spotlight
+  class BulkUpdatesUploader < CarrierWave::Uploader::Base
+    storage Spotlight::Engine.config.uploader_storage
+  end
+end

data/app/uploaders/spotlight/featured_image_uploader.rb

@@ -6,7 +6,7 @@ module Spotlight
   class FeaturedImageUploader < CarrierWave::Uploader::Base
     storage Spotlight::Engine.config.uploader_storage
 
-    def extension_whitelist
+    def extension_allowlist
       Spotlight::Engine.config.allowed_upload_extensions
     end
 

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

@@ -0,0 +1,28 @@
+<div class="modal fade" id="add-tags-modal" tabindex="-1" role="dialog" aria-labelledby="add-tag-modal" aria-hidden="true">
+  <div class="modal-dialog">
+  <%= bootstrap_form_for([:visibility, current_exhibit], url: add_tags_exhibit_bulk_actions_path(current_exhibit), method: 'post') do |f| %>
+    <div class="modal-content">
+      <div class="modal-header">
+        <h4 class="modal-title" id="add-tag-modal"><%= t(:'spotlight.bulk_actions.add_tags.heading') %></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">
+        <p>
+          <%= t(:'spotlight.bulk_actions.add_tags.description', count: @response.total) %>
+        </p>
+        <div class="form-group">
+          <%= label_tag :tags, t(:'spotlight.bulk_actions.add_tags.label') %>
+          <%= text_field_tag :tags, '', class: 'form-control', data: { autocomplete_tag: true, autocomplete_url: exhibit_tags_path(current_exhibit, format: 'json')} %>
+        </div>
+        <%= render Blacklight::HiddenSearchStateComponent.new(params: search_state.params_for_search) %>
+      </div>
+      <div class="modal-footer d-flex flex-row-reverse justify-content-start">
+        <%= f.submit t(:'spotlight.bulk_actions.add'), class: 'btn btn-primary', data: { confirm: t(:'spotlight.bulk_actions.confirm') } %>
+        <button type="button" class="btn btn-link" data-dismiss="modal"><%= t :cancel %></button>
+      </div>
+    </div>
+    <% end %>
+  </div>
+</div>