blacklight 3.3.2 → 3.4.0

data/VERSION

@@ -1 +1 @@
-3.3.2
+3.4.0

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -118,6 +118,7 @@ module Blacklight::BlacklightHelperBehavior
 
   def render_index_field_value args
     value = args[:value]
+    value ||= send(blacklight_config.index_fields[args[:field]][:helper_method], args) if args[:field] and blacklight_config.index_fields[args[:field]][:helper_method]
     value ||= args[:document].get(args[:field], :sep => nil) if args[:document] and args[:field]
     render_field_value value
   end
@@ -173,6 +174,7 @@ module Blacklight::BlacklightHelperBehavior
 
   def render_document_show_field_value args
     value = args[:value]
+    value ||= send(blacklight_config.show_fields[args[:field]][:helper_method], args) if args[:field] and blacklight_config.show_fields[args[:field]][:helper_method]
     value ||= args[:document].get(args[:field], :sep => nil) if args[:document] and args[:field]
     render_field_value value
   end

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

@@ -7,5 +7,11 @@
   <% @documents.each do |doc| %>
     <%=hidden_field_tag "id[]", doc.get(:id)%>
   <% end %>
+  <%- if params[:sort] -%>
+    <%= hidden_field_tag "sort", params[:sort] %>
+  <%- end -%>
+  <%- if params[:per_page] -%>
+    <%= hidden_field_tag "per_page", params[:per_page] %>
+  <%- end -%>
   <%= submit_tag "Send" %>
 <% end %>

data/app/views/folder/_tools.html.erb

@@ -1,15 +1,15 @@
     <ul class="folderTools">
       <li class="cite">
-        <%= link_to "Cite", citation_catalog_path(:id => @documents.collect{|doc| doc.id}), {:id => 'citeLink', :name => 'citation'} %>
+        <%= link_to "Cite", citation_catalog_path(:sort=>params[:sort], :per_page=>params[:per_page], :id => @documents.collect{|doc| doc.id}), {:id => 'citeLink', :name => 'citation'} %>
       </li>
       <li class="refworks">
         <%= render :partial => 'catalog/refworks_form', :locals => {:documents=>@documents} %>
       </li>
       <li class="endnote">
-        <%= link_to "Export to EndNote", endnote_catalog_path(:id => @documents.collect {|doc| doc.id}, :format => 'endnote')%>
+        <%= link_to "Export to EndNote", endnote_catalog_path(:sort=>params[:sort], :per_page=>params[:per_page], :id => @documents.collect {|doc| doc.id}, :format => 'endnote')%>
       </li>
       <li class="email">
-        <%= link_to "Email", email_catalog_path(:id => @documents.collect {|doc| doc.id}), :class=>"lightboxLink", :id => "emailLink" %>
+        <%= link_to "Email", email_catalog_path(:sort=>params[:sort], :per_page=>params[:per_page], :id => @documents.collect {|doc| doc.id}), :class=>"lightboxLink", :id => "emailLink" %>
       </li>
       <% if has_user_authentication_provider? and current_user %>  
         <li>

data/blacklight.gemspec

@@ -5,11 +5,11 @@ Gem::Specification.new do |s|
   s.name        = "blacklight"
   s.version     = Blacklight::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Jonathan Rochkind", "Matt Mitchell", "Chris Beer", "Jessie Keck", "Jason Ronallo", "Vernon Chapman", "Mark A. Matienzo", "Dan Funk"]
+  s.authors     = ["Jonathan Rochkind", "Matt Mitchell", "Chris Beer", "Jessie Keck", "Jason Ronallo", "Vernon Chapman", "Mark A. Matienzo", "Dan Funk", "Naomi Dushay"]
   s.email       = ["blacklight-development@googlegroups.com"]
   s.homepage    = "http://projectblacklight.org/"
-  s.summary     = "A next-generation Library Catalag for Universities"
-  s.description = %q{Blacklight is a free and open source ruby-on-rails based discovery interface (a.k.a. “next-generation catalog”) especially optimized for heterogeneous collections. You can use it as a library catalog, as a front end for a digital repository, or as a single-search interface to aggregate digital content that would otherwise be siloed.}
+  s.summary     = "Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr) index."
+  s.description = %q{Blacklight is an open source Solr user interface discovery platform. You can use Blacklight to enable searching and browsing of your collections. Blacklight uses the Apache Solr search engine to search full text and/or metadata.}
   
   s.rubyforge_project = "blacklight"
   

data/lib/blacklight.rb

@@ -55,13 +55,39 @@ module Blacklight
 
   def self.solr_config
     @solr_config ||= begin
-        raise "You are missing a solr configuration file: #{solr_file}. Have you run \"rails generate blacklight\"?" unless File.exists?(solr_file) 
-        solr_config = YAML::load(File.open(solr_file))
-        raise "The #{::Rails.env} environment settings were not found in the solr.yml config" unless solr_config[::Rails.env]
-        solr_config[::Rails.env].symbolize_keys
+        raise "The #{::Rails.env} environment settings were not found in the solr.yml config" unless solr_yml[::Rails.env]
+        solr_yml[::Rails.env].symbolize_keys
       end
   end
 
