blacklight 3.0pre1 → 3.0pre2

data/test_support/spec/rcov.opts

@@ -0,0 +1,3 @@
+--exclude "spec/*,gems/*,features/*"
+--rails
+--aggregate coverage.data

data/test_support/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/test_support/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+# Has been customized by Blacklight to work when application is in one place,
+# and actual spec/ stuff is in another (the blacklight gem checkout).  
+
+ENV["RAILS_ENV"] ||= 'test'
+
+#require File.expand_path("../../config/environment", __FILE__)
+# version that works with our blacklight:spec stuff that calls specs
+# in a remote directory. 
+require File.expand_path("config/environment", ENV['RAILS_ROOT'] || File.expand_path("../..", __FILE__))
+require 'rspec/rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+# Blacklight, again, make sure we're looking in the right place for em. 
+# Relative to HERE, NOT to Rails.root, which is off somewhere else. 
+#Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+Dir[Pathname.new(File.expand_path("../support/**/*.rb", __FILE__))].each {|f| require f}
+
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+end

data/test_support/spec/support/action_controller.rb

@@ -0,0 +1,42 @@
+# 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
+

data/test_support/spec/support/assert_difference.rb

@@ -0,0 +1,16 @@
+# Added based on http://www.arctickiwi.com/blog/upgrading-to-rspec-2-with-ruby-on-rails-3
+# God bless you Jonathon Horsman 
+def assert_difference(executable, how_many = 1, &block)
+  before = eval(executable)
+  yield
+  after = eval(executable)
+  after.should == before + how_many
+end
+
+def assert_no_difference(executable, &block)
+  before = eval(executable)
+  yield
+  after = eval(executable)
+  after.should == before
+end
+

data/test_support/spec/support/include_text.rb

@@ -0,0 +1,20 @@
+# Added from http://www.arctickiwi.com/blog/upgrading-to-rspec-2-with-ruby-on-rails-3
+module RSpec::Rails
+  module Matchers
+    RSpec::Matchers.define :include_text do |text|
+      match do |response_or_text|
+        @content = response_or_text.respond_to?(:body) ? response_or_text.body : response_or_text
+        @content.include?(text)
+      end
+
+      failure_message_for_should do |text|
+        "expected '#{@content}' to contain '#{text}'"
+      end
+
+      failure_message_for_should_not do |text|
+        "expected #{@content} to not contain '#{text}'"
+      end
+    end
+  end
+end
+

data/test_support/spec/views/catalog/_constraints_element.html.erb_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "catalog/_constraints_element.html.erb" do
+  describe "for simple display" do
+    before do
+      render :partial => "catalog/constraints_element", :locals => {:label => "my label", :value => "my value"}
+    end
+    it "should render label and value" do
+      rendered.should have_selector("span.appliedFilter.constraint") do |s|
+        s.should have_selector "span.filterName", :content => "my label"
+        s.should have_selector "span.filterValue", :content => "my value" 
+      end
+    end
+  end
+
+  describe "with remove link" do
+    before do
+      render :partial => "catalog/constraints_element", :locals => {:label => "my label", :value => "my value", :options => {:remove => "http://remove"}}
+    end
+    it "should include remove link" do
+      rendered.should have_selector("span.appliedFilter") do |s|
+        s.should have_selector("a.btnRemove.imgReplace[href='http://remove']")
+      end    
+    end
+  end
+
+  describe "with checkmark suppressed" do
+    before do
+      render :partial => "catalog/constraints_element", :locals => {:label => "my label", :value => "my value", :options => {:check => false}}
+    end
+    it "should not include checkmark" do
+      rendered.should have_selector("span.appliedFilter") do |s|
+        s.should_not have_selector("img[src$='checkmark.gif']")
+      end   
+    end
+  end
+
+  describe "with custom classes" do
+    before do
+      render :partial => "catalog/constraints_element", :locals => {:label => "my label", :value => "my value", :options => {:classes => ["class1", "class2"]}}
+    end
+    it "should include them" do
+      rendered.should have_selector("span.appliedFilter.constraint.class1.class2")
+    end
+  end
+
+  describe "with no escaping" do
+    before do
+      render( :partial => "catalog/constraints_element", :locals => {:label => "<span class='custom_label'>my label</span>", :value => "<span class='custom_value'>my value</span>", :options => {:escape_label => false, :escape_value => false}} )
+    end
+    it "should not escape key and value" do
+      rendered.should have_selector("span.appliedFilter.constraint span.filterName span.custom_label")
+      rendered.should have_selector("span.appliedFilter.constraint span.filterValue span.custom_value")
+    end
+
+  end
+ 
+
+end

data/test_support/spec/views/catalog/_document_list.html.erb_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "/catalog/_document_list.html.erb" do  
+  
+
+
+
+end

data/test_support/spec/views/catalog/_facets.html.erb_spec.rb

