blacklight 3.6.1.1 → 3.7.0

data/lib/blacklight/routes.rb

@@ -24,7 +24,7 @@ module Blacklight
     end
 
     def default_route_sets
-      [:bookmarks, :folders, :search_history, :saved_searches, :catalog, :solr_document, :feedback]
+      [:bookmarks, :search_history, :saved_searches, :catalog, :solr_document, :feedback]
     end
 
     module RouteSets
@@ -35,15 +35,6 @@ module Blacklight
         end
       end
   
-  
-      def folders
-        add_routes do |options|
-           match "folder/clear", :to => "folder#clear", :as => "clear_folder"
-          match "folder/destroy", :to => "folder#destroy"
-          resources :folder, :only => [:index, :update, :destroy] 
-        end
-      end
-    
       def search_history
         add_routes do |options|
           match "search_history",             :to => "search_history#index",   :as => "search_history"

data/lib/blacklight/solr_helper.rb

@@ -244,12 +244,19 @@ module Blacklight::SolrHelper
     ##
     # Add any existing facet limits, stored in app-level HTTP query
     # as :f, to solr as appropriate :fq query. 
-    def add_facet_fq_to_solr(solr_parameters, user_params)      
+    def add_facet_fq_to_solr(solr_parameters, user_params)   
+
+      # convert a String value into an Array
+      if solr_parameters[:fq].is_a? String
+        solr_parameters[:fq] = [solr_parameters[:fq]]
+      end
+
       # :fq, map from :f. 
       if ( user_params[:f])
         f_request_params = user_params[:f] 
         
         solr_parameters[:fq] ||= []
+
         f_request_params.each_pair do |facet_field, value_list|
           Array(value_list).each do |value|
             solr_parameters[:fq] << facet_value_to_fq_string(facet_field, value)
@@ -261,18 +268,30 @@ module Blacklight::SolrHelper
     ##
     # Convert a facet/value pair into a solr fq parameter
     def facet_value_to_fq_string(facet_field, value) 
-      case
-        when (value.is_a?(TrueClass) or value.is_a?(FalseClass) or value == 'true' or value == 'false')
-          "#{facet_field}:#{value}"
-        when (value.is_a?(Integer) or (value.to_i.to_s == value if value.respond_to? :to_i))
-          "#{facet_field}:#{value}"
-        when (value.is_a?(Float) or (value.to_f.to_s == value if value.respond_to? :to_f))
-          "#{facet_field}:#{value}"
+      facet_config = blacklight_config.facet_fields[facet_field]
+
+      local_params = []
+      local_params << "tag=#{facet_config.tag}" if facet_config and facet_config.tag
+
+      prefix = ""
+      prefix = "{!#{local_params.join(" ")}}" unless local_params.empty?
+
+      fq = case
+        when (facet_config and facet_config.query)
+          facet_config.query[value][:fq]
+        when (facet_config and facet_config.date),
+             (value.is_a?(TrueClass) or value.is_a?(FalseClass) or value == 'true' or value == 'false'),
+             (value.is_a?(Integer) or (value.to_i.to_s == value if value.respond_to? :to_i)),
+             (value.is_a?(Float) or (value.to_f.to_s == value if value.respond_to? :to_f))
+             (value.is_a?(DateTime) or value.is_a?(Date) or value.is_a?(Time))
+          "#{prefix}#{facet_field}:#{value}"
         when value.is_a?(Range)
-          "#{facet_field}:[#{value.first} TO #{value.last}]"
+          "#{prefix}#{facet_field}:[#{value.first} TO #{value.last}]"
         else
-          "{!raw f=#{facet_field}}#{value}"
+          "{!raw f=#{facet_field}#{(" " + local_params.join(" ")) unless local_params.empty?}}#{value}"
       end
+
+
     end
     
     ##
@@ -290,14 +309,38 @@ module Blacklight::SolrHelper
         solr_parameters[:"facet.field"] ||= []
         solr_parameters[:"facet.field"].concat( [user_params["facet.field"], user_params["facets"]].flatten.compact ).uniq!
       end                
-  
-      # Support facet paging and 'more'
-      # links, by sending a facet.limit one more than what we
-      # want to page at, according to configured facet limits.       
+
+
+      if blacklight_config.add_facet_fields_to_solr_request
+        solr_parameters[:'facet.field'] ||= []
+        solr_parameters[:'facet.field'] += blacklight_config.facet_fields_to_add_to_solr
+        
+        if blacklight_config.facet_fields.any? { |k,v| v[:query] }
+          solr_parameters[:'facet.query'] ||= []
+        end
+      end
+         
       blacklight_config.facet_fields.each do |field_name, facet|
