blacklight-spotlight 0.4.1 → 0.5.0

data/app/controllers/spotlight/feature_pages_controller.rb

@@ -1,30 +1,40 @@
 module Spotlight
+  ##
+  # CRUD actions for feature pages
   class FeaturePagesController < PagesController
-
     load_and_authorize_resource through: :exhibit, instance_name: 'page'
-    before_filter :attach_breadcrumbs
+    before_action :attach_breadcrumbs
 
     protected
+
     def attach_breadcrumbs
       super
 
-      if action_name == 'edit'
-        add_breadcrumb t(:'spotlight.curation.sidebar.feature_pages'), exhibit_feature_pages_path(@exhibit)
-      end
-
       if @page
-        add_breadcrumb @page.parent_page.title, [@page.exhibit, @page.parent_page] unless @page.top_level_page?
-        add_breadcrumb @page.title, action_name == 'edit' ? [:edit, @page.exhibit, @page] : [@page.exhibit, @page]
+        attach_page_breadcrumbs
       elsif action_name == 'index'
-        add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
+        attach_index_breadcrumbs
+      end
+    end
+
+    def attach_page_breadcrumbs
+      if action_name == 'edit'
         add_breadcrumb t(:'spotlight.curation.sidebar.feature_pages'), exhibit_feature_pages_path(@exhibit)
       end
+
+      add_breadcrumb @page.parent_page.title, [@page.exhibit, @page.parent_page] unless @page.top_level_page?
+      add_breadcrumb @page.title, action_name == 'edit' ? [:edit, @page.exhibit, @page] : [@page.exhibit, @page]
+    end
+
+    def attach_index_breadcrumbs
+      add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
+      add_breadcrumb t(:'spotlight.curation.sidebar.feature_pages'), exhibit_feature_pages_path(@exhibit)
     end
 
     def update_all_page_params
       params.require(:exhibit).permit(
-        "feature_pages_attributes" => page_attributes,
-        "home_page_attributes" => [:id, :title, :display_title]
+        'feature_pages_attributes' => page_attributes,
+        'home_page_attributes' => [:id, :title, :display_title]
       )
     end
 

data/app/controllers/spotlight/home_pages_controller.rb

@@ -1,11 +1,13 @@
 module Spotlight
+  ##
+  # CRUD actions for the exhibit home page
   class HomePagesController < Spotlight::PagesController
     include Blacklight::SearchHelper
     include Spotlight::Catalog
 
     load_and_authorize_resource through: :exhibit, singleton: true, instance_name: 'page'
 
-    before_filter :attach_breadcrumbs, except: :show
+    before_action :attach_breadcrumbs, except: :show
 
     def edit
       add_breadcrumb t(:'spotlight.curation.sidebar.feature_pages'), exhibit_feature_pages_path(@exhibit)
@@ -18,11 +20,9 @@ module Spotlight
     end
 
     def show
-      if @page.display_sidebar?
-        @response, @document_list = get_search_results
-      end
+      @response, @document_list = search_results({}, search_params_logic) if @page.display_sidebar?
 
-      if @page.nil? or !@page.published?
+      if @page.nil? || !@page.published?
         render '/catalog/index'
       else
         render 'show'
@@ -30,6 +30,7 @@ module Spotlight
     end
 
     private
+
     alias_method :search_action_url, :exhibit_search_action_url
     alias_method :search_facet_url, :exhibit_search_facet_url
 

data/app/controllers/spotlight/lock_controller.rb

@@ -1,4 +1,6 @@
 module Spotlight
+  ##
+  # Locking mechanism for page-level locks
   class LockController < Spotlight::ApplicationController
     load_and_authorize_resource
 
@@ -6,7 +8,7 @@ module Spotlight
     def destroy
       @lock.destroy
 
-      render text: "", status: 204
+      render text: '', status: 204
     end
   end
 end

data/app/controllers/spotlight/metadata_configurations_controller.rb

@@ -0,0 +1,49 @@
+module Spotlight
+  ##
+  # CRUD actions for Blacklight metadata fields (e.g. index/show fields for
+  # various view types)
+  class MetadataConfigurationsController < Spotlight::ApplicationController
+    before_action :authenticate_user!
+    load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+    load_and_authorize_resource :blacklight_configuration, through: :exhibit, singleton: true, parent: false
+
+    def show
+      respond_to do |format|
+        format.json do
+          render json: @blacklight_configuration.blacklight_config.index_fields.as_json
+        end
+      end
+    end
+
+    def edit
+      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.curation.sidebar.metadata'), edit_exhibit_metadata_configuration_path(@exhibit)
+    end
+
+    def update
+      if @blacklight_configuration.update(exhibit_params)
+        flash[:notice] = t(:'helpers.submit.blacklight_configuration.updated', model: @blacklight_configuration.class.model_name.human.downcase)
+        redirect_to edit_exhibit_metadata_configuration_path(@exhibit)
+      else
+        render action: 'edit'
+      end
+    end
+
+    private
+
+    def exhibit_params
+      params.require(:blacklight_configuration).permit(
+        index_fields: [exhibit_configuration_index_params]
+      )
+    end
+
+    def exhibit_configuration_index_params
+      views = @blacklight_configuration.default_blacklight_config.view.keys | [:show]
+
+      @blacklight_configuration.blacklight_config.index_fields.keys.each_with_object({}) do |element, result|
+        result[element] = ([:enabled, :label, :weight] | views)
+      end
+    end
+  end
+end

