commonwealth-vlr-engine 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81eafc50bc934b62d575ff630c9fbbe9fb60afe0
-  data.tar.gz: 44961a50c7a222659f8463137265e6f2151ac22b
+  metadata.gz: fbc356706414c0b95805533c2ea00a3a7effe6ce
+  data.tar.gz: 11c89f4dcc69806d61f9ede8d50f9b96cf165662
 SHA512:
-  metadata.gz: b0437c422051c52e463d8770a796691926dd14b6bc14eea75402d268b06d2a782b7bbedb44489e936e8e144e696d5bed21cf9dd853fbd5d9bca64b053957976b
-  data.tar.gz: af8acb84d0073a49f1a0b07616867f36bad415b2f1b1dc5a1bca4fae35f7d27ce3a86a774b907740200259d3a624868eaa2dcc9794ad6fb0d893bcbe769544b4
+  metadata.gz: 782bfa9e350b5564b73eef9318cd52928f11e29a4ef0cb95ca7571fc3a378a540223773a40a2a040109926ead37a2804aa0d7603515487d7e013670d60648da9
+  data.tar.gz: 56e045a323e114dc8c2521c3be14369729a0b00c70cd12571ac308db7758b7794be4ff256fbf72ff09db9517e20d9383658472be3f8e7cb9ed35502bb54b0539

data/README.md

