atrium 0.0.1 → 0.1.1

data/app/models/atrium/showcase/facet_selection.rb

@@ -1,21 +1,21 @@
-class Atrium::Showcase::FacetSelection < ActiveRecord::Base
-  self.table_name = 'atrium_showcase_facet_selections'
+module Atrium
+  class Showcase::FacetSelection < ActiveRecord::Base
+    belongs_to(
+        :showcase,
+        class_name: 'Atrium::Showcase',
+        foreign_key: 'atrium_showcase_id'
+    )
 
-  belongs_to(
-    :showcase,
-    :class_name => 'Atrium::Showcase',
-    :foreign_key => 'atrium_showcase_id'
-  )
+    validates_presence_of(
+        :atrium_showcase_id,
+        :value,
+        :solr_facet_name
+    )
 
-  validates_presence_of(
-    :atrium_showcase_id,
-    :value,
-    :solr_facet_name
-  )
-
-  attr_accessible(
-    :atrium_showcase_id,
-    :solr_facet_name,
-    :value
-  )
+    attr_accessible(
+        :atrium_showcase_id,
+        :solr_facet_name,
+        :value
+    )
+  end
 end

data/app/models/atrium/showcase/featured_selection.rb

@@ -0,0 +1,15 @@
+module Atrium
+  class Showcase::FeaturedSelection
+    include Atrium::ApplicationHelper
+
+    attr_reader :solr_id, :title
+
+    def initialize(selected_item_hash)
+      @solr_id = selected_item_hash[:id]
+      @title = selected_item_hash[:title]
+    end
+
+
+  end
+end
+

data/app/services/browse_level_evaluation_service.rb

@@ -0,0 +1,131 @@
+# Purpose: To walk the browse levels until we reach the current browse level.
+# While walking the browse levels, determine which FacetItems to attach at each
+# level.
+#
+# That is to say, each browse level's "values" are lazily evaluated.
+#
+# There is a complicated negotation of the Exhibit, Collection, BrowseLevel, and
+# query params.
+#
+# TODO: Should this class be implemented as a delegate of the
+#   ApplicationController class. I am passing in three anonymous functions that
+#   could instead be deferred to the calling context.
+class BrowseLevelEvaluationService
+  attr_reader(
+    :exhibit,
+    :extra_controller_params,
+    :params,
+    :solr_search_params_callable,
+    :get_search_results_callable
+  )
+
+  def initialize(
+      solr_search_params_callable,
+      get_search_results_callable,
+      facet_in_params_callable,
+      collection,
+      exhibit,
+      params
+    )
+    @solr_search_params_callable = solr_search_params_callable
+    @get_search_results_callable = get_search_results_callable
+    @facet_in_params_callable = facet_in_params_callable
+    @collection = collection
+    @exhibit = exhibit
+    @params = ParamsAdaptorForFilter.new(params)
+  end
+
+  def extract(browse_levels)
+    recursive_extract(browse_levels,true)
+  end
+
+  protected
+  def recursive_extract(browse_levels, top_level)
+    return [] if browse_levels.nil? || browse_levels.empty?
+    updated_browse_levels = []
+    browse_level = browse_levels.first
+    browse_facet_name = browse_level.solr_facet_name
+    updated_browse_levels << browse_level
+    deep_cloned_params = Marshal.load(Marshal.dump(params))
+
+    remove_f_params_for!(
+      deep_cloned_params,
+      browse_facet_name,
+      browse_levels,
+      top_level
+    )
+
+    response_without_f_param = extract_response_from(
+      deep_cloned_params,
+      browse_level
+    )
+
+    display_facet = response_without_f_param.facets.detect {|f|
+      f.name == browse_facet_name
+    }
+
+    unless display_facet.nil?
+      level_has_selected_facet = false
+      browse_level_subset = browse_levels.slice(1,browse_levels.length-1)
+
+      display_facet.items.each do |item|
+        browse_level.values << item.value
+        if @facet_in_params_callable.call(display_facet.name, item.value )
+          level_has_selected_facet = true
+          browse_level.selected = item.value
+          if browse_levels.length > 1
+            extracted_levels = recursive_extract(browse_level_subset, false)
+            updated_browse_levels << extracted_levels
+            updated_browse_levels.flatten!(1)
+          end
+        end
+      end
+
+      unless level_has_selected_facet
+        updated_browse_levels << browse_level_subset
+        updated_browse_levels.flatten!(1)
+      end
+    end
+    updated_browse_levels
+  end
+
+  protected
+
+  def remove_f_params_for!(fetchable, facet_name, browse_levels, top_level)
+    begin
+      f_hash = fetchable.fetch(:f)
+    rescue NoMethodError, KeyError
+      return fetchable
+    end
+
+    facet_entry =
+    begin
+      f_hash[facet_name] || f_hash[facet_name.to_s]
+    rescue TypeError
+      nil
+    end
+
+    if !top_level || facet_entry
+      browse_levels.each do |browse_level|
+        fetchable[:f].delete(browse_level.solr_facet_name)
+      end
+    else
+      fetchable[:f] = {}
+    end
+  end
+
+
+  def extract_response_from(modified_params, browse_level)
+    prepared_params = CurrentFilterQueryParamsExtractionService.new(
+      @solr_search_params_callable,
+      [exhibit.collection, exhibit, browse_level, modified_params],
+      [:filter_query_params,:exclude_query_params]
+    ).filter_query_params
+
+    (response_document, document_list) =
+      @get_search_results_callable.call(params,prepared_params)
+
+    response_document
+  end
+
+end

