blacklight 5.1.1 → 5.2.0

data/config/locales/blacklight.es.yml

@@ -0,0 +1,220 @@
+es:
+  views:
+    pagination:
+      first: '« Primero'
+      last: 'Ultimo »'
+      previous: '« Anterior'
+      next: 'Siguiente »'
+      truncate: '…'
+
+    pagination_compact:
+      previous: '« Anterior'
+      next: 'Siguiente »'
+
+  blacklight:
+    application_name: 'Blacklight'
+
+    header_links:
+      login: 'Entrar'
+      logout: 'Salir'
+      bookmarks: 'Favoritos'
+      saved_searches: 'Búsquedas guardadas'
+      search_history: 'Historia'
+
+    welcome: '¡Bienvenido!'
+    and: 'y'
+    or: 'o'
+
+    bookmarks:
+      title: 'Favoritos'
+      no_bookmarks: 'Usted no tiene favoritos'
+      add:
+        button: 'Favoritos'
+        success:
+          one: 'Éxito al añadir su favorito.'
+          other: 'Éxito añadido favorito.'
+        failure: 'Lo siento, hubo un problema al guardar los favoritos.'
+      remove:
+        button: 'Borrar favorito'
+        success: 'Borrado favorito.'
+        failure: 'Lo siento, hubo un problema al borrar los favoritos.'
+        action_confirm: '¿Quitar este favorito?'
+      clear:
+        action_title: 'Borrar favorito'
+        action_confirm: '¿Borrar sus favoritos?'
+        success: 'Se borraron sus favoritos.'
+        failure: 'Lo siento, hubo un problema al borrar sus favoritos.'
+      need_login: 'Por favor, inicie sesión para administrar y ver sus favoritos.'
+      list_title: 'Mis Favoritos'
+      delete: 'Borrar'
+
+    saved_searches:
+      add:
+        success: 'Éxito al añadir su búsqueda.'
+        failure: 'Hubo un problema al guardar su búsqueda.'
+      remove:
+        success: 'Éxito al borrar su búsqueda.'
+        failure: 'Lo siento, hubo un problema al borrar su busqueda.'
+      clear:
+        action_title: 'Borrar Búsquedas Guardadas'
+        action_confirm: '¿Borrar Búsquedas Guardadas?'
+        success: 'Se borraron sus búsquedas guardadas'
+        failure: 'Hubo un problema al borrar sus búsquedas.'
+      title: 'Búsquedas guardadas'
+      need_login: 'Por favor, inicie sesión para administrar y ver sus búsquedas guardadas.'
+      no_searches: 'No tienes búsquedas guardadas'
+      list_title: 'Sus búsquedas guardadas'
+      delete: 'Borrar'
+
+    search_history:
+      clear:
+        action_title: 'Borrar historial de búsqueda'
+        action_confirm: '¿Borrar el historial de búsqueda?'
+        success: 'Se borro el historial de búsqueda.'
+        failure: 'Hubo un problema al borrar su historial de búsqueda.'
+      title: 'Historia'
+      no_history: 'Usted no tiene historial de búsqueda'
+      recent: 'Sus búsquedas recientes'
+      forget: 'Olvidar'
+      save: 'Guardar'
+
+    tools:
+      title: 'Herramientas'
+      cite: 'Cité'
+      endnote: 'Exportar a EndNote'
+      refworks: 'Exportar a Refworks'
+      email: 'Correo electrónico'
+      sms: 'Enviar SMS'
+      clear: 'Borrar'
+
+    citation:
+      mla: 'MLA'
+      apa: 'APA'
+      chicago: 'Chicago'
+
+    email:
+      form:
+        title: 'Enviar'
+        to: 'Email:'
+        message: 'Mensaje:'
+        submit: 'Enviar'
+      text:
+        title: 'Titulo: %{value}'
+        author: 'Autor: %{value}'
+        format: 'Formato: %{value}'
+        language: 'Idioma: %{value}'
+        subject:
+          one: 'Ficha artículo: %{title}'
+          other: 'Ficha artículos'
+        url: 'URL: %{url}'
+        message: 'Mensaje: %{message}'
+
+      success: "Email enviado"
+
+      errors:
+        to:
+          invalid: 'Debe entrar un email válido'
+          blank: 'Debe introducir un destinatario para enviar este mensaje'
+    sms:
+      form:
+        title: 'Enviar SMS'
+        to: 'Número de teléfono:'
+        carrier: 'Compañía telefónica'
+        carrier_prompt: 'Por favor, seleccione su compañía telefónica'
+        submit: 'Enviar'
+      text:
+        title: '%{value}'
+        author: 'por %{value}'
+        url: 'Link: %{url}'
+      success: "SMS enviado"
+      errors:
+        to:
+          invalid: 'Debe entrar un número de teléfono válido de 10 dígitos'
+          blank: "Debe introducir el número de teléfono del destinatario para enviar este mensaj"
+        carrier:
+          blank: 'Debe seleccionar compañía telefónica'
+          invalid: "Debe entrar una compañía telefónica válida"
+
+    back_to_search: 'Volver a Buscar'
+    back_to_bookmarks: 'Volver a sus favoritos'
+
+    search:
+      title: '%{application_name} Resultados de la búsqueda'
+      search_results_header: 'Buscar'
+      search_results: 'Resultados de la búsqueda'
+      errors:
+        request_error: "Lo siento, no entiendo esta búsqueda"
+        invalid_solr_id: "Lo sentimos, usted ha solicitado un registro que no existe."
+      per_page:
+        label: '%{count}<span class="sr-only"> por página</span>'
+        button_label: '%{count} por página'
+        title: 'El número de resultados a mostrar por página'
+        submit: 'Actualización'
+      sort:
+        label: 'Ordenar por %{field}'
+        submit: 'Resultados de ordenación'
+      form:
+        search_field:
+          label: 'Buscar en'
+          title: 'Opciones de Búsqueda temática'
+          post_label: 'para'
+        q: 'Buscar...'
+        submit: 'Buscar'
+      pagination:
+        title: 'Resultados de navegación'
+      pagination_info:
+        no_items_found: 'No %{entry_name} encontrado'
+        single_item_found: '<strong>1</strong> %{entry_name} encontrado'
+        pages:
+          one: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> de <strong>%{total_num}</strong>'
+          other: '<strong>%{start_num}</strong> - <strong>%{end_num}</strong> de <strong>%{total_num}</strong>'
+      entry_pagination_info:
+        one: '<strong>1 de 1</strong>'
+        other: '<strong>%{current}</strong> de <strong>%{total}</strong>'
+      documents:
+        counter: '%{counter}.'
+      facets:
+        title: 'Limite su búsqueda'
+        sort:
+          count: 'Ordenación numérica'
+          index: 'Ordenación A-Z'
+        count: '%{number}'
+        more: 'más »'
+        selected:
+          remove: '[borrar]'
+      group:
+        more: 'más »'
+      filters:
+        title: 'Usted ha buscado:'
+        label: '%{label}:'
+        remove:
+          value: 'Eliminar la restricción %{value}'
+          label_value: 'Eliminar la restricción%{label}: %{value}'
+      start_over: 'Volver a empezar'
+      index:
+        label: '%{label}:'
+      show:
+        title: '%{document_title} - %{application_name}'
+        label: '%{label}:'
+      rss_feed: 'RSS de los resultados'
+      atom_feed: 'Atom de los resultados'
+      fields:
+        default: 'Palabra clave'
+      bookmarks:
+        present: "En Favoritos"
+        absent: "Favoritos"
+        inprogress: "Guardando..."
+      zero_results:
+        title: "No se han encontrado resultados para su búsqueda"
+        modify_search: "Intente modificar su búsqueda"
+        use_fewer_keywords: "Use menos palabras para empezar, y luego refinar la búsqueda utilizando los enlaces de la izquierda."
+        search_fields: "Usted busco por %{search_fields}"
+        search_everything: "Pruebe a buscar de todo"
+      view_title: "Ver Resultados por: "
+      view:
+        list: "Lista"
+
+    entry_name:
+      default: 'entrada'
+
+    did_you_mean: '¿Quiere decir %{options}?'

