blacklight-spotlight 0.4.1 → 0.5.0

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

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Spotlight::SolrDocument::AtomicUpdates, type: :model do
+  let(:blacklight_solr) { double }
+  subject do
+    ::SolrDocument.new.extend(described_class)
+  end
+
+  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
+
+    it 'sends an atomic update request' do
+      expected = {
+        params: { commitWithin: 500 },
+        data: [{ id: 'doc_id', a: { set: 1 }, b: { set: 2 } }].to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      }
+      expect(blacklight_solr).to receive(:update).with(expected)
+      subject.reindex
+    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' })
+      expect(blacklight_solr).not_to receive(:update)
+      subject.reindex
+    end
+  end
+end

data/spec/models/spotlight/{solr_document_images_spec.rb → solr_document/spotlight_images_spec.rb}

@@ -1,27 +1,28 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Spotlight::SolrDocument::SpotlightImages do
-  let(:subject) {
+  subject do
     SolrDocument.new(
-      Spotlight::Engine.config.full_image_field   => ['http://lorempixel.com/800/500/'],
-      Spotlight::Engine.config.thumbnail_field    => ['http://lorempixel.com/400/240/'],
-      Spotlight::Engine.config.square_image_field => ['http://lorempixel.com/200/200/'],
+      Spotlight::Engine.config.full_image_field => ['http://lorempixel.com/800/500/'],
+      Spotlight::Engine.config.thumbnail_field => ['http://lorempixel.com/400/240/'],
+      Spotlight::Engine.config.square_image_field => ['http://lorempixel.com/200/200/']
     )
-  }
-  it 'should be a Versions class' do
+  end
+
+  it 'is a Versions class' do
     expect(subject.spotlight_image_versions).to be_a Spotlight::SolrDocument::SpotlightImages::Versions
   end
-  it 'should map image urls in the document to the appropriate version' do
+  it 'maps image urls in the document to the appropriate version' do
     expect(subject.spotlight_image_versions.full).to eq ['http://lorempixel.com/800/500/']
     expect(subject.spotlight_image_versions.thumb).to eq ['http://lorempixel.com/400/240/']
     expect(subject.spotlight_image_versions.square).to eq ['http://lorempixel.com/200/200/']
   end
-  it 'should include the version keys in the versions array' do
+  it 'includes the version keys in the versions array' do
     [:full, :thumb, :square].each do |version|
       expect(subject.spotlight_image_versions.versions).to include version
     end
   end
