blacklight-spotlight 3.4.0 → 3.4.1

data/spec/models/spotlight/resources/iiif_manifest_spec.rb

@@ -1,178 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-class TestMetadataClass
-  def initialize(*); end
-
-  def to_solr
-    { 'test_field' => 'metadata-to-solr' }
-  end
-
-  def label; end
-end
-
-describe Spotlight::Resources::IiifManifest do
-  subject { described_class.new(url: url, manifest: manifest, collection: collection) }
-
-  let(:url) { 'uri://to-manifest' }
-
-  let(:collection) { double(compound_id: '1') }
-  let(:manifest_fixture) { test_manifest1 }
-
-  before do
-    stub_iiif_response_for_url(url, manifest_fixture)
-    subject.with_exhibit(exhibit)
-  end
-
-  describe '#to_solr' do
-    let(:manifest) { Spotlight::Resources::IiifService.new(url).send(:object) }
-    let(:exhibit) { FactoryBot.create(:exhibit) }
-
-    describe 'id' do
-      it 'is an MD5 hexdigest of the exhibit id and the and the url' do
-        expected = Digest::MD5.hexdigest("#{exhibit.id}-#{url}")
-        expect(subject.to_solr[:id]).to eq expected
-      end
-    end
-
-    describe 'label' do
-      it 'is included in the solr document when present' do
-        expect(subject.to_solr['full_title_tesim']).to eq 'Test Manifest 1'
-      end
-
-      it 'indexes to multiple fields when configured' do
-        allow(Spotlight::Engine.config).to receive(:iiif_title_fields).at_least(:once).and_return(%w[title_field1 title_field2])
-
-        expect(subject.to_solr['title_field1']).to eq 'Test Manifest 1'
-        expect(subject.to_solr['title_field2']).to eq 'Test Manifest 1'
-      end
-    end
-
-    context 'JSON-LD style labels' do
-      context 'when it is an array' do
-        let(:manifest_fixture) { test_manifest3 }
-
-        it 'uses the configured language to find a value' do
-          expect(subject.to_solr['full_title_tesim']).to eq 'Test Manifest 3'
-
-          allow(Spotlight::Engine.config).to receive(:default_json_ld_language).and_return('fr')
-          expect(subject.to_solr['full_title_tesim']).to eq "Manifeste d'essai 3"
-        end
-      end
-
-      context 'when it is a hash' do
-        let(:manifest_fixture) { test_manifest2 }
-
-        it 'is parsed correctly' do
-          expect(subject.to_solr['full_title_tesim']).to eq 'Test Manifest 2'
-        end
-      end
-    end
-
-    describe 'collection id' do
-      it 'is included when a collection is given' do
-        expect(subject.to_solr[:collection_id_ssim]).to eq ['1']
-      end
-    end
-
-    describe 'manifest url' do
-      it 'is inlcuded in the solr document when present' do
-        expect(subject.to_solr[:iiif_manifest_url_ssi]).to eq url
-      end
-    end
-
-    describe 'thumbnail url' do
-      it 'is inlcuded in the solr document when present' do
-        expect(subject.to_solr[:thumbnail_url_ssm]).to eq 'uri://to-thumbnail'
-      end
-    end
-
-    describe 'full size image url' do
-      it 'is included in the solr document' do
-        expect(subject.to_solr[:full_image_url_ssm]).to eq 'uri://full-image'
-      end
-    end
-
-    describe 'image urls' do
-      it 'is included in the solr document when present' do
-        expect(subject.to_solr[:content_metadata_image_iiif_info_ssm]).to eq ['uri://to-image-service/info.json']
-      end
-    end
-
-    describe 'metadata' do
-      it 'includes the top-level attribution' do
-        expect(subject.to_solr['readonly_attribution_tesim']).to eq ['Attribution Data']
-      end
-
-      it 'includes the top-level description' do
-        expect(subject.to_solr['readonly_description_tesim']).to eq ['A test IIIF manifest']
-      end
-
-      it 'includes the top-level license' do
-        expect(subject.to_solr['readonly_license_tesim']).to eq ['http://www.example.org/license.html']
-      end
-
-      it 'includes fields for each label/value pair in the metadata section' do
-        expect(subject.to_solr['readonly_author_tesim']).to include 'John Doe'
-        expect(subject.to_solr['readonly_another-field_tesim']).to eq ['Some data']
-      end
-
-      it 'collects items with the same label into an array' do
-        expect(subject.to_solr['readonly_author_tesim']).to eq ['John Doe', 'Jane Doe']
-      end
-
-      it 'exhibit custom fields are created for the necessary fields' do
-        expect { subject.to_solr }.to change(Spotlight::CustomField, :count).by(5)
-      end
-
-      it 'creates read-only custom fields' do
-        expect { subject.to_solr }.to change(Spotlight::CustomField.where(readonly_field: true), :count).by(5)
-      end
-
-      context 'custom class' do
-        before do
-          allow(Spotlight::Engine.config).to receive(:iiif_metadata_class).and_return(-> { TestMetadataClass })
-        end
-
-        it 'merges the solr hash from the configured custom metadata class' do
-          expect(subject.to_solr['readonly_test_field_tesim']).to eq 'metadata-to-solr'
-        end
-      end
-    end
-  end
-
-  context 'with a multilingual manifest' do
-    let(:manifest_fixture) { test_multilingual_manifest_like_bsb }
-
-    describe '#to_solr' do
-      let(:manifest) { Spotlight::Resources::IiifService.new(url).send(:object) }
-      let(:exhibit) { FactoryBot.create(:exhibit) }
-
-      describe 'label' do
-        it 'is included in the solr document when present' do
-          expect(subject.to_solr['full_title_tesim']).to eq 'Murasaki Shikibu: Genji monogatari - BSB Cod.jap. 18(53'
-        end
-      end
-
-      describe 'metadata' do
-        it 'extracts labels and values out of multivalued data and removes HTML markup' do
-          expect(subject.to_solr).to include 'readonly_author_tesim' => ['Murasaki Shikibu -- (GND: 118985655)'],
-                                             'readonly_language_tesim' => ['Japanese']
-        end
-
-        it 'extracts data using the configured default language' do
-          allow(Spotlight::Engine.config).to receive(:default_json_ld_language).and_return('de')
-          expect(subject.to_solr).to include 'readonly_verfasser_tesim' => ['Murasaki Shikibu -- (GND: 118985655)'],
-                                             'readonly_sprache_tesim' => ['Japanisch']
-        end
-
-        it 'falls back to a language from the manifest using the IIIF rules' do
-          allow(Spotlight::Engine.config).to receive(:default_json_ld_language).and_return('fr')
-          expect(subject.to_solr).to include 'readonly_verfasser_tesim' => ['Murasaki Shikibu -- (GND: 118985655)'],
-                                             'readonly_sprache_tesim' => ['Japanisch']
-        end
-      end
-    end
-  end
-end

