blacklight-spotlight 0.4.1 → 0.5.0

data/app/helpers/spotlight/browse_helper.rb

@@ -1,8 +1,20 @@
 module Spotlight
+  ##
+  # Helper for browse views
   module BrowseHelper
     include ::BlacklightConfigurationHelper
+
+    ##
+    # Override Blacklight's #default_document_index_view_type helper to
+    # use a different default view when presenting browse categories
     def default_document_index_view_type
-      (:gallery if blacklight_config.view.has_key? :gallery) || super
+      (default_browse_index_view_type if blacklight_config.view.key? default_browse_index_view_type) || super
+    end
+
+    private
+
+    def default_browse_index_view_type
+      Spotlight::Engine.config.default_browse_index_view_type
     end
   end
 end

data/app/helpers/spotlight/crud_link_helpers.rb

@@ -1,70 +1,77 @@
 module Spotlight
+  ##
+  # Helpers for building polymorphic links within the exhibit context
   module CrudLinkHelpers
-    def cancel_link model, link, link_to_options = {}
+    def cancel_link(model, link, link_to_options = {})
       link_to action_default_value(model, :cancel), link, link_to_options
     end
 
-    def view_link model, *args
+    def view_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || [spotlight, model]
       link_to action_default_value(model, :view), link, link_to_options
     end
 
-    def exhibit_view_link model, *args
+    def exhibit_view_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || [spotlight, model.exhibit, model]
       link_to action_default_value(model, :view), link, link_to_options
     end
 
-    def create_link model, *args
+    def create_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || polymorphic_path([spotlight, model], action: :new)
       link_to action_default_value(model), link, link_to_options
     end
 
-    def exhibit_create_link model, *args
+    def exhibit_create_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || polymorphic_path([spotlight, current_exhibit, model], action: :new)
       link_to action_default_value(model), link, link_to_options
     end
 
-    def edit_link model, *args
+    def edit_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || polymorphic_path([spotlight, model], action: :edit)
       link_to action_default_value(model), link, link_to_options
     end
 
-    def exhibit_edit_link model, *args
+    def exhibit_edit_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || polymorphic_path([spotlight, model.exhibit, model], action: :edit)
       link_to action_default_value(model), link, link_to_options
     end
 
-    def delete_link model, *args
+    def delete_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || [spotlight, model]
       default_options = { method: :delete, data: { confirm: action_default_value(model, :destroy_are_you_sure) } }
       link_to action_default_value(model, :destroy), link, default_options.merge(link_to_options)
     end
 
-    def exhibit_delete_link model, *args
+    def exhibit_delete_link(model, *args)
       link_to_options = args.extract_options!
       link = args.first || [spotlight, model.exhibit, model]
       default_options = { method: :delete, data: { confirm: action_default_value(model, :destroy_are_you_sure) } }
       link_to action_default_value(model, :destroy), link, default_options.merge(link_to_options)
     end
 
-    def action_label model, action
+    def action_label(model, action)
       action_default_value model, action
     end
 
     private
 
-    def action_default_value object, key = nil
+    # rubocop:disable Metrics/MethodLength
+    def action_default_value(object, key = nil)
       object_model = convert_to_model(object)
 
-      key ||= object_model ? (object_model.persisted? ? :edit : :create) : :view
-      
+      key ||= if object_model
+                object_model.persisted? ? :edit : :create
+              else
+                :view
+              end
+
       case object_model
       when ActsAsTaggableOn::Tag
         model = :tag
@@ -83,5 +90,6 @@ module Spotlight
       defaults << "#{key.to_s.humanize} #{model}"
       I18n.t(defaults.shift, model: model, default: defaults)
     end
+    # rubocop:enable Metrics/MethodLength
   end
-end
+end

data/app/helpers/spotlight/jcrop_helper.rb

@@ -1,4 +1,6 @@
 module Spotlight
