blacklight-spotlight 0.4.1 → 0.5.0

data/app/models/spotlight/contact.rb

@@ -1,39 +1,44 @@
-class Spotlight::Contact < ActiveRecord::Base
-  belongs_to :exhibit, touch: true
-  scope :published, -> { where(show_in_sidebar: true) }
-  default_scope { order("weight ASC") }
-  serialize :contact_info, Hash
+module Spotlight
+  ##
+  # Exhibit curator contact information
+  class Contact < ActiveRecord::Base
+    belongs_to :exhibit, touch: true
+    scope :published, -> { where(show_in_sidebar: true) }
+    default_scope { order('weight ASC') }
+    serialize :contact_info, Hash
 
-  extend FriendlyId
-  friendly_id :name, use: [:slugged,:scoped,:finders], scope: :exhibit
+    extend FriendlyId
+    friendly_id :name, use: [:slugged, :scoped, :finders], scope: :exhibit
 
-  mount_uploader :avatar, Spotlight::AvatarUploader
+    mount_uploader :avatar, Spotlight::AvatarUploader
 
-  ## carrierwave-crop doesn't want to store the crop points. we do.
-  # so instead of this:
-  #crop_uploaded :avatar  ## Add this
-  # we do this:
-  after_save do
-    if avatar.present?
-      avatar.cache! if !avatar.cached?
-      avatar.store!
-      recreate_avatar_versions
+    ## carrierwave-crop doesn't want to store the crop points. we do.
+    # so instead of this:
+    # crop_uploaded :avatar  ## Add this
+    # we do this:
+    after_save do
+      if avatar.present?
+        avatar.cache! unless avatar.cached?
+        avatar.store!
+        recreate_avatar_versions
+      end
     end
-  end
 
-  before_save on: :create do
-    self.show_in_sidebar = true if show_in_sidebar.nil?
-  end
+    before_save on: :create do
+      self.show_in_sidebar = true if show_in_sidebar.nil?
+    end
 
-  def self.fields
-    @fields ||= {title:     {itemprop: 'jobTitle'},
-                 location:  {itemprop: 'workLocation'},
-                 email:     {helper: :render_contact_email_address},
-                 telephone: {}}
-  end
+    def self.fields
+      @fields ||= { title: { itemprop: 'jobTitle' },
+                    location: { itemprop: 'workLocation' },
+                    email: { helper: :render_contact_email_address },
+                    telephone: {} }
+    end
+
+    protected
 
-  protected
-  def should_generate_new_friendly_id?
-    name_changed?
+    def should_generate_new_friendly_id?
+      name_changed?
+    end
   end
 end

data/app/models/spotlight/contact_email.rb

@@ -1,4 +1,6 @@
 module Spotlight
+  ##
+  # Exhibit feedback contacts
   class ContactEmail < ActiveRecord::Base
     extend Devise::Models
     devise :confirmable
@@ -16,14 +18,16 @@ module Spotlight
       confirmation_sent_at > 3.days.ago if confirmation_sent_at?
     end
 
-    protected 
+    protected
 
     def valid_email
       begin
         parsed = Mail::Address.new(email)
       rescue Mail::Field::ParseError => e
+        Rails.logger.debug "Failed to parse email #{email}: #{e}"
       end
-      errors.add :email, "is not valid" unless !parsed.nil? && parsed.address == email && parsed.local != email #cannot be a local address
+
+      errors.add :email, 'is not valid' if parsed.nil? || parsed.address != email || parsed.local == email
     end
 
     def send_devise_notification(notification, *args)
@@ -38,6 +42,5 @@ module Spotlight
     def notification_mailer
       Spotlight::ConfirmationMailer
     end
-
   end
 end

data/app/models/spotlight/contact_form.rb

@@ -1,6 +1,8 @@
 require 'mail_form'
 
 module Spotlight
+  ##
+  # Exhibit feedback form
   class ContactForm < MailForm::Base
     attribute :current_exhibit
     attribute :name, validate: false
@@ -15,9 +17,8 @@ module Spotlight
         subject: "#{I18n.t(:'blacklight.application_name')} Contact Form",
         to: current_exhibit.contact_emails.first,
         from: %("#{name}" <#{email}>),
-        cc: current_exhibit.contact_emails.join(", ")
+        cc: current_exhibit.contact_emails.join(', ')
       }
     end
-
   end
-end
+end

data/app/models/spotlight/custom_field.rb

@@ -1,28 +1,30 @@
 module Spotlight
+  ##
+  # Exhibit custom fields
   class CustomField < ActiveRecord::Base
     serialize :configuration, Hash
     belongs_to :exhibit
-    
+
     extend FriendlyId
