blacklight 5.13.1 → 5.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa14f9dfd9ac0a4e26d1905608d59f8e992bcae3
-  data.tar.gz: e8cdf5a5a230634dfb787292d83dcf00da17e60d
+  metadata.gz: 155a3451e8e922400f8c30a67dd298471dd7c176
+  data.tar.gz: 70525a0b4e6393a968af18a813f05221b691d921
 SHA512:
-  metadata.gz: b4eba5b2e373d15fb4350ed3647489320a86f8839887ff1f72bf353c7f0988a72d3f3d1bb0906b26b1910778d28b496f0351a04f58e1294918f6a206f46119e6
-  data.tar.gz: dc9e78e09a197f569cd54bee0e52f39dba67ff99639d35ce1c3418972d1a741c5067fae0e078b5127af3b1c48d11a44b37a417d4845ee31248bf61338264ec9c
+  metadata.gz: 90ce5a38742b9a880f307faaef78687bfa169cbd016af562d9824c84652d883bc19aaf59b6ed2333ea4ccdfbcf98937e394592992863bd34a20036346c942e2c
+  data.tar.gz: dbe00471126594db517968998e5c705bb434ae5b1f638e460c74e9ce4f36724e275411ac8ee27d43edaa808ec8e37efecd6d369c7d2e9a069f31126c94bc8205

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop_todo.yml

@@ -24,6 +24,11 @@ Lint/UnusedMethodArgument:
 Lint/UselessAssignment:
   Enabled: false
 
+# Offense count: 10
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 212
+
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.

data/VERSION

@@ -1 +1 @@
-5.13.1
+5.14.0

data/app/assets/stylesheets/blacklight/_header.scss

