blacklight-spotlight 0.0.1

data/app/controllers/spotlight/searches_controller.rb

@@ -0,0 +1,59 @@
+class Spotlight::SearchesController < Spotlight::ApplicationController
+  load_resource :exhibit, class: "Spotlight::Exhibit", only: [:index, :create, :update_all]
+  before_filter :authenticate_user!
+  before_filter :only_curators!
+  load_and_authorize_resource through: :exhibit, shallow: true
+
+  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 main_app.catalog_index_path, notice: "Search has been saved"
+  end
+
+  def index
+  end
+
+  def edit
+    @exhibit = @search.exhibit
+  end
+
+  def update
+    if @search.update params.require(:search).permit(:title, :short_description, :long_description, :featured_image)
+      redirect_to exhibit_searches_path(@search.exhibit), notice: "Search has been saved"
+    else
+      render action: 'edit'
+    end
+  end
+
+  def destroy
+    @search.destroy
+    redirect_to exhibit_searches_path(@search.exhibit), alert: "Search was deleted"
+  end
+
+  def update_all
+    notice = if @exhibit.update search_params
+      "Searches were successfully updated."
+    else
+      "There was an error updating the requested searches."
+    end
+    redirect_to :back, notice: notice
+  end
+
+  protected
+
+  def search_params
+    params.require(:exhibit).permit("searches_attributes" => [:id, :on_landing_page, :weight])
+  end
+
+  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

data/app/helpers/spotlight/application_helper.rb

@@ -0,0 +1,36 @@
+module Spotlight
+  module ApplicationHelper
+
+    # search_action_url is a special Blacklight helper (not a route),
+    # so it doesn't get caught by the method_missing logic below.
+    # TODO: we should consider making this configurable
+    def search_action_url *args
+      if controller_path == 'spotlight/catalog'
+        catalog_index_url *args
+      else
+        main_app.catalog_index_url *args
+      end
+    end
+
+    # Can search for named routes directly in the main app, omitting
+    # the "main_app." prefix
+    def method_missing method, *args, &block
+      if main_app_url_helper?(method)
+        main_app.send(method, *args)
+      else
+        super
+      end
+    end
+
+    def respond_to?(method)
+      main_app_url_helper?(method) or super
+    end
+
+    private
+
+    def main_app_url_helper?(method)
+        (method.to_s.end_with?('_path') or method.to_s.end_with?('_url')) and
+        main_app.respond_to?(method)
+    end
+  end
+end

data/app/helpers/spotlight/attachments_helper.rb

@@ -0,0 +1,4 @@
+module Spotlight
+  module AttachmentsHelper
+  end
+end

data/app/helpers/spotlight/home_pages_helper.rb

@@ -0,0 +1,22 @@
+module Spotlight::HomePagesHelper
+  include Blacklight::UrlHelperBehavior
+
+  ##
+  # Standard display of a facet value in a list. Used in both _facets sidebar
+  # partial and catalog/facet expanded list. Will output facet value name as
+  # a link to add that to your restrictions, with count in parens.
+  #
+  # @param [Blacklight::SolrResponse::Facets::FacetField]
+  # @param [String] facet item
+  # @param [Hash] options
+  # @option options [Boolean] :suppress_link display the facet, but don't link to it
+  # @option options [Rails::Engine] :route_set route set to use to render the link
+  # @return [String]
+  def render_facet_value(facet_solr_field, item, options ={})    
+    scope = options.delete(:route_set) || main_app
+    path = scope.catalog_index_url(add_facet_params_and_redirect(facet_solr_field, item).merge(only_path: true))
+    content_tag(:span, :class => "facet-label") do
+      link_to_unless(options[:suppress_link], facet_display_value(facet_solr_field, item), path, :class=>"facet_select")
+    end + render_facet_count(item.hits)
+  end
+end

data/app/helpers/spotlight/main_app_helpers.rb

@@ -0,0 +1,9 @@
+module Spotlight::MainAppHelpers
+  def on_browse_page?
+    params[:controller] == 'spotlight/browse'
+  end
+
+  def on_about_page?
+    params[:controller] == 'spotlight/about_pages'
+  end
+end

data/app/helpers/spotlight/pages_helper.rb

@@ -0,0 +1,10 @@
+module Spotlight
+  module PagesHelper
+    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
+  end
+end

data/app/models/ability.rb

@@ -0,0 +1,3 @@
+class Ability
+  include Spotlight::Ability
+end

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

@@ -0,0 +1,6 @@
+module Spotlight::User
+  extend ActiveSupport::Concern
+  included do
+    has_many :roles, class_name: 'Spotlight::Role'
+  end
+end

data/app/models/spotlight/ability.rb

