blacklight-spotlight 0.4.1 → 0.5.0

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-ENV["RAILS_ENV"] ||= 'test'
+ENV['RAILS_ENV'] ||= 'test'
 
 require 'factory_girl'
 require 'database_cleaner'
@@ -13,7 +13,7 @@ require 'rspec/active_model/mocks'
 
 require 'capybara/poltergeist'
 
-if ENV["POLTERGEIST_DEBUG"]
+if ENV['POLTERGEIST_DEBUG']
   Capybara.register_driver :poltergeist_debug do |app|
     Capybara::Poltergeist::Driver.new(app, inspector: true, phantomjs_options: ['--load-images=no'])
   end
@@ -24,33 +24,26 @@ else
   end
   Capybara.javascript_driver = :poltergeist
 end
-Capybara.default_wait_time = 10
+Capybara.default_max_wait_time = 10
 
-# Setting this to false when running tests so that we don't have to set up
-# exhibit specific solr documents for tests that don't use the default exhibit.
-Spotlight::Engine.config.filter_resources_by_exhibit = false
-
-
-if ENV["COVERAGE"] or ENV["CI"]
+if ENV['COVERAGE'] || ENV['CI']
   require 'simplecov'
-  require 'coveralls' if ENV["CI"]
+  require 'coveralls' if ENV['CI']
 
-  SimpleCov.formatter = Coveralls::SimpleCov::Formatter if ENV["CI"]
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter if ENV['CI']
   SimpleCov.start do
-    add_filter "/spec/"
+    add_filter '/spec/'
   end
 end
 
 require 'spotlight'
 
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
 
-Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
-
-FactoryGirl.definition_file_paths = [File.expand_path("../factories", __FILE__)]
+FactoryGirl.definition_file_paths = [File.expand_path('../factories', __FILE__)]
 FactoryGirl.find_definitions
 
-FIXTURES_PATH = File.expand_path("../fixtures", __FILE__);
-
+FIXTURES_PATH = File.expand_path('../fixtures', __FILE__)
 
 RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
@@ -73,9 +66,7 @@ RSpec.configure do |config|
     DatabaseCleaner.clean
   end
 
-  if ENV['CI']
-    config.filter_run_excluding js: true
-  end
+  config.filter_run_excluding js: true if ENV['CI']
 
   config.include Devise::TestHelpers, type: :controller
   config.include Devise::TestHelpers, type: :view
@@ -87,8 +78,8 @@ RSpec.configure do |config|
   config.include Spotlight::TestFeaturesHelpers, type: :feature
 end
 
-def add_new_page_via_button(title="New Page")
-  add_link = find("[data-expanded-add-button]")
+def add_new_page_via_button(title = 'New Page')
+  add_link = find('[data-expanded-add-button]')
   within(add_link) do
     expect(page).to have_css("input[type='text']", visible: false)
   end

data/spec/support/features/test_features_helpers.rb

@@ -1,64 +1,68 @@
-module Spotlight::TestFeaturesHelpers
-  def fill_in_typeahead_field opts = {}
-    # Poltergeist / Capybara doesn't fire the events typeahead.js
-    # is listening for, so we help it out a little:
-    page.execute_script <<-EOF
-      $("[data-twitter-typeahead]").val("#{opts[:with]}").trigger("input");
-      $("[data-twitter-typeahead]").typeahead("open");
-      $(".tt-suggestion").click();
-    EOF
+module Spotlight
+  module TestFeaturesHelpers
+    def fill_in_typeahead_field(opts = {})
+      # Poltergeist / Capybara doesn't fire the events typeahead.js
+      # is listening for, so we help it out a little:
+      page.execute_script <<-EOF
+        $("[data-twitter-typeahead]").val("#{opts[:with]}").trigger("input");
+        $("[data-twitter-typeahead]").typeahead("open");
+        $(".tt-suggestion").click();
+      EOF
 
-    find('.tt-suggestion', text: opts[:with], match: :first).click
-  end
-
-  def add_widget type = nil
-    # Lame hack to get the sir-trevor Add widget link to work.
-    # Not sure if it's the font-icon delayed loading, or something weird w/ the
-    # test under javascript where the click handler hasn't been applied when the click happens,
-    # but clicking on it an additional time seems to do the trick. 5 times is totally arbitrary,
-    # it seems to work after the first attempt.
-    5.times do
-      break if all("a[data-type]").present?
-      find('[data-icon="add"]').click
-      sleep(0.1)
+      find('.tt-suggestion', text: opts[:with], match: :first).click
     end
 
-    if type
+    def add_widget(type)
+      click_add_widget
+
       # click the item + image widget
       expect(page).to have_css("a[data-type='#{type}']")
       find("a[data-type='#{type}']").click
     end
-  end
 