-  it 'should include newly configured image versions' do
+  it 'includes newly configured image versions' do
     Spotlight::ImageDerivatives.spotlight_image_derivatives << {
       version: :tiny,
       field: :new_image_field
@@ -32,4 +33,11 @@ describe Spotlight::SolrDocument::SpotlightImages do
       d[:version] == :tiny
     end
   end
+
+  it 'gracefully handles missing data' do
+    subject = SolrDocument.new Spotlight::Engine.config.full_image_field => ['http://lorempixel.com/800/500/']
+    expect(subject.spotlight_image_versions.full).to eq ['http://lorempixel.com/800/500/']
+    expect(subject.spotlight_image_versions.thumb).to be_empty
+    expect(subject.spotlight_image_versions.square).to be_empty
+  end
 end

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

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Spotlight::SolrDocument::UploadedResource, type: :model do
+  let(:valid_resource) do
+    ::SolrDocument.new(id: '123',
+                       full_image_url_ssm: ['http://example.com/png.png'],
+                       spotlight_full_image_height_ssm: ['1400'],
+                       spotlight_full_image_width_ssm: ['1000'],
+                       spotlight_resource_type_ssim: ['spotlight/resources/uploads'])
+  end
+
+  describe 'SolrDocument.use_extension' do
+    it 'does not include the uploaded resource extension when the spotlight resource type is not correct' do
+      expect(::SolrDocument.new(id: '123', spotlight_resource_type_ssim: ['not-correct'])).to_not be_a_kind_of(described_class)
+    end
+    it 'includes the uploaded resource extension when the correct fields are present with the correct data' do
+      expect(valid_resource).to be_a_kind_of(described_class)
+    end
+  end
+  describe 'to_openseadragon' do
+    let(:subject) { valid_resource.to_openseadragon }
+    it 'includes hashes for each full_image_url_ssm' do
+      expect(subject).to be_an Array
+      expect(subject.length).to eq 1
+      expect(subject.first.keys.length).to eq 1
+    end
+    it 'the hashes key should be a LegacyImagePyramidTileSource object' do
+      expect(subject.first.keys.first).to be_a(Spotlight::SolrDocument::UploadedResource::LegacyImagePyramidTileSource)
+    end
+    describe 'LegacyImagePyramidTileSource' do
+      let(:subject) { valid_resource.to_openseadragon.first.keys.first.to_tilesource }
+      it 'is a hash' do
+        expect(subject).to be_a Hash
+      end
+      it 'is a legacy image pyramid type' do
+        expect(subject[:type]).to eq 'legacy-image-pyramid'
+      end
+      describe 'levels' do
+        it 'includes one level' do
+          expect(subject[:levels].length).to eq 1
+        end
+        it 'includes the image url' do
+          expect(subject[:levels].first[:url]).to eq 'http://example.com/png.png'
+        end
+        it 'includes the height and width from the document' do
+          expect(subject[:levels].first[:height]).to eq '1400'
+          expect(subject[:levels].first[:width]).to eq '1000'
+        end
+      end
+    end
+  end
+end

data/spec/models/spotlight/solr_document_sidecar_spec.rb

@@ -1,20 +1,19 @@
 require 'spec_helper'
 
-describe Spotlight::SolrDocumentSidecar, :type => :model do
+describe Spotlight::SolrDocumentSidecar, type: :model do
   let(:exhibit) { FactoryGirl.create(:exhibit) }
   before do
     allow(subject).to receive_messages exhibit: exhibit
     allow(subject).to receive_messages document: SolrDocument.new(id: 'doc_id')
   end
 
-  describe "#to_solr" do
+  describe '#to_solr' do
     before do
-      subject.data = {'a_tesim' => 1, 'b_tesim' => 2, 'c_tesim' => 3 }
+      subject.data = { 'a_tesim' => 1, 'b_tesim' => 2, 'c_tesim' => 3 }
     end
 
     its(:to_solr) { should include id: 'doc_id' }
     its(:to_solr) { should include "exhibit_#{exhibit.id}_public_bsi".to_sym => true }
     its(:to_solr) { should include 'a_tesim', 'b_tesim', 'c_tesim' }
   end
-
 end

data/spec/routing/spotlight/exhibit_catalog_spec.rb

@@ -1,12 +1,12 @@
-require "spec_helper"
+require 'spec_helper'
 
 module Spotlight
-  describe "Catalog controller", :type => :routing do
-    describe "routing" do
+  describe 'Catalog controller', type: :routing do
+    describe 'routing' do
       routes { Spotlight::Engine.routes }
 
-      it "routes to #edit" do
-        expect(get("/1/catalog/dq287tq6352/edit")).to route_to("spotlight/catalog#edit", exhibit_id: '1', id: 'dq287tq6352')
+      it 'routes to #edit' do
+        expect(get('/1/catalog/dq287tq6352/edit')).to route_to('spotlight/catalog#edit', exhibit_id: '1', id: 'dq287tq6352')
       end
     end
   end

data/spec/routing/spotlight/pages_routing_spec.rb

@@ -1,45 +1,44 @@
-require "spec_helper"
+require 'spec_helper'
 
 module Spotlight
-  describe "FeaturePagesController and AboutPagesController", :type => :routing do
-    describe "routing" do
+  describe 'FeaturePagesController and AboutPagesController', type: :routing do
+    describe 'routing' do
       routes { Spotlight::Engine.routes }
 
-      it "routes to #index" do
-        expect(get("/1/feature")).to route_to("spotlight/feature_pages#index", exhibit_id: '1')
-        expect(get("/1/about")).to   route_to("spotlight/about_pages#index",   exhibit_id: '1')
+      it 'routes to #index' do
+        expect(get('/1/feature')).to route_to('spotlight/feature_pages#index', exhibit_id: '1')
+        expect(get('/1/about')).to route_to('spotlight/about_pages#index', exhibit_id: '1')
       end
 
-      it "routes to #new" do
-        expect(get("/1/feature/new")).to route_to("spotlight/feature_pages#new", exhibit_id: '1')
-        expect(get("/1/about/new")).to   route_to("spotlight/about_pages#new",   exhibit_id: '1')
+      it 'routes to #new' do
+        expect(get('/1/feature/new')).to route_to('spotlight/feature_pages#new', exhibit_id: '1')
+        expect(get('/1/about/new')).to route_to('spotlight/about_pages#new', exhibit_id: '1')
       end
 
-      it "routes to #show" do
-        expect(get("/1/feature/2")).to route_to("spotlight/feature_pages#show", id: "2", exhibit_id: "1")
-        expect(get("/1/about/2")).to   route_to("spotlight/about_pages#show",   id: "2", exhibit_id: "1")
+      it 'routes to #show' do
+        expect(get('/1/feature/2')).to route_to('spotlight/feature_pages#show', id: '2', exhibit_id: '1')
+        expect(get('/1/about/2')).to route_to('spotlight/about_pages#show', id: '2', exhibit_id: '1')
       end
 
-      it "routes to #edit" do
-        expect(get("/1/feature/2/edit")).to route_to("spotlight/feature_pages#edit", id: "2", exhibit_id: "1")
-        expect(get("/1/about/2/edit")).to   route_to("spotlight/about_pages#edit",   id: "2", exhibit_id: "1")
+      it 'routes to #edit' do
+        expect(get('/1/feature/2/edit')).to route_to('spotlight/feature_pages#edit', id: '2', exhibit_id: '1')
+        expect(get('/1/about/2/edit')).to route_to('spotlight/about_pages#edit', id: '2', exhibit_id: '1')
       end
 
-      it "routes to #create" do
-        expect(post("/1/feature")).to route_to("spotlight/feature_pages#create", exhibit_id: '1')
-        expect(post("/1/about")).to   route_to("spotlight/about_pages#create",   exhibit_id: '1')
+      it 'routes to #create' do
+        expect(post('/1/feature')).to route_to('spotlight/feature_pages#create', exhibit_id: '1')
+        expect(post('/1/about')).to route_to('spotlight/about_pages#create', exhibit_id: '1')
       end
 
-      it "routes to #update" do
-        expect(put("/1/feature/2")).to route_to("spotlight/feature_pages#update", id: "2", exhibit_id: "1")
-        expect(put("/1/about/2")).to   route_to("spotlight/about_pages#update",   id: "2", exhibit_id: "1")
+      it 'routes to #update' do
+        expect(put('/1/feature/2')).to route_to('spotlight/feature_pages#update', id: '2', exhibit_id: '1')
+        expect(put('/1/about/2')).to route_to('spotlight/about_pages#update', id: '2', exhibit_id: '1')
       end
 
-      it "routes to #destroy" do
-        expect(delete("/1/feature/2")).to route_to("spotlight/feature_pages#destroy", id: "2", exhibit_id: "1")
-        expect(delete("/1/about/2")).to   route_to("spotlight/about_pages#destroy",   id: "2", exhibit_id: "1")
+      it 'routes to #destroy' do
+        expect(delete('/1/feature/2')).to route_to('spotlight/feature_pages#destroy', id: '2', exhibit_id: '1')
+        expect(delete('/1/about/2')).to route_to('spotlight/about_pages#destroy', id: '2', exhibit_id: '1')
       end
-
     end
   end
 end

data/spec/serializers/spotlight/exhibit_export_serializer_spec.rb

@@ -3,100 +3,106 @@ require 'spec_helper'
 describe Spotlight::ExhibitExportSerializer do
   let!(:source_exhibit) { FactoryGirl.create(:exhibit) }
 
-  subject { JSON.parse(Spotlight::ExhibitExportSerializer.new(source_exhibit).to_json) }
+  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
+
+  subject { JSON.parse(described_class.new(source_exhibit).to_json) }
 
-  it "should not include unique identifiers" do
+  it 'does not include unique identifiers' do
     expect(subject).to_not have_key 'id'
     expect(subject).to_not have_key 'slug'
     expect(subject).to_not have_key 'name'
     expect(subject).to_not have_key 'default'
   end
 
-  it "should have search attributes" do
-    expect(subject["searches"]).to have(source_exhibit.searches.count).searches
+  it 'has search attributes' do
+    expect(subject['searches']).to have(source_exhibit.searches.count).searches
   end
 
-  it "should have home page attributes" do
-    expect(subject).to have_key "home_page"
+  it 'has home page attributes' do
+    expect(subject).to have_key 'home_page'
     expect(subject['home_page']).to_not have_key 'id'
     expect(subject['home_page']).to_not have_key 'scope'
     expect(subject['home_page']).to_not have_key 'exhibit_id'
   end
 
-  it "should have about pages" do
-    expect(subject["about_pages"]).to have(source_exhibit.about_pages.count).pages
+  it 'has about pages' do
+    expect(subject['about_pages']).to have(source_exhibit.about_pages.count).pages
   end
 
-  it "should have feature pages" do
-    expect(subject["feature_pages"]).to have(source_exhibit.feature_pages.at_top_level.count).pages
+  it 'has feature pages' do
+    expect(subject['feature_pages']).to have(source_exhibit.feature_pages.at_top_level.count).pages
   end
 
-  it "should have custom fields" do
-    expect(subject["custom_fields"]).to have(source_exhibit.custom_fields.count).items
+  it 'has custom fields' do
+    expect(subject['custom_fields']).to have(source_exhibit.custom_fields.count).items
   end
 
-  it "should have contacts" do
-    expect(subject["contacts"]).to have(source_exhibit.contacts.count).items
+  it 'has contacts' do
+    expect(subject['contacts']).to have(source_exhibit.contacts.count).items
   end
 
-  it "should have contact emails" do
-    expect(subject["contact_emails"]).to have(source_exhibit.contact_emails.count).items
+  it 'has contact emails' do
+    expect(subject['contact_emails']).to have(source_exhibit.contact_emails.count).items
   end
 
-  it "should have blacklight configuration attributes" do
-    expect(subject).to have_key "blacklight_configuration"
+  it 'has blacklight configuration attributes' do
+    expect(subject).to have_key 'blacklight_configuration'
   end
 
-  it "should have solr document sidecars" do
+  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).to_not include 'id'
+    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).to_not include 'id'
   end
 
