blacklight 3.0.0pre4 → 3.0.0pre6

data/VERSION

@@ -1 +1 @@
-3.0.0pre4
+3.0.0pre6

data/app/controllers/bookmarks_controller.rb

@@ -34,7 +34,7 @@ class BookmarksController < ApplicationController
   end
 
   def index
-    @bookmarks = current_user.bookmarks.paginate :page => params[:page]
+    @bookmarks = current_user.bookmarks.page(params[:page])
   end
 
   # For adding a single bookmark, suggest use PUT/#update to 

data/app/controllers/folder_controller.rb

@@ -1,6 +1,6 @@
 class FolderController < ApplicationController
-
   include Blacklight::SolrHelper
+  helper CatalogHelper
 
   # fetch the documents that match the ids in the folder
   def index

data/app/helpers/blacklight_helper.rb

@@ -83,7 +83,7 @@ module BlacklightHelper
   def render_stylesheet_includes
     return "".html_safe unless respond_to?(:stylesheet_links)
     
-    stylesheet_links.collect do |args|
+    stylesheet_links.uniq.collect do |args|
       stylesheet_link_tag(*args)
     end.join("\n").html_safe
   end
@@ -97,7 +97,7 @@ module BlacklightHelper
   def render_js_includes
     return "".html_safe unless respond_to?(:javascript_includes)    
   
-    javascript_includes.collect do |args|
+    javascript_includes.uniq.collect do |args|
       javascript_include_tag(*args)
     end.join("\n").html_safe
   end
@@ -132,7 +132,7 @@ module BlacklightHelper
       unless( options[:exclude].include?(format) ||
              (options[:unique] && seen.include?(spec[:content_type]))
              )
-        html << tag(:link, {:rel=>"alternate", :title=>format, :type => spec[:content_type], :href=> catalog_url(document[:id],  format)}) << "\n"
+        html << tag(:link, {:rel=>"alternate", :title=>format, :type => spec[:content_type], :href=> catalog_url(document.id,  format)}) << "\n"
         
         seen.add(spec[:content_type]) if options[:unique]
       end
@@ -282,6 +282,7 @@ module BlacklightHelper
 
   def render_field_value value=nil
     value = [value] unless value.is_a? Array
+    value = value.collect { |x| x.respond_to?(:force_encoding) ? x.force_encoding("UTF-8") : x}
     return value.map { |v| html_escape v }.join(field_value_separator).html_safe
   end  
 
@@ -444,7 +445,7 @@ module BlacklightHelper
   # 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=>Blacklight.config[:index][:show_link].to_sym, :counter => nil, :results_view => true})
     label = render_document_index_label doc, opts
-    link_to_with_data(label, catalog_path(doc[:id]), {:method => :put, :class => label.parameterize, :data => opts}).html_safe
+    link_to_with_data(label, catalog_path(doc.id), {:method => :put, :class => label.parameterize, :data => opts}).html_safe
   end
 
   # link_back_to_catalog(:label=>'Back to Search')

data/app/helpers/catalog_helper.rb

@@ -1,33 +1,37 @@
 module CatalogHelper
+
+  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
+    num_pages = (response.total / per_page.to_f).ceil
+
+    paginate Struct.new(:current_page, :num_pages, :limit_value).new(current_page, num_pages, per_page), options, &block
+  end
+
   #
   	# 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
-      
-      # actual WillPaginate::Collection's have #total_entries. RSolr::Ext::Response
-      # has #total instead. We want this to work for both, to do what we want
-      # for RSolr, but not break WillPaginate's usual use. 
-      total_hits = collection.respond_to?(:total_entries) ? collection.total_entries : collection.total
+  	# 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 + collection.size - 1)
+      end_num = format_num(start + response.docs.length - 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('_', ' '))
+        (response.empty?? 'entry' : response.docs.first.class.name.underscore.sub('_', ' '))
 
-      if collection.total_pages < 2
-        case collection.size
+      if num_pages < 2
+        case response.docs.length
         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
@@ -53,7 +57,7 @@ module CatalogHelper
 
   # 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))}"        
+    "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)

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

@@ -10,7 +10,7 @@
   
 <%- else -%>
 
