blacklight-spotlight 3.4.0 → 3.4.1

data/spec/controllers/application_controller_spec.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-describe ApplicationController, type: :controller do
-  routes { Spotlight::Engine.routes }
-  let(:exhibit) { FactoryBot.create(:exhibit) }
-
-  it { is_expected.to be_a_kind_of Spotlight::Controller }
-
-  describe 'exhibit-specific routing' do
-    context 'with a current exhibit' do
-      before do
-        allow(controller).to receive(:current_exhibit).and_return(exhibit)
-      end
-
-      describe '#search_action_url' do
-        it 'is a path within the current exhibit' do
-          expected = { controller: 'spotlight/catalog', action: 'index', exhibit_id: exhibit.slug }
-          expect(get: controller.search_action_url(only_path: true).gsub('/spotlight', '')).to route_to expected
-        end
-      end
-
-      describe '#search_facet_path' do
-        it 'is a path within the current exhibit' do
-          expected = { controller: 'spotlight/catalog', action: 'facet', id: 'some-facet', exhibit_id: exhibit.slug }
-          expect(get: controller.search_facet_path(id: 'some-facet', only_path: true).gsub('/spotlight', '')).to route_to expected
-        end
-      end
-    end
-  end
-end

data/spec/controllers/spotlight/about_pages_controller_spec.rb

