blacklight-spotlight 0.4.1 → 0.5.0

data/spec/models/spotlight/resource_spec.rb

@@ -1,66 +1,96 @@
 require 'spec_helper'
 
-describe Spotlight::Resource, :type => :model do
+describe Spotlight::Resource, type: :model do
   before do
-    allow_any_instance_of(Spotlight::Resource).to receive(:update_index)
+    allow_any_instance_of(described_class).to receive(:update_index)
   end
-  let(:exhibit) { double(solr_data: { }) }
-  
-  describe ".class_for_resource" do
+  let(:exhibit) { FactoryGirl.create(:exhibit) }
+
+  describe '.class_for_resource' do
     let(:thing) { double }
-    let(:type_a) { double("TypeA", weight: 10) }
-    let(:type_b) { double("TypeB", weight: 5) }
+    let(:type_a) { double('TypeA', weight: 10) }
+    let(:type_b) { double('TypeB', weight: 5) }
     let(:providers) { [type_a, type_b] }
-    subject { Spotlight::Resource.class_for_resource(thing) }
+    subject { described_class.class_for_resource(thing) }
 
     before do
-      allow(Spotlight::Resource).to receive_messages(providers: providers)
+      allow(described_class).to receive_messages(providers: providers)
     end
 
-    it "should return a class that can provide indexing for the resource" do
+    it 'returns a class that can provide indexing for the resource' do
       expect(type_a).to receive(:can_provide?).with(thing).and_return(true)
       expect(type_b).to receive(:can_provide?).with(thing).and_return(false)
       expect(subject).to eq type_a
     end
 
-    it "should return the lowest weighted class that can provide indexing for the resource" do
+    it 'returns the lowest weighted class that can provide indexing for the resource' do
       expect(type_a).to receive(:can_provide?).with(thing).and_return(true)
       expect(type_b).to receive(:can_provide?).with(thing).and_return(true)
       expect(subject).to eq type_b
     end
   end
 
-  describe "#to_solr" do
+  describe '#to_solr' do
     before do
       allow(subject).to receive(:exhibit).and_return(exhibit)
-      allow(subject).to receive_messages(type: "Spotlight::Resource::Something", id: 15)
+      allow(subject).to receive_messages(type: 'Spotlight::Resource::Something', id: 15, persisted?: true)
     end
-    it "should include a reference to the resource" do
+    it 'includes a reference to the resource' do
       expect(subject.to_solr).to include spotlight_resource_id_ssim: subject.to_global_id.to_s
     end
 
-    it "should include exhibit-specific data" do
+    it 'includes exhibit-specific data' do
       allow(exhibit).to receive(:solr_data).and_return(exhibit_data: true)
       expect(subject.to_solr).to include exhibit_data: true
     end
   end
 
-  describe "#becomes_provider" do
-    it "should convert the resource to a provider-specific resource" do
-      SomeClass = Class.new(Spotlight::Resource)
-      allow(Spotlight::Resource).to receive_messages(class_for_resource: SomeClass)
+  describe '#reindex' do
+    context 'with a provider that generates ids' do
+      subject do
+        Class.new(described_class) do
+          def to_solr
+            super.merge(id: 123)
+          end
+        end.new(exhibit: exhibit)
+      end
+
+      before do
+        SolrDocument.new(id: 123).sidecars.create!(exhibit: exhibit, data: { document_data: true })
+        allow(subject).to receive_messages(to_global_id: '', update_index_time!: nil)
+      end
+
+      it 'includes exhibit document-specific data' do
+        expect(subject.send(:blacklight_solr)).to receive(:update) do |options|
+          data = JSON.parse(options[:data], symbolize_names: true)
+
+          expect(data.length).to eq 1
+          doc = data.first
+
+          expect(doc).to include document_data: true
+        end
+
+        subject.reindex
+      end
+    end
+  end
+
+  describe '#becomes_provider' do
+    it 'converts the resource to a provider-specific resource' do
+      SomeClass = Class.new(described_class)
+      allow(described_class).to receive_messages(class_for_resource: SomeClass)
       expect(subject.becomes_provider).to be_a_kind_of(SomeClass)