data/app/services/current_filter_query_params_extraction_service.rb

@@ -0,0 +1,91 @@
+# The purpose of this class is to consolodate the :q and :fq params for querying
+# SOLR.
+class CurrentFilterQueryParamsExtractionService
+  # @param [lambda] the function that will convert :f params to :fq
+  # @param [Array] an array of receiver objects that will interact with that may
+  #         have methods which return a hash with keys :f and :q
+  # @param [Array] an array of symbols representing messages to send to each of
+  #         the receiver objects; These messages should return a hash
+  def initialize(
+      solr_fq_extractor,
+      objects_to_merge_solr_params = [],
+      method_names_with_query_params = []
+    )
+
+    raise(
+      RuntimeError,
+      "Expected :solr_fq_extractor for #{self.class} to respond to #call"
+    ) unless solr_fq_extractor.respond_to?(:call)
+
+    raise(
+      RuntimeError,
+      "Expected :objects_to_merge_solr_params for #{self.class}" <<
+      " to respond to #each"
+    ) unless objects_to_merge_solr_params.respond_to?(:each)
+
+    raise(
+      RuntimeError,
+      "Expected :method_names_with_query_params for #{self.class}" <<
+      " to respond to #each"
+    ) unless method_names_with_query_params.respond_to?(:each)
+
+    @solr_fq_extractor = solr_fq_extractor
+    @objects_to_merge_solr_params = objects_to_merge_solr_params
+    @method_names_with_query_params = method_names_with_query_params
+  end
+
+  def filter_query_params
+    f_queries = []
+    queries = []
+
+    @objects_to_merge_solr_params.each do |object|
+      @method_names_with_query_params.each do |method_name|
+        collect_solr_params_from(object, method_name) do |q,fq|
+          queries << q if q
+          f_queries << fq if fq
+        end
+      end
+    end
+
+    {
+      fq: f_queries.uniq.flatten,
+      q: queries.uniq.flatten.join(" AND ")
+    }
+  end
+
+  protected
+
+  def collect_solr_params_from(object, method_name)
+    begin
+      return false unless object.public_send(method_name).present?
+    rescue NoMethodError
+      # Either an undefined method; or we are trying to call a private method
+      return false
+    end
+
+    query_params = object.public_send(method_name)
+
+    return false unless query_params.respond_to?(:fetch)
+
+    solrized_hash = @solr_fq_extractor.call(query_params)
+
+    q_value = nil
+    begin
+      q_value = solrized_hash.fetch(:q)
+    rescue NoMethodError, KeyError
+    end
+
+    fq_value = nil
+    begin
+      fq_value = solrized_hash.fetch(:fq)
+    rescue NoMethodError, KeyError
+    end
+
+    if q_value || fq_value
+      yield(q_value, fq_value)
+      return q_value, fq_value
+    else
+      return nil
+    end
+  end
+end

