blacklight 6.14.0 → 7.0.0

data/config/locales/blacklight.sq.yml

@@ -12,13 +12,10 @@ sq:
       next: 'Tjetra »'
 
   blacklight:
-    application_name: 'Blacklight'
-
     header_links:
       login: 'Hyr'
       logout: 'Dil'
       bookmarks: 'Memorizimet'
-      saved_searches: 'Kërkimet e ruajtura'
       search_history: 'Historia'
 
     welcome: 'Mirësevini!'
@@ -52,25 +49,6 @@ sq:
       list_title: 'Memorizimet e juaja'
       delete: 'Fshije'
 
-    saved_searches:
-      add:
-        success: 'Kërkimi u ruajt me sukses.'
-        failure: 'Ka pasur një problem gjatë ruajt së kërkimit.'
-      remove:
-        success: 'Kërkimi i ruajtur u fshi me sukses.'
-        failure: 'Ka pasur një problem gjatë fshirjes së kërkimit.'
-      clear:
-        action_title: 'Fshij Kërkimet E Ruajtura'
-        action_confirm: "Dëshiron t'i fshishë kërkimet e ruajtua?"
-        success: 'Kërkimet e ruajtua u fshinë'
-        failure: 'Ka pasur një problem gjatë fshirjes së kërkimeve.'
-      title: 'Kërkimet e ruajtura'
-      page_title: 'Kërkimet E Ruajtura - %{application_name}'
-      need_login: 'Ju lutemi kyçuni për të menaxhuar dhe për të parë kërkimet e ruajtura.'
-      no_searches: 'Nuk keni kerkime të ruajtura'
-      list_title: 'Kërkimet e ruajtura'
-      delete: 'fshije'
-
     search_history:
       clear:
         action_title: 'Fshij Historinë E Kërkimit'
@@ -144,13 +122,12 @@ sq:
     back_to_bookmarks: 'Kthehu te memorizimet'
 
     search:
-      # i18n key 'title' is deprecated and will be removed in Blacklight 6.0
-      title: '%{application_name} Rezultatet e kërkimit'
       page_title:
         title: '%{constraints} - %{application_name} Rezultatet e kërkimit'
         constraint: '%{label}: %{value}'
         many_constraint_values: '%{values} zgjedhura'
-      search_results_header: 'Kufizimet e kërkimit'
+      header: 'Kërkimit'
+      search_constraints_header: 'Kufizimet e kërkimit'
       search_results: 'Rezultatet e kërkimit'
       errors:
         request_error: "Na vjen keq, unë nuk e kuptoj kërkimin tuaj."
@@ -188,6 +165,7 @@ sq:
       facets:
         title: 'Kufizo këkimin'
         clear: 'Fshij filterin'
+        all: 'Gjithë'
         sort:
           count: 'Renditja numerike'
           index: 'A-Z Renditja'
@@ -212,8 +190,6 @@ sq:
         label: '%{label}:'
       rss_feed: 'RSS për rezultatet'
       atom_feed: 'Atom për rezultatet'
-      fields:
-        default: 'Fjala'
       bookmarks:
         present: "Në memorizime"
         absent: "Memorizo"
@@ -231,4 +207,4 @@ sq:
     entry_name:
       default: 'entry'
 
-    did_you_mean: 'A keni menduar: %{options}?'
+    did_you_mean: 'A keni menduar: %{options}?'

data/config/locales/blacklight.zh.yml

@@ -18,7 +18,6 @@ zh:
       login: '登陆'
       logout: '注销'
       bookmarks: '书签'
-      saved_searches: '保存的搜索'
       search_history: '搜索历史'
 
     welcome: '欢迎!'
@@ -52,25 +51,6 @@ zh:
       list_title: '你的书签'
       delete: '删除'
 
