blacklight 5.7.2 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31aa3ab54992e5866424bca93671473ae6c92b3a
-  data.tar.gz: 36ddb1ad5da8378c261c921154bc5858908a6cba
+  metadata.gz: 2e6abf19233b0973dff8cfaff353836ee5af69e6
+  data.tar.gz: ae4e3d469b37f1ae8f469470fb6e87e2976cb788
 SHA512:
-  metadata.gz: fd067ca4fb5e30e3d89dd97b74a7770040c0c729c79a5e42ef9235554a44f8182784a53532335e1e2a71900c02374d178701d3af49a1f8fd280e8e25ce4e285c
-  data.tar.gz: b65151e3ebc7493ca386cd174326db50dc7b023960b4b7b48b038c853cc141b25ec0db9a119a8c3a5b70862f6900877d9d0ab945bf13d7a1f2640614a425d070
+  metadata.gz: 7244ed7c511e061c63bf949889671cbcfcfac42bafc87d98b95093dcd2d1596629be83fbec0fffe02715ebb23fbd9ac626fcd35d3fd59b06e1b488eb412cc206
+  data.tar.gz: a3f3d9b2ccb72941967790c380735dabceff82c4bf5eb22a885771ceeda226d60cc7ac86a81e90136decdcce537ffbdd48adc43b095b7cd956c13a559f3ebc2f

data/.travis.yml

@@ -15,9 +15,7 @@ matrix:
     - rvm: jruby
       env: "RAILS_VERSION=4.1.7 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
     - rvm: 2.1.4
-      env: "RAILS_VERSION=4.2.0.beta4"
-  allow_failures:
-    - env: "RAILS_VERSION=4.2.0.beta4"
+      env: "RAILS_VERSION=4.2.0.rc1"
 
 before_install:
   - gem install bundler

data/Gemfile

@@ -22,11 +22,8 @@ if File.exists?(file)
 else
   gem 'rails', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
 
-  # explicitly include sass-rails to get compatible sprocket dependencies
   if ENV['RAILS_VERSION'] and ENV['RAILS_VERSION'] =~ /^4.2/
-    gem 'sass-rails', ">= 5.0.0.beta1"
     gem 'responders', "~> 2.0"
-  else
-    gem 'sass-rails'
   end
+  gem 'sass-rails'
 end

data/VERSION

@@ -1 +1 @@
-5.7.2
+5.8.0

data/app/assets/stylesheets/blacklight/_catalog.css.scss

@@ -52,7 +52,25 @@ span.constraints-label {
 {
   .constraint-value {
     cursor: default;
-    
+    text-overflow: ellipsis;
+    overflow: hidden;
+
+    @media (max-width: $screen-xs-max) {
+      max-width: $screen-xs-min / 2;
+    }
+
+    @media (min-width: $screen-sm-min) and (max-width: $screen-sm-max) {
+      max-width: $screen-sm-min / 2;
+    }
+
+    @media (min-width: $screen-md-min) and (max-width: $screen-md-max) {
+      max-width: $screen-md-min / 2;
+    }
+
+    @media (min-width: $screen-lg-min) {
+      max-width: $screen-lg-min / 2;
+    }
+
     &:hover, &:active {
       background-color: $btn-default-bg;
       border-color: $btn-default-border;
@@ -190,3 +208,22 @@ label.toggle_bookmark
     @extend .sr-only;
   }
 }
+
+#sort-dropdown .dropdown-toggle, #per_page-dropdown .dropdown-toggle {
+  color: $link-color;
+
+  .caret {
+    color: $text-color;
+  }
+}
+
+
+.search-input-group {
+  width: 80%;
+}
+
+@media (max-width: $screen-sm-min) {
+  .search-input-group {
+    width: auto;
+  }
+}

data/app/assets/stylesheets/blacklight/_facets.css.scss

@@ -49,6 +49,16 @@
     .remove {
       @extend .text-muted;
       text-indent: $padding-base-horizontal;
+
+      .glyphicon {
+        top: 0.1em;
+        vertical-align: text-top;
+      }
+
+      &:hover {
+        color: $brand-danger;
+      }
+
     }
   }
 

data/app/assets/stylesheets/blacklight/_layout.css.scss

@@ -2,4 +2,10 @@
 
 .navbar + .navbar {
   margin-top: -$navbar-margin-bottom;
+}
+
+.navbar-inverse .navbar-toggle {
+  &:focus, &:hover {
+    border-color: $gray-light;
+  }
 }

data/app/controllers/bookmarks_controller.rb

@@ -1,166 +1,6 @@
 # -*- encoding : utf-8 -*-
-# note that while this is mostly restful routing, the #update and #destroy actions
-# take the Solr document ID as the :id, NOT the id of the actual Bookmark action. 
-class BookmarksController < CatalogController
+class BookmarksController < CatalogController  
 
-  ##
-  # Give Bookmarks access to the CatalogController configuration
-  include Blacklight::Configurable
-  include Blacklight::SolrHelper
+  include Blacklight::Bookmarks
 
