blacklight-spotlight 3.0.0.alpha.9 → 3.0.0.rc4

data/app/models/concerns/spotlight/resources/open_graph.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Spotlight
-  module Resources
-    ##
-    # OpenGraph metadata harvester
-    module OpenGraph
-      extend ActiveSupport::Concern
-      include Spotlight::Resources::Web
-
-      def opengraph
-        @opengraph ||= begin
-          page = {}
-
-          body.css('meta').select { |m| m.attribute('property') }.each do |m|
-            page[m.attribute('property').to_s] = m.attribute('content').to_s
-          end
-
-          page
-        end
-      end
-
-      def opengraph_properties
-        Hash[opengraph.map do |k, v|
-          ["#{opengraph_solr_field_name(k)}_tesim", v]
-        end]
-      end
-
-      private
-
-      def opengraph_solr_field_name(field)
-        field.parameterize(separator: '_')
-      end
-    end
-  end
-end

data/app/models/spotlight/reindexing_log_entry.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Spotlight
-  ##
-  # a log entry representing an attempt to reindex some number of records in an exhibit
-  class ReindexingLogEntry < ActiveRecord::Base
-    enum job_status: { unstarted: 0, in_progress: 1, succeeded: 2, failed: 3 }
-
-    belongs_to :exhibit, class_name: 'Spotlight::Exhibit'
-    belongs_to :user, class_name: '::User', optional: true
-
-    # null start times sort to the top, to more easily surface pending reindexing
-    default_scope { order(Arel.sql('start_time IS NOT NULL, start_time DESC')) }
-    scope :recent, -> { limit(5) }
-    scope :started_or_completed, -> { where.not(job_status: 'unstarted') }
-
-    def duration
-      end_time - start_time if end_time
-    end
-
-    def in_progress!
-      self.start_time = Time.zone.now
-      super
-    rescue StandardError
-      Rails.logger.error "unexpected error updating log entry to :in_progress from #{caller}"
-    end
-
-    def succeeded!
-      self.end_time = Time.zone.now
-      super
-    rescue StandardError
-      Rails.logger.error "unexpected error updating log entry to :succeeded from #{caller}"
-    end
-
-    def failed!
-      self.end_time = Time.zone.now
-      super
-    rescue StandardError
-      Rails.logger.error "unexpected error updating log entry to :failed from #{caller}"
-    end
-  end
-end

data/app/serializers/spotlight/exhibit_export_serializer.rb

@@ -1,205 +0,0 @@
-# frozen_string_literal: true
-
-require 'roar/decorator'
-require 'roar/json'
-require 'base64'
-require 'tempfile'
-
-module Spotlight
-  ##
-  # Serialize the Spotlight::BlacklightConfiguration
-  class ConfigurationRepresenter < Roar::Decorator
-    include Roar::JSON
-
-    (Spotlight::BlacklightConfiguration.attribute_names - %w[id exhibit_id]).each do |prop|
-      property prop
-    end
-
-    property :skip_default_configuration, exec_context: :decorator
-
-    def skip_default_configuration
-      true
-    end
-
-    delegate :skip_default_configuration=, to: :represented
-  end
-
-  ##
-  # 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, if: config?(:config)
-    end
-
-    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,
-                          if: Spotlight::ExhibitExportSerializer.config?(:attachments)
-
-      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,
-                               if: config?(:pages)
-
-    property :home_page, populator: ->(_fragment, options) { options[:represented].home_page },
-                         class: Spotlight::HomePage,
-                         decorator: PageRepresenter,
-                         if: config?(:pages)
-
-    collection :contacts, populator: ->(fragment, options) { options[:represented].contacts.find_or_initialize_by(slug: fragment['slug']) },
-                          class: Spotlight::Contact,
-                          if: config?(:pages) do
-      (Spotlight::Contact.attribute_names - %w[id exhibit_id]).each do |prop|
-        property prop
-      end
-
-      property :avatar, class: Spotlight::ContactImage, decorator: FeaturedImageRepresenter
-    end
-
-    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,
-                                        if: config?(:resources) do
-      (Spotlight::SolrDocumentSidecar.attribute_names - %w[id document_type exhibit_id]).each do |prop|
-        property prop
-      end
-
-      property :document_type, exec_context: :decorator
-
-      def document_type
-        represented.document_type.to_s
-      end
-
-      delegate :document_type=, to: :represented
-    end
-
-    collection :owned_taggings, class: ActsAsTaggableOn::Tagging,
-                                if: config?(:resources) do
-      property :taggable_id
-      property :taggable_type
-      property :context
-      property :tag, exec_context: :decorator
-
-      def tag
-        represented.tag.name
-      end
-
-      def tag=(tag)
-        represented.tag = ActsAsTaggableOn::Tag.find_or_create_by name: tag
-      end
-    end
-
-    collection :attachments, class: Spotlight::Attachment, if: config?(:attachments) do
-      (Spotlight::Attachment.attribute_names - %w[id exhibit_id file]).each do |prop|
-        property prop
-      end
-
-      property :file, exec_context: :decorator
-
-      def file
-        file = represented.file.file
-
-        { filename: file.filename, content_type: file.content_type, content: Base64.encode64(file.read) }
-      end
-
-      def file=(file)
-        represented.file = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file['content'])),
-                                                          filename: file['filename'],
-                                                          content_type: file['content_type']
-      end
-    end
-
-    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
-
-      property :upload, exec_context: :decorator
-
-      def upload
-        return unless represented.is_a? Spotlight::Resources::Upload
-
-        FeaturedImageRepresenter.new(represented.upload).to_json
-      end
-
-      def upload=(json)
-        return unless represented.is_a? Spotlight::Resources::Upload
-
-        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/featured_image_representer.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'roar/decorator'
-require 'roar/json'
-module Spotlight
-  ##
-  # Serialize mastheads and thumbnails
-  class FeaturedImageRepresenter < Roar::Decorator
-    include Roar::JSON
-    (Spotlight::FeaturedImage.attribute_names - %w[id image]).each do |prop|
-      property prop
-    end
-
-    property :image, exec_context: :decorator
-    def image
-      file = represented.image.file
-
-      return unless file
-
-      { filename: file.filename, content_type: file.content_type, content: Base64.encode64(file.read) }
-    end
-
-    def image=(file)
-      represented.image = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file['content'])),
-                                                         filename: file['filename'],
-                                                         content_type: file['content_type']
-    end
-  end
-end

