commonwealth-vlr-engine 0.0.1

data/spec/helpers/collections_helper_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe CollectionsHelper do
+
+  let(:blacklight_config) { CatalogController.blacklight_config }
+
+  before(:each) do
+    allow(helper).to receive_messages(blacklight_config: blacklight_config)
+  end
+
+  describe '#link_to_all_col_items' do
+    before { @coll_items_link = helper.link_to_all_col_items('Foo Collection', 'Bar Institution', 'baz') }
+    it 'should create a search link with the correct collection and institution params' do
+      expect(@coll_items_link).to include("#{blacklight_config.collection_field}%5D%5B%5D=Foo+Collection")
+      expect(@coll_items_link).to include("#{blacklight_config.institution_field}%5D=Bar+Institution")
+    end
+  end
+
+  # TODO: figure out why this spec doesn't pass when run in CI/run-all-specs testing
+  # getting NoMethodError: private method 'should_render_col_az?' called
+  # works fine in context of this single spec though
+  describe '#should_render_col_az?' do
+    it 'should return false' #do
+      #expect(helper.should_render_col_az?).to be_falsey
+    #end
+  end
+
+end

data/spec/helpers/component_helper_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe ComponentHelper do
+
+  include Blacklight::SearchHelper
+
+  let(:document) { Blacklight.default_index.search({:q => 'id:"bpl-dev:h702q6403"', :rows => 1}).documents.first }
+
+  before(:each) do
+    allow(helper).to receive(:has_user_authentication_provider?).and_return(true)
+    allow(helper).to receive(:current_or_guest_user).and_return(true)
+    allow(helper).to receive(:current_user).and_return(User.create!({:email => "testy@test.com", :password => "password"}))
+    @current_bookmarks = [] # have to set this for Blacklight::CatalogHelperBehavior#current_bookmarks
+  end
+
+  describe '#render_show_doc_actions' do
+
+    before { @show_doc_actions = helper.render_show_doc_actions(document, {}) }
+
+    it 'should create the document actions controls wrapper' do
+      expect(@show_doc_actions).to include('<div class="documentFunctions">')
+    end
+
+    it 'should include the catalog/add_this partial' do
+      expect(@show_doc_actions).to include('addthis')
+    end
+
+    it 'should include the catalog/folder_item_control partial' do
+      expect(@show_doc_actions).to include('<div id="folder_item_toggle">')
+    end
+
+  end
+
+end

data/spec/helpers/folders_helper_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe FoldersHelper do
+
+  before(:each) do
+    @test_user = User.create!({:email => 'testy@test.com', :password => 'password'})
+    @folder = @test_user.folders.create!({:title => 'Test Folder Title',:visibility => 'private'})
+  end
+
+  describe '#folder_belongs_to_user' do
+
+    describe 'correct user' do
+      before { allow(helper).to receive(:current_or_guest_user).and_return(@test_user) }
+      it 'should return true if the folder belongs to the current_or_guest_user' do
+        expect(helper.folder_belongs_to_user).to be_truthy
+      end
+    end
+
+    describe 'incorrect user' do
+      before {
+        @wrong_user = User.create!({:email => 'testy2@test2.com', :password => 'password'})
+        allow(helper).to receive(:current_or_guest_user).and_return(@wrong_user)
+      }
+      it 'should return false if the folder does not belong to the current_or_guest_user' do
+        expect(helper.folder_belongs_to_user).to be_falsey
+      end
+    end
+
+  end
+
+end

data/spec/helpers/image_viewer_helper_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe ImageViewerHelper do
+
+  let(:item_pid) { 'bpl-dev:h702q6403' }
+  let(:document) { Blacklight.default_index.search({:q => "id:\"#{item_pid}\"", :rows => 1}).documents.first }
+
+  describe '#book_id' do
+    it 'should return the correct document id' do
+      expect(helper.book_id({is_volume_of_ssim: ['info:fedora/bpl-dev:abcd1234']})).to eq('bpl-dev:abcd1234')
+      expect(helper.book_id(document)).to eq(item_pid)
+    end
+  end
+
+end

data/spec/helpers/institutions_helper_spec.rb

