blacklight-spotlight 0.0.2 → 0.0.3

data/app/helpers/spotlight/application_helper.rb

@@ -1,5 +1,7 @@
 module Spotlight
   module ApplicationHelper
+    include CrudLinkHelpers
+    include AdminTitleHelper
 
     # Can search for named routes directly in the main app, omitting
     # the "main_app." prefix
@@ -37,8 +39,17 @@ module Spotlight
       params[:action] == "edit"
     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, {}))
+      else
+        search_action_url(q: tag)
+      end
+    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)

data/app/helpers/spotlight/crud_link_helpers.rb

@@ -0,0 +1,68 @@
+module Spotlight
+  module CrudLinkHelpers
+    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
+      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_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
+      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
+      link_to_options = args.extract_options!
+      link = args.first || polymorphic_path([spotlight, current_exhibit, model], action: :edit)
+      link_to action_default_value(model), link, link_to_options
+    end
+
+    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 action_label model, action
+      action_default_value model, action
+    end
+
+    private
+
+    def action_default_value object, key = nil
+      object_model = convert_to_model(object)
+
+      key ||= object_model ? (object_model.persisted? ? :edit : :create) : :view
+      
+      case object_model
+      when ActsAsTaggableOn::Tag
+        model = :tag
+        object_name = :tag
+      when Symbol, String
+        model = object_model
+        object_name = object_model
+      else
+        model = object_model.class.model_name.human
+        object_name = object_model.class.model_name.i18n_key
+      end
+
+      defaults = []
+      defaults << :"helpers.action.#{object_name}.#{key}"
+      defaults << :"helpers.action.#{key}"
+      defaults << "#{key.to_s.humanize} #{model}"
+      I18n.t(defaults.shift, model: model, default: defaults)
+    end
+  end
+end

data/app/helpers/spotlight/main_app_helpers.rb

@@ -7,19 +7,5 @@ module Spotlight::MainAppHelpers
   def on_about_page?
     params[:controller] == 'spotlight/about_pages'
   end
-
-  def exhibit_specific_field opts = {}
-    document = opts[:document]
-    field = opts[:field]
-
-    document.sidecar(current_exhibit).data[field]
-  end
   
-  def should_render_index_field? document, solr_field
-    super || document.sidecar(current_exhibit).has_key?(solr_field.field)
-  end
-
-  def should_render_show_field? document, solr_field
-    super || document.sidecar(current_exhibit).has_key?(solr_field.field)
-  end
-end
+end

data/app/helpers/spotlight/pages_helper.rb

@@ -6,5 +6,19 @@ module Spotlight
     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")}
+        end
+      end
+      objects
+    end
+    def item_grid_block_ids(block)
+      item_grid_block_objects(block).map do |object|
+        object[:id] if object[:display]
+      end.compact
+    end
   end
 end

data/app/helpers/spotlight/roles_helper.rb

@@ -0,0 +1,7 @@
+module Spotlight::RolesHelper
+  def roles_for_select
+    Spotlight::Role::ROLES.each_with_object({}) do |key, object|
+      object[t("spotlight.role.#{key}")] = key
+    end
+  end
+end

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

@@ -15,6 +15,22 @@ module Spotlight
       @association_cache = {}
       super
     end
+
+    # Returns true if +comparison_object+ is the same exact object, or +comparison_object+
+    # is of the same type and +self+ has an ID and it is equal to +comparison_object.id+.
+    #
+    # Note that new records are different from any other record by definition, unless the
+    # other record is the receiver itself. Besides, if you fetch existing records with
+    # +select+ and leave the ID out, you're on your own, this predicate will return false.
+    #
+    # Note also that destroying a record preserves its ID in the model instance, so deleted
+    # models are still comparable.
+    def ==(comparison_object)
+      super ||
+        comparison_object.instance_of?(self.class) &&
+        id &&
+        comparison_object.id == id
+    end
       
     module ClassMethods
       def generated_feature_methods

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

@@ -9,6 +9,7 @@ module Spotlight
       extend Finder
 
       acts_as_taggable
+      has_many :sidecars, class_name: 'Spotlight::SolrDocumentSidecar'
     end
 
     module ClassMethods
@@ -24,6 +25,8 @@ module Spotlight
 
       def reindex(id)
         find(id).reindex
+      rescue Blacklight::Exceptions::InvalidSolrID
+        # no-op
       end
     end
 
