blacklight-spotlight 0.4.1 → 0.5.0

data/app/controllers/spotlight/concerns/application_controller.rb

@@ -1,26 +1,28 @@
 require 'spotlight'
 
-module Spotlight::Concerns
-  # Inherit from the host app's ApplicationController
-  # This will configure e.g. the layout used by the host
-  module ApplicationController
-    extend ActiveSupport::Concern
-    include Spotlight::Controller
-    
-    included do
-      layout 'spotlight/spotlight'
-      
-      helper Spotlight::ApplicationHelper
+module Spotlight
+  module Concerns
+    # Inherit from the host app's ApplicationController
+    # This will configure e.g. the layout used by the host
+    module ApplicationController
+      extend ActiveSupport::Concern
+      include Spotlight::Controller
 
-      rescue_from CanCan::AccessDenied do |exception|
-        if current_exhibit and !can? :read, current_exhibit
-          # Try to authenticate the user
-          authenticate_user!
-  
-          # If that fails (and we end up back here), offer a 404 error instead
-          raise ActionController::RoutingError.new('Not Found')
-        else
-          redirect_to main_app.root_url, :alert => exception.message
+      included do
+        layout 'spotlight/spotlight'
+
+        helper Spotlight::ApplicationHelper
+
+        rescue_from CanCan::AccessDenied do |exception|
+          if current_exhibit && !can?(:read, current_exhibit)
+            # Try to authenticate the user
+            authenticate_user!
+
+            # If that fails (and we end up back here), offer a 404 error instead
+            fail ActionController::RoutingError, 'Not Found'
+          else
+            redirect_to main_app.root_url, alert: exception.message
+          end
         end
       end
     end

data/app/controllers/spotlight/concerns/catalog_search_context.rb

@@ -0,0 +1,44 @@
+module Spotlight
+  module Concerns
+    ##
+    # Search context helpers
+    module CatalogSearchContext
+      protected
+
+      def current_page_context
+        @current_page_context ||= if current_search_session_from_home_page?
+                                    current_exhibit.home_page if can? :read, current_exhibit.home_page
+                                  elsif current_search_session_from_page?
+                                    page_id = current_search_session.query_params['id']
+                                    current_exhibit.pages.accessible_by(current_ability).find(page_id) if page_id
+                                  end
+      end
+
+      def current_browse_category
+        @current_browse_category ||= if current_search_session_from_browse_category?
+                                       search_id = current_search_session.query_params['id']
+                                       current_exhibit.searches.accessible_by(current_ability).find(search_id)
+                                     end
+      end
+
+      def current_search_session_from_browse_category?
+        current_search_session &&
+          current_search_session.query_params['action'] == 'show' &&
+          current_search_session.query_params['controller'] == 'spotlight/browse' &&
+          current_search_session.query_params['id']
+      end
+
+      def current_search_session_from_page?
+        current_search_session &&
+          current_search_session.query_params['action'] == 'show' &&
+          current_search_session.query_params['controller'].ends_with?('_pages')
+      end
+
+      def current_search_session_from_home_page?
+        current_search_session &&
+          current_search_session.query_params['action'] == 'show' &&
+          current_search_session.query_params['controller'] == 'spotlight/home_pages'
+      end
+    end
+  end
+end

data/app/controllers/spotlight/confirmations_controller.rb

@@ -1,9 +1,12 @@
 module Spotlight
+  ##
+  # Custom {Devise::ConfirmationsController} with spotlight behaviors
   class ConfirmationsController < Devise::ConfirmationsController
     layout 'spotlight/spotlight'
+
     protected
 
-    def after_confirmation_path_for(resource_name, resource)
+    def after_confirmation_path_for(_resource_name, resource)
       if signed_in?
         exhibit_root_path(resource.exhibit)
       else
@@ -11,7 +14,7 @@ module Spotlight
       end
     end
 
-    def after_resending_confirmation_instructions_path_for(resource_name)
+    def after_resending_confirmation_instructions_path_for(_resource_name)
       main_app.root_path
     end
   end

data/app/controllers/spotlight/contact_forms_controller.rb

@@ -1,16 +1,15 @@
 module Spotlight
+  ##
+  # Controller for routing exhibit feedback from users
   class ContactFormsController < Spotlight::ApplicationController
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+    before_action :build_contact_form
 
     def new
-      @contact_form = Spotlight::ContactForm.new :current_url => request.referer
+      @contact_form.current_url = request.referer
     end
 
     def create
-      @contact_form = Spotlight::ContactForm.new(contact_form_params)
-      @contact_form.current_exhibit = current_exhibit
-      @contact_form.request = request
-
       if @contact_form.valid?
         if @contact_form.respond_to? :deliver_now
           @contact_form.deliver_now
