blacklight 5.19.2 → 6.0.0.pre1

data/config/locales/blacklight.es.yml

@@ -166,8 +166,6 @@ es:
           label: 'Buscar en'
           title: 'Opciones de Búsqueda temática'
           post_label: 'para'
-        # i18n key 'q' is deprecated and will be removed in Blacklight 6.0, use 'search.label' and 'search.placeholder'
-        q: 'Buscar...'
         search:
           label: 'buscar'
           placeholder: 'Buscar...'
@@ -187,12 +185,11 @@ es:
         counter: '%{counter}.'
       facets:
         title: 'Limite su búsqueda'
+        clear: 'Borrar'
         sort:
           count: 'Ordenación numérica'
           index: 'Ordenación A-Z'
         count: '%{number}'
-        # i18n key 'more' is deprecated and will be removed in Blacklight 6.0
-        more: 'más »'
         more_html: 'más <span class="sr-only">%{field_name}</span> »'
         selected:
           remove: '[borrar]'

data/config/locales/blacklight.fr.yml

@@ -169,8 +169,6 @@ fr:
           label: 'dans'
           title: 'Options de recherche'
         post_label: 'pour'
-        # i18n key 'q' is deprecated and will be removed in Blacklight 6.0, use 'search.label' and 'search.placeholder'
-        q: 'Rechercher '
         search:
           label: 'Rechercher'
           placeholder: 'Rechercher'
@@ -193,12 +191,11 @@ fr:
         unselect: 'Panier'
       facets:
         title: 'Limiter votre recherche'
+        clear: 'Effacer'
         sort:
           count: 'Du + au - fréquent'
           index: 'Tri de A à Z'
         count: '%{number}'
-        # i18n key 'more' is deprecated and will be removed in Blacklight 6.0
-        more: 'plus »'
         more_html: 'plus <span class="sr-only">%{field_name}</span> »'
         selected:
           remove: '[ X ]'

data/config/locales/blacklight.it.yml

@@ -166,8 +166,6 @@ it:
           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...'
@@ -187,12 +185,11 @@ it:
         counter: '%{counter}. '
       facets:
         title: 'Affina la ricerca'
+        clear: 'Cancella'
         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]'

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

@@ -164,8 +164,6 @@ pt-BR:
           label: 'Procurar em'
           title: 'Opções da Busca'
           post_label: 'por'
-        # i18n key 'q' is deprecated and will be removed in Blacklight 6.0, use 'search.label' and 'search.placeholder'
-        q: 'Busca...'
         search:
           label: 'busca'
           placeholder: 'Busca...'
@@ -185,12 +183,11 @@ pt-BR:
         counter: '%{counter}. '
       facets:
         title: 'Filtre sua busca'
+        clear: 'Limpar'  
         sort:
           count: 'Ordenar por Número'
           index: 'Ordem Alfabética A-Z'
         count: '%{number}'
-        # i18n key 'more' is deprecated and will be removed in Blacklight 6.0
-        more: 'mais »'
         more_html: 'mais <span class="sr-only">%{field_name}</span> »'
         selected:
           remove: '[remover]'

data/config/routes.rb

@@ -0,0 +1,9 @@
+Blacklight::Engine.routes.draw do
+  get "search_history",             :to => "search_history#index",   :as => "search_history"
+  delete "search_history/clear",       :to => "search_history#clear",   :as => "clear_search_history"
+  delete "saved_searches/clear",       :to => "saved_searches#clear",   :as => "clear_saved_searches"
+  get "saved_searches",       :to => "saved_searches#index",   :as => "saved_searches"
+  put "saved_searches/save/:id",    :to => "saved_searches#save",    :as => "save_search"
+  delete "saved_searches/forget/:id",  :to => "saved_searches#forget",  :as => "forget_search"
+  post "saved_searches/forget/:id",  :to => "saved_searches#forget"
+end

data/db/migrate/20140202020201_create_searches.rb