+  def self.solr_yml
+    require 'erb'
+    require 'yaml'
+
+    return @solr_yml if @solr_yml
+    unless File.exists?(solr_file)
+      raise "You are missing a solr configuration file: #{solr_file}. Have you run \"rails generate blacklight\"?"  
+    end
+
+    begin
+      @solr_erb = ERB.new(IO.read(solr_file)).result(binding)
+    rescue Exception => e
+      raise("solr.yml was found, but could not be parsed with ERB. \n#{$!.inspect}")
+    end
+
+    begin
+      @solr_yml = YAML::load(@solr_erb)
+    rescue StandardError => e
+      raise("solr.yml was found, but could not be parsed.\n")
+    end
+
+    if @solr_yml.nil? || !@solr_yml.is_a?(Hash)
+      raise("solr.yml was found, but was blank or malformed.\n")
+    end
+
+    return @solr_yml
+  end
+
   def self.logger
     ::Rails.logger
   end

data/lib/blacklight/catalog.rb

@@ -255,11 +255,12 @@ module Blacklight::Catalog
         # Set the notice flag if the flash[:notice] is already set to the error that we are setting.
         # This is intended to stop the redirect loop error
         notice = flash[:notice] if flash[:notice] == flash_notice
+        logger.error exception
         unless notice
           flash[:notice] = flash_notice
           redirect_to root_path, :status => 500
         else
-          render :template => "public/500.html", :layout => false, :status => 500
+          render :file => "#{Rails.root}/public/500.html", :status => 500
         end
       end
     end
@@ -270,9 +271,9 @@ module Blacklight::Catalog
         render # will give us the stack trace
       else
         flash[:notice] = "Sorry, you have requested a record that doesn't exist."
-        redirect_to root_path, :status => 404
+        params.delete(:id)
+        index
+        render "index", :status => 404
       end
-      
     end
-  
 end

data/lib/blacklight/configuration.rb

@@ -8,9 +8,12 @@ module Blacklight
     # the basic, required Blacklight fields
     class << self; attr_accessor :default_values; end
     @default_values = {
+      :solr_request_handler => 'select',
       :default_solr_params => {},
-      :show => OpenStructWithHashAccess.new,
-      :index => OpenStructWithHashAccess.new,
+      :document_solr_request_handler => nil,
+      :default_document_solr_params => {},
+      :show => OpenStructWithHashAccess.new(:html_title => SolrDocument.unique_key, :heading => SolrDocument.unique_key),
+      :index => OpenStructWithHashAccess.new(:show_link => SolrDocument.unique_key),
       :spell_max => 5,
       :max_per_page => 100
     }

data/lib/blacklight/exceptions.rb

@@ -10,5 +10,7 @@ module Blacklight
     class InvalidSolrID < RuntimeError
     end
 
+    class ECONNREFUSED < ::Errno::ECONNREFUSED; end
+
   end
 end

data/lib/blacklight/solr_helper.rb

@@ -81,8 +81,11 @@ module Blacklight::SolrHelper
     value
   end
   
-  def find(params) 
-    response = force_to_utf8(Blacklight.solr.find(params))
+  def find(*args)
+    response = Blacklight.solr.find(*args)
+    force_to_utf8(response)
+  rescue Errno::ECONNREFUSED => e
+    raise Blacklight::Exceptions::ECONNREFUSED.new("Unable to connect to Solr instance using #{Blacklight.solr.inspect}")
   end
     
   
@@ -314,7 +317,7 @@ module Blacklight::SolrHelper
     # better for us. 
     bench_start = Time.now
 
-    solr_response = find(self.solr_search_params(user_params).merge(extra_controller_params))  
+    solr_response = find(blacklight_config.solr_request_handler, 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)")
     
@@ -326,17 +329,20 @@ module Blacklight::SolrHelper
   # This method is primary called by the get_solr_response_for_doc_id method.
   def solr_doc_params(id=nil)
     id ||= params[:id]
-    # just to be consistent with the other solr param methods:
-    {
-      :qt => :document,
+
+    p = blacklight_config.default_document_solr_params.merge({
       :id => id # this assumes the document request handler will map the 'id' param to the unique key field
-    }
+    })
+
+    p[:qt] ||= 'document'
+
+    p
   end
   
   # 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 = find solr_doc_params(id).merge(extra_controller_params)
+    solr_response = find((blacklight_config.document_solr_request_handler || blacklight_config.solr_request_handler), 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]
@@ -367,7 +373,7 @@ module Blacklight::SolrHelper
       :spellcheck => 'false'
     }.merge(extra_solr_params)
     
-    solr_response = find( self.solr_search_params().merge(solr_params) )
+    solr_response = find(blacklight_config.solr_request_handler, self.solr_search_params().merge(solr_params) )
     document_list = solr_response.docs.collect{|doc| SolrDocument.new(doc, solr_response) }
     [solr_response,document_list]
   end
