blacklight-spotlight 0.12.1 → 0.13.0

data/config/locales/spotlight.en.yml

@@ -311,7 +311,9 @@ en:
     exhibits:
       breadcrumb: Home
       index:
-        private: Private exhibits
+        published: Published exhibits
+        user: Your exhibits
+        unpublished: Unpublished exhibits
       delete:
         heading: Delete exhibit
         warning_html: >
@@ -337,6 +339,7 @@ en:
             label: URL slug
             help_block: A hyphenated name to be displayed in the URL for the exhibit (e.g., "maps-of-africa").
       exhibit_card:
+        unpublished: Unpublished
         visit_exhibit: "Visit exhibit"
       new:
         header: Create a new exhibit

data/lib/spotlight/catalog.rb

@@ -11,17 +11,20 @@ module Spotlight
     include Spotlight::Catalog::AccessControlsEnforcement
 
     included do
-      before_filter do
-        if current_exhibit && can?(:curate, current_exhibit)
-          blacklight_config.add_facet_field 'exhibit_visibility',
-                                            label: I18n.t(:'spotlight.catalog.facets.exhibit_visibility.label'),
-                                            query: {
-                                              private: {
-                                                label: I18n.t(:'spotlight.catalog.facets.exhibit_visibility.private'),
-                                                fq: "#{Spotlight::SolrDocument.visibility_field(current_exhibit)}:false" }
-                                            }
-        end
-      end
+      before_action :add_facet_visibility_field
+    end
+
+    # Adds a facet to display document visibility for the current exhibit
+    # if the user is a curator
+    def add_facet_visibility_field
+      return unless current_exhibit && can?(:curate, current_exhibit)
+      blacklight_config.add_facet_field 'exhibit_visibility',
+                                        label: I18n.t(:'spotlight.catalog.facets.exhibit_visibility.label'),
+                                        query: {
+                                          private: {
+                                            label: I18n.t(:'spotlight.catalog.facets.exhibit_visibility.private'),
+                                            fq: "#{blacklight_config.document_model.visibility_field(current_exhibit)}:false" }
+                                        }
     end
   end
 end

data/lib/spotlight/catalog/access_controls_enforcement.rb

@@ -18,11 +18,12 @@ module Spotlight
           self.default_processor_chain += [:apply_permissive_visibility_filter, :apply_exhibit_resources_filter]
         end
 
+        # Adds a filter that excludes resources that have been marked as not-visible
         def apply_permissive_visibility_filter(solr_params)
           return unless current_exhibit
           return if scope.respond_to?(:can?) && scope.can?(:curate, current_exhibit) && !blacklight_params[:public]
 
-          solr_params.append_filter_query "-#{Spotlight::SolrDocument.visibility_field(current_exhibit)}:false"
+          solr_params.append_filter_query "-#{blacklight_config.document_model.visibility_field(current_exhibit)}:false"
         end
 
         def apply_exhibit_resources_filter(solr_params)

data/lib/spotlight/engine.rb

@@ -83,6 +83,11 @@ module Spotlight
     Spotlight::Engine.config.solr_fields.string_suffix = '_ssim'.freeze
     Spotlight::Engine.config.solr_fields.text_suffix = '_tesim'.freeze
 
+    # A lambda expression that filters the solr index per exhibit
+    config.exhibit_filter = lambda do |exhibit|
+      { :"#{config.solr_fields.prefix}spotlight_exhibit_slug_#{exhibit.slug}#{config.solr_fields.boolean_suffix}" => true }
+    end
+
     Spotlight::Engine.config.resource_global_id_field = :"#{config.solr_fields.prefix}spotlight_resource_id#{config.solr_fields.string_suffix}"
 
     # The solr field that original (largest) images will be stored.

data/lib/spotlight/version.rb

@@ -1,4 +1,4 @@
 #
 module Spotlight
-  VERSION = '0.12.1'
+  VERSION = '0.13.0'
 end

data/spec/controllers/spotlight/about_pages_controller_spec.rb

@@ -9,7 +9,7 @@ describe Spotlight::AboutPagesController, type: :controller do
   describe 'when not logged in' do
     describe 'POST update_all' do
       let(:exhibit) { FactoryGirl.create(:exhibit) }
