blacklight 6.25.0 → 7.0.0.rc1

data/lib/blacklight/configuration.rb

@@ -4,31 +4,28 @@ module Blacklight
   # Blacklight::Configuration holds the configuration for a Blacklight::Controller, including
   # fields to display, facets to show, sort options, and search fields.
   class Configuration < OpenStructWithHashAccess
-    # Using required_dependency to work around Rails autoloading
-    # problems when developing blacklight. Without this, any change
-    # to this class breaks other classes in this namespace
-
-    require_dependency 'blacklight/configuration/context'
-    require_dependency 'blacklight/configuration/view_config'
-    require_dependency 'blacklight/configuration/tool_config'
-    # XXX this isn't very pretty, but it works.
-    require_dependency 'blacklight/configuration/fields'
-    require_dependency 'blacklight/configuration/field'
-    require_dependency 'blacklight/configuration/null_field'
-    require_dependency 'blacklight/configuration/search_field'
-    require_dependency 'blacklight/configuration/facet_field'
-    require_dependency 'blacklight/configuration/sort_field'
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :Context
+      autoload :ViewConfig
+      autoload :ToolConfig
+      autoload :Fields
+      autoload :Field
+      autoload :NullField
+      autoload :SearchField
+      autoload :FacetField
+      autoload :SortField
+    end
+
     include Fields
 
-    # Set up Blacklight::Configuration.default_values to contain
-    # the basic, required Blacklight fields
+    # Set up Blacklight::Configuration.default_values to contain the basic, required Blacklight fields
     class << self
+      # rubocop:disable Metrics/MethodLength
       def default_values
         @default_values ||= begin
           {
-          ##
           # === Search request configuration
-          ##
           # HTTP method to use when making requests to solr; valid
           # values are :get and :post.
           http_method: :get,
@@ -38,26 +35,14 @@ module Blacklight
           default_solr_params: {},
           ##
           # === Single document request configuration
-          ##
           # The solr request 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,
+          document_solr_request_handler: nil,
+          # The path to send single document requests to solr
+          document_solr_path: 'get',
+          document_unique_id_param: :ids,
           # 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: "{!term f=#{unique_key} v=$id}",
-            ## disable features we don't need
-            #facet: false,
-            #rows: 1
-          },
+          default_document_solr_params: {},
           document_pagination_params: {},
-          fetch_many_document_params: nil,
           ##
           # == Response models
           ## Class for sending and receiving requests from a search index
@@ -68,16 +53,13 @@ module Blacklight
           response_model: nil,
           # the model to use for each response document
           document_model: nil,
-          # document presenter class used by helpers and views
-          document_presenter_class: nil, # deprecated
           # Class for paginating long lists of facet fields
           facet_paginator_class: nil,
           # repository connection configuration
           connection_config: nil,
           ##
           # == Blacklight view configuration
-          ##
-          navbar: OpenStructWithHashAccess.new(partials: { }),
+          navbar: OpenStructWithHashAccess.new(partials: {}),
           # General configuration for all views
           index: ViewConfig::Index.new(
             # document presenter class used by helpers and views
@@ -99,10 +81,9 @@ module Blacklight
           show: ViewConfig::Show.new(
             # document presenter class used by helpers and views
             document_presenter_class: nil,
-            # default route parameters for 'show' requests
-            # set this to a hash with additional arguments to merge into
-            # the route, or set `controller: :current` to route to the
-            # current controller.
+            # Default route parameters for 'show' requests.
+            # Set this to a hash with additional arguments to merge into the route,
+            # or set `controller: :current` to route to the current controller.
             route: nil,
             # partials to render for each document(see #render_document_partials)
             partials: [:show_header, :show],
@@ -110,17 +91,17 @@ module Blacklight
           ),
           # Configurations for specific types of index views
           view: NestedOpenStructWithHashAccess.new(ViewConfig,
-            'list',
-            atom: {
-              if: false, # by default, atom should not show up as an alternative view
-              partials: [:document]
-            },
-            rss: {
-              if: false, # by default, rss should not show up as an alternative view
-              partials: [:document]
-          }),
+                                                   list: {},
+                                                   atom: {
+                                                     if: false, # by default, atom should not show up as an alternative view
+                                                     partials: [:document]
+                                                   },
+                                                   rss: {
+                                                     if: false, # by default, rss should not show up as an alternative view
+                                                     partials: [:document]
+                                                 }),
           #