@@ -1,239 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::AboutPagesController, type: :controller, versioning: true do
-  routes { Spotlight::Engine.routes }
-  let(:valid_attributes) { { 'title' => 'MyString', thumbnail: { iiif_url: '' } } }
-
-  after do
-    I18n.locale = I18n.default_locale
-  end
-
-  describe 'when not logged in' do
-    let(:exhibit) { FactoryBot.create(:exhibit) }
-
-    describe 'POST update_all' do
-      it 'is not allowed' do
-        post :update_all, params: { exhibit_id: exhibit }
-        expect(response).to redirect_to main_app.new_user_session_path
-      end
-    end
-
-    describe 'GET clone' do
-      let(:page) { FactoryBot.create(:about_page, exhibit: exhibit) }
-
-      it 'is not allowed' do
-        get :clone, params: { exhibit_id: exhibit.id, id: page.id, language: 'es' }
-        expect(flash['alert']).to eq 'You need to sign in or sign up before continuing.'
-        expect(response).to redirect_to main_app.new_user_session_path
-      end
-    end
-  end
-
-  describe 'when signed in as a curator' do
-    let(:exhibit) { FactoryBot.create(:exhibit) }
-    let(:user) { FactoryBot.create(:exhibit_curator, exhibit: exhibit) }
-
-    before { sign_in user }
-
-    describe 'GET show' do
-      let(:page) { FactoryBot.create(:about_page, weight: 0, exhibit: exhibit) }
-      let(:page2) { FactoryBot.create(:about_page, weight: 5, exhibit: exhibit) }
-
-      describe 'on the main about page' do
-        it 'is successful' do
-          expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
-          expect(controller).to receive(:add_breadcrumb).with('About', [a_kind_of(ActionDispatch::Routing::RoutesProxy), exhibit, page])
-          get :show, params: { id: page, exhibit_id: exhibit }
-          expect(assigns(:page)).to eq page
-          expect(assigns(:exhibit)).to eq exhibit
-        end
-      end
-
-      describe 'on a different about page' do
-        it 'is successful' do
-          expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
-          expect(controller).to receive(:add_breadcrumb).with('About', [a_kind_of(ActionDispatch::Routing::RoutesProxy), exhibit, page])
-          expect(controller).to receive(:add_breadcrumb).with(page2.title, [exhibit, page2])
-          get :show, params: { id: page2, exhibit_id: exhibit }
-          expect(assigns(:page)).to eq page2
-          expect(assigns(:exhibit)).to eq exhibit
-        end
-      end
-
-      describe 'under a non-default locale' do
-        let!(:page_es) do
-          FactoryBot.create(
-            :about_page,
-            title: page.title,
-            weight: 0,
-            exhibit: exhibit,
-            locale: 'es',
-            default_locale_page: page
-          )
-        end
-
-        it 'renders the locale specific page' do
-          get :show, params: { exhibit_id: exhibit.id, id: page.slug, locale: 'es' }
-
-          expect(assigns[:page]).to eq page_es
-        end
-      end
-
-      describe 'when "switching" locales for pages that have updated their title/slug' do
-        let(:page) { FactoryBot.create(:about_page, exhibit: exhibit) }
-        let!(:page_es) do
-          FactoryBot.create(
-            :about_page,
-            exhibit: exhibit,
-            title: 'Page in spanish',
-            locale: 'es',
-            default_locale_page: page
-          )
-        end
-
-        it 'redirects from the spanish slug to the english page when the english locale is selected' do
-          expect(page_es.slug).not_to eq page.slug # Ensure the slugs are different
-          get :show, params: { exhibit_id: exhibit.id, id: page_es.slug, locale: 'en' }
-          expect(response).to redirect_to(exhibit_about_page_path(exhibit, page))
-        end
-
-        it 'redirects from the english slug to the spanish page when the spanish locale is selected' do
-          expect(page_es.slug).not_to eq page.slug # Ensure the slugs are different
-          get :show, params: { exhibit_id: exhibit.id, id: page.slug, locale: 'es' }
-          expect(response).to redirect_to(exhibit_about_page_path(exhibit, page_es))
-        end
-      end
-    end
-
-    describe 'GET edit' do
-      let!(:page) { FactoryBot.create(:about_page, weight: 0, exhibit: exhibit) }
-      let!(:page2) { FactoryBot.create(:about_page, weight: 5, exhibit: exhibit) }
-
-      describe 'on the main about page' do
-        it 'is successful' do
-          expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
-          expect(controller).to receive(:add_breadcrumb).with('About pages', exhibit_about_pages_path(exhibit))
-          get :edit, params: { id: page, exhibit_id: exhibit }
-          expect(assigns(:page)).to eq page
-          expect(assigns(:exhibit)).to eq exhibit
-        end
-      end
-
-      describe 'on a different about page' do
-        it 'is successful' do
-          expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
-          expect(controller).to receive(:add_breadcrumb).with('About pages', exhibit_about_pages_path(exhibit))
-          expect(controller).to receive(:add_breadcrumb).with(page2.title, [:edit, exhibit, page2])
-          get :edit, params: { id: page2, exhibit_id: exhibit }
-          expect(assigns(:page)).to eq page2
-          expect(assigns(:exhibit)).to eq exhibit
-        end
-      end
-    end
-
-    describe 'GET index' do
-      let!(:page) { FactoryBot.create(:about_page, exhibit: exhibit) }
-
-      it 'is successful' do
-        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit_root_path(exhibit))
-        expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
-        expect(controller).to receive(:add_breadcrumb).with('About pages', exhibit_about_pages_path(exhibit))
-        get :index, params: { exhibit_id: exhibit }
-        expect(assigns(:page)).to be_kind_of Spotlight::Page
-        expect(assigns(:page)).to be_new_record
-        expect(assigns(:pages)).to include page
-        expect(assigns(:exhibit)).to eq exhibit
-      end
-    end
-
-    describe 'POST create' do
-      it 'redirects to the about page index' do
-        post :create, params: { about_page: { title: 'MyString' }, exhibit_id: exhibit }
-        expect(response).to redirect_to(exhibit_about_pages_path(exhibit))
-      end
-    end
-
-    describe 'PUT update' do
-      let!(:page) { FactoryBot.create(:about_page, exhibit: exhibit) }
-
-      it 'redirects to the about page' do
-        put :update, params: { id: page, exhibit_id: page.exhibit.id, about_page: valid_attributes }
-        page.reload
-        expect(response).to redirect_to(exhibit_about_page_path(page.exhibit, page))
-        expect(flash[:notice]).to have_link 'Undo changes'
-      end
-    end
-
-    describe 'POST update_all' do
-      let!(:page1) { FactoryBot.create(:about_page, exhibit: exhibit) }
-      let!(:page2) { FactoryBot.create(:about_page, exhibit: exhibit, published: true) }
-      let!(:page3) { FactoryBot.create(:about_page, exhibit: exhibit, published: true) }
-
-      it 'updates whether they are on the landing page' do
-        post :update_all, params: {
-          exhibit_id: page1.exhibit,
-          exhibit: {
-            about_pages_attributes: [
-              { id: page1.id, published: true, title: 'This is a new title!' },
-              { id: page2.id, published: false }
-            ]
-          }
-        }
-        expect(response).to redirect_to end_with('/dashboard')
-        expect(flash[:notice]).to eq 'About pages were successfully updated.'
-        expect(page1.reload.published).to be_truthy
-        expect(page1.title).to eq 'This is a new title!'
-        expect(page2.reload.published).to be_falsey
-        expect(page3.reload.published).to be_truthy # should remain untouched since it wasn't in present[]
-      end
-    end
-
-    describe 'PATCH update_contacts' do
-      let!(:contact1) { FactoryBot.create(:contact, name: 'Aphra Behn', exhibit: exhibit) }
-      let!(:contact2) { FactoryBot.create(:contact, exhibit: exhibit) }
-
-      it 'updates contacts' do
-        patch :update_contacts, params: {
-          exhibit_id: exhibit,
-          exhibit: {
-            contacts_attributes: [
-              { 'show_in_sidebar' => '1', 'id' => contact1.id, weight: 1 },
-              { 'show_in_sidebar' => '0', 'id' => contact2.id, weight: 2 }
-            ]
-          }
-        }
-        expect(response).to redirect_to exhibit_about_pages_path(exhibit)
-        expect(flash[:notice]).to eq 'Contacts were successfully updated.'
-        expect(exhibit.contacts.size).to eq 2
-        expect(exhibit.contacts.published.map(&:name)).to eq ['Aphra Behn']
-        expect(contact1.reload.weight).to eq 1
-        expect(contact2.reload.weight).to eq 2
-      end
-
-      it 'shows index on failure' do
-        expect_any_instance_of(Spotlight::Exhibit).to receive(:update).and_return(false)
-        patch :update_contacts, params: {
-          exhibit_id: exhibit,
-          exhibit: { contacts_attributes: [
-            { 'show_in_sidebar' => '1', 'name' => 'Justin Coyne', 'email' => 'jcoyne@justincoyne.com', 'title' => '', 'location' => 'US' },
-            { 'show_in_sidebar' => '0', 'name' => '', 'email' => '', 'title' => '', 'location' => '' },
-            { 'show_in_sidebar' => '0', 'name' => '', 'email' => '', 'title' => 'Librarian', 'location' => '' }
-          ] }
-        }
-        expect(response).to render_template('index')
-      end
-    end
-
-    describe 'GET clone' do
-      let(:page) { FactoryBot.create(:about_page, exhibit: exhibit) }
-
-      it 'calls the CloneTranslatedPageFromLocale service' do
-        expect(
-          Spotlight::CloneTranslatedPageFromLocale
-        ).to receive(:call).with(locale: 'es', page: page).and_call_original
-
-        get :clone, params: { exhibit_id: exhibit.id, id: page.id, language: 'es' }
-      end
-    end
-  end
-end

