blacklight 3.0pre1 → 3.0pre2

data/test_support/spec/lib/search_fields_spec.rb

@@ -0,0 +1,105 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Blacklight::SearchFields do
+
+  class MockConfig
+    include Blacklight::SearchFields
+
+    # add in a #config method that includes search field config
+    # that will be used by SearchFields
+    def config
+      @config ||= {:search_fields => [ {:display_label => 'All Fields', :key => "all_fields"},
+                           {:key => 'title', :qt => 'title_search'},
+                           {:key => 'author', :qt => 'author_search'},
+                           {:key => 'subject', :qt=> 'subject_search'},
+                           ['Legacy Config', 'legacy_qt'],
+                           {:key => "no_display", :qt=>"something", :include_in_simple_select => false}
+                          ],
+        :default_qt => "search"
+      }
+    end
+    
+  end
+
+  before(:all) do
+    @search_field_obj = MockConfig.new
+  end
+
+  it 'should convert legacy Array config to Hash properly' do
+    hash = @search_field_obj.search_field_def_for_key('legacy_qt')
+
+    hash.should be_kind_of(Hash)
+    hash[:key].should == hash[:qt]
+    hash[:display_label].should == 'Legacy Config'
+  end
+  
+  it "should return search field list with calculated :display_label when needed" do
+     @search_field_obj.search_field_list.each do |hash|        
+        hash[:display_label].should_not be_blank
+     end
+  end
+
+  it "should fill in default qt where needed" do
+    @search_field_obj.search_field_def_for_key("all_fields")[:qt].should == Blacklight.config[:default_qt]
+  end
+  
+  it "should return proper options_for_select arguments" do
+    select_arguments = @search_field_obj.search_field_options_for_select
+
+    select_arguments.each_index do |index|
+       argument = select_arguments[index]
+       config_hash = @search_field_obj.search_field_list[index]
+
+       argument.length.should == 2
+       argument[0].should == config_hash[:display_label]
+       argument[1].should == config_hash[:key]
+    end    
+  end
+
+  it "should not include fields in select if :display_in_simple_search=>false" do
+    select_arguments = @search_field_obj.search_field_options_for_select
+
+    select_arguments.should_not include(["No Display", "no_display"])
+  end
+
+  
+
+  it "should lookup field definitions by key" do
+    @search_field_obj.search_field_def_for_key("title")[:key].should == "title"
+  end
+
+  it "should find display_label by key" do
+    @search_field_obj.label_for_search_field("title").should == "Title"
+  end
+
+  it "should supply default label for key not found" do
+    @search_field_obj.label_for_search_field("non_existent_key").should == "Keyword"
+  end
+
+  describe "for unspecified :key" do
+    before do
+      @bad_config = MockConfig.new
+      @bad_config.config[:search_fields] = [ 
+        {:display_label => 'All Fields', :qt => "all_fields"},
+        {:key => 'title', :qt => 'title_search'}
+      ]
+    end
+    it "should raise exception on #search_field_list" do
+      lambda {@bad_config.search_field_list}.should raise_error
+    end
+  end
+
+  describe "for duplicate keys" do
+    before do
+      @bad_config = MockConfig.new
+      @bad_config.config[:search_fields] = [ 
+        {:display_label => 'All Fields', :key => "my_key"},
+        {:key => 'title', :key => 'my_key'}
+      ]
+    end
+    it "should raise on #search_field_list" do
+      lambda {@bad_config.search_field_list}.should raise_error
+    end
+  end
+  
+end

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

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require "rake"
+
+describe "blacklight:delete_old_searches" do
+
+  before do
+    @rake = Rake::Application.new      
+    Rake.application = @rake
+    Rake.application.rake_require "../lib/railties/blacklight"
+    Rake::Task.define_task(:environment)
+    @task_name = "blacklight:delete_old_searches"
+  end
+  
+  it "should call Search.delete_old_searches" do
+    days_old = 7
+    Search.should_receive(:delete_old_searches).with(days_old)  
+    @rake[@task_name].invoke(days_old)
+  end
+    
+end

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

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require "rake"
+describe "solr:marc:*" do
+    # saves original $stdout in variable
+    # set $stdout as local instance of StringIO
+    # yields to code execution
+    # returns the local instance of StringIO
+    # resets $stout to original value
+    def capture_stdout
+      out = StringIO.new
+      $stdout = out
+      yield
+      return out.string
+    ensure
+      $stdout = STDOUT
+    end
+    
+    before do
+      @rake = Rake::Application.new      
+      Rake.application = @rake
+      Rake.application.rake_require "../lib/railties/solr_marc"
+      Rake::Task.define_task(:environment)
+    end
+        
+    describe 'solr:marc:index_test_data' do        
+      it 'should print out usage using NOOP=true' do
+        root = Rails.root
+        ENV['NOOP'] = "true"
+        o = capture_stdout do      
+          @rake['solr:marc:index_test_data'].invoke      
+        end
+        
+        o.should match(Regexp.escape("SolrMarc command that will be run:"))
+      end    
+    end
+    
+    describe "solr:marc:index" do
+      it "should produce proper java command" do
+        # can NOT figure out how to actually run solr:marc:index and trap
+        # it's backtick system call. So we'll run solr:marc:index:info and
+        # just test it's dry run output
+        ENV["MARC_FILE"] = "dummy.mrc"
+        output = capture_stdout do
+          @rake['solr:marc:index:info'].invoke
+        end
+        output =~ /SolrMarc command that will be run:\n\s*\n\s*(.*)\n/
+        java_cmd = $1
+        
+        java_cmd.should_not be_nil
+        java_cmd.should match "java -Xmx512m"
+        java_cmd.should match "-jar #{Rails.root}/lib/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"
+      end
+      
+    end  
+  end
+

