commonwealth-vlr-engine 0.0.1

data/solr_conf/conf/solrconfig.xml

@@ -0,0 +1,286 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!-- COPIED FROM https://github.com/boston-library/solr-core-conf/master/solrconfig.xml  -->
+<config>
+  <!-- NOTE: various comments and unused configuration possibilities have been purged
+from this file. Please refer to http://wiki.apache.org/solr/SolrConfigXml,
+as well as the default solrconfig file included with Solr -->
+
+  <abortOnConfigurationError>${solr.abortOnConfigurationError:true}</abortOnConfigurationError>
+
+  <luceneMatchVersion>LUCENE_40</luceneMatchVersion>
+
+  <directoryFactory name="DirectoryFactory" class="${solr.directoryFactory:solr.StandardDirectoryFactory}"/>
+
+  <!-- solr lib dirs -->
+  <lib dir="../lib/contrib/analysis-extras/lib" />
+  <lib dir="../lib/contrib/analysis-extras/lucene-libs" />
+
+  <dataDir>${solr.data.dir:}</dataDir>
+
+  <requestHandler name="search" class="solr.SearchHandler" default="true">
+    <!-- default values for query parameters can be specified, these
+will be overridden by parameters in the request
+-->
+    <lst name="defaults">
+      <str name="defType">edismax</str>
+      <str name="echoParams">explicit</str>
+      <str name="q.alt">*:*</str>
+      <str name="mm">2&lt;-1 5&lt;-2 6&lt;90%</str>
+      <int name="qs">1</int>
+      <int name="ps">2</int>
+      <float name="tie">0.01</float>
+      <!-- this qf and pf are used by default, if not otherwise specified by
+client. The default blacklight_config will use these for the
+"keywords" search. See the author_qf/author_pf, title_qf, etc
+below, which the default blacklight_config will specify for
+those searches. You may also be interested in:
+http://wiki.apache.org/solr/LocalParams
+-->
+      <str name="qf">
+        id
+        all_text_timv
+        active_fedora_model_ssim
+        object_type_si
+        title_info_primary_tsi^100
+        title_info_primary_trans_tsim^80
+        title_info_alternative_tsim^80
+        title_info_translated_tsim^80
+        subtitle_tsim^80
+        name_personal_tsim^20
+        name_personal_role_tsim
+        name_corporate_tsim^20
+        name_corporate_role_tsim
+        name_generic_tsim^20
+        abstract_tsim^30
+        genre_basic_tsim
+        genre_specific_tsim
+        publisher_tsim^20
+        edition_tsim
+        issuance_tsim
+        date_start_tsim
+        date_end_tsim
+        table_of_contents_tsi^30
+        note_tsim^10
+        note_resp_tsim^20
+        note_date_tsim
+        note_performers_tsim^10
+        note_acquisition_tsim^10
+        note_ownership_tsim^10
+        note_citation_tsim^10
+        note_reference_tsim^10
+        collection_name_tsim^10
+        physical_location_tsim^20
+        sub_location_tsim
+        shelf_locator_tsim
+        subject_topic_tsim^50
+        subject_name_corporate_tsim^50
+        subject_name_personal_tsim^50
+        subject_geographic_tsim^50
+        subject_scale_tsim
+        subject_temporal_start_tsim
+        subject_temporal_end_tsim
+        subject_title_tsim^50
+        related_item_host_tsim^10
+        related_item_series_tsim^10
+        related_item_subseries_tsim^10
+        related_item_subsubseries_tsim^10
+        identifier_local_other_tsim
+        identifier_local_other_invalid_tsim
+        local_accession_id_tsim
+        identifier_local_call_tsim
+        identifier_local_barcode_tsim
+        classification_tsim
+        extent_tsi
+        institution_name_tsim^10
+        institution_pid_ssi
+        ocr_tiv^0.5
+        ocr_tsiv^0.5
+      </str>
+      <str name="pf">
+        all_text_timv^10
+      </str>
+
+      <str name="author_qf">
+        name_personal_tsim^20
+        name_corporate_tsim^20
+        name_generic_tsim^20
+        note_resp_tsim^20
+      </str>
+      <str name="author_pf">
+      </str>
+      <str name="title_qf">
+        title_info_primary_tsi^100
+        title_info_primary_trans_tsim^80
+        title_info_alternative_tsim^80
+        title_info_translated_tsim^80
+        subtitle_tsim^80
+      </str>
+      <str name="title_pf">
+      </str>
+      <str name="subject_qf">
+        subject_topic_tsim^50
+        subject_name_corporate_tsim^50
+        subject_name_personal_tsim^50
+        subject_geographic_tsim^50
+        subject_temporal_start_tsim
+        subject_temporal_end_tsim
+        subject_title_tsim^50
+      </str>
+      <str name="subject_pf">
+      </str>
+      <str name="place_qf">
+        subject_geographic_tsim^50
+        subject_topic_tsim^20
+        title_info_primary_tsi^10
+        subtitle_tsim^5
+        abstract_tsim^5
+        table_of_contents_tsi^5
+        note_tsim^5
+        institution_name_tsim^10
+        physical_location_tsim^10
+      </str>
+      <str name="place_pf">
+      </str>
+
+      <str name="fl">
+        *,
+        score
+      </str>
+
+      <str name="facet">true</str>
+      <str name="facet.mincount">1</str>
+      <str name="facet.limit">10</str>
+      <str name="facet.field">active_fedora_model_ssi</str>
+      <str name="facet.field">object_type_si</str>
+
+      <str name="spellcheck">true</str>
+      <str name="spellcheck.dictionary">default</str>
+      <str name="spellcheck.onlyMorePopular">true</str>
+      <str name="spellcheck.extendedResults">false</str>
+      <str name="spellcheck.collate">false</str>
+      <str name="spellcheck.count">5</str>
+
+    </lst>
+    <arr name="last-components">
+      <str>spellcheck</str>
+    </arr>
+  </requestHandler>
+
+  <requestHandler name="permissions" class="solr.SearchHandler" >
+    <lst name="defaults">
+      <str name="facet">off</str>
+      <str name="echoParams">all</str>
+      <str name="rows">1</str>
+      <str name="q">{!raw f=id v=$id}</str> <!-- use id=666 instead of q=id:666 -->
+      <str name="fl">
+        id,
+        access_ssim,
+        discover_access_group_ssim,discover_access_person_ssim,
+        read_access_group_ssim,read_access_person_ssim,
+        edit_access_group_ssim,edit_access_person_ssim,
+        depositor_ti,
+        embargo_release_date_dtsi
+        inheritable_access_ssim,
+        inheritable_discover_access_group_ssim,inheritable_discover_access_person_ssim,
+        inheritable_read_access_group_ssim,inheritable_read_access_person_ssim,
+        inheritable_edit_access_group_ssim,inheritable_edit_access_person_ssim,
+        inheritable_embargo_release_date_dtsi
+      </str>
+    </lst>
+  </requestHandler>
+
+  <requestHandler name="standard" class="solr.SearchHandler">
+    <lst name="defaults">
+      <str name="echoParams">explicit</str>
+      <str name="defType">lucene</str>
+    </lst>
+  </requestHandler>
+
+  <!-- for requests to get a single document; use id=666 instead of q=id:666 -->
+  <requestHandler name="document" class="solr.SearchHandler" >
+    <lst name="defaults">
+      <str name="echoParams">all</str>
+      <str name="fl">*</str>
+      <str name="rows">1</str>
+      <str name="mlt">true</str>
+      <str name="mlt.fl">subject_facet_ssim,subject_geo_city_ssim,related_item_host_ssim,title_info_primary_tsi</str>
+      <str name="mlt.count">4</str>
+      <str name="mlt.mintf">1</str>
+      <str name="mlt.qf">subject_facet_ssim^10 subject_geo_city_ssim^5 related_item_host_ssim^3</str>
+      <str name="q">{!raw f=id v=$id}</str> <!-- use id=666 instead of q=id:666 -->
+    </lst>
+  </requestHandler>
+
+  <!-- totally experimental, for "more like this" link in catalog#show -->
+  <requestHandler name="mlt" class="solr.MoreLikeThisHandler">
+    <lst name="defaults">
+      <str name="fl">
+        *,
+        score
+      </str>
+      <str name="facet">true</str>
+      <str name="facet.mincount">1</str>
+      <str name="echoParams">explicit</str>
+      <str name="mlt.match.include">false</str>
+      <str name="mlt.mintf">1</str>
+      <str name="mlt.fl">subject_facet_ssim,subject_geo_city_ssim,related_item_host_ssim</str>
+      <str name="mlt.qf">subject_facet_ssim^5</str>
+      <str name="q">{!raw f=id v=$id}</str>
+    </lst>
+  </requestHandler>
+
+  <searchComponent name="spellcheck" class="solr.SpellCheckComponent">
+    <str name="queryAnalyzerFieldType">textSpell</str>
+    <!-- Multiple "Spell Checkers" can be declared and used by this component
+(e.g. for title_spell field)
+-->
+    <lst name="spellchecker">
+      <str name="name">default</str>
+      <!-- using DirectSolrSpellChecker as doesn't require rebuilds -->
+      <str name="classname">solr.DirectSolrSpellChecker</str>
+      <str name="field">spell</str>
+      <!-- don't need separate index or build with DirectSolrSpellChecker -->
+      <!-- <str name="spellcheckIndexDir">./spell</str> -->
+      <!-- <str name="buildOnOptimize">true</str> -->
+    </lst>
+  </searchComponent>
+
+  <requestHandler name="/replication" class="solr.ReplicationHandler" startup="lazy" />
+
+  <requestDispatcher handleSelect="true" >
+    <requestParsers enableRemoteStreaming="true" multipartUploadLimitInKB="2048" />
+  </requestDispatcher>
+
+  <requestHandler name="/analysis/field" startup="lazy" class="solr.FieldAnalysisRequestHandler" />
+  <requestHandler name="/update" class="solr.UpdateRequestHandler" />
+  <requestHandler name="/admin/" class="org.apache.solr.handler.admin.AdminHandlers" />
+
+  <requestHandler name="/admin/ping" class="solr.PingRequestHandler">
+    <lst name="invariants">
+      <str name="q">solrpingquery</str>
+    </lst>
+    <lst name="defaults">
+      <str name="echoParams">all</str>
+    </lst>
+  </requestHandler>
+
+  <!-- config for the admin interface -->
+  <admin>
+    <defaultQuery>search</defaultQuery>
+  </admin>
+
+  <updateHandler class="solr.DirectUpdateHandler2">
+
+    <updateLog>
+      <str name="dir">${solr.ulog.dir:}</str>
+    </updateLog>
+
+    <autoCommit>
+      <maxTime>86400000</maxTime>
+      <maxDocs>2000</maxDocs>
+      <openSearcher>true</openSearcher>
+    </autoCommit>
+
+  </updateHandler>
+
+</config>

