blacklight 6.25.0 → 7.0.0.rc1

data/app/models/concerns/blacklight/document/semantic_fields.rb

@@ -7,7 +7,7 @@ module Blacklight::Document
       # Returns array of hashes of registered extensions. Each hash
       # has a :module_obj key and a :condition_proc key. Usually this
       # method is only used internally in #apply_extensions, but if you
-   
+
       # Class-level method for accessing/setting semantic mappings
       # for solr stored fields. Can be set by local app, key is
       # a symbol for a semantic, value is a solr _stored_ field.
@@ -17,22 +17,22 @@ module Blacklight::Document
       #
       # Currently documented semantic tokens, not all may be
       # used by core BL, but some may be used by plugins present
-      # or future. 
-      # :title, :author, :year, :language => User-presentable strings. 
+      # or future.
+      # :title, :author, :year, :language => User-presentable strings.
       def field_semantics
         @field_semantics ||= {}
-      end  
+      end
     end
-    
+
     # Returns a hash keyed by semantic tokens, value is an array of
     # strings. (Array to handle multi-value fields). If no value(s)
-    # available, empty array is returned. 
+    # available, empty array is returned.
     #
     # Default implementation here uses field_semantics
-    # to just take values from Solr stored fields. 
+    # to just take values from Solr stored fields.
     # Extensions can over-ride this method to provide better/different lookup,
     # but extensions should call super and modify hash returned, to avoid
-    # unintentionally erasing values provided by other extensions. 
+    # unintentionally erasing values provided by other extensions.
     def to_semantic_values
       @semantic_value_hash ||= self.class.field_semantics.each_with_object(Hash.new([])) do |(key, field_names), hash|
         ##
@@ -45,6 +45,6 @@ module Blacklight::Document
       end
 
       @semantic_value_hash ||= {}
-    end    
+    end
   end
 end

data/app/models/concerns/blacklight/document/sms.rb

@@ -3,7 +3,7 @@
 module Blacklight::Document::Sms
   # Return a text string that will be the body of the email
   def to_sms_text
-    semantics = self.to_semantic_values
+    semantics = to_semantic_values
     body = []
     body << I18n.t('blacklight.sms.text.title', value: semantics[:title].first) unless semantics[:title].blank?
     body << I18n.t('blacklight.sms.text.author', value: semantics[:author].first) unless semantics[:author].blank?

data/app/models/concerns/blacklight/document.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
-
-require 'globalid'
-
+##
 ##
 # = Introduction
 # Blacklight::Document is the module with logic for a class representing
@@ -16,9 +14,6 @@ require 'globalid'
 # transformation formats.
 #
 module Blacklight::Document
-  extend Deprecation
-  self.deprecation_horizon = 'blacklight 7.0'
-
   autoload :ActiveModelShim, 'blacklight/document/active_model_shim'
   autoload :SchemaOrg, 'blacklight/document/schema_org'
   autoload :CacheKey, 'blacklight/document/cache_key'
@@ -43,38 +38,15 @@ module Blacklight::Document
 
   attr_reader :response, :_source
   alias_method :solr_response, :response
-  delegate :[], :key?, :keys, :to_h, to: :_source
 
-  def initialize(source_doc={}, response=nil)
-    @_source = if source_doc.respond_to?(:to_hash)
-                 ActiveSupport::HashWithIndifferentAccess.new(source_doc)
-               else
-                 Deprecation.warn(Blacklight::Document, "Blacklight::Document#initialize expects a hash-like object, received #{source_doc.class}.")
-                 ActiveSupport::HashWithIndifferentAccess.new(source_doc.to_h)
-               end
+  delegate :[], :key?, :keys, :to_h, :as_json, to: :_source
+
+  def initialize(source_doc = {}, response = nil)
+    @_source = ActiveSupport::HashWithIndifferentAccess.new(source_doc).freeze
     @response = response
     apply_extensions
   end
 
-  # the wrapper method to the @_source object.
-  # If a method is missing, it gets sent to @_source
-  # with all of the original params and block
-  def method_missing(m, *args, &b)
-    return super if m == :to_hash
-
-    if _source_responds_to?(m)
-      Deprecation.warn(Blacklight::Solr::Document, "Blacklight::Document##{m} is deprecated; use obj.to_h.#{m} instead.")
-      _source.send(m, *args, &b)
-    else
-      super
-    end
-  end
-
-  def respond_to_missing? m, *args
-    return super if %i(empty? to_hash).include?(m)
-    _source_responds_to?(m, *args) || super
-  end
-
   # Helper method to check if value/multi-values exist for a given key.
   # The value can be a string, or a RegExp
   # Multiple "values" can be given; only one needs to match.