-          # These fields are created and managed below by `defined_field_access`
+          # These fields are created and managed below by `define_field_access`
           # facet_fields
           # index_fields
           # show_fields
@@ -128,7 +109,6 @@ module Blacklight
           # search_fields
           ##
           # === Blacklight behavior configuration
-          ##
           # Maxiumum number of spelling suggestions to offer
           spell_max: 5,
           # Maximum number of results to show per page
@@ -142,10 +122,10 @@ 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,
-          autocomplete_suggester: 'mySuggester'
+          crawler_detector: nil
           }
         end
+        # rubocop:enable Metrics/MethodLength
       end
     end
 
@@ -179,6 +159,11 @@ module Blacklight
       super || ::SolrDocument
     end
 
+    # A class that builds documents
+    def document_factory
+      super || Blacklight::DocumentFactory
+    end
+
     # only here to support alias_method
     def document_model=(*args)
       super
@@ -188,17 +173,6 @@ module Blacklight
       super || Blacklight::Solr::Response
     end
 
-    # @deprecated
-    def document_presenter_class
-      super || Blacklight::DocumentPresenter
-    end
-
-    # @deprecated
-    def document_presenter_class=(klass)
-      super
-    end
-    deprecation_deprecate :document_presenter_class= => "replaced by show.presenter_class and index.presenter_class"
-
     def response_model=(*args)
       super
     end
@@ -207,6 +181,10 @@ module Blacklight
       super || Blacklight::Solr::Repository
     end
 
+    def repository
+      repository_class.new(self)
+    end
+
     def connection_config
       super || Blacklight.connection_config
     end
@@ -236,16 +214,14 @@ module Blacklight
     # Returns default search field, used for simpler display in history, etc.
     # if not set, defaults to first defined search field
     def default_search_field
-      field = super
-      field ||= search_fields.values.find { |f| f.default == true }
+      field = super || search_fields.values.find { |f| f.default == true }
       field || search_fields.values.first
     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
-      field = super
-      field ||= sort_fields.values.find { |f| f.default == true }
+      field = super || sort_fields.values.find { |f| f.default == true }
       field || sort_fields.values.first
     end
 
@@ -273,11 +249,10 @@ module Blacklight
       if fields.empty?
         self.add_facet_fields_to_solr_request = true
       else
-        facet_fields.slice(*fields).each { |_k, v| v.include_in_request = true }
+        facet_fields.slice(*fields).each_value { |v| v.include_in_request = true }
       end
     end
 
-    ##
     # Add any configured facet fields to the default solr parameters hash
     # @overload add_field_configuration_to_solr_request!
     #    add all index, show, and facet fields to the solr request
@@ -287,9 +262,9 @@ module Blacklight
       if fields.empty?
         self.add_field_configuration_to_solr_request = true
       else
-        index_fields.slice(*fields).each { |_k, v| v.include_in_request = true }
-        show_fields.slice(*fields).each { |_k, v| v.include_in_request = true }
-        facet_fields.slice(*fields).each { |_k, v| v.include_in_request = true }
+        index_fields.slice(*fields).each_value { |v| v.include_in_request = true }
+        show_fields.slice(*fields).each_value { |v| v.include_in_request = true }
+        facet_fields.slice(*fields).each_value { |v| v.include_in_request = true }
       end
     end
 
@@ -306,17 +281,22 @@ module Blacklight
         end
       end
     end
-    alias_method :inheritable_copy, :deep_copy
 
-    ##
+    # builds a copy for the provided controller class
+    def build(klass)
+      deep_copy.tap do |conf|
+        conf.klass = klass
+      end
+    end
+    alias_method :inheritable_copy, :build
+
     # Get a view configuration for the given view type
     # including default values from the index configuration
+    # @param [Symbol,#to_sym] view_type
+    # @return [Blacklight::Configuration::ViewConfig]
     def view_config(view_type)
-      if view_type == :show
-        self.index.merge self.show
-      else
-        self.index.merge view.fetch(view_type, {})
-      end
+      view_type = view_type.to_sym unless view_type.is_a? Symbol
+      index.merge(view_type == :show ? show : view.fetch(view_type, {}))
     end
 
     # YARD will include inline disabling as docs, cannot do multiline inside @!macro.  AND this must be separate from doc block.