@@ -413,7 +419,7 @@ module Blacklight::SolrHelper
     solr_params = solr_facet_params(facet_field, params, extra_controller_params)
     
     # Make the solr call
-    response =find(solr_params)
+    response =find(blacklight_config.solr_request_handler, solr_params)
 
     limit =       
       if respond_to?(:facet_list_limit)
@@ -447,7 +453,7 @@ module Blacklight::SolrHelper
     solr_params[:start] = (index - 1) # start at 0 to get 1st doc, 1 to get 2nd.    
     solr_params[:rows] = 1
     solr_params[:fl] = '*'
-    solr_response = find(solr_params)
+    solr_response = find(blacklight_config.solr_request_handler, solr_params)
     SolrDocument.new(solr_response.docs.first, solr_response) unless solr_response.docs.empty?
   end
     
@@ -470,7 +476,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 = find(solr_params)
+    response = find(blacklight_config.solr_request_handler, solr_params)
     a = [solr_params[:q]]
     a << response.docs.map {|doc| doc[solr_params[:fl]].to_s }
   end

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -6,11 +6,23 @@ class CatalogController < ApplicationController
   include Blacklight::Catalog
 
   configure_blacklight do |config|
+    ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
     config.default_solr_params = { 
       :qt => 'search',
       :rows => 10 
     }
 
+    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SolrHelper#solr_doc_params) or 
+    ## parameters included in the Blacklight-jetty document requestHandler.
+    #
+    #config.default_document_solr_params = {
+    #  :qt => 'document',
+    #  ## These are hard-coded in the blacklight 'document' requestHandler
+    #  # :fl => '*',
+    #  # :rows => 1
+    #  # :q => '{!raw f=id v=$id}' 
+    #}
+
     # solr field configuration for search results/index views
     config.index.show_link = 'title_display'
     config.index.record_display_type = 'format'

data/lib/generators/blacklight/templates/config/solr.yml

@@ -13,6 +13,6 @@
 development:
   url: http://127.0.0.1:8983/solr
 test: &test
-  url: http://127.0.0.1:8888/solr
+  url: <%= "http://127.0.0.1:#{ENV['TEST_JETTY_PORT'] || 8888}/solr" %>
 cucumber:
-  <<: *test
+  <<: *test

data/lib/generators/blacklight/templates/migrations/add_user_types_to_bookmarks_searches.rb

@@ -10,7 +10,7 @@ class AddUserTypesToBookmarksSearches < ActiveRecord::Migration
   end
 
   def self.down
-    remove_column :searches, :user_type, :string
-    remove_column :bookmarks, :user_type, :string
+    remove_column :searches, :user_type
+    remove_column :bookmarks, :user_type
   end
 end

data/lib/railties/all_tests.rake

@@ -9,14 +9,16 @@ namespace :blacklight do
 
     desc "Run Blacklight cucumber and rspec, with test solr"
     task :hudson do
-        solr_yml_path = Blacklight.locate_path("config", "solr.yml")
-        jetty_path = if ( File.exists?( solr_yml_path ))
-            solr_config = YAML::load(File.open(solr_yml_path))
-            solr_config["test"]["jetty_path"] if solr_config["test"]
-        end   
-        raise Exception.new("Can't find jetty path to start test jetty. Expect a jetty_path key in config/solr.yml for test environment.") unless jetty_path 
+      solr_config = Blacklight.solr_yml["test"]
+      if solr_config
+        jetty_path = solr_config["jetty_path"] 
+        uri = URI(solr_config["url"])
+        jetty_port = uri.port if ['127.0.0.1', 'localhost'].include? uri.host
+      end   
+      raise Exception.new("Can't find jetty path to start test jetty. Expect a jetty_path key in config/solr.yml for test environment.") unless jetty_path 
 
       error = Jettywrapper.wrap(
+        :jetty_port => jetty_port,
         :jetty_home => File.expand_path(jetty_path, Rails.root), 
         :sleep_after_start => 2) do          
           Rake::Task["blacklight:spec"].invoke 
@@ -29,15 +31,17 @@ namespace :blacklight do
     namespace :all_tests do
       task :rcov do
       desc "Run Blacklight rspec and cucumber tests with rcov"
-        solr_yml_path = Blacklight.locate_path("config", "solr.yml")
-        jetty_path = if ( File.exists?( solr_yml_path ))
-            solr_config = YAML::load(File.open(solr_yml_path))
-            solr_config["test"]["jetty_path"] if solr_config["test"]
-        end   
-        raise Exception.new("Can't find jetty path to start test jetty. Expect a jetty_path key in config/solr.yml for test environment.") unless jetty_path 
+      solr_config = Blacklight.solr_yml["test"]
+      if solr_config
+        jetty_path = solr_config["jetty_path"] 
+        uri = URI(solr_config["url"])
+        jetty_port = uri.port if ['127.0.0.1', 'localhost'].include? uri.host
+      end   
+      raise Exception.new("Can't find jetty path to start test jetty. Expect a jetty_path key in config/solr.yml for test environment.") unless jetty_path 
 
       rm "blacklight-coverage.data" if File.exist?("blacklight-coverage.data")
       error = Jettywrapper.wrap(
+        :jetty_port => jetty_port,
         :jetty_home => File.expand_path(jetty_path, Rails.root), 
         :sleep_after_start => 2) do          
           Rake::Task["blacklight:spec:rcov"].invoke 

