atrium 0.0.1 → 0.1.1

data/lib/generators/atrium/install/templates/controllers/atrium_base_controller.rb

@@ -0,0 +1,18 @@
+# TODO: Move to
+class AtriumBaseController < ApplicationController
+
+  before_filter :find_collection
+  include ApplicationHelper
+  include CollectionsHelper
+  include CatalogHelper
+  include BlacklightHelper
+  include Blacklight::SolrHelper
+  include SolrHelper
+
+  layout :determine_layout
+
+  helper_method :get_solr_response_for_field_values
+
+  self.solr_search_params_logic += [:add_exclude_fq_to_solr]
+
+end

data/lib/generators/atrium/install/templates/controllers/collections_controller.rb

@@ -0,0 +1,40 @@
+# TODO: Move to generator
+class CollectionsController  < AtriumBaseController
+
+  def show
+    @showcases=find_showcases
+  end
+
+  def browse
+    @showcases=find_showcases
+  end
+
+  protected
+  def find_collection
+    if params.has_key? :id
+      @collection = Atrium::Collection.find(params[:id])
+      return __initialize_collection
+    else
+      return false
+    end
+  end
+
+  def find_showcases
+    Atrium::Showcase.with_selected_facets(@collection.id, @collection.class.name, {})
+  end
+
+  def evaluate_query_params
+    unless @collection
+      raise("No collection object found. Please initialize collection")
+    end
+    @extra_controller_params = prepare_extra_controller_params_for_asset_query(
+      @collection,
+      params
+    )
+  end
+
+  def determine_layout
+    @collection.theme_path
+  end
+end
+

data/lib/generators/atrium/install/templates/controllers/descriptions_controller.rb

@@ -0,0 +1,36 @@
+# TODO: Move to generator
+class DescriptionsController  < ApplicationController
+  before_filter :find_collection
+  layout :determine_layout
+  include ApplicationHelper
+  include Blacklight::SolrHelper
+  include CollectionsHelper
+
+  def show
+
+  end
+
+  protected
+  def find_collection
+    find_description
+    @collection = @showcase.collection
+  end
+
+  def find_description
+    @description=Atrium::Description.find(params[:id])
+    @showcase= @description.showcase
+  end
+
+  def evaluate_query_params
+    unless @collection
+      raise("No collection object found. Please initialize collection")
+    end
+    @extra_controller_params =
+    prepare_extra_controller_params_for_asset_query(@collection,params)
+  end
+
+  def determine_layout
+    @collection.theme_path
+  end
+end
+

data/lib/generators/atrium/install/templates/controllers/exhibits_controller.rb

@@ -0,0 +1,47 @@
+# TODO: Move to generator
+class ExhibitsController  < AtriumBaseController
+
+
+  def show
+    @exhibit_navigation_data = get_exhibit_navigation_data(@exhibit)
+    @showcases=find_showcases
+    logger.debug("Showcase: #{@showcase.inspect}")
+  end
+
+  def find_collection
+    if params.has_key? :id
+      @exhibit = Atrium::Exhibit.find(params[:id])
+      @collection = @exhibit.collection
+      return __initialize_collection
+    else
+      return false
+    end
+  end
+
+  def find_showcases
+    Atrium::Showcase.with_selected_facets(@exhibit.id, @exhibit.class.name, params[:f])
+  end
+
+  def evaluate_query_params
+    unless @exhibit
+      raise("No exhibit object found. Please initialize exhibit")
+    end
+    assets_to_extract_query = []
+    assets_to_extract_query << @exhibit
+    assets_to_extract_query << @exhibit.collection
+
+    if @exhibit.respond_to?(:browse_levels)
+      assets_to_extract_query << @exhibit.browse_levels
+    end
+
+    @extra_controller_params = prepare_extra_controller_params_for_asset_query(
+      assets_to_extract_query,
+      params
+    )
+  end
+
+  def determine_layout
+    @exhibit.collection.theme_path
+  end
+
+end

data/lib/generators/atrium/install/templates/controllers/selected_items_controller.rb

