blacklight 5.3.0 → 5.4.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d93877de36068052dea5532f02351756789a2bd
-  data.tar.gz: 9103ab9e7d7a91c17de2233aed70f0f3e7df5c4c
+  metadata.gz: 540546b2abe3b14b82ac1bf0bc9c079db212a291
+  data.tar.gz: 7fa2ffa45e80e88b3d02a744124b94be1f7b64a5
 SHA512:
-  metadata.gz: 7eec942d25ae5133dff56c7dbe1b3d169b01510bfdb86adfb99ba533e230e04287c988f86b58e9104e62a6617f3c93bc1bca009085ed6be98bdbb03ccedc5c5e
-  data.tar.gz: dd0767408947a969b6bb130b65d38e243e664d2efce6667d9d23d29b6c8bff5847a3909104f4da4d53782e890e82c23c984f2e8b370e46e398a5d78872179806
+  metadata.gz: a06c30a6d5e7b2bb8686ed8f80a8bad01e237b9bf52d6af2fb63c546c15a631e4b8f77c033afffcd231499101d404369d8eda26c2ed58f18f02b8e490c4884d4
+  data.tar.gz: b47793969ac19bd39fc851cd1ade641be5b97c84ecc2bdbc34a0412ca628150833c2d50dda1f093ba4e8d331543c46fb5ca6e5b5d5978a38d79610177b5ce26a

data/Gemfile

@@ -4,7 +4,9 @@ source 'https://rubygems.org'
 gemspec path: File.expand_path('..', __FILE__)
 
 
-gem 'simplecov', require: false
+# Peg simplecov to < 0.8 until this is resolved:
+# https://github.com/colszowka/simplecov/issues/281
+gem 'simplecov', '~> 0.7.1', require: false
 gem 'coveralls', require: false
 
 gem 'engine_cart', '~> 0.3.0'

data/VERSION

@@ -1 +1 @@
-5.3.0
+5.4.0.rc1

data/app/assets/javascripts/blacklight/blacklight.js

@@ -9,6 +9,7 @@
 //= require blacklight/bookmark_toggle
 //= require blacklight/ajax_modal
 //= require blacklight/search_context
+//= require blacklight/collapsable
 //
 //Bootstrap JS for providing collapsable tablet/mobile menu/alert boxes
 //= require bootstrap/transition

data/app/assets/javascripts/blacklight/collapsable.js

@@ -0,0 +1,9 @@
+(function($) {
+  Blacklight.onLoad(function() {
+    // when clicking on a link that toggles the collapsing behavior, don't do anything
+    // with the hash or the page could jump around.
+    $(document).on("click", "a[data-toggle=collapse][href='#'], [data-toggle=collapse] a[href='#']", function(event) {
+      event.preventDefault();
+    });
+  });
+})(jQuery);

data/app/controllers/bookmarks_controller.rb

@@ -9,6 +9,10 @@ class BookmarksController < CatalogController
   include Blacklight::SolrHelper
 
   copy_blacklight_config_from(CatalogController)
+
+  rescue_from Blacklight::Exceptions::ExpiredSessionToken do
+    head :unauthorized
+  end
  
   # Blacklight uses #search_action_url to figure out the right URL for
   # the global search box
@@ -19,12 +23,25 @@ class BookmarksController < CatalogController
   before_filter :verify_user
 
   def index
-    @bookmarks = current_or_guest_user.bookmarks
+    @bookmarks = token_or_current_or_guest_user.bookmarks
     bookmark_ids = @bookmarks.collect { |b| b.document_id.to_s }
   
-    @response, @document_list = get_solr_response_for_field_values(SolrDocument.unique_key, bookmark_ids)
+    @response, @document_list = get_solr_response_for_document_ids(bookmark_ids)
+
+    respond_to do |format|
+      format.html { }
+      format.rss  { render :layout => false }
+      format.atom { render :layout => false }
+      format.json do
+        render json: render_search_results_as_json
+      end
+
+      additional_response_formats(format)
+      document_export_formats(format)
+    end
   end
 
+
   def update
     create
   end
@@ -41,13 +58,13 @@ class BookmarksController < CatalogController
     if params[:bookmarks]
       @bookmarks = params[:bookmarks]
     else
-      @bookmarks = [{ :document_id => params[:id] }]
+      @bookmarks = [{ document_id: params[:id], document_type: blacklight_config.solr_document_model.to_s }]
     end
 
     current_or_guest_user.save! unless current_or_guest_user.persisted?
 
     success = @bookmarks.all? do |bookmark|