-    friendly_id :slug_candidates, use: [:slugged,:scoped,:finders], scope: :exhibit
-    
-    scope :vocab, -> { where(field_type: "vocab") }
+    friendly_id :slug_candidates, use: [:slugged, :scoped, :finders], scope: :exhibit
+
+    scope :vocab, -> { where(field_type: 'vocab') }
 
     before_save do
       self.field ||= field_name
-      self.field_type ||= "text"
+      self.field_type ||= 'text'
     end
 
     before_save do
-      if persisted? and field_type_changed?
+      if persisted? && field_type_changed?
         old_field = self.field
         self.field = field_name
 
-        if exhibit.blacklight_configuration.index_fields.has_key? old_field
-          exhibit.blacklight_configuration.index_fields_will_change!
-          f = exhibit.blacklight_configuration.index_fields.delete(old_field)
-          exhibit.blacklight_configuration.index_fields[field] = f
-          exhibit.blacklight_configuration.save
+        if blacklight_configuration && blacklight_configuration.index_fields.key?(old_field)
+          blacklight_configuration.index_fields_will_change!
+          f = blacklight_configuration.index_fields.delete(old_field)
+          blacklight_configuration.index_fields[field] = f
+          blacklight_configuration.save
         end
 
         Spotlight::RenameSidecarFieldJob.perform_later(exhibit, old_field, self.field)
@@ -30,45 +32,51 @@ module Spotlight
     end
 
     def label=(label)
-      configuration["label"] = label
-      if (field && exhibit)
-        conf = exhibit.blacklight_configuration
-        if conf.index_fields.has_key? field
-          conf.index_fields[field]['label'] = label
-          conf.save!
-        end
-      end
+      configuration['label'] = label
+
+      update_blacklight_configuration_label label
     end
 
     def label
-      conf = if field && exhibit && exhibit.blacklight_configuration.index_fields.has_key?(field)
-        exhibit.blacklight_configuration.index_fields[field].reverse_merge(configuration)
-      else
-        configuration
-      end
-
+      conf = if field && blacklight_configuration && blacklight_configuration.index_fields.key?(field)
+               blacklight_configuration.index_fields[field].reverse_merge(configuration)
+             else
+               configuration
+             end
       conf['label']
     end
 
     def short_description=(short_description)
-      configuration["short_description"] = short_description
+      configuration['short_description'] = short_description
     end
 
     def short_description
-      configuration["short_description"]
+      configuration['short_description']
     end
 
     def configured_to_display?
-      if index_fields_config && index_fields_config["enabled"]
+      index_fields_config &&
+        index_fields_config['enabled'] &&
         view_types.any? do |view|
           index_fields_config[view.to_s]
         end
-      end
     end
 
     protected
+
+    def blacklight_configuration
+      exhibit.blacklight_configuration if exhibit
+    end
+
+    def update_blacklight_configuration_label(label)
+      return unless field && blacklight_configuration && blacklight_configuration.index_fields.key?(field)
+
+      blacklight_configuration.index_fields[field]['label'] = label
+      blacklight_configuration.save
+    end
+
     def field_name
-      "#{Spotlight::Engine.config.solr_fields.prefix}exhibit_#{self.exhibit.to_param}_#{configuration["label"].parameterize}#{field_suffix}"
+      "#{Spotlight::Engine.config.solr_fields.prefix}exhibit_#{exhibit.to_param}_#{configuration['label'].parameterize}#{field_suffix}"
     end
 
     def field_suffix
@@ -76,7 +84,7 @@ module Spotlight
       when 'vocab'
         Spotlight::Engine.config.solr_fields.string_suffix
       else
-        Spotlight::Engine.config.solr_fields.text_suffix    
+        Spotlight::Engine.config.solr_fields.text_suffix
       end
     end
 
@@ -90,7 +98,8 @@ module Spotlight
 
     def should_generate_new_friendly_id?
       true
-    end  
+    end
+
     # Try building a slug based on the following fields in
     # increasing order of specificity.
     def slug_candidates
@@ -99,6 +108,5 @@ module Spotlight
         :field
       ]
     end
-
   end
 end

data/app/models/spotlight/exhibit.rb

@@ -1,153 +1,127 @@
 require 'mail'
