blacklight-spotlight 0.4.1 → 0.5.0

data/spec/helpers/spotlight/roles_helper_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-describe Spotlight::RolesHelper, :type => :helper do
-  it "should be a list of options" do
-    expect(helper.roles_for_select).to eq({"Admin"=>"admin", "Curator"=>"curator"})
+describe Spotlight::RolesHelper, type: :helper do
+  it 'is a list of options' do
+    expect(helper.roles_for_select).to eq('Admin' => 'admin', 'Curator' => 'curator')
   end
 end

data/spec/helpers/spotlight/search_configurations_helper_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Spotlight::SearchConfigurationsHelper, type: :helper do
+  describe '#translate_sort_fields' do
+    let(:sort_config) do
+      Blacklight::OpenStructWithHashAccess.new(sort: 'score asc, sort_title_ssi desc')
+    end
+
+    it 'translates sort fields' do
+      expect(translate_sort_fields(sort_config)).to eq 'relevancy score ascending and title descending'
+    end
+
+    it 'humanizes untranslatable sort fields' do
+      sort_config.sort = 'some_other_field desc'
+
+      expect(translate_sort_fields(sort_config)).to eq 'some other field descending'
+    end
+
+    it 'supports explicit sort descriptions' do
+      sort_config.sort_description = 'xyz'
+      expect(translate_sort_fields(sort_config)).to eq 'xyz'
+    end
+  end
+end

data/spec/helpers/spotlight/title_helper_spec.rb

@@ -1,60 +1,58 @@
 require 'spec_helper'
 
-describe Spotlight::TitleHelper, :type => :helper do
+describe Spotlight::TitleHelper, type: :helper do
   before do
-    allow(helper).to receive_messages(application_name: "Application")
+    allow(helper).to receive_messages(application_name: 'Application')
   end
 
-  describe "#page_title" do
-    it "should set the @page_title ivar" do
-      helper.page_title("Section", "Title")
+  describe '#page_title' do
+    it 'sets the @page_title ivar' do
+      helper.page_title('Section', 'Title')
       title = helper.instance_variable_get(:@page_title)
-      expect(title).to eq "Section - Title | Application"
+      expect(title).to eq 'Section - Title | Application'
     end
 
-    it "should render the section title and the page title" do
-      title = helper.page_title("Section", "Title")
-      expect(title).to have_selector "h1", text: "Section"
-      expect(title).to have_selector "h1 small", text: "Title"
-      
+    it 'renders the section title and the page title' do
+      title = helper.page_title('Section', 'Title')
+      expect(title).to have_selector 'h1', text: 'Section'
+      expect(title).to have_selector 'h1 small', text: 'Title'
     end
   end
 
-  describe "#set_html_page_title" do
-    it "should assign the @page_title ivar" do
-      allow(helper).to receive_messages(application_name: "B")
-      helper.set_html_page_title "A"
+  describe '#set_html_page_title' do
+    it 'assigns the @page_title ivar' do
+      allow(helper).to receive_messages(application_name: 'B')
+      helper.set_html_page_title 'A'
       title = helper.instance_variable_get(:@page_title)
-      expect(title).to eq "A | B"
+      expect(title).to eq 'A | B'
     end
-    it 'should strip out any HTML tags' do
-      allow(helper).to receive_messages(application_name: "B")
-      expect(helper.set_html_page_title("<b>text</b> should not include HTML")).to eq "text should not include HTML | B"
+    it 'strips out any HTML tags' do
+      allow(helper).to receive_messages(application_name: 'B')
+      expect(helper.set_html_page_title('<b>text</b> should not include HTML')).to eq 'text should not include HTML | B'
     end
   end
 
-  describe "#curation_page_title" do
-    it "should render a page title in the curation section" do
-      title = helper.curation_page_title "Some title"
-      expect(title).to have_selector "h1", text: "Curation"
-      expect(title).to have_selector "h1 small", text: "Some title"
+  describe '#curation_page_title' do
+    it 'renders a page title in the curation section' do
+      title = helper.curation_page_title 'Some title'
+      expect(title).to have_selector 'h1', text: 'Curation'
+      expect(title).to have_selector 'h1 small', text: 'Some title'
     end
   end
 
