blacklight 9.0.0 → 9.1.0

data/lib/blacklight/search_builder.rb

@@ -9,14 +9,14 @@ module Blacklight
     class_attribute :default_processor_chain
     self.default_processor_chain = []
 
-    attr_reader :processor_chain, :search_state, :blacklight_params
+    attr_reader :processor_chain, :blacklight_config
 
     # @overload initialize(scope)
     #   @param [Object] 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 the scope where the filter methods reside in.
-    def initialize(*options)
+    def initialize(*options, blacklight_config: nil)
       case options.size
       when 1
         @processor_chain = default_processor_chain.dup
@@ -27,20 +27,29 @@ module Blacklight
         raise ArgumentError, "wrong number of arguments. (#{options.size} for 1..2)"
       end
 
-      @blacklight_params = {}
-      search_state_class = @scope.try(:search_state_class) || Blacklight::SearchState
-      @search_state = search_state_class.new(@blacklight_params, @scope&.blacklight_config, @scope)
+      @blacklight_config = blacklight_config || @scope&.blacklight_config
       @additional_filters = {}
       @merged_params = {}
       @reverse_merged_params = {}
     end
 
+    def search_state
+      @search_state ||= begin
+        search_state_class = @scope.try(:search_state_class) || Blacklight::SearchState
+        @search_state = search_state_class.new({}, blacklight_config, @scope)
+      end
+    end
+
+    def blacklight_params
+      search_state.params
+    end
+    Blacklight.deprecation.deprecate_methods(self, blacklight_params: 'Use search_state.params instead of blacklight_params directly')
+
     ##
     # Set the parameters to pass through the processor chain
     def with(blacklight_params_or_search_state = {})
       params_will_change!
-      @search_state = blacklight_params_or_search_state.is_a?(Blacklight::SearchState) ? blacklight_params_or_search_state : @search_state.reset(blacklight_params_or_search_state)
-      @blacklight_params = @search_state.params.dup
+      @search_state = blacklight_params_or_search_state.is_a?(Blacklight::SearchState) ? blacklight_params_or_search_state : search_state.reset(blacklight_params_or_search_state)
       self
     end
 
@@ -51,8 +60,7 @@ module Blacklight
     #    search_builder.where(id: [1,2,3]) # produces: q:"{!lucene}id:(1 OR 2 OR 3)"
     def where(conditions)
       params_will_change!
-      @search_state = @search_state.reset(@search_state.params.merge(q: conditions))
-      @blacklight_params = @search_state.params
+      @search_state = search_state.reset(search_state.params.merge(q: conditions))
       @additional_filters = conditions
       self
     end
@@ -127,8 +135,8 @@ module Blacklight
                 .tap { clear_changes }
     end
 
-    alias_method :query, :to_hash
-    alias_method :to_h, :to_hash
+    alias query to_hash
+    alias to_h to_hash
 
     # The CatalogController #index action uses this.
     # Solr parameters can come from a number of places. From lowest
@@ -154,16 +162,43 @@ module Blacklight
       end
     end
 
-    delegate :blacklight_config, to: :scope
+    def default_document_pagination_params
+      { fl: blacklight_config.document_model.unique_key }
+    end
+
+    def for_previous_and_next_documents(index, window = 1)
+      document_pagination_params = blacklight_config.document_pagination_params.dup
+
+      if document_pagination_params.empty?
+        merge(default_document_pagination_params)
+      else
+        merge(document_pagination_params)
+      end
+
+      if index > 0
+        self.start = [index - window, 0].max
+        self.rows = (2 * window) + 1
+      else
+        self.start = 0
+        self.rows = 2 * window
+      end
+
+      self
+    end
+
+    # An undefined value that can be used to detect if a parameter was passed in or not, since nil and false may be valid values for some parameters.
+    UNDEFINED = Object.new.freeze
 
     def start=(value)
+      return if value.nil?
+
       params_will_change!
       @start = value.to_i
     end
 
     # @param [#to_i] value
-    def start(value = nil)
-      if value
+    def start(value = Blacklight::SearchBuilder::UNDEFINED)
+      if value != Blacklight::SearchBuilder::UNDEFINED
         self.start = value
         return self
       end
@@ -172,17 +207,19 @@ module Blacklight
       val = 0 if @start < 0
       val
     end
-    alias_method :padding, :start
+    alias padding start
 
     def page=(value)
+      return if value.nil?
+
       params_will_change!
       @page = value.to_i
       @page = 1 if @page < 1
     end
 
     # @param [#to_i] value