-  <%= will_paginate @bookmarks %>
+<%= paginate @bookmarks, :theme => 'blacklight' %>
   <div id="userBookmarks">
     <p>
       <%= link_to "Clear Bookmarks", clear_bookmarks_path, :method => :delete, :confirm => "Clear your bookmarks?" %>

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

@@ -9,7 +9,12 @@
 
 <% if document.respond_to?(:export_as_apa_citation_txt) %>
   <h4>APA</h4>
-  <%= document.send(:export_as_apa_citation_txt).html_safe %>
+  <%= document.send(:export_as_apa_citation_txt).html_safe %><br/><br/>
 <% end %>
 
+<%- if document.respond_to?(:export_as_chicago_citation_txt) -%>
+  <h4>Chicago</h4>
+  <%= document.send(:export_as_chicago_citation_txt).html_safe %>
+<%- end -%>
+
 <% end %>

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

@@ -1,11 +1,6 @@
-  <% if @response.docs.total_pages > 1 %>
+  <% if @response.total > 1 %>
     <div class="pagination">
-      <% # will_paginate is called oddly because we want next/prev together
-         # at left for screen reader accessibility. We use CSS to restore
-         # a more conventional next-on-right. 
-      %>
       <h2>Results navigation</h2>
-      <%= will_paginate @response.docs, :page_links => false, :container => false, :renderer => Blacklight::CommaLinkRenderer %>
-      <%= will_paginate @response.docs, :next_label => '', :previous_label => '', :class => "page_links", :renderer => Blacklight::CommaLinkRenderer %>
+      <%= paginate_rsolr_response @response, :theme => 'blacklight' %>
     </div>
   <% end %>

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

@@ -5,7 +5,7 @@
 'T Mobile' => 'tmobile',
 'Sprint' => 'sprint',
 'Nextel' => 'nextel',
-'Virgin Mobile' => 'vmobile',
+'Virgin Mobile' => 'virgin',
 'Alltel' => 'alltel',
 'Cricket' => 'cricket'
 }

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

@@ -15,7 +15,7 @@
 	<%= render 'constraints', :localized_params=>params %>
   
   <div class="pageEntriesInfo">
-    <%= (page_entries_info @response.docs, :entry_name=>'item').html_safe %>
+    <%= render_pagination_info @response, :entry_name=>'item' %>
     <%=link_to "start over", catalog_index_path, :id=>"startOverLink" %>
   </div>
   

data/app/views/kaminari/blacklight/_first_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "First" page
+  - available local variables
+    url:           url to the first page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="first">
+  <%= link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, :remote => remote %>
+</span>

data/app/views/kaminari/blacklight/_gap.html.erb

@@ -0,0 +1,8 @@
+<%# Non-link tag that stands for skipped pages...
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="page gap"><%= raw(t 'views.pagination.truncate') %></span>

data/app/views/kaminari/blacklight/_last_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "Last" page
+  - available local variables
+    url:           url to the last page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="last">
+  <%= link_to_unless current_page.last?, raw(t 'views.pagination.last'), url, {:remote => remote} %>
+</span>

data/app/views/kaminari/blacklight/_next_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "Next" page
+  - available local variables
+    url:           url to the next page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="next next_page <%= 'disabled' if current_page.last? %>">
+  <%= link_to_unless current_page.last?, raw(t 'views.pagination.next'), url, :rel => 'next', :remote => remote %>
+</span>

data/app/views/kaminari/blacklight/_page.html.erb

@@ -0,0 +1,12 @@
+<%# Link showing page number
+  - available local variables
+    page:          a page object for "this" page
+    url:           url to this page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="page<%= ' current' if page.current? %>">
+  <%= link_to_unless page.current?, page, url, opts = {:remote => remote, :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil} %>
+</span>

data/app/views/kaminari/blacklight/_paginator.html.erb

@@ -0,0 +1,23 @@
+<%# The container tag
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+    paginator:     the paginator that renders the pagination tags inside
+-%>
+<%= paginator.render do -%>
+  <nav class="pagination-container">
+    <%= prev_page_tag %>
+    <%= next_page_tag  %>
+    <div class="page_links">
+    <% each_page do |page| -%>
+      <% if page.left_outer? || page.right_outer? || page.inside_window? -%>
+        <%= page_tag page %>
+      <% elsif !page.was_truncated? -%>
+        <%= gap_tag %>
+      <% end -%>
+    <% end -%>
+  </div>
+  </nav>
+<% end -%>