@@ -6,7 +6,7 @@ class CreateSearches < ActiveRecord::Migration
       t.integer :user_id
       t.string :user_type
 
-      t.timestamps null: false
+      t.timestamps
     end
 
     add_index :searches, :user_id

data/db/migrate/20140202020202_create_bookmarks.rb

@@ -6,7 +6,7 @@ class CreateBookmarks < ActiveRecord::Migration
       t.string :user_type
       t.string :document_id
       t.string :title
-      t.timestamps null: false
+      t.timestamps
     end
   end
 

data/lib/blacklight.rb

@@ -5,74 +5,34 @@ require 'blacklight/utils'
 
 module Blacklight
   autoload :Exceptions, 'blacklight/exceptions'
+  autoload :Path,       'blacklight/path'
+  autoload :Parameters, 'blacklight/parameters'
   autoload :Routes, 'blacklight/routes'
-  autoload :Solr, 'blacklight/solr'
-
-  autoload :SolrHelper, 'blacklight/solr_helper'
-
-  autoload :AbstractRepository, 'blacklight/abstract_repository'
-  autoload :Configuration, 'blacklight/configuration'
-  autoload :SearchBuilder, 'blacklight/search_builder'
 
   extend Deprecation
 
   require 'blacklight/version'
   require 'blacklight/engine' if defined?(Rails)
-
+  
   class << self
     attr_accessor :solr, :solr_config
   end
 
-  class SolrRepository < Solr::Repository
-    extend Deprecation
-    def initialize blacklight_config
-      Deprecation.warn(self, 'Blacklight::SolrRepository is deprecated; use Blacklight::Solr::Repository instead')
-      super
-    end 
-  end
-
-  class SolrResponse < Solr::Response
-    extend Deprecation
-    def initialize(data, request_params, options = {})
-      Deprecation.warn(self, 'Blacklight::SolrResponse is deprecated; use Blacklight::Solr::Response instead')
-      super
-    end 
-  end
-
   # Secret key used to share session information with
   # other services (e.g. refworks callback urls)
   mattr_accessor :secret_key
   @@secret_key = nil
 
-  # @deprecated
-  def self.solr_file
-    "#{::Rails.root}/config/solr.yml"
-  end
-
   def self.blacklight_config_file
     "#{::Rails.root}/config/blacklight.yml"
   end
 
-  def self.add_routes(router, options = {})
-    Blacklight::Routes.new(router, options).draw
-  end
-
-  def self.solr
-    Deprecation.warn Blacklight, "Blacklight.solr is deprecated and will be removed in 6.0.0. Use Blacklight.default_index.connection instead", caller
-    default_index.connection
-  end
-
   ##
   # The default index connection for the search index
   def self.default_index
     @default_index ||= repository_class.new(default_configuration)
   end
 
-  def self.solr_config
-    Deprecation.warn Blacklight, "Blacklight.solr_config is deprecated and will be removed in 6.0.0. Use Blacklight.connection_config instead", caller
-    connection_config
-  end
-
   ##
   # The configured repository class. By convention, this is
   # the class Blacklight::{name of the adapter}::Repository, e.g.
@@ -83,12 +43,8 @@ module Blacklight
       Blacklight::Solr::Repository
     when /::/
       connection_config[:adapter].constantize
-    when nil, ''
-      Rails.logger.warn "The value for :adapter was not found in the blacklight.yml config, and will be required in Blacklight 6.0.0"
-
-      Blacklight::Solr::Repository
     else
-      "Blacklight/#{connection_config.fetch(:adapter)}/Repository".classify.constantize
+      Blacklight.const_get("#{connection_config[:adapter]}/Repository".classify)
     end
   end
 
@@ -111,12 +67,7 @@ module Blacklight
 
     return @blacklight_yml if @blacklight_yml
     unless File.exists?(blacklight_config_file)
