blacklight-spotlight 3.0.0.rc2 → 3.0.0

data/app/assets/images/blacklight/add_circle.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0V0z"/><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm5 11h-4v4h-2v-4H7v-2h4V7h2v4h4v2z"/></svg>

data/app/assets/images/blacklight/custom_fullscreen.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M7,14H5v5h5V17H7Zm7-9V7h3v3h2V5Z" /><path d="M22.517,1.524H1.736V22.37H22.517Zm-2,18.845H3.736V3.524H20.517Z" /></svg>

data/app/assets/images/blacklight/remove_circle.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0V0z"/><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm5 11H7v-2h10v2z"/></svg>

data/app/assets/images/blacklight/resize_small.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M5,16H8v3h2V14H5ZM16,8V5H14v5h5V8Z"/><path d="M22.517,1.524H1.736V22.37H22.517Zm-2,18.845H3.736V3.524H20.517Z"/></svg>

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/reindex_progress.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-module Spotlight
-  ##
-  # ReindexProgress is a class that models the progress of reindexing a list of resources
-  class ReindexProgress
-    attr_reader :current_log_entry
-
-    delegate :updated_at, to: :current_log_entry
-
-    def initialize(current_log_entry)
-      @current_log_entry = current_log_entry
-    end
-
-    def recently_in_progress?
-      return true if current_log_entry.in_progress?
-
-      current_log_entry.end_time.present? && (current_log_entry.end_time > Spotlight::Engine.config.reindex_progress_window.minutes.ago)
-    end
-
-    def started_at
-      current_log_entry.start_time
-    end
-
-    def finished?
-      current_log_entry.succeeded? || current_log_entry.failed?
-    end
-
-    def finished_at
-      current_log_entry.end_time
-    end
-
-    def total
-      current_log_entry.items_reindexed_estimate
-    end
-
-    def completed
-      current_log_entry.items_reindexed_count
-    end
-
-    def errored?
-      current_log_entry.failed?
-    end
-
-    def as_json(*)
-      {
-        recently_in_progress: recently_in_progress?,
-        started_at: localized_start_time,
-        finished_at: localized_finish_time,
-        updated_at: localized_updated_time,
-        total: total,
-        completed: completed,
-        finished: finished?,
-        errored: errored?
-      }
-    end
-
-    private
-
-    def localized_start_time
-      return unless started_at
-
-      I18n.l(started_at, format: :long)
-    end
-
-    def localized_finish_time
-      return unless finished_at
-
-      I18n.l(finished_at, format: :long)
-    end
-
-    def localized_updated_time
-      return unless updated_at
-
-      I18n.l(updated_at, format: :long)
-    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/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,77 +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

data/app/services/spotlight/upload_solr_document_builder.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module Spotlight
-  # Creates solr documents for the uploaded documents in a resource
-  class UploadSolrDocumentBuilder < SolrDocumentBuilder
-    delegate :compound_id, to: :resource
-
-    def to_solr
-      super.tap do |solr_hash|
-        add_default_solr_fields solr_hash
-        add_sidecar_fields solr_hash
-
-        if attached_file?
-          add_image_dimensions solr_hash
-          add_file_versions solr_hash
-          add_manifest_path solr_hash
-        end
-      end
-    end
-
-    private
-
-    def add_default_solr_fields(solr_hash)
-      solr_hash[exhibit.blacklight_config.document_model.unique_key.to_sym] = compound_id
-    end
-
-    def add_image_dimensions(solr_hash)
-      dimensions = Riiif::Image.new(resource.upload_id).info
-      solr_hash[:spotlight_full_image_width_ssm] = dimensions.width
-      solr_hash[:spotlight_full_image_height_ssm] = dimensions.height
-    end
-
-    def add_file_versions(solr_hash)
-      solr_hash[Spotlight::Engine.config.thumbnail_field] = riiif.image_path(resource.upload_id, size: '!400,400')
-    end
-
-    def add_sidecar_fields(solr_hash)
-      solr_hash.merge! resource.sidecar.to_solr
-    end
-
-    def add_manifest_path(solr_hash)
-      solr_hash[Spotlight::Engine.config.iiif_manifest_field] = spotlight_routes.manifest_exhibit_solr_document_path(exhibit, resource.compound_id)
-    end
-
-    def spotlight_routes
-      Spotlight::Engine.routes.url_helpers
-    end
-
-    def riiif
-      Riiif::Engine.routes.url_helpers
-    end
-
-    def attached_file?
-      resource.upload&.file_present?
-    end
-  end
-end

