blacklight 5.15.0 → 5.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 081be929f259b05c3eb58415ad673efb09ed8b14
-  data.tar.gz: 4f26d85908c059106c6699e8a9395933fd95cbd6
+  metadata.gz: 7f04052db0293c8e93daad2cd0292fb6f6dd221d
+  data.tar.gz: 915bc9c1fc3a1685ac79c0ee68ff19d5a8ab5a62
 SHA512:
-  metadata.gz: b3ba6fdedc8dfbe085e6040c5087229e17d98d7564d9ee51eee33b422c82bf73fb369081c53dee10474b8b4823720617c7df10bede4e96b520f32e5cb77f49d6
-  data.tar.gz: 7e6d6cecb7f0432cf007139469a3e0a5b2217285d5d3b9604ef51cecd01f682d8e12aeb7a2dd160cc2d9c04893115a8b55f92a0519aac3b337de36fed61ffc34
+  metadata.gz: 79f8af63d92a6fcc81a8f2381477d7e09ea30e42ed3dd1f1bd34b8fe4d9e1c4baae9831d1169233f4bf4cce41ffd01b5dc5c272f8943f4da63c941bd1e3d0cfb
+  data.tar.gz: a0388a293e6791114f1310ec5a83d219746bfd151bc29fc024afa7933ef0c7755ed4d8179c60421c80eab4a43eaf38a0b4489356659d2050b9171d527c28fc4a

data/.gitignore