data/spec/controllers/spotlight/admin_users_controller_spec.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Spotlight::AdminUsersController, type: :controller do
-  routes { Spotlight::Engine.routes }
-
-  before { sign_in(user) }
-
-  context 'by a non-admin' do
-    let(:user) { FactoryBot.create(:exhibit_visitor) }
-
-    it 'redirects with an error message' do
-      get :index
-      expect(response).to redirect_to '/'
-      expect(flash[:alert]).to eq 'You are not authorized to access this page.'
-    end
-  end
-
-  context 'by an admin user' do
-    before { request.env['HTTP_REFERER'] = 'http://example.com' }
-
-    let(:user) { FactoryBot.create(:site_admin) }
-
-    describe 'GET index' do
-      it 'is successful' do
-        get :index
-        expect(response).to be_successful
-      end
-    end
-
-    describe 'DELETE destroy' do
-      let(:user) { FactoryBot.create(:user) }
-      let!(:admin_role) { FactoryBot.create(:role, role: 'admin', user: user, resource: Spotlight::Site.instance) }
-
-      it 'removes the site admin role from the given user' do
-        delete :destroy, params: { id: user.id }
-        expect(response).to redirect_to(admin_users_path)
-        expect(flash[:notice]).to eq 'User removed from site adminstrator role'
-        expect(Spotlight::Site.instance.roles.where(user_id: user.id)).to be_none
-      end
-    end
-
-    describe 'PATCH update' do
-      let(:non_admin) { FactoryBot.create(:exhibit_visitor) }
-
-      it 'adds the site admin role to the given user' do
-        patch :update, params: { id: non_admin.id }
-        expect(response).to redirect_to(admin_users_path)
-        expect(flash[:notice]).to eq 'Added user as an adminstrator'
-        expect(non_admin.roles.map(&:role)).to eq ['admin']
-      end
-    end
-  end
-end

