blacklight 6.14.0 → 7.0.0

data/app/builders/blacklight/action_builder.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # Dynamically creates methods on the given controller (typically CatalogController)
+  # for handling configured show tools
+  class ActionBuilder
+    def initialize(klass, name, opts)
+      @klass = klass
+      @name = name
+      @opts = opts
+    end
+
+    attr_reader :klass, :name, :opts
+
+    # Define a simple action handler for the tool as long as the method
+    # doesn't already exist or the `:define_method` option is not `false`
+    def build
+      return if skip?
+
+      callback = opts.fetch(:callback, nil).inspect
+      validator = opts.fetch(:validator, nil).inspect
+      klass.class_eval <<EORUBY, __FILE__, __LINE__ + 1
+          def #{name}
+            @response, @documents = action_documents
+
+            if request.post? && #{callback} &&
+               (#{validator}.blank? || send(#{validator}))
+
+              send(#{callback}, @documents)
+
+              flash[:success] ||= I18n.t("blacklight.#{name}.success", default: nil)
+
+              respond_to do |format|
+                format.html do
+                  return render "#{name}_success" if request.xhr?
+                  redirect_to action_success_redirect_path
+                end
+              end
+            else
+              respond_to do |format|
+                format.html do
+                  return render layout: false if request.xhr?
+                  # Otherwise draw the full page
+                end
+              end
+            end
+          end
+EORUBY
+    end
+
+    private
+
+    def skip?
+      klass.method_defined?(name) || opts[:define_method] == false
+    end
+  end
+end

data/app/controllers/bookmarks_controller.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
-class BookmarksController < CatalogController  
+class BookmarksController < CatalogController
   include Blacklight::Bookmarks
-end 
+end

data/app/controllers/catalog_controller.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
-class CatalogController < ApplicationController  
+class CatalogController < ApplicationController
   include Blacklight::Catalog
-end 
+end

data/app/controllers/concerns/blacklight/base.rb

@@ -3,38 +3,5 @@ module Blacklight::Base
   extend ActiveSupport::Concern
 
   include Blacklight::Configurable
-  include Blacklight::SearchHelper
-
   include Blacklight::SearchContext
-
-  included do
-    # When Blacklight::Exceptions::InvalidRequest is raised, the rsolr_request_error method is executed.
-    # The index action will more than likely throw this one.
-    # Example, when the standard query parser is used, and a user submits a "bad" query.
-    rescue_from Blacklight::Exceptions::InvalidRequest, with: :handle_request_error if respond_to? :rescue_from
-  end
-
-  protected
-
-  # when The index throws an error (Blacklight::Exceptions::InvalidRequest), this method is executed.
-  def handle_request_error(exception)
-    if Rails.env.development? || Rails.env.test?
-      raise exception # Rails own code will catch and give usual Rails error page with stack trace
-    else
-
-      flash_notice = I18n.t('blacklight.search.errors.request_error')
-
-      # If there are errors coming from the index page, we want to trap those sensibly
-
-      if flash[:notice] == flash_notice
-        logger.error "Cowardly aborting rsolr_request_error exception handling, because we redirected to a page that raises another exception"
-        raise exception
-      end
-
-      logger.error exception
-
-      flash[:notice] = flash_notice 
-      redirect_to root_path
-    end
-  end
 end

data/app/controllers/concerns/blacklight/bookmarks.rb

@@ -8,7 +8,6 @@ module Blacklight::Bookmarks
     ##
     # Give Bookmarks access to the CatalogController configuration
     include Blacklight::Configurable
-    include Blacklight::SearchHelper
     include Blacklight::TokenBasedUser
 
     copy_blacklight_config_from(CatalogController)
@@ -25,7 +24,7 @@ module Blacklight::Bookmarks
   def action_documents
     bookmarks = token_or_current_or_guest_user.bookmarks
     bookmark_ids = bookmarks.collect { |b| b.document_id.to_s }
-    fetch(bookmark_ids)
+    search_service.fetch(bookmark_ids)
   end
 
   def action_success_redirect_path
@@ -41,13 +40,13 @@ module Blacklight::Bookmarks
   def index
     @bookmarks = token_or_current_or_guest_user.bookmarks
     bookmark_ids = @bookmarks.collect { |b| b.document_id.to_s }
-
-    @response, @document_list = fetch(bookmark_ids)
+    @response, deprecated_document_list = search_service.fetch(bookmark_ids)
+    @document_list = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(deprecated_document_list, "The @document_list instance variable is now deprecated and will be removed in Blacklight 8.0")
 
     respond_to do |format|
-      format.html { }
-      format.rss  { render :layout => false }
-      format.atom { render :layout => false }
+      format.html {}
+      format.rss  { render layout: false }
+      format.atom { render layout: false }
       format.json do
         render json: render_search_results_as_json
       end
@@ -71,7 +70,7 @@ module Blacklight::Bookmarks
   # is simpler.
   def create
     @bookmarks = if params[:bookmarks]
-                   params[:bookmarks]
+                   permit_bookmarks[:bookmarks]
                  else
                    [{ document_id: params[:id], document_type: blacklight_config.document_model.to_s }]
                  end
@@ -79,48 +78,47 @@ module Blacklight::Bookmarks
     current_or_guest_user.save! unless current_or_guest_user.persisted?
 
     success = @bookmarks.all? do |bookmark|
-       current_or_guest_user.bookmarks.where(bookmark).exists? || current_or_guest_user.bookmarks.create(bookmark)
+      current_or_guest_user.bookmarks.where(bookmark).exists? || current_or_guest_user.bookmarks.create(bookmark)
     end
 
     if request.xhr?
-      success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(plain: "", status: "500")
+      success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count } }) : render(plain: "", status: "500")
     else
       if @bookmarks.any? && success
