blacklight 3.1.2 → 3.2.0pre1

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -4,9 +4,7 @@
 # implementations can be of course.
 #
 # Includes methods for rendering contraints graphically on the
-# search results page (render_constraints(_*)), and also
-# for rendering more textually on Search History page
-# (render_search_to_s(_*))
+# search results page (render_constraints(_*))
 module Blacklight::RenderConstraintsHelperBehavior
 
   # Render actual constraints, not including header or footer
@@ -19,10 +17,10 @@ module Blacklight::RenderConstraintsHelperBehavior
     # So simple don't need a view template, we can just do it here.
     if (!localized_params[:q].blank?)
       label = 
-        if (localized_params[:search_field] == Blacklight.default_search_field[:key] or localized_params[:search_field].blank? )
+        if (localized_params[:search_field].blank? || (default_search_field && localized_params[:search_field] == default_search_field[:key] ) )
           nil
         else
-          Blacklight.label_for_search_field(localized_params[:search_field])
+          label_for_search_field(localized_params[:search_field])
         end
     
       render_constraint_element(label,
@@ -36,18 +34,22 @@ module Blacklight::RenderConstraintsHelperBehavior
 
   def render_constraints_filters(localized_params = params)
      return "".html_safe unless localized_params[:f]
-     content = ""
+     content = []
      localized_params[:f].each_pair do |facet,values|
-        values.each do |val|
-           content << render_constraint_element( facet_field_labels[facet],
+       content << render_filter_element(facet, values, localized_params)
+     end 
+
+     return content.flatten.join("\n").html_safe    
+  end
+
+  def render_filter_element(facet, values, localized_params)
+    values.map do |val|
+      render_constraint_element( facet_field_labels[facet],
                   val, 
                   :remove => catalog_index_path(remove_facet_params(facet, val, localized_params)),
                   :classes => ["filter", "filter-" + facet.parameterize] 
                 ) + "\n"                 					            
-				end
-     end 
-
-     return content.html_safe    
+    end
   end
 
   # Render a label/value constraint on the screen. Can be called
@@ -71,51 +73,4 @@ module Blacklight::RenderConstraintsHelperBehavior
     render(:partial => "catalog/constraints_element", :locals => {:label => label, :value => value, :options => options})    
   end
 
-
-  # Simpler textual version of constraints, used on Search History page.
-  # Theoretically can may be DRY'd up with results page render_constraints,
-  # maybe even using the very same HTML with different CSS? 
-  # But too tricky for now, too many changes to existing CSS. TODO.  
-  def render_search_to_s(params)
-    render_search_to_s_q(params) +
-    render_search_to_s_filters(params)
-  end
-
-  def render_search_to_s_q(params)
-    return "".html_safe if params[:q].blank?
-    
-    label = (params[:search_field] == Blacklight.default_search_field[:key]) ? 
-      nil :
-      Blacklight.label_for_search_field(params[:search_field])
-    
-    render_search_to_s_element(label , params[:q] )        
-  end
-  def render_search_to_s_filters(params)
-    return "".html_safe unless params[:f]
-
-    params[:f].collect do |facet_field, value_list|
-      render_search_to_s_element(Blacklight.config[:facet][:labels][facet_field],
-        value_list.collect do |value|
-          render_filter_value(value)
-        end.join(content_tag(:span, 'and', :class =>'label')).html_safe
-      )    
-    end.join(" \n ").html_safe    
-  end
-
-  # value can be Array, in which case elements are joined with
-  # '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')
-  end
-
-  def render_filter_name name
-    return "".html_safe if name.blank?
-    content_tag(:span, h(name) + ":", :class => 'filterName')
-  end
-
-  def render_filter_value value
-    content_tag(:span, h(value), :class => 'filterValue')
-  end
-  
 end

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -0,0 +1,56 @@
+# -*- encoding : utf-8 -*-
+# All methods in here are 'api' that may be over-ridden by plugins and local
+# code, so method signatures and semantics should not be changed casually.
+# implementations can be of course.
+#
+# Includes methods for rendering more textually on Search History page
+# (render_search_to_s(_*))
+module Blacklight::SearchHistoryConstraintsHelperBehavior
+
+  # Simpler textual version of constraints, used on Search History page.
+  # Theoretically can may be DRY'd up with results page render_constraints,
+  # maybe even using the very same HTML with different CSS? 
+  # But too tricky for now, too many changes to existing CSS. TODO.  
+  def render_search_to_s(params)
+    render_search_to_s_q(params) +
+    render_search_to_s_filters(params)
+  end
+
+  def render_search_to_s_q(params)
+    return "".html_safe if params[:q].blank?
+    
+    label = (params[:search_field] == default_search_field[:key]) ? 
+      nil :
+      label_for_search_field(params[:search_field])
+    
+    render_search_to_s_element(label , params[:q] )        
+  end
+  def render_search_to_s_filters(params)
+    return "".html_safe unless params[:f]
+
+    params[:f].collect do |facet_field, value_list|
+      render_search_to_s_element(blacklight_config.facet_fields[facet_field].label,
+        value_list.collect do |value|
+          render_filter_value(value)
+        end.join(content_tag(:span, 'and', :class =>'label')).html_safe
+      )    
+    end.join(" \n ").html_safe    
+  end
+
+  # value can be Array, in which case elements are joined with
+  # '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')
+  end
+
+  def render_filter_name name
+    return "".html_safe if name.blank?
+    content_tag(:span, h(name) + ":", :class => 'filterName')
+  end
+
+  def render_filter_value value
+    content_tag(:span, h(value), :class => 'filterValue')
+  end
+
+end

data/app/helpers/search_history_constraints_helper.rb

@@ -0,0 +1,3 @@
+module SearchHistoryConstraintsHelper
+  include Blacklight::SearchHistoryConstraintsHelperBehavior
+end

data/app/models/record_mailer.rb

@@ -4,8 +4,7 @@ class RecordMailer < ActionMailer::Base
   
   def email_record(documents, details, from_host, url_gen_params)
     #raise ArgumentError.new("RecordMailer#email_record only works with documents with a #to_marc") unless document.respond_to?(:to_marc)
-    
-    recipients details[:to]
+        
     if documents.size == 1
       subject = "Item Record: #{documents.first.to_semantic_values[:title] rescue 'N/A'}"
     else

data/app/views/_flash_msg.html.erb

@@ -1,6 +1,5 @@
-<% if flash_notice = flash[:notice] %>
-  <div class="ui-state-highlight ui-corner-all notice"><%= flash_notice %></div>
+<% [:notice, :error, :alert].each do |type| %>
+  <% if flash[type] %>
+    <div class="ui-state-<%= type == :error ? 'error' : 'highlight' %> ui-corner-all <%= type.to_s %>"><%= flash[type] %></div>
+  <% end %>
 <% end %>
-<% if flash_error = flash[:error] %>
-  <div class="ui-state-error ui-corner-all error"><%= flash_error %></div>
-<% end %>

data/app/views/_user_util_links.html.erb

@@ -1,4 +1,5 @@
-<% if current_user %>
+<% if has_user_authentication_provider? %>
+  <% if current_user%>
   <%= link_to "Log Out", destroy_user_session_path %> [<%= link_to current_user, edit_user_registration_path %>]
     | 
     <%= link_to 'Your Bookmarks', bookmarks_path %>
@@ -8,6 +9,7 @@
   <%= link_to 'Login', new_user_session_path %>
 <% end %>
 | 
+<% end %>
 <%= link_to "Selected Items", folder_index_path %> (<span id="folder_number"><%= "#{session[:folder_document_ids] ? session[:folder_document_ids].length : 0}" %></span>)
 |
 <%= link_to "Search History", search_history_path %>

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

@@ -21,8 +21,8 @@
     <table class="zebra">
       <% @bookmarks.each do |bm| %>
       <tr>
-    	<td><%= link_to h(bm.title), catalog_path(bm.document_id) %></td>
-    	<td><%= button_to 'Remove', {:controller => "bookmarks", :action => "destroy", :id => bm.document_id}, 
+    	<td><%= link_to h(bm.title), catalog_path(CGI.escape(bm.document_id)) %></td>
+    	<td><%= button_to 'Remove', {:controller => "bookmarks", :action => "destroy", :id => CGI.escape(bm.document_id)}, 
 	  :method => :delete, :confirm => 'Remove this bookmark?' %></td>
       </tr>
       <% end %>

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

@@ -1,5 +1,5 @@
-<% if current_user %>
-  <%- existing_bookmark = current_user.existing_bookmark_for(document[:id]) -%>
+<% if has_user_authentication_provider? and current_user %>
+  <%- existing_bookmark = current_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.
@@ -7,16 +7,16 @@
   -%>  
   <% unless existing_bookmark %>  
 
-      <%= form_tag( bookmark_path( document[:id]), :method => :put, :class => "bookmark_toggle", "data-doc-id" => document[:id], :title=> document[document_show_link_field] ) do %>        
+      <%= form_tag( bookmark_path( document ), :method => :put, :class => "bookmark_toggle", "data-doc-id" => document.id, :title=> document[document_show_link_field] ) do %>        
         <%= hidden_field(:bookmark, :title, :value => document[document_show_link_field] ) %>
-        <%= submit_tag("Bookmark", :id => "bookmark_toggle_#{document[:id]}", :class => "bookmark_add") %>
+        <%= submit_tag("Bookmark", :id => "bookmark_toggle_#{document.id.to_s.parameterize}", :class => "bookmark_add") %>
       <% end %>
   
   <% else %>
   
-      <%= form_tag( bookmark_path( document[:id]), :method => :delete, :class => "bookmark_toggle", "data-doc-id" => document[:id], :title=> document[document_show_link_field]) do %>  
+      <%= form_tag( bookmark_path( document ), :method => :delete, :class => "bookmark_toggle", "data-doc-id" => document.id, :title=> document[document_show_link_field]) do %>  
         <%= hidden_field(:bookmark, :title, :value => document[document_show_link_field] ) %>
-        <%= submit_tag("Remove bookmark", :id => "bookmark_toggle_#{document[:id]}", :class => "bookmark_remove") %>
+        <%= submit_tag("Remove bookmark", :id => "bookmark_toggle_#{document.id.to_s.parameterize}", :class => "bookmark_remove") %>
       <% end %>
       
   <% end %>

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

@@ -0,0 +1,4 @@
+<div class="facet_limit blacklight-<%= facet_field.field.parameterize %>">
+  <h3><%= facet_field.label -%></h3>
+  <%= yield %>
+</div>

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

@@ -1,33 +1,20 @@
-<%-  # required to pass in local :solr_field
-     # optional :display_heading parameter, sometimes set to false
-     #     by plugins that might re-use this inside something else. 
-     display_heading = true unless local_assigns.has_key?(:display_heading)
--%>
-   
-   <% display_facet = @response.facets.detect {|f| f.name == solr_field} -%>
-      <% if display_facet && display_facet.items.length > 0 %>
-        <% if display_heading %>
-          <h3><%= facet_field_labels[solr_field] -%></h3>
-        <% end %>
-        <ul>
-          <% paginator =    
-              Blacklight::Solr::FacetPaginator.new(display_facet.items,        
-                :limit => facet_limit_for(solr_field))
-          %>
-          <% paginator.items.each do |item| -%>
-            <li>
-            <% if facet_in_params?( solr_field, item.value ) %>              
-                <%= render_selected_facet_value(solr_field, item) %>              
-              <% else %>              
-                <%= render_facet_value(solr_field, item) %>              
-            <% end -%>
-            </li>
-          <% end %>
-          
-          <% if(paginator.has_next?)  %>
-            <li class="more_facets_link"><%= link_to('more »', params.merge(:id => solr_field, :action=>"facet"), :class => "more_facets_link") %></li>
-          <% end %>
-          
-        </ul>
-      <% end %>
-   
+<ul>
+  <% paginator =    
+      Blacklight::Solr::FacetPaginator.new(display_facet.items,        
+        :limit => facet_limit_for(solr_field))
+  %>
+  <% paginator.items.each do |item| -%>
+    <li>
+    <% if facet_in_params?( solr_field, item.value ) %>              
+        <%= render_selected_facet_value(solr_field, item) %>              
+      <% else %>              
+        <%= render_facet_value(solr_field, item) %>              
+    <% end -%>
+    </li>
+  <% end %>
+
+  <% if(paginator.has_next?)  %>
+    <li class="more_facets_link"><%= link_to('more »', params.merge(:id => solr_field, :action=>"facet"), :class => "more_facets_link") %></li>
+  <% end %>
+
+</ul>

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

@@ -1,9 +1,5 @@
 <% # main container for facets/limits menu -%>
 <div id="facets" class="facets">
   <h2>Limit your search</h2>
-  <% facet_field_names.each do |solr_fname| %>
-	  <div class="facet_limit blacklight-<%= solr_fname.parameterize %>">
-      <%= render_facet_limit(solr_fname) %>
-    </div>
-  <% end %>
+  <%= render_facet_partials %>
 </div>

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

@@ -1,12 +1,12 @@
 <%-   
   # pass in local :document with a SolrDocument
-  method = (item_in_folder?(document[:id]) ? "delete" : "put")
-  label = (item_in_folder?(document[:id]) ? "Unselect" : "Select")
-  cssClass = (item_in_folder?(document[:id]) ? "deleteFolder" : "addFolder")
+  method = (item_in_folder?(document.id) ? "delete" : "put")
+  label = (item_in_folder?(document.id) ? "Unselect" : "Select")
+  cssClass = (item_in_folder?(document.id) ? "deleteFolder" : "addFolder")
 -%>
 
-<%= form_tag( folder_path(document[:id]), :method => method, :class=> "folder_toggle #{cssClass}", "data-doc-id" => document[:id], :title=>h(document[document_show_link_field])) do -%>  
+<%= form_tag( folder_path(document), :method => method, :class=> "folder_toggle #{cssClass}", "data-doc-id" => document.id, :title=>h(document[document_show_link_field])) do -%>  
   <%= hidden_field(:bookmark, :title, :value => document[document_show_link_field]) %>
-  <%= submit_tag(label, :class=>"folder_submit", :id => "folder_submit_#{document[:id]}") %>
+  <%= submit_tag(label, :class=>"folder_submit", :id => "folder_submit_#{document.id}") %>
 <% end %>
 

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

@@ -1,7 +1,7 @@
 <%# default partial to display solr document fields in catalog index view -%>
 <dl class="defList">
   
-  <% index_field_names.each do |solr_fname| -%>
+  <% index_fields.each do |solr_fname, field| -%>
     <% if document.has? solr_fname %>
 	    <dt class="blacklight-<%= solr_fname.parameterize %>"><%= render_index_field_label :field => solr_fname %></dt>
 	    <dd class="blacklight-<%= solr_fname.parameterize %>"><%= render_index_field_value :document => document, :field => solr_fname %></dd>

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

@@ -2,9 +2,10 @@
   <%= form_tag catalog_index_path, :method => :get do %>
     <h2 class="search"><%= label_tag(:q, "Search ") %></h2>
     <%= text_field_tag :q, params[:q], :class => "q" %>
-    <%= label_tag(:search_field, " in ") %>
-    <%= select_tag(:search_field, options_for_select(search_fields, h(params[:search_field])), :title => "Targeted search options", :class=>"search_field") %>
-    
+    <% unless search_fields.empty? %>
+      <%= label_tag(:search_field, " in ") %>
+      <%= select_tag(:search_field, options_for_select(search_fields, h(params[:search_field])), :title => "Targeted search options", :class=>"search_field") %>
+    <% end %>
     <%= search_as_hidden_fields(:omit_keys => [:q, :search_field, :qt, :page]).html_safe %>        
     
     <%= submit_tag 'search', :class=>'submit' %>

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

@@ -1,6 +1,6 @@
 <%# default partial to display solr document fields in catalog show view -%>
 <dl class="defList">
-  <% document_show_fields.each do |solr_fname| -%>
+  <% document_show_fields.each do |solr_fname, field| -%>
     <% if document.has? solr_fname %>
 	    <dt class="blacklight-<%= solr_fname.parameterize %>"><%= render_document_show_field_label :field => solr_fname %></dt>
 	    <dd class="blacklight-<%= solr_fname.parameterize %>"><%= render_document_show_field_value :document => document, :field => solr_fname %></dd>

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

@@ -10,36 +10,36 @@
   
     <% if (@document.respond_to?(:export_as_mla_citation_txt) || @document.respond_to?(:export_as_apa_citation_txt)) %>
       <li class="cite">
-         <%= link_to "Cite This", citation_catalog_path(:id => @document[:id]), {:id => 'citeLink', :name => 'citation', :class => 'lightboxLink'} %>
+      <%= link_to "Cite This", citation_catalog_path(:id => @document), {:id => 'citeLink', :name => 'citation', :class => 'lightboxLink'} %>
       </li>
     <% end %>
     
     <% if @document.export_formats.keys.include?( :refworks_marc_txt ) %>
       <li class="refworks">
-        <%= link_to "Export to RefWorks", refworks_export_url(@document) %>        
+      <%= link_to "Export to RefWorks", refworks_export_url(:id => @document) %>        
       </li>
     <% end %>
     
     <% if @document.export_formats.keys.include?( :endnote ) %>
       <li class="endnote">
-        <%= link_to "Export to EndNote", catalog_path(@document[:id], :format => 'endnote') %>
+        <%= link_to "Export to EndNote", catalog_path(@document, :format => 'endnote') %>
       </li>
     <% end %>
     
     <% if @document.respond_to?( :to_email_text ) %>
       <li class="email">
-         <%= link_to "Email This", email_catalog_path(:id => @document[:id]), {:id => 'emailLink', :name => 'email', :class => 'lightboxLink'} %>
+      <%= link_to "Email This", email_catalog_path(:id => @document), {:id => 'emailLink', :name => 'email', :class => 'lightboxLink'} %>
       </li>
     <%- end -%>
     <%- if @document.respond_to?( :to_sms_text ) -%>
       <li class="sms">
-         <%= link_to "SMS This", sms_catalog_path(:id => @document[:id]), {:id => 'smsLink', :name => 'sms', :class => 'lightboxLink'} %>
+      <%= link_to "SMS This", sms_catalog_path(:id => @document), {:id => 'smsLink', :name => 'sms', :class => 'lightboxLink'} %>
       </li>
     <%- end -%>
     
     <% if @document.respond_to?(:to_marc) %>
       <li class="librarian_view">
-        <%= link_to "Librarian View", librarian_view_catalog_path(@document[:id]), {:id => 'librarianLink', :name => 'librarian_view', :class => 'lightboxLink'} %>
+        <%= link_to "Librarian View", librarian_view_catalog_path(@document), {:id => 'librarianLink', :name => 'librarian_view', :class => 'lightboxLink'} %>
       </li>
     <% end %>
     

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

@@ -15,6 +15,6 @@
 			<%= select_tag(:sort, options_for_select(sort_fields, h(params[:sort]))) %>			      
       <%= search_as_hidden_fields(:omit_keys => [:page, :sort]) %>
 			<%= submit_tag 'sort results' %>
-		<% end %>
+		<% end unless sort_fields.empty? %>
 	<% end %>
 </div>

data/app/views/catalog/index.atom.builder

@@ -48,12 +48,12 @@ xml.feed("xmlns" => "http://www.w3.org/2005/Atom",
   
   @document_list.each do |doc|
     xml.entry do
-      xml.title   doc.to_semantic_values[:title][0] || doc[:id]
+      xml.title   doc.to_semantic_values[:title][0] || doc.id
 
       # updated is required, for now we'll just set it to now, sorry
       xml.updated Time.now.strftime("%Y-%m-%dT%H:%M:%SZ")
       
-      xml.link    "rel" => "alternate", "type" => "text/html", "href" => catalog_url(doc[:id])
+      xml.link    "rel" => "alternate", "type" => "text/html", "href" => catalog_url(doc)
       # add other doc-specific formats, atom only lets us have one per
       # content type, so the first one in the list wins.
       xml << render_link_rel_alternates(doc, :unique => true)      

data/app/views/catalog/index.rss.builder

@@ -9,7 +9,7 @@ xml.rss(:version=>"2.0") {
     xml.language('en-us')
     @document_list.each do |doc|
       xml.item do  
-        xml.title( doc.to_semantic_values[:title][0] || doc[:id] )                              
+        xml.title( doc.to_semantic_values[:title][0] || doc.id )                              
         xml.link(catalog_url(doc[:id]))                                   
         xml.author( doc.to_semantic_values[:author][0] ) if doc.to_semantic_values[:author][0]       
       end