data/gemfiles/rails4.1.gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+file = File.expand_path("../../Gemfile", __FILE__)
+
+if File.exists?(file)
+  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
+  instance_eval File.read(file)
+end
+
+gem 'rails', '4.1.0.rc1'

data/lib/blacklight/base.rb

@@ -20,7 +20,7 @@ module Blacklight::Base
   # when solr (RSolr) throws an error (RSolr::RequestError), this method is executed.
   def rsolr_request_error(exception)
 
-    if Rails.env.development?
+    if Rails.env.development? || Rails.env.test?
       raise exception # Rails own code will catch and give usual Rails error page with stack trace
     else
 

data/lib/blacklight/catalog/search_context.rb

@@ -6,17 +6,17 @@ module Blacklight::Catalog::SearchContext
   # own controller.
   included do  
     helper_method :current_search_session, :search_session
-    before_filter :search_session, :history_session, :current_search_session
+
   end
-  
-  protected
 
-  # sets up the session[:history] hash if it doesn't already exist.
-  # assigns all Search objects (that match the searches in session[:history]) to a variable @searches.
-  def history_session
-    session[:history] ||= []
-    @searches = searches_from_history # <- in BlacklightController
+  module ClassMethods
+    # Save the submitted search parameters in the search session
+    def record_search_parameters opts = { only: :index}
+      before_filter :current_search_session, opts
+    end
   end
