blacklight 6.5.0 → 6.6.0

data/lib/blacklight/configuration/context.rb

@@ -11,10 +11,10 @@ module Blacklight
       ##
       # Evaluate conditionals for a configuration with if/unless attributes
       #
-      # @param displayable_config [#if,#unless] an object that responds to if/unless
+      # @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 or config == false
 
         if_value = !config.respond_to?(:if) ||
                         config.if.nil? ||
@@ -32,7 +32,7 @@ module Blacklight
         when Symbol
           arity = context.method(proc_helper_or_boolean).arity
 
-          if arity == 0
+          if arity.zero?
             context.send(proc_helper_or_boolean)
           else
             context.send(proc_helper_or_boolean, *args_for_procs_and_methods)

data/lib/blacklight/configuration/fields.rb

@@ -7,7 +7,6 @@ module Blacklight
       extend ActiveSupport::Concern
 
       module ClassMethods
-
         # Add a configuration block for a collection of solr fields
         def define_field_access(key, options = {})
           key = key.to_s if respond_to? :to_s
@@ -39,12 +38,20 @@ module Blacklight
       #
       # * a field name and block format:
       #
+      # @overload add_blacklight_field(config_key, field_key)
+      #   @param [Symbol] config_key
+      #   @param [Symbol,String] field_key
+      #
+      #
       #     add_blacklight_field :index_field, 'format' do |field|
       #       field.label = 'Format'
       #     end
       #
       # * a plain block:
       #
+      # @overload add_blacklight_field(config_key)
+      #   @param [Symbol] config_key
+      #
       #     add_blacklight_field :index_field do |field|
       #       field.field = 'format'
       #       field.label = 'Format'
@@ -52,20 +59,28 @@ module Blacklight
       # 
       # * a configuration hash:
       #
+      # @overload add_blacklight_field(config_key, options)
+      #   @param [Symbol] config_key
+      #   @param [Hash] options
+      #
       #     add_blacklight_field :index_field, :field => 'format', :label => 'Format'
       #   
       # * a Field instance: 
       #
+      # @overload add_blacklight_field(config_key, field)
+      #   @param [Symbol] config_key
+      #   @param [Blacklight::Configuration::Field] field
+      #
+      #
       #     add_blacklight_field :index_field, IndexField.new(:field => 'format', :label => 'Format')
       #
       # * an array of hashes: 
       #
-      #     add_blacklight_field :index_field, [{:field => 'format', :label => 'Format'}, IndexField.new(:field => 'date', :label => 'Date')]
-      #
+      # @overload add_blacklight_field(config_key, fields)
+      #   @param [Symbol] config_key
+      #   @param [Array<Blacklight::Configuration::Field, Hash>] fields
       #
-      # @param String config_key 
-      # @param Array *args 
-      # @para
+      #     add_blacklight_field :index_field, [{ :field => 'format', :label => 'Format' }, IndexField.new(:field => 'date', :label => 'Date')]
       #
       def add_blacklight_field config_key, *args, &block
         field_config = case args.first
@@ -121,8 +136,9 @@ module Blacklight
       end
 
       protected
+
       def luke_fields
-        if @table[:luke_fields] === false
+        if @table[:luke_fields] == false
           return nil
         end
 
@@ -179,6 +195,7 @@ module Blacklight
       end
 
       private
+
       # convert a config key to the appropriate Field class
       def field_class_from_key key
         "Blacklight::Configuration::#{key.camelcase}".constantize

data/lib/blacklight/exceptions.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 module Blacklight
   module Exceptions
-
     class AccessDenied < StandardError
     end
 
@@ -21,6 +20,5 @@ module Blacklight
     end
 
     class ECONNREFUSED < ::Errno::ECONNREFUSED; end
-
   end
 end

data/lib/blacklight/parameters.rb

@@ -4,7 +4,7 @@ module Blacklight
     ##
     # Sanitize the search parameters by removing unnecessary parameters
     # from the provided parameters.
-    # @param [Hash] source_params parameters
+    # @param [Hash] params parameters
     def self.sanitize params
       params.reject { |k,v| v.nil? }
             .except(:action, :controller, :id, :commit, :utf8)

data/lib/blacklight/search_builder.rb

@@ -11,14 +11,18 @@ module Blacklight
 
     attr_reader :processor_chain, :blacklight_params
 
