blacklight-spotlight 0.0.3 → 0.1.0

data/app/controllers/spotlight/tags_controller.rb

@@ -6,7 +6,7 @@ module Spotlight
     def index
       authorize! :tag, @exhibit
       @tags = @exhibit.owned_tags
-      add_breadcrumb @exhibit.title, @exhibit
+      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.tags'), exhibit_tags_path(@exhibit)
 

data/app/forms/spotlight/appearance.rb

@@ -0,0 +1,99 @@
+module Spotlight
+  class Appearance
+    extend ActiveModel::Naming
+    include ActiveModel::Conversion
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    attr_reader :configuration
+    delegate :persisted?, :exhibit, :exhibit_id, :default_per_page, :thumbnail_size,
+      :default_blacklight_config, to: :configuration
+
+    delegate :main_navigations, to: :exhibit
+
+    ##
+    # This enables us to have a group of checkboxes that is backed by the array
+    # stored in Spotlight::BlacklightConfiguration#document_index_view_types
+    def document_index_view_types
+      vals = configuration.document_index_view_types
+      Blacklight::OpenStructWithHashAccess.new.tap do |s|
+        view_type_options.each do |k|
+          s[k] = vals.include?(k.to_s)
+        end
+      end
+    end
+
+    ##
+    # This enables us to have a group of checkboxes that is backed by the array
+    # stored in Spotlight::BlacklightConfiguration#default_sort_fields
+    def sort_fields 
+      fields = configuration.sort_fields
+      Blacklight::OpenStructWithHashAccess.new.tap do |s|
+        default_sort_fields.each do |k, field|
+          s[field.label.underscore] = fields[k] && fields[k][:show]
+        end
+      end
+    end
+
+    def allowed_params
+      default_sort_field_labels.map(&:to_sym)
+    end
+
+    def update(params)
+      configuration.exhibit.update(main_navigations_attributes: exhibit_params(params)) if exhibit_params(params)
+      configuration.update(configuration_params(params))
+    end
+
+    def view_type_options
+      default_blacklight_config.view.keys
+    end
+
+    def per_page_options
+      default_blacklight_config.per_page
+    end
+
+    def sort_options
+      default_sort_field_labels - ['relevance']
+    end
+
+    protected
+
+    def default_sort_fields
+      default_blacklight_config.sort_fields
+    end
+
+    def default_sort_field_labels
+      default_sort_fields.map { |k, v| v.label.underscore }
+    end
+
+    def enable_sort_fields(checked_fields)
+      default_sort_fields.each_with_object({}) do |(key, sf), new_val|
+        new_val[key] = {show: true} if checked_fields.include?(sf.label.underscore)
+      end
+    end
+
+    def configuration_params(params)
+      p = params.except(:main_navigations)
+      p[:document_index_view_types] = keep_selected_values(p[:document_index_view_types])
+      p[:sort_fields] = enable_sort_fields(keep_selected_values(p[:sort_fields]))
+      p
+    end
+
+    def exhibit_params(params)
+      params[:main_navigations].try(:values)
+    end
+
+    ##
+    # A group of checkboxes on a form returns values like this:
+    #   {"list"=>["0", "1"], "gallery"=>["0", "1"], "map"=>["0"]}
+    # where, "list" and "gallery" are selected and "map" is not. This function
+    # digests that hash into a list of selected values. e.g.:
+    #   ["list", "gallery"]
+    def keep_selected_values h
+      return if h.nil?
+      h.each_with_object([]) { |(k, v), o| o << k if v.include?("1")}
+    end
+  end
+end

data/app/helpers/spotlight/application_helper.rb

@@ -1,7 +1,17 @@
 module Spotlight
   module ApplicationHelper
     include CrudLinkHelpers
-    include AdminTitleHelper
+    include TitleHelper
+
+    def application_name
+      name = super
+
+      if current_exhibit
+        t :'spotlight.application_name', exhibit: current_exhibit.title, application_name: name
+      else
+        name
+      end
+    end
 
     # Can search for named routes directly in the main app, omitting
     # the "main_app." prefix
@@ -13,7 +23,7 @@ module Spotlight
       end
     end
 
-    def respond_to?(method)
+    def respond_to?(method, *args)
       main_app_url_helper?(method) or super
     end
 
@@ -27,28 +37,75 @@ module Spotlight
       end
     end
 
-    def curation_mode_label_class
-      if curation_mode?
-        "warning"
+    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
-        "primary"
+        search_action_url(q: tag)
       end
     end
 