data/spec/controllers/spotlight/appearances_controller_spec.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::AppearancesController, type: :controller do
-  routes { Spotlight::Engine.routes }
-  let(:exhibit) { FactoryBot.create(:exhibit) }
-
-  describe 'when the user is not authorized' do
-    before do
-      sign_in FactoryBot.create(:exhibit_visitor)
-    end
-
-    describe 'GET edit' do
-      it 'denies access' do
-        get :edit, params: { 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 'PATCH update' do
-      it 'is not allowed' do
-        patch :update, params: { exhibit_id: exhibit }
-        expect(response).to redirect_to main_app.new_user_session_path
-      end
-    end
-  end
-
-  describe 'when signed in' do
-    let(:user) { FactoryBot.create(:exhibit_admin, exhibit: exhibit) }
-
-    before { sign_in user }
-
-    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))
-        expect(controller).to receive(:add_breadcrumb).with('Appearance', edit_exhibit_appearance_path(exhibit))
-        get :edit, params: { exhibit_id: exhibit }
-        expect(response).to be_successful
-        expect(assigns[:exhibit]).to be_kind_of Spotlight::Exhibit
-      end
-    end
-
-    describe 'PATCH update' do
-      let(:first_nav) { exhibit.main_navigations.first }
-      let(:last_nav) { exhibit.main_navigations.last }
-      let(:submitted) do
-        {
-          exhibit_id: exhibit,
-          exhibit: {
-            masthead_attributes: {
-              iiif_tilesource: 'http://test.host/1/foo',
-              iiif_region: '0,0,2000,200'
-            },
-            thumbnail_attributes: {
-              iiif_tilesource: 'http://test.host/2/foo',
-              iiif_region: '0,0,600,600'
-            },
-            main_navigations_attributes: main_navigation_attributes
-          }
-        }
-      end
-      let(:main_navigation_attributes) do
-        {
-          0 => { id: first_nav.id, label: 'Some Label', weight: 500 },
-          1 => { id: last_nav.id, display: false }
-        }
-      end
-
-      it 'updates the navigation' do
-        patch :update, params: submitted
-        expect(flash[:notice]).to eq 'The exhibit was successfully updated.'
-        expect(response).to redirect_to edit_exhibit_appearance_path(exhibit)
-        assigns[:exhibit].tap do |saved|
-          expect(saved.main_navigations.find(first_nav.id).label).to eq 'Some Label'
-          expect(saved.main_navigations.find(first_nav.id).weight).to eq 500
-          expect(saved.main_navigations.find(last_nav.id)).not_to be_displayable
-          expect(saved.masthead.iiif_tilesource).to eq 'http://test.host/1/foo'
-          expect(saved.thumbnail.iiif_region).to eq '0,0,600,600'
-          expect(saved.masthead.iiif_url).to eq 'http://test.host/1/foo/0,0,2000,200/1800,180/0/default.jpg'
-          expect(saved.thumbnail.iiif_url).to eq 'http://test.host/2/foo/0,0,600,600/400,400/0/default.jpg'
-        end
-      end
-    end
-  end
-end

data/spec/controllers/spotlight/application_controller_spec.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::ApplicationController, type: :controller do
-  routes { Spotlight::Engine.routes }
-  let(:exhibit) { FactoryBot.create(:exhibit) }
-
-  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 search_exhibit_catalog_url(exhibit, q: 'query')
-  end
-end