-  describe "#administration_page_title" do
-    it "should render a page title in the administration section" do
-      title = helper.administration_page_title "Some title"
-      expect(title).to have_selector "h1", text: "Administration"
-      expect(title).to have_selector "h1 small", text: "Some title"
+  describe '#administration_page_title' do
+    it 'renders a page title in the administration section' do
+      title = helper.administration_page_title 'Some title'
+      expect(title).to have_selector 'h1', text: 'Administration'
+      expect(title).to have_selector 'h1 small', text: 'Some title'
     end
   end
 
-  describe "#header_with_count" do
-    it "should merge the title with a count label" do
-      val = helper.header_with_count "some title", 5
-      expect(val).to match /some title /
-      expect(val).to have_selector "span.label", text: 5
+  describe '#header_with_count' do
+    it 'merges the title with a count label' do
+      val = helper.header_with_count 'some title', 5
+      expect(val).to include 'some title'
+      expect(val).to have_selector 'span.label', text: 5
     end
   end
-
 end

data/spec/jobs/spotlight/reindex_job_spec.rb

@@ -8,14 +8,14 @@ describe Spotlight::ReindexJob do
     allow_any_instance_of(Spotlight::Resource).to receive(:reindex)
   end
 
-  context "with an exhibit" do
+  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
+    it 'attempts 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
@@ -25,12 +25,12 @@ describe Spotlight::ReindexJob do
     end
   end
 
-  context "with a resource" do
+  context 'with a resource' do
     subject { described_class.new(resource) }
-    
-    it "should attempt to reindex every resource in the exhibit" do
+
+    it 'attempts to reindex every resource in the exhibit' do
       expect(resource).to receive(:reindex)
       subject.perform_now
     end
   end
-end
+end

data/spec/jobs/spotlight/rename_sidecar_field_job_spec.rb

@@ -2,26 +2,26 @@ require 'spec_helper'
 
 describe Spotlight::RenameSidecarFieldJob do
   let(:exhibit) { FactoryGirl.create(:exhibit) }
-  let(:sidecar) { SolrDocument.new(id: 'test').sidecar(exhibit).tap { |x| x.save! } }
+  let(:sidecar) { SolrDocument.new(id: 'test').sidecar(exhibit).tap(&:save!) }
 
-  it "should update the sidecar data and reindex affected documents" do
+  it 'updates the sidecar data and reindex affected documents' do
     expect_any_instance_of(::SolrDocument).to receive(:reindex)
 
     sidecar.data['old_field'] = 'some value'
     sidecar.save!
 
-    described_class.perform_later(exhibit, "old_field", "new_field")
-    
+    described_class.perform_later(exhibit, 'old_field', 'new_field')
+
     sidecar.reload
     expect(sidecar.data['new_field']).to eq 'some value'
   end
 
-  it "shouldn't touch unaffected documents" do
+  it 'does not touch unaffected documents' do
     expect_any_instance_of(::SolrDocument).not_to receive(:reindex)
 
     sidecar.data['other_field'] = 'some value'
     sidecar.save!
 
-    described_class.perform_later(exhibit, "old_field", "new_field")
+    described_class.perform_later(exhibit, 'old_field', 'new_field')
   end
-end
+end

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

@@ -1,57 +1,72 @@
 require 'spec_helper'
 
 describe Spotlight::Catalog::AccessControlsEnforcement do
-  class MockCatalogController
-    include Blacklight::SearchHelper
-    include Spotlight::Catalog::AccessControlsEnforcement
+  class MockSearchBuilder < Blacklight::SearchBuilder
+    attr_reader :blacklight_params, :scope
+    def initialize(blacklight_params, scope)
+      @blacklight_params = blacklight_params
+      @scope = scope
+    end
+    include Spotlight::Catalog::AccessControlsEnforcement::SearchBuilder
+    include Blacklight::Solr::SearchBuilderBehavior
 
     def blacklight_config
