blacklight-spotlight 3.0.0.alpha.6 → 3.0.0.rc1

data/spec/models/spotlight/page_spec.rb

@@ -119,7 +119,7 @@ describe Spotlight::Page, type: :model do
   end
 
   describe '#slug' do
-    let(:page) { FactoryBot.create(:feature_page) }
+    let(:page) { FactoryBot.create(:about_page) }
 
     it 'gets a default slug' do
       expect(page.slug).not_to be_blank
@@ -130,6 +130,11 @@ describe Spotlight::Page, type: :model do
       expect(page.slug).to eq 'abc'
     end
 
+    it 'blacklists contacts' do
+      page.update(title: 'contacts')
+      expect(page.slug).not_to eq 'contacts'
+    end
+
     context 'with a custom slug' do
       let(:page) { FactoryBot.create(:feature_page, slug: 'xyz') }
 

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

@@ -1,107 +1,71 @@
 # frozen_string_literal: true
 
 describe Spotlight::Resources::Upload, type: :model do
-  let!(:exhibit) { FactoryBot.create :exhibit }
-  let!(:custom_field) { FactoryBot.create :custom_field, exhibit: exhibit }
-  let(:resource) { described_class.new(exhibit: exhibit) }
-  let(:doc_builder) { resource.document_builder }
+  subject(:upload) { described_class.new(id: 42, exhibit: exhibit) }
 
-  let(:configured_fields) { [title_field] + described_class.fields(exhibit) }
-  let(:title_field) { Spotlight::UploadFieldConfig.new(field_name: 'configured_title_field') }
-  let(:upload_data) do
-    {
-      title_field.field_name => 'Title Data',
-      'spotlight_upload_description_tesim' => 'Description Data',
-      'spotlight_upload_attribution_tesim' => 'Attribution Data',
-      'spotlight_upload_date_tesim' => 'Date Data',
-      custom_field.field => 'Custom Field Data'
-    }
-  end
-  let(:featured_image) { FactoryBot.create(:featured_image, image: File.open(File.join(FIXTURES_PATH, '800x600.png'))) }
-
-  before do
-    Rails.cache.clear # wipes out any cached image info.
-    allow(resource).to receive(:configured_fields).and_return configured_fields
-    allow(described_class).to receive(:fields).and_return configured_fields
-
-    allow(resource.send(:blacklight_solr)).to receive(:update)
-    allow(Spotlight::Engine.config).to receive(:upload_title_field).and_return(title_field)
-    resource.data = upload_data
-    resource.upload = featured_image
-    resource.save
-  end
+  let(:exhibit) { FactoryBot.create(:exhibit) }
 
-  context 'with a custom upload title field' do
-    subject { doc_builder.to_solr }
-
-    let(:title_field) { Spotlight::UploadFieldConfig.new(field_name: 'configured_title_field', solr_fields: [:some_other_field]) }
+  describe '.fields' do
+    it "includes the exhibit's uploaded resource fields" do
+      expect(described_class.fields(exhibit)).to include(*exhibit.uploaded_resource_fields)
+    end
 
-    describe '#to_solr' do
-      it 'stores the title field in the provided solr field' do
-        expect(subject[:some_other_field]).to eq 'Title Data'
+    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
 
-  context 'multiple solr field mappings' do
-    let :configured_fields do
-      [
-        Spotlight::UploadFieldConfig.new(field_name: 'some_field', solr_fields: %w[a b])
-      ]
-    end
-
-    let :upload_data do
-      { 'some_field' => 'value' }
+  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 '#to_solr' do
-      subject { doc_builder.to_solr }
+  describe '#sidecar' do
+    it 'is a SolrDocumentSidecar with the correct relationships' do
+      sidecar = upload.sidecar
 
-      it 'maps a single uploaded field to multiple solr fields' do
-        expect(subject).not_to include 'some_field'
-        expect(subject['a']).to eq 'value'
-        expect(subject['b']).to eq 'value'
-      end
+      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
 
