blacklight-spotlight 0.3.1 → 0.4.1

data/spec/models/spotlight/custom_field_spec.rb

@@ -12,8 +12,7 @@ describe Spotlight::CustomField, :type => :model do
       before { subject.exhibit = exhibit }
       describe "that overrides the label" do
         before do
-          exhibit.blacklight_configuration.index_fields['foo_tesim'] = 
-            Blacklight::Configuration::IndexField.new(label: "overridden")
+          exhibit.blacklight_configuration.index_fields['foo_tesim'] = { 'label' => "overridden" }
         end
         its(:label) { should eq "overridden"}
       end
@@ -35,8 +34,7 @@ describe Spotlight::CustomField, :type => :model do
       before { subject.exhibit = exhibit }
       describe "that overrides the label" do
         before do
-          exhibit.blacklight_configuration.index_fields['foo_tesim'] = 
-            Blacklight::Configuration::IndexField.new(label: "overridden")
+          exhibit.blacklight_configuration.index_fields['foo_tesim'] = { 'label' => "overridden" }
           subject.label = 'edited'
         end
         it "should have updated the exhibit" do
@@ -96,12 +94,63 @@ describe Spotlight::CustomField, :type => :model do
       expect(subject).to_not be_configured_to_display
     end
     it 'should be falsey when the field is not enabled' do
-      exhibit.blacklight_configuration.index_fields['foo_tesim'] =
-        Blacklight::Configuration::IndexField.new(label: "Label", enabled: false, view_name: false)
+      exhibit.blacklight_configuration.index_fields['foo_tesim'] = { 'label' => "overridden", enabled: false, view_name: false } 
       subject.save
 
       expect(subject).to_not be_configured_to_display
     end
   end
 
+  describe "#field_name" do
+    let(:exhibit) { double(to_param: "a") }
+
+    before do
+      subject.label = "xyz"
+    end
+
+    it "should end in the text suffix if it is a text field" do
+      subject.field_type = "text"
+      expect(subject.send(:field_name)).to end_with Spotlight::Engine.config.solr_fields.text_suffix
+    end
+
+    it "should end in a string suffix if it is a vocab field" do
+      subject.field_type = "vocab"
+      expect(subject.send(:field_name)).to end_with Spotlight::Engine.config.solr_fields.string_suffix
+    end
+  end
+
+  describe "changing the field type" do
+    let(:exhibit) { FactoryGirl.create(:exhibit) }
+    before do
+      subject.label = "xyz"
+      subject.exhibit = exhibit
+      subject.save!
+    end
+
+    it "should change the field name for the field" do
+      expect(subject.field).to end_with "tesim"
+      subject.field_type = "vocab"
+      subject.save
+      expect(subject.field).to end_with "ssim"
+    end
+
+    it "should copy index field configuration to the new field name" do
+      subject.exhibit.blacklight_configuration.index_fields_will_change!
+      subject.exhibit.blacklight_configuration.index_fields[subject.field] = { value: true }
+      subject.exhibit.blacklight_configuration.save
+      expect(subject.exhibit.blacklight_configuration.index_fields).to have_key subject.field
+
+      subject.field_type = "vocab"
+      subject.save
+      expect(subject.exhibit.blacklight_configuration.index_fields).to have_key subject.field
+      expect(subject.exhibit.blacklight_configuration.index_fields[subject.field]).to include value: true
+    end
+    
+    it "should queue a job to reindex any documents with data in the old field" do
+      expect(Spotlight::RenameSidecarFieldJob).to receive(:perform_later).with(exhibit, subject.field, subject.field.sub("tesim", "ssim"))
+      subject.field_type = "vocab"
+      subject.save
+    end
+  end
+
 end

data/spec/models/spotlight/featured_image_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Spotlight::FeaturedImage do
+  context "with an uploaded resource" do
+    subject { described_class.new }
+    let(:document) { double(uploaded_resource?: true) }
+
+    it "should replace the remote_image_url fragment with the local path to the file" do
+      allow(document).to receive_message_chain(:uploaded_resource, :url, file: File.open(File.join(FIXTURES_PATH, "avatar.png")))
+      allow(subject).to receive(:document).and_return(document)
+
+      subject.remote_image_url = "/some/path"
+      expect(subject.remote_image_url).to be_nil
+
+      subject.validate
+
+      expect(subject.image.filename).to eq 'avatar.png'
+    end
+  end
+end

