blacklight 4.0.0.pre7 → 4.0.0.rc1

data/lib/generators/blacklight/blacklight_generator.rb

@@ -141,7 +141,8 @@ EOF
       "  # Adds a few additional behaviors into the application controller \n " +        
         "  include Blacklight::Controller\n" + 
         "  # Please be sure to impelement current_user and user_session. Blacklight depends on \n" +
-        "  # these methods in order to perform user specific actions. \n\n"
+        "  # these methods in order to perform user specific actions. \n\n" +
+        "  layout 'blacklight'\n\n"
     end
   end
   

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

@@ -59,6 +59,7 @@ class CatalogController < ApplicationController
     config.add_facet_field 'subject_geo_facet', :label => 'Region' 
     config.add_facet_field 'subject_era_facet', :label => 'Era'  
 
+    config.add_facet_field 'example_pivot_field', :label => 'Pivot Field', :pivot => ['format', 'language_facet']
 
     config.add_facet_field 'example_query_facet_field', :label => 'Publish Date', :query => {
        :years_5 => { :label => 'within 5 Years', :fq => "pub_date:[#{Time.now.year - 5 } TO *]" },

data/test_support/spec/helpers/blacklight_helper_spec.rb

@@ -216,9 +216,22 @@ describe BlacklightHelper do
      it "should consist of #document_heading wrapped in a <h1>" do
       @document = SolrDocument.new('title_display' => "A Fake Document")
 
-      render_document_heading.should have_selector("h4", :text => document_heading, :count => 1)
+      render_document_heading.should have_selector("h4", :text => "A Fake Document", :count => 1)
       render_document_heading.html_safe?.should == true
      end
+     it "should join the values if it is an array" do
+      @document = SolrDocument.new('title_display' => ["A Fake Document", 'Something Else'])
+
+      render_document_heading.should have_selector("h4", :text => "A Fake Document, Something Else", :count => 1)
+      render_document_heading.html_safe?.should == true
+     end
+   end
+
+   describe "document_show_html_title" do
+     it "should join the values if it is an array" do
+      @document = SolrDocument.new('title_display' => ["A Fake Document", 'Something Else'])
+      document_show_html_title.should == "A Fake Document, Something Else"
+     end
    end
 
    describe "document_index_view_type" do
@@ -227,8 +240,12 @@ describe BlacklightHelper do
      end
 
      it "should pluck values out of params" do
+       blacklight_config.stub(:document_index_view_types) { ['list', 'asdf'] }
        params[:view] = 'asdf'
        document_index_view_type.should == 'asdf'
+
+       params[:view] = 'not_in_list'
+       document_index_view_type.should == 'list'
      end
    end
 

data/test_support/spec/helpers/facets_helper_spec.rb

@@ -107,6 +107,32 @@ describe FacetsHelper do
         facet_item.label.should == 'A Human Readable label'
       end
     end
+
+    describe "pivot facets" do
+      let(:facet_config) {
+        mock(:pivot => ['field_a', 'field_b'])
+      }
+
+      before(:each) do 
+        helper.should_receive(:facet_configuration_for_field).with(anything()).and_return(facet_config)
+      
+        @response = mock(:facet_pivot => { 'field_a,field_b' => [{:field => 'field_a', :value => 'a', :count => 10, :pivot => [{:field => 'field_b', :value => 'b', :count => 2}]}]})
+      end
+
+      it "should convert the pivot facet into a mock RSolr FacetField" do
+        field = helper.facet_by_field_name('my_pivot_facet_field')
+        field.should be_a_kind_of Blacklight::SolrResponse::Facets::FacetField
+
+        field.name.should == 'my_pivot_facet_field'
+
+        field.items.length.should == 1
+
+        field.items.first.should respond_to(:items)
+
+        field.items.first.items.length.should == 1
+        field.items.first.items.first.fq.should == { 'field_a' => 'a' }
+      end
+    end
   end
 
 
@@ -143,6 +169,8 @@ describe FacetsHelper do
 
       @config = Blacklight::Configuration.new do |config|
         config.add_facet_field 'basic_field'
+        config.add_facet_field 'pivot_facet_field', :pivot => ['a', 'b']
+        config.add_facet_field 'my_pivot_facet_field_with_custom_partial', :partial => 'custom_facet_partial', :pivot => ['a', 'b']
         config.add_facet_field 'my_facet_field_with_custom_partial', :partial => 'custom_facet_partial'
       end
 
@@ -191,6 +219,18 @@ describe FacetsHelper do
       helper.should_receive(:render).with(hash_including(:layout => nil))
       helper.render_facet_limit(@mock_facet, :layout => nil)
     end
+
+    it "should render the facet_pivot partial for pivot facets" do
+      @mock_facet = mock(:name => 'pivot_facet_field', :items => [1,2,3])
+      helper.should_receive(:render).with(hash_including(:partial => 'facet_pivot'))
+      helper.render_facet_limit(@mock_facet)
+    end 
+
+    it "should let you override the rendered partial for pivot facets" do
+      @mock_facet = mock(:name => 'my_pivot_facet_field_with_custom_partial', :items => [1,2,3])
+      helper.should_receive(:render).with(hash_including(:partial => 'custom_facet_partial'))
+      helper.render_facet_limit(@mock_facet)
+    end 
   end
 
   describe "add_facet_params" do
@@ -249,6 +289,29 @@ describe FacetsHelper do
       result_params[:f]['single_value_facet_field'].length.should == 1
       result_params[:f]['single_value_facet_field'].first.should == 'my_value'
     end
+
+    it "should accept a FacetItem instead of a plain facet value" do
+          
+      result_params = helper.add_facet_params('facet_field_1', mock(:value => 123))
+
+      result_params[:f]['facet_field_1'].should include(123)
+    end
+
+    it "should defer to the field set on a FacetItem" do
+          
+      result_params = helper.add_facet_params('facet_field_1', mock(:field => 'facet_field_2', :value => 123))
+
+      result_params[:f]['facet_field_1'].should be_blank
+      result_params[:f]['facet_field_2'].should include(123)
+    end
+
+    it "should add any extra fq parameters from the FacetItem" do
+          
+      result_params = helper.add_facet_params('facet_field_1', mock(:value => 123, :fq => {'facet_field_2' => 'abc'}))
+
+      result_params[:f]['facet_field_1'].should include(123)
+      result_params[:f]['facet_field_2'].should include('abc')
+    end
   end
 
   describe "add_facet_params_and_redirect" do

data/test_support/spec/lib/blacklight_solr_response_spec.rb

@@ -60,6 +60,41 @@ describe Blacklight::SolrResponse do
 
   end
 
+  describe "FacetItem" do
+    it "should work with a field,value tuple" do
+      item = Blacklight::SolrResponse::Facets::FacetItem.new('value', 15)
+      item.value.should == 'value'
+      item.hits.should == 15
+    end
+
+    it "should work with a field,value + hash triple" do
+      item = Blacklight::SolrResponse::Facets::FacetItem.new('value', 15, :a => 1, :value => 'ignored')
+      item.value.should == 'value'
+      item.hits.should == 15
+      item.a.should == 1
+    end
+
+    it "should work like an openstruct" do
+      item = Blacklight::SolrResponse::Facets::FacetItem.new(:value => 'value', :hits => 15)
+      
+      item.hits.should == 15
+      item.value.should == 'value'
+      item.should be_a_kind_of(OpenStruct)
+    end
+
+    it "should provide a label accessor" do
+      item = Blacklight::SolrResponse::Facets::FacetItem.new('value', :hits => 15)
+      item.label.should == 'value'
+    end
+
+    it "should use a provided label" do
+      item = Blacklight::SolrResponse::Facets::FacetItem.new('value', 15, :label => 'custom label')
+      item.label.should == 'custom label'
+
+    end
+
+  end
+
   it 'should return the correct value when calling facet_by_field_name' do
     r = create_response
     facet = r.facet_by_field_name('cat')

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

@@ -15,7 +15,7 @@ describe "catalog/_facets" do
 
       @mock_field_1 = mock(:field => 'facet_field_1',
                        :label => 'label')
-      @mock_display_facet_1 = mock(:name => 'facet_field_1', :items => [mock(:value => 'Value', :hits => 1234)])
+      @mock_display_facet_1 = mock(:name => 'facet_field_1', :items => [Blacklight::SolrResponse::Facets::FacetItem.new(:value => 'Value', :hits => 1234)])
       view.stub(:facet_field_names => [:facet_field_1],
                 :facet_limit_for => 10 )
 
@@ -31,7 +31,7 @@ describe "catalog/_facets" do
     before do
       @mock_field_1 = mock(:field => 'facet_field_1',
                        :label => 'label')
-      @mock_display_facet_1 = mock(:name => 'facet_field_1', :items => [mock(:value => 'Value', :hits => 1234)])
+      @mock_display_facet_1 = mock(:name => 'facet_field_1', :items => [Blacklight::SolrResponse::Facets::FacetItem.new(:value => 'Value', :hits => 1234)])
       view.stub(:facet_field_names => [:facet_field_1],
                 :facet_limit_for => 10 )
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 4.0.0.pre7
+  version: 4.0.0.rc1
   prerelease: 6
 platform: ruby
 authors:
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -252,6 +252,7 @@ files:
 - app/views/catalog/_facet_layout.html.erb
 - app/views/catalog/_facet_limit.html.erb
 - app/views/catalog/_facet_pagination.html.erb
+- app/views/catalog/_facet_pivot.html.erb
 - app/views/catalog/_facets.html.erb
 - app/views/catalog/_home.html.erb
 - app/views/catalog/_home_text.html.erb
@@ -322,6 +323,7 @@ files:
 - lib/blacklight/controller.rb
 - lib/blacklight/engine.rb
 - lib/blacklight/exceptions.rb
+- lib/blacklight/legacy_controller_methods.rb
 - lib/blacklight/mash.rb
 - lib/blacklight/routes.rb
 - lib/blacklight/search_fields.rb
@@ -465,7 +467,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1421767879458885450
+      hash: 4562410494290204402
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: