commonwealth-vlr-engine 0.0.1

data/spec/lib/commonwealth-vlr-engine/iiif_manifest_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+describe CommonwealthVlrEngine::IiifManifest do
+
+  include Blacklight::SearchHelper
+
+  class IiifManifestTestClass < IiifManifestController
+    include CommonwealthVlrEngine::Finder
+  end
+
+  before { @obj = IiifManifestTestClass.new }
+
+  let(:document) { Blacklight.default_index.search({:q => "id:\"bpl-dev:h702q6403\"", :rows => 1}).documents.first }
+  let(:image_files) { @obj.get_files(document.id)[:images] }
+  let(:image_id_suffix) { image_files.first.id.gsub(/\A[\w-]+:/,'/') }
+
+  describe 'create_iiif_manifest' do
+
+    before { @manifest = @obj.create_iiif_manifest(document, image_files) }
+
+    it 'should create an instance of IIIF::Presentation::Manifest' do
+      expect(@manifest).not_to be_nil
+      expect(@manifest.class).to eq(IIIF::Presentation::Manifest)
+    end
+
+    it 'should have metadata, sequences, canvases, images, and resources' do
+      expect(@manifest.metadata.empty?).not_to be_truthy
+      expect(@manifest.sequences.empty?).not_to be_truthy
+      expect(@manifest.sequences[0].canvases.empty?).not_to be_truthy
+      expect(@manifest.sequences[0].canvases[0].images.empty?).not_to be_truthy
+      expect(@manifest.sequences[0].canvases[0].images[0].resource).not_to be_nil
+    end
+
+    it 'should have the right id' do
+      expect(@manifest['@id']).to eq("#{document[:identifier_uri_ss]}/manifest")
+    end
+
+  end
+
+  describe 'canvas_from_id' do
+
+    before { @canvas = @obj.canvas_from_id(image_files.first.id, 'image1', document) }
+
+    it 'should create an instance of IIIF::Presentation::Canvas' do
+      expect(@canvas).not_to be_nil
+      expect(@canvas.class).to eq(IIIF::Presentation::Canvas)
+    end
+
+    it 'should have images and resources' do
+      expect(@canvas.images.empty?).not_to be_truthy
+      expect(@canvas.images[0].resource).not_to be_nil
+    end
+
+    it 'should have the right id' do
+      expect(@canvas['@id']).to eq("#{document[:identifier_uri_ss]}/canvas#{image_id_suffix}")
+    end
+
+  end
+
+  describe 'image_annotation_from_image_id' do
+
+    before { @annotation = @obj.image_annotation_from_image_id(image_files.first.id, document) }
+
+    it 'should create an instance of IIIF::Presentation::Annotation' do
+      expect(@annotation).not_to be_nil
+      expect(@annotation.class).to eq(IIIF::Presentation::Annotation)
+    end
+
+    it 'should have a resource' do
+      expect(@annotation.resource).not_to be_nil
+    end
+
+    it 'should have the right id' do
+      expect(@annotation['@id']).to eq("#{document[:identifier_uri_ss]}/annotation#{image_id_suffix}")
+    end
+
+  end
+
+  describe 'image_resource_from_image_id' do
+
+    before { @image_resource = @obj.image_resource_from_image_id(image_files.first.id, document) }
+
+    it 'should create an instance of IIIF::Presentation::ImageResource' do
+      expect(@image_resource).not_to be_nil
+      expect(@image_resource.class).to eq(IIIF::Presentation::ImageResource)
+    end
+
+    it 'should represent an image' do
+      expect(@image_resource.format).to eq('image/jpeg')
+      expect(@image_resource.width).not_to be_nil
+    end
+
+    it 'should have the right id' do
+      expect(@image_resource['@id']).to eq(document[:identifier_uri_ss].gsub(/\/[\w]+\z/, image_id_suffix) + "/large_image")
+    end
+
+  end
+
+  describe 'collection_for_manifests' do
+
+    let(:series_document) { Blacklight.default_index.search({:q => "id:\"bpl-dev:3j334b469\"", :rows => 1}).documents.first }
+    let(:manifest_docs) { @obj.get_volume_objects(series_document.id) }
+
+    before { @collection = @obj.collection_for_manifests(series_document, manifest_docs) }
+
+    it 'should create an instance of IIIF::Presentation::Collection' do
+      expect(@collection).not_to be_nil
+      expect(@collection.class).to eq(IIIF::Presentation::Collection)
+    end
+
+    it 'should have contain a list of manifests' do
+      expect(@collection.manifests.length).to eq(2)
+      expect(@collection.manifests.first['@id']).to include('3j334603p')
+    end
+
+    it 'should have the right id' do
+      expect(@collection['@id']).to eq(series_document[:identifier_uri_ss].gsub(/\/[\w]+\z/,"/collection\\0"))
+    end
+
+  end
+
+  describe 'manifest_metadata' do
+
+    before { @manifest_metadata = @obj.manifest_metadata(document) }
+
+    it 'should create a hash of metadata' do
+      expect(@manifest_metadata.empty?).to be_falsey
+    end
+
+    it 'should have a bunch of metadata about the item' do
+      expect(@manifest_metadata.find { |field| field[:label] == I18n.t('blacklight.metadata_display.fields.title') }[:value]).to eq(document[IiifManifestTestClass.blacklight_config.index.title_field.to_sym])
+      expect(@manifest_metadata.find { |field| field[:label] == I18n.t('blacklight.metadata_display.fields.collection') }[:value]).to eq(document[:related_item_host_ssim].first)
+    end
+
+  end
+
+  describe 'manifest_attribution' do
+
+    before { @manifest_attribution = @obj.manifest_attribution(document) }
+
+    it 'should create an attribution string' do
+      expect(@manifest_attribution).to include('No known copyright restrictions')
+    end
+
+  end
+
+  describe 'label_for_canvas' do
+
+    before { @label_for_canvas = @obj.label_for_canvas(image_files.first, 0) }
+
+    it 'should return the correct label' do
+      expect(@label_for_canvas).to eq('Front')
+    end
+
+  end
+
+end

