blacklight 5.9.4 → 5.10.0

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

@@ -1,10 +1,10 @@
 <%# default partial to display solr document fields in catalog index view -%>
 <dl class="document-metadata dl-horizontal dl-invert">
   
-  <% index_fields(document).each do |solr_fname, field| -%>
+  <% index_fields(document).each do |field_name, field| -%>
     <% if should_render_index_field? document, field %>
-	    <dt class="blacklight-<%= solr_fname.parameterize %>"><%= render_index_field_label document, :field => solr_fname %></dt>
-	    <dd class="blacklight-<%= solr_fname.parameterize %>"><%= render_index_field_value document, :field => solr_fname %></dd>
+	    <dt class="blacklight-<%= field_name.parameterize %>"><%= render_index_field_label document, field: field_name %></dt>
+	    <dd class="blacklight-<%= field_name.parameterize %>"><%= render_index_field_value document, field: field_name %></dd>
     <% end -%>
   <% end -%>
 

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

@@ -1,9 +1,9 @@
 <%# default partial to display solr document fields in catalog show view -%>
 <dl class="dl-horizontal  dl-invert">
-  <% document_show_fields(document).each do |solr_fname, field| -%>
+  <% document_show_fields(document).each do |field_name, field| -%>
     <% if should_render_show_field? document, field %>
-	    <dt class="blacklight-<%= solr_fname.parameterize %>"><%= render_document_show_field_label document, :field => solr_fname %></dt>
-	    <dd class="blacklight-<%= solr_fname.parameterize %>"><%= render_document_show_field_value document, :field => solr_fname %></dd>
+	    <dt class="blacklight-<%= field_name.parameterize %>"><%= render_document_show_field_label document, field: field_name %></dt>
+	    <dd class="blacklight-<%= field_name.parameterize %>"><%= render_document_show_field_value document, field: field_name %></dd>
     <% end -%>
   <% end -%>
 </dl>

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

@@ -19,7 +19,7 @@
 
     </div>
     <% @documents.each do |doc| %>
-       <%=hidden_field_tag "id[]", doc.id %>
+       <%=hidden_field_tag "id[]", doc.get(:id)%>
     <% end %>
 </div>
 <div class="modal-footer">

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

@@ -4,7 +4,7 @@
 
 <div class="modal-header">
   <button type="button" class="ajax-modal-close close" data-dismiss="modal" aria-hidden="true">×</button>
-  <h3 class="modal-title"><%= facet_field_label(@facet.field) %></h3>
+  <h3 class="modal-title"><%= facet_field_label(@facet.key) %></h3>
 </div>
 <div class="modal-body">
   <div class="facet_extended_list">

data/blacklight.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.add_dependency "rails",     ">= 3.2.6", "< 5"
   s.add_dependency "nokogiri",  "~>1.6"     # XML Parser
   s.add_dependency "kaminari", "~> 0.13"  # the pagination (page 1,2,3, etc..) of our search results
-  s.add_dependency "rsolr",     "~> 1.0.6"  # Library for interacting with rSolr.
+  s.add_dependency "rsolr",     "~> 1.0.11"  # Library for interacting with rSolr.
   s.add_dependency "bootstrap-sass", "~> 3.2"
   s.add_dependency "deprecation"
 

data/config/jetty.yml

@@ -1,13 +1,10 @@
 development:
   startup_wait: 15
   jetty_port: 8983 
-  java_version: ">= 1.7"
 test:
   startup_wait: 60
   jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8888 %> 
   <%= ENV['TEST_JETTY_PATH'] ? "jetty_home: " + ENV['TEST_JETTY_PATH'] : '' %>
-  java_version: ">= 1.7"
 production:
   startup_wait: 15
   jetty_port: 8983
-  java_version: ">= 1.7"

data/config/locales/blacklight.de.yml

@@ -183,7 +183,9 @@ de:
           count: 'Numerisch ordnen'
           index: 'A-Z Ordnen'
         count: '%{number}'
+        # i18n key 'more' is deprecated and will be removed in Blacklight 6.0
         more: 'mehr »'
+        more_html: 'mehr <span class="sr-only">%{field_name}</span> »'
         selected:
           remove: '[entfernen]'
       group:

data/config/locales/blacklight.en.yml

@@ -183,7 +183,9 @@ en:
           count: 'Numerical Sort'
           index: 'A-Z Sort'
         count: '%{number}'
+        # i18n key 'more' is deprecated and will be removed in Blacklight 6.0 
         more: 'more »'
