blacklight 3.6.1.1 → 3.7.0

data/VERSION

@@ -1 +1 @@
-3.6.1.1
+3.7.0

data/app/controllers/bookmarks_controller.rb

@@ -3,40 +3,14 @@
 # take the Solr document ID as the :id, NOT the id of the actual Bookmark action. 
 class BookmarksController < ApplicationController
 
-  before_filter :require_user_authentication_provider
   before_filter :verify_user
-  
-  # Beware, :id is the Solr document_id, not the actual Bookmark id.
-  # idempotent, as PUT is supposed to be. 
-  # you can also send a bookmark[title] param, which will be used for simplest case
-  # or fall through display of Bookmark in list. 
-  def update
-    bookmark = current_user.existing_bookmark_for(params[:id])
-    if bookmark
-      #update existing one with new values if present
-      bookmark.attributes = params[:bookmark] if params[:bookmark]
-    else
-      # create new one with values and document_id
-      bookmark = current_user.bookmarks.build(params[:bookmark].merge(:document_id => params[:id]))      
-    end
-    
-    success = bookmark.save
-    
-    unless request.xhr?
-      if success
-        flash[:notice] = I18n.t('blacklight.bookmarks.add.success')
-      else
-        flash[:error] = I18n.t('blacklight.bookmarks.add.failure') 
-      end
-      redirect_to :back
-    else
-      #ajaxy request doesn't need a redirect and shouldn't have flash set
-      render :text => "", :status => (success ? "200" : "500" )
-    end    
-  end
 
   def index
-    @bookmarks = current_user.bookmarks.page(params[:page])
+    @bookmarks = current_or_guest_user.bookmarks.page(params[:page])
+  end
+
+  def update
+    create
   end
 
   # For adding a single bookmark, suggest use PUT/#update to 
@@ -49,27 +23,35 @@ class BookmarksController < ApplicationController
   # is simpler. 
   def create
     @bookmarks = params[:bookmarks] || []
-    @bookmarks << params[:bookmark] if params[:bookmark]
-    
-    success = true
-    @bookmarks.each do |key, bookmark|
-      success = false unless current_user.bookmarks.create(bookmark)
+
+    if params[:bookmark]
+      params[:bookmark][:document_id] ||= params[:id]
+      @bookmarks << params[:bookmark] if params[:bookmark]
+     end
+
+    success = @bookmarks.all? do |bookmark|
+      current_or_guest_user.bookmarks.create(bookmark) unless current_or_guest_user.existing_bookmark_for(bookmark[:document_id])
     end
-    if @bookmarks.length > 0 && success
-      flash[:notice] = I18n.t('blacklight.bookmarks.add.success', :count => @bookmarks.length)
-    elsif @bookmarks.length > 0
-      flash[:error] = I18n.t('blacklight.bookmarks.add.failure', :count => @bookmarks.length)
+
+    if request.xhr?
+      render :text => "", :status => (success ? "200" : "500" )
+    else
+      if @bookmarks.length > 0 && success
+        flash[:notice] = I18n.t('blacklight.bookmarks.add.success', :count => @bookmarks.length)
+      elsif @bookmarks.length > 0
+        flash[:error] = I18n.t('blacklight.bookmarks.add.failure', :count => @bookmarks.length)
+      end
+
+      redirect_to :back
     end
-    
-    redirect_to :back
   end
   
   # Beware, :id is the Solr document_id, not the actual Bookmark id.
   # idempotent, as DELETE is supposed to be. 
   def destroy
-    bookmark = current_user.existing_bookmark_for(params[:id])
+    bookmark = current_or_guest_user.existing_bookmark_for(params[:id])
     
-    success = (!bookmark) || current_user.bookmarks.delete(bookmark)
+    success = (!bookmark) || current_or_guest_user.bookmarks.delete(bookmark)
     
     unless request.xhr?
       if success
@@ -85,7 +67,7 @@ class BookmarksController < ApplicationController
   end
   
   def clear    
-    if current_user.bookmarks.clear
+    if current_or_guest_user.bookmarks.clear
       flash[:notice] = I18n.t('blacklight.bookmarks.clear.success') 
     else
       flash[:error] = I18n.t('blacklight.bookmarks.clear.failure') 
@@ -95,6 +77,6 @@ class BookmarksController < ApplicationController
   
   protected
   def verify_user
