blacklight 3.0.0pre4 → 3.0.0pre6

data/lib/blacklight/solr_helper.rb

@@ -196,6 +196,8 @@ module Blacklight::SolrHelper
         
         solr_parameters[:fq] ||= []
         f_request_params.each_pair do |facet_field, value_list|
+          value_list ||= []
+          value_list = [value_list] unless value_list.respond_to? :each
           value_list.each do |value|
             solr_parameters[:fq] << "{!raw f=#{facet_field}}#{value}"
           end              
@@ -261,13 +263,12 @@ module Blacklight::SolrHelper
     # just to be consistent with the other solr param methods:
     {
       :qt => :document,
-      :id => id
+      :id => id # this assumes the document request handler will map the 'id' param to the unique key field
     }
   end
   
   # a solr query method
   # retrieve a solr document, given the doc id
-  # TODO: shouldn't hardcode id field;  should be setable to unique_key field in schema.xml
   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)
     raise Blacklight::Exceptions::InvalidSolrID.new if solr_response.docs.empty?
@@ -277,6 +278,8 @@ module Blacklight::SolrHelper
   
   # given a field name and array of values, get the matching SOLR documents
   def get_solr_response_for_field_values(field, values, extra_solr_params = {})
+    values ||= []
+    values = [values] unless values.respond_to? :each
     value_str = "(\"" + values.to_a.join("\" OR \"") + "\")"
     solr_params = {
       :defType => "lucene",   # need boolean for OR
@@ -368,6 +371,8 @@ module Blacklight::SolrHelper
   def get_single_doc_via_search(index, request_params)
     solr_params = solr_search_params(request_params)
     solr_params[:start] = index - 1 # start at 0 to get 1st doc, 1 to get 2nd. 
+    # FIXME: we must set page because of a  bug posted here: https://github.com/mwmitchell/rsolr-ext/issues/16
+    solr_params[:page] = index - 1 # start at 0 to get 1st doc, 1 to get 2nd. 
     solr_params[:per_page] = 1
     solr_params[:rows] = 1
     solr_params[:fl] = '*'

data/lib/generators/blacklight/blacklight_generator.rb

@@ -22,6 +22,7 @@ This generator makes the following changes to your application:
  9. Injects behavior into your user model
 10. Creates a blacklight catalog controller in your /app/controllers directory
 11. Creates a blacklight document in your /app/models directory
+12. Adds Blacklight routes to your ./config/routes.rb
 Thank you for Installing Blacklight.
        """ 
   # Implement the required interface for Rails::Generators::Migration.
@@ -134,6 +135,11 @@ EOF
     copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb"
   end
 
+  def inject_blacklight_routes
+    route('root :to => "catalog#index"')
+    route('Blacklight.add_routes(self)')
+  end
+
   private  
   
   def better_migration_template (file)

data/lib/generators/blacklight/templates/public/stylesheets/blacklight/blacklight.css

@@ -218,7 +218,7 @@ font-weight:bold;
   text-align: center;
 }
 
-#startOverLink{display:block; position:absolute; top:50%; right:0.66em; margin-top:-12px; padding:0 7px 3px 12px; line-height:22px; text-decoration:none; color:#fff; background:url(../images/blacklight/start_over.gif) no-repeat center center; border-bottom: none;}
+#startOverLink{display:block; position:absolute; top:50%; right:0.66em; margin-top:-12px; padding:0 7px 3px 12px; line-height:22px; text-decoration:none; color:#fff; background:url(../../images/blacklight/start_over.gif) no-repeat center center; border-bottom: none;}
 
 
 #sortAndPerPage {
@@ -460,7 +460,7 @@ Search Parameters
   top:0; 
   width:32px;
   height:100%; 
-  background:url(../images/blacklight/remove.gif) no-repeat center center; 
+  background:url(../../images/blacklight/remove.gif) no-repeat center center; 
   border-left:1px solid #d0daea;
   border-bottom: none;
   text-indent:-99999px; /* text there for screen readers, hidden visually */
@@ -475,7 +475,7 @@ Search Parameters
 .appliedFilter .queryName, .appliedFilter .filterName {
   /* ">" image */ 
   padding-right:14px; 
-  background:url(../images/blacklight/separator.gif) no-repeat right center;
+  background:url(../../images/blacklight/separator.gif) no-repeat right center;
 }
 
 .filterValue {

data/lib/railties/all_tests.rake

@@ -1,11 +1,23 @@
 namespace :blacklight do
-  desc "Run Blacklight cucumber and rspec"
-  task :all_tests => ['blacklight:spec:with_solr', 'blacklight:cucumber:with_solr']
+  begin
+    require 'cucumber/rake/task'
+    require 'rspec/core'
+    require 'rspec/core/rake_task'
 
-  namespace :all_tests do
-    desc "Run Blacklight rspec and cucumber tests with rcov"
-    rm "blacklight-coverage.data" if File.exist?("blacklight-coverage.data")
-    task :rcov => ['blacklight:spec:rcov', 'blacklight:cucumber:rcov']
+    desc "Run Blacklight cucumber and rspec, with test solr"
+    task :all_tests => ['blacklight:spec:with_solr', 'blacklight:cucumber:with_solr']
+    
+    namespace :all_tests do
+      desc "Run Blacklight rspec and cucumber tests with rcov"
+      rm "blacklight-coverage.data" if File.exist?("blacklight-coverage.data")
+      task :rcov => ['blacklight:spec:rcov', 'blacklight:cucumber:rcov']
+    end
+    
+  rescue LoadError
+    desc "Not available! (cucumber and rspec not avail)"
+    task :all_tests do
+      abort 'Not available. Both cucumber and rspec need to be installed to run blacklight:all_tests'
+    end
   end
 end
 

data/lib/railties/blacklight.rake

@@ -1,11 +1,12 @@
+
 namespace :blacklight do
-  
   # task to clean out old, unsaved searches
   # rake blacklight:delete_old_searches[days_old]
   # example cron entry to delete searches older than 7 days at 2:00 AM every day: 
   # 0 2 * * * cd /path/to/your/app && /path/to/rake blacklight:delete_old_searches[7] RAILS_ENV=your_env
   desc "Removes entries in the searches table that are older than the number of days given."
-  task :delete_old_searches, :days_old, :needs => :environment do |t, args|
+  task :delete_old_searches, [:days_old] => [:environment] do |t, args|
+    args.with_defaults(:days_old => 7)    
     Search.delete_old_searches(args[:days_old].to_i)
   end
 

data/lib/railties/blacklight_cucumber.rake

@@ -7,7 +7,7 @@
 # Blacklight customization, trick Cucumber into looking in our current
 # location for Rails.root, even though we're going to give it features
 # from elsewhere. 
-ENV['RAILS_ROOT'] = Rails.root
+ENV['RAILS_ROOT'] = Rails.root.to_s
 
 # blacklight_features, where to find features inside blacklight source?
 blacklight_features = File.expand_path("./test_support/features", Blacklight.root)

data/lib/railties/blacklight_rspec.rake

@@ -23,7 +23,7 @@ begin
   # since we allow spec_dir to be in a remote location. spec_helper.rb
   # needs it before Rails.root is defined there, even though we can
   # oddly get it here, i dunno. 
-  ENV['RAILS_ROOT'] = Rails.root
+  ENV['RAILS_ROOT'] = Rails.root.to_s
   
   namespace :blacklight do
     

data/lib/railties/solr_marc.rake

@@ -1,4 +1,4 @@
-# -*- coding: undecided -*-
+# -*- coding: UTF-8 -*-
 # Rake tasks for the SolrMarc Java indexer.
 # Marc Record defaults to indexing lc_records.utf8.mrc
 # config.properties defaults to config/demo_config.properties (in the plugin, not the rails app)

data/test_support/spec/controllers/application_controller_spec.rb

@@ -9,11 +9,11 @@ describe ApplicationController do
         controller.send(:default_html_head)
       end
       it "should setup js and css defaults" do                
-        controller.javascript_includes.should include(["blacklight/jquery-1.4.2.min.js", "blacklight/jquery-ui-1.8.1.custom.min.js", "blacklight/blacklight"])#find do |item|
+        controller.javascript_includes.should include(["jquery-1.4.2.min.js", "jquery-ui-1.8.1.custom.min.js", "blacklight/blacklight"])#find do |item|
         #  item == ["jquery-1.4.2.min.js", "jquery-ui-1.7.2.custom.min.js", "blacklight", "application", "accordion", "lightbox", {:plugin=>:blacklight}]
         #end
 
-        controller.stylesheet_links.should include(["blacklight/yui", "blacklight/jquery/ui-lightness/jquery-ui-1.8.1.custom.css", "blacklight/blacklight", {:media=>"all"}])
+        controller.stylesheet_links.should include(["yui", "jquery/ui-lightness/jquery-ui-1.8.1.custom.css", "blacklight/blacklight", {:media=>"all"}])
       end
     end
   end

data/test_support/spec/controllers/catalog_controller_spec.rb

@@ -20,18 +20,6 @@ describe CatalogController do
       # RSpec <1.2.9: route_for(:controller => 'catalog', :action => 'show', :id => '666').should == '/catalog/666'
       { :get => "/catalog/666" }.should route_to(:controller => 'catalog', :action => 'show', :id => "666")
     end
-    it "should map {:controller => 'catalog', :id = '444', :action => 'image'} to /catalog/444/image" do
-      # RSpec <1.2.9: route_for(:controller => 'catalog', :action => 'image', :id => '444').should == '/catalog/444/image'
-      { :get => "/catalog/444/image" }.should route_to(:controller => "catalog", :action => "image", :id => "444")
-    end
-    it "should map {:controller => 'catalog', :id = '333', :action => 'status'} to /catalog/333/status" do
-      # RSpec <1.2.9: route_for(:controller => 'catalog', :action => 'status', :id => '333').should == '/catalog/333/status'
-      { :get => "/catalog/333/status" }.should route_to(:controller => 'catalog', :action => 'status', :id => "333")
-    end
-    it "should map {:controller => 'catalog', :id => '222', :action => 'availability'} to /catalog/222/availability" do
-      # RSpec <1.2.9: route_for(:controller => 'catalog', :action => 'availability', :id => '222').should == '/catalog/222/availability'
-      { :get => "/catalog/222/availability" }.should route_to(:controller => 'catalog', :action => 'availability', :id => "222")
-    end
     it "should map {:controller => 'catalog', :id => '111', :action => 'librarian_view'} to /catalog/111/librarian_view" do
       # RSpec <1.2.9: route_for(:controller => 'catalog', :action => 'librarian_view', :id => '111').should == '/catalog/111/librarian_view'
       { :get => "/catalog/111/librarian_view" }.should route_to(:controller => 'catalog', :action => 'librarian_view', :id => "111")
@@ -52,18 +40,6 @@ describe CatalogController do
       #RSPEC <1.2.9  params_from(:get, '/catalog/666').should == {:controller => 'catalog', :action => 'show', :id => '666'}
       { :get => "/catalog/666" }.should route_to(:controller => 'catalog', :action => 'show', :id => "666")
     end
-    it "should map /catalog/444/image to {:controller => 'catalog', :action => 'image', :id => 444}" do
-     # params_from(:get, '/catalog/444/image').should == {:controller => 'catalog', :action => 'image', :id => '444'}
-      { :get => "/catalog/444/image" }.should route_to(:controller => 'catalog', :action => 'image', :id => "444")
-    end
-    it "should map /catalog/333/status to {:controller => 'catalog', :action => 'status', :id => 333}" do
-      #params_from(:get, '/catalog/333/status').should == {:controller => 'catalog', :action => 'status', :id => '333'}
-      { :get => "/catalog/333/status" }.should route_to(:controller => 'catalog', :action => 'status', :id => "333")
-    end
-    it "should map /catalog/222/availability to {:controller => 'catalog', :action => 'availability', :id => 222}" do
-#      params_from(:get, '/catalog/222/availability').should == {:controller => 'catalog', :action => 'availability', :id => '222'}
-      { :get => "/catalog/222/availability" }.should route_to(:controller => 'catalog', :action => 'availability', :id => "222")
-    end
     it "should map /catalog/111/librarian_view to {:controller => 'catalog', :action => 'librarian_view', :id => 111}" do
 #      params_from(:get, '/catalog/111/librarian_view').should == {:controller => 'catalog', :action => 'librarian_view', :id => '111'}
       { :get => "/catalog/111/librarian_view" }.should route_to(:controller => 'catalog', :action => 'librarian_view', :id => "111")

data/test_support/spec/helpers/blacklight_helper_spec.rb

@@ -1,4 +1,4 @@
-# -*- coding: undecided -*-
+# -*- coding: UTF-8 -*-
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 require 'marc'
 def exportable_record
@@ -419,7 +419,7 @@ describe BlacklightHelper do
   end
 
   describe "render_link_rel_alternates" do
-      class MockDocumentAppHlper
+      class MockDocumentAppHelper
         include Blacklight::Solr::Document        
       end
       module MockExtension
@@ -432,10 +432,10 @@ describe BlacklightHelper do
          def export_as_weirder ; "weirder" ; end
          def export_as_weird_dup ; "weird_dup" ; end
       end
-      MockDocumentAppHlper.use_extension(MockExtension)
+      MockDocumentAppHelper.use_extension(MockExtension)
     before(:each) do
       @doc_id = "MOCK_ID1"
-      @document = MockDocumentAppHlper.new(:id => @doc_id)
+      @document = MockDocumentAppHelper.new(:id => @doc_id)
       render_params = {:controller => "controller", :action => "action"}
       helper.stub!(:params).and_return(render_params)
     end

data/test_support/spec/helpers/catalog_helper_spec.rb

@@ -2,65 +2,69 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe CatalogHelper do
   include CatalogHelper
 
-  def mock_collection args
+  def mock_response args
     current_page = args[:current_page] || 1
     per_page = args[:per_page] || 10
     total = args[:total]
-    arr = (1..total).to_a
+    start = (current_page - 1) * per_page
 
-    page_results = WillPaginate::Collection.create(current_page, per_page, total) do |pager|
-      pager.replace(arr.slice(pager.offset, pager.per_page))
-    end
+    mock_response = mock("RSolr::Ext::Response")
+    mock_response.stub!(:total).and_return(total)
+    mock_response.stub!(:rows).and_return(per_page)
+    mock_response.stub!(:start).and_return(start)
+    mock_response.stub!(:docs).and_return((1..total).to_a.slice(start, per_page))
+
+    mock_response
   end
   
-  describe "page_entries_info" do
+  describe "render_pagination_info" do
     before(:all) do
     end
 
     it "with no results" do
-      @collection = mock_collection :total => 0
+      @response = mock_response :total => 0
 
-      html = page_entries_info(@collection, { :entry_name => 'entry_name' })
+      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
       html.should == "No entry_names found"
       html.html_safe?.should == true
     end
 
     it "with a single result" do
-      @collection = mock_collection :total => 1
+      @response = mock_response :total => 1
 
-      html = page_entries_info(@collection, { :entry_name => 'entry_name' })
+      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
       html.should == "Displaying <b>1</b> entry_name"
       html.html_safe?.should == true
     end
 
     it "with a single page of results" do
-      @collection = mock_collection :total => 7
+      @response = mock_response :total => 7
 
-      html = page_entries_info(@collection, { :entry_name => 'entry_name' })
+      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
       html.should == "Displaying <b>all 7</b> entry_names"
       html.html_safe?.should == true
     end
 
     it "on the first page of multiple pages of results" do
-      @collection = mock_collection :total => 15, :per_page => 10
+      @response = mock_response :total => 15, :per_page => 10
 
-      html = page_entries_info(@collection, { :entry_name => 'entry_name' })
+      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
       html.should == "Displaying entry_names <b>1 - 10</b> of <b>15</b>"
       html.html_safe?.should == true
     end
 
     it "on the second page of multiple pages of results" do
-      @collection = mock_collection :total => 47, :per_page => 10, :current_page => 2
+      @response = mock_response :total => 47, :per_page => 10, :current_page => 2
 
-      html = page_entries_info(@collection, { :entry_name => 'entry_name' })
+      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
       html.should == "Displaying entry_names <b>11 - 20</b> of <b>47</b>"
       html.html_safe?.should == true
     end
 
     it "on the last page of results" do
-      @collection = mock_collection :total => 47, :per_page => 10, :current_page => 5
+      @response = mock_response :total => 47, :per_page => 10, :current_page => 5
 
-      html = page_entries_info(@collection, { :entry_name => 'entry_name' })
+      html = render_pagination_info(@response, { :entry_name => 'entry_name' })
       html.should == "Displaying entry_names <b>41 - 47</b> of <b>47</b>"
       html.html_safe?.should == true
     end

data/test_support/spec/helpers/solr_helper_spec.rb

@@ -151,6 +151,8 @@ describe 'Blacklight::SolrHelper' do
         params = @solr_helper.solr_search_params(:f => @multi_facets)
 
         @multi_facets.each_pair do |facet_field, value_list|
+          value_list ||= []
+          value_list = [value_list] unless value_list.respond_to? :each
           value_list.each do |value|
             params[:fq].should include("{!raw f=#{facet_field}}#{value}"  )
           end
@@ -164,6 +166,8 @@ describe 'Blacklight::SolrHelper' do
         params = @solr_helper.solr_search_params(:q => @mult_word_query, :f => @multi_facets)
 
         @multi_facets.each_pair do |facet_field, value_list|
+          value_list ||= []
+          value_list = [value_list] unless value_list.respond_to? :each
           value_list.each do |value|
             params[:fq].should include("{!raw f=#{facet_field}}#{value}"  )
           end
@@ -686,7 +690,7 @@ describe 'Blacklight::SolrHelper' do
       @response2.docs.size.should == 1
     end
     it 'should have the expected value in the id field' do
-      @document.get(:id).should == @doc_id
+      @document.id.should == @doc_id
     end
     it 'should have non-nil values for required fields set in initializer' do
       @document.get(Blacklight.config[:show][:html_title]).should_not == nil
@@ -699,9 +703,22 @@ describe 'Blacklight::SolrHelper' do
       Blacklight.config[:show_fields][:field_names].length.should > 0
       Blacklight.config[:show_fields][:field_names][0].should_not == nil
     end
+  end
 
-
-
+  describe "Get Document by custom unique id" do
+=begin    
+    # Can't test this properly without updating the "document" request handler in solr
+    it "should respect the configuration-supplied unique id" do
+      SolrDocument.should_receive(:unique_key).and_return("title_display")
+      @response, @document = @solr_helper.get_solr_response_for_doc_id('"Strong Medicine speaks"')
+      @document.id.should == '"Strong Medicine speaks"'
+      @document.get(:id).should == 2007020969
+    end
+=end
+    it "should respect the configuration-supplied unique id" do
+      doc_params = @solr_helper.solr_doc_params('"Strong Medicine speaks"')
+      doc_params[:id].should == '"Strong Medicine speaks"'
+    end
   end
 
 # NOTE: some of these repeated fields could be in a shared behavior, but the
@@ -731,7 +748,7 @@ describe 'Blacklight::SolrHelper' do
 =end
 
     it 'should have a doc id field' do
-      @doc.get(:id).should_not == nil
+      @doc.id.should_not == nil
     end
 
     it 'should have non-nil values for required fields set in initializer' do
@@ -742,7 +759,7 @@ describe 'Blacklight::SolrHelper' do
 
     it "should limit search result by facets when supplied" do
       doc2 = @solr_helper.get_single_doc_via_search(@doc_row , :q => @all_docs_query, :f => @multi_facets)
-      doc2.get(:id).should_not == nil
+      doc2.id.should_not == nil
     end
 
   end

data/test_support/spec/lib/blacklight_solr_document_spec.rb

@@ -18,6 +18,13 @@ describe "Blacklight::Solr::Document" do
       end
     end
    
+    context "Unique Key" do
+      it "should use a configuration-defined document unique key" do
+        MockDocument.should_receive(:unique_key).and_return(:my_unique_key)
+        @document = MockDocument.new :id => 'asdf', :my_unique_key => '1234'
+        @document.id.should == '1234'
+      end
+    end
 
     context "Extendability" do
       before(:each) do
@@ -27,7 +34,7 @@ describe "Blacklight::Solr::Document" do
     
       it "should let you register an extension" do
         MockDocument.use_extension(MockExtension) { |doc| true }
-  
+
         MockDocument.registered_extensions.find {|a| a[:module_obj] == MockExtension}.should_not be_nil
       end
       it "should let you register an extension with a nil condition proc" do
@@ -37,39 +44,39 @@ describe "Blacklight::Solr::Document" do
       it "should apply an extension whose condition is met" do
         MockDocument.use_extension(MockExtension) {|doc| true}
         doc = MockDocument.new()
-  
-        doc.methods.find {|name| name =="my_extension_method"}.should_not be_nil
-        doc.my_extension_method.should == "my_extension_results"
+
+        doc.methods.find {|name| name.to_s == "my_extension_method"}.should_not be_nil
+        doc.my_extension_method.to_s.should == "my_extension_results"
       end
       it "should apply an extension based on a Solr field" do
         MockDocument.use_extension(MockExtension) {|doc| doc.key?(:required_key)}
 
         with_extension = MockDocument.new(:required_key => "value")
-        with_extension.my_extension_method.should == "my_extension_results"
+        with_extension.my_extension_method.to_s.should == "my_extension_results"
 
         without_extension = MockDocument.new(:other_key => "value")
-        without_extension.methods.find {|name| name == "my_extension_method"}.should be_nil
+        without_extension.methods.find {|name| name.to_s == "my_extension_method"}.should be_nil
         
       end
       it "should not apply an extension whose condition is not met" do
         MockDocument.use_extension(MockExtension) {|doc| false}
         doc = MockDocument.new()
   
-        doc.methods.find {|name| name == "my_extension_method"}.should be_nil      
+        doc.methods.find {|name| name.to_s == "my_extension_method"}.should be_nil      
       end
       it "should treat a nil condition as always applyable" do
         MockDocument.use_extension(MockExtension)
   
         doc = MockDocument.new()
   
-        doc.methods.find {|name | name=="my_extension_method"}.should_not be_nil
+        doc.methods.find {|name | name.to_s =="my_extension_method"}.should_not be_nil
         doc.my_extension_method.should == "my_extension_results"
       end
       it "should let last extension applied override earlier extensions" do
         MockDocument.use_extension(MockExtension)
         MockDocument.use_extension(MockSecondExtension)
 
-        MockDocument.new().my_extension_method.should == "override"        
+        MockDocument.new().my_extension_method.to_s.should == "override"        
       end
 
       describe "extension_parameters class-level hash" do