blacklight-spotlight 0.8.2 → 0.9.0

data/lib/spotlight/engine.rb

@@ -39,6 +39,10 @@ module Spotlight
       OEmbed::Providers.register_all
     end
 
+    initializer 'spotlight.factories', after: 'factory_girl.set_factory_paths' do
+      FactoryGirl.definition_file_paths << File.expand_path('../../../spec/factories', __FILE__) if defined?(FactoryGirl)
+    end
+
     def self.catalog_controller
       Spotlight::Engine.config.catalog_controller_class.constantize
     end

data/lib/spotlight/version.rb

@@ -1,4 +1,4 @@
 #
 module Spotlight
-  VERSION = '0.8.2'
+  VERSION = '0.9.0'
 end

data/spec/controllers/spotlight/appearances_controller_spec.rb

@@ -31,7 +31,7 @@ describe Spotlight::AppearancesController, type: :controller do
     describe '#edit' do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
-        expect(controller).to receive(:add_breadcrumb).with('Administration', exhibit_dashboard_path(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, exhibit_id: exhibit
         expect(response).to be_successful

data/spec/controllers/spotlight/custom_fields_controller_spec.rb

@@ -3,14 +3,14 @@ describe Spotlight::CustomFieldsController, type: :controller do
   routes { Spotlight::Engine.routes }
   let(:exhibit) { FactoryGirl.create(:exhibit) }
 
-  describe 'when signed in as a curator' do
-    let(:user) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
+  describe 'when signed in as an exhibit admin' do
+    let(:user) { FactoryGirl.create(:exhibit_admin, exhibit: exhibit) }
     before { sign_in user }
 
     describe 'GET new' do
       it 'assigns a new custom field' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
-        expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Configuration', exhibit_dashboard_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with('Metadata', edit_exhibit_metadata_configuration_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with('Add new field', new_exhibit_custom_field_path(exhibit))
         get :new, exhibit_id: exhibit
@@ -22,7 +22,7 @@ describe Spotlight::CustomFieldsController, type: :controller do
       let(:field) { FactoryGirl.create(:custom_field, exhibit: exhibit) }
       it 'assigns the requested custom_field' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
-        expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Configuration', exhibit_dashboard_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with('Metadata', edit_exhibit_metadata_configuration_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with(field.label, edit_exhibit_custom_field_path(exhibit, field))
         get :edit, exhibit_id: exhibit, id: field

data/spec/controllers/spotlight/dashboards_controller_spec.rb

@@ -26,6 +26,16 @@ describe Spotlight::DashboardsController, type: :controller do
         expect(assigns[:solr_documents]).to have(1).item
       end
     end
+
+    describe 'GET analytics' do
+      it 'loads the exhibit' do
+        expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
+        expect(controller).to receive(:add_breadcrumb).with('Analytics', analytics_exhibit_dashboard_path(exhibit))
+        get :analytics, exhibit_id: exhibit.id
+        expect(response).to render_template 'spotlight/dashboards/analytics'
+        expect(assigns[:exhibit]).to eq exhibit
+      end
+    end
   end
 
   describe 'when user does not have access' do
@@ -34,6 +44,11 @@ describe Spotlight::DashboardsController, type: :controller do
       get :show, exhibit_id: exhibit.id
       expect(response).to redirect_to main_app.root_path
     end
+
+    it 'does not allow analytics' do
+      get :analytics, exhibit_id: exhibit.id
+      expect(response).to redirect_to main_app.root_path
+    end
   end
 
   describe 'when not logged in' do

data/spec/controllers/spotlight/exhibits_controller_spec.rb

@@ -126,8 +126,8 @@ describe Spotlight::ExhibitsController, type: :controller do
     describe '#edit' do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
-        expect(controller).to receive(:add_breadcrumb).with('Administration', exhibit_dashboard_path(exhibit))
-        expect(controller).to receive(:add_breadcrumb).with('Settings', edit_exhibit_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Configuration', exhibit_dashboard_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('General', edit_exhibit_path(exhibit))
         get :edit, id: exhibit
         expect(response).to be_successful
       end

data/spec/controllers/spotlight/metadata_configurations_controller_spec.rb

@@ -44,7 +44,7 @@ describe Spotlight::MetadataConfigurationsController, type: :controller do
     describe '#edit' do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
-        expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Configuration', exhibit_dashboard_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with('Metadata', edit_exhibit_metadata_configuration_path(exhibit))
         get :edit, exhibit_id: exhibit
         expect(response).to be_successful

data/spec/controllers/spotlight/roles_controller_spec.rb

@@ -18,7 +18,7 @@ describe Spotlight::RolesController, type: :controller do
     before { sign_in admin }
     it 'allows index' do
       expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
-      expect(controller).to receive(:add_breadcrumb).with('Administration', exhibit_dashboard_path(exhibit))
+      expect(controller).to receive(:add_breadcrumb).with('Configuration', exhibit_dashboard_path(exhibit))
       expect(controller).to receive(:add_breadcrumb).with('Users', exhibit_roles_path(exhibit))
       get :index, exhibit_id: exhibit
       expect(response).to be_successful

data/spec/controllers/spotlight/search_configurations_controller_spec.rb

@@ -38,7 +38,7 @@ describe Spotlight::SearchConfigurationsController, type: :controller do
     describe '#edit' do
       it 'is successful' do
         expect(controller).to receive(:add_breadcrumb).with('Home', exhibit)
-        expect(controller).to receive(:add_breadcrumb).with('Curation', exhibit_dashboard_path(exhibit))
+        expect(controller).to receive(:add_breadcrumb).with('Configuration', exhibit_dashboard_path(exhibit))
         expect(controller).to receive(:add_breadcrumb).with('Search', edit_exhibit_search_configuration_path(exhibit))
         get :edit, exhibit_id: exhibit
         expect(response).to be_successful
@@ -101,7 +101,7 @@ describe Spotlight::SearchConfigurationsController, type: :controller do
         expect(response).to redirect_to edit_exhibit_search_configuration_path(exhibit)
         assigns[:exhibit].tap do |saved|
           expect(saved.blacklight_configuration.search_fields).to eq(
-            'all_fields' => { 'label' => 'All fields', 'enabled' => true },
+            'all_fields' => { 'label' => 'Everything', 'enabled' => true },
             'title' => { 'label' => 'Title', 'enabled' => false },
             'author' => { 'label' => 'Primary Author', 'enabled' => true }
           )

data/spec/features/create_exhibit_spec.rb

@@ -12,7 +12,7 @@ describe 'Create a new exhibit', type: :feature do
     within '.dropdown-menu' do
       click_link 'Create Exhibit'
     end
-    expect(page).to have_selector 'h1', text: 'Administration'
+    expect(page).to have_selector 'h1', text: 'Configuration'
     expect(page).to have_selector 'h1 small', text: 'Create a new exhibit'
   end
 

data/spec/features/edit_search_fields_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe 'Search Administration', type: :feature do
   let(:exhibit) { FactoryGirl.create(:exhibit) }
-  let(:exhibit_curator) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
-  before { login_as exhibit_curator }
+  let(:exhibit_admin) { FactoryGirl.create(:exhibit_admin, exhibit: exhibit) }
+  before { login_as exhibit_admin }
 
   describe 'edit' do
     it 'displays the search configuration edit screen' do
@@ -13,7 +13,7 @@ describe 'Search Administration', type: :feature do
 
     it 'has breadcrumbs' do
       visit spotlight.edit_exhibit_search_configuration_path exhibit
-      expect(page).to have_breadcrumbs 'Home', 'Curation', 'Search'
+      expect(page).to have_breadcrumbs 'Home', 'Configuration', 'Search'
     end
 
     describe 'facets' do
@@ -29,7 +29,7 @@ describe 'Search Administration', type: :feature do
       it 'allows curators to select and unselect facets for display' do
         visit spotlight.edit_exhibit_search_configuration_path exhibit
 
-        expect(page).to have_content 'Curation Search Options Facets'
+        expect(page).to have_content 'Configuration Search Options Facets'
         expect(page).to have_button 'Save'
 
         uncheck 'blacklight_configuration_facet_fields_language_ssim_show' # Language

data/spec/features/exhibits/administration_spec.rb

@@ -12,7 +12,7 @@ describe 'Exhibit Administration', type: :feature do
   describe 'Contact Emails' do
     it 'has breadcrumbs' do
       visit spotlight.edit_exhibit_path(exhibit)
-      expect(page).to have_breadcrumbs 'Home', 'Administration', 'Settings'
+      expect(page).to have_breadcrumbs 'Home', 'Configuration', 'General'
     end
 
     it 'has a blank input field when there are no contacts yet' do

data/spec/features/exhibits/custom_metadata_fields_spec.rb

@@ -48,7 +48,7 @@ describe 'Adding custom metadata fields', type: :feature do
   it 'has breadcrumbs' do
     visit spotlight.edit_exhibit_metadata_configuration_path exhibit
     click_on 'Add new field'
-    expect(page).to have_breadcrumbs 'Home', 'Curation', 'Metadata', 'Add new field'
+    expect(page).to have_breadcrumbs 'Home', 'Configuration', 'Metadata', 'Add new field'
   end
 
   it 'lets the curator choose the type of field on create' do

data/spec/features/exhibits/edit_metadata_fields_spec.rb

@@ -43,6 +43,6 @@ describe 'Editing metadata fields', type: :feature do
   it 'has breadcrumbs' do
     visit spotlight.edit_exhibit_metadata_configuration_path exhibit
 
-    expect(page).to have_breadcrumbs 'Home', 'Curation', 'Metadata'
+    expect(page).to have_breadcrumbs 'Home', 'Configuration', 'Metadata'
   end
 end

data/spec/features/import_exhibit_spec.rb

@@ -17,7 +17,7 @@ the export option behind a bootstrap tab)))
       click_link 'Dashboard'
     end
 