@@ -0,0 +1,32 @@
+module Spotlight::Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    user ||= ::User.new
+    
+    # This is the "right" way to do it. But it doesn't work in rails 4
+    # until this PR is merged: https://github.com/ryanb/cancan/pull/917
+    # can :create, Spotlight::Exhibit, admin_roles: { id: user.role_ids } 
+    # Until then, workaround:
+    can [:update], Spotlight::Exhibit do |exhibit|
+      exhibit.roles.where(id: user.role_ids, role: 'admin').any?
+    end
+
+    can [:update, :edit_metadata_fields, :edit_facet_fields], Spotlight::BlacklightConfiguration do |config|
+      config.exhibit.roles.where(id: user.role_ids).any?
+    end
+
+    can [:curate], Spotlight::Exhibit do |exhibit|
+      # any curator or admin role
+      exhibit.roles.where(id: user.role_ids).any?
+    end
+
+    can [:read, :index], [Spotlight::Exhibit, Spotlight::Page, Spotlight::Search]
+
+      # any curator or admin role
+    if Spotlight::Exhibit.default.roles.where(id: user.role_ids).any?
+      can [:create, :update, :destroy], [Spotlight::Search, Spotlight::Page]
+      can :update_all, [Spotlight::Search, Spotlight::Page]
+    end
+  end
+end

data/app/models/spotlight/about_page.rb

@@ -0,0 +1,4 @@
+module Spotlight
+  class AboutPage < Spotlight::Page
+  end
+end

data/app/models/spotlight/attachment.rb

@@ -0,0 +1,9 @@
+module Spotlight
+  class Attachment < ActiveRecord::Base
+    mount_uploader :file, AttachmentUploader
+
+    def as_json(options = nil)
+      file.as_json(options).merge(:name => name, :uid => uid, :id => id, :class => self.class.to_s)
+    end
+  end
+end

data/app/models/spotlight/blacklight_configuration.rb

@@ -0,0 +1,145 @@
+require 'blacklight/utils'
+
+module Spotlight
+  class BlacklightConfiguration < ActiveRecord::Base
+    has_one :exhibit
+    serialize :facet_fields, Hash
+    serialize :index_fields, Hash
+    serialize :sort_fields, Hash
+    serialize :default_solr_params, Hash
+    serialize :show, Hash
+    serialize :index, Hash
+    serialize :per_page, Array
+    serialize :document_index_view_types, Array
+
+    # get rid of empty values
+    before_validation do |model|
+
+      model.index_fields.each do |k,v|
+        v[:enabled] ||= v.any? { |k1, v1| !v1.blank? }
+
+        default_blacklight_config.view.keys.each do |view|
+          v[view] &&= (v[view] == "1")
+        end
+
+        v[:show] &&= (v[:show] == "1")
+
+        v.reject! { |k, v1| v1.blank? and !v1 === false }
+      end if model.index_fields
+
+      [:facet_fields, :sort_fields].each do |field|
+        model.send(field).each do |k,v|
+          v[:enabled] &&= (v[:enabled] == "1")
+          v[:enabled] ||= true if v[:enabled].nil?
+          v.reject! { |k, v1| v1.blank? and !v1 === false }
+        end if model.send(field)
+      end
+
+      model.per_page.reject!(&:blank?) if model.per_page
+      model.document_index_view_types.reject!(&:blank?) if model.document_index_view_types
+    end
+
+    ##
+    # Serialize this configuration to a Blacklight::Configuration object 
+    # appropriate to the current view. If a value isn't set in this record,
+    # it will use the configuration set upstream (in default_blacklight_config)
+    # @param [String] view the configuration may be different depending on the index view selected
+    def blacklight_config view = :list
+      config = default_blacklight_config.inheritable_copy
+
+      config.show.merge! show unless show.blank?
+      config.index.merge! index unless index.blank?
+
+      config.default_solr_params = config.default_solr_params.merge(default_solr_params)
+
+      
+      show_fields = index_fields_for_view(:show)
+      unless show_fields.blank?
+        active_show_fields = show_fields.select { |k,v| v[:enabled] == true }
+        config.show_fields = config.index_fields.slice *active_show_fields.keys
+        config.show_fields = Hash[config.show_fields.sort_by { |k,v| active_show_fields.keys.index k }]
+
+        config.index_fields.each do |k, v|
+          next if show_fields[k].blank?
+
+          v.merge! show_fields[k].symbolize_keys
+          v.normalize! config
+          v.validate!
+        end
+      end
+
+      unless index_fields_for_view(view).blank?
+        active_index_fields = index_fields_for_view(view).select { |k,v| v[:enabled] == true }
+        config.index_fields.slice! *active_index_fields.keys
+        config.index_fields = Hash[config.index_fields.sort_by { |k,v| active_index_fields.keys.index k }]
+
+        config.index_fields.each do |k, v|
+          next if index_fields[k].blank?
+
+          v.merge! index_fields[k].symbolize_keys
+          v.normalize! config
+          v.validate!
+        end
+      end
+
+      unless sort_fields.blank?
+        active_sort_fields = sort_fields.select { |k,v| v[:enabled] == true }
+        config.sort_fields.slice! *active_sort_fields.keys
+        config.sort_fields = Hash[config.sort_fields.sort_by { |k,v| active_sort_fields.keys.index k }]
+
+        config.sort_fields.each do |k, v|
+          next if sort_fields[k].blank?
+
+          v.merge! sort_fields[k].symbolize_keys
+          v.normalize! config
+          v.validate!
+        end
+      end
+
+      unless facet_fields.blank?
+        active_facet_fields = facet_fields.select { |k,v| v[:enabled] == true }
+        config.facet_fields.slice! *active_facet_fields.keys
+        config.facet_fields = Hash[config.facet_fields.sort_by { |k,v| active_facet_fields.keys.index k }]
+
+        config.facet_fields.each do |k, v|
+          next if facet_fields[k].blank?
+
+          v.merge! facet_fields[k].symbolize_keys
+          v.normalize! config
+          v.validate!
+        end
+      end
+
+      config.per_page = (config.per_page & per_page) unless per_page.blank?
+      config.view.select! { |k, v| document_index_view_types.include? k.to_s } unless document_index_view_types.blank?
+
+      config
+    end
+
+    def all_facet_fields
+      default_blacklight_config.facet_fields.sort_by { |k,v| facet_fields.keys.index k }
+    end
+
+    def all_index_fields
+      default_blacklight_config.index_fields.sort_by { |k,v| index_fields.keys.index k }
+    end
+
+    ##
+    # Get the index fields that should be visible for the given view; if the view is
+    # not found, just use the list view.
+    # @param [String] view 
+    def index_fields_for_view view = :list
+      index_fields.select do |key, config|
+        config.with_indifferent_access[:enabled] &&
+          config.with_indifferent_access[view]
+      end
+    end
+
+    ##
+    # Get the "upstream" blacklight configuration to use
+    def default_blacklight_config
+      ::CatalogController.blacklight_config
+    end
+
+  end
+end