-    # @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.
+    
+    # @overload initialize(scope)
+    #   @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.
     def initialize(*options)
       @scope = case options.size
       when 1
         options.first
       when 2
-        if options.first === true
+        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
@@ -36,7 +40,7 @@ module Blacklight
 
     ##
     # Set the parameters to pass through the processor chain
-    def with blacklight_params = {}
+    def with(blacklight_params = {})
       params_will_change!
       @blacklight_params = blacklight_params.dup
       self
@@ -44,7 +48,7 @@ module Blacklight
 
     ##
     # Update the :q (query) parameter
-    def where conditions
+    def where(conditions)
       params_will_change!
       @blacklight_params[:q] = conditions
       self
@@ -52,55 +56,53 @@ module Blacklight
 
     ##
     # Append additional processor chain directives
-    def append *addl_processor_chain
+    def append(*addl_processor_chain)
       params_will_change!
       builder = self.class.new(processor_chain + addl_processor_chain, scope)
           .with(blacklight_params)
           .merge(@merged_params)
           .reverse_merge(@reverse_merged_params)
 
-      builder.start(@start) if @start
-      builder.rows(@rows) if @rows
-      builder.page(@page) if @page
-      builder.facet(@facet) if @facet
-
+      builder.start = @start if @start
+      builder.rows  = @rows if @rows
+      builder.page  = @page if @page
+      builder.facet = @facet if @facet
       builder
     end
 
     ##
     # Converse to append, remove processor chain directives,
     # returning a new builder that's a copy of receiver with
-    # specified change. 
+    # specified change.
     #
     # Methods in argument that aren't currently in processor
-    # chain are ignored as no-ops, rather than raising. 
-    def except *except_processor_chain
+    # chain are ignored as no-ops, rather than raising.
+    def except(*except_processor_chain)
       builder = self.class.new(processor_chain - except_processor_chain, scope)
           .with(blacklight_params)
           .merge(@merged_params)
           .reverse_merge(@reverse_merged_params)
 
-      builder.start(@start) if @start
-      builder.rows(@rows) if @rows
-      builder.page(@page) if @page
-      builder.facet(@facet) if @facet
-
+      builder.start = @start if @start
+      builder.rows  = @rows if @rows
+      builder.page  = @page if @page
+      builder.facet = @facet if @facet
       builder
     end
 
     ##
     # Merge additional, repository-specific parameters
-    def merge extra_params, &block
+    def merge(extra_params, &block)
       if extra_params
         params_will_change!
         @merged_params.merge!(extra_params.to_hash, &block)
       end
       self
     end
-    
+
     ##
     # "Reverse merge" additional, repository-specific parameters
-    def reverse_merge extra_params, &block
+    def reverse_merge(extra_params, &block)
       if extra_params
         params_will_change!
         @reverse_merged_params.reverse_merge!(extra_params.to_hash, &block)
@@ -111,23 +113,18 @@ module Blacklight
     delegate :[], :key?, to: :to_hash
 
     # a solr query method
-    # @param [Hash] extra_controller_params (nil) extra parameters to add to the search
     # @return [Blacklight::Solr::Response] the solr response object
     def to_hash
-      if params_need_update?
-        @params = processed_parameters.
-                    reverse_merge(@reverse_merged_params).
-                    merge(@merged_params).
-                    tap { self.clear_changes }
-      else
-        @params
-      end
+      return @params unless params_need_update?
+      @params = processed_parameters.
+                  reverse_merge(@reverse_merged_params).
+                  merge(@merged_params).
+                  tap { self.clear_changes }
     end
 
     alias_method :query, :to_hash
     alias_method :to_h, :to_hash
 
-    # @returns a params hash for searching solr.
     # The CatalogController #index action uses this.
     # Solr parameters can come from a number of places. From lowest
     # precedence to highest:
@@ -142,6 +139,8 @@ module Blacklight
     # specified otherwise.
     #
     # Incoming parameter :f is mapped to :fq solr parameter.
+    #
+    # @return a params hash for searching solr.
     def processed_parameters
       request.tap do |request_parameters|
         processor_chain.each do |method_name|
@@ -150,80 +149,90 @@ module Blacklight
       end
     end
 
-    def blacklight_config
-      scope.blacklight_config
-    end
+    delegate :blacklight_config, to: :scope
 