-    saved_searches:
-      add:
-        success: '成功保存了您的搜索。'
-        failure: '保存搜索时出现问题。'
-      remove:
-        success: '成功删除保存的搜索。'
-        failure: '删除您的搜索时出现问题。'
-      clear:
-        action_title: '清除保存的搜索'
-        action_confirm: '清除您保存的搜索？'
-        success: '清除您保存的搜索。'
-        failure: '清除搜索时出现问题。'
-      title: '保存的搜索'
-      page_title: '保存的搜索 - %{application_name}'
-      need_login: '请登录来管理和查看您保存的搜索。'
-      no_searches: '您没有保存的搜索'
-      list_title: '您保存的搜索'
-      delete: '删除'
-
     search_history:
       clear:
         action_title: '清除搜索历史'
@@ -144,13 +124,12 @@ zh:
     back_to_bookmarks: '返回书签页面'
 
     search:
-      # i18n key 'title' is deprecated and will be removed in Blacklight 6.0
-      title: '%{application_name} 搜索结果'
       page_title:
         title: '%{constraints} - %{application_name} 搜索结果'
         constraint: '%{label}: %{value}'
         many_constraint_values: '%{values} 已选'
-      search_results_header: '搜索条件'
+      header: '搜'
+      search_constraints_header: '搜索条件'
       search_results: '搜索结果'
       errors:
         request_error: "抱歉，我不明白你要找什么。"
@@ -188,6 +167,7 @@ zh:
       facets:
         title: '限定搜索'
         clear: '清除搜索条件'
+        all: '皆'
         sort:
           count: '按数量排序'
           index: '按字母排序'
@@ -212,8 +192,6 @@ zh:
         label: '%{label}:'
       rss_feed: '搜索结果RSS'
       atom_feed: '搜索结果Atom'
-      fields:
-        default: '关键词'
       bookmarks:
         present: "在书签中"
         absent: "加入书签"

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/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,25 +21,37 @@ 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
 
-    protected
+    # Query the fields that exist from the index
+    # @return [Hash]
+    def reflect_fields
+      raise NotImplementedError
+    end
 
-      def connection_config
-        blacklight_config.connection_config
-      end
+    ##
+    # Is the repository in a working state?
+    def ping
+      raise NotImplementedError
+    end
 
-      def logger
-        @logger ||= Blacklight.logger
-      end
+    private
+
+    def connection_config
+      blacklight_config.connection_config
+    end
+
+    def logger
+      @logger ||= Blacklight.logger
+    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? ||

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

@@ -5,22 +5,24 @@ module Blacklight
     # solr fields configuration
     module Fields
       extend ActiveSupport::Concern
+      extend Deprecation
+      self.deprecation_horizon = 'blacklight version 8.0.0'
 
       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
 
-          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
           end
-    
+
           class_eval <<-END_EVAL, __FILE__, __LINE__ + 1
             def add_#{key}(*args, &block)
               add_blacklight_field("#{key}", *args, &block)
@@ -32,7 +34,7 @@ module Blacklight
       # Add a solr field configuration to the given configuration key
       #
       # The recommended and strongly encouraged format is a field name, configuration pair, e.g.:
-      #     add_blacklight_field :index_field, 'format', :label => 'Format' 
+      #     add_blacklight_field :index_field, 'format', :label => 'Format'
       #
       # Alternative formats include:
       #
@@ -56,7 +58,7 @@ module Blacklight
       #       field.field = 'format'
       #       field.label = 'Format'
       #     end
-      # 
+      #
       # * a configuration hash:
       #
       # @overload add_blacklight_field(config_key, options)
@@ -64,8 +66,8 @@ module Blacklight
       #   @param [Hash] options
       #
       #     add_blacklight_field :index_field, :field => 'format', :label => 'Format'
-      #   
-      # * a Field instance: 
+      #
+      # * a Field instance:
       #
       # @overload add_blacklight_field(config_key, field)
       #   @param [Symbol] config_key
@@ -74,7 +76,7 @@ module Blacklight
       #
       #     add_blacklight_field :index_field, IndexField.new(:field => 'format', :label => 'Format')
       #