@@ -20,12 +19,19 @@ module Spotlight
 
         redirect_to :back, notice: t(:'helpers.submit.contact_form.created')
       else
-        render 'new' 
+        render 'new'
       end
-      
     end
 
     protected
+
+    def build_contact_form
+      @contact_form = Spotlight::ContactForm.new(contact_form_params)
+      @contact_form.current_exhibit = current_exhibit
+      @contact_form.request = request
+      @contact_form
+    end
+
     def contact_form_params
       params.require(:contact_form).permit(:name, :email, :message, :current_url)
     end

data/app/controllers/spotlight/contacts_controller.rb

@@ -1,9 +1,12 @@
 module Spotlight
+  ##
+  # CRUD actions for exhibit curator contacts (not to be confused with
+  # email addresses for receiving feedback messages, see {Spotlight::ExhibitsController})
   class ContactsController < Spotlight::ApplicationController
-    before_filter :authenticate_user!
-    load_and_authorize_resource :exhibit, class: "Spotlight::Exhibit"
+    before_action :authenticate_user!
+    load_and_authorize_resource :exhibit, class: 'Spotlight::Exhibit'
     load_and_authorize_resource through: :exhibit
-    before_filter :attach_breadcrumbs
+    before_action :attach_breadcrumbs
 
     def new
       add_breadcrumb t(:'helpers.action.spotlight/contact.create'), new_exhibit_contact_path(@exhibit)
@@ -43,7 +46,13 @@ module Spotlight
     end
 
     def contact_params
-      params.require(:contact).permit(:name, :avatar, :avatar_crop_x, :avatar_crop_y, :avatar_crop_w, :avatar_crop_h, contact_info: Spotlight::Contact.fields.keys)
+      params.require(:contact).permit(:name,
+                                      :avatar,
+                                      :avatar_crop_x,
+                                      :avatar_crop_y,
+                                      :avatar_crop_w,
+                                      :avatar_crop_h,
+                                      contact_info: Spotlight::Contact.fields.keys)
     end
   end
 end

data/app/controllers/spotlight/custom_fields_controller.rb

@@ -1,52 +1,60 @@
-class Spotlight::CustomFieldsController < Spotlight::ApplicationController
-  before_filter :authenticate_user!
-  
-  load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
-  load_and_authorize_resource through: :exhibit
-  before_filter :attach_breadcrumbs, only: [:new, :edit]
-
-  def new
-    @custom_field.field_type ||= "text"
-    add_breadcrumb t(:'helpers.action.spotlight/custom_field.create'), new_exhibit_custom_field_path(@exhibit)
-  end
+module Spotlight
+  ##
+  # CRUD actions for exhibit custom field management.
+  class CustomFieldsController < Spotlight::ApplicationController
+    before_action :authenticate_user!
+
+    load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+    load_and_authorize_resource through: :exhibit
+    before_action :attach_breadcrumbs, only: [:new, :edit]
+
+    def new
+      @custom_field.field_type ||= 'text'
+      add_breadcrumb t(:'helpers.action.spotlight/custom_field.create'), new_exhibit_custom_field_path(@exhibit)
+    end
 
-  def edit
-    add_breadcrumb @custom_field.label, edit_exhibit_custom_field_path(@custom_field.exhibit, @custom_field)
-  end
+    def edit
+      add_breadcrumb @custom_field.label, edit_exhibit_custom_field_path(@custom_field.exhibit, @custom_field)
+    end
 
-  def create
-    @custom_field.attributes = custom_field_params
-    @custom_field.exhibit = current_exhibit
+    def create
+      @custom_field.attributes = custom_field_params
+      @custom_field.exhibit = current_exhibit
 
-    if @custom_field.save
-      redirect_to exhibit_edit_metadata_path(@custom_field.exhibit), notice: t(:'helpers.submit.custom_field.created', model: @custom_field.class.model_name.human.downcase)
-    else
-      render action: 'new'
+      if @custom_field.save
+        redirect_to edit_exhibit_metadata_configuration_path(@custom_field.exhibit),
+                    notice: t(:'helpers.submit.custom_field.created', model: @custom_field.class.model_name.human.downcase)
+      else
+        render action: 'new'
+      end
     end
-  end
 
-  def update
-    if @custom_field.update custom_field_params
-      redirect_to exhibit_edit_metadata_path(@custom_field.exhibit), notice: t(:'helpers.submit.custom_field.updated', model: @custom_field.class.model_name.human.downcase)
-    else
-      render action: 'edit'
+    def update
+      if @custom_field.update custom_field_params
+        redirect_to edit_exhibit_metadata_configuration_path(@custom_field.exhibit),
+                    notice: t(:'helpers.submit.custom_field.updated', model: @custom_field.class.model_name.human.downcase)
+      else
+        render action: 'edit'
+      end
     end