data/app/controllers/spotlight/pages_controller.rb

@@ -1,6 +1,8 @@
 module Spotlight
+  ##
+  # Base CRUD controller for pages
   class PagesController < Spotlight::ApplicationController
-    before_filter :authenticate_user!, except: [:show]
+    before_action :authenticate_user!, except: [:show]
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
 
     helper Openseadragon::OpenseadragonHelper
@@ -8,7 +10,7 @@ module Spotlight
     include Blacklight::Catalog::SearchContext
     include Spotlight::Catalog::AccessControlsEnforcement
 
-    helper_method :get_search_results, :search_results, :fetch, :page_collection_name
+    helper_method :get_search_results, :search_results, :search_params_logic, :fetch, :page_collection_name
 
     # GET /exhibits/1/pages
     def index
@@ -62,7 +64,7 @@ module Spotlight
       @page.lock.delete if @page.lock
 
       if @page.update(page_params.merge(last_edited_by: current_user))
-        redirect_to [@page.exhibit, @page], flash: { html_safe: true }, notice: view_context.safe_join([t(:'helpers.submit.page.updated', model: @page.class.model_name.human.downcase), undo_link], " ")
+        redirect_to [@page.exhibit, @page], flash: { html_safe: true }, notice: undo_notice(:updated)
       else
         render action: 'edit'
       end
@@ -72,28 +74,32 @@ module Spotlight
     def destroy
       @page.destroy
 
-      redirect_to [@page.exhibit, page_collection_name], flash: { html_safe: true }, notice: view_context.safe_join([t(:'helpers.submit.page.destroyed', model: @page.class.model_name.human.downcase), undo_link], " ")
+      redirect_to [@page.exhibit, page_collection_name], flash: { html_safe: true }, notice: undo_notice(:destroyed)
     end
 
     def update_all
       notice = if @exhibit.update update_all_page_params
-        t(:'helpers.submit.page.batch_updated', model: human_name)
-      else
-        t(:'helpers.submit.page.batch_error', model: human_name)
-      end
+                 t(:'helpers.submit.page.batch_updated', model: human_name)
+               else
+                 t(:'helpers.submit.page.batch_error', model: human_name)
+               end
       redirect_to :back, notice: notice
     end
 
+    protected
+
     def _prefixes
       @_prefixes ||= super + ['catalog']
     end
 
     def undo_link
       return unless can? :manage, @page
-      view_context.link_to(t(:'spotlight.versions.undo'), revert_version_path(@page.versions.last), :method => :post)
+      view_context.link_to(t(:'spotlight.versions.undo'), revert_version_path(@page.versions.last), method: :post)
     end
 
-    protected
+    def undo_notice(key)
+      view_context.safe_join([t(:"helpers.submit.page.#{key}", model: @page.class.model_name.human.downcase), undo_link], ' ')
+    end
 
     ##
     # Browsing an exhibit should start a new search session
@@ -102,7 +108,7 @@ module Spotlight
     end
 
     def page_attributes
-      [:id, :published, :title, :weight, :display_sidebar, :parent_page_id ]
+      [:id, :published, :title, :weight, :display_sidebar, :parent_page_id]
     end
 
     def allowed_page_params
@@ -110,17 +116,20 @@ module Spotlight
     end
 
     def featured_image_attributes
-      [:source, :image, :remote_image_url, :document_global_id, :image_crop_x, :image_crop_y, :image_crop_w, :image_crop_h]
+      [
+        :source, :image, :remote_image_url, :document_global_id,
+        :image_crop_x, :image_crop_y, :image_crop_w, :image_crop_h
+      ]
     end
 
     def human_name
       @human_name ||= page_collection_name.humanize
     end
 
-    alias page_collection_name controller_name 
+    alias_method :page_collection_name, :controller_name
 
     def attach_breadcrumbs
-      if view_context.current_page? "/"
+      if view_context.current_page? '/'
         add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: current_exhibit.title), main_app.root_path
       else
         add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: current_exhibit.title), spotlight.exhibit_root_path(current_exhibit)