-      @blacklight_config ||= Blacklight::Configuration.new
+      scope.current_exhibit.blacklight_config
     end
   end
 
-  subject { MockCatalogController.new }
-  let(:solr_request) { Blacklight::Solr::Request.new }
+  subject { MockSearchBuilder.new blacklight_params, scope }
   let(:exhibit) { FactoryGirl.create(:exhibit) }
+  let(:scope) { double(current_exhibit: exhibit) }
+  let(:solr_request) { Blacklight::Solr::Request.new }
+  let(:blacklight_params) { Hash.new }
 
-  before do
-    allow(subject).to receive_messages(current_exhibit: exhibit)
-  end
+  describe '.search_params_logic' do
+    class MockCatalogController
+      include Blacklight::SearchHelper
+      include Spotlight::Catalog::AccessControlsEnforcement
+    end
+
+    subject { MockCatalogController.new }
 
-  describe "#apply_permissive_visibility_filter" do
-    it "should add the filter to the params logic" do
-      expect(subject.search_params_logic).to include :apply_permissive_visibility_filter 
+    it 'adds the filter to the params logic' do
+      expect(subject.search_params_logic).to include :apply_permissive_visibility_filter
     end
+  end
 
-    it "should allow curators to view everything" do
-      allow(subject).to receive(:can?).and_return(true)
-      subject.send(:apply_permissive_visibility_filter, solr_request, {})
+  describe '#apply_permissive_visibility_filter' do
+    it 'allows curators to view everything' do
+      allow(scope).to receive(:can?).and_return(true)
+      subject.apply_permissive_visibility_filter(solr_request)
       expect(solr_request.to_hash).to be_empty
     end
 
-    it "should restrict searches to public items" do
-      allow(subject).to receive(:can?).and_return(false)
+    it 'restricts searches to public items' do
+      allow(scope).to receive(:can?).and_return(false)
 
-      subject.send(:apply_permissive_visibility_filter, solr_request, {})
+      subject.apply_permissive_visibility_filter(solr_request)
       expect(solr_request).to include :fq
-      expect(solr_request[:fq]).to include "-exhibit_1_public_bsi:false"
+      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
+
+    it 'does 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, {})
+      subject.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
+  end
 
-    context "with filter_resources_by_exhibit" do
+  describe '#apply_exhibit_resources_filter' do
+    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, {})
+      it 'filters resources to just those created by the exhibit' do
+        allow(scope).to receive(:can?).and_return(true)
+
+        subject.apply_exhibit_resources_filter(solr_request)
         expect(solr_request).to include :fq
         expect(solr_request[:fq]).to include "spotlight_exhibit_slug_#{exhibit.slug}_bsi:true"
       end

data/spec/lib/spotlight/controller_spec.rb

@@ -8,11 +8,11 @@ describe Spotlight::Controller do
   subject { MockController.new }
 
   before do
-    allow(subject).to receive_messages(params: {action: 'show'})
+    allow(subject).to receive_messages(params: { action: 'show' })
   end
 
-  describe "#current_exhibit" do
-    it "should be nil by default" do
+  describe '#current_exhibit' do
+    it 'is nil by default' do
       expect(subject.current_exhibit).to be_nil
     end
   end
@@ -24,16 +24,16 @@ describe Spotlight::Controller do
       allow(subject).to receive_messages(current_exhibit: nil, current_masthead: nil)
     end
 
-    it "should be true if there is no exhibit" do
+    it 'is true if there is no exhibit' do
       expect(subject.exhibit_masthead?).to eq true
     end
 
-    it "should be true if there is no custom exhibit masthead" do
+    it 'is true if there is no custom exhibit masthead' do
       allow(subject).to receive_messages(current_exhibit: double, current_masthead: nil)
       expect(subject.exhibit_masthead?).to eq true
     end
 