data/app/models/spotlight/contact_form.rb

@@ -0,0 +1,21 @@
+require 'mail_form'
+
+module Spotlight
+  class ContactForm < MailForm::Base
+    attribute :name, validate: false
+    attribute :email, validate: /\A([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})\z/i
+    attribute :message
+    attribute :current_url
+
+    append :remote_ip, :user_agent
+
+    def headers
+      {
+        subject: "#{I18n.t(:'blacklight.application_name')} Contact Form",
+        to: Spotlight::Exhibit.default.contact_emails.first,
+        from: %("#{name}" <#{email}>),
+        cc: Spotlight::Exhibit.default.contact_emails.join(", ")
+      }
+    end
+  end
+end

data/app/models/spotlight/exhibit.rb

@@ -0,0 +1,71 @@
+require 'mail'
+class Spotlight::Exhibit < ActiveRecord::Base
+  DEFAULT = 'default'.freeze
+  has_many :roles
+  has_many :searches
+  has_many :about_pages
+  has_many :feature_pages
+  has_one :home_page
+  has_many :home_pages
+
+  belongs_to :blacklight_configuration, class_name: Spotlight::BlacklightConfiguration
+  accepts_nested_attributes_for :blacklight_configuration
+  accepts_nested_attributes_for :searches
+  accepts_nested_attributes_for :about_pages
+  accepts_nested_attributes_for :feature_pages
+  delegate :blacklight_config, to: :blacklight_configuration
+
+  serialize :facets, Array
+  serialize :contact_emails, Array
+
+  before_save :sanitize_description
+  validate :name, :title, presence: true
+  validate :valid_emails
+
+  # This is necessary so the form will draw as if we have nested attributes (fields_for).
+  def contact_emails
+    super.each do |e|
+      def e.persisted?
+        false
+      end
+    end
+  end
+
+  # The attributes setter is required so the form will draw as if we have nested attributes (fields_for)
+  def contact_emails_attributes=(emails)
+    attributes_collection = emails.is_a?(Hash) ? emails.values : emails
+    self.contact_emails = attributes_collection.map {|e| e['email']}.reject(&:blank?)
+  end
+
+  def main_about_page
+    about_pages.published.first
+  end
+
+  # Find or create the default exhibit
+  def self.default
+    self.find_or_create_by!(name: DEFAULT) do |e|
+      e.title = 'Default exhibit'.freeze
+      e.blacklight_configuration = Spotlight::BlacklightConfiguration.create!
+    end
+  end
+
+  def has_browse_categories?
+    searches.published.any?
+  end
+
+  protected
+
+  def valid_emails
+    contact_emails.each do |email|
+      begin
+        parsed = Mail::Address.new(email)
+      rescue Mail::Field::ParseError => e
+      end
+      errors.add :contact_emails, "#{email} is not valid" unless !parsed.nil? && parsed.address == email && parsed.local != email #cannot be a local address
+    end
+  end
+
+  def sanitize_description
+    self.description = HTML::FullSanitizer.new.sanitize(description) if description_changed?
+  end
+end