blacklight 6.20.0 → 7.3.0

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? ||

data/lib/blacklight/configuration/facet_field.rb

@@ -1,19 +1,26 @@
 # frozen_string_literal: true
 module Blacklight
   class Configuration::FacetField < Blacklight::Configuration::Field
+    extend Deprecation
+
     def normalize! blacklight_config = nil
-      self.query.stringify_keys! if self.query
+      query.stringify_keys! if query
+
+      self.collapse = true if collapse.nil?
+      self.show = true if show.nil?
+      self.if = show if self.if.nil?
+      self.index_range = 'A'..'Z' if index_range == true
 
-      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
+      if link_to_search
+        Deprecation.warn(Blacklight::Configuration::FacetField, '`link_to_search:` is deprecated, use `link_to_facet:` instead')
+        self.link_to_facet = link_to_search if link_to_facet.nil?
+      end
 
       super
-      
-      if self.single and self.tag.blank? and self.ex.blank?
-        self.tag = "#{self.key}_single"
-        self.ex = "#{self.key}_single"
+
+      if single && tag.blank? && ex.blank?
+        self.tag = "#{key}_single"
+        self.ex = "#{key}_single"
       end
 
       self

data/lib/blacklight/configuration/field.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 module Blacklight
   class Configuration::Field < OpenStructWithHashAccess
-    def normalize! blacklight_config = nil
-      self.field ||= self.key
+    def normalize! _blacklight_config = nil
+      self.field ||= key
       self.key ||= self.field
 
       self.label ||= default_label
@@ -14,11 +14,20 @@ module Blacklight
 
       self
     end
-  
+
     def validate!
       raise ArgumentError, "Must supply a field name" if self.field.nil?
     end
 
+    def display_label(context = nil)
+      field_label(
+        (:"blacklight.search.fields.#{context}.#{key}" if context),
+        :"blacklight.search.fields.#{key}",
+        label,
+        default_label
+      )
+    end
+
     def default_label
       if self.key.respond_to?(:titleize)
         self.key.try(:titleize)
@@ -26,5 +35,25 @@ module Blacklight
         self.key.to_s.titleize
       end
     end
+
+    private
+
+    ##
+    # Look up the label for a solr field.
+    #
+    # @overload label
+    #   @param [Symbol] an i18n key
+    #
+    # @overload label, i18n_key, another_i18n_key, and_another_i18n_key
+    #   @param [String] default label to display if the i18n look up fails
+    #   @param [Symbol] i18n keys to attempt to look up
+    #     before falling  back to the label
+    #   @param [Symbol] any number of additional keys
+    #   @param [Symbol] ...
+    def field_label *i18n_keys
+      first, *rest = i18n_keys.compact
+
+      I18n.t(first, default: rest)
+    end
   end
 end

data/lib/blacklight/configuration/fields.rb

@@ -13,11 +13,11 @@ module Blacklight
         def define_field_access(key, options = {})
           key = key.to_s if respond_to? :to_s
 
-          self.default_values[key.pluralize.to_sym] = ActiveSupport::OrderedHash.new
+          default_values[key.pluralize.to_sym] = ActiveSupport::OrderedHash.new
 
           base_class_name = options.fetch(:class, Field)
 
-          unless self.const_defined? key.camelcase
+          unless const_defined? key.camelcase
             class_eval <<-END_EVAL, __FILE__, __LINE__ + 1
               class #{key.camelcase} < #{base_class_name}; end
             END_EVAL
@@ -86,17 +86,17 @@ module Blacklight
       #
       def add_blacklight_field config_key, *args, &block
         field_config = case args.first
-          when String
-            field_config_from_key_and_hash(config_key, *args)
-          when Symbol
-            args[0] = args[0].to_s
-            field_config_from_key_and_hash(config_key, *args)
-          when Array
-            field_config_from_array(config_key, *args, &block)
-            return # we've iterated over the array above.
-          else
-            field_config_from_field_or_hash(config_key, *args)
-        end
+                         when String
+                           field_config_from_key_and_hash(config_key, *args)
+                         when Symbol
+                           args[0] = args[0].to_s
+                           field_config_from_key_and_hash(config_key, *args)
+                         when Array
+                           field_config_from_array(config_key, *args, &block)
+                           return # we've iterated over the array above.
+                         else
+                           field_config_from_field_or_hash(config_key, *args)
+                       end
 
         if (field_config.field || field_config.key).to_s =~ /\*/
           field_config.match = Regexp.new("^" + (field_config.field || field_config.key).to_s.gsub('*', '.+') + "$")
@@ -117,10 +117,10 @@ 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
 
-      protected
+      private
 
       ##
       # Using reflection into the index, add any fields in the index that match the field_config
