commonwealth-vlr-engine 0.0.4 → 0.0.7

data/spec/helpers/application_helper_spec.rb

@@ -12,9 +12,9 @@ describe ApplicationHelper do
   end
 
   describe '#render_format_index' do
-    let(:args) { {document: {genre_field: 'Maps'}, field: :genre_field} }
+    let(:opts) { {value: ['Maps']} }
     it 'should return the right value' do
-      expect(helper.render_format_index(args)).to eq('Maps/Atlases')
+      expect(helper.render_format_index(opts)).to eq('Maps/Atlases')
     end
   end
 
@@ -25,6 +25,13 @@ describe ApplicationHelper do
     end
   end
 
+  describe '#date_range_constraints_to_s' do
+    let(:sample_params) { {date_start: '1970', date_end: '2000'} }
+    it 'should return the right string' do
+      expect(helper.date_range_constraints_to_s(sample_params)).to eq('1970-2000')
+    end
+  end
+
   describe '#link_to_facet' do
 
     it 'should create a link to catalog#index with the facet params and display value' do

data/spec/helpers/catalog_helper_spec.rb

@@ -76,47 +76,22 @@ describe CatalogHelper do
     end
   end
 
-  describe 'download_links helpers' do
+  describe 'image file helpers' do
 
-    before do
-      # copy :images to :documents, since we don't have any non-image items to test with at the moment
-      files_hash[:documents] = files_hash[:images]
-      @download_links = helper.create_download_links(document, files_hash, 'link_class')
-    end
-
-    describe '#create_download_links' do
-
-      it 'should return an array of links' do
-        expect(@download_links.length).to eq(2)
-        expect(@download_links.first.match(/\A<a[a-z =\\"_]*href=/)).to be_truthy
+    describe '#has_image_files?' do
+      it 'should return true' do
+        expect(helper.has_image_files?(files_hash)).to be_truthy
       end
-
-      it 'should link to the productionMaster datastream' do
-        expect(@download_links.first).to include("href=\"#{FEDORA_URL['url']}/objects/#{image_pid}/datastreams/productionMaster/content")
-      end
-
     end
 
-    describe '#has_downloadable_files?' do
-      it 'should return true if there are documents, audio, or generic files' do
-        expect(helper.has_downloadable_files?(files_hash)).to be_truthy
+    describe '#image_file_pids' do
+      let (:image_file_pids_result) { helper.image_file_pids(files_hash[:images]) }
+      it 'should return an array of ImageFile pids' do
+        expect(image_file_pids_result.length).to eq(2)
+        expect(image_file_pids_result.first).to eq(image_pid)
       end
     end
 
-    describe '#ia_download_title' do
-      it 'should return the correct download title' do
-        expect(helper.ia_download_title('mobi')).to eq('Kindle')
-        expect(helper.ia_download_title('zip')).to eq('Daisy')
-      end
-    end
-
-  end
-
-  describe '#has_image_files?' do
-    it 'should return an array of ImageFile pids' do
-      expect(helper.has_image_files?(files_hash).length).to eq(2)
-      expect(helper.has_image_files?(files_hash).first).to eq(image_pid)
-    end
   end
 
   describe '#has_volumes?' do
@@ -286,12 +261,19 @@ describe CatalogHelper do
 
     describe 'copyright date' do
       it 'should return the correct date value' do
-        expect(helper.render_mods_date('1984', nil, nil, 'copyrightDate')).to eq('c1984')
+        expect(helper.render_mods_date('1984', nil, nil, 'copyrightDate')).to eq('(c) 1984')
       end
     end
 
   end
 
+  describe '#render_search_to_page_title' do
+    before { @page_title = helper.render_search_to_page_title({mlt_id: item_pid}) }
+    it 'should return the correct string for the page title' do
+      expect(@page_title).to include(I18n.t('blacklight.more_like_this.constraint_label'))
+    end
+  end
+
   describe '#render_mods_xml_record' do
     before { @mods_xml_doc = helper.render_mods_xml_record(item_pid) }
     it 'should return the XML document for the MODS record' do
@@ -342,27 +324,29 @@ describe CatalogHelper do
 
     describe '#thumbnail_url' do
 
+      let(:document_to_hash) { document.to_h }
+
       it 'should return the datastream path if there is an exemplary_image_ssi value' do
         expect(helper.thumbnail_url(document)).to eq("#{FEDORA_URL['url']}/objects/#{image_pid}/datastreams/thumbnail300/content")
       end
 
       describe 'with no exemplary image' do
 
-        before { document.delete(:exemplary_image_ssi) }
+        before { document_to_hash.delete('exemplary_image_ssi') }
 
         it 'should return the proper icon if there is a type_of_resource_ssim value' do
-          expect(helper.thumbnail_url(document)).to include('dc_image-icon.png')
+          expect(helper.thumbnail_url(SolrDocument.new(document_to_hash))).to include('dc_image-icon.png')
         end
 
         describe 'with no type_of_resource_ssim value' do
 
           before do
-            document.delete(:type_of_resource_ssim)
-            document[blacklight_config.index.display_type_field.to_sym] = 'Collection'
+            document_to_hash.delete('type_of_resource_ssim')
+            document_to_hash[blacklight_config.index.display_type_field] = 'Collection'
           end
 
           it 'should return the collection icon' do
-            expect(helper.thumbnail_url(document)).to include('dc_collection-icon.png')
+            expect(helper.thumbnail_url(SolrDocument.new(document_to_hash))).to include('dc_collection-icon.png')
           end
 
         end
@@ -371,10 +355,10 @@ describe CatalogHelper do
 
       describe 'flagged item' do
 
-        before { document[blacklight_config.flagged_field.to_sym] = true }
+        before { document_to_hash[blacklight_config.flagged_field] = true }
 
         it 'should return the icon rather than the exemplary image' do
-          expect(helper.thumbnail_url(document)).to include('dc_image-icon.png')
+          expect(helper.thumbnail_url(SolrDocument.new(document_to_hash))).to include('dc_image-icon.png')
         end
 
       end

data/spec/helpers/downloads_helper_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+
+describe DownloadsHelper do
+
+  class DownloadsHelperTestClass < CatalogController
+    cattr_accessor :blacklight_config
+
+    include Blacklight::SearchHelper
+    include CommonwealthVlrEngine::Finder
+
+    def initialize blacklight_config
+      self.blacklight_config = blacklight_config
+    end
+
+  end
+
+  let(:blacklight_config) { CatalogController.blacklight_config }
+  let(:downloads_helper_test_class) { DownloadsHelperTestClass.new blacklight_config }
+  let(:item_pid) { 'bpl-dev:h702q6403' }
+  let(:image_pid) { 'bpl-dev:h702q641c' }
+  let(:document) { Blacklight.default_index.search({:q => "id:\"#{item_pid}\"", :rows => 1}).documents.first }
+  let(:files_hash) { downloads_helper_test_class.get_files(item_pid) }
+  let(:object_profile) { JSON.parse(files_hash[:images].first['object_profile_ssm'].first) }
+
+  before(:each) do
+    allow(helper).to receive_messages(blacklight_config: blacklight_config)
+  end
+
+  before do
+    # copy :images to :documents, since we don't have any non-image items to test with at the moment
+    files_hash[:documents] = files_hash[:images]
+    @download_links = helper.create_download_links(document, files_hash)
+    @image_datastreams_output = helper.image_datastreams(object_profile)
+  end
+
+  describe '#create_download_links' do
+    it 'should return an array of links' do
+      expect(@download_links.length).to eq(5)
+      expect(@download_links.first.match(/\A<a[a-z -=\\"_]*href=/)).to be_truthy
+    end
+  end
+
+  describe '#download_link_class' do
+    it 'should return a string' do
+      expect(helper.download_link_class.class).to eq(String)
+    end
+  end
+
+  describe '#download_link_options' do
+    it 'should return a Hash of link options' do
+      expect(helper.download_link_options[:class]).to be_truthy
+    end
+  end
+
+  describe '#has_downloadable_files?' do
+    it 'should return true if there are documents, audio, or generic files' do
+      expect(helper.has_downloadable_files?(document, files_hash)).to be_truthy
+    end
+  end
+
+  describe '#has_downloadable_images?' do
+    it 'should return true if there are image files and the license allows download' do
+      expect(helper.has_downloadable_images?(document, files_hash)).to be_truthy
+    end
+  end
+
+  describe '#ia_download_title' do
+    it 'should return the correct download title' do
+      expect(helper.ia_download_title('mobi')).to eq('Kindle')
+      expect(helper.ia_download_title('zip')).to eq('Daisy')
+    end
+  end
+
+  describe '#image_datastreams' do
+    it 'should return an array of image datastream ids' do
+      expect(@image_datastreams_output.class).to eq(Array)
+      expect(@image_datastreams_output[0]).to eq('productionMaster')
+    end
+  end
+
+  describe '#image_download_links' do
+
+    before do
+      @image_download_links = helper.image_download_links(document, files_hash[:images])
+    end
+
+    it 'should return an array of links' do
+      expect(@image_download_links.length).to eq(3)
+      expect(@image_download_links.first.match(/\A<a[a-z -=\\"_]*href=/)).to be_truthy
+    end
+
+  end
+
+  describe '#license_allows_download?' do
+    it 'should return true if the license allows download' do
+      expect(helper.license_allows_download?(document)).to be_truthy
+    end
+  end
+
+  describe '#file_download_link' do
+
+    let (:file_download_link_output) { helper.file_download_link(image_pid,
+                                                                 'foo',
+                                                                 object_profile,
+                                                                 @image_datastreams_output[0]) }
+
+    it 'should return a link' do
+      expect(file_download_link_output.match(/\A<a[a-z -=\\"_]*href=/)).to be_truthy
+    end
+
+    it 'should link to the downloads controller show action with the correct datastream param' do
+      expect(file_download_link_output).to include(download_path(image_pid, datastream_id: @image_datastreams_output[0]))
+    end
+
+    it 'should include a <span> with the file type and size' do
+      expect(file_download_link_output).to include('<span')
+      expect(file_download_link_output).to include('TIF')
+      expect(file_download_link_output).to include('10.5 MB')
+    end
+
+  end
+
+  describe '#file_type_string' do
+    it 'should return the correct file type' do
+      expect(helper.file_type_string(@image_datastreams_output[0], object_profile)).to eq('TIF')
+      expect(helper.file_type_string(@image_datastreams_output[1], nil)).to eq('JPEG')
+    end
+  end
+
+  describe '#file_size_string' do
+    it 'should return the correct file size' do
+      expect(helper.file_size_string(@image_datastreams_output[0], object_profile)).to eq('10.5 MB')
+      expect(helper.file_size_string(@image_datastreams_output[1], nil)).to eq('multi-file ZIP')
+    end
+  end
+
+  describe '#setup_zip_object_profile' do
+
+    let (:zip_object_profile) { helper.setup_zip_object_profile(files_hash[:images], @image_datastreams_output[0]) }
+
+    it 'should return a hash with the right structure' do
+      expect(zip_object_profile['zip']).to be_truthy
+      expect(zip_object_profile['datastreams'][@image_datastreams_output[0]]['dsSize']).to be_truthy
+    end
+
+    # should be greater than 10.5 MB
+    it 'should estimate the zip size' do
+      expect(zip_object_profile['datastreams'][@image_datastreams_output[0]]['dsSize'] > 11010048).to be_truthy
+    end
+
+  end
+
+  describe '#url_for_download' do
+
+    it 'should return the correct link path for a hosted item' do
+      expect(helper.url_for_download(document, @image_datastreams_output[0])).to include(trigger_downloads_path(item_pid,
+                                                                                                                datastream_id: @image_datastreams_output[0]))
+    end
+
+    describe 'item from Internet Archive' do
+
+      let (:document_to_hash) { document.to_h }
+      before { document_to_hash['identifier_ia_id_ssi'] = 'foo' }
+
+      it 'should return the correct link path for an Internet Archive item' do
+        expect(helper.url_for_download(SolrDocument.new(document_to_hash), 'JPEG2000')).to include('archive.org')
+      end
+
+    end
+
+  end
+
+end

data/spec/helpers/ocr_search_helper_spec.rb

@@ -16,11 +16,19 @@ describe OcrSearchHelper do
 
   let(:blacklight_config) { CatalogController.blacklight_config }
   let(:ocr_search_helper_test_class) { OcrSearchHelperTestClass.new blacklight_config }
+  let(:book_pid) { 'bpl-dev:7s75dn48d' }
+  let(:book_document) { Blacklight.default_index.search({:q => "id:\"#{book_pid}\"", :rows => 1}).documents.first }
 
   before(:each) do
     allow(helper).to receive_messages(blacklight_config: blacklight_config)
   end
 
+  describe '#has_searchable_text?' do
+    it 'should return true if the item has searchable text' do
+      expect(helper.has_searchable_text?(book_document)).to be_truthy
+    end
+  end
+
   describe '#ocr_q_params' do
 
     let(:current_search_session) { double(:query_params => {'q' => 'foo'}) }
@@ -33,21 +41,20 @@ describe OcrSearchHelper do
 
   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)) }
+    let(:page_document) { Blacklight.default_index.search({:q => "id:\"#{page_pid}\"", :rows => 1}).documents.first }
+    let(:image_pid_list) { ocr_search_helper_test_class.image_file_pids(ocr_search_helper_test_class.get_image_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) }
+      before { @ocr_page_link = helper.render_page_link(page_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])
+        expect(@ocr_page_link).to include(page_document[blacklight_config.page_num_field.to_sym])
       end
 
     end
@@ -55,8 +62,9 @@ describe OcrSearchHelper do
     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)
+        no_page_num = page_document.to_h
+        no_page_num[blacklight_config.page_num_field] = nil
+        @ocr_page_link = helper.render_page_link(SolrDocument.new(no_page_num), image_pid_list, book_pid)
       end
 
       it 'should have the correct label' do

data/spec/helpers/range_limit_helper_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe RangeLimitHelper do
+
+  let(:range_field_name) { 'date_facet_yearly_ssim' }
+  let(:params) { {'f'=>{'institution_name_ssim'=>['Boston Public Library']},
+                  'id'=>'bpl-dev:abcd12345',
+                  'range_end'=>'1922s',
+                  'range_field'=> range_field_name,
+                  'range_start'=>'1851s'} }
+
+  describe '#add_range_missing' do
+
+    it 'create a link to catalog#show' do
+      expect(helper.add_range_missing(range_field_name,params)).to include(search_catalog_path)
+    end
+
+  end
+
+end

data/spec/helpers/search_history_constraints_helper_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe CommonwealthVlrEngine::SearchHistoryConstraintsHelper do
+
+  class SearchHistoryConstraintsHelperTestClass < CatalogController
+    attr_accessor :params
+    include CommonwealthVlrEngine::ApplicationHelper
+  end
+
+  before(:each) do
+    @fake_controller = SearchHistoryConstraintsHelperTestClass.new
+    @fake_controller.extend(CommonwealthVlrEngine::SearchHistoryConstraintsHelper)
+  end
+
+  describe 'render_search_to_s_mlt' do
+
+    let (:mlt_test_params) { {mlt_id: 'bpl-dev:h702q6403'} }
+
+    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(mlt_test_params)
+    end
+
+  end
+
+  describe 'render_search_to_s_advanced' do
+
+    let (:date_range_params) { {date_start: '1970', date_end: '2000'} }
+
+    it 'should return render_search_to_s_element when date range 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_advanced(date_range_params)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe CommonwealthVlrEngine::ControllerOverride do
+
+  class ControllerOverrideTestClass < CatalogController
+  end
+
+  let (:mock_controller) { ControllerOverrideTestClass.new }
+  let (:override_config) { mock_controller.blacklight_config }
+
+  describe 'customized blacklight configuration' do
+
+    describe 'index document actions' do
+
+      it 'should remove the unwanted actions' do
+        expect(override_config.index.document_actions[:bookmark]).to be_empty
+      end
+
+    end
+
+    describe 'show document actions' do
+
+      it 'should remove the unwanted actions' do
+        expect(override_config.show.document_actions[:email]).to be_empty
+        expect(override_config.show.document_actions[:bookmark]).to be_empty
+      end
+
+      it 'should add the desired actions' do
+        expect(override_config.show.document_actions[:custom_email]).not_to be_empty
+        expect(override_config.show.document_actions[:folder_items]).not_to be_empty
+      end
+
+    end
+
+  end
+
+ end