blacklight 3.0pre1 → 3.0pre2

data/test_support/spec/lib/blacklight_email_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Blacklight::Solr::Document::Email" do
+  before(:all) do
+    SolrDocument.use_extension( Blacklight::Solr::Document::Email )
+  end
+  it "should only return values that are available in the field semantics" do
+    doc = SolrDocument.new({:id=>"1234", :title_display=>"My Title"})
+    email_body = doc.to_email_text
+    email_body.should match(/Title: My Title/)
+    email_body.should_not match(/Author/)
+  end
+  it "should handle multi-values fields correctly" do
+    doc = SolrDocument.new({:id=>"1234", :title_display=>["My Title", "My Alt. Title"]})
+    email_body = doc.to_email_text
+    email_body.should match(/Title: My Title My Alt. Title/)
+  end
+  it "should return nil if there are no valid field semantics to build the email body from" do
+    doc = SolrDocument.new({:id=>"1234"})
+    doc.to_email_text.should be_nil
+  end
+end
+

data/test_support/spec/lib/blacklight_sms_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Blacklight::Solr::Document::Email" do
+  before(:all) do
+    SolrDocument.use_extension( Blacklight::Solr::Document::Sms )
+  end
+  it "should only return values that are available in the field semantics" do
+    doc = SolrDocument.new({:id=>"1234", :title_display=>"My Title", :author_display=>"Joe Schmoe"})
+    sms_text = doc.to_sms_text
+    sms_text.should match(/My Title by Joe Schmoe/)
+  end
+  it "should handle multi-values fields correctly and only take the first" do
+    doc = SolrDocument.new({:id=>"1234", :title_display=>["My Title", "My Alt. Title"]})
+    sms_text = doc.to_sms_text
+    sms_text.should match(/My Title/)
+    sms_text.should_not match(/My Alt\. Title/)
+  end
+  it "should return nil if there are no valid field semantics to build the email body from" do
+    doc = SolrDocument.new({:id=>"1234"})
+    doc.to_sms_text.should be_nil
+  end
+end
+

data/test_support/spec/lib/blacklight_solr_document_dublin_core_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Blacklight::Solr::Document::DublinCore" do
+  before(:all) do
+    @mock_class = Class.new do
+      include Blacklight::Solr::Document
+    end
+    @mock_class.use_extension( Blacklight::Solr::Document::DublinCore )
+    @mock_class.field_semantics.merge!(
+      :title => :title_display,
+      :non_dc_title => :title_display
+    )
+  end
+
+
+  it "should register all its export formats" do
+    document = @mock_class.new
+    Set.new(document.export_formats.keys).should  be_superset(Set.new([:oai_dc_xml,:dc_xml, :xml]))    
+  end
+
+  it "should export oai_dc with the proper namespaces" do
+    document = @mock_class.new
+    document.export_as_oai_dc_xml.should match 'xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/"'
+
+  end
+
+  it "should include 'dc:'-prefixed semantic fields" do
+      data = {'id'=>'123456','title_display'=>['654321'] }
+      document = @mock_class.new(data)
+      document.export_as_oai_dc_xml.should match  'xmlns:dc="http://purl.org/dc/elements/1.1/"'
+      document.export_as_oai_dc_xml.should match  '<dc:title>654321</dc:title>'
+  end
+
+  it "should work with multi-value fields" do
+      data = {'id'=>'123456','title_display'=>['654321', '987'] }
+      document = @mock_class.new(data)
+      document.export_as_oai_dc_xml.should match '<dc:title>654321</dc:title>'
+      document.export_as_oai_dc_xml.should match '<dc:title>987</dc:title></oai_dc:dc>'
+  end
+end
+

data/test_support/spec/lib/blacklight_solr_document_marc_spec.rb

