blacklight 4.0.0.pre7 → 4.0.0.rc1

data/app/views/_user_util_links.html.erb

@@ -2,7 +2,7 @@
   <% if has_user_authentication_provider? %>
     <div class="util-links-login">
       <% if current_user %>
-        <%= link_to t('blacklight.header_links.logout'), destroy_user_session_path %> <%= "[#{ link_to current_user, edit_user_registration_path }]" unless current_user.to_s.blank? %>
+        <%= link_to t('blacklight.header_links.logout'), destroy_user_session_path %> <%= "[#{ link_to current_user, edit_user_registration_path }]".html_safe unless current_user.to_s.blank? %>
       <% else %>
         <%= link_to t('blacklight.header_links.login'), new_user_session_path %>
       <% end %>

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

@@ -0,0 +1,16 @@
+<ul>
+  <% display_facet.items.each do |item| -%>
+    <li>
+    <% if facet_in_params?( solr_field, item ) %>              
+        <%= render_selected_facet_value(solr_field, item) %>              
+      <% else %>              
+        <%= render_facet_value(solr_field, item) %>              
+    <% end -%>
+
+    <% unless item.items.blank? %>
+      <%= render :partial => 'facet_pivot', :locals => { :display_facet => item, :solr_field => solr_field } %>
+    <% end %>
+    </li>
+  <% end %>
+
+</ul>

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

@@ -1,13 +1,15 @@
+<% if show_sort_and_per_page? and !blacklight_config.per_page.blank? %>
 <div id="per_page-dropdown" class="dropdown pull-right  hidden-phone">
   <span class="hide-text"><%= t('blacklight.search.per_page.title') %></span>
   <ul class="css-dropdown">
     <li class="btn">
-      <%= link_to("#{@response.rows} per page", "#") %> <span class="caret"></span>
+      <%= link_to(t(:'blacklight.search.per_page.button_label', :count => current_per_page), "#") %> <span class="caret"></span>
       <ul>
         <%- blacklight_config.per_page.each do |count| %>
-          <li><%= link_to("#{count} #{content_tag(:span, t('blacklight.search.per_page.post_label'), :class =>'hide-text')}".html_safe, url_for(params_for_search.merge(:per_page => count))) %></li>
+          <li><%= link_to(t(:'blacklight.search.per_page.label', :count => count).html_safe, url_for(params_for_search.merge(:per_page => count))) %></li>
         <%- end -%>
       </ul>
     </li>
   </ul>
-</div>
+</div>
+<% end %>

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

@@ -1,6 +1,6 @@
 <div id="sortAndPerPage">
 
-    <%= render :partial => "paginate_compact" %> 
+    <%= render :partial => "paginate_compact" %>
 
     <%= render :partial => 'sort_widget' %>
 

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

@@ -1,7 +1,8 @@
+<% if show_sort_and_per_page? and !blacklight_config.sort_fields.blank? %>
 <div id="sort-dropdown" class="dropdown pull-right hidden-phone">
   <ul class="css-dropdown">
     <li class="btn">
-      <%= link_to("#{t('blacklight.search.sort.label')} #{current_sort_field ? current_sort_field.label : 'default'}".html_safe, "#") %> <span class="caret"></span>
+      <%= link_to(t('blacklight.search.sort.label', :field =>current_sort_field.label), "#") %> <span class="caret"></span>
       <ul>
         <%- blacklight_config.sort_fields.each do |sort_key, field| %>
           <li><%= link_to(field.label, url_for(params_for_search.merge(:sort => sort_key))) %></li>
@@ -10,3 +11,4 @@
     </li>
   </ul>
 </div>
+<% end %>

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

@@ -1,7 +1,6 @@
-
-  <div id="sidebar" class="span3">
-   <%= render :partial=>'facets' %>
-  </div><!--/well -->
+<div id="sidebar" class="span3">
+ <%= render :partial=>'facets' %>
+</div><!--/well -->
 
 <div id="content" class="span9">
 

data/config/locales/blacklight.en.yml

@@ -164,12 +164,12 @@ en:
         request_error: "Sorry, I don't understand your search."
         invalid_solr_id: "Sorry, you have requested a record that doesn't exist."
       per_page:
-        post_label: 'per page'
-        label: 'Show %{select} per page'
+        label: '%{count}<span class="hide-text"> per page</span>'
+        button_label: '%{count} per page'
         title: 'Number of results to display per page'
         submit: 'Update'
       sort:
-        label: 'Sort by'
+        label: 'Sort by %{field}'
         submit: 'sort results'
       form:
         search_field:

data/lib/blacklight.rb

@@ -18,6 +18,7 @@ module Blacklight
   autoload :User, 'blacklight/user'
 
   autoload :Controller, 'blacklight/controller'
+  autoload :LegacyControllerMethods, 'blacklight/legacy_controller_methods'
   autoload :Catalog,    'blacklight/catalog'
 
   autoload :Routes, 'blacklight/routes'

data/lib/blacklight/catalog.rb

@@ -100,7 +100,7 @@ module Blacklight::Catalog
     def endnote
       @response, @documents = get_solr_response_for_field_values(SolrDocument.unique_key,params[:id])
       respond_to do |format|
-        format.endnote
+        format.endnote :layout => false
       end
     end
     

data/lib/blacklight/configuration.rb

@@ -4,13 +4,13 @@ module Blacklight
   # fields to display, facets to show, sort options, and search fields.
   class Configuration < OpenStructWithHashAccess
 
-    # Set up Blacklight::Configuration.default_values to contain 
+    # Set up Blacklight::Configuration.default_values to contain
     # the basic, required Blacklight fields
     class << self
       def default_values
         @default_values ||= begin
           unique_key = ((SolrDocument.unique_key if defined?(SolrDocument)) || 'id')
-          
+
           {
           :solr_path => 'select',
           :qt => 'search',
@@ -22,6 +22,7 @@ module Blacklight
           :spell_max => 5,
           :max_per_page => 100,
           :per_page => [10,20,50,100],
+          :document_index_view_types => ['list'],
           :add_facet_fields_to_solr_request => false,
           :add_field_configuration_to_solr_request => false
           }
@@ -91,7 +92,7 @@ module Blacklight
     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
+      return facet_fields.reject { |k,v| v[:query] || v[:pivot] }.map { |k,v| v.field } if self.add_facet_fields_to_solr_request
 
       []
     end
@@ -107,7 +108,7 @@ module Blacklight
 
     ##
     # DSL helper
-    def configure 
+    def configure
       yield self if block_given?
       self
     end

data/lib/blacklight/controller.rb

@@ -4,35 +4,32 @@
 # as this module is mixed-in to the application controller in the hosting app on installation.
 module Blacklight::Controller 
 
-  def self.included(base)
-    base.send :include, Blacklight::SearchFields
-    base.send :include, ActiveSupport::Callbacks
+  extend ActiveSupport::Concern
+  include Blacklight::LegacyControllerMethods
+  
+  included do
+    include Blacklight::SearchFields
+    include ActiveSupport::Callbacks
 
-    base.send :before_filter, :default_html_head # add JS/stylesheet stuff
     # now in application.rb file under config.filter_parameters
     # filter_parameter_logging :password, :password_confirmation 
-    base.send :helper_method, :current_user_session, :current_user, :current_or_guest_user
-    base.send :after_filter, :discard_flash_if_xhr    
+    helper_method :current_user_session, :current_user, :current_or_guest_user
+    after_filter :discard_flash_if_xhr    
 
     # handle basic authorization exception with #access_denied
-    base.send :rescue_from, Blacklight::Exceptions::AccessDenied, :with => :access_denied
+    rescue_from Blacklight::Exceptions::AccessDenied, :with => :access_denied
     
-    base.send :helper_method, [:request_is_for_user_resource?]#, :user_logged_in?]
+    helper_method :request_is_for_user_resource?
     
-    base.send :layout, :choose_layout
-
     # extra head content
-    base.send :helper_method, :extra_head_content
-    base.send :helper_method, :stylesheet_links
-    base.send :helper_method, :javascript_includes
-    base.send :helper_method, :has_user_authentication_provider?
-    base.send :helper_method, :blacklight_config
+    helper_method :has_user_authentication_provider?
+    helper_method :blacklight_config
 
 
     # This callback runs when a user first logs in
 
