blacklight-spotlight 0.4.1 → 0.5.0

data/app/controllers/spotlight/search_configurations_controller.rb

@@ -0,0 +1,66 @@
+module Spotlight
+  ##
+  # CRUD actions for Blacklight search configuration
+  class SearchConfigurationsController < 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
+
+    include Blacklight::SearchHelper
+
+    def show
+      respond_to do |format|
+        format.json do
+          render json: @blacklight_configuration.default_blacklight_config.view.to_h.reject { |_k, v| v.if == false }.keys
+        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.search_configuration'), edit_exhibit_search_configuration_path(@exhibit)
+
+      @field_metadata = Spotlight::FieldMetadata.new(repository, @blacklight_configuration.blacklight_config)
+    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_search_configuration_path(@exhibit)
+      else
+        render action: 'edit'
+      end
+    end
+
+    private
+
+    def exhibit_params
+      params.require(:blacklight_configuration).permit(
+        :default_per_page,
+        facet_fields: [exhibit_configuration_facet_params],
+        search_fields: [exhibit_configuration_search_params],
+        sort_fields: [exhibit_configuration_sort_params],
+        document_index_view_types: @blacklight_configuration.default_blacklight_config.view.keys
+      )
+    end
+
+    def exhibit_configuration_facet_params
+      @blacklight_configuration.blacklight_config.facet_fields.keys.each_with_object({}) do |element, result|
+        result[element] = [:show, :label, :weight]
+      end
+    end
+
+    def exhibit_configuration_search_params
+      @blacklight_configuration.blacklight_config.search_fields.keys.each_with_object({}) do |element, result|
+        result[element] = [:enabled, :label, :weight]
+      end
+    end
+
+    def exhibit_configuration_sort_params
+      @blacklight_configuration.blacklight_config.sort_fields.keys.each_with_object({}) do |element, result|
+        result[element] = [:enabled, :label, :weight]
+      end
+    end
+  end
+end

data/app/controllers/spotlight/searches_controller.rb

@@ -1,105 +1,114 @@
-class Spotlight::SearchesController < Spotlight::ApplicationController
-  load_resource :exhibit, class: "Spotlight::Exhibit"
-  before_filter :authenticate_user!
-  before_filter :only_curators!
-  load_and_authorize_resource through: :exhibit
-  before_filter :attach_breadcrumbs, only: [:index, :edit], unless: -> { request.format.json? }
-
-  include Spotlight::Base
-
-  def create
-    params_copy = params.dup
-    params_copy.delete(:exhibit_id)
-    @search.title = params_copy.delete(:search)[:title]
-    @search.query_params = params_copy.reject { |k,v| blacklisted_search_session_params.include?(k.to_sym) or v.blank? }
-    @search.save!
-
-    redirect_to :back, notice: t(:'helpers.submit.search.created', model: @search.class.model_name.human.downcase)
-  end
+module Spotlight
+  ##
+  # CRUD actions for curating browse categories (see
+  # {Spotlight::BrowseController} for the end-user read and index actions)
+  class SearchesController < Spotlight::ApplicationController
+    load_resource :exhibit, class: 'Spotlight::Exhibit'
+    before_action :authenticate_user!
+    before_action :only_curators!
+    load_and_authorize_resource through: :exhibit
+    before_action :attach_breadcrumbs, only: [:index, :edit], unless: -> { request.format.json? }
+
+    include Spotlight::Base
+
+    # rubocop:disable Metrics/AbcSize
+    def create
+      @search.attributes = search_params
+      @search.query_params = params.except(:exhibit_id, :search, *blacklisted_search_session_params).reject { |_k, v| v.blank? }
+
+      if @search.save
+        redirect_to :back, notice: t(:'helpers.submit.search.created', model: @search.class.model_name.human.downcase)
+      else
+        redirect_to :back, alert: @search.errors.full_messages.join('<br>'.html_safe)
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
 