-      it 'does not be allowed' do
+      it 'is not allowed' do
         post :update_all, exhibit_id: exhibit
         expect(response).to redirect_to main_app.new_user_session_path
       end

data/spec/controllers/spotlight/appearances_controller_spec.rb

@@ -8,16 +8,18 @@ describe Spotlight::AppearancesController, type: :controller do
       sign_in FactoryGirl.create(:exhibit_visitor)
     end
 
-    it 'denies access' do
-      get :edit, exhibit_id: exhibit
-      expect(response).to redirect_to main_app.root_path
-      expect(flash[:alert]).to be_present
+    describe 'GET edit' do
+      it 'denies access' do
+        get :edit, exhibit_id: exhibit
+        expect(response).to redirect_to main_app.root_path
+        expect(flash[:alert]).to be_present
+      end
     end
   end
 
   describe 'when not logged in' do
-    describe '#update' do
-      it 'does not be allowed' do
+    describe 'PATCH update' do
+      it 'is not allowed' do
         patch :update, exhibit_id: exhibit
         expect(response).to redirect_to main_app.new_user_session_path
       end
@@ -28,7 +30,7 @@ describe Spotlight::AppearancesController, type: :controller do
     let(:user) { FactoryGirl.create(:exhibit_admin, exhibit: exhibit) }
     before { sign_in user }
 
-    describe '#edit' do
+    describe 'GET edit' do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
         expect(controller).to receive(:add_breadcrumb).with('Configuration', exhibit_dashboard_path(exhibit))
@@ -39,7 +41,7 @@ describe Spotlight::AppearancesController, type: :controller do
       end
     end
 
-    describe '#update' do
+    describe 'PATCH update' do
       it 'updates the navigation' do
         first_nav = exhibit.main_navigations.first
         last_nav = exhibit.main_navigations.last

data/spec/controllers/spotlight/browse_controller_spec.rb

@@ -11,7 +11,7 @@ describe Spotlight::BrowseController, type: :controller do
 
   describe 'when authenticated as an admin' do
     before { sign_in admin }
-    describe '#index' do
+    describe 'GET 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))
@@ -26,7 +26,7 @@ describe Spotlight::BrowseController, type: :controller do
   end
 
   describe 'when unauthenticated' do
-    describe '#index' do
+    describe 'GET 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))
@@ -39,7 +39,7 @@ describe Spotlight::BrowseController, type: :controller do
       end
     end
 
-    describe '#show' do
+    describe 'GET show' do
       let(:mock_response) { double }
       let(:document_list) { double }
       before do

data/spec/controllers/spotlight/catalog_controller_spec.rb

@@ -17,7 +17,7 @@ describe Spotlight::CatalogController, type: :controller do
     end
 
     describe 'GET edit' do
-      it 'does not be allowed' do
+      it 'is not allowed' do
         get :edit, exhibit_id: exhibit, id: 'dq287tq6352'
         expect(response).to redirect_to main_app.new_user_session_path
       end
@@ -135,7 +135,7 @@ describe Spotlight::CatalogController, type: :controller do
     end
 
     describe 'GET edit' do
-      it 'does not be allowed' do
+      it 'is not 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.'
@@ -143,7 +143,7 @@ describe Spotlight::CatalogController, type: :controller do
     end
 
     describe 'GET show with private item' do
-      it 'does not be allowed' do
+      it 'is not 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
@@ -152,7 +152,7 @@ describe Spotlight::CatalogController, type: :controller do
     end
 
     describe 'PUT make_public' do
-      it 'does not be allowed' do
+      it 'is not 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.'
@@ -160,7 +160,7 @@ describe Spotlight::CatalogController, type: :controller do
     end
 
     describe 'DELETE make_private' do
-      it 'does not be allowed' do
+      it 'is not 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.'
@@ -249,14 +249,14 @@ describe Spotlight::CatalogController, type: :controller do
   describe 'when the user is a site admin' do
     before { sign_in FactoryGirl.create(:site_admin, exhibit: exhibit) }
 