@@ -107,7 +79,7 @@ module Blacklight::Document
   def fetch key, *default
     if key? key
       self[key]
-    elsif default.empty? and !block_given?
+    elsif default.empty? && !block_given?
       raise KeyError, "key not found \"#{key}\""
     else
       (yield(self) if block_given?) || default.first
@@ -122,11 +94,11 @@ module Blacklight::Document
     'catalog/document'
   end
 
-  def has_highlight_field? k
+  def has_highlight_field? _k
     false
   end
 
-  def highlight_field k
+  def highlight_field _k
     nil
   end
 
@@ -161,10 +133,4 @@ module Blacklight::Document
       end
     end
   end
-
-  private
-
-  def _source_responds_to? *args
-    _source && self != _source && _source.respond_to?(*args)
-  end
 end

data/app/models/concerns/blacklight/solr/document.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'rsolr'
 ##
 ##
 # = Introduction
@@ -16,20 +15,20 @@ require 'rsolr'
 #
 
 module Blacklight::Solr::Document
-  autoload :MoreLikeThis, 'blacklight/solr/document/more_like_this'
-
   extend ActiveSupport::Concern
   include Blacklight::Document
   include Blacklight::Document::ActiveModelShim
-  include Blacklight::Solr::Document::MoreLikeThis
+
+  def more_like_this
+    response.more_like(self).map { |doc| self.class.new(doc, response) }
+  end
 
   def has_highlight_field? k
-    return false if response['highlighting'].blank? or response['highlighting'][self.id].blank?
-    
-    response['highlighting'][self.id].key? k.to_s
+    return false if response['highlighting'].blank? || response['highlighting'][id].blank?
+    response['highlighting'][id].key? k.to_s
   end
 
   def highlight_field k
-    response['highlighting'][self.id][k.to_s].map(&:html_safe) if has_highlight_field? k
+    response['highlighting'][id][k.to_s].map(&:html_safe) if has_highlight_field? k
   end
 end

data/app/models/concerns/blacklight/suggest/response.rb

@@ -2,19 +2,17 @@
 module Blacklight
   module Suggest
     class Response
-      attr_reader :response, :request_params, :suggest_path, :suggester_name
+      attr_reader :response, :request_params, :suggest_path
 
       ##
       # Creates a suggest response
       # @param [RSolr::HashWithResponse] response
       # @param [Hash] request_params
       # @param [String] suggest_path
-      # @param [String] suggester_name
-      def initialize(response, request_params, suggest_path, suggester_name)
+      def initialize(response, request_params, suggest_path)
         @response = response
         @request_params = request_params
         @suggest_path = suggest_path
-        @suggester_name = suggester_name
       end
 
       ##
@@ -22,7 +20,7 @@ module Blacklight
       # present
       # @return [Array]
       def suggestions
-        (response.try(:[], suggest_path).try(:[], suggester_name).try(:[], request_params[:q]).try(:[], 'suggestions') || []).uniq
+        response.try(:[], suggest_path).try(:[], 'mySuggester').try(:[], request_params[:q]).try(:[], 'suggestions') || []
       end
     end
   end

data/app/models/concerns/blacklight/user.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 module Blacklight::User
   # This gives us an is_blacklight_user method that can be included in
-  # the containing applications models. 
-  # SEE ALSO:  The /lib/blacklight/engine.rb class for how when this 
+  # the containing applications models.
+  # SEE ALSO:  The /lib/blacklight/engine.rb class for how when this
   # is injected into the hosting application through ActiveRecord::Base extend
   def self.included(base)
     return unless base.respond_to? :has_many
-    base.send :has_many, :bookmarks, :dependent => :destroy, :as => :user
-    base.send :has_many, :searches,  :dependent => :destroy, :as => :user
+    base.send :has_many, :bookmarks, dependent: :destroy, as: :user
+    base.send :has_many, :searches,  dependent: :destroy, as: :user
   end
 
   def bookmarks_for_documents documents = []
@@ -21,9 +21,9 @@ module Blacklight::User
   def document_is_bookmarked?(document)
     bookmarks_for_documents([document]).any?
   end
