blacklight 3.0.0pre7 → 3.0.0pre8

data/VERSION

@@ -1 +1 @@
-3.0.0pre7
+3.0.0pre8

data/app/controllers/search_history_controller.rb

@@ -4,15 +4,6 @@ class SearchHistoryController < ApplicationController
     @searches = searches_from_history
   end
   
-  #TODO we may want to remove unsaved (those without user_id) items from the database when removed from history
-  def destroy
-    if session[:history].delete(params[:id].to_i)
-      flash[:notice] = "Successfully removed that search history item."
-    else
-      flash[:error] = "Couldn't remove that search history item."
-    end
-    redirect_to :back
-  end
   
   #TODO we may want to remove unsaved (those without user_id) items from the database when removed from history
   def clear

data/app/helpers/blacklight_helper.rb

@@ -297,13 +297,11 @@ module BlacklightHelper
     # using "_" as sep. to more closely follow the views file naming conventions
     # parameterize uses "-" as the default sep. which throws errors
     display_type = document[Blacklight.config[:show][:display_type]]
-    if display_type
-      if display_type.respond_to?(:join)
-        "#{display_type.join(" ").gsub("-"," ")}".parameterize("_").to_s
-      else
-        "#{display_type.gsub("-"," ")}".parameterize("_").to_s
-      end
-    end
+
+    return 'default' unless display_type
+    display_type = display_type.join(" ") if display_type.respond_to?(:join)
+
+    "#{display_type.gsub("-"," ")}".parameterize("_").to_s
   end
 
   # given a doc and action_name, this method attempts to render a partial template
@@ -358,8 +356,8 @@ module BlacklightHelper
   # add_facet_params_and_redirect
   def add_facet_params(field, value)
     p = params.dup
-    p[:f] = params[:f].nil? ? {} : params[:f].dup  # the command above is not deep in rails3, !@#$!@#$
-    p[:f][field] ||= []
+    p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
+    p[:f][field] = (p[:f][field] || []).dup
     p[:f][field].push(value)
     p
   end
@@ -398,6 +396,7 @@ module BlacklightHelper
     # if the values aren't dup'd, then the values
     # from the session will get remove in the show view...
     p[:f] = p[:f].dup
+    p[:f][field] = p[:f][field].nil? ? [] : p[:f][field].dup
     p.delete :page
     p.delete :id
     p.delete :counter
@@ -472,6 +471,9 @@ module BlacklightHelper
     # removing action and controller from duplicate params so that we don't get hidden fields for them.
     my_params.delete(:action)
     my_params.delete(:controller)
+    # commit is just an artifact of submit button, we don't need it, and
+    # don't want it to pile up with another every time we press submit again!
+    my_params.delete(:commit)
     # hash_as_hidden_fields in hash_as_hidden_fields.rb
     return hash_as_hidden_fields(my_params)
   end

data/app/views/search_history/index.html.erb

@@ -15,7 +15,6 @@
       <%- else -%>
         <%= button_to "save", save_search_path(search.id), :method => :put %>
       <%- end -%></td>
-      <td class="actions"><%= button_to "delete", delete_search_path(search.id), :confirm => "Delete item?" %></td>
     <% end #content_tag %>
   <%- end -%>
   </table>

data/lib/blacklight/catalog.rb

@@ -2,6 +2,8 @@
 module Blacklight::Catalog 
   extend ActiveSupport::Concern
   include Blacklight::SolrHelper
+  
+  SearchHistoryWindow = 12 # how many searches to save in session history
 
   # The following code is executed when someone includes blacklight::catalog in their
   # own controller.
@@ -234,13 +236,18 @@ module Blacklight::Catalog
     def save_current_search_params    
       # If it's got anything other than controller, action, total, we
       # consider it an actual search to be saved. Can't predict exactly
-      # what the keys for a search will be, due to possible extra plugins. 
+      # what the keys for a search will be, due to possible extra plugins.
       return if (search_session.keys - [:controller, :action, :total, :counter, :commit ]) == [] 
       params_copy = search_session.clone # don't think we need a deep copy for this
       params_copy.delete(:page)
+      
       unless @searches.collect { |search| search.query_params }.include?(params_copy)
+        
         new_search = Search.create(:query_params => params_copy)
         session[:history].unshift(new_search.id)