-      expect(subject.becomes_provider.type).to eq "SomeClass"
+      expect(subject.becomes_provider.type).to eq 'SomeClass'
     end
   end
 
-  it "should reindex after save" do
+  it 'reindexs after save' do
     expect(subject).to receive(:reindex)
     subject.data_will_change!
     subject.save!
   end
 
-  it "should store arbitrary data" do
+  it 'stores arbitrary data' do
     subject.data[:a] = 1
     subject.data[:b] = 2
 
@@ -68,15 +98,15 @@ describe Spotlight::Resource, :type => :model do
     expect(subject.data[:b]).to eq 2
   end
 
-  describe "#update_index_time!" do
-    it "should update the index_time column" do
+  describe '#update_index_time!' do
+    it 'updates the index_time column' do
       expect(subject).to receive(:update_columns).with(hash_including(:indexed_at))
       subject.update_index_time!
     end
   end
 
-  describe "#save_and_commit" do
-    it "should save the object and commit to solr" do
+  describe '#save_and_commit' do
+    it 'saves the object and commit to solr' do
       expect(subject).to receive(:save)
       expect(subject.send(:blacklight_solr)).to receive(:commit)
       subject.save_and_commit

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

@@ -1,43 +1,41 @@
 require 'spec_helper'
 
-describe Spotlight::Resources::OpenGraph, :type => :model do
+describe Spotlight::Resources::OpenGraph, type: :model do
   class TestResource < Spotlight::Resource
     include Spotlight::Resources::Web
     include Spotlight::Resources::OpenGraph
   end
-  
-  let(:exhibit) { double(solr_data: { }) }
 
-  subject { TestResource.new url: "info:url" }
+  let(:exhibit) { double(solr_data: {}) }
 
-  describe "#to_solr" do
+  subject { TestResource.new url: 'info:url' }
 
+  describe '#to_solr' do
     before do
-      allow(subject).to receive_messages id: 15, opengraph_properties: {}, exhibit: exhibit
+      allow(subject).to receive_messages id: 15, opengraph_properties: {}, exhibit: exhibit, persisted?: true
     end
 
     let(:solr_doc) { subject.to_solr }
 
-    it "should include this record id" do
+    it 'includes this record id' do
       expect(solr_doc).to include spotlight_resource_id_ssim: subject.to_global_id.to_s
     end
 
-    it "should include opengraph properties" do
-      allow(subject).to receive_messages opengraph_properties: { a: 1, b: 2}
+    it 'includes opengraph properties' do
+      allow(subject).to receive_messages opengraph_properties: { a: 1, b: 2 }
 
       expect(solr_doc).to include a: 1, b: 2
     end
-
   end
 
-  describe "#opengraph_properties" do
-    it "should map opengraph properties to solr fields" do
-      allow(subject).to receive_messages opengraph: { "og_title" => "title", "og_description" => "description"}
-      expect(subject.opengraph_properties).to include "og_title_tesim" => "title", "og_description_tesim" => "description"
+  describe '#opengraph_properties' do
+    it 'maps opengraph properties to solr fields' do
+      allow(subject).to receive_messages opengraph: { 'og_title' => 'title', 'og_description' => 'description' }
+      expect(subject.opengraph_properties).to include 'og_title_tesim' => 'title', 'og_description_tesim' => 'description'
     end
   end
 
-  describe "#opengraph" do
+  describe '#opengraph' do
     let(:body) do
       Nokogiri::HTML.parse <<-EOF
         <html><head>
@@ -51,10 +49,10 @@ describe Spotlight::Resources::OpenGraph, :type => :model do
         </head></html>
       EOF
     end
-    it "should extract opengraph <meta> tags" do
+    it 'extracts opengraph <meta> tags' do
       allow(subject).to receive_messages(body: body)
-      expect(subject.opengraph).to include "og:title", "og:description", "og:type", "og:type", "og:site_name", "og:video", "og:video:width", "og:video:height"
-      expect(subject.opengraph["og:title"]).to eq "The Ground Truth: The Human Cost of War"
+      expect(subject.opengraph).to include 'og:title', 'og:description', 'og:type', 'og:type', 'og:site_name', 'og:video', 'og:video:width', 'og:video:height'
+      expect(subject.opengraph['og:title']).to eq 'The Ground Truth: The Human Cost of War'
     end
   end
 end

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