@@ -41,7 +44,7 @@ module Spotlight
     end
 
     def reindex
-      #TODO implement this
+      # no-op reindex implementation
     end
 
     def save
@@ -66,8 +69,55 @@ module Spotlight
     end
 
     def sidecar exhibit
-      @sidecar ||= SolrDocumentSidecar.find_or_initialize_by exhibit: exhibit, solr_document_id: self.id
+      sidecars.first_or_initialize(exhibit: exhibit)
     end
+
+    def to_solr
+      { id: id }.reverse_merge(sidecars.inject({}) { |result, sidecar| result.merge(sidecar.to_solr) }).merge(tags_to_solr)
+    end
+
+    def self.solr_field_for_tagger tagger
+      :"#{tagger.class.model_name.param_key}_#{tagger.id}_tags_ssim"
+    end
+
+    def self.visibility_field exhibit
+      :"#{exhibit.class.model_name.param_key}_#{exhibit.id}_public_bsi"
+    end
+
+    def make_public! exhibit
+      sidecar(exhibit).public!
+    end
+
+    def make_private! exhibit
+      sidecar(exhibit).private!
+    end
+
+    def private? exhibit
+      !(public?(exhibit))
+    end
+
+    def public? exhibit
+      sidecar(exhibit).public?
+    end
+
+    protected
+    def tags_to_solr
+      h = {}
+
+      # Adding a placeholder entry in case the last tag for an exhibit
+      # is removed, so we clear out the solr field too.
+      Spotlight::Exhibit.find_each do |exhibit|
+        h[Spotlight::SolrDocument.solr_field_for_tagger(exhibit)] = nil
+      end
+
+      taggings.includes(:tag, :tagger).map do |tagging|
+        key = Spotlight::SolrDocument.solr_field_for_tagger(tagging.tagger)
+        h[key] ||= []
+        h[key] << tagging.tag.name
+      end
+      h
+    end
+
   end
 end
 

data/app/models/concerns/spotlight/solr_document/atomic_updates.rb

@@ -0,0 +1,22 @@
+module Spotlight::SolrDocument::AtomicUpdates
+
+  def reindex
+    solr_hash = hash_for_solr_update
+    return if solr_hash.length == 1
+
+    blacklight_solr.update params: { commitWithin: 500 }, data: [solr_hash].to_json, headers: { 'Content-Type' => 'application/json'}
+  end
+
+  private
+  def hash_for_solr_update
+    Hash[to_solr.map do |k,v|
+      val = if k == :id
+        v
+      else
+        { set: v }
+      end
+
+      [k,val]
+    end] 
+  end
+end

data/app/models/spotlight/ability.rb

@@ -8,33 +8,23 @@ module Spotlight::Ability
     # 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, id: user.admin_roles.map(&:exhibit_id)
 
-    can [:index, :update, :destroy, :create], Spotlight::Role, exhibit_id: user.admin_roles.map(&:exhibit_id)
+    # exhibit admin 
+    can :manage, Spotlight::Exhibit, id: user.admin_roles.map(&:exhibit_id)
+    can :manage, [Spotlight::Role], exhibit_id: user.admin_roles.map(&:exhibit_id)
 
+    # exhibit curator
+    can :manage, [
+      Spotlight::Search,
+      Spotlight::Page,
+      Spotlight::BlacklightConfiguration,
+      Spotlight::Contact,
+      Spotlight::CustomField], exhibit_id: user.roles.map(&:exhibit_id)
 
-    can [:update, :edit_metadata_fields, :edit_facet_fields], Spotlight::BlacklightConfiguration do |config|
-      config.exhibit.roles.where(id: user.role_ids).any?
-    end
-
-    can :manage, Spotlight::CustomField 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 [:curate, :tag], Spotlight::Exhibit, id: user.roles.map(&:exhibit_id)
 
+    # public
     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] #TODO make these specific to the owning exhibit
-      can :update, ::SolrDocument
-
-      can [:index, :destroy], ActsAsTaggableOn::Tag
-    end
   end
 end

data/app/models/spotlight/blacklight_configuration.rb

@@ -2,7 +2,7 @@ require 'blacklight/utils'
 
 module Spotlight
   class BlacklightConfiguration < ActiveRecord::Base