+        # Only keep most recent X searches in history, for performance. 
+        # both database (fetching em all), and cookies (session is in cookie)
+        session[:history] = session[:history].slice(0, Blacklight::Catalog::SearchHistoryWindow )
       end
     end
           

data/lib/blacklight/controller.rb

@@ -40,9 +40,14 @@ module Blacklight::Controller
     # http://api.rubyonrails.org/classes/ActionController/Filters/ClassMethods.html
     # for how to turn off a filter in a sub-class and such.
     def default_html_head
-      stylesheet_links << ['yui', 'jquery/ui-lightness/jquery-ui-1.8.1.custom.css', 'blacklight/blacklight', {:media=>'all'}]
+      if use_asset_pipeline?
+        stylesheet_links  << ["application"]
+        javascript_includes << ["application"]
+      else
+        stylesheet_links << ['yui', 'jquery/ui-lightness/jquery-ui-1.8.1.custom.css', 'blacklight/blacklight', {:media=>'all'}]
       
-      javascript_includes << ['jquery-1.4.2.min.js', 'jquery-ui-1.8.1.custom.min.js', 'blacklight/blacklight' ]
+        javascript_includes << ['jquery-1.4.2.min.js', 'jquery-ui-1.8.1.custom.min.js', 'blacklight/blacklight' ]
+      end
     end
     
     
@@ -71,7 +76,7 @@ module Blacklight::Controller
 
     # Returns a list of Searches from the ids in the user's history.
     def searches_from_history
-      session[:history].blank? ? [] : Search.find(session[:history]) rescue []
+      session[:history].blank? ? [] : Search.where(:id => session[:history]).order("updated_at desc")
     end
     
     #
@@ -124,5 +129,10 @@ module Blacklight::Controller
       redirect_to new_user_session_url(:referer => request.fullpath)
     end
   
+    private
+    # Detect if the Rails asset pipeline is enabled
+    def use_asset_pipeline?
+      Rails.application.config.respond_to?(:assets) and Rails.application.config.assets.enabled
+    end
 end
 

data/lib/blacklight/routes.rb

@@ -47,8 +47,7 @@ module Blacklight
       def search_history
         add_routes do |options|
           match "search_history",             :to => "search_history#index",   :as => "search_history"
-          match "search_history/clear",       :to => "search_history#clear",   :as => "clear_search_history"
-          match "search_history/destroy/:id", :to => "search_history#destroy", :as => "delete_search"
+          match "search_history/clear",       :to => "search_history#clear",   :as => "clear_search_history"          
         end
       end
   

data/lib/blacklight/solr_helper.rb

@@ -391,13 +391,14 @@ module Blacklight::SolrHelper
   # the Blacklight app-level request params that define the search. 
   def get_single_doc_via_search(index, request_params)
     solr_params = solr_search_params(request_params)
-    solr_params[:start] = index - 1 # start at 0 to get 1st doc, 1 to get 2nd. 
+    # solr_params[:start] = index - 1 # start at 0 to get 1st doc, 1 to get 2nd. 
     # FIXME: we must set page because of a  bug posted here: https://github.com/mwmitchell/rsolr-ext/issues/16
-    solr_params[:page] = index - 1 # start at 0 to get 1st doc, 1 to get 2nd. 
+    solr_params[:page] = index # start at 1 to get 1st 1-doc page with RSolr::Ext :page
     solr_params[:per_page] = 1
     solr_params[:rows] = 1
     solr_params[:fl] = '*'
-    solr_response = find(solr_params).docs.first
+    solr_response = find(solr_params)
+    SolrDocument.new(solr_response.docs.first, solr_response) unless solr_response.docs.empty?
   end
     
   # returns a solr params hash

data/lib/generators/blacklight/assets_generator.rb

@@ -5,7 +5,7 @@
 # generally you'd only want to do this in 'development', and can
 # add it to environments/development.rb:
 #       require File.join(Blacklight.root, "lib", "generators", "blacklight", "assets_generator.rb")
-#       Blacklight::AssetsGenerator.start(["--force", "--quiet"])
+#       Blacklight::Assets.start(["--force", "--quiet"])
 
 
 # Need the requires here so we can call the generator from environment.rb
@@ -13,13 +13,40 @@
 require 'rails/generators'
 require 'rails/generators/base'
 module Blacklight