-    flash[:notice] = I18n.t('blacklight.bookmarks.need_login') and raise Blacklight::Exceptions::AccessDenied  unless current_user
+    flash[:notice] = I18n.t('blacklight.bookmarks.need_login') and raise Blacklight::Exceptions::AccessDenied  unless current_or_guest_user
   end
 end

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -73,21 +73,19 @@ module Blacklight::BlacklightHelperBehavior
   end
   
   # Save function area for search results 'index' view, normally
-  # renders next to title. Includes just 'Folder' by default.
+  # renders next to title. 
   def render_index_doc_actions(document, options={})   
     content = []
-    content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if has_user_authentication_provider? and current_user
-    content << render(:partial => 'catalog/folder_control', :locals => {:document=> document}.merge(options))
+    content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if has_user_authentication_provider? and current_or_guest_user
 
     content_tag("div", content.join("\n").html_safe, :class=>"documentFunctions")
   end
   
   # Save function area for item detail 'show' view, normally
-  # renders next to title. By default includes 'Folder' and 'Bookmarks'
+  # renders next to title. By default includes 'Bookmarks'
   def render_show_doc_actions(document=@document, options={})
     content = []
-    content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if has_user_authentication_provider? and current_user
-    content << render(:partial => 'catalog/folder_control', :locals => {:document=> document}.merge(options))
+    content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if has_user_authentication_provider? and current_or_guest_user
 
     content_tag("div", content.join("\n").html_safe, :class=>"documentFunctions")
   end
@@ -344,11 +342,6 @@ module Blacklight::BlacklightHelperBehavior
     return result
   end
   
-  # determines if the given document id is in the folder
-  def item_in_folder?(doc_id)
-    session[:folder_document_ids] && session[:folder_document_ids].include?(doc_id) ? true : false
-  end
-  
   # puts together a collection of documents into one refworks export string
   def render_refworks_texts(documents)
     val = ''

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -32,14 +32,15 @@ module Blacklight::FacetsHelperBehavior
   def facet_by_field_name solr_field
     case solr_field
       when String, Symbol
-        @response.facet_by_field_name(solr_field)
+        extract_solr_facet_by_field_name(solr_field)
       when Blacklight::Configuration::FacetField
-        @response.facet_by_field_name(solr_field.field)
+        extract_solr_facet_by_field_name(solr_field.field)
       else
         solr_field
       end
   end
 
+
   # used in the catalog/_facets partial and elsewhere
   # Renders a single section for facet limit with a specified
   # solr field used for faceting. Can be over-ridden for custom
@@ -95,7 +96,7 @@ module Blacklight::FacetsHelperBehavior
   # options consist of:
   # :suppress_link => true # do not make it a link, used for an already selected value for instance
   def render_facet_value(facet_solr_field, item, options ={})    