-    def curation_mode?
-      params[:action] == "edit"
+    ##
+    # TODO remove this when we use blacklight 5.2+
+    # Returns a document presenter for the given document
+    def presenter(document)
+      presenter_class.new(document, self)
     end
 
-    def url_to_tag_facet tag
-      if current_exhibit
-        search_action_url(add_facet_params(Spotlight::SolrDocument.solr_field_for_tagger(current_exhibit), tag, {}))
+    ##
+    # Override Blacklight (5.2+) so we use our own presenter
+    def presenter_class
+      Spotlight::DocumentPresenter
+    end
+
+    # Return a copy of the blacklight configuration
+    # that only includes views conifgured by our block
+    def blacklight_view_config_for_search_block sir_tervor_json
+      # Reject any views that aren't configured to display for this block
+      blacklight_config.view.select do |view,_|
+        selected_search_block_views(sir_tervor_json).include? view.to_s
+      end
+    end
+    
+    def block_document_index_view_type block
+      views = blacklight_view_config_for_search_block(block)
+      
+      if views.has_key? document_index_view_type
+        document_index_view_type
       else
-        search_action_url(q: tag)
+        views.keys.first
       end
     end
 
-    private
+    # Return the list of views that are configured to display for a block
+    def selected_search_block_views sir_tervor_json
+      sir_tervor_json.select do |key, value|
+        value == "on"
+      end.keys
+    end
 
+    def render_save_search
+      render('save_search') if render_save_this_search?
+    end
+
+    def render_save_this_search?
+      (current_exhibit and can?( :curate, current_exhibit)) &&
+      (params[:controller] != "spotlight_catalog_controller" && params[:action] != "admin")
+    end
+
+    def select_deselect_button
+      button_tag(
+        t(:".deselect_all"),
+        class: "btn btn-default btn-xs metadata-select",
+        data: {
+          :behavior        => "metadata-select",
+          :'deselect-text' => t(:".deselect_all"),
+          :'select-text'   => t(:".select_all")
+        }
+      )
+    end
+
+    private
 
     def main_app_url_helper?(method)
         (method.to_s.end_with?('_path') or method.to_s.end_with?('_url')) and

data/app/helpers/spotlight/browse_helper.rb

@@ -0,0 +1,8 @@
+module Spotlight
+  module BrowseHelper
+    include ::BlacklightConfigurationHelper
+    def default_document_index_view_type
+      (:gallery if blacklight_config.view.has_key? :gallery) || super
+    end
+  end
+end

data/app/helpers/spotlight/crud_link_helpers.rb

@@ -10,6 +10,18 @@ module Spotlight
       link_to action_default_value(model, :view), link, link_to_options
     end
 
+    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
+      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
       link_to_options = args.extract_options!
       link = args.first || polymorphic_path([spotlight, current_exhibit, model], action: :new)
@@ -24,7 +36,7 @@ module Spotlight
 
     def exhibit_edit_link model, *args
       link_to_options = args.extract_options!
-      link = args.first || polymorphic_path([spotlight, current_exhibit, model], action: :edit)
+      link = args.first || polymorphic_path([spotlight, model.exhibit, model], action: :edit)
       link_to action_default_value(model), link, link_to_options
     end
 
@@ -35,6 +47,13 @@ module Spotlight
       link_to action_default_value(model, :destroy), link, default_options.merge(link_to_options)
     end
 
+    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
       action_default_value model, action
     end

data/app/helpers/spotlight/main_app_helpers.rb

@@ -1,4 +1,7 @@
 module Spotlight::MainAppHelpers
+  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'
@@ -8,4 +11,20 @@ module Spotlight::MainAppHelpers
     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
+    return true unless current_exhibit
+
+    return true if controller.is_a? Spotlight::PagesController
+
+    return current_exhibit.blacklight_configuration.document_index_view_types.include? config.key.to_s
+  end
+  
+  def field_enabled? field, *args
+    field.enabled && field.send((:show if controller.is_a? Blacklight::Catalog and action_name == "show") || document_index_view_type)
+  end
+
 end

data/app/helpers/spotlight/pages_helper.rb

@@ -3,14 +3,11 @@ module Spotlight
     def has_title? document
       document_heading(document) != document.id
     end
