atrium 0.0.1 → 0.1.1

data/app/models/atrium/collection.rb

@@ -1,9 +1,28 @@
+require 'friendly_id'
+# An Atrium::Collection contains a subset of the items in the complete index as
+# defined by a Solr query. An explicitly declared subset of the total facets can
+# be applied to these items. An Atrium::Collection description and or featured
+# items form the Atrium::Collection can be displayed at the top level
+# Atrium::Collection page. Collections can be themed independently of the base
+# application and other collections.
 class Atrium::Collection < ActiveRecord::Base
-  self.table_name = 'atrium_collections'
+  extend FriendlyId
+  friendly_id :url_slug, use: :slugged, slug_column: :url_slug
 
+  validate(
+    :title,
+    presence: true,
+    uniqueness: true,
+    length: { maximum: 255, minimum: 3 }
+  )
+  validate(
+    :url_slug,
+    presence: true,
+    uniqueness: true,
+    length: { maximum: 255, minimum: 3 }
+  )
   attr_accessible(
     :collection_items,
-    :filter_query_params,
     :theme,
     :title,
     :title_markup,
@@ -15,56 +34,56 @@ class Atrium::Collection < ActiveRecord::Base
     :search_facets_attributes
   )
 
-  has_many(
-    :showcases,
-    :class_name => 'Atrium::Showcase',
-    :as => :showcases,
-    :dependent => :destroy
-  )
+  include Atrium::IsShowcasedMixin
 
   has_many(
     :search_facets,
-    :class_name => 'Atrium::Search::Facet',
-    :foreign_key => 'atrium_collection_id',
-    :dependent => :destroy
+    class_name: 'Atrium::Search::Facet',
+    foreign_key: 'atrium_collection_id',
+    dependent: :destroy,
+    inverse_of: :collection,
+    autosave: true
   )
 
-  accepts_nested_attributes_for :search_facets, :allow_destroy => true
+  accepts_nested_attributes_for :search_facets, allow_destroy: true
 
   def search_facet_names
-    search_facets.map{|facet| facet.name }
+    search_facets.pluck(:name)
   end
 
+
   def search_facet_names=(collection_of_facet_names)
-    existing_facet_names = search_facets.map{|facet| facet.name }
-    add_collection_of_facets_by_name( collection_of_facet_names - existing_facet_names )
-    remove_collection_of_facets_by_name( existing_facet_names - collection_of_facet_names )
+    existing_facet_names = search_facet_names
+    add_collection_of_facets_by_name(
+      collection_of_facet_names - existing_facet_names
+    )
+    remove_collection_of_facets_by_name(
+      existing_facet_names - collection_of_facet_names
+    )
   end
 
   def add_collection_of_facets_by_name(collection_of_facet_names)
     collection_of_facet_names.each do |name|
-      search_facets << Atrium::Search::Facet.find_or_create_by_name_and_collection_id(name, id)
+      search_facets.find_or_initialize_by_name(name) if name.present?
     end
   end
   private :add_collection_of_facets_by_name
 
   def remove_collection_of_facets_by_name(collection_of_facet_names)
-    collection_of_facet_names.each do |name|
-      search_facets.delete(Atrium::Search::Facet.find_by_name_and_collection_id(name, id))
-    end
+    search_facets.where("name IN (?)", collection_of_facet_names).destroy_all
   end
   private :remove_collection_of_facets_by_name
 
 
   has_many(
     :exhibits,
-    :class_name => 'Atrium::Exhibit',
-    :foreign_key => 'atrium_collection_id',
-    :order => 'set_number ASC',
-    :dependent => :destroy
+    class_name: 'Atrium::Exhibit',
+    foreign_key: 'atrium_collection_id',
+    order: 'set_number ASC',
+    dependent: :destroy
   )
 
-  accepts_nested_attributes_for :exhibits, :allow_destroy => true
+  accepts_nested_attributes_for :exhibits, allow_destroy: true
 
   def exhibit_order
     exhibit_order = {}
@@ -75,31 +94,43 @@ class Atrium::Collection < ActiveRecord::Base
   def exhibit_order=(exhibit_order = {})
     valid_ids = exhibits.select(:id).map{|exhibit| exhibit[:id]}
     exhibit_order.each_pair do |id, order|