-    
+
   # returns a Bookmark object if there is one for document_id, else
-  # nil. 
+  # nil.
   def existing_bookmark_for(document)
     bookmarks_for_documents([document]).first
   end

data/app/models/record_mailer.rb

@@ -1,25 +1,24 @@
 # frozen_string_literal: true
-# Only works for documents with a #to_marc right now. 
+# Only works for documents with a #to_marc right now.
 class RecordMailer < ActionMailer::Base
   def email_record(documents, details, url_gen_params)
-        
     title = begin
               documents.first.to_semantic_values[:title]
             rescue
               I18n.t('blacklight.email.text.default_title')
             end
-    subject = I18n.t('blacklight.email.text.subject', :count => documents.length, :title => title )
+    subject = I18n.t('blacklight.email.text.subject', count: documents.length, title: title)
 
     @documents      = documents
     @message        = details[:message]
     @url_gen_params = url_gen_params
 
-    mail(:to => details[:to],  :subject => subject)
+    mail(to: details[:to],  subject: subject)
   end
-  
+
   def sms_record(documents, details, url_gen_params)
     @documents      = documents
     @url_gen_params = url_gen_params
-    mail(:to => details[:to], :subject => "")
+    mail(to: details[:to], subject: "")
   end
 end

data/app/models/search.rb

@@ -1,23 +1,19 @@
 # frozen_string_literal: true
-class Search < ActiveRecord::Base
-  belongs_to_arguments = { optional: true } if Rails.version >= '5.0.0'
 
-  belongs_to :user, belongs_to_arguments
+class Search < ApplicationRecord
+  belongs_to :user, optional: true
 
-  # use a backwards-compatible serializer until the Rails API stabilizes and we can evaluate for major-revision compatibility
-  serialize :query_params, Blacklight::SearchParamsYamlCoder
-
-  attr_accessible :query_params if Blacklight::Utils.needs_attr_accessible?
+  serialize :query_params
 
   # A Search instance is considered a saved search if it has a user_id.
   def saved?
-    self.user_id?
+    user_id?
   end
 
   # delete old, unsaved searches
   def self.delete_old_searches(days_old)
     raise ArgumentError, 'days_old is expected to be a number' unless days_old.is_a?(Numeric)
     raise ArgumentError, 'days_old is expected to be greater than 0' if days_old <= 0
-    self.where(['created_at < ? AND user_id IS NULL', Time.zone.today - days_old]).destroy_all
+    where(['created_at < ? AND user_id IS NULL', Time.zone.today - days_old]).destroy_all
   end
 end

data/app/presenters/blacklight/field_presenter.rb

@@ -1,5 +1,5 @@
 module Blacklight
-  # Renders a field and handles link_to_search or helper_method if supplied
+  # Renders a field and handles link_to_facet or helper_method if supplied
   class FieldPresenter
     def initialize(controller, document, field_config, options)
       @controller = controller
@@ -9,7 +9,7 @@ module Blacklight
     end
 
     attr_reader :controller, :document, :field_config, :options
-    
+
     def render
       if options[:value]
         # This prevents helper methods from drawing.
@@ -24,8 +24,8 @@ module Blacklight
 
     private
 
-      def retrieve_values
-        FieldRetriever.new(document, field_config).fetch
-      end
+    def retrieve_values
+      FieldRetriever.new(document, field_config).fetch
+    end
   end
 end

data/app/presenters/blacklight/index_presenter.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 module Blacklight
   class IndexPresenter
-    extend Deprecation
-    self.deprecation_horizon = 'Blacklight version 7.0.0'
+    class_attribute :thumbnail_presenter
+    self.thumbnail_presenter = ThumbnailPresenter
 
-    attr_reader :document, :configuration, :view_context
+    attr_reader :document, :configuration, :view_context, :view_config
 
     # @param [SolrDocument] document
     # @param [ActionView::Base] view_context scope for linking and generating urls
@@ -13,6 +13,7 @@ module Blacklight
       @document = document
       @view_context = view_context
       @configuration = configuration
+      @view_config = configuration.view_config(view_context.document_index_view_type)
     end
 
     ##
@@ -24,93 +25,55 @@ module Blacklight
     def label(field_or_string_or_proc, opts = {})
       config = Configuration::NullField.new
       value = case field_or_string_or_proc