@@ -0,0 +1,182 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "/catalog/_facets.html.erb" do
+  
+  before(:each) do
+
+    # create mock facets to be retrieved from the response
+    @solr_item00 = stub("solr_item00")
+    @solr_item00.stub!(:value).and_return("val_0_0")
+    @solr_item00.stub!(:hits).and_return("90")
+    @solr_item01 = stub("solr_item01")
+    @solr_item01.stub!(:value).and_return("val_0_1")
+    @solr_item01.stub!(:hits).and_return("91")
+    @facet0 = stub("facet0")
+    @solr_fname0 = Blacklight.config[:facet][:field_names].last
+    @facet0.stub!(:name).and_return(@solr_fname0);
+    @solr_items0 = [@solr_item00, @solr_item01]
+    @facet0.stub!(:items).and_return(@solr_items0);
+
+    @solr_item10 = stub("solr_item10")
+    @solr_item10.stub!(:value).and_return("val_1_0")
+    @solr_item10.stub!(:hits).and_return("10")
+    @solr_item11 = stub("solr_item11")
+    @solr_item11.stub!(:value).and_return("val_1_1")
+    @solr_item11.stub!(:hits).and_return("11")
+    @facet1 = stub("facet1")
+    @solr_fname1 = Blacklight.config[:facet][:field_names][1]
+    @facet1.stub!(:name).and_return(@solr_fname1);
+    @solr_items1 = [@solr_item10, @solr_item11]
+    @facet1.stub!(:items).and_return(@solr_items1);
+
+    @solr_item20 = stub("solr_item20")
+    @solr_item20.stub!(:value).and_return("val_2_0")
+    @solr_item20.stub!(:hits).and_return("20")
+    @solr_item21 = stub("solr_item21")
+    @solr_item21.stub!(:value).and_return("val_2_1")
+    @solr_item21.stub!(:hits).and_return("21")
+    @facet2 = stub("facet2")
+    @solr_fname2 = Blacklight.config[:facet][:field_names][0]
+    @facet2.stub!(:name).and_return(@solr_fname2);
+    @solr_items2 = [@solr_item20, @solr_item21]
+    @facet2.stub!(:items).and_return(@solr_items2);
+
+    @solr_item30 = stub("solr_item30")
+    @solr_item30.stub!(:value).and_return("val_3_0")
+    @solr_item30.stub!(:hits).and_return("30")
+    @solr_item31 = stub("solr_item31")
+    @solr_item31.stub!(:value).and_return("val_3_1")
+    @solr_item31.stub!(:hits).and_return("31")
+    @facet3 = stub("facet3")
+    @solr_fname3 = "solr_field_not_in_initializer_facet"
+    @facet3.stub!(:name).and_return(@solr_fname3);
+    @solr_items3 = [@solr_item30, @solr_item31]
+    @facet3.stub!(:items).and_return(@solr_items3);
+
+    @facets = [@facet0, @facet1, @facet2, @facet3]
+    @response.stub!(:facets).and_return(@facets) 
+
+    # one facet is selected
+    selected_facet = {@solr_fname1 => [@solr_item10.value]}
+    params[:f] = selected_facet
+
+    assigns[:response] = @response    
+
+    render :partial => 'catalog/facets'
+  end
+    
+# There is a problem with link_to and rspec-rails.  See:
+#  http://www.nabble.com/Rails:-View-specs-and-implicit-parameters-in-link_to()-td20011051.html
+# This spec will run cleanly if the implicit routes are added to the plugin
+#  level routes.rb file:   (at the bottom of the file)
+#
+#  map.connect ':controller/:action/:id'
+#  map.connect ':controller/:action/:id.:format'
+
+# If someone can find a better workaround, that would be mega-spiffy.
+#
+# For now, I am commenting out this spec because I'm not sure if adding those
+#  routes will affect anything else.  Similar comments are in routes.rb 
+#   - Naomi  2009-04-19
+
+=begin
+    
+  it "should have div tag with id=facets" do
+    response.should have_selector('div[id=facets]')
+  end
+  
+  it "should not have facets that aren't specified in initializer" do
+    response.should_not include_text(@solr_fname3)
+  end
+
+  it "should skip over facets specified in the initializer that aren't in the response" do
+    solr_field = Blacklight.config[:facet][:field_names][2]
+    label = Blacklight.config[:facet][:labels][solr_field]
+    response.should_not include_text(label)
+  end
+
+  it "should have all facets specified in initializer that are included in solr response" do
+    solr_field1 = Blacklight.config[:facet][:field_names].last
+    response.should include_text(solr_field1)
+    
+    solr_field2 = Blacklight.config[:facet][:field_names][1]
+    response.should include_text(solr_field2)
+
+    solr_field3 = Blacklight.config[:facet][:field_names][0]
+    response.should include_text(solr_field3)
+  end 
+
+  it "should use the labels specified in initializer" do
+    label1 = Blacklight.config[:facet][:labels][@solr_fname0]
+    response.should include_text(label1)
+    
+    label2 = Blacklight.config[:facet][:labels][@solr_fname1]
+    response.should include_text(label2)
+
+    label3 = Blacklight.config[:facet][:labels][@solr_fname2]
+    response.should include_text(label3)
+  end
+  
+# TODO:  check the display order of the facets.  Naomi can't figure this out
+#  it "should display the facets in the order specified in the initializer" do
+#    pending
+#  end
+#
+#    output is:
+#    <div id="facets">
+#      <div>
+#        <h3>Format</h3>
+#        <ul>
+#          <li>Book</li>
+#          <li>Online</li>
+#        </ul>
+#      </div>
+#      <div>
+#        <h3>Language</h3>
+#        <ul>
+#          <li>English</li>
+#          <li>Urdu/li>
+#        </ul>
+#      </div>
+#    </div>
+#
+#   can't test for ordering of h3 contents:
+#     they are not immediate children of  <div id="facets">
+#
+#   perhaps use Cucumber?
+
+  
+  it "should have values for displayed facets" do
+    response.should have_selector("li") do
+      with_tag("a", @solr_item00.value)
+      with_tag("a", @solr_item01.value)
+#      with_tag("a", @solr_item10.value)  # this facet is selected
+      with_tag("a", @solr_item11.value)
+      with_tag("a", @solr_item20.value)
+      with_tag("a", @solr_item21.value)
+    end
+  end
+
+  it "should have numbers of hits for displayed facets" do
+    response.should include_text(@solr_item00.hits)
+    response.should include_text(@solr_item01.hits)
+    response.should include_text(@solr_item10.hits)
+    response.should include_text(@solr_item11.hits)
+    response.should include_text(@solr_item20.hits)
+    response.should include_text(@solr_item21.hits)
+  end
+  
+  it "should have links to include facet values in solr query" do
+    response.should have_selector("a", :text => @solr_item00.value)
+    response.should include_text("f%5B"+@solr_fname0 + "%5D%5B%5D=" + @solr_item00.value)
+    response.should have_selector("a", :text => @solr_item11.value)
+    response.should include_text("f%5B"+@solr_fname1 + "%5D%5B%5D=" + @solr_item11.value)
+  end
+
+  it "should display selected facets properly" do
+      response.should have_selector("span[class=selected]", :text => /#{@solr_item10.value}/)
+  end
+  
+=end
+  
+end

data/test_support/spec/views/catalog/_index_partials/_default.erb_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+# spec for default partial to display solr document fields 
+#  in catalog INDEX view
+
+describe "/catalog/_index_partials/_default.erb" do
+  
+  include BlacklightHelper
+  include CatalogHelper
+  
+  before(:each) do
+    @fname_1 = Blacklight.config[:index_fields][:field_names].last
+    @fname_2 = "solr_field_not_in_initializer"
+    @fname_3 = Blacklight.config[:index_fields][:field_names][1]
+    @fname_4 = Blacklight.config[:index_fields][:field_names][0]
+    
+    @document = mock("solr_doc")
+    @document.should_receive(:get).with(@fname_1, hash_including(:sep => nil)).any_number_of_times.and_return("val_1")
+    @document.should_receive(:get).with(@fname_2, hash_including(:sep => nil)).any_number_of_times.and_return("val_2")
+    @document.should_receive(:get).with(@fname_3, hash_including(:sep => nil)).any_number_of_times.and_return(nil)
+    @document.should_receive(:get).with(@fname_4, hash_including(:sep => nil)).any_number_of_times.and_return("val_4")
+    
+    @document.should_receive(:'has?').with(@fname_1).any_number_of_times.and_return(true)
+    @document.should_receive(:'has?').with(@fname_2).any_number_of_times.and_return(true)
+    @document.should_receive(:'has?').with(@fname_3).any_number_of_times.and_return(false)
+    @document.should_receive(:'has?').with(@fname_4).any_number_of_times.and_return(true)
+    @document.should_receive(:'has?').with(anything()).any_number_of_times.and_return(true)
+    
+    # cover any remaining fields in initalizer
+    @document.should_receive(:get).with(anything(), hash_including(:sep => nil)).any_number_of_times.and_return("bleah")
+    @document.should_receive(:[]).any_number_of_times
+    
+    @flabel_1 = Blacklight.config[:index_fields][:labels][@fname_1]
+    @flabel_3 = Blacklight.config[:index_fields][:labels][@fname_3]
+    @flabel_4 = Blacklight.config[:index_fields][:labels][@fname_4]
+
+    assigns[:document] = @document
+    render_document_partial @document, :index
+  end
+
+  it "should only display fields listed in the initializer" do
+    rendered.should_not include_text("val_2")
+    rendered.should_not include_text(@fname_2)
+  end
+  
+  it "should skip over fields listed in initializer that are not in solr response" do
+    rendered.should_not include_text(@fname_3)
+  end
+
+  it "should display field labels from initializer and raw solr field names in the class" do
+    # labels
+    rendered.should include_text(@flabel_1)
+    rendered.should include_text(@flabel_4)
+    # classes    
+    rendered.should include_text("blacklight-#{@fname_1}")
+    rendered.should include_text("blacklight-#{@fname_4}")
+  end
+  
+# this test probably belongs in a Cucumber feature
+#  it "should display fields in the order listed in the initializer" do
+#    pending
+#  end
+
+  it "should have values for displayed fields" do
+    rendered.should include_text("val_1")
+    rendered.should include_text("val_4")
+    rendered.should_not include_text("val_2")
+  end
+
+end