-  end
 
-  def destroy
-    @custom_field.destroy
-    redirect_to exhibit_edit_metadata_path(@custom_field.exhibit), notice: t(:'helpers.submit.custom_field.destroyed', model: @custom_field.class.model_name.human.downcase)
-  end
+    def destroy
+      @custom_field.destroy
 
-  protected
+      redirect_to edit_exhibit_metadata_configuration_path(@custom_field.exhibit),
+                  notice: t(:'helpers.submit.custom_field.destroyed', model: @custom_field.class.model_name.human.downcase)
+    end
 
-  def attach_breadcrumbs
-    add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
-    add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
-    add_breadcrumb t(:'spotlight.blacklight_configurations.edit_metadata_fields.header'), exhibit_edit_metadata_path(@exhibit)
-  end
+    protected
 
-  def custom_field_params
-    params.require(:custom_field).permit(:label, :short_description, :field_type)
+    def attach_breadcrumbs
+      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
+      add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
+      add_breadcrumb t(:'spotlight.metadata_configurations.edit.header'), edit_exhibit_metadata_configuration_path(@exhibit)
+    end
+
+    def custom_field_params
+      params.require(:custom_field).permit(:label, :short_description, :field_type)
+    end
   end
 end

data/app/controllers/spotlight/dashboards_controller.rb

@@ -1,22 +1,26 @@
 module Spotlight
+  ##
+  # Exhibit dashboard controller
   class DashboardsController < Spotlight::ApplicationController
-    before_filter :authenticate_user!
+    before_action :authenticate_user!
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
 
     include Spotlight::Base
     include Spotlight::Catalog::AccessControlsEnforcement
 
+    before_action only: [:show] do
+      blacklight_config.view.reject! { |_k, _v| true }
+      blacklight_config.view.admin_table.partials = ['index_compact']
+      blacklight_config.view.admin_table.document_actions = []
+    end
+
     def show
       authorize! :curate, @exhibit
 
       @pages = @exhibit.pages.recent.limit(5)
       @solr_documents = load_recent_solr_documents 5
-      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
-      add_breadcrumb t(:'spotlight.curation.sidebar.dashboard'), exhibit_dashboard_path(@exhibit)
 
-      self.blacklight_config.view.reject! { |k,v| true }
-      self.blacklight_config.view.admin_table.partials = ['index_compact']
-      self.blacklight_config.view.admin_table.document_actions = []
+      attach_dashboard_breadcrumbs
     end
 
     def _prefixes
@@ -25,9 +29,14 @@ module Spotlight
 
     protected
 
-    def load_recent_solr_documents count
+    def attach_dashboard_breadcrumbs
+      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
+      add_breadcrumb t(:'spotlight.curation.sidebar.dashboard'), exhibit_dashboard_path(@exhibit)
+    end
+
+    def load_recent_solr_documents(count)
       solr_params = { sort: "#{blacklight_config.index.timestamp_field} desc" }
-      @response, docs = get_search_results(solr_params)
+      @response, docs = search_results(solr_params, search_params_logic)
       docs.take(count)
     end
   end

data/app/controllers/spotlight/default_controller.rb

@@ -1,6 +1,8 @@
 module Spotlight
+  ##
+  # Shim controller to redirect engine root requests to
+  # an exhibit root
   class DefaultController < Spotlight::ApplicationController
-
     def index
       default = Spotlight::Exhibit.default
       redirect_to exhibit_root_path(default)

data/app/controllers/spotlight/exhibits_controller.rb

@@ -1,84 +1,91 @@
-class Spotlight::ExhibitsController < Spotlight::ApplicationController
-  before_filter :authenticate_user!
-  include Blacklight::SearchHelper
+module Spotlight
+  ##
+  # Administrative CRUD actions for an exhibit
+  class ExhibitsController < Spotlight::ApplicationController
+    before_action :authenticate_user!
+    include Blacklight::SearchHelper
 
-  load_and_authorize_resource
+    load_and_authorize_resource
 
-  def new
-    build_initial_exhibit_contact_emails
-  end
+    def new
+      build_initial_exhibit_contact_emails
+    end
 
