commonwealth-vlr-engine 0.0.1 → 0.0.2

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

@@ -23,10 +23,6 @@ module CommonwealthVlrEngine
     # for db migrations
     engine_name 'commonwealth_vlr_engine'
 
-    config.to_prepare do
-      CommonwealthVlrEngine.inject!
-    end
-
     # This makes our rake tasks visible.
     rake_tasks do
       Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))) do
@@ -36,5 +32,11 @@ module CommonwealthVlrEngine
       end
       #load "#{config.root}/tasks/dc_public.rake"
     end
+
+    # needs to be explicit as of sprockets-rails >=3.*
+    initializer 'commonwealth.assets.precompile' do |app|
+      app.config.assets.precompile += %w(commonwealth-vlr-engine/*.png commonwealth-vlr-engine/*.gif commonwealth-vlr-engine/openseadragon/*.png)
+    end
+
   end
 end

data/lib/commonwealth-vlr-engine/render_constraints_override.rb

@@ -32,13 +32,14 @@ module CommonwealthVlrEngine
     # Render the 'more like this' query constraints
     def render_mlt_query(localized_params = params)
       # So simple don't need a view template, we can just do it here.
-      scope = localized_params.delete(:route_set) || self
       return ''.html_safe if localized_params[:mlt_id].blank?
 
       render_constraint_element(t('blacklight.more_like_this.constraint_label'),
                                 localized_params[:mlt_id],
                                 :classes => ['mlt'],
-                                :remove => scope.url_for(localized_params.merge(:mlt_id=>nil, :qt=>nil, :action=>'index')))
+                                :remove => remove_constraint_url(localized_params.merge(:mlt_id=>nil,
+                                                                                        :qt=>nil,
+                                                                                        :action=>'index')))
     end
 
     # include render_search_to_s_mlt() in rendered constraints

data/lib/commonwealth-vlr-engine/search_builder/collections_search_builder.rb

@@ -0,0 +1,14 @@
+class CommonwealthCollectionsSearchBuilder < Blacklight::SearchBuilder
+
+  include Blacklight::Solr::SearchBuilderBehavior
+  include CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior
+
+  self.default_processor_chain += [
+      :exclude_unpublished_items, :collections_filter
+  ]
+
+  unless I18n.t('blacklight.home.browse.institutions.enabled')
+    self.default_processor_chain += [:institution_limit]
+  end
+
+end

data/lib/commonwealth-vlr-engine/{commonwealth_search_builder.rb → search_builder/commonwealth_search_builder_behavior.rb}

@@ -1,5 +1,5 @@
 module CommonwealthVlrEngine
-  module CommonwealthSearchBuilder
+  module CommonwealthSearchBuilderBehavior
 
     # keep file assets from appearing in search results
     def exclude_unwanted_models(solr_parameters = {})
@@ -30,6 +30,12 @@ module CommonwealthVlrEngine
       solr_parameters[:fq] << "-#{blacklight_config.flagged_field}:[* TO *]"
     end
 
+    # limit results to a single institution
+    def institution_limit(solr_parameters = {})
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << '+institution_pid_ssi:"' + CommonwealthVlrEngine.config[:institution][:pid] + '"'
+    end
+
     # used by InstitutionsController#index
     def institutions_filter(solr_parameters = {})
       solr_parameters[:fq] ||= []
@@ -63,4 +69,5 @@ module CommonwealthVlrEngine
     end
 
   end
-end
+end
+

data/lib/commonwealth-vlr-engine/search_builder/flagged_search_builder.rb

@@ -0,0 +1,14 @@
+class CommonwealthFlaggedSearchBuilder < Blacklight::SearchBuilder
+
+  include Blacklight::Solr::SearchBuilderBehavior
+  include CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior
+
+  self.default_processor_chain += [
+      :exclude_unpublished_items, :flagged_filter
+  ]
+
+  unless I18n.t('blacklight.home.browse.institutions.enabled')
+    self.default_processor_chain += [:institution_limit]
+  end
+
+end

data/lib/commonwealth-vlr-engine/search_builder/institutions_search_builder.rb

@@ -0,0 +1,11 @@
+class CommonwealthInstitutionsSearchBuilder < Blacklight::SearchBuilder
+
+  include Blacklight::Solr::SearchBuilderBehavior
+  include BlacklightMaps::MapsSearchBuilderBehavior
+  include CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior
+
+  self.default_processor_chain += [
+      :exclude_unpublished_items, :institutions_filter
+  ]
+
+end

data/lib/commonwealth-vlr-engine/search_builder/mlt_search_builder.rb

@@ -0,0 +1,15 @@
+class CommonwealthMltSearchBuilder < Blacklight::SearchBuilder
+
+  include Blacklight::Solr::SearchBuilderBehavior
+  include BlacklightMaps::MapsSearchBuilderBehavior
+  include CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior
+
+  self.default_processor_chain += [
+      :set_solr_id_for_mlt, :exclude_unpublished_items, :exclude_volumes
+  ]
+
+  unless I18n.t('blacklight.home.browse.institutions.enabled')
+    self.default_processor_chain += [:institution_limit, :exclude_institutions]
+  end
+
+end

data/lib/commonwealth-vlr-engine/search_builder/ocr_search_builder.rb

@@ -0,0 +1,10 @@
+class CommonwealthOcrSearchBuilder < Blacklight::SearchBuilder
+
+  include Blacklight::Solr::SearchBuilderBehavior
+  include CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior
+
+  self.default_processor_chain += [
+      :exclude_unpublished_items, :ocr_search_params
+  ]
+
+end

data/lib/commonwealth-vlr-engine/version.rb

@@ -1,3 +1,3 @@
 module CommonwealthVlrEngine
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/generators/commonwealth_vlr_engine/controller_generator.rb

@@ -40,7 +40,6 @@ module CommonwealthVlrEngine
           %q{
   # CatalogController-scope behavior and configuration for CommonwealthVlrEngine
   include CommonwealthVlrEngine::ControllerOverride
-  CatalogController.search_params_logic += [:institution_limit]
 }
         end
 
@@ -48,7 +47,7 @@ module CommonwealthVlrEngine
         insert_into_file "app/controllers/#{controller_name}_controller.rb", :after => marker do
           %q{
     # SearchBuilder contains logic for adding search params to Solr
-    config.search_builder_class = SearchBuilder
+    config.search_builder_class = CommonwealthSearchBuilder
 
     # limit Advanced Search facets to this institution
     # can't call SearchBuilder.institution_limit because it's an instance method, not a class method

data/lib/generators/commonwealth_vlr_engine/localassets_generator.rb

@@ -21,7 +21,7 @@ module CommonwealthVlrEngine
         end
       end
 
-      copy_file "commonwealth_vlr_engine.css.scss", "app/assets/stylesheets/commonwealth_vlr_engine.css.scss"
+      copy_file "commonwealth_vlr_engine.scss", "app/assets/stylesheets/commonwealth_vlr_engine.scss"
 
     end
 

data/lib/generators/commonwealth_vlr_engine/model_generator.rb

@@ -12,26 +12,13 @@ module CommonwealthVlrEngine
 
     desc """
   This generator makes the following changes to your application:
-   1. Injects the institution limiter into search_builder.rb
-   2. Adds OpenSeadragon suppoer to solr_document.rb
+   1. Adds commonwealth_search_builder.rb to app/models
+   2. Adds OpenSeadragon support to solr_document.rb
   Thank you for Installing Commonwealth VLR.
          """
 
-    # Limit the institutions
     def inject_search_builder_behavior
-      unless IO.read("app/models/#{search_builder_model}.rb").include?('def institutions_filter')
-        marker = 'Blacklight::Solr::SearchBuilderBehavior'
-        insert_into_file "app/models/#{search_builder_model}.rb", :after => marker do
-          %q{
-
-  # limit to a specific institution
-  def institution_limit(solr_parameters = {})
-    solr_parameters[:fq] ||= []
-    solr_parameters[:fq] << '+institution_pid_ssi:"' + CommonwealthVlrEngine.config[:institution][:pid] + '"'
-  end
-}
-        end
-      end
+      copy_file "commonwealth_search_builder.rb", "app/models/commonwealth_search_builder.rb"
     end
 
     # OpenSeadragon support?

data/lib/generators/commonwealth_vlr_engine/routes_generator.rb

@@ -26,12 +26,20 @@ module CommonwealthVlrEngine
 
   # user authentication
   devise_for :users, :controllers => {:omniauth_callbacks => "users/omniauth_callbacks", :registrations => "users/registrations", :sessions => "users/sessions"}
+
+  # bookmarks item actions
+  # this has to be in local app for bookmark item actions to work
+  put 'bookmarks/item_actions', :to => 'folder_items_actions#folder_item_actions', :as => 'selected_bookmarks_actions'
 }
         end
 
+        # remove Blacklight root
         bl_root_marker = 'root to: "catalog#index"'
         gsub_file("config/routes.rb", bl_root_marker, "")
 
+        # change '/catalog' to '/search'
+        gsub_file("config/routes.rb", /\/catalog/, "/search")
+
       end
     end
 

data/lib/generators/commonwealth_vlr_engine/templates/commonwealth_search_builder.rb

@@ -0,0 +1,17 @@
+class CommonwealthSearchBuilder < Blacklight::SearchBuilder
+
+  include Blacklight::Solr::SearchBuilderBehavior
+  include BlacklightAdvancedSearch::AdvancedSearchBuilder
+  include BlacklightMaps::MapsSearchBuilderBehavior
+  include CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior
+
+  self.default_processor_chain += [
+      :exclude_unwanted_models, :exclude_unpublished_items, :exclude_institutions,
+      :exclude_volumes, :add_advanced_parse_q_to_solr, :add_advanced_search_to_solr
+  ]
+
+  unless I18n.t('blacklight.home.browse.institutions.enabled')
+    self.default_processor_chain += [:institution_limit]
+  end
+
+end

data/spec/controllers/catalog_controller_spec.rb

@@ -1,12 +1,20 @@
 require 'spec_helper'
 
-# tests for controller actions added to CatalogController via CommonwealthVlrEngine::ControllerOverride
+# tests for controller actions and configuration added to CatalogController via CommonwealthVlrEngine::ControllerOverride
 describe CatalogController do
 
   render_views
 
   #include CommonwealthVlrEngine::Finder
 
+  describe 'search_builder_class' do
+
+    it 'should use CommonwealthSearchBuilder' do
+      expect(CatalogController.blacklight_config.search_builder_class).to eq(CommonwealthSearchBuilder)
+    end
+
+  end
+
   describe 'GET "metadata_view"' do
 
     before { get :metadata_view, :id => 'bpl-dev:h702q6403'}
@@ -39,9 +47,9 @@ describe CatalogController do
 
   describe 'mlt_search' do
 
-    it 'should include :set_solr_id_for_mlt in search_params_logic' do
+    it 'should modify the config to use the correct search builder class' do
       get :index, :mlt_id => 'bpl-dev:df65v790j'
-      expect(CatalogController.search_params_logic).to include(:set_solr_id_for_mlt)
+      expect(controller.blacklight_config.search_builder_class).to eq(CommonwealthMltSearchBuilder)
     end
 
   end
@@ -55,6 +63,15 @@ describe CatalogController do
 
   end
 
+  describe 'add_institution_fields' do
+
+    it 'should add the institution-related facet fields to the config' do
+      get :index
+      expect(controller.blacklight_config.facet_fields['physical_location_ssim']).to_not be_nil
+    end
+
+  end
+
   describe 'set_nav_context' do
 
     it 'should set the nav context' do

data/spec/controllers/collections_controller_spec.rb

@@ -84,9 +84,9 @@ describe CollectionsController do
     end
 
     describe 'collections_limit' do
-      it 'should add :collections filter to search_params_logic' do
+      it 'should set the correct search builder class' do
         @mock_controller.send(:collections_limit)
-        expect(@mock_controller.search_params_logic).to include(:collections_filter)
+        expect(@mock_controller.blacklight_config.search_builder_class).to eq(CommonwealthCollectionsSearchBuilder)
       end
     end
 

data/spec/controllers/folder_items_actions_controller_spec.rb

@@ -72,7 +72,7 @@ describe FolderItemsActionsController do
               :origin => "folders",
               :id => @folder,
               :selected => ["bpl-dev:g445cd14k"]
-          expect(response).to redirect_to(citation_catalog_path(:id => ["bpl-dev:g445cd14k"]))
+          expect(response).to redirect_to(citation_solr_document_path(:id => ["bpl-dev:g445cd14k"]))
       end
 
     end
@@ -89,7 +89,7 @@ describe FolderItemsActionsController do
             :origin => "folders",
             :id => @folder,
             :selected => ["bpl-dev:g445cd14k"]
-        expect(response).to redirect_to(email_catalog_path(:id => ["bpl-dev:g445cd14k"]))
+        expect(response).to redirect_to(email_solr_document_path(:id => ["bpl-dev:g445cd14k"]))
       end
 
     end

data/spec/controllers/institutions_controller_spec.rb

@@ -61,4 +61,17 @@ describe InstitutionsController do
 
   end
 
+  describe 'private methods and before_filters' do
+
+    describe 'institutions_index_config' do
+      it 'should set the appropriate blacklight_config properties' do
+        get :index
+        expect(controller.blacklight_config.search_builder_class).to eq(CommonwealthInstitutionsSearchBuilder)
+        expect(controller.blacklight_config.view.to_s).not_to include('gallery')
+      end
+
+    end
+
+  end
+
 end

data/spec/controllers/ocr_search_controller_spec.rb

@@ -51,6 +51,10 @@ describe OcrSearchController do
         expect(blacklight_config.add_facet_fields_to_solr_request).to eq(false)
       end
 
+      it 'should use the correct search builder class' do
+        expect(blacklight_config.search_builder_class).to eq(CommonwealthOcrSearchBuilder)
+      end
+
       let(:ocr_field) { blacklight_config.index_fields[blacklight_config.ocr_search_field] }
 
       it 'should add the ocr_search_field to the index_fields config' do

data/spec/features/more_like_this_search_spec.rb

@@ -16,7 +16,7 @@ describe 'more like this search' do
   end
 
   it 'should show the constraint for a more-like-this search' do
-    visit catalog_index_path(:mlt_id => 'bpl-dev:df65v790j', :qt => 'mlt')
+    visit search_catalog_path(:mlt_id => 'bpl-dev:df65v790j', :qt => 'mlt')
     expect(page).to have_selector('#appliedParams span.mlt')
   end
 

data/spec/features/ocr_search/index_spec.rb

@@ -16,7 +16,7 @@ describe 'OCR search index view' do
     describe 'with current_search_session params' do
 
       before do
-        visit catalog_index_path(q: 'foo')
+        visit search_catalog_path(q: 'foo')
       end
 
       it 'should display the suggestion link' do

data/spec/helpers/institutions_helper_spec.rb

@@ -7,7 +7,6 @@ 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)
@@ -22,7 +21,7 @@ describe InstitutionsHelper do
 
   describe 'render_institutions_index' do
 
-    before { (@response, @document_list) = search_results({}, search_params_logic) }
+    before { (@response, @document_list) = search_results({}) }
 
     describe 'with default document_index_view_type' do
       before { allow(helper).to receive_messages(document_index_view_type: :list) }
@@ -31,16 +30,22 @@ describe InstitutionsHelper do
     end
 
     describe 'with "maps" document_index_view_type' do
-      before { allow(helper).to receive_messages(document_index_view_type: :maps) }
+
+      before do
+        allow(helper).to receive_messages(blacklight_configuration_context: Blacklight::Configuration::Context.new(CatalogController.new))
+        allow(helper).to receive_messages(document_index_view_type: :maps)
+      end
+
       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 {
+    after do
       remove_instance_variable(:@response)
       remove_instance_variable(:@document_list)
-    }
+    end
 
   end
 

data/spec/lib/commonwealth-vlr-engine/search_builder/collections_search_builder_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe CommonwealthCollectionsSearchBuilder do
+
+  class CommonwealthCollectionsSearchBuilderTestClass < CommonwealthCollectionsSearchBuilder
+  end
+
+  before { @obj = CommonwealthCollectionsSearchBuilderTestClass.new(CatalogController.new) }
+
+  describe 'processor chain' do
+
+    it 'should add the right methods to the processor chain' do
+      expect(@obj.processor_chain).to include(:collections_filter)
+    end
+
+  end
+
+
+end

data/spec/lib/commonwealth-vlr-engine/search_builder/commonwealth_search_builder_behavior_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior do
+
+  let(:blacklight_params) { Hash.new }
+  let(:solr_parameters) { Blacklight::Solr::Request.new }
+
+  let(:blacklight_config) { CatalogController.blacklight_config.deep_copy }
+  let(:user_params) { Hash.new }
+  let(:context) { CatalogController.new }
+
+  before { allow(context).to receive(:blacklight_config).and_return(blacklight_config) }
+
+  let(:search_builder_class) do
+    Class.new(Blacklight::SearchBuilder) do
+      include Blacklight::Solr::SearchBuilderBehavior
+      include CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior
+    end
+  end
+
+  let(:search_builder) { search_builder_class.new(context) }
+
+  describe 'exclude_unwanted_models' do
+
+    it 'should add parameters to exclude unwanted models' do
+      expect(search_builder.exclude_unwanted_models(solr_parameters).to_s).to include('afmodel:Bplmodels_File')
+    end
+
+  end
+
+  describe 'exclude_unpublished_items' do
+
+    let(:excluded_unpublished) { search_builder.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(search_builder.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(search_builder.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(search_builder.institutions_filter(solr_parameters).to_s).to include('+active_fedora_model_suffix_ssi:\"Institution\"')
+    end
+
+  end
+
+  describe 'institutions_limit' do
+
+    it 'should add parameters to limit to a single institution' do
+      expect(search_builder.institution_limit(solr_parameters).to_s).to include('+institution_pid_ssi:\"' + CommonwealthVlrEngine.config[:institution][:pid])
+    end
+
+  end
+
+  describe 'set_solr_id_for_mlt' do
+
+    subject { search_builder.with({mlt_id: 'bpl-dev:12345678'}) }
+
+    it 'should set the id param to the mlt_id value' do
+      expect(subject.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(search_builder.collections_filter(solr_parameters).to_s).to include('+active_fedora_model_suffix_ssi:\"Collection\"')
+    end
+
+  end
+
+  describe 'exclude_volumes' do
+
+    it 'should add parameters to exclude volume objects' do
+      expect(search_builder.exclude_volumes(solr_parameters).to_s).to include('-active_fedora_model_suffix_ssi:\"Volume\"')
+    end
+
+  end
+
+  describe 'ocr_search_params' do
+
+    before do
+      search_builder.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