@@ -0,0 +1,88 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+
+describe "Blacklight::Solr::Document::Marc" do
+  before(:all) do
+    @mock_class = Class.new do
+      include Blacklight::Solr::Document
+    end
+    @mock_class.use_extension( Blacklight::Solr::Document::Marc )
+    @mock_class.extension_parameters[:marc_source_field] = :marc      
+  end
+
+  describe "marc binary mode" do
+    before(:each) do
+      @mock_class.extension_parameters[:marc_format_type] = :marc21      
+    end
+    it "should read and parse a marc binary file" do
+      document = @mock_class.new(:marc => sample_marc_binary )
+      document.to_marc.should == marc_from_string(:binary => sample_marc_binary )
+    end
+  end
+
+  describe "marcxml mode" do
+    before(:each) do
+      @mock_class.extension_parameters[:marc_format_type] = :marcxml
+    end
+    it "should read and parse a marc xml file" do
+      document = @mock_class.new(:marc => sample_marc_xml)
+      document.to_marc.should == marc_from_string(:xml => sample_marc_xml)
+    end
+  end
+
+  it "should register all its export formats" do
+    document = @mock_class.new
+    Set.new(document.export_formats.keys).should  be_superset(Set.new([:marc, :marcxml, :openurl_ctx_kev, :refworks_marc_txt, :endnote, :xml]))    
+  end
+
+
+
+    def sample_marc_xml
+    "<record>
+      <leader>01182pam a22003014a 4500</leader>
+      <controlfield tag=\"001\">a4802615</controlfield>
+      <controlfield tag=\"003\">SIRSI</controlfield>
+      <controlfield tag=\"008\">020828s2003    enkaf    b    001 0 eng  </controlfield>
+    
+      <datafield tag=\"245\" ind1=\"0\" ind2=\"0\">
+        <subfield code=\"a\">Apples :</subfield>
+        <subfield code=\"b\">botany, production, and uses /</subfield>
+        <subfield code=\"c\">edited by D.C. Ferree and I.J. Warrington.</subfield>
+      </datafield>
+    
+      <datafield tag=\"260\" ind1=\" \" ind2=\" \">
+        <subfield code=\"a\">Oxon, U.K. ;</subfield>
+        <subfield code=\"a\">Cambridge, MA :</subfield>
+        <subfield code=\"b\">CABI Pub.,</subfield>
+        <subfield code=\"c\">c2003.</subfield>
+      </datafield>
+    
+      <datafield tag=\"700\" ind1=\"1\" ind2=\" \">
+        <subfield code=\"a\">Ferree, David C.</subfield>
+        <subfield code=\"q\">(David Curtis),</subfield>
+        <subfield code=\"d\">1943-</subfield>
+      </datafield>
+    
+      <datafield tag=\"700\" ind1=\"1\" ind2=\" \">
+        <subfield code=\"a\">Warrington, I. J.</subfield>
+        <subfield code=\"q\">(Ian J.)</subfield>
+      </datafield>
+    </record>"
+  end
+
+
+  def sample_marc_binary
+    "00386pam a22001094a 4500001000900000003000600009008004100015245008900056260005400145700004500199700003200244\036a4802615\036SIRSI\036020828s2003    enkaf    b    001 0 eng  \03600\037aApples :\037bbotany, production, and uses /\037cedited by D.C. Ferree and I.J. Warrington.\036  \037aOxon, U.K. ;\037aCambridge, MA :\037bCABI Pub.,\037cc2003.\0361 \037aFerree, David C.\037q(David Curtis),\037d1943-\0361 \037aWarrington, I. J.\037q(Ian J.)\036\035"
+  end
+  def marc_from_string(args = {})
+    if args[:binary]
+      reader = MARC::Reader.new(StringIO.new(args[:binary]))
+      reader.each {|rec| return rec }
+    elsif args[:xml]
+      reader = MARC::XMLReader.new(StringIO.new(args[:xml]))
+      reader.each {|rec| return rec }
+    end
+    return nil
+  end
+end
+

data/test_support/spec/lib/blacklight_solr_document_spec.rb