-  def save_page
-    sleep 1
-    click_button("Save changes")
-    # verify that the page was created
-    expect(page).to have_content("page was successfully updated")
-  end
+    def click_add_widget
+      # Lame hack to get the sir-trevor Add widget link to work.
+      # Not sure if it's the font-icon delayed loading, or something weird w/ the
+      # test under javascript where the click handler hasn't been applied when the click happens,
+      # but clicking on it an additional time seems to do the trick. 5 times is totally arbitrary,
+      # it seems to work after the first attempt.
+      5.times do
+        break if all('a[data-type]').present?
+        find('[data-icon="add"]').click
+        sleep(0.1)
+      end
+    end
 
-  RSpec::Matchers.define :have_breadcrumbs do |*expected|
-    match do |actual|
-      errors = []
-      errors << "Unable to find breadcrumbs" unless actual.has_css? ".breadcrumb"
+    def save_page
+      sleep 1
+      click_button('Save changes')
+      # verify that the page was created
+      expect(page).to have_content('page was successfully updated')
+    end
+
+    RSpec::Matchers.define :have_breadcrumbs do |*expected|
+      match do |actual|
+        errors = []
+        errors << 'Unable to find breadcrumbs' unless actual.has_css? '.breadcrumb'
+
+        breadcrumbs = expected.dup
 
-      breadcrumbs = expected.dup
+        actual.within('.breadcrumb') do
+          last = breadcrumbs.pop
+          breadcrumbs.each do |e|
+            errors << "Unable to find breadcrumb #{e}" unless actual.has_link? e
+          end
 
-      actual.within(".breadcrumb") do
-        last = breadcrumbs.pop
-        breadcrumbs.each do |e|
-          errors << "Unable to find breadcrumb #{e}" unless actual.has_link? e
+          errors << "Unable to find breadcrumb #{last}" unless actual.has_content? last
+          errors << "Expected #{last} not to be a link" if actual.has_link? last
         end
 
-        errors << "Unable to find breadcrumb #{last}" unless actual.has_content? last
-        errors << "Expected #{last} not to be a link" if actual.has_link? last
+        errors.empty?
       end
 
-      errors.empty?
-    end
-
-    failure_message do |actual|
-      "expected that #{actual.all(".breadcrumb li").map { |x| x.text }.join(" / ")} would include #{expected.join(" / ")}"
+      failure_message do |actual|
+        "expected that #{actual.all('.breadcrumb li').map(&:text).join(' / ')} would include #{expected.join(' / ')}"
+      end
     end
   end
 end

data/spec/support/views/test_view_helpers.rb

@@ -9,4 +9,4 @@ module Spotlight
       end
     end
   end
-end
+end

data/spec/test_app_templates/Gemfile.extra

@@ -1 +0,0 @@
-gem "sir_trevor_rails", github: "sul-dlss/sir-trevor-rails"

data/spec/test_app_templates/carrierwave.rb

@@ -1,6 +1,6 @@
-if Rails.env.test? or Rails.env.cucumber?
+if Rails.env.test? || Rails.env.cucumber?
   CarrierWave.configure do |config|
     config.storage = :file
     config.enable_processing = false
   end
-end
+end

data/spec/test_app_templates/catalog_controller.rb

@@ -1,29 +1,28 @@
 # -*- encoding : utf-8 -*-
 require 'blacklight/catalog'
 
-class CatalogController < ApplicationController  
-
+class CatalogController < ApplicationController
   include Blacklight::Catalog
   helper Openseadragon::OpenseadragonHelper
 
   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   => '*'
+    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 
+    ## 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 = {
+    # 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}' 
-    #}
+    #  # :q => '{!raw f=id v=$id}'
+    # }
 
     # solr field configuration for search results/index views
     config.index.title_field = 'full_title_tesim'
@@ -43,24 +42,24 @@ class CatalogController < ApplicationController
     # * 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.    
+    # 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 
+    # 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.  
+    # 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 
+    # :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_ssim', :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_ssim', :label => 'Geographic' 
-    config.add_facet_field 'subject_temporal_ssim', :label => 'Era'  
-    config.add_facet_field 'language_ssim', :label => 'Language'  
+    config.add_facet_field 'genre_ssim', 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_ssim', label: 'Geographic'
+    config.add_facet_field 'subject_temporal_ssim', label: 'Era'
+    config.add_facet_field 'language_ssim', 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
@@ -68,26 +67,30 @@ class CatalogController < ApplicationController
     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'
+    #   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'
+    #   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'
+
+    config.add_search_field 'all_fields', label: 'All fields'
+    config.add_search_field 'title', label: 'Title', solr_local_parameters: { qf: 'full_title_tesim', pf: 'full_title_tesim' }
+    config.add_search_field 'author', label: 'Author', solr_local_parameters: { qf: '$qf_author', pf: '$pf_author' }
 
     config.add_sort_field 'relevance', sort: 'score desc, sort_title_ssi asc', label: 'Relevance'
     config.add_sort_field 'title', sort: 'sort_title_ssi asc', label: 'Title'