data/test_support/spec/models/bookmark_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module BookmarkSpecHelper
+  def valid_bookmark_attributes
+    {
+      :id => 1,
+      :user_id => 1,
+      :document_id => 'u001'
+    }
+  end
+end
+
+describe Bookmark do
+  include BookmarkSpecHelper
+  before(:each) do
+    @bookmark = Bookmark.new
+  end
+  
+  it "should be valid" do
+    @bookmark.attributes = valid_bookmark_attributes
+    @bookmark.should be_valid
+  end
+   
+  it "should require user_id" do
+    @bookmark.should have(1).error_on(:user_id)
+  end
+
+  it "should belong to user" do
+    Bookmark.reflect_on_association(:user).should_not be_nil
+  end
+
+  it "should be valid after saving" do
+    @bookmark.attributes = valid_bookmark_attributes
+    @bookmark.save
+    @bookmark.should be_valid
+  end
+end

data/test_support/spec/models/record_mailer_spec.rb

@@ -0,0 +1,67 @@
+# encoding: UTF-8
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe RecordMailer do
+  before(:each) do
+    SolrDocument.use_extension( Blacklight::Solr::Document::Email )
+    SolrDocument.use_extension( Blacklight::Solr::Document::Sms )
+    document = SolrDocument.new({:id=>"123456", :format=>["book"], :title_display => "The horn", :language_facet => "English", :author_display => "Janetzky, Kurt"})
+    @documents = [document]
+  end
+  describe "email" do
+    before(:each) do
+      details = {:to => 'test@test.com', :message => "This is my message"}
+      @email = RecordMailer.email_record(@documents,details,'projectblacklight.org',{:host =>'projectblacklight.org', :protocol => 'https'}) 
+    end
+    it "should receive the TO paramater and send the email to that address" do
+      @email.to.should == ['test@test.com']
+    end
+    it "should start the subject w/ Item Record:" do
+      @email.subject.should =~ /^Item Record:/
+    end
+    it "should put the title of the item in the subject" do
+      @email.subject.should =~ /The horn/
+    end
+    it "should have the correct from address (w/o the port number)" do
+      @email.from.should == ["no-reply@projectblacklight.org"]
+    end
+    it "should print out the correct body" do
+      @email.body.should =~ /Title: The horn/
+      @email.body.should =~ /Author: Janetzky, Kurt/
+      @email.body.should =~ /projectblacklight.org/
+    end
+    it "should use https URLs when protocol is set" do
+      details = {:to => 'test@test.com', :message => "This is my message"}
+      @https_email = RecordMailer.email_record(@documents,details,'projectblacklight.org',{:host =>'projectblacklight.org', :protocol => 'https'})
+      @https_email.body.should =~ %r|https://projectblacklight.org/|
+    end
+  end
+  
+  describe "SMS" do
+    before(:each) do
+      details = {:to => '5555555555', :carrier => 'att'}
+      @sms = RecordMailer.sms_record(@documents,details,'projectblacklight.org',{:host =>'projectblacklight.org:3000'})
+    end
+    it "should create the correct TO address for the SMS email" do
+      @sms.to.should == ['5555555555@txt.att.net']
+    end
+    it "should not have a subject" do
+      @sms.subject.should == "" unless @sms.subject.nil?
+    end
+    it "should have the correct from address (w/o the port number)" do
+      @sms.from.should == ["no-reply@projectblacklight.org"]
+    end
+    it "should print out the correct body" do
+      @sms.body.should =~ /The horn/
+      @sms.body.should =~ /by Janetzky, Kurt/
+      @sms.body.should =~ /projectblacklight.org:300/      
+    end
+    it "should use https URL when protocol is set" do
+      details = {:to => '5555555555', :carrier => 'att'}
+      @https_sms = RecordMailer.sms_record(@documents,details,'projectblacklight.org',{:host =>'projectblacklight.org', :protocol => 'https'})
+      @https_sms.body.should =~ %r|https://projectblacklight.org/|
+    end
+  end
+
+end