data/lib/railties/blacklight_cucumber.rake

@@ -81,20 +81,18 @@ begin
       desc "blacklight:cucumber with jetty/solr launch"
       task :with_solr do      
         require 'jettywrapper'
-        # wrap tests with a test-specific Solr server
-        # Need to look  up where the test jetty is located
-        # from solr.yml, we don't hardcode it anymore. 
-
-        solr_yml_path = Blacklight.locate_path("config", "solr.yml")
-        jetty_path = if ( File.exists?( solr_yml_path ))
-            solr_config = YAML::load(File.open(solr_yml_path))
-            solr_config["test"]["jetty_path"] if solr_config["test"]
+        solr_config = Blacklight.solr_yml["test"]
+        if solr_config
+          jetty_path = solr_config["jetty_path"] 
+          uri = URI(solr_config["url"])
+          jetty_port = uri.port if ['127.0.0.1', 'localhost'].include? uri.host
         end   
         raise Exception.new("Can't find jetty path to start test jetty. Expect a jetty_path key in config/solr.yml for test environment.") unless jetty_path 
-        
+
         error = Jettywrapper.wrap(
+          :jetty_port => jetty_port,
           :jetty_home => File.expand_path(jetty_path, Rails.root), 
-          :sleep_after_start => 2) do 
+          :sleep_after_start => 2) do        
             Rake::Task["blacklight:cucumber"].invoke 
         end     
 

data/lib/railties/blacklight_rspec.rake

@@ -79,18 +79,18 @@ begin
         # Need to look  up where the test jetty is located
         # from solr.yml, we don't hardcode it anymore. 
 
-        solr_yml_path = Blacklight.locate_path("config", "solr.yml")
-        jetty_path = if ( File.exists?( solr_yml_path ))
-            solr_config = YAML::load(File.open(solr_yml_path))
-            solr_config["test"]["jetty_path"] if solr_config["test"]
+        solr_config = Blacklight.solr_yml["test"]
+        if solr_config
+          jetty_path = solr_config["jetty_path"] 
+          uri = URI(solr_config["url"])
+          jetty_port = uri.port if ['127.0.0.1', 'localhost'].include? uri.host
         end   
         raise Exception.new("Can't find jetty path to start test jetty. Expect a jetty_path key in config/solr.yml for test environment.") unless jetty_path 
 
-        
-        # wrap tests with a test-specific Solr server
         error = Jettywrapper.wrap(
+          :jetty_port => jetty_port,
           :jetty_home => File.expand_path(jetty_path, Rails.root), 
-          :sleep_after_start => 2) do          
+          :sleep_after_start => 2) do              
             Rake::Task["blacklight:spec"].invoke 
         end             
         raise "test failures: #{error}" if error

data/lib/railties/solr_marc.rake

@@ -88,13 +88,14 @@ def compute_arguments
   arguments["MARC_FILE"] = ENV["MARC_FILE"]
 
   
-  app_site_path = File.expand_path(File.join(Rails.root, "config", "SolrMarc"))
-  plugin_site_path = File.expand_path(File.join(Rails.root, "vendor", "plugins", "blacklight", "config", "SolrMarc"))
+  arguments[:config_properties_path] = ENV['CONFIG_PATH']
 
 
   # Find config in local app or plugin, possibly based on our RAILS_ENV (::Rails.env)
-  arguments[:config_properties_path] = ENV['CONFIG_PATH']
   unless arguments[:config_properties_path]