@@ -0,0 +1,173 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'rubygems'
+
+describe "Blacklight::Solr::Document" do
+    class MockDocument
+      include Blacklight::Solr::Document
+    end
+
+    module MockExtension
+      def my_extension_method
+        "my_extension_results"
+      end
+    end
+
+    module MockSecondExtension
+      def my_extension_method
+        "override"
+      end
+    end
+   
+
+    context "Extendability" do
+      before(:each) do
+        #Clear extensions
+        MockDocument.registered_extensions = []
+      end
+    
+      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
+        MockDocument.use_extension(MockExtension) { |doc| true }
+        MockDocument.registered_extensions.find {|a| a[:module_obj] == MockExtension}.should_not be_nil
+      end
+      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"
+      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"
+
+        without_extension = MockDocument.new(:other_key => "value")
+        without_extension.methods.find {|name| name == "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      
+      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.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"        
+      end
+
+      describe "extension_parameters class-level hash" do
+        it "should provide an extension_parameters hash at the class level" do
+          MockDocument.extension_parameters[:key] = "value"
+          MockDocument.extension_parameters[:key].should == "value"
+        end
+    
+        it "extension_parameters should not be shared between classes" do
+          class_one = Class.new do
+            include Blacklight::Solr::Document
+          end
+          class_two = Class.new do
+            include Blacklight::Solr::Document
+          end
+
+          class_one.extension_parameters[:key] = "class_one_value"
+          class_two.extension_parameters[:key] = "class_two_value"
+
+          class_one.extension_parameters[:key].should == "class_one_value"
+        end
+      end
+      
+    end
+
+    context "Will export as" do
+      class MockDocument
+        include Blacklight::Solr::Document
+
+        def export_as_marc
+          "fake_marc"
+        end
+      end
+
+      it "reports it's exportable formats properly" do
+        doc = MockDocument.new
+        doc.will_export_as(:marc, "application/marc" )
+        doc.export_formats.should have_key(:marc)
+        doc.export_formats[:marc][:content_type].should ==  "application/marc"
+      end
+
+      it "looks up content-type from Mime::Type if not given in arg" do
+        doc = MockDocument.new
+        doc.will_export_as(:html)
+        doc.export_formats.should have_key(:html)        
+      end
+
+      context "format not registered with Mime::Type" do
+        before(:all) do
+          @doc = MockDocument.new
+          @doc.will_export_as(:mock2, "application/mock2" )
+          # Mime::Type doesn't give us a good way to clean up our new
+          # registration in an after, sorry. 
+        end
+        it "registers format" do
+          defined?("Mime::MOCK2").should be_true
+        end
+        it "registers as alias only" do
+          Mime::Type.lookup("application/mock2").should_not equal(Mime::Type.lookup_by_extension("mock2"))
+        end
+      end
+
+      it "export_as(:format) by calling export_as_format" do
+        doc = MockDocument.new
+        doc.will_export_as(:marc, "application/marc")
+        doc.export_as(:marc).should == "fake_marc"
+      end
+    end
+
+    context "to_semantic_fields" do
+      class MockDocument
+          include Blacklight::Solr::Document                        
+      end
+      before do
+        MockDocument.field_semantics.merge!( :title => "title_field", :author => "author_field", :something => "something_field" )
+        
+        @doc1 = MockDocument.new( 
+           "title_field" => "doc1 title",
+           "something_field" => ["val1", "val2"],
+           "not_in_list_field" => "weird stuff" 
+         )
+      end
+
+      it "should return complete dictionary based on config'd fields" do        
+        @doc1.to_semantic_values.should == {:title => ["doc1 title"], :something => ["val1", "val2"]}
+      end      
+      it "should return empty array for a key without a value" do
+        @doc1.to_semantic_values[:author].should == []
+        @doc1.to_semantic_values[:nonexistent_token].should == []
+      end
+      it "should return an array even for a single-value field" do
+        @doc1.to_semantic_values[:title].should be_kind_of(Array)
+      end
+      it "should return complete array for a multi-value field" do
+        @doc1.to_semantic_values[:something].should == ["val1", "val2"] 
+      end
+      
+    end
+
+    
+end

data/test_support/spec/lib/blacklight_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Blacklight do
+  
+  context "locate_path" do
+    
+    it "should find app/controllers/application_controller.rb" do
+      result = Blacklight.locate_path 'app', 'controllers', 'application_controller.rb'
+      result.should_not == nil
+    end
+    
+    it "should not find blah.rb" do
+      result = Blacklight.locate_path 'blah.rb'
+      result.should == nil
+    end
+    
+  end
+  
+  context 'root' do
+
+    before(:all) do
+      @blroot = File.expand_path(File.join(__FILE__, '..', '..', '..', '..'))
+    end
+
+    it 'should return the full path to the BL plugin' do
+      Blacklight.root.should == @blroot
+    end
+    
+    it 'should return the full path to the model directory' do
+      Blacklight.models_dir.should == @blroot + "/app/models"
+    end
+
+    it 'should return the full path to the controllers directory' do
+      Blacklight.controllers_dir.should == @blroot + "/app/controllers"
+    end
+
+  end
+  
+end

data/test_support/spec/lib/configurable_spec.rb

@@ -0,0 +1,97 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Blacklight::Configurable do
+  
+  class TestConfig
+    extend Blacklight::Configurable
+  end
+  
+  before(:each) do
+    TestConfig.reset_configs!
+  end
+  
+  it "should respond to configure" do
+    TestConfig.respond_to? :configure
+  end
+  
+  describe "the default state" do
+    describe "config" do
+      it "should be a Hash" do
+          TestConfig.config.should be_a Hash      
+      end
+    end
+    describe "configs[:shared]" do
+      it "should be a Hash" do
+        TestConfig.configs[:shared].should be_a Hash
+      end
+    end
+  end
+  
+  describe "configs[:shared]" do
+    it "should not have the values of its members altered by other environments" do
+      TestConfig.configure do |config|
+        config[:key] = ":shared value"
+      end
+      TestConfig.configure(::Rails.env) do |config|
+        config[:key] = ":test value"
+      end
+      TestConfig.config[:key].should == ":test value"
+      TestConfig.configs[:shared][:key].should == ":shared value"
+      TestConfig.configs[::Rails.env][:key].should == ":test value"
+    end
+  end
+  
+  describe "the #configure method behavior" do
+    it "requires a block" do
+      lambda{TestConfig.configure}.should raise_error(LocalJumpError)
+    end
+    it "yields a hash" do
+      TestConfig.configure{|config| config.should be_a(Hash) }
+    end
+    it "should clear the configs if reset_configs! is called" do
+      TestConfig.configure do |config|
+        config[:asdf] = 'asdf'
+      end
+      TestConfig.configs[:shared][:asdf].should == 'asdf'
+      TestConfig.reset_configs!
+      TestConfig.configs[:shared][:asdf].should == nil
+    end
+    
+    it "should merge settings from the :shared environment" do
+      TestConfig.configure do |config|
+        config[:app_id] = 'Blacklight'
+        config[:mode] = :shared!
+      end
+      TestConfig.configure(::Rails.env) do |config|
+        config[:mode] = ::Rails.env
+      end
+      TestConfig.config[:app_id].should == 'Blacklight'
+      TestConfig.config[:mode].should_not == :shared!
+      TestConfig.config[:mode].should == ::Rails.env
+    end
+  end
+  
+  describe "config" do
+    it "should return an empty Hash if nothing was configured" do
+      TestConfig.config.should == {}
+    end
+    
+    it "should return only what is in configs[:shared] if no other environment was configured" do
+      TestConfig.configure(:shared) do |config|
+        config[:foo] = 'bar'
+        config[:baz] = 'dang'
+      end
+      TestConfig.config.should == {:foo => 'bar', :baz => 'dang'}
+      TestConfig.config.should == TestConfig.configs[:shared]
+    end
+    
+    it "should return a merge of configs[:shared] and configs[RAILS_ENV]" do
+      TestConfig.configure(:shared) do |config|
+        config[:foo] = 'bar'
+        config[:baz] = 'dang'
+      end
+    end
+  end
+  
+  
+end