+  
+  protected
 
   # sets up the session[:search] hash if it doesn't already exist
   def search_session
@@ -37,15 +37,15 @@ module Blacklight::Catalog::SearchContext
       rescue ActiveRecord::RecordNotFound
         nil
       end
-    elsif search_session[:id]
+    elsif search_session['id']
       begin
-        searches_from_history.find(search_session[:id])
+        searches_from_history.find(search_session['id'])
       rescue ActiveRecord::RecordNotFound
         nil
       end
     end
 
-    search_session[:id] = @current_search_session.id if @current_search_session
+    search_session['id'] = @current_search_session.id if @current_search_session
 
     @current_search_session
   end
@@ -92,11 +92,11 @@ module Blacklight::Catalog::SearchContext
   # calls setup_previous_document then setup_next_document.
   # used in the show action for single view pagination.
   def setup_next_and_previous_documents
-    if search_session[:counter] and current_search_session
-      index = search_session[:counter].to_i - 1
-      response, documents = get_previous_and_next_documents_for_search index, current_search_session.query_params
+    if search_session['counter'] and current_search_session
+      index = search_session['counter'].to_i - 1
+      response, documents = get_previous_and_next_documents_for_search index, current_search_session.query_params.with_indifferent_access
 
-      search_session[:total] = response.total
+      search_session['total'] = response.total
       @search_context_response = response
       @previous_document = documents.first
       @next_document = documents.last

data/lib/blacklight/catalog.rb

@@ -9,19 +9,20 @@ module Blacklight::Catalog
   # The following code is executed when someone includes blacklight::catalog in their
   # own controller.
   included do
-    helper_method :sms_mappings
+    helper_method :sms_mappings, :has_search_parameters?
 
     # Whenever an action raises SolrHelper::InvalidSolrID, this block gets executed.
     # Hint: the SolrHelper #get_solr_response_for_doc_id method raises this error,
     # which is used in the #show action here.
     rescue_from Blacklight::Exceptions::InvalidSolrID, :with => :invalid_solr_id_error
+
+    record_search_parameters
   end
   
     # get search results from the solr index
     def index
       
       (@response, @document_list) = get_search_results
-      @filters = params[:f] || []
       
       respond_to do |format|
         format.html { }
@@ -56,11 +57,16 @@ module Blacklight::Catalog
     end
 
     # updates the search counter (allows the show view to paginate)
-    def update
-      search_session[:counter] = params[:counter]
-      redirect_to :action => "show", :status => 303
+    def track
+      search_session['counter'] = params[:counter]
+      path = if params[:redirect] and (params[:redirect].starts_with?("/") or params[:redirect] =~ URI::regexp)
+        URI.parse(params[:redirect]).path
+      else
+        { action: 'show' }
+      end
+      redirect_to path, :status => 303
     end
