commonwealth-vlr-engine 0.0.1 → 0.0.2

data/app/controllers/saved_searches_controller.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+class SavedSearchesController < ApplicationController
+  include Blacklight::SavedSearches
+
+  helper BlacklightAdvancedSearch::RenderConstraintsOverride
+  helper BlacklightMaps::RenderConstraintsOverride
+  helper CommonwealthVlrEngine::RenderConstraintsOverride
+end

data/app/controllers/search_history_controller.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+class SearchHistoryController < ApplicationController
+  include Blacklight::SearchHistory
+
+  helper BlacklightAdvancedSearch::RenderConstraintsOverride
+  helper BlacklightMaps::RenderConstraintsOverride
+  helper CommonwealthVlrEngine::RenderConstraintsOverride
+end

data/app/helpers/commonwealth_vlr_engine/application_helper.rb

@@ -52,16 +52,16 @@ module CommonwealthVlrEngine
     # TODO: this isn't used anywhere in the app, get rid of it?
     def link_to_field(fieldname, fieldvalue, displayvalue = nil)
       p = {:search_field => fieldname, :q => '"'+fieldvalue+'"'}
-      link_url = catalog_index_path(p)
+      link_url = search_catalog_path(p)
       display = displayvalue.blank? ? fieldvalue: displayvalue
       link_to(display, link_url)
     end
 
     def link_to_facet(field_value, field, displayvalue = nil)
       if field == 'genre_basic_ssim'
-        link_to(render_format(field_value), catalog_index_path(:f => {field => [field_value]}))
+        link_to(render_format(field_value), search_catalog_path(:f => {field => [field_value]}))
       else
-        link_to(displayvalue.presence || field_value, catalog_index_path(:f => {field => [field_value]}))
+        link_to(displayvalue.presence || field_value, search_catalog_path(:f => {field => [field_value]}))
       end
     end
 
@@ -71,11 +71,11 @@ module CommonwealthVlrEngine
       fields.each_with_index do |field, index|
         facets[field] = [field_values[index]]
       end
-      link_to(displayvalue.presence || field_values[0], catalog_index_path(:f => facets))
+      link_to(displayvalue.presence || field_values[0], search_catalog_path(:f => facets))
     end
 
     def link_to_county_facet(field_value, field)
-      link_to(field_value + ' County', catalog_index_path(:f => {field => [field_value + ' (county)']}))
+      link_to(field_value + ' County', search_catalog_path(:f => {field => [field_value + ' (county)']}))
     end
 
     # returns the direct URL to a datastream in Fedora