data/app/services/navigation_tree.rb

@@ -0,0 +1,13 @@
+class NavigationTree
+  def initialize(browse_levels, facet_query_hash)
+    @browse_levels = browse_levels.clone
+    @facet_query_hash = facet_query_hash
+  end
+
+  def current_level
+    return nil unless @facet_query_hash.present?
+    @browse_levels.reverse.detect do |browse_level|
+      @facet_query_hash.has_key?(browse_level.solr_facet_name)
+    end
+  end
+end

data/app/services/params_adaptor_for_filter.rb

@@ -0,0 +1,18 @@
+class ParamsAdaptorForFilter < Delegator
+  def initialize(obj)
+    super
+    @_sd_obj = obj
+  end
+
+  def __getobj__
+    @_sd_obj
+  end
+
+  def __setobj__(obj)
+    @_sd_obj = obj
+  end
+
+  def filter_query_params
+    @_sd_obj
+  end
+end

data/app/views/atrium/collections/_form.html.erb

@@ -1,98 +1,175 @@
+<%= form_for(@collection, :html => {:class => "atrium"}) do |f| %>
+  <% if @collection.errors.any? %>
+    <ul class="errors">
+      <% @collection.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+    </ul>
+  <% end %>
 
-<% content_for :atrium_side_bar do %>
-  <%= render :partial => 'atrium/collections/edit_navigation' %>
-<% end %>
-<%= form_for(@atrium_collection, :html => {:class => "atrium"}) do |f| %>
   <fieldset>
-    <legend>Basic Configuration</legend>
-    <% if @atrium_collection.errors.any? %>
-      <ul class="errors">
-        <% @atrium_collection.errors.full_messages.each do |msg| %>
-          <li><%= msg %></li>
-        <% end %>
-      </ul>
-    <% end %>
-
+    <legend>Collection Attributes</legend>
     <ol>
       <li>
-        <%= f.label :title, 'Title:' %>
+        <%= f.label :title, 'Title Text:' %>
         <%= f.text_field :title %>
       </li>
-      <li>
-        <%= f.label :title_markup, 'Title Markup:' %>
-        <%= f.text_area :title_markup, :class => 'jquery-ckeditor'  %>
-      </li>
       <li>
         <%= f.label :url_slug, 'URL slug:' %>
         <%= f.text_field :url_slug %>
+        <small>
+          Enter the way you'd like this collection to be identified in the URL.<br />
+          It defaults to the numeric id of the collection.
+        </small>
       </li>
       <li>
-        <%= f.label :search_facet_names, 'Collection Search Facets:' %>
-        <%= f.collection_select :search_facet_names, blacklight_config.facet_fields.map {|key, facet| Atrium::Search::FacetSelection.new(:field_name => facet.field)}, :field_name, :label, {}, :multiple => true, :class => 'chosen', :'data-placeholder' => 'Select desired facets from the Collection' %>
-      <li/>
+        <%= f.label :title_markup, 'HTML Title (optional):' %>
+        <%= f.text_area :title_markup, :class => 'jquery-ckeditor'  %>
+        <small>
+          You can create an HTML title for use throughout this collection.<br />
+          For more dramatic view customization create a theme instead.
+        </small>
+      </li>
+    </ol>
+  </fieldset>
+
+  <fieldset>
+    <legend>Collection Scope</legend>
+    <p>
+      A collection is a subset of the total holdings.<br />
+      Save a search on the catalog page to use as the collection scope.
+    </p>
+    <p>
+      <% if f.object.filter_query_params.present? %>
+        Current Scope: <%= Atrium.query_param_beautifier(self,f.object.filter_query_params) %>
+        <%= f.check_box :remove_filter_query_params %>
+        <small>Use the checkbox to delete scope</small>
+      <% end %>
+    </p>
+    <ol>
       <li>