-    describe 'show' do
+    describe 'GET 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
         expect(data).to include id: 'dq287tq6352'
         expect(data).to include exhibit.solr_data
-        expect(data).to include Spotlight::SolrDocument.solr_field_for_tagger(exhibit)
+        expect(data).to include ::SolrDocument.solr_field_for_tagger(exhibit)
       end
     end
   end
@@ -292,4 +292,85 @@ describe Spotlight::CatalogController, type: :controller do
       end
     end
   end
+
+  describe 'next and previous documents' do
+    before do
+      exhibit.searches.first.update(published: true)
+      allow(controller).to receive(:current_search_session).and_return(search)
+      allow(controller).to receive(:search_session).and_return(search_session)
+    end
+
+    let(:search_session) { { 'counter' => 2 } }
+
+    let(:response) { double(total: 5, documents: [first_doc, nil, last_doc]) }
+    let(:first_doc) { double }
+    let(:last_doc) { double }
+
+    context 'when arriving from a browse page' do
+      let(:search) do
+        Search.new(query_params: { action: 'show', controller: 'spotlight/browse', id: exhibit.searches.first.id }.with_indifferent_access)
+      end
+
+      context 'when published' do
+        before do
+          exhibit.searches.first.update(published: true)
+          allow(controller).to receive(:get_previous_and_next_documents_for_search).with(1, exhibit.searches.first.query_params).and_return(response)
+        end
+
+        it 'uses the saved search context' do
+          get :show, exhibit_id: exhibit, id: 'dq287tq6352'
+
+          expect(assigns(:previous_document)).to eq first_doc
+          expect(assigns(:next_document)).to eq last_doc
+        end
+      end
+
+      context 'when arriving from a private browse page' do
+        before do
+          exhibit.searches.first.update(published: false)
+        end
+
+        it 'ignores the search context' do
+          get :show, exhibit_id: exhibit, id: 'dq287tq6352'
+
+          expect(assigns(:previous_document)).to be_nil
+          expect(assigns(:next_document)).to be_nil
+        end
+      end
+    end
+
+    context 'when arriving from a feature page' do
+      let(:page) { FactoryGirl.create(:feature_page, exhibit: exhibit) }
+      let(:search) do
+        Search.new(query_params: { action: 'show', controller: 'spotlight/feature_pages', id: page.id }.with_indifferent_access)
+      end
+
+      context 'when published' do
+        before do
+          page.update(published: true)
+        end
+
+        it 'uses the page context' do
+          pending 'Waiting to figure out how to construct previous/next documents'
+          get :show, exhibit_id: exhibit, id: 'dq287tq6352'
+
+          expect(assigns(:previous_document)).to be_a_kind_of SolrDocument
+          expect(assigns(:next_document)).to be_a_kind_of SolrDocument
+        end
+      end
+
+      context 'when unpublished' do
+        before do
+          page.update(published: false)
+        end
+
+        it 'ignores the search context' do
+          get :show, exhibit_id: exhibit, id: 'dq287tq6352'
+
+          expect(assigns(:previous_document)).to be_nil
+          expect(assigns(:next_document)).to be_nil
+        end
+      end
+    end
+  end
 end

data/spec/controllers/spotlight/confirmations_controller_spec.rb

@@ -7,12 +7,15 @@ describe Spotlight::ConfirmationsController, type: :controller do
     @request.env['devise.mapping'] = Devise.mappings[:contact_email]
     # rubocop:enable RSpec/InstanceVariable
   end
-  it 'has new' do
-    get :new
-    expect(response).to be_successful
+
+  describe 'GET new' do
+    it 'exists' do
+      get :new
+      expect(response).to be_successful
+    end
   end
 
-  describe '#show' do
+  describe 'GET show' do
     let(:exhibit) { FactoryGirl.create(:exhibit) }
     let(:contact_email) { Spotlight::ContactEmail.create!(email: 'justin@example.com', exhibit: exhibit) }
     let(:raw_token) { contact_email.instance_variable_get(:@raw_confirmation_token) }

data/spec/controllers/spotlight/contact_forms_controller_spec.rb