data/spec/models/spotlight/home_page_spec.rb

@@ -38,10 +38,4 @@ describe Spotlight::HomePage, :type => :model do
       expect(home_page.display_sidebar?).to be_falsey
     end
   end
-  describe "content" do
-    it "should include default text" do
-      expect(home_page.content.first).to be_a SirTrevorRails::Blocks::TextBlock
-      expect(home_page.content.first.text).to eq Spotlight::HomePage.default_content_text
-    end
-  end
 end

data/spec/models/spotlight/masthead_spec.rb

@@ -13,13 +13,13 @@ describe Spotlight::Masthead, :type => :model do
     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])
+      allow(image).to receive(:cropped).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(image).to receive(:cropped).and_return([0])
       expect(masthead.display?).to be_truthy
     end
   end

data/spec/models/spotlight/page_spec.rb

@@ -62,4 +62,19 @@ describe Spotlight::Page, :type => :model do
       expect(page.content).to be_a_kind_of SirTrevorRails::BlockArray
     end
   end
+
+  describe "#has_content?" do
+    let(:page) { FactoryGirl.create(:feature_page) }
+
+    it "should not have content when the page is empty" do
+      page.content = []
+      expect(page).not_to have_content
+    end
+
+    it "should have content when the page has a widget" do
+      page.content = [{type: 'rule'}]
+      expect(page).to have_content
+    end
+
+  end
 end

data/spec/models/spotlight/resource_spec.rb

@@ -36,12 +36,7 @@ describe Spotlight::Resource, :type => :model do
       allow(subject).to receive_messages(type: "Spotlight::Resource::Something", id: 15)
     end
     it "should include a reference to the resource" do
-      expect(subject.to_solr).to include spotlight_resource_id_ssim: "spotlight/resource/somethings:15"
-    end
-
-    it "should include a reference to the url" do
-      allow(subject).to receive(:url).and_return("info:something")
-      expect(subject.to_solr).to include spotlight_resource_url_ssim: "info:something"
+      expect(subject.to_solr).to include spotlight_resource_id_ssim: subject.to_global_id.to_s
     end
 
     it "should include exhibit-specific data" do

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

@@ -19,7 +19,7 @@ describe Spotlight::Resources::Csv, :type => :model do
     end
 
     before do
-      allow(subject).to receive_messages(csv: csv, label_to_field: label_to_field, exhibit: exhibit)
+      allow(subject).to receive_messages(csv: csv, label_to_field: label_to_field, exhibit: exhibit, to_global_id: "xyz")
     end
 
     it "should map csv headers to solr fields" do

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

@@ -19,7 +19,7 @@ describe Spotlight::Resources::OpenGraph, :type => :model do
     let(:solr_doc) { subject.to_solr }
 
     it "should include this record id" do
-      expect(solr_doc).to include spotlight_resource_id_ssim: "test_resources:15"
+      expect(solr_doc).to include spotlight_resource_id_ssim: subject.to_global_id.to_s
     end
 
     it "should include opengraph properties" do

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

@@ -6,69 +6,76 @@ describe Spotlight::Resources::Upload, :type => :model do
   before do
     subject.exhibit = exhibit
   end
-  describe '#to_solr' do
-    before do
-      subject.id = "1"
-      subject.data = {
-        configured_title_field: "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"
-      }
-      allow(subject).to receive(:url).and_return(stub_model(Spotlight::ItemUploader))
-      allow(subject.url.file).to receive(:file).and_return(File.expand_path(File.join('..', 'fixtures', '800x600.png'), Rails.root))
-      allow(subject.exhibit).to receive(:blacklight_config).and_return(
-        Blacklight::Configuration.new do |config|
-          config.index.title_field = :configured_title_field
-        end
-      )
-    end
 
-    it 'should have 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'
-    end
+  let(:configured_fields) { [title_field] + Spotlight::Resources::Upload.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"
+    }
+  end
 
-    context "with a custom upload title field" do
-      let(:custom_title_field) { OpenStruct.new(field_name: :configured_title_field, solr_field: :some_other_field) }
+  before do
 