@@ -0,0 +1,26 @@
+# TODO: This concept should be proposed to Blacklight core
+# as something to add into. Be it as an callback for the search
+# or some process therein.
+class SelectedItemsController < ApplicationController
+
+  def index
+    @searches = current_user.searches
+  end
+
+  def save
+    success = true
+    existing_selected_items = current_user.selected_document_ids
+    @selected_items = params[:items] || []
+    @selected_items.delete_if {|key, value| existing_selected_items.include?(value[:document_id]) }
+    @selected_items.each do |key, item|
+      success = false unless current_user.selected_items.create(item)
+    end
+    if @selected_items.length > 0 && success
+      flash[:notice] = 'Selected items '+ @selected_items.length.to_s + ' was saved successfully.'
+    elsif @selected_items.length > 0
+      flash[:error] = 'Error saving selected items'
+    end
+
+    redirect_to :back
+  end
+end

data/lib/generators/atrium/install/templates/helpers/application_helper.rb

@@ -0,0 +1,42 @@
+module ApplicationHelper
+  include Atrium::ApplicationHelper
+  include Atrium::CollectionsHelper
+  include Atrium::ShowcasesHelper
+  include NavigationHelper
+  include SolrHelper
+
+  def in_unscoped_catalog_search?
+    (params[:controller] == "catalog") && !params[:id]
+  end
+
+  def in_collection_context?
+    !defined?(@collection).nil?
+  end
+
+  def breadcrumb_links
+    in_collection_context? ? breadcrumb_builder : "Search Across Collections"
+  end
+
+  # TODO: Improve the robustness of this implementation
+  def breadcrumb_builder
+    @collection.pretty_title
+  end
+
+  def if_browsing_facet?
+    params[:f] && current_user
+  end
+
+  def application_name
+    "Digitial Collections — Rare Books & Special Collections".html_safe
+  end
+
+  def collection_title
+    if @collection
+      if @collection.title_markup.blank?
+        "<h1 id=\"collection-title\">#{@collection.title}</h1>".html_safe
+      else
+        "<div id=\"collection-title\">#{@collection.title_markup}\n</div>".html_safe
+      end
+    end
+  end
+end

data/lib/generators/atrium/install/templates/helpers/collections_helper.rb

@@ -0,0 +1,15 @@
+# TODO: Move to generator
+module CollectionsHelper
+  include Atrium::ApplicationHelper
+  include Atrium::CollectionsHelper
+
+  #This methods merge params q and fq with asset q and fq
+  def prepare_extra_controller_params_for_asset_query(assets,params, *args)
+    CurrentFilterQueryParamsExtractionService.new(
+      method(:solr_search_params),
+      [assets,ParamsAdaptorForFilter.new(params)].flatten,
+      [:filter_query_params,:exclude_query_params]
+    ).filter_query_params
+
+  end
+end

data/lib/generators/atrium/install/templates/helpers/navigation_helper.rb

