blacklight 4.0.0.pre7 → 4.0.0.rc1

data/.gitignore

@@ -18,4 +18,4 @@ Gemfile.lock
 tmp/test_app
 .rvmrc
 pkg/*
-*.swp
+*.sw[pon]

data/VERSION

@@ -1 +1 @@
-4.0.0.pre7
+4.0.0.rc1

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

@@ -10,7 +10,7 @@
   .label
   {
  position: absolute !important;
-  height: 1px; width: 1px; 
+  height: 1px; width: 1px;
   overflow: hidden;
   clip: rect(1px 1px 1px 1px); /* IE6, IE7 */
   clip: rect(1px, 1px, 1px, 1px);
@@ -120,7 +120,7 @@ li.pill-with-label {
   }
 }
 
-.show-document-title 
+.show-document-title
 {
   padding-top: 0.5em;
 
@@ -178,7 +178,7 @@ li.pill-with-label {
 
 .document
 {
-	border-bottom:1px dotted $dotted_border_color; 
+	border-bottom:1px dotted $dotted_border_color;
 	clear:both;
   padding-bottom: 1em;
 

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

@@ -19,7 +19,6 @@
 		  }
 	  }
 	  a:hover {
-		  display: block;
 		  text-decoration: none;
 	  }
 	}

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

@@ -15,7 +15,7 @@
       padding-bottom:0.3em;
       padding-right: 50px;
       clear: right;