-    def page(value = nil)
-      if value
+    def page(value = Blacklight::SearchBuilder::UNDEFINED)
+      if value != Blacklight::SearchBuilder::UNDEFINED
         self.page = value
         return self
       end
@@ -190,13 +227,15 @@ module Blacklight
     end
 
     def rows=(value)
+      return if value.nil?
+
       params_will_change!
       @rows = [value, blacklight_config.max_per_page].map(&:to_i).min
     end
 
     # @param [#to_i] value
-    def rows(value = nil)
-      if value
+    def rows(value = Blacklight::SearchBuilder::UNDEFINED)
+      if value != Blacklight::SearchBuilder::UNDEFINED
         self.rows = value
         return self
       end

data/lib/blacklight/search_state.rb

@@ -37,6 +37,10 @@ module Blacklight
       params[:q]
     end
 
+    def query_boolean_operator
+      params[:op]
+    end
+
     def clause_params
       params[:clause] || {}
     end

data/lib/blacklight/solr/request.rb

@@ -2,7 +2,7 @@
 
 class Blacklight::Solr::InvalidParameter < ArgumentError; end
 
-class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess
+class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess # rubocop:disable Style/OneClassPerFile
   def initialize(constructor = {})
     if constructor.is_a?(Hash)
       super()
@@ -52,6 +52,13 @@ class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess
     self['fq'] << query
   end
 
+  # Filter the results to a specific set of values in the given field.
+  # @param [String] field
+  # @param [Array<String>] values
+  def append_ids_filter(field, values)
+    append_filter_query("{!terms f=#{field}}#{Array(values).join(',')}")
+  end
+
   def append_facet_fields(values)
     self['facet.field'] ||= []
     self['facet.field'] += Array(values)

data/lib/blacklight/solr/response/group_response.rb

@@ -11,7 +11,7 @@ class Blacklight::Solr::Response::GroupResponse
     @response = response
   end
 
-  alias_method :group_field, :key
+  alias group_field key
 
   def groups
     @groups ||= group["groups"].map do |g|

data/lib/blacklight/solr/response/spelling.rb

@@ -53,14 +53,14 @@ module Blacklight::Solr::Response::Spelling
               #   suggestion =>  [{ frequency =>, word => }] # for extended results
               #   suggestion => ['word'] # for non-extended results
               orig_freq = term_info['origFreq']
-              if term_info['suggestion'].first.is_a?(Hash)
-                word_suggestions << term_info['suggestion'].map do |suggestion|
-                  suggestion['word'] if suggestion['freq'] > orig_freq
-                end
-              else
-                # only extended suggestions have frequency so we just return all suggestions
-                word_suggestions << term_info['suggestion']
-              end
+              word_suggestions << if term_info['suggestion'].first.is_a?(Hash)
+                                    term_info['suggestion'].map do |suggestion|
+                                      suggestion['word'] if suggestion['freq'] > orig_freq
+                                    end
+                                  else
+                                    # only extended suggestions have frequency so we just return all suggestions
+                                    term_info['suggestion']
+                                  end
             end
           end
         end

data/lib/blacklight/solr/response.rb

@@ -18,7 +18,7 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
   def initialize(data, request_params, options = {})
     @search_builder = request_params if request_params.is_a?(Blacklight::SearchBuilder)
 
-    super(force_to_utf8(ActiveSupport::HashWithIndifferentAccess.new(data)))
+    super(ActiveSupport::HashWithIndifferentAccess.new(data))
     @request_params = ActiveSupport::HashWithIndifferentAccess.new(request_params)
     self.blacklight_config = options[:blacklight_config]
     self.options = options
@@ -31,7 +31,7 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
   def documents
     @documents ||= (response['docs'] || []).collect { |doc| document_factory.build(doc, self, options) }
   end
-  alias_method :docs, :documents
+  alias docs documents
 
   def grouped
     @groups ||= self["grouped"].map do |field, group|
@@ -61,23 +61,4 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
   def export_formats
     documents.map { |x| x.export_formats.keys }.flatten.uniq
   end
-
-  private
-
-  def force_to_utf8(value)
-    case value
-    when Hash
-      value.each { |k, v| value[k] = force_to_utf8(v) }
-    when Array
-      value.each { |v| force_to_utf8(v) }
-    when String
-      if value.encoding == Encoding::UTF_8
-        value
-      else
-        Blacklight.logger&.warn "Found a non utf-8 value in Blacklight::Solr::Response. \"#{value}\" Encoding is #{value.encoding}"
-        value.dup.force_encoding('UTF-8')
-      end
-    end
-    value
-  end
 end

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -102,7 +102,7 @@ module Blacklight::Solr
 
     # Transform "clause" parameters into the Solr JSON Query DSL
     def add_adv_search_clauses(solr_parameters)
