blacklight 3.0.0pre6 → 3.0.0pre7

data/Rakefile

@@ -7,3 +7,4 @@ rescue LoadError
 end
 
 require 'rake'
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -1 +1 @@
-3.0.0pre6
+3.0.0pre7

data/app/controllers/bookmarks_controller.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # note that while this is mostly restful routing, the #update and #destroy actions
 # take the Solr document ID as the :id, NOT the id of the actual Bookmark action. 
 class BookmarksController < ApplicationController

data/app/controllers/feedback_controller.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 class FeedbackController < ApplicationController
   
   # http://expressica.com/simple_captcha/

data/app/controllers/folder_controller.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 class FolderController < ApplicationController
   include Blacklight::SolrHelper
   helper CatalogHelper
@@ -23,17 +24,17 @@ class FolderController < ApplicationController
   # remove a document_id from the folder. :id of action is solr_doc_id
   def destroy
     session[:folder_document_ids].delete(params[:id])
-    
-    unless request.xhr?      
-      respond_to do |format|
-        format.html do
-          flash[:notice] = "#{params[:title] || "Item"} successfully removed from selected items"
-          redirect_to :back
-        end
+          
+    respond_to do |format|
+      format.html do
+        flash[:notice] = "#{params[:title] || "Item"} successfully removed from selected items"
+        redirect_to :back
       end
-    else
-      render :text => "OK"
-    end        
+      format.js do
+        render :json => {"OK" => "OK"}
+      end
+    end
+          
   end
  
   # get rid of the items in the folder

data/app/controllers/saved_searches_controller.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 class SavedSearchesController < ApplicationController
   before_filter :verify_user 
   

data/app/controllers/search_history_controller.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 class SearchHistoryController < ApplicationController
   def index
     @searches = searches_from_history

data/app/helpers/blacklight_helper.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # -*- coding: utf-8 -*-
 #
 # Methods added to this helper will be available to all templates in the hosting application

data/app/helpers/bookmarks_helper.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module BookmarksHelper
   
-end
+end

data/app/helpers/catalog_helper.rb

@@ -1,22 +1,34 @@
+# -*- encoding : utf-8 -*-
 module CatalogHelper
 
-  def paginate_rsolr_response(response, options = {}, &block)
+  # Pass in an RSolr::Response (or duck-typed similar) object, 
+  # it translates to a Kaminari-paginatable
+  # 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).new(current_page, num_pages, per_page)
+  end    
 
-    paginate Struct.new(:current_page, :num_pages, :limit_value).new(current_page, num_pages, per_page), options, &block
+  # 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. 
+  def paginate_rsolr_response(response, options = {}, &block)
+    paginate paginate_params(response), options, &block
   end
 
   #
-  	# shortcut for built-in Rails helper, "number_with_delimiter"
-  	#
-  	def format_num(num); number_with_delimiter(num) 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. 
-    def render_pagination_info(response, options = {})
+  #
+  # 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
@@ -41,8 +53,9 @@ module CatalogHelper
       end
   end
 
-  # Like the mysteriously named #page_entry_info above, but for an individual
-  # item show page. Displays "showing X of Y items" message.
+  # 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). 
   # 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

data/app/helpers/feedback_helper.rb

@@ -1,2 +1,3 @@
+# -*- encoding : utf-8 -*-
 module FeedbackHelper
 end

data/app/helpers/hash_as_hidden_fields.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # 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

data/app/helpers/render_constraints_helper.rb

@@ -1,3 +1,4 @@
+# -*- 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.

data/app/helpers/saved_searches_helper.rb

@@ -1,2 +1,3 @@
+# -*- encoding : utf-8 -*-
 module SavedSearchesHelper
 end

data/app/helpers/search_history_helper.rb

@@ -1,2 +1,3 @@
+# -*- encoding : utf-8 -*-
 module SearchHistoryHelper
-end
+end

data/app/models/bookmark.rb

@@ -1,6 +1,7 @@
+# -*- encoding : utf-8 -*-
 class Bookmark < ActiveRecord::Base
   
   belongs_to :user
   validates_presence_of :user_id, :scope=>:document_id
   
-end
+end

data/app/models/record_mailer.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # Only works for documents with a #to_marc right now. 
 class RecordMailer < ActionMailer::Base
   

data/app/models/search.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 class Search < ActiveRecord::Base
   
   belongs_to :user
@@ -16,4 +17,4 @@ class Search < ActiveRecord::Base
     self.destroy_all(['created_at < ? AND user_id IS NULL', Date.today - days_old])
   end
   
-end
+end

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

@@ -1,3 +1,4 @@
+<% page_info = paginate_params(@response) %>
 <%= tag :meta, :name => "totalResults", :content => @response.total %>