-  class AssetsGenerator < Rails::Generators::Base
+  class Assets < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
   
     def assets
-      directory("public/images")
-      directory("public/stylesheets") 
-      directory("public/javascripts") 
+      if use_asset_pipeline?
+        insert_into_file "app/assets/stylesheets/application.css", :after => " *= require_self" do
+%q{
+ *
+ * Required by Blacklight
+ *= require 'yui'
+ *= require 'jquery/ui-lightness/jquery-ui-1.8.1.custom.css'
+ *= require 'blacklight/blacklight'         
+}
+        end
+
+        insert_into_file "app/assets/javascripts/application.js", :after => "//= require jquery_ujs" do
+%q{
+// Required by Blacklight
+//= require jquery-ui
+//= require blacklight/blacklight          
+}          
+        end
+        directory("../../../../app/assets/images/blacklight", "public/images/blacklight")
+      else
+        # directories are relative to the source_root 
+        directory("../../../../app/assets/images/blacklight", "public/images/blacklight")
+        directory("../../../../app/assets/stylesheets", "public/stylesheets") 
+        directory("../../../../app/assets/javascripts", "public/javascripts") 
+      end
+    end
+
+    private
+    def use_asset_pipeline?
+      (Rails::VERSION::MAJOR >= 3 and Rails::VERSION::MINOR >= 1) and Rails.application.config.assets.enabled
     end
     
   end

data/lib/generators/blacklight/blacklight_generator.rb

@@ -83,6 +83,7 @@ EOF
   end
 }
       end
+      gsub_file("config/initializers/devise.rb", "config.sign_out_via = :delete", "config.sign_out_via = :get")
     end
   end
 
@@ -93,12 +94,11 @@ EOF
     directory("config/SolrMarc")
   end
   
-  require File.expand_path('../assets_generator.rb', __FILE__)  
   # Copy all files in templates/public/ directory to public/
   # Call external generator in AssetsGenerator, so we can
   # leave that callable seperately too. 
   def copy_public_assets 
-    Blacklight::AssetsGenerator.start()    
+    generate "blacklight:assets"
   end
   
   # Setup the database migrations

data/test_support/bin/test.sh

@@ -74,11 +74,12 @@ platforms :ruby do
  gem 'sqlite3-ruby', :require => 'sqlite3'
 end
 gem 'blacklight', :path => '../../'
+gem 'jquery-rails'
 
 # For testing
 group :development, :test do 
        gem 'rspec'
-       gem 'rspec-rails', '~>2.5.0'       
+       gem 'rspec-rails', '>=2.5.0'       
        gem 'generator_spec'
        gem 'cucumber-rails'
        gem 'database_cleaner'  

data/test_support/features/search_history.feature

@@ -27,15 +27,6 @@ Feature: Search History Page
     Then I should see "dang"
     And I should see "book"
 
-  Scenario: Deleting a Search
-    Given I have done a search with term "book"
-    And I am on the search history page
-    Then I should see a "delete" button
-    And I should see "book"
-    When I press "delete"
-    Then I should see "Successfully removed that search history item."    
-    Then I should not see "book"
-
   Scenario: Clearing Search History
     Given I have done a search with term "book"
     And I have done a search with term "dang"

data/test_support/features/step_definitions/saved_searches_steps.rb

@@ -7,7 +7,7 @@ Given /^I am logged in as "([^\"]*)"$/ do |login|
   visit new_user_session_path
   fill_in("user_email", :with => email) 
   fill_in("user_password", :with => "password") 
-  click_button("user_submit")
+  click_button("Sign in")
 #  response.body.should =~ /Logged/m  
   Then 'I should see "Log Out"'
 end

data/test_support/spec/controllers/application_controller_spec.rb

@@ -6,16 +6,23 @@ describe ApplicationController do
   describe "head content from variables" do
 
     describe "#default_html_head" do
-      before(:each) do
-        controller.send(:default_html_head)
-      end
       it "should setup js and css defaults" do                
