blacklight 5.11.3 → 5.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d66f63cc8f730572a615a21e6e02c6f2bec32a04
-  data.tar.gz: 0e0a72eaec2d8ac932f37c96cff9c3482e1c884d
+  metadata.gz: 1e42546dfea7f15e6d7fb7840dc8c565dc1a2f4d
+  data.tar.gz: 4f80a2c7b454658bd1be662f9509224db5eeee47
 SHA512:
-  metadata.gz: 2cfd5cd4a3c90a7f88aace8b30f706adc7a932ae8f1b49f30464051fddaf35cc48de2259c307d6501d4e555c934c4196ed5a841cac232d97cca1322ea1c146fb
-  data.tar.gz: 87e32807796642701f8891a2fb8c2ae6027bc8fc1b24d9e2dc1e3fe66387c6c4710af5ae306e0ef2bf3258b3f055ceb8d915729c4b9b1d35c53c35979cb103ca
+  metadata.gz: c8fbed4b5264a3d96387cb0fafe1e39f7e18ad2c1b2847ab357f9c749ff6e63028876db67ed7906ae21f765bfbac900a9dfd891faa2df981a861c63fabb14790
+  data.tar.gz: 99196a24351223263018890b8acd9d0d9c5a0adcc2d0793fe44f6f9310d4d803fead0e0930d3fc16e2ddc05d6a1459fb1c6578685d14a23f965f85f3cc2dc3c5

data/VERSION

@@ -1 +1 @@
-5.11.3
+5.12.0

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -183,7 +183,7 @@ module Blacklight::BlacklightHelperBehavior
     document = args.shift || options[:document]
 
     field = args.shift || options[:field]
-    presenter(document).render_index_field_value field, options
+    presenter(document).render_index_field_value field, options.except(:document, :field)
   end
 
   ##
@@ -236,7 +236,7 @@ module Blacklight::BlacklightHelperBehavior
     document = args.shift || options[:document]
 
     field = args.shift || options[:field]
-    presenter(document).render_document_show_field_value field, options
+    presenter(document).render_document_show_field_value field, options.except(:document, :field)
   end
 
   ##

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -14,11 +14,9 @@ module Blacklight::CatalogHelperBehavior
     entry_name = if options[:entry_name]
       options[:entry_name]
     elsif collection.respond_to? :model  # DataMapper
-        collection.model.model_name.human.downcase
+      collection.model.model_name.human.downcase
     elsif collection.respond_to? :model_name and !collection.model_name.nil? # AR, Blacklight::PaginationMethods
-        collection.model_name.human.downcase
-    elsif collection.is_a?(::Kaminari::PaginatableArray)
-      'entry'
+      collection.model_name.human.downcase
     else
       t('blacklight.entry_name.default')
     end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -159,7 +159,7 @@ module Blacklight::FacetsHelperBehavior
   # @param [String] facet field
   # @return [Boolean]
   def facet_field_in_params? field
-    params[:f] and params[:f][field]
+    !facet_params(field).blank?
   end
   
   ##
@@ -170,13 +170,17 @@ module Blacklight::FacetsHelperBehavior
   # @param [Object] facet value
   # @return [Boolean]
   def facet_in_params?(field, item)
-    if item and item.respond_to? :field
-      field = item.field
-    end
-
     value = facet_value_for_facet_item(item)
 
-    params[:f] and params[:f][field] and params[:f][field].include?(value)
+    (facet_params(field) || []).include? value
+  end
+
+  ##
+  # Get the values of the facet set in the blacklight query string
+  def facet_params field
+    config = facet_configuration_for_field(field)
+
+    params[:f][config.key] if params[:f]
   end
 
   ##

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -235,7 +235,7 @@ module Blacklight::UrlHelperBehavior
     p[:f][url_field].push(value)
 
     if item and item.respond_to?(:fq) and item.fq
-      item.fq.each do |f,v|
+      Array(item.fq).each do |f,v|
         p = add_facet_params(f, v, p)
       end
     end

data/app/views/bookmarks/_clear_bookmarks_widget.html.erb

@@ -0,0 +1 @@
+  <%= link_to t('blacklight.bookmarks.clear.action_title'), clear_bookmarks_path, :method => :delete, :data => { :confirm => t('blacklight.bookmarks.clear.action_confirm') }, :class => 'clear-bookmarks btn btn-danger' %>

data/app/views/bookmarks/index.html.erb

@@ -9,7 +9,6 @@
 
   <h3 class='section-heading'><%= t('blacklight.bookmarks.no_bookmarks') %></h3>
 <% else %>
