blacklight 5.7.2 → 5.8.0

data/lib/blacklight/solr_repository.rb

@@ -0,0 +1,69 @@
+module Blacklight
+  class SolrRepository
+    attr_accessor :blacklight_config, :blacklight_solr
+
+    # ActiveSupport::Benchmarkable requires a logger method
+    attr_accessor :logger
+
+    include ActiveSupport::Benchmarkable
+
+    def initialize blacklight_config
+      @blacklight_config = blacklight_config
+    end
+
+    ##
+    # Find a single solr document result (by id) using the document configuration
+    # @param [String] document's unique key value
+    # @param [Hash] additional solr query parameters
+    def find id, params = {}
+      solr_response = send_and_receive blacklight_config.document_solr_path || blacklight_config.solr_path, {qt: blacklight_config.document_solr_request_handler}.merge(blacklight_config.default_document_solr_params.merge(params).merge(blacklight_config.document_unique_id_param => id))
+      raise Blacklight::Exceptions::InvalidSolrID.new if solr_response.documents.empty?
+      solr_response
+    end
+
+    ##
+    # Execute a search query against solr
+    # @param [Hash] solr query parameters
+    def search params = {}
+      send_and_receive blacklight_config.solr_path, { qt: blacklight_config.qt }.merge(params)
+    end
+
+    ##
+    # Execute a solr query
+    # @see [RSolr::Client#send_and_receive]
+    # @overload find(solr_path, params)
+    #   Execute a solr query at the given path with the parameters
+    #   @param [String] solr path (defaults to blacklight_config.solr_path)
+    #   @param [Hash] parameters for RSolr::Client#send_and_receive
+    # @overload find(params)
+    #   @param [Hash] parameters for RSolr::Client#send_and_receive
+    # @return [Blacklight::SolrResponse] the solr response object
+    def send_and_receive(path, solr_params = {})
+      benchmark("Solr fetch", level: :debug) do
+        key = blacklight_config.http_method == :post ? :data : :params
+        res = blacklight_solr.send_and_receive(path, {key=>solr_params.to_hash, method:blacklight_config.http_method})
+
+        solr_response = blacklight_config.solr_response_model.new(res, solr_params, solr_document_model: blacklight_config.solr_document_model)
+
+        Rails.logger.debug("Solr query: #{solr_params.inspect}")
+        Rails.logger.debug("Solr response: #{solr_response.inspect}") if defined?(::BLACKLIGHT_VERBOSE_LOGGING) and ::BLACKLIGHT_VERBOSE_LOGGING
+        solr_response
+      end
+    rescue Errno::ECONNREFUSED => e
+      raise Blacklight::Exceptions::ECONNREFUSED.new("Unable to connect to Solr instance using #{blacklight_solr.inspect}")
+    end
+
+    def blacklight_solr
+      @blacklight_solr ||= RSolr.connect(blacklight_solr_config)
+    end
+
+    protected
+    def blacklight_solr_config
+      @blacklight_solr_config ||= Blacklight.solr_config
+    end
+
+    def logger
+      @logger ||= Rails.logger if defined? Rails
+    end
+  end
+end

data/lib/blacklight/token_based_user.rb

@@ -0,0 +1,58 @@
+module Blacklight::TokenBasedUser
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :encrypt_user_id
+
+    rescue_from Blacklight::Exceptions::ExpiredSessionToken do
+      head :unauthorized
+    end
+
+  end
+
+  protected
+
+  def token_or_current_or_guest_user
+    token_user || current_or_guest_user
+  end
+
+  def token_user
+    @token_user ||= if params[:encrypted_user_id]
+      user_id = decrypt_user_id params[:encrypted_user_id]
+      User.find(user_id)
+    else
+      nil
+    end
+  end
+
+  # Used for #export action, with encrypted user_id.
+  def decrypt_user_id(encrypted_user_id)
+    user_id, timestamp = message_encryptor.decrypt_and_verify(encrypted_user_id)
+
+    if timestamp < 1.hour.ago
+      raise Blacklight::Exceptions::ExpiredSessionToken.new
+    end
+
+    user_id
+  end
+
+  # Used for #export action with encrypted user_id, available
+  # as a helper method for views.
+  def encrypt_user_id(user_id)
+    message_encryptor.encrypt_and_sign([user_id, Time.now])
+  end
+
+  ##
+  # This method provides Rails 3 compatibility to our message encryptor.
+  # When we drop support for Rails 3, we can just use the AS::KeyGenerator
+  # directly instead of this helper.
+  def export_secret_token salt
+    OpenSSL::PKCS5.pbkdf2_hmac_sha1(Blacklight.secret_key, salt, 1000, 64)
+  end
+
+  def message_encryptor
+    derived_secret = export_secret_token("encrypted user session key")
+    ActiveSupport::MessageEncryptor.new(derived_secret)
+  end
+
+end