-        next unless (limit = facet_limit_for(field_name))
-  
-        solr_parameters[:"f.#{field_name}.facet.limit"] = (limit + 1)
+
+        if blacklight_config.add_facet_fields_to_solr_request
+          case 
+            when facet.query
+              solr_parameters[:'facet.query'] += facet.query.map { |k, x| x[:fq] } 
+   
+            when facet.ex
+              idx = solr_parameters[:'facet.field'].index(facet.field)
+              solr_parameters[:'facet.field'][idx] = "{!ex=#{facet.ex}}#{solr_parameters[:'facet.field'][idx]}" unless idx.nil?
+          end
+
+          if facet.sort
+            solr_parameters[:"f.#{facet.field}.facet.sort"] = facet.sort
+          end
+        end
+
+        # Support facet paging and 'more'
+        # links, by sending a facet.limit one more than what we
+        # want to page at, according to configured facet limits.
+        solr_parameters[:"f.#{facet.field}.facet.limit"] = (facet_limit_for(field_name) + 1) if facet_limit_for(field_name)
       end
     end
 

data/lib/generators/blacklight/blacklight_generator.rb

@@ -69,6 +69,7 @@ EOF
   def generate_devise_assets
     if options[:devise]
       gem "devise"
+      gem "devise-guests"
       run "bundle install"      
       generate "devise:install"
       generate "devise", model_name.classify

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

@@ -51,21 +51,26 @@ class CatalogController < ApplicationController
     #
     # :show may be set to false if you don't want the facet to be drawn in the 
     # facet bar
-    config.add_facet_field 'format', :label => 'Format' 
-    config.add_facet_field 'pub_date', :label => 'Publication Year' 
+    config.add_facet_field 'format', :label => 'Format'
+    config.add_facet_field 'pub_date', :label => 'Publication Year', :single => true
     config.add_facet_field 'subject_topic_facet', :label => 'Topic', :limit => 20 
     config.add_facet_field 'language_facet', :label => 'Language', :limit => true 
     config.add_facet_field 'lc_1letter_facet', :label => 'Call Number' 
     config.add_facet_field 'subject_geo_facet', :label => 'Region' 
     config.add_facet_field 'subject_era_facet', :label => 'Era'  
 
+
+    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 *]" },
+       :years_10 => { :label => 'within 10 Years', :fq => "pub_date:[#{Time.now.year - 10 } TO *]" },
+       :years_25 => { :label => 'within 25 Years', :fq => "pub_date:[#{Time.now.year - 25 } TO *]" }
+    }
+
+
     # Have BL send all facet field names to Solr, which has been the default
     # previously. Simply remove these lines if you'd rather use Solr request
     # handler defaults, or have no facets.
-    config.default_solr_params[:'facet.field'] = config.facet_fields.keys
-    #use this instead if you don't want to query facets marked :show=>false
-    #config.default_solr_params[:'facet.field'] = config.facet_fields.select{ |k, v| v[:show] != false}.keys
-
+    config.add_facet_fields_to_solr_request!
 
     # solr fields to be displayed in the index (search results) view
     #   The ordering of the field names is the order of the display 

data/test_support/bin/test.sh

@@ -110,6 +110,7 @@ end
 
 gem 'jettywrapper', '>= 1.2.0'
 gem \"devise\"
+gem \"devise-guests\"
 " >> Gemfile
 
 bundle install

data/test_support/features/bookmarks.feature

@@ -16,11 +16,7 @@ Feature: Bookmarks
       Given I am logged in as "user1"
       When I go to the bookmarks page
       Then I should see "You have no bookmarks"
-      
-    Scenario: Bookmarks not logged in
-      When I go to the bookmarks page
-      Then I should see "Sign in"
-  
+        
     Scenario: User Has Bookmarks
       Given I am logged in as "user1"
       And "user1" has bookmarked an item with title "foo bar"
@@ -72,17 +68,11 @@ Feature: Bookmarks
       And I press "Remove bookmark"
       And I should see "Successfully removed bookmark"
       
-    Scenario: Adding bookmarks from Folder
-      Given I am logged in as "user1"
-      And I have record 2007020969 in my folder
-      And I have record 2008308175 in my folder
-      And I follow "Selected Items"
-      And I press "Add to Bookmarks"
-      Then I should see "Successfully added bookmarks."
-      
-    Scenario: Adding bookmark from Folder
-       Given I am logged in as "user1"
-       And I have record 2007020969 in my folder
-       And I follow "Selected Items"
-       And I press "Add to Bookmarks"
-       Then I should see "Successfully added bookmark."
+    Scenario: Adding bookmarks after a user logs in
+      Given I am on the document page for id 2007020969
+      Then I should see a "Bookmark" button
+      And I press "Bookmark"
+      And I am logged in as "user1"
+      When I go to the bookmarks page
+      Then I should see a "Remove" button
+      