@@ -0,0 +1,62 @@
+# TODO: Move to generator
+module NavigationHelper
+
+  # 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.
+  # first arg item is a facet value item from rsolr-ext.
+  # options consist of:
+  # :suppress_link => true # do not make it a link, used for an already selected value for instance
+  def get_browse_facet_path(facet_solr_field, value, browse_facets, exhibit_number, exhibit_id, opts={})
+    p = HashWithIndifferentAccess.new
+    p.merge!(:f=>params[:f].dup) if params[:f]
+    p.merge!(:id=>exhibit_id)
+    p = remove_related_facet_params(facet_solr_field, p, browse_facets, exhibit_number)
+    p = add_browse_facet_params(facet_solr_field,value,p)
+    exhibit_path(p.merge!({:class=>"browse_facet_select"}))
+  end
+
+  def get_selected_browse_facet_path(facet_solr_field, value, browse_facets, exhibit_number, exhibit_id, opts={})
+    value = [value] unless value.is_a? Array
+    p = HashWithIndifferentAccess.new
+    p.merge!(:f=>params[:f].dup) if params[:f]
+    p = remove_related_facet_params(facet_solr_field, p, browse_facets, exhibit_number)
+    p.merge!(:id=>exhibit_id)
+    # params[:action] == "edit" ? edit_atrium_collection_path(p) : atrium_collection_path(p)
+    exhibit_path(p)
+  end
+
+  def add_browse_facet_params(field, value, p=HashWithIndifferentAccess.new)
+    p[:f]||={}
+    p[:f][field] ||= []
+    p[:f][field].push(value)
+    p
+  end
+
+  #Remove current selected facet plus any child facets selected
+  def remove_related_facet_params(solr_facet_field, p, browse_facets, exhibit_number)
+    if params[:exhibit_number] && params[:exhibit_number].to_i != exhibit_number.to_i
+      p.delete(:f) if p[:f]
+    elsif browse_facets.include?(solr_facet_field)
+      #iterate through browseable facets from current on down
+      index = browse_facets.index(solr_facet_field)
+      if p[:f]
+        browse_facets.slice(index, browse_facets.length - index).each do |f|
+          p[:f].delete(f)
+        end
+      end
+    end
+    p
+  end
+
+  def get_selected_browse_facets(browse_facets)
+    selected = {}
+    if params[:f]
+      browse_facets.each do |facet|
+        selected.merge!({facet.to_sym=>params[:f][facet].first}) if params[:f][facet]
+      end
+    end
+    selected
+  end
+
+end

data/lib/generators/atrium/install/templates/helpers/solr_helper.rb