-      Atrium::Exhibit.find(id).update_attributes!(:set_number => order) if valid_ids.include?(id.to_i)
+      if valid_ids.include?(id.to_i)
+        Atrium::Exhibit.find(id).update_attributes!(set_number: order)
+      end
     end
   end
 
-  @@included_themes = ['default']
+  @@included_themes = ['Default']
   def self.available_themes
     return @@available_themes if defined? @@available_themes
-    # NOTE: theme filenames should conform to rails expectations and only use periods to delimit file extensions
-    local_themes = Dir.entries(File.join(Rails.root, 'app/views/layouts/atrium_themes')).reject {|f| f =~ /^\./}
-    local_themes.collect!{|f| f.split('.').first}
-    @@available_themes = @@included_themes + local_themes
+    # NOTE: theme filenames should conform to rails expectations and only use
+    # periods to delimit file extensions
+    begin
+      local_themes = Dir.entries(
+        Rails.root.join('app/views/layouts/atrium/themes').to_s
+      ).reject {|f| f =~ /^[\._]/}
+      local_themes.collect!{|f| f.split('.').first.titleize}
+      @@available_themes = @@included_themes + local_themes
+    rescue Errno::ENOENT
+      @@included_themes
+    end
   end
 
+
   def theme_path
-    theme.blank? ? 'atrium_themes/default' : "atrium_themes/#{theme}"
+    theme.blank? ? 'atrium/themes/default' : "atrium/themes/#{theme.downcase}"
   end
 
-
-  serialize :filter_query_params
+  include Atrium::QueryParamMixin
 
   serialize :collection_items, Hash
   def collection_items
     read_attribute(:collection_items) || write_attribute(:collection_items, {})
   end
 
+  def collection
+    self
+  end
 
   def solr_doc_ids
     collection_items[:solr_doc_ids] unless collection_items.blank?
@@ -110,12 +141,15 @@ class Atrium::Collection < ActiveRecord::Base
   end
 
   def display_title
-    has_custom_title? ? title_markup.html_safe : "<h2>#{pretty_title}</h2>".html_safe
+    if has_custom_title?
+      title_markup.html_safe
+    else
+      "<h2>#{pretty_title}</h2>".html_safe
+    end
   end
 
   def has_custom_title?
     !title_markup.blank?
   end
   private :has_custom_title?
-
 end

data/app/models/atrium/configuration.rb

@@ -0,0 +1,66 @@
+module Atrium
+  # This class is intended to be a decorator for the Blacklight::Configuration,
+  # yet could stand alone without Blacklight.
+  class Configuration < SimpleDelegator
+    def initialize(default_configuration)
+      super(default_configuration)
+      yield(self) if block_given?
+    end
+
+    attr_writer :application_name
+    def application_name
+      @application_name || super
+    rescue NoMethodError
+      ''
+    end
+
+    def label_for_facet(facet_name)
+      facet_fields[facet_name].label
+    rescue NoMethodError, NameError
+      facet_name
+    end
+
+    attr_writer :saved_search_class
+    def saved_search_class
+      if @saved_search_class.respond_to?(:constantize)
+        @saved_search_class.constantize
+      else
+        raise(Atrium::ConfigurationNotSet, 'Atrium.config.saved_search_class')
+      end
+    end
+
+    attr_writer :saved_items_class
+    def saved_items_class
+      if @saved_items_class.respond_to?(:constantize)
+        @saved_items_class.constantize
+      else
+        raise(Atrium::ConfigurationNotSet, 'Atrium.config.saved_items_class')
+      end
+    end
+
+    def query_param_beautifier=(callable)
+      if callable.nil?
+        @query_param_beautifier = nil
+        return callable
+      end
+      if ! callable.respond_to?(:call)
+        message = "Expected Atrium.query_param_beautifier to respond to :call"
+        raise Atrium::ConfigurationExpectation, message
+      end
+      if callable.arity != 2
+        message = "Expected Atrium.query_param_beautifier to require 2 args"
+        raise Atrium::ConfigurationExpectation, message
+      end
+      @query_param_beautifier = callable
+    end
+
+    def query_param_beautifier(context,query_params)
+      if defined?(@query_param_beautifier) && @query_param_beautifier
+        @query_param_beautifier.call(context,query_params)
+      else
+        query_params.inspect
+      end
+    end
+
+  end
+end