data/test_support/spec/controllers/application_controller_spec.rb

@@ -1,6 +1,7 @@
 # -*- encoding : utf-8 -*-
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe ApplicationController do
+  include Devise::TestHelpers
 
 # HEAD CONTENT
   describe "head content from variables" do

data/test_support/spec/controllers/bookmarks_controller_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe BookmarksController do
+  include Devise::TestHelpers
+  let :user do
+    User.create :email => 'mods_asset@example.com', :password => 'modsasset'
+  end
+
+  before(:each) do
+    request.env["HTTP_REFERER"] = "/"
+
+    sign_in user
+  end
+
+  it "should create bookmarks" do
+    post "create", :bookmark => { :document_id => 'a' }
+    Bookmark.last.document_id.should == 'a'
+  end
+
+  it "should create multiple bookmarks" do
+    post "create", :bookmarks => [
+       { :document_id => 'a' },
+       { :document_id => 'b' }
+    ]
+    Bookmark.count.should == 2
+  end
+
+  it "should not create duplicate bookmarks" do
+    post "create", :bookmark => { :document_id => 'a' }
+    post "create", :bookmark => { :document_id => 'b' }
+    post "create", :bookmark => { :document_id => 'a' }
+    Bookmark.count.should == 2
+  end
+
+  it "should delete bookmarks" do
+    post "create", :bookmark => { :document_id => 'a' }
+    Bookmark.count.should == 1
+    delete "destroy", :id => 'a'
+    Bookmark.count.should == 0
+  end
+
+  it "should clear bookmarks" do
+    post "create", :bookmark => { :document_id => 'a' }
+    post "create", :bookmark => { :document_id => 'b' }
+    delete "clear"
+    Bookmark.count.should == 0
+  end
+end

data/test_support/spec/controllers/catalog_controller_spec.rb

@@ -4,6 +4,7 @@ require 'rubygems'
 require 'marc'
 
 describe CatalogController do
+  include Devise::TestHelpers
 #=begin
   # ROUTES and MAPPING
   describe "Paths Generated by Custom Routes:" do
@@ -489,7 +490,7 @@ describe CatalogController do
       controller.stub(:has_user_authentication_provider?) { false }
         @mock_response = mock()
         @mock_document = mock()
-        @mock_response.stub(:docs => [], :total => 1, :facets => [], :facet_by_field_name => nil)
+        @mock_response.stub(:docs => [], :total => 1, :facets => [], :facet_queries => {}, :facet_by_field_name => nil)
         @mock_document = mock()
         controller.stub(:find => @mock_response, 
                         :get_single_doc_via_search => @mock_document)

data/test_support/spec/controllers/search_history_controller_spec.rb

@@ -2,6 +2,8 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe SearchHistoryController do
+  include Devise::TestHelpers
+
   describe "index" do
     before(:all) do
       @one = Search.create

data/test_support/spec/helpers/blacklight_helper_spec.rb

@@ -66,6 +66,7 @@ end
 describe BlacklightHelper do
   include ERB::Util
   include BlacklightHelper
+  include Devise::TestHelpers
   def blacklight_config
     @config ||= Blacklight::Configuration.new.configure do |config| 
       config.show.html_title = "title_display"
@@ -356,14 +357,12 @@ describe BlacklightHelper do
       it "should render partials" do
         response = helper.render_index_doc_actions(@document)
         response.should have_selector(".bookmark_toggle")
-        response.should have_selector(".folder_toggle")
       end
     end
     describe "render_show_doc_actions" do
       it "should render partials" do
         response = helper.render_show_doc_actions(@document)
         response.should have_selector(".bookmark_toggle")
-        response.should have_selector(".folder_toggle")
       end
     end
   end

data/test_support/spec/helpers/facets_helper_spec.rb

@@ -1,6 +1,11 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe FacetsHelper do
+  let(:blacklight_config) { Blacklight::Configuration.new }
 
+  before(:each) do
+    helper.stub(:blacklight_config).and_return blacklight_config
+  end
+  
   describe "should_render_facet?" do
     before do
       @config = Blacklight::Configuration.new do |config|
@@ -27,15 +32,64 @@ describe FacetsHelper do
 
   describe "facet_by_field_name" do
     it "should retrieve the facet from the response given a string" do