+        more_html: 'more <span class="sr-only">%{field_name}</span> »'
         selected:
           remove: '[remove]'
       group:

data/config/locales/blacklight.es.yml

@@ -183,7 +183,9 @@ es:
           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]'
       group:

data/config/locales/blacklight.fr.yml

@@ -199,7 +199,9 @@ fr:
           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 ]'
       group:

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

@@ -203,7 +203,9 @@ pt-BR:
           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]'
       filters:

data/lib/blacklight.rb

@@ -1,21 +1,21 @@
 # -*- encoding : utf-8 -*-
 require 'kaminari'
-require 'rsolr'
 require 'deprecation'
-require 'blacklight/utils'
-
 module Blacklight
-
   autoload :Configurable, 'blacklight/configurable'
   autoload :Configuration, 'blacklight/configuration'
   autoload :SearchFields, 'blacklight/search_fields'
-
-  autoload :Solr, 'blacklight/solr'
-  
-  autoload :SolrHelper, 'blacklight/solr_helper'
-  autoload :SolrRepository, 'blacklight/solr_repository'
-  autoload :RequestBuilders, 'blacklight/request_builders'
+  autoload :SearchBuilder, 'blacklight/search_builder'
   
+  autoload :Document, 'blacklight/document'
+  autoload :Solr, 'blacklight/solr'
+
+  autoload :SearchHelper,       'blacklight/search_helper'
+  autoload :SolrHelper,         'blacklight/solr_helper'
+  autoload :AbstractRepository, 'blacklight/abstract_repository'
+  autoload :SolrRepository,     'blacklight/solr_repository'
+  autoload :RequestBuilders,    'blacklight/request_builders'
+
   autoload :Exceptions, 'blacklight/exceptions'
 
   autoload :User, 'blacklight/user'
@@ -23,17 +23,19 @@ module Blacklight
   autoload :Controller,        'blacklight/controller'
   autoload :Base,              'blacklight/base'
   autoload :Catalog,           'blacklight/catalog'
-  autoload :TokenBasedUser,     'blacklight/token_based_user'
+  autoload :TokenBasedUser,    'blacklight/token_based_user'
   autoload :Bookmarks,         'blacklight/bookmarks'
   autoload :DocumentPresenter, 'blacklight/document_presenter'
 
   autoload :Routes, 'blacklight/routes'
-  
+
+  autoload :OpenStructWithHashAccess, 'blacklight/utils'
   autoload :SolrResponse, 'blacklight/solr_response'
   autoload :Facet, 'blacklight/facet'
 
   extend SearchFields
-  
+  extend Deprecation
+
   require 'blacklight/version'
   require 'blacklight/engine' if defined?(Rails)
   
@@ -45,26 +47,74 @@ module Blacklight
   # other services (e.g. refworks callback urls)
   mattr_accessor :secret_key
   @@secret_key = nil
-  
+
+  # @deprecated
   def self.solr_file
     "#{::Rails.root.to_s}/config/solr.yml"
   end
-  
+
+  def self.blacklight_config_file
+    "#{::Rails.root.to_s}/config/blacklight.yml"
+  end
+
   def self.add_routes(router, options = {})
     Blacklight::Routes.new(router, options).draw
   end
 
   def self.solr
-    @solr ||=  RSolr.connect(Blacklight.solr_config)
+    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
+
+  def self.default_index
+    @default_index ||=  Blacklight::SolrRepository.new(Blacklight::Configuration.new)
   end
 
   def self.solr_config
-    @solr_config ||= begin
-        raise "The #{::Rails.env} environment settings were not found in the solr.yml config" unless solr_yml[::Rails.env]
-        solr_yml[::Rails.env].symbolize_keys
+    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
+
+  def self.connection_config
+    @connection_config ||= begin
+        raise "The #{::Rails.env} environment settings were not found in the blacklight.yml config" unless blacklight_yml[::Rails.env]
+        blacklight_yml[::Rails.env].symbolize_keys
       end
   end
 
+  def self.blacklight_yml
+    require 'erb'
+    require 'yaml'
+
+    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
+    end
+
+    begin
+      blacklight_erb = ERB.new(IO.read(blacklight_config_file)).result(binding)
+    rescue Exception => e
+      raise("#{blacklight_config_file} was found, but could not be parsed with ERB. \n#{$!.inspect}")
+    end
+
+    begin
+      @blacklight_yml = YAML::load(blacklight_erb)
+    rescue StandardError => e
+      raise("#{blacklight_config_file} was found, but could not be parsed.\n")
+    end
+
+    if @blacklight_yml.nil? || !@blacklight_yml.is_a?(Hash)
+      raise("#{blacklight_config_file} was found, but was blank or malformed.\n")
+    end
+
+    return @blacklight_yml
+  end
+
   def self.solr_yml
     require 'erb'
     require 'yaml'
