blacklight-spotlight 0.13.0 → 0.14.0

data/config/routes.rb

@@ -1,6 +1,10 @@
 Spotlight::Engine.routes.draw do
   devise_for :contact_email, class_name: 'Spotlight::ContactEmail', only: [:confirmations]
 
+  get '/edit' => 'sites#edit', as: :edit_site
+  get '/exhibits/edit' => 'sites#edit_exhibits', as: :edit_site_exhibits
+  patch '/edit' => 'sites#update', as: :site
+
   resources :exhibits, path: '/', except: [:show] do
     member do
       get 'exhibit', to: 'exhibits#show', as: 'get'
@@ -45,6 +49,7 @@ Spotlight::Engine.routes.draw do
 
     resources :resources do
       collection do
+        get :monitor
         post :reindex_all
       end
     end

data/db/migrate/20151210073829_create_spotlight_site.rb

@@ -0,0 +1,9 @@
+class CreateSpotlightSite < ActiveRecord::Migration
+  def change
+    create_table :spotlight_sites do |t|
+      t.string :title
+      t.string :subtitle
+      t.references :masthead
+    end
+  end
+end

data/db/migrate/20151211131415_add_site_to_spotlight_exhibits.rb

@@ -0,0 +1,23 @@
+class AddSiteToSpotlightExhibits < ActiveRecord::Migration
+  def up
+    add_column :spotlight_exhibits, :site_id, :integer
+    add_index :spotlight_exhibits, :site_id
+
+    add_default_site_to_exhibits
+  end
+
+  def down
+    remove_column :spotlight_exhibits, :site_id, :integer
+  end
+
+  private
+
+  def add_default_site_to_exhibits
+    Spotlight::Site.reset_column_information
+    Spotlight::Exhibit.reset_column_information
+
+    Spotlight::Exhibit.find_each do |e|
+      e.site = Spotlight::Site.instance
+    end
+  end
+end

data/db/migrate/20151215141516_change_roles_to_support_polymorphic_associations.rb

@@ -0,0 +1,40 @@
+class ChangeRolesToSupportPolymorphicAssociations < ActiveRecord::Migration
+  def up
+    add_column :spotlight_roles, :resource_id, :integer
+    add_column :spotlight_roles, :resource_type, :string
+
+    migrate_role_data_to_polymorphic_resource
+
+    remove_column :spotlight_roles, :exhibit_id
+
+    add_index :spotlight_roles, [:resource_type, :resource_id, :user_id], unique: true, name: 'index_spotlight_roles_on_resource_and_user_id'
+    remove_index :spotlight_roles, [:exhibit_id, :user_id]
+  end
+
+  def down
+    add_column :spotlight_roles, :exhibit_id, :integer
+    add_index(:spotlight_roles, [:exhibit_id])
+
+    Spotlight::Role.reset_column_information
+
+    Spotlight::Role.find_each do |e|
+      e.update(exhibit_id: e.resource_id) if e.exhibit_id.nil? && e.resource_type == 'Spotlight::Exhibit'
+    end
+
+    remove_column :spotlight_roles, :resource_id
+    remove_column :spotlight_roles, :resource_type
+
+    add_index :spotlight_roles, [:exhibit_id, :user_id], unique: true
+    remove_index :spotlight_roles, name: 'index_spotlight_roles_on_resource_and_user_id'
+  end
+
+  private
+
+  def migrate_role_data_to_polymorphic_resource
+    Spotlight::Role.reset_column_information
+
+    Spotlight::Role.find_each do |e|
+      e.update(resource_id: e.exhibit_id, resource_type: 'Spotlight::Exhibit') unless e.resource_id
+    end
+  end
+end

data/db/migrate/20151215192845_add_index_status_to_resources.rb

@@ -0,0 +1,6 @@
+class AddIndexStatusToResources < ActiveRecord::Migration
+  def change
+    add_column :spotlight_resources, :index_status, :integer
+    add_index :spotlight_resources, :index_status
+  end
+end

data/lib/spotlight/controller.rb

@@ -7,7 +7,11 @@ module Spotlight
     include Spotlight::Config
 
     included do
-      helper_method :current_exhibit, :current_masthead, :exhibit_masthead?
+      helper_method :current_site, :current_exhibit, :current_masthead, :exhibit_masthead?, :resource_masthead?
+    end
+
+    def current_site
+      @current_site ||= Spotlight::Site.instance
     end
 
     def current_exhibit
@@ -15,21 +19,28 @@ module Spotlight
     end
 
     def current_masthead