- 
+
     a.remove
     {
       color:#666;
@@ -54,8 +54,8 @@
 
 .facet_extended_list
 {
-  .sort_options 
-  { 
+  .sort_options
+  {
     text-align:right;
   }
 
@@ -84,7 +84,7 @@ ul.facet_extended_list
 }
 
 
-/* Sidenav 
+/* Sidenav
 -------------------------------------------------- */
 
 .sidenav {
@@ -98,7 +98,7 @@ ul.facet_extended_list
   -webkit-box-shadow: 0 1px 4px rgba(0,0,0,.065);
      -moz-box-shadow: 0 1px 4px rgba(0,0,0,.065);
           box-shadow: 0 1px 4px rgba(0,0,0,.065);
-  
+
 	h5, h4 {
 	  display: block;
 	  *width: 190px;
@@ -106,52 +106,18 @@ ul.facet_extended_list
 	  padding: 8px 14px;
 	}
 	h5 {
-		cursor: pointer;
 	  border-top: 1px solid $navbarBorder;
-
 	}
-	
+
   .facet_limit:last-child > h5 {
 
     &.twiddle-open {
-      @include border-bottom-radius(0px); 
+      @include border-bottom-radius(0px);
     }
-    
-    @include border-bottom-radius(6px);  
+
+    @include border-bottom-radius(6px);
     }
-  /* Chevrons */
-	.icon-chevron {
-	  float: right;
-	  margin-top: 2px;
-	  margin-right: -6px;
-	  opacity: .25;
-	}	
-	
-  .facet_limit h5:hover {
-	  background-color: darken($bodyBackground, 10%);
-	}
-	
-	.icon-chevron {
-	  @extend .icon-chevron-right;
-	  opacity: .5;
-	}
-	
-	.twiddle-open .icon-chevron {
-	  @extend .icon-chevron-down;
-	  opacity: 1;
-    padding-right:2px;
-	}
-  
-  /* hide the chevron when js isn't supported */
-  .no-js & .icon-chevron {
-    @extend .icon-chevron-down;
-    padding-right:2px;
-  }
 
-	h5:hover .icon-chevron,
-	.twiddle-open .icon-chevron {
-	  opacity: 1;
-	}
 }
 
 
@@ -179,6 +145,45 @@ ul.facet_extended_list
 
 }
 
+.facets-collapse {
+  h5 {
+    cursor: pointer;
+  }
+  /* Chevrons */
+  .icon-chevron {
+    float: right;
+    margin-top: 2px;
+    margin-right: -6px;
+    opacity: .25;
+  }
+
+  .facet_limit h5:hover {
+    background-color: darken($bodyBackground, 10%);
+  }
+
+  .icon-chevron {
+    @extend .icon-chevron-right;
+    opacity: .5;
+  }
+
+  .twiddle-open .icon-chevron {
+    @extend .icon-chevron-down;
+    opacity: 1;
+    padding-right:2px;
+  }
+
+  /* hide the chevron when js isn't supported */
+  .no-js & .icon-chevron {
+    @extend .icon-chevron-down;
+    padding-right:2px;
+  }
+
+  h5:hover .icon-chevron,
+  .twiddle-open .icon-chevron {
+    opacity: 1;
+  }
+}
+
 .facet_pagination {
   @extend .clearfix;
 }

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -151,13 +151,14 @@ module Blacklight::BlacklightHelperBehavior
   def document_heading
     @document[blacklight_config.show.heading] || @document.id
   end
+
   def render_document_heading
-    content_tag(:h4, document_heading, :class => "show-document-title")
+    content_tag(:h4, render_field_value(document_heading), :class => "show-document-title")
   end
 
   # Used in the show view for setting the main html document title
   def document_show_html_title
-    @document[blacklight_config.show.html_title]
+    render_field_value(@document[blacklight_config.show.html_title])
   end
 
   # Used in citation view for displaying the title
@@ -225,7 +226,11 @@ module Blacklight::BlacklightHelperBehavior
   end
 
   def document_index_view_type
-    params.fetch(:view, 'list')
+    if blacklight_config.document_index_view_types.include? params[:view]
+      params[:view]
+    else
+      blacklight_config.document_index_view_types.first
+    end
   end
 
   def render_document_index documents = nil, locals = {}
@@ -235,7 +240,7 @@ module Blacklight::BlacklightHelperBehavior
       # XXX rather than handling this logic through exceptions, maybe there's a Rails internals method
       # for determining if a partial template exists..
       begin
-        return render(:partial => (str % [document_index_view_type]), :locals => { :documents => documents })
+        return render(:partial => (str % { :index_view_type => document_index_view_type }), :locals => { :documents => documents })
       rescue ActionView::MissingTemplate
         nil
       end
@@ -249,7 +254,7 @@ module Blacklight::BlacklightHelperBehavior
     # 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_%s", "catalog/document_%s", "catalog/document_list"]
+    @document_index_path_templates ||= ["document_%{index_view_type}", "catalog/document_%{index_view_type}", "catalog/document_list"]
   end
 
   # Return a normalized partial name that can be used to contruct view partial path
@@ -276,7 +281,7 @@ module Blacklight::BlacklightHelperBehavior
       # XXX rather than handling this logic through exceptions, maybe there's a Rails internals method
       # for determining if a partial template exists..
       begin
-        return render :partial => (str % [action_name, format]), :locals=>locals.merge({:document=>doc})
+        return render :partial => (str % { :action_name => action_name, :format => format, :index_view_type => document_index_view_type }), :locals=>locals.merge({:document=>doc})
       rescue ActionView::MissingTemplate
         nil
       end
@@ -286,14 +291,11 @@ module Blacklight::BlacklightHelperBehavior
   end
 
   # a list of document partial templates to try to render for #render_document_partial
-  #
-  # (NOTE: I suspect #document_partial_name, #render_document_partial and #document_partial_path_templates
-  # should be more succinctly refactored in the future)
   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 ||= ["catalog/_%s_partials/%s", "catalog/_%s_partials/default", "%s_%s", "%s_default", "catalog/%s_%s", "catalog/%s_default"]
+    @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
 
 
@@ -335,7 +337,7 @@ module Blacklight::BlacklightHelperBehavior
   # catalog_path accepts a HashWithIndifferentAccess object. The solr query params are stored in the session,
   # so we only need the +counter+ param here. We also need to know if we are viewing to document as part of search results.
   def link_to_document(doc, opts={:label=>nil, :counter => nil, :results_view => true})
-    label ||= blacklight_config.index.show_link.to_sym
+    opts[:label] ||= blacklight_config.index.show_link.to_sym
     label = render_document_index_label doc, opts
     link_to label, doc, { :'data-counter' => opts[:counter] }.merge(opts.reject { |k,v| [:label, :counter, :results_view].include? k  })
   end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -1,28 +1,42 @@
 # -*- encoding : utf-8 -*-
 module Blacklight::CatalogHelperBehavior
 
-  # Pass in an RSolr::Response (or duck-typed similar) object, 
+  # Pass in an RSolr::Response (or duck-typed similar) object,
   # it translates to a Kaminari-paginatable
-  # object, with the keys Kaminari views expect. 
+  # object, with the keys Kaminari views expect.
   def paginate_params(response)
+
     per_page = response.rows
     per_page = 1 if per_page < 1
+
     current_page = (response.start / per_page).ceil + 1
     num_pages = (response.total / per_page.to_f).ceil
 
-    Struct.new(:current_page, :num_pages, :limit_value, :total_count, :first_page?, :last_page?).new(current_page, num_pages, per_page, response.total, current_page > 1, current_page < num_pages)
+    total_count = response.total
+
+    start_num = response.start + 1
+    end_num = start_num + response.docs.length - 1
+
+    OpenStruct.new(:start => start_num,
+                   :end => end_num,
+                   :per_page => per_page,
+                   :current_page => current_page,
+                   :num_pages => num_pages,
+                   :limit_value => per_page, # backwards compatibility
+                   :total_count => total_count,
+                   :first_page? => current_page > 1,
+                   :last_page? => current_page < num_pages
+      )
   end
 
-  # Equivalent to kaminari "paginate", but takes an RSolr::Response as first argument. 
+  # Equivalent to kaminari "paginate", but takes an RSolr::Response as first argument.
   # Will convert it to something kaminari can deal with (using #paginate_params), and
   # then call kaminari paginate with that. Other arguments (options and block) same as
-  # kaminari paginate, passed on through. 
-  # will output HTML pagination controls. 
+  # kaminari paginate, passed on through.
+  # will output HTML pagination controls.
   def paginate_rsolr_response(response, options = {}, &block)
-    per_page = response.rows
-    per_page = 1 if per_page < 1
-    current_page = (response.start / per_page).ceil + 1
-    paginate Kaminari.paginate_array(response.docs, :total_count => response.total).page(current_page).per(per_page), options, &block
+    pagination_info = paginate_params(response)
+    paginate Kaminari.paginate_array(response.docs, :total_count => pagination_info.total_count).page(pagination_info.current_page).per(pagination_info.per_page), options, &block
   end
 
   #
@@ -31,55 +45,51 @@ module Blacklight::CatalogHelperBehavior
   def format_num(num); number_with_delimiter(num) end
 
   #
-  # Pass in an RSolr::Response. Displays the "showing X through Y of N" message. 
+  # Pass in an RSolr::Response. Displays the "showing X through Y of N" message.
   def render_pagination_info(response, options = {})
-      start = response.start + 1
-      per_page = response.rows
-      current_page = (response.start / per_page).ceil + 1
-      num_pages = (response.total / per_page.to_f).ceil
-      total_hits = response.total
-
-      start_num = format_num(start)
-      end_num = format_num(start + response.docs.length - 1)
-      total_num = format_num(total_hits)
+      pagination_info = paginate_params(response)
 
    # TODO: i18n the entry_name
-      entry_name = options[:entry_name] 
+      entry_name = options[:entry_name]
       entry_name ||= response.docs.first.class.name.underscore.sub('_', ' ') unless response.docs.empty?
       entry_name ||= t('blacklight.entry_name.default')
 
 
-      case response.total
+      case pagination_info.total_count
         when 0; t('blacklight.search.pagination_info.no_items_found', :entry_name => entry_name.pluralize ).html_safe
         when 1; t('blacklight.search.pagination_info.single_item_found', :entry_name => entry_name).html_safe
-        else; t('blacklight.search.pagination_info.pages', :entry_name => entry_name.pluralize, :current_page => current_page, :num_pages => num_pages, :start_num => start_num, :end_num => end_num, :total_num => total_num, :count => num_pages).html_safe
+        else; t('blacklight.search.pagination_info.pages', :entry_name => entry_name.pluralize, :current_page => pagination_info.current_page, :num_pages => pagination_info.num_pages, :start_num => format_num(pagination_info.start), :end_num => format_num(pagination_info.end), :total_num => pagination_info.total_count, :count => pagination_info.num_pages).html_safe
       end
   end
 
   # Like  #render_pagination_info above, but for an individual
   # item show page. Displays "showing X of Y items" message. Actually takes
-  # data from session though (not a great design). 
+  # data from session though (not a great design).
   # Code should call this method rather than interrogating session directly,
-  # because implementation of where this data is stored/retrieved may change. 
+  # because implementation of where this data is stored/retrieved may change.
   def item_page_entry_info
     t('blacklight.search.entry_pagination_info.other', :current => format_num(session[:search][:counter]), :total => format_num(session[:search][:total]), :count => session[:search][:total].to_i).html_safe
   end
-  
+
   # Look up search field user-displayable label
   # based on params[:qt] and blacklight_configuration.
   def search_field_label(params)
     h( label_for_search_field(params[:search_field]) )
   end
-  
+
   def current_sort_field
     blacklight_config.sort_fields[params[:sort]] || (blacklight_config.sort_fields.first ? blacklight_config.sort_fields.first.last : nil )
   end
 
+  def current_per_page
+    (@response.rows if @response and @response.rows > 0) || params.fetch(:per_page, (blacklight_config.per_page.first unless blacklight_config.per_page.blank?)).to_i
+  end
+
   # Export to Refworks URL, called in _show_tools
   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))}"        