@@ -1,60 +1,58 @@
 require 'spec_helper'
 
-describe Spotlight::Resources::Upload, :type => :model do
+describe Spotlight::Resources::Upload, type: :model do
   let!(:exhibit) { FactoryGirl.create :exhibit }
   let!(:custom_field) { FactoryGirl.create :custom_field, exhibit: exhibit }
   before do
     subject.exhibit = exhibit
   end
 
-  let(:configured_fields) { [title_field] + Spotlight::Resources::Upload.fields(exhibit) }
-  let(:title_field) { OpenStruct.new(field_name: "configured_title_field") }
+  let(:configured_fields) { [title_field] + described_class.fields(exhibit) }
+  let(:title_field) { OpenStruct.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"
+      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
 
   before do
-
     allow(subject).to receive(:configured_fields).and_return configured_fields
     allow(described_class).to receive(:fields).and_return configured_fields
 
-    allow(subject.send(:blacklight_solr)).to receive(:update) 
+    allow(subject.send(:blacklight_solr)).to receive(:update)
     allow(Spotlight::Engine.config).to receive(:upload_title_field).and_return(title_field)
     subject.data = upload_data
     subject.url = File.open(File.join(FIXTURES_PATH, '800x600.png'))
     subject.save
   end
-  
-  context "with a custom upload title field" do
-    let(:title_field) { OpenStruct.new(field_name: "configured_title_field", solr_field: :some_other_field) }
 
-    describe "#to_solr" do
-      it "should store the title field in the provided solr field" do
-        expect(subject.to_solr[:some_other_field]).to eq "Title Data"
+  context 'with a custom upload title field' do
+    let(:title_field) { OpenStruct.new(field_name: 'configured_title_field', solr_field: :some_other_field) }
+
+    describe '#to_solr' do
+      it 'stores the title field in the provided solr field' do
+        expect(subject.to_solr[:some_other_field]).to eq 'Title Data'
       end
     end
   end
-  
-  context "multiple solr field mappings" do
 
+  context 'multiple solr field mappings' do
     let :configured_fields do
       [
-        OpenStruct.new(field_name: 'some_field', solr_field: ['a', 'b'])
+        OpenStruct.new(field_name: 'some_field', solr_field: %w(a b))
       ]
     end
 
     let :upload_data do
-      { 'some_field' => 'value'}
+      { 'some_field' => 'value' }
     end
 
-    describe "#to_solr" do
-      it "should map a single uploaded field to multiple solr fields" do
+    describe '#to_solr' do
+      it 'maps a single uploaded field to multiple solr fields' do
         expect(subject.to_solr['a']).to eq 'value'
         expect(subject.to_solr['b']).to eq 'value'
       end
@@ -62,35 +60,34 @@ describe Spotlight::Resources::Upload, :type => :model do
   end
 
   describe '#to_solr' do
-
-    it 'should have the exhibit id and the upload id as the solr id' do
+    it 'has the exhibit id and the upload id as the solr id' do
       expect(subject.to_solr[:id]).to eq "#{subject.exhibit.id}-#{subject.id}"
     end
 
-    it 'should have a title field using the exhibit specific blacklight_config' do
-      expect(subject.to_solr["configured_title_field"]).to eq 'Title Data'
+    it 'has a title field using the exhibit specific blacklight_config' do
+      expect(subject.to_solr['configured_title_field']).to eq 'Title Data'
     end
 
-    it 'should have the other additional configured fields' do
-      expect(subject.to_solr[:spotlight_upload_description_tesim]).to eq "Description Data"
-      expect(subject.to_solr[:spotlight_upload_attribution_tesim]).to eq "Attribution Data"
-      expect(subject.to_solr[:spotlight_upload_date_tesim]).to eq "Date Data"
+    it 'has the other additional configured fields' do
+      expect(subject.to_solr[:spotlight_upload_description_tesim]).to eq 'Description Data'
+      expect(subject.to_solr[:spotlight_upload_attribution_tesim]).to eq 'Attribution Data'
+      expect(subject.to_solr[:spotlight_upload_date_tesim]).to eq 'Date Data'
     end
 
-    it 'should have a spotlight_resource_type field' do
+    it 'has a spotlight_resource_type field' do
       expect(subject.to_solr[:spotlight_resource_type_ssim]).to eq 'spotlight/resources/uploads'
     end
-    it 'should have the various image fields' do
+    it 'has the various image fields' do
       expect(subject.to_solr).to have_key Spotlight::Engine.config.full_image_field
       expect(subject.to_solr).to have_key Spotlight::Engine.config.thumbnail_field
       expect(subject.to_solr).to have_key Spotlight::Engine.config.square_image_field
     end
-    it 'should have the full image dimensions fields' do
+    it 'has the full image dimensions fields' do
       expect(subject.to_solr[:spotlight_full_image_height_ssm]).to eq 600
       expect(subject.to_solr[:spotlight_full_image_width_ssm]).to eq 800
     end
-    it 'should have fields representing exhibit specific custom fields' do
-      expect(subject.to_solr[custom_field.field]).to eq "Custom Field Data"
+    it 'has fields representing exhibit specific custom fields' do
+      expect(subject.to_solr[custom_field.field]).to eq 'Custom Field Data'
     end
   end
 end

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

@@ -1,28 +1,26 @@
 require 'spec_helper'
 
-describe Spotlight::Resources::Web, :type => :model do
-
+describe Spotlight::Resources::Web, type: :model do
   class TestResource < Spotlight::Resource
     include Spotlight::Resources::Web
   end
 
   subject { TestResource.new }
-  describe ".fetch" do
-
+  describe '.fetch' do
   end
 
-  describe "#harvest!" do
-    it "should cache the body and headers in the data" do
-      allow(Spotlight::Resources::Web).to receive_messages(fetch: double(body: "xyz", headers: {a: 1}))
+  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[:body]).to eq 'xyz'
       expect(subject.data[:headers]).to eq a: 1
     end
   end
 