data/spec/controllers/catalog_controller_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+# tests for controller actions added to CatalogController via CommonwealthVlrEngine::ControllerOverride
+describe CatalogController do
+
+  render_views
+
+  #include CommonwealthVlrEngine::Finder
+
+  describe 'GET "metadata_view"' do
+
+    before { get :metadata_view, :id => 'bpl-dev:h702q6403'}
+
+    it 'should respond to the #metadata_view action' do
+      expect(response).to be_success
+      expect(assigns(:document)).to_not be_nil
+    end
+
+    it 'should render the page' do
+      expect(response.body).to include('<mods:title>Beauregard</mods:title>')
+    end
+
+  end
+
+  describe 'GET "formats_facet"' do
+
+    before { get :formats_facet }
+
+    it 'should respond to the #formats_facet action' do
+      expect(response).to be_success
+      expect(assigns(:display_facet)).to_not be_nil
+    end
+
+    it 'should render the page' do
+      expect(response.body).to have_css('.facet_extended_list')
+    end
+
+  end
+
+  describe 'mlt_search' do
+
+    it 'should include :set_solr_id_for_mlt in search_params_logic' do
+      get :index, :mlt_id => 'bpl-dev:df65v790j'
+      expect(CatalogController.search_params_logic).to include(:set_solr_id_for_mlt)
+    end
+
+  end
+
+  describe 'get_object_files' do
+
+    it 'should retrieve the files for the item' do
+      get :show, :id => 'bpl-dev:df65v790j'
+      expect(assigns(:object_files)).to_not be_nil
+    end
+
+  end
+
+  describe 'set_nav_context' do
+
+    it 'should set the nav context' do
+      get :index
+      expect(assigns(:nav_li_active)).to eq('search')
+    end
+
+  end
+
+end