+    "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
-  
+
   def render_document_class(document = @document)
    'blacklight-' + document.get(blacklight_config.index.record_display_type).parameterize rescue nil
   end
@@ -91,4 +101,10 @@ module Blacklight::CatalogHelperBehavior
   def has_search_parameters?
     !params[:q].blank? or !params[:f].blank? or !params[:search_field].blank?
   end
+
+  def show_sort_and_per_page? response = nil
+    response ||= @response
+    response.response['numFound'] > 1
+  end
+
 end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -86,7 +86,9 @@ module Blacklight::FacetsHelperBehavior
   # the name of the partial to use to render a facet field. Can be over-ridden for custom
   # display on a per-facet basis. 
   def facet_partial_name(display_facet = nil)
-    name = facet_configuration_for_field(display_facet.name).try(:partial)
+    config = facet_configuration_for_field(display_facet.name)
+    name = config.try(:partial)
+    name ||= "facet_pivot" if config.pivot
     name ||= "facet_limit"
   end
  
@@ -101,7 +103,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.label if item.respond_to?(:label)) || item.value), add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select") + " " + render_facet_count(item.hits)).html_safe
+    (link_to_unless(options[:suppress_link], item.label, add_facet_params_and_redirect(facet_solr_field, item), :class=>"facet_select") + " " + render_facet_count(item.hits)).html_safe
   end
 
   # Standard display of a SELECTED facet value, no link, special span