-    click_link 'Settings'
+    click_link 'General'
     within('.nav-tabs') do
       click_link 'Export data'
     end
@@ -38,7 +38,7 @@ the export option behind a bootstrap tab)))
       click_link 'Dashboard'
     end
 
-    click_link 'Settings'
+    click_link 'General'
 
     within('.nav-tabs') do
       click_link 'Import data'

data/spec/features/javascript/search_config_admin_spec.rb

@@ -2,15 +2,15 @@ require 'spec_helper'
 
 feature 'Search Configuration Administration', js: true do
   let(:exhibit) { FactoryGirl.create(:exhibit) }
-  let(:exhibit_curator) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
-  before { login_as exhibit_curator }
+  let(:user) { FactoryGirl.create(:exhibit_admin, exhibit: exhibit) }
+  before { login_as user }
 
   describe 'search fields' do
     it 'allows the curator to disable all search fields' do
       visit spotlight.exhibit_home_page_path(exhibit, exhibit.home_page)
       expect(page).to have_css 'select#search_field'
 
-      click_link exhibit_curator.email
+      click_link user.email
       within '#user-util-collapse .dropdown' do
         click_link 'Dashboard'
       end
@@ -28,7 +28,7 @@ feature 'Search Configuration Administration', js: true do
 
     it 'allows the curator to update search field options' do
       visit spotlight.exhibit_home_page_path(exhibit, exhibit.home_page)