-      a = mock(:name => 'a', :items => [1,2])
+      facet_config = mock(:query => nil)
+      facet_field = mock()
+      helper.should_receive(:facet_configuration_for_field).with(anything()).and_return(facet_config)
 
       @response = mock()
-      @response.should_receive(:facet_by_field_name).with('a') { a }
+      @response.should_receive(:facet_by_field_name).with('a').and_return(facet_field)
+
+      helper.facet_by_field_name('a').should == facet_field
+    end
+
+    it "should also work for facet query fields" do
+      facet_config = mock(:query => {})
+      helper.should_receive(:facet_configuration_for_field).with('a_query_facet_field').and_return(facet_config)
+      helper.should_receive(:create_rsolr_facet_field_response_for_query_facet_field).with('a_query_facet_field', facet_config)
+
+      helper.facet_by_field_name 'a_query_facet_field'
+    end
+
+    describe "query facets" do
+      let(:facet_config) { 
+        mock(
+          :query => {
+             'a_simple_query' => { :fq => 'field:search', :label => 'A Human Readable label'},
+             'another_query' => { :fq => 'field:different_search', :label => 'Label'},
+             'without_results' => { :fq => 'field:without_results', :label => 'No results for this facet'}
+             }
+        )
+      }
+
+      before(:each) do
+        helper.should_receive(:facet_configuration_for_field).with(anything()).and_return(facet_config)
+
+        @response = mock(:facet_queries => {
+          'field:search' => 10,
+          'field:different_search' => 2,
+          'field:not_appearing_in_the_config' => 50,
+          'field:without_results' => 0
+        })
+      end
 
-      helper.facet_by_field_name('a').should == a
+      it"should convert the query facets into a mock RSolr FacetField" do
+        field = helper.facet_by_field_name('my_query_facet_field')
+        field.should be_a_kind_of RSolr::Ext::Response::Facets::FacetField
+
+        field.name.should == 'my_query_facet_field'
+        field.items.length.should == 2
+        field.items.map { |x| x.value }.should_not include 'field:not_appearing_in_the_config'
+
+        facet_item = field.items.select { |x| x.value == 'a_simple_query' }.first
+
+        facet_item.value.should == 'a_simple_query'
+        facet_item.hits.should == 10
+        facet_item.label.should == 'A Human Readable label'
+      end
     end
   end
 
+
   describe "render_facet_partials" do
     it "should try to render all provided facets " do
       a = mock(:items => [1,2])
@@ -163,6 +217,18 @@ describe FacetsHelper do
         end        
       end
     end    
+
+    it "should replace facets for facets configured as single" do
+      helper.should_receive(:facet_configuration_for_field).with('single_value_facet_field').and_return(mock(:single => true))
+      params = { :f => { 'single_value_facet_field' => 'other_value'}}
+      helper.stub!(:params).and_return params
+
+      result_params = helper.add_facet_params('single_value_facet_field', 'my_value')
+
+
+      result_params[:f]['single_value_facet_field'].length.should == 1
+      result_params[:f]['single_value_facet_field'].first.should == 'my_value'
+    end
   end
 
   describe "add_facet_params_and_redirect" do
@@ -214,5 +280,26 @@ describe FacetsHelper do
   describe "facet_in_params?" do
 
   end
-  
+
+  describe "#facet_display_value" do
+    it "should just be the facet value for an ordinary facet" do
+      helper.stub(:facet_configuration_for_field).with('simple_field').and_return(mock(:query => nil, :date => nil))
+      helper.facet_display_value('simple_field', 'asdf').should == 'asdf'
+    end
+
+    it "should extract the configuration label for a query facet" do
+      helper.stub(:facet_configuration_for_field).with('query_facet').and_return(mock(:query => { 'query_key' => { :label => 'XYZ'}}, :date => nil))
+      helper.facet_display_value('query_facet', 'query_key').should == 'XYZ'
+    end
+
+    it "should localize the label for date-type facets" do
+      helper.stub(:facet_configuration_for_field).with('date_facet').and_return(mock('date' => true, :query => nil))
+      helper.facet_display_value('date_facet', '2012-01-01').should == 'Sun, 01 Jan 2012 00:00:00 +0000'
+    end
+
+    it "should localize the label for date-type facets with the supplied localization options" do
+      helper.stub(:facet_configuration_for_field).with('date_facet').and_return(mock('date' => { :format => :short }, :query => nil))
+      helper.facet_display_value('date_facet', '2012-01-01').should == '01 Jan 00:00'
+    end
+  end
 end