@@ -145,52 +145,52 @@ module CommonwealthVlrEngine
     def osd_nav_images(path_to_directory)
       {
           zoomIn: {
-              REST:     image_path("#{path_to_directory}/zoomin_rest.png"),
-              GROUP:    image_path("#{path_to_directory}/zoomin_grouphover.png"),
-              HOVER:    image_path("#{path_to_directory}/zoomin_hover.png"),
-              DOWN:     image_path("#{path_to_directory}/zoomin_pressed.png")
+              REST:   path_to_image("#{path_to_directory}/zoomin_rest.png"),
+              GROUP:  path_to_image("#{path_to_directory}/zoomin_grouphover.png"),
+              HOVER:  path_to_image("#{path_to_directory}/zoomin_hover.png"),
+              DOWN:   path_to_image("#{path_to_directory}/zoomin_pressed.png")
           },
           zoomOut: {
-              REST:   image_path("#{path_to_directory}/zoomout_rest.png"),
-              GROUP:  image_path("#{path_to_directory}/zoomout_grouphover.png"),
-              HOVER:  image_path("#{path_to_directory}/zoomout_hover.png"),
-              DOWN:   image_path("#{path_to_directory}/zoomout_pressed.png")
+              REST:   path_to_image("#{path_to_directory}/zoomout_rest.png"),
+              GROUP:  path_to_image("#{path_to_directory}/zoomout_grouphover.png"),
+              HOVER:  path_to_image("#{path_to_directory}/zoomout_hover.png"),
+              DOWN:   path_to_image("#{path_to_directory}/zoomout_pressed.png")
           },
           home: {
-              REST:   image_path("#{path_to_directory}/home_rest.png"),
-              GROUP:  image_path("#{path_to_directory}/home_grouphover.png"),
-              HOVER:  image_path("#{path_to_directory}/home_hover.png"),
-              DOWN:   image_path("#{path_to_directory}/home_pressed.png")
+              REST:   path_to_image("#{path_to_directory}/home_rest.png"),
+              GROUP:  path_to_image("#{path_to_directory}/home_grouphover.png"),
+              HOVER:  path_to_image("#{path_to_directory}/home_hover.png"),
+              DOWN:   path_to_image("#{path_to_directory}/home_pressed.png")
           },
           fullpage: {
-              REST:   image_path("#{path_to_directory}/fullpage_rest.png"),
-              GROUP:  image_path("#{path_to_directory}/fullpage_grouphover.png"),
-              HOVER:  image_path("#{path_to_directory}/fullpage_hover.png"),
-              DOWN:   image_path("#{path_to_directory}/fullpage_pressed.png")
+              REST:   path_to_image("#{path_to_directory}/fullpage_rest.png"),
+              GROUP:  path_to_image("#{path_to_directory}/fullpage_grouphover.png"),
+              HOVER:  path_to_image("#{path_to_directory}/fullpage_hover.png"),
+              DOWN:   path_to_image("#{path_to_directory}/fullpage_pressed.png")
           },
           rotateleft: {
-              REST:   image_path("#{path_to_directory}/rotateleft_rest.png"),
-              GROUP:  image_path("#{path_to_directory}/rotateleft_grouphover.png"),
-              HOVER:  image_path("#{path_to_directory}/rotateleft_hover.png"),
-              DOWN:   image_path("#{path_to_directory}/rotateleft_pressed.png")
+              REST:   path_to_image("#{path_to_directory}/rotateleft_rest.png"),
+              GROUP:  path_to_image("#{path_to_directory}/rotateleft_grouphover.png"),
+              HOVER:  path_to_image("#{path_to_directory}/rotateleft_hover.png"),
+              DOWN:   path_to_image("#{path_to_directory}/rotateleft_pressed.png")
           },
           rotateright: {
-              REST:   image_path("#{path_to_directory}/rotateright_rest.png"),
-              GROUP:  image_path("#{path_to_directory}/rotateright_grouphover.png"),
-              HOVER:  image_path("#{path_to_directory}/rotateright_hover.png"),
-              DOWN:   image_path("#{path_to_directory}/rotateright_pressed.png")
+              REST:   path_to_image("#{path_to_directory}/rotateright_rest.png"),
+              GROUP:  path_to_image("#{path_to_directory}/rotateright_grouphover.png"),
+              HOVER:  path_to_image("#{path_to_directory}/rotateright_hover.png"),
+              DOWN:   path_to_image("#{path_to_directory}/rotateright_pressed.png")
           },
           previous: {
-              REST:   image_path("#{path_to_directory}/previous_rest.png"),
-              GROUP:  image_path("#{path_to_directory}/previous_grouphover.png"),
-              HOVER:  image_path("#{path_to_directory}/previous_hover.png"),
-              DOWN:   image_path("#{path_to_directory}/previous_pressed.png")
+              REST:   path_to_image("#{path_to_directory}/previous_rest.png"),
+              GROUP:  path_to_image("#{path_to_directory}/previous_grouphover.png"),
+              HOVER:  path_to_image("#{path_to_directory}/previous_hover.png"),
+              DOWN:   path_to_image("#{path_to_directory}/previous_pressed.png")
           },
           next: {
-              REST:   image_path("#{path_to_directory}/next_rest.png"),
-              GROUP:  image_path("#{path_to_directory}/next_grouphover.png"),
-              HOVER:  image_path("#{path_to_directory}/next_hover.png"),
-              DOWN:   image_path("#{path_to_directory}/next_pressed.png")
+              REST:   path_to_image("#{path_to_directory}/next_rest.png"),
+              GROUP:  path_to_image("#{path_to_directory}/next_grouphover.png"),
+              HOVER:  path_to_image("#{path_to_directory}/next_hover.png"),
+              DOWN:   path_to_image("#{path_to_directory}/next_pressed.png")
           }
       }.to_json
     end