-      @masthead ||= begin
-        current_exhibit.masthead if current_exhibit && current_exhibit.masthead && current_exhibit.masthead.display?
-      end
+      @masthead ||= if resource_masthead?
+                      # TODO: is there a way to get this generically, instead of requiring controllers
+                      #  to override #current_masthead or set it explicitly?. In the meantime, `nil` is
+                      #  hopefully less confusing than a wrong value.
+                      nil
+                    elsif current_exhibit
+                      current_exhibit.masthead if exhibit_masthead?
+                    else
+                      current_site.masthead if current_site.masthead && current_site.masthead.display?
+                    end
     end
 
     def current_masthead=(masthead)
       @masthead = masthead
     end
 
-    def default_masthead?
-      current_exhibit.nil? || current_masthead.nil?
+    def resource_masthead?
+      false
     end
 
     def exhibit_masthead?
-      default_masthead? || current_masthead == current_exhibit.masthead
+      current_exhibit && current_exhibit.masthead && current_exhibit.masthead.display?
     end
 
     # overwrites Blacklight::Controller#blacklight_config

data/lib/spotlight/engine.rb

@@ -59,55 +59,57 @@ module Spotlight
       Spotlight::Engine.config.default_blacklight_config || catalog_controller.blacklight_config
     end
 
-    Spotlight::Engine.config.user_class = '::User'
+    config.user_class = '::User'
 
-    Spotlight::Engine.config.catalog_controller_class = '::CatalogController'
-    Spotlight::Engine.config.default_blacklight_config = nil
+    config.catalog_controller_class = '::CatalogController'
+    config.default_blacklight_config = nil
 
-    Spotlight::Engine.config.exhibit_main_navigation = [:curated_features, :browse, :about]
+    config.exhibit_main_navigation = [:curated_features, :browse, :about]
 
-    Spotlight::Engine.config.resource_providers = []
-    Spotlight::Engine.config.new_resource_partials = [] # e.g. "spotlight/resources/bookmarklet"
-    Spotlight::Engine.config.uploaded_resource_partials = ['spotlight/resources/upload/single_item_form', 'spotlight/resources/upload/multi_item_form']
-    Spotlight::Engine.config.solr_batch_size = 20
+    config.resource_providers = []
+    config.new_resource_partials = [] # e.g. "spotlight/resources/bookmarklet"
+    config.uploaded_resource_partials = ['spotlight/resources/upload/single_item_form', 'spotlight/resources/upload/multi_item_form']
+    config.solr_batch_size = 20
+
+    Spotlight::Engine.config.reindex_progress_window = 10
 
     # Filter resources by exhibit by default
-    Spotlight::Engine.config.filter_resources_by_exhibit = true
+    config.filter_resources_by_exhibit = true
     # The allowed file extensions for uploading non-repository items.
-    Spotlight::Engine.config.allowed_upload_extensions = %w(jpg jpeg png)
+    config.allowed_upload_extensions = %w(jpg jpeg png)
 
     # Suffixes for exhibit-specific solr fields
-    Spotlight::Engine.config.solr_fields = OpenStruct.new
-    Spotlight::Engine.config.solr_fields.prefix = ''.freeze
-    Spotlight::Engine.config.solr_fields.boolean_suffix = '_bsi'.freeze
-    Spotlight::Engine.config.solr_fields.string_suffix = '_ssim'.freeze
-    Spotlight::Engine.config.solr_fields.text_suffix = '_tesim'.freeze
+    config.solr_fields = OpenStruct.new
+    config.solr_fields.prefix = ''.freeze
+    config.solr_fields.boolean_suffix = '_bsi'.freeze
+    config.solr_fields.string_suffix = '_ssim'.freeze
+    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}"
+    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.
-    Spotlight::Engine.config.full_image_field = :full_image_url_ssm
-    Spotlight::Engine.config.thumbnail_field = :thumbnail_url_ssm
-    Spotlight::Engine.config.square_image_field = :thumbnail_square_url_ssm
+    config.full_image_field = :full_image_url_ssm
+    config.thumbnail_field = :thumbnail_url_ssm
+    config.square_image_field = :thumbnail_square_url_ssm
 
     # Defaults to the blacklight_config.index.title_field:
-    Spotlight::Engine.config.upload_title_field = nil # OpenStruct.new(...)
+    config.upload_title_field = nil # OpenStruct.new(...)
 