data/spec/factories/reindexing_log_entries.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-FactoryBot.define do
-  factory :unstarted_reindexing_log_entry, class: 'Spotlight::ReindexingLogEntry' do
-    items_reindexed_count { 15 }
-    job_status { 'unstarted' }
-    exhibit
-    user
-  end
-
-  factory :reindexing_log_entry, class: 'Spotlight::ReindexingLogEntry' do
-    items_reindexed_count { 10 }
-    start_time { Time.zone.parse('2017-01-05 23:00:00') }
-    end_time { Time.zone.parse('2017-01-05 23:05:00') }
-    job_status { 'succeeded' }
-    exhibit
-    user
-  end
-
-  factory :reindexing_log_entry_no_user, class: 'Spotlight::ReindexingLogEntry' do
-    items_reindexed_count { 10 }
-    start_time { Time.zone.parse('2017-01-05 23:00:00') }
-    end_time { Time.zone.parse('2017-01-05 23:05:00') }
-    job_status { 'succeeded' }
-    exhibit
-  end
-
-  factory :in_progress_reindexing_log_entry, class: 'Spotlight::ReindexingLogEntry' do
-    items_reindexed_count { 100 }
-    start_time { Time.zone.now - 300 }
-    end_time { nil }
-    job_status { 'in_progress' }
-    exhibit
-    user
-  end
-
-  factory :recent_reindexing_log_entry, class: 'Spotlight::ReindexingLogEntry' do
-    sequence(:items_reindexed_count)
-    start_time { Time.zone.now - 86_400 }
-    end_time { Time.zone.now - 86_100 }
-    job_status { 'succeeded' }
-    exhibit
-    user
-  end
-
-  factory :failed_reindexing_log_entry, class: 'Spotlight::ReindexingLogEntry' do
-    items_reindexed_count { 10 }
-    start_time { Time.zone.parse('2017-01-10 23:00:00') }
-    end_time { Time.zone.parse('2017-01-10 23:05:00') }
-    job_status { 'failed' }
-    exhibit
-    user
-  end
-end

data/spec/models/spotlight/reindex_progress_spec.rb

@@ -1,122 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::ReindexProgress, type: :model do
-  let(:reindexing_log_entry) do
-    FactoryBot.create(:failed_reindexing_log_entry, items_reindexed_estimate: 12)
-  end
-
-  let(:subject) { described_class.new(reindexing_log_entry) }
-
-  describe '#started_at' do
-    it 'returns start_time for current_log_entry' do
-      expect(subject.started_at).to eq reindexing_log_entry.start_time
-    end
-  end
-
-  describe '#updated_at' do
-    it 'returns the time of last update for current_log_entry' do
-      expect(subject.updated_at).to eq reindexing_log_entry.updated_at
-    end
-  end
-
-  describe '#finished?' do
-    it 'returns true if current_log_entry is succeeded or failed' do
-      expect(subject.finished?).to be true
-    end
-  end
-
-  describe '#finished_at' do
-    it 'returns end_time for current_log_entry' do
-      expect(subject.finished_at).to eq(reindexing_log_entry.end_time)
-    end
-  end
-
-  describe '#total' do
-    it 'returns items_reindexed_estimate for current_log_entry' do
-      expect(subject.total).to be 12
-    end
-  end
-
-  describe '#completed' do
-    it 'returns items_reindexed_count for current_log_entry' do
-      expect(subject.completed).to be 10
-    end
-  end
-
-  describe '#errored?' do
-    it 'returns true for log entries marked as failed' do
-      expect(subject).to be_errored
-    end
-  end
-
-  describe '#as_json' do
-    it 'returns a hash with values for current_log_entry via the various helper methods' do
-      expect(subject.as_json).to eq(
-        recently_in_progress: subject.recently_in_progress?,
-        started_at: I18n.l(reindexing_log_entry.start_time, format: :long),
-        finished_at: I18n.l(reindexing_log_entry.end_time, format: :long),
-        updated_at: I18n.l(reindexing_log_entry.updated_at, format: :long),
-        total: subject.total,
-        completed: subject.completed,
-        errored: subject.errored?,
-        finished: subject.finished?
-      )
-    end
-  end
-
-  describe '#recently_in_progress?' do
-    context 'there is no end_time for current_log_entry' do
-      let(:reindexing_log_entry) { FactoryBot.create(:in_progress_reindexing_log_entry) }
-
-      it 'returns true' do
-        expect(subject).to be_recently_in_progress
-      end
-    end
-
-    context 'current_log_entry has an end_time less than Spotlight::Engine.config.reindex_progress_window.minutes.ago' do
-      let(:reindexing_log_entry) { FactoryBot.create(:recent_reindexing_log_entry, end_time: Time.zone.now) }
-
-      it 'returns true' do
-        expect(subject).to be_recently_in_progress
-      end
-    end
-
-    context 'current_log_entry is unstarted ' do
-      let(:reindexing_log_entry) { FactoryBot.create(:unstarted_reindexing_log_entry) }
-
-      it 'returns false' do
-        expect(subject).not_to be_recently_in_progress
-      end
-    end
-  end
-
-  context 'current_log_entry is blan' do
-    let(:reindexing_log_entry) { Spotlight::ReindexingLogEntry.new }
-
-    # rubocop:disable RSpec/MultipleExpectations
-    it 'methods return gracefully' do
-      expect(subject.recently_in_progress?).to be false
-      expect(subject.started_at).to be nil
-      expect(subject.updated_at).to be nil
-      expect(subject.finished?).to be false
-      expect(subject.finished_at).to be nil
-      expect(subject.total).to be nil
-      expect(subject.completed).to be nil
-      expect(subject.errored?).to be false
-      expect(subject.send(:localized_start_time)).to be nil
-      expect(subject.send(:localized_finish_time)).to be nil
-      expect(subject.send(:localized_updated_time)).to be nil
-      expect(subject.as_json).to eq(
-        recently_in_progress: false,
-        started_at: nil,
-        finished_at: nil,
-        updated_at: nil,
-        total: nil,
-        completed: nil,
-        errored: false,
-        finished: false
-      )
-    end
-    # rubocop:enable RSpec/MultipleExpectations
-  end
-end