blacklight-spotlight 0.0.1

data/spec/models/spotlight/feature_page_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Spotlight::FeaturePage do
+  describe "default_scope" do
+    let!(:page1) { FactoryGirl.create(:feature_page, weight: 5) }
+    let!(:page2) { FactoryGirl.create(:feature_page, weight: 1) }
+    let!(:page3) { FactoryGirl.create(:feature_page, weight: 10) }
+    it "should order by weight" do
+      expect(Spotlight::FeaturePage.all.map(&:weight)).to eq [1, 5, 10]
+    end
+  end
+
+  describe "weight" do
+    let(:good_weight) { FactoryGirl.build(:feature_page, weight: 10) }
+    let(:low_weight)  { FactoryGirl.build(:feature_page, weight: -1) }
+    let(:high_weight) { FactoryGirl.build(:feature_page, weight:  51) }
+    it "should default to 0" do
+      expect(Spotlight::FeaturePage.new.weight).to eq 0
+    end
+    it "should validate when in the 0 to 50 range" do
+      expect(good_weight).to be_valid
+      expect(good_weight.weight).to eq 10
+    end
+    it "should raise an error when outside of the 0 to 50 range" do
+      expect(low_weight ).to_not be_valid
+      expect(high_weight).to_not be_valid
+    end
+    it "settable valid maximum" do
+      stub_const("Spotlight::Page::MAX_PAGES", 51)
+      expect(high_weight).to be_valid
+    end
+  end
+
+  it {should be_feature_page}
+  it {should_not be_about_page}
+
+  describe "relationships" do
+    let(:parent)  { FactoryGirl.create(:feature_page) }
+    let!(:child1) { FactoryGirl.create(:feature_page, :parent_page => parent ) }
+    let!(:child2) { FactoryGirl.create(:feature_page, :parent_page => parent ) }
+    it "child pages should have a parent_page" do
+      [child1, child2].each do |child|
+         expect(child.parent_page).to eq parent
+      end
+    end
+    it "parent pages should have child_pages" do
+      expect(parent.child_pages.length).to eq 2
+      expect(parent.child_pages.map(&:id)).to eq [child1.id, child2.id]
+    end
+    it "should define top_level_page? properly" do
+      expect(parent.top_level_page?).to be_true
+      expect(child1.top_level_page?).to be_false
+      expect(child2.top_level_page?).to be_false
+    end
+  end
+end

data/spec/models/spotlight/search_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Spotlight::Search do
+
+  before do
+    subject.query_params = {"f"=>{"genre_sim"=>["map"]}}
+  end
+
+  it "should have a default feature image" do
+    subject.stub(images: [['title', 'image_url'], ['title1', 'image2']])
+    subject.save
+    expect(subject.featured_image).to eq 'image_url'
+  end
+
+  it "should have items" do
+    expect(subject.count).to eq 55
+  end
+
+  it "should have images" do
+    subject.images.size.should == 55
+    expect(subject.images.map(&:last)).to include "https://stacks.stanford.edu/image/dq287tq6352/dq287tq6352_05_0001_thumb", "https://stacks.stanford.edu/image/jp266yb7109/jp266yb7109_05_0001_thumb"
+  end
+
+  describe "default_scope" do
+    let!(:page1) { FactoryGirl.create(:search, weight: 5) }
+    let!(:page2) { FactoryGirl.create(:search, weight: 1) }
+    let!(:page3) { FactoryGirl.create(:search, weight: 10) }
+    it "should order by weight" do
+      expect(Spotlight::Search.all.map(&:weight)).to eq [1, 5, 10]
+    end
+  end
+end

