blacklight 5.3.0 → 5.4.0.rc1

data/lib/blacklight/solr_response/response.rb

@@ -0,0 +1,18 @@
+module Blacklight::SolrResponse::Response
+  def response
+    self[:response] || {}
+  end
+  
+  # short cut to response['numFound']
+  def total
+    response[:numFound].to_s.to_i
+  end
+  
+  def start
+    response[:start].to_s.to_i
+  end
+
+  def empty?
+    total == 0
+  end
+end

data/lib/blacklight/user.rb

@@ -1,5 +1,8 @@
 # -*- encoding : utf-8 -*-
 module Blacklight::User
+  
+  extend Deprecation
+  self.deprecation_horizon = 'blacklight 6.0'
 
   # This gives us an is_blacklight_user method that can be included in
   # the containing applications models. 
@@ -12,17 +15,27 @@ module Blacklight::User
     end
   end
 
+  def bookmarks_for_documents documents = []
+    if documents.length > 0
+      bookmarks.where(document_type: documents.first.class.base_class, document_id: documents.map { |x| x.id})
+    else
+      []
+    end
+  end
+
   def bookmarked_document_ids
+    Deprecation.warn self, "The User#bookmarked_document_ids method is deprecated and will be removed in Blacklight 6.0"
+
     self.bookmarks.pluck(:document_id)
   end
 
-  def document_is_bookmarked?(document_id)
-    bookmarked_document_ids.include? document_id.to_s
+  def document_is_bookmarked?(document)
+    bookmarks_for_documents([document]).any?
   end
     
   # returns a Bookmark object if there is one for document_id, else
   # nil. 
-  def existing_bookmark_for(document_id)
-    self.bookmarks.where(:document_id => document_id).first
+  def existing_bookmark_for(document)
+    bookmarks_for_documents([document]).first
   end
 end

data/lib/blacklight/utils.rb

@@ -21,6 +21,10 @@ module Blacklight
     def to_h
       @table
     end
+    
+    def select *args, &block
+      self.class.new to_h.select(*args, &block)
+    end
 
     ##
     # Merge the values of this OpenStruct with another OpenStruct or Hash
@@ -54,7 +58,7 @@ module Blacklight
       hashes_and_keys = args.flatten
       lazy_configs = hashes_and_keys.extract_options!
 
-      args.each do |v|
+      hashes_and_keys.each do |v|
         if v.is_a? Hash
           key = v.first
           value = v[key]
@@ -66,7 +70,11 @@ module Blacklight
       end
 
       lazy_configs.each do |k,v|
-        hash[k] = nested_class.new v
+        if v.is_a? nested_class
+          hash[k] = v
+        else
+          hash[k] = nested_class.new v
+        end
       end
 
       super hash
@@ -111,6 +119,26 @@ module Blacklight
       set_default_proc!
     end
 