data/lib/blacklight/utils.rb

@@ -13,6 +13,10 @@ module Blacklight
       def [](key)
         send key
       end
+
+      def respond_to? method, *args
+        super(method, *args) || has_key?(method.to_sym)
+      end
     end
 
     ##
@@ -40,7 +44,11 @@ module Blacklight
     # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
     def merge! other_hash
       @table.merge!((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
-    end 
+    end
+
+    def deep_dup
+      self.class.new @table.deep_dup
+    end
   end
 
 
@@ -119,6 +127,10 @@ module Blacklight
       set_default_proc!
     end
 
+    def deep_dup
+      self.class.new self.nested_class, @table.deep_dup
+    end
+
     def select *args, &block
       self.class.new nested_class, to_h.select(*args, &block)
     end

data/lib/generators/blacklight/install_generator.rb

@@ -55,14 +55,13 @@ module Blacklight
     end
 
     # Add Blacklight to the application controller
-    def inject_blacklight_controller_behavior    
-  #    prepend_file("app/controllers/application_controller.rb", "require 'blacklight/controller'\n\n")
+    def inject_blacklight_controller_behavior
       inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
-        "  # 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" +
-          "  layout 'blacklight'\n\n"
+        "  # 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" +
+        "  layout 'blacklight'\n\n"
       end
     end
     

data/spec/controllers/alternate_controller_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe AlternateController do
+  describe "the search results tools" do
+    it "should inherit tools from CatalogController" do
+      expect(AlternateController.blacklight_config.index.document_actions).to have_key(:bookmark)
+    end
+
+    context "when deleting partials from the AlternateController" do
+      before do
+        AlternateController.blacklight_config.index.document_actions.delete(:bookmark)
+      end
+      it "should not affect the CatalogController" do
+        expect(AlternateController.blacklight_config.index.document_actions).to be_empty
+        expect(CatalogController.blacklight_config.index.document_actions).to have_key(:bookmark)
+      end
+    end
+  end
+end

data/spec/controllers/catalog_controller_spec.rb

@@ -28,6 +28,33 @@ describe CatalogController do
         expect(session[:history]).to be_empty
       end
 
+      describe "preferred view" do
+        it "should save the view choice" do
+          get :index, q: 'foo', view: 'gallery'
+          expect(session[:preferred_view]).to eq 'gallery'
+        end
+
+        context "when they have a preferred view" do
+          before do
+            session[:preferred_view] = 'gallery'
+          end
+
+          context "and no view is specified" do
+            it "should use the saved preference" do
+              get :index, q: 'foo'
+              expect(controller.params[:view]).to eq 'gallery'
+            end
+          end
+
+          context "and a view is specified" do
+            it "should use the saved preference" do
+              get :index, q: 'foo', view: 'list'
+              expect(controller.params[:view]).to eq 'list'
+            end
+          end
+        end
+      end
+
       # check each user manipulated parameter
       it "should have docs and facets for query with results", :integration => true do
         get :index, q: user_query
@@ -425,9 +452,9 @@ describe CatalogController do
         expect(request.flash[:error]).to be_nil
         expect(request).to redirect_to(catalog_path(doc_id))
       end
-      it "should render email_sent for XHR requests" do
+      it "should render email_success for XHR requests" do
         xhr :post, :email, :id => doc_id, :to => 'test_email@projectblacklight.org'
-        expect(request).to render_template 'email_sent'
+        expect(request).to render_template 'email_success'
         expect(request.flash[:success]).to eq "Email Sent"
       end
     end
@@ -465,9 +492,9 @@ describe CatalogController do
         expect(request).to redirect_to(catalog_path(doc_id))
       end
 
-      it "should render sms_sent template for XHR requests" do
+      it "should render sms_success template for XHR requests" do
         xhr :post, :sms, :id => doc_id, :to => '5555555555', :carrier => 'txt.att.net'
-        expect(request).to render_template 'sms_sent'
+        expect(request).to render_template 'sms_success'
         expect(request.flash[:success]).to eq "SMS Sent"
       end
     end
@@ -665,6 +692,64 @@ describe CatalogController do
     end
   end
 
+  describe "#add_show_tools_partial" do
+    before do
+      CatalogController.add_show_tools_partial(:like, callback: :perform_like, validator: :validate_like_params)
+      allow(controller).to receive(:perform_like)
+      allow(controller).to receive(:catalog_path).and_return('catalog/1')
+      Rails.application.routes.draw do
+        get 'catalog/like', as: :catalog_like
+      end
+    end
+ 
+    after do
+      CatalogController.blacklight_config.show.document_actions.delete(:like)
+      Rails.application.reload_routes!
+    end
+
+    it "should add the action to a list" do
+      expect(CatalogController.blacklight_config.show.document_actions).to have_key(:like)
+    end
+
+    it "should define the action method" do
+      expect(controller.respond_to?(:like)).to be true
+    end
+
+    describe "when posting to the action" do
+      describe "with success" do
+        before do
+          allow(controller).to receive(:validate_like_params).and_return(true)
+          post :like
+        end
+        it "should call the supplied method on post" do
+          expect(controller).to have_received(:perform_like) 
+        end
+      end
+
+      describe "with failure" do
+        describe "with invalid params" do
+          before { allow(controller).to receive(:validate_like_params).and_return(false) }
+          it "should not call the supplied method if validation failed" do
+            expect(controller).not_to have_received(:perform_like)
+          end
+        end
+      end
+    end
+  end
+
+  describe "search_action_url" do
+    it "should be the same as the catalog url" do
+      get :index, :page => 1
+      expect(controller.send(:search_action_url, q: "xyz")).to eq root_url(q: "xyz")
+    end
+  end
+
+  describe "search_facet_url" do
+    it "should be the same as the catalog url" do
+      get :index, :page => 1
+      expect(controller.send(:search_facet_url, id: "some_facet", page: 5)).to eq catalog_facet_url(id: "some_facet")
+    end
+  end
 end
 
 

data/spec/features/alternate_controller_spec.rb

@@ -31,6 +31,5 @@ describe "Alternate Controller Behaviors" do
     expect(page).to have_selector ".document-thumbnail"
     expect(page).to have_selector ".document-thumbnail a[data-context-href]"
     expect(page).to have_selector ".document-thumbnail a img"
-
   end
 end

data/spec/features/bookmarks_spec.rb

@@ -18,6 +18,7 @@ describe "Bookmarks" do
     expect(page).to have_content 'Cleared your bookmarks.'
     expect(page).to have_content 'You have no bookmarks'
   end
+
   it "add and remove bookmarks from search results" do
     sign_in 'user1'
     visit root_path
@@ -30,7 +31,7 @@ describe "Bookmarks" do
     click_button 'Remove bookmark'
     expect(page).to have_content 'Successfully removed bookmark.'
   end
-        
+
   it "should add and delete bookmarks from the show page" do
     sign_in 'user1'
     visit catalog_path('2007020969')
@@ -38,7 +39,7 @@ describe "Bookmarks" do
     click_button 'Remove bookmark'
     expect(page).to have_content 'Successfully removed bookmark.'
   end
-      
+
   it "should add bookmarks after a user logs in" do
     visit catalog_path('2007020969')
     click_button 'Bookmark'
@@ -55,18 +56,42 @@ describe "Bookmarks" do
     click_link 'Cite'
     expect(page).to have_content 'Strong Medicine speaks'
   end
-  
+
+  it "should cite items in current bookmarks page" do
+    visit catalog_path('2009373513')
+    click_button 'Bookmark'
+
+    visit catalog_path('2007020969')
+    click_button 'Bookmark'
+
+    visit "/bookmarks?per_page=1"
+    expect(page).to have_content 'Ci an zhou bian'
+    expect(page).not_to have_content 'Strong Medicine speaks'
+
+    click_link 'Cite'
+    expect(page).to have_content 'Ci an zhou bian'
+    expect(page).not_to have_content 'Strong Medicine speaks'
+
+    visit "/bookmarks?per_page=1"
+    click_link "2"
+    expect(page).to have_content 'Strong Medicine speaks'
+
+    click_link 'Cite'
+    expect(page).to have_content 'Strong Medicine speaks'
+    expect(page).not_to have_content 'Ci an zhou bian'
+  end
+
   it "should have an endnote export" do
     visit catalog_path('2007020969')
     click_button 'Bookmark'
-    visit "/bookmarks.endnote?q=" 
+    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=" 
+    visit "/bookmarks.refworks_marc_txt?q="
     expect(page).to have_content "LEADER 01490cam a2200361 a 4500001      2007020969"
   end
 end

data/spec/features/search_results_spec.rb

@@ -48,6 +48,17 @@ describe "Search Results" do
     search_for 'asdfghj'
     expect(page).to have_content "No results found for your search"
   end
+
+  it "should provide search hints if there are no results" do
+    visit root_path
+    fill_in "q", with: "inmul"
+    select "Author", from: "search_field"
+    click_button 'search'
+    expect(page).to have_content "No results found for your search"
+    expect(page).to have_content "you searched by Author"
+    click_on "try searching everything"
+    expect(page).to have_xpath("//a[contains(@href, #{77826928})]")
+  end
 end
 
 

data/spec/features/search_spec.rb

@@ -111,5 +111,10 @@ describe "Search Page" do
     expect(page).to have_content "Welcome!"
     expect(page).to_not have_selector "#q[value='history']"
   end
+
+  it "should gracefully handle searches with invalid facet parameters" do
+    visit root_path f: { missing_s: [1]}
+    expect(page).to have_content "No results found for your search"
+  end
 end
 

data/spec/helpers/blacklight_helper_spec.rb

@@ -111,37 +111,54 @@ describe BlacklightHelper do
   end
 
   describe "with a config" do
-    before do
-      @config = Blacklight::Configuration.new.configure do |config|
+    let(:config) do
+      Blacklight::Configuration.new.configure do |config|
         config.index.title_field = 'title_display'
         config.index.display_type_field = 'format'
       end
+    end
 
-      @document = SolrDocument.new('title_display' => "A Fake Document", 'id'=>'8')
-      allow(helper).to receive(:blacklight_config).and_return(@config)
+    let(:document) { SolrDocument.new('title_display' => "A Fake Document", 'id'=>'8') }
+
+    before do
+      config.add_show_tools_partial(:bookmark, partial: 'catalog/bookmark_control', if: :render_bookmarks_control?)
+      config.add_results_document_tool(:bookmark, partial: 'catalog/bookmark_control', if: :render_bookmarks_control?)
+      config.add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark', if: :render_bookmarks_control?)
+      allow(helper).to receive(:blacklight_config).and_return(config)
       allow(helper).to receive(:has_user_authentication_provider?).and_return(true)
       allow(helper).to receive(:current_or_guest_user).and_return(User.new)
       allow(helper).to receive_messages(current_bookmarks: [])
     end
+
+    describe "render_nav_actions" do
+      it "should render partials" do
+        buff = ''
+        helper.render_nav_actions { |config, item| buff << "<foo>#{item}</foo>" }
+        expect(buff).to have_selector "foo a#bookmarks_nav[href=\"/bookmarks\"]"
+        expect(buff).to have_selector "foo a span[data-role='bookmark-counter']", text: '0'
+      end
+    end
+
     describe "render_index_doc_actions" do
       it "should render partials" do
-        response = helper.render_index_doc_actions(@document)
+        response = helper.render_index_doc_actions(document)
         expect(response).to have_selector(".bookmark_toggle")
       end
     end
+
     describe "render_show_doc_actions" do
       it "should render partials" do
-        response = helper.render_show_doc_actions(@document)
+        response = helper.render_show_doc_actions(document)
         expect(response).to have_selector(".bookmark_toggle")
       end
     end
   end
-  
+
   describe "#should_render_index_field?" do
     before do
       allow(helper).to receive_messages(should_render_field?: true, document_has_value?: true)
     end
-    
+
     it "should be true" do
       expect(helper.should_render_index_field?(double, double)).to be true
     end
@@ -467,6 +484,7 @@ describe BlacklightHelper do
     let(:doc) { double }
     before do
       allow(helper).to receive_messages(document_partial_path_templates: [])
+      allow(helper).to receive_messages(document_index_view_type: 'index_header')
     end
     
     it "should get the document format from document_partial_name" do
@@ -593,4 +611,27 @@ describe BlacklightHelper do
       expect(response).to match /<div id="documents">/
     end
   end
+
+  describe "#presenter_class" do
+    before do
+      allow(helper).to receive(:blacklight_config).and_return(blacklight_config)
+    end
+
+    let :blacklight_config do
+      Blacklight::Configuration.new
+    end
+
+    let :presenter_class do
+      double
+    end
+
+    it "should use the value defined in the blacklight configuration" do
+      blacklight_config.document_presenter_class = presenter_class
+      expect(helper.presenter_class).to eq presenter_class
+    end
+
+    it "should default to Blacklight::DocumentPresenter" do
+      expect(helper.presenter_class).to eq Blacklight::DocumentPresenter
+    end
+  end
 end