blacklight 6.18.0 → 6.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 59d179acd38459b0540692e705b2c4835f31c022
-  data.tar.gz: e3f02fe1b03842e4d80fe678435105064504c8c6
+SHA256:
+  metadata.gz: f8c4e84017c1688f0bcd1f5d99438369b1ac18bda293369d65422d732b401755
+  data.tar.gz: 7c7dc8aaa1ceb8aa086ffdeecd6dd1c086952298f4a626c927df495f64958086
 SHA512:
-  metadata.gz: f55802166972b36f29a5e687c4e42a323426b27a189134bc7940bf227e0532e6b183c57b4f3d539f92dd64a85ca8c915af68bd627e50c6560b9c07061a6141ad
-  data.tar.gz: dec4137377509c2eebd25f4c63fb7302d9daf7e22d84e8bc7b0a8916999637c7d048b51964c7de8b7e8ebd5dcddb7739c7453c5304a612b9e045be9c9b3bc02d
+  metadata.gz: de725df92b158a47778ae9f7d0fe54b1055ca1679d68995d5dee0653cfb637bef524b3011d62fa2ec57289abae7f1e2158e38e160a32848112783531af0d1507
+  data.tar.gz: '02385cf07bd6d5c1296d8a5521acf481c42a6ec3046e3a2dbc5d21cba5a624dddec3d68e8f0cff8b885537a76b15a5d3ca7bf1729d167b64fadc5cad2e555e33'

data/.rubocop_todo.yml

@@ -108,7 +108,7 @@ Metrics/MethodLength:
 # Offense count: 9
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 208
+  Max: 211
   Exclude:
     - 'lib/blacklight/solr/search_builder_behavior.rb'
 

data/.travis.yml

@@ -1,3 +1,6 @@
+dist: trusty
+addons:
+  chrome: stable
 language: ruby
 sudo: false
 
@@ -26,6 +29,7 @@ matrix:
 before_install:
   - gem update --system
   - gem install bundler
