blacklight-spotlight 0.2.0 → 0.3.0

data/spec/jobs/spotlight/reindex_job_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Spotlight::ReindexJob do
+  let(:exhibit) { FactoryGirl.create(:exhibit) }
+  let(:resource) { FactoryGirl.create(:resource) }
+
+  before do
+    allow_any_instance_of(Spotlight::Resource).to receive(:reindex)
+  end
+
+  context "with an exhibit" do
+    subject { described_class.new(exhibit) }
+
+    before do
+      exhibit.resources << resource
+      exhibit.save
+    end
+    it "should attempt to reindex every resource in the exhibit" do
+      # ActiveJob will reload the collection, so we go through a little trouble:
+      expect_any_instance_of(Spotlight::Resource).to receive(:reindex) do |thingy|
+        expect(exhibit.resources).to include thingy
+      end
+
+      subject.perform_now
+    end
+  end
+
+  context "with a resource" do
+    subject { described_class.new(resource) }
+    
+    it "should attempt to reindex every resource in the exhibit" do
+      expect(resource).to receive(:reindex)
+      subject.perform_now
+    end
+  end
+end

data/spec/lib/spotlight/catalog/access_controls_enforcement_spec.rb

@@ -4,13 +4,18 @@ describe Spotlight::Catalog::AccessControlsEnforcement do
   class MockCatalogController
     include Blacklight::SolrHelper
     include Spotlight::Catalog::AccessControlsEnforcement
+
+    def blacklight_config
+      @blacklight_config ||= Blacklight::Configuration.new
+    end
   end
 
   subject { MockCatalogController.new }
   let(:solr_request) { Blacklight::Solr::Request.new }
+  let(:exhibit) { FactoryGirl.create(:exhibit) }
 
   before do
-    allow(subject).to receive_messages(current_exhibit: FactoryGirl.create(:exhibit))
+    allow(subject).to receive_messages(current_exhibit: exhibit)
   end
 
   describe "#apply_permissive_visibility_filter" do
@@ -31,5 +36,25 @@ describe Spotlight::Catalog::AccessControlsEnforcement do
       expect(solr_request).to include :fq
       expect(solr_request[:fq]).to include "-exhibit_1_public_bsi:false"
     end
+    
+    it "should not filter resources to just those created by the exhibit" do
+      allow(subject).to receive(:can?).and_return(true)
+      subject.send(:apply_permissive_visibility_filter, solr_request, {})
+      expect(solr_request).to include :fq
+      expect(solr_request[:fq]).not_to include "spotlight_exhibit_slug_#{exhibit.slug}_bsi:true"
+    end
+
+    context "with filter_resources_by_exhibit" do
+      before do
+        allow(Spotlight::Engine.config).to receive(:filter_resources_by_exhibit).and_return(true)
+      end
+
+      it "should filter resources to just those created by the exhibit" do
+        allow(subject).to receive(:can?).and_return(true)
+        subject.send(:apply_permissive_visibility_filter, solr_request, {})
+        expect(solr_request).to include :fq
+        expect(solr_request[:fq]).to include "spotlight_exhibit_slug_#{exhibit.slug}_bsi:true"
+      end
+    end
   end
 end

data/spec/mailers/spotlight/indexing_complete_mailer_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Spotlight::IndexingCompleteMailer do
+  let(:user) { double(email: "test@example.com") }
+  let(:exhibit) { double(title: "Exhibit title") }
+  subject { Spotlight::IndexingCompleteMailer.documents_indexed [1,2,3], exhibit, user}
+  
+  it 'renders the receiver email' do
+    expect(subject.to).to eql([user.email])
+  end
+
+  it "includes a title" do
+    expect(subject.body.encoded).to match "Your CSV file has just finished being processed"
+  end
+  
+  it 'describes how many documents were indexed' do
+    expect(subject.body.encoded).to match "3 documents"
+  end
+
+  context "single item" do
+    subject { Spotlight::IndexingCompleteMailer.documents_indexed [1], exhibit, user}
+
+    it 'handles pluralization when only a single item was indexed' do
+      expect(subject.body.encoded).to match "1 document has"
+    end
+  end
+  
+  it 'includes the exhibit title' do
+    expect(subject.body.encoded).to match exhibit.title
+  end
+end

data/spec/models/solr_document_spec.rb

@@ -30,6 +30,18 @@ describe SolrDocument, :type => :model do
     expect(::SolrDocument.find('dq287tq6352')).to eq ::SolrDocument.find('dq287tq6352')
   end
 