-    base.define_callbacks :logging_in_user
-    base.set_callback :logging_in_user, :before, :transfer_guest_user_actions_to_current_user
+    define_callbacks :logging_in_user
+    set_callback :logging_in_user, :before, :transfer_guest_user_actions_to_current_user
 
   end
 
@@ -43,47 +40,7 @@ module Blacklight::Controller
   def blacklight_config
     default_catalog_controller.blacklight_config
   end
-
-    # test for exception notifier plugin
-    def error
-      raise RuntimeError, "Generating a test error..."
-    end
-    
-    #############
-    # Display-related methods.
-    #############
-    
-    # before filter to set up our default html HEAD content. Sub-class
-    # controllers can over-ride this method, or instead turn off the before_filter
-    # if they like. See:
-    # http://api.rubyonrails.org/classes/ActionController/Filters/ClassMethods.html
-    # for how to turn off a filter in a sub-class and such.
-    def default_html_head
- 
-    end
-    
-    
-    # An array of strings to be added to HTML HEAD section of view.
-    # See ApplicationHelper#render_head_content for details.
-    def extra_head_content
-      @extra_head_content ||= []
-    end
-
-    
-    # Array, where each element is an array of arguments to
-    # Rails stylesheet_link_tag helper. See
-    # ApplicationHelper#render_head_content for details.
-    def stylesheet_links
-      @stylesheet_links ||= []
-    end
-    
-    # Array, where each element is an array of arguments to
-    # Rails javascript_include_tag helper. See
-    # ApplicationHelper#render_head_content for details.
-    def javascript_includes
-      @javascript_includes ||= []
-    end
-    
+   
     protected
 
     # Returns a list of Searches from the ids in the user's history.
@@ -98,20 +55,7 @@ module Blacklight::Controller
       request.env['PATH_INFO'] =~ /\/?users\/?/
     end
 
-    #
-    # If a param[:no_layout] is set OR
-    # request.env['HTTP_X_REQUESTED_WITH']=='XMLHttpRequest'
-    # don't use a layout, otherwise use the "application.html.erb" layout
-    #
-    def choose_layout
-      layout_name unless request.xml_http_request? || ! params[:no_layout].blank?
-    end
-    
-    #over-ride this one locally to change what layout BL controllers use, usually
-    #by defining it in your own application_controller.rb
-    def layout_name
-      'blacklight'
-    end
+
 
     # Should be provided by authentication provider
     # def current_user

data/lib/blacklight/legacy_controller_methods.rb

@@ -0,0 +1,69 @@
+##
+# These controller methods are mixed into the ApplicationController, and 
+# are likely things new Blacklight apps won't need (e.g. because of advancements in Rails)
+# but are ideas that are firmly baked into existing application or plugins, so we're
+# keeping around for now. There are probably better ways of doing some of the things 
+# in here, but you may find them useful. 
+module Blacklight
+  module LegacyControllerMethods 
+  	extend ActiveSupport::Concern
+
+    included do
+
+      before_filter :default_html_head # add JS/stylesheet stuff
+
+      helper_method :extra_head_content, :stylesheet_links, :javascript_includes
+    end
+
+    #############
+    # Display-related methods.
+    #############
+    
+    # before filter to set up our default html HEAD content. Sub-class
+    # controllers can over-ride this method, or instead turn off the before_filter
+    # if they like. See:
+    # http://api.rubyonrails.org/classes/ActionController/Filters/ClassMethods.html
+    # for how to turn off a filter in a sub-class and such.
+    def default_html_head
+ 
+    end
+    
+    
+    # An array of strings to be added to HTML HEAD section of view.
+    # See ApplicationHelper#render_head_content for details.
+    def extra_head_content
+      @extra_head_content ||= []
+    end
+
+    
+    # Array, where each element is an array of arguments to
+    # Rails stylesheet_link_tag helper. See
+    # ApplicationHelper#render_head_content for details.
+    def stylesheet_links
+      @stylesheet_links ||= []
+    end
+    
+    # Array, where each element is an array of arguments to
+    # Rails javascript_include_tag helper. See
+    # ApplicationHelper#render_head_content for details.
+    def javascript_includes
+      @javascript_includes ||= []
+    end
+    
+    protected
+    #
+    # If a param[:no_layout] is set OR
+    # request.env['HTTP_X_REQUESTED_WITH']=='XMLHttpRequest'
+    # don't use a layout, otherwise use the "application.html.erb" layout
+    #
+    def choose_layout
+      layout_name unless request.xml_http_request? || ! params[:no_layout].blank?
+    end
+    
+    #over-ride this one locally to change what layout BL controllers use, usually
+    #by defining it in your own application_controller.rb
+    def layout_name
+      'blacklight'
+    end
+  end
+end