data/app/helpers/commonwealth_vlr_engine/blacklight_helper.rb

@@ -16,17 +16,9 @@ module CommonwealthVlrEngine
     # local override to use custom #document_heading method (above) for catalog#show title heading
     def render_document_heading(*args)
       options = args.extract_options!
-
-      tag_or_document = args.first
-
-      if tag_or_document.is_a? String or tag_or_document.is_a? Symbol
-        Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#render_document_heading with a tag argument is deprecated; pass e.g. `tag: :h4` instead")
-        tag = tag_or_document
-        document = @document
-      else
-        tag = options.fetch(:tag, :h4)
-        document = tag_or_document || @document
-      end
+      document = args.first
+      tag = options.fetch(:tag, :h4)
+      document = document || @document
 
       content_tag(tag, document_heading(document), itemprop: "name")
     end

data/app/helpers/commonwealth_vlr_engine/blacklight_url_helper.rb

@@ -2,22 +2,6 @@ module CommonwealthVlrEngine
   module BlacklightUrlHelper
     include Blacklight::UrlHelperBehavior
 
-    # overriding to allow use in collections#show and institutions#show
-    # so facet links in those views point to catalog#index
-    def add_facet_params_and_redirect(field, item)
-      new_params = add_facet_params(field, item)
-
-      # Delete any request params from facet-specific action, needed
-      # to redir to index action properly.
-      request_keys = blacklight_config.facet_paginator_class.request_keys
-      new_params.except! *request_keys.values
-
-      # Force controller#action to be catalog#index.
-      new_params[:action] = "index"
-      new_params[:controller] = "catalog"
-      new_params
-    end
-
     # need this method for rss and atom polymorphic_url(url_for_document(document))
     # because polymorphic_url appends any action passed in arg hash to route
     # so we need to re-route to the correct url
@@ -36,6 +20,7 @@ module CommonwealthVlrEngine
     end
 
     # override to route to collections#show and institutions#show where appropriate
+    # this uses the older BL 5.14 def as the basis, but don't really need to update to BL6.* model
     def url_for_document doc, options = {}
       if respond_to?(:blacklight_config) && doc.respond_to?(:[])
         display_type = doc[blacklight_config.show.display_type_field].presence

data/app/helpers/commonwealth_vlr_engine/catalog_helper.rb

@@ -269,7 +269,7 @@ module CommonwealthVlrEngine
       if document[:subject_facet_ssim] || document[:subject_geo_city_ssim]
         content_tag :div, :id => 'more_mlt_link_wrapper' do
           link_to t('blacklight.more_like_this.more_mlt_link'),
-                  catalog_index_path(:mlt_id => document.id,
+                  search_catalog_path(:mlt_id => document.id,
                                      :qt => 'mlt'),
                   :id => 'more_mlt_link'
         end

data/app/helpers/commonwealth_vlr_engine/collections_helper_behavior.rb

@@ -6,7 +6,7 @@ module CommonwealthVlrEngine
       facet_params = {blacklight_config.collection_field => [col_title]}
       facet_params[blacklight_config.institution_field] = institution_name if institution_name
       link_to(t('blacklight.collections.browse.all'),
-              catalog_index_path(:f => facet_params),
+              search_catalog_path(:f => facet_params),
               :class => link_class)
     end
 

data/app/helpers/commonwealth_vlr_engine/institutions_helper_behavior.rb

@@ -4,7 +4,7 @@ module CommonwealthVlrEngine
     # link to view all items from an institution
     def link_to_all_inst_items(link_class)
       link_to(t('blacklight.institutions.browse.all'),
-              catalog_index_path(:f => {blacklight_config.institution_field => [@institution_title]}),
+              search_catalog_path(:f => {blacklight_config.institution_field => [@institution_title]}),
               :class => link_class)
     end
 
@@ -13,7 +13,7 @@ module CommonwealthVlrEngine
     def render_institutions_index documents = nil, locals = {}
       documents ||= @document_list
       if document_index_view_type.to_s == 'maps'
-        render :partial => 'catalog/index_map_institutions',
+        render :partial => 'catalog/index_mapview_institutions',
                :locals => {:geojson_features => serialize_geojson(map_facet_values,
                                                                   nil,
                                                                   {partial: 'institutions/map_institutions_search'})}

data/app/helpers/commonwealth_vlr_engine/vlr_blacklight_maps_helper_behavior.rb

@@ -5,9 +5,8 @@ module CommonwealthVlrEngine
     # OVERRIDE: convert state abbreviations, deal with complex locations, etc.
     # create a link to a location name facet value
     def link_to_placename_field field_value, field, displayvalue = nil, catalogpath = nil
-      search_path = catalogpath || 'catalog_index_path'
+      search_path = catalogpath || 'search_catalog_path'
       new_params = params
-      new_params[:view] = default_document_index_view_type
       field_values = field_value.split(', ')
       if field_values.last.match(/[\.\)]/) # Mass.)
         field_values = [field_values.join(', ')]