-  def index
-    respond_to do |format|
-      format.html
-      format.json { render json: @searches.published.as_json(methods: [:count, :thumbnail_image_url]), root: false }
+    def index
+      respond_to do |format|
+        format.html
+        format.json { render json: @searches.published.as_json(methods: [:count, :thumbnail_image_url]), root: false }
+      end
     end
-  end
 
-  def autocomplete
-    (_, document_list) = get_search_results(autocomplete_params, blacklight_config.default_autocomplete_solr_params)
+    def autocomplete
+      search_params = autocomplete_params.merge(search_field: Spotlight::Engine.config.autocomplete_search_field)
+      (_, document_list) = search_results(search_params, search_params_logic)
 
-    respond_to do |format|
-      format.json do
-        render json: { docs: autocomplete_json_response(document_list) }
+      respond_to do |format|
+        format.json do
+          render json: { docs: autocomplete_json_response(document_list) }
+        end
       end
     end
-  end
 
-  def edit
-    add_breadcrumb @search.title, edit_exhibit_search_path(@search.exhibit, @search)
-    @exhibit = @search.exhibit
-  end
+    def edit
+      add_breadcrumb @search.title, edit_exhibit_search_path(@search.exhibit, @search)
+      @exhibit = @search.exhibit
+    end
 
-  def update
-    if @search.update search_params
-      redirect_to exhibit_searches_path(@search.exhibit), notice: t(:'helpers.submit.search.updated', model: @search.class.model_name.human.downcase)
-    else
-      render action: 'edit'
+    def update
+      if @search.update search_params
+        redirect_to exhibit_searches_path(@search.exhibit), notice: t(:'helpers.submit.search.updated', model: @search.class.model_name.human.downcase)
+      else
+        render action: 'edit'
+      end
     end
-  end
 
-  def destroy
-    @search.destroy
-    redirect_to exhibit_searches_path(@search.exhibit), alert: t(:'helpers.submit.search.destroyed', model: @search.class.model_name.human.downcase)
-  end
+    def destroy
+      @search.destroy
+      redirect_to exhibit_searches_path(@search.exhibit), alert: t(:'helpers.submit.search.destroyed', model: @search.class.model_name.human.downcase)
+    end
 
-  def update_all
-    notice = if @exhibit.update batch_search_params
-      t(:'helpers.submit.search.batch_updated', model: Spotlight::Search.model_name.human.pluralize)
-    else
-      t(:'helpers.submit.search.batch_error', model: Spotlight::Search.model_name.human.pluralize.downcase)
+    def update_all
+      notice = if @exhibit.update batch_search_params
+                 t(:'helpers.submit.search.batch_updated', model: Spotlight::Search.model_name.human.pluralize)
+               else
+                 t(:'helpers.submit.search.batch_error', model: Spotlight::Search.model_name.human.pluralize.downcase)
+               end
+      redirect_to :back, notice: notice
     end
-    redirect_to :back, notice: notice
-  end
 
-  def show
-    redirect_to exhibit_browse_url(@search.exhibit, @search)
-  end
+    def show
+      redirect_to exhibit_browse_url(@search.exhibit, @search)
+    end
 
-  protected
+    protected
 
-  def autocomplete_params
-    ##
-    # Ideally, we would be able to search within results for all queries, but in practice
-    # searching within saved searches with a `q` parameter is.. hard.
+    def autocomplete_params
+      ##
+      # Ideally, we would be able to search within results for all queries, but in practice
+      # searching within saved searches with a `q` parameter is.. hard.
 
-    query_params = @search.query_params.with_indifferent_access
-    query_params.merge(q: params[:q])
-  end
+      query_params = @search.query_params.with_indifferent_access
+      query_params.merge(q: params[:q])
+    end
 