data/spec/controllers/spotlight/attachments_controller_spec.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::AttachmentsController, type: :controller do
-  routes { Spotlight::Engine.routes }
-  let(:exhibit) { FactoryBot.create(:exhibit) }
-
-  describe 'when not logged in' do
-    describe 'GET edit' do
-      it 'is successful' do
-        post :create, params: { 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
-    let(:user) { FactoryBot.create(:exhibit_curator, exhibit: exhibit) }
-
-    before { sign_in user }
-
-    describe 'POST create' do
-      it 'is successful' do
-        post :create, params: { exhibit_id: exhibit, attachment: { name: 'xyz' } }
-        expect(response).to be_successful
-      end
-    end
-  end
-end

data/spec/controllers/spotlight/browse_controller_spec.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-describe Spotlight::BrowseController, type: :controller do
-  routes { Spotlight::Engine.routes }
-  let(:exhibit) { FactoryBot.create(:exhibit) }
-  let!(:search) { FactoryBot.create(:published_search, exhibit: exhibit) }
-  let(:group) { FactoryBot.create(:group, published: true, title: 'Good group', exhibit: exhibit, searches: [search]) }
-  let(:group_unpublished) { FactoryBot.create(:group, title: 'Secret group', exhibit: exhibit, searches: [search]) }
-  let!(:unpublished) { FactoryBot.create(:search, exhibit: exhibit) }
-  let(:admin) { FactoryBot.create(:site_admin) }
-
-  describe 'protected methods' do
-    it 'uses the blacklight.browse configuration for the document actions when additional configuration layers are not defined' do
-      expect(controller).to receive(:view_available?).and_return true
-      expect(controller.send(:document_index_view_type)).to equal :gallery
-    end
-
-    it 'uses the blacklight_config view configuration when there are no params' do
-      allow(controller).to receive(:current_exhibit).and_return exhibit
-      expect(controller).to receive(:view_available?).and_return false
-      expect(controller.send(:document_index_view_type)).to equal :list
-    end
-
-    it 'returns document_index_view_type from a search object' do
-      allow(controller).to receive(:current_exhibit).and_return exhibit
-      expect(controller).to receive(:view_available?).and_return true
-      search.default_index_view_type = 'gallery'
-      controller.instance_variable_set(:@search, search)
-      expect(controller.send(:default_document_index_view_type)).to equal :gallery
-    end
-
-    it 'returns default_document_index_view_type from super when there is no view available' do
-      allow(controller).to receive(:current_exhibit).and_return exhibit
-      expect(controller).to receive(:view_available?).and_return false
-      expect(controller.send(:default_document_index_view_type)).to equal :list
-    end
-
-    it 'returns the default_browse_index_view_type from exhibit configuration' do
-      allow(controller).to receive(:current_exhibit).and_return exhibit
-      expect(controller.send(:default_browse_index_view_type)).to equal :gallery
-    end
-  end
-
-  describe 'when authenticated as an admin' do
-    before { sign_in admin }
-
-    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))
-        get :index, params: { exhibit_id: exhibit }
-        expect(response).to be_successful
-        expect(assigns[:searches]).to eq [search]
-        expect(assigns[:searches]).not_to include unpublished
-        expect(assigns[:exhibit]).to eq exhibit
-        expect(response).to render_template 'spotlight/browse/index'
-      end
-
-      it 'includes the browse groups' 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('Good group', exhibit_browse_groups_path(exhibit, group))
-        get :index, params: { exhibit_id: exhibit, group_id: group.id }
-        expect(response).to be_successful
-        expect(assigns[:groups]).to eq [group]
-        expect(response).to render_template 'spotlight/browse/index'
-      end
-    end
-  end
-
-  describe 'when unauthenticated' 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))
-        get :index, params: { exhibit_id: exhibit }
-        expect(response).to be_successful
-        expect(assigns[:searches]).to eq [search]
-        expect(assigns[:searches]).not_to include unpublished
-        expect(assigns[:exhibit]).to eq exhibit
-        expect(response).to render_template 'spotlight/browse/index'
-      end
-    end
-
-    describe 'GET show' do
-      let(:mock_response) { double aggregations: {} }
-      let(:document_list) { double }
-
-      before do
-        allow(controller).to receive_messages(search_service: double(search_results: [mock_response, document_list]))
-      end
-
-      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, params: { 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'
-      end
-
-      it 'includes the browse group when a group_id is provided' 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('Good group', exhibit_browse_groups_path(exhibit, group))
-        expect(controller).to receive(:add_breadcrumb).with(search.title, exhibit_browse_group_path(exhibit, group, search))
-        get :show, params: { id: search, exhibit_id: exhibit, group_id: group.id }
-        expect(response).to be_successful
-        expect(assigns[:group]).to eq group
-        expect(response).to render_template 'spotlight/browse/show'
-      end
-
-      it 'removes all the document actions' do
-        get :show, params: { id: search, exhibit_id: exhibit }
-        expect(controller.blacklight_config.index.document_actions).to be_blank
-      end
-
-      it 'uses the blacklight.browse configuration for the document actions' do
-        config = Blacklight::Configuration.new do |c|
-          c.browse.document_actions = %i[a b c]
-        end
-
-        allow(controller).to receive(:blacklight_config).and_return(config)
-
-        get :show, params: { id: search, exhibit_id: exhibit }
-        expect(controller.blacklight_config.index.document_actions).to match_array %i[a b c]
-      end
-    end
-  end
-end