@@ -23,24 +22,29 @@ module CommonwealthVlrEngine
         field_values[field_values.length-1] = state_name if state_name
       end
       field_values.each do |val|
+        # new_params = new_params.to_hash
         place = val.match(/\(county\)/) ? val : val.gsub(/\s\([a-z]*\)\z/,'')
-        new_params = add_facet_params(field, place, new_params) unless params[:f] && params[:f][field] && params[:f][field].include?(place)
-        new_params[:view] = default_document_index_view_type
+        unless params[:f] && params[:f][field] && params[:f][field].include?(place)
+          # have to initialize SearchState with existing params as Hash, not HashWithIndifferentAccess
+          new_params = Blacklight::SearchState.new(new_params.to_hash,
+                                                   blacklight_config).add_facet_params(field, place)
+        end
       end
+      new_params[:view] = default_document_index_view_type
       link_to(displayvalue.presence || field_value,
               self.send(search_path,new_params.except(:id, :spatial_search_type, :coordinates)))
     end
 
     # OVERRIDE: use a static file for catalog#map so page loads faster
     # render the map for #index and #map views
-    def render_index_map
+    def render_index_mapview
       static_geojson_file_loc = "#{Rails.root.to_s}/#{GEOJSON_STATIC_FILE['filepath']}"
       if Rails.env.to_s == 'production' && params[:action] == 'map' && File::exists?(static_geojson_file_loc)
         geojson_for_map = File.open(static_geojson_file_loc).first
       else
         geojson_for_map = serialize_geojson(map_facet_values)
       end
-      render :partial => 'catalog/index_map',
+      render :partial => 'catalog/index_mapview',
              :locals => {:geojson_features => geojson_for_map}
     end
 

data/app/views/advanced/_advanced_search_fields.html.erb

@@ -27,8 +27,8 @@
   </div>
 </div>
 <div class="pull-right">
-  <%= submit_tag 'Search', :class=>'btn btn-primary advanced_submit', :id=>'advanced_search' %>
-  <%= link_to 'Start over', {:controller => 'advanced', :action => 'index'}, :class =>'reset btn btn-default' %>
+  <%= submit_tag t('blacklight_advanced_search.form.search_btn'), :class=>'btn btn-primary advanced_submit', :id=>'advanced_search' %>
+  <%= link_to t('blacklight_advanced_search.form.start_over'), blacklight_advanced_search_engine.advanced_search_path, :class =>'reset btn btn-default' %>
 </div>
 
 <%# search_fields_for_advanced_search.each do |key, field_def| -%>

data/app/views/advanced/_advanced_search_form.html.erb

@@ -1,4 +1,4 @@
-<%= form_tag catalog_index_path, :id => 'advanced_search_form', :class => 'advanced form-horizontal', :method => :get do  %>
+<%= form_tag search_catalog_path, :id => 'advanced_search_form', :class => 'advanced form-horizontal', :method => :get do  %>
   <%# search_as_hidden_fields(:params => advanced_search_context,
                                 :op => 'AND' ) %>
   <div class="row">
@@ -28,7 +28,7 @@
         <div class="pull-right">
           <%= submit_tag 'Search', :class=>'btn btn-primary advanced_submit' %>
           <%= link_to 'Start over',