-  def attach_breadcrumbs
-    e = @exhibit || (@search.exhibit if @search)
-    add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: e.title), e
-    add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(e)
-    add_breadcrumb t(:'spotlight.curation.sidebar.browse'), exhibit_searches_path(e)
-  end
+    def attach_breadcrumbs
+      e = @exhibit || (@search.exhibit if @search)
+      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: e.title), e
+      add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(e)
+      add_breadcrumb t(:'spotlight.curation.sidebar.browse'), exhibit_searches_path(e)
+    end
 
-  def batch_search_params
-    params.require(:exhibit).permit("searches_attributes" => [:id, :on_landing_page, :weight])
-  end
+    def batch_search_params
+      params.require(:exhibit).permit('searches_attributes' => [:id, :published, :weight])
+    end
 
-  def search_params
-    params.require(:search).permit(:title, :long_description, masthead_attributes: featured_image_attributes, thumbnail_attributes: featured_image_attributes)
-  end
-  
-  def featured_image_attributes
-    [:display, :source, :image, :remote_image_url, :document_global_id, :image_crop_x, :image_crop_y, :image_crop_w, :image_crop_h]
-  end
+    def search_params
+      params.require(:search).permit(:title, :long_description, masthead_attributes: featured_image_attributes, thumbnail_attributes: featured_image_attributes)
+    end
 
-  def only_curators!
-    authorize! :curate, @exhibit if @exhibit
-  end
+    def featured_image_attributes
+      [:display, :source, :image, :remote_image_url, :document_global_id, :image_crop_x, :image_crop_y, :image_crop_w, :image_crop_h]
+    end
 
-  def blacklisted_search_session_params
-    [:commit, :counter, :total, :search_id, :page, :per_page, :authenticity_token, :utf8, :action, :controller]
+    def only_curators!
+      authorize! :curate, @exhibit if @exhibit
+    end
+
+    def blacklisted_search_session_params
+      [:commit, :counter, :total, :search_id, :page, :per_page, :authenticity_token, :utf8, :action, :controller]
+    end
   end
 end

data/app/controllers/spotlight/solr_controller.rb

@@ -1,19 +1,26 @@
-class Spotlight::SolrController < Spotlight::ApplicationController
-  before_filter :authenticate_user!
-  load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+module Spotlight
+  ##
+  # Proxy update requests to Solr and inject spotlight's exhibit
+  # specific fields.
+  #
+  # This is an example of how you could integrate external indexing
+  # workflows with exhibit-specific content
+  class SolrController < Spotlight::ApplicationController
+    before_action :authenticate_user!
+    load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
 
-  def update
-    authorize! :update_solr, @exhibit
+    def update
+      authorize! :update_solr, @exhibit
 
-    req = ActiveSupport::JSON.decode(request.body.read)
+      req = ActiveSupport::JSON.decode(request.body.read)
 
-    docs = Array.wrap(req).map do |r|
-      SolrDocument.new(r).to_solr.merge(@exhibit.solr_data).merge(r)
-    end
+      docs = Array.wrap(req).map do |r|
+        blacklight_config.document_model.new(r).to_solr.merge(@exhibit.solr_data).merge(r)
+      end
 
-    blacklight_solr.update docs
+      blacklight_solr.update docs
 
-    render nothing: true
+      render nothing: true
+    end
   end
-
-end
+end

data/app/controllers/spotlight/tags_controller.rb

@@ -1,6 +1,8 @@
 module Spotlight
+  ##
+  # CRUD actions for document tags
   class TagsController < Spotlight::ApplicationController
-    before_filter :authenticate_user!
+    before_action :authenticate_user!
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
 
     def index
@@ -12,12 +14,12 @@ module Spotlight
 
       respond_to do |format|
         format.html
-        format.json { render json: @exhibit.owned_tags.map { |x| x.name } }
+        format.json { render json: @exhibit.owned_tags.map(&:name) }
       end
     end
 
     def destroy
-      authorize! :tag, @exhibit 
+      authorize! :tag, @exhibit
       # warning: this causes every solr document with this tag to reindex.  That could be slow.
       @exhibit.owned_taggings.where(tag_id: params[:id]).destroy_all
 