@@ -331,6 +311,7 @@ module Blacklight
     def add_show_tools_partial(name, opts = {})
       opts[:partial] ||= 'document_action'
       add_action(show.document_actions, name, opts)
+      klass && ActionBuilder.new(klass, name, opts).build
     end
     # rubocop:enable Metrics/LineLength
 
@@ -352,13 +333,25 @@ module Blacklight
       add_action(navbar.partials, name, opts)
     end
 
+    ##
+    # Add a section of config that only applies to documents with a matching display type
+    def for_display_type display_type, &block
+      self.fields_for_type ||= {}
+      fields_for_type[display_type] ||= self.class.new(&block)
+    end
+
+    def index_fields_for(document)
+      display_type = document.first(index.display_type_field)
+      for_display_type(display_type).index_fields.merge(index_fields)
+    end
+
     private
 
-      def add_action(config_hash, name, opts)
-        config = Blacklight::Configuration::ToolConfig.new opts
-        config.name = name
-        yield(config) if block_given?
-        config_hash[name] = config
-      end
+    def add_action(config_hash, name, opts)
+      config = Blacklight::Configuration::ToolConfig.new opts
+      config.name = name
+      yield(config) if block_given?
+      config_hash[name] = config
+    end
   end
 end

data/lib/blacklight/engine.rb

@@ -3,12 +3,9 @@ module Blacklight
   class Engine < Rails::Engine
     engine_name "blacklight"
 
-    require 'bootstrap-sass'
-    require 'twitter-typeahead-rails'
-
     # BlacklightHelper is needed by all helpers, so we inject it
     # into action view base here.
-    initializer 'blacklight.helpers' do |app|
+    initializer 'blacklight.helpers' do
       ActionView::Base.send :include, BlacklightHelper
     end
 
@@ -28,8 +25,7 @@ module Blacklight
     end
 
     initializer "blacklight.assets.precompile" do |app|
-      # When Rails has been generated in API mode, it does not have sprockets available
-      app.config.assets.precompile += %w(favicon.ico) if defined? Sprockets
+      app.config.assets.precompile += %w(favicon.ico)
     end
 
     Blacklight::Engine.config.sms_mappings = {
@@ -43,14 +39,12 @@ module Blacklight
       'Cricket' => 'mms.mycricket.com'
     }
 
-    config.routes = OpenStruct.new
-    # Set identifier_constraint to enforce a format for the document identifiers
-    config.routes.identifier_constraint = /.+/
-
     config.bookmarks_http_method = :post
 
     config.email_regexp = defined?(Devise) ? Devise.email_regexp : /\A[^@\s]+@[^@\s]+\z/
 
-    Blacklight::Engine.config.search_params_permitted_classes = [ActiveSupport::HashWithIndifferentAccess, Symbol]
+    config.action_dispatch.rescue_responses.merge!(
+      "Blacklight::Exceptions::RecordNotFound" => :not_found
+    )
   end
 end

data/lib/blacklight/exceptions.rb

@@ -4,13 +4,7 @@ module Blacklight
     class AccessDenied < StandardError
     end
 
-    # When a request for a single solr document by id
-    # is not successful, we can raise this exception. 
-    # Deprecated; this will be removed in Blacklight 6.0:
-    class InvalidSolrID < RuntimeError
-    end
-    # In Blacklight 6.0, this exception can subclass RuntimeError directly
-    class RecordNotFound < InvalidSolrID
+    class RecordNotFound < RuntimeError
     end
 
     class InvalidRequest < StandardError
@@ -20,5 +14,8 @@ module Blacklight
     end
 
     class ECONNREFUSED < ::Errno::ECONNREFUSED; end
+
+    class IconNotFound < StandardError
+    end
   end
 end