-      current_or_guest_user.bookmarks.create(bookmark) unless current_or_guest_user.existing_bookmark_for(bookmark[:document_id])
+      current_or_guest_user.bookmarks.create(bookmark) unless current_or_guest_user.bookmarks.where(bookmark).exists?
     end
 
     if request.xhr?
@@ -66,10 +83,10 @@ class BookmarksController < CatalogController
   # Beware, :id is the Solr document_id, not the actual Bookmark id.
   # idempotent, as DELETE is supposed to be. 
   def destroy
-    bookmark = current_or_guest_user.existing_bookmark_for(params[:id])
-    
-    success = (!bookmark) || current_or_guest_user.bookmarks.delete(bookmark)
-    
+    bookmark = current_or_guest_user.bookmarks.where(document_id: params[:id], document_type: blacklight_config.solr_document_model).first
+
+    success = bookmark && bookmark.delete && bookmark.destroyed?
+
     unless request.xhr?
       if success
         flash[:notice] =  I18n.t('blacklight.bookmarks.remove.success')
@@ -94,10 +111,56 @@ class BookmarksController < CatalogController
   
   protected
   def verify_user
-    flash[:notice] = I18n.t('blacklight.bookmarks.need_login') and raise Blacklight::Exceptions::AccessDenied  unless current_or_guest_user
+    unless current_or_guest_user or (action == "index" and token_or_current_or_guest_user)
+      flash[:notice] = I18n.t('blacklight.bookmarks.need_login') and raise Blacklight::Exceptions::AccessDenied
+    end
   end
 
   def start_new_search_session?
     action_name == "index"
   end
+
+  # Used for #export action, with encrypted user_id.
+  def decrypt_user_id(encrypted_user_id)
+    user_id, timestamp = message_encryptor.decrypt_and_verify(encrypted_user_id)
+
+    if timestamp < 1.hour.ago
+      raise Blacklight::Exceptions::ExpiredSessionToken.new
+    end
+
+    user_id
+  end
+
+  # Used for #export action with encrypted user_id, available
+  # as a helper method for views.
+  def encrypt_user_id(user_id)
+    message_encryptor.encrypt_and_sign([user_id, Time.now])
+  end
+  helper_method :encrypt_user_id
+  
+  ##
+  # This method provides Rails 3 compatibility to our message encryptor.
+  # When we drop support for Rails 3, we can just use the AS::KeyGenerator
+  # directly instead of this helper.
+  def bookmarks_export_secret_token salt
+    OpenSSL::PKCS5.pbkdf2_hmac_sha1(Blacklight.secret_key, salt, 1000, 64)
+  end
+  
+  def message_encryptor
+    derived_secret = bookmarks_export_secret_token("bookmarks session key")
+    ActiveSupport::MessageEncryptor.new(derived_secret)
+  end
+  
+  def token_or_current_or_guest_user
+    token_user || current_or_guest_user
+  end
+  
+  def token_user
+    @token_user ||= if params[:encrypted_user_id]
+      user_id = decrypt_user_id params[:encrypted_user_id]
+      User.find(user_id)
+    else
+      nil
+    end
+  end
 end

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -134,9 +134,7 @@ module Blacklight::BlacklightHelperBehavior
   # @param [Blacklight::Solr::Configuration::SolrField] solr_field
   # @return [Boolean]
   def should_render_index_field? document, solr_field
-    document.has?(solr_field.field) ||
-      (document.has_highlight_field? solr_field.field if solr_field.highlight) ||
-      solr_field.accessor
+    should_render_field?(solr_field, document) && document_has_value?(document, solr_field)
   end
 
   ##
@@ -146,9 +144,19 @@ module Blacklight::BlacklightHelperBehavior
   # @param [Blacklight::Solr::Configuration::SolrField] solr_field
   # @return [Boolean]
   def should_render_show_field? document, solr_field
-    document.has?(solr_field.field) ||
-      (document.has_highlight_field? solr_field.field if solr_field.highlight) ||
-      solr_field.accessor
+    should_render_field?(solr_field, document) && document_has_value?(document, solr_field)
+  end
+  
+  ##
+  # Check if a document has (or, might have, in the case of accessor methods) a value for
+  # the given solr field
+  # @param [SolrDocument] document
+  # @param [Blacklight::Solr::Configuration::SolrField] solr_field
+  # @return [Boolean]
+  def document_has_value? document, field_config
+    document.has?(field_config.field) ||
+      (document.has_highlight_field? field_config.field if field_config.highlight) ||
+      field_config.accessor
   end
 
   ##
@@ -378,7 +386,7 @@ module Blacklight::BlacklightHelperBehavior
   # @return [String]
   def render_document_index documents = nil, locals = {}
     documents ||= @document_list