-    has_one :exhibit
+    belongs_to :exhibit
     serialize :facet_fields, Hash
     serialize :index_fields, Hash
     serialize :sort_fields, Hash
@@ -27,13 +27,17 @@ module Spotlight
         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] &&= ActiveRecord::ConnectionAdapters::Column.value_to_boolean(v[:enabled])
-          v[:enabled] ||= true if v[:enabled].nil?
-          v.reject! { |k, v1| v1.blank? and !v1 === false }
-        end if model.send(field)
-      end
+      model.facet_fields.each do |k,v|
+        v[:show] &&= ActiveRecord::ConnectionAdapters::Column.value_to_boolean(v[:show])
+        v[:show] ||= true if v[:show].nil?
+        v.reject! { |k, v1| v1.blank? and !v1 === false }
+      end if model.facet_fields
+
+      model.sort_fields.each do |k,v|
+        v[:enabled] &&= ActiveRecord::ConnectionAdapters::Column.value_to_boolean(v[:enabled])
+        v[:enabled] ||= true if v[:enabled].nil?
+        v.reject! { |k, v1| v1.blank? and !v1 === false }
+      end if model.sort_fields
 
       model.per_page.reject!(&:blank?) if model.per_page
       model.document_index_view_types.reject!(&:blank?) if model.document_index_view_types
@@ -102,9 +106,7 @@ module Spotlight
       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| field_weight(active_facet_fields, k) }]
+        config.facet_fields = Hash[config.facet_fields.sort_by { |k,v| field_weight(facet_fields, k) }]
 
         config.facet_fields.each do |k, v|
           next if facet_fields[k].blank?
@@ -131,7 +133,7 @@ module Spotlight
 
     def custom_index_fields
       Hash[exhibit.custom_fields.map do |x| 
-        field = Blacklight::Configuration::IndexField.new x.configuration.merge(field: x.field, helper_method: :exhibit_specific_field)
+        field = Blacklight::Configuration::IndexField.new x.configuration.merge(field: x.field)
         [x.field, field] 
       end]
     end
@@ -150,7 +152,11 @@ module Spotlight
     ##
     # Get the "upstream" blacklight configuration to use
     def default_blacklight_config
-      ::CatalogController.blacklight_config
+      @default_blacklight_config ||= begin
+        config = ::CatalogController.blacklight_config.deep_copy
+        config.add_facet_field Spotlight::SolrDocument.solr_field_for_tagger(exhibit), label: "Exhibit Tags", show: false
+        config
+      end
     end
 
     protected

data/app/models/spotlight/contact.rb

@@ -0,0 +1,5 @@
+class Spotlight::Contact < ActiveRecord::Base
+  belongs_to :exhibit
+  scope :published, -> { where(show_in_sidebar: true) }
+  default_scope { order("weight ASC") }
+end

data/app/models/spotlight/contact_form.rb

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

data/app/models/spotlight/custom_field.rb

@@ -22,10 +22,16 @@ module Spotlight
     def short_description
       configuration["short_description"]
     end
+    
+    protected 
+    SUFFIX = '_tesim'.freeze
+    def self.with_suffix(field)
+      field.to_s + SUFFIX
+    end
 
     private
     def field_name
-      "exhibit_#{self.exhibit.to_param}_#{label.parameterize}"
+      CustomField.with_suffix("exhibit_#{self.exhibit.to_param}_#{label.parameterize}")
     end
 
   end

data/app/models/spotlight/exhibit.rb

@@ -9,13 +9,15 @@ class Spotlight::Exhibit < ActiveRecord::Base
   has_many :home_pages
   has_many :users, through: :roles, class_name: '::User'
   has_many :custom_fields
+  has_many :contacts
+  has_one :blacklight_configuration, class_name: Spotlight::BlacklightConfiguration
 
-  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
-  accepts_nested_attributes_for :roles, allow_destroy: true
+  accepts_nested_attributes_for :contacts
+  accepts_nested_attributes_for :roles, allow_destroy: true, reject_if: proc {|attr| attr['user_key'].blank?}
   delegate :blacklight_config, to: :blacklight_configuration
 
   serialize :facets, Array
@@ -43,7 +45,7 @@ class Spotlight::Exhibit < ActiveRecord::Base
   end
 
   def main_about_page
-    about_pages.published.first
+    @main_about_page ||= about_pages.published.first
   end
 
   # Find or create the default exhibit