-  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
-  def search_action_url *args
-    catalog_index_url *args
-  end
-
-  before_filter :verify_user
-
-  def index
-    @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_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
-
-  # For adding a single bookmark, suggest use PUT/#update to 
-  # /bookmarks/$docuemnt_id instead.
-  # But this method, accessed via POST to /bookmarks, can be used for
-  # creating multiple bookmarks at once, by posting with keys
-  # such as bookmarks[n][document_id], bookmarks[n][title]. 
-  # It can also be used for creating a single bookmark by including keys
-  # bookmark[title] and bookmark[document_id], but in that case #update
-  # is simpler. 
-  def create
-    if params[:bookmarks]
-      @bookmarks = params[:bookmarks]
-    else
-      @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.where(bookmark).exists? || current_or_guest_user.bookmarks.create(bookmark) 
-    end
-
-    if request.xhr?
-      success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(:text => "", :status => "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
-  end
-  
-  # 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.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')
-      else
-        flash[:error] = I18n.t('blacklight.bookmarks.remove.failure')
-      end 
-      redirect_to :back
-    else
-      # ajaxy request needs no redirect and should not have flash set
-      success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(:text => "", :status => "500")
-    end        
-  end
-
-  def 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') 
-    end
-    redirect_to :action => "index"
-  end
-  
-  protected
-  def verify_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
+end 

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -8,7 +8,9 @@ module Blacklight::BlacklightHelperBehavior
   include BlacklightConfigurationHelper
   include HashAsHiddenFieldsHelper
   include RenderConstraintsHelper
+  include RenderPartialsHelper
   include FacetsHelper
+  extend Deprecation
 
   ##
   # Get the name of this application, from either:
@@ -91,42 +93,6 @@ module Blacklight::BlacklightHelperBehavior
     render :partial=>'catalog/search_form'
   end
 
-  ##
-  # Render "docuemnt actions" area for search results view
-  # (normally renders next to title in the list view)
-  #
-  # @param [SolrDocument] document
-  # @param [Hash] options
-  # @option options [String] :wrapping_class
-  # @return [String]
-  def render_index_doc_actions(document, options={})
-    wrapping_class = options.delete(:wrapping_class) || "index-document-functions"
-
-    content = []
-    content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if render_bookmarks_control?
-
-    content_tag("div", safe_join(content, "\n"), :class=> wrapping_class)
-  end
-
-  ##
-  # Render "docuemnt actions" for the item detail 'show' view.
-  # (this normally renders next to title)
-  #
-  # By default includes 'Bookmarks'
-  # 
-  # @param [SolrDocument] document
-  # @param [Hash] options
-  # @option options [String] :wrapping_class
-  # @return [String]
-  def render_show_doc_actions(document=@document, options={})
-    wrapping_class = options.delete(:wrapping_class) || "documentFunctions"
-
-    content = []
-    content << render(:partial => 'catalog/bookmark_control', :locals => {:document=> document}.merge(options)) if render_bookmarks_control?
-
-    content_tag("div", safe_join(content, "\n"), :class=> wrapping_class)
-  end
-
   ##
   # Determine whether to render a given field in the index view.
   #  
@@ -378,162 +344,22 @@ module Blacklight::BlacklightHelperBehavior
     end
   end
 
-  ##
-  # Render the document index view
-  #
-  # @param [Array<SolrDocument>] list of documents to render
-  # @param [Hash] locals to pass to the render call
-  # @return [String]
-  def render_document_index documents = nil, locals = {}
-    documents ||= @document_list
-    render_document_index_with_view(document_index_view_type, documents, locals)
-  end
-
-  ##
-  # Render the document index for a grouped response
-  def render_grouped_document_index
-    render :partial => 'catalog/group_default'
-  end
-
-  ##
-  # Render the document index for the given view type with the 
-  # list of documents.
-  # 
-  # This method will interpolate the list of templates with
-  # the current view, and gracefully handles missing templates.
-  # 
-  # @see #document_index_path_templates
-  #
-  # @param [String] view type
-  # @param [Array<SolrDocument>] list of documents to render
-  # @param [Hash] locals to pass to the render call
-  # @return [String]
-  def render_document_index_with_view view, documents, locals = {}
-    document_index_path_templates.each do |str|
-      partial = str % { index_view_type: view }
-      logger.debug "Looking for document index partial #{partial}"
-      template = lookup_context.find_all(partial, lookup_context.prefixes + [""], true, locals.keys + [:documents], {}).first
-      return template.render(self, locals.merge(documents: documents)) if template
-    end
-
-    return ""
-  end
-
-  ##
-  # A list of document partial templates to attempt to render
-  #
-  # @see #render_document_index_with_view
-  # @return [Array<String>]
-  def document_index_path_templates
-    # first, the legacy template names for backwards compatbility
-    # followed by the new, inheritable style
-    # finally, a controller-specific path for non-catalog subclasses
-    @document_index_path_templates ||= ["document_%{index_view_type}", "catalog/document_%{index_view_type}", "catalog/document_list"]
-  end
-
-  ##
-  # Return a normalized partial name for rendering a single document
-  #
-  # @param [SolrDocument]
-  # @param [Symbol] base name for the partial
-  # @return [String]
-  def document_partial_name(document, base_name = nil)
-    view_config = blacklight_config.view_config(:show)
-
-    display_type = if base_name and view_config.has_key? :"#{base_name}_display_type_field"
-      document[view_config[:"#{base_name}_display_type_field"]]
-    end
-
-    display_type ||= document[view_config.display_type_field]
-
-    display_type ||= 'default'
-
-    type_field_to_partial_name(document, display_type)
-  end
-
-  ##
-  # Return a partial name for rendering a document
-  # this method can be overridden in order to transform the value
-  #   (e.g. 'PdfBook' => 'pdf_book')
-  #
-  # @param [SolrDocument] document
-  # @param [String, Array] display_type a value suggestive of a partial
-  # @return [String] the name of the partial to render
-  # @example
-  #  type_field_to_partial_name(['a book-article'])
-  #  => 'a_book_article'
-  def type_field_to_partial_name(document, display_type)
-    # using "_" as sep. to more closely follow the views file naming conventions
-    # parameterize uses "-" as the default sep. which throws errors
-    Array(display_type).join(" ").gsub("-","_").parameterize("_")
-  end
-
-  ##
-  # Return the list of partials for a given solr document
-  # @param [SolrDocument]
-  # @return [String] 
-  def render_document_partials(doc, partials = [], locals ={})
-    safe_join(partials.map do |action_name|
-      render_document_partial(doc, action_name, locals)
-    end, "\n")
-  end
-
-  ##
-  # Given a doc and a base name for a partial, this method will attempt to render
-  # an appropriate partial based on the document format and view type.
-  # 
-  # If a partial that matches the document format is not found, 
-  # render a default partial for the base name.
-  #
-  # @see #document_partial_path_templates
-  # 
-  # @param [SolrDocument] doc
-  # @param [String] base name for the partial
-  # @param [Hash] locales to pass through to the partials
-  def render_document_partial(doc, base_name, locals = {})
-    format = if method(:document_partial_name).arity == 1
-      Deprecation.warn self, "The #document_partial_name with a single argument is deprecated. Update your override to include a second argument for the 'base name'"
-      document_partial_name(doc)
-    else
-      document_partial_name(doc, base_name)
-    end
-
-    document_partial_path_templates.each do |str|
-      partial = str % { action_name: base_name, format: format, index_view_type: document_index_view_type }
-      logger.debug "Looking for document partial #{partial}"
-      template = lookup_context.find_all(partial, lookup_context.prefixes + [""], true, locals.keys + [:document], {}).first
-      return template.render(self, locals.merge(document: doc)) if template
-    end
-
-    return ''
-  end
-
-  ##
-  # A list of document partial templates to try to render for a document
-  #
-  # The partial names will be interpolated with the following variables:
-  #   - action_name: (e.g. index, show)
-  #   - index_view_type: (the current view type, e.g. list, gallery)
-  #   - format: the document's format (e.g. book) 
-  #
-  # @see #render_document_partial
-  def document_partial_path_templates
-    # first, the legacy template names for backwards compatbility
-    # followed by the new, inheritable style
-    # finally, a controller-specific path for non-catalog subclasses
-    @partial_path_templates ||= ["%{action_name}_%{index_view_type}_%{format}", "%{action_name}_%{index_view_type}_default", "%{action_name}_%{format}", "%{action_name}_default", "catalog/%{action_name}_%{format}", "catalog/_%{action_name}_partials/%{format}", "catalog/_%{action_name}_partials/default"]
-  end
-
   ##
   # Render the document index heading
   #
   # @param [SolrDocument] doc
-  # @param [Hash] opts
+  # @param [Hash] opts (deprecated)
   # @option opts [Symbol] :label Render the given field from the document
   # @option opts [Proc] :label Evaluate the given proc
   # @option opts [String] :label Render the given string
-  def render_document_index_label doc, opts = {}
-    presenter(doc).render_document_index_label opts
+  # @param [Symbol, Proc, String] field Render the given field or evaluate the proc or render the given string
+  def render_document_index_label doc, field, opts = {}
+    Deprecation.warn self, "render_document_index_label is deprecated"
+    if field.kind_of? Hash
+      Deprecation.warn self, "Calling render_document_index_label with a hash is deprecated"
+      field = field[:label]
+    end
+    presenter(doc).render_document_index_label field, opts
   end
 
   ##
@@ -566,6 +392,12 @@ module Blacklight::BlacklightHelperBehavior
     has_user_authentication_provider? and current_or_guest_user.present?
   end
 
+  ##
+  # Determine whether to render the saved searches link
+  def render_saved_searches?
+    has_user_authentication_provider? and current_user
+  end
+
   ##
   # Returns a document presenter for the given document
   def presenter(document)
@@ -575,7 +407,7 @@ module Blacklight::BlacklightHelperBehavior
   ##
   # Override this method if you want to use a different presenter class
   def presenter_class
-    Blacklight::DocumentPresenter
+    blacklight_config.document_presenter_class || Blacklight::DocumentPresenter
   end
   
   ##