-      click_link exhibit_curator.email
+      click_link user.email
       within '#user-util-collapse .dropdown' do
         click_link 'Dashboard'
       end
@@ -56,7 +56,7 @@ feature 'Search Configuration Administration', js: true do
     it 'allows us to update the label with edit-in-place' do
       input_id = 'blacklight_configuration_facet_fields_genre_ssim_label'
       visit spotlight.exhibit_home_page_path(exhibit, exhibit.home_page)
-      click_link exhibit_curator.email
+      click_link user.email
       within '#user-util-collapse .dropdown' do
         click_link 'Dashboard'
       end
@@ -87,7 +87,7 @@ feature 'Search Configuration Administration', js: true do
   describe 'results' do
     it 'updates search result options' do
       visit spotlight.exhibit_home_page_path(exhibit, exhibit.home_page)
-      click_link exhibit_curator.email
+      click_link user.email
       within '#user-util-collapse .dropdown' do
         click_link 'Dashboard'
       end
@@ -113,7 +113,7 @@ feature 'Search Configuration Administration', js: true do
     end
     it 'updates Sort field result options' do
       visit spotlight.exhibit_home_page_path(exhibit, exhibit.home_page)
-      click_link exhibit_curator.email
+      click_link user.email
       within '#user-util-collapse .dropdown' do
         click_link 'Dashboard'
       end