-      when Symbol
-        config = field_config(field_or_string_or_proc)
-        document[field_or_string_or_proc]
-      when Proc
-        field_or_string_or_proc.call(document, opts)
-      when String
-        field_or_string_or_proc
-      end
+                when Symbol
+                  config = field_config(field_or_string_or_proc)
+                  document[field_or_string_or_proc]
+                when Proc
+                  field_or_string_or_proc.call(document, opts)
+                when String
+                  field_or_string_or_proc
+              end
 
       value ||= document.id
       field_values(config, value: value)
     end
 
-    # @deprecated
-    def render_document_index_label(*args)
-      label(*args)
-    end
-    deprecation_deprecate render_document_index_label: 'Use #label instead'
-
     ##
     # Render the index field label for a document
     #
     # Allow an extention point where information in the document
     # may drive the value of the field
-    # @param [Configuration::Field, String] field_or_name
+    # @param [String] field
     # @param [Hash] options
     # @option options [String] :value
-    def field_value field_or_name, options = {}
-      field = case field_or_name
-              when Blacklight::Configuration::Field
-                field_or_name
-              when String, Symbol
-                Deprecation.warn(self, "You provided a #{field_or_name.class} value to IndexPresenter#field_value " \
-                "Provide a Blacklight::Configuration::Field instead. This behavior is deprecated in Blacklight 7")
-                field_config(field_or_name)
-              else
-                Deprecation.warn(self, "You provided a #{field_or_name.class} value to IndexPresenter#field_value. " \
-                "This will be silently ignored and will be an error in Blacklight 7.")
-
-                Configuration::NullField.new
-              end
-      field_values(field, options)
-    end
-
-    # @deprecated
-    def render_index_field_value(*args)
-      field_value(*args)
-    end
-    deprecation_deprecate render_index_field_value: 'replaced by #field_value'
-
-    # @deprecated
-    def get_field_values(field_config, options={})
+    def field_value field, options = {}
+      field_config = field_config(field)
       field_values(field_config, options)
     end
-    deprecation_deprecate get_field_values: "replaced by #field_value"
-
-    # @deprecated
-    def render_field_values(values, field_config = Configuration::NullField.new)
-      field_values(field_config, value: Array(values))
-    end
-    deprecation_deprecate render_field_values: "replaced by #field_value"
 
-    # @deprecated
-    def render_values(values, field_config = Configuration::NullField.new)
-      field_values(field_config, value: Array(values))
+    def thumbnail
+      @thumbnail ||= thumbnail_presenter.new(document, view_context, view_config)
     end
-    deprecation_deprecate render_values: "replaced by #field_value"
 
     private
 
-      ##
-      # Get the value for a document's field, and prepare to render it.
-      # - highlight_field
-      # - accessor
-      # - solr field
-      #
-      # Rendering:
-      #   - helper_method
-      #   - link_to_search
-      # @param [Blacklight::Configuration::Field] field_config solr field configuration
-      # @param [Hash] options additional options to pass to the rendering helpers
-      def field_values(field_config, options={})
-        FieldPresenter.new(view_context, document, field_config, options).render
-      end
+    ##
+    # Get the value for a document's field, and prepare to render it.
+    # - highlight_field
+    # - accessor
+    # - solr field
+    #
+    # Rendering:
+    #   - helper_method
+    #   - link_to_facet
+    # @param [Blacklight::Configuration::Field] field_config solr field configuration
+    # @param [Hash] options additional options to pass to the rendering helpers
+    def field_values(field_config, options = {})
+      FieldPresenter.new(view_context, document, field_config, options).render
+    end
 
-      def field_config(field)
-        configuration.index_fields.fetch(field) { Configuration::NullField.new(field) }
-      end
+    def field_config(field)
+      configuration.index_fields.fetch(field) { Configuration::NullField.new(field) }
+    end
   end
 end

data/app/presenters/blacklight/json_presenter.rb

@@ -4,19 +4,22 @@ module Blacklight
     include Blacklight::Facet
 
     # @param [Solr::Response] response raw solr response.
-    # @param [Array<SolrDocument>] documents a list of documents
     # @param [Array] facets list of facets
-    def initialize(response, documents, facets, blacklight_config)
+    def initialize(response, facets, blacklight_config)
       @response = response
-      @documents = documents
       @facets = facets
       @blacklight_config = blacklight_config
     end
 