@@ -128,9 +137,10 @@ module Spotlight
     end
 
     private
-      # Only allow a trusted parameter "white list" through.
-      def page_params
-        params.require(controller_name.singularize).permit(allowed_page_params)
-      end
+
+    # Only allow a trusted parameter "white list" through.
+    def page_params
+      params.require(controller_name.singularize).permit(allowed_page_params)
+    end
   end
 end

data/app/controllers/spotlight/resources/upload_controller.rb

@@ -1,67 +1,74 @@
 # encoding: utf-8
 require 'csv'
 
-module Spotlight::Resources
-  class UploadController < ApplicationController
-    helper :all
+module Spotlight
+  module Resources
+    ##
+    # Creating new exhibit items from single-item entry forms
+    # or batch CSV upload
+    class UploadController < ApplicationController
+      helper :all
 
-    before_filter :authenticate_user!
+      before_action :authenticate_user!
 
-    load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
-    before_filter :build_resource, only: [:new, :create, :template]
+      load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+      before_action :build_resource, only: [:new, :create, :template]
 
-    load_and_authorize_resource class: 'Spotlight::Resources::Upload', through_association: "exhibit.resources", instance_name: 'resource'
-    def new
-      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), exhibit_root_path(@exhibit)
-      add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
-      add_breadcrumb t(:'spotlight.curation.sidebar.items'), admin_exhibit_catalog_index_path(@exhibit)
-      add_breadcrumb t(:'spotlight.resources.upload.new.header'), new_exhibit_resources_upload_path(@exhibit)
-    end
+      load_and_authorize_resource class: 'Spotlight::Resources::Upload', through_association: 'exhibit.resources', instance_name: 'resource'
+      def new
+        add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), exhibit_root_path(@exhibit)
+        add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
+        add_breadcrumb t(:'spotlight.curation.sidebar.items'), admin_exhibit_catalog_index_path(@exhibit)
+        add_breadcrumb t(:'spotlight.resources.upload.new.header'), new_exhibit_resources_upload_path(@exhibit)
+      end
 
-    def create
-      @resource.attributes = resource_params
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def create
+        @resource.attributes = resource_params
 
-      if @resource.save_and_commit
-        flash[:notice] = t('spotlight.resources.upload.success')
-        if params["add-and-continue"]
-          redirect_to new_exhibit_resources_upload_path(@resource.exhibit)
+        if @resource.save_and_commit
+          flash[:notice] = t('spotlight.resources.upload.success')
+          if params['add-and-continue']
+            redirect_to new_exhibit_resources_upload_path(@resource.exhibit)
+          else
+            redirect_to admin_exhibit_catalog_index_path(@resource.exhibit, sort: :timestamp)
+          end
         else
+          flash[:error] = t('spotlight.resources.upload.error')
           redirect_to admin_exhibit_catalog_index_path(@resource.exhibit, sort: :timestamp)
         end
-      else
-        flash[:error] = t('spotlight.resources.upload.error')
-        redirect_to admin_exhibit_catalog_index_path(@resource.exhibit, sort: :timestamp)
       end
-    end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-    def csv_upload
-      file = csv_params[:url]
-      csv = CSV.parse(file.read, {headers:true, return_headers: false, encoding: 'utf-8'}).map(&:to_hash)
-      Spotlight::AddUploadsFromCSV.perform_later(csv, current_exhibit, current_user)
-      flash[:notice] = t('spotlight.resources.upload.csv.success', file_name: file.original_filename)
-      redirect_to :back
-    end
+      def csv_upload
+        file = csv_params[:url]
+        csv = CSV.parse(file.read, headers: true, return_headers: false, encoding: 'utf-8').map(&:to_hash)
+        Spotlight::AddUploadsFromCSV.perform_later(csv, current_exhibit, current_user)
+        flash[:notice] = t('spotlight.resources.upload.csv.success', file_name: file.original_filename)
+        redirect_to :back
+      end
 
-    def template
-      render text: CSV.generate { |csv| csv << data_param_keys.unshift(:url) }, content_type: 'text/csv'
-    end
+      def template
+        render text: CSV.generate { |csv| csv << data_param_keys.unshift(:url) }, content_type: 'text/csv'
+      end
 
-    private
-    def build_resource
-      @resource ||= Spotlight::Resources::Upload.new exhibit: current_exhibit
-    end
+      private
 
-    def csv_params
-      params.require(:resources_csv_upload).permit(:url)
-    end
+      def build_resource
+        @resource ||= Spotlight::Resources::Upload.new exhibit: current_exhibit
+      end
 
-    def resource_params
-      params.require(:resources_upload).permit(:url, data: data_param_keys)
-    end
+      def csv_params
+        params.require(:resources_csv_upload).permit(:url)
+      end
 