@@ -0,0 +1,53 @@
+# -*- encoding : utf-8 -*-
+
+require 'spec_helper'
+
+describe InstitutionsHelper do
+
+  include Blacklight::SearchHelper
+
+  let(:blacklight_config) { CatalogController.blacklight_config }
+  let(:search_params_logic) { CatalogController.search_params_logic += [:institutions_filter] }
+
+  before :each do
+    allow(helper).to receive_messages(blacklight_config: blacklight_config)
+  end
+
+  describe '#link_to_all_inst_items' do
+    before { @institution_title = 'Foo Institution'}
+    it 'should create a search link with the correct institution params' do
+      expect(helper.link_to_all_inst_items('foo')).to include("#{blacklight_config.institution_field}%5D%5B%5D=Foo+Institution")
+    end
+  end
+
+  describe 'render_institutions_index' do
+
+    before { (@response, @document_list) = search_results({}, search_params_logic) }
+
+    describe 'with default document_index_view_type' do
+      before { allow(helper).to receive_messages(document_index_view_type: :list) }
+      subject { helper.render_institutions_index }
+      it { should have_selector '#documents.documents-list' }
+    end
+
+    describe 'with "maps" document_index_view_type' do
+      before { allow(helper).to receive_messages(document_index_view_type: :maps) }
+      subject { helper.render_institutions_index }
+      it { should have_selector 'div#institutions-index-map' }
+    end
+
+    # remove the instance variables so they don't mess up other specs
+    after {
+      remove_instance_variable(:@response)
+      remove_instance_variable(:@document_list)
+    }
+
+  end
+
+  describe '#should_render_inst_az?' do
+    it 'should return false' do
+     expect(helper.should_render_inst_az?).to be_falsey
+    end
+  end
+
+end

data/spec/helpers/ocr_search_helper_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe OcrSearchHelper do
+
+  class OcrSearchHelperTestClass < CatalogController
+    cattr_accessor :blacklight_config
+
+    include Blacklight::SearchHelper
+    include CommonwealthVlrEngine::Finder
+    include CommonwealthVlrEngine::CatalogHelper
+
+    def initialize blacklight_config
+      self.blacklight_config = blacklight_config
+    end
+  end
+
+  let(:blacklight_config) { CatalogController.blacklight_config }
+  let(:ocr_search_helper_test_class) { OcrSearchHelperTestClass.new blacklight_config }
+
+  before(:each) do
+    allow(helper).to receive_messages(blacklight_config: blacklight_config)
+  end
+
+  describe '#ocr_q_params' do
+
+    let(:current_search_session) { double(:query_params => {'q' => 'foo'}) }
+
+    it 'should return the query params if they exist' do
+      expect(helper.send(:ocr_q_params, current_search_session)).to eq('foo')
+    end
+
+  end
+
+  describe '#render_page_link' do
+
+    let(:book_pid) { 'bpl-dev:7s75dn48d' }
+    let(:page_pid) { 'bpl-dev:7s75dn58n' }
+    let(:document) { Blacklight.default_index.search({:q => "id:\"#{page_pid}\"", :rows => 1}).documents.first }
+    let(:image_pid_list) { ocr_search_helper_test_class.has_image_files?(ocr_search_helper_test_class.get_files(book_pid)) }
+
+    describe 'with a page_num_field value' do
+
+      before { @ocr_page_link = helper.render_page_link(document, image_pid_list, book_pid) }
+
+      it 'should create a link to the book viewer' do
+        expect(@ocr_page_link).to include("href=\"/book_viewer/#{book_pid}?ocr_q=#1/1")
+      end
+
+      it 'should have the correct label' do
+        expect(@ocr_page_link).to include(document[blacklight_config.page_num_field.to_sym])
+      end
+
+    end
+
+    describe 'without page_num_field value' do
+
+      before do
+        document[blacklight_config.page_num_field.to_sym] = nil
+        @ocr_page_link = helper.render_page_link(document, image_pid_list, book_pid)
+      end
+
+      it 'should have the correct label' do
+        expect(@ocr_page_link).to include('Image 1')
+      end
+
+    end
+
+  end
+
+end