-  def process_import
-    @exhibit.import(JSON.parse(import_exhibit_params.read))
-    if @exhibit.save
-      redirect_to spotlight.exhibit_dashboard_path(@exhibit), notice: t(:'helpers.submit.exhibit.updated', model: @exhibit.class.model_name.human.downcase)
-    else
-      render action: :import
+    def process_import
+      @exhibit.import(JSON.parse(import_exhibit_params.read))
+      if @exhibit.save
+        redirect_to spotlight.exhibit_dashboard_path(@exhibit), notice: t(:'helpers.submit.exhibit.updated', model: @exhibit.class.model_name.human.downcase)
+      else
+        render action: :import
+      end
     end
-  end
 
-  def create
-    @exhibit.attributes = exhibit_params
+    def create
+      @exhibit.attributes = exhibit_params
 
-    if @exhibit.save
-      redirect_to spotlight.exhibit_dashboard_path(@exhibit), notice: t(:'helpers.submit.exhibit.created', model: @exhibit.class.model_name.human.downcase)
-    else
-      render action: :new
+      if @exhibit.save
+        redirect_to spotlight.exhibit_dashboard_path(@exhibit), notice: t(:'helpers.submit.exhibit.created', model: @exhibit.class.model_name.human.downcase)
+      else
+        render action: :new
+      end
     end
-  end
 
-  def show
-    respond_to do |format|
-      format.json do
-        authorize! :export, @exhibit
-        send_data JSON.pretty_generate(Spotlight::ExhibitExportSerializer.new(@exhibit).as_json), type: 'application/json', disposition: 'attachment', filename: "#{@exhibit.friendly_id}-export.json"
+    def show
+      respond_to do |format|
+        format.json do
+          authorize! :export, @exhibit
+          send_data JSON.pretty_generate(Spotlight::ExhibitExportSerializer.new(@exhibit).as_json),
+                    type: 'application/json',
+                    disposition: 'attachment',
+                    filename: "#{@exhibit.friendly_id}-export.json"
+        end
       end
     end
-  end
 
-  def edit
-    add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
-    add_breadcrumb t(:'spotlight.administration.sidebar.header'), exhibit_dashboard_path(@exhibit)
-    add_breadcrumb t(:'spotlight.administration.sidebar.settings'), edit_exhibit_path(@exhibit)
-    build_initial_exhibit_contact_emails
-  end
+    def edit
+      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), @exhibit
+      add_breadcrumb t(:'spotlight.administration.sidebar.header'), exhibit_dashboard_path(@exhibit)
+      add_breadcrumb t(:'spotlight.administration.sidebar.settings'), edit_exhibit_path(@exhibit)
+      build_initial_exhibit_contact_emails
+    end
 
-  def update
-    if @exhibit.update(exhibit_params)
-      redirect_to edit_exhibit_path(@exhibit), notice: t(:'helpers.submit.exhibit.updated', model: @exhibit.class.model_name.human.downcase)
-    else
-      flash[:alert] = @exhibit.errors.full_messages.join("<br>".html_safe)
-      render action: :edit
+    def update
+      if @exhibit.update(exhibit_params)
+        redirect_to edit_exhibit_path(@exhibit), notice: t(:'helpers.submit.exhibit.updated', model: @exhibit.class.model_name.human.downcase)
+      else
+        flash[:alert] = @exhibit.errors.full_messages.join('<br>'.html_safe)
+        render action: :edit
+      end
     end
-  end
 
-  def destroy
-    @exhibit.destroy
+    def destroy
+      @exhibit.destroy
 
-    redirect_to main_app.root_url, notice: t(:'helpers.submit.exhibit.destroyed', model: @exhibit.class.model_name.human.downcase)
-  end
+      redirect_to main_app.root_url, notice: t(:'helpers.submit.exhibit.destroyed', model: @exhibit.class.model_name.human.downcase)
+    end
 
-  protected
+    protected
 
-  def current_exhibit
-    @exhibit if @exhibit and @exhibit.persisted?
-  end
+    def current_exhibit
+      @exhibit if @exhibit && @exhibit.persisted?
+    end
 
-  def exhibit_params
-    params.require(:exhibit).permit(
-      :title,
-      :subtitle,
-      :description,
-      :published,
-      contact_emails_attributes: [:id, :email]
-    )
-  end
+    def exhibit_params
+      params.require(:exhibit).permit(
+        :title,
+        :subtitle,
+        :description,
+        :published,
+        contact_emails_attributes: [:id, :email]
+      )
+    end
 
-  def import_exhibit_params
-    params.require(:file)
-  end
+    def import_exhibit_params
+      params.require(:file)
+    end
 
-  def build_initial_exhibit_contact_emails
-    @exhibit.contact_emails.build unless @exhibit.contact_emails.present?
+    def build_initial_exhibit_contact_emails
+      @exhibit.contact_emails.build unless @exhibit.contact_emails.present?
+    end
   end
 end