blacklight-spotlight 0.4.1 → 0.5.0

data/lib/spotlight/rails/routes.rb

@@ -1,8 +1,11 @@
-module ActionDispatch::Routing
-  class Mapper
-
+module Spotlight
+  ##
+  # Spotlight routing helpers
+  module Routes
     def spotlight_root
-      root to: "spotlight/default#index"
+      root to: 'spotlight/default#index'
     end
   end
 end
+
+ActionDispatch::Routing::Mapper.send :include, Spotlight::Routes

data/lib/spotlight/version.rb

@@ -1,3 +1,4 @@
+#
 module Spotlight
-  VERSION = "0.4.1"
+  VERSION = '0.5.0'
 end

data/lib/tasks/spotlight_tasks.rake

@@ -1,92 +1,99 @@
 namespace :spotlight do
-  desc "Create an initial admin user and default exhibit"
-  task :initialize => :environment do
-    puts "Creating an initial admin user."
-    print "Email: "
-    email = $stdin.gets.chomp
-    password = prompt_password
-    u = User.create!(email: email, password: password)
+  desc 'Create an initial admin user and default exhibit'
+  task initialize: :environment do
+    puts 'Creating an initial admin user.'
+    u = prompt_to_create_user
+
     Spotlight::Role.create(user: u, exhibit: nil, role: 'admin')
-    puts "User created."
+    puts 'User created.'
   end
 
-  desc "Add application-wide admin privileges to an existing user" 
-  task :admin => :environment do
-    print "Email: "
-    email = $stdin.gets.chomp
-    u = User.find_by email: email
+  desc 'Add application-wide admin privileges to a user'
+  task admin: :environment do
+    u = prompt_to_create_user
     Spotlight::Role.create(user: u, exhibit: nil, role: 'admin')
   end
 
-  desc "Create a new exhibit"
-  task :exhibit => :environment do
-    print "Exhibit title: "
+  desc 'Create a new exhibit'
+  task exhibit: :environment do
+    print 'Exhibit title: '
     title = $stdin.gets.chomp
 
     exhibit = Spotlight::Exhibit.create!(title: title)
 
-    puts "Who can admin this exhibit?"
-    print "Email: "
-    email = $stdin.gets.chomp
-   
-    u = User.find_by(email: email)
-    unless u
-      puts "User not found."
-      password = prompt_password
-      u = User.create!(email: email, password: password)
-    end
+    puts 'Who can admin this exhibit?'
+
+    u = prompt_to_create_user
+
     Spotlight::Role.create(user: u, exhibit: exhibit, role: 'admin')
-    puts "Exhibit created."
+    puts 'Exhibit created.'
   end
 
-  desc "Import an exhibit"
+  desc 'Import an exhibit'
   task import: :environment do
     contents = if ENV['FILE']
-        File.read(ENV['FILE'])
-      else
-        STDIN.read
-      end
+                 File.read(ENV['FILE'])
+               else
+                 STDIN.read
+               end
 
     data = JSON.parse(contents)
 
-    exhibit = Spotlight::Exhibit.find_or_create_by slug: data["slug"] do |e|
-      e.title = data["title"]
+    exhibit = Spotlight::Exhibit.find_or_create_by! slug: data['slug'] do |e|
+      e.title = data['title']
     end
 
     exhibit.import data
 
-    puts Spotlight::ExhibitExportSerializer.new(exhibit).to_json
+    exhibit.save!
+
+    puts Spotlight::ExhibitExportSerializer.new(exhibit.reload).to_json
   end
 
-  def prompt_password
+  def prompt_to_create_user
+    User.find_or_create_by!(email: prompt_for_email) do |u|
+      puts 'User not found. Enter a password to create the user.'
+      u.password = prompt_for_password
+    end
+  rescue => e
+    puts e
+    retry
+  end
+
+  def prompt_for_email
+    print 'Email: '
+    $stdin.gets.chomp
+  end
+
+  def prompt_for_password
     begin
-      system "stty -echo"
-      print "Password: "
+      system 'stty -echo'
+      print 'Password (must be 8+ characters): '
       password = $stdin.gets.chomp
       puts "\n"
     ensure
-      system "stty echo"
+      system 'stty echo'
     end
     password
   end
 
   namespace :check do
-    desc "Check the Solr connection and controller configuration"
-    task :solr, [:model_name] => ['blacklight:check:solr', :environment] do |_, args|
+    desc 'Check the Solr connection and controller configuration'
+    task :solr, [:model_name] => ['blacklight:check:solr', :environment] do |_, _args|
       errors = 0
-      verbose = ENV.fetch('VERBOSE', false).present?
 
       puts "[#{Blacklight.default_index.connection.uri}]"
 
-      print " - atomic updates:"
+      print ' - atomic updates:'
       begin
         id = 'test123'
         field = "test_#{Spotlight::Engine.config.solr_fields.string_suffix}"
+        sample_doc = { Spotlight::Engine.blacklight_config.document_model.unique_key => id, field => { set: 'a-new-string' } }
         Blacklight.default_index.connection.add Spotlight::Engine.blacklight_config.document_model.unique_key.to_sym => id, field => 'some-string'