-    
+
     # displays values and pagination links for a single facet field
     def facet
       @facet = blacklight_config.facet_fields[params[:id]]
@@ -149,6 +155,13 @@ module Blacklight::Catalog
         format.html
       end
     end
+
+    ##
+    # Check if any search parameters have been set
+    # @return [Boolean] 
+    def has_search_parameters?
+      !params[:q].blank? or !params[:f].blank? or !params[:search_field].blank?
+    end
     
     protected    
     #

data/lib/blacklight/configuration.rb

@@ -5,6 +5,13 @@ module Blacklight
   class Configuration < OpenStructWithHashAccess
 
     require 'blacklight/configuration/view_config'
+    # XXX this isn't very pretty, but it works.
+    require 'blacklight/configuration/fields'
+    require 'blacklight/configuration/solr_field'
+    require 'blacklight/configuration/search_field'
+    require 'blacklight/configuration/facet_field'
+    require 'blacklight/configuration/sort_field'
+    include Fields
 
     # Set up Blacklight::Configuration.default_values to contain
     # the basic, required Blacklight fields
@@ -14,45 +21,92 @@ module Blacklight
           unique_key = ((SolrDocument.unique_key if defined?(SolrDocument)) || 'id')
 
           {
-          :solr_path => 'select',
+          # HTTP method to use when making requests to solr; valid
+          # values are :get and :post.
+          :http_method => :get,
+          # The solr request handler ('qt') to use for search requests
           :qt => 'search',
+          # The path to send requests to solr.
+          :solr_path => 'select',
+          # Default values of parameters to send with every search request
           :default_solr_params => {},
-          :document_solr_request_handler => nil,
-          :default_document_solr_params => {},
-          :show => ViewConfig::Show.new(:partials => [:show_header, :show]),
-          :index => ViewConfig::Index.new(:partials => [:index_header, :thumbnail, :index],
+          # The solr rqeuest handler to use when requesting only a single document 
+          :document_solr_request_handler => 'document',
+          # THe path to send single document requests to solr
+          :document_solr_path => nil,
+          :document_unique_id_param => :id,
+          # Default values of parameters to send when requesting a single document
+          :default_document_solr_params => {
+            ## Blacklight provides these settings in the /document request handler
+            ## by default, we just ask for all fields. 
+            #:fl => '*',
+            ## this is a fancy way to say "find the document by id using
+            ## the value in the id query parameter"
+            #:q => "{!raw f=#{unique_key} v=$id}",
+            ## disable features we don't need
+            #:facet => false,
+            #:rows => 1
+          },
+          # General configuration for all views
+          :index => ViewConfig::Index.new(
+            # solr field to use to render a document title
             :title_field => unique_key,
+            # solr field to use to render format-specific partials
             :display_type_field => 'format',
+            # partials to render for each document(see #render_document_partials)
+            :partials => [:index_header, :thumbnail, :index],
+            # what field, if any, to use to render grouped results
             :group => false,
+            # additional response formats for search results
             :respond_to => OpenStructWithHashAccess.new()
             ),
+          # Additional configuration when displaying a single document
+          :show => ViewConfig::Show.new(:partials => [:show_header, :show]),
+          # Configurations for specific types of index views
           :view => NestedOpenStructWithHashAccess.new(ViewConfig, 'list'),
+          # Maxiumum number of spelling suggestions to offer
           :spell_max => 5,
+          # Maximum number of results to show per page
           :max_per_page => 100,
+          # Options for the user for number of results to show per page
           :per_page => [10,20,50,100],
+          :default_per_page => nil,
+          # how many searches to save in session history
+          # (TODO: move the value into the configuration?)
           :search_history_window => Blacklight::Catalog::SearchHistoryWindow,
-          :add_facet_fields_to_solr_request => false,
-          :add_field_configuration_to_solr_request => false,
-          :http_method => :get
+          ## deprecated; use add_facet_field :include_in_request instead;
+          # if this is configured true, all facets will be included in the solr request
+          # unless explicitly disabled.
+          :add_facet_fields_to_solr_request => false, 
+          ## deprecated; use add_index_field :include_in_request instead;
+          # if this is configured true, all show and index will be included in the solr request
+          # unless explicitly disabled.
+          :add_field_configuration_to_solr_request => false
           }
         end
       end
     end
 
-
-    # XXX this isn't very pretty, but it works.
-    require 'blacklight/configuration/fields'
-    require 'blacklight/configuration/solr_field'
-    require 'blacklight/configuration/search_field'
-    require 'blacklight/configuration/facet_field'
-    require 'blacklight/configuration/sort_field'
-    include Fields
-
-    # Create collections of solr fields
+    ##
+    # Create collections of solr field configurations.
+    # This will create array-like accessor methods for
+    # the given field, and an #add_x_field convenience 
+    # method for adding new fields to the configuration
+    
+    # facet fields
     define_field_access :facet_field
+    
+    # solr fields to display on search results
     define_field_access :index_field
+    
+    # solr fields to display when showing single documents
     define_field_access :show_field
+    
+    # solr "fields" to use for scoping user search queries
+    # to particular fields
     define_field_access :search_field
+    
+    # solr fields to use for sorting results
     define_field_access :sort_field
 
     def initialize(*args)
@@ -70,6 +124,14 @@ module Blacklight
       end
     end
 
+    ##
+    # DSL helper
+    def configure
+      yield self if block_given?
+      self
+    end
+
+    ##
     # Returns default search field, used for simpler display in history, etc.
     # if not set, defaults to first defined search field
     def default_search_field
@@ -80,6 +142,7 @@ module Blacklight
       field
     end
 
+    ##
     # Returns default sort field, used for simpler display in history, etc.
     # if not set, defaults to first defined sort field
     def default_sort_field
@@ -90,20 +153,56 @@ module Blacklight
       field
     end
 
+    ##
     # Add any configured facet fields to the default solr parameters hash
-    def add_facet_fields_to_solr_request!
-      self.add_facet_fields_to_solr_request = true
+    # @overload add_facet_fields_to_solr_request!
+    #    add all facet fields to the solr request
+    # @overload add_facet_fields_to_solr_request! field, field, field
+    #   @param [Symbol] Field names to add to the solr request
+    #   @param [Symbol] 
+    #   @param [Symbol] 
+    def add_facet_fields_to_solr_request! *fields
+      if fields.empty?
+        self.add_facet_fields_to_solr_request = true
+      else
+        facet_fields.slice(*fields).each do |k,v|
+          v.include_in_request = true
+        end
+      end
     end
 
+    ##
     # Add any configured facet fields to the default solr parameters hash
-    def add_field_configuration_to_solr_request!
-      self.add_field_configuration_to_solr_request = true
+    # @overload add_field_configuration_to_solr_request!
+    #    add all index, show, and facet fields to the solr request
+    # @overload add_field_configuration_to_solr_request! field, field, field
+    #   @param [Symbol] Field names to add to the solr request
+    #   @param [Symbol] 
+    #   @param [Symbol] 
+    def add_field_configuration_to_solr_request! *fields
+      if fields.empty?
+        self.add_field_configuration_to_solr_request = true
+      else
+        index_fields.slice(*fields).each do |k,v|
+          v.include_in_request = true
+        end
+
+        show_fields.slice(*fields).each do |k,v|
+          v.include_in_request = true
+        end
+        facet_fields.slice(*fields).each do |k,v|
+          v.include_in_request = true
+        end
+      end
     end
 
+    ##
+    # Deprecated. Get the list of facet fields to explicitly
+    # add to the solr request
     def facet_fields_to_add_to_solr
-      return facet_fields.reject { |k,v| v[:query] || v[:pivot] }.map { |k,v| v.field } if self.add_facet_fields_to_solr_request
-
-      []
+      facet_fields.select { |k,v| v.include_in_request }
+                  .reject { |k,v| v[:query] || v[:pivot] }
+                  .map { |k,v| v.field }
     end
 
     ##
@@ -116,12 +215,8 @@ module Blacklight
     alias_method :inheritable_copy, :deep_copy
 
     ##
-    # DSL helper
-    def configure
-      yield self if block_given?
-      self
-    end
-
+    # Get a view configuration for the given view type
+    # including default values from the index configuration
     def view_config view_type
       if view_type == :show
         self.index.merge self.show