+  - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 http://localhost &
 
 before_script:
   - if [[ "${RAILS_VERSION}" =~ ^4.2.* ]]; then perl -pi -e "s/ActiveRecord::Migration\[[\d\.]+\]/ActiveRecord::Migration/" db/migrate/*; fi
@@ -40,5 +44,6 @@ notifications:
 
 global_env:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+  - ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test'
 
 jdk: oraclejdk8

data/Gemfile

@@ -37,6 +37,7 @@ else
     gem 'sass-rails', '>= 5.0'
     gem 'coffee-rails', '~> 4.1.0'
     gem 'json', '~> 1.8'
+    gem 'capybara', '~> 2.0'
   when /^4.[01]/
     gem 'sass-rails', '< 5.0'
   end

data/VERSION

@@ -1 +1 @@
-6.18.0
+6.19.0

data/app/controllers/concerns/blacklight/bookmarks.rb

@@ -71,7 +71,7 @@ module Blacklight::Bookmarks
   # is simpler.
   def create
     @bookmarks = if params[:bookmarks]
-                   params[:bookmarks]
+                   permit_bookmarks[:bookmarks]
                  else
                    [{ document_id: params[:id], document_type: blacklight_config.document_model.to_s }]
                  end
@@ -103,9 +103,19 @@ 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.find_by(document_id: params[:id], document_type: blacklight_config.document_model.to_s)
+    @bookmarks =
+      if params[:bookmarks]
+        permit_bookmarks[:bookmarks]
+      else
+        [{ document_id: params[:id], document_type: blacklight_config.document_model.to_s }]
+      end
 
-    if bookmark && bookmark.delete && bookmark.destroyed?
+    success = @bookmarks.all? do |bookmark|
+      bookmark = current_or_guest_user.bookmarks.find_by(bookmark)
+      bookmark && bookmark.delete && bookmark.destroyed?
+    end
+
+    if success
       if request.xhr?
         render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }})
       elsif respond_to? :redirect_back
@@ -144,4 +154,8 @@ module Blacklight::Bookmarks
   def start_new_search_session?
     action_name == "index"
   end
+
+  def permit_bookmarks
+    params.permit(bookmarks: [:document_id, :document_type])
+  end
 end

data/app/controllers/concerns/blacklight/catalog.rb

@@ -9,9 +9,11 @@ module Blacklight::Catalog
   # The following code is executed when someone includes blacklight::catalog in their
   # own controller.
   included do
-    helper_method :sms_mappings, :has_search_parameters?
+    if respond_to? :helper_method
+      helper_method :sms_mappings, :has_search_parameters?
+    end
 
-    helper Blacklight::Facet
+    helper Blacklight::Facet if respond_to? :helper
 
     # When an action raises Blacklight::Exceptions::RecordNotFound, handle
     # the exception appropriately.

data/app/controllers/concerns/blacklight/controller.rb

@@ -8,23 +8,26 @@ module Blacklight::Controller
 
   included do
     include Blacklight::SearchFields
-    helper Blacklight::SearchFields
+    helper Blacklight::SearchFields if respond_to? :helper
 
     include ActiveSupport::Callbacks
 
     # now in application.rb file under config.filter_parameters
     # filter_parameter_logging :password, :password_confirmation
-    helper_method :current_user_session, :current_user, :current_or_guest_user
     after_action :discard_flash_if_xhr
 
     # handle basic authorization exception with #access_denied
     rescue_from Blacklight::Exceptions::AccessDenied, :with => :access_denied
 
-    # extra head content
-    helper_method :has_user_authentication_provider?
-    helper_method :blacklight_config, :blacklight_configuration_context
-    helper_method :search_action_url, :search_action_path, :search_facet_url, :search_facet_path
-    helper_method :search_state
+    if respond_to? :helper_method
+      helper_method :current_user_session, :current_user, :current_or_guest_user
+
+      # extra head content
+      helper_method :has_user_authentication_provider?
+      helper_method :blacklight_config, :blacklight_configuration_context
+      helper_method :search_action_url, :search_action_path, :search_facet_path
+      helper_method :search_state
+    end
 
     # Specify which class to use for the search state. You can subclass SearchState if you
     # want to override any of the methods (e.g. SearchState#url_for_document)

data/app/controllers/concerns/blacklight/search_context.rb

@@ -2,10 +2,12 @@
 module Blacklight::SearchContext
   extend ActiveSupport::Concern
 
-  # The following code is executed when someone includes blacklight::catalog::search_session in their
+  # The following code is executed when someone includes Blacklight::Catalog::SearchSession in their
   # own controller.
-  included do  
-    helper_method :current_search_session, :search_session
+  included do
+    if respond_to? :helper_method
+      helper_method :current_search_session, :search_session
+    end
   end
 
   module ClassMethods

data/app/controllers/concerns/blacklight/token_based_user.rb

@@ -3,7 +3,9 @@ module Blacklight::TokenBasedUser
   extend ActiveSupport::Concern
 
   included do
-    helper_method :encrypt_user_id
+    if respond_to? :helper_method
+      helper_method :encrypt_user_id
+    end
 
     rescue_from Blacklight::Exceptions::ExpiredSessionToken do
       head :unauthorized

data/app/models/blacklight/suggest_search.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+
 module Blacklight
   class SuggestSearch
     attr_reader :request_params, :repository
     
     ##
     # @param [Hash] params
+    # @param [Blacklight::AbstractRepository] repository
     def initialize(params, repository)
       @request_params = { q: params[:q] }
       @repository = repository
@@ -15,20 +17,7 @@ module Blacklight
     # Blacklight::Suggest::Response
     # @return [Blacklight::Suggest::Response]
     def suggestions
-      Blacklight::Suggest::Response.new suggest_results, request_params, suggest_handler_path
-    end
-
-    ##
-    # Query the suggest handler using RSolr::Client::send_and_receive
-    # @return [RSolr::HashWithResponse]
-    def suggest_results
-      repository.connection.send_and_receive(suggest_handler_path, params: request_params)
-    end
-
-    ##
-    # @return [String]
-    def suggest_handler_path
-      repository.blacklight_config.autocomplete_path
+      repository.suggestions(request_params)
     end
   end
 end

data/app/models/concerns/blacklight/document.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
-##
+
+require 'globalid'
+
 ##
 # = Introduction
 # Blacklight::Document is the module with logic for a class representing

data/app/models/concerns/blacklight/suggest/response.rb

@@ -2,17 +2,19 @@
 module Blacklight
   module Suggest
     class Response
-      attr_reader :response, :request_params, :suggest_path
+      attr_reader :response, :request_params, :suggest_path, :suggester_name
 
       ##
       # Creates a suggest response
       # @param [RSolr::HashWithResponse] response
       # @param [Hash] request_params
       # @param [String] suggest_path
-      def initialize(response, request_params, suggest_path)
+      # @param [String] suggester_name
+      def initialize(response, request_params, suggest_path, suggester_name)
         @response = response
         @request_params = request_params
         @suggest_path = suggest_path
+        @suggester_name = suggester_name
       end
 
       ##
@@ -20,7 +22,7 @@ module Blacklight
       # present
       # @return [Array]
       def suggestions
-        response.try(:[], suggest_path).try(:[], 'mySuggester').try(:[], request_params[:q]).try(:[], 'suggestions') || []
+        (response.try(:[], suggest_path).try(:[], suggester_name).try(:[], request_params[:q]).try(:[], 'suggestions') || []).uniq
       end
     end
   end

data/app/presenters/blacklight/index_presenter.rb

@@ -53,10 +53,10 @@ module Blacklight
     # @option options [String] :value
     def field_value field_or_name, options = {}
       field = case field_or_name
-              when String
-                Deprecation.warn(self, "You provided a String value to IndexPresenter#field_value " \
+              when String, Symbol
+                Deprecation.warn(self, "You provided a String or Symbol value to IndexPresenter#field_value " \
                 "Provide a Blacklight::Configuration::Field instead. field_value() will not accept " \
-                "strings in Blacklight 7")
+                "strings or symbols in Blacklight 7")
                 field_config(field_or_name)
               else
                 field_or_name

data/blacklight.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "rails", ">= 4.2", "< 6"
   s.add_dependency "globalid"
-  s.add_dependency "jbuilder"
+  s.add_dependency "jbuilder", '~> 2.7'
   s.add_dependency "nokogiri",  "~>1.6"     # XML Parser
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
@@ -39,9 +39,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec-rails", "~> 3.5"
   s.add_development_dependency "rspec-its"
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
-  s.add_development_dependency "capybara", '~> 2.6'
-  s.add_development_dependency "poltergeist"
-  s.add_development_dependency 'engine_cart', '~> 1.0'
+  s.add_development_dependency "capybara", '>= 2', '< 4'
+  s.add_development_dependency 'chromedriver-helper', '< 2.0.0' # 2.1.0 is causing "Unable to find chromedriver" on Travis
+  s.add_development_dependency "selenium-webdriver", '>= 3.13.1'
+  s.add_development_dependency 'engine_cart', '~> 1.2'
   s.add_development_dependency "equivalent-xml"
   s.add_development_dependency "coveralls"
   s.add_development_dependency "simplecov"

data/lib/blacklight.rb

@@ -3,6 +3,7 @@ require 'kaminari'
 require 'deprecation'
 require 'blacklight/utils'
 require 'active_support/hash_with_indifferent_access'
+require 'jbuilder'
 
 module Blacklight
   autoload :AbstractRepository, 'blacklight/abstract_repository'
@@ -105,17 +106,16 @@ module Blacklight
     @logger = logger
   end
 
-  #############  
+  #############
   # Methods for figuring out path to BL plugin, and then locate various files
   # either in the app itself or defaults in the plugin -- whether you are running
   # from the plugin itself or from an actual app using te plugin.
   # In a seperate module so it can be used by both Blacklight class, and
-  # by rake tasks without loading the whole Rails environment. 
+  # by rake tasks without loading the whole Rails environment.
   #############
-  
+
   # returns the full path the the blacklight plugin installation
   def self.root
     @root ||= File.expand_path(File.dirname(File.dirname(__FILE__)))
   end
-  
 end

data/lib/blacklight/abstract_repository.rb

@@ -32,7 +32,19 @@ module Blacklight
       raise NotImplementedError
     end
 
-    protected
+    # Query the fields that exist from the index
+    # @return [Hash]
+    def reflect_fields
+      raise NotImplementedError
+    end
+
+    ##
+    # Is the repository in a working state?
+    def ping
+      raise NotImplementedError
+    end
+
+    private
 
       def connection_config
         blacklight_config.connection_config

data/lib/blacklight/configuration.rb

@@ -142,7 +142,8 @@ module Blacklight
           default_more_limit: 20,
           # proc for determining whether the session is a crawler/bot
           # ex.: crawler_detector: lambda { |req| req.env['HTTP_USER_AGENT'] =~ /bot/ }
-          crawler_detector: nil
+          crawler_detector: nil,
+          autocomplete_suggester: 'mySuggester'
           }
         end
       end

data/lib/blacklight/configuration/fields.rb

@@ -5,6 +5,8 @@ module Blacklight
     # solr fields configuration
     module Fields
       extend ActiveSupport::Concern
+      extend Deprecation
+      self.deprecation_horizon = 'blacklight version 8.0.0'
 
       module ClassMethods
         # Add a configuration block for a collection of solr fields
@@ -20,7 +22,7 @@ module Blacklight
               class #{key.camelcase} < #{base_class_name}; end
             END_EVAL
           end
-    
+
           class_eval <<-END_EVAL, __FILE__, __LINE__ + 1
             def add_#{key}(*args, &block)
               add_blacklight_field("#{key}", *args, &block)
@@ -32,7 +34,7 @@ module Blacklight
       # Add a solr field configuration to the given configuration key
       #
       # The recommended and strongly encouraged format is a field name, configuration pair, e.g.:
-      #     add_blacklight_field :index_field, 'format', :label => 'Format' 
+      #     add_blacklight_field :index_field, 'format', :label => 'Format'
       #
       # Alternative formats include:
       #
@@ -56,7 +58,7 @@ module Blacklight
       #       field.field = 'format'
       #       field.label = 'Format'
       #     end
-      # 
+      #
       # * a configuration hash:
       #
       # @overload add_blacklight_field(config_key, options)
@@ -64,8 +66,8 @@ module Blacklight
       #   @param [Hash] options
       #
       #     add_blacklight_field :index_field, :field => 'format', :label => 'Format'
-      #   
-      # * a Field instance: 
+      #
+      # * a Field instance:
       #
       # @overload add_blacklight_field(config_key, field)
       #   @param [Symbol] config_key
@@ -74,7 +76,7 @@ module Blacklight
       #
       #     add_blacklight_field :index_field, IndexField.new(:field => 'format', :label => 'Format')
       #
-      # * an array of hashes: 
+      # * an array of hashes:
       #
       # @overload add_blacklight_field(config_key, fields)
       #   @param [Symbol] config_key
@@ -102,31 +104,14 @@ module Blacklight
 
         # look up any dynamic fields
         if field_config.match
-
-          salient_fields = luke_fields.select do |k,v|
-            k =~ field_config.match
-          end
-
-          salient_fields.each do |field, luke_config|
-            config = field_config.dup
-            config.match = nil
-            config.field = field
-            config.key = field
-
-            if self[config_key.pluralize][ config.key ]
-              self[config_key.pluralize][ config.key ] = config.merge(self[config_key.pluralize][ config.key ])
-            else
-              add_blacklight_field(config_key, config, &block)
-            end
-          end
-
+          handle_matching_fields(config_key, field_config, &block)
           return
         end
-  
+
         if block_given?
           yield field_config
         end
-            
+
         field_config.normalize!(self)
         field_config.validate!
 
@@ -137,27 +122,47 @@ module Blacklight
 
       protected
 
-      def luke_fields
-        if @table[:luke_fields] == false
+      ##
+      # Using reflection into the index, add any fields in the index that match the field_config
+      def handle_matching_fields(config_key, field_config, &block)
+        salient_fields = reflected_fields.select do |k, _v|
+          k =~ field_config.match
+        end
+
+        salient_fields.each_key do |field|
+          config = field_config.dup
+          config.match = nil
+          config.field = field
+          config.key = field
+          if self[config_key.pluralize][config.key]
+            self[config_key.pluralize][config.key] = config.merge(self[config_key.pluralize][config.key])
+          else
+            add_blacklight_field(config_key, config, &block)
+          end
+        end
+      end
+
+      def reflected_fields
+        if @table[:reflected_fields] == false
           return nil
         end
 
-        @table[:luke_fields] ||= Rails.cache.fetch("blacklight_configuration/admin/luke", expires_in: 1.hour) do
+        @table[:reflected_fields] ||= Rails.cache.fetch("blacklight_configuration/admin/reflected_fields", expires_in: 1.hour) do
           begin
-            if repository_class <= Blacklight::Solr::Repository
-              repository = repository_class.new(self)
-              repository.send_and_receive('admin/luke', params: { fl: '*', 'json.nl' => 'map' })['fields']
-            end
+            repository = repository_class.new(self)
+            repository.reflect_fields
           rescue => e
             Blacklight.logger.warn "Error retrieving field metadata: #{e}"
             false
           end
         end
 
-        @table[:luke_fields] || {}
+        @table[:reflected_fields] || {}
       end
+      alias luke_fields reflected_fields
+      deprecation_deprecate luke_fields: 'use reflected_fields instead'
 
-      # Add a solr field by a solr field name and hash 
+      # Add a solr field by a solr field name and hash
       def field_config_from_key_and_hash config_key, field_name, field_or_hash = {}
         field_config = field_config_from_field_or_hash(config_key, field_or_hash)
         field_config.key = field_name
@@ -166,7 +171,7 @@ module Blacklight
 
       # Add multiple solr fields using a hash or Field instance
       def field_config_from_array config_key, array_of_fields_or_hashes, &block
-        array_of_fields_or_hashes.map do |field_or_hash| 
+        array_of_fields_or_hashes.map do |field_or_hash|
           add_blacklight_field(config_key, field_or_hash, &block)
         end
       end
@@ -180,16 +185,16 @@ module Blacklight
       # and makes it into a specific config OpenStruct, like
       # FacetField or SearchField. Or if the param already was
       # one, that's cool. Or if the param is nil, make
-      # an empty one. Second argument is an actual class object. 
+      # an empty one. Second argument is an actual class object.
       def hash_arg_to_config(hash_arg, klass)
         case hash_arg
-        when Hash 
+        when Hash
           klass.new(hash_arg)
-        when NilClass 
+        when NilClass
           klass.new
-        else 
+        else
           # this assumes it already is an element of klass, or acts like one,
-          # if not something bad will happen later, that's your problem. 
+          # if not something bad will happen later, that's your problem.
           hash_arg
         end
       end