+  ##
+  # JCrop options helpers
   module JcropHelper
     def default_masthead_jcrop_options
       {
@@ -6,9 +8,9 @@ module Spotlight
         selector: 'masthead_image',
         bg_color: 'black',
         bg_opacity: '.4',
-        aspect_ratio: 15,
+        aspect_ratio: 10,
         box_width: '600',
-        initial_set_select: '[0, 0, 1800, 120]'
+        initial_set_select: '[0, 0, 1800, 180]'
       }
     end
 

data/app/helpers/spotlight/main_app_helpers.rb

@@ -1,53 +1,57 @@
-module Spotlight::MainAppHelpers
-  include Spotlight::NavbarHelper
-  def cache_key_for_spotlight_exhibits
-    Spotlight::Exhibit.maximum(:updated_at).try(:utc).try(:to_s, :number)
-  end
-
-  def on_browse_page?
-    params[:controller] == 'spotlight/browse'
-  end
-
-  def on_about_page?
-    params[:controller] == 'spotlight/about_pages'
-  end
-  
-  def show_contact_form?
-    current_exhibit && current_exhibit.contact_emails.confirmed.any?
-  end
-  
-  def enabled_in_spotlight_view_type_configuration? config, *args
-    if config.respond_to? :upstream_if and !config.upstream_if.nil?
-      return false unless evaluate_configuration_conditional(config.upstream_if, config, *args)
+module Spotlight
+  ##
+  # Helpers that are injected into the main application (because they used in layouts)
+  module MainAppHelpers
+    include Spotlight::NavbarHelper
+    def cache_key_for_spotlight_exhibits
+      Spotlight::Exhibit.maximum(:updated_at).try(:utc).try(:to_s, :number)
     end
 
-    return true unless current_exhibit
+    def on_browse_page?
+      params[:controller] == 'spotlight/browse'
+    end
 
-    return true if controller.is_a? Spotlight::PagesController
+    def on_about_page?
+      params[:controller] == 'spotlight/about_pages'
+    end
 
-    return current_exhibit.blacklight_configuration.document_index_view_types.include? config.key.to_s
-  end
-  
-  def field_enabled? field, *args
-    return false unless field.enabled
+    def show_contact_form?
+      current_exhibit && current_exhibit.contact_emails.confirmed.any?
+    end
 
-    if field.respond_to? :upstream_if and !field.upstream_if.nil?
-      return false unless evaluate_configuration_conditional(field.upstream_if, field, *args)
+    def enabled_in_spotlight_view_type_configuration?(config, *args)
+      case
+      when config.respond_to?(:upstream_if) && !config.upstream_if.nil? && !evaluate_configuration_conditional(config.upstream_if, config, *args)
+        false
+      when current_exhibit.nil? || controller.is_a?(Spotlight::PagesController)
+        true
+      else
+        current_exhibit.blacklight_configuration.document_index_view_types.include? config.key.to_s
+      end
     end
 
-    if field.is_a? Blacklight::Configuration::SortField
-      field.enabled
-    elsif field.is_a?(Blacklight::Configuration::FacetField) or (controller.is_a?(Blacklight::Catalog) and ["edit", "show"].include?(action_name))
-      field.show
-    else
-      field.send(document_index_view_type)
+    # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
+    def field_enabled?(field, *args)
+      case
+      when !field.enabled
+        false
+      when (field.respond_to?(:upstream_if) && !field.upstream_if.nil? && !evaluate_configuration_conditional(field.upstream_if, field, *args))
+        false
+      when field.is_a?(Blacklight::Configuration::SortField) || field.is_a?(Blacklight::Configuration::SearchField)
+        field.enabled
+      when field.is_a?(Blacklight::Configuration::FacetField) || (controller.is_a?(Blacklight::Catalog) && %w(edit show).include?(action_name))
+        field.show
+      else
+        field.send(document_index_view_type)
+      end
     end
-  end
+    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength
 