@@ -15,7 +15,7 @@ describe Spotlight::ContactFormsController, type: :controller do
       end
     end
   end
-  describe '#create' do
+  describe 'POST create' do
     it 'redirects back' do
       post :create, exhibit_id: exhibit.id, contact_form: { name: 'Joe Doe', email: 'jdoe@example.com' }
       expect(response).to redirect_to :back

data/spec/controllers/spotlight/exhibits_controller_spec.rb

@@ -13,51 +13,53 @@ describe Spotlight::ExhibitsController, type: :controller do
       sign_in FactoryGirl.create(:exhibit_visitor)
     end
 
-    it 'denies access' do
-      get :edit, id: exhibit
-      expect(response).to redirect_to main_app.root_path
-      expect(flash[:alert]).to be_present
+    describe 'GET edit' do
+      it 'denies access' do
+        get :edit, id: exhibit
+        expect(response).to redirect_to main_app.root_path
+        expect(flash[:alert]).to be_present
+      end
     end
   end
 
   describe 'when not logged in' do
-    describe '#index' do
+    describe 'GET index' do
       it 'is allowed' do
         get :index
         expect(response).to be_success
       end
     end
 
-    describe '#new' do
-      it 'does not be allowed' do
+    describe 'GET new' do
+      it 'is not allowed' do
         get :new, id: exhibit
         expect(response).to redirect_to main_app.new_user_session_path
       end
     end
 
-    describe '#edit' do
-      it 'does not be allowed' do
+    describe 'GET edit' do
+      it 'is not allowed' do
         get :edit, id: exhibit
         expect(response).to redirect_to main_app.new_user_session_path
       end
     end
 
-    describe '#update' do
-      it 'does not be allowed' do
+    describe 'PATCH update' do
+      it 'is not allowed' do
         patch :update, id: exhibit
         expect(response).to redirect_to main_app.new_user_session_path
       end
     end
 
-    describe '#process_import' do
-      it 'does not be allowed' do
+    describe 'PATCH process_import' do
+      it 'is not allowed' do
         patch :process_import, id: exhibit
         expect(response).to redirect_to main_app.new_user_session_path
       end
     end
 
-    describe '#destroy' do
-      it 'does not be allowed' do
+    describe 'DELETE destroy' do
+      it 'is not allowed' do
         delete :destroy, id: exhibit
         expect(response).to redirect_to main_app.new_user_session_path
       end
@@ -68,14 +70,14 @@ describe Spotlight::ExhibitsController, type: :controller do
     let(:user) { FactoryGirl.create(:site_admin) }
     before { sign_in user }
 
-    describe '#new' do
+    describe 'GET new' do
       it 'is successful' do
         get :new
         expect(response).to be_successful
       end
     end
 
-    describe '#create' do
+    describe 'POST create' do
       before do
         # decouple this test from needing solr running
         allow_any_instance_of(Spotlight::Search).to receive(:set_default_featured_image)
@@ -91,6 +93,8 @@ describe Spotlight::ExhibitsController, type: :controller do
 
         expect(exhibit.title).to eq 'Some Title'
         expect(exhibit.slug).to eq 'custom-slug'
+
+        expect(user.exhibits).to include exhibit
       end
     end
   end
@@ -99,14 +103,14 @@ describe Spotlight::ExhibitsController, type: :controller do
     let(:user) { FactoryGirl.create(:exhibit_admin, exhibit: exhibit) }
     before { sign_in user }
 
-    describe '#new' do
-      it 'does not be allowed' do
+    describe 'GET new' do
+      it 'is not allowed' do
         get :new
         expect(response).to_not be_successful
       end
     end
 
-    describe '#process_import' do
+    describe 'PATCH process_import' do
       it 'is successful' do
         expect_any_instance_of(Spotlight::Exhibit).to receive(:reindex_later).and_return(true)
         f = Tempfile.new('foo')
@@ -127,7 +131,7 @@ describe Spotlight::ExhibitsController, type: :controller do
       end
     end
 
-    describe '#edit' do
+    describe 'GET edit' do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
         expect(controller).to receive(:add_breadcrumb).with('Configuration', exhibit_dashboard_path(exhibit))