+    app_site_path = File.expand_path(File.join(Rails.root, "config", "SolrMarc"))
+    plugin_site_path = File.expand_path(File.join(Rails.root, "vendor", "plugins", "blacklight", "config", "SolrMarc"))
+
     [ File.join(app_site_path, "config-#{::Rails.env}.properties"  ),
       File.join( app_site_path, "config.properties"),
       File.join( plugin_site_path, "config-#{::Rails.env}.properties"),
@@ -117,29 +118,23 @@ def compute_arguments
   
 
       
+  # solrmarc.solr.war.path and solr.path, for now pull out of ENV
+  # if present. In progress. jrochkind 25 Apr 2011. 
+  arguments[:solr_war_path] = ENV["SOLR_WAR_PATH"] if ENV["SOLR_WAR_PATH"]
+  arguments[:solr_path] = ENV['SOLR_PATH'] if ENV['SOLR_PATH']
 
   # Solr URL, find from solr.yml, app or plugin
   # use :replicate_master_url for current env if present, otherwise :url
   # for current env. 
   # Also take jetty_path from there if present. 
-  solr_yml_path = locate_path("config", "solr.yml")
-  if ( File.exists?( solr_yml_path ))
-    solr_config = YAML::load(File.open(solr_yml_path))
-    if c = solr_config[::Rails.env]
-      arguments[:solr_url] = c['url']    
-      if c['jetty_path']
-        arguments[:solr_path] = File.expand_path(File.join(c['jetty_path'], "solr"), Rails.root)
-        arguments[:solr_war_path] = File.expand_path(File.join(c['jetty_path'], "webapps", "solr.war"), Rails.root)
+    if c = Blacklight.solr_config
+      arguments[:solr_url] = c[:url]    
+      if c[:jetty_path]
+        arguments[:solr_path] ||= File.expand_path(File.join(c[:jetty_path], "solr"), Rails.root)
+        arguments[:solr_war_path] ||= File.expand_path(File.join(c[:jetty_path], "webapps", "solr.war"), Rails.root)
       end
-    end
   end
   
-  # solrmarc.solr.war.path and solr.path, for now pull out of ENV
-  # if present. In progress. jrochkind 25 Apr 2011. 
-  arguments[:solr_war_path] = ENV["SOLR_WAR_PATH"] if ENV["SOLR_WAR_PATH"]
-  arguments[:solr_path] = ENV['SOLR_PATH'] if ENV['SOLR_PATH']
-
-
   return arguments
 end
 

data/test_support/bin/test.sh

@@ -38,7 +38,7 @@ rm -rf tmp/test_app
 mkdir -p tmp/test_app
 cd tmp
 
-# Make certain rvn will work correctly.
+# Make certain rvm will work correctly.
 # Load RVM into a shell session *as a function*
 if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
   # First try to load from a user install

data/test_support/features/record_view.feature

@@ -32,3 +32,9 @@ Feature: Record View
     Then I should see /次按驟變/
     And I should see /林行止/
     And I should see /臺北縣板橋市/
+
+  Scenario: a document is requested doesn't exist in solr
+    Given I am on the document page for id this_id_does_not_exist
+    Then I should get a status code 404
+    And I should see "Sorry, you have requested a record that doesn't exist."
+    

data/test_support/features/step_definitions/web_steps.rb

@@ -210,3 +210,8 @@ end
 Then /^show me the page$/ do
   save_and_open_page
 end
+
+Then  /^I should get a status code (\d+)/ do |http_status|
+  page.driver.status_code.should == http_status.to_i
+end
+

data/test_support/spec/controllers/catalog_controller_spec.rb

@@ -442,18 +442,22 @@ describe CatalogController do
         controller.stub(:find => @mock_response, 
                         :get_single_doc_via_search => @mock_document)
       get :show, :id=>"987654321"
-      response.redirect_url.should == root_url
       request.flash[:notice].should == "Sorry, you have requested a record that doesn't exist."
       response.should_not be_success
       response.status.should == 404
     end
     it "should return a status 500 for a bad search" do
-      controller.stub(:get_search_results) { |*args| raise RSolr::Error::Http.new(nil, nil) }
+      req = {}
+      res = {}
+      fake_error = RSolr::Error::Http.new(req, res) 
+      controller.stub(:get_search_results) { |*args| raise fake_error }
+      controller.logger.should_receive(:error).with(fake_error)
       get :index, :q=>"+"
       response.redirect_url.should == root_url
       request.flash[:notice].should == "Sorry, I don't understand your search."
       response.should_not be_success
       response.status.should == 500
+      response.should render_template(:file=>"#{Rails.root}/public/500.html")
     end
 
   end

data/test_support/spec/helpers/blacklight_helper_spec.rb

@@ -266,12 +266,15 @@ describe BlacklightHelper do
       @document = SolrDocument.new(data)
       link_to_document(@document, { :label => :title_display, :counter => 5  }).should =~ /data-counter="5"/
      end
+
      it "passes on the title attribute to the link_to_with_data method" do
-       link_to_document(@mock_doc,:label=>"Some crazy long label...",:title=>"Some crazy longer label").should match(/title=\"Some crazy longer label\"/)
+       @document = SolrDocument.new('id'=>'123456')
+       link_to_document(@document,:label=>"Some crazy long label...",:title=>"Some crazy longer label").should match(/title=\"Some crazy longer label\"/)
      end
 
      it "doesn't add an erroneous title attribute if one isn't provided" do
-       link_to_document(@mock_doc,:label=>"Some crazy long label...").should_not match(/title=/)
+       @document = SolrDocument.new('id'=>'123456')
+       link_to_document(@document,:label=>"Some crazy long label...").should_not match(/title=/)
      end
    end
 
@@ -359,5 +362,70 @@ describe BlacklightHelper do
     end
   end
 
+  describe "render_index_field_value" do
+    before do
+      @config = Blacklight::Configuration.new.configure do |config|
+        config.add_index_field 'qwer'
+        config.add_index_field 'asdf', :helper_method => :render_asdf_index_field
+      end
+      helper.stub(:blacklight_config).and_return(@config)
+    end
+
+    it "should check for an explicit value" do
+      doc = mock()
+      doc.should_not_receive(:get).with('asdf', :sep => nil)
+      value = helper.render_index_field_value :value => 'asdf', :document => doc, :field => 'asdf'
+      value.should == 'asdf'
+    end
+
+    it "should check for a helper method to call" do
+      doc = mock()
+      doc.should_not_receive(:get).with('asdf', :sep => nil)
+      helper.stub(:render_asdf_index_field).and_return('custom asdf value')
+      value = helper.render_index_field_value :document => doc, :field => 'asdf'
+      value.should == 'custom asdf value'
+    end
+
+    it "should check the document field value" do
+      doc = mock()
+      doc.should_receive(:get).with('qwer', :sep => nil).and_return('document qwer value')
+      value = helper.render_index_field_value :document => doc, :field => 'qwer'
+      value.should == 'document qwer value'
+    end
+  end
+  
+
+  describe "render_document_show_field_value" do
+    before do
+      @config = Blacklight::Configuration.new.configure do |config|
+        config.add_show_field 'qwer'
+        config.add_show_field 'asdf', :helper_method => :render_asdf_document_show_field
+      end
+      helper.stub(:blacklight_config).and_return(@config)
+    end
+
+    it "should check for an explicit value" do
+      doc = mock()
+      doc.should_not_receive(:get).with('asdf', :sep => nil)
+      helper.should_not_receive(:render_asdf_document_show_field)
+      value = helper.render_document_show_field_value :value => 'asdf', :document => doc, :field => 'asdf'
+      value.should == 'asdf'
+    end
+
+    it "should check for a helper method to call" do
+      doc = mock()
+      doc.should_not_receive(:get).with('asdf', :sep => nil)
+      helper.stub(:render_asdf_document_show_field).and_return('custom asdf value')
+      value = helper.render_document_show_field_value :document => doc, :field => 'asdf'
+      value.should == 'custom asdf value'
+    end
+
+    it "should check the document field value" do
+      doc = mock()
+      doc.should_receive(:get).with('qwer', :sep => nil).and_return('document qwer value')
+      value = helper.render_document_show_field_value :document => doc, :field => 'qwer'
+      value.should == 'document qwer value'
+    end
+  end
   
 end

data/test_support/spec/helpers/render_constraints_helper_spec.rb

@@ -3,12 +3,13 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe RenderConstraintsHelper do
 
   before do
-    ## Pretend that we're in a controller at /advanced_search
-    Journey::Route.any_instance.stub(:format).and_return('/advanced_search')
+    # the helper methods below infer paths from the current route
+    controller.request.path_parameters["controller"] = 'catalog'
   end
+
   describe '#render_constraints_query' do
     it "should have a link relative to the current url" do
-      helper.render_constraints_query(:q=>'foobar', :f=>{:type=>'journal'}).should have_selector "a[href='/advanced_search?f%5Btype%5D=journal']"
+      helper.render_constraints_query(:q=>'foobar', :f=>{:type=>'journal'}).should have_selector "a[href='/catalog?f%5Btype%5D=journal']"
     end
   end
 
@@ -23,7 +24,7 @@ describe RenderConstraintsHelper do
       result = helper.render_filter_element('type', ['journal'], {:q=>'biz'})
       result.size.should == 1
       # I'm not certain how the ampersand gets in there. It's not important.
-      result.first.should have_selector "a[href='/advanced_search?&q=biz']"
+      result.first.should have_selector "a[href='/catalog?&q=biz']"
     end
   end
 

data/test_support/spec/lib/blacklight_configuration_spec.rb

@@ -35,11 +35,18 @@ describe "Blacklight::Configuration" do
     it "should have a hash of default rsolr query parameters" do
       @config.default_solr_params.should be_a_kind_of Hash
     end
+
     it "should have openstruct values for show and index parameters" do
       @config.show.should be_a_kind_of OpenStruct
       @config.index.should be_a_kind_of OpenStruct
     end
 
+    it "should introspect SolrDocument for sensible defaults  for show + index" do
+      @config.show.html_title.should == 'id'
+      @config.show.heading.should == 'id'
+      @config.index.show_link.should == 'id'
+    end
+
     it "should have ordered hashes for field configuration" do
       @config.facet_fields.should be_a_kind_of ActiveSupport::OrderedHash
       @config.index_fields.should be_a_kind_of ActiveSupport::OrderedHash

data/test_support/spec/lib/solr_helper_spec.rb

@@ -472,6 +472,13 @@ describe 'Blacklight::SolrHelper' do
         (@solr_response, @document_list) = get_search_results(:q => @all_docs_query)
       end
 
+      it "should use the configured request handler " do
+        require 'ostruct'
+        blacklight_config.stub(:solr_request_handler => 'custom_request_handler')
+        self.should_receive(:find).with('custom_request_handler', anything).and_return(OpenStruct.new( :docs => [{}] ))
+        get_search_results(:q => @all_docs_query)
+      end
+
       it 'should have a @response.docs list of the same size as @document_list' do
         @solr_response.docs.length.should == @document_list.length
       end
@@ -700,6 +707,13 @@ describe 'Blacklight::SolrHelper' do
       }.should raise_error(Blacklight::Exceptions::InvalidSolrID)
     end
 
+    it "should use a provided document request handler " do
+      require 'ostruct'
+      blacklight_config.stub(:document_solr_request_handler => 'document')
+      self.should_receive(:find).with('document', anything).and_return(OpenStruct.new( :docs => [{}] ))
+      get_solr_response_for_doc_id(@doc_id)
+    end
+
     it "should have a non-nil result for a known id" do
       @document.should_not == nil
     end
@@ -716,6 +730,29 @@ describe 'Blacklight::SolrHelper' do
     end
   end
 
+  describe "solr_doc_params" do
+    it "should default to using the 'document' requestHandler" do
+      doc_params = solr_doc_params('asdfg')
+      doc_params[:qt].should == 'document'
+    end
+
+
+    describe "blacklight config's default_document_solr_parameters" do
+      def blacklight_config          
+        config = Blacklight::Configuration.new
+        config.default_document_solr_params = { :qt => 'my_custom_handler', :asdf => '1234' }
+        config
+      end
+
+      it "should use parameters from the controller's default_document_solr_parameters" do
+        doc_params = solr_doc_params('asdfg')
+        doc_params[:qt].should == 'my_custom_handler'
+        doc_params[:asdf].should == '1234'
+      end
+    end
+
+  end
+
   describe "Get Document by custom unique id" do
 =begin    
     # Can't test this properly without updating the "document" request handler in solr
@@ -880,17 +917,17 @@ describe 'Blacklight::SolrHelper' do
         @mock_response.stub(:docs => [])
       end
       it "should contruct a solr query based on the field and value pair" do
-        self.should_receive(:find).with(hash_including(:q => "field_name:(value)")).and_return(@mock_response)
+        self.should_receive(:find).with(an_instance_of(String), hash_including(:q => "field_name:(value)")).and_return(@mock_response)
         get_solr_response_for_field_values('field_name', 'value')
       end
 
       it "should OR multiple values together" do
-        self.should_receive(:find).with(hash_including(:q => "field_name:(a OR b)")).and_return(@mock_response)
+        self.should_receive(:find).with(an_instance_of(String), hash_including(:q => "field_name:(a OR b)")).and_return(@mock_response)
         get_solr_response_for_field_values('field_name', ['a', 'b'])
       end
 
       it "should escape crazy identifiers" do
-        self.should_receive(:find).with(hash_including(:q => "field_name:(\"h://\\\"\\\'\")")).and_return(@mock_response)
+        self.should_receive(:find).with(an_instance_of(String), hash_including(:q => "field_name:(\"h://\\\"\\\'\")")).and_return(@mock_response)
         get_solr_response_for_field_values('field_name', 'h://"\'')
       end
     end
@@ -902,6 +939,9 @@ describe 'Blacklight::SolrHelper' do
 # TODO: maybe eventually check other types of solr requests
 #  more like this
 #  nearby on shelf
-
+  it "should raise a Blacklight exception if RSolr can't connect to the Solr instance" do
+    Blacklight.solr.stub!(:find).and_raise(Errno::ECONNREFUSED)
+    expect { find(:a => 123) }.to raise_exception(/Unable to connect to Solr instance/)
+  end
 end
 

data/test_support/spec/lib/tasks/solr_marc_task_spec.rb

@@ -52,7 +52,7 @@ describe "solr:marc:*" do
         java_cmd.should match "java -Xmx512m"
         java_cmd.should match /-jar .*\/SolrMarc\.jar/
         java_cmd.should match "#{Rails.root}/config/SolrMarc/config-test.properties dummy.mrc"
-        java_cmd.should match "-Dsolr.hosturl=http://127.0.0.1:[0-9]{4}/solr"
+        java_cmd.should match "-Dsolr.hosturl=http://127.0.0.1:[0-9]{2,5}/solr"
       end
       
     end  

data/test_support/spec/views/catalog/index.atom.builder_spec.rb

@@ -4,48 +4,25 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 describe "catalog/index" do  
 
   before(:all) do
-    @config ||= Blacklight::Configuration.from_legacy_configuration({
-      :show => {
-        :display_type => 'asdf'
-      },
-      :index_fields => {
-        :field_names => [],
-        :labels => {}
+    @config = Blacklight::Configuration.new.configure do |config|
+      config.default_solr_params = {
+        :fl => '*',
+        :rows => 10
       }
-    })
-  
-    @mock_configuration_module = Module.new do 
-      # Just test against our default config for now. 
-      def blacklight_config
-        @config ||= Blacklight::Config.new
-      end
     end
     
-    class AtomMockDocument
-      include Blacklight::Solr::Document
-    end
+    @params = { 'content_format' => 'marc', :f => { :format => ['Book'] }, :page => 2 }
 
-    AtomMockDocument.field_semantics.merge!(    
-      :title => "title_display",
-      :author => "author_display"        
-    )
-    AtomMockDocument.extension_parameters[:marc_format_type] = :marc21
-    AtomMockDocument.extension_parameters[:marc_source_field] = :marc_display
-    AtomMockDocument.use_extension( Blacklight::Solr::Document::Marc) do |document|
-      document.key?( :marc_display  )
-    end
-  
-    # Load sample responses from Solr to a sample request, to test against
-    @data = YAML.load(File.open(File.dirname(__FILE__) + 
-                               "/../../data/sample_docs.yml", "r:UTF-8"))
-    @rsolr_response = RSolr::Ext::Response::Base.new(@data["solr_response"], nil, @data["params"])
-    @params = @data["params"]
-    @document_list = @data["document_list_mash"].collect do |d|   
-      AtomMockDocument.new(d)
-    end
+    # run a solr query to get our data
+    c = CatalogController.new
+    c.blacklight_config = @config
+    @response, @document_list = c.get_search_results(@params)
+
+    # munge the solr response to match test expectations
+    @document_list[1] = SolrDocument.new(@document_list[1].to_mash.reject! { |k,v| k == "author_display" })
+    @document_list[5] = SolrDocument.new(@document_list[1].to_mash.reject! { |k,v| k == "marc_display" })
   end
   before(:each) do
-
     # Not sure what Assigns was doing here ... dhf
     #    assigns[:response] = @rsolr_response
     #    assigns[:document_list] = @document_list
@@ -53,8 +30,6 @@ describe "catalog/index" do
     # but okay. 
 
     params.merge!( @params )
-    @response = @rsolr_response
- 
     view.stub!(:blacklight_config).and_return(@config)
     view.stub!(:search_field_options_for_select).and_return([])
 
@@ -64,7 +39,6 @@ describe "catalog/index" do
       render :template => 'catalog/index.atom'
     end
 
-
     # We need to use rexml to test certain things that have_tag wont' test    
     # note that response is depricated rails 3, use "redered" instead. 
     @response_xml = REXML::Document.new(rendered)   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,10 +13,11 @@ authors:
 - Vernon Chapman
 - Mark A. Matienzo
 - Dan Funk
+- Naomi Dushay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-17 00:00:00.000000000 Z
+date: 2012-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -194,11 +195,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.0
-description: Blacklight is a free and open source ruby-on-rails based discovery interface
-  (a.k.a. “next-generation catalog”) especially optimized for heterogeneous collections.
-  You can use it as a library catalog, as a front end for a digital repository, or
-  as a single-search interface to aggregate digital content that would otherwise be
-  siloed.
+description: Blacklight is an open source Solr user interface discovery platform.
+  You can use Blacklight to enable searching and browsing of your collections. Blacklight
+  uses the Apache Solr search engine to search full text and/or metadata.
 email:
 - blacklight-development@googlegroups.com
 executables: []
@@ -477,7 +476,6 @@ files:
 - test_support/spec/rcov.opts
 - test_support/spec/spec.opts
 - test_support/spec/spec_helper.rb
-- test_support/spec/support/action_controller.rb
 - test_support/spec/support/assert_difference.rb
 - test_support/spec/support/include_text.rb
 - test_support/spec/views/catalog/_constraints_element.html.erb_spec.rb
@@ -501,7 +499,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1253427252595743180
+      hash: 3883419086442595673
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -510,11 +508,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1253427252595743180
+      hash: 3883419086442595673
 requirements: []
 rubyforge_project: blacklight
 rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: A next-generation Library Catalag for Universities
+summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
+  index.
 test_files: []

data/test_support/spec/support/action_controller.rb

@@ -1,43 +0,0 @@
-# -*- encoding : utf-8 -*-
-# Added based on http://www.arctickiwi.com/blog/upgrading-to-rspec-2-with-ruby-on-rails-3
-# God bless you Jonathon Horsman 
-module ActionController
-  class TestCase < ActiveSupport::TestCase
-    module Behavior
-      def process(action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
-        # Sanity check for required instance variables so we can give an
-        # understandable error message.
-        %w(@routes @controller @request @response).each do |iv_name|
-          if !(instance_variable_names.include?(iv_name) || instance_variable_names.include?(iv_name.to_sym)) || instance_variable_get(iv_name).nil?
-            raise "#{iv_name} is nil: make sure you set it in your test's setup method."
-          end
-        end
-        
-        @request.recycle!
-        @response.recycle!
-        @controller.response_body = nil
-        @controller.formats = nil
-        @controller.params = nil
-        
-        @html_document = nil
-        @request.env['REQUEST_METHOD'] = http_method
-        
-        parameters ||= {}
-        @request.assign_parameters(@routes, @controller.class.name.underscore.sub(/_controller$/, ''), action.to_s, parameters)
-        
-        @request.session = ActionController::TestSession.new(session) unless session.nil?
-        @request.session["flash"] = @request.flash.update(flash || {})
-        @request.session["flash"].sweep
-        
-        @controller.request = @request
-        #@controller.params.merge!(parameters) # this is the offending line, which I removed
-        build_request_uri(action, parameters)
-        Base.class_eval { include Testing }
-        @controller.process_with_new_base_test(@request, @response)
-        @request.session.delete('flash') if @request.session['flash'].blank?
-        @response
-      end
-    end
-  end
-end
-