-<%= tag :meta, :name => "startIndex", :content => (@response.docs.next_page == 2 ? 1 : @response.docs.previous_page * @response.docs.per_page + 1) %>
-<%= tag :meta, :name => "itemsPerPage", :content => @response.docs.per_page %>
+<%= tag :meta, :name => "startIndex", :content => (page_info.current_page == 1 ? 1 : @response.start ) %>
+<%= tag :meta, :name => "itemsPerPage", :content => page_info.limit_value %>

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

@@ -1,6 +1,6 @@
-  <% if @response.total > 1 %>
+<% if paginate_params(@response).num_pages > 1 %>
     <div class="pagination">
       <h2>Results navigation</h2>
-      <%= paginate_rsolr_response @response, :theme => 'blacklight' %>
+      <%= paginate_rsolr_response @response, :outer_window => 2, :theme => 'blacklight' %>
     </div>
-  <% end %>
+<% end %>

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

@@ -8,5 +8,5 @@
     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} %>
+  <%= link_to_unless page.current?, number_with_delimiter(page.to_s), url, opts = {:remote => remote, :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil} %>
 </span>

data/blacklight.gemspec

@@ -19,31 +19,13 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # PRODUCTION GEM REQUIREMENTS
-  # ---------------------------------------    
-  # JRuby Specific Gems - and their counterparts
-  if defined?(JRUBY_VERSION)
-    # Jruby specific gems should go here.
-  else
-    s.add_dependency "unicode" # provides C-form normalization of unicode characters, as required by refworks.
-  end  
-
-  # Required Gems
+  # ---------------------------------------   
   s.add_dependency "rails", "~> 3.0"
   s.add_dependency "nokogiri", "~>1.5.0.beta.3"   # XML Parser
+  s.add_dependency "unicode" # provides C-form normalization of unicode characters, as required by refworks.
   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 "kaminari" # the pagination (page 1,2,3, etc..) of our search results
 
-  # TESTING GEM REQUIREMENTS
-  # -------------------------------------------
-  # For testing the generators
-#  s.add_dependency "cucumber-rails"
-#  s.add_dependency "capybara"
-#  s.add_dependency "aruba"
-
-#  s.add_dependency "rspec-rails", "~>2.3.0"
-#  s.add_dependency "webrat"
-#  s.add_dependency "database_cleaner"
-
 end

data/config/routes.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 Rails.application.routes.draw do
   # A Note on User Sessions:
   # Blacklight expects the following named routes or at least the associated path helper methods to be defined.

data/db/seeds.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # This file should contain all the record creation needed to seed the database with its default values.
 # The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
 #

data/install.rb

@@ -0,0 +1 @@
+# -*- encoding : utf-8 -*-

data/lib/blacklight.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'kaminari'
 require 'marc'
 require 'rsolr'

data/lib/blacklight/catalog.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Blacklight::Catalog 
   extend ActiveSupport::Concern
   include Blacklight::SolrHelper

data/lib/blacklight/comma_link_renderer.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'will_paginate/view_helpers/link_renderer'
 
 # Custom link renderer for WillPaginate

data/lib/blacklight/configurable.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Blacklight::Configurable
   
   # The config environment name used by the #config method

data/lib/blacklight/controller.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 #
 # Filters added to this controller apply to all controllers in the hosting application
 # as this module is mixed-in to the application controller in the hosting app on installation.

data/lib/blacklight/engine.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # lib/blacklight/engine.rb
 require "blacklight"
 require "rails"

data/lib/blacklight/exceptions.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Blacklight
   module Exceptions
 

data/lib/blacklight/routes.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Blacklight
   class Routes
 

data/lib/blacklight/search_fields.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 ##
 # Module to deal with accessing (and setting some defaults) in an array of
 # hashes that describe Blacklight search fields.  Requires the base class this

data/lib/blacklight/solr.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Blacklight::Solr
   
   autoload :Facets, 'blacklight/solr/facets'

data/lib/blacklight/solr/document.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'rsolr'
 require 'rsolr-ext'
 ##

data/lib/blacklight/solr/document/dublin_core.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'builder'
 
 # This module provide Dublin Core export based on the document's semantic values

data/lib/blacklight/solr/document/email.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # This module provides the body of an email export based on the document's semantic values
 module Blacklight::Solr::Document::Email
 

data/lib/blacklight/solr/document/marc.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 
 # This is a document extension meant to be mixed into a
 # Blacklight::Solr::Document class, such as SolrDocument. It provides support

data/lib/blacklight/solr/document/marc_export.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # -*- coding: utf-8 -*-
 # Written for use with Blacklight::Solr::Document::Marc, but you can use
 # it for your own custom Blacklight document Marc extension too -- just

data/lib/blacklight/solr/document/sms.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # This module provides the body of an email export based on the document's semantic values
 module Blacklight::Solr::Document::Sms
 

data/lib/blacklight/solr/facet_paginator.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Blacklight::Solr
   
 
@@ -90,4 +91,4 @@ module Blacklight::Solr
     
   end
   
-end
+end