data/test_support/spec/models/search_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Search do
+  describe "query_params" do
+    before(:each) do
+      @search = Search.new
+      @query_params = { :q => "query", :f => "facet" }
+    end
+    it "should accept a Hash as the value and save without error" do
+      @search.query_params = @query_params
+      assert @search.save
+    end
+    it "should return a Hash as the value" do
+      @search.query_params = @query_params
+      assert @search.save
+      Search.find(@search.id).query_params.should == @query_params
+    end
+  end
+  
+  describe "saved?" do
+    it "should be true when user_id is not NULL and greater than 0" do
+      @search = Search.create(:user_id => 1)
+      @search.saved?.should be_true
+    end
+    it "should be false when user_id is NULL or less than 1" do
+      @search = Search.create
+      @search.saved?.should_not be_true
+    end
+  end
+  
+  describe "delete_old_searches" do
+    it "should throw an ArgumentError if days_old is not a number" do
+      lambda { Search.delete_old_searches("blah") }.should raise_error(ArgumentError)
+    end
+    it "should throw an ArgumentError if days_old is equal to 0" do
+      lambda { Search.delete_old_searches(0) }.should raise_error(ArgumentError)
+    end
+    it "should throw an ArgumentError if days_old is less than 0" do
+      lambda { Search.delete_old_searches(-1) }.should raise_error(ArgumentError)
+    end
+    it "should destroy searches with no user_id that are older than X days" do
+      Search.destroy_all
+      days_old = 7
+      unsaved_search_today = Search.create(:user_id => nil, :created_at => Date.today)
+      unsaved_search_past = Search.create(:user_id => nil, :created_at => Date.today - (days_old + 1).days)
+      saved_search_today = Search.create(:user_id => 1, :created_at => Date.today)
+      saved_search_past = Search.create(:user_id => 1, :created_at => (Date.today - (days_old + 1).days))
+      lambda do
+        Search.delete_old_searches(days_old)
+      end.should change(Search, :count).by(-1)
+    end
+    
+  end
+  
+end

data/test_support/spec/models/solr_docment_spec.rb