-                      {:controller => 'advanced', :action => 'index'},
+                      blacklight_advanced_search_engine.advanced_search_path,
                       :class => 'reset btn btn-default' %>
         </div>
       </div>

data/app/views/advanced/index.html.erb

@@ -11,7 +11,7 @@
 
   <ul id="search_mode_tabs" class="nav nav-tabs">
     <li>
-      <%= link_to 'Basic', catalog_index_path %>
+      <%= link_to 'Basic', search_catalog_path %>
     </li>
     <li class="active"><a href="#">Advanced</a></li>
   </ul>

data/app/views/bookmarks/index.html.erb

@@ -1,4 +1,4 @@
-<% @page_title = t('blacklight.bookmarks.title') + ' - ' + application_name %>
+<% @page_title = t('blacklight.bookmarks.page_title', :application_name => application_name) %>
 
 <%= javascript_include_tag 'commonwealth-vlr-engine/folder_tools' %>
 

data/app/views/catalog/_basic_search.html.erb

@@ -5,7 +5,7 @@
 
   <ul id="search_mode_tabs" class="nav nav-tabs">
     <li class="active"><a href="#">Basic</a></li>
-    <li class="hidden-xs"><%= link_to 'Advanced', advanced_search_path %></li>
+    <li class="hidden-xs"><%= link_to 'Advanced', blacklight_advanced_search_engine.advanced_search_path %></li>
   </ul>
 
   <div class="tab-content">
@@ -22,7 +22,7 @@
                          :method => :get,
                          :id => 'basic_search_form',
                          :class => 'basic-search-form form-inline' do %>
-                <%= render_hash_as_hidden_fields(params_for_search().except(:q, :qt, :page, :f, :sort)) %>
+                <%= render_hash_as_hidden_fields(search_state.params_for_search().except(:q, :qt, :page, :f, :sort)) %>
                 <label for="q_basic" class="sr-only">
                   <%= t('blacklight.search.form.search.label') %>
                 </label>
@@ -31,7 +31,9 @@
                                    :placeholder => t('blacklight.search.basic_search.form.q'),
                                    :class => 'search_q q form-control',
                                    :id => 'q_basic',
-                                   :autofocus => should_autofocus_on_search_box? %>
+                                   :autofocus => should_autofocus_on_search_box?,
+                                   data: { autocomplete_enabled: autocomplete_enabled?,
+                                           autocomplete_path: blacklight.suggest_index_path } %>
 
                 <% unless search_fields.empty? %>
                     <label for="search_field" class="sr-only">

data/app/views/catalog/_constraints.html.erb

@@ -11,7 +11,7 @@
           <% if current_user %>
               <li>
                 <%= link_to t('blacklight.saved_searches.save'),
-                            save_search_path( session[:history].first ),
+                            blacklight.save_search_path( session[:history].first ),
                             :method => :put,
                             :id=>'saveSearchLink',
                             :class=>'catalog_saveSearchLink btn btn-sm btn-default' %>

data/app/views/catalog/_facet_limit_series.html.erb

@@ -1,15 +1,17 @@
 <div id="documents">
   <% display_facet.items.each do |item| -%>
       <% series_title = facet_display_value(solr_field, item) %>
+      <% series_object = get_series_image_obj(series_title, @collection_title) %>
       <div class="document col-sm-3">
         <div class="thumbnail">
-          <%= link_to(create_thumb_img_element(get_series_image_obj(series_title,
-                                                                    @collection_title),
-                                               %w(series_thumbnail)),
-                      add_facet_params_and_redirect(solr_field, item)) %>
+          <% if series_object %>
+            <%= link_to(create_thumb_img_element(series_object,
+                                                 %w(series_thumbnail)),
+                        path_for_facet(solr_field, item)) %>
+          <% end %>
           <div class="caption">
             <%= (link_to(series_title,
-                         add_facet_params_and_redirect(solr_field, item),
+                         path_for_facet(solr_field, item),
                          :class=> 'facet_select')).html_safe %><!-- <br/>
                 <span class="series_facet_count">
                   <%# render_facet_count(item.hits) + ' items' %>

data/app/views/catalog/_index_gallery.html.erb