+    def select *args, &block
+      self.class.new nested_class, to_h.select(*args, &block)
+    end
+
+    ##
+    # Merge the values of this OpenStruct with another OpenStruct or Hash
+    # @param [Hash,#to_h]
+    # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
+    def merge other_hash
+      self.class.new nested_class, to_h.merge((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
+    end
+
+    ##
+    # Merge the values of another OpenStruct or Hash into this object
+    # @param [Hash,#to_h]
+    # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
+    def merge! other_hash
+      @table.merge!(nested_class, (other_hash if other_hash.is_a? Hash) || other_hash.to_h)
+    end 
+
     private
     def set_default_proc!
       self.default_proc = lambda do |hash, key|

data/lib/generators/blacklight/install_generator.rb

@@ -104,5 +104,9 @@ EOF
     def inject_blacklight_i18n_strings
       copy_file "blacklight.en.yml", "config/locales/blacklight.en.yml"
     end
+
+    def add_blacklight_initializer
+      template "config/initializers/blacklight_initializer.rb"
+    end
   end
 end

data/lib/generators/blacklight/templates/config/initializers/blacklight_initializer.rb

@@ -0,0 +1,9 @@
+# A secret token used to encrypt user_id's in the Bookmarks#export callback URL
+# functionality, for example in Refworks export of Bookmarks. In Rails 4, Blacklight
+# will use the application's secret key base instead.
+#
+<% if Rails::VERSION::MAJOR == 4 %>
+# Blacklight.secret_key = '<%= SecureRandom.hex(64) %>'
+<% else %>
+Blacklight.secret_key = '<%= SecureRandom.hex(64) %>'
+<% end %>

data/spec/controllers/application_controller_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe ApplicationController do
-  include Devise::TestHelpers
 
   describe "#blacklight_config" do
 

data/spec/controllers/bookmarks_controller_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
 describe BookmarksController do
-  include Devise::TestHelpers
-  
   # jquery 1.9 ajax does error callback if 200 returns empty body. so use 204 instead. 
   describe "update" do
     it "has a 204 status code when creating a new one" do
@@ -14,6 +12,7 @@ describe BookmarksController do
     it "has a 500 status code when fails is success" do
       @controller.stub_chain(:current_or_guest_user, :existing_bookmark_for).and_return(false)
       @controller.stub_chain(:current_or_guest_user, :persisted?).and_return(true)
+      @controller.stub_chain(:current_or_guest_user, :bookmarks, :where, :exists?).and_return(false)  
       @controller.stub_chain(:current_or_guest_user, :bookmarks, :create).and_return(false)  
       xhr :put, :update, :id => 'iamabooboo', :format => :js
       expect(response.code).to eq "500"
@@ -21,6 +20,11 @@ describe BookmarksController do
   end
   
   describe "delete" do
+    before do
+      @controller.send(:current_or_guest_user).save
+      @controller.send(:current_or_guest_user).bookmarks.create! document_id: '2007020969', document_type: "SolrDocument"
+    end
+    
     it "has a 204 status code when delete is success" do
       xhr :delete, :destroy, :id => '2007020969', :format => :js
       expect(response).to be_success
@@ -30,7 +34,7 @@ describe BookmarksController do
    it "has a 500 status code when delete is not success" do
       bm = double(Bookmark)
       @controller.stub_chain(:current_or_guest_user, :existing_bookmark_for).and_return(bm)
-      @controller.stub_chain(:current_or_guest_user, :bookmarks, :delete).and_return(false)
+      @controller.stub_chain(:current_or_guest_user, :bookmarks, :where, :first).and_return(double('bookmark', delete: nil, destroyed?: false)) 
      
       xhr :delete, :destroy, :id => 'pleasekillme', :format => :js
 
@@ -38,4 +42,4 @@ describe BookmarksController do
     end
   end
   
-end
+end

data/spec/controllers/catalog_controller_spec.rb

@@ -1,24 +1,26 @@
 require 'spec_helper'
 
 describe CatalogController do
-  include Devise::TestHelpers
-  # INDEX ACTION
+
   describe "index action" do
-    before(:each) do
-      @user_query = 'history'  # query that will get results
-      @no_docs_query = 'sadfdsafasdfsadfsadfsadf' # query for no results
-      @facet_query = {"format" => 'Book'}
-    end
     
-    # in rails3, the assigns method within ActionDispathc::TestProcess 
-    # kindly converts anything that desends from hash to a hash_With_indifferent_access
-    # which means that our solr resposne object gets replaced if we call
-    # assigns(:response) - so we can't do that anymore.
-    def assigns_response
-      @controller.instance_variable_get("@response")
+    # In Rails 3 ActionDispatch::TestProcess#assigns() converts anything that 
+    # descends from Hash to a HashWithIndifferentAccess. Therefore our Solr
+    # response object gets replaced if we call assigns(:response)
+    # Fixed by https://github.com/rails/rails/commit/185c3dbc6ab845edfc94e8d38ef5be11c417dd81
+    if ::Rails.version < "4.0"
+      def assigns_response
+        controller.instance_variable_get("@response")
+      end
+    else
+      def assigns_response
+        assigns(:response)
+      end
     end
     
     describe "with format :html" do
+      let(:user_query) { 'history' } # query that will get results
+
       it "should have no search history if no search criteria" do
         controller.should_receive(:get_search_results) 
         session[:history] = []
@@ -28,12 +30,12 @@ describe CatalogController do
 
       # check each user manipulated parameter
       it "should have docs and facets for query with results", :integration => true do
-        get :index, :q => @user_query
+        get :index, q: user_query
         expect(assigns_response.docs).to_not be_empty
         assert_facets_have_values(assigns_response.facets)
       end
       it "should have docs and facets for existing facet value", :integration => true do
-        get :index, :f => @facet_query
+        get :index, f: {"format" => 'Book'}
         expect(assigns_response.docs).to_not be_empty
         assert_facets_have_values(assigns_response.facets)
       end
@@ -53,7 +55,7 @@ describe CatalogController do
       end
 
       it "should have no docs or facet values for query without results", :integration => true do
-        get :index, :q => @no_docs_query
+        get :index, q: 'sadfdsafasdfsadfsadfsadf' # query for no results
 
         expect(assigns_response.docs).to be_empty
         assigns_response.facets.each do |facet|
@@ -71,12 +73,12 @@ describe CatalogController do
           controller.stub(:get_search_results) 
         end
         it "should include search hash with key :q" do
-          get :index, :q => @user_query
+          get :index, q: user_query
           expect(session[:search]).to_not be_nil
           expect(session[:search].keys).to include 'id'
           
           search = Search.find(session[:search]['id'])
-          expect(search.query_params['q']).to eq @user_query
+          expect(search.query_params['q']).to eq user_query
         end
       end
 
@@ -295,8 +297,7 @@ describe CatalogController do
       @mock_response = double()
       @mock_document = double()
       @mock_document.stub(:export_formats => {})
-      controller.stub(:get_solr_response_for_doc_id => [@mock_response, @mock_document], 
-                      :get_single_doc_via_search => @mock_document)
+      controller.stub(:get_solr_response_for_doc_id => [@mock_response, @mock_document])
       get :show, :id => doc_id
       response.should render_template(:show)
     end
@@ -304,10 +305,9 @@ describe CatalogController do
     describe "@document" do
       before do
         @mock_response = double()
-        @mock_response.stub(:docs => [{ :id => 'my_fake_doc' }])
+        @mock_response.stub(documents: [SolrDocument.new(id: 'my_fake_doc')])
         @mock_document = double()
-        controller.stub(:find => @mock_response, 
-                        :get_single_doc_via_search => @mock_document)
+        controller.stub(:find => @mock_response )
       end
       before(:each) do
         get :show, :id => doc_id
@@ -329,18 +329,15 @@ describe CatalogController do
           "mock_export"
         end
       end
+      
       before do
         @mock_response = double()
         @mock_response.stub(:docs => [{ :id => 'my_fake_doc' }])
         @mock_document = double()
-        controller.stub(:find => @mock_response, 
-                        :get_single_doc_via_search => @mock_document)
-
-        controller.stub(:find => @mock_response, 
-                        :get_single_doc_via_search => @mock_document)
+        controller.stub(find: @mock_response)
       end
 
-       before(:each) do
+      before(:each) do
 
         # Rails3 needs this to propertly setup a new mime type and
         # render the results. 
@@ -352,8 +349,19 @@ describe CatalogController do
         SolrDocument.use_extension(FakeExtension)
       end
       
+      before do
+        @mock_response = double()
+        @mock_response.stub(:documents => [SolrDocument.new(id: 'my_fake_doc')])
+        @mock_document = double()
+        controller.stub(:find => @mock_response, 
+                        :get_single_doc_via_search => @mock_document)
+
+        controller.stub(:find => @mock_response, 
+                        :get_single_doc_via_search => @mock_document)
+      end
+
       it "should respond to an extension-registered format properly" do
-        get :show, :id => doc_id, :format => "mock" # This no longer works: :format => "mock"
+        get :show, :id => doc_id, :format => "mock"
         expect(response).to be_success
         expect(response.body).to match /mock_export/
       end
@@ -371,10 +379,10 @@ describe CatalogController do
     before do
       @mock_response = double()
       @mock_document = double()
-      @mock_response.stub(:docs => [{ :id => 'my_fake_doc' }, { :id => 'my_other_doc'}])
+      @mock_response.stub(documents:  [SolrDocument.new(id: 'my_fake_doc'), SolrDocument.new(id: 'my_other_doc')])
       @mock_document = double()
-      controller.stub(:find => @mock_response, 
-                      :get_single_doc_via_search => @mock_document)
+      controller.stub(find: @mock_response)
+                      
     end
     it "should return an opensearch description" do
       get :opensearch, :format => 'xml'
@@ -388,15 +396,9 @@ describe CatalogController do
 
   describe "email/sms" do
     doc_id = '2007020969'
-      before do
-        @mock_response = double()
-        @mock_document = double()
-        @mock_response.stub(:docs => [{ :id => 'my_fake_doc' }, { :id => 'my_other_doc'}])
-        @mock_document = double()
-        controller.stub(:find => @mock_response, 
-                        :get_single_doc_via_search => @mock_document)
-      end
-    before(:each) do
+    let(:mock_response) { double(documents: [SolrDocument.new(id: 'my_fake_doc'), SolrDocument.new(id: 'my_other_doc')]) }
+    before do
+      controller.stub(find: mock_response)
       request.env["HTTP_REFERER"] = "/catalog/#{doc_id}"
       SolrDocument.use_extension( Blacklight::Solr::Document::Email )
       SolrDocument.use_extension( Blacklight::Solr::Document::Sms )
@@ -468,21 +470,15 @@ describe CatalogController do
 
   describe "errors" do
     it "should return status 404 for a record that doesn't exist" do
-        @mock_response = double()
-        @mock_response.stub(:docs => [])
-        @mock_document = double()
-        controller.stub(:find => @mock_response, 
-                        :get_single_doc_via_search => @mock_document)
+      @mock_response = double(documents: [])
+      controller.stub(:find => @mock_response)
       get :show, :id=>"987654321"
       expect(response.status).to eq 404
       expect(response.content_type).to eq Mime::HTML
     end
     it "should return status 404 for a record that doesn't exist even for non-html format" do
-      @mock_response = double()
-      @mock_response.stub(:docs => [])
-      @mock_document = double()
-      controller.stub(:find => @mock_response,
-                      :get_single_doc_via_search => @mock_document)
+      @mock_response = double(documents: [])
+      controller.stub(:find => @mock_response)
 
       get :show, :id=>"987654321", :format => "xml"
       expect(response.status).to eq 404
@@ -523,9 +519,6 @@ describe CatalogController do
 
     before do
       controller.stub(:has_user_authentication_provider?) { false }
-        @mock_response = double()
-        @mock_document = double()
-        controller.stub(:get_single_doc_via_search => @mock_document)
     end
 
     it "should not show user util links" do

data/spec/controllers/saved_searches_controller_spec.rb

@@ -1,14 +1,11 @@
 require 'spec_helper'
 
 describe SavedSearchesController do
-  include Devise::TestHelpers
 
   before(:all) do
     @one = Search.create
     @two = Search.create
     @three = Search.create
-
-
   end
 
   before(:each) do
@@ -36,4 +33,4 @@ describe SavedSearchesController do
 
 
 
-end
+end

data/spec/controllers/search_history_controller_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe SearchHistoryController do
-  include Devise::TestHelpers
 
   describe "index" do
     before(:all) do

data/spec/features/bookmarks_spec.rb

@@ -55,4 +55,18 @@ describe "Bookmarks" do
     click_link 'Cite'
     expect(page).to have_content 'Strong Medicine speaks'
   end
+  
+  it "should have an endnote export" do
+    visit catalog_path('2007020969')
+    click_button 'Bookmark'
+    visit "/bookmarks.endnote?q=" 
+    expect(page).to have_content " %@ 9780743297790"
+  end
+  
+  it "should have a refworks export" do
+    visit catalog_path('2007020969')
+    click_button 'Bookmark'
+    visit "/bookmarks.refworks_marc_txt?q=" 
+    expect(page).to have_content "LEADER 01490cam a2200361 a 4500001      2007020969"
+  end
 end