@@ -36,3 +36,11 @@ $ rails generate commonwealth_vlr_engine:install
 $ rake db:migrate
 ```
 You will then need to configure various YAML files to point to existing Solr, Fedora, and IIIF image servers.
+
+## Blacklight Version Compatibility
+The table below indicates which versions of Commonwealth-VLR-Engine are compatible with which versions of Blacklight.
+
+VLR-Engine version | works with Blacklight version
+----------------------- | ---------------------
+0.0.2 | >= 6.1.0
+0.0.1 | >= 5.14.0 to < 6.*  

data/app/assets/stylesheets/commonwealth-vlr-engine/advanced_search.scss

@@ -82,7 +82,7 @@
               font-size: 12px;
 
               .facet-label {
-                text-indent: -20px;
+                text-indent: -5px;
                 padding-bottom: 4px;
               }
 

data/app/assets/stylesheets/commonwealth-vlr-engine/basic_search.scss

@@ -5,9 +5,14 @@
 
   #basic_search_form {
 
+    .twitter-typeahead {
+      width: 45%;
+      margin-right: 4px;
+    }
+
     #q_basic {
       @include box-shadow(0 1px 0 rgba(255, 255, 255, 0.2) inset, 0 1px 2px rgba(0, 0, 0, 0.05));
-      width: 45%;
+      width: 100%;
     }
 
     #basic_search_indexes {

data/app/assets/stylesheets/commonwealth-vlr-engine/commonwealth-vlr-engine.css

@@ -29,4 +29,5 @@
 @import 'searches';
 @import 'show';
 @import 'signin';
+@import 'twitter_typeahead';
 @import 'users';

data/app/assets/stylesheets/commonwealth-vlr-engine/folders.scss

@@ -231,7 +231,7 @@ div.folder_show_container {
               }
 
               .document-title-heading {
-                width: 93%;
+                width: 90%;
                 padding-left: 5px;
               }
 

data/app/assets/stylesheets/commonwealth-vlr-engine/header.scss

@@ -84,6 +84,15 @@
             display: none;
           }
 
+          .tt-menu {
+            min-width: 120px;
+
+            .tt-suggestion {
+              font-size: 12px;
+            }
+
+          }
+
         }
 
       }

data/app/assets/stylesheets/commonwealth-vlr-engine/home.scss

@@ -50,6 +50,15 @@ body.blacklight-home {
         margin-right: 3px;
       }
 
+      .twitter-typeahead {
+
+        input {
+          border-bottom-left-radius: 3px;
+          border-top-left-radius: 3px;
+        }
+
+      }
+
     }
 
   }

data/app/assets/stylesheets/commonwealth-vlr-engine/twitter_typeahead.scss

@@ -0,0 +1,9 @@
+/* site-wide typeahead styles for search forms */
+
+.twitter-typeahead {
+
+  .tt-cursor {
+    background-color: $light_gray;
+  }
+
+}

data/app/controllers/blacklight_advanced_search/advanced_controller.rb

@@ -1,14 +1,6 @@
 # Need to sub-class CatalogController so we get all other plugins behavior
 # for our own "inside a search context" lookup of facets.
 class BlacklightAdvancedSearch::AdvancedController < CatalogController
-  include AdvancedHelper # so we get the #advanced_search_context method
-  
-  # Blacklight uses #search_action_url to figure out the right URL for
-  # the global search box
-  def search_action_url options = {}
-    catalog_index_url(options.except(:controller, :action))
-  end
-  helper_method :search_action_url
 
   def index
     @nav_li_active = 'search'
@@ -18,49 +10,21 @@ class BlacklightAdvancedSearch::AdvancedController < CatalogController
   end
 
   protected
-  def get_advanced_search_facets
-
-    search_context_params = {}
-    if (advanced_search_context.length > 0 )
-      # We have a search context, need to fetch facets from within
-      # that context -- but we dont' want to search within any
-      # existing :q or ADVANCED facets, so we remove those params.
-      adv_keys = blacklight_config.search_fields.keys.map {|k| k.to_sym}
-      trimmed_params = params.except *adv_keys
-      trimmed_params.delete(:f_inclusive) # adv facets
 
-      search_context_params = solr_search_params(trimmed_params)
-
-      # Don't want to include the 'q' from basic search in our search
-      # context. Kind of hacky becuase solr_search_params insists on
-      # using controller.params, not letting us over-ride.
-      search_context_params.delete(:q)
-      search_context_params.delete("q")
+  # Override to use the engine routes
+  def search_action_url options = {}
+    blacklight_advanced_search_engine.url_for(options.merge(action: 'index'))
+  end
 
-      # Also delete any facet-related params, or anything else
-      # we want to set ourselves
-      search_context_params.delete_if do |k, v|
-        k = k.to_s
-        (["facet.limit", "facet.sort", "f", "facets", "facet.fields", "per_page"].include?(k) ||
-            k =~ /f\..+\.facet\.limit/ ||
-            k =~ /f\..+\.facet\.sort/
-        )
-      end
+  def get_advanced_search_facets
+    # We want to find the facets available for the current search, but:
+    # * IGNORING current query (add in facets_for_advanced_search_form filter)
+    # * IGNORING current advanced search facets (remove add_advanced_search_to_solr filter)
+    response, _ = search_results(params) do |search_builder|
+      search_builder.except(:add_advanced_search_to_solr).append(:facets_for_advanced_search_form)
     end
 
-    input = HashWithIndifferentAccess.new
-    input.merge!( search_context_params )
-
-    input[:per_page] = 0 # force
-
-    # force if set
-    input[:qt] = blacklight_config.advanced_search[:qt] if blacklight_config.advanced_search[:qt]
-
-    input.merge!( blacklight_config.advanced_search[:form_solr_parameters] ) if blacklight_config.advanced_search[:form_solr_parameters]
-
-    # ensure empty query is all records, to fetch available facets on entire corpus
-    input[:q] ||= '{!lucene}*:*'
-
-    repository.search(input)
+    return response
   end
+
 end

data/app/controllers/bookmarks_controller.rb

@@ -1,15 +1,15 @@
-# -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 class BookmarksController < CatalogController
 
   include Blacklight::Bookmarks
 
   # LOCAL OVERRIDE to render update.js.erb partial when bookmark created
   def create
-    if params[:bookmarks]
-      @bookmarks = params[:bookmarks]
-    else
-      @bookmarks = [{ document_id: params[:id], document_type: blacklight_config.document_model.to_s }]
-    end
+    @bookmarks = if params[:bookmarks]
+                   params[:bookmarks]
+                 else
+                   [{ document_id: params[:id], document_type: blacklight_config.document_model.to_s }]
+                 end
 
     current_or_guest_user.save! unless current_or_guest_user.persisted?
 
@@ -21,9 +21,9 @@ class BookmarksController < CatalogController
       # success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(:text => "", :status => "500")
       success ? render(:update) : render(:text => "", :status => "500")
     else
-      if @bookmarks.length > 0 && success
+      if @bookmarks.any? && success
         flash[:notice] = I18n.t('blacklight.bookmarks.add.success', :count => @bookmarks.length)
-      elsif @bookmarks.length > 0
+      elsif @bookmarks.any?
         flash[:error] = I18n.t('blacklight.bookmarks.add.failure', :count => @bookmarks.length)
       end
 

data/app/controllers/collections_controller.rb

@@ -1,7 +1,7 @@
 class CollectionsController < CatalogController
 
   ##
-  # Give Bookmarks access to the CatalogController configuration
+  # Give CollectionsController access to the CatalogController configuration
   include Blacklight::Configurable
   include Blacklight::SearchHelper
 
@@ -16,13 +16,13 @@ class CollectionsController < CatalogController
   # Blacklight uses #search_action_url to figure out the right URL for
   # the global search box
   def search_action_url options = {}
-    catalog_index_url(options.except(:controller, :action))
+    search_catalog_url(options.except(:controller, :action))
   end
   helper_method :search_action_url
 
   def index
     @nav_li_active = 'explore'
-    (@response, @document_list) = search_results(params, search_params_logic)
+    (@response, @document_list) = search_results(params)
     params[:view] = 'list'
     params[:sort] = 'title_info_primary_ssort asc'
 
@@ -40,7 +40,7 @@ class CollectionsController < CatalogController
     params[:f] = set_collection_facet_params(@collection_title, @document)
 
     # get the response for the facets representing items in collection
-    (@response, @document_list) = search_results({:f => params[:f]}, search_params_logic)
+    (@response, @document_list) = search_results({:f => params[:f]})
 
     # get an image for the collection
     if @document[:exemplary_image_ssi]
@@ -70,7 +70,7 @@ class CollectionsController < CatalogController
 
   # filter out non-collection items
   def collections_limit
-    self.search_params_logic += [:collections_filter]
+    blacklight_config.search_builder_class = CommonwealthCollectionsSearchBuilder
   end
 
   # find the title and pid for the object representing the collection image
@@ -92,15 +92,12 @@ class CollectionsController < CatalogController
     col_img_info
   end
 
-  # find a representative image for a series
-  # TODO better exception handling for items which don't have exemplary_image
+  # find a representative image/item for a series
   def get_series_image_obj(series_title,collection_title)
-    self.search_params_logic += [:flagged_filter] unless self.search_params_logic.include?(:flagged_filter)
-    series_doc_list = search_results(
-        {:f => {'related_item_series_ssim' => series_title,
-                blacklight_config.collection_field => collection_title},
-         :rows => 1},
-        search_params_logic)[1]
+    blacklight_config.search_builder_class = CommonwealthFlaggedSearchBuilder # ignore flagged items
+    series_doc_list = search_results({f: {'related_item_series_ssim' => series_title,
+                                          blacklight_config.collection_field => collection_title},
+                                      rows: 1})[1]
     series_doc_list.first
   end
   helper_method :get_series_image_obj
@@ -112,17 +109,4 @@ class CollectionsController < CatalogController
     facet_params
   end
 
-  # Not using this for now
-  # find a representative image for a collection if none is assigned
-  # TODO better exception handling for items which don't have exemplary_image
-  #def get_collection_image_pid(collection_title)
-  #  (@default_coll_img_resp, @default_coll_img_doc_list) = search_results(
-  #      {:f => {blacklight_config.collection_field => collection_title,
-  #              'has_model_ssim' => 'info:fedora/afmodel:Bplmodels_ObjectBase'},
-  #       :rows => 1
-  #      })
-  #  @default_coll_img_doc_list.first[:exemplary_image_ssi]
-  #end
-  #helper_method :get_collection_image_pid
-
 end

data/app/controllers/folder_items_actions_controller.rb

@@ -13,10 +13,10 @@ class FolderItemsActionsController < ApplicationController
       case params[:commit]
         # email
         when t('blacklight.tools.email')
-          redirect_to email_catalog_path(:id => items)
+          redirect_to email_solr_document_path(:id => items)
         # cite
         when t('blacklight.tools.citation')
-          redirect_to citation_catalog_path(:id => items)
+          redirect_to citation_solr_document_path(:id => items)
         # remove
         when t('blacklight.tools.remove')
           if params[:origin] == "folders"

data/app/controllers/folders_controller.rb

@@ -4,13 +4,14 @@ class FoldersController < CatalogController
   # Give Bookmarks access to the CatalogController configuration
   include Blacklight::Configurable
   include Blacklight::SearchHelper
+  include Blacklight::TokenBasedUser
 
   copy_blacklight_config_from(CatalogController)
 
   # Blacklight uses #search_action_url to figure out the right URL for
   # the global search box
   def search_action_url options = {}
-    catalog_index_url(options.except(:controller, :action))
+    search_catalog_url(options.except(:controller, :action))
   end
   helper_method :search_action_url
 
@@ -19,12 +20,15 @@ class FoldersController < CatalogController
   before_filter :correct_user_for_folder, :only => [:update, :destroy]
 
   def index
-    if current_user
-      @folders = current_user.folders
+    flash[:notice] = flash[:notice].html_safe if flash[:notice].present? and flash[:notice] == %Q[Welcome! You're viewing Digital Stacks items using a link from a temporary card. To save these items to a free permanent account, click <a href="#{new_user_session_path}" title="Sign Up Link">Sign Up / Log In</a>.]
+    if current_or_guest_user
+      @folders = current_or_guest_user.folders
     end
   end
 
   def show
+    flash[:notice] = flash[:notice].html_safe if flash[:notice].present? and flash[:notice] == %Q[Welcome! You're viewing Digital Stacks items using a link from a temporary card. To save these items to a free permanent account, click <a href="#{new_user_session_path}" title="Sign Up Link">Sign Up / Log In</a>.]
+
     # @folder is set by correct_user_for_folder
     @folder_items = @folder.folder_items
     folder_items_ids = @folder_items.collect { |f_item| f_item.document_id.to_s }
@@ -58,7 +62,7 @@ class FoldersController < CatalogController
   #      if @folder.save
   #        flash[:success] = "Folder created; " + t('blacklight.folder_items.add.success')
   #        current_user.folders.first.folder_items.create!(:document_id => params['id'].first)
-  #        redirect_to catalog_path(params['id']) unless request.xhr?
+  #        redirect_to solr_document_path(params['id']) unless request.xhr?
   #      else
   #        flash[:error] = t('blacklight.folders.create.error.no_save')
   #      end
@@ -122,8 +126,8 @@ class FoldersController < CatalogController
 
     def correct_user_for_folder
       @folder ||= Bpluser::Folder.find(params[:id])
-      if current_user
-        flash[:notice] = t('blacklight.folders.private') and redirect_to root_path unless current_user.folders.include?(@folder)
+      if current_or_guest_user
+        flash[:notice] = t('blacklight.folders.private') and redirect_to root_path unless current_or_guest_user.folders.include?(@folder)
       else
         flash[:notice] = t('blacklight.folders.private') and redirect_to root_path
       end

data/app/controllers/image_viewer_controller.rb

@@ -10,8 +10,8 @@ class ImageViewerController < CatalogController
     @page_sequence = get_page_sequence(@document.id, params[:view])
     respond_to do |format|
       format.js
-      format.html { redirect_to catalog_path(@document.id,
-                                             :view => params[:view]) }
+      format.html { redirect_to solr_document_path(@document.id,
+                                                   :view => params[:view]) }
     end
   end
 

data/app/controllers/institutions_controller.rb

@@ -7,18 +7,21 @@ class InstitutionsController < CatalogController
 
   copy_blacklight_config_from(CatalogController)
 
+  before_filter :institutions_index_config, :only => [:index]
+  # remove collection facet and collapse others
+  before_filter :relation_base_blacklight_config, :only => [:show]
+
   # Blacklight uses #search_action_url to figure out the right URL for
   # the global search box
   def search_action_url options = {}
-    catalog_index_url(options.except(:controller, :action))
+    search_catalog_url(options.except(:controller, :action))
   end
   helper_method :search_action_url
 
   def index
     @nav_li_active = 'explore'
-    self.search_params_logic += [:institutions_filter]
     params[:per_page] = params[:per_page].presence || '50'
-    (@response, @document_list) = search_results(params, search_params_logic)
+    (@response, @document_list) = search_results(params)
     params[:view] ||= 'list' # still need this or grid view is invoked
     params[:sort] = 'title_info_primary_ssort asc'
 
@@ -33,13 +36,13 @@ class InstitutionsController < CatalogController
     @institution_title = @document[blacklight_config.index.title_field.to_sym]
 
     # get the response for collection objects
-    @collex_response, @collex_documents = search_results({:f => {'active_fedora_model_suffix_ssi' => 'Collection','institution_pid_ssi' => params[:id]},:rows => 100, :sort => 'title_info_primary_ssort asc'}, search_params_logic)
+    @collex_response, @collex_documents = search_results({:f => {'active_fedora_model_suffix_ssi' => 'Collection','institution_pid_ssi' => params[:id]},:rows => 100, :sort => 'title_info_primary_ssort asc'})
 
     # add params[:f] for proper facet links
     params[:f] = {blacklight_config.institution_field => [@institution_title]}
 
     # get the response for the facets representing items in collection
-    (@response, @document_list) = search_results({:f => params[:f]}, search_params_logic)
+    (@response, @document_list) = search_results({:f => params[:f]})
 
     respond_to do |format|
       format.html
@@ -47,16 +50,14 @@ class InstitutionsController < CatalogController
 
   end
 
-  # remove grid view from blacklight_config for index view
-  def remove_unwanted_views
+  private
+
+  # remove grid view from blacklight_config, use correct SearchBuilder for index view
+  def institutions_index_config
+    blacklight_config.search_builder_class = CommonwealthInstitutionsSearchBuilder
     blacklight_config.view.delete(:gallery)
     blacklight_config.view.delete(:masonry)
     blacklight_config.view.delete(:slideshow)
   end
 
-  before_filter :remove_unwanted_views, :only => [:index]
-
-  # remove collection facet and collapse others
-  before_filter :relation_base_blacklight_config, :only => [:show]
-
 end

data/app/controllers/ocr_search_controller.rb

@@ -9,7 +9,6 @@ class OcrSearchController < CatalogController
   copy_blacklight_config_from(CatalogController)
 
   before_filter :modify_config_for_ocr, :only => [:index]
-  before_filter :modify_search_params_logic_for_ocr, :only => [:index]
 
   def index
     @doc_response, @document = fetch(params[:id])
@@ -22,7 +21,7 @@ class OcrSearchController < CatalogController
       # for some reason, have to set :fl here, or gets scrubbed out of ocr_search_params somehow
       blacklight_config.default_solr_params[:fl] =
           "id,#{blacklight_config.page_num_field},#{termfreq_query(params[:ocr_q])}"
-      (@response, @document_list) = search_results(ocr_search_params, search_params_logic)
+      (@response, @document_list) = search_results(ocr_search_params)
     else
       (@response, @document_list) = {},[]
     end
@@ -39,6 +38,7 @@ class OcrSearchController < CatalogController
 
   # modify Solr query/response for OCR searches
   def modify_config_for_ocr
+    blacklight_config.search_builder_class = CommonwealthOcrSearchBuilder
     blacklight_config.sort_fields = {}
     blacklight_config.add_sort_field 'score desc, system_create_dtsi asc', label: 'relevance'
     blacklight_config.add_sort_field 'system_create_dtsi asc', label: 'page #'
@@ -49,12 +49,6 @@ class OcrSearchController < CatalogController
     blacklight_config.default_per_page = 5
   end
 
-  # modify Solr search_params_logic for OCR searches
-  def modify_search_params_logic_for_ocr
-    self.search_params_logic -= [:exclude_unwanted_models, :institution_limit]
-    self.search_params_logic += [:ocr_search_params] unless self.search_params_logic.include?(:ocr_search_params)
-  end
-
   # create the Solr function query to return term frequency
   def termfreq_query(ocr_search_terms)
     search_terms = if ocr_search_terms =~ (/\A"[\s\S]*"\z/) # phrase search