-    it "should be false if the current masthead is not the exhibit masthead" do
+    it 'is false if the current masthead is not the exhibit masthead' do
       allow(subject).to receive_messages(current_exhibit: double(masthead: double), current_masthead: masthead)
       expect(subject.exhibit_masthead?).to eq false
     end
@@ -44,17 +44,17 @@ describe Spotlight::Controller do
     let(:exhibit_masthead) { double('exhibit-masthead', display?: true) }
     let(:exhibit) { FactoryGirl.create(:exhibit) }
     let(:search) { FactoryGirl.create(:search) }
-    it 'should be nil by default' do
+    it 'is nil by default' do
       expect(subject.current_masthead).to be_nil
     end
-    it 'should return the exhibit masthead if available' do
+    it 'returns the exhibit masthead if available' do
       allow(exhibit).to receive_messages(masthead: exhibit_masthead)
       subject.instance_variable_set(:@exhibit, exhibit)
       expect(subject.current_masthead).to eq exhibit_masthead
     end
-    it 'should allow the masthead to be set' do
+    it 'allows the masthead to be set' do
       subject.current_masthead = search_masthead
       expect(subject.current_masthead).to eq search_masthead
     end
   end
-end
+end

data/spec/lib/spotlight/routes_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe ActionDispatch::Routing::Mapper do
-  describe "#spotlight_root" do
+describe Spotlight::Routes do
+  describe '#spotlight_root' do
     subject { ActionDispatch::Routing::Mapper.new(ActionDispatch::Routing::RouteSet.new) }
-    it "should make the root route" do
-      expect(subject).to receive(:root).with(to: "spotlight/default#index")
+    it 'makes the root route' do
+      expect(subject).to receive(:root).with(to: 'spotlight/default#index')
       subject.spotlight_root
     end
   end

data/spec/mailers/spotlight/indexing_complete_mailer_spec.rb

@@ -1,31 +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}
-  
+  let(:user) { double(email: 'test@example.com') }
+  let(:exhibit) { double(title: 'Exhibit title') }
+  subject { described_class.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"
+  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"
+    expect(subject.body.encoded).to match '3 documents'
   end
 
-  context "single item" do
-    subject { Spotlight::IndexingCompleteMailer.documents_indexed [1], exhibit, user}
+  context 'single item' do
+    subject { described_class.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"
+      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
+end

data/spec/models/sir_trevor_rails/blocks/solr_documents_block_spec.rb

@@ -3,18 +3,18 @@ require 'spec_helper'
 describe SirTrevorRails::Blocks::SolrDocumentsBlock do
   let(:page) { FactoryGirl.create(:feature_page) }
   let(:block_data) { {} }
-  subject { described_class.new({type: "", data: block_data}, page) }
+  subject { described_class.new({ type: '', data: block_data }, page) }
 
-  describe "#text" do
-    it "should be the block's text data" do
-      block_data[:text] = "abc"
+  describe '#text' do
+    it "is the block's text data" do
+      block_data[:text] = 'abc'
 
-      expect(subject.text).to eq "abc"
+      expect(subject.text).to eq 'abc'
     end
 
-    it "should squelch sir-trevor's placeholder values" do
-      block_data[:text] = "<p><br></p>"
+    it "squelches sir-trevor's placeholder values" do
+      block_data[:text] = '<p><br></p>'
       expect(subject.text).to be_blank
     end
   end
-end
+end

data/spec/models/{spotlight/sir_trevor_blocks → sir_trevor_rails/blocks}/textable_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe SirTrevorRails::Blocks::Textable do
   class TextableTestClass
@@ -8,31 +8,30 @@ describe SirTrevorRails::Blocks::Textable do
   let(:subject) { TextableTestClass.new }
   let(:st_blank_text) { '<p><br></p>' }
   describe '#text?' do
-    it 'should return false when there is no text' do
+    it 'returns 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
+    it 'returns 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')
+    it 'proxies 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
+    it 'is 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
+    it 'does not have any alignment if there is no text' do
       expect(subject.content_align).to be_nil
     end
   end
 end
-