data/spec/models/spotlight/resources/iiif_service_spec.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Spotlight::Resources::IiifService do
-  subject { described_class.new(url) }
-
-  let(:url) { 'uri://for-top-level-collection' }
-
-  before { stub_default_collection }
-
-  describe '#collections' do
-    it 'returns service objects for each top-level collection' do
-      expect(subject.collections.length).to eq 2
-      expect(subject.collections).to be_all { |s| s.is_a?(described_class) }
-    end
-
-    it 'returns service objects for nested collections' do
-      expect(subject.collections.first.collections.length).to eq 1
-      expect(subject.collections.last.collections).to be_blank
-      expect(subject.collections.first.collections.first).to be_a(described_class)
-      expect(
-        subject.collections.first.collections.first.collections
-      ).to be_blank
-    end
-  end
-
-  describe '#manifests' do
-    it 'returns manifests for the current service level' do
-      expect(subject.manifests.length).to eq 2
-      expect(subject.manifests.first).to be_a Spotlight::Resources::IiifManifest
-      expect(subject.collections.first.manifests.length).to eq 2
-      expect(
-        subject.collections.first.manifests.first
-      ).to be_a Spotlight::Resources::IiifManifest
-    end
-  end
-
-  describe '#parse' do
-    let(:manifests) { described_class.parse(url) }
-
-    it 'recursively traverses all all the collections and returns manifests' do
-      expect(manifests).to be_all do |manifest|
-        manifest.is_a?(Spotlight::Resources::IiifManifest)
-      end
-    end
-
-    it 'returns manifests representing collection documents' do
-      expect(manifests.count).to eq 8
-    end
-
-    it 'keeps track of the parent collection' do
-      arr = manifests.to_a
-      expect(arr[1].collection).to eq arr[0]
-    end
-  end
-end