-class Spotlight::Exhibit < ActiveRecord::Base
-
-  extend FriendlyId
-  friendly_id :title, use: [:slugged,:finders]
-
-  # friendly id associations need to be 'destroy'ed to reap the slug history 
-  has_many :searches, dependent: :destroy, extend: FriendlyId::FinderMethods
-  has_many :pages, dependent: :destroy
-  has_many :about_pages, extend: FriendlyId::FinderMethods
-  has_many :feature_pages, extend: FriendlyId::FinderMethods
-  has_one :home_page
-  belongs_to :masthead, dependent: :destroy
-  belongs_to :thumbnail, class_name: "Spotlight::FeaturedImage", dependent: :destroy
-
-  has_many :users, through: :roles, class_name: '::User'
-  has_many :custom_fields, dependent: :delete_all
-  has_many :contacts, dependent: :delete_all       # These are the contacts who appear in the sidebar
-  has_many :contact_emails, dependent: :delete_all # These are the contacts who get "Contact us" emails 
-  has_many :main_navigations, dependent: :delete_all
-  has_many :solr_document_sidecars, dependent: :delete_all
-  has_many :roles, dependent: :delete_all
-  has_many :attachments, dependent: :destroy
-
-  has_one :blacklight_configuration, class_name: "Spotlight::BlacklightConfiguration", dependent: :delete
-  has_many :resources
-
-  accepts_nested_attributes_for :solr_document_sidecars
-  accepts_nested_attributes_for :attachments
-  accepts_nested_attributes_for :blacklight_configuration, update_only: true
-  accepts_nested_attributes_for :searches
-  accepts_nested_attributes_for :about_pages
-  accepts_nested_attributes_for :feature_pages
-  accepts_nested_attributes_for :home_page, update_only: true
-  accepts_nested_attributes_for :masthead, update_only: true
-  accepts_nested_attributes_for :thumbnail, update_only: true
-  accepts_nested_attributes_for :main_navigations
-  accepts_nested_attributes_for :contacts
-  accepts_nested_attributes_for :contact_emails, reject_if: proc {|attr| attr['email'].blank?}
-  accepts_nested_attributes_for :roles, allow_destroy: true, reject_if: proc {|attr| attr['user_key'].blank?}
-  accepts_nested_attributes_for :custom_fields
-  accepts_nested_attributes_for :resources
-
-  delegate :blacklight_config, to: :blacklight_configuration
-
-  serialize :facets, Array
-
-  before_create :build_home_page
-  after_create :initialize_config
-  after_create :initialize_browse
-  after_create :initialize_main_navigation
-  before_save :sanitize_description
-
-  after_destroy do
-    # Touch the default exhibit to ensure caching knows that
-    # the exhibits have changed.
-    Spotlight::Exhibit.default.touch
-  end
-
-  validates :title, presence: true
-  acts_as_tagger
-  has_many :owned_taggings, class_name: "ActsAsTaggableOn::Tagging", as: :tagger
-  accepts_nested_attributes_for :owned_taggings
-
-  def main_about_page
-    @main_about_page ||= about_pages.published.first
-  end
-
-  # Find or create the default exhibit
-  def self.default
-    self.find_or_create_by!(default: true) do |e|
-      e.title = 'Default exhibit'.freeze
+module Spotlight
+  ##
+  # Spotlight exhibit
+  class Exhibit < ActiveRecord::Base
+    include Spotlight::ExhibitAnalytics
+
+    extend FriendlyId
+    friendly_id :title, use: [:slugged, :finders]
+    validates :title, presence: true
+
+    acts_as_tagger
+    delegate :blacklight_config, to: :blacklight_configuration
+    serialize :facets, Array
+
+    # Note: friendly id associations need to be 'destroy'ed to reap the slug history
+    has_many :about_pages, extend: FriendlyId::FinderMethods
+    has_many :attachments, dependent: :destroy
+    has_many :contact_emails, dependent: :delete_all # These are the contacts who get "Contact us" emails
+    has_many :contacts, dependent: :delete_all # These are the contacts who appear in the sidebar
+    has_many :custom_fields, dependent: :delete_all
+    has_many :feature_pages, extend: FriendlyId::FinderMethods
+    has_many :main_navigations, dependent: :delete_all
+    has_many :owned_taggings, class_name: 'ActsAsTaggableOn::Tagging', as: :tagger
+    has_many :resources
+    has_many :roles, dependent: :delete_all
+    has_many :searches, dependent: :destroy, extend: FriendlyId::FinderMethods
+    has_many :solr_document_sidecars, dependent: :delete_all
+    has_many :users, through: :roles, class_name: '::User'
+    has_many :pages, dependent: :destroy
+
+    has_one :blacklight_configuration, class_name: 'Spotlight::BlacklightConfiguration', dependent: :delete
+    has_one :home_page
+
+    belongs_to :masthead, dependent: :destroy
+    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy
+
+    accepts_nested_attributes_for :about_pages, :attachments, :contacts, :custom_fields, :feature_pages,
+                                  :main_navigations, :owned_taggings, :resources, :searches, :solr_document_sidecars
+    accepts_nested_attributes_for :blacklight_configuration, :home_page, :masthead, :thumbnail, update_only: true
+    accepts_nested_attributes_for :contact_emails, reject_if: proc { |attr| attr['email'].blank? }
+    accepts_nested_attributes_for :roles, allow_destroy: true, reject_if: proc { |attr| attr['user_key'].blank? }
+
+    before_save :sanitize_description, if: :description_changed?
+    before_create :build_home_page
+    after_create :initialize_config
+    after_create :initialize_browse
+    after_create :initialize_main_navigation
+
+    after_destroy do
+      # Touch the default exhibit to ensure caching knows that
+      # the exhibits have changed.
+      Spotlight::Exhibit.default.touch
     end
