blacklight-spotlight 3.4.0 → 3.4.1

data/spec/services/spotlight/exhibit_import_export_service_spec.rb

@@ -1,569 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::ExhibitImportExportService do
-  subject { JSON.parse(described_class.new(source_exhibit).to_json) }
-
-  let!(:source_exhibit) { FactoryBot.create(:exhibit) }
-
-  before do
-    allow_any_instance_of(Spotlight::Search).to receive(:set_default_featured_image)
-    allow_any_instance_of(SolrDocument).to receive(:reindex)
-    allow_any_instance_of(Spotlight::Resource).to receive(:reindex)
-  end
-
-  it 'does not include unique identifiers' do
-    expect(subject).not_to have_key 'id'
-    expect(subject).not_to have_key 'slug'
-    expect(subject).not_to have_key 'name'
-    expect(subject).not_to have_key 'default'
-    expect(subject).not_to have_key 'masthead_id'
-    expect(subject).not_to have_key 'thumbnail_id'
-  end
-
-  it 'has search attributes' do
-    expect(subject['searches']).to have(source_exhibit.searches.count).searches
-  end
-
-  it 'has group attributes' do
-    expect(subject['groups']).to have(source_exhibit.groups.count).groups
-  end
-
-  it 'has home page attributes' do
-    expect(subject).to have_key 'home_page'
-    expect(subject['home_page']).not_to have_key 'id'
-    expect(subject['home_page']).not_to have_key 'scope'
-    expect(subject['home_page']).not_to have_key 'exhibit_id'
-  end
-
-  it 'has about pages' do
-    expect(subject['about_pages']).to have(source_exhibit.about_pages.count).pages
-  end
-
-  it 'has feature pages' do
-    expect(subject['feature_pages']).to have(source_exhibit.feature_pages.at_top_level.count).pages
-  end
-
-  it 'has custom fields' do
-    expect(subject['custom_fields']).to have(source_exhibit.custom_fields.count).items
-  end
-
-  it 'has contact emails' do
-    expect(subject['contact_emails']).to have(source_exhibit.contact_emails.count).items
-  end
-
-  it 'has blacklight configuration attributes' do
-    expect(subject).to have_key 'blacklight_configuration'
-  end
-
-  it 'has solr document sidecars' do
-    source_exhibit.solr_document_sidecars.create! document: SolrDocument.new(id: 1), public: false
-    expect(subject['solr_document_sidecars']).to have_at_least(1).item
-    expect(subject['solr_document_sidecars']).to have(source_exhibit.solr_document_sidecars.count).items
-
-    expect(subject['solr_document_sidecars'].first).to include('document_id', 'public')
-    expect(subject['solr_document_sidecars'].first).not_to include 'id'
-  end
-
-  it 'has attachments' do
-    expect(subject['attachments']).to have(source_exhibit.attachments.count).items
-  end
-
-  it 'has languages' do
-    expect(subject['languages']).to have(source_exhibit.languages.count).items
-  end
-
-  it 'has translations' do
-    expect(subject['translations']).to have(source_exhibit.translations.count).items
-  end
-
-  it 'has resources' do
-    expect(subject['resources']).to have(source_exhibit.resources.count).items
-  end
-
-  it 'has tags' do
-    source_exhibit.tag(Spotlight::SolrDocumentSidecar.create(document_id: 1, document_type: 'SolrDocument'), with: 'xyz', on: :tags)
-    expect(subject['owned_taggings']).to have(source_exhibit.owned_taggings.count).items
-  end
-
-  describe 'should round-trip data' do
-    subject do
-      destination_exhibit.import(export)
-      destination_exhibit
-    end
-
-    let(:destination_exhibit) { FactoryBot.create(:exhibit) }
-
-    let :export do
-      described_class.new(source_exhibit).as_json
-    end
-
-    before do
-      sidecar = source_exhibit.solr_document_sidecars.create! document: SolrDocument.new(id: 1), public: false
-      source_exhibit.tag(sidecar, with: 'xyz', on: :tags)
-    end
-
-    it 'has exhibit properties' do
-      expect(subject.title).to eq source_exhibit.title
-    end
-
-    context 'with a theme that does not exist in the destination' do
-      it 'ignores the invalid theme' do
-        source_exhibit.theme = 'xyz'
-        expect(subject.theme).to eq nil
-      end
-    end
-
-    it 'does not duplicate saved searches' do
-      expect(subject.searches).to have(1).item
-    end
-
-    it 'has blacklight configuration properties' do
-      subject.blacklight_configuration.index_fields_will_change!
-      subject.blacklight_configuration.index_fields['language_ssm'] = { some_value: true }
-      subject.blacklight_configuration.save
-
-      expect(subject.blacklight_configuration).to be_persisted
-      expect(subject.blacklight_configuration.blacklight_config.index_fields['language_ssm'].to_h).to include some_value: true
-    end
-
-    context 'for an exhibit without search fields' do
-      before do
-        source_exhibit.blacklight_configuration.search_fields = {}
-        source_exhibit.blacklight_configuration.save
-      end
-
-      it 'remains without search fields' do
-        expect(subject.blacklight_configuration.search_fields).to be_blank
-      end
-    end
-
-    it 'has home page properties' do
-      expect(subject.home_page).to be_persisted
-      expect(subject.home_page.id).not_to eq source_exhibit.home_page.id
-
-      expect(subject.home_page.title).to eq source_exhibit.home_page.title
-      expect(subject.home_page.content).to eq source_exhibit.home_page.content
-    end
-
-    it 'has sidecars' do
-      expect(SolrDocument.new(id: 1)).not_to be_public(subject)
-    end
-
-    context 'for an exhibit with contacts' do
-      context 'for a contact with an avatar' do
-        let!(:curator) do
-          FactoryBot.create(:contact, :with_avatar,
-                            exhibit: source_exhibit,
-                            contact_info: { title: 'xyz' })
-        end
-
-        it 'has contacts' do
-          expect(subject.contacts.count).to eq 1
-          contact = subject.contacts.first
-          expect(contact.contact_info[:title]).to eq 'xyz'
-          expect(contact.avatar).to be_kind_of Spotlight::ContactImage
-        end
-      end
-
-      context 'for a contact without an avatar' do
-        let!(:curator) do
-          FactoryBot.create(:contact, exhibit: source_exhibit, avatar: nil)
-        end
-
-        it 'has contacts' do
-          expect(subject.contacts.count).to eq 1
-        end
-      end
-    end
-
-    context 'for exhibits with languages and translations' do
-      let!(:language) do
-        source_exhibit.languages.create!(locale: 'zz', public: true, text: 'abc')
-      end
-
-      let!(:translation) do
-        source_exhibit.translations.create!(locale: 'zz', key: 'abc', value: '123')
-      end
-
-      it 'has the language' do
-        expect(subject.languages.count).to eq 1
-
-        language = subject.languages.first
-        expect(language).to have_attributes(locale: 'zz', public: true, text: 'abc')
-      end
-
-      it 'has translations' do
-        expect(subject.translations.count).to eq 1
-
-        translation = subject.translations.unscope(where: :locale).first
-        expect(translation).to have_attributes(locale: 'zz', key: 'abc', value: '123')
-      end
-    end
-
-    it 'has tags' do
-      expect(subject.owned_taggings.length).to eq source_exhibit.owned_taggings.length
-      expect(subject.owned_taggings.first).to be_persisted
-      expect(subject.owned_taggings.first.tag.name).to eq 'xyz'
-    end
-
-    context 'with custom main navigation labels' do
-      before do
-        nav = source_exhibit.main_navigations.about
-        nav.label = 'Custom Label'
-        nav.save
-      end
-
-      it 'persists across import/export' do
-        expect(subject.main_navigations.about.label).to eq 'Custom Label'
-      end
-    end
-
-    it 'deals with nested feature pages' do
-      FactoryBot.create :feature_subpage, exhibit: source_exhibit
-      expect(subject.feature_pages.at_top_level.length).to eq 1
-      expect(subject.feature_pages.first.child_pages.length).to eq 1
-    end
-
-    context 'page slugs' do
-      let!(:feature_page) { FactoryBot.create(:feature_page, exhibit: source_exhibit, slug: 'xyz') }
-
-      it 'uses the existing slug for the page' do
-        expect(subject.feature_pages.find('xyz')).to be_persisted
-      end
-    end
-
-    context 'with a feature page' do
-      let(:feature_page) { FactoryBot.create(:feature_page, exhibit: source_exhibit) }
-      let(:thumbnail) { FactoryBot.create(:featured_image) }
-
-      before do
-        feature_page.content = { data: [{ type: 'text', data: { text: 'xyz' } }] }.to_json
-        feature_page.thumbnail = thumbnail
-        feature_page.save!
-      end
-
-      it 'copies the masthead' do
-        expect(subject.feature_pages.first.thumbnail).not_to be_blank
-        expect(subject.feature_pages.first.thumbnail.image.file.path).not_to eq feature_page.thumbnail.image.file.path
-      end
-
-      it 'copies the thumbnail' do
-        expect(subject.feature_pages.first.thumbnail).not_to be_blank
-        expect(subject.feature_pages.first.thumbnail.image.file.path).not_to eq source_exhibit.feature_pages.first.thumbnail.image.file.path
-      end
-
-      it 'copies the content' do
-        expect(JSON.parse(subject.feature_pages.first.read_attribute(:content))).to have_key 'data'
-        expect(subject.feature_pages.first.content.length).to eq 1
-        expect(subject.feature_pages.first.content.first).to be_a_kind_of SirTrevorRails::Blocks::TextBlock
-      end
-
-      context 'with a translation' do
-        before do
-          localized_page = feature_page.clone_for_locale('ar')
-          localized_page.content = { data: [{ type: 'text', data: { text: 'xyz-in-ar' } }] }.to_json
-          localized_page.save!
-        end
-
-        it 'transfers the localized page' do
-          expect(subject.feature_pages.first.translated_pages.length).to eq 1
-          expect(JSON.parse(subject.feature_pages.first.translated_page_for('ar').read_attribute(:content))).to have_key 'data'
-          expect(subject.feature_pages.first.translated_page_for('ar').content.length).to eq 1
-          expect(subject.feature_pages.first.translated_page_for('ar').content.first).to be_a_kind_of SirTrevorRails::Blocks::TextBlock
-        end
-      end
-    end
-
-    it 'assigns STI resources the correct class' do
-      resource = FactoryBot.create :uploaded_resource, exhibit: source_exhibit
-      expect(subject.resources.length).to eq 1
-      expect(subject.resources.first.class).to eq Spotlight::Resources::Upload
-      expect(subject.resources.first.upload.image.path).not_to eq resource.upload.image.path
-    end
-
-    it 'assigns normal resources the correct class' do
-      resource = FactoryBot.create :resource, exhibit: source_exhibit
-      expect(subject.resources.length).to eq 1
-      expect(subject.resources.first.class).to eq Spotlight::Resource
-      expect(subject.resources.first.url).to eq resource.url
-    end
-
-    context 'with a browse category' do
-      let(:masthead) { FactoryBot.create(:masthead) }
-      let(:thumbnail) { FactoryBot.create(:featured_image) }
-      let!(:search) { FactoryBot.create(:search, exhibit: source_exhibit, masthead: masthead, thumbnail: thumbnail) }
-      let!(:existing_search) { FactoryBot.create(:search, slug: search.slug, exhibit: destination_exhibit) }
-
-      before do
-        source_exhibit.reload
-        destination_exhibit.reload
-      end
-
-      it 'copies the title' do
-        subject
-        existing_search.reload
-        expect(existing_search.title).to eq search.title
-      end
-
-      it 'copies the masthead' do
-        subject
-        existing_search.reload
-        expect(existing_search.masthead).not_to be_blank
-        expect(existing_search.masthead.image.file.path).not_to eq search.masthead.image.file.path
-      end
-
-      it 'copies the thumbnail' do
-        subject
-        existing_search.reload
-        expect(existing_search.thumbnail).not_to be_blank
-        expect(existing_search.thumbnail.image.file.path).not_to eq search.thumbnail.image.file.path
-      end
-
-      context 'without an attached image' do
-        before do
-          search.masthead.remove_image!
-          search.masthead.save
-        end
-
-        it 'copies the masthead without an image' do
-          subject
-          existing_search.reload
-          expect(existing_search.masthead).not_to be_blank
-          expect(existing_search.masthead.image).to be_blank
-        end
-      end
-
-      context 'remote thumbnail with existing tilesource' do
-        it do
-          search.thumbnail.iiif_tilesource
-          search.thumbnail.save
-          source_exhibit.reload
-        end
-
-        it 'unsets the iiif_tilesource' do
-          subject
-          existing_search.reload
-          expect(existing_search.thumbnail.iiif_tilesource).not_to eq search.thumbnail.iiif_tilesource
-        end
-      end
-
-      context 'with a thumbnail from an uploaded resource' do
-        before do
-          search.masthead.document_global_id = SolrDocument.new(id: 'xyz').to_global_id
-          search.masthead.source = 'exhibit'
-          search.masthead.iiif_tilesource = 'foo'
-          search.masthead.image = nil # Setting to nil to mimick an exhibit source
-          search.masthead.save
-
-          source_exhibit.reload
-        end
-
-        it 'copies the resource' do
-          subject
-          existing_search.reload
-          expect(existing_search.masthead).not_to be_blank
-        end
-
-        it 'does not unset the iiif_tilesource' do
-          subject
-          existing_search.reload
-          expect(existing_search.masthead.iiif_tilesource).to eq search.masthead.iiif_tilesource
-        end
-      end
-
-      context 'in a group' do
-        let!(:group) { FactoryBot.create(:group, title: 'blah', exhibit: source_exhibit) }
-
-        before do
-          search.groups << group
-          search.save!
-        end
-
-        it 'copies the group' do
-          subject
-          expect(destination_exhibit.groups.length).to eq 1
-          expect(destination_exhibit.groups.first.as_json).to include(group.as_json.slice('slug', 'title', 'weight', 'published'))
-        end
-
-        it 'copies the group membership' do
-          subject
-          expect(existing_search.reload.groups.length).to eq 1
-          expect(existing_search.groups.pluck(:slug)).to match_array [group.slug]
-        end
-      end
-    end
-
-    context 'with a masthead' do
-      let!(:masthead) { FactoryBot.create(:masthead) }
-
-      before do
-        source_exhibit.masthead = masthead
-      end
-
-      it 'is copied' do
-        expect(subject.masthead).not_to be_blank
-        expect(subject.masthead.image.file.path).not_to eq source_exhibit.masthead.image.file.path
-      end
-    end
-
-    context 'with a thumbnail' do
-      let!(:thumbnail) { FactoryBot.create(:exhibit_thumbnail) }
-
-      before do
-        source_exhibit.thumbnail = thumbnail
-      end
-
-      it 'is copied' do
-        expect(subject.thumbnail).not_to be_blank
-        expect(subject.thumbnail.image.file.path).not_to eq source_exhibit.thumbnail.image.file.path
-      end
-    end
-  end
-
-  context 'testing idempotency' do
-    let(:masthead) { FactoryBot.create(:masthead) }
-    let(:thumbnail) { FactoryBot.create(:exhibit_thumbnail) }
-    let!(:search) { FactoryBot.create(:search, exhibit: source_exhibit, masthead: FactoryBot.create(:masthead), thumbnail: FactoryBot.create(:featured_image)) }
-    let!(:feature_page_1) { FactoryBot.create(:feature_page, exhibit: source_exhibit) }
-    let!(:feature_page_2) { FactoryBot.create(:feature_page, exhibit: source_exhibit) }
-
-    before do
-      source_exhibit.masthead = masthead
-      source_exhibit.thumbnail = thumbnail
-    end
-
-    # From Rails 6:
-    def _deep_transform_values_in_object(object, &block)
-      case object
-      when Hash
-        object.transform_values { |value| _deep_transform_values_in_object(value, &block) }
-      when Array
-        object.map { |e| _deep_transform_values_in_object(e, &block) }
-      else
-        yield(object)
-      end
-    end
-
-    it 'is re-runnable' do
-      FactoryBot.create :feature_subpage, exhibit: source_exhibit
-      export = described_class.new(source_exhibit).as_json
-      e = FactoryBot.create(:exhibit)
-      e.import(export)
-      e.import(export)
-    end
-
-    it 'is idempotent-ish' do
-      export = described_class.new(source_exhibit).as_json
-      e = FactoryBot.create(:exhibit)
-      e.import(export)
-      new_export = described_class.new(e).as_json
-
-      actual = _deep_transform_values_in_object(new_export) do |v|
-        if DateTime.parse(v.to_s)
-          nil
-        else
-          v
-        end
-      rescue ArgumentError
-        nil
-      end
-      expected = _deep_transform_values_in_object(export) do |v|
-        if DateTime.parse(v.to_s)
-          nil
-        else
-          v
-        end
-      rescue ArgumentError
-        nil
-      end
-      expect(actual).to include expected
-    end
-  end
-
-  describe 'should export saved searches with query parameters that can be re-generated' do
-    subject do
-      e = FactoryBot.create(:exhibit)
-      e.import(export)
-      e
-    end
-
-    before do
-      source_exhibit.feature_pages.create content: [{
-        type: 'search_results',
-        data: {
-          'item' => {
-            search.slug => { id: search.slug, display: 'true' }
-          },
-          view: ['list']
-        }
-      }].to_json
-    end
-
-    let :export do
-      described_class.new(source_exhibit).as_json
-    end
-
-    context 'with a search object with matching query params' do
-      let :search do
-        source_exhibit.searches.first
-      end
-
-      it 'uses a search within the exhibit' do
-        # searches need to be published.
-        subject.searches.each { |x| x.update published: true }
-
-        expect(subject.feature_pages.first.content.first.search.exhibit).to eq subject
-      end
-
-      it 'uses the existing search object with the same query params' do
-        expect(subject.searches).to have(1).item
-      end
-    end
-
-    context 'with a search object that needs to be created' do
-      let :search do
-        source_exhibit.searches.create title: 'custom query', slug: 'xyz', published: true
-      end
-
-      before do
-        allow(Spotlight::DefaultThumbnailJob).to receive(:perform_later)
-      end
-
-      it 'creates a search within the exhibit' do
-        expect(subject.feature_pages.first.content.first.search.exhibit).to eq subject
-      end
-
-      it 'uses the existing search object with the same query params' do
-        expect(subject.searches).to have(2).items
-      end
-    end
-  end
-
-  context 'with engine configuration disabling all export types' do
-    let(:exports) do
-      {}
-    end
-
-    before do
-      allow(Spotlight::Engine.config).to receive(:exports).and_return(exports)
-    end
-
-    it 'includes nothing' do
-      expect(subject).to be_blank
-    end
-  end
-
-  context 'with engine configuration enabling only pages' do
-    let(:exports) do
-      { pages: true }
-    end
-
-    before do
-      allow(Spotlight::Engine.config).to receive(:exports).and_return(exports)
-    end
-
-    it 'includes only the page-related data' do
-      expect(subject.keys).to match_array %w[searches groups about_pages feature_pages home_page contacts]
-    end
-  end
-end