-        Blacklight.default_index.connection.update data: [{Spotlight::Engine.blacklight_config.document_model.unique_key => id, field => { set: 'a-new-string' }}].to_json, headers: { 'Content-Type' => 'application/json' }
+        Blacklight.default_index.connection.update data: [sample_doc].to_json, headers: { 'Content-Type' => 'application/json' }
         Blacklight.default_index.connection.delete_by_id id
         print " OK\n"
-      rescue Exception => e
+      rescue StandardError => e
         errors += 1
         puts e.to_s
       end
@@ -97,15 +104,14 @@ namespace :spotlight do
 
   task :reindex, [:exhibit_slug] => :environment do |_, args|
     exhibits = if args[:exhibit_slug]
-      Spotlight::Exhibit.where(slug: args[:exhibit_slug])
-    else
-      Spotlight::Exhibit.all
-    end
+                 Spotlight::Exhibit.where(slug: args[:exhibit_slug])
+               else
+                 Spotlight::Exhibit.all
+               end
 
     exhibits.find_each do |e|
       puts " == Reindexing #{e.title} =="
       e.reindex_later
     end
   end
-
 end

data/spec/controllers/application_controller_spec.rb

@@ -1,29 +1,29 @@
 require 'spec_helper'
 
-describe ApplicationController, :type => :controller do
+describe ApplicationController, 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 Spotlight::Controller }
 
-  describe "exhibit-specific routing" do
-
-    context "with a current exhibit" do
-
+  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 "should be a path within the current exhibit" do
-          expect(get: controller.search_action_url(only_path: true).gsub("/spotlight", "")).to route_to controller: "spotlight/catalog", action: "index", exhibit_id: exhibit.slug
+      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_facets_url" do
-        it "should be a path within the current exhibit" do
-          expect(get: controller.search_facet_url(id: "some-facet", only_path: true).gsub("/spotlight", "")).to route_to controller: "spotlight/catalog", action: "facet", id:"some-facet", exhibit_id: exhibit.slug
+      describe '#search_facets_url' 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_url(id: 'some-facet', only_path: true).gsub('/spotlight', '')).to route_to expected
         end
       end
     end
   end
-end
+end

data/spec/controllers/spotlight/about_pages_controller_spec.rb

@@ -1,42 +1,41 @@
 require 'spec_helper'
 
-describe Spotlight::AboutPagesController, :type => :controller do
+describe Spotlight::AboutPagesController, type: :controller do
   routes { Spotlight::Engine.routes }
-  let(:valid_attributes) { { "title" => "MyString" } }
+  let(:valid_attributes) { { 'title' => 'MyString' } }
 
   it { is_expected.to be_a Spotlight::Catalog::AccessControlsEnforcement }
 
-  describe "when not logged in" do
-
-    describe "POST update_all" do
+  describe 'when not logged in' do
+    describe 'POST update_all' do
       let(:exhibit) { FactoryGirl.create(:exhibit) }
-      it "should not be allowed" do
+      it 'does not be allowed' do
         post :update_all, 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(:exhibit) { FactoryGirl.create(:exhibit) }
     let(:user) { FactoryGirl.create(:exhibit_curator, exhibit: exhibit) }
-    before {sign_in user }
+    before { sign_in user }
 
-    describe "GET show" do
+    describe 'GET show' do
       let(:page) { FactoryGirl.create(:about_page, weight: 0, exhibit: exhibit) }
       let(:page2) { FactoryGirl.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", [exhibit, page])
+      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', [exhibit, page])
           get :show, id: page, exhibit_id: exhibit
           expect(assigns(:page)).to eq page
-          expect(assigns(:exhibit)).to eq exhibit 
+          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))
+      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', [exhibit, page])
           expect(controller).to receive(:add_breadcrumb).with(page2.title, [exhibit, page2])
           get :show, id: page2, exhibit_id: exhibit
@@ -46,81 +45,86 @@ describe Spotlight::AboutPagesController, :type => :controller do
       end
     end
 
-    describe "GET edit" do
+    describe 'GET edit' do
       let!(:page) { FactoryGirl.create(:about_page, weight: 0, exhibit: exhibit) }
       let!(:page2) { FactoryGirl.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))
+      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, 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))
+      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, id: page2, exhibit_id: exhibit 
+          get :edit, id: page2, exhibit_id: exhibit
           expect(assigns(:page)).to eq page2
-          expect(assigns(:exhibit)).to eq exhibit 
+          expect(assigns(:exhibit)).to eq exhibit
         end
       end
     end
 