@@ -0,0 +1,111 @@
+# encoding: UTF-8
+
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'rubygems'
+require 'marc'
+
+# WARNING!!!
+# If you set any values in Blacklight here, you must reset them to the original
+# values in an after() block so other tests get expected results. 
+# Blacklight is a Singleton for application configuration.
+
+# NOTE the helper methods below that return hashes and call to_mash.
+# this will NOT be needed if using RSolr::Ext >= version 0.9.6.3
+
+## TODO: ALL these specs probably really ought to be on the modules
+# being tested, not on the bare SolrDocument class that has no logic
+# of it's own, it just includes modules. No? jrochkind 29 Mar 2010
+
+def get_hash_with_marcxml
+  {'responseHeader'=>{'status'=>0,'QTime'=>0,'params'=>{'q'=>'id:00282214','wt'=>'ruby'}},'response'=>{'numFound'=>1,'start'=>0,'docs'=>[{'id'=>'00282214', "marc_display" =>'<record xmlns=\'http://www.loc.gov/MARC21/slim\'><leader>00799cam a2200241 a 4500</leader><controlfield tag=\'001\'>   00282214 </controlfield><controlfield tag=\'003\'>DLC</controlfield><controlfield tag=\'005\'>20090120022042.0</controlfield><controlfield tag=\'008\'>000417s1998    pk            000 0 urdo </controlfield><datafield tag=\'010\' ind1=\' \' ind2=\' \'><subfield code=\'a\'>   00282214 </subfield></datafield><datafield tag=\'025\' ind1=\' \' ind2=\' \'><subfield code=\'a\'>P-U-00282214; 05; 06</subfield></datafield><datafield tag=\'040\' ind1=\' \' ind2=\' \'><subfield code=\'a\'>DLC</subfield><subfield code=\'c\'>DLC</subfield><subfield code=\'d\'>DLC</subfield></datafield><datafield tag=\'041\' ind1=\'1\' ind2=\' \'><subfield code=\'a\'>urd</subfield><subfield code=\'h\'>snd</subfield></datafield><datafield tag=\'042\' ind1=\' \' ind2=\' \'><subfield code=\'a\'>lcode</subfield></datafield><datafield tag=\'050\' ind1=\'0\' ind2=\'0\'><subfield code=\'a\'>PK2788.9.A9</subfield><subfield code=\'b\'>F55 1998</subfield></datafield><datafield tag=\'100\' ind1=\'1\' ind2=\' \'><subfield code=\'a\'>Ayaz, Shaikh,</subfield><subfield code=\'d\'>1923-1997.</subfield></datafield><datafield tag=\'245\' ind1=\'1\' ind2=\'0\'><subfield code=\'a\'>Fikr-i Ayāz /</subfield><subfield code=\'c\'>murattibīn, Āṣif Farruk̲h̲ī, Shāh Muḥammad Pīrzādah.</subfield></datafield><datafield tag=\'260\' ind1=\' \' ind2=\' \'><subfield code=\'a\'>Karācī :</subfield><subfield code=\'b\'>Dāniyāl,</subfield><subfield code=\'c\'>[1998]</subfield></datafield><datafield tag=\'300\' ind1=\' \' ind2=\' \'><subfield code=\'a\'>375 p. ;</subfield><subfield code=\'c\'>23 cm.</subfield></datafield><datafield tag=\'546\' ind1=\' \' ind2=\' \'><subfield code=\'a\'>In Urdu.</subfield></datafield><datafield tag=\'520\' ind1=\' \' ind2=\' \'><subfield code=\'a\'>Selected poems and articles from the works of renowned Sindhi poet; chiefly translated from Sindhi.</subfield></datafield><datafield tag=\'700\' ind1=\'1\' ind2=\' \'><subfield code=\'a\'>Farruk̲h̲ī, Āṣif,</subfield><subfield code=\'d\'>1959-</subfield></datafield><datafield tag=\'700\' ind1=\'1\' ind2=\' \'><subfield code=\'a\'>Pīrzādah, Shāh Muḥammad.</subfield></datafield></record>','timestamp'=>'2009-03-26T18:15:31.074Z','material_type_display'=>['375 p'],'title_display'=>['Fikr-i Ayāz'],'author_display'=>['Farruk̲h̲ī, Āṣif','Pīrzādah, Shāh Muḥammad'],'language_facet'=>['Urdu'],'format'=>['Book'],'published_display'=>['Karācī']}]}}
+end
+def get_hash_without_marcxml
+  {'responseHeader'=>{'status'=>0,'QTime'=>0,'params'=>{'q'=>'id:00282214','wt'=>'ruby'}},'response'=>{'numFound'=>1,'start'=>0,'docs'=>[{'id'=>'00282214','timestamp'=>'2009-03-26T18:15:31.074Z','material_type_display'=>['375 p'],'title_display'=>['Fikr-i Ayāz'],'author_display'=>['Farruk̲h̲ī, Āṣif','Pīrzādah, Shāh Muḥammad'],'language_facet'=>['Urdu'],'format'=>['Book'],'published_display'=>['Karācī']}]}}
+end
+
+def get_hash_with_marc21
+  reader = MARC::Reader.new(File.dirname(__FILE__) + '/../data/test_data.utf8.mrc')
+  # doing weird i= stuff to get only first record.  reader.first, or i = 0, i+1 didn't work and this was the only way I could get it working.  Needs refactoring.
+  i = "1st"
+  for record in reader
+   if i == "1st"
+     first_rec = record.to_marc
+   end
+   i = "not1st"
+  end
+  return {'responseHeader'=>{'status'=>0,'QTime'=>0,'params'=>{'q'=>'id:00282214','wt'=>'ruby'}},'response'=>{'numFound'=>1,'start'=>0,'docs'=>[{'id'=>'00282214', "marc_display" => first_rec, 'timestamp'=>'2009-03-26T18:15:31.074Z','material_type_display'=>['375 p'],'title_display'=>['Fikr-i Ayāz'],'author_display'=>['Farruk̲h̲ī, Āṣif','Pīrzādah, Shāh Muḥammad'],'language_facet'=>['Urdu'],'format'=>['Book'],'published_display'=>['Karācī']}]}}
+end
+  
+  describe SolrDocument do
+    
+    before(:each) do
+      @hash_with_marcxml = get_hash_with_marcxml['response']['docs'][0]
+      SolrDocument.extension_parameters[:marc_source_field]  = :marc_display
+      SolrDocument.extension_parameters[:marc_format_type]   = :marcxml
+
+      # rsolr seems to reload SolrDocument from time to time, so we can't
+      # count on the initializer to register the extension, need to re-register
+      # it.
+      SolrDocument.registered_extensions = nil
+      SolrDocument.use_extension( Blacklight::Solr::Document::Marc ) { |document| document.key?(:marc_display)}
+      
+      @solrdoc = SolrDocument.new(@hash_with_marcxml)
+
+    end
+    
+    describe "new" do
+      it "should take a Hash as the argument" do
+        lambda { SolrDocument.new(@hash_with_marcxml) }.should_not raise_error(ArgumentError)
+      end
+    end
+    
+    describe "access methods" do
+      
+      it "should have the right value for format" do
+        @solrdoc[:format][0].should == 'Book'
+      end
+      
+      it "should provide the item's solr id" do
+        @solrdoc.id.should == '00282214'
+      end
+
+      it "should have access methods for all special function fields named in initializer" do
+        # the fields specified in Blacklight.config[:show] that
+        Blacklight.config[:show].each_key do |function| 
+          @solrdoc[Blacklight.config[:show][function]].should_not be_nil
+        end
+      end
+      
+    end
+    
+    describe "ruby marc creation" do
+ 
+      it "should have a valid to_marc" do
+        @solrdoc = SolrDocument.new(@hash_with_marcxml)
+
+        @solrdoc.should respond_to(:to_marc)
+        @solrdoc.to_marc.should be_kind_of(MARC::Record)        
+      end
+      
+      it "should not try to create marc for objects w/out stored marc (marcxml test only at this time)" do
+        # TODO: Create another mock object that does not have marc-xml in it and make
+        # sure everything fails gracefully
+        @hash_without_marcxml = get_hash_without_marcxml['response']['docs'][0]
+        @solrdoc_without_marc = SolrDocument.new(@hash_without_marcxml)
+        @solrdoc_without_marc.should_not respond_to(:to_marc)
+        # legacy check
+      #        @solrdoc_without_marc.should respond_to(:marc)
+      #        @solrdoc_without_marc.marc.should == nil
+      end
+    end
+    
+    
+    
+
+    
+   
+
+ 
+    
+    
+end