data/spec/helpers/pages_helper_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe PagesHelper do
+
+  describe '#render_blog_feed' do
+
+    let(:rendered_feed) { helper.render_blog_feed(File.open(File.expand_path(File.join('..', '..', 'fixtures', 'sample_rss_feed.xml'), __FILE__))) }
+
+    it 'should create the correct HTML content' do
+      expect(rendered_feed).to include('<ul class="feed_items">')
+      expect(rendered_feed).to include('<li class="feed_item">')
+      expect(rendered_feed).to include('href="http://blog.somelibrary.org/?p=942">Event 1')
+    end
+
+    it 'should have 4 items' do
+      expect(rendered_feed.scan(/<li class="feed_item">/).count).to eq(4)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe CommonwealthVlrEngine::CommonwealthSearchBuilder do
+
+  class CommonwealthSearchBuilderTestClass
+    cattr_accessor :blacklight_config, :blacklight_params
+
+    include Blacklight::SearchHelper
+    include CommonwealthVlrEngine::CommonwealthSearchBuilder
+
+    def initialize blacklight_config, blacklight_params
+      self.blacklight_config = blacklight_config
+      self.blacklight_params = blacklight_params
+    end
+
+  end
+
+  let(:blacklight_config) { CatalogController.blacklight_config }
+  let(:blacklight_params) { Hash.new }
+  let(:solr_parameters) { Blacklight::Solr::Request.new }
+
+  before { @obj = CommonwealthSearchBuilderTestClass.new blacklight_config, blacklight_params }
+
+  describe 'exclude_unwanted_models' do
+
+    it 'should add parameters to exclude unwanted models' do
+      expect(@obj.exclude_unwanted_models(solr_parameters).to_s).to include('afmodel:Bplmodels_File')
+    end
+
+  end
+
+  describe 'exclude_unpublished_items' do
+
+    let(:excluded_unpublished) { @obj.exclude_unpublished_items(solr_parameters).to_s }
+
+    it 'should add parameters to exclude non-published items' do
+      expect(excluded_unpublished).to include('draft')
+      expect(excluded_unpublished).to include('needs_review')
+      expect(excluded_unpublished).to include('derivatives')
+    end
+
+  end
+
+  describe 'exclude_institutions' do
+
+    it 'should add parameters to exclude institutions' do
+      expect(@obj.exclude_institutions(solr_parameters).to_s).to include('-active_fedora_model_suffix_ssi:\"Institution\"')
+    end
+
+  end
+
+  describe 'flagged_filter' do
+
+    it 'should add parameters to exclude flagged items' do
+      expect(@obj.flagged_filter(solr_parameters).to_s).to include("-#{blacklight_config.flagged_field}:[* TO *]")
+    end
+
+  end
+
+  describe 'institutions_filter' do
+
+    it 'should add parameters to require institutions' do
+      expect(@obj.institutions_filter(solr_parameters).to_s).to include('+active_fedora_model_suffix_ssi:\"Institution\"')
+    end
+
+  end
+
+  describe 'set_solr_id_for_mlt' do
+
+    before {blacklight_params[:mlt_id] = 'bpl-dev:12345678'}
+
+    it 'should set the id param to the mlt_id value' do
+      expect(@obj.set_solr_id_for_mlt(solr_parameters)).to eq('bpl-dev:12345678')
+    end
+
+  end
+
+  describe 'collections_filter' do
+
+    it 'should add parameters to require institutions' do
+      expect(@obj.collections_filter(solr_parameters).to_s).to include('+active_fedora_model_suffix_ssi:\"Collection\"')
+    end
+
+  end
+
+  describe 'ocr_search_params' do
+
+    before do
+      @obj.ocr_search_params(solr_parameters)
+    end
+
+    it 'should add parameters for field highlighting' do
+      expect(solr_parameters.to_s).to include('"hl"=>true')
+      expect(solr_parameters.to_s).to include('hl.fragsize')
+      expect(solr_parameters.to_s).to include("\"hl.fl\"=>\"#{blacklight_config.ocr_search_field}\"")
+    end
+
+  end
+
+
+end

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

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe CommonwealthVlrEngine::ControllerOverride do
+
+  class ControllerOverrideTestClass < CatalogController
+    #include CommonwealthVlrEngine::ControllerOverride
+  end
+
+  before { @obj = ControllerOverrideTestClass.new }
+
+  describe 'search_params_logic' do
+
+    it 'should have exclude_unwanted_models included' do
+      expect(@obj.search_params_logic).to include(:exclude_unwanted_models)
+    end
+
+    it 'should have exclude_unpublished_items included' do
+      expect(@obj.search_params_logic).to include(:exclude_unpublished_items)
+    end
+
+  end
+
+  describe 'search_builder_class' do
+
+    it 'should have CommonwealthSearchBuilder included' do
+      expect(@obj.blacklight_config.search_builder_class).to include(CommonwealthVlrEngine::CommonwealthSearchBuilder)
+    end
+
+  end
+
+  describe 'add_institution_fields' do
+
+    # this spec needs more work. not sure how to set appropriate institution stuff so it will pass
+    # subject { @obj.send(:add_institution_fields) } ## not sure if I should use this??
+    it 'should add institution facets to the blacklight_config' #do
+    #  expect(@obj.blacklight_config.facet_fields).to include('physical_location_ssim')
+    #end
+
+  end
+
+end

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

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe CommonwealthVlrEngine::Controller do
+
+  class ControllerTestClass < ActionController::Base
+      include CommonwealthVlrEngine::Controller
+  end
+
+  before { @obj = ControllerTestClass.new }
+
+  describe 'create_img_sequence' do
+
+    before do
+      @image_files = ['bpl-dev:h702q641c', 'bpl-dev:h702q642n']
+      @current_img_pid = 'bpl-dev:h702q642n'
+      @img_seq = @obj.create_img_sequence @image_files, @current_img_pid
+    end
+
+    it 'should set the index to the correct value' do
+      expect(@img_seq[:index]).to eq(2)
+    end
+
+    it 'should set the previous image to the correct value' do
+      expect(@img_seq[:prev]).to eq(@image_files[0])
+    end
+
+    it 'should set the next image to the correct value' do
+      expect(@img_seq[:next]).to eq(nil)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+describe CommonwealthVlrEngine::Finder do
+
+  class FinderTestClass
+    cattr_accessor :blacklight_config
+
+    include Blacklight::SearchHelper
+    include CommonwealthVlrEngine::Finder
+
+    def initialize blacklight_config
+      self.blacklight_config = blacklight_config
+    end
+
+  end
+
+  let(:blacklight_config) { Blacklight::Configuration.new }
+
+  before do
+    @obj = FinderTestClass.new blacklight_config
+    @item_pid = 'bpl-dev:h702q6403'
+    @image1_pid = 'bpl-dev:h702q641c'
+    @image2_pid = 'bpl-dev:h702q642n'
+  end
+
+  describe 'get_files' do
+
+    let (:return_hash) { @obj.get_files(@item_pid) }
+
+    it 'should create a hash with the file objects' do
+      expect(return_hash.empty?).to be_falsey
+      expect(return_hash.length).to eq(5)
+    end
+
+    it 'should have an :images key with a hash of Bplmodel::ImageFile SolrDocs as the value' do
+      expect(return_hash[:images].length).to eq(2)
+      expect(return_hash[:images][0].class).to eq(SolrDocument)
+      expect(return_hash[:images][0]['active_fedora_model_ssi']).to eq('Bplmodels::ImageFile')
+    end
+
+    it 'should have the right ImageFile objects for the item' do
+      expect(return_hash[:images].to_s).to include(@image1_pid)
+    end
+
+    describe 'sort_files' do
+
+      it 'should have the images in the right order' do
+        expect(return_hash[:images][0]['id']).to eq(@image1_pid)
+        expect(return_hash[:images][1]['id']).to eq(@image2_pid)
+      end
+
+    end
+
+  end
+
+  describe 'get_image_files' do
+
+    let(:pid) { 'bpl-dev:h702q6403' }
+    let (:return_list) { @obj.get_image_files(pid) }
+
+    it 'should create an array with the ImageFile objects' do
+      expect(return_list.empty?).to be_falsey
+      expect(return_list.length).to eq(2)
+      expect(return_list[0]['active_fedora_model_ssi']).to eq('Bplmodels::ImageFile')
+    end
+
+    it 'should have the right ImageFile objects for the item, in the right order' do
+      expect(return_list[0]['id']).to eq(@image1_pid)
+    end
+
+  end
+
+  describe 'get_first_image_file' do
+
+    let (:response) { @obj.get_first_image_file(@item_pid) }
+
+    it 'should return the first ImageFile object' do
+      expect(response).not_to be_nil
+      expect(response['id']).to eq(@image1_pid)
+    end
+
+  end
+
+  describe 'get_next_image_file' do
+
+    let (:response) { @obj.get_next_image_file(@image1_pid) }
+
+    it 'should return the next ImageFile object' do
+      expect(response).not_to be_nil
+      expect(response['id']).to eq(@image2_pid)
+    end
+
+  end
+
+  describe 'get_prev_image_file' do
+
+    let (:response) { @obj.get_prev_image_file(@image2_pid) }
+
+    it 'should return the next ImageFile object' do
+      expect(response).not_to be_nil
+      expect(response['id']).to eq(@image1_pid)
+    end
+
+  end
+
+  describe 'get_file_parent_object' do
+
+    let (:response) { @obj.get_file_parent_object(@image2_pid) }
+
+    it 'should return the parent object' do
+      expect(response).to eq(@item_pid)
+    end
+
+  end
+
+  describe 'get_volume_objects' do
+
+    let(:pid) { 'bpl-dev:3j334b469' }
+    let (:return_list) { @obj.get_volume_objects(pid) }
+
+    it 'should return an array of hashes with the Volume objects and files' do
+      expect(return_list.class).to eq(Array)
+      expect(return_list.length).to eq(2)
+      expect(return_list[0].class).to eq(Hash)
+    end
+
+    it 'should return the volume document in the :vol_doc value' do
+      expect(return_list[0][:vol_doc].id).to eq('bpl-dev:3j334603p')
+      expect(return_list[0][:vol_doc]['active_fedora_model_ssi']).to eq('Bplmodels::Volume')
+    end
+
+    it 'should return the volume files in the :vol_files value' do
+      expect(return_list[0][:vol_files][:ereader].length).to eq(1)
+      expect(return_list[0][:vol_files][:ereader].first.id).to eq('bpl-dev:3j334b41x')
+    end
+
+  end
+
+
+end