-  it "should have attachments" do
-    expect(subject["attachments"]).to have(source_exhibit.attachments.count).items
+  it 'has attachments' do
+    expect(subject['attachments']).to have(source_exhibit.attachments.count).items
   end
 
-  it "should have resources" do
-    expect(subject["resources"]).to have(source_exhibit.resources.count).items
+  it 'has resources' do
+    expect(subject['resources']).to have(source_exhibit.resources.count).items
   end
 
-  it "should have tags" do
-    source_exhibit.tag(SolrDocument.new(id: 1), with: "xyz", on: :tags)
-    expect(subject["owned_taggings"]).to have(source_exhibit.owned_taggings.count).items
+  it 'has tags' do
+    source_exhibit.tag(SolrDocument.new(id: 1), with: 'xyz', on: :tags)
+    expect(subject['owned_taggings']).to have(source_exhibit.owned_taggings.count).items
   end
 
-  describe "should round-trip data" do
+  describe 'should round-trip data' do
     before do
       source_exhibit.solr_document_sidecars.create! document: SolrDocument.new(id: 1), public: false
-      source_exhibit.tag(SolrDocument.new(id: 1), with: "xyz", on: :tags)
+      source_exhibit.tag(SolrDocument.new(id: 1), with: 'xyz', on: :tags)
     end
 
     let :export do