-    def should_render_record_thumbnail_title? document, block
-      has_title?(document) && block["show-title"]
-    end
     def item_grid_block_objects(block)
       objects = []
       block.each do |key, value|
         if value.present? and key.include?("item-grid-id")
-          objects << {id: value, display: (block[key.gsub("-id", "-display")] == "true")}
+          objects << {id: value, display: (block[key.gsub("-id", "-display")])}
         end
       end
       objects
@@ -20,5 +17,26 @@ module Spotlight
         object[:id] if object[:display]
       end.compact
     end
+    def multi_up_item_grid_caption(block, document, type='primary')
+      key = "item-grid-#{type}-caption-field"
+      if block[key].present?
+        if block[key] == 'spotlight_title_field'
+          return document_heading(document)
+        else
+          return safe_join(Array(document[block[key]]), ", ")
+        end
+      end
+    end
+    def disable_save_pages_button?
+      page_collection_name == "about_pages" && @pages.empty?
+    end
+    def get_search_widget_search_results sir_trevor_json
+      begin
+        search = Spotlight::Search.find(sir_trevor_json['searches-options'])
+        get_search_results(search.query_params.with_indifferent_access.merge(params))
+      rescue ActiveRecord::RecordNotFound
+        []
+      end
+    end
   end
 end

data/app/helpers/spotlight/{admin_title_helper.rb → title_helper.rb}

@@ -1,5 +1,5 @@
 module Spotlight
-  module AdminTitleHelper
+  module TitleHelper
     def curation_page_title title = nil
       page_title t(:'spotlight.curation.header'), title
     end
@@ -9,10 +9,14 @@ module Spotlight
     end
 
     def page_title section, title = nil
-      @page_title = t(:'spotlight.html_admin_title', section: section, title: title || t(:'.title', default: :'.header'), application_name: application_name)
+      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")
     end
 
+    def set_html_page_title title = nil
+      @page_title = t(:'spotlight.html_title', title: title || t(:'.title', default: :'.header'), application_name: application_name)
+    end
+
     def header_with_count *args
       title, count = if args.length == 2
         args

data/app/mailers/spotlight/confirmation_mailer.rb

@@ -0,0 +1,11 @@
+module Spotlight
+  class ConfirmationMailer < ActionMailer::Base
+    include Devise::Mailers::Helpers
+
+    def confirmation_instructions(record, token, opts)
+      @token = token
+      initialize_from_record(record)
+      mail headers_for(:confirmation_instructions, opts)
+    end
+  end
+end

data/app/models/concerns/spotlight/ar_light.rb

@@ -6,11 +6,18 @@ module Spotlight
     include ActiveRecord::Associations
     include ActiveRecord::Reflection
     include ActiveModel::Dirty
-    included do
-      def self.base_class
+
+    module ClassMethods
+      def base_class
         self
       end
+
+      # required for Rails >= 4.0.4
+      def subclass_from_attributes?(_)
+        false
+      end
     end
+
     def initialize (source_doc={}, solr_response=nil)
       @association_cache = {}
       super

data/app/models/concerns/spotlight/blacklight_configuration_defaults.rb

@@ -0,0 +1,47 @@
+module Spotlight::BlacklightConfigurationDefaults
+  extend ActiveSupport::Concern
+
+  included do
+    before_create :setup_defaults
+  end
+
+
+  protected
+    def setup_defaults
+      default_sort_fields
+      default_view_types
+      set_default_per_page
+      default_thumbnail_size
+    end
+
+    def default_sort_fields
+      return true unless sort_fields.empty?
+
+      # can't use default_blacklight_config until after the BlacklightConfiguration
+      # is created or we run into a circular dependency.
+      default_fields = ::CatalogController.blacklight_config.sort_fields
+      self.sort_fields = default_fields.each_with_object({}) do |(k, v), obj|
+        obj[k] = { show: true }
+      end
+    end
+
+    def default_view_types
+      return true unless document_index_view_types.empty?
+
+      # can't use default_blacklight_config until after the BlacklightConfiguration
+      # is created or we run into a circular dependency.
+      self.document_index_view_types = ::CatalogController.blacklight_config.view.keys.map(&:to_s)
+    end
+
+    def set_default_per_page
+      # can't use default_blacklight_config until after the BlacklightConfiguration
+      # is created or we run into a circular dependency.
+      self.default_per_page ||= ::CatalogController.blacklight_config.per_page.first
+    end
+
+    def default_thumbnail_size
+      self.thumbnail_size ||= 'small'
+    end
+
+
+end