@@ -1,6 +1,4 @@
-<%# copy (with some changes) of  blacklight-gallery/app/views/catalog/_index_gallery %>
-<%# need this partial or catalog#index will attempt to render blacklight-maps/index_map %>
-<%# whenever rendering a doc with 'map' as the value of blacklight_config.display_type_field %>
+<%# copy (with some changes to styles) of  blacklight-gallery/app/views/catalog/_index_gallery %>
 <div class="document col-xs-6 col-sm-4 col-md-4 <%= cycle('new_row', '', '', name: 'desktop_row_class') %> <%= cycle('new_row_device', '', name: 'device_row_class') %>">
   <div class="thumbnail">
     <%= render_thumbnail_tag(document, {}, :counter => document_counter_with_offset(document_counter)) %>

data/app/views/catalog/_search_form.html.erb

@@ -1,17 +1,27 @@
-<%= form_tag search_action_url, :method => :get, :class => 'search-query-form form-inline clearfix navbar-form' do %>
-    <%= render_hash_as_hidden_fields(params_for_search().except(:q, :search_field, :qt, :page, :utf8)) %>
+<%= form_tag search_action_url, method: :get, class: 'search-query-form form-inline clearfix navbar-form', role: 'search'  do %>
+    <%= render_hash_as_hidden_fields(search_state.params_for_search().except(:q, :search_field, :qt, :page, :utf8)) %>
 
       <% unless search_fields.empty? %>
 
       <div class="search_select_wrapper">
         <label for="search_field" class="sr-only"><%= t('blacklight.search.form.search_field.label') %></label>
-        <%= select_tag(:search_field, options_for_select(search_fields, h(params[:search_field])), :title => t('blacklight.search.form.search_field.title'), :class=>'search_field btn btn-default') %>
+        <%= select_tag(:search_field,
+                       options_for_select(search_fields, h(params[:search_field])),
+                       title: t('blacklight.search.form.search_field.title'),
+                       class: 'search_field btn btn-default') %>
         <span class="sr-only"><%= t('blacklight.search.form.search_field.post_label') %></span>
         </div>
       <% end %>
     <label for="q" class="sr-only"><%= t('blacklight.search.form.search.label') %></label>
     <div class="input-group">
-      <%= text_field_tag :q, params[:q], :placeholder => t('blacklight.search.form.search.placeholder'), :class => 'search_q q form-control', :id => 'q', :autofocus => should_autofocus_on_search_box? %>
+      <%= text_field_tag :q,
+                         params[:q],
+                         placeholder: t('blacklight.search.form.search.placeholder'),
+                         class: 'search_q q form-control',
+                         id: 'q',
+                         autofocus: should_autofocus_on_search_box?,
+                         data: { autocomplete_enabled: autocomplete_enabled?,
+                                 autocomplete_path: blacklight.suggest_index_path } %>
 
       <span class="input-group-btn">
         <button type="submit" class="btn btn-primary search-btn" id="search">

data/app/views/catalog/_show_partials/_show_default_metadata.html.erb

@@ -319,6 +319,15 @@
           <% end %>
         </dd>
     <% end %>
+    <%# physical description note field %>
+    <% if document[:note_physical_tsim] %>
+        <dt><%= t('blacklight.metadata_display.fields.note_physical') %>:</dt>
+        <dd>
+          <% document[:note_physical_tsim].each do |physical_note| %>
+              <%= physical_note %><br />
+          <% end %>
+        </dd>
+    <% end %>
     <%# extent field %>
     <% if document[:extent_tsi] %>
       <dt><%= t('blacklight.metadata_display.fields.extent') %>:</dt>

data/app/views/catalog/_show_partials/_show_flagged_notice.html.erb

@@ -16,7 +16,7 @@
         <% if current_search_session %>
             <%= link_back_to_catalog(:class => 'btn btn-danger') %>
         <% else %>
-            <%= link_to t('blacklight.back_to_search'), catalog_index_path, :class => 'btn btn-danger' %>
+            <%= link_to t('blacklight.back_to_search'), search_catalog_path, :class => 'btn btn-danger' %>
         <% end %>
       </div>
     </div>