-        flash[:notice] = I18n.t('blacklight.bookmarks.add.success', :count => @bookmarks.length)
+        flash[:notice] = I18n.t('blacklight.bookmarks.add.success', count: @bookmarks.length)
       elsif @bookmarks.any?
-        flash[:error] = I18n.t('blacklight.bookmarks.add.failure', :count => @bookmarks.length)
+        flash[:error] = I18n.t('blacklight.bookmarks.add.failure', count: @bookmarks.length)
       end
 
-      if respond_to? :redirect_back
-        redirect_back fallback_location: bookmarks_path
-      else
-        # Deprecated in Rails 5.0
-        redirect_to :back
-      end
+      redirect_back fallback_location: bookmarks_path
     end
   end
 
   # Beware, :id is the Solr document_id, not the actual Bookmark id.
   # idempotent, as DELETE is supposed to be.
   def destroy
-    bookmark = current_or_guest_user.bookmarks.find_by(document_id: params[:id], document_type: blacklight_config.document_model.to_s)
+    @bookmarks =
+      if params[:bookmarks]
+        permit_bookmarks[:bookmarks]
+      else
+        [{ document_id: params[:id], document_type: blacklight_config.document_model.to_s }]
+      end
+
+    success = @bookmarks.all? do |bookmark|
+      bookmark = current_or_guest_user.bookmarks.find_by(bookmark)
+      bookmark && bookmark.delete && bookmark.destroyed?
+    end
 
-    if bookmark && bookmark.delete && bookmark.destroyed?
+    if success
       if request.xhr?
-        render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }})
-      elsif respond_to? :redirect_back
-        redirect_back fallback_location: bookmarks_path, notice: I18n.t('blacklight.bookmarks.remove.success')
+        render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count } })
       else
-        # Deprecated in Rails 5.0
-        redirect_to :back, notice: I18n.t('blacklight.bookmarks.remove.success')
+        redirect_back fallback_location: bookmarks_path, notice: I18n.t('blacklight.bookmarks.remove.success')
       end
     elsif request.xhr?
       head 500 # ajaxy request needs no redirect and should not have flash set
-    elsif respond_to? :redirect_back
-      redirect_back fallback_location: bookmarks_path, flash: { error: I18n.t('blacklight.bookmarks.remove.failure') }
     else
-      # Deprecated in Rails 5.0
-      redirect_to :back, flash: { error: I18n.t('blacklight.bookmarks.remove.failure') }
+      redirect_back fallback_location: bookmarks_path, flash: { error: I18n.t('blacklight.bookmarks.remove.failure') }
     end
   end
 
@@ -130,18 +128,23 @@ module Blacklight::Bookmarks
     else
       flash[:error] = I18n.t('blacklight.bookmarks.clear.failure')
     end
-    redirect_to :action => "index"
+    redirect_to action: "index"
   end
 
-  protected
+  private
 
   def verify_user
-    unless current_or_guest_user or (action == "index" and token_or_current_or_guest_user)
-      flash[:notice] = I18n.t('blacklight.bookmarks.need_login') and raise Blacklight::Exceptions::AccessDenied
+    unless current_or_guest_user || (action == "index" && token_or_current_or_guest_user)
+      flash[:notice] = I18n.t('blacklight.bookmarks.need_login')
+      raise Blacklight::Exceptions::AccessDenied
     end
   end
 
   def start_new_search_session?
     action_name == "index"
   end
+
+  def permit_bookmarks
+    params.permit(bookmarks: [:document_id, :document_type])
+  end
 end