-  <%= link_to t('blacklight.bookmarks.clear.action_title'), clear_bookmarks_path, :method => :delete, :data => { :confirm => t('blacklight.bookmarks.clear.action_confirm') }, :class => 'clear-bookmarks btn btn-danger pull-right' %>
   <%= render 'sort_and_per_page' %>
   <%= render partial: 'tools', locals: { document_list: @document_list } %>
 

data/blacklight.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "rails",     ">= 3.2.6", "< 5"
   s.add_dependency "nokogiri",  "~>1.6"     # XML Parser
-  s.add_dependency "kaminari", "~> 0.13"  # the pagination (page 1,2,3, etc..) of our search results
+  s.add_dependency "kaminari", "~> 0.15"  # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "rsolr",     "~> 1.0.11"  # Library for interacting with rSolr.
   s.add_dependency "bootstrap-sass", "~> 3.2"
   s.add_dependency "deprecation"

data/config/locales/blacklight.en.yml

@@ -188,6 +188,7 @@ en:
         more_html: 'more <span class="sr-only">%{field_name}</span> »'
         selected:
           remove: '[remove]'
+        missing: "[Missing]"
       group:
         more: 'more »'
       filters:

data/lib/blacklight.rb

@@ -8,7 +8,8 @@ module Blacklight
   autoload :Configuration, 'blacklight/configuration'
   autoload :SearchFields, 'blacklight/search_fields'
   autoload :SearchBuilder, 'blacklight/search_builder'
-  
+  autoload :SearchBuilderBehavior, 'blacklight/search_builder_behavior'
+
   autoload :Document, 'blacklight/document'
   autoload :Solr, 'blacklight/solr'
 

data/lib/blacklight/bookmarks.rb

@@ -15,6 +15,8 @@ module Blacklight::Bookmarks
 
     before_filter :verify_user
 
+    blacklight_config.add_results_collection_tool(:clear_bookmarks_widget)
+
     blacklight_config.show.document_actions[:bookmark].if = false if blacklight_config.show.document_actions[:bookmark]
     blacklight_config.show.document_actions[:sms].if = false if blacklight_config.show.document_actions[:sms]
   end

data/lib/blacklight/catalog.rb

@@ -78,7 +78,7 @@ module Blacklight::Catalog
     def facet
       @facet = blacklight_config.facet_fields[params[:id]]
       @response = get_facet_field_response(@facet.key, params)
-      @display_facet = @response.facets.first
+      @display_facet = @response.aggregations[@facet.key]
 
       @pagination = facet_paginator(@facet, @display_facet)
 

data/lib/blacklight/configuration.rb

@@ -212,7 +212,14 @@ module Blacklight
     end
 
     def search_builder_class
-      super || Blacklight::Solr::SearchBuilder
+      super || locate_search_builder_class
+    end
+
+    def locate_search_builder_class
+      ::SearchBuilder
+    rescue NameError
+      Deprecation.warn(Configuration, "Your application is missing the SearchBuilder. Have you run `rails generate blacklight:search_builder`? Falling back to Blacklight::Solr::SearchBuilder")
+      Blacklight::Solr::SearchBuilder
     end
 
     def default_per_page

data/lib/blacklight/configuration/fields.rb

@@ -82,17 +82,23 @@ module Blacklight
             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('*', '.+') + "$")
+        end
+
         # look up any dynamic fields
-        if (field_config.field || field_config.key).to_s =~ /\*/ and luke_fields
-          wildcard_field = (field_config.field || field_config.key).to_s
-          salient_fields = luke_fields.select do |k,v| 
-            k =~ Regexp.new("^" + wildcard_field.gsub('*', '.+') + "$")
+        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
@@ -123,15 +129,19 @@ module Blacklight
           return nil
         end
 
-        @table[:luke_fields] ||= begin
-          if has_key? :blacklight_solr
-            blacklight_solr.get('admin/luke', params: { fl: '*', 'json.nl' => 'map' })['fields']
+        @table[:luke_fields] ||= Rails.cache.fetch("blacklight_configuration/admin/luke", expires_in: 1.hour) do
+          begin
+            if repository_class == Blacklight::SolrRepository
+              repository = repository_class.new(self)
+              repository.send_and_receive('admin/luke', params: { fl: '*', 'json.nl' => 'map' })['fields']
+            end
+          rescue => e
+            Blacklight.logger.warn "Error retrieving field metadata: #{e}"
+            false
           end
-        rescue
-          false
         end
 
-        @table[:luke_fields] || nil
+        @table[:luke_fields] || {}
       end
 
       # Add a solr field by a solr field name and hash 

data/lib/blacklight/document.rb

@@ -26,6 +26,8 @@ module Blacklight::Document
   include Blacklight::Document::SemanticFields
   include Blacklight::Document::Export
 