-  end
 
-  def has_browse_categories?
-    searches.published.any?
-  end
+    # Find or create the default exhibit
+    def self.default
+      self.find_or_create_by!(default: true) do |e|
+        e.title = 'Default exhibit'.freeze
+      end
+    end
 
-  def to_s
-    title
-  end
+    def self.default?
+      where(default: true).any?
+    end
 
-  def import hash
-    Spotlight::ExhibitExportSerializer.prepare(self).from_hash(hash)
-    self
-  end
+    def main_about_page
+      @main_about_page ||= about_pages.published.first
+    end
 
-  def solr_data
-    { :"#{Spotlight::Engine.config.solr_fields.prefix}spotlight_exhibit_slug_#{slug}#{Spotlight::Engine.config.solr_fields.boolean_suffix}" => true }
-  end
+    def browse_categories?
+      searches.published.any?
+    end
 
-  def appearance
-    Spotlight::Appearance.new(blacklight_configuration)
-  end
+    def to_s
+      title
+    end
 
-  def analytics start_date = 1.month, path = nil
-    return OpenStruct.new unless analytics_provider and analytics_provider.enabled?
-    @analytics ||= {}
-    @analytics[start_date] ||= begin
-      analytics_provider.exhibit_data(path || self, start_date: start_date.ago)
+    def import(hash)
+      Spotlight::ExhibitExportSerializer.prepare(self).from_hash(hash)
+      self
     end
-  end
-  
-  def page_analytics start_date = 1.month, path = nil
-    return [] unless analytics_provider and analytics_provider.enabled?
-    
-    @page_analytics ||= {}
-    @page_analytics[start_date] ||= begin
-      analytics_provider.page_data(path || self, start_date: start_date.ago)
+
+    def solr_data
+      { :"#{Spotlight::Engine.config.solr_fields.prefix}spotlight_exhibit_slug_#{slug}#{Spotlight::Engine.config.solr_fields.boolean_suffix}" => true }
     end
-  end
 
-  def reindex_later
-    Spotlight::ReindexJob.perform_later(self)
-  end
+    def reindex_later
+      Spotlight::ReindexJob.perform_later(self)
+    end
 
-  def uploaded_resource_fields
-    Spotlight::Engine.config.upload_fields
-  end
+    def uploaded_resource_fields
+      Spotlight::Engine.config.upload_fields
+    end
 
-  protected
+    def searchable?
+      blacklight_config.search_fields.any? { |_k, v| v.enabled && v.include_in_simple_select != false }
+    end
 
-  def initialize_config
-    self.blacklight_configuration ||= Spotlight::BlacklightConfiguration.create!
-  end
+    protected
 
-  def initialize_browse
-    return unless self.searches.blank?
+    def initialize_config
+      self.blacklight_configuration ||= Spotlight::BlacklightConfiguration.create!
+    end
 
-    self.searches.create title: "All Exhibit Items",
-      long_description: "All items in this exhibit."
-  end
+    def initialize_browse
+      return unless searches.blank?
 
-  def initialize_main_navigation
-    self.default_main_navigations.each_with_index do |nav_type, weight|
-      self.main_navigations.create nav_type: nav_type, weight: weight
+      searches.create title: 'All Exhibit Items',
+                      long_description: 'All items in this exhibit.'
     end
-  end
 
-  def sanitize_description
-    self.description = ::Rails::Html::FullSanitizer.new.sanitize(description) if description_changed?
-  end
+    def initialize_main_navigation
+      default_main_navigations.each_with_index do |nav_type, weight|
+        main_navigations.create nav_type: nav_type, weight: weight
+      end
+    end
 
-  def default_main_navigations
-    Spotlight::Engine.config.exhibit_main_navigation.dup
-  end
+    def sanitize_description
+      self.description = ::Rails::Html::FullSanitizer.new.sanitize(description)
+    end
 
-  def analytics_provider
-    Spotlight::Engine.config.analytics_provider
+    def default_main_navigations
+      Spotlight::Engine.config.exhibit_main_navigation.dup
+    end
   end
-
 end