data/app/views/kaminari/blacklight/_prev_page.html.erb

@@ -0,0 +1,11 @@
+<%# Link to the "Previous" page
+  - available local variables
+    url:           url to the previous page
+    current_page:  a page object for the currently displayed page
+    num_pages:     total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="prev prev_page <%= 'disabled' if current_page.first? %>">
+  <%= link_to_unless current_page.first?, raw(t 'views.pagination.previous'), url, :rel => 'prev', :remote => remote %>
+</span>

data/app/views/record_mailer/email_record.text.erb

@@ -0,0 +1,5 @@
+<% @documents.each do |document| %>
+<%= document.to_email_text %>
+URL: <%= catalog_path(document[:id], {:only_path => false}.merge(@url_gen_params)) %>
+<% end %>
+Message: <%= @message %>

data/app/views/record_mailer/sms_record.text.erb

@@ -0,0 +1,4 @@
+<% @documents.each do |document| %>
+<%= document.to_sms_text %>
+Link: <%= catalog_path(document[:id], {:only_path => false}.merge(@url_gen_params) ) %>
+<% end %>

data/blacklight.gemspec

@@ -1,11 +1,11 @@
 # -*- coding: utf-8 -*-
-require "lib/blacklight/version"
+require File.join(File.dirname(__FILE__), "lib/blacklight/version")
 
 Gem::Specification.new do |s|
   s.name        = "blacklight"
   s.version     = Blacklight::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["jrochkind", "Matt Mitchell", "Chris Beer", "Jessie Keck", "Jason Ronallo", "Vernon Chapman", "Marck A. Matienzo"]
+  s.authors     = ["Jonathan Rochkind", "Matt Mitchell", "Chris Beer", "Jessie Keck", "Jason Ronallo", "Vernon Chapman", "Mark A. Matienzo", "Dan Funk"]
   s.email       = ["blacklight-development@googlegroups.com"]
   s.homepage    = "http://projectblacklight.org/"
   s.summary     = "A next-geration Library Catalag for Universities"
@@ -30,11 +30,10 @@ Gem::Specification.new do |s|
   # Required Gems
   s.add_dependency "rails", "~> 3.0"
   s.add_dependency "nokogiri", "~>1.5.0.beta.3"   # XML Parser
-  s.add_dependency "marc", "~> 0.3"  # Marc record parser
+  s.add_dependency "marc", "~> 0.4.3"  # Marc record parser
   s.add_dependency "rsolr",  '~> 1.0' # Library for interacting with rSolr.
   s.add_dependency "rsolr-ext", '~> 1.0' # extension to the above for some rails-ish behaviors - currently embedded in our solr document ojbect.
-  s.add_dependency "will_paginate", "~> 3.0.pre2" # the pagination (page 1,2,3, etc..) of our search results
-
+  s.add_dependency "kaminari" # the pagination (page 1,2,3, etc..) of our search results
 
   # TESTING GEM REQUIREMENTS
   # -------------------------------------------

data/config/locales/kaminari.yml

@@ -0,0 +1,10 @@
+# Sample localization file for Kaminari. You can override these values in your app's locales file if you want.
+
+en:
+  views:
+    pagination:
+      first: "« First"
+      last: "Last »"
+      previous: "« Previous"
+      next: "Next »"
+      truncate: "…"

data/config/routes.rb

@@ -1,54 +1,16 @@
 Rails.application.routes.draw do
-  
-  # Root context
-  root :to => "catalog#index"
-
   # A Note on User Sessions:
   # Blacklight expects the following named routes or at least the associated path helper methods to be defined.
   # new_user_session   (for logging in) - pages that require a log in will redirect users here.
   # destroy_user_session (for logging out)
 