@@ -12,4 +12,4 @@ solr_marc/solrmarc.log
 lib/solrmarc.log.*
 tmp/*
 pkg/*
-spec/internal
+.internal_test_app

data/Gemfile

@@ -3,9 +3,7 @@ source 'https://rubygems.org'
 # Please see blacklight.gemspec for dependency information.
 gemspec path: File.expand_path('..', __FILE__)
 
-# Peg simplecov to < 0.8 until this is resolved:
-# https://github.com/colszowka/simplecov/issues/281
-gem 'simplecov', '~> 0.7.1', require: false
+gem 'simplecov', '~> 0.10', require: false
 gem 'coveralls', require: false
 
 group :test do
@@ -13,14 +11,24 @@ group :test do
   gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 end
 
-file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
-if File.exists?(file)
-  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
-  instance_eval File.read(file)
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 0.8.0
+# engine_cart stanza: 0.8.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path(".internal_test_app", File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
 else
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
   gem 'rails', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
 
-  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] > "4.2"
+  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^4.2/
     gem 'responders', "~> 2.0"
     gem 'sass-rails', ">= 5.0"
   else
@@ -28,3 +36,4 @@ else
     gem 'sass-rails', "< 5.0"
   end
 end
+# END ENGINE_CART BLOCK

data/VERSION

@@ -1 +1 @@
-5.15.0
+5.16.0

data/{lib → app/controllers/concerns}/blacklight/base.rb

@@ -5,7 +5,7 @@ module Blacklight::Base
   include Blacklight::Configurable
   include Blacklight::SearchHelper
 
-  include Blacklight::Catalog::SearchContext
+  include Blacklight::SearchContext
 
   included do
     # When Blacklight::Exceptions::InvalidRequest is raised, the rsolr_request_error method is executed.

data/{lib → app/controllers/concerns}/blacklight/catalog.rb

@@ -1,17 +1,13 @@
 # -*- encoding : utf-8 -*-
 module Blacklight::Catalog
   extend ActiveSupport::Concern
-  extend ActiveSupport::Autoload
   extend Deprecation
 
-  eager_autoload do
-    autoload :ComponentConfiguration
-    autoload :DocumentActions
-    autoload :SearchContext
-  end
+  SearchContext = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('Blacklight::Catalog::SearchContext', 'Blacklight::SearchContext')
+  ComponentConfiguration = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('Blacklight::Catalog::ComponentConfiguration', 'Blacklight::DefaultComponentConfiguration')
 
   include Blacklight::Base
-  include Blacklight::Catalog::ComponentConfiguration
+  include Blacklight::DefaultComponentConfiguration
   include Blacklight::Facet
 
   # rubocop:disable Style/ConstantName
@@ -24,6 +20,8 @@ module Blacklight::Catalog
   included do
     helper_method :sms_mappings, :has_search_parameters?
 
+    helper Blacklight::Facet
+
     # When an action raises Blacklight::Exceptions::RecordNotFound, handle 
     # the exception appropriately.
     rescue_from Blacklight::Exceptions::RecordNotFound, with: :invalid_document_id_error
@@ -67,6 +65,7 @@ module Blacklight::Catalog
     # updates the search counter (allows the show view to paginate)
     def track
       search_session['counter'] = params[:counter]
+      search_session['id'] = params[:search_id]
       search_session['per_page'] = params[:per_page]
 
       path = if params[:redirect] and (params[:redirect].starts_with?("/") or params[:redirect] =~ URI::regexp)

data/{lib → app/controllers/concerns}/blacklight/controller.rb

@@ -5,9 +5,14 @@
 module Blacklight::Controller 
 
   extend ActiveSupport::Concern
+  extend Deprecation
+
+  self.deprecation_horizon = 'blacklight 6.0'
   
   included do
     include Blacklight::SearchFields
+    helper Blacklight::SearchFields
+
     include ActiveSupport::Callbacks
 
     # now in application.rb file under config.filter_parameters
@@ -75,6 +80,7 @@ module Blacklight::Controller
     def request_is_for_user_resource?
       request.env['PATH_INFO'] =~ /\/?users\/?/
     end
+    deprecation_deprecate :request_is_for_user_resource?
 
 
 

data/{lib/blacklight/catalog/component_configuration.rb → app/controllers/concerns/blacklight/default_component_configuration.rb}

@@ -1,5 +1,5 @@
 module Blacklight
-  module Catalog::ComponentConfiguration
+  module DefaultComponentConfiguration
     extend ActiveSupport::Concern
 
     included do
@@ -35,6 +35,9 @@ module Blacklight
       def add_show_tools_partial name, opts = {}
         blacklight_config.add_show_tools_partial(name, opts)
 
+        return if method_defined?(name) || opts[:define_method] == false
+
+        # Define a simple action handler for the tool
         define_method name do
           @response, @documents = action_documents
 
@@ -56,7 +59,7 @@ module Blacklight
               format.js { render :layout => false }
             end
           end
-        end unless method_defined? name
+        end
       end
 
       ##

data/{lib/blacklight/catalog → app/controllers/concerns/blacklight}/search_context.rb

@@ -1,7 +1,6 @@
-module Blacklight::Catalog::SearchContext
+module Blacklight::SearchContext
   extend ActiveSupport::Concern
 
-
   # The following code is executed when someone includes blacklight::catalog::search_session in their
   # own controller.
   included do  

data/{lib → app/controllers/concerns}/blacklight/search_fields.rb

@@ -26,12 +26,6 @@
 #
 ##
 module Blacklight::SearchFields
-  extend ActiveSupport::Concern
-
-  included do
-    helper Blacklight::SearchFields if respond_to? :helper
-  end
-
   # Looks up search field config list from blacklight_config[:search_fields], and
   # 'normalizes' all field config hashes using normalize_config method. 
   def search_field_list

data/{lib → app/controllers/concerns}/blacklight/search_helper.rb

@@ -96,7 +96,7 @@ module Blacklight::SearchHelper
   # @param [Hash,HashWithIndifferentAccess] user_params ({}) the user provided parameters (e.g. query, facets, sort, etc)
   # @param [List<Symbol] processor_chain a list of filter methods to run
   # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used. 
-  # @return [Blacklight::SolrResponse] the solr response object
+  # @return [Blacklight::Solr::Response] the solr response object
   def search_results(user_params, search_params_logic)
     builder = search_builder(search_params_logic).with(user_params)
     builder.page(user_params[:page]) if user_params[:page]
@@ -129,7 +129,7 @@ module Blacklight::SearchHelper
   deprecation_deprecate :query_solr
 
   # retrieve a document, given the doc id
-  # @return [Blacklight::SolrResponse, Blacklight::SolrDocument] the solr response object and the first document
+  # @return [Blacklight::Solr::Response, Blacklight::SolrDocument] the solr response object and the first document
   def fetch(id=nil, extra_controller_params={})
     if id.is_a? Array
       fetch_many(id, params, extra_controller_params)
@@ -161,7 +161,7 @@ module Blacklight::SearchHelper
 
   ##
   # Get the solr response when retrieving only a single facet field
-  # @return [Blacklight::SolrResponse] the solr response
+  # @return [Blacklight::Solr::Response] the solr response
   def get_facet_field_response(facet_field, user_params = params || {}, extra_controller_params = {})
     query = search_builder.with(user_params).facet(facet_field)
     repository.search(query.merge(extra_controller_params))
@@ -202,7 +202,7 @@ module Blacklight::SearchHelper
   deprecation_deprecate :get_single_doc_via_search
 
   # Get the previous and next document from a search result
-  # @return [Blacklight::SolrResponse, Array<Blacklight::SolrDocument>] the solr response and a list of the first and last document
+  # @return [Blacklight::Solr::Response, Array<Blacklight::SolrDocument>] the solr response and a list of the first and last document
   def get_previous_and_next_documents_for_search(index, request_params, extra_controller_params={})
     p = previous_and_next_document_params(index)
 

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -112,7 +112,7 @@ module Blacklight::BlacklightHelperBehavior
   ##
   # Determine whether to display spellcheck suggestions
   #
-  # @param [Blacklight::SolrResponse] response
+  # @param [Blacklight::Solr::Response] response
   # @return [Boolean]
   def should_show_spellcheck_suggestions? response
     response.total <= spell_check_max and response.spelling.words.size > 0

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -131,7 +131,7 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Should we display the sort and per page widget?
   # 
-  # @param [Blacklight::SolrResponse]
+  # @param [Blacklight::Solr::Response]
   # @return [Boolean]
   def show_sort_and_per_page? response = nil
     response ||= @response
@@ -141,7 +141,7 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Should we display the pagination controls?
   #
-  # @param [Blacklight::SolrResponse]
+  # @param [Blacklight::Solr::Response]
   # @return [Boolean]
   def show_pagination? response = nil
     response ||= @response
@@ -207,7 +207,7 @@ module Blacklight::CatalogHelperBehavior
   ##
   # Get url parameters to a search within a grouped result set
   # 
-  # @param [Blacklight::SolrResponse::Group]
+  # @param [Blacklight::Solr::Response::Group]
   # @return [Hash]
   def add_group_facet_params_and_redirect group
     add_facet_params_and_redirect(group.field, group.key)

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -1,5 +1,4 @@
 module Blacklight::FacetsHelperBehavior
-
   include Blacklight::Facet
 
   ##
@@ -31,7 +30,7 @@ module Blacklight::FacetsHelperBehavior
   # solr field used for faceting. Can be over-ridden for custom
   # display on a per-facet basis. 
   #
-  # @param [Blacklight::SolrResponse::Facets::FacetField] display_facet 
+  # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet 
   # @param [Hash] options parameters to use for rendering the facet limit partial
   # @option options [String] :partial partial to render
   # @option options [String] :layout partial layout to render
@@ -77,7 +76,7 @@ module Blacklight::FacetsHelperBehavior
   #
   # By default, only render facets with items.
   #
-  # @param [Blacklight::SolrResponse::Facets::FacetField] display_facet
+  # @param [Blacklight::Solr::Response::Facets::FacetField] display_facet
   # @return [Boolean] 
   def should_render_facet? display_facet
     # display when show is nil or true
@@ -117,7 +116,7 @@ module Blacklight::FacetsHelperBehavior
   # partial and catalog/facet expanded list. Will output facet value name as
   # a link to add that to your restrictions, with count in parens.
   #
-  # @param [Blacklight::SolrResponse::Facets::FacetField]
+  # @param [Blacklight::Solr::Response::Facets::FacetField]
   # @param [String] facet item
   # @param [Hash] options
   # @option options [Boolean] :suppress_link display the facet, but don't link to it
@@ -131,7 +130,7 @@ module Blacklight::FacetsHelperBehavior
 
   ##
   # Where should this facet link to?
-  # @param [Blacklight::SolrResponse::Facets::FacetField]
+  # @param [Blacklight::Solr::Response::Facets::FacetField]
   # @param [String] facet item
   # @return [String]
   def path_for_facet(facet_field, item)

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -32,7 +32,7 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
     return "".html_safe unless params[:f]
 
     safe_join(params[:f].collect do |facet_field, value_list|
-      render_search_to_s_element(facet_configuration_for_field(facet_field).label,
+      render_search_to_s_element(facet_field_label(facet_field),
         safe_join(value_list.collect do |value|
           render_filter_value(value, facet_field)
         end, content_tag(:span, " #{t('blacklight.and')} ", :class =>'filterSeparator'))

data/{lib → app/models}/blacklight/configuration.rb

@@ -201,7 +201,7 @@ module Blacklight
     end
 
     def response_model
-      super || Blacklight::SolrResponse
+      super || Blacklight::Solr::Response
     end
     alias_method :solr_response_model, :response_model
     # only here to support alias_method
@@ -212,7 +212,7 @@ module Blacklight
     deprecation_deprecate solr_response_model: :response_model, :solr_response_model= => :response_model=
 
     def repository_class
-      super || Blacklight::SolrRepository
+      super || Blacklight::Solr::Repository
     end
 
     def connection_config

data/{lib → app/models}/blacklight/configuration/fields.rb

@@ -131,7 +131,7 @@ module Blacklight
 
         @table[:luke_fields] ||= Rails.cache.fetch("blacklight_configuration/admin/luke", expires_in: 1.hour) do
           begin
-            if repository_class == Blacklight::SolrRepository
+            if repository_class <= Blacklight::Solr::Repository
               repository = repository_class.new(self)
               repository.send_and_receive('admin/luke', params: { fl: '*', 'json.nl' => 'map' })['fields']
             end

data/{lib → app/models}/blacklight/search_builder.rb

@@ -101,7 +101,7 @@ module Blacklight
 
     # a solr query method
     # @param [Hash,HashWithIndifferentAccess] extra_controller_params (nil) extra parameters to add to the search
-    # @return [Blacklight::SolrResponse] the solr response object
+    # @return [Blacklight::Solr::Response] the solr response object
     def to_hash method_extra_params = nil
       unless method_extra_params.nil?
         Deprecation.warn(Blacklight::SearchBuilder, "Calling SearchBuilder#query with extra parameters is deprecated. Use #merge(Hash) instead")

data/{lib/blacklight/solr_repository.rb → app/models/blacklight/solr/repository.rb}

@@ -1,5 +1,5 @@
-module Blacklight
-  class SolrRepository < AbstractRepository
+module Blacklight::Solr
+  class Repository < Blacklight::AbstractRepository
     unless defined? RSolr
       Deprecation.warn self, "RSolr should be in your gemfile. Blacklight 6.0 will not load rsolr by default"
       require 'rsolr'
@@ -37,7 +37,7 @@ module Blacklight
     #   @param [Hash] parameters for RSolr::Client#send_and_receive
     # @overload find(params)
     #   @param [Hash] parameters for RSolr::Client#send_and_receive
-    # @return [Blacklight::SolrResponse] the solr response object
+    # @return [Blacklight::Solr::Response] the solr response object
     def send_and_receive(path, solr_params = {})
       benchmark("Solr fetch", level: :debug) do
         key = blacklight_config.http_method == :post ? :data : :params

data/{lib/blacklight/solr_response.rb → app/models/blacklight/solr/response.rb}

@@ -1,14 +1,14 @@
-class Blacklight::SolrResponse < HashWithIndifferentAccess
+class Blacklight::Solr::Response < HashWithIndifferentAccess
   extend Deprecation
 
-  require  'blacklight/solr_response/pagination_methods'
+  require  'blacklight/solr/response/pagination_methods'
 
-  require 'blacklight/solr_response/response'
-  require 'blacklight/solr_response/spelling'
-  require 'blacklight/solr_response/facets'
-  require 'blacklight/solr_response/more_like_this'
-  autoload :GroupResponse, 'blacklight/solr_response/group_response'
-  autoload :Group, 'blacklight/solr_response/group'
+  require 'blacklight/solr/response/response'
+  require 'blacklight/solr/response/spelling'
+  require 'blacklight/solr/response/facets'
+  require 'blacklight/solr/response/more_like_this'
+  autoload :GroupResponse, 'blacklight/solr/response/group_response'
+  autoload :Group, 'blacklight/solr/response/group'
 
   include PaginationMethods
   include Spelling

data/{lib/blacklight/solr_response → app/models/blacklight/solr/response}/facets.rb

@@ -1,8 +1,8 @@
 require 'ostruct'
 
-module Blacklight::SolrResponse::Facets
+module Blacklight::Solr::Response::Facets
   extend Deprecation
-  
+
   # represents a facet value; which is a field value and its hit count
   class FacetItem < OpenStruct
     def initialize *args
@@ -143,7 +143,7 @@ module Blacklight::SolrResponse::Facets
 
   ##
   # Convert Solr's facet_field response into
-  # a hash of Blacklight::SolrResponse::Facet::FacetField objects
+  # a hash of Blacklight::Solr::Response::Facet::FacetField objects
   def facet_field_aggregations
     list_as_hash(facet_fields).each_with_object({}) do |(facet_field_name, values), hash|
       items = []
@@ -191,16 +191,16 @@ module Blacklight::SolrResponse::Facets
         facet_queries.select { |k,v| salient_facet_queries.include?(k) }.reject { |value, hits| hits == 0 }.map do |value,hits|
           salient_fields = facet_field.query.select { |key, val| val[:fq] == value }
           key = ((salient_fields.keys if salient_fields.respond_to? :keys) || salient_fields.first).first
-          items << Blacklight::SolrResponse::Facets::FacetItem.new(value: key, hits: hits, label: facet_field.query[key][:label])
+          items << Blacklight::Solr::Response::Facets::FacetItem.new(value: key, hits: hits, label: facet_field.query[key][:label])
         end
 
-        hash[field_name] = Blacklight::SolrResponse::Facets::FacetField.new field_name, items
+        hash[field_name] = Blacklight::Solr::Response::Facets::FacetField.new field_name, items
     end
   end
 
   ##
   # Convert Solr's facet_pivot response into 
-  # a hash of Blacklight::SolrResponse::Facet::FacetField objects
+  # a hash of Blacklight::Solr::Response::Facet::FacetField objects
   def facet_pivot_aggregations
     facet_pivot.each_with_object({}) do |(field_name, values), hash|
         items = []
@@ -211,7 +211,7 @@ module Blacklight::SolrResponse::Facets
         if blacklight_config and !blacklight_config.facet_fields[field_name]
           # alias all the possible blacklight config names..
           blacklight_config.facet_fields.select { |k,v| v.pivot and v.pivot.join(",") == field_name }.each do |key, _|
-            hash[key] = Blacklight::SolrResponse::Facets::FacetField.new key, items
+            hash[key] = Blacklight::Solr::Response::Facets::FacetField.new key, items
           end
         end
     end
@@ -226,7 +226,7 @@ module Blacklight::SolrResponse::Facets
       items << construct_pivot_field(i, parent_fq.merge({ lst[:field] => lst[:value] }))
     end if lst[:pivot]
 
-    Blacklight::SolrResponse::Facets::FacetItem.new(value: lst[:value], hits: lst[:count], field: lst[:field], items: items, fq: parent_fq)
+    Blacklight::Solr::Response::Facets::FacetItem.new(value: lst[:value], hits: lst[:count], field: lst[:field], items: items, fq: parent_fq)
   end