@@ -199,8 +199,6 @@ module Blacklight
         end
       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/configuration/null_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blacklight
   # Returned if no config is defined for the field in the Blacklight::Configuration
   class Configuration::NullField < Blacklight::Configuration::Field

data/lib/blacklight/configuration/search_field.rb

@@ -2,7 +2,7 @@
 module Blacklight
   class Configuration::SearchField < Blacklight::Configuration::Field
     def normalize! blacklight_config = nil
-      self.if = self.include_in_simple_select if self.if.nil?
+      self.if = include_in_simple_select if self.if.nil?
 
       super
       self.qt ||= blacklight_config.default_solr_params[:qt] if blacklight_config && blacklight_config.default_solr_params
@@ -11,7 +11,7 @@ module Blacklight
     end
 
     def validate!
-      raise ArgumentError, "Must supply a search field key" if self.key.nil?
+      raise ArgumentError, "Must supply a search field key" if key.nil?
     end
   end
 end

data/lib/blacklight/configuration/sort_field.rb

@@ -3,8 +3,8 @@ module Blacklight
   class Configuration::SortField < Blacklight::Configuration::Field
     def normalize! blacklight_config = nil
       super
-      self.field ||= self.label.try(:parameterize)
-      self.field ||= self.sort
+      self.field ||= label.try(:parameterize)
+      self.field ||= sort
 
       self.sort ||= self.field
 

data/lib/blacklight/configuration/view_config.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 class Blacklight::Configuration
   class ViewConfig < Blacklight::OpenStructWithHashAccess
+    def search_bar_presenter_class
+      super || Blacklight::SearchBarPresenter
+    end
+
     class Show < ViewConfig
       def document_presenter_class
         super || Blacklight::ShowPresenter

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
 
@@ -29,7 +26,9 @@ module Blacklight
 
     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
+      if defined? Sprockets
+        app.config.assets.precompile += %w(favicon.ico)
+      end
     end
 
     Blacklight::Engine.config.sms_mappings = {
@@ -40,15 +39,16 @@ module Blacklight
       'Sprint' => 'messaging.sprintpcs.com',
       'T Mobile' => 'tmomail.net',
       'Alltel' => 'message.alltel.com',
-      'Cricket' => 'mms.mycricket.com'
+      'Cricket' => 'mms.mycricket.com',
+      'Google Fi' => 'msg.fi.google.com'
     }
 
-    config.routes = OpenStruct.new
-    # Set identifier_constraint to enforce a format for the document identifiers
-    config.routes.identifier_constraint = /[\w-]+/
-
     config.bookmarks_http_method = :post
 
     config.email_regexp = defined?(Devise) ? Devise.email_regexp : /\A[^@\s]+@[^@\s]+\z/
+
+    config.action_dispatch.rescue_responses["Blacklight::Exceptions::RecordNotFound"] = :not_found
+
+    config.enable_search_bar_autofocus = false
   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/{utils.rb → nested_open_struct_with_hash_access.rb}

@@ -1,96 +1,24 @@
 # frozen_string_literal: true
 require 'ostruct'
 module Blacklight
-  module Utils
-    def self.needs_attr_accessible?
-      protected_attributes_enabled?
-    end
-
-    def self.protected_attributes_enabled?
-      defined?(ActiveModel::MassAssignmentSecurity)
-    end
-  end
-
   ##
-  # 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
-
-  ##
-  # An OpenStruct refinement that converts any hash-keys into  
+  # 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
+    delegate :default_proc=, to: :to_h
 
-    def initialize klass, *args
+    def initialize(klass, hash = {})
       @nested_class = klass
-      hash = {}
-
-      hashes_and_keys = args.flatten
-      lazy_configs = hashes_and_keys.extract_options!
-
-      hashes_and_keys.each do |v|
+      value = hash.transform_values do |v|
         if v.is_a? Hash
-          key = v.first
-          value = v[key]
-
-          hash[key] = nested_class.new value
+          nested_class.new(v)
         else
-          hash[v] = nested_class.new
+          v
         end
       end
 
-      lazy_configs.each do |k,v|
-        hash[k] = if v.is_a? nested_class
-                    v
-                  else
-                    nested_class.new v
-                  end
-      end
-
-      super hash
+      super value
       set_default_proc!
     end
 
@@ -131,7 +59,7 @@ module Blacklight
     end
 
     def deep_dup
-      self.class.new self.nested_class, @table.deep_dup
+      self.class.new nested_class, @table.deep_dup
     end
 
     def select *args, &block
@@ -172,7 +100,7 @@ module Blacklight
 
     def set_default_proc!
       self.default_proc = lambda do |hash, key|
-        hash[key] = self.nested_class.new
+        hash[key] = nested_class.new
       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