data/spec/routing/spotlight/pages_routing_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+module Spotlight
+  describe "FeaturePagesController and AboutPagesController" do
+    describe "routing" do
+      routes { Spotlight::Engine.routes }
+
+      it "routes to #index" do
+        get("/exhibits/1/feature").should route_to("spotlight/feature_pages#index", exhibit_id: '1')
+        get("/exhibits/1/about").should   route_to("spotlight/about_pages#index",   exhibit_id: '1')
+      end
+
+      it "routes to #new" do
+        get("/exhibits/1/feature/new").should route_to("spotlight/feature_pages#new", exhibit_id: '1')
+        get("/exhibits/1/about/new").should   route_to("spotlight/about_pages#new",   exhibit_id: '1')
+      end
+
+      it "routes to #show" do
+        get("/feature/2").should route_to("spotlight/feature_pages#show", id: "2")
+        get("/about/2").should   route_to("spotlight/about_pages#show",   id: "2")
+      end
+
+      it "routes to #edit" do
+        get("/feature/2/edit").should route_to("spotlight/feature_pages#edit", id: "2")
+        get("/about/2/edit").should   route_to("spotlight/about_pages#edit",   id: "2")
+      end
+
+      it "routes to #create" do
+        post("/exhibits/1/feature").should route_to("spotlight/feature_pages#create", exhibit_id: '1')
+        post("/exhibits/1/about").should   route_to("spotlight/about_pages#create",   exhibit_id: '1')
+      end
+
+      it "routes to #update" do
+        put("/feature/2").should route_to("spotlight/feature_pages#update", id: "2")
+        put("/about/2").should   route_to("spotlight/about_pages#update",   id: "2")
+      end
+
+      it "routes to #destroy" do
+        delete("/feature/2").should route_to("spotlight/feature_pages#destroy", id: "2")
+        delete("/about/2").should   route_to("spotlight/about_pages#destroy",   id: "2")
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'devise'
+require 'engine_cart'
+EngineCart.load_application!
+
+require 'rspec/rails'
+require 'rspec/autorun'
+require 'capybara/poltergeist'
+Capybara.javascript_driver = :poltergeist
+
+if ENV["COVERAGE"] or ENV["CI"]
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+  SimpleCov.start
+end
+
+require 'spotlight'
+
+
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
+FactoryGirl.definition_file_paths = [File.expand_path("../factories", __FILE__)]
+FactoryGirl.find_definitions
+
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = false
+
+  config.before :each do
+    if Capybara.current_driver == :rack_test
+      DatabaseCleaner.strategy = :transaction
+    else
+      DatabaseCleaner.strategy = :truncation
+    end
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+
+  config.include Devise::TestHelpers, type: :controller
+  config.include Devise::TestHelpers, type: :view
+  config.include Warden::Test::Helpers, type: :feature
+  config.include Controllers::EngineHelpers, type: :controller
+  config.include Capybara::DSL
+end

data/spec/support/controllers/engine_helpers.rb

@@ -0,0 +1,7 @@
+module Controllers
+  module EngineHelpers
+    def main_app
+      Rails.application.class.routes.url_helpers
+    end
+  end
+end

data/spec/test_app_templates/Gemfile.extra

@@ -0,0 +1,13 @@
+# extra gems to load into the test app go here
+
+gem 'blacklight', '~> 5.0'
+gem 'sir-trevor-rails', :github => 'sul-dlss/sir-trevor-rails'
+
+group :test do
+  gem 'rspec-rails'
+  gem 'poltergeist'
+  gem 'database_cleaner'
+  gem 'factory_girl'
+end
+
+

data/spec/test_app_templates/catalog_controller.rb