-    attr_reader :documents, :blacklight_config
+    attr_reader :blacklight_config
+
+    def documents
+      @response.documents
+    end
 
     def search_facets_as_json
       @facets.as_json.each do |f|
+        f.stringify_keys!
         f.delete "options"
         f["label"] = facet_configuration_for_field(f["name"]).label
         f["items"] = f["items"].as_json.each do |i|

data/app/presenters/blacklight/link_alternate_presenter.rb

@@ -12,7 +12,7 @@ module Blacklight
 
     attr_reader :view_context, :document, :options
 
-    # Renders links to alternate representations 
+    # Renders links to alternate representations
     # provided by export formats. Returns empty string if no links available.
     def render
       seen = Set.new

data/app/presenters/blacklight/rendering/abstract_step.rb

@@ -12,12 +12,12 @@ module Blacklight
 
       attr_reader :values, :config, :document, :context, :options, :stack
 
-      protected
+      private
 
-        def next_step(output_values)
-          first, *rest = *stack
-          first.new(output_values, config, document, context, options, rest).render
-        end
+      def next_step(output_values)
+        first, *rest = *stack
+        first.new(output_values, config, document, context, options, rest).render
+      end
     end
   end
 end

data/app/presenters/blacklight/rendering/helper_method.rb

@@ -4,20 +4,20 @@ module Blacklight
       def render
         if config.helper_method
           render_helper # short circut the rest of the steps
-        else  
+        else
           next_step(values)
         end
       end
 
       private
 
-        def render_helper
-          context.send(config.helper_method,
-                       options.merge(document: document,
-                                     field: config.field,
-                                     config: config,
-                                     value: values))
-        end
+      def render_helper
+        context.send(config.helper_method,
+                     options.merge(document: document,
+                                   field: config.field,
+                                   config: config,
+                                   value: values))
+      end
     end
   end
 end

data/app/presenters/blacklight/rendering/join.rb

@@ -8,9 +8,9 @@ module Blacklight
 
       private
 
-        def html_escape(*args)
-          ERB::Util.html_escape(*args)
-        end
+      def html_escape(*args)
+        ERB::Util.html_escape(*args)
+      end
     end
   end
 end

data/app/presenters/blacklight/rendering/link_to_facet.rb

@@ -1,35 +1,35 @@
 module Blacklight
   module Rendering
     class LinkToFacet < AbstractStep
+      extend Deprecation
       def render
-        # TODO: We should rename the config variable, because it creates a link to a facet.
-        return next_step(values) unless config.link_to_search
+        return next_step(values) unless config.link_to_facet
         next_step(render_link)
       end
 
       private
 
-        # This allows the link to wrap an itemprop
-        def render_link
-          values.map { |v| link(link_field, v) }
-        end
+      # This allows the link to wrap an itemprop
+      def render_link
+        values.map { |v| link(link_field, v) }
+      end
 
-        def link_field
-          return config.key if config.link_to_search == true
-          config.link_to_search
-        end
+      def link_field
+        return config.key if config.link_to_facet == true
+        config.link_to_facet
+      end
 
-        def link(field, v)
-          context.link_to v, search_path(field, v)
-        end
+      def link(field, v)
+        context.link_to v, search_path(field, v)
+      end
 
-        def search_path(field, v)
-          context.search_action_path(facet_params(field, v))
-        end
+      def search_path(field, v)
+        context.search_action_path(facet_params(field, v))
+      end
 
-        def facet_params(field, v)
-          context.search_state.reset.add_facet_params(field, v)
-        end
+      def facet_params(field, v)
+        context.search_state.reset.add_facet_params(field, v)
+      end
     end
   end
 end

data/app/presenters/blacklight/rendering/microdata.rb

@@ -9,9 +9,9 @@ module Blacklight
 
       private
 
-        def itemprop(val, itemprop)
-          content_tag :span, val, itemprop: itemprop
-        end
+      def itemprop(val, itemprop)
+        content_tag :span, val, itemprop: itemprop
+      end
     end
   end
 end

data/app/presenters/blacklight/rendering/pipeline.rb

@@ -26,12 +26,12 @@ module Blacklight
         first.new(values, config, document, context, options, rest).render
       end
 
-      protected
+      private
 
-        # Ordered list of operations, Terminator must be at the end.
-        def stack
-          operations + [Terminator]
-        end
+      # Ordered list of operations, Terminator must be at the end.
+      def stack
+        operations + [Terminator]
+      end
     end
   end
 end