+  extend Deprecation
+
   included do
     extend ActiveModel::Naming
     include Blacklight::Document::Extensions
@@ -52,7 +54,7 @@ module Blacklight::Document
   # If a method is missing, it gets sent to @_source
   # with all of the original params and block
   def method_missing(m, *args, &b)
-    if _source and _source.respond_to? m
+    if _source_responds_to?(m)
       _source.send(m, *args, &b)
     else
       super
@@ -60,7 +62,7 @@ module Blacklight::Document
   end
 
   def respond_to_missing? *args
-    (_source && _source.respond_to?(*args)) || super
+    _source_responds_to?(*args) || super
   end
 
   def [] *args
@@ -80,21 +82,29 @@ module Blacklight::Document
   # doc.has?(:location_facet, 'Clemons')
   # doc.has?(:id, 'h009', /^u/i)
   def has?(k, *values)
-    return true if key?(k) and values.empty?
-    return false if self[k].nil?
-    target = self[k]
-    if target.is_a?(Array)
-      values.each do |val|
-        return target.any?{|tv| val.is_a?(Regexp) ? (tv =~ val) : (tv==val)}
-      end
+    if !key?(k)
+      false
+    elsif values.empty?
+      self[k].present?
     else
-      return values.any? {|val| val.is_a?(Regexp) ? (target =~ val) : (target == val)}
+      Array(values).any? do |expected|
+        Array(self[k]).any? do |actual|
+          case expected
+          when Regexp
+            actual =~ expected
+          else
+            actual == expected
+          end
+        end
+      end
     end
   end
+  alias_method :has_field?, :has?
 
   def key? k
     _source.key? k
   end
+  alias_method :has_key?, :key?
 
   # helper
   # key is the name of the field
@@ -103,11 +113,24 @@ module Blacklight::Document
   #  - :default - a value to return when the key doesn't exist
   # if :sep is nil and the field is a multivalued field, the array is returned
   def get(key, opts={:sep=>', ', :default=>nil})
+    val = fetch(key, opts[:default])
+
+    if val.is_a?(Array) and opts[:sep]
+      Deprecation.warn(Blacklight::Solr::Document, "#{self.class}#get with a :sep option is deprecated; use #[] or #fetch and join the values using e.g. Array#to_sentence") unless opts[:sep].nil?
+      val.join(opts[:sep])
+    else
+      val
+    end
+  end
+  deprecation_deprecate get: "Use #[] or #fetch instead"
+
+  def fetch key, *default
     if key? key
-      val = self[key]
-      (val.is_a?(Array) and opts[:sep]) ? val.join(opts[:sep]) : val
+      self[key]
+    elsif default.empty? and !block_given?
+      raise KeyError.new("key not found \"#{key}\"")
     else
-      opts[:default]
+      (yield(self) if block_given?) || default.first
     end
   end
 
@@ -171,4 +194,11 @@ module Blacklight::Document
       self
     end  
   end
+  
+  private
+  
+  def _source_responds_to? *args
+    _source && self != _source && _source.respond_to?(*args)
+  end
+
 end

data/lib/blacklight/document_presenter.rb

@@ -82,7 +82,7 @@ module Blacklight
       end
       label = case field
       when Symbol
-        @document.get(field, :sep => nil)
+        @document[field]
       when Proc
         field.call(@document, opts)
       when String
@@ -156,10 +156,14 @@ module Blacklight
             end
           end
         when field_config
-          # regular solr
-          @document.get(field_config.field, sep: nil)
+          # regular document field
+          if field_config.default and field_config.default.is_a? Proc
+            @document.fetch(field_config.field, &field_config.default)
+          else
+            @document.fetch(field_config.field, field_config.default)
+          end
         when field
-          @document.get(field, sep: nil)
+          @document[field]
       end
 
       # rendering values

data/lib/blacklight/facet.rb

@@ -32,61 +32,13 @@ module Blacklight
     # Get a FacetField object from the @response
     def facet_by_field_name field_or_field_name
       case field_or_field_name