-    def start start = nil
-      if start
-        params_will_change!
-        @start = start.to_i
-        self
-      else
-        @start ||= (page - 1) * (rows || 10)
+    def start=(value)
+      params_will_change!
+      @start = value.to_i
+    end
 
-        val = @start || 0
-        val = 0 if @start < 0
-        val
+    # @param [#to_i] value
+    def start(value = nil)
+      if value
+        self.start = value
+        return self
       end
+      @start ||= (page - 1) * (rows || 10)
+      val = @start || 0
+      val = 0 if @start < 0
+      val
     end
     alias_method :padding, :start
 
-    def page page = nil
-      if page
-        params_will_change!
-        @page = page.to_i
-        @page = 1 if @page < 1
-        self
-      else
-        @page ||= begin
-          page = if blacklight_params[:page].blank?
-            1
-          else
-            blacklight_params[:page].to_i
-          end
-
-          page
-        end
-      end
+    def page=(value)
+      params_will_change!
+      @page = value.to_i
+      @page = 1 if @page < 1
     end
 
-    def rows rows = nil
-      if rows
-        params_will_change!
-        @rows = rows.to_i
-        @rows = blacklight_config.max_per_page if @rows > blacklight_config.max_per_page
-        self
-      else
-        @rows ||= begin
-          rows = blacklight_config.default_per_page
-
-          # user-provided parameters should override any default row
-          rows = blacklight_params[:rows].to_i unless blacklight_params[:rows].blank?
-          rows = blacklight_params[:per_page].to_i unless blacklight_params[:per_page].blank?
+    # @param [#to_i] value
+    def page(value = nil)
+      if value
+        self.page = value
+        return self
+      end
+      @page ||= blacklight_params[:page].blank? ? 1 : blacklight_params[:page].to_i
+    end
 
-          # ensure we don't excede the max page size
-          rows = blacklight_config.max_per_page if rows.to_i > blacklight_config.max_per_page
+    def rows=(value)
+      params_will_change!
+      @rows = [value, blacklight_config.max_per_page].map(&:to_i).min
+    end
 
-          rows.to_i unless rows.nil?
-        end
+    # @param [#to_i] value
+    def rows(value = nil)
+      if value
+        self.rows = value
+        return self
+      end
+      @rows ||= begin
+        # user-provided parameters should override any default row
+        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
       end
     end
 
     alias per rows
 
+    # sets the facet that this query pertains to, for the purpose of facet pagination
+    def facet=(value)
+      params_will_change!
+      @facet = value
+    end
+
+    # @param [Object] value
+    def facet(value = nil)
+      if value
+        self.facet = value
+        return self
+      end
+      @facet
+    end
+
     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  
+        # check for sort field key
         blacklight_config.sort_fields[blacklight_params[:sort]]
       end
 
       field = if sort_field.present?
         sort_field.sort
-      else 
+      else
         # just pass the key through
         blacklight_params[:sort]
       end
@@ -231,23 +240,12 @@ module Blacklight
       field unless field.blank?
     end
 
-    # sets the facet that this query pertains to, if it is for the purpose of
-    # facet pagination
-    def facet(facet = nil)
-      if facet
-        params_will_change!
-        @facet = facet
-        self
-      else
-        @facet
-      end
-    end
-
     def search_field
       blacklight_config.search_fields[blacklight_params[:search_field]]
     end
 
     protected
+
     def request
       Blacklight::Solr::Request.new
     end
@@ -256,9 +254,7 @@ module Blacklight
       field.include_in_request || (field.include_in_request.nil? && blacklight_config.add_field_configuration_to_solr_request)
     end
 
-    def scope
-      @scope
-    end
+    attr_reader :scope
 
     def params_will_change!
       @dirty = true

data/lib/blacklight/search_state.rb

@@ -3,10 +3,11 @@ module Blacklight
   # This class encapsulates the search state as represented by the query
   # parameters namely: :f, :q, :page, :per_page and, :sort
   class SearchState
-    include Blacklight::Facet
     attr_reader :blacklight_config # Must be called blacklight_config, because Blacklight::Facet calls blacklight_config.
     attr_reader :params
 
+    delegate :facet_configuration_for_field, to: :blacklight_config
+
     # @param [ActionController::Parameters] params
     # @param [Blacklight::Config] blacklight_config
     def initialize(params, blacklight_config)