-      return if search_state.clause_params.blank?
+      return if search_state.clause_params.blank? || search_state.clause_params.all? { |_k, v| v[:query].blank? }
 
       # We need to specify lucene as the top-level defType when using JSON Query DSL in Solr versions
       # between 7.2.0 & 9.4.0. After 9.4.0 this is no longer necessary, but also not harmful to include.
@@ -112,7 +112,7 @@ module Blacklight::Solr
       solr_parameters[:spellcheck] = 'false'
 
       defaults = { must: [], must_not: [], should: [] }
-      default_op = blacklight_params[:op]&.to_sym || :must
+      default_op = search_state.query_boolean_operator&.to_sym || :must
       solr_parameters[:mm] = 1 if default_op == :should && search_state.clause_params.values.any? { |clause| }
 
       search_state.clause_params.each_value do |clause|
@@ -200,7 +200,7 @@ module Blacklight::Solr
         if facet.pivot
           solr_parameters.append_facet_pivot with_ex_local_param(facet.ex, facet.pivot.join(","))
         elsif facet.query
-          solr_parameters.append_facet_query facet.query.values.map { |x| with_ex_local_param(facet.ex, x[:fq]) }
+          solr_parameters.append_facet_query(facet.query.values.map { |x| with_ex_local_param(facet.ex, x[:fq]) })
         else
           solr_parameters.append_facet_fields with_ex_local_param(facet.ex, facet.field)
         end
@@ -367,12 +367,6 @@ module Blacklight::Solr
       end
     end
 
-    def search_state
-      return super if defined?(super)
-
-      @search_state ||= Blacklight::SearchState.new(blacklight_params, blacklight_config)
-    end
-
     def add_search_field_query_builder_params(solr_parameters)
       q, additional_parameters = search_field.query_builder.call(self, search_field, solr_parameters)
 

data/lib/blacklight.rb

@@ -85,7 +85,7 @@ module Blacklight
                         else
                           YAML.safe_load(blacklight_erb, [], [], true)
                         end
-    rescue => e
+    rescue StandardError => e
       raise("#{blacklight_config_file} was found, but could not be parsed.\n#{e.inspect}")
     end
 
@@ -122,6 +122,6 @@ module Blacklight
   end
 
   def self.deprecation
-    @deprecation ||= ActiveSupport::Deprecation.new('9.0', 'Blacklight')
+    @deprecation ||= ActiveSupport::Deprecation.new('10.0', 'Blacklight')
   end
 end

data/lib/generators/blacklight/assets/importmap_generator.rb

@@ -8,7 +8,7 @@ module Blacklight
       def import_javascript_assets
         append_to_file 'config/importmap.rb' do
           <<~CONTENT
-            pin "@github/auto-complete-element", to: "https://cdn.skypack.dev/@github/auto-complete-element"
+            pin "@github/auto-complete-element", to: "https://cdn.jsdelivr.net/npm/@github/auto-complete-element@3.8.0/+esm"
             pin "@popperjs/core", to: "https://ga.jspm.io/npm:@popperjs/core@2.11.6/dist/umd/popper.min.js"
             pin "bootstrap", to: "https://ga.jspm.io/npm:bootstrap@#{(defined?(Bootstrap) && Bootstrap::VERSION) || '5.3.5'}/dist/js/bootstrap.js"
           CONTENT
@@ -49,7 +49,7 @@ module Blacklight
         else
           append_to_file 'app/assets/stylesheets/application.css' do
             <<~CONTENT
-              @import url(https://cdn.jsdelivr.net/npm/bootstrap@5.3.5/dist/css/bootstrap.min.css);
+              @import url(https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/css/bootstrap.min.css);
               @import url("blacklight.css");
             CONTENT
           end

data/lib/generators/blacklight/assets_generator.rb

@@ -2,7 +2,7 @@
 
 module Blacklight
   class AssetsGenerator < Rails::Generators::Base
-    class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '5.3.5'), desc: "Set the generated app's bootstrap version"
+    class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '5.3.8'), desc: "Set the generated app's bootstrap version"
 
     def run_asset_pipeline_specific_generator
       generated_options = "--bootstrap-version='#{options[:'bootstrap-version']}'" if options[:'bootstrap-version']

data/lib/generators/blacklight/controller_generator.rb

@@ -2,7 +2,7 @@
 
 module Blacklight
   class ControllerGenerator < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     argument :controller_name, type: :string, default: "catalog"
 