@@ -96,7 +99,4 @@ class CatalogController < ApplicationController
     config.add_sort_field 'source', sort: 'sort_source_ssi asc', label: 'Source'
     config.add_sort_field 'identifier', sort: 'id asc', label: 'Identifier'
   end
-
-
-
-end 
+end

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

@@ -1,27 +1,26 @@
 require 'rails/generators'
 
 class TestAppGenerator < Rails::Generators::Base
-  source_root "../../spec/test_app_templates"
+  source_root '../../spec/test_app_templates'
 
   def add_gems
-    gem 'blacklight', ">= 5.4.0.rc1", "<6"
-    gem "blacklight-gallery", ">= 0.3.0"
-    gem "sir_trevor_rails", github: "sul-dlss/sir-trevor-rails"
-    gem "jettywrapper"
+    gem 'blacklight', '~> 5.13'
+    gem 'blacklight-gallery', '>= 0.3.0'
+    gem 'jettywrapper'
     Bundler.with_clean_env do
-      run "bundle install"
+      run 'bundle install'
     end
   end
 
   def run_blacklight_generator
-    say_status("warning", "GENERATING BL", :yellow)
+    say_status('warning', 'GENERATING BL', :yellow)
 
     generate 'blacklight:install', '--devise'
   end
 
   def run_spotlight_migrations
-    rake "spotlight:install:migrations"
-    rake "db:migrate"
+    rake 'spotlight:install:migrations'
+    rake 'db:migrate'
   end
 
   def add_spotlight_routes_and_assets
@@ -29,7 +28,7 @@ class TestAppGenerator < Rails::Generators::Base
   end
 
   def install_test_catalog_controller
-    copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb", force: true
+    copy_file 'catalog_controller.rb', 'app/controllers/catalog_controller.rb', force: true
   end
 
   def add_rake_tasks_to_app
@@ -37,6 +36,16 @@ class TestAppGenerator < Rails::Generators::Base
   end
 
   def disable_carrierwave_processing
-    copy_file "carrierwave.rb", "config/initializers/carrierwave.rb"
+    copy_file 'carrierwave.rb', 'config/initializers/carrierwave.rb'
+  end
+
+  def disable_filter_resources_by_exhibit
+    initializer 'disable_filter_resources_by_exhibit.rb' do
+      <<-EOF
+      # Setting this to false when running tests so that we don't have to set up
+      # exhibit specific solr documents for tests that don't use the default exhibit.
+      Spotlight::Engine.config.filter_resources_by_exhibit = false
+EOF
+    end
   end
 end

data/spec/test_app_templates/spotlight_test.rake

@@ -2,11 +2,11 @@ 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)"
+    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)))
+      docs = YAML.load(File.open(File.expand_path(File.join('..', 'fixtures', 'sample_solr_documents.yml'), Rails.root)))
       Blacklight.default_index.connection.add docs
       Blacklight.default_index.connection.commit
     end
   end
-end
+end

data/spec/uploaders/spotlight/item_uploader_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'carrierwave/test/matchers'
+
+describe Spotlight::ItemUploader do
+  include CarrierWave::Test::Matchers
+  let(:exhibit) { FactoryGirl.create(:exhibit) }
+  let(:resource) { stub_model(Spotlight::Resources::Upload) }
+  before do
+    allow(resource).to receive(:exhibit).and_return(exhibit)
+    described_class.enable_processing = true
+  end
+  after do
+    described_class.enable_processing = false
+  end
+  describe 'default configuration' do
+    subject do
+      described_class.new(resource, :resource)
+    end
+
+    before do
+      subject.store!(File.open(File.expand_path(File.join('..', 'fixtures', '800x600.png'), Rails.root)))
+    end
+
+    after do
+      subject.remove!
+    end
+
+    context 'the thumb version' do
+      it 'scales down an image so that the longest edge is 400px (maintaining aspect ratio)' do
+        expect(subject.thumb).to have_dimensions(400, 300)
+      end
+    end
+
+    context 'the square version' do
+      it 'scales down a landscape image to fit within 100px by 100px' do
+        expect(subject.square).to be_no_larger_than(100, 100)
+      end
+    end
+  end
+  describe 'with added configurations' do
+    subject do
+      described_class.new(resource, :resource)
+    end
+
+    before do
+      Spotlight::ImageDerivatives.spotlight_image_derivatives << {
+        version: :super_tiny,
+        blacklight_config_field: :super_tiny_field,
+        lambda: lambda do
+          version :super_tiny do
+            process resize_to_fill: [25, 25]
+          end
+        end
+      }
+      subject.store!(File.open(File.expand_path(File.join('..', 'fixtures', '800x600.png'), Rails.root)))
+    end
+
+    after do
+      subject.remove!
+    end
+
+    context 'the newly configured version' do
+      pending 'should have the newly configured dimensions' do
+        expect(subject.super_tiny).to have_dimensions(25, 25)
+      end
+    end
+  end
+end