+
+        controller.should_receive(:use_asset_pipeline?).any_number_of_times.and_return(false)
+        controller.send(:default_html_head)
         controller.javascript_includes.should include(["jquery-1.4.2.min.js", "jquery-ui-1.8.1.custom.min.js", "blacklight/blacklight"])#find do |item|
         #  item == ["jquery-1.4.2.min.js", "jquery-ui-1.7.2.custom.min.js", "blacklight", "application", "accordion", "lightbox", {:plugin=>:blacklight}]
         #end
 
         controller.stylesheet_links.should include(["yui", "jquery/ui-lightness/jquery-ui-1.8.1.custom.css", "blacklight/blacklight", {:media=>"all"}])
       end
+
+      it "should support rails 3.1 asset pipeline js and css defaults" do
+        controller.should_receive(:use_asset_pipeline?).any_number_of_times.and_return(true)
+        controller.send(:default_html_head)
+        controller.javascript_includes.should include(["application"])
+        controller.stylesheet_links.should include(["application"])
+      end
     end
   end
 

data/test_support/spec/controllers/search_history_controller_spec.rb

@@ -19,6 +19,15 @@ describe SearchHistoryController do
       @searches.should_not include(@two)
     end
     
+    it "should tolerate bad ids in session" do
+      session[:history] = [@one.id, @three.id, "NOT_IN_DB"]
+      get :index
+      @searches = assigns(:searches)
+      @searches.length.should == 2
+      @searches.should include(@one)
+      @searches.should include(@three)      
+    end
+    
     it "should not fetch any searches if there is no history" do
       session[:history] = []
       get :index
@@ -27,20 +36,6 @@ describe SearchHistoryController do
     end
   end
 
-  describe "destroy" do
-    it "should delete the search by id from the search history not by array index" do
-      session[:history] = [1,2,2]
-      request.env["HTTP_REFERER"] = "/search_history"
-      get :destroy, :id=>1
-      session[:history].length.should == 2
-    end
-    it "should return a flash error if an id that is not in the users search history is deleted" do
-      session[:history] = [1,2,3]
-      request.env["HTTP_REFERER"] = "/search_history"
-      get :destroy, :id=>4
-      request.flash[:error].should_not == ""
-    end
-    
-  end
+
 
 end

data/test_support/spec/helpers/blacklight_helper_spec.rb

@@ -63,6 +63,7 @@ def exportable_record
 </record>"
 end
 describe BlacklightHelper do
+  include ERB::Util
   include BlacklightHelper
   
   describe "link_back_to_catalog" do
@@ -123,16 +124,17 @@ describe BlacklightHelper do
 
   describe "search_as_hidden_fields" do
     def params
-      {:q => "query", :sort => "sort", :per_page => "20", :search_field => "search_field", :page => 100, :arbitrary_key => "arbitrary_value", :f => {"field" => ["value1", "value2"]}, :controller => "catalog", :action => "index"}
+      {:q => "query", :sort => "sort", :per_page => "20", :search_field => "search_field", :page => 100, :arbitrary_key => "arbitrary_value", :f => {"field" => ["value1", "value2"]}, :controller => "catalog", :action => "index", :commit => "search"}
     end
     describe "for default arguments" do
       it "should default to omitting :page" do
         search_as_hidden_fields.should have_selector("input[type='hidden']", :count =>7)
         search_as_hidden_fields.should_not have_selector("input[name='page']") 
       end
-      it "should not return action and controller hidden elements" do
+      it "should not return blacklisted elements" do
         search_as_hidden_fields.should_not have_selector("input[name='action']")
         search_as_hidden_fields.should_not have_selector("input[name='controller']")
+        search_as_hidden_fields.should_not have_selector("input[name='commit']")
       end
       describe "for omit_keys parameter" do
         it "should not include those keys" do

data/test_support/spec/helpers/catalog_helper_spec.rb

@@ -1,6 +1,7 @@
 # -*- encoding : utf-8 -*-
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe CatalogHelper do
+  include ERB::Util
   include CatalogHelper
 
   def mock_response args

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 3
   - 0
-  - 0pre7
-  version: 3.0.0pre7
+  - 0pre8
+  version: 3.0.0pre8
 platform: ruby
 authors: 
 - Jonathan Rochkind