-    def data_param_keys
-      Spotlight::Resources::Upload.fields(current_exhibit).collect(&:field_name) + current_exhibit.custom_fields.collect(&:field)
-    end
+      def resource_params
+        params.require(:resources_upload).permit(:url, data: data_param_keys)
+      end
 
+      def data_param_keys
+        Spotlight::Resources::Upload.fields(current_exhibit).map(&:field_name) + current_exhibit.custom_fields.map(&:field)
+      end
+    end
   end
 end

data/app/controllers/spotlight/resources_controller.rb

@@ -1,15 +1,16 @@
 module Spotlight
+  ##
+  # CRUD actions for exhibit resources
   class ResourcesController < Spotlight::ApplicationController
-    before_filter :authenticate_user!, except: [:show]
+    before_action :authenticate_user!, except: [:show]
 
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
-    before_filter :build_resource, only: [:create]
+    before_action :build_resource, only: [:create]
 
     load_and_authorize_resource through: :exhibit
     helper_method :from_popup?
 
     def new
-
       @resource.attributes = resource_params if params[:resource]
       @resource = @resource.becomes_provider
 
@@ -21,13 +22,14 @@ module Spotlight
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def create
       @resource.attributes = resource_params
       @resource = @resource.becomes_provider
 
       if @resource.save_and_commit
         if from_popup?
-          render layout: false, text: "<html><script>window.close();</script></html>"
+          render layout: false, text: '<html><script>window.close();</script></html>'
         else
           redirect_to admin_exhibit_catalog_index_path(@resource.exhibit, sort: :timestamp)
         end
@@ -35,6 +37,7 @@ module Spotlight
         render action: 'new'
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def reindex_all
       @exhibit.reindex_later
@@ -43,8 +46,9 @@ module Spotlight
     end
 
     protected
+
     def resource_params
-      params.require(:resource).permit(:url)
+      params.require(:resource).permit(:url, data: params[:resource][:data].try(:keys))
     end
 
     def build_resource

data/app/controllers/spotlight/roles_controller.rb

@@ -1,57 +1,61 @@
 module Spotlight
+  ##
+  # CRUD actions for assigning exhibit roles to
+  # existing users
   class RolesController < Spotlight::ApplicationController
-    before_filter :authenticate_user!
+    before_action :authenticate_user!
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
     load_and_authorize_resource through: :exhibit, except: [:update_all]
 
     def index
       role = @exhibit.roles.build
       authorize! :edit, role
-      
+
       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.users'), exhibit_roles_path(@exhibit)
     end
 
     def update_all
-      attrs = params.require(:exhibit).permit(:roles_attributes => [:id, :user_key, :role, :_destroy])
+      authorize_nested_attributes! exhibit_params[:roles_attributes], Role
 
-      any_deleted = authorize_nested_attributes(attrs[:roles_attributes], Role)
+      any_deleted = exhibit_params[:roles_attributes].values.any? { |item| item['_destroy'].present? }
 
-      if @exhibit.update(attrs)
-        notice = any_deleted > 0 ? t(:'helpers.submit.role.destroyed') : t(:'helpers.submit.role.updated')
-        redirect_to exhibit_roles_path(@exhibit), notice: notice 
+      if @exhibit.update(exhibit_params)
+        notice = any_deleted ? t(:'helpers.submit.role.destroyed') : t(:'helpers.submit.role.updated')
+        redirect_to exhibit_roles_path(@exhibit), notice: notice
       else
         flash[:alert] = t(:'helpers.submit.role.batch_error')
         render action: 'index'
       end
-
     end
 
     protected
 
+    def exhibit_params
+      params.require(:exhibit).permit(roles_attributes: [:id, :user_key, :role, :_destroy])
+    end
 
     # When nested attributes are passed in, ensure we have authorization to update each row.
     # @param attr [Hash,Array] the nested attributes
     # @param klass [Class] the class that is getting created
     # @return [Integer] a count of the number of deleted records
-    def authorize_nested_attributes(attrs, klass)
-      attrs = attrs.values if attrs.is_a? Hash
-      delete_count = 0
-      attrs.each do |item|
-        if item[:id]
-          if item['_destroy'].present?
-            authorize! :destroy, klass.find(item[:id])
-            delete_count += 1
-          else
-            authorize! :update, klass.find(item[:id])
-          end
+    def authorize_nested_attributes!(attrs, klass)
+      attrs.each do |_, item|
+        authorize_item item, klass
+      end
+    end
+
+    def authorize_item(item, klass)
+      if item[:id]
+        if item['_destroy'].present?
+          authorize! :destroy, klass.find(item[:id])
         else
-          authorize! :create, klass
+          authorize! :update, klass.find(item[:id])
         end
+      else
+        authorize! :create, klass
       end
-      delete_count
     end
-
   end
 end