blacklight 5.19.2 → 6.0.0.pre1

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

@@ -16,21 +16,6 @@ module Blacklight
       @connection ||= build_connection
     end
 
-    ##
-    # Find a single document result by a known id
-    # @param [String] document's unique key value
-    # @param [Hash] additional query parameters
-    def find(id, params = {})
-      fail NotImplementedError
-    end
-
-    ##
-    # Execute a search query against a search index
-    # @param [Hash] query parameters
-    def search(params = {})
-      fail NotImplementedError
-    end
-
     protected
       def connection_config
         blacklight_config.connection_config

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

@@ -3,20 +3,19 @@ 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
-
-    require 'blacklight/configuration/view_config'
-    require 'blacklight/configuration/tool_config'
-
-    # XXX this isn't very pretty, but it works.
-    require 'blacklight/configuration/fields'
-    require 'blacklight/configuration/field'
-    require 'blacklight/configuration/solr_field'
-    require 'blacklight/configuration/search_field'
-    require 'blacklight/configuration/facet_field'
-    require 'blacklight/configuration/sort_field'
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :ViewConfig
+      autoload :ToolConfig
+      autoload :Fields
+      autoload :Field
+      autoload :SolrField
+      autoload :SearchField
+      autoload :FacetField
+      autoload :SortField
+    end
     include Fields
-    extend Deprecation
-    self.deprecation_horizon = 'blacklight 6.0'
 
     # Set up Blacklight::Configuration.default_values to contain
     # the basic, required Blacklight fields
@@ -31,20 +30,10 @@ module Blacklight
           # HTTP method to use when making requests to solr; valid
           # values are :get and :post.
           http_method: :get,
-          # The solr request handler ('qt') to use for search requests
-          qt: 'search',
           # The path to send requests to solr.
           solr_path: 'select',
           # Default values of parameters to send with every search request
           default_solr_params: {},
-          ## deprecated; use add_facet_field :include_in_request instead;
-          # if this is configured true, all facets will be included in the solr request
-          # unless explicitly disabled.
-          add_facet_fields_to_solr_request: false, 
-          ## deprecated; use add_index_field :include_in_request instead;
-          # if this is configured true, all show and index will be included in the solr request
-          # unless explicitly disabled.
-          add_field_configuration_to_solr_request: false,
           ##
           # === Single document request configuration
           ##
@@ -60,7 +49,7 @@ module Blacklight
             #fl: '*',
             ## this is a fancy way to say "find the document by id using
             ## the value in the id query parameter"
-            #q: "{!raw f=#{unique_key} v=$id}",
+            #q: "{!term f=#{unique_key} v=$id}",
             ## disable features we don't need
             #facet: false,
             #rows: 1
@@ -140,7 +129,6 @@ module Blacklight
           per_page: [10,20,50,100],
           default_per_page: nil,
           # how many searches to save in session history
-          # (TODO: move the value into the configuration?)
           search_history_window: 100,
           default_facet_limit: 10
           }
@@ -188,14 +176,11 @@ module Blacklight
     def document_model
       super || ::SolrDocument
     end
-    alias_method :solr_document_model, :document_model
 
     # only here to support alias_method
     def document_model= *args
       super
     end
-    alias_method :solr_document_model=, :document_model=
-    deprecation_deprecate solr_document_model: :document_model, :solr_document_model= => :document_model=
 
     def document_presenter_class
       super || Blacklight::DocumentPresenter
@@ -204,13 +189,10 @@ module Blacklight
     def response_model
       super || Blacklight::Solr::Response
     end
-    alias_method :solr_response_model, :response_model
-    # only here to support alias_method
+
     def response_model= *args
       super
     end
-    alias_method :solr_response_model=, :response_model=
-    deprecation_deprecate solr_response_model: :response_model, :solr_response_model= => :response_model=
 
     def repository_class
       super || Blacklight::Solr::Repository
@@ -320,40 +302,21 @@ module Blacklight
       end
     end
 
-    ##
-    # Deprecated. Get the list of facet fields to explicitly
-    # add to the solr request
-    def facet_fields_to_add_to_solr
-      facet_fields.select { |k,v| v.include_in_request }
-                  .reject { |k,v| v[:query] || v[:pivot] }
-                  .map { |k,v| v.field }
-    end
-    deprecation_deprecate :facet_fields_to_add_to_solr
-
     ##
     # Provide a 'deep copy' of Blacklight::Configuration that can be modifyed without affecting
     # the original Blacklight::Configuration instance.
     #