+  describe 'GlobalID' do
+    let(:doc_id) { 'dq287tq6352' }
+    it 'should respond to #to_global_id' do
+      expect(::SolrDocument.find(doc_id).to_global_id.to_s).to eq "gid://internal/SolrDocument/#{doc_id}"
+    end
+    it 'should be able to locate SolrDocuments by their GlobalID' do
+      expect(GlobalID::Locator.locate(
+        ::SolrDocument.find(doc_id).to_global_id
+      )['id']).to eq doc_id
+    end
+  end
+
   describe "#sidecar" do
     it "should return a sidecar for adding exhibit-specific fields" do
       expect(subject.sidecar(exhibit)).to be_kind_of Spotlight::SolrDocumentSidecar
@@ -57,7 +69,7 @@ describe SolrDocument, :type => :model do
 
   describe "#to_solr" do
     before do
-      Spotlight::SolrDocumentSidecar.create! solr_document: subject, exhibit: exhibit,
+      Spotlight::SolrDocumentSidecar.create! document: subject, exhibit: exhibit,
         data: {'a_tesim' => 1, 'b_tesim' => 2, 'c_tesim' => 3 }
     end
 
@@ -122,7 +134,7 @@ describe SolrDocument, :type => :model do
     let(:uploaded_resource) {
       SolrDocument.new(
         Spotlight::Engine.config.full_image_field => "ImageData",
-        spotlight_resource_type_ssm: "spotlight/resources/uploads"
+        spotlight_resource_type_ssim: "spotlight/resources/uploads"
       )
     }
     it 'should not include Spotlight::SolrDocument::UploadedResource when the correct fields are present' do

data/spec/models/spotlight/analytics/ga_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Spotlight::Analytics::Ga do
+  it "should not be enabled without configuration" do
+    expect(described_class.enabled?).to be_falsey
+  end
+end

data/spec/models/spotlight/appearance_spec.rb

@@ -4,14 +4,6 @@ describe Spotlight::Appearance, :type => :model do
   let(:config) { FactoryGirl.create(:exhibit).blacklight_configuration }
   subject { Spotlight::Appearance.new config }
 
-  describe '#allowed_params' do
-    it 'should include all the sort types and the settable options' do
-      [:relevance, :title, :type, :date, :source, :identifier].each do |sort|
-        expect(subject.allowed_params[sort]). to eq [:enabled, :label, :weight]
-      end
-    end
-  end
-
   describe '#searchable' do
     it 'should be delegated to the exhibit' do
       expect(config.exhibit).to receive(:searchable)
@@ -28,17 +20,14 @@ describe Spotlight::Appearance, :type => :model do
     end
   end
 
-  describe "#sort_fields" do
-    subject { Spotlight::Appearance.new(config).sort_fields }
-    describe "when fields are set" do
-      before do
-        config.sort_fields = {"relevance"=> {enabled: true}, 'type' => {enabled: true}}
-      end
-      it 'should be true' do
-        expect(subject[:relevance][:enabled]).to be_truthy
-        expect(subject[:type][:enabled]).to be_truthy
-        expect(subject[:title][:enabled]).to be_falsey
-      end
+  describe "#view_type_options" do
+    subject { Spotlight::Appearance.new(config).view_type_options }
+    it "should include the available view types" do
+      expect(subject).to include :list, :gallery, :slideshow
+    end
+
+    it "should not include rss or atom" do
+      expect(subject).not_to include :rss, :atom
     end
   end
 end

data/spec/models/spotlight/blacklight_configuration_spec.rb

@@ -46,7 +46,9 @@ describe Spotlight::BlacklightConfiguration, :type => :model do
       blacklight_config.add_facet_field 'c'
 
       expect(subject.blacklight_config.facet_fields['a'].show).to be_truthy
+      expect(subject.blacklight_config.facet_fields['a'].enabled).to be_truthy
       expect(subject.blacklight_config.facet_fields['b'].show).to be_falsey
+      expect(subject.blacklight_config.facet_fields['b'].enabled).to be_falsey
       expect(subject.blacklight_config.facet_fields['d']).to be_nil
     end
 
@@ -109,10 +111,18 @@ describe Spotlight::BlacklightConfiguration, :type => :model do
       expect(subject.blacklight_config.index_fields['d']).to be_nil
     end
 