@@ -109,7 +111,7 @@ module Blacklight::FacetsHelperBehavior
   def render_selected_facet_value(facet_solr_field, item)
     #Updated class for Bootstrap Blacklight 
     content_tag(:span, render_facet_value(facet_solr_field, item, :suppress_link => true), :class => "selected") +
-      link_to(content_tag(:i, '', :class => "icon-remove") + content_tag(:span, '[remove]', :class => 'hide-text'), remove_facet_params(facet_solr_field, item.value, params), :class=>"remove")
+      link_to(content_tag(:i, '', :class => "icon-remove") + content_tag(:span, '[remove]', :class => 'hide-text'), remove_facet_params(facet_solr_field, item, params), :class=>"remove")
   end
 
   # Renders a count value for facet limits. Can be over-ridden locally
@@ -122,12 +124,17 @@ module Blacklight::FacetsHelperBehavior
   # Does NOT remove request keys and otherwise ensure that the hash
   # is suitable for a redirect. See
   # add_facet_params_and_redirect
-  def add_facet_params(field, value)
+  def add_facet_params(field, item, source_params = params)
+
+    if item.respond_to? :field
+      field = item.field
+    end
+
     facet_config = facet_configuration_for_field(field)
 
- 
+    value = facet_value_for_facet_item(item)
 