-  
-  # Bookmarks 
-  match "bookmarks/clear", :to => "bookmarks#clear", :as => "clear_bookmarks"
-  resources :bookmarks
-  
-  # Folder Paths
-  match "folder/clear", :to => "folder#clear", :as => "clear_folder"
-  match "folder/destroy", :to => "folder#destroy"
-  resources :folder, :only => [:index, :update, :destroy] 
-  
-  # Search History
-  match "search_history",             :to => "search_history#index",   :as => "search_history"
-  match "search_history/clear",       :to => "search_history#clear",   :as => "clear_search_history"
-  match "search_history/destroy/:id", :to => "search_history#destroy", :as => "delete_search"
-
-  # Saved Searches
-  match "saved_searches/clear",       :to => "saved_searches#clear",   :as => "clear_saved_searches"
-  match "saved_searches",       :to => "saved_searches#index",   :as => "saved_searches"
-  match "saved_searches/save/:id",    :to => "saved_searches#save",    :as => "save_search"
-  match "saved_searches/forget/:id",  :to => "saved_searches#forget",  :as => "forget_search"
-  
-  # Catalog stuff.
-  match 'catalog/map', :as => "map_catalog"
-  match 'catalog/opensearch', :as => "opensearch_catalog"
-  match 'catalog/citation', :as => "citation_catalog"
-  match 'catalog/email', :as => "email_catalog"
-  match 'catalog/sms', :as => "sms_catalog"
-  match 'catalog/endnote', :as => "endnote_catalog"
-  match 'catalog/send_email_record', :as => "send_email_record_catalog"
-  match "catalog/facet/:id", :to => 'catalog#facet', :as => 'catalog_facet'
-  match 'catalog/unapi', :to => "catalog#unapi", :as => 'unapi'
-  resources :catalog, :only => [:index, :show, :update]
-  match 'catalog/:id/image', :to => "catalog#image"
-  match 'catalog/:id/status', :to => "catalog#status"
-  match 'catalog/:id/availability', :to => "catalog#availability"
-  match 'catalog/:id/librarian_view', :to => "catalog#librarian_view", :as => "librarian_view_catalog"
-
-  
-  # Feedback
-  match "feedback", :to => "feedback#show"    
-  match "feedback/complete", :to => "feedback#complete"
-  
+  # Routes for the Blacklight application are defined in Blacklight::Routes
+  #
+  # These routes can be injected into your Rails application by adding
+  #     Blacklight.add_routes(self)
+  # to the application's ./config/routes.rb. The injected routes can be 
+  # customized as well, e.g.:
+  #     Blacklight.add_routes(self, :only => [:bookmarks]) # will only look bookmark routes
+  #     Blacklight.add_routes(self, :except => [:catalog]) # will not load catalog routes
 end
 

data/features/default_setup.feature

@@ -28,6 +28,7 @@ Feature:
 
     Then the file "app/models/user.rb" should not exist
     And I run `rails generate blacklight -d`
+    Then the exit status should be 0
 
     # Devise should now be installed.
     Then a file named "app/models/user.rb" should exist
@@ -48,4 +49,4 @@ Feature:
     Then the output should contain "0 failures"
     And I remove the file "public/index.html"
     And I run `rake blacklight:cucumber:with_solr`
-    Then the output should contain "81 passed"
+    Then the exit status should be 0

data/lib/blacklight.rb

@@ -1,4 +1,4 @@
-require 'will_paginate'
+require 'kaminari'
 require 'marc'
 require 'rsolr'
 require 'rsolr-ext'
@@ -22,6 +22,8 @@ module Blacklight
   autoload :Controller, 'blacklight/controller'
   autoload :Catalog,    'blacklight/catalog'
 
+  autoload :Routes, 'blacklight/routes'
+
   extend Configurable
   extend SearchFields
   
@@ -41,12 +43,8 @@ module Blacklight
     "#{::Rails.root.to_s}/config/solr.yml"
   end
   
-  def self.init
-    SolrDocument.connection = Blacklight.solr
-    logger.info("BLACKLIGHT: running version #{Blacklight.version}")
-    logger.info("BLACKLIGHT: initialized with Blacklight.solr_config: #{Blacklight.solr_config.inspect}")
-    logger.info("BLACKLIGHT: initialized with Blacklight.solr: #{Blacklight.solr.inspect}")
-    logger.info("BLACKLIGHT: initialized with Blacklight.config: #{Blacklight.config.inspect}")
+  def self.add_routes(router, options = {})
+    Blacklight::Routes.new(router, options).draw
   end
 
   def self.solr