data/spec/features/metadata_admin_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe 'Metadata Administration', type: :feature do
   let(:exhibit) { FactoryGirl.create(:exhibit) }
-  let(:exhibit_curator) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
-  before { login_as exhibit_curator }
+  let(:user) { FactoryGirl.create(:exhibit_admin, exhibit: exhibit) }
+  before { login_as user }
 
   describe 'edit' do
     it 'displays the metadata edit page' do

data/spec/helpers/spotlight/title_helper_spec.rb

@@ -40,10 +40,10 @@ describe Spotlight::TitleHelper, type: :helper do
     end
   end
 
-  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'
+  describe '#configuration_page_title' do
+    it 'renders a page title in the configuration section' do
+      title = helper.configuration_page_title 'Some title'
+      expect(title).to have_selector 'h1', text: 'Configuration'
       expect(title).to have_selector 'h1 small', text: 'Some title'
     end
   end

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

@@ -46,7 +46,7 @@ describe Spotlight::Catalog::AccessControlsEnforcement do
 
       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_#{exhibit.slug}_public_bsi:false"
     end
 
     it 'does not filter resources to just those created by the exhibit' do

data/spec/models/solr_document_spec.rb

@@ -80,13 +80,13 @@ describe SolrDocument, type: :model do
     it 'includes exhibit-specific tags' do
       exhibit.tag(subject, with: 'paris', on: :tags)
 
-      expect(subject.to_solr).to include :exhibit_1_tags_ssim
-      expect(subject.to_solr[:exhibit_1_tags_ssim]).to include 'paris'
+      expect(subject.to_solr).to include :"exhibit_#{exhibit.slug}_tags_ssim"
+      expect(subject.to_solr[:"exhibit_#{exhibit.slug}_tags_ssim"]).to include 'paris'
     end
 
     it "includes placeholders for all exhibits' tags" do
-      expect(subject.to_solr).to include :exhibit_1_tags_ssim
-      expect(subject.to_solr[:exhibit_1_tags_ssim]).to eq nil
+      expect(subject.to_solr).to include :"exhibit_#{exhibit.slug}_tags_ssim"
+      expect(subject.to_solr[:"exhibit_#{exhibit.slug}_tags_ssim"]).to eq nil
     end
 
     it 'includes sidecar fields' do
@@ -151,4 +151,29 @@ describe SolrDocument, type: :model do
       end
     end
   end
+
+  describe '.find_each' do
+    it 'enumerates the documents in the exhibit' do
+      expect(described_class.find_each).to be_a Enumerable
+    end
+
+    it 'pages through the index' do
+      allow_any_instance_of(Blacklight::Solr::Repository).to receive(:search).with(hash_including(start: 0)).and_return(double(documents: [1, 2, 3]))
+      allow_any_instance_of(Blacklight::Solr::Repository).to receive(:search).with(hash_including(start: 3)).and_return(double(documents: [4, 5, 6]))
+      allow_any_instance_of(Blacklight::Solr::Repository).to receive(:search).with(hash_including(start: 6)).and_return(double(documents: []))
+
+      expect(described_class.find_each.to_a).to match_array [1, 2, 3, 4, 5, 6]
+    end
+  end
+
+  describe '.reindex_all' do
+    let(:doc) { described_class.new id: 1 }
+
+    it 'reindexes all solr documents' do
+      expect(described_class).to receive(:find_each).and_yield(doc)
+      expect(doc).to receive(:reindex)
+
+      described_class.reindex_all
+    end
+  end
 end

data/spec/models/spotlight/blacklight_configuration_spec.rb

@@ -440,10 +440,10 @@ describe Spotlight::BlacklightConfiguration, type: :model do
 
   describe '#custom_index_fields' do
     it 'converts exhibit-specific fields to Blacklight configurations' do
