blacklight 6.19.1 → 7.1.0

data/config/routes.rb

@@ -1,13 +1,5 @@
 # frozen_string_literal: true
 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"
-  post "/catalog/:id/track", to: 'catalog#track', as: 'track_search_context'
-
-  resources :suggest, only: :index, defaults: { format: 'json' }
+  get "search_history",             to: "search_history#index",   as: "search_history"
+  delete "search_history/clear",       to: "search_history#clear",   as: "clear_search_history"
 end

data/db/migrate/20140202020202_create_bookmarks.rb

@@ -14,5 +14,4 @@ class CreateBookmarks < ActiveRecord::Migration[4.2]
   def self.down
     drop_table :bookmarks
   end
-  
 end

data/db/migrate/20140320000000_add_polymorphic_type_to_bookmarks.rb

@@ -2,7 +2,7 @@
 class AddPolymorphicTypeToBookmarks < ActiveRecord::Migration[4.2]
   def change
     add_column(:bookmarks, :document_type, :string) unless Bookmark.connection.column_exists? :bookmarks, :document_type
-    
+
     add_index :bookmarks, :user_id unless Bookmark.connection.index_exists? :bookmarks, :user_id
   end
 end

data/lib/blacklight.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 require 'kaminari'
 require 'deprecation'
-require 'blacklight/utils'
-require 'active_support/hash_with_indifferent_access'
+require 'blacklight/open_struct_with_hash_access'
+require 'blacklight/nested_open_struct_with_hash_access'
 require 'jbuilder'
 
 module Blacklight
@@ -47,6 +47,7 @@ module Blacklight
       connection_config[:adapter].constantize
     else
       raise "The value for :adapter was not found in the blacklight.yml config" unless connection_config.key? :adapter
+
       Blacklight.const_get("#{connection_config.fetch(:adapter)}/Repository".classify)
     end
   end
@@ -60,6 +61,7 @@ module Blacklight
   def self.connection_config
     Blacklight::RuntimeRegistry.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
@@ -84,7 +86,7 @@ module Blacklight
     end
 
     begin
-      @blacklight_yml = YAML.load(blacklight_erb)
+      @blacklight_yml = YAML.safe_load(blacklight_erb)
     rescue => e
       raise("#{blacklight_config_file} was found, but could not be parsed.\n#{e.inspect}")
     end
@@ -98,7 +100,7 @@ module Blacklight
 
   def self.logger
     @logger ||= begin
-      ::Rails.logger if defined? Rails and Rails.respond_to? :logger
+      ::Rails.logger if defined? Rails && Rails.respond_to?(:logger)
     end
   end
 

data/lib/blacklight/abstract_repository.rb

@@ -5,7 +5,7 @@ module Blacklight
     attr_writer :connection
 
     # ActiveSupport::Benchmarkable requires a logger method
-    attr_accessor :logger
+    attr_writer :logger
 
     include ActiveSupport::Benchmarkable
 
@@ -21,14 +21,14 @@ module Blacklight
     # Find a single document result by a known id
     # @param [String] id document's unique key value
     # @param [Hash] params additional query parameters
-    def find(id, params = {})
+    def find(_id, _params = {})
       raise NotImplementedError
     end
 
     ##
     # Execute a search query against a search index
     # @param [Hash] params query parameters
-    def search(params = {})
+    def search(_params = {})
       raise NotImplementedError
     end
 
@@ -46,12 +46,12 @@ module Blacklight
 
     private
 
-      def connection_config
-        blacklight_config.connection_config
-      end
+    def connection_config
+      blacklight_config.connection_config
+    end
 
-      def logger
-        @logger ||= Blacklight.logger
-      end
+    def logger
+      @logger ||= Blacklight.logger
+    end
   end
 end

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,15 @@ 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: {},
+          fetch_many_document_params: {},
           document_pagination_params: {},
-          fetch_many_document_params: nil,
           ##
           # == Response models
           ## Class for sending and receiving requests from a search index
@@ -68,16 +54,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 +82,10 @@ 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.
+            display_type_field: 'format',
+            # 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 +93,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 +111,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
@@ -143,9 +125,12 @@ module Blacklight
           # 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'
+          autocomplete_suggester: 'mySuggester',
+          raw_endpoint: OpenStructWithHashAccess.new(enabled: false),
+          track_search_session: true
           }
         end
+        # rubocop:enable Metrics/MethodLength
       end
     end
 
@@ -179,6 +164,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 +178,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 +186,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 +219,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 +254,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 +267,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 +286,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 +316,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 +338,39 @@ module Blacklight
       add_action(navbar.partials, name, opts)
     end
 
-    private
+    ##
+    # 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 ||= {}
 
-      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
+      (fields_for_type[display_type] ||= self.class.new).tap do |conf|
+        yield(conf) if block_given?
       end
+    end
+
+    ##
+    # Return a list of fields for the index display that should be used for the
+    # provided document.  This respects any configuration made using for_display_type
+    def index_fields_for(document)
+      display_type = document.first(index.display_type_field)
+      for_display_type(display_type).index_fields.merge(index_fields)
+    end
+
+    ##
+    # Return a list of fields for the show page that should be used for the
+    # provided document.  This respects any configuration made using for_display_type
+    def show_fields_for(document)
+      display_type = document.first(show.display_type_field)
+      for_display_type(display_type).show_fields.merge(show_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
   end
 end

data/lib/blacklight/configuration/context.rb

@@ -1,6 +1,17 @@
 # frozen_string_literal: true
+
 module Blacklight
   class Configuration
+    # This class helps determine whether a specific field/tool should display for a
+    # particular controller.  This is used when the field/tool is configured with an
+    # _if_ or _unless_ argument.
+    #
+    # e.g.
+    #   config.add_results_document_tool(:bookmark,
+    #                                    partial: 'bookmark_control',
+    #                                    if: :render_bookmarks_control?)
+    #
+    # The context points at the scope for where to evaluate the method _render_bookmarks_control?_
     class Context
       attr_reader :context
 
@@ -14,7 +25,7 @@ module Blacklight
       # @param [#if,#unless] config an object that responds to if/unless
       # @return [Boolean]
       def evaluate_if_unless_configuration(config, *args)
-        return config if config == true or config == false
+        return config if config == true || config == false
 
         if_value = !config.respond_to?(:if) ||
                         config.if.nil? ||