-      # * an array of hashes: 
+      # * an array of hashes:
       #
       # @overload add_blacklight_field(config_key, fields)
       #   @param [Symbol] config_key
@@ -84,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('*', '.+') + "$")
@@ -102,62 +104,65 @@ module Blacklight
 
         # look up any dynamic fields
         if field_config.match
-
-          salient_fields = luke_fields.select do |k,v|
-            k =~ field_config.match
-          end
-
-          salient_fields.each do |field, luke_config|
-            config = field_config.dup
-            config.match = nil
-            config.field = field
-            config.key = field
-
-            if self[config_key.pluralize][ config.key ]
-              self[config_key.pluralize][ config.key ] = config.merge(self[config_key.pluralize][ config.key ])
-            else
-              add_blacklight_field(config_key, config, &block)
-            end
-          end
-
+          handle_matching_fields(config_key, field_config, &block)
           return
         end
-  
+
         if block_given?
           yield field_config
         end
-            
+
         field_config.normalize!(self)
         field_config.validate!
 
         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
+      def handle_matching_fields(config_key, field_config, &block)
+        salient_fields = reflected_fields.select do |k, _v|
+          k =~ field_config.match
+        end
+
+        salient_fields.each_key do |field|
+          config = field_config.dup
+          config.match = nil
+          config.field = field
+          config.key = field
+          if self[config_key.pluralize][config.key]
+            self[config_key.pluralize][config.key] = config.merge(self[config_key.pluralize][config.key])
+          else
+            add_blacklight_field(config_key, config, &block)
+          end
+        end
+      end
 
-      def luke_fields
-        if @table[:luke_fields] == false
+      def reflected_fields
+        if @table[:reflected_fields] == false
           return nil
         end
 
-        @table[:luke_fields] ||= Rails.cache.fetch("blacklight_configuration/admin/luke", expires_in: 1.hour) do
+        @table[:reflected_fields] ||= Rails.cache.fetch("blacklight_configuration/admin/reflected_fields", expires_in: 1.hour) do
           begin
-            if repository_class <= Blacklight::Solr::Repository
-              repository = repository_class.new(self)
-              repository.send_and_receive('admin/luke', params: { fl: '*', 'json.nl' => 'map' })['fields']
-            end
+            repository = repository_class.new(self)
+            repository.reflect_fields
           rescue => e
             Blacklight.logger.warn "Error retrieving field metadata: #{e}"
             false
           end
         end
 
-        @table[:luke_fields] || {}
+        @table[:reflected_fields] || {}
       end
+      alias luke_fields reflected_fields
+      deprecation_deprecate luke_fields: 'use reflected_fields instead'
 
-      # Add a solr field by a solr field name and hash 
+      # Add a solr field by a solr field name and hash
       def field_config_from_key_and_hash config_key, field_name, field_or_hash = {}
         field_config = field_config_from_field_or_hash(config_key, field_or_hash)
         field_config.key = field_name
@@ -166,7 +171,7 @@ module Blacklight
 
       # Add multiple solr fields using a hash or Field instance
       def field_config_from_array config_key, array_of_fields_or_hashes, &block
-        array_of_fields_or_hashes.map do |field_or_hash| 
+        array_of_fields_or_hashes.map do |field_or_hash|
           add_blacklight_field(config_key, field_or_hash, &block)
         end
       end
@@ -180,22 +185,20 @@ module Blacklight
       # and makes it into a specific config OpenStruct, like
       # FacetField or SearchField. Or if the param already was
       # one, that's cool. Or if the param is nil, make
-      # an empty one. Second argument is an actual class object. 
+      # an empty one. Second argument is an actual class object.
       def hash_arg_to_config(hash_arg, klass)
         case hash_arg
-        when Hash 
+        when Hash
           klass.new(hash_arg)
-        when NilClass 
+        when NilClass
           klass.new
-        else 
+        else
           # this assumes it already is an element of klass, or acts like one,
-          # if not something bad will happen later, that's your problem. 
+          # if not something bad will happen later, that's your problem.
           hash_arg
         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