-    render_document_index_with_view(document_index_view_type, documents)
+    render_document_index_with_view(document_index_view_type, documents, locals)
   end
 
   ##

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -87,15 +87,6 @@ module Blacklight::CatalogHelperBehavior
     (@response.rows if @response and @response.rows > 0) || params.fetch(:per_page, default_per_page).to_i
   end
 
-  ##
-  # Export to Refworks URL
-  # 
-  # @param [SolrDocument]
-  # @return [String]
-  def refworks_export_url(document = @document)
-    "http://www.refworks.com/express/expressimport.asp?vendor=#{CGI.escape(application_name)}&filter=MARC%20Format&encoding=65001&url=#{CGI.escape(polymorphic_path(document, :format => 'refworks_marc_txt', :only_path => false))}"
-  end
-
   ##
   # Get the classes to add to a document's div
   # 
@@ -205,4 +196,21 @@ module Blacklight::CatalogHelperBehavior
   def default_view_type_group_icon_classes view
     "glyphicon-#{view.to_s.parameterize } view-icon-#{view.to_s.parameterize}"
   end
+  
+  def current_bookmarks response = nil
+    response ||= @response
+    @current_bookmarks ||= current_or_guest_user.bookmarks_for_documents(response.documents).to_a
+  end
+  
+  def render_marc_tools
+    return unless defined? Blacklight::Marc
+    
+    begin
+      # blacklight-marc 5.4+
+      render 'marc_tools'
+    rescue ActionView::MissingTemplate
+      # blacklight-marc 5.0+
+      render('endnote') + render('refworks')
+    end
+  end
 end

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -11,13 +11,26 @@ module Blacklight::ConfigurationHelperBehavior
 
   # Used in the document_list partial (search view) for building a select element
   def sort_fields
-    blacklight_config.sort_fields.map { |key, x| [x.label, x.key] }
+    active_sort_fields.map { |key, x| [x.label, x.key] }
+  end
+  
+  def active_sort_fields
+    blacklight_config.sort_fields.select { |sort_key, field_config| should_render_field?(field_config) }
   end
 
   # Used in the search form partial for building a select tag
   def search_fields
     search_field_options_for_select
   end
+  
+  # Returns suitable argument to options_for_select method, to create
+  # an html select based on #search_field_list. Skips search_fields
+  # marked :include_in_simple_select => false
+  def search_field_options_for_select
+    blacklight_config.search_fields.collect do |key, field_def|
+      [field_def.label,  field_def.key] if should_render_field?(field_def)
+    end.compact
+  end
 
   # used in the catalog/_show/_default partial
   def document_show_fields document=nil
@@ -63,10 +76,10 @@ module Blacklight::ConfigurationHelperBehavior
   ##
   # Look up the label for a solr field.
   #
-  # @overload
+  # @overload label
   #   @param [Symbol] an i18n key 
   #
-  # @overload
+  # @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
@@ -84,16 +97,22 @@ module Blacklight::ConfigurationHelperBehavior
     t(first, default: rest)
   end
   
+  def document_index_views
+    blacklight_config.view.select do |k, config|
+      should_render_field? config
+    end
+  end
+  
   ##
   # Get the default index view type
   def default_document_index_view_type
-    blacklight_config.view.keys.first
+    document_index_views.select { |k,config| config.respond_to? :default and config.default }.keys.first || document_index_views.keys.first
   end
 
   ##
   # Check if there are alternative views configuration
   def has_alternative_views?
-    blacklight_config.view.keys.length > 1
+    document_index_views.keys.length > 1
   end
 
   ##
@@ -104,13 +123,13 @@ module Blacklight::ConfigurationHelperBehavior
 
   # Used in the document list partial (search view) for creating a link to the document show action
   def document_show_link_field document=nil
-    blacklight_config.view_config(document_index_view_type).title_field.to_sym
+    blacklight_config.view_config(document_index_view_type).title_field.try(:to_sym) || document.id
   end
 
   ##
   # Default sort field
   def default_sort_field
-    blacklight_config.sort_fields.first.last if blacklight_config.sort_fields.first
+    (active_sort_fields.select { |k,config| config.respond_to? :default and config.default }.first || active_sort_fields.first).try(:last)
   end
 
   ##
@@ -126,4 +145,37 @@ module Blacklight::ConfigurationHelperBehavior
       [t(:'blacklight.search.per_page.label', :count => count).html_safe, count]
     end
   end