data/app/controllers/spotlight/versions_controller.rb

@@ -1,12 +1,14 @@
 module Spotlight
+  ##
+  # Controller for reverting to historical versions of e.g. pages
   class VersionsController < Spotlight::ApplicationController
-    before_filter :authenticate_user!
+    before_action :authenticate_user!
 
-    load_and_authorize_resource class: "PaperTrail::Version"
+    load_and_authorize_resource class: 'PaperTrail::Version'
 
     def revert
-      if obj = @version.reify
-        authorize! :manage, obj
+      obj = @version.reify
+      if obj && authorize!(:manage, obj)
         if obj.save
           redirect_to [obj.exhibit, obj], flash: { html_safe: true }, notice: undo_link
         else
@@ -15,19 +17,20 @@ module Spotlight
       else
         redirect_to :back, flash: { html_safe: true }, notice: view_context.t(:'spotlight.versions.undo_error')
       end
-
     end
 
+    private
+
     def undo_link
       return unless can? :manage, @version
 
-      link_name = if params[:redo] == "true"
-        view_context.t(:'spotlight.versions.undo')
-      else
-        view_context.t(:'spotlight.versions.redo')
-      end
+      link_name = if params[:redo] == 'true'
+                    view_context.t(:'spotlight.versions.undo')
+                  else
+                    view_context.t(:'spotlight.versions.redo')
+                  end
 
-      view_context.link_to(link_name, revert_version_path(@version.next, :redo => !params[:redo]), method: :post)
+      view_context.link_to(link_name, revert_version_path(@version.next, redo: !params[:redo]), method: :post)
     end
   end
-end
+end

data/app/controllers/spotlight/view_configurations_controller.rb

@@ -0,0 +1,17 @@
+module Spotlight
+  ##
+  # Administration for Blacklight view configurations
+  class ViewConfigurationsController < 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.default_blacklight_config.view.to_h.reject { |_k, v| v.if == false }.keys
+        end
+      end
+    end
+  end
+end

data/app/helpers/spotlight/application_helper.rb

@@ -1,9 +1,13 @@
 module Spotlight
+  ##
+  # General spotlight application helpers
   module ApplicationHelper
     include CrudLinkHelpers
     include TitleHelper
     include JcropHelper
 
+    ##
+    # Give the application name a chance to include the exhibit title
     def application_name
       name = super
 
@@ -16,7 +20,7 @@ module Spotlight
 
     # Can search for named routes directly in the main app, omitting
     # the "main_app." prefix
-    def method_missing method, *args, &block
+    def method_missing(method, *args, &block)
       if main_app_url_helper?(method)
         main_app.send(method, *args)
       else
@@ -24,11 +28,14 @@ module Spotlight
       end
     end
 
-    def respond_to?(method, *args)
-      main_app_url_helper?(method) or super
+    def respond_to_missing?(method, *args)
+      main_app_url_helper?(method) || super
     end
 
-    def url_for_document document
+    ##
+    # Override the Blacklight #url_for_document helper to add
+    # the current exhibit context
+    def url_for_document(document)
       return nil if document.nil?
 
       if current_exhibit
@@ -38,7 +45,10 @@ module Spotlight
       end
     end
 
-    def document_action_path action_opts, url_opts = nil
+    ##
+    # Override Blacklight's #document_action_path helper to add
+    # the current exhibit context
+    def document_action_path(action_opts, url_opts = nil)
       if current_exhibit
         spotlight.send(action_opts.path || "exhibit_#{action_opts.key}_#{controller_name}_path", url_opts)
       else
@@ -46,7 +56,9 @@ module Spotlight
       end
     end
 
-    def url_to_tag_facet tag
+    ##
+    # Helper to turn tag data into facets
+    def url_to_tag_facet(tag)
       if current_exhibit
         search_action_url(add_facet_params(Spotlight::SolrDocument.solr_field_for_tagger(current_exhibit), tag, {}))
       else