data/app/serializers/spotlight/main_navigation_representer.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Spotlight
-  ##
-  # Serialize the Spotlight::BlacklightConfiguration
-  class MainNavigationRepresenter < Roar::Decorator
-    include Roar::JSON
-
-    (Spotlight::MainNavigation.attribute_names - %w[id exhibit_id]).each do |prop|
-      property prop
-    end
-  end
-end

data/app/serializers/spotlight/page_representer.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require 'roar/decorator'
-require 'roar/json'
-module Spotlight
-  ##
-  # Serialize an exhibit page
-  class PageRepresenter < Roar::Decorator
-    include Roar::JSON
-    (Spotlight::Page.attribute_names - %w[id scope exhibit_id parent_page_id content thumbnail_id]).each do |prop|
-      property prop
-    end
-
-    property :content, exec_context: :decorator
-
-    def content
-      # get the original data, bypassing any Sir-Trevor transformations
-      represented.read_attribute(:content)
-    end
-
-    delegate :content=, to: :represented
-  end
-
-  ##
-  # Serialize the page hierarchy (e.g. for Feature pages)
-  class NestedPageRepresenter < PageRepresenter
-    collection :child_pages, populator: ->(fragment, options) { options[:represented].child_pages.find_or_initialize_by(slug: fragment['slug']) },
-                             class: Spotlight::FeaturePage,
-                             extend: NestedPageRepresenter
-
-    property :thumbnail, class: Spotlight::FeaturedImage, decorator: FeaturedImageRepresenter, if: Spotlight::ExhibitExportSerializer.config?(:attachments)
-  end
-end

data/app/services/spotlight/resources/iiif_builder.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Spotlight
-  module Resources
-    # transforms a IiifHarvester into solr documents
-    class IiifBuilder < Spotlight::SolrDocumentBuilder
-      def to_solr
-        return to_enum(:to_solr) { 0 } unless block_given?
-
-        base_doc = super
-        resource.iiif_manifests.each do |manifest|
-          manifest.with_exhibit(exhibit)
-          manifest_solr = manifest.to_solr
-          yield base_doc.merge(manifest_solr) if manifest_solr.present?
-        end
-      end
-    end
-  end
-end

data/app/services/spotlight/solr_document_builder.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module Spotlight
-  # Creates solr documents for the documents in a resource
-  class SolrDocumentBuilder
-    def initialize(resource)
-      @resource = resource
-    end
-
-    attr_reader :resource
-    delegate :exhibit, :document_model, to: :resource
-
-    ##
-    # @return an enumerator of all the indexable documents for this resource
-    def documents_to_index
-      data = to_solr
-      return [] if data.blank?
-
-      data &&= [data] if data.is_a? Hash
-
-      return to_enum(:documents_to_index) { data.size } unless block_given?
-
-      data.lazy.reject(&:blank?).each do |doc|
-        yield doc.reverse_merge(exhibit_solr_doc(doc[unique_key]).to_solr)
-      end
-    end
-
-    protected
-
-    ##
-    # @abstract
-    # Convert this resource into zero-to-many new solr documents. The data here
-    # should be merged into the resource-specific {#to_solr} data.
-    #
-    # @return [Hash] a single solr document hash
-    # @return [Enumerator<Hash>] multiple solr document hashes. This can be a
-    #   simple array, or an lazy enumerator
-    def to_solr
-      spotlight_resource_metadata_for_solr
-    end
-
-    private
-
-    # Null object for SolrDocument
-    module NilSolrDocument
-      def self.to_solr
-        {}
-      end
-    end
-
-    ##
-    # Get any exhibit-specific metadata stored in e.g. sidecars, tags, etc
-    # This needs the generated solr document
-    # @returns [#to_solr] something that responds to `to_solr'
-    def exhibit_solr_doc(id)
-      return NilSolrDocument unless document_model || id.present?
-
-      document_model.build_for_exhibit(id, exhibit, resource: (resource if resource.persisted?))
-    end
-
-    def unique_key
-      if document_model
-        document_model.unique_key.to_sym
-      else
-        :id
-      end
-    end
-
-    def spotlight_resource_metadata_for_solr
-      {
-        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
-  end
-end