@@ -0,0 +1,138 @@
+# TODO: Move to generator
+module SolrHelper
+
+  def __initialize_collection
+    @collection_response, @collection_document_list =
+      get_search_results(params, evaluate_query_params)
+
+    @extra_controller_params =
+    get_current_filter_query_params(
+      @collection,
+      @exhibit,
+      get_current_browse_level(@exhibit),
+    )
+  end
+
+  # Checks if a browse level has been navigated to for a exhibit
+  # @param [Atrium::Exhibit] The current exhibit in view
+  # @return [Atrium::BrowseLevel] It will return a browse level that is
+  #   selected, otherwise it will return nil
+  def get_current_browse_level(exhibit)
+    return nil unless exhibit.respond_to?(:browse_levels)
+    NavigationTree.new(exhibit.browse_levels, params[:f]).current_level
+  end
+
+  def get_exhibit_navigation_data(exhibit)
+    browse_data=[]
+    if exhibit.respond_to?(:browse_levels) && !exhibit.browse_levels.nil?
+      updated_browse_levels = get_browse_level_data(exhibit)
+      exhibit.browse_levels.each_index do |index|
+        exhibit.browse_levels.fetch(index).values = updated_browse_levels.fetch(index).values
+        exhibit.browse_levels.fetch(index).label = updated_browse_levels.fetch(index).label
+        exhibit.browse_levels.fetch(index).selected = updated_browse_levels.fetch(index).selected
+      end
+      exhibit.browse_levels.flatten!
+      browse_data << exhibit
+    end
+
+    browse_data=[] if check_for_scope(browse_data)
+    @exhibit_navigation_data=browse_data
+    browse_data
+  end
+
+  private
+
+  def check_for_scope(exhibit_list)
+    scoped_to_items=false
+    #unless  @collection.filter_query_params.blank? && @collection.filter_query_params[:solr_doc_ids]
+    #  scoped_to_items=true
+    #end
+    #return scoped_to_items
+  end
+
+  # This is a private method and should not be called directly.
+  # get_exhibit_navigation_data calls this method to fill out the
+  # browse_level_navigation_data array This method calls itself recursively as
+  # it generates the current browse state data. It returns the browse levels
+  # array with its browse level objects passed in updated with any values,
+  # label, and selected value if one is selected.  It will fill in values for
+  # the top browse level, and then will only fill in values for the second
+  # browse level if something is selected, and so on for any deeper browse
+  # levels.  If no label is defined for a browse level, it will fill in the
+  # default label for the browse level facet.
+  #
+  # @param [Atrium::Collection] The current collection
+  # @param [Atrium::Exhibit] the current exhibit
+  # @params [Array] The current browse levels (will reduce as this method recurses)
+  # @param [SolrResponse] the browse response from solr
+  # @param [Hash] the extra controller params that need to be passed to solr if we query for another response if necessary to get child level data
+  # @param [Boolean] true if the top level of the exhibit
+  # @return [Array] An array of update BrowseLevel objects that are enhanced with current navigation data such as selected, values, and label filled in
+  #   The relevant attributes of a BrowseLevel are
+  #   :solr_facet_name [String] the facet used as the category for that browse level
+  #   :label [String] browse level category label
+  #   :values [Array] values to display for the browse level
+  #   :selected [String] the selected value if one
+  def get_browse_level_data(exhibit)
+    BrowseLevelEvaluationService.new(
+      method(:solr_search_params),
+      method(:get_search_results),
+      method(:facet_in_params?),
+      exhibit.collection,
+      exhibit,
+      params
+    ).extract(exhibit.browse_levels)
+  end
+
+  def get_current_filter_query_params(*args)
+    CurrentFilterQueryParamsExtractionService.new(
+      method(:solr_search_params),
+      args,
+      [:filter_query_params,:exclude_query_params]
+    ).filter_query_params
+  end
+
+  def get_solr_documents_from_asset(asset)
+    p = params.dup
+    params.delete :f
+    params.delete :q
+    params.delete :page
+    logger.debug("Asset is: #{asset.class}")
+    if asset.is_a?(Atrium::Showcase)
+      if asset && !asset.showcase_items.blank?
+        selected_document_ids = asset.showcase_items
+        response, documents = get_solr_response_for_field_values("id",selected_document_ids || [])
+      end
+    else
+      if asset && asset.filter_query_params && asset.filter_query_params[:solr_doc_ids]
+        document_ids = asset.filter_query_params[:solr_doc_ids].split(',')
+        response, documents = get_solr_response_for_field_values("id",document_ids || [])
+      end
+    end
+    params.merge!(:f=>p[:f])
+    params.merge!(:q=>p[:q])
+    params.merge!(:page=>p[:page])
+    return  [response, documents]
+  end
+
+  def add_exclude_fq_to_solr(solr_parameters, user_params)
+    logger.debug("Solr exclude!!!: #{solr_parameters.inspect}, #{user_params.inspect}")
+    if ( user_params[:exclude])
+      exclude_request_params = user_params[:exclude]
+      solr_parameters[:fq] ||= []
+      exclude_request_params.each_pair do |facet_field, value_list|
+        value_list ||= []
+        value_list = [value_list] unless value_list.respond_to? :each
+        value_list.each do |value|
+          exclude_facet="-(#{facet_value_to_fq_string(facet_field, value)})"
+          exclude_query="-(#{facet_value_to_fq_string(facet_field, value)})"
+          solr_parameters[:fq] << exclude_query
+          solr_parameters[:fq] << exclude_facet
+        end
+      end
+    end
+  end
+
+
+
+end

data/lib/generators/atrium/install/templates/models/selected_item.rb

@@ -0,0 +1,7 @@
+class SelectedItem < ActiveRecord::Base
+  attr_accessible :id, :document_id, :title
+
+  def document
+    SolrDocument.new :id => document_id
+  end
+end

data/lib/generators/atrium/install/templates/views/collections/_document.html.erb

@@ -0,0 +1,19 @@
+    <% # container for a single doc -%>
+    <div class="document <%= render_document_class document %>">
+      
+      <% # header bar for doc items in index view -%>
+      <div class="documentHeader">
+        
+        <% # bookmark/folder functions for items/docs -%>
+        <%= render_index_doc_actions document %>
+        
+        <% # main title container for doc partial view -%>
+        <div class="yui-u">
+          <h3 class="index_title"><%= t('blacklight.search.documents.counter', :counter => (document_counter + 1 + @collection_response.params[:start].to_i)) %><%= link_to_document document, :label=>document_show_link_field, :counter => (document_counter + 1 + @collection_response.params[:start].to_i) %></h3>
+        </div>
+      </div>
+      
+      <% # main container for doc partial view -%>
+      <%= render_document_partial document, :index %>
+
+    </div>