-      if File.exists?(solr_file)
-        Deprecation.warn Blacklight, "Configuration is now done via blacklight.yml. Suppport for solr.yml will be removed in blacklight 6.0.0"
-        return solr_yml
-      else
-        raise "You are missing a configuration file: #{blacklight_config_file}. Have you run \"rails generate blacklight:install\"?"
-      end
+      raise "You are missing a configuration file: #{blacklight_config_file}. Have you run \"rails generate blacklight:install\"?"
     end
 
     begin
@@ -138,34 +89,6 @@ module Blacklight
     return @blacklight_yml
   end
 
-  def self.solr_yml
-    require 'erb'
-    require 'yaml'
-
-    return @solr_yml if @solr_yml
-    unless File.exists?(solr_file)
-      raise "You are missing a solr configuration file: #{solr_file}. Have you run \"rails generate blacklight:install\"?"  
-    end
-
-    begin
-      @solr_erb = ERB.new(IO.read(solr_file)).result(binding)
-    rescue StandardError, SyntaxError => e
-      raise("solr.yml was found, but could not be parsed with ERB. \n#{e.inspect}")
-    end
-
-    begin
-      @solr_yml = YAML::load(@solr_erb)
-    rescue => e
-      raise("solr.yml was found, but could not be parsed.\n#{e.inspect}")
-    end
-
-    if @solr_yml.nil? || !@solr_yml.is_a?(Hash)
-      raise("solr.yml was found, but was blank or malformed.\n")
-    end
-
-    return @solr_yml
-  end
-
   def self.logger
     @logger ||= begin
       ::Rails.logger if defined? Rails and Rails.respond_to? :logger

data/lib/blacklight/engine.rb

@@ -3,7 +3,6 @@ module Blacklight
     engine_name "blacklight"
 
     require 'bootstrap-sass'
-    require 'blacklight/rails/routes'
 
     # BlacklightHelper is needed by all helpers, so we inject it
     # into action view base here. 
@@ -34,10 +33,6 @@ module Blacklight
       end
     end
 