@@ -55,26 +67,26 @@ module Spotlight
     end
 
     ##
-    # Overridden from Blacklight to inject a private class
+    # Override Blacklight's #render_document_class to inject a private class
     def render_document_class(document = @document)
-      types = super || ""
+      types = super || ''
       types << " #{document_class_prefix}private" if document.private?(current_exhibit)
       types
     end
 
     # Return a copy of the blacklight configuration
     # that only includes views conifgured by our block
-    def blacklight_view_config_for_search_block block
+    def blacklight_view_config_for_search_block(block)
       # Reject any views that aren't configured to display for this block
-      blacklight_config.view.select do |view,_|
+      blacklight_config.view.select do |view, _|
         block.view.include? view.to_s
       end
     end
-    
-    def block_document_index_view_type block
+
+    def block_document_index_view_type(block)
       views = blacklight_view_config_for_search_block(block)
-      
-      if views.has_key? document_index_view_type
+
+      if views.key? document_index_view_type
         document_index_view_type
       else
         views.keys.first
@@ -82,20 +94,20 @@ module Spotlight
     end
 
     # Return the list of views that are configured to display for a block
-    def selected_search_block_views block
-      block.as_json[:data].select do |key, value|
-        value == "on"
-      end.keys.map { |x| x.to_s }
+    def selected_search_block_views(block)
+      block.as_json[:data].select do |_key, value|
+        value == 'on'
+      end.keys.map(&:to_s)
     end
 
     def select_deselect_button
       button_tag(
         t(:".deselect_all"),
-        class: "btn btn-default btn-xs metadata-select",
+        class: 'btn btn-default btn-xs metadata-select',
         data: {
-          :behavior        => "metadata-select",
-          :'deselect-text' => t(:".deselect_all"),
-          :'select-text'   => t(:".select_all")
+          behavior: 'metadata-select',
+          'deselect-text': t(:".deselect_all"),
+          'select-text': t(:".select_all")
         }
       )
     end
@@ -109,40 +121,40 @@ module Spotlight
       end
     end
 
-    def carrierwave_url upload
+    def carrierwave_url(upload)
       # Carrierwave's #url returns either a full url (if asset path was configured)
       # or just the path to the image. We'll try to normalize it to a url.
       url = upload.url
 
-      if url.nil? or url.starts_with? "http"
+      if url.nil? || url.starts_with?('http')
         url
       else
-        (Rails.application.config.asset_host || root_url).sub(/\/$/, "") + url
+        (URI.parse(Rails.application.config.asset_host || root_url) + url).to_s
       end
     end
 
     def render_save_this_search?
-      (current_exhibit and can?( :curate, current_exhibit)) &&
-      !(params[:controller] == "spotlight/catalog" && params[:action] == "admin")
+      (current_exhibit && can?(:curate, current_exhibit)) &&
+        !(params[:controller] == 'spotlight/catalog' && params[:action] == 'admin')
     end
 
-    def uploaded_field_label config
+    def uploaded_field_label(config)
       solr_field = Array(config.solr_field || config.field_name).first.to_s
       config.label || blacklight_config.index_fields[solr_field].try(:label) || t(".#{solr_field}")
     end
 
-    def view_label view
+    def view_label(view)
       t(:"blacklight.search.view.#{view}", default: blacklight_config.view[view].title || view.to_s)
     end
-    
+
     def available_view_fields
-      current_exhibit.blacklight_configuration.default_blacklight_config.view.to_h.reject { |k,v| v.if === false}
+      current_exhibit.blacklight_configuration.default_blacklight_config.view.to_h.reject { |_k, v| v.if == false }
     end
 
     private
 
     def main_app_url_helper?(method)
-        (method.to_s.end_with?('_path') or method.to_s.end_with?('_url')) and
+      (method.to_s.end_with?('_path') || method.to_s.end_with?('_url')) &&
         main_app.respond_to?(method)
     end
   end