+    it "should include configured show fields, but disable them for index views" do
+      blacklight_config.add_show_field 'a'
+      expect(subject.blacklight_config.index_fields).to have_key 'a'
+      expect(subject.blacklight_config.index_fields['a'].enabled).to be_truthy
+      expect(subject.blacklight_config.index_fields['a'].show).to be_truthy
+      expect(subject.blacklight_config.index_fields['a'].list).to be_falsey
+    end
+
     context "custom fields" do
       it "should include any custom fields" do
         subject.index_fields['a'] = { enabled: true, list: true }
-        allow(subject).to receive_messages(custom_index_fields: { 'a' => double(:if= => true, merge!: true, validate!: true, normalize!: true) })
+        allow(subject).to receive_messages(custom_index_fields: { 'a' => double(if: nil, :if= => true, merge!: true, validate!: true, normalize!: true) })
         expect(subject.blacklight_config.index_fields).to include('a')
       end
 
@@ -175,7 +185,7 @@ describe Spotlight::BlacklightConfiguration, :type => :model do
     it "should include any custom fields" do
       subject.index_fields['a'] = { enabled: true, show: true }
 
-      allow(subject).to receive_messages(custom_index_fields: { 'a' => double(:if= => true, merge!: true, validate!: true, normalize!: true) })
+      allow(subject).to receive_messages(custom_index_fields: { 'a' => double(if: nil, :if= => true, merge!: true, validate!: true, normalize!: true) })
 
       expect(subject.blacklight_config.show_fields).to include('a')
     end
@@ -248,8 +258,8 @@ describe Spotlight::BlacklightConfiguration, :type => :model do
       blacklight_config.add_sort_field 'b'
       blacklight_config.add_sort_field 'c'
 
-      expect(subject.blacklight_config.sort_fields.select { |k,v| v.if == true}).to include('a', 'c')
-      expect(subject.blacklight_config.sort_fields.select { |k,v| v.if == false}).to include('b')
+      expect(subject.blacklight_config.sort_fields.select { |k,v| v.enabled == true}).to include('a', 'c')
+      expect(subject.blacklight_config.sort_fields.select { |k,v| v.enabled == true}).not_to include('b', 'd')
     end
   end
 
@@ -330,11 +340,12 @@ describe Spotlight::BlacklightConfiguration, :type => :model do
   describe "default_autocomplete_solr_params" do
     it "should include all the fields we need to render the autocomplete widget" do
       blacklight_config.show.title_field = "some_field"
-      blacklight_config.show.thumbnail_field = "some_thumbnail"
       expect(subject.blacklight_config.default_autocomplete_solr_params).to have_key :fl
       expect(subject.blacklight_config.default_autocomplete_solr_params[:fl]).to include "id"
       expect(subject.blacklight_config.default_autocomplete_solr_params[:fl]).to include "some_field"
-      expect(subject.blacklight_config.default_autocomplete_solr_params[:fl]).to include "some_thumbnail"
+      expect(subject.blacklight_config.default_autocomplete_solr_params[:fl]).to include "full_image_url_ssm"
+      expect(subject.blacklight_config.default_autocomplete_solr_params[:fl]).to include "thumbnail_url_ssm"
+      expect(subject.blacklight_config.default_autocomplete_solr_params[:fl]).to include "thumbnail_square_url_ssm"
     end
   end
 

data/spec/models/spotlight/exhibit_spec.rb

@@ -46,11 +46,20 @@ describe Spotlight::Exhibit, :type => :model do
       expect(subject.searches.first.query_params).to be_empty
     end
 
+  end
+
+  describe "#main_navigations" do
+    subject { Spotlight::Exhibit.new(title: "Sample").tap(&:save!)  }
     it "should have main navigations" do
       expect(subject.main_navigations).to have(3).main_navigations
       expect(subject.main_navigations.map(&:label).compact).to be_blank
       expect(subject.main_navigations.map(&:weight)).to eq [0, 1, 2]
     end
+    it "should use the engine's configuration for default navigations" do
+      expect(Spotlight::Engine.config).to receive(:exhibit_main_navigation).and_return([:a,:b])
+      expect(subject.main_navigations).to have(2).main_navigations
+      expect(subject.main_navigations.map(&:nav_type).compact).to match_array ["a", "b"]
+    end
   end
 
   describe "contacts" do
@@ -68,20 +77,19 @@ describe Spotlight::Exhibit, :type => :model do
     it "should remove the default browse category" do
       subject.save
       expect { subject.import({}) }.to change {subject.searches.count}.by(0)
-      expect { subject.import({"searches_attributes" => [{"title" => "All Exhibit Items","slug" => "all-exhibit-items"}]}) }.to change {subject.searches.count}.by(0)
+      expect { subject.import({"searches" => [{"title" => "All Exhibit Items","slug" => "all-exhibit-items"}]}) }.to change {subject.searches.count}.by(0)
     end
 
     it "should import nested attributes from the hash" do
       subject.save