-      allow(subject).to receive_messages(exhibit: double(custom_fields: [
-        stub_model(Spotlight::CustomField, field: 'abc', configuration: { a: 1 }),
-        stub_model(Spotlight::CustomField, field: 'xyz', configuration: { x: 2 })
-      ]))
+      allow(subject.exhibit).to receive_messages(custom_fields: [
+        stub_model(Spotlight::CustomField, field: 'abc', configuration: { a: 1 }, exhibit: subject.exhibit),
+        stub_model(Spotlight::CustomField, field: 'xyz', configuration: { x: 2 }, exhibit: subject.exhibit)
+      ])
 
       expect(subject.custom_index_fields).to include 'abc', 'xyz'
       expect(subject.custom_index_fields['abc']).to be_a_kind_of Blacklight::Configuration::Field

data/spec/models/spotlight/custom_field_spec.rb

@@ -45,22 +45,63 @@ describe Spotlight::CustomField, type: :model do
   end
 
   describe '#field' do
-    let(:exhibit) { FactoryGirl.create(:exhibit) }
+    let(:exhibit) { double(to_param: 'a', solr_document_sidecars: Spotlight::SolrDocumentSidecar.none) }
+
+    before do
+      subject.label = 'xyz'
+      subject.save
+
+      allow(Spotlight::RenameSidecarFieldJob).to receive(:perform_later)
+    end
+
     it 'is auto-generated from the field label' do
-      subject.configuration['label'] = 'xyz'
-      subject.exhibit = exhibit
+      expect(subject.field).to start_with 'xyz'
+    end
+
+    it 'ends in the text suffix if it is a text field' do
+      subject.field_type = 'text'
       subject.save
+      expect(subject.field).to end_with Spotlight::Engine.config.solr_fields.text_suffix
+    end
 
-      expect(subject.field).to eq "exhibit_#{exhibit.to_param}_xyz_tesim"
+    it 'ends in a string suffix if it is a vocab field' do
+      subject.field_type = 'vocab'
+      subject.save
+      expect(subject.field).to end_with Spotlight::Engine.config.solr_fields.string_suffix
     end
+  end
+
+  describe '#solr_field' do
+    let(:exhibit) { FactoryGirl.create(:exhibit) }
 
-    it 'uses the solr field prefix' do
-      allow(Spotlight::Engine.config.solr_fields).to receive(:prefix).and_return 'prefix_'
+    before do
       subject.configuration['label'] = 'xyz'
       subject.exhibit = exhibit
       subject.save
+    end
+
+    it 'is auto-generated from the field label' do
+      expect(subject.solr_field).to eq "exhibit_#{exhibit.to_param}_xyz_tesim"
+    end
+
+    context 'with a solr field prefix configured' do
+      before do
+        allow(Spotlight::Engine.config.solr_fields).to receive(:prefix).and_return 'prefix_'
+      end
+
+      it 'uses the solr field prefix' do
+        expect(subject.solr_field).to eq "prefix_exhibit_#{exhibit.to_param}_xyz_tesim"
+      end
+    end
+
+    context 'for a legacy solr field name' do
+      before do
+        subject.field = "exhibit_#{exhibit.to_param}_xyz_tesim"
+      end
 
-      expect(subject.field).to eq "prefix_exhibit_#{exhibit.to_param}_xyz_tesim"
+      it 'returns the original field name' do
+        expect(subject.solr_field).to eq "exhibit_#{exhibit.to_param}_xyz_tesim"
+      end
     end
   end
 
@@ -101,24 +142,6 @@ describe Spotlight::CustomField, type: :model do
     end
   end
 
-  describe '#field_name' do
-    let(:exhibit) { double(to_param: 'a') }
-
-    before do
-      subject.label = 'xyz'
-    end
-
-    it 'ends in the text suffix if it is a text field' do
-      subject.field_type = 'text'
-      expect(subject.send(:field_name)).to end_with Spotlight::Engine.config.solr_fields.text_suffix
-    end
-
-    it 'ends in a string suffix if it is a vocab field' do
-      subject.field_type = 'vocab'
-      expect(subject.send(:field_name)).to end_with Spotlight::Engine.config.solr_fields.string_suffix
-    end
-  end
-
   describe 'changing the field type' do
     let(:exhibit) { FactoryGirl.create(:exhibit) }
     before do