data/app/models/atrium/description.rb

@@ -1,37 +1,53 @@
-require 'sanitize'
 class Atrium::Description < ActiveRecord::Base
-  self.table_name = 'atrium_descriptions'
-
   belongs_to(
     :showcase,
-    :class_name => 'Atrium::Showcase',
-    :foreign_key => 'atrium_showcase_id'
+    class_name: 'Atrium::Showcase',
+    foreign_key: 'atrium_showcase_id',
+    inverse_of: :descriptions
+  )
+
+  validate(
+    :showcase,
+    presence: true
   )
 
   has_one(
     :summary,
-    :class_name => 'Atrium::Essay',
-    :conditions => "\"atrium_essays\".content_type = \"summary\"",
-    :foreign_key => 'atrium_description_id',
-    :dependent => :destroy
+    class_name: 'Atrium::Essay',
+    conditions: "\"atrium_essays\".content_type = \"summary\"",
+    foreign_key: 'atrium_description_id',
+    dependent: :destroy,
+    inverse_of: :description
   )
-  accepts_nested_attributes_for :summary, :allow_destroy => true
-  def get_summary
-    essay.blank? ? "" : summary.content
-  end
+  accepts_nested_attributes_for :summary, allow_destroy: true
+
+  delegate(
+    :content,
+    to: :summary,
+    prefix: :summary,
+    allow_nil: true,
+    default: ''
+  )
+  alias_method :get_summary, :summary_content
 
   has_one(
     :essay,
-    :class_name => 'Atrium::Essay',
-    :conditions => "\"atrium_essays\".content_type = \"essay\"",
-    :foreign_key => 'atrium_description_id',
-    :dependent => :destroy
+    class_name: 'Atrium::Essay',
+    conditions: "\"atrium_essays\".content_type = \"essay\"",
+    foreign_key: 'atrium_description_id',
+    dependent: :destroy,
+    inverse_of: :description
   )
-  accepts_nested_attributes_for :essay,   :allow_destroy => true
-  def get_essay
-    essay.blank? ? "" : essay.content
-  end
-
+  accepts_nested_attributes_for :essay,   allow_destroy: true
+
+  delegate(
+    :content,
+    to: :essay,
+    prefix: :essay,
+    allow_nil: true,
+    default: ''
+  )
+  alias_method :get_essay, :essay_content
 
   validates_presence_of :atrium_showcase_id
 
@@ -44,85 +60,20 @@ class Atrium::Description < ActiveRecord::Base
     :summary_attributes
   )
 
-  def self.get_description_from_solr_id(solr_id)
-    atrium_description=Atrium::Description.find_by_description_solr_id(solr_id.to_s)
-
-    if atrium_description
-      atrium_showcase=Atrium::Showcase.find(atrium_description.atrium_showcase_id)
-      return atrium_description , atrium_showcase
-    else
-      return []
-    end
-  end
-
   def generate_solr_id
     "atrium_description_#{id}"
   end
 
-  def as_solr
-    doc= {
-      :active_fedora_model_s          => "Description",
-      :page_display_s                 => (page_display unless page_display.blank?),
-      :id                             => generate_solr_id,
-      :format                         => "Description",
-      :title_t                        => pretty_title,
-      :title_s                        => pretty_title,
-      :summary_t                      => (summary_text unless summary.blank?),
-      :summary_s                      => (summary_text unless summary.blank?),
-      :description_content_t          => (essay.content unless essay.blank?),
-      :description_content_s          => (essay.content unless essay.blank?),
-      :description_content_no_html_t  => (essay_text unless essay.blank?),
-      :atrium_showcase_id_t           => get_atrium_showcase_id,
-      :atrium_showcase_id_display     => get_atrium_showcase_id
-    }.reject{|key, value| value.blank?}
-    return doc
-  end
-
-  def to_solr
-    Blacklight.solr.add as_solr
-  end
-
-  def update_solr
-    if (description_solr_id.blank?)
-      to_solr
-      Blacklight.solr.commit
-    end
-  end
-
-  def summary_text
-    ::Sanitize.clean(summary.content).squish unless summary.blank?
-  end
-  private :summary_text
-
-  def essay_text
-    ::Sanitize.clean(essay.content).squish unless essay.blank?
-  end
-  private :essay_text
-
-  def remove_from_solr
-    if(description_solr_id.blank?)
-      Blacklight.solr.delete_by_id solr_id
-      Blacklight.solr.commit
-    end
-  end
-  private :remove_from_solr
-
-  def get_atrium_showcase_id
-    "atrium_showcase_#{id}"
-  end
-  private :get_atrium_showcase_id
-
 
   def pretty_title
     title.blank? ? "Description #{id}" : title
   end
 
   def show_on_this_page?