data/spec/models/spotlight/resources/upload_spec.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::Resources::Upload, type: :model do
-  subject(:upload) { described_class.new(id: 42, exhibit: exhibit) }
-
-  let(:exhibit) { FactoryBot.create(:exhibit) }
-
-  describe '.fields' do
-    it "includes the exhibit's uploaded resource fields" do
-      expect(described_class.fields(exhibit)).to include(*exhibit.uploaded_resource_fields)
-    end
-
-    context 'title field' do
-      it 'is an UploadFieldConfig object for the configured index title_field' do
-        upload_config = described_class.fields(exhibit).first
-        expect(upload_config).to be_a Spotlight::UploadFieldConfig
-        expect(upload_config.field_name).to eq exhibit.blacklight_config.index.title_field
-      end
-    end
-  end
-
-  describe '#compound_id' do
-    it 'appends the object ID w/ the exhibit ID' do
-      expect(upload.compound_id).to eq "#{exhibit.id}-42"
-    end
-  end
-
-  describe '#sidecar' do
-    it 'is a SolrDocumentSidecar with the correct relationships' do
-      sidecar = upload.sidecar
-
-      expect(sidecar).to be_a Spotlight::SolrDocumentSidecar
-      expect(sidecar.exhibit_id).to eq exhibit.id
-      expect(sidecar.document_id).to eq "#{exhibit.id}-42"
-    end
-  end
-
-  context 'when creating' do
-    before do
-      allow(upload).to receive(:write?).and_return(false)
-    end
-
-    it 'the sidecar is updated with the apporpriate data from configured fields' do
-      expect(upload.sidecar).to receive(:update).with(
-        data: {
-          'configured_fields' => {
-            'full_title_tesim' => 'My Upload Title',
-            'spotlight_upload_date_tesim' => 'My Upload Date'
-          }
-        }
-      )
-
-      upload.data = { 'full_title_tesim' => 'My Upload Title', 'spotlight_upload_date_tesim' => 'My Upload Date' }
-
-      upload.save
-    end
-
-    it 'the sidecar is updated with the appropriate data from custom fields' do
-      FactoryBot.create(:custom_field, exhibit: exhibit, slug: 'custom_field_1')
-      FactoryBot.create(:custom_field, exhibit: exhibit, slug: 'custom_field_2')
-
-      expect(upload.sidecar).to receive(:update).with(
-        data: hash_including('custom_field_1' => 'Custom Field 1 Data', 'custom_field_2' => 'Custom Field 2 Data')
-      )
-
-      upload.data = { 'custom_field_1' => 'Custom Field 1 Data', 'custom_field_2' => 'Custom Field 2 Data' }
-
-      upload.save
-    end
-  end
-end

data/spec/models/spotlight/resources/web_spec.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::Resources::Web, type: :model do
-  class TestResource < Spotlight::Resource
-    include Spotlight::Resources::Web
-  end
-
-  subject { TestResource.new }
-
-  describe '#harvest!' do
-    it 'caches the body and headers in the data' do
-      allow(described_class).to receive_messages(fetch: double(body: 'xyz', headers: { a: 1 }))
-      subject.harvest!
-      expect(subject.data[:body]).to eq 'xyz'
-      expect(subject.data[:headers]).to eq a: 1
-    end
-  end
-
-  describe '#body' do
-    it 'returns the body DOM' do
-      allow(described_class).to receive_messages(fetch: double(body: '<html />', headers: { a: 1 }))
-      expect(subject.body).to be_a_kind_of(Nokogiri::HTML::Document)
-    end
-  end
-end