-  describe "#body" do
-    it "should return the body DOM" do
-      allow(Spotlight::Resources::Web).to receive_messages(fetch: double(body: "<html />", headers: {a: 1}))
+  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

data/spec/models/spotlight/role_spec.rb

@@ -1,37 +1,37 @@
 require 'spec_helper'
 
-describe Spotlight::Role, :type => :model do
-  describe "validations" do
-    subject { Spotlight::Role.new(args) }
-    describe "with nothing" do
-      let(:args) { {user_key: ''} }
-      it "should not be valid" do
+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).to eq({:role=>["is not included in the list"], :user_key=>["can't be blank"]})
+        expect(subject.errors.messages).to eq(role: ['is not included in the list'], user_key: ["can't be blank"])
       end
     end
-    describe "with user_key" do
-      let (:user) { FactoryGirl.create(:user)}
+    describe 'with user_key' do
+      let(:user) { FactoryGirl.create(:user) }
       describe "that doesn't point at a user" do
-        let(:args) { {role: 'curator', user_key: 'bob'} }
-        it "should not be valid" do
+        let(:args) { { role: 'curator', user_key: 'bob' } }
+        it 'does not be valid' do
           expect(subject).not_to be_valid
-          expect(subject.errors.messages).to eq({:user_key=>["User must sign up first."]})
+          expect(subject.errors.messages).to eq(user_key: ['User must sign up first.'])
         end
       end
-      describe "that points at a user" do
-        let(:args) { {role: 'curator', user_key: user.email} }
-        it "should be valid" do
+      describe 'that points at a user' do
+        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
-        before { Spotlight::Role.create!(role: 'curator', user: user) }
-        let(:args) { {role: 'curator', user_key: user.email} }
-        it "should be valid" do
+      describe 'that points at a user with an existing role' do
+        before { described_class.create!(role: 'curator', user: user) }
+        let(:args) { { role: 'curator', user_key: user.email } }
+        it 'is valid' do
           expect(subject).not_to be_valid