@@ -29,8 +29,7 @@
     border: 0;
   }
   .submit-search-text {
-    // hide 'search' label at very small screens, magnifying glass
-    // icon should still be there. 
+    // hide 'search' label at very small screens
     @media screen and (max-width: $screen-xs-min ) {      
       // copied from .sr-only, sadly can't seem to use @extend in a media
       // query like this, have to copy. 

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -9,7 +9,7 @@ module Blacklight::FacetsHelperBehavior
   # @param [Hash] options
   # @return [Boolean]
   def has_facet_values? fields = facet_field_names, options = {}
-    facets_from_request(fields).any? { |display_facet| !display_facet.items.empty? }
+    facets_from_request(fields).any? { |display_facet| !display_facet.items.empty? && should_render_facet?(display_facet) }
   end
 
   ##
@@ -123,12 +123,26 @@ module Blacklight::FacetsHelperBehavior
   # @option options [Boolean] :suppress_link display the facet, but don't link to it
   # @return [String]
   def render_facet_value(facet_field, item, options ={})
-    path = search_action_path(add_facet_params_and_redirect(facet_field, item))
+    path = path_for_facet(facet_field, item)
     content_tag(:span, :class => "facet-label") do
       link_to_unless(options[:suppress_link], facet_display_value(facet_field, item), path, :class=>"facet_select")
     end + render_facet_count(item.hits)
   end
 
+  ##
+  # Where should this facet link to?
+  # @param [Blacklight::SolrResponse::Facets::FacetField]
+  # @param [String] facet item
+  # @return [String]
+  def path_for_facet(facet_field, item)
+    facet_config = facet_configuration_for_field(facet_field)
+    if facet_config.url_method
+      path = send(facet_config.url_method, facet_field, item)
+    else
+      path = search_action_path(add_facet_params_and_redirect(facet_field, item))
+    end
+  end
+
   ##
   # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
   # @params (see #render_facet_value)

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -1,4 +1,6 @@
 require 'deprecation'
+##
+# URL helper methods
 module Blacklight::UrlHelperBehavior
   extend Deprecation
   self.deprecation_horizon = 'blacklight 6.0'
@@ -255,9 +257,10 @@ module Blacklight::UrlHelperBehavior
 
     # Delete any request params from facet-specific action, needed
     # to redir to index action properly. 
-    new_params.except! *Blacklight::Solr::FacetPaginator.request_keys.values
+    request_keys = blacklight_config.facet_paginator_class.request_keys
+    new_params.except! *request_keys.values
 
-    new_params 
+    new_params
   end
 
   # copies the current params (or whatever is passed in as the 3rd arg)

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

@@ -1,8 +1,8 @@
     <div class="prev_next_links btn-group pull-left">
-      <%= link_to_previous_page @pagination, raw(t('views.pagination.previous')), :params => params, :param_name => Blacklight::Solr::FacetPaginator.request_keys[:page], :class => 'btn btn-link', :data => {:ajax_modal => "preserve"} do %>
+      <%= link_to_previous_page @pagination, raw(t('views.pagination.previous')), :params => params, :param_name => blacklight_config.facet_paginator_class.request_keys[:page], :class => 'btn btn-link', :data => {:ajax_modal => "preserve"} do %>
        <span class="disabled btn btn-disabled"><%= raw(t('views.pagination.previous')) %></span>
      <% end %>
-      <%= link_to_next_page @pagination, raw(t('views.pagination.next')), :params => params, :param_name => Blacklight::Solr::FacetPaginator.request_keys[:page], :class => 'btn btn-link',  :data => {:ajax_modal => "preserve"} do %>
+      <%= link_to_next_page @pagination, raw(t('views.pagination.next')), :params => params, :param_name => blacklight_config.facet_paginator_class.request_keys[:page], :class => 'btn btn-link',  :data => {:ajax_modal => "preserve"} do %>
        
        <span class="disabled btn  btn-disabled"><%= raw(t('views.pagination.next')) %></span>
       <% end %>

data/config/locales/blacklight.fr.yml

@@ -48,16 +48,6 @@ fr:
       list_title: 'Vos favoris'
       delete: 'Supprimer'
 
-    folder:
-      title: 'Panier'
-      add:
-        success: '%{title} a bien été sélectionné.'
-      remove:
-        success: '%{title} a bien été supprimé.'
-      clear:
-        success: 'Panier vide.'
-      no_folder: 'Votre panier est vide'
-
     saved_searches:
       add:
         success: 'Votre recherche a bien été sauvegardée.'

data/config/locales/blacklight.it.yml

@@ -0,0 +1,226 @@
+it:
+  views:
+    pagination:
+      first: '« Pagina iniziale'
+      last: 'Pagina finale »'
+      previous: '« Pagina precedente'
+      next: 'Pagina successiva »'
+      truncate: '…'
+
+    pagination_compact:
+      previous: '« Pagina precedente'
+      next: 'Pagina successiva »'
+
+  blacklight:
+    application_name: 'Blacklight'
+
+    header_links:
+      login: 'Login'
+      logout: 'Log out'
+      bookmarks: 'Preferiti'
+      saved_searches: 'Ricerche salvate'
+      search_history: 'Ricerche effettuate'
+
+    welcome: 'Benvenuti!'
+    and: 'e'
+    or: 'o'
+
+    bookmarks:
+      title: 'Preferiti'
+      no_bookmarks: 'Non è stato salvato nessun preferito.'
+      add:
+        button: 'Preferiti'
+        success:
+          one: 'Pagina aggiunta a preferiti.'
+          other: 'Pagine aggiunte a preferiti.'
+        failure:  'Si è verificato un errore nel salvare i preferiti.'
+      remove:
+        button: 'Togli la pagina dai preferiti'
+        success: 'La pagina è stata tolta dai preferiti.'
+        failure: 'Si è verificato un errore nel togliere la pagina dai preferiti.'
+        action_confirm: 'Vuoi togliere questa pagina dai preferiti?'
+      clear:
+        action_title: 'Cancella tutti i preferiti'
+        action_confirm: 'Vuoi cancellare tutti i preferiti?'
+        success: 'Tutti i preferiti sono stati cancellati.'
+        failure: 'Si è verificato un errore nel cancellare i preferiti.'
+      need_login: 'Effettuare il login per gestire e visualizzare i preferiti.'
+      list_title: 'Preferiti'
+      delete: 'Togli'
+
+    saved_searches:
+      add:
+        success: 'Ricerca salvata.'
+        failure: 'Si è verificato un errore nel salvare la ricerca.'
+      remove:
+        success: 'La ricerca è stata tolta dalla lista.'
+        failure: 'Si è verificato un errore nel togliere la ricerca dalla lista.'
+      clear:
+        action_title: 'Cancella tutte le ricerche salvate'
+        action_confirm: 'Vuoi cancellare tutte le ricerche salvate?'
+        success: 'Tutte le ricerche salvate sono state cancellate.'
+        failure: 'Si è verificato un errore nel cancellare le ricerche salvate.'
+      title: 'Ricerche salvate'
+      need_login: 'Effettuare il login per gestire e visualizzare le ricerche salvate.'
+      no_searches: 'Non è stata salvata nessuna ricerca.'
+      list_title: 'Ricerche salvate'
+      delete: 'cancella'
+
+    search_history:
+      clear:
+        action_title: 'Cancella le ricerche effettuate'
+        action_confirm: 'Vuoi cancellare le ricerche effettuate?'
+        success: 'Le ricerche effettuate sono state cancellate.'
+        failure: 'Si è verificato un errore nel cancellare le ricerche effettuate.'
+      title: 'Ricerche effettuate'
+      no_history: 'Non è stata effettuata nessuna ricerca'
+      recent: 'Ricerche effettuate'
+      forget: 'dimentica'
+      save: 'salva'
+
+    tools:
+      title: 'Strumenti'
+      citation: 'Cita'
+      endnote: 'Esporta in EndNote'
+      refworks: 'Esporta in Refworks'
+      email: 'Invia per e-mail'
+      sms: 'Invia per SMS'
+      clear: 'Cancella'
+
+    citation:
+      mla: 'MLA'
+      apa: 'APA'
+      chicago: 'Chicago'
+
+    email:
+      form:
+        title: 'Invia per e-mail'
+        to: 'E-mail:'
+        message: 'Messaggio:'
+        submit: 'Invia'
+      text:
+        title: 'Titolo: %{value}'
+        author: 'Autore: %{value}'
+        format: 'Formato: %{value}'
+        language: 'Lingua: %{value}'
+        subject:
+          one: 'Numero di scheda: %{title}'
+          other: 'Numeri di scheda'
+        url: 'URL: %{url}'
+        message: 'Messaggio: %{message}'
+
+      success: "Messaggio inviato"
+
+      errors:
+        to:
+          invalid: "L'indirizzo e-mail inserito non è valido"
+          blank: 'Inserisci un destinatario per inviare il messaggio'
+    sms:
+      form:
+        title: 'Invia per SMS'
+        to: 'Numero di telefono:'
+        carrier: 'Operatore'
+        carrier_prompt: "Indicare l'operatore"
+        submit: 'Inviare'
+      text:
+        title: '%{value}'
+        author: ' da %{value}'
+        url: 'Link: %{url}'
+      success: "SMS inviato"
+      errors:
+        to:
+          invalid: 'Inserisci un numero telefonico valido di 10 cifre'
+          blank: "Inserisci il numero di telefono del destinarario per inviare il messaggio"
+        carrier:
+          blank: 'Si richiede la scelta di un operatore'
+          invalid: "L'operatore non è valido"
+
+    back_to_search: 'Torna alla ricerca'
+    back_to_bookmarks: 'Torna ai preferiti'
+
+    search:
+      title: 'Risultati della ricerca per %{application_name}'
+      search_results_header: 'Ricerca'
+      search_results: 'Risultati della ricerca'
+      errors:
+        request_error: "La richiesta non è comprensibile."
+        invalid_solr_id: "Il numero di scheda richiesto non esiste."
+      per_page:
+        label: '%{count}<span class="sr-only"> per pagina</span>'
+        button_label: '%{count} per pagina'
+        title: 'Risultati per pagina'
+        submit: 'Aggiorna'
+      sort:
+        label: 'Ordina per %{field}'
+        submit: 'Ordina i risultati'
+      form:
+        search_field:
+          label: 'Cerca in'
+          title: 'Opzioni di ricerca mirate'
+          post_label: 'per'
+        # i18n key 'q' is deprecated and will be removed in Blacklight 6.0, use 'search.label' and 'search.placeholder'
+        q: 'Ricerca in corso...'
+        search:
+          label: 'cerca per'
+          placeholder: 'Ricerca in corso...'
+        submit: 'Avvia la ricerca'
+      pagination:
+        title: 'Navigazione nei risultati'
+      pagination_info:
+        no_items_found: 'Nessun %{entry_name} trovano'
+        single_item_found: '<strong>1</strong> %{entry_name} trovato'
+        pages:
+          one: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> di <strong>%{total_num}</strong>'
+          other: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> di <strong>%{total_num}</strong>'
+      entry_pagination_info:
+        one: '<strong>1 di 1</strong>'
+        other: '<strong>%{current}</strong> di <strong>%{total}</strong>'
+      documents:
+        counter: '%{counter}. '
+      facets:
+        title: 'Affina la ricerca'
+        sort:
+          count: 'Ordina per numero'
+          index: 'Ordina A-Z'
+        count: '%{number}'
+        # i18n key 'more' is deprecated and will be removed in Blacklight 6.0 
+        more: 'altri »'
+        more_html: 'altri <span class="sr-only">%{field_name}</span> »'
+        selected:
+          remove: '[cancella]'
+      group:
+        more: 'altri »'
+      filters:
+        title: 'Hai cercato per:'
+        label: '%{label}:'
+        remove:
+          value: 'Cancella il filtro %{value}'
+          label_value: 'Cancella il filtro %{label}: %{value}'
+      start_over: 'Nuova ricerca'
+      index:
+        label: '%{label}:'
+      show:
+        title: '%{document_title} - %{application_name}'
+        label: '%{label}:'
+      rss_feed: 'RSS per i risultati'
+      atom_feed: 'Atom per i risultati'
+      fields:
+        default: 'Parola chiave'
+      bookmarks:
+        present: "Nei preferiti"
+        absent: "Non fra i preferiti"
+        inprogress: "Salvataggio in corso..."
+      zero_results:
+        title: "La ricerca non ha prodotto alcun risultato"
+        modify_search: "Modifica la ricerca"
+        use_fewer_keywords: "Usa meno parole chiave per iniziare, poi raffina la ricerca con i links sulla sinistra."
+        search_fields: "hai cercato in %{search_fields}"
+        search_everything: "prova a cercare in tutti i campi"
+      view_title: "Visualizza i risultati come: "
+      view:
+        list: "Lista"
+
+    entry_name:
+      default: 'termine di ricerca'
+
+    did_you_mean: 'Intendevi digitare: %{options}?'

data/config/locales/blacklight.pt-BR.yml

@@ -1,12 +1,4 @@
 pt-BR:
-  active_record:
-    models:
-      feedback: 'Feedback'
-    attributes:
-      feedback:
-        name: 'Seu Nome'
-        email: 'Seu Email'
-        message: 'Sua Mensagem'
   views:
     pagination:
       first: '« primeiro'
@@ -34,9 +26,6 @@ pt-BR:
     or: 'ou'
 
     bookmarks:
-      collection:
-        add:
-          button: 'Adicionar aos Favoritos'
       title: 'Favoritos'
       no_bookmarks: 'Você não salvou nenhum Favorito'
       add:
@@ -58,17 +47,6 @@ pt-BR:
       need_login: 'Faça o login para ver ou modificar seus favoritos.'
       list_title: 'Seus Favoritos'
       delete: 'Excluir'
-
-    feedback:
-      valid_name: 'Preencha o Nome'
-      valid_email: 'Verifique seu endereço de email'
-      need_message: 'Escreva uma mensagem'
-      submit: 'Enviar!'
-      errors:
-        title: 'Por favor corrija os seguintes erros no formulário:'
-      complete:
-        title: 'Obrigado por seu contato'
-
     saved_searches:
       add:
         success: 'Sua busca foi salva.'

data/lib/blacklight/configuration.rb

@@ -76,6 +76,8 @@ module Blacklight
           document_model: nil,
           # document presenter class used by helpers and views
           document_presenter_class: nil,
+          # Class for paginating long lists of facet fields
+          facet_paginator_class: nil,
           # repository connection configuration
           connection_config: nil,
           ##
@@ -228,6 +230,10 @@ module Blacklight
       Blacklight::Solr::SearchBuilder
     end
 
+    def facet_paginator_class
+      super || Blacklight::Solr::FacetPaginator
+    end
+
     def default_per_page
       super || per_page.first
     end
@@ -334,11 +340,10 @@ module Blacklight
       # too. These model names should not be `#dup`'ed or we might break ActiveModel::Naming.
       def deep_copy
         deep_dup.tap do |copy|
-          copy.repository_class = self.repository_class
-          copy.response_model = self.response_model
-          copy.document_model = self.document_model
-          copy.document_presenter_class = self.document_presenter_class
-          copy.search_builder_class = self.search_builder_class
+          %w(repository_class response_model document_model document_presenter_class search_builder_class facet_paginator_class).each do |klass|
+            # Don't copy if nil, so as not to prematurely autoload default classes
+            copy.send("#{klass}=", send(klass)) unless fetch(klass.to_sym, nil).nil?
+          end
         end
       end
       alias_method :inheritable_copy, :deep_copy

data/lib/blacklight/document.rb

@@ -15,6 +15,7 @@
 module Blacklight::Document
   autoload :ActiveModelShim, 'blacklight/document/active_model_shim'
   autoload :SchemaOrg, 'blacklight/document/schema_org'
+  autoload :CacheKey, 'blacklight/document/cache_key'
   autoload :DublinCore, 'blacklight/document/dublin_core'
   autoload :Email, 'blacklight/document/email'
   autoload :SemanticFields, 'blacklight/document/semantic_fields'
@@ -25,6 +26,7 @@ module Blacklight::Document
   extend ActiveSupport::Concern
   include Blacklight::Document::SchemaOrg
   include Blacklight::Document::SemanticFields
+  include Blacklight::Document::CacheKey
   include Blacklight::Document::Export
 
   extend Deprecation

data/lib/blacklight/document/cache_key.rb

@@ -0,0 +1,23 @@
+# -*- encoding : utf-8 -*-
+# This module provides the cache key which can be used by rails
+# caching to determine when to expire a particular object's cache
+# See http://apidock.com/rails/ActiveRecord/Integration/cache_key
+# This key should be used in conjunction with additional data to
+# determine when a document can be cached (e.g. for different view
+# types in search results like gallery and list)
+module Blacklight::Document::CacheKey
+  def cache_key
+    case
+    when new_record?
+      "#{self.class.model_name.cache_key}/new"
+    when cache_version_value = self[cache_version_key]
+      "#{self.class.model_name.cache_key}/#{id}-#{Array(cache_version_value).join}"
+    else
+      "#{self.class.model_name.cache_key}/#{id}"
+    end
+  end
+
+  def cache_version_key
+    :_version_
+  end
+end

data/lib/blacklight/facet.rb

@@ -1,14 +1,15 @@
-# These are methods that are used at both the view helper and controller layers
-# They are only dependent on `blacklight_config` and `@response`
-#
 module Blacklight
+  # These are methods that are used at both the view helper and controller layers
+  # They are only dependent on `blacklight_config` and `@response`
+  #
   module Facet
-
-    def facet_paginator field_config, display_facet
-      Blacklight::Solr::FacetPaginator.new(display_facet.items, 
+    def facet_paginator(field_config, display_facet)
+      blacklight_config.facet_paginator_class.new(
+        display_facet.items,
         sort: display_facet.sort,
-        offset: display_facet.offset,     
-        limit: facet_limit_for(field_config.key))
+        offset: display_facet.offset,
+        limit: facet_limit_for(field_config.key)
+      )
     end
 
     def facets_from_request(fields = facet_field_names)
@@ -20,17 +21,13 @@ module Blacklight
     end
 
     def facet_configuration_for_field(field)
-      f = blacklight_config.facet_fields[field]
-      f ||= begin
-        _, value = blacklight_config.facet_fields.find { |k,v| v.field.to_s == field.to_s }
-        value
-      end
-      f ||= Blacklight::Configuration::FacetField.new(:field => field).normalize!
+      blacklight_config.facet_fields[field] ||
+        blacklight_config.facet_fields.values.find { |v| v.field.to_s == field.to_s } ||
+        Blacklight::Configuration::FacetField.new(field: field).normalize!
     end
 
-
     # Get a FacetField object from the @response
-    def facet_by_field_name field_or_field_name
+    def facet_by_field_name(field_or_field_name)
       case field_or_field_name
       when String, Symbol, Blacklight::Configuration::FacetField
         facet_field = facet_configuration_for_field(field_or_field_name)

data/lib/blacklight/rails/routes.rb

@@ -18,7 +18,7 @@ module ActionDispatch::Routing
     private
     def raise_no_blacklight_secret_key #:nodoc:
       raise <<-ERROR
-Blacklight.secret_key was not set. Please add the following to an initializer:
+Blacklight.secret_key was not set. If you are using Rails 4.1+, set your app's secret key base (config/secrets.yml) OR add the following to an initializer:
 
 Blacklight.secret_key = '#{SecureRandom.hex(64)}'
 

data/lib/blacklight/request_builders.rb

@@ -23,7 +23,12 @@ module Blacklight
       # CatalogController.include ModuleDefiningNewMethod
       # CatalogController.search_params_logic += [:new_method]
       # CatalogController.search_params_logic.delete(:we_dont_want)
-      self.search_params_logic = [:default_solr_parameters, :add_query_to_solr, :add_facet_fq_to_solr, :add_facetting_to_solr, :add_solr_fields_to_query, :add_paging_to_solr, :add_sorting_to_solr, :add_group_config_to_solr ]
+      self.search_params_logic = [
+        :default_solr_parameters, :add_query_to_solr, :add_facet_fq_to_solr,
+        :add_facetting_to_solr, :add_solr_fields_to_query, :add_paging_to_solr,
+        :add_sorting_to_solr, :add_group_config_to_solr,
+        :add_facet_paging_to_solr
+      ]
 
       if self.respond_to?(:helper_method)
         helper_method(:facet_limit_for)
@@ -111,35 +116,6 @@ module Blacklight
     end
     deprecation_deprecate :solr_documents_by_field_values_params
 
-    ##
-    # Retrieve a facet's paginated values.
-    def solr_facet_params(facet_field, user_params=params || {}, extra_controller_params={})
-      input = user_params.deep_merge(extra_controller_params)
-      facet_config = blacklight_config.facet_fields[facet_field]
-
-      solr_params = {}
-
-      # Now override with our specific things for fetching facet values
-      solr_params[:"facet.field"] = search_builder.with_ex_local_param((facet_config.ex if facet_config.respond_to?(:ex)), facet_field)
-
-      limit = if respond_to?(:facet_list_limit)
-          facet_list_limit.to_s.to_i
-        elsif solr_params["facet.limit"]
-          solr_params["facet.limit"].to_i
-        else
-          20
-        end
-
-      # Need to set as f.facet_field.facet.* to make sure we
-      # override any field-specific default in the solr request handler.
-      solr_params[:"f.#{facet_field}.facet.limit"]  = limit + 1
-      solr_params[:"f.#{facet_field}.facet.offset"] = ( input.fetch(Blacklight::Solr::FacetPaginator.request_keys[:page] , 1).to_i - 1 ) * ( limit )
-      solr_params[:"f.#{facet_field}.facet.sort"] = input[  Blacklight::Solr::FacetPaginator.request_keys[:sort] ] if  input[  Blacklight::Solr::FacetPaginator.request_keys[:sort] ]
-      solr_params[:rows] = 0
-
-      solr_params
-    end
-
     ##
     # Opensearch autocomplete parameters for plucking a field's value from the results
     def solr_opensearch_params(field=nil)

data/lib/blacklight/search_builder.rb

@@ -51,6 +51,7 @@ module Blacklight
       builder.start(@start) if @start
       builder.rows(@rows) if @rows
       builder.page(@page) if @page
+      builder.facet(@facet) if @facet
 
       builder
     end
@@ -204,6 +205,18 @@ module Blacklight
       field unless field.blank?
     end
 
+    # sets the facet that this query pertains to, if it is for the purpose of
+    # facet pagination
+    def facet(facet = nil)
+      if facet
+        params_will_change!
+        @facet = facet
+        self
+      else
+        @facet
+      end
+    end
+
     def search_field
       blacklight_config.search_fields[blacklight_params[:search_field]]
     end

data/lib/blacklight/search_helper.rb

@@ -159,8 +159,8 @@ module Blacklight::SearchHelper
   # Get the solr response when retrieving only a single facet field
   # @return [Blacklight::SolrResponse] the solr response
   def get_facet_field_response(facet_field, user_params = params || {}, extra_controller_params = {})
-    query = search_builder.with(user_params).merge(extra_controller_params).merge(solr_facet_params(facet_field, user_params, extra_controller_params))
-    repository.search(query)
+    query = search_builder.with(user_params).facet(facet_field)
+    repository.search(query.merge(extra_controller_params))
   end
 
   # a solr query method

data/lib/blacklight/solr.rb

@@ -1,7 +1,5 @@
 # -*- encoding : utf-8 -*-
 module Blacklight::Solr
-  
-  autoload :Facets, 'blacklight/solr/facets'
   autoload :FacetPaginator, 'blacklight/solr/facet_paginator'
   autoload :Document, 'blacklight/solr/document'
   autoload :Request, 'blacklight/solr/request'

data/lib/blacklight/solr/search_builder.rb

@@ -1,5 +1,6 @@
 module Blacklight::Solr
-  # @deprecated
+  # @deprecated In 6.0 you should have this class generated into your application and Blacklight will
+  #             no longer need to provide it.
   class SearchBuilder < Blacklight::SearchBuilder
     include Blacklight::Solr::SearchBuilderBehavior
   end

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -3,7 +3,12 @@ module Blacklight::Solr
     extend ActiveSupport::Concern
 
     included do
-      self.default_processor_chain = [:default_solr_parameters, :add_query_to_solr, :add_facet_fq_to_solr, :add_facetting_to_solr, :add_solr_fields_to_query, :add_paging_to_solr, :add_sorting_to_solr, :add_group_config_to_solr ]
+      self.default_processor_chain = [
+        :default_solr_parameters, :add_query_to_solr, :add_facet_fq_to_solr,
+        :add_facetting_to_solr, :add_solr_fields_to_query, :add_paging_to_solr,
+        :add_sorting_to_solr, :add_group_config_to_solr,
+        :add_facet_paging_to_solr
+      ]
     end
 
     ####
@@ -190,6 +195,38 @@ module Blacklight::Solr
       end
     end
 
+    def add_facet_paging_to_solr(solr_params)
+      return unless facet.present?
+
+      facet_config = blacklight_config.facet_fields[facet]
+
+      # Now override with our specific things for fetching facet values
+      facet_ex = facet_config.respond_to?(:ex) ? facet_config.ex : nil
+      solr_params[:"facet.field"] = with_ex_local_param(facet_ex, facet)
+
+      limit = if scope.respond_to?(:facet_list_limit)
+                scope.facet_list_limit.to_s.to_i
+              elsif solr_params["facet.limit"]
+                solr_params["facet.limit"].to_i
+              else
+                20
+              end
+
+      page = blacklight_params.fetch(request_keys[:page], 1).to_i
+      offset = (page - 1) * (limit)
+
+      sort = blacklight_params[request_keys[:sort]]
+
+      # Need to set as f.facet_field.facet.* to make sure we
+      # override any field-specific default in the solr request handler.
+      solr_params[:"f.#{facet}.facet.limit"] = limit + 1
+      solr_params[:"f.#{facet}.facet.offset"] = offset
+      if blacklight_params[request_keys[:sort]]
+        solr_params[:"f.#{facet}.facet.sort"] = sort
+      end
+      solr_params[:rows] = 0
+    end
+
     def with_ex_local_param(ex, value)
       if ex
         "{!ex=#{ex}}#{value}"
@@ -277,5 +314,9 @@ module Blacklight::Solr
         facet.include_in_request || (facet.include_in_request.nil? && blacklight_config.add_facet_fields_to_solr_request)
       end
     end
+
+    def request_keys
+      blacklight_config.facet_paginator_class.request_keys
+    end
   end
 end

data/lib/blacklight/solr_response/facets.rb

@@ -31,7 +31,8 @@ module Blacklight::SolrResponse::Facets
   class FacetField
     attr_reader :name, :items
     def initialize name, items, options = {}
-      @name, @items = name, items
+      @name = name
+      @items = items
       @options = options
     end
 

data/spec/helpers/facets_helper_spec.rb

@@ -12,9 +12,9 @@ describe FacetsHelper do
   describe "has_facet_values?" do
     it "should be true if there are any facets to display" do
 
-      a = double(:items => [1,2])
-      b = double(:items => ['b','c'])
-      empty = double(:items => [])
+      a = double(:items => [1,2], :name => 'a')
+      b = double(:items => ['b','c'], :name => 'b')
+      empty = double(:items => [], :name => 'empty')
 
       fields = [a,b,empty]
       expect(helper.has_facet_values?(fields)).to be true
@@ -27,6 +27,19 @@ describe FacetsHelper do
       fields = [empty]
       expect(helper.has_facet_values?(fields)).to be false
     end
+
+    it "should be false if no facets are displayable" do
+      @config = Blacklight::Configuration.new do |config|
+        config.add_facet_field 'basic_field', :if => false
+      end
+
+      allow(helper).to receive_messages(:blacklight_config => @config)
+
+      a = double(:items => [1,2], :name=>'basic_field')
+      fields = [a]
+
+      expect(helper.has_facet_values?(fields)).to be false
+    end
   end
 
   describe "should_render_facet?" do
@@ -289,7 +302,7 @@ describe FacetsHelper do
   describe "render_facet_value" do
     let (:item) { double(:value => 'A', :hits => 10) }
     before do
-      allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(double(:query => nil, :date => nil, :helper_method => nil, :single => false))
+      allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(double(:query => nil, :date => nil, :helper_method => nil, :single => false, :url_method => nil))
       allow(helper).to receive(:facet_display_value).and_return('Z')
       allow(helper).to receive(:add_facet_params_and_redirect).and_return({controller:'catalog'})
       
@@ -305,6 +318,16 @@ describe FacetsHelper do
       end
     end
 
+    describe "when :url_method is set" do
+      let(:expected_html) { "<span class=\"facet-label\"><a class=\"facet_select\" href=\"/blabla\">Z</a></span><span class=\"facet-count\">10</span>" }
+      it "should use that method" do
+        allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(double(:query => nil, :date => nil, :helper_method => nil, :single => false, :url_method => :test_method))
+        allow(helper).to receive(:test_method).with('simple_field', item).and_return('/blabla')
+        result = helper.render_facet_value('simple_field', item)
+        expect(result).to be_equivalent_to(expected_html).respecting_element_order
+      end
+    end
+
     describe "when :suppress_link is set" do
       let(:expected_html) { "<span class=\"facet-label\">Z</span><span class=\"facet-count\">10</span>" }
       it "should suppress the link" do
@@ -316,12 +339,12 @@ describe FacetsHelper do
  
   describe "#facet_display_value" do
     it "should just be the facet value for an ordinary facet" do
-      allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(double(:query => nil, :date => nil, :helper_method => nil))
+      allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(double(:query => nil, :date => nil, :helper_method => nil, :url_method => nil))
       expect(helper.facet_display_value('simple_field', 'asdf')).to eq 'asdf'
     end
 
     it "should allow you to pass in a :helper_method argument to the configuration" do
-      allow(helper).to receive(:facet_configuration_for_field).with('helper_field').and_return(double(:query => nil, :date => nil, :helper_method => :my_facet_value_renderer))
+      allow(helper).to receive(:facet_configuration_for_field).with('helper_field').and_return(double(:query => nil, :date => nil, :url_method => nil, :helper_method => :my_facet_value_renderer))
     
       allow(helper).to receive(:my_facet_value_renderer).with('qwerty').and_return('abc')
 
@@ -329,17 +352,17 @@ describe FacetsHelper do
     end
 
     it "should extract the configuration label for a query facet" do
-      allow(helper).to receive(:facet_configuration_for_field).with('query_facet').and_return(double(:query => { 'query_key' => { :label => 'XYZ'}}, :date => nil, :helper_method => nil))
+      allow(helper).to receive(:facet_configuration_for_field).with('query_facet').and_return(double(:query => { 'query_key' => { :label => 'XYZ'}}, :date => nil, :helper_method => nil, :url_method => nil))
       expect(helper.facet_display_value('query_facet', 'query_key')).to eq 'XYZ'
     end
 
     it "should localize the label for date-type facets" do
-      allow(helper).to receive(:facet_configuration_for_field).with('date_facet').and_return(double('date' => true, :query => nil, :helper_method => nil))
+      allow(helper).to receive(:facet_configuration_for_field).with('date_facet').and_return(double('date' => true, :query => nil, :helper_method => nil, :url_method => nil))
       expect(helper.facet_display_value('date_facet', '2012-01-01')).to eq 'Sun, 01 Jan 2012 00:00:00 +0000'
     end
 
     it "should localize the label for date-type facets with the supplied localization options" do
-      allow(helper).to receive(:facet_configuration_for_field).with('date_facet').and_return(double('date' => { :format => :short }, :query => nil, :helper_method => nil))
+      allow(helper).to receive(:facet_configuration_for_field).with('date_facet').and_return(double('date' => { :format => :short }, :query => nil, :helper_method => nil, :url_method => nil))
       expect(helper.facet_display_value('date_facet', '2012-01-01')).to eq '01 Jan 00:00'
     end
   end

data/spec/lib/blacklight/configuration_spec.rb

@@ -96,14 +96,32 @@ describe "Blacklight::Configuration" do
       expect(@config.facet_fields).to_not include(@mock_facet)
     end
 
-    it "should not dup response_model or document_model" do
-      @config.response_model = Blacklight::SolrResponse
-      @config.document_model = SolrDocument
+    context "when model classes are customised" do
+      it "should not dup response_model or document_model" do
+        @config.response_model = Hash
+        @config.document_model = Array
 
-      config_copy = @config.inheritable_copy
+        config_copy = @config.inheritable_copy
 
-      expect(config_copy.response_model).to eq Blacklight::SolrResponse
-      expect(config_copy.document_model).to eq SolrDocument
+        expect(config_copy.response_model).to eq Hash
+        expect(config_copy.document_model).to eq Array
+      end
+    end
+
+    context "when model classes are not set" do
+      it "should leave response_model and document_model empty" do
+        config_copy = @config.inheritable_copy
+
+        expect(config_copy.fetch(:response_model, nil)).to be_nil
+        expect(config_copy.fetch(:document_model, nil)).to be_nil
+      end
+
+      it "should return default classes" do
+        config_copy = @config.inheritable_copy
+
+        expect(config_copy.response_model).to eq Blacklight::SolrResponse
+        expect(config_copy.document_model).to eq SolrDocument
+      end
     end
 
     it "should provide cloned copies of mutable data structures" do
@@ -469,5 +487,10 @@ describe "Blacklight::Configuration" do
       expect(@config.default_search_field.key).to eq 'search_field_2'
     end
   end
-  
+
+  describe "#facet_paginator_class" do
+    it "should default to Blacklight::Solr::FacetPaginator" do
+      expect(@config.facet_paginator_class).to eq Blacklight::Solr::FacetPaginator
+    end
+  end
 end

data/spec/lib/blacklight/document/cache_key_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Blacklight::Document::CacheKey do
+  let(:attributes) { {} }
+  let(:subject) { SolrDocument.new(attributes) }
+  it 'SolrDocument includes the module' do
+    expect(subject.class).to include(Blacklight::Document::CacheKey)
+  end
+
+  describe 'new record' do
+    before do
+      allow(subject).to receive_messages(new_record?: true)
+    end
+    it 'provides an acceptable cache key' do
+      expect(subject.cache_key).to eq 'solr_documents/new'
+    end
+  end
+
+  describe 'with version' do
+    let(:attributes) { { id: '12345', _version_: '1497353774427013120' } }
+    it 'provides a cache key with the id and version' do
+      expect(subject.cache_key).to eq 'solr_documents/12345-1497353774427013120'
+    end
+    describe 'as array' do
+      let(:attributes) { { id: '12345', _version_: ['1234', '4321'] } }
+      it 'provides a cache key with the id and joined version array' do
+        expect(subject.cache_key).to eq 'solr_documents/12345-12344321'
+      end
+    end
+  end
+
+  describe 'without version' do
+    let(:attributes) { { id: '12345' } }
+    it 'provides a cache key with just the id' do
+      expect(subject.cache_key).to eq 'solr_documents/12345'
+    end
+  end
+
+  describe '#cache_version_key' do
+    let(:attributes) { { id: '12345', another_version_field: '1497353774427013120' } }
+    before do
+      allow(subject).to receive_messages(cache_version_key: :another_version_field)
+    end
+    it 'provides a cache key with the defined field' do
+      expect(subject.cache_key).to eq 'solr_documents/12345-1497353774427013120'
+    end
+  end
+end

data/spec/lib/blacklight/facet_spec.rb

@@ -31,4 +31,4 @@ describe Blacklight::Facet do
     end
   end
 
-end
+end

data/spec/lib/blacklight/search_builder_spec.rb

@@ -187,6 +187,16 @@ describe Blacklight::SearchBuilder do
     end
   end
 
+  describe "#facet" do
+    it "should be nil if no value is set" do
+      expect(subject.facet).to be_nil
+    end
+
+    it "should set facet value" do
+      expect(subject.facet('format').facet).to eq 'format'
+    end
+  end
+
   describe "#search_field" do
     it "should use the requested search field" do
       blacklight_config.add_search_field 'x'
@@ -240,4 +250,4 @@ describe Blacklight::SearchBuilder do
     end
 
   end
-end
+end

data/spec/lib/blacklight/search_helper_spec.rb

@@ -64,78 +64,6 @@ describe Blacklight::SearchHelper do
     end
   end
 
-  describe "solr_facet_params" do
-    before do
-      @facet_field = 'format'
-      @generated_solr_facet_params = subject.solr_facet_params(@facet_field)
-
-      @sort_key = Blacklight::Solr::FacetPaginator.request_keys[:sort]
-      @page_key = Blacklight::Solr::FacetPaginator.request_keys[:page]
-    end
-    let(:blacklight_config) do
-      Blacklight::Configuration.new do |config|
-        config.add_facet_fields_to_solr_request!
-        config.add_facet_field 'format'
-        config.add_facet_field 'format_ordered', :sort => :count
-        config.add_facet_field 'format_limited', :limit => 5
-
-      end
-    end
-
-    it 'sets rows to 0' do
-      expect(@generated_solr_facet_params[:rows]).to eq 0
-    end
-    it 'sets facets requested to facet_field argument' do
-      expect(@generated_solr_facet_params["facet.field".to_sym]).to eq @facet_field
-    end
-    it 'defaults offset to 0' do
-      expect(@generated_solr_facet_params[:"f.#{@facet_field}.facet.offset"]).to eq 0
-    end
-    it 'uses offset manually set, and converts it to an integer' do
-      solr_params = subject.solr_facet_params(@facet_field, @page_key => 2)
-      expect(solr_params[:"f.#{@facet_field}.facet.offset"]).to eq 20
-    end
-    it 'defaults limit to 20' do
-      solr_params = subject.solr_facet_params(@facet_field)
-      expect(solr_params[:"f.#{@facet_field}.facet.limit"]).to eq 21
-    end
-
-    describe 'if facet_list_limit is defined in controller' do
-      before do
-        allow(subject).to receive_messages facet_list_limit: 1000
-      end
-      it 'uses controller method for limit' do
-        solr_params = subject.solr_facet_params(@facet_field)
-        expect(solr_params[:"f.#{@facet_field}.facet.limit"]).to eq 1001
-      end
-
-      it 'uses controller method for limit when a ordinary limit is set' do
-        solr_params = subject.solr_facet_params(@facet_field)
-        expect(solr_params[:"f.#{@facet_field}.facet.limit"]).to eq 1001
-      end
-    end
-
-    it 'uses the default sort' do
-      solr_params = subject.solr_facet_params(@facet_field)
-      expect(solr_params[:"f.#{@facet_field}.facet.sort"]).to be_blank
-    end
-
-    it 'uses sort provided in the parameters' do
-      solr_params = subject.solr_facet_params(@facet_field, @sort_key => "index")
-      expect(solr_params[:"f.#{@facet_field}.facet.sort"]).to eq 'index'
-    end
-
-    it "comes up with the same params as #solr_search_params to constrain context for facet list" do
-      search_params = {:q => 'tibetan history', :f=> {:format=>'Book', :language_facet=>'Tibetan'}}
-      solr_facet_params = subject.solr_facet_params('format', search_params)
-
-      expect(solr_facet_params).to include :"facet.field" => "format"
-      expect(solr_facet_params).to include :"f.format.facet.limit" => 21
-      expect(solr_facet_params).to include :"f.format.facet.offset" => 0
-      expect(solr_facet_params).to include :"rows" => 0
-    end
-  end
-
   describe "get_facet_pagination", :integration => true do
     before do
       @facet_field = 'format'

data/spec/lib/blacklight/solr/search_builder_spec.rb

@@ -553,7 +553,71 @@ describe Blacklight::Solr::SearchBuilder do
       end
     end
   end
-  
+
+  describe "#add_facet_paging_to_solr" do
+    let(:facet_field) { 'format' }
+    let(:sort_key) { Blacklight::Solr::FacetPaginator.request_keys[:sort] }
+    let(:page_key) { Blacklight::Solr::FacetPaginator.request_keys[:page] }
+
+    let(:blacklight_config) do
+      Blacklight::Configuration.new do |config|
+        config.add_facet_fields_to_solr_request!
+        config.add_facet_field 'format'
+        config.add_facet_field 'format_ordered', sort: :count
+        config.add_facet_field 'format_limited', limit: 5
+      end
+    end
+
+    let(:solr_parameters) do
+      solr_parameters = Blacklight::Solr::Request.new
+      subject.facet(facet_field).add_facet_paging_to_solr(solr_parameters)
+      solr_parameters
+    end
+
+    it 'sets rows to 0' do
+      expect(solr_parameters[:rows]).to eq 0
+    end
+    it 'sets facets requested to facet_field argument' do
+      expect(solr_parameters["facet.field".to_sym]).to eq facet_field
+    end
+    it 'defaults offset to 0' do
+      expect(solr_parameters[:"f.#{facet_field}.facet.offset"]).to eq 0
+    end
+    context 'when offset is manually set' do
+      let(:user_params) { { page_key => 2 } }
+      it 'uses offset manually set, and converts it to an integer' do
+        expect(solr_parameters[:"f.#{facet_field}.facet.offset"]).to eq 20
+      end
+    end
+    it 'defaults limit to 20' do
+      expect(solr_parameters[:"f.#{facet_field}.facet.limit"]).to eq 21
+    end
+
+    context 'when facet_list_limit is defined in scope' do
+      before do
+        allow(context).to receive_messages facet_list_limit: 1000
+      end
+      it 'uses scope method for limit' do
+        expect(solr_parameters[:"f.#{facet_field}.facet.limit"]).to eq 1001
+      end
+
+      it 'uses controller method for limit when a ordinary limit is set' do
+        expect(solr_parameters[:"f.#{facet_field}.facet.limit"]).to eq 1001
+      end
+    end
+
+    it 'uses the default sort' do
+      expect(solr_parameters[:"f.#{facet_field}.facet.sort"]).to be_blank
+    end
+
+    context 'when sort is provided' do
+      let(:user_params) { { sort_key => 'index' } }
+      it 'uses sort provided in the parameters' do
+        expect(solr_parameters[:"f.#{facet_field}.facet.sort"]).to eq 'index'
+      end
+    end
+  end
+
   describe "#with_tag_ex" do
     it "should add an !ex local parameter if the facet configuration requests it" do
       expect(subject.with_ex_local_param("xyz", "some-value")).to eq "{!ex=xyz}some-value"

data/spec/views/catalog/_constraints_element.html.erb_spec.rb

@@ -32,17 +32,6 @@ describe "catalog/_constraints_element.html.erb" do
     end
   end
 
-  describe "with checkmark suppressed" do
-    before do
-      render :partial => "catalog/constraints_element", :locals => {:label => "my label", :value => "my value", :options => {:check => false}}
-    end
-    it "should not include checkmark" do
-      expect(rendered).to have_selector("span.appliedFilter") do |s|
-        expect(s).to_not have_selector("img[src$='checkmark.gif']")
-      end
-    end
-  end
-
   describe "with custom classes" do
     before do
       render :partial => "catalog/constraints_element", :locals => {:label => "my label", :value => "my value", :options => {:classes => ["class1", "class2"]}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 5.13.1
+  version: 5.14.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -245,6 +245,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_hound.yml"
@@ -256,15 +257,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- app/assets/images/blacklight/bg.png
-- app/assets/images/blacklight/border.png
-- app/assets/images/blacklight/bul_sq_gry.gif
-- app/assets/images/blacklight/checkmark.gif
 - app/assets/images/blacklight/logo.png
-- app/assets/images/blacklight/magnifying_glass.gif
-- app/assets/images/blacklight/remove.gif
-- app/assets/images/blacklight/separator.gif
-- app/assets/images/blacklight/start_over.gif
 - app/assets/images/favicon.ico
 - app/assets/javascripts/blacklight/ajax_modal.js
 - app/assets/javascripts/blacklight/autofocus.js
@@ -407,6 +400,7 @@ files:
 - config/locales/blacklight.en.yml
 - config/locales/blacklight.es.yml
 - config/locales/blacklight.fr.yml
+- config/locales/blacklight.it.yml
 - config/locales/blacklight.pt-BR.yml
 - db/migrate/20140202020201_create_searches.rb
 - db/migrate/20140202020202_create_bookmarks.rb
@@ -431,6 +425,7 @@ files:
 - lib/blacklight/controller.rb
 - lib/blacklight/document.rb
 - lib/blacklight/document/active_model_shim.rb
+- lib/blacklight/document/cache_key.rb
 - lib/blacklight/document/dublin_core.rb
 - lib/blacklight/document/email.rb
 - lib/blacklight/document/export.rb
@@ -527,6 +522,7 @@ files:
 - spec/lib/blacklight/catalog/component_configuration_spec.rb
 - spec/lib/blacklight/configurable_spec.rb
 - spec/lib/blacklight/configuration_spec.rb
+- spec/lib/blacklight/document/cache_key_spec.rb
 - spec/lib/blacklight/document/dublin_core_spec.rb
 - spec/lib/blacklight/document/email_spec.rb
 - spec/lib/blacklight/document/sms_spec.rb
@@ -648,6 +644,7 @@ test_files:
 - spec/lib/blacklight/catalog/component_configuration_spec.rb
 - spec/lib/blacklight/configurable_spec.rb
 - spec/lib/blacklight/configuration_spec.rb
+- spec/lib/blacklight/document/cache_key_spec.rb
 - spec/lib/blacklight/document/dublin_core_spec.rb
 - spec/lib/blacklight/document/email_spec.rb
 - spec/lib/blacklight/document/sms_spec.rb