blacklight-spotlight 0.0.1

data/spec/helpers/spotlight/pages_helper_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module Spotlight
+  describe PagesHelper do
+    let(:blacklight_config) { Blacklight::Configuration.new { |config| config.show.title_field = :abc } }
+    let(:titled_document)   { SolrDocument.new( :abc => "value" ) }
+    let(:untitled_document) { SolrDocument.new( :id  => "1234"  ) }
+    before(:each) { helper.stub(:blacklight_config => blacklight_config) }
+
+    describe "has_title?" do
+      it "should return true if the title is not the same as the ID" do
+        expect(helper.has_title? titled_document).to be_true
+      end
+      it "should return false if the document heading returned is the same as the ID (indicating there is no title)" do
+        expect(helper.has_title? untitled_document).to be_false
+      end
+    end
+    describe "should_render_record_thumbnail_title?" do
+      it "should return true if there is a title" do
+        expect(helper.should_render_record_thumbnail_title?(titled_document, {'show-title' => true})).to be_true
+      end
+      it "should return false there is no title" do
+        expect(helper.should_render_record_thumbnail_title?(untitled_document, {'show-title' => true})).to be_false
+      end
+      it "should return false if the block configuration is hiding the title" do
+        expect(helper.should_render_record_thumbnail_title?(titled_document, {'show-title' => false})).to be_false
+      end
+    end
+  end
+end

data/spec/internal/Gemfile

@@ -0,0 +1,53 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.0.2'
+
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.0'
+
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 1.2'
+
+group :doc do
+  # bundle exec rake doc:rails generates the API under doc/api.
+  gem 'sdoc', require: false
+end
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.1.2'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano', group: :development
+
+# Use debugger
+# gem 'debugger', group: [:development, :test]
+        gem 'blacklight-spotlight', :path => '/Volumes/TempStorage/Projects/spotlight'
+
+        if File.exists?("/Volumes/TempStorage/Projects/spotlight/spec/test_app_templates/Gemfile.extra")
+          eval File.read("/Volumes/TempStorage/Projects/spotlight/spec/test_app_templates/Gemfile.extra"), nil, "/Volumes/TempStorage/Projects/spotlight/spec/test_app_templates/Gemfile.extra"
+        end
+
+gem "devise"
+gem "devise-guests", "~> 0.3"

data/spec/internal/Gemfile.lock