-      before do
-        allow(Spotlight::Engine.config).to receive(:upload_title_field).and_return(custom_title_field)
-      end
+    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(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"
       end
     end
+  end
+  
+  context "multiple solr field mappings" do
 
-    it 'should have the other additional configured fields' do
-      expect(subject.to_solr[Spotlight::Engine.config.uploaded_description_field]).to eq "Description Data"
-      expect(subject.to_solr[Spotlight::Engine.config.uploaded_attribution_field]).to eq "Attribution Data"
-      expect(subject.to_solr[Spotlight::Engine.config.uploaded_date_field]).to eq "Date Data"
+    let :configured_fields do
+      [
+        OpenStruct.new(field_name: 'some_field', solr_field: ['a', 'b'])
+      ]
     end
 
-    context "multiple solr field mappings" do
-
-      let :configured_fields do
-        [
-          OpenStruct.new(field_name: 'some_field', solr_field: ['a', 'b'])
-        ]
-      end
-
-      before do
-        allow(subject).to receive(:configured_fields).and_return configured_fields
-
-        subject.data = { 'some_field' => 'value'}
-      end
+    let :upload_data do
+      { 'some_field' => 'value'}
+    end
 
+    describe "#to_solr" do
       it "should map 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
     end
+  end
+
+  describe '#to_solr' do
+
+    it 'should have 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'
+    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"
+    end
 
     it 'should have a spotlight_resource_type field' do
       expect(subject.to_solr[:spotlight_resource_type_ssim]).to eq 'spotlight/resources/uploads'

data/spec/models/spotlight/search_spec.rb

@@ -1,33 +1,18 @@
 require 'spec_helper'
 
 describe Spotlight::Search, :type => :model do
+  let(:query_params) { {"f"=>{"genre_sim"=>["map"]}} }
+  subject { FactoryGirl.build(:search, query_params: query_params )}
 
-  before do
-    subject.query_params = {"f"=>{"genre_sim"=>["map"]}}
-    subject.exhibit = FactoryGirl.create(:exhibit)
-  end
+  let(:blacklight_config) { ::CatalogController.blacklight_config }
 
   it { is_expected.to be_a Spotlight::Catalog::AccessControlsEnforcement }
 
   it "should have a default feature image" do
-    allow(subject).to receive_messages(images: [['dq287tq6352', 'title', 'image_url']])
-    allow(subject).to receive(:featured_item_id).and_return("dq287tq6352")
-    subject.save
-    expect(subject.featured_image).to eq "https://stacks.stanford.edu/image/dq287tq6352/dq287tq6352_05_0001_thumb"
-  end
-
-  it "should handle blank and nil featured_image_ids" do
-    allow(subject).to receive(:featured_item_id).and_return("")
-    subject.save
-    expect(subject.featured_item).to be_nil
-    allow(subject).to receive(:featured_item_id).and_return(nil)
-    subject.save
-    expect(subject.featured_item).to be_nil
-  end
-
-  it "should #default_featured_iamge should not thrown an error when no images are present" do
-    allow(subject).to receive_messages(images: nil)
-    expect(subject.default_featured_item_id).to be_nil
+    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")])
+    subject.save!
+    expect(subject.thumbnail).not_to be_nil
+    expect(subject.thumbnail.image.path).to end_with "dq287tq6352_05_0001_thumb.jpeg"
   end
 
   it "should have items" do

data/spec/models/spotlight/sir_trevor_blocks/textable_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe SirTrevorRails::Blocks::Textable do
+  class TextableTestClass
+    include SirTrevorRails::Blocks::Textable
+    attr_accessor :text
+  end
+  let(:subject) { TextableTestClass.new }
+  let(:st_blank_text) { '<p><br></p>' }
+  describe '#text?' do
+    it 'should return false when there is no text' do
+      expect(subject.text?).to be_falsey
+    end
+    it 'should return true false when the text is the default sir-trevor text' do
+      allow(subject).to receive_messages(text: st_blank_text)
+      expect(subject.text?).to be_truthy
+    end
+  end
+  describe '#text_align' do
+    it 'should proxy the sir-trevor text-align attribute' do
+      allow(subject).to receive_messages(:'text-align' => 'text-align-value')
+      expect(subject.text_align).to eq 'text-align-value'
+    end
+  end
+  describe '#content_align' do
+    it 'should be the reverse of text-align' do
+      allow(subject).to receive_messages(text: 'TextContent')
+      allow(subject).to receive_messages(text_align: 'left')
+      expect(subject.content_align).to eq 'right'
+      allow(subject).to receive_messages(text_align: 'right')
+      expect(subject.content_align).to eq 'left'
+    end
+    it 'should not have any alignment if there is no text' do
+      expect(subject.content_align).to be_nil
+    end
+  end
+end
+

data/spec/models/spotlight/solr_document_uploaded_resource_spec.rb

@@ -3,11 +3,8 @@ require 'spec_helper'
 describe Spotlight::SolrDocument::UploadedResource, :type => :model do
   let(:valid_resource) { ::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"]) }
   describe 'SolrDocument.use_extension' do
-    it 'should not include the uploaded resource extension when there is no full image field' do
-      expect(::SolrDocument.new(id: '123', spotlight_resource_type_ssim: ["spotlight/resources/uploads"])).to_not be_a_kind_of(Spotlight::SolrDocument::UploadedResource)
-    end
     it 'should not include the uploaded resource extension when the spotlight resource type is not correct' do
-      expect(::SolrDocument.new(id: '123', full_image_url_ssm: ["http://example.com/png.png"], spotlight_resource_type_ssim: ["not-correct"])).to_not be_a_kind_of(Spotlight::SolrDocument::UploadedResource)
+      expect(::SolrDocument.new(id: '123', spotlight_resource_type_ssim: ["not-correct"])).to_not be_a_kind_of(Spotlight::SolrDocument::UploadedResource)
     end
     it 'should include the uploaded resource extension when the correct fields are present with the correct data' do
       expect(valid_resource).to be_a_kind_of(Spotlight::SolrDocument::UploadedResource)

data/spec/serializers/spotlight/exhibit_export_serializer_spec.rb

@@ -144,7 +144,7 @@ describe Spotlight::ExhibitExportSerializer 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=>{:"slug"=>search.slug, :atom=>nil, :rss=>nil, :gallery=>nil, :slideshow=>nil, :list=>"on"}}].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
@@ -162,6 +162,9 @@ describe Spotlight::ExhibitExportSerializer do
       end
 
       it "should use a search within the exhibit" do