data/spec/lib/commonwealth-vlr-engine/render_constraints_override_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe CommonwealthVlrEngine::RenderConstraintsOverride do
+
+  class RenderConstraintsOverrideTestClass < CatalogController
+    attr_accessor :params
+  end
+
+  before(:each) do
+    @fake_controller = RenderConstraintsOverrideTestClass.new
+    @fake_controller.extend(CommonwealthVlrEngine::RenderConstraintsOverride)
+    @fake_controller.params = { mlt_id: 'bpl-dev:h702q6403' }
+  end
+
+  describe "testing for mlt parameters" do
+
+    describe "has_mlt_parameters?" do
+
+      it "should be true if mlt params are present" do
+        expect(@fake_controller.has_mlt_parameters?).to be true
+      end
+
+    end
+
+    describe "has_search_parameters?" do
+
+      it "should be true if mlt params are present" do
+        expect(@fake_controller.has_search_parameters?).to be true
+      end
+
+    end
+
+  end
+
+  describe "render_constraint_element" do
+
+    # TODO: can't get the spec below to pass, getting error:
+    # NoMethodError: super: no superclass method `render_constraint_element'
+
+    it "should render AZ link constraints properly" #do
+      #expect(@fake_controller.render_constraint_element(nil, "title_info_primary_ssort:B*")).to
+        #have_content("Starts with")
+    #end
+
+  end
+
+  describe "render mlt constraints" do
+
+    before do
+      @test_params = @fake_controller.params
+    end
+
+    describe "query_has_constraints?" do
+
+      it "should be true if there are mlt params" do
+        expect(@fake_controller.query_has_constraints?).to be true
+      end
+
+    end
+
+
+    describe "render_mlt_query" do
+
+      before :each do
+        # have to create a request or call to 'url_for' returns an error
+        @fake_controller.request = ActionDispatch::Request.new(params:{controller: 'catalog', action: 'index'})
+        @fake_controller.request.path_parameters[:controller] = 'catalog'
+      end
+
+      # TODO: can't get these specs to pass, getting error:
+      # NoMethodError: undefined method `render_constraint_element'
+
+      it "should render the mlt id" #do
+        #expect(@fake_controller.render_mlt_query(@test_params)).to have_content(@fake_controller.params[:mlt_id])
+      #end
+
+      it "should remove spatial params in the 'remove' link" #do
+      #expect(@fake_controller.render_mlt_query(@test_params)).to_not have_content("spatial_search_type")
+      #end
+
+    end
+
+    describe "render_search_to_s_mlt" do
+
+      it "should return render_search_to_s_element when mlt params are present" do
+        expect(@fake_controller).to receive(:render_search_to_s_element)
+        expect(@fake_controller).to receive(:render_filter_value)
+        @fake_controller.render_search_to_s_mlt(@test_params)
+      end
+
+    end
+
+  end
+
+
+
+end

data/spec/mailers/notifier_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe CommonwealthVlrEngine::Notifier do
+
+  describe "feedback" do
+
+    before(:each) do
+      @test_params = {
+          :name => "Testy McGee",
+          :email => "testy@example.com",
+          :topic => "image reproduction",
+          :message => "Test message"
+      }
+      @test_feedback_email = Notifier.feedback(@test_params)
+    end
+
+    it "should create the email" do
+      expect(@test_feedback_email).not_to be_nil
+    end
+
+    it "should have the right user email in the text" do
+      expect(@test_feedback_email.body.encoded).to include(@test_params[:email])
+    end
+
+    it "should have the right receiver email address" do
+      expect(@test_feedback_email.to[0]).to eq(CONTACT_EMAILS['image_requests'])
+    end
+
+  end
+
+end