@@ -0,0 +1,240 @@
+GIT
+  remote: git://github.com/sul-dlss/sir-trevor-rails.git
+  revision: 33de17d54122c6ed3fb0fcc25b46ca50979d0bcb
+  specs:
+    sir-trevor-rails (0.2.4)
+      activesupport (>= 3.0.7)
+      jquery-rails
+      rails (>= 3.0.7)
+      redcarpet (~> 2.0.1)
+      twitter-text (~> 1.4)
+      underscore-rails
+
+PATH
+  remote: /Volumes/TempStorage/Projects/spotlight
+  specs:
+    blacklight-spotlight (0.0.1)
+      blacklight (~> 5.0)
+      blacklight-gallery
+      bootstrap_form
+      cancan
+      carrierwave
+      mail_form
+      mini_magick
+      rails (~> 4.0.1)
+      sir-trevor-rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.2)
+      actionpack (= 4.0.2)
+      mail (~> 2.5.4)
+    actionpack (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activerecord (4.0.2)
+      activemodel (= 4.0.2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.2)
+    atomic (1.1.14)
+    bcrypt-ruby (3.1.2)
+    blacklight (5.0.1)
+      bootstrap-sass (~> 3.0)
+      deprecation
+      kaminari (~> 0.13)
+      nokogiri (~> 1.6)
+      rails (>= 3.2.6, < 5)
+      rsolr (~> 1.0.6)
+      sass-rails
+    blacklight-gallery (0.0.1)
+      blacklight (>= 5.0.0.pre4, < 6.0)
+      bootstrap-sass (~> 3.0)
+      rails
+    bootstrap-sass (3.1.0.2)
+      sass (~> 3.2)
+    bootstrap_form (2.0.1)
+    builder (3.1.4)
+    cancan (1.6.10)
+    capybara (2.2.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    carrierwave (0.9.0)
+      activemodel (>= 3.2.0)
+      activesupport (>= 3.2.0)
+      json (>= 1.7)
+    cliver (0.3.2)
+    coffee-rails (4.0.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.7.0)
+    database_cleaner (1.2.0)
+    deprecation (0.1.0)
+      activesupport
+    devise (3.2.2)
+      bcrypt-ruby (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 3.2.6, < 5)
+      thread_safe (~> 0.1)
+      warden (~> 1.2.3)
+    devise-guests (0.3.2)
+      devise
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    execjs (2.0.2)
+    factory_girl (4.3.0)
+      activesupport (>= 3.0.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    jbuilder (1.5.3)
+      activesupport (>= 3.0.0)
+      multi_json (>= 1.2.0)
+    jquery-rails (3.1.0)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.1)
+    kaminari (0.15.1)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mail_form (1.5.0)
+      actionmailer (>= 3.2, < 5)
+      activemodel (>= 3.2, < 5)
+    mime-types (1.25.1)
+    mini_magick (3.7.0)
+      subexec (~> 0.2.1)
+    mini_portile (0.5.2)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    orm_adapter (0.5.0)
+    poltergeist (1.5.0)
+      capybara (~> 2.1)
+      cliver (~> 0.3.1)
+      multi_json (~> 1.0)
+      websocket-driver (>= 0.2.0)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.2)
+      actionmailer (= 4.0.2)
+      actionpack (= 4.0.2)
+      activerecord (= 4.0.2)
+      activesupport (= 4.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.2)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.2)
+      actionpack (= 4.0.2)
+      activesupport (= 4.0.2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.1)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    redcarpet (2.0.1)
+    rsolr (1.0.9)
+      builder (>= 2.1.2)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    rspec-rails (2.14.1)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    sass (3.2.14)
+    sass-rails (4.0.1)
+      railties (>= 4.0.0, < 5.0)
+      sass (>= 3.1.10)
+      sprockets-rails (~> 2.0.0)
+    sdoc (0.4.0)
+      json (~> 1.8)
+      rdoc (~> 4.0, < 5.0)
+    sprockets (2.10.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    subexec (0.2.3)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    turbolinks (2.2.1)
+      coffee-rails
+    twitter-text (1.7.0)
+      unf (~> 0.1.0)
+    tzinfo (0.3.38)
+    uglifier (2.4.0)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+    underscore-rails (1.5.2)
+    unf (0.1.3)
+      unf_ext
+    unf_ext (0.0.6)
+    warden (1.2.3)
+      rack (>= 1.0)
+    websocket-driver (0.3.2)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blacklight (~> 5.0)
+  blacklight-spotlight!
+  coffee-rails (~> 4.0.0)
+  database_cleaner
+  devise
+  devise-guests (~> 0.3)
+  factory_girl
+  jbuilder (~> 1.2)
+  jquery-rails
+  poltergeist
+  rails (= 4.0.2)
+  rspec-rails
+  sass-rails (~> 4.0.0)
+  sdoc
+  sir-trevor-rails!
+  sqlite3
+  turbolinks
+  uglifier (>= 1.3.0)

data/spec/internal/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/internal/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Internal::Application.load_tasks

data/spec/internal/app/assets/javascripts/application.js

@@ -0,0 +1,19 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//
+// Required by Blacklight
+//= require blacklight/blacklight
+//= require_tree .

data/spec/internal/app/assets/javascripts/spotlight.js

@@ -0,0 +1 @@
+//= require spotlight/application

data/spec/internal/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/internal/app/assets/stylesheets/blacklight.css.scss

@@ -0,0 +1,3 @@
+@import 'bootstrap';
+
+@import 'blacklight/blacklight';

data/spec/internal/app/assets/stylesheets/spotlight.css.scss

@@ -0,0 +1,3 @@
+/*
+ *= require spotlight/application
+ */

data/spec/internal/app/controllers/application_controller.rb

@@ -0,0 +1,14 @@
+class ApplicationController < ActionController::Base
+  # Adds a few additional behaviors into the application controller 
+   include Blacklight::Controller
+  include Spotlight::Controller
+
+  # Please be sure to impelement current_user and user_session. Blacklight depends on 
+  # these methods in order to perform user specific actions. 
+
+  layout 'blacklight'
+
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/internal/app/controllers/catalog_controller.rb

@@ -0,0 +1,92 @@
+# -*- encoding : utf-8 -*-
+require 'blacklight/catalog'
+
+class CatalogController < ApplicationController  
+
+  include Blacklight::Catalog
+  include Spotlight::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