blacklight 3.0pre1

data/app/helpers/bookmarks_helper.rb

@@ -0,0 +1,3 @@
+module BookmarksHelper
+  
+end

data/app/helpers/catalog_helper.rb

@@ -0,0 +1,65 @@
+module CatalogHelper
+  #
+  	# shortcut for built-in Rails helper, "number_with_delimiter"
+  	#
+  	def format_num(num); number_with_delimiter(num) end
+
+  	#
+  	# Displays the "showing X through Y of N" message. Not sure
+    # why that's called "page_entries_info". Not entirely sure
+    # what collection argument is supposed to duck-type too, but
+    # an RSolr::Ext::Response works.  Perhaps it duck-types to something
+    # from will_paginate?
+  	def page_entries_info(collection, options = {})
+      start = (collection.current_page - 1) * collection.per_page + 1
+      total_hits = @response.total
+      start_num = format_num(start)
+      end_num = format_num(start + collection.size - 1)
+      total_num = format_num(total_hits)
+    #  end_num = total_num if total_hits < (start + collection.per_page - 1)
+
+      entry_name = options[:entry_name] ||
+        (collection.empty?? 'entry' : collection.first.class.name.underscore.sub('_', ' '))
+
+      if collection.total_pages < 2
+        case collection.size
+        when 0; "No #{h(entry_name.pluralize)} found".html_safe
+        when 1; "Displaying <b>1</b> #{h(entry_name)}".html_safe
+        else;   "Displaying <b>all #{total_num}</b> #{entry_name.pluralize}".html_safe
+        end
+      else
+        "Displaying #{h(entry_name.pluralize)} <b>#{start_num} - #{end_num}</b> of <b>#{total_num}</b>".html_safe
+      end
+  end
+
+  # Like the mysteriously named #page_entry_info above, but for an individual
+  # item show page. Displays "showing X of Y items" message.
+  # Code should call this method rather than interrogating session directly,
+  # because implementation of where this data is stored/retrieved may change. 
+  def item_page_entry_info
+    "Showing item <b>#{session[:search][:counter].to_i} of #{format_num(session[:search][:total])}</b> from your search.".html_safe
+  end
+  
+  # Look up search field user-displayable label
+  # based on params[:qt] and configuration.
+  def search_field_label(params)
+    h( Blacklight.label_for_search_field(params[:search_field]) )
+  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(catalog_path(document[:id], :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
+
+  def render_document_sidebar_partial(document = @document)
+    render :partial => 'show_sidebar'
+  end
+
+  def has_search_parameters?
+    !params[:q].blank? or !params[:f].blank? or !params[:search_field].blank?
+  end
+end

data/app/helpers/feedback_helper.rb

@@ -0,0 +1,2 @@
+module FeedbackHelper
+end

data/app/helpers/hash_as_hidden_fields.rb

@@ -0,0 +1,57 @@
+# Rails Helper methods to take a hash and turn it to form <input type="hidden">
+# fields, works with hash nested with other hashes and arrays, standard rails
+# serialization style.  Oddly while Hash#to_query will do this for a URL
+# query parameters, there seems to be no built in way to do it to create
+# hidden form fields instead. 
+#
+# Code taken from http://marklunds.com/articles/one/314
+#
+# This is used to serialize a complete current query from current params
+# to form fields used for sort and change per-page
+module HashAsHiddenFields
+
+  # Writes out zero or more <input type="hidden"> elements, completely
+  # representing a hash passed in using Rails-style request parameters
+  # for hashes nested with arrays and other hashes. 
+  def hash_as_hidden_fields(hash)
+    
+    hidden_fields = []
+    flatten_hash(hash).each do |name, value|
+      value = [value] if !value.is_a?(Array)
+      value.each do |v|
+        hidden_fields << hidden_field_tag(name, v.to_s, :id => nil)          
+      end
+    end
+    
+    hidden_fields.join("\n").html_safe
+  end
+
+  protected
+  
+  def flatten_hash(hash = params, ancestor_names = [])
+    flat_hash = {}
+    hash.each do |k, v|
+      names = Array.new(ancestor_names)
+      names << k
+      if v.is_a?(Hash)
+        flat_hash.merge!(flatten_hash(v, names))
+      else
+        key = flat_hash_key(names)
+        key += "[]" if v.is_a?(Array)
+        flat_hash[key] = v
+      end
+    end
+    
+    flat_hash
+  end
+  
+  def flat_hash_key(names)
+    names = Array.new(names)
+    name = names.shift.to_s.dup 
+    names.each do |n|
+      name << "[#{n}]"
+    end
+    name
+  end
+  
+end

data/app/helpers/render_constraints_helper.rb

@@ -0,0 +1,120 @@
+# 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 contraints graphically on the
+# search results page (render_constraints(_*)), and also
+# for rendering more textually on Search History page
+# (render_search_to_s(_*))
+module RenderConstraintsHelper
+
+  # Render actual constraints, not including header or footer
+  # info. 
+  def render_constraints(localized_params = params)
+    (render_constraints_query(localized_params) + render_constraints_filters(localized_params)).html_safe
+  end
+  
+  def render_constraints_query(localized_params = params)
+    # 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? )
+          nil
+        else
+          Blacklight.label_for_search_field(localized_params[:search_field])
+        end
+    
+      render_constraint_element(label,
+            localized_params[:q], 
+            :classes => ["query"], 
+            :remove => catalog_index_path(localized_params.merge(:q=>nil, :action=>'index')))
+    else
+      "".html_safe
+    end
+  end
+
+  def render_constraints_filters(localized_params = params)
+     return "".html_safe unless localized_params[:f]
+     content = ""
+     localized_params[:f].each_pair do |facet,values|
+        values.each do |val|
+           content << 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
+
+  # Render a label/value constraint on the screen. Can be called
+  # by plugins and such to get application-defined rendering.
+  #
+  # Can be over-ridden locally to render differently if desired,
+  # although in most cases you can just change CSS instead.
+  #
+  # Can pass in nil label if desired.
+  #
+  # options:
+  # [:remove]
+  #    url to execute for a 'remove' action  
+  # [:classes] 
+  #    can be an array of classes to add to container span for constraint.
+  # [:escape_label]
+  #    default true, HTML escape.
+  # [:escape_value]
+  #    default true, HTML escape. 
+  def render_constraint_element(label, value, options = {})
+    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/saved_searches_helper.rb

@@ -0,0 +1,2 @@
+module SavedSearchesHelper
+end

data/app/helpers/search_history_helper.rb

@@ -0,0 +1,2 @@
+module SearchHistoryHelper
+end

data/app/models/bookmark.rb

@@ -0,0 +1,6 @@
+class Bookmark < ActiveRecord::Base
+  
+  belongs_to :user
+  validates_presence_of :user_id, :scope=>:document_id
+  
+end

data/app/models/record_mailer.rb

@@ -0,0 +1,43 @@
+# Only works for documents with a #to_marc right now. 
+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
+      subject = "Item records"
+    end
+
+    @documents      = documents
+    @message        = details[:message]
+    @url_gen_params = url_gen_params
+
+    mail(:to => details[:to],  :from => "no-reply@" << from_host, :subject => subject)
+  end
+  
+  def sms_record(documents, details, from_host, url_gen_params)
+    if sms_mapping[details[:carrier]]
+      to = "#{details[:to]}@#{sms_mapping[details[:carrier]]}"
+    end
+    @documents      = documents
+    @host           = from_host
+    @url_gen_params = url_gen_params
+    mail(:to => to, :from => "no-reply@" << from_host, :subject => "")
+  end
+
+  protected
+  
+  def sms_mapping
+    {'virgin' => 'vmobl.com',
+    'att' => 'txt.att.net',
+    'verizon' => 'vtext.com',
+    'nextel' => 'messaging.nextel.com',
+    'sprint' => 'messaging.sprintpcs.com',
+    'tmobile' => 'tmomail.net',
+    'alltel' => 'message.alltel.com',
+    'cricket' => 'mms.mycricket.com'}
+  end
+end

data/app/models/search.rb

@@ -0,0 +1,19 @@
+class Search < ActiveRecord::Base
+  
+  belongs_to :user
+  
+  serialize :query_params
+  
+  # A Search instance is considered a saved search if it has a user_id.
+  def saved?
+    self.user_id?
+  end
+  
+  # delete old, unsaved searches
+  def self.delete_old_searches(days_old)
+    raise ArgumentError.new('days_old is expected to be a number') unless days_old.is_a?(Numeric)
+    raise ArgumentError.new('days_old is expected to be greater than 0') if days_old <= 0
+    self.destroy_all(['created_at < ? AND user_id IS NULL', Date.today - days_old])
+  end
+  
+end

data/app/views/_flash_msg.html.erb

@@ -0,0 +1,6 @@
+<% if flash_notice = flash[:notice] %>
+  <div class="ui-state-highlight ui-corner-all notice"><%= flash_notice %></div>
+<% 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

@@ -0,0 +1,13 @@
+<% if current_user %>
+  <%= link_to "Log Out", destroy_user_session_path %> [<%= link_to current_user, edit_user_registration_path %>]
+  <% if current_user.last_search_url %>
+    | <%= link_to('View your last search', catalog_index_path(current_user.last_search_url)) %><% end %> | 
+    <%= link_to 'Your Bookmarks', bookmarks_path %> |
+    <%= link_to "Saved Searches", saved_searches_path %>
+<% else %>
+  <%= link_to 'Login', new_user_session_path %>
+<% 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

@@ -0,0 +1,33 @@
+<h1>Bookmarks</h1>
+
+<%- if current_user.blank? -%>
+  
+  <h2>Please log in to see your bookmarks.</h2>
+  
+<%- elsif @bookmarks.blank? -%>
+  
+  <h2>You have no bookmarks</h2>
+  
+<%- else -%>
+
+  <%= will_paginate @bookmarks %>
+  <div id="userBookmarks">
+    <p>
+      <%= link_to "Clear Bookmarks", clear_bookmarks_path, :method => :delete, :confirm => "Clear your bookmarks?" %>
+    </p>
+    
+    <h2>Your Bookmarks</h2>
+    
+    <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}, 
+	  :method => :delete, :confirm => 'Remove this bookmark?' %></td>
+      </tr>
+      <% end %>
+    </table>
+  </div>
+
+<% end %>
+  

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

@@ -0,0 +1,25 @@
+<% if 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.
+  # the data-doc-id attribute is used by our JS that converts to a checkbox/label.
+  -%>  
+  <% 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 %>        
+        <%= hidden_field(:bookmark, :title, :value => document[document_show_link_field] ) %>
+        <%= submit_tag("Bookmark", :id => "bookmark_toggle_#{document[:id]}", :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 %>  
+        <%= hidden_field(:bookmark, :title, :value => document[document_show_link_field] ) %>
+        <%= submit_tag("Remove bookmark", :id => "bookmark_toggle_#{document[:id]}", :class => "bookmark_remove") %>
+      <% end %>
+      
+  <% end %>
+<% else %>
+  &nbsp;
+<% end %>

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

@@ -0,0 +1,8 @@
+<%= form_tag '/bookmarks', :name => "bookmarks" do %>
+  <% documents.each_with_index do |document, index| %>
+    <%= hidden_field_tag "bookmarks[#{index}][document_id]", document.get(:id)%>
+    <%= hidden_field_tag "bookmarks[#{index}][title]", h(document[document_show_link_field])%>
+  <% end %>
+  <%= link_to_function "Add to Bookmarks", "document.bookmarks.submit()" %>
+  <%= submit_tag 'Add to Bookmarks', :class => 'hide' %>
+<% end %>

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

@@ -0,0 +1,15 @@
+<% @documents.each do |document| %>
+
+<h1><%= citation_title(document) %></h1>
+
+<% if document.respond_to?(:export_as_mla_citation_txt) %>
+  <h4>MLA</h4>
+  <%= document.send(:export_as_mla_citation_txt).html_safe %><br/><br/>
+<% end %>
+
+<% if document.respond_to?(:export_as_apa_citation_txt) %>
+  <h4>APA</h4>
+  <%= document.send(:export_as_apa_citation_txt).html_safe %>
+<% end %>
+
+<% end %>

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

@@ -0,0 +1,7 @@
+<div id="appliedParams">
+
+	<h3 class="label">You searched for:</h3>
+  
+  <%= render_constraints(localized_params) %>  
+		
+</div>