-  def link_back_to_catalog(opts={:label=>nil})
-    if (current_search_session.try(:query_params) || {}).fetch(:controller, "").starts_with? "spotlight"
-      opts[:route_set] ||= spotlight
+    def link_back_to_catalog(opts = { label: nil })
+      if (current_search_session.try(:query_params) || {}).fetch(:controller, '').starts_with? 'spotlight'
+        opts[:route_set] ||= spotlight
+      end
+      super
     end
-    super
   end
 end

data/app/helpers/spotlight/navbar_helper.rb

@@ -1,5 +1,11 @@
 module Spotlight
+  ##
+  # Helpers used by the navbar
   module NavbarHelper
+    ##
+    # Check if the spotlight search box should be rendered. It is not displayed
+    # if the exhibit is not searchable, we're not in an exhibit, or the top-level
+    # exhibit masthead isn't being used (e.g. on a browse category)
     def should_render_spotlight_search_bar?
       exhibit_masthead? && (current_exhibit.nil? || current_exhibit.searchable?)
     end

data/app/helpers/spotlight/pages_helper.rb

@@ -1,44 +1,52 @@
 module Spotlight
+  ##
+  # Sir-trevor helpers methods
   module PagesHelper
-    def sir_trevor_markdown text
-      GitHub::Markup.render(".md", text.gsub("<br>", "\n").gsub("<p>", "").gsub("</p>", "\n\n")).html_safe
+    ##
+    # Override the default #sir_trevor_markdown so we can use
+    # a more complete markdown rendered
+    def sir_trevor_markdown(text)
+      GitHub::Markup.render('.md', text.gsub('<br>', "\n").gsub('<p>', '').gsub('</p>', "\n\n")).html_safe
     end
 
     def available_index_fields
-      [{key: document_show_link_field, label: t(:'.title_placeholder')}] + (@page.exhibit.blacklight_configuration.default_blacklight_config.index_fields.map { |k,v| { key: k, label: index_field_label(nil, k) }})
-    end
+      fields = blacklight_config.index_fields.map { |k, _v| { key: k, label: index_field_label(nil, k) } }
+      fields.unshift(key: document_show_link_field, label: t(:'spotlight.pages.form.title_placeholder')) unless index_fields.include? document_show_link_field
 
-    def has_title? document
-      document_heading(document) != document.id
+      fields
     end
 
     def disable_save_pages_button?
-      page_collection_name == "about_pages" && @pages.empty?
+      page_collection_name == 'about_pages' && @pages.empty?
     end
-    def get_search_widget_search_results block
+
+    def get_search_widget_search_results(block)
       if block.searches?
-        get_search_results(block.query_params.with_indifferent_access.merge(params))
+        search_results(block.query_params.with_indifferent_access.merge(params), search_params_logic)
       else
         []
       end
     end
+
     def nestable_data_attributes(type)
       nestable_data_attributes_hash(type).map do |attr, val|
         "#{attr}='#{val}'"
       end.join(' ')
     end
+
     def nestable_data_attributes_hash(type)
       case type
-      when "feature_pages"
-        {:"data-max-depth" => '2',
-         :"data-expand-btn-HTML" => '',
-         :"data-collapse-btn-HTML" => ''}
-      when "about_pages"
-        {:"data-max-depth" => '1'}
+      when 'feature_pages'
+        { "data-max-depth": '2',
+          "data-expand-btn-HTML": '',
+          "data-collapse-btn-HTML": '' }
+      when 'about_pages'
+        { "data-max-depth": '1' }
       else
         {}
       end
     end
+
     def render_contact_email_address(address)
       mail_to address, address
     end

data/app/helpers/spotlight/roles_helper.rb

@@ -1,7 +1,13 @@
-module Spotlight::RolesHelper
-  def roles_for_select
-    Spotlight::Role::ROLES.each_with_object({}) do |key, object|
-      object[t("spotlight.role.#{key}")] = key
+module Spotlight
+  ##
+  # Exhibit roles helpers
+  module RolesHelper
+    ##
+    # Format the available roles for a select_tag
+    def roles_for_select
+      Spotlight::Role::ROLES.each_with_object({}) do |key, object|
+        object[t("spotlight.role.#{key}")] = key
+      end
     end
   end
 end