-  describe '#to_solr' do
-    subject { doc_builder.to_solr }
-
-    it 'has the exhibit id and the upload id as the solr id' do
-      expect(subject[:id]).to eq "#{resource.exhibit.id}-#{resource.id}"
+  context 'when creating' do
+    before do
+      allow(upload).to receive(:write?).and_return(false)
     end
 
-    it 'has a title field using the exhibit specific blacklight_config' do
-      expect(subject['configured_title_field']).to eq 'Title Data'
-    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'
+          }
+        }
+      )
 
-    it 'has the other additional configured fields' do
-      expect(subject[:spotlight_upload_description_tesim]).to eq 'Description Data'
-      expect(subject[:spotlight_upload_attribution_tesim]).to eq 'Attribution Data'
-      expect(subject[:spotlight_upload_date_tesim]).to eq 'Date Data'
-    end
+      upload.data = { 'full_title_tesim' => 'My Upload Title', 'spotlight_upload_date_tesim' => 'My Upload Date' }
 
-    it 'has a spotlight_resource_type field' do
-      expect(subject[:spotlight_resource_type_ssim]).to eq 'spotlight/resources/uploads'
+      upload.save
     end
 
-    it 'has the various image fields' do
-      expect(subject).to have_key Spotlight::Engine.config.thumbnail_field
-    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')
 
-    it 'has the full image dimensions fields' do
-      expect(subject[:spotlight_full_image_height_ssm]).to eq 600
-      expect(subject[:spotlight_full_image_width_ssm]).to eq 800
-    end
+      expect(upload.sidecar).to receive(:update).with(
+        data: hash_including('custom_field_1' => 'Custom Field 1 Data', 'custom_field_2' => 'Custom Field 2 Data')
+      )
 
-    it 'has fields representing exhibit specific custom fields' do
-      expect(subject[custom_field.solr_field]).to eq 'Custom Field Data'
-    end
+      upload.data = { 'custom_field_1' => 'Custom Field 1 Data', 'custom_field_2' => 'Custom Field 2 Data' }
 
-    it 'has a field for the iiif manifest url' do
-      manifest_path = Spotlight::Engine.routes.url_helpers.manifest_exhibit_solr_document_path(exhibit, resource.compound_id)
-      expect(subject[Spotlight::Engine.config.iiif_manifest_field]).to eq(manifest_path)
+      upload.save
     end
   end
 end

data/spec/models/spotlight/role_spec.rb

@@ -37,10 +37,10 @@ describe Spotlight::Role, type: :model do
 
       describe 'that points at a user with an existing role' do
         let(:user) { FactoryBot.create(:user) }