@@ -0,0 +1,90 @@
+# -*- encoding : utf-8 -*-
+require 'blacklight/catalog'
+
+class CatalogController < ApplicationController  
+
+  include Blacklight::Catalog
+
+  configure_blacklight do |config|
+    ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
+    config.default_solr_params = { 
+      :qt   => 'search',
+      :rows => 10,
+      :fl   => '*'
+    }
+
+    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SolrHelper#solr_doc_params) or 
+    ## parameters included in the Blacklight-jetty document requestHandler.
+    #
+    #config.default_document_solr_params = {
+    #  :qt => 'document',
+    #  ## These are hard-coded in the blacklight 'document' requestHandler
+    #  # :fl => '*',
+    #  # :rows => 1
+    #  # :q => '{!raw f=id v=$id}' 
+    #}
+
+    # solr field configuration for search results/index views
+    config.index.title_field = 'full_title_tesim'
+    config.index.display_type_field = 'content_metadata_type_ssm'
+    config.index.thumbnail_field = :thumbnail_url_ssm
+
+    # solr fields that will be treated as facets by the blacklight application
+    #   The ordering of the field names is the order of the display
+    #
+    # Setting a limit will trigger Blacklight's 'more' facet values link.
+    # * If left unset, then all facet values returned by solr will be displayed.
+    # * If set to an integer, then "f.somefield.facet.limit" will be added to
+    # solr request, with actual solr request being +1 your configured limit --
+    # you configure the number of items you actually want _displayed_ in a page.    
+    # * If set to 'true', then no additional parameters will be sent to solr,
+    # but any 'sniffed' request limit parameters will be used for paging, with
+    # paging at requested limit -1. Can sniff from facet.limit or 
+    # f.specific_field.facet.limit solr request params. This 'true' config
+    # can be used if you set limits in :default_solr_params, or as defaults
+    # on the solr side in the request handler itself. Request handler defaults
+    # sniffing requires solr requests to be made with "echoParams=all", for
+    # app code to actually have it echo'd back to see it.  
+    #
+    # :show may be set to false if you don't want the facet to be drawn in the 
+    # facet bar
+    config.add_facet_field 'genre_sim', :label => 'Genre', :limit => true 
+    config.add_facet_field 'personal_name_ssm', :label => 'Personal Names', :limit => true 
+    config.add_facet_field 'corporate_name_ssm', :label => 'Corporate Names', :limit => true
+    config.add_facet_field 'subject_geographic_sim', :label => 'Geographic' 
+    config.add_facet_field 'subject_temporal_sim', :label => 'Era'  
+    config.add_facet_field 'language_sim', :label => 'Language'  
+
+
+    # Have BL send all facet field names to Solr, which has been the default
+    # previously. Simply remove these lines if you'd rather use Solr request
+    # handler defaults, or have no facets.
+    config.add_facet_fields_to_solr_request!
+
+    # solr fields to be displayed in the index (search results) view
+    #   The ordering of the field names is the order of the display 
+    config.add_index_field 'language_ssm', :label => 'Language'
+    config.add_index_field 'abstract_tesim', :label => 'Abstract'
+    config.add_index_field 'note_mapuse_tesim', :label => 'Type'
+    config.add_index_field 'note_source_tesim', :label => 'Source'
+    config.add_index_field 'subject_geographic_tesim', :label => 'Geographic Subject'
+    config.add_index_field 'subject_temporal_tesim', :label => 'Temporal Subject'
+
+    # solr fields to be displayed in the show (single result) view
+    #   The ordering of the field names is the order of the display 
+    config.add_show_field 'note_phys_desc_tesim', :label => 'Note'
+    config.add_show_field 'note_source_tesim', :label => 'Source'
+    config.add_show_field 'note_desc_note_tesim', :label => 'Note'
+    config.add_show_field 'note_references_tesim', :label => 'References'
+    config.add_show_field 'note_provenance_tesim', :label => 'Provenance'
+    config.add_show_field 'note_page_num_tesim', :label => 'Page Number'
+    config.add_show_field 'subject_geographic_tesim', :label => 'Geographic Subject'
+    config.add_show_field 'subject_temporal_tesim', :label => 'Temporal Subject'
+    config.add_show_field 'personal_name_ssm', :label => 'Personal Names'
+    config.add_show_field 'corporate_name_ssm', :label => 'Corporate Names'
+
+  end
+
+
+
+end 

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+  source_root "../../spec/test_app_templates"
+
+  def run_blacklight_generator
+    say_status("warning", "GENERATING BL", :yellow)       
+
+    generate 'blacklight:install', '--devise'
+    copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb", force: true
+  end
+
+  def run_spotlight_migrations
+    rake "spotlight:install:migrations"
+    rake "db:migrate"
+  end
+
+  def add_spotlight_routes_and_assets
+    generate 'spotlight:install'
+  end
+
+  def add_rake_tasks_to_app
+    rakefile 'spotlight_test.rake', File.read(find_in_source_paths('spotlight_test.rake'))
+  end
+end

data/spec/test_app_templates/spotlight_test.rake

@@ -0,0 +1,12 @@
+require 'rake'
+
+namespace :spotlight_test do
+  namespace :solr do
+    desc "Index test data into solr; must be run from within an app (see spotlight:fixtures)"
+    task :seed do
+      docs = YAML::load(File.open(File.expand_path(File.join('..', 'fixtures', 'sample_solr_documents.yml'), Rails.root)))
+      Blacklight.solr.add docs
+      Blacklight.solr.commit
+    end
+  end
+end

data/spec/views/_user_util_links.html.erb_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module Spotlight
+  describe "_user_util_links" do
+    before do
+      view.stub(:current_user).and_return(current_user)
+    end
+
+    describe "when user is not logged in" do
+      let(:current_user) { nil }
+      it "renders the links" do
+        render
+        expect(rendered).to have_link 'Sign in'
+        expect(rendered).to have_link 'Report a problem'
+      end
+    end
+
+    describe "when user is logged in" do
+      let(:current_user) { ::User.new }
+      it "renders the links" do
+        render
+        expect(rendered).to have_link 'Report a problem'
+        expect(rendered).to_not have_link 'Administration'
+        expect(rendered).to_not have_link 'Curation'
+        expect(rendered).to have_link 'Sign out'
+      end
+    end
+
+    describe "when user is a curator" do
+      let(:current_user) { ::User.new }
+      before do
+        view.stub(:can?).with(:update, Spotlight::Exhibit.default).and_return(false)
+        view.stub(:can?).with(:curate, Spotlight::Exhibit.default).and_return(true)
+      end
+      it "renders the links" do
+        render
+        expect(rendered).to have_link 'Report a problem'
+        expect(rendered).to have_link 'Curation'
+        expect(rendered).to have_link 'Sign out'
+        expect(rendered).to_not have_link 'Administration'
+      end
+    end
+    describe "when user is an admin" do
+      let(:current_user) { ::User.new }
+      before do
+        view.stub(:can?).with(:update, Spotlight::Exhibit.default).and_return(true)
+        view.stub(:can?).with(:curate, Spotlight::Exhibit.default).and_return(true)
+      end
+      it "renders the links" do
+        render
+        expect(rendered).to have_link 'Report a problem'
+        expect(rendered).to have_link 'Administration'
+        expect(rendered).to have_link 'Curation'
+        expect(rendered).to have_link 'Sign out'
+      end
+    end
+  end
+end
+