data/lib/generators/blacklight/document_generator.rb

@@ -6,7 +6,7 @@ module Blacklight
   class DocumentGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     argument :model_name, type: :string, default: "solr_document"
 

data/lib/generators/blacklight/install_generator.rb

@@ -2,7 +2,7 @@
 
 module Blacklight
   class Install < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     argument     :model_name, type: :string, default: "user"
     argument     :controller_name, type: :string, default: "catalog"
@@ -10,6 +10,7 @@ module Blacklight
     argument     :search_builder_name, type: :string, default: "search_builder"
 
     class_option :devise, type: :boolean, default: false, aliases: "-d", desc: "Use Devise as authentication logic."
+    class_option :authentication, type: :boolean, default: false, desc: "Use Rails' built-in authentication generator."
     class_option :marc, type: :boolean, default: false, aliases: "-m", desc: "Generate MARC-based demo."
     class_option :'bootstrap-version', type: :string, default: nil, desc: "Set the generated app's bootstrap version"
     class_option :'skip-assets', type: :boolean, default: false, desc: "Skip generating javascript and css assets into the application"
@@ -62,9 +63,10 @@ module Blacklight
 
     def generate_blacklight_user
       generator_args = [model_name]
-      if options[:devise]
-        generator_args << "--devise #{options[:devise]}"
-      end
+      raise Thor::Error, "Choose either --devise or --authentication, not both." if options[:devise] && options[:authentication]
+
+      generator_args << "--devise" if options[:devise]
+      generator_args << "--authentication" if options[:authentication]
 
       generate 'blacklight:user', generator_args.join(" ")
     end

data/lib/generators/blacklight/models_generator.rb

@@ -8,7 +8,7 @@ module Blacklight
   class ModelsGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     desc <<-EOS
     This generator makes the following changes to your application:

data/lib/generators/blacklight/search_builder_generator.rb

@@ -6,7 +6,7 @@ module Blacklight
   class SearchBuilderGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     argument :model_name, type: :string, default: "search_builder"
 

data/lib/generators/blacklight/solr_generator.rb

@@ -4,7 +4,7 @@ require 'rails/generators'
 
 module Blacklight
   class SolrGenerator < Rails::Generators::Base
-    source_root ::File.expand_path('../templates', __FILE__)
+    source_root ::File.expand_path('templates', __dir__)
 
     desc <<-EOF
       This generator makes the following changes to your application:

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -15,6 +15,9 @@ class <%= controller_name.classify %>Controller < ApplicationController
     ## Specify the style of markup to be generated
     # config.bootstrap_version = 5
     #
+    ## Show or hide the light/dark mode theme switcher component
+    # config.dark_mode_support = true
+    #
     ## Class for sending and receiving requests from a search index
     # config.repository_class = Blacklight::Solr::Repository
     #
@@ -36,12 +39,20 @@ class <%= controller_name.classify %>Controller < ApplicationController
     ## Optional fine-tuning for advanced search, e.g., set different limits for
     ## different facets.
     # config.advanced_search.form_solr_parameters = {}
-
+    #
+    ## What type of HTTP request to make to solr. Use `:post' to support requests longer than the URI length limit.
+    ## (default is `:get')
+    # config.http_method = :post
+    #
     ## Default parameters to send to solr for all search-like requests. See also SearchBuilder#processed_parameters
     config.default_solr_params = {
       rows: 10
     }
 
+    # If you add any inputs to the search form, you must specify them so that they are not stripped out as unpermitted.
+    # By default this includes the fields required for basic search and advanced search.
+    # config.search_state_fields += [:search_type]
+
     # solr path which will be added to solr base url before the other solr params.
     #config.solr_path = 'select'
     #config.document_solr_path = 'get'
@@ -164,6 +175,14 @@ class <%= controller_name.classify %>Controller < ApplicationController
 
     # solr fields to be displayed in the show (single result) view
     #   The ordering of the field names is the order of the display
+    #   You can configure some components related to the show field:
+    #     - component: should have a similar API to
+    #       Blacklight::MetadataFieldComponent, and describes how
+    #       the values should be displayed
+    #     - layout_component: should have a similar API to
+    #       Blacklight::MetadataFieldLayoutComponent, and describes
+    #       how the overall layout of the field (both label and
+    #       values) should be displayed
     config.add_show_field 'title_tsim', label: 'Title'
     config.add_show_field 'title_vern_ssim', label: 'Title'
     config.add_show_field 'subtitle_tsim', label: 'Subtitle'