-    p = params.dup
+    p = source_params.dup
     p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
     p[:f][field] = (p[:f][field] || []).dup
 
@@ -136,6 +143,13 @@ module Blacklight::FacetsHelperBehavior
     end
     
     p[:f][field].push(value)
+
+    if item and item.respond_to?(:fq) and item.fq
+      item.fq.each do |f,v|
+        p = add_facet_params(f, v, p)
+      end
+    end
+
     p
   end
 
@@ -146,8 +160,8 @@ module Blacklight::FacetsHelperBehavior
   # for a 'fresh' display. 
   # Change the action to 'index' to send them back to
   # catalog/index with their new facet choice. 
-  def add_facet_params_and_redirect(field, value)
-    new_params = add_facet_params(field, value)
+  def add_facet_params_and_redirect(field, item)
+    new_params = add_facet_params(field, item)
 
     # Delete page, if needed. 
     new_params.delete(:page)
@@ -167,7 +181,13 @@ module Blacklight::FacetsHelperBehavior
   # removes the field value from params[:f]
   # removes the field if there are no more values in params[:f][field]
   # removes additional params (page, id, etc..)
-  def remove_facet_params(field, value, source_params=params)
+  def remove_facet_params(field, item, source_params=params)
+    if item.respond_to? :field
+      field = item.field
+    end
+
+    value = facet_value_for_facet_item(item)
+
     p = source_params.dup
     # need to dup the facet values too,
     # if the values aren't dup'd, then the values
@@ -184,11 +204,19 @@ module Blacklight::FacetsHelperBehavior
   end
   
   # true or false, depending on whether the field and value is in params[:f]
-  def facet_in_params?(field, value)
+  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)
   end
 
-  def facet_display_value field, value
+  def facet_display_value field, item
+    
+    value = facet_value_for_facet_item(item)
 
     facet_config = facet_configuration_for_field(field)
 
@@ -209,12 +237,22 @@ module Blacklight::FacetsHelperBehavior
 
   private
 
+  def facet_value_for_facet_item item
+    if item.respond_to? :value
+      value = item.value
+    else
+      value = item
+    end
+  end
+
   # 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     
+      when (facet_field.respond_to?(:query) and facet_field.query)
+        create_rsolr_facet_field_response_for_query_facet_field facet_name, facet_field 
+      when (facet_field.respond_to?(:pivot) and facet_field.pivot)
+        create_rsolr_facet_field_response_for_pivot_facet_field facet_name, facet_field   
       else
         @response.facet_by_field_name(facet_name)
     end
@@ -226,9 +264,31 @@ module Blacklight::FacetsHelperBehavior
     @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])
+      items << Blacklight::SolrResponse::Facets::FacetItem.new(:value => key, :hits => hits, :label => facet_field.query[key][:label])
+    end
+ 
+    Blacklight::SolrResponse::Facets::FacetField.new facet_name, items
+  end
+
+
+  def create_rsolr_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