-    (link_to_unless(options[:suppress_link], item.value, add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select label") + " " + render_facet_count(item.hits)).html_safe
+    (link_to_unless(options[:suppress_link], ((item.label if item.respond_to?(:label)) || item.value), add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select label") + " " + render_facet_count(item.hits)).html_safe
   end
 
   # Standard display of a SELECTED facet value, no link, special span
@@ -117,9 +118,18 @@ module Blacklight::FacetsHelperBehavior
   # is suitable for a redirect. See
   # add_facet_params_and_redirect
   def add_facet_params(field, value)
+    facet_config = facet_configuration_for_field(field)
+
+ 
+
     p = params.dup
     p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
     p[:f][field] = (p[:f][field] || []).dup
+
+    if facet_config.single and not p[:f][field].empty?
+      p[:f][field] = []
+    end
+    
     p[:f][field].push(value)
     p
   end
@@ -172,5 +182,48 @@ module Blacklight::FacetsHelperBehavior
   def facet_in_params?(field, value)
     params[:f] and params[:f][field] and params[:f][field].include?(value)
   end
-  
+
+  def facet_display_value field, value
+
+    facet_config = facet_configuration_for_field(field)
+
+    display_label = value
+
+    if facet_config.query and facet_config.query[value]
+      display_label = facet_config.query[value][:label]     
+    end
+
+    if facet_config.date
+      localization_options = {}
+      localization_options = facet_config.date unless facet_config.date === true
+      display_label = l(value.to_datetime, localization_options)
+    end
+
+    display_label
+  end
+
+  private
+
+  # Get the solr response for the solr field :field
+  def extract_solr_facet_by_field_name facet_name
+    facet_field = facet_configuration_for_field(facet_name)
+    case 
+      when facet_field.query
+        create_rsolr_facet_field_response_for_query_facet_field facet_name, facet_field     
+      else
+        @response.facet_by_field_name(facet_name)
+    end
+  end
+
+  def create_rsolr_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 << OpenStruct.new(:value => key, :hits => hits, :label => facet_field.query[key][:label])
+    end
+ 
+    RSolr::Ext::Response::Facets::FacetField.new facet_name, items
+  end
 end

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -43,9 +43,12 @@ module Blacklight::RenderConstraintsHelperBehavior
   end
 
   def render_filter_element(facet, values, localized_params)
+    facet_config = facet_configuration_for_field(facet)
+
     values.map do |val|
+
       render_constraint_element( facet_field_labels[facet],
-                  val, 
+                  facet_display_value(facet, val), 
                   :remove => url_for(remove_facet_params(facet, val, localized_params)),
                   :classes => ["filter", "filter-" + facet.parameterize] 
                 ) + "\n"                 					            

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -41,7 +41,7 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
   # 'and'.   Pass in option :escape_value => false to pass in pre-rendered
   # html for value. key with escape_key if needed.  
   def render_search_to_s_element(key, value, options = {})
-    content_tag(:span, render_filter_name(key) + render_filter_value(value), :class => 'constraint')
+    content_tag(:span, render_filter_name(key) + render_filter_value(value, key), :class => 'constraint')
   end
 
   def render_filter_name name
@@ -49,8 +49,10 @@ module Blacklight::SearchHistoryConstraintsHelperBehavior
     content_tag(:span, t('blacklight.search.filters.label', :label => name), :class => 'filterName')
   end
 
-  def render_filter_value value
-    content_tag(:span, h(value), :class => 'filterValue')
+  def render_filter_value value, key = nil
+    display_value = value
+    display_value = facet_display_value(key, value) if key
+    content_tag(:span, h(display_value), :class => 'filterValue')
   end
 
 end

data/app/views/_user_util_links.html.erb

@@ -1,15 +1,16 @@
 <% if has_user_authentication_provider? %>
-  <% if current_user%>
+<% if current_user %>
   <%= link_to t('blacklight.header_links.logout'), destroy_user_session_path %> [<%= link_to current_user, edit_user_registration_path %>]
+<% else %>
+  <%= link_to t('blacklight.header_links.login'), new_user_session_path %>
+<% end %>
     | 
+<% end %>
     <%= link_to t('blacklight.header_links.bookmarks'), bookmarks_path %>
+ <% if current_user %>
     |
     <%= link_to t('blacklight.header_links.saved_searches'), saved_searches_path %>
-<% else %>
-  <%= link_to t('blacklight.header_links.login'), new_user_session_path %>
 <% end %>
-| 
-<% end %>
-<%= link_to t('blacklight.header_links.selected_items'), folder_index_path %> (<span id="folder_number"><%= "#{session[:folder_document_ids] ? session[:folder_document_ids].length : 0}" %></span>)
-|
+    |
 <%= link_to t('blacklight.header_links.search_history'), search_history_path %>
+

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

@@ -1,6 +1,6 @@
 <h1><%= t('blacklight.bookmarks.title') %></h1>
 
-<%- if current_user.blank? -%>
+<%- if current_or_guest_user.blank? -%>
   
   <h2><%= t('blacklight.bookmarks.need_login') %></h2>
   

data/app/views/catalog/_bookmark_control.html.erb

@@ -1,5 +1,5 @@
-<% if has_user_authentication_provider? and current_user %>
-  <%- existing_bookmark = current_user.existing_bookmark_for(document.id) -%>
+<% if has_user_authentication_provider? and current_or_guest_user %>
+  <%- existing_bookmark = current_or_guest_user.existing_bookmark_for(document.id) -%>
   <%- 
   # Note these two forms are pretty similar but for different :methods, classes, and labels. 
   # but it was simpler to leave them seperate instead of DRYing them, got confusing trying that.

data/lib/blacklight/configuration.rb

@@ -15,7 +15,8 @@ module Blacklight
       :show => OpenStructWithHashAccess.new(:html_title => SolrDocument.unique_key, :heading => SolrDocument.unique_key),
       :index => OpenStructWithHashAccess.new(:show_link => SolrDocument.unique_key),
       :spell_max => 5,
-      :max_per_page => 100
+      :max_per_page => 100,
+      :add_facet_fields_to_solr_request => false
     }
 
 
@@ -23,6 +24,7 @@ module Blacklight
     require 'blacklight/configuration/fields'
     require 'blacklight/configuration/solr_field'
     require 'blacklight/configuration/search_field'
+    require 'blacklight/configuration/facet_field'
     require 'blacklight/configuration/sort_field'
     include Fields
 
@@ -68,6 +70,17 @@ module Blacklight
       field
     end
 
+    # Add any configured facet fields to the default solr parameters hash
+    def add_facet_fields_to_solr_request!
+      self.add_facet_fields_to_solr_request = true
+    end
+
+    def facet_fields_to_add_to_solr
+      return facet_fields.reject { |k,v| v[:query] }.map { |k,v| v.field } if self.add_facet_fields_to_solr_request
+
+      []
+    end
+
     ##
     # Provide a 'deep copy' of Blacklight::Configuration that can be modifyed without affecting
     # the original Blacklight::Configuration instance.

data/lib/blacklight/configuration/facet_field.rb

@@ -0,0 +1,14 @@
+module Blacklight
+  class Configuration::FacetField < Blacklight::Configuration::SolrField
+    def normalize! blacklight_config         
+      self.query.stringify_keys! if self.query
+
+      if self.single and self.tag.blank? and self.ex.blank?
+        self.tag = "#{self.field}_single"
+        self.ex = "#{self.field}_single"
+      end
+      super
+    end
+  end
+end
+

data/lib/blacklight/controller.rb

@@ -25,6 +25,22 @@ module Blacklight::Controller
     base.send :helper_method, :stylesheet_links
     base.send :helper_method, :javascript_includes
     base.send :helper_method, :has_user_authentication_provider?
+
+
+    # This callback runs when a user first logs in
+    base.set_callback :logging_in_user, :before, :transfer_guest_user_actions_to_current_user rescue nil
+
+  end
+
+  def method_missing(meth, *args, &block)
+    if meth.to_s == "current_or_guest_user"
+      # Add the method
+      define_method(meth) { blacklight_current_or_guest_user }
+
+      blacklight_current_or_guest_user
+    else
+      super
+    end
   end
 
     # test for exception notifier plugin
@@ -96,15 +112,17 @@ module Blacklight::Controller
       'blacklight'
     end
 
-    def current_user_session
-      puts "DEPRICATED:  Please use Devise, Authlogic or other authentication system."
-      user_session  # method provided by devise
-    end
-
-    # Should be provided by devise
+    # Should be provided by authentication provider
     # def current_user
     # end
-    
+    # def current_or_guest_user
+    # end
+
+    # Here's a stub implementation we'll add if it isn't provided for us
+    def blacklight_current_or_guest_user
+      current_user if has_user_authentication_provider?
+    end
+
     ##
     # We discard flash messages generated by the xhr requests to avoid
     # confusing UX.
@@ -122,6 +140,25 @@ module Blacklight::Controller
     def require_user_authentication_provider
       raise ActionController::RoutingError.new('Not Found') unless has_user_authentication_provider?
     end
+
+    ##
+    # When a user logs in, transfer any saved searches or bookmarks to the current_user
+    def transfer_guest_user_actions_to_current_user
+      return unless respond_to? :current_user and respond_to? :guest_user and current_user and guest_user
+      current_user_searches = current_user.searches.all.collect(&:query_params)
+      current_user_bookmarks = current_user.bookmarks.all.collect(&:document_id)
+
+      guest_user.searches.all.reject { |s| current_user_searches.include?(s.query_params)}.each do |s| 
+        s.user_id = current_user.id 
+        s.save 
+      end
+
+      guest_user.bookmarks.all.reject { |b| current_user_bookmarks.include?(b.document_id)}.each do |b| 
+        b.user_id = current_user.id 
+        b.save
+      end
+    end
+
     ##
     # To handle failed authorization attempts, redirect the user to the 
     # login form and persist the current request uri as a parameter