-    initializer "blacklight.assets.precompile" do |app|
-      app.config.assets.precompile += %w(favicon.ico)
-    end
-
     Blacklight::Engine.config.sms_mappings = {
       'Virgin' => 'vmobl.com',
       'AT&T' => 'txt.att.net',

data/lib/blacklight/parameters.rb

@@ -0,0 +1,13 @@
+module Blacklight
+  module Parameters
+    ##
+    # Sanitize the search parameters by removing unnecessary parameters
+    # from the provided parameters
+    # @param [Hash] source_params parameters
+    def self.sanitize params
+      params
+        .reject { |k,v| v.nil? }
+        .except(:action, :controller, :id, :commit, :utf8)
+    end
+  end
+end

data/lib/blacklight/path.rb

@@ -0,0 +1,143 @@
+module Blacklight
+  # This class encapsulates the search state as represented by the query
+  # parameters namely: :f, :q, :page, :per_page and, :sort
+  class Path
+    include Blacklight::Facet
+    attr_reader :blacklight_config # Must be called blacklight_config, because Blacklight::Facet calls blacklight_config.
+    attr_reader :params
+
+    def initialize(params, blacklight_config)
+      @params = params
+      @blacklight_config = blacklight_config
+    end
+
+    def url_for_document(doc, options = {})
+      if respond_to?(:blacklight_config) and
+          blacklight_config.show.route and
+          (!doc.respond_to?(:to_model) or doc.to_model.is_a? SolrDocument)
+        route = blacklight_config.show.route.merge(action: :show, id: doc).merge(options)
+        route[:controller] = params[:controller] if route[:controller] == :current
+        route
+      else
+        doc
+      end
+    end
+
+    # adds the value and/or field to params[:f]
+    # Does NOT remove request keys and otherwise ensure that the hash
+    # is suitable for a redirect. See
+    # add_facet_params_and_redirect
+    def add_facet_params(field, item, source_params=params)
+
+      if item.respond_to? :field
+        field = item.field
+      end
+
+      facet_config = facet_configuration_for_field(field)
+
+      url_field = facet_config.key
+
+      value = facet_value_for_facet_item(item)
+
+      p = reset_search_params(source_params)
+      p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
+      p[:f][url_field] = (p[:f][url_field] || []).dup
+
+      if facet_config.single and not p[:f][url_field].empty?
+        p[:f][url_field] = []
+      end
+
+      p[:f][url_field].push(value)
+
+      if item and item.respond_to?(:fq) and item.fq
+        Array(item.fq).each do |f,v|
+          p = add_facet_params(f, v, p)
+        end
+      end
+
+      p
+    end
+
+    # Used in catalog/facet action, facets.rb view, for a click
+    # on a facet value. Add on the facet params to existing
+    # search constraints. Remove any paginator-specific request
+    # params, or other request params that should be removed
+    # for a 'fresh' display.
+    # Change the action to 'index' to send them back to
+    # catalog/index with their new facet choice.
+    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
+
+      new_params
+    end
+
+    # copies the current params (or whatever is passed in as the 3rd arg)
+    # removes the field value from params[:f]
+    # removes the field if there are no more values in params[:f][field]
+    # removes additional params (page, id, etc..)
+    def remove_facet_params(field, item)
+      if item.respond_to? :field
+        field = item.field
+      end
+
+      facet_config = facet_configuration_for_field(field)
+
+      url_field = facet_config.key
+
+      value = facet_value_for_facet_item(item)
+
+      p = reset_search_params(params)
+      # need to dup the facet values too,
+      # if the values aren't dup'd, then the values
+      # from the session will get remove in the show view...
+      p[:f] = (p[:f] || {}).dup
+      p[:f][url_field] = (p[:f][url_field] || []).dup
+      p[:f][url_field] = p[:f][url_field] - [value]
+      p[:f].delete(url_field) if p[:f][url_field].size == 0
+      p.delete(:f) if p[:f].empty?
+      p
+    end
+
+    # Merge the source params with the params_to_merge hash
+    # @param [Hash] params_to_merge to merge into above
+    # @return the current search parameters after being sanitized by Blacklight::Parameters.sanitize
+    # @yield [params] The merged parameters hash before being sanitized
+    def params_for_search(params_to_merge={}, &block)
+      # params hash we'll return
+      my_params = params.dup.merge(params_to_merge.dup)
+
+      if block_given?
+        yield my_params
+      end
+
+      if my_params[:page] and (my_params[:per_page] != params[:per_page] or my_params[:sort] != params[:sort] )
+        my_params[:page] = 1
+      end
+
+      Parameters.sanitize(my_params)
+    end
+
+    private
+
+      ##
+      # Reset any search parameters that store search context
+      # and need to be reset when e.g. constraints change
+      def reset_search_params source_params
+        Parameters.sanitize(source_params).except(:page, :counter).with_indifferent_access
+      end
+
+      # TODO: this code is duplicated in Blacklight::FacetsHelperBehavior
+      def facet_value_for_facet_item item
+        if item.respond_to? :value
+          item.value
+        else
+          item
+        end
+      end
+  end
+end

data/lib/blacklight/routes.rb

@@ -1,138 +1,7 @@
 # -*- encoding : utf-8 -*-
-require 'deprecation'
 module Blacklight
-  class Routes
-    extend Deprecation
-
-    attr_reader :resources 
-
-    # adds as class and instance level accessors, default_route_sets
-    # returns an array of symbols for method names that define routes. 
-    # Order is important:.  (e.g. /catalog/email precedes /catalog/:id)
-    #
-    # Add-ons that want to add routes into default routing might
-    # monkey-patch Blacklight::Routes, say:
-    #
-    #     module MyWidget::Routes
-    #       extend ActiveSupport::Concern
-    #       included do |klass|
-    #         klass.default_route_sets += [:widget_routing]
-    #       end
-    #       def widget_routing(primary_resource)
-    #         add_routes do |options|
-    #           get "#{primary_resource}/widget", "#{primary_resource}#widget"
-    #         end
-    #       end
-    #     end
-    #     Blacklight::Routes.send(:include, MyWidget::Routes)
-    class_attribute :default_route_sets
-    self.default_route_sets = [:bookmarks, :search_history, :saved_searches, :export, :solr_document]
-
-    def initialize(router, options)
-      @router = router
-      @options = options
-      @resources = options.fetch(:resources, [:catalog])
-    end
-
-    def draw
-      route_sets.each do |r|
-        self.send(r, primary_resource)
-      end
-      resources.each do |r|
-        self.map_resource(r)
-      end
-    end
-
-    protected
-
-    def primary_resource
-      resources.first
-    end
-
-    def add_routes &blk
-      @router.instance_exec(@options, &blk)
-    end
-
-    def route_sets
-      (@options[:only] || default_route_sets) - (@options[:except] || [])
-    end
-
-
-
-    module RouteSets
-      def bookmarks(_)
-        add_routes do |options|
-          delete "bookmarks/clear", :to => "bookmarks#clear", :as => "clear_bookmarks"
-          get "bookmarks/email", :as => "email_bookmarks"
-          post "bookmarks/email"
-          get "bookmarks/sms", :as => "sms_bookmarks"
-          post "bookmarks/sms"
-          get "bookmarks/citation", :as => "citation_bookmarks"
-
-          args = {}
-          args[:constraints] = options[:constraints] if options[:constraints]
-          resources :bookmarks, args
-        end
-      end
-  
-      def search_history(_)
-        add_routes do |options|
-          get "search_history",             :to => "search_history#index",   :as => "search_history"
-          delete "search_history/clear",       :to => "search_history#clear",   :as => "clear_search_history"          
-        end
-      end
-  
-  
-      def saved_searches(_)
-        add_routes do |options|
-          delete "saved_searches/clear",       :to => "saved_searches#clear",   :as => "clear_saved_searches"
-          get "saved_searches",       :to => "saved_searches#index",   :as => "saved_searches"
-          put "saved_searches/save/:id",    :to => "saved_searches#save",    :as => "save_search"
-          delete "saved_searches/forget/:id",  :to => "saved_searches#forget",  :as => "forget_search"
-          post "saved_searches/forget/:id",  :to => "saved_searches#forget"
-        end
-      end
-    
-      def catalog(_=nil)
-        map_resource(:catalog)
-      end
-      deprecation_deprecate catalog: "use Blacklight::Routes.map_resource(:catalog) instead"
-
-      def map_resource(key)
-        add_routes do |options|
-          get "#{key}/facet/:id", :to => "#{key}#facet", :as => "#{key}_facet"
-          get "#{key}", :to => "#{key}#index", :as => "#{key}_index"
-        end
-      end
-
-      def export(primary_resource)
-        add_routes do |options|
-          get "#{primary_resource}/opensearch", :as => "opensearch_#{primary_resource}"
-          get "#{primary_resource}/citation", :as => "citation_#{primary_resource}"
-          get "#{primary_resource}/email", :as => "email_#{primary_resource}"
-          post "#{primary_resource}/email"
-          get "#{primary_resource}/sms", :as => "sms_#{primary_resource}"
-          post "#{primary_resource}/sms"
-        end
-      end
-
-      def solr_document(primary_resource)
-        add_routes do |options|
-
-          args = {only: [:show]}
-          args[:constraints] = options[:constraints] if options[:constraints]
-
-          resources :solr_document, args.merge(path: primary_resource, controller: primary_resource) do
-            member do
-              post "track"
-            end
-          end
-
-          # :show and :update are for backwards-compatibility with catalog_url named routes
-          resources primary_resource, args
-        end
-      end
-    end
-    include RouteSets
+  module Routes
+    require 'blacklight/routes/exportable'
+    require 'blacklight/routes/searchable'
   end
 end