+        # searches need to be published.
+        subject.searches.each { |x| x.on_landing_page = true; x.save }
+
         expect(subject.feature_pages.first.content.first.search.exhibit).to eq subject
       end
 
@@ -172,7 +175,7 @@ describe Spotlight::ExhibitExportSerializer do
 
     context "with a search object that needs to be created" do
        let :search do
-         source_exhibit.searches.create title: "custom query", slug: 'xyz'
+         source_exhibit.searches.create title: "custom query", slug: 'xyz', on_landing_page: true
        end
 
        it "should create a search within the exhibit" do

data/spec/spec_helper.rb

@@ -12,9 +12,24 @@ require 'rspec/rails'
 require 'rspec/active_model/mocks'
 
 require 'capybara/poltergeist'
-Capybara.javascript_driver = :poltergeist
+
+if ENV["POLTERGEIST_DEBUG"]
+  Capybara.register_driver :poltergeist_debug do |app|
+    Capybara::Poltergeist::Driver.new(app, inspector: true, phantomjs_options: ['--load-images=no'])
+  end
+  Capybara.javascript_driver = :poltergeist_debug
+else
+  Capybara.register_driver :poltergeist do |app|
+    Capybara::Poltergeist::Driver.new(app, phantomjs_options: ['--load-images=no'])
+  end
+  Capybara.javascript_driver = :poltergeist
+end
 Capybara.default_wait_time = 10
 
+# Setting this to false when running tests so that we don't have to set up
+# exhibit specific solr documents for tests that don't use the default exhibit.
+Spotlight::Engine.config.filter_resources_by_exhibit = false
+
 
 if ENV["COVERAGE"] or ENV["CI"]
   require 'simplecov'
@@ -58,6 +73,10 @@ RSpec.configure do |config|
     DatabaseCleaner.clean
   end
 
+  if ENV['CI']
+    config.filter_run_excluding js: true
+  end
+
   config.include Devise::TestHelpers, type: :controller
   config.include Devise::TestHelpers, type: :view
   config.include Spotlight::TestViewHelpers, type: :view