-        before { described_class.create!(role: 'curator', user: 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'])

data/spec/{serializers/spotlight/exhibit_export_serializer_spec.rb → services/spotlight/exhibit_import_export_service_spec.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-describe Spotlight::ExhibitExportSerializer do
+describe Spotlight::ExhibitImportExportService do
   subject { JSON.parse(described_class.new(source_exhibit).to_json) }
 
   let!(:source_exhibit) { FactoryBot.create(:exhibit) }
@@ -83,29 +83,43 @@ describe Spotlight::ExhibitExportSerializer do
 
   describe 'should round-trip data' do
     subject do
-      e = FactoryBot.create(:exhibit)
-      e.import(export).tap(&:save)
+      destination_exhibit.import(export)
+      destination_exhibit
     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
+    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
@@ -221,7 +235,7 @@ describe Spotlight::ExhibitExportSerializer do
       before do
         feature_page.content = { data: [{ type: 'text', data: { text: 'xyz' } }] }.to_json
         feature_page.thumbnail = thumbnail
-        feature_page.save
+        feature_page.save!
       end
 
       it 'copies the masthead' do
@@ -239,6 +253,21 @@ describe Spotlight::ExhibitExportSerializer do
         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
@@ -259,19 +288,31 @@ describe Spotlight::ExhibitExportSerializer 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
-        expect(subject.searches.last.masthead).not_to be_blank
-        expect(subject.searches.last.masthead.image.file.path).not_to eq search.masthead.image.file.path
+        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
-        expect(subject.searches.first.thumbnail).not_to be_blank
-        expect(subject.searches.first.thumbnail.image.file.path).not_to eq search.thumbnail.image.file.path
+        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
@@ -281,8 +322,10 @@ describe Spotlight::ExhibitExportSerializer do
         end
 
         it 'copies the masthead without an image' do
-          expect(subject.searches.last.masthead).not_to be_blank
-          expect(subject.searches.last.masthead.image).to be_blank
+          subject
+          existing_search.reload
+          expect(existing_search.masthead).not_to be_blank
+          expect(existing_search.masthead.image).to be_blank
         end
       end
 
@@ -296,7 +339,9 @@ describe Spotlight::ExhibitExportSerializer do
         end
 
         it 'copies the resource' do
-          expect(subject.searches.last.masthead).not_to be_blank
+          subject
+          existing_search.reload
+          expect(existing_search.masthead).not_to be_blank
         end
       end
     end
@@ -328,18 +373,71 @@ describe Spotlight::ExhibitExportSerializer do
     end
   end
 
-  it 'is idempotent-ish' do
-    FactoryBot.create :feature_subpage, exhibit: source_exhibit
-    export = described_class.new(source_exhibit).as_json
-    e = FactoryBot.create(:exhibit)
-    e.import(export).tap(&:save)
-    e.import(export).tap(&:save)
+  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).tap(&:save)
+      e.import(export)
+      e
     end
 
     before do

data/spec/services/spotlight/iiif_resource_resolver_spec.rb

@@ -68,7 +68,7 @@ describe Spotlight::IiifResourceResolver do
       end
     end
 
-    context 'when the stored canvas ID is not present' do
+    context 'when the stored image ID is not present' do
       it 'raises a ManifestError' do
         resource.iiif_image_id = 'not-a-real-image-id'
 

data/spec/test_app_templates/Gemfile.extra

@@ -1,3 +0,0 @@
-gem 'blacklight', '~> 7.0'
-gem 'sprockets', '< 4'
-gem 'thor', '~> 0.20'

data/spec/views/spotlight/feature_pages/_sidebar.html.erb_spec.rb

@@ -34,6 +34,7 @@ describe 'spotlight/feature_pages/_sidebar.html.erb', type: :view do
     assign(:page, child1)
     render
     # Checking that they are sorted accoding to weight
+    expect(rendered).to have_selector 'ol.sidenav', count: 1
     expect(rendered).to have_selector 'li', text: 'Parent Page'
     expect(rendered).to have_selector 'ol.sidenav li:nth-child(1) a', text: 'Five'
     expect(rendered).to have_selector 'ol.sidenav li:nth-child(2) a', text: 'Three'

data/spec/views/spotlight/metadata_configurations/_metadata_field.html.erb_spec.rb

@@ -2,7 +2,10 @@
 
 describe 'spotlight/metadata_configurations/_metadata_field', type: :view do
   let(:exhibit) { FactoryBot.create(:exhibit) }
+  let(:field) { Blacklight::Configuration::Field.new immutable: OpenStruct.new(another_view_type: false) }
+  let(:builder) { ActionView::Helpers::FormBuilder.new 'z', nil, view, {} }
   let(:p) { 'spotlight/metadata_configurations/metadata_field.html.erb' }
+
   before do
     assign(:exhibit, exhibit)
     assign(:blacklight_configuration, exhibit.blacklight_configuration)
@@ -14,9 +17,6 @@ describe 'spotlight/metadata_configurations/_metadata_field', type: :view do
     )
   end
 
-  let(:field) { Blacklight::Configuration::Field.new immutable: OpenStruct.new(another_view_type: false) }
-  let(:builder) { ActionView::Helpers::FormBuilder.new 'z', nil, view, {} }
-
   it 'uses the index_field_label helper to render the label' do
     allow(view).to receive(:index_field_label).with(anything, 'some_key').and_return 'Some label'
     render partial: p, locals: { key: 'some_key', config: field, f: builder }