data/spec/models/spotlight/role_spec.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::Role, type: :model do
-  describe 'validations' do
-    subject { described_class.new(args) }
-
-    describe 'with nothing' do
-      let(:args) { { user_key: '' } }
-
-      it 'does not be valid' do
-        expect(subject).not_to be_valid
-        expect(subject.errors.messages.transform_values(&:to_a)).to include(role: ['is not included in the list'], 'user.email': ["can't be blank"])
-      end
-    end
-
-    describe 'with user_key' do
-      describe "that doesn't point at a user" do
-        let(:user) { FactoryBot.build(:user) }
-        let(:args) { { role: 'curator', user_key: user.email } }
-
-        it 'does not be valid' do
-          expect(subject).to be_valid
-          subject.save!
-          expect(subject.user).to be_invite_pending
-        end
-      end
-
-      describe 'that points at a user' do
-        let(:user) { FactoryBot.create(:user) }
-        let(:args) { { role: 'curator', user_key: user.email } }
-
-        it 'is valid' do
-          expect(subject).to be_valid
-          expect(subject.errors.messages).to be_empty
-        end
-      end
-
-      describe 'that points at a user with an existing role' do
-        let(:user) { FactoryBot.create(:user) }
-        let(:args) { { role: 'curator', user_key: user.email } }
-
-        before { described_class.create!(role: 'curator', user: user) }
-
-        it 'is valid' do
-          expect(subject).not_to be_valid
-          expect(subject.errors.messages).to eq(user_key: ['already a member of this exhibit'])
-        end
-      end
-    end
-  end
-end

data/spec/models/spotlight/search_spec.rb

@@ -1,125 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::Search, type: :model do
-  subject { exhibit.searches.build(title: 'Search', query_params: query_params) }
-
-  let(:exhibit) { FactoryBot.create(:exhibit) }
-
-  let(:query_params) { { 'f' => { 'genre_ssim' => ['map'] } } }
-
-  let(:blacklight_config) { ::CatalogController.blacklight_config }
-  let(:document) do
-    SolrDocument.new(id: 'dq287tq6352',
-                     blacklight_config.index.title_field => 'title')
-  end
-
-  describe 'for a search matching all items' do
-    let(:query_params) { {} }
-
-    it 'has items' do
-      # Add some fuzziness to this. Running locally it should be 55 but in some
-      # CI environments, spec/features/add_items_spec.rb will end up adding new
-      # records and cannot ensure deletion of them.
-      expect(subject.documents.size).to be_within(1).of(55)
-    end
-  end
-
-  describe 'default_scope' do
-    let!(:page1) { FactoryBot.create(:search, weight: 5, published: true) }
-    let!(:page2) { FactoryBot.create(:search, weight: 1, published: true) }
-    let!(:page3) { FactoryBot.create(:search, weight: 10, published: true) }
-
-    it 'orders by weight' do
-      expect(described_class.published.map(&:weight)).to eq [1, 5, 10]
-    end
-  end
-
-  describe '.unpublished' do
-    let!(:search1) { FactoryBot.create(:search, published: true) }
-    let!(:search2) { FactoryBot.create(:search, published: false) }
-    let!(:search3) { FactoryBot.create(:search, published: nil) }
-
-    it 'accounts for nil and false values' do
-      expect(described_class.unpublished.count).to eq 5
-    end
-  end
-
-  describe '#slug' do
-    let(:search) { FactoryBot.create(:search) }
-
-    it 'gets a default slug' do
-      expect(search.slug).not_to be_blank
-    end
-
-    it 'is updated when the title changes' do
-      search.update(title: 'abc')
-      expect(search.slug).to eq 'abc'
-    end
-
-    context 'with a custom slug' do
-      let(:search) { FactoryBot.create(:search, slug: 'xyz') }
-
-      it 'gets a default slug' do
-        expect(search.slug).to eq 'xyz'
-      end
-    end
-  end
-
-  describe '#search_params' do
-    it 'maps the search to the appropriate facet values' do
-      expect(subject.search_params.to_hash).to include 'fq' => array_including('{!term f=genre_ssim}map')
-    end
-
-    context 'with filter_resources_by_exhibit configured' do
-      before do
-        allow(Spotlight::Engine.config).to receive(:filter_resources_by_exhibit).and_return(true)
-      end
-
-      it 'includes the exhibit context' do
-        expect(subject.search_params.to_hash).to include 'fq' => array_including("{!term f=spotlight_exhibit_slug_#{exhibit.slug}_bsi}true")
-      end
-    end
-  end
-
-  describe '#repository' do
-    let(:search) { FactoryBot.create(:search) }
-
-    before do
-      allow(search).to receive(:blacklight_config).and_return blacklight_config
-    end
-
-    it 'returns an exhibit specific config' do
-      expect(search.send(:repository).blacklight_config).to eql blacklight_config
-    end
-  end
-
-  describe '#merge_params_for_search' do
-    it 'merges user-supplied parameters into the search query' do
-      user_params = { view: 'x' }
-      search_params = subject.merge_params_for_search(user_params, blacklight_config)
-      expect(search_params).to include query_params
-      expect(search_params).to include user_params
-    end
-
-    it 'preserves user pagination' do
-      user_params = { page: 5, per_page: 7 }
-      search_params = subject.merge_params_for_search(user_params, blacklight_config)
-      expect(search_params).to include query_params
-      expect(search_params).to include user_params
-    end
-  end
-
-  describe '#groups' do
-    let(:search) { FactoryBot.create(:search_with_groups, groups_count: 3) }
-
-    it do
-      expect(search.groups.count).to eq 3
-    end
-
-    it do
-      search.groups.all do |group|
-        expect(group).to be_an Spotlight::Group
-      end
-    end
-  end
-end