data/lib/blacklight/solr_helper.rb

@@ -154,9 +154,9 @@ module Blacklight::SolrHelper
       end
 
       # Now any over-rides from current URL?
-      solr_params[:rows] = user_params[:per_page] unless user_params[:per_page].blank?
-      
-      # Do we need to translate :page to Solr :start?      
+      solr_params[:rows] = user_params[:per_page].to_i  unless user_params[:per_page].blank?
+
+      # Do we need to translate :page to Solr :start?
       unless user_params[:page].blank?
         # already set solr_params["rows"] might not be the one we just set,
         # could have been from app defaults too. But we need one.
@@ -166,13 +166,13 @@ module Blacklight::SolrHelper
         if solr_params[:rows].blank?
           raise Exception.new("To use pagination when no :per_page is supplied in the URL, :rows must be configured in blacklight_config default_solr_params")
         end
-        
-        solr_params[:page] = user_params[:page]
+
+        solr_params[:page] = user_params[:page].to_i
       end
 
-      # limit to MaxPerPage (100). Tests want this to be a string not an integer,
-      # not sure why.     
-      solr_params[:rows] = solr_params[:rows].to_i > blacklight_config.max_per_page ? blacklight_config.max_per_page : solr_params[:rows]      
+      solr_params[:rows] ||= blacklight_config.per_page.first unless blacklight_config.per_page.blank?
+
+      solr_params[:rows] = blacklight_config.max_per_page if solr_params[:rows].to_i > blacklight_config.max_per_page
     end
 
     ###
@@ -316,12 +316,18 @@ module Blacklight::SolrHelper
         if blacklight_config.facet_fields.any? { |k,v| v[:query] }
           solr_parameters[:'facet.query'] ||= []
         end
+
+        if blacklight_config.facet_fields.any? { |k,v| v[:pivot] }
+          solr_parameters[:'facet.pivot'] ||= []
+        end
       end
          
       blacklight_config.facet_fields.each do |field_name, facet|
 
         if blacklight_config.add_facet_fields_to_solr_request
           case 
+            when facet.pivot
+              solr_parameters[:'facet.pivot'] << facet.pivot.join(",")
             when facet.query
               solr_parameters[:'facet.query'] += facet.query.map { |k, x| x[:fq] } 
    

data/lib/blacklight/solr_response/facets.rb

@@ -1,10 +1,24 @@
+require 'ostruct'
+
 module Blacklight::SolrResponse::Facets
   
   # represents a facet value; which is a field value and its hit count
-  class FacetItem
-    attr_reader :value, :hits
-    def initialize value, hits
-      @value, @hits = value, hits
+  class FacetItem < OpenStruct
+    def initialize *args
+      options = args.extract_options!
+
+      # Backwards-compat method signature
+      value = args.shift
+      hits = args.shift
+
+      options[:value] = value if value
+      options[:hits] = hits if hits
+      
+      super(options)
+    end
+
+    def label
+      super || value
     end
   end
   
@@ -26,7 +40,7 @@ module Blacklight::SolrResponse::Facets
       facet_fields.map do |(facet_field_name,values_and_hits)|
         items = []
         values_and_hits.each_slice(2) do |k,v|
-          items << FacetItem.new(k, v)
+          items << FacetItem.new(:value => k, :hits => v)
         end
         FacetField.new(facet_field_name, items)
       end
@@ -55,4 +69,9 @@ module Blacklight::SolrResponse::Facets
     @facet_queries ||= facet_counts['facet_queries'] || {}
   end
   
+  # Returns all of the facet queries
+  def facet_pivot
+    @facet_pivot ||= facet_counts['facet_pivot'] || {}
+  end
+  
 end # end Facets