-        <%= f.label :collection_description, 'Collection Browse Page About Text:' %>
-        <%= f.text_area :collection_description, :rows=> '20', :cols => '120', :class => 'jquery-ckeditor' %>
+        <%= f.label :include_search_id, 'Set Collection Scope:' %>
+        <%= f.select(:include_search_id, saved_searches_for_select, { :include_blank => true }) %>
+        <small>Choose from one of your saved searches.</small>
       </li>
+    </ol>
+  </fieldset>
+
+  <fieldset>
+    <legend>Collection Options</legend>
+    <ol>
       <li>
-        <%= f.label :search_instructions, 'Collection Search Page About Text:' %>
-        <%= f.text_area :search_instructions, :rows=> '20', :cols => '120', :class => 'jquery-ckeditor' %>
+        <%= f.label :theme, 'Theme:' %>
+        <%= f.select :theme, @collection.class.available_themes %>
+        <small>Themes are created outside of the administrative interface.</small>
       </li>
       <li>
-        <%= f.label :theme, 'Collection Theme:' %>
-        <%= f.collection_select :theme, Atrium::Collection.available_themes, :to_s, :titleize %>
+        <%= f.label :search_facet_names, 'Collection Search Facets:' %>
+        <%= f.collection_select(
+          :search_facet_names,
+          Atrium.config.facet_fields.map {|key, facet| Atrium::Search::FacetSelection.new(:field_name => facet.field)},
+          :field_name,
+          :label,
+          {},
+          :multiple => true,
+          :class => 'chosen',
+          :'data-placeholder' => 'Select desired facets from the Collection'
+        )%>
+      </li>
+    </ol>
+  </fieldset>
+
+  <fieldset class="last">
+    <legend>Collection Description</legend>
+    <ol>
+      <li>
+        <%= f.label :collection_description, 'Collection Home Page About Text:' %>
+        <%= f.text_area :collection_description, :rows=> '20', :cols => '120', :class => 'jquery-ckeditor' %>
+      </li>
+    </ol>
       </li>
     </ol>
-    <%= f.submit 'Update Collection Configuration', :class => 'button' %>
   </fieldset>
+  <p>
+  <% if @collection.new_record? %>
+    <%= f.submit 'Create Collection', :class => 'button' %>
+  <% else %>
+    <%= f.submit 'Update Collection', :class => 'button' %>
+  <% end %>
+  </p>
 <% end %>
+<% unless @collection.new_record?  %>
 
-  <h3>Collection Scope</h3>
-    <p>
-      An collection is a subset of a collection. The scope of the collection can be set to any possible query made in the search interface.
-    </p>
-    <fieldset>
-      <legend>Current Scope</legend>
-      <%-if @atrium_collection.filter_query_params %>
-        <ul>
-          <%- @atrium_collection.filter_query_params.each do |key,value| %>
-            <li><label><%= key %>: </label><%= value %></li>
-          <%- end %>
-        </ul>
-      <%- end %>
-    </fieldset>
-    <%- query_params = {:collection_id=>@atrium_collection[:id],:edit_collection_filter=>true} -%>
-    <%- query_params.merge!(@atrium_collection.filter_query_params) if @atrium_collection.filter_query_params -%>
-    <%- query_params.delete(:controller) %>
-    <%- query_params.delete(:action) %>
-    <%- query_params.delete(:solr_doc_ids) %>
-    <p class="exhibit-scope-controls">
-      <%= link_to("Set Collection Scope", atrium_set_collection_scope_path(query_params), :class => 'button').html_safe %>
-      <%= link_to("Remove Collection Scope", atrium_unset_collection_scope_path(@atrium_collection[:id]), :class => 'button').html_safe  %>
-    </p>
+  <hr />
 
   <h3>Exhibits</h3>