data/spec/models/spotlight/site_spec.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::Site do
-  describe '.instance' do
-    it 'is a singleton' do
-      expect(described_class.instance).to eq described_class.instance
-    end
-  end
-end

data/spec/models/spotlight/sitemap_spec.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-require 'sitemap_generator'
-
-describe Spotlight::Sitemap do
-  subject { described_class.new(sitemap, exhibit) }
-
-  let(:sitemap) { SitemapGenerator::Interpreter.new }
-  let(:exhibit) { FactoryBot.create(:exhibit, published: true) }
-  let(:blacklight_config) { Blacklight::Configuration.new }
-  let(:sitemap_content) { sitemap.sitemap.sitemap.instance_variable_get(:@xml_content) }
-  let(:url_helpers) { Spotlight::Engine.routes.url_helpers }
-
-  before do
-    allow(exhibit).to receive(:blacklight_config).and_return(blacklight_config)
-
-    SitemapGenerator::Sitemap.default_host = 'http://localhost/'
-    SitemapGenerator::Interpreter.send :include, Rails.application.routes.url_helpers
-    SitemapGenerator::Interpreter.send :include, Spotlight::Engine.routes.url_helpers
-  end
-
-  describe '.add_all_exhibits' do
-    let!(:second_exhibit) { FactoryBot.create(:exhibit, published: true) }
-    let!(:unpublished_exhibit) { FactoryBot.create(:exhibit, published: false) }
-
-    it 'builds a sitemap for all published exhibits' do
-      sitemaps = []
-
-      allow_any_instance_of(described_class).to receive(:add_resources!) do |s|
-        sitemaps << s
-      end
-
-      described_class.add_all_exhibits(sitemap)
-
-      expect(sitemaps.map(&:exhibit)).to include exhibit, second_exhibit
-      expect(sitemaps.map(&:exhibit)).not_to include unpublished_exhibit
-    end
-  end
-
-  describe '.add_exhibit' do
-    it 'builds a sitemap for the exhibit' do
-      expect_any_instance_of(described_class).to receive(:add_resources!)
-
-      described_class.add_exhibit(sitemap, exhibit)
-    end
-  end
-
-  describe '#add_resources!' do
-    it 'builds a sitemap for all exhibit resources' do
-      expect(subject).to receive(:add_exhibit_root)
-      expect(subject).to receive(:add_pages)
-      expect(subject).to receive(:add_resources)
-      expect(subject).to receive(:add_browse_categories)
-
-      subject.add_resources!
-    end
-
-    it 'does not publish sitemaps for unpublished exhibits' do
-      exhibit.published = false
-
-      expect(subject).not_to receive(:add_exhibit_root)
-      expect(subject).not_to receive(:add_pages)
-      expect(subject).not_to receive(:add_resources)
-      expect(subject).not_to receive(:add_browse_categories)
-
-      subject.add_resources!
-    end
-  end
-
-  describe '#add_exhibit_root' do
-    it 'adds the home page' do
-      subject.add_exhibit_root
-      expect(sitemap_content).to include url_helpers.exhibit_root_path(exhibit)
-    end
-  end
-
-  describe '#add_pages' do
-    let!(:feature_page) { FactoryBot.create(:feature_page, exhibit: exhibit, published: true) }
-    let!(:about_page) { FactoryBot.create(:about_page, exhibit: exhibit, published: true) }
-
-    it 'adds feature pages' do
-      subject.add_pages
-      expect(sitemap_content).to include url_helpers.exhibit_feature_page_path(exhibit, feature_page)
-    end
-
-    it 'adds about pages' do
-      subject.add_pages
-      expect(sitemap_content).to include url_helpers.exhibit_about_page_path(exhibit, about_page)
-    end
-  end
-
-  describe '#add_resources' do
-    let(:document) { blacklight_config.document_model.new(id: 'a') }
-
-    before do
-      allow(exhibit).to receive(:solr_documents).and_return([document])
-    end
-
-    it 'adds document resources' do
-      subject.add_resources
-      expect(sitemap_content).to include url_helpers.exhibit_solr_document_path(exhibit, document)
-    end
-  end
-
-  describe '#add_browse_categories' do
-    let!(:search) { FactoryBot.create(:published_search, exhibit: exhibit) }
-
-    it 'adds browse categories to the sitemap' do
-      subject.add_browse_categories
-      expect(sitemap_content).to include url_helpers.exhibit_browse_path(exhibit, search)
-    end
-  end
-end