@@ -94,13 +144,7 @@ module Blacklight
   end
 
   def self.logger
-    @logger ||= begin
-      ::Rails.logger if defined? Rails and Rails.respond_to? :logger
-    end
-  end
-
-  def self.logger= logger
-    @logger = logger
+    ::Rails.logger
   end
 
   #############  

data/lib/blacklight/abstract_repository.rb

@@ -0,0 +1,29 @@
+module Blacklight
+  class AbstractRepository
+    attr_accessor :blacklight_config
+    attr_writer :connection
+
+    # ActiveSupport::Benchmarkable requires a logger method
+    attr_accessor :logger
+
+    include ActiveSupport::Benchmarkable
+
+    def initialize blacklight_config
+      @blacklight_config = blacklight_config
+    end
+
+    def connection
+      @connection ||= build_connection
+    end
+
+
+    protected
+      def connection_config
+        @connection_config ||= Blacklight.connection_config
+      end
+
+      def logger
+        @logger ||= Rails.logger if defined? Rails
+      end
+  end
+end

data/lib/blacklight/base.rb

@@ -1,23 +1,23 @@
 # -*- encoding : utf-8 -*-
-module Blacklight::Base   
+module Blacklight::Base
   extend ActiveSupport::Concern
 
   include Blacklight::Configurable
-  include Blacklight::SolrHelper
+  include Blacklight::SearchHelper
 
   include Blacklight::Catalog::SearchContext
 
-  included do  
-    # When RSolr::RequestError is raised, the rsolr_request_error method is executed.
+  included do
+    # When Blacklight::Exceptions::InvalidRequest is raised, the rsolr_request_error method is executed.
     # The index action will more than likely throw this one.
     # Example, when the standard query parser is used, and a user submits a "bad" query.
-    rescue_from RSolr::Error::Http, :with => :rsolr_request_error if respond_to? :rescue_from
+    rescue_from Blacklight::Exceptions::InvalidRequest, with: :handle_request_error if respond_to? :rescue_from
   end
 
   protected
 
-  # when solr (RSolr) throws an error (RSolr::RequestError), this method is executed.
-  def rsolr_request_error(exception)
+  # when The index throws an error (Blacklight::Exceptions::InvalidRequest), this method is executed.
+  def handle_request_error(exception)
 
     if Rails.env.development? || Rails.env.test?
       raise exception # Rails own code will catch and give usual Rails error page with stack trace

data/lib/blacklight/bookmarks.rb

@@ -8,7 +8,7 @@ module Blacklight::Bookmarks
     ##
     # Give Bookmarks access to the CatalogController configuration
     include Blacklight::Configurable
-    include Blacklight::SolrHelper
+    include Blacklight::SearchHelper
     include Blacklight::TokenBasedUser
 
     copy_blacklight_config_from(CatalogController)
@@ -22,7 +22,7 @@ module Blacklight::Bookmarks
   def action_documents
     bookmarks = token_or_current_or_guest_user.bookmarks
     bookmark_ids = bookmarks.collect { |b| b.document_id.to_s }
-    get_solr_response_for_document_ids(bookmark_ids)
+    fetch(bookmark_ids)
   end
 
   def action_success_redirect_path
@@ -39,7 +39,7 @@ module Blacklight::Bookmarks
     @bookmarks = token_or_current_or_guest_user.bookmarks
     bookmark_ids = @bookmarks.collect { |b| b.document_id.to_s }
 
-    @response, @document_list = get_solr_response_for_document_ids(bookmark_ids)
+    @response, @document_list = fetch(bookmark_ids)
 
     respond_to do |format|
       format.html { }
@@ -71,7 +71,7 @@ module Blacklight::Bookmarks
     if params[:bookmarks]
       @bookmarks = params[:bookmarks]
     else
-      @bookmarks = [{ document_id: params[:id], document_type: blacklight_config.solr_document_model.to_s }]
+      @bookmarks = [{ document_id: params[:id], document_type: blacklight_config.document_model.to_s }]
     end
 
     current_or_guest_user.save! unless current_or_guest_user.persisted?