-    # The Rails 3.x version only copies hashes, and ignores arrays and similar structures
-    if ::Rails.version < "4.0"
-      def deep_copy
-        Marshal.load(Marshal.dump(self))
-      end
-      alias_method :inheritable_copy, :deep_copy
-    else
-      ##
-      # Rails 4.x provides `#deep_dup`, but it aggressively `#dup`'s class names
-      # too. These model names should not be `#dup`'ed or we might break ActiveModel::Naming.
-      def deep_copy
-        deep_dup.tap do |copy|
-          %w(repository_class response_model document_model document_presenter_class search_builder_class facet_paginator_class).each do |klass|
-            # Don't copy if nil, so as not to prematurely autoload default classes
-            copy.send("#{klass}=", send(klass)) unless fetch(klass.to_sym, nil).nil?
-          end
+    # Rails 4.x provides `#deep_dup`, but it aggressively `#dup`'s class names
+    # too. These model names should not be `#dup`'ed or we might break ActiveModel::Naming.
+    def deep_copy
+      deep_dup.tap do |copy|
+        %w(repository_class response_model document_model document_presenter_class search_builder_class facet_paginator_class).each do |klass|
+          # Don't copy if nil, so as not to prematurely autoload default classes
+          copy.send("#{klass}=", send(klass)) unless fetch(klass.to_sym, nil).nil?
         end
       end
-      alias_method :inheritable_copy, :deep_copy
     end
+    alias_method :inheritable_copy, :deep_copy
 
     ##
     # Get a view configuration for the given view type

data/app/models/blacklight/configuration/context.rb

@@ -0,0 +1,47 @@
+module Blacklight
+  class Configuration
+    class Context
+      attr_reader :context
+
+      def initialize(context)
+        @context = context
+      end
+
+      ##
+      # Evaluate conditionals for a configuration with if/unless attributes
+      #
+      # @param displayable_config [#if,#unless] an object that responds to if/unless
+      # @return [Boolean]
+      def evaluate_if_unless_configuration(config, *args)
+        return config if config === true or config === false
+
+        if_value = !config.respond_to?(:if) ||
+                        config.if.nil? ||
+                        evaluate_configuration_conditional(config.if, config, *args)
+
+        unless_value = !config.respond_to?(:unless) ||
+                          config.unless.nil? ||
+                          !evaluate_configuration_conditional(config.unless, config, *args)
+
+        if_value && unless_value
+      end
+
+      def evaluate_configuration_conditional(proc_helper_or_boolean, *args_for_procs_and_methods)
+        case proc_helper_or_boolean
+        when Symbol
+          arity = context.method(proc_helper_or_boolean).arity
+
+          if arity == 0
+            context.send(proc_helper_or_boolean)
+          else
+            context.send(proc_helper_or_boolean, *args_for_procs_and_methods)
+          end
+        when Proc
+          proc_helper_or_boolean.call context, *args_for_procs_and_methods
+        else
+          proc_helper_or_boolean
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,7 @@ module Blacklight
       self.collapse = true if self.collapse.nil?
       self.show = true if self.show.nil?
       self.if = self.show if self.if.nil?
+      self.index_range = 'A'..'Z' if self.index_range == true
 
       super
       

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

@@ -4,8 +4,6 @@ module Blacklight
     # solr fields configuration
     module Fields
       extend ActiveSupport::Concern
-      extend Deprecation
-      self.deprecation_horizon = "blacklight 6.0"
 
       module ClassMethods
 
@@ -118,14 +116,12 @@ module Blacklight
 
         raise "A #{config_key} with the key #{field_config.key} already exists." if self[config_key.pluralize][field_config.key].present?
 
-        self[config_key.pluralize][ field_config.key ] = field_config            
+        self[config_key.pluralize][ field_config.key ] = field_config
       end
-      alias_method :add_solr_field, :add_blacklight_field
-      deprecation_deprecate add_solr_field: :add_blacklight_field
 
       protected
       def luke_fields
-        if @table[:luke_fields] == false
+        if @table[:luke_fields] === false
           return nil
         end
 

data/app/models/blacklight/configuration/view_config.rb

@@ -0,0 +1,9 @@
+class Blacklight::Configuration
+  class ViewConfig < Blacklight::OpenStructWithHashAccess
+    class Show < ViewConfig
+    end
+
+    class Index < ViewConfig
+    end
+  end
+end

data/app/models/blacklight/facet_paginator.rb

@@ -9,24 +9,16 @@ module Blacklight
   # so we cannot know how many "pages" there are.
   #
   class FacetPaginator
-    extend Deprecation
-
-    self.deprecation_horizon = 'blacklight version 6.0.0'
-    
     # What request keys will we use for the parameters need. Need to
     # make sure they do NOT conflict with catalog/index request params,
     # and need to make them accessible in a list so we can easily
     # strip em out before redirecting to catalog/index.
     mattr_accessor :request_keys do
-      { sort: :'facet.sort', page: :'facet.page' }
+      { sort: :'facet.sort', page: :'facet.page', prefix: :'facet.prefix' }
     end
 
-    if Rails.version < "4.1"
-      self.request_keys = { sort: :'facet.sort', page: :'facet.page' }
-    end
+    attr_reader :offset, :limit, :sort, :prefix
 
-    attr_reader :offset, :limit, :sort
-    
     # all_facet_values is a list of facet value objects returned by solr,
     # asking solr for n+1 facet values.
     # options:
@@ -34,11 +26,12 @@ module Blacklight
     #            display all with no previous or next. 
     # :offset => current item offset, default 0
     # :sort => 'count' or 'index', solr tokens for facet value sorting, default 'count'. 
-    def initialize(all_facet_values, arguments)
+    def initialize(all_facet_values, arguments = {})
       # to_s.to_i will conveniently default to 0 if nil
-      @offset = arguments[:offset].to_s.to_i
+      @offset = arguments[:offset].to_s.to_i 
       @limit = arguments[:limit]
       @sort = arguments[:sort]
+      @prefix = arguments[:prefix]
 
       @all = all_facet_values
     end
@@ -57,8 +50,7 @@ module Blacklight
     end
 
     def current_page
-      # A nil limit is unlimited, thus only one page.
-      if limit.nil? || limit == 0 #check for divide by zero
+      if limit == 0 #check for divide by zero
         1
       else
         @offset / limit + 1
@@ -68,18 +60,6 @@ module Blacklight
     def next_page
       current_page + 1 unless last_page?
     end
-   
-    #@deprecated
-    def has_next?
-      !last_page?
-    end
-    deprecation_deprecate :has_next? => "use #!last_page?"
-
-    #@deprecated
-    def has_previous?
-      !first_page?
-    end
-    deprecation_deprecate :has_next? => "use #!first_page?"
 
     def last_page?
       limit.nil? || total_count <= limit
@@ -101,10 +81,16 @@ module Blacklight
     # under facet.sort ), and your current request params.
     # Get back params suitable to passing to an ActionHelper method for
     # creating a url, to resort by that method.
-    def params_for_resort_url(sort_method, params)
+    def params_for_resort_url(sort_method, params = {})
       # When resorting, we've got to reset the offset to start at beginning,
       # no way to make it make sense otherwise.
-      params.merge(request_keys[:sort] => sort_method, request_keys[:page] => nil)
+      resort_params = params.merge(request_keys[:sort] => sort_method, request_keys[:page] => nil)
+
+      if sort_method == 'count'
+        resort_params.except!(request_keys[:prefix])
+      end
+
+      resort_params
     end
 
     def as_json(_ = nil)

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

@@ -1,27 +1,29 @@
 module Blacklight
-  ##
-  # Blacklight's SearchBuilder converts blacklight request parameters into
-  # 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
-    self.deprecation_horizon = "blacklight 6.0"
-
     class_attribute :default_processor_chain
     self.default_processor_chain = []
 
     attr_reader :processor_chain, :blacklight_params
 
-    # @param [List<Symbol>,TrueClass] processor_chain a list of filter methods to run or true, to use the default methods
+    # @param [List<Symbol>,TrueClass] options a list of filter methods to run or true, to use the default methods
     # @param [Object] scope the scope where the filter methods reside in.
-    def initialize(processor_chain, scope)
-      @processor_chain = if processor_chain == true
-        default_processor_chain.dup
+    def initialize(*options)
+      @scope = case options.size
+      when 1
+        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
       else
-        processor_chain
+        raise ArgumentError, "wrong number of arguments. (#{options.size} for 1..2)"
       end
 
-      @scope = scope
+      @processor_chain ||= default_processor_chain.dup
       @blacklight_params = {}
       @merged_params = {}
       @reverse_merged_params = {}
@@ -106,12 +108,7 @@ module Blacklight
     # a solr query method
     # @param [Hash,HashWithIndifferentAccess] extra_controller_params (nil) extra parameters to add to the search
     # @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")
-        merge(method_extra_params)
-      end
-
+    def to_hash
       if params_need_update?
         @params = processed_parameters.
                     reverse_merge(@reverse_merged_params).
@@ -143,12 +140,7 @@ module Blacklight
     def processed_parameters
       request.tap do |request_parameters|
         processor_chain.each do |method_name|
-          if scope.respond_to?(method_name, true)
-            Deprecation.warn Blacklight::SearchBuilder, "Building search parameters by calling #{method_name} on #{scope.class}. This behavior will be deprecated in Blacklight 6.0. Instead, define #{method_name} on a subclass of #{self.class} and set search_builder_class in the configuration"
-            scope.send(method_name, request_parameters, blacklight_params)
-          else
-            send(method_name, request_parameters)
-          end
+          send(method_name, request_parameters)
         end
       end
     end

data/app/models/blacklight/solr/facet_paginator.rb

@@ -17,11 +17,15 @@ module Blacklight::Solr
     #            display all with no previous or next. 
     # :offset => current item offset, default 0
     # :sort => 'count' or 'index', solr tokens for facet value sorting, default 'count'. 
-    def initialize(all_facet_values, arguments)
+    def initialize(all_facet_values, arguments = {})
       super
 
       # count is solr's default
-      @sort ||= 'count'
+      @sort ||= if @limit.to_i > 0
+                  'count'
+                else
+                  'index'
+                end
     end
   end
 end