blacklight-spotlight 0.4.1 → 0.5.0

data/spec/controllers/spotlight/application_controller_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe Spotlight::ApplicationController, :type => :controller do
+describe Spotlight::ApplicationController, type: :controller do
   routes { Spotlight::Engine.routes }
   let(:exhibit) { FactoryGirl.create(:exhibit) }
-  it "should provide a search_action_url override" do
+  it 'provides a search_action_url override' do
     allow(controller).to receive_messages(current_exhibit: exhibit)
-    expect(controller.search_action_url(q: 'query')).to eq exhibit_catalog_index_url(exhibit, q: "query")
+    expect(controller.search_action_url(q: 'query')).to eq exhibit_catalog_index_url(exhibit, q: 'query')
   end
 end

data/spec/controllers/spotlight/attachments_controller_spec.rb

@@ -1,24 +1,24 @@
 require 'spec_helper'
 
-describe Spotlight::AttachmentsController, :type => :controller do
+describe Spotlight::AttachmentsController, type: :controller do
   routes { Spotlight::Engine.routes }
   let(:exhibit) { FactoryGirl.create(:exhibit) }
-  describe "when not logged in" do
-    describe "GET edit" do
-      it "should be successful" do
-        post :create, exhibit_id: exhibit 
+  describe 'when not logged in' do
+    describe 'GET edit' do
+      it 'is successful' do
+        post :create, exhibit_id: exhibit
         expect(response).to redirect_to main_app.new_user_session_path
       end
     end
   end
 
-  describe "when signed in as a curator" do
+  describe 'when signed in as a curator' do
     let(:user) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
-    before {sign_in user }
+    before { sign_in user }
 
-    describe "POST create" do
-      it "should be successful" do
-        post :create, exhibit_id: exhibit, attachment: { name: "xyz" }
+    describe 'POST create' do
+      it 'is successful' do
+        post :create, exhibit_id: exhibit, attachment: { name: 'xyz' }
         expect(response).to be_successful
       end
     end

data/spec/controllers/spotlight/browse_controller_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Spotlight::BrowseController, :type => :controller do
+describe Spotlight::BrowseController, type: :controller do
   routes { Spotlight::Engine.routes }
   let(:exhibit) { FactoryGirl.create(:exhibit) }
   let!(:search) { FactoryGirl.create(:published_search, exhibit: exhibit) }
@@ -9,62 +9,62 @@ describe Spotlight::BrowseController, :type => :controller do
 
   it { is_expected.to be_a Spotlight::Catalog::AccessControlsEnforcement }
 
-  describe "when authenticated as an admin" do
+  describe 'when authenticated as an admin' do
     before { sign_in admin }
-    describe "#index" do
-      it "should not show unpublished categories" do
-        expect(controller).to receive(:add_breadcrumb).with("Home", exhibit)
-        expect(controller).to receive(:add_breadcrumb).with("Browse", exhibit_browse_index_path(exhibit))
+    describe '#index' do
+      it 'does not show unpublished categories' do
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
+        expect(controller).to receive(:add_breadcrumb).with('Browse', exhibit_browse_index_path(exhibit))
         get :index, exhibit_id: exhibit
         expect(response).to be_successful
         expect(assigns[:searches]).to eq [search]
         expect(assigns[:searches]).to_not include unpublished
         expect(assigns[:exhibit]).to eq exhibit
-        expect(response).to render_template "spotlight/browse/index"
+        expect(response).to render_template 'spotlight/browse/index'
       end
     end
   end
 
-  describe "when unauthenticated" do
-    describe "#index" do
-      it "should show the list of browse categories" do
-        expect(controller).to receive(:add_breadcrumb).with("Home", exhibit)
-        expect(controller).to receive(:add_breadcrumb).with("Browse", exhibit_browse_index_path(exhibit))
+  describe 'when unauthenticated' do
+    describe '#index' do
+      it 'shows the list of browse categories' do
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
+        expect(controller).to receive(:add_breadcrumb).with('Browse', exhibit_browse_index_path(exhibit))
         get :index, exhibit_id: exhibit
         expect(response).to be_successful
         expect(assigns[:searches]).to eq [search]
         expect(assigns[:searches]).to_not include unpublished
         expect(assigns[:exhibit]).to eq exhibit
-        expect(response).to render_template "spotlight/browse/index"
+        expect(response).to render_template 'spotlight/browse/index'
       end
     end
 