data/spec/controllers/collections_controller_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe CollectionsController do
+
+  render_views
+
+  include BlacklightMapsHelper
+
+  def blacklight_config
+    CatalogController.blacklight_config
+  end
+
+  describe 'GET "index"' do
+    it 'should show the collections page' do
+      get :index
+      expect(response).to be_success
+      expect(assigns(:document_list)).not_to be_nil
+      expect(response.body).to have_selector('.blacklight-collection')
+    end
+  end
+
+  describe 'GET "show"' do
+
+    before(:each) do
+      get :show, :id => 'bpl-dev:h702q636h'
+    end
+
+    it 'should show the collection page' do
+      expect(response).to be_success
+      expect(assigns(:document)).not_to be_nil
+      expect(response.body).to have_selector('.blacklight-collection')
+    end
+
+    it 'should show some facets' do
+      expect(response.body).to have_selector('#facets')
+    end
+
+    it 'should show the collection image and title' do
+      expect(response.body).to have_selector('.collection_img_show')
+      expect(response.body).to have_selector('#collection_img_caption')
+    end
+
+    it 'should show the series list' do
+      expect(response.body).to have_selector('#facet-related_item_series_ssim')
+      expect(assigns(:document_list)).not_to be_nil
+    end
+
+    it 'should show the map' do
+      expect(response.body).to have_selector('#blacklight-collection-map-container')
+      expect(assigns(:response).aggregations[map_facet_field].items).not_to be_empty
+    end
+
+  end
+
+  describe 'private methods and before_filters' do
+
+    # for testing private methods
+    class CollectionsControllerTestClass < CollectionsController
+      attr_accessor :params
+    end
+
+    before(:each) do
+      @mock_controller = CollectionsControllerTestClass.new
+      @mock_controller.params = {}
+      @mock_controller.request = ActionDispatch::TestRequest.new
+      @mock_controller.send(:add_institution_fields)
+      @collection_pid = 'bpl-dev:h702q636h'
+      @collection_image_pid = 'bpl-dev:h702q642n'
+      @document = {blacklight_config.institution_field.to_sym => 'Boston Public Library'}
+    end
+
+    describe 'add_series_facet' do
+      it 'should add the series facet to the Solr request' do
+        @mock_controller.send(:add_series_facet)
+        expect(@mock_controller.blacklight_config.facet_fields['related_item_series_ssim'].include_in_request).to eq(true)
+      end
+    end
+
+    describe 'collapse_institution_facet' do
+      it 'should collapse the institution facet' do
+        @mock_controller.send(:collapse_institution_facet)
+        expect(@mock_controller.blacklight_config.facet_fields['physical_location_ssim'].collapse).to eq(true)
+      end
+    end
+
+    describe 'collections_limit' do
+      it 'should add :collections filter to search_params_logic' do
+        @mock_controller.send(:collections_limit)
+        expect(@mock_controller.search_params_logic).to include(:collections_filter)
+      end
+    end
+
+    describe 'get_collection_image_info' do
+      it 'should return a hash with the collection image object title and pid' do
+        expect(@mock_controller.send(:get_collection_image_info,@collection_image_pid,@collection_pid)).to eq({title:'Beauregard', pid:'bpl-dev:h702q6403', access_master:true})
+      end
+    end
+
+    describe 'get_series_image_obj' do
+      it 'should return the series object' do
+        expect(@mock_controller.send(:get_series_image_obj,'Test Series','Carte de Visite Collection')[:exemplary_image_ssi]).to eq('bpl-dev:h702q641c')
+      end
+    end
+
+    describe 'set_collection_facet_params' do
+      it 'should set the correct facet params' do
+        expect(@mock_controller.send(:set_collection_facet_params,'Carte de Visite Collection', @document)[blacklight_config.collection_field][0]).to eq('Carte de Visite Collection')
+      end
+    end
+
+    describe 'relation_base_blacklight_config' do
+
+      before { @mock_controller.send(:relation_base_blacklight_config) }
+
+      it 'should set the collection_name_ssim facet :show property to false' do
+        expect(@mock_controller.blacklight_config.facet_fields['collection_name_ssim'].show).not_to be_truthy
+      end
+
+      it 'should set the collapse property to true for all displayed facets' do
+        expect(@mock_controller.blacklight_config.facet_fields['subject_facet_ssim'].collapse).to be_truthy
+      end
+
+    end
+
+  end
+
+end