-      Spotlight::ExhibitExportSerializer.new(source_exhibit).as_json
+      described_class.new(source_exhibit).as_json
     end
 
     subject do
       e = FactoryGirl.create(:exhibit)
-      e.import(export).tap { |e| e.save }
+      e.import(export).tap(&:save)
     end
 
-    it "should have exhibit properties" do
+    it 'has exhibit properties' do
       expect(subject.title).to eq source_exhibit.title
     end
 
-    it "should not duplicate saved searches" do
+    it 'does not duplicate saved searches' do
       expect(subject.searches).to have(1).item
     end
 
-    it "should have blacklight configuration properties" do
+    it 'has blacklight configuration properties' do
       expect(subject.blacklight_configuration).to be_persisted
     end
 
-    it "should have home page properties" do
+    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
 
@@ -104,88 +110,102 @@ describe Spotlight::ExhibitExportSerializer do
       expect(subject.home_page.content).to eq source_exhibit.home_page.content
     end
 
-    it "should have sidecars" do
+    it 'has sidecars' do
       expect(SolrDocument.new(id: 1).public? subject).to be_falsey
     end
 
-    it "should have tags" do
+    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"
+      expect(subject.owned_taggings.first.tag.name).to eq 'xyz'
     end
 
-    it "should deal with nested feature pages" do
+    it 'deals with nested feature pages' do
       FactoryGirl.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
 