data/lib/blacklight/solr_helper.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # SolrHelper is a controller layer mixin. It is in the controller scope: request params, session etc.
 # 
 # NOTE: Be careful when creating variables here as they may be overriding something that already exists.
@@ -69,6 +70,23 @@ module Blacklight::SolrHelper
     # CatalogController.solr_search_params_logic.delete(:we_dont_want)
     self.solr_search_params_logic = [:default_solr_parameters , :add_query_to_solr, :add_facet_fq_to_solr, :add_facetting_to_solr, :add_sorting_paging_to_solr ]
   end
+
+  def force_to_utf8(value)
+    case value
+    when Hash
+      value.each { |k, v| value[k] = force_to_utf8(v) }
+    when Array
+      value.each { |v| force_to_utf8(v) }
+    when String
+      value.force_encoding("utf-8")  if value.respond_to?(:force_encoding) 
+    end
+    value
+  end
+  
+  def find(params) 
+    response = force_to_utf8(Blacklight.solr.find(params))
+  end
+    
   
   # A helper method used for generating solr LocalParams, put quotes
   # around the term unless it's a bare-word. Escape internal quotes
@@ -128,9 +146,14 @@ module Blacklight::SolrHelper
       # Omit empty strings and nil values.             
       # Apparently RSolr takes :per_page and converts it to Solr :rows,
       # so we let it. 
-      [:page, :sort, :per_page].each do |key|
+      [:page, :per_page, :sort].each do |key|
         solr_parameters[key] = user_params[key] unless user_params[key].blank?      
       end
+
+      if solr_parameters[:sort].blank?
+        default_sort_field = Blacklight.config[:sort_fields].first || [nil, nil]
+        solr_parameters[:sort] = default_sort_field.last unless default_sort_field.last.blank?
+      end
       
       # limit to MaxPerPage (100). Tests want this to be a string not an integer,
       # not sure why.     
@@ -246,11 +269,9 @@ module Blacklight::SolrHelper
     # better for us. 
     bench_start = Time.now
     
-      solr_response = Blacklight.solr.find(  self.solr_search_params(user_params).merge(extra_controller_params))
-  
-      document_list = solr_response.docs.collect {|doc| SolrDocument.new(doc, solr_response)}  
-
-      Rails.logger.debug("Solr fetch: #{self.class}#get_search_results (#{'%.1f' % ((Time.now.to_f - bench_start.to_f)*1000)}ms)")
+    solr_response = find(self.solr_search_params(user_params).merge(extra_controller_params))  
+    document_list = solr_response.docs.collect {|doc| SolrDocument.new(doc, solr_response)}  
+    Rails.logger.debug("Solr fetch: #{self.class}#get_search_results (#{'%.1f' % ((Time.now.to_f - bench_start.to_f)*1000)}ms)")
     
     return [solr_response, document_list]
   end
@@ -270,7 +291,7 @@ module Blacklight::SolrHelper
   # a solr query method
   # retrieve a solr document, given the doc id
   def get_solr_response_for_doc_id(id=nil, extra_controller_params={})
-    solr_response = Blacklight.solr.find solr_doc_params(id).merge(extra_controller_params)
+    solr_response = find solr_doc_params(id).merge(extra_controller_params)
     raise Blacklight::Exceptions::InvalidSolrID.new if solr_response.docs.empty?
     document = SolrDocument.new(solr_response.docs.first, solr_response)
     [solr_response, document]
@@ -294,7 +315,7 @@ module Blacklight::SolrHelper
       :spellcheck => 'false'
     }.merge(extra_solr_params)
     
-    solr_response = Blacklight.solr.find( self.solr_search_params().merge(solr_params) )
+    solr_response = find( self.solr_search_params().merge(solr_params) )
     document_list = solr_response.docs.collect{|doc| SolrDocument.new(doc, solr_response) }
     [solr_response,document_list]
   end
@@ -340,7 +361,7 @@ module Blacklight::SolrHelper
     solr_params = solr_facet_params(facet_field, params, extra_controller_params)
     
     # Make the solr call
-    response = Blacklight.solr.find(solr_params)
+    response =find(solr_params)
 
     limit =       
       if respond_to?(:facet_list_limit)
@@ -376,7 +397,7 @@ module Blacklight::SolrHelper
     solr_params[:per_page] = 1
     solr_params[:rows] = 1
     solr_params[:fl] = '*'
-    Blacklight.solr.find(solr_params).docs.first
+    solr_response = find(solr_params).docs.first
   end
     
   # returns a solr params hash
@@ -398,7 +419,7 @@ module Blacklight::SolrHelper
   # where the field is the "field" argument passed in.
   def get_opensearch_response(field=nil, extra_controller_params={})
     solr_params = solr_opensearch_params().merge(extra_controller_params)
-    response = Blacklight.solr.find(solr_params)
+    response = find(solr_params)
     a = [solr_params[:q]]
     a << response.docs.map {|doc| doc[solr_params[:fl]].to_s }
   end