data/lib/blacklight/nested_open_struct_with_hash_access.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+require 'ostruct'
+module Blacklight
+  ##
+  # An OpenStruct refinement that converts any hash-keys into
+  # additional instances of NestedOpenStructWithHashAccess
+  class NestedOpenStructWithHashAccess < OpenStructWithHashAccess
+    attr_reader :nested_class
+    delegate :default_proc=, to: :to_h
+
+    def initialize(klass, hash = {})
+      @nested_class = klass
+      value = hash.transform_values do |v|
+        if v.is_a? Hash
+          nested_class.new(v)
+        else
+          v
+        end
+      end
+
+      super value
+      set_default_proc!
+    end
+
+    ##
+    # Add an new key to the object, with a default default
+    def << key
+      @table[key]
+    end
+
+    ##
+    # Add a new key/value to the object; if it's a Hash, turn it
+    # into another NestedOpenStructWithHashAccess
+    def []=(key, value)
+      if value.is_a? Hash
+        send "#{key}=", nested_class.new(value)
+      else
+        super
+      end
+    end
+
+    ##
+    # Before serializing, we need to reset the default proc
+    # so it can be serialized appropriately
+    def marshal_dump
+      h = to_h.dup
+      h.default = nil
+
+      [nested_class, h]
+    end
+
+    ##
+    # After deserializing, we need to re-add the default proc
+    # to the internal hash
+    def marshal_load x
+      @nested_class = x.first
+      super x.last
+      set_default_proc!
+    end
+
+    def deep_dup
+      self.class.new nested_class, @table.deep_dup
+    end
+
+    def select *args, &block
+      self.class.new nested_class, to_h.select(*args, &block)
+    end
+
+    ##
+    # Merge the values of this OpenStruct with another OpenStruct or Hash
+    # @param [Hash,#to_h] other_hash
+    # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
+    def merge other_hash
+      self.class.new nested_class, to_h.merge((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
+    end
+
+    ##
+    # Merge the values of another OpenStruct or Hash into this object
+    # @param [Hash,#to_h] other_hash
+    # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
+    def merge! other_hash
+      @table.merge!(nested_class, (other_hash if other_hash.is_a? Hash) || other_hash.to_h)
+    end
+
+    ##
+    # Override #method_missing from OpenStruct to ensure the default_proc logic
+    # gets triggered.
+    def method_missing(mid, *args)
+      len = args.length
+
+      if len.zero?
+        new_ostruct_member(mid)
+        @table[mid]
+      else
+        super
+      end
+    end
+
+    private
+
+    def set_default_proc!
+      self.default_proc = lambda do |hash, key|
+        hash[key] = nested_class.new
+      end
+    end
+  end
+end

data/lib/blacklight/open_struct_with_hash_access.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require 'ostruct'
+module Blacklight
+  ##
+  # An OpenStruct that responds to common Hash methods
+  class OpenStructWithHashAccess < OpenStruct
+    delegate :keys, :each, :map, :has_key?, :key?, :include?, :empty?, :length, :delete, :delete_if, :keep_if, :clear, :reject!, :select!, :replace, :fetch, :to_json, :as_json, :any?, to: :to_h
+
+    ##
+    # Expose the internal hash
+    # @return [Hash]
+    def to_h
+      @table
+    end
+
+    def select *args, &block
+      self.class.new to_h.select(*args, &block)
+    end
+
+    def sort_by *args, &block
+      self.class.new Hash[to_h.sort_by(*args, &block)]
+    end
+
+    def sort_by! *args, &block
+      replace Hash[to_h.sort_by(*args, &block)]
+      self
+    end
+
+    ##
+    # Merge the values of this OpenStruct with another OpenStruct or Hash
+    # @param [Hash,#to_h] other_hash
+    # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
+    def merge other_hash
+      self.class.new to_h.merge((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
+    end
+
+    ##
+    # Merge the values of another OpenStruct or Hash into this object
+    # @param [Hash,#to_h] other_hash
+    # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
+    def merge! other_hash
+      @table.merge!((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
+    end
+
+    def deep_dup
+      self.class.new @table.deep_dup
+    end
+  end
+end

data/lib/blacklight/parameters.rb

@@ -6,7 +6,7 @@ module Blacklight
     # from the provided parameters.
     # @param [Hash] params parameters
     def self.sanitize params
-      params.reject { |k,v| v.nil? }
+      params.reject { |_k, v| v.nil? }
             .except(:action, :controller, :id, :commit, :utf8)
     end
   end

data/lib/blacklight/routes/searchable.rb

@@ -14,6 +14,7 @@ module Blacklight
         mapper.post ":id/track", action: 'track', as: 'track'
 
         mapper.get "opensearch"
+        mapper.get 'suggest', as: 'suggest_index', defaults: { format: 'json' }
         mapper.get "facet/:id", action: 'facet', as: 'facet'
       end
     end

data/lib/blacklight/search_builder.rb

@@ -5,34 +5,27 @@ module Blacklight
   # query parameters appropriate for search index. It does so by evaluating a
   # chain of processing methods to populate a result hash (see {#to_hash}).
   class SearchBuilder
-    extend Deprecation
     class_attribute :default_processor_chain
     self.default_processor_chain = []
 
     attr_reader :processor_chain, :blacklight_params
 
-    
     # @overload initialize(scope)
-    #   @param [Object] scope scope the scope where the filter methods reside in.    
+    #   @param [Object] scope scope the scope where the filter methods reside in.
     # @overload initialize(processor_chain, scope)
     #   @param [List<Symbol>,TrueClass] processor_chain options a list of filter methods to run or true, to use the default methods
-    #   @param [Object] scope scope the scope where the filter methods reside in.
+    #   @param [Object] scope the scope where the filter methods reside in.
     def initialize(*options)
-      @scope = case options.size
+      case options.size
       when 1
-        options.first
+        @processor_chain = default_processor_chain.dup
+        @scope = options.first
       when 2
-        if options.first == true
-          Deprecation.warn Blacklight::SearchBuilder, "SearchBuilder#initialize now takes only one parameter, the scope. Passing `true' will be removed in Blacklight 7"
-        else
-          @processor_chain = options.first
-        end
-        options.last
+        @processor_chain, @scope = options
       else
         raise ArgumentError, "wrong number of arguments. (#{options.size} for 1..2)"
       end
 
-      @processor_chain ||= default_processor_chain.dup
       @blacklight_params = {}
       @merged_params = {}
       @reverse_merged_params = {}
@@ -116,10 +109,10 @@ module Blacklight
     # @return [Blacklight::Solr::Response] the solr response object
     def to_hash
       return @params unless params_need_update?
-      @params = processed_parameters.
-                  reverse_merge(@reverse_merged_params).
-                  merge(@merged_params).
-                  tap { self.clear_changes }
+      @params = processed_parameters
+                  .reverse_merge(@reverse_merged_params)
+                  .merge(@merged_params)
+                  .tap { clear_changes }
     end
 
     alias_method :query, :to_hash
@@ -197,7 +190,7 @@ module Blacklight
       end
       @rows ||= begin
         # user-provided parameters should override any default row
-        r = [:rows, :per_page].map {|k| blacklight_params[k] }.reject(&:blank?).first
+        r = [:rows, :per_page].map { |k| blacklight_params[k] }.reject(&:blank?).first
         r ||= blacklight_config.default_per_page
         # ensure we don't excede the max page size
         r.nil? ? nil : [r, blacklight_config.max_per_page].map(&:to_i).min
@@ -221,36 +214,34 @@ module Blacklight
       @facet
     end
 
+    # Decode the user provided 'sort' parameter into a sort string that can be
+    # passed to the search.  This sanitizes the input by ensuring only
+    # configured search values are passed through to the search.
+    # @return [String] the field/fields to sort by
     def sort
       sort_field = if blacklight_params[:sort].blank?
-        # no sort param provided, use default
-        blacklight_config.default_sort_field
-      else
-        # check for sort field key
-        blacklight_config.sort_fields[blacklight_params[:sort]]
-      end
-
-      field = if sort_field.present?
-        sort_field.sort
-      else
-        # just pass the key through
-        blacklight_params[:sort]
-      end
-
-      field unless field.blank?
+                     # no sort param provided, use default
+                     blacklight_config.default_sort_field
+                   else
+                     # check for sort field key
+                     blacklight_config.sort_fields[blacklight_params[:sort]]
+                   end
+      return sort_field.sort if sort_field.present?
+      Blacklight.logger.warn "Invalid sort field: '#{blacklight_params[:sort]}' was provided."
+      nil
     end
 
     def search_field
       blacklight_config.search_fields[blacklight_params[:search_field]]
     end
 
-    protected
+    private
 
     def request
       Blacklight::Solr::Request.new
     end
 
-    def should_add_field_to_request? field_name, field
+    def should_add_field_to_request? _field_name, field
       field.include_in_request || (field.include_in_request.nil? && blacklight_config.add_field_configuration_to_solr_request)
     end