data/spec/views/shared/_exhibit_masthead.html.erb_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Spotlight
+  describe "shared/_exhibit_masthead" do
+    let(:current_exhibit) { double(title: "Some title", subtitle: "Subtitle") }
+    let(:current_exhibit_without_subtitle) { double(title: "Some title", subtitle: nil) }
+  
+    it "should display the title and subtitle" do
+      view.stub(current_exhibit: current_exhibit)
+      render
+      expect(rendered).to have_selector('h1', text: "Some title")
+      expect(rendered).to have_selector('h1 small', text: "Subtitle")
+    end
+
+    it "should display just the title" do
+      view.stub(current_exhibit: current_exhibit_without_subtitle)
+      render
+      expect(rendered).to have_selector('h1', text: "Some title")
+      expect(rendered).to_not have_selector('h1 small')
+    end
+  end
+end

data/spec/views/shared/_exhibit_navbar.html.erb_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+module Spotlight
+  describe "shared/_exhibit_navbar" do
+    let(:current_exhibit) {  Spotlight::Exhibit.default }
+    let(:feature_page) { FactoryGirl.create(:feature_page) }
+    let(:unpublished_feature_page) { FactoryGirl.create(:feature_page, published: false) }
+    let(:about_page) { FactoryGirl.create(:about_page) }
+    let(:unpublished_about_page) { FactoryGirl.create(:about_page, published: false) }
+
+    before :each do
+      view.stub(current_exhibit: current_exhibit)
+      view.stub(on_browse_page?: false, on_about_page?: false)
+      view.stub(render_search_bar: "Search Bar")
+    end
+
+    it "should link to the search page if no home page is defined" do
+      render
+      expect(response).to have_link "Home", href: main_app.root_url
+    end
+
+    it "should link to the home page" do
+      current_exhibit.stub home_page: feature_page
+      render
+      expect(response).to have_link "Home", href: main_app.root_url
+    end
+
+    it "should link directly to a single feature page" do
+      feature_page
+      render
+      expect(response).to have_link feature_page.title, href: spotlight.feature_page_path(feature_page)
+    end
+
+    it "should provide a dropdown of multiple feature pages" do
+      feature_page
+      another_page = FactoryGirl.create(:feature_page)
+      render
+      expect(response).to have_selector ".dropdown .dropdown-toggle", text: "Curated Features"
+      expect(response).to have_link feature_page.title, visible: false, href: spotlight.feature_page_path(feature_page)
+      expect(response).to have_link another_page.title, visible: false,  href: spotlight.feature_page_path(another_page)
+    end
+
+    it "should not display links to feature pages if none are defined" do
+      render
+      expect(response).to_not have_link "Curated Features"
+    end
+
+    it "should not display links to feature pages that are not published" do
+      unpublished_feature_page
+      render
+      expect(response).to_not have_link "Curated Features"
+    end
+
+    it "should link to the browse index if there's a published search" do
+      FactoryGirl.create :published_search
+      render
+      expect(response).to have_link "Browse", href: spotlight.exhibit_browse_index_path(current_exhibit)
+    end
+
+    it "should mark the browse button as active if we're on a browse page" do
+      FactoryGirl.create :published_search
+      view.stub(on_browse_page?: true)
+      render
+      expect(response).to have_selector "li.active", text: "Browse"
+    end
+
+    it "should not link to the browse index if no categories are defined" do
+      render
+      expect(response).not_to have_link "Browse"
+    end
+
+    it "should not link to the browse index if only private categories are defined" do
+      FactoryGirl.create :search
+      render
+      expect(response).not_to have_link "Browse"
+    end
+
+    it "should link to the about page" do
+      current_exhibit.stub main_about_page: about_page
+      render
+      expect(response).to have_link "About", href: spotlight.about_page_path(about_page)
+    end
+
+    it "should not link to the about page if no about page exists" do
+      render
+      expect(response).to_not have_link "About"
+    end
+
+    it "should not to the about page if none are published" do
+      unpublished_about_page
+      render
+      expect(response).to_not have_link "About"
+    end
+
+    it "should  mark the about button as active if we're on an about page" do
+      current_exhibit.stub main_about_page: about_page
+      view.stub(on_about_page?: true)
+      render
+      expect(response).to have_selector "li.active", text: "About"
+    end
+
+  end
+end