-          expect(subject.errors.messages).to eq({:user_key => ["already a member of this exhibit"]})
+          expect(subject.errors.messages).to eq(user_key: ['already a member of this exhibit'])
         end
       end
     end

data/spec/models/spotlight/search_spec.rb

@@ -1,35 +1,52 @@
 require 'spec_helper'
 
-describe Spotlight::Search, :type => :model do
-  let(:query_params) { {"f"=>{"genre_sim"=>["map"]}} }
-  subject { FactoryGirl.build(:search, query_params: query_params )}
+describe Spotlight::Search, type: :model do
+  let(:query_params) { { 'f' => { 'genre_sim' => ['map'] } } }
+  subject { FactoryGirl.create(:exhibit).searches.build(title: 'Search', query_params: query_params) }
 
   let(:blacklight_config) { ::CatalogController.blacklight_config }
+  let(:document) do
+    SolrDocument.new(id: 'dq287tq6352',
+                     blacklight_config.index.title_field => 'title',
+                     Spotlight::Engine.config.full_image_field => 'https://stacks.stanford.edu/image/iiif/dq287tq6352%2Fdq287tq6352_05_0001/full/!400,400/0/default.jpg')
+  end
+  let(:document_without_an_image) do
+    SolrDocument.new(id: 'ab123fd9876',
+                     blacklight_config.index.title_field => 'title')
+  end
 
   it { is_expected.to be_a Spotlight::Catalog::AccessControlsEnforcement }
 
-  it "should have a default feature image" do
-    allow(subject).to receive_messages(documents: [SolrDocument.new(id: 'dq287tq6352', blacklight_config.index.title_field => 'title', Spotlight::Engine.config.full_image_field => "https://stacks.stanford.edu/image/dq287tq6352/dq287tq6352_05_0001_thumb")])
+  it 'has a default feature image' do
+    allow(subject).to receive_messages(documents: [document])
+    subject.save!
+    expect(subject.thumbnail).not_to be_nil
+    expect(subject.thumbnail.image.path).to end_with 'default.jpg'
+  end
+
+  it 'uses a document with an image for the default feature image' do
+    allow(subject).to receive_messages(documents: [document_without_an_image, document])
     subject.save!
     expect(subject.thumbnail).not_to be_nil
-    expect(subject.thumbnail.image.path).to end_with "dq287tq6352_05_0001_thumb.jpeg"
+    expect(subject.thumbnail.image.path).to end_with 'default.jpg'
   end
 
-  it "should have items" do
+  it 'has items' do
     expect(subject.count).to eq 55
   end
 
-  it "should have images" do
+  it 'has images' do
     expect(subject.images.size).to eq(55)
-    expect(subject.images.map(&:last)).to include "https://stacks.stanford.edu/image/dq287tq6352/dq287tq6352_05_0001_thumb", "https://stacks.stanford.edu/image/jp266yb7109/jp266yb7109_05_0001_thumb"
+    expect(subject.images.map(&:last)).to include 'https://stacks.stanford.edu/image/dq287tq6352/dq287tq6352_05_0001_thumb',
+                                                  'https://stacks.stanford.edu/image/jp266yb7109/jp266yb7109_05_0001_thumb'
   end
 
-  describe "default_scope" do
-    let!(:page1) { FactoryGirl.create(:search, weight: 5, on_landing_page: true) }
-    let!(:page2) { FactoryGirl.create(:search, weight: 1, on_landing_page: true) }
-    let!(:page3) { FactoryGirl.create(:search, weight: 10, on_landing_page: true) }
-    it "should order by weight" do
-      expect(Spotlight::Search.published.map(&:weight)).to eq [1, 5, 10]
+  describe 'default_scope' do
+    let!(:page1) { FactoryGirl.create(:search, weight: 5, published: true) }
+    let!(:page2) { FactoryGirl.create(:search, weight: 1, published: true) }
+    let!(:page3) { FactoryGirl.create(:search, weight: 10, published: true) }
+    it 'orders by weight' do
+      expect(described_class.published.map(&:weight)).to eq [1, 5, 10]
     end
   end
 end