-    describe "#show" do
+    describe '#show' do
       let(:mock_response) { double }
       let(:document_list) { double }
       before do
-        allow(controller).to receive_messages(get_search_results: [mock_response, document_list])
+        allow(controller).to receive_messages(search_results: [mock_response, document_list])
       end
-      it "should show the items in the category" do
-        expect(controller).to receive(:add_breadcrumb).with("Home", exhibit)
-        expect(controller).to receive(:add_breadcrumb).with("Browse", exhibit_browse_index_path(exhibit))
+      it 'shows the items in the category' do
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
+        expect(controller).to receive(:add_breadcrumb).with('Browse', exhibit_browse_index_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with(search.title, exhibit_browse_path(exhibit, search))
         get :show, id: search, exhibit_id: exhibit
         expect(response).to be_successful
         expect(assigns[:search]).to be_a Spotlight::Search
         expect(assigns[:response]).to eq mock_response
         expect(assigns[:document_list]).to eq document_list
-        expect(response).to render_template "spotlight/browse/show"
+        expect(response).to render_template 'spotlight/browse/show'
       end
 
-      it "should remove all the document actions" do
+      it 'removes all the document actions' do
         get :show, id: search, exhibit_id: exhibit
         expect(controller.blacklight_config.index.document_actions).to be_blank
       end
 
-      it "should use the blacklight.browse configuration for the document actions" do
-        config = Blacklight::Configuration.new do |config|
-          config.browse.document_actions = [:a, :b, :c]
+      it 'uses the blacklight.browse configuration for the document actions' do
+        config = Blacklight::Configuration.new do |c|
+          c.browse.document_actions = [:a, :b, :c]
         end
 
         allow(controller). to receive(:blacklight_config).and_return(config)
@@ -72,8 +72,6 @@ describe Spotlight::BrowseController, :type => :controller do
         get :show, id: search, exhibit_id: exhibit
         expect(controller.blacklight_config.index.document_actions).to match_array [:a, :b, :c]
       end
-
     end
   end
-
 end

data/spec/controllers/spotlight/catalog_controller_spec.rb

@@ -1,261 +1,256 @@
 require 'spec_helper'
 
-describe Spotlight::CatalogController, :type => :controller do
+describe Spotlight::CatalogController, type: :controller do
   routes { Spotlight::Engine.routes }
-  let (:exhibit) { FactoryGirl.create(:exhibit) }
-  
+  let(:exhibit) { FactoryGirl.create(:exhibit) }
+
   it { is_expected.to be_a_kind_of ::CatalogController }
   it { is_expected.to be_a_kind_of Spotlight::Concerns::ApplicationController }
   its(:view_context) { should be_a_kind_of Spotlight::ApplicationHelper }
 
-  describe "when the user is not authenticated" do
-
-    describe "GET admin" do
-      it "should redirect to the login page" do
+  describe 'when the user is not authenticated' do
+    describe 'GET admin' do
+      it 'redirects to the login page' do
         get :admin, exhibit_id: exhibit
         expect(response).to redirect_to main_app.new_user_session_path
       end
     end
 
-    describe "GET edit" do
-      it "should not be allowed" do
+    describe 'GET edit' do
+      it 'does not be allowed' do
         get :edit, exhibit_id: exhibit, id: 'dq287tq6352'
         expect(response).to redirect_to main_app.new_user_session_path
       end
     end
 
-    describe "GET show" do
-      let (:document) { SolrDocument.find('dq287tq6352') }
+    describe 'GET show' do
+      let(:document) { SolrDocument.find('dq287tq6352') }
       let(:search) { FactoryGirl.create(:search, exhibit: exhibit) }
-      it "should show the item" do
-        expect(controller).to receive(:add_breadcrumb).with("Home", exhibit_path(exhibit, q: ''))
+      it 'shows the item' do
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
         expect(controller).to receive(:add_breadcrumb).with("L'AMERIQUE", exhibit_catalog_path(exhibit, document))
         get :show, exhibit_id: exhibit, id: 'dq287tq6352'
         expect(response).to be_successful
       end
 
-      it "should show the item with breadcrumbs to the browse page" do
+      it 'shows the item with breadcrumbs to the browse page' do
         allow(controller).to receive_messages(current_browse_category: search)
-        
-        expect(controller).to receive(:add_breadcrumb).with("Home", exhibit_path(exhibit, q: ''))
-        expect(controller).to receive(:add_breadcrumb).with("Browse", exhibit_browse_index_path(exhibit))
+
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
+        expect(controller).to receive(:add_breadcrumb).with('Browse', exhibit_browse_index_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with(search.title, exhibit_browse_path(exhibit, search))
         expect(controller).to receive(:add_breadcrumb).with("L'AMERIQUE", exhibit_catalog_path(exhibit, document))
         get :show, exhibit_id: exhibit, id: 'dq287tq6352'
         expect(response).to be_successful
       end
 
-      it "should show the item with breadcrumbs to the feature page" do
+      it 'shows the item with breadcrumbs to the feature page' do
         feature_page = FactoryGirl.create(:feature_page, exhibit: exhibit)
         allow(controller).to receive_messages(current_page_context: feature_page)
 
-        expect(controller).to receive(:add_breadcrumb).with("Home", exhibit_path(exhibit, q: ''))
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
         expect(controller).to receive(:add_breadcrumb).with(feature_page.title, [exhibit, feature_page])
         expect(controller).to receive(:add_breadcrumb).with("L'AMERIQUE", exhibit_catalog_path(exhibit, document))
         get :show, exhibit_id: exhibit, id: 'dq287tq6352'
         expect(response).to be_successful
       end
 
-      it "should show the item with breadcrumbs from the home page" do
+      it 'shows the item with breadcrumbs from the home page' do
         home_page = FactoryGirl.create(:home_page)
         allow(controller).to receive_messages(current_page_context: home_page)
 
-        expect(controller).to receive(:add_breadcrumb).with("Home", exhibit_path(exhibit, q: ''))
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
         expect(controller).to receive(:add_breadcrumb).with("L'AMERIQUE", exhibit_catalog_path(exhibit, document))
         get :show, exhibit_id: exhibit, id: 'dq287tq6352'
         expect(response).to be_successful
       end
 
-      it "should add the curation widget" do
+      it 'adds the curation widget' do
         get :show, exhibit_id: exhibit, id: 'dq287tq6352'
-        expect(controller.blacklight_config.show.partials.first).to eq "curation_mode_toggle"
+        expect(controller.blacklight_config.show.partials.first).to eq 'curation_mode_toggle'
       end
 
-      it "should not have a solr_json serialization" do
+      it 'does not have a solr_json serialization' do
         get :show, exhibit_id: exhibit, id: 'dq287tq6352', format: :solr_json
         expect(response).not_to be_successful
       end
     end
 
-    describe "GET index" do
-      it "should show the index when there are parameters" do
-        expect(controller).to receive(:add_breadcrumb).with("Home", exhibit_path(exhibit, q: ''))
-        expect(controller).to receive(:add_breadcrumb).with("Search Results", exhibit_catalog_index_path(exhibit, q:'map'))
+    describe 'GET index' do
+      it 'shows the index when there are parameters' do
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
+        expect(controller).to receive(:add_breadcrumb).with('Search Results', exhibit_catalog_index_path(exhibit, q: 'map'))
         get :index, exhibit_id: exhibit, q: 'map'
         expect(response).to be_successful
       end
-      it "should redirect to the exhibit home page when there are no parameters" do
+      it 'redirects to the exhibit home page when there are no parameters' do
         get :index, exhibit_id: exhibit
         expect(response).to redirect_to(exhibit_root_path(exhibit))
       end
     end
 
-    describe "GET autocomplete" do
-      it "should have partial matches for title" do
+    describe 'GET autocomplete' do
+      it 'has partial matches for title' do
         # Testing with ps921pn8250 because it has html escapable characters in the title (c'estadire)
         get :autocomplete, exhibit_id: exhibit, q: 'PLANIS', format: 'json'
         expect(assigns[:document_list].first.id).to eq 'ps921pn8250'
         expect(response).to be_successful
         json = JSON.parse(response.body)
         doc = json['docs'].first
-        expect(doc).to include "id", "title", "description", "thumbnail", "url"
+        expect(doc).to include 'id', 'title', 'description', 'thumbnail', 'url'
         expect(doc['id']).to eq 'ps921pn8250'
         expect(doc['description']).to eq 'ps921pn8250'
         expect(doc['title']).to eq "PLANISPHERE URANO-GEOGRAPHIQUE c'estadire LES SPHERES CELESTE et TERRESTRE mises en plan."
         expect(doc['thumbnail']).to eq assigns[:document_list].first.first(:thumbnail_url_ssm)
         expect(doc['url']).to eq exhibit_catalog_path(exhibit, id: 'ps921pn8250')
       end
-      it "should have partial matches for id" do
+      it 'has partial matches for id' do
         get :autocomplete, exhibit_id: exhibit, q: 'dx157', format: 'json'
         expect(assigns[:document_list].first.id).to eq 'dx157dh4345'
         expect(response).to be_successful
         json = JSON.parse(response.body)
         expect(json['docs'].first['id']).to eq 'dx157dh4345'
-        expect(json['docs'].first['title']).to eq "KAART der REYZE van drie Schepen naar het ZUYDLAND in de Jaaren 1721 en 1722"
+        expect(json['docs'].first['title']).to eq 'KAART der REYZE van drie Schepen naar het ZUYDLAND in de Jaaren 1721 en 1722'
       end
     end
   end
 
-  describe "when the user is not authorized" do
+  describe 'when the user is not authorized' do
     before do
       sign_in FactoryGirl.create(:exhibit_visitor)
     end
 
-    describe "GET index" do
-      it "should apply gated discovery access controls" do
+    describe 'GET index' do
+      it 'applies gated discovery access controls' do
         expect(controller.search_params_logic).to include :apply_permissive_visibility_filter
       end
     end
 
-    describe "GET admin" do
-      it "should deny access" do
+    describe 'GET admin' do
+      it 'denies access' do
         get :admin, exhibit_id: exhibit
         expect(response).to redirect_to main_app.root_path
         expect(flash[:alert]).to be_present
       end
     end
 
-    describe "GET edit" do
-      it "should not be allowed" do
+    describe 'GET edit' do
+      it 'does not be allowed' do
         get :edit, exhibit_id: exhibit, id: 'dq287tq6352'
         expect(response).to redirect_to main_app.root_path
-        expect(flash[:alert]).to eq "You are not authorized to access this page."
+        expect(flash[:alert]).to eq 'You are not authorized to access this page.'
       end
     end
 
-    describe "GET show with private item" do
-      it "should not be allowed" do
+    describe 'GET show with private item' do
+      it 'does not be allowed' do
         allow_any_instance_of(::SolrDocument).to receive(:private?).and_return(true)
         get :show, exhibit_id: exhibit, id: 'dq287tq6352'
         expect(response).to redirect_to main_app.root_path
-        expect(flash[:alert]).to eq "You are not authorized to access this page."
+        expect(flash[:alert]).to eq 'You are not authorized to access this page.'
       end
     end
 
-    describe "PUT make_public" do
-      it "should not be allowed" do
+    describe 'PUT make_public' do
+      it 'does not be allowed' do
         put :make_public, exhibit_id: exhibit, catalog_id: 'dq287tq6352'
         expect(response).to redirect_to main_app.root_path
-        expect(flash[:alert]).to eq "You are not authorized to access this page."
+        expect(flash[:alert]).to eq 'You are not authorized to access this page.'
       end
-
     end
 
-    describe "DELETE make_private" do
-      it "should not be allowed" do
+    describe 'DELETE make_private' do
+      it 'does not be allowed' do
         delete :make_private, exhibit_id: exhibit, catalog_id: 'dq287tq6352'
         expect(response).to redirect_to main_app.root_path
-        expect(flash[:alert]).to eq "You are not authorized to access this page."
+        expect(flash[:alert]).to eq 'You are not authorized to access this page.'
       end
     end
   end
 
-  describe "when the user is a curator" do
+  describe 'when the user is a curator' do
     before { sign_in FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
 
-    it "should show all the items" do
-      expect(controller).to receive(:add_breadcrumb).with("Home", exhibit_path(exhibit, q: ''))
-      expect(controller).to receive(:add_breadcrumb).with("Curation", exhibit_dashboard_path(exhibit))
-      expect(controller).to receive(:add_breadcrumb).with("Items", admin_exhibit_catalog_index_path(exhibit))
+    it 'shows all the items' do
+      expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
+      expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
+      expect(controller).to receive(:add_breadcrumb).with('Items', admin_exhibit_catalog_index_path(exhibit))
       get :admin, exhibit_id: exhibit
       expect(response).to be_successful
       expect(assigns[:document_list]).to be_a Array
       expect(assigns[:exhibit]).to eq exhibit
-      expect(response).to render_template "spotlight/catalog/admin"
+      expect(response).to render_template 'spotlight/catalog/admin'
       expect(controller.blacklight_config.view.admin_table.document_actions).to be_empty
     end
 
-    it "should use the admin table view and hide the document actions" do
+    it 'uses the admin table view and hide the document actions' do
       get :admin, exhibit_id: exhibit
 
       expect(controller.blacklight_config.view.to_h.keys).to match_array [:admin_table]
       expect(controller.blacklight_config.view.admin_table.document_actions).to be_empty
     end
-    
-    describe "GET new" do
-      it "should be successful" do
-        expect(controller).to receive(:add_breadcrumb).with("Home", exhibit_path(exhibit, q: ''))
-        expect(controller).to receive(:add_breadcrumb).with("Curation", exhibit_dashboard_path(exhibit))
-        expect(controller).to receive(:add_breadcrumb).with("Items", admin_exhibit_catalog_index_path(exhibit))
-        expect(controller).to receive(:add_breadcrumb).with("Import items", new_exhibit_catalog_path(exhibit))
+
+    describe 'GET new' do
+      it 'is successful' do
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_path(exhibit, q: ''))
+        expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Items', admin_exhibit_catalog_index_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Import items', new_exhibit_catalog_path(exhibit))
         get :new, exhibit_id: exhibit
         expect(response).to be_successful
       end
     end
 
-    describe "GET edit" do
-      it "should be successful" do
+    describe 'GET edit' do
+      it 'is successful' do
         get :edit, exhibit_id: exhibit, id: 'dq287tq6352'
         expect(response).to be_successful
         expect(assigns[:exhibit]).to eq exhibit
         expect(assigns[:document]).to be_kind_of SolrDocument
       end
     end
-    describe "PATCH update" do
-      it "should be successful" do
-        expect {
-          patch :update, exhibit_id: exhibit, id: 'dq287tq6352', solr_document: {exhibit_tag_list: 'one, two'}
-        }.to change { exhibit.owned_taggings.count }.by(2)
+    describe 'PATCH update' do
+      it 'is successful' do
+        expect do
+          patch :update, exhibit_id: exhibit, id: 'dq287tq6352', solr_document: { exhibit_tag_list: 'one, two' }
+        end.to change { exhibit.owned_taggings.count }.by(2)
       end
     end
 
-
-    describe "PUT make_public" do
+    describe 'PUT make_public' do
       before do
-        request.env["HTTP_REFERER"] = "where_i_came_from"
+        request.env['HTTP_REFERER'] = 'where_i_came_from'
         allow_any_instance_of(::SolrDocument).to receive(:reindex)
       end
 
-      it "should be successful" do
+      it 'is successful' do
         expect_any_instance_of(::SolrDocument).to receive(:reindex)
         expect_any_instance_of(::SolrDocument).to receive(:make_public!).with(exhibit)
         put :make_public, exhibit_id: exhibit, catalog_id: 'dq287tq6352'
-        expect(response).to redirect_to "where_i_came_from"
+        expect(response).to redirect_to 'where_i_came_from'
       end
-
     end
 
-    describe "DELETE make_private" do
-
+    describe 'DELETE make_private' do
       before do
-        request.env["HTTP_REFERER"] = "where_i_came_from"
+        request.env['HTTP_REFERER'] = 'where_i_came_from'
         allow_any_instance_of(::SolrDocument).to receive(:reindex)
       end
 
-      it "should be successful" do
+      it 'is successful' do
         expect_any_instance_of(::SolrDocument).to receive(:reindex)
         expect_any_instance_of(::SolrDocument).to receive(:make_private!).with(exhibit)
         delete :make_private, exhibit_id: exhibit, catalog_id: 'dq287tq6352'
-        expect(response).to redirect_to "where_i_came_from"
+        expect(response).to redirect_to 'where_i_came_from'
       end
     end
   end
 
-  describe "when the user is a site admin" do
+  describe 'when the user is a site admin' do
     before { sign_in FactoryGirl.create(:site_admin, exhibit: exhibit) }
 
-    describe "show" do
-      it "should have a solr_json serialization" do
+    describe 'show' do
+      it 'has a solr_json serialization' do
         get :show, exhibit_id: exhibit, id: 'dq287tq6352', format: :solr_json
         expect(response).to be_successful
         data = JSON.parse(response.body).with_indifferent_access