@@ -21,7 +21,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-30 00:00:00 -04:00
+date: 2011-07-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -142,6 +142,36 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- app/assets/images/blacklight/bg.png
+- app/assets/images/blacklight/border.png
+- app/assets/images/blacklight/bul_sq_gry.gif
+- app/assets/images/blacklight/checkmark.gif
+- app/assets/images/blacklight/logo.png
+- app/assets/images/blacklight/magnifying_glass.gif
+- app/assets/images/blacklight/remove.gif
+- app/assets/images/blacklight/separator.gif
+- app/assets/images/blacklight/start_over.gif
+- app/assets/javascripts/blacklight/blacklight.js
+- app/assets/javascripts/jquery-1.4.2.min.js
+- app/assets/javascripts/jquery-ui-1.8.1.custom.min.js
+- app/assets/stylesheets/blacklight/blacklight.css
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-anim_basic_16x16.gif
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-bg_diagonals-thick_18_b81900_40x40.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-bg_diagonals-thick_20_666666_40x40.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-bg_flat_10_000000_40x100.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-bg_glass_100_f6f6f6_1x400.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-bg_glass_100_fdf5ce_1x400.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-bg_glass_65_ffffff_1x400.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-bg_gloss-wave_35_558fd0_500x100.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-bg_highlight-soft_100_eeeeee_1x100.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-bg_highlight-soft_75_ffe45c_1x100.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-icons_222222_256x240.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-icons_228ef1_256x240.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-icons_2e4f81_256x240.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-icons_ffd27a_256x240.png
+- app/assets/stylesheets/jquery/ui-lightness/images/ui-icons_ffffff_256x240.png
+- app/assets/stylesheets/jquery/ui-lightness/jquery-ui-1.8.1.custom.css
+- app/assets/stylesheets/yui.css
 - app/controllers/bookmarks_controller.rb
 - app/controllers/feedback_controller.rb
 - app/controllers/folder_controller.rb
@@ -274,36 +304,6 @@ files:
 - lib/generators/blacklight/templates/migrations/create_bookmarks.rb
 - lib/generators/blacklight/templates/migrations/create_searches.rb
 - lib/generators/blacklight/templates/migrations/remove_editable_fields_from_bookmarks.rb
-- lib/generators/blacklight/templates/public/images/blacklight/bg.png
-- lib/generators/blacklight/templates/public/images/blacklight/border.png
-- lib/generators/blacklight/templates/public/images/blacklight/bul_sq_gry.gif
-- lib/generators/blacklight/templates/public/images/blacklight/checkmark.gif
-- lib/generators/blacklight/templates/public/images/blacklight/logo.png
-- lib/generators/blacklight/templates/public/images/blacklight/magnifying_glass.gif
-- lib/generators/blacklight/templates/public/images/blacklight/remove.gif
-- lib/generators/blacklight/templates/public/images/blacklight/separator.gif
-- lib/generators/blacklight/templates/public/images/blacklight/start_over.gif
-- lib/generators/blacklight/templates/public/javascripts/blacklight/blacklight.js
-- lib/generators/blacklight/templates/public/javascripts/jquery-1.4.2.min.js
-- lib/generators/blacklight/templates/public/javascripts/jquery-ui-1.8.1.custom.min.js
-- lib/generators/blacklight/templates/public/stylesheets/blacklight/blacklight.css
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-anim_basic_16x16.gif
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-bg_diagonals-thick_18_b81900_40x40.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-bg_diagonals-thick_20_666666_40x40.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-bg_flat_10_000000_40x100.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-bg_glass_100_f6f6f6_1x400.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-bg_glass_100_fdf5ce_1x400.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-bg_glass_65_ffffff_1x400.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-bg_gloss-wave_35_558fd0_500x100.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-bg_highlight-soft_100_eeeeee_1x100.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-bg_highlight-soft_75_ffe45c_1x100.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-icons_222222_256x240.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-icons_228ef1_256x240.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-icons_2e4f81_256x240.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-icons_ffd27a_256x240.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/images/ui-icons_ffffff_256x240.png
-- lib/generators/blacklight/templates/public/stylesheets/jquery/ui-lightness/jquery-ui-1.8.1.custom.css
-- lib/generators/blacklight/templates/public/stylesheets/yui.css
 - lib/generators/blacklight/templates/solr_conf/schema.xml
 - lib/generators/blacklight/templates/solr_conf/solrconfig.xml
 - lib/generators/blacklight/templates/solr_document.rb
@@ -402,7 +402,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1025619995026452913
+      hash: -4202533913713398219
       segments: 
       - 0
       version: "0"