data/spec/services/spotlight/iiif_resource_resolver_spec.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::IiifResourceResolver do
-  subject(:resolver) { described_class.new(resource) }
-
-  let(:fixture_json) do
-    File.open(
-      File.expand_path(File.join('..', 'spec', 'fixtures', 'gk446cj2442-manifest.json'), Rails.root)
-    ).read
-  end
-  let(:iiif_manifest_url) { 'https://purl.stanford.edu/gk446cj2442/manifest.json' }
-  let(:resource) do
-    FactoryBot.create(
-      :featured_image,
-      iiif_manifest_url: iiif_manifest_url,
-      iiif_image_id: 'https://purl.stanford.edu/gk446cj2442/iiif/annotation/gk446cj2442_1',
-      iiif_canvas_id: 'https://purl.stanford.edu/gk446cj2442/iiif/canvas/gk446cj2442_1',
-      iiif_tilesource: 'https://stacks.stanford.edu/image/iiif/gk446cj2442%2Fgk446cj2442_05_0001/info.json'
-    )
-  end
-
-  before do
-    expect(resolver).to receive(:response).and_return(fixture_json)
-  end
-
-  context 'success' do
-    context 'when the tilesource has changed' do
-      before do
-        resource.iiif_tilesource = 'a-tilesource-that-no-longer-exists'
-        resource.save
-      end
-
-      it 'the resource is updated and saved' do
-        expect(resource).to receive(:save).and_call_original
-        resolver.resolve!
-        expect(resource.reload.iiif_tilesource).to eq 'https://stacks.stanford.edu/image/iiif/gk446cj2442%2Fgk446cj2442_05_0001/info.json'
-      end
-    end
-
-    context 'when the tilesource has not changed' do
-      it 'the resource is not saved' do
-        expect(resource).not_to receive(:save)
-        resolver.resolve!
-      end
-
-      it 'a statment indicating nothing was changed is loged' do
-        expect(Rails.logger).to receive(:info).with(
-          "Spotlight::IiifResourceResolver resolved #{iiif_manifest_url}, but nothing changed."
-        )
-        resolver.resolve!
-      end
-    end
-  end
-
-  context 'failure' do
-    before do
-      expect(resource).not_to receive(:save) # No spec should trigger a save under failure
-    end
-
-    context 'when the stored canvas ID is not present' do
-      it 'raises a ManifestError' do
-        resource.iiif_canvas_id = 'not-a-real-canvas-id'
-
-        expect { resolver.resolve! }.to raise_error(
-          Spotlight::IiifResourceResolver::ManifestError,
-          "No canvas with @id not-a-real-canvas-id found in #{iiif_manifest_url}"
-        )
-      end
-    end
-
-    context 'when the stored image ID is not present' do
-      it 'raises a ManifestError' do
-        resource.iiif_image_id = 'not-a-real-image-id'
-
-        expect { resolver.resolve! }.to raise_error(
-          Spotlight::IiifResourceResolver::ManifestError,
-          "No image with @id not-a-real-image-id found in #{iiif_manifest_url}"
-        )
-      end
-    end
-
-    context 'when the JSON is unparsable' do
-      let(:fixture_json) { 'Some sort of html error!' }
-
-      it 'logs that the JSON was unparsable and falls through to an no-canvas error' do
-        klass = described_class.name
-        expect(Rails.logger).to receive(:warn).with(
-          a_string_matching(/#{klass} failed to parse #{iiif_manifest_url} with: \d{3}: unexpected token at '#{fixture_json}'/)
-        )
-        expect { resolver.resolve! }.to raise_error(Spotlight::IiifResourceResolver::ManifestError)
-      end
-    end
-  end
-end

data/spec/services/spotlight/invite_users_service_spec.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::InviteUsersService do
-  subject { described_class.call(resource: resource) }
-
-  let(:resource) do
-    FactoryBot.create(:exhibit, roles: [FactoryBot.create(:role, user: user)])
-  end
-
-  context 'when the user was not created by an invite' do
-    let(:user) { FactoryBot.create(:user) }
-
-    it 'does not send an invite' do
-      expect do
-        subject
-      end.to change { Devise::Mailer.deliveries.count }.by(0)
-      expect(user.reload.invitation_sent_at).to be_nil
-    end
-  end
-
-  context 'when the user has already received an invite' do
-    let!(:user) do
-      User.invite!(email: 'a-user-that-does-not-exist@example.com', skip_invitation: true).tap do |u|
-        u.invitation_sent_at = Time.zone.now
-      end
-    end
-
-    it 'does not send an invite' do
-      expect do
-        subject
-      end.to change { Devise::Mailer.deliveries.count }.by(0)
-    end
-  end
-
-  context 'when the user was created by but not yet received an invite' do
-    let(:user) do
-      User.invite!(email: 'a-user-that-does-not-exist@example.com', skip_invitation: true)
-    end
-
-    it 'sends an invite' do
-      expect do
-        subject
-      end.to change { Devise::Mailer.deliveries.count }.by(1)
-      expect(user.reload.invitation_sent_at).to be_present
-    end
-  end
-end