data/spec/models/spotlight/solr_document/atomic_updates_spec.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::SolrDocument::AtomicUpdates, type: :model do
-  subject do
-    SolrDocument.new.extend(described_class)
-  end
-
-  let(:blacklight_solr) { double }
-
-  before do
-    allow(subject).to receive_messages(blacklight_solr: blacklight_solr)
-  end
-
-  describe '#reindex' do
-    before do
-      allow(subject).to receive_messages(to_solr: { id: 'doc_id', a: 1, b: 2 })
-    end
-
-    context 'when the index is not writable' do
-      before do
-        allow(Spotlight::Engine.config).to receive_messages(writable_index: false)
-      end
-
-      it "doesn't write" do
-        expect(blacklight_solr).not_to receive(:update)
-        subject.reindex
-      end
-    end
-
-    it 'sends an atomic update request' do
-      expected = {
-        params: { commitWithin: 500 },
-        data: [{ id: 'doc_id', a: { set: 1 }, b: { set: 2 }, timestamp: { set: nil } }].to_json,
-        headers: { 'Content-Type' => 'application/json' }
-      }
-      expect(blacklight_solr).to receive(:update).with(expected)
-      subject.reindex
-    end
-
-    it 'update parameters can be specified to modify commitWithin' do
-      expected = {
-        params: { commitWithin: 5001 },
-        data: [{ id: 'doc_id', a: { set: 1 }, b: { set: 2 }, timestamp: { set: nil } }].to_json,
-        headers: { 'Content-Type' => 'application/json' }
-      }
-      expect(blacklight_solr).to receive(:update).with(expected)
-      subject.reindex(update_params: { commitWithin: 5001 })
-    end
-
-    it 'cowardlies refuse to index a document if the only value is an id' do
-      allow(subject).to receive_messages(to_solr: { id: 'doc_id' }, timestamp: { set: nil })
-      expect(blacklight_solr).not_to receive(:update)
-      subject.reindex
-    end
-  end
-end