+  
+  ##
+  # Determine whether to render a field by evaluating :if and :unless conditions
+  #
+  # @param [SolrDocument] document
+  # @param [Blacklight::Solr::Configuration::SolrField] solr_field
+  # @return [Boolean]
+  def should_render_field? field_config, *args
+    return field_config if field_config === true or field_config === false
+    
+    if_value = !field_config.respond_to?(:if) || field_config.if.nil? || evaluate_configuration_conditional(field_config.if, field_config, *args)
+    
+    unless_value = !field_config.respond_to?(:unless) ||  field_config.unless.nil? || !evaluate_configuration_conditional(field_config.unless, field_config, *args)
+
+    if_value && unless_value
+  end
+  
+  def evaluate_configuration_conditional proc_helper_or_boolean, *args_for_procs_and_methods
+    case proc_helper_or_boolean
+    when Symbol
+      arity = method(proc_helper_or_boolean).arity
+
+      if arity == 0
+        send(proc_helper_or_boolean)
+      else 
+        send(proc_helper_or_boolean, *args_for_procs_and_methods)
+      end
+    when Proc
+      proc_helper_or_boolean.call self, *args_for_procs_and_methods
+    else
+      proc_helper_or_boolean
+    end
+  end
 end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -60,22 +60,7 @@ module Blacklight::FacetsHelperBehavior
   def should_render_facet? display_facet
     # display when show is nil or true
     facet_config = facet_configuration_for_field(display_facet.name)
-
-    display = case facet_config.show
-    when Symbol
-      arity = method(facet_config.show).arity
-
-      if arity == 0
-        send(facet_config.show)
-      else 
-        send(facet_config.show, display_facet)
-      end
-    when Proc
-      facet_config.show.call self, facet_config, display_facet
-    else
-      facet_config.show
-    end
-
+    display = should_render_field?(facet_config, display_facet)
     return display && display_facet.items.present?
   end
 

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -7,11 +7,11 @@ module Blacklight::UrlHelperBehavior
   # Extension point for downstream applications
   # to provide more interesting routing to
   # documents
-  def url_for_document doc
+  def url_for_document doc, options = {}
     if respond_to?(:blacklight_config) and
         blacklight_config.show.route and
         (!doc.respond_to?(:to_model) or doc.to_model.is_a? SolrDocument)
-      route = blacklight_config.show.route.merge(action: :show, id: doc)
+      route = blacklight_config.show.route.merge(action: :show, id: doc).merge(options)
       route[:controller] = controller_name if route[:controller] == :current
       route
     else
@@ -260,6 +260,25 @@ module Blacklight::UrlHelperBehavior
     p.delete(:f) if p[:f].empty?
     p
   end
+  
+  # A URL to refworks export, with an embedded callback URL to this app. 
+  # the callback URL is to bookmarks#export, which delivers a list of 
+  # user's bookmarks in 'refworks marc txt' format -- we tell refworks
+  # to expect that format. 
+  def bookmarks_export_url(format, params = {})
+    bookmarks_url(params.merge(format: :format, encrypted_user_id: encrypt_user_id(current_or_guest_user.id) ))
+  end
+  
+  # This method should move to BlacklightMarc in Blacklight 6.x
+  def refworks_export_url params = {}
+    if params.is_a? ::SolrDocument or (params.nil? and instance_variable_defined? :@document)
+      Deprecation.warn self, "#refworks_export_url with a SolrDocument is deprecated. Pass in { url: url_for_document(@document) } instead"
+      url = url_for_document(params || @document, format: :refworks_marc_txt, only_path: false)
+      params = { url: url }
+    end
+    
+    "http://www.refworks.com/express/expressimport.asp?vendor=#{CGI.escape(params[:vendor] || application_name)}&filter=#{CGI.escape(params[:filter] || "MARC Format")}&encoding=65001" + (("&url=#{CGI.escape(params[:url])}" if params[:url]) || "")
+  end
 
   if ::Rails.version < "4.0"
     def asset_url *args

data/app/models/bookmark.rb

@@ -1,13 +1,22 @@
 # -*- encoding : utf-8 -*-
 class Bookmark < ActiveRecord::Base
   
-  belongs_to :user
-  validates_presence_of :user_id, :scope=>:document_id
-  attr_accessible :id, :document_id, :title if Rails::VERSION::MAJOR < 4
+  belongs_to :user, polymorphic: true
+  belongs_to :document, polymorphic: true
 
+  validates_presence_of :user_id, :scope=>:document_id
+  attr_accessible :id, :document_id, :document_type, :title if Rails::VERSION::MAJOR < 4
 
   def document
-    SolrDocument.new SolrDocument.unique_key => document_id
+    document_type.new document_type.unique_key => document_id
+  end
+  
+  def document_type
+    (super.constantize if defined?(super)) || default_document_type
+  end
+  
+  def default_document_type
+    SolrDocument
   end
   
 end