data/app/helpers/spotlight/search_configurations_helper.rb

@@ -0,0 +1,22 @@
+module Spotlight
+  ##
+  # Search configurations helpers
+  module SearchConfigurationsHelper
+    ##
+    # Translate a sort field configuration into
+    # a complete description of the sort
+    def translate_sort_fields(sort_config)
+      sort_description = sort_config[:sort_description] if sort_config[:sort_description]
+
+      sort_description ||= sort_config[:sort].split(',').map do |sort|
+        sort_field, sort_order = sort.split(' ')
+        safe_join([
+          t(:"spotlight.search_configurations.sort.keys.#{sort_field.strip}", default: sort_field.humanize.downcase),
+          t(:"spotlight.search_configurations.sort.keys.#{sort_order.strip}", default: '')
+        ], ' ')
+      end.to_sentence if sort_config[:sort]
+
+      sort_description
+    end
+  end
+end

data/app/helpers/spotlight/title_helper.rb

@@ -1,31 +1,34 @@
 module Spotlight
+  ##
+  # Page title helpers
   module TitleHelper
-    def curation_page_title title = nil
+    def curation_page_title(title = nil)
       page_title t(:'spotlight.curation.header'), title
     end
 
-    def administration_page_title title = nil
+    def administration_page_title(title = nil)
       page_title t(:'spotlight.administration.header'), title
     end
 
-    def page_title section, title = nil
+    def page_title(section, title = nil)
       set_html_page_title(t(:'spotlight.html_admin_title', section: section, title: title || t(:'.title', default: :'.header')))
-      content_tag(:h1, safe_join([section, content_tag(:small, title || t(:'.header'))], "\n"), class: "page-header")
+      content_tag(:h1, safe_join([section, content_tag(:small, title || t(:'.header'))], "\n"), class: 'page-header')
     end
 
-    def set_html_page_title title = nil
+    # rubocop:disable Style/AccessorMethodName
+    def set_html_page_title(title = nil)
       @page_title = strip_tags(t(:'spotlight.html_title', title: title || t(:'.title', default: :'.header'), application_name: application_name))
     end
+    # rubocop:enable Style/AccessorMethodName
 
-    def header_with_count *args
+    def header_with_count(*args)
       title, count = if args.length == 2
-        args
-      else
-        [t(:'.header'), args.first]
-      end
+                       args
+                     else
+                       [t(:'.header'), args.first]
+                     end
 
-      safe_join([title, content_tag(:span, count, class: 'label label-default')], " ")
+      safe_join([title, content_tag(:span, count, class: 'label label-default')], ' ')
     end
-
   end
-end
+end

data/app/jobs/spotlight/add_uploads_from_csv.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 module Spotlight
+  ##
+  # Process a CSV upload into new Spotlight::Resource::Upload objects
   class AddUploadsFromCSV < ActiveJob::Base
     queue_as :default
 
@@ -8,19 +10,21 @@ module Spotlight
       Spotlight::IndexingCompleteMailer.documents_indexed(csv_data, exhibit, user).deliver_now
     end
 
-    def perform(csv_data, exhibit, user)
+    def perform(csv_data, exhibit, _user)
       encoded_csv(csv_data).each do |row|
-        if (url = row.delete("url")).present?
-          Spotlight::Resources::Upload.create(
-            remote_url_url: url,
-            data: row,
-            exhibit: exhibit
-          )
-        end
-      end
+        url = row.delete('url')
+        next unless url.present?
 
+        Spotlight::Resources::Upload.create(
+          remote_url_url: url,
+          data: row,
+          exhibit: exhibit
+        )
+      end
     end
+
     private
+
     def encoded_csv(csv)
       csv.map do |row|
         row.map do |label, column|