-    page_display.nil? || page_display == "newpage"
+    page_display.nil? || page_display == "samepage"
   end
 
   def blank?
     title.blank? && essay.blank?
   end
-
 end

data/app/models/atrium/essay.rb

@@ -1,13 +1,12 @@
 class Atrium::Essay < ActiveRecord::Base
-  self.table_name = 'atrium_essays'
-
   belongs_to(
     :description,
-    :class_name => 'Atrium::Description',
-    :foreign_key => 'atrium_description_id'
+    class_name: 'Atrium::Description',
+    foreign_key: 'atrium_description_id',
+    inverse_of: :essay
   )
 
-  validates_presence_of :atrium_description_id
+  validates_presence_of :description
 
   attr_accessible(
     :content_type,

data/app/models/atrium/exhibit.rb

@@ -1,9 +1,10 @@
+# An Atrium::Exhibit is a customizable view of a single topic (as defined by a
+# facet), further scoped by an optional Solr query. An Atrium::Exhibit defines
+# it's own hierarchical list of facets. An Atrium::Exhibit may also have a
+# description and a list of featured items.
 class Atrium::Exhibit < ActiveRecord::Base
-  self.table_name = 'atrium_exhibits'
-
   attr_accessible(
     :atrium_collection_id,
-    :filter_query_params,
     :label,
     :set_number,
     :browse_levels_attributes,
@@ -12,26 +13,20 @@ class Atrium::Exhibit < ActiveRecord::Base
 
   belongs_to(
     :collection,
-    :class_name => 'Atrium::Collection',
-    :foreign_key => 'atrium_collection_id'
-  )
-
-  has_many(
-    :showcases,
-    :class_name => 'Atrium::Showcase',
-    :as => :showcases
+    class_name: 'Atrium::Collection',
+    foreign_key: 'atrium_collection_id'
   )
-  accepts_nested_attributes_for :showcases
 
+  include Atrium::IsShowcasedMixin
 
   has_many(
     :browse_levels,
-    :class_name => 'Atrium::BrowseLevel',
-    :foreign_key => 'atrium_exhibit_id',
-    :order => 'level_number ASC'
+    class_name: 'Atrium::BrowseLevel',
+    foreign_key: 'atrium_exhibit_id',
+    order: 'level_number ASC'
   )
 
-  accepts_nested_attributes_for :browse_levels, :allow_destroy => true
+  accepts_nested_attributes_for :browse_levels, allow_destroy: true
   def browse_facet_names
     browse_levels.collect {|facet| facet.solr_facet_name} rescue []
   end
@@ -45,14 +40,28 @@ class Atrium::Exhibit < ActiveRecord::Base
   def facet_order=(facet_order = {})
     valid_ids = browse_levels.select(:id).map{|facet| facet[:id]}
     facet_order.each_pair do |id, order|
-      Atrium::BrowseLevel.find(id).update_attributes!(:level_number => order) if valid_ids.include?(id.to_i)
+      if valid_ids.include?(id.to_i)
+        Atrium::BrowseLevel.find(id).update_attributes!(level_number: order)
+      end
     end
   end
 
-
-  serialize :filter_query_params
+  include Atrium::QueryParamMixin
 
   def pretty_title
     label.blank? ? "Exhibit #{set_number}" : label
   end
+
+  def get_available_facets
+    collection.search_facet_names - browse_facet_names
+  end
+
+  before_create :assign_set_number
+
+  private
+  def assign_set_number
+    if collection
+      self.set_number= collection.exhibits.size + 1
+    end
+  end
 end