-    it "should assign STI resources the correct class" do
+    it 'assigns STI resources the correct class' do
       resource = FactoryGirl.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.url.file.path).not_to eq resource.url.file.path
     end
 
-    it "should copy contact avatars" do
+    it 'assigns normal resources the correct class' do
+      resource = FactoryGirl.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
+
+    it 'copies contact avatars' do
       contact = FactoryGirl.create :contact, exhibit: source_exhibit
       expect(subject.contacts.length).to eq 1
       expect(subject.contacts.first.avatar.file.path).not_to eq contact.avatar.file.path
     end
   end
 
-  it "should be idempotent-ish" do
+  it 'is idempotent-ish' do
     FactoryGirl.create :feature_subpage, exhibit: source_exhibit
-    export = Spotlight::ExhibitExportSerializer.new(source_exhibit).as_json
+    export = described_class.new(source_exhibit).as_json
     e = FactoryGirl.create(:exhibit)
-    e.import(export).tap { |e| e.save }
-    e.import(export).tap { |e| e.save }
+    e.import(export).tap(&:save)
+    e.import(export).tap(&:save)
   end
 
-  describe "should export saved searches with query parameters that can be re-generated" do
+  describe 'should export saved searches with query parameters that can be re-generated' do
     before do
-      source_exhibit.feature_pages.create content: [{:type=>"search_results", :data=>{"item"=> { search.slug => { id: search.slug, display: "true"}}, view: ["list"]}}].to_json
+      source_exhibit.feature_pages.create content: [{
+        type: 'search_results',
+        data: {
+          'item' => {
+            search.slug => { id: search.slug, display: 'true' }
+          },
+          view: ['list']
+        }
+      }].to_json
     end
 
     subject do
       e = FactoryGirl.create(:exhibit)
-      e.import(export).tap { |e| e.save }
+      e.import(export).tap(&:save)
     end
 
     let :export do
-      Spotlight::ExhibitExportSerializer.new(source_exhibit).as_json
+      described_class.new(source_exhibit).as_json
     end
 
-    context "with a search object with matching query params" do  
+    context 'with a search object with matching query params' do
       let :search do
         source_exhibit.searches.first
       end
 
-      it "should use a search within the exhibit" do
+      it 'uses a search within the exhibit' do
         # searches need to be published.
-        subject.searches.each { |x| x.on_landing_page = true; x.save }
+        subject.searches.each { |x| x.update published: true }
 
         expect(subject.feature_pages.first.content.first.search.exhibit).to eq subject
       end
 
-      it "should use the existing search object with the same query params" do
+      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', on_landing_page: true
-       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
 
-       it "should create a search within the exhibit" do
-         expect(subject.feature_pages.first.content.first.search.exhibit).to eq subject
-       end
+      it 'creates a search within the exhibit' do
+        expect(subject.feature_pages.first.content.first.search.exhibit).to eq subject
+      end
 
-       it "should use the existing search object with the same query params" do
-         expect(subject.searches).to have(2).items
-       end
+      it 'uses the existing search object with the same query params' do
+        expect(subject.searches).to have(2).items
+      end
     end
   end
-
 end