-    describe "GET index" do
+    describe 'GET index' do
       let!(:page) { FactoryGirl.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, exhibit_id: 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, 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, about_page: {title: "MyString"}, exhibit_id: exhibit 
+    describe 'POST create' do
+      it 'redirects to the about page index' do
+        post :create, about_page: { title: 'MyString' }, exhibit_id: exhibit
         expect(response).to redirect_to(exhibit_about_pages_path(exhibit))
       end
     end
-    describe "PUT update" do
+    describe 'PUT update' do
       let!(:page) { FactoryGirl.create(:about_page, exhibit: exhibit) }
-      it "redirects to the about page" do
+      it 'redirects to the about page' do
         put :update, 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"
+        expect(flash[:notice]).to have_link 'Undo changes'
       end
     end
-    describe "POST update_all" do
+    describe 'POST update_all' do
       let!(:page1) { FactoryGirl.create(:about_page, exhibit: exhibit) }
-      let!(:page2) { FactoryGirl.create(:about_page, exhibit: exhibit, published: true ) }
-      let!(:page3) { FactoryGirl.create(:about_page, exhibit: exhibit, published: true ) }
-      before { request.env["HTTP_REFERER"] = "http://example.com" }
-      it "should update whether they are on the landing page" do
-        post :update_all, exhibit_id: page1.exhibit, exhibit: {about_pages_attributes: [{id: page1.id, published: true, title: "This is a new title!"}, {id: page2.id, published: false}]}
+      let!(:page2) { FactoryGirl.create(:about_page, exhibit: exhibit, published: true) }
+      let!(:page3) { FactoryGirl.create(:about_page, exhibit: exhibit, published: true) }
+      before { request.env['HTTP_REFERER'] = 'http://example.com' }
+      it 'updates whether they are on the landing page' do
+        post :update_all, 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 'http://example.com'
-        expect(flash[:notice]).to eq "About pages were successfully updated."
+        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(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
+    describe 'PATCH update_contacts' do
       let!(:contact1) { FactoryGirl.create(:contact, name: 'Aphra Behn', exhibit: exhibit) }
       let!(:contact2) { FactoryGirl.create(:contact, exhibit: exhibit) }
-      it "should update contacts" do
-        patch :update_contacts, exhibit_id: exhibit, exhibit: {contacts_attributes: [
-          {"show_in_sidebar"=>"1", "id"=>contact1.id, weight: 1},
-          {"show_in_sidebar"=>"0", "id"=>contact2.id, weight: 2}]}
+      it 'updates contacts' do
+        patch :update_contacts, 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
@@ -128,13 +132,13 @@ describe Spotlight::AboutPagesController, :type => :controller do
         expect(contact1.reload.weight).to eq 1
         expect(contact2.reload.weight).to eq 2
       end
-      it "should show index on failure" do
+      it 'shows index on failure' do
         expect_any_instance_of(Spotlight::Exhibit).to receive(:update).and_return(false)
-        patch :update_contacts, 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")
+        patch :update_contacts, 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
   end

data/spec/controllers/spotlight/appearances_controller_spec.rb

@@ -1,55 +1,60 @@
 require 'spec_helper'
-describe Spotlight::AppearancesController, :type => :controller do
+describe Spotlight::AppearancesController, type: :controller do
   routes { Spotlight::Engine.routes }
   let(:exhibit) { FactoryGirl.create(:exhibit) }
 
-  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
 
-    it "should deny access" do
-      get :edit, exhibit_id: exhibit 
+    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
 
-  describe "when not logged in" do
-    describe "#update" do
-      it "should not be allowed" do
-        patch :update, exhibit_id: exhibit 
+  describe 'when not logged in' do
+    describe '#update' do
+      it 'does not be allowed' do
+        patch :update, exhibit_id: exhibit
         expect(response).to redirect_to main_app.new_user_session_path
       end
     end
   end
 
-  describe "when signed in" do
+  describe 'when signed in' do
     let(:user) { FactoryGirl.create(:exhibit_admin, exhibit: exhibit) }
-    before {sign_in user }
+    before { sign_in user }
 
-    describe "#edit" do
-      it "should be 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("Appearance", edit_exhibit_appearance_path(exhibit))
+    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('Appearance', edit_exhibit_appearance_path(exhibit))
         get :edit, exhibit_id: exhibit
         expect(response).to be_successful
-        expect(assigns[:appearance]).to be_kind_of Spotlight::Appearance
+        expect(assigns[:exhibit]).to be_kind_of Spotlight::Exhibit
       end
     end
 
-    describe "#update" do
-      it "should update appearance fields" do
-        patch :update, exhibit_id: exhibit, appearance: { 
-          document_index_view_types: {"list"=>"1", "gallery"=>"1", "map"=>"0"},
-          default_per_page: "50",
+    describe '#update' do
+      it 'updates the navigation' do
+        first_nav = exhibit.main_navigations.first
+        last_nav = exhibit.main_navigations.last
+        patch :update, exhibit_id: exhibit, exhibit: {
+          main_navigations_attributes: [
+            { id: first_nav.id, label: 'Some Label', weight: 500 },
+            { id: last_nav.id, display: false }
+          ]
         }
-        expect(flash[:notice]).to eq "The appearance was successfully updated."
+        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.blacklight_configuration.document_index_view_types).to eq ['list', 'gallery']
-          expect(saved.blacklight_configuration.default_per_page).to eq 50
+          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
         end
       end
     end