@@ -96,7 +96,7 @@ module Blacklight::Bookmarks
   # Beware, :id is the Solr document_id, not the actual Bookmark id.
   # idempotent, as DELETE is supposed to be.
   def destroy
-    bookmark = current_or_guest_user.bookmarks.where(document_id: params[:id], document_type: blacklight_config.solr_document_model).first
+    bookmark = current_or_guest_user.bookmarks.where(document_id: params[:id], document_type: blacklight_config.document_model).first
 
     success = bookmark && bookmark.delete && bookmark.destroyed?
 

data/lib/blacklight/catalog.rb

@@ -2,6 +2,7 @@
 module Blacklight::Catalog
   extend ActiveSupport::Concern
   extend ActiveSupport::Autoload
+  extend Deprecation
 
   eager_autoload do
     autoload :ComponentConfiguration
@@ -20,17 +21,19 @@ module Blacklight::Catalog
   included do
     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
+    # When an action raises Blacklight::Exceptions::RecordNotFound, handle 
+    # the exception appropriately.
+    rescue_from Blacklight::Exceptions::RecordNotFound, with: :invalid_document_id_error
+
+    # Deprecated:
+    rescue_from Blacklight::Exceptions::InvalidSolrID, with: :invalid_document_id_error
 
     record_search_parameters
   end
 
     # get search results from the solr index
     def index
-      (@response, @document_list) = get_search_results
+      (@response, @document_list) = search_results(params, search_params_logic)
 
       respond_to do |format|
         format.html { store_preferred_view }
@@ -48,21 +51,13 @@ module Blacklight::Catalog
     # get a single document from the index
     # to add responses for formats other than html or json see _Blacklight::Document::Export_
     def show
-      @response, @document = get_solr_response_for_doc_id params[:id]
+      @response, @document = fetch params[:id]
 
       respond_to do |format|
-        format.html {setup_next_and_previous_documents}
-
-        format.json { render json: {response: {document: @document}}}
-
-        # Add all dynamically added (such as by document extensions)
-        # export formats.
-        @document.export_formats.each_key do | format_name |
-          # It's important that the argument to send be a symbol;
-          # if it's a string, it makes Rails unhappy for unclear reasons.
-          format.send(format_name.to_sym) { render :text => @document.export_as(format_name), :layout => false }
-        end
+        format.html { setup_next_and_previous_documents }
+        format.json { render json: { response: { document: @document } } }
 
+        additional_export_formats(@document, format)
       end
     end
 
@@ -82,7 +77,7 @@ module Blacklight::Catalog
     # displays values and pagination links for a single facet field
     def facet
       @facet = blacklight_config.facet_fields[params[:id]]
-      @response = get_facet_field_response(@facet.field, params)
+      @response = get_facet_field_response(@facet.key, params)
       @display_facet = @response.facets.first
 
       @pagination = facet_paginator(@facet, @display_facet)
@@ -111,7 +106,7 @@ module Blacklight::Catalog
     end
 
     def action_documents
-      get_solr_response_for_document_ids(params[:id])
+      fetch(Array(params[:id]))
     end
 
     def action_success_redirect_path
@@ -171,6 +166,15 @@ module Blacklight::Catalog
       end
     end
 
+    ##
+    # Render additional export formats for the show action, as provided by
+    # the document extension framework. See _Blacklight::Document::Export_
+    def additional_export_formats(document, format)
+      document.export_formats.each_key do | format_name |
+        format.send(format_name.to_sym) { render text: document.export_as(format_name), layout: false }
+      end
+    end
+
     ##
     # Try to render a response from the document export formats available
     def document_export_formats format
@@ -295,10 +299,20 @@ module Blacklight::Catalog
       flash[:error].blank?
     end
 
+    ##
     # when a request for /catalog/BAD_SOLR_ID is made, this method is executed.
     # Just returns a 404 response, but you can override locally in your own
     # CatalogController to do something else -- older BL displayed a Catalog#inde
     # page with a flash message and a 404 status.
+    def invalid_document_id_error *args
+      Deprecation.silence(Blacklight::Catalog) do
+        invalid_solr_id_error *args
+      end
+    end
+
+    ##
+    # DEPRECATED; this method will be removed in Blacklight 6.0 and the functionality
+    # moved to invalid_document_id_error
     def invalid_solr_id_error(exception)
       error_info = {
         "status" => "404",
@@ -321,6 +335,7 @@ module Blacklight::Catalog
         end
       end
     end
+    deprecation_deprecate invalid_solr_id_error: :invalid_document_id_error
 
     def start_new_search_session?
       action_name == "index"