data/spec/models/carousel_slide_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe CarouselSlide do
+
+  before(:each) do
+    @slide_attr = {
+      :sequence => 1,
+      :object_pid => 'bpl-dev:123456',
+      :image_pid => 'bpl-dev:7891011',
+      :size => '570,',
+      :region => '250,90,295,570',
+      :title => 'The Slide Title',
+      :institution => 'Institution Name',
+      :context => 'bpl-dev:0022331'
+    }
+  end
+
+  it 'should create a new slide given valid attributes' do
+    CarouselSlide.create!(@slide_attr)
+  end
+
+  describe 'assign values properly' do
+
+    before(:each) do
+      @slide = CarouselSlide.create!(@slide_attr)
+    end
+
+    it 'should have a title attribute' do
+      expect(@slide).to respond_to(:title)
+    end
+
+    it 'should have the right title' do
+      expect(@slide.title).to eq('The Slide Title')
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'engine_cart'
+require 'coveralls'
+Coveralls.wear!('rails')
+EngineCart.load_application!
+
+require 'capybara/poltergeist'
+Capybara.javascript_driver = :poltergeist
+
+Capybara.register_driver :poltergeist do |app|
+  options = {}
+  options[:js_errors] = false
+  options[:timeout] = 120 if RUBY_PLATFORM == "java"
+  Capybara::Poltergeist::Driver.new(app, options)
+end
+
+if ENV["COVERAGE"] or ENV["CI"]
+  require 'simplecov'
+
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+require 'commonwealth-vlr-engine'
+
+require 'rspec/rails'
+require 'capybara/rspec'
+
+
+RSpec.configure do |config|
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+  config.include Devise::TestHelpers, type: :controller
+  config.infer_spec_type_from_file_location!
+end

data/spec/tasks/vlr_engine_rake_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'rake'
+
+describe 'vlr_engine namespace rake tasks' do
+
+  before :all do
+    Rake.application.rake_require '../tasks/vlr_engine'
+    Rake::Task.define_task(:environment)
+    @time = Time.now.to_f
+  end
+
+  describe 'vlr_engine:create_geojson' do
+
+    let :run_rake_task do
+      Rake::Task['vlr_engine:create_geojson'].reenable
+      Rake.application.invoke_task 'vlr_engine:create_geojson'
+      @file_path = "#{Rails.root.to_s}/#{GEOJSON_STATIC_FILE['filepath']}"
+    end
+
+    it 'should create the geojson file' do
+      run_rake_task
+      expect(File.file?(@file_path)).not_to be_nil
+      expect(File.stat(@file_path).mtime.to_f).to be > @time
+    end
+
+  end
+
+end

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

@@ -0,0 +1,23 @@
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+
+  def remove_index
+    remove_file "public/index.html"
+  end
+
+  def run_blacklight_generator
+    say_status("warning", "GENERATING BL", :yellow)
+
+    Bundler.with_clean_env do
+      run "bundle install"
+    end
+
+    generate 'blacklight:install'
+  end
+
+  def run_vlr_engine_install
+    generate 'commonwealth_vlr_engine:install'
+  end
+
+end

data/tasks/vlr_engine.rake

@@ -0,0 +1,46 @@
+# rake tasks for Commonwealth-public-interface
+
+namespace :vlr_engine do
+
+  desc 'generate the static geojson file for catalog#map view'
+  task :create_geojson => :environment do
+
+    include BlacklightMapsHelper
+
+    def blacklight_config
+      CatalogController.blacklight_config
+    end
+
+    class BlacklightGeojsonTestClass < CatalogController
+      include Blacklight::SearchHelper
+    end
+
+    @controller = BlacklightGeojsonTestClass.new
+    @controller.request = ActionDispatch::TestRequest.new
+
+    (@response, @document_list) = @controller.search_results({},@controller.search_params_logic)
+
+    geojson_features = serialize_geojson(map_facet_values, 'index')
+    if geojson_features
+      File.open("#{Rails.root.to_s}/#{GEOJSON_STATIC_FILE['filepath']}", 'w') {|f| f.write(geojson_features) }
+      puts 'The GeoJSON file has successfully been created'
+    else
+      puts 'ERROR: The GeoJSON file was not created!'
+    end
+
+  end
+
+  desc "Put sample data into test app solr"
+  namespace :test_index do
+    task :seed do
+      require 'yaml'
+      docs = YAML::load(File.open(File.expand_path(File.join('..', '..', '..', 'fixtures', 'sample_solr_documents.yml'), __FILE__)))
+      #Blacklight.solr.add docs
+      #Blacklight.solr.commit
+      conn = Blacklight.default_index.connection
+      conn.add docs
+      conn.commit
+    end
+  end
+
+end