-    Spotlight::Engine.config.upload_fields = [
+    config.upload_fields = [
       OpenStruct.new(field_name: :spotlight_upload_description_tesim, label: 'Description', form_field_type: :text_area),
       OpenStruct.new(field_name: :spotlight_upload_attribution_tesim, label: 'Attribution'),
       OpenStruct.new(field_name: :spotlight_upload_date_tesim, label: 'Date')
     ]
 
     # Configure the CarrierWave file storage mechanism
-    Spotlight::Engine.config.uploader_storage = :file
-    Spotlight::Engine.config.featured_image_thumb_size = [400, 300]
-    Spotlight::Engine.config.featured_image_square_size = [400, 400]
+    config.uploader_storage = :file
+    config.featured_image_thumb_size = [400, 300]
+    config.featured_image_square_size = [400, 400]
 
     initializer 'spotlight-assets.initialize' do
       Rails.application.config.assets.precompile += %w( Jcrop.gif )
@@ -115,7 +117,7 @@ module Spotlight
 
     # To present curators with analytics reports on the exhibit dashboard, you need to configure
     # an Analytics provider. Google Analytics support is provided out-of-the-box.
-    Spotlight::Engine.config.analytics_provider = nil
+    config.analytics_provider = nil
 
     initializer 'analytics.initialize' do
       Spotlight::Engine.config.analytics_provider = Spotlight::Analytics::Ga
@@ -131,21 +133,21 @@ module Spotlight
     # b) download the pkcs12 key and make it accessible to your application
     # c) in e.g. an initializer, set these configuration values as appropriate
     #    to your OAuth2 service account and analytics property:
-    Spotlight::Engine.config.ga_pkcs12_key_path = nil
-    Spotlight::Engine.config.ga_web_property_id = nil
-    Spotlight::Engine.config.ga_email = nil
-    Spotlight::Engine.config.ga_analytics_options = {}
-    Spotlight::Engine.config.ga_page_analytics_options = Spotlight::Engine.config.ga_analytics_options.merge(limit: 5)
+    config.ga_pkcs12_key_path = nil
+    config.ga_web_property_id = nil
+    config.ga_email = nil
+    config.ga_analytics_options = {}
+    config.ga_page_analytics_options = config.ga_analytics_options.merge(limit: 5)
 
     Blacklight::Engine.config.inject_blacklight_helpers = false
 
     # Query parameters for autocomplete requests
-    Spotlight::Engine.config.autocomplete_search_field = 'autocomplete'
-    Spotlight::Engine.config.default_autocomplete_params = { qf: 'id^1000 full_title_tesim^100 id_ng full_title_ng',
-                                                             facet: false,
-                                                             'facet.field' => [] }
+    config.autocomplete_search_field = 'autocomplete'
+    config.default_autocomplete_params = { qf: 'id^1000 full_title_tesim^100 id_ng full_title_ng',
+                                           facet: false,
+                                           'facet.field' => [] }
 
-    Spotlight::Engine.config.default_browse_index_view_type = :gallery
+    config.default_browse_index_view_type = :gallery
 
     initializer 'blacklight.configuration' do
       # Field containing the last modified date for a Solr document

data/lib/spotlight/version.rb

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

data/spec/controllers/spotlight/contacts_controller_spec.rb

@@ -13,8 +13,8 @@ describe Spotlight::ContactsController, type: :controller do
   end
 
   describe 'when signed in as a curator' do
-    let(:user) { FactoryGirl.create(:exhibit_curator) }
-    let(:exhibit) { user.roles.first.exhibit }
+    let(:user) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
+    let(:exhibit) { FactoryGirl.create(:exhibit) }
     let(:contact) { FactoryGirl.create(:contact, exhibit: exhibit, name: 'Andrew Carnegie') }
     before { sign_in user }
 

data/spec/controllers/spotlight/home_pages_controller_spec.rb

@@ -9,9 +9,8 @@ describe Spotlight::HomePagesController, type: :controller do
   it { is_expected.to be_a Spotlight::Catalog::AccessControlsEnforcement }
 
   describe 'when signed in as a curator' do
-    let(:user) { FactoryGirl.create(:exhibit_curator) }
+    let(:user) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
     before do
-      FactoryGirl.create(:role, exhibit: exhibit, user: user)
       sign_in user
     end
 
@@ -89,8 +88,7 @@ describe Spotlight::HomePagesController, type: :controller do
       end
 
       it 'redirects an authorized user to the signin path' do
-        user = FactoryGirl.create(:exhibit_curator)
-        FactoryGirl.create(:role, exhibit: exhibit, user: user)
+        user = FactoryGirl.create(:exhibit_curator, exhibit: exhibit)
         sign_in user
         get :show, exhibit_id: exhibit
         expect(response).to be_successful

data/spec/controllers/spotlight/resources_controller_spec.rb

@@ -12,6 +12,13 @@ describe Spotlight::ResourcesController, type: :controller do
       end
     end
 
+    describe 'GET monitor' do
+      it 'is not allowed' do
+        get :monitor, exhibit_id: exhibit
+        expect(response).to redirect_to main_app.new_user_session_path
+      end
+    end
+
     describe 'POST create' do
       it 'is not allowed' do
         post :create, exhibit_id: exhibit
@@ -50,6 +57,13 @@ describe Spotlight::ResourcesController, type: :controller do
       end
     end
 
+    describe 'GET monitor' do
+      it 'succesfully renders json' do
+        get :monitor, exhibit_id: exhibit
+        expect(response).to be_success
+      end
+    end
+
     describe 'POST create' do
       let(:blacklight_solr) { double }
       it 'create a resource' do

data/spec/controllers/spotlight/roles_controller_spec.rb

@@ -105,7 +105,7 @@ describe Spotlight::RolesController, type: :controller do
           post :invite, exhibit_id: exhibit, user: 'user@example.com', role: 'curator'
         end.to change { Spotlight::Engine.user_class.count }.by(1)
         expect(Spotlight::Engine.user_class.last.roles.length).to eq 1
-        expect(Spotlight::Engine.user_class.last.roles.first.exhibit).to eq exhibit
+        expect(Spotlight::Engine.user_class.last.roles.first.resource).to eq exhibit
       end
 
       it 'adds the user to the exhibit via a role' do

data/spec/controllers/spotlight/sites_controller_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Spotlight::SitesController, type: :controller do
+  routes { Spotlight::Engine.routes }
+
+  describe 'when user does not have access' do
+    before { sign_in FactoryGirl.create(:exhibit_visitor) }
+    describe 'GET edit' do
+      it 'denies access' do
+        get :edit
+        expect(response).to redirect_to main_app.root_path
+      end
+    end
+  end
+
+  describe 'when user is an admin' do
+    let(:admin) { FactoryGirl.create(:site_admin) }
+    before { sign_in admin }
+
+    describe 'GET edit' do
+      it 'allows access' do
+        get :edit
+        expect(response).to be_successful
+      end
+    end
+
+    describe 'GET edit_exhibits' do
+      it 'allows access' do
+        get :edit_exhibits
+        expect(response).to be_successful
+      end
+    end
+
+    describe 'PATCH update' do
+      let!(:exhibit_a) { FactoryGirl.create(:exhibit) }
+      let!(:exhibit_b) { FactoryGirl.create(:exhibit) }
+
+      it 'changes the exhibit order' do
+        patch :update, site: { exhibits_attributes: [{ id: exhibit_a.id, weight: 5 }, { id: exhibit_b.id, weight: 2 }] }
+
+        expect(response).to redirect_to(exhibits_path)
+
+        expect(Spotlight::Exhibit.all.first).to eq exhibit_b
+        expect(exhibit_a.reload.weight).to eq 5
+      end
+    end
+  end
+end

data/spec/controllers/spotlight/versions_controller_spec.rb

@@ -31,10 +31,9 @@ describe Spotlight::VersionsController, type: :controller do
 
   describe 'when logged in as a curator' do
     let(:exhibit) { FactoryGirl.create(:exhibit) }
-    let(:user) { FactoryGirl.create(:exhibit_curator) }
+    let(:user) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
     let!(:page) { FactoryGirl.create(:feature_page, exhibit: exhibit) }
     before do
-      FactoryGirl.create(:role, exhibit: exhibit, user: user)
       sign_in user
     end
 

data/spec/factories/roles.rb

@@ -1,6 +1,6 @@
 FactoryGirl.define do
   factory :role, class: Spotlight::Role do
-    exhibit
+    resource { FactoryGirl.build(:exhibit) }
     role 'curator'
     user
   end

data/spec/factories/users.rb

@@ -8,18 +8,18 @@ FactoryGirl.define do
 
     factory :site_admin do
       after(:create) do |user, _evaluator|
-        create_list(:role, 1, user: user, exhibit_id: nil, role: 'admin')
+        user.roles.create role: 'admin', resource: Spotlight::Site.instance
       end
     end
 
     factory :exhibit_admin do
       after(:create) do |user, evaluator|
-        create_list(:role, 1, user: user, exhibit: evaluator.exhibit, role: 'admin')
+        user.roles.create role: 'admin', resource: evaluator.exhibit
       end
     end
     factory :exhibit_curator do
       after(:create) do |user, evaluator|
-        create_list(:role, 1, user: user, exhibit: evaluator.exhibit, role: 'curator')
+        user.roles.create role: 'curator', resource: evaluator.exhibit
       end
     end