blacklight 6.19.1 → 7.1.0

data/app/{assets/javascripts → javascript}/blacklight/search_context.js

@@ -1,12 +1,19 @@
-//= require blacklight/core
 (function($) {
-  Blacklight.do_search_context_behavior = function() {
+  Blacklight.doSearchContextBehavior = function() {
+    if (typeof Blacklight.do_search_context_behavior == 'function') {
+      console.warn("do_search_context_behavior is deprecated. Use doSearchContextBehavior instead.");
+      return Blacklight.do_search_context_behavior();
+    }
     $('a[data-context-href]').on('click.search-context', Blacklight.handleSearchContextMethod);
   };
 
   // this is the $.rails.handleMethod with a couple adjustments, described inline:
   // first, we're attaching this directly to the event handler, so we can check for meta-keys
   Blacklight.handleSearchContextMethod = function(event) {
+    if (typeof Blacklight.handle_search_context_method == 'function') {
+      console.warn("handle_search_context_method is deprecated. Use handleSearchContextMethod instead.");
+      return Blacklight.handle_search_context_method(event);
+    }
     var link = $(this);
 
     // instead of using the normal href, we need to use the context href instead
@@ -37,6 +44,6 @@
   };
 
   Blacklight.onLoad(function() {
-    Blacklight.do_search_context_behavior();
+      Blacklight.doSearchContextBehavior();
   });
 })(jQuery);

data/app/models/blacklight/facet_paginator.rb

@@ -4,7 +4,7 @@ module Blacklight
   # displayable. You have to ask Solr for limit+1, to get enough
   # results to see if 'more' are available'. That is, the all_facet_values
   # arg in constructor should be the result of asking solr for limit+1
-  # values. 
+  # values.
   # This is a workaround for the fact that Solr itself can't compute
   # the total values for a given facet field,
   # so we cannot know how many "pages" there are.
@@ -24,9 +24,9 @@ module Blacklight
     # asking solr for n+1 facet values.
     # options:
     # :limit =>  number to display per page, or (default) ?. Nil means
-    #            display all with no previous or next. 
+    #            display all with no previous or next.
     # :offset => current item offset, default 0
-    # :sort => 'count' or 'index', solr tokens for facet value sorting, default 'count'. 
+    # :sort => 'count' or 'index', solr tokens for facet value sorting, default 'count'.
     def initialize(all_facet_values, arguments = {})
       # to_s.to_i will conveniently default to 0 if nil
       @offset = arguments[:offset].to_s.to_i

data/app/models/blacklight/icon.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class Icon
+    attr_reader :icon_name
+    ##
+    # @param [String, Symbol] icon_name
+    # @param [Hash] options
+    # @param [String] classes additional classes separated by a string
+    def initialize(icon_name, classes: '', aria_hidden: false)
+      @icon_name = icon_name
+      @classes = classes
+      @aria_hidden = aria_hidden
+    end
+
+    ##
+    # Returns the raw source, but you could extend this to add additional attributes
+    # @return [String]
+    def svg
+      file_source
+    end
+
+    ##
+    # @return [Hash]
+    def options
+      {
+        class: classes,
+        "aria-hidden": (true if @aria_hidden)
+      }
+    end
+
+    ##
+    # @return [String]
+    def path
+      "blacklight/#{icon_name}.svg"
+    end
+
+    ##
+    # @return [String]
+    def file_source
+      raise Blacklight::Exceptions::IconNotFound, "Could not find #{path}" if file.blank?
+
+      file.source.force_encoding('UTF-8')
+    end
+
+    private
+
+    def file
+      # Rails.application.assets is `nil` in production mode (where compile assets is enabled).
+      # This workaround is based off of this comment: https://github.com/fphilipe/premailer-rails/issues/145#issuecomment-225992564
+      (Rails.application.assets || ::Sprockets::Railtie.build_environment(Rails.application)).find_asset(path)
+    end
+
+    def classes
+      " blacklight-icons #{@classes} ".strip
+    end
+  end
+end

data/app/models/blacklight/solr/facet_paginator.rb

@@ -4,7 +4,7 @@ module Blacklight::Solr
   # displayable. You have to ask Solr for limit+1, to get enough
   # results to see if 'more' are available'. That is, the all_facet_values
   # arg in constructor should be the result of asking solr for limit+1
-  # values. 
+  # values.
   # This is a workaround for the fact that Solr itself can't compute
   # the total values for a given facet field,
   # so we cannot know how many "pages" there are.
@@ -14,9 +14,9 @@ module Blacklight::Solr
     # asking solr for n+1 facet values.
     # options:
     # :limit =>  number to display per page, or (default) nil. Nil means
-    #            display all with no previous or next. 
+    #            display all with no previous or next.
     # :offset => current item offset, default 0
-    # :sort => 'count' or 'index', solr tokens for facet value sorting, default 'count'. 
+    # :sort => 'count' or 'index', solr tokens for facet value sorting, default 'count'.
     def initialize(all_facet_values, arguments = {})
       super
 

data/app/models/blacklight/suggest_search.rb

@@ -3,7 +3,7 @@
 module Blacklight
   class SuggestSearch
     attr_reader :request_params, :repository
-    
+
     ##
     # @param [Hash] params
     # @param [Blacklight::AbstractRepository] repository

data/app/models/bookmark.rb

@@ -1,27 +1,22 @@
 # frozen_string_literal: true
-class Bookmark < ActiveRecord::Base
-  
+
+class Bookmark < ApplicationRecord
   belongs_to :user, polymorphic: true
   belongs_to :document, polymorphic: true
 
   validates :user_id, presence: true
 
-  if Blacklight::Utils.needs_attr_accessible?
-    attr_accessible :id, :document_id, :document_type, :title
-  end
-
   def document
     document_type.new document_type.unique_key => document_id
   end
-  
+
   def document_type
     value = super if defined?(super)
     value &&= value.constantize
-    value ||= default_document_type
+    value || default_document_type
   end
-  
+
   def default_document_type
     SolrDocument
   end
-  
 end

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

@@ -5,32 +5,32 @@ module Blacklight::Configurable
   included do
     helper_method :blacklight_config if respond_to? :helper_method
   end
-  
+
   #instance methods for blacklight_config, so get a deep copy of the class-level config
   def blacklight_config
     @blacklight_config ||= self.class.blacklight_config.deep_copy
   end
   attr_writer :blacklight_config
 
-  module ClassMethods   
+  module ClassMethods
     def copy_blacklight_config_from(other_class)
-      self.blacklight_config = other_class.blacklight_config.inheritable_copy
+      self.blacklight_config = other_class.blacklight_config.inheritable_copy(self)
     end
-    
+
     # lazy load a deep_copy of superclass if present, else
-    # a default_configuration, which will be legacy load or new empty config. 
+    # a default_configuration, which will be legacy load or new empty config.
     # note the @blacklight_config variable is a ruby 'instance method on class
     # object' that won't be automatically available to subclasses, that's why
-    # we lazy load to 'inherit' how we want. 
+    # we lazy load to 'inherit' how we want.
     def blacklight_config
       @blacklight_config ||= if superclass.respond_to?(:blacklight_config)
-        superclass.blacklight_config.deep_copy
-      else
-        default_configuration
-      end
+                               superclass.blacklight_config.build(self)
+                             else
+                               default_configuration
+                             end
     end
     attr_writer :blacklight_config
-    
+
     #simply a convenience method for blacklight_config.configure
     def configure_blacklight(*args, &block)
       blacklight_config.configure(*args, &block)
@@ -39,12 +39,12 @@ module Blacklight::Configurable
     ##
     # The default configuration object
     def default_configuration
-      Blacklight::Configurable.default_configuration.inheritable_copy
+      Blacklight::Configurable.default_configuration.inheritable_copy(self)
     end
   end
 
   def self.default_configuration
-      @default_configuration ||= Blacklight::Configuration.new
+    @default_configuration ||= Blacklight::Configuration.new
   end
 
   def self.default_configuration= config

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

@@ -16,9 +16,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,36 +40,13 @@ 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
-    @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
+  delegate :[], :key?, :keys, :to_h, :as_json, to: :_source
 
-  def respond_to_missing? m, *args
-    return super if %i(empty? to_hash).include?(m)
-    _source_responds_to?(m, *args) || super
+  def initialize(source_doc = {}, response = nil)
+    @_source = ActiveSupport::HashWithIndifferentAccess.new(source_doc).freeze
+    @response = response
+    apply_extensions
   end
 
   # Helper method to check if value/multi-values exist for a given key.
@@ -107,7 +81,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 +96,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
 
@@ -144,11 +118,21 @@ module Blacklight::Document
     def unique_key
       @unique_key ||= 'id'
     end
-  end
 
-  private
-
-  def _source_responds_to? *args
-    _source && self != _source && _source.respond_to?(*args)
+    # Define an attribute reader on a document model
+    # @Example
+    #   class SolrDocument
+    #     include Blacklight::Solr::Document
+    #     attribute :title, Blacklight::Types::String, 'title_tesim'
+    #   end
+    #
+    #   doc = SolrDocument.new(title_tesim: ["One flew over the cuckoo's nest"])
+    #   doc.title
+    #   #=> "One flew over the cuckoo's nest"
+    def attribute(name, type, field)
+      define_method name do
+        type.coerce(self[field])
+      end
+    end
   end
 end

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

@@ -29,27 +29,24 @@ module Blacklight::Document
         repository.find(id).documents.first
       end
     end
-    
+
     ##
     # Unique ID for the document
     def id
       self[self.class.unique_key]
     end
 
-    ##
-    # accessors for reading attribute
-    def [] *args
-      _source.send :[], *args
+    def ==(other)
+      super ||
+        (other.instance_of?(self.class) &&
+          id &&
+          other.id == id)
     end
-    
+
     def _read_attribute(attr)
       self[attr]
     end
 
-    def as_json(options = nil)
-      _source.as_json(options)
-    end
-    
     ##
     # ActiveRecord::Persistence method stubs to get non-AR objects to
     # play nice with e.g. Blacklight's bookmarks
@@ -60,7 +57,7 @@ module Blacklight::Document
     def destroyed?
       false
     end
-    
+
     def new_record?
       false
     end

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

@@ -9,7 +9,7 @@ module Blacklight::Document::CacheKey
   def cache_key
     if new_record?
       "#{self.class.model_name.cache_key}/new"
-    elsif self.key? cache_version_key
+    elsif key? cache_version_key
       cache_version_value = self[cache_version_key]
       "#{self.class.model_name.cache_key}/#{id}-#{Array(cache_version_value).join}"
     else

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

@@ -5,7 +5,7 @@ require 'builder'
 module Blacklight::Document::DublinCore
   def self.extended(document)
     # Register our exportable formats
-    Blacklight::Document::DublinCore.register_export_formats( document )
+    Blacklight::Document::DublinCore.register_export_formats(document)
   end
 
   def self.register_export_formats(document)
@@ -26,7 +26,7 @@ module Blacklight::Document::DublinCore
              'xmlns:dc' => "http://purl.org/dc/elements/1.1/",
              'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
              'xsi:schemaLocation' => %(http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd)) do
-      self.to_semantic_values.select { |field, values| dublin_core_field_name? field  }.each do |field,values|
+      to_semantic_values.select { |field, _values| dublin_core_field_name? field  }.each do |field, values|
         Array.wrap(values).each do |v|
           xml.tag! "dc:#{field}", v
         end

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

@@ -3,12 +3,12 @@
 module Blacklight::Document::Email
   # Return a text string that will be the body of the email
   def to_email_text
-    semantics = self.to_semantic_values
+    semantics = to_semantic_values
     body = []
-    body << I18n.t('blacklight.email.text.title', value: semantics[:title].join(" ")) unless semantics[:title].blank?
-    body << I18n.t('blacklight.email.text.author', value: semantics[:author].join(" ")) unless semantics[:author].blank?
-    body << I18n.t('blacklight.email.text.format', value: semantics[:format].join(" ")) unless semantics[:format].blank?
-    body << I18n.t('blacklight.email.text.language', value: semantics[:language].join(" ")) unless semantics[:language].blank?
+    body << I18n.t('blacklight.email.text.title', value: semantics[:title].join(" ")) if semantics[:title].present?
+    body << I18n.t('blacklight.email.text.author', value: semantics[:author].join(" ")) if semantics[:author].present?
+    body << I18n.t('blacklight.email.text.format', value: semantics[:format].join(" ")) if semantics[:format].present?
+    body << I18n.t('blacklight.email.text.language', value: semantics[:language].join(" ")) if semantics[:language].present?
     return body.join("\n") unless body.empty?
   end
 end

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

@@ -24,8 +24,8 @@ module Blacklight::Document::Extensions
   # Needs to be called in initializer of class including this module, to
   # apply all registered extensions on a per-document basis
   def apply_extensions
-    self.class.registered_extensions.each do | registration|
-      self.extend( registration[:module_obj] ) if registration[:condition_proc].nil? || registration[:condition_proc].call( self )
+    self.class.registered_extensions.each do |registration|
+      extend(registration[:module_obj]) if registration[:condition_proc].nil? || registration[:condition_proc].call(self)
     end
   end
 
@@ -43,15 +43,15 @@ module Blacklight::Document::Extensions
     end
 
     # Register an extension module with the class. A block taking one
-    # parameter can be supplied; the block will be passed an instance of 
+    # parameter can be supplied; the block will be passed an instance of
     # a Document, and the extension will be applied only if the block
     # evaluates as true. If no condition is given, the extension will
     # be applied to every instance of the class.
     #
     # SolrDocument.use_extension( SomeExtensionModule ) { | document | should_apply_some_extension?(document) }
     # SolrDocument.use_extension( SomeExtensionModule) # will be applied to all docs
-    def use_extension( module_obj, &condition )
-      registered_extensions << {module_obj: module_obj, condition_proc: condition}    
+    def use_extension(module_obj, &condition)
+      registered_extensions << { module_obj: module_obj, condition_proc: condition }
     end
   end
 end