-<% if @atrium_collection.exhibits.any? %>
-  <ol data-resource="<%= update_atrium_collection_exhibit_order_path %>" class="exhibit-listing sortable">
-    <% @atrium_collection.exhibits.each do |exhibit| %>
-      <li data-id="<%= exhibit[:id] %>" data-order="<%= exhibit.set_number %>" class="ui-state-default">
-        <span class="ui-icon ui-icon-arrowthick-2-n-s"></span>
-        <%= exhibit.pretty_title %>
-        <span class="controls">
-          <%= link_to 'Configure', edit_atrium_exhibit_path(exhibit) %>
+  <p>
+    An exhibit is a customizable view of a single topic (as defined by a facet),
+    further scoped by an optional Solr query. An exhibit defines it's own
+    hierarchical list of facets. It may also have a description and a list of
+    featured items.
+  </p>
+  <% if @collection.exhibits.any? %>
+    <ol data-resource="<%=update_collection_exhibit_order_path %>" class="exhibit-listing sortable">
+      <% @collection.exhibits.each do |exhibit| %>
+        <li data-id="<%= exhibit[:id] %>" data-order="<%= exhibit.set_number %>" class="ui-state-default">
+          <span class="ui-icon ui-icon-arrowthick-2-n-s"></span>
+          <%= exhibit.pretty_title %>
+          <span class="controls">
+            <%= link_to 'Configure', edit_collection_exhibit_path(exhibit.collection, exhibit) %>
+            <%= link_to(
+              'Delete',
+              collection_exhibit_path(exhibit.collection, exhibit),
+              :method => :delete,
+              :class => :destroy,
+              :confirm => 'Do you really want to delete this exhibit?'
+            )%>
         </span>
-      </li>
-    <% end %>
-  </ol>
-<% else %>
-  <em>There are no exhibits in this collection.</em>
-<% end %>
-<% if can_add_view_exhibit? %>
-  <%= form_for(@atrium_exhibit) do |exhibit| %>
-    <%- @atrium_exhibit.set_number = @atrium_collection.exhibits.size + 1 -%>
-    <%- @atrium_exhibit.atrium_collection_id = @atrium_collection[:id] -%>
-    <%= exhibit.hidden_field :set_number %>
-    <%= exhibit.hidden_field :atrium_collection_id %>
-    <%= exhibit.submit 'Add a Exhibit to this Collection', :class => 'button' %>
+        </li>
+      <% end %>
+    </ol>
+  <% else %>
+    <p><em>There are no exhibits in this collection.</em></p>
+  <% end %>
+  <%= link_to 'Add a Exhibit to this Collection', new_collection_exhibit_path(@collection), :class => 'button' %>
+  <hr />
+
+  <h3>Showcases</h3>
+  <p>
+    A showcase is a container for storing featured items and descriptions. A
+    showcase can be attached to a collection, exhibit, or to specific
+    combinations of selected facets and facet values within an exhibit. There
+    can be multiple showcases in a collection.
+  </p>
+  <% if @collection.showcases.any? %>
+    <ol data-resource="<%=update_collection_showcase_order_path   %>" class="exhibit-listing sortable">
+      <% @collection.showcases.each do |showcase| %>
+        <li data-id="<%= showcase.id%>" data-order="<%= showcase.sequence %>" class="ui-state-default">
+          <span class="ui-icon ui-icon-arrowthick-2-n-s"></span>
+          <%= showcase.pretty_title %>
+          <span class="controls">
+            <%= link_to 'Configure', get_showcase_parent_edit_path(showcase) %>
+            <%= link_to "Delete", get_showcase_parent_show_path(showcase), :method=>:delete, :class=>:destroy, :confirm=>"Do you really want to delete this showcase?"%>
+          </span>
+        </li>
+      <% end %>
+    </ol>
+  <% else %>
+    <p><em>There are no showcases in this collection.</em></p>
+  <% end %>
+  <%= link_to 'Add a Showcase to this Collection', new_collection_showcase_path(@collection), :class => 'button' %>
+
+  <hr />
+  <%= button_to(
+                'Delete this Collection',
+                collection_path(@collection),
+                :method => :delete,
+                :form_class => 'collection-destroy-controls hazardous-action',
+                :confirm => 'Do you really want to delete this collection?',
+                :class => 'button'
+        )%>
+
+  <% content_for :atrium_side_bar do %>
+    <%= render :partial => 'shared/navigation' %>
   <% end %>
 <% end %>