-      some_value = {}
-      expect(subject).to receive(:update).with(some_value)
-      subject.import some_value
+      subject.import 'title' => 'xyz'
+      expect(subject.title).to eq 'xyz'
     end
 
     it "should munge taggings so they can be imported easily" do
-      subject.save
       expect do
-        subject.import("owned_taggings_attributes"=>[{"taggable_type"=>"SolrDocument", "context"=>'tags', "created_at"=>"2015-01-16T18:23:27.340Z", "taggable_id"=>"1", "tag_attributes"=>{"name"=>"xyz"}}])
+        subject.import("owned_taggings"=>[{"taggable_id"=>"1", "taggable_type"=>"SolrDocument", "context"=>"tags", "tag"=>"xyz"}])
+        subject.save
       end.to change { subject.owned_taggings.count }.by(1)
       tag = subject.owned_taggings.last
       expect(tag.taggable_id).to eq "1"
@@ -112,4 +120,51 @@ describe Spotlight::Exhibit, :type => :model do
     end
   end
 
+  describe "#solr_data" do
+    subject { FactoryGirl.create(:exhibit) }
+
+    it "should provide a solr field with the exhibit slug" do
+      expect(subject.solr_data).to include(:"spotlight_exhibit_slug_#{subject.slug}_bsi" => true)
+    end
+  end
+
+  describe "#analytics" do
+    subject { FactoryGirl.create(:exhibit) }
+    let(:ga_data) { OpenStruct.new(pageviews: 123)}
+
+    before do
+      allow(Spotlight::Analytics::Ga).to receive(:enabled?).and_return(true)
+      allow(Spotlight::Analytics::Ga).to receive(:exhibit_data).with(subject, hash_including(:start_date)).and_return(ga_data)
+    end
+
+    it "should request analytics data" do
+      expect(subject.analytics.pageviews).to eq 123
+    end
+  end
+
+  describe "#page_analytics" do
+    subject { FactoryGirl.create(:exhibit) }
+    let(:ga_data) { [OpenStruct.new(pageviews: 123)]}
+
+    before do
+      allow(Spotlight::Analytics::Ga).to receive(:enabled?).and_return(true)
+      allow(Spotlight::Analytics::Ga).to receive(:page_data).with(subject, hash_including(:start_date)).and_return(ga_data)
+    end
+
+    it "should request analytics data" do
+      expect(subject.page_analytics.length).to eq 1
+      expect(subject.page_analytics.first.pageviews).to eq 123
+    end
+  end
+
+  describe "#reindex_later" do
+    subject { FactoryGirl.create(:exhibit) }
+
+    it "should queue a reindex job for the exhibit" do
+      expect(Spotlight::ReindexJob).to receive(:perform_later).with(subject)
+      subject.reindex_later
+    end
+
+  end
+
 end

data/spec/models/spotlight/home_page_spec.rb

@@ -24,6 +24,11 @@ describe Spotlight::HomePage, :type => :model do
     end
   end
   describe 'display_sidebar?' do
+
+    it 'should be false when the page disabled the display_sidebar' do
+      home_page.display_sidebar = false
+      expect(home_page.display_sidebar?).to be_falsey
+    end
     it 'should be true when the exhibit is searchable' do
       home_page.exhibit.searchable = true
       expect(home_page.display_sidebar?).to be_truthy

data/spec/models/spotlight/masthead_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Spotlight::Masthead, :type => :model do
+  describe '#masthead_exists?' do
+    let(:masthead) { stub_model(Spotlight::Masthead) }
+    let(:image) { OpenStruct.new }
+    it 'should return false when the masthead is set to not display' do
+      expect(masthead.display?).to be_falsey
+    end
+    it 'should return false when the cropped image is not present' do
+      masthead.display = true
+      expect(masthead.display?).to be_falsey
+    end
+    it 'should return false when the cropped image is present but the masthead is set to not display' do
+      allow(masthead).to receive(:image).and_return(image)
+      allow(image).to receive(:cropped_masthead).and_return([0])
+      expect(masthead.display?).to be_falsey
+    end
+    it 'should return true when the cropped image is present and the masthead is set to display' do
+      masthead.display = true
+      expect(masthead).to receive(:image).and_return(image)
+      expect(image).to receive(:cropped_masthead).and_return([0])
+      expect(masthead.display?).to be_truthy
+    end
+  end
+end