-        when String, Symbol
-          facet_field = facet_configuration_for_field(field_or_field_name)
-          extract_facet_by_field(facet_field)
-        when Blacklight::Configuration::FacetField
-          extract_facet_by_field(field_or_field_name)
-        else
-          field_or_field_name
-        end
-    end
-
-    private
-
-    # Get the solr response for the field :field
-    def extract_facet_by_field facet_field
-      case 
-        when (facet_field.respond_to?(:query) and facet_field.query)
-          create_facet_field_response_for_query_facet_field facet_field.key, facet_field
-        when (facet_field.respond_to?(:pivot) and facet_field.pivot)
-          create_facet_field_response_for_pivot_facet_field facet_field.key, facet_field
-        else
-          @response.facet_by_field_name(facet_field.field)
-      end
-    end
-
-    def create_facet_field_response_for_query_facet_field facet_name, facet_field
-      salient_facet_queries = facet_field.query.map { |k, x| x[:fq] }
-      items = []
-      @response.facet_queries.select { |k,v| salient_facet_queries.include?(k) }.reject { |value, hits| hits == 0 }.map do |value,hits|
-        salient_fields = facet_field.query.select { |key, val| val[:fq] == value }
-        key = ((salient_fields.keys if salient_fields.respond_to? :keys) || salient_fields.first).first
-        items << Blacklight::SolrResponse::Facets::FacetItem.new(:value => key, :hits => hits, :label => facet_field.query[key][:label])
+      when String, Symbol, Blacklight::Configuration::FacetField
+        facet_field = facet_configuration_for_field(field_or_field_name)
+        @response.aggregations[facet_field.key]
+      else
+        # is this really a useful case?
+        field_or_field_name
       end
-   
-      Blacklight::SolrResponse::Facets::FacetField.new facet_name, items
-    end
-
-
-    def create_facet_field_response_for_pivot_facet_field facet_name, facet_field
-      items = []
-      (@response.facet_pivot[facet_field.pivot.join(",")] || []).map do |lst|
-        items << construct_pivot_field(lst)
-      end
-   
-      Blacklight::SolrResponse::Facets::FacetField.new facet_name, items
-    end
-
-    def construct_pivot_field lst, parent_fq = {}
-      items = []
-
-      lst[:pivot].each do |i|
-        items << construct_pivot_field(i, parent_fq.merge({ lst[:field] => lst[:value] }))
-      end if lst[:pivot]
-
-      Blacklight::SolrResponse::Facets::FacetItem.new(:value => lst[:value], :hits => lst[:count], :field => lst[:field], :items => items, :fq => parent_fq)
-
     end
   end
 end

data/lib/blacklight/request_builders.rb

@@ -184,8 +184,8 @@ module Blacklight
       facet = blacklight_config.facet_fields[facet_field]
       return if facet.blank?
 
-      if facet.limit and @response and @response.facet_by_field_name(facet_field)
-        limit = @response.facet_by_field_name(facet_field).limit
+      if facet.limit and @response and @response.aggregations[facet_field]
+        limit = @response.aggregations[facet_field].limit
 
         if limit.nil? # we didn't get or a set a limit, so infer one.
           facet.limit if facet.limit != true

data/lib/blacklight/search_builder.rb

@@ -80,34 +80,64 @@ module Blacklight
       scope.blacklight_config
     end
 
-    protected
-    def request
-      Blacklight::Solr::Request.new
+    def start start = nil
+      if start
+        @start = start.to_i
+        self
+      else
+        @start ||= (page - 1) * (rows || 10)
+
+        val = @start || 0
+        val = 0 if @start < 0
+        val
+      end
     end
+    alias_method :padding, :start
 
-    def page
-      if blacklight_params[:page].blank?
-        1
+    def page page = nil
+      if page
+        @page = page.to_i
+        @page = 1 if @page < 1
+        self
       else
-        blacklight_params[:page].to_i
+        @page ||= begin
+          page = if blacklight_params[:page].blank?
+            1
+          else
+            blacklight_params[:page].to_i
+          end
+
+          page
+        end
       end
     end
 
-    def rows default = nil
-      # default number of rows
-      rows = default
-      rows ||= blacklight_config.default_per_page
-      rows ||= 10
+    def rows rows = nil
+      if rows
+        @rows = rows.to_i
+        @rows = blacklight_config.max_per_page if @rows > blacklight_config.max_per_page
+        self
+      else
+        @rows ||= begin
+          rows = blacklight_config.default_per_page
 
-      # user-provided parameters should override any default row
-      rows = blacklight_params[:rows].to_i unless blacklight_params[:rows].blank?
-      rows = blacklight_params[:per_page].to_i unless blacklight_params[:per_page].blank?
+          # user-provided parameters should override any default row
+          rows = blacklight_params[:rows].to_i unless blacklight_params[:rows].blank?
+          rows = blacklight_params[:per_page].to_i unless blacklight_params[:per_page].blank?
 
-      # ensure we don't excede the max page size
-      rows = blacklight_config.max_per_page if rows.to_i > blacklight_config.max_per_page
+          # ensure we don't excede the max page size
+          rows = blacklight_config.max_per_page if rows.to_i > blacklight_config.max_per_page
 
+          rows.to_i unless rows.nil?
+        end
+      end
+    end
 
-      rows
+    alias_method :per, :rows
+
+    protected
+    def request
+      Blacklight::Solr::Request.new
     end
 
     def sort