atrium 0.0.1 → 0.1.1

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

@@ -0,0 +1,3 @@
+<% @collection.exhibits.each do |exhibit| %>
+  <h3><%= link_to "#{exhibit.pretty_title}", exhibit %></h3>
+<% end %>

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

@@ -0,0 +1,6 @@
+<% if paginate_params(document_response).num_pages > 1 %>
+    <div class="pagination">
+      <h2><%= t('blacklight.search.pagination.title') %></h2>
+      <%= paginate_rsolr_response document_response, :outer_window => 2, :theme => 'blacklight' %>
+    </div>
+<% end %>

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

@@ -0,0 +1,16 @@
+<%= collection_title %>
+
+<%= render partial: 'shared/showcases', locals: { showcases: @showcases } %>
+<%= render partial: 'shared/document_list', locals: { collection_response: @collection_response } %>
+
+<% content_for :atrium_side_bar do %>
+  <%= render partial: 'exhibits' %>
+  <h3><%= link_to 'Collection Home', collection_path(@collection) %></h3>
+
+  <% if current_user %>
+    <hr />
+    <p>
+      <%= link_to 'Edit this Collection', atrium.edit_collection_path(@collection) %>
+    </p>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,19 @@
+<%= collection_title %>
+
+<%= render partial: 'shared/showcases', locals: { showcases: @showcases } %>
+
+<div id="collection-description">
+  <%= @collection.collection_description.html_safe %>
+</div>
+
+<% content_for :atrium_side_bar do %>
+  <%= render partial: 'exhibits' %>
+  <h3><%= link_to 'Browse Collection Holdings', browse_collection_path(@collection) %></h3>
+
+  <% if current_user %>
+    <hr />
+    <p>
+      <%= link_to 'Edit this Collection', atrium.edit_collection_path(@collection) %>
+    </p>
+  <% end %>
+<% end %>

data/lib/generators/atrium/install/templates/views/descriptions/show.html.erb

@@ -0,0 +1,8 @@
+<% content_for :atrium_side_bar do %>
+  <%= link_to "Back to #{@showcase.parent_title}", get_parent_path(@showcase) %>
+<% end %>
+<div>
+  <h3><%= @description.pretty_title%></h3>
+    <%= @description.essay_content.to_s.html_safe %>
+</div>
+

data/lib/generators/atrium/install/templates/views/exhibits/_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>

data/lib/generators/atrium/install/templates/views/exhibits/_pagination.html.erb

@@ -0,0 +1,6 @@
+<% if paginate_params(document_response).num_pages > 1 %>
+    <div class="pagination">
+      <h2><%= t('blacklight.search.pagination.title') %></h2>
+      <%= paginate_rsolr_response document_response, :outer_window => 2, :theme => 'blacklight' %>
+    </div>
+<% end %>

data/lib/generators/atrium/install/templates/views/exhibits/show.html.erb

@@ -0,0 +1,28 @@
+<%= collection_title %>
+
+<%= render partial: 'shared/showcases', locals: { showcases: @showcases } %>
+<%= render partial: 'shared/document_list', locals: { collection_response: @collection_response } %>
+
+<% content_for :atrium_side_bar do %>
+  <%= render partial: 'shared/side_bar_navigation' %>
+  <h3><%= link_to 'Collection Home', collection_path(@collection) %></h3>
+
+  <% if current_user %>
+    <hr>
+    <% if if_browsing_facet? %>
+      <p>
+        <%= link_to(
+          'Customize this Page',
+          atrium.get_browse_level_showcase_path(
+            exhibit_id: @exhibit[:id],
+            facet_selection: params[:f]
+          )
+        )%>
+      </p>
+    <% end %>
+    <p>
+      <%= link_to 'Edit this Exhibit', atrium.edit_collection_exhibit_path(@collection, @exhibit) %>
+    </p>
+  <% end %>
+
+<% end %>

data/lib/generators/atrium/install/templates/views/folder/_selected_items_form.html.erb

@@ -0,0 +1,8 @@
+<%= form_tag save_selected_items_url, :name => "items" do %>
+    <% documents.each_with_index do |document, index| %>
+        <%= hidden_field_tag "items[#{index}][document_id]", document.get(:id)%>
+        <%= hidden_field_tag "items[#{index}][title]", h(document[document_show_link_field])%>
+    <% end %>
+    <%= link_to_function "Save Items", "document.items.submit()" %>
+    <%= submit_tag "Save Items", :class => 'hide' %>
+<% end %>

data/lib/generators/atrium/install/templates/views/folder/index.html.erb

@@ -0,0 +1,45 @@
+<% sidebar_items << capture do %>
+  <p><%= link_back_to_catalog %></p>
+<% end %>
+<h1><%= t('blacklight.folder.title') %></h1>
+
+<% unless @documents.empty? %>
+  <%- # just adding pageEntriedInfo div to get the proper rounded corners at the top -%>
+  <div class="pageEntriesInfo"></div>
+  <%= render "catalog/sort_and_per_page" %>
+  <%= render "catalog/results_pagination" %>
+  
+  <%= render 'tools' %>
+    <ul class="folderTools">  <li> <%= render :partial=>'selected_items_form', :locals=>{:documents=>@documents} %> </li>   </ul>
+<% end %>
+
+<div id="documents">  
+  <% @documents.each_with_index do |document, i| %>
+    <% # container for a single doc -%>
+    <div class="document">
+      <% # header bar for doc items in index view -%>
+      <div class="documentHeader">
+        <div class="documentFunctions">          
+          <div class="in_folder">
+            <%= render :partial=>'catalog/folder_control', :locals=>{:document=>document} %>
+          </div>
+        </div>  
+      
+        <h3 class="index_title"><%= i + 1 + @response.params[:start].to_i%>. <%= link_to_document document, :label => document_show_link_field, :results_view => false %></h3>
+        
+              
+      </div>
+      
+	    <%= render_document_partial document, :index %>
+	    <% if document.respond_to?(:export_as_openurl_ctx_kev) %>
+        <!-- 
+             // COinS, for Zotero among others. 
+             // This document_partial_name(@document) business is not quite right,
+             // but has been there for a while. 
+        -->
+        <span class="Z3988" title="<%= document.export_as_openurl_ctx_kev(document_partial_name(document)) %>"></span>
+      <% end %>
+    </div>
+  
+  <% end %>
+</div>

data/lib/generators/atrium/install/templates/views/shared/_document_list.html.erb

@@ -0,0 +1,14 @@
+<% if collection_response.nil? %>
+  <div id="documents" class="none-found">
+    <em>0 items found</em>
+  </div>
+<% else %>
+  <div class="pageEntriesInfo">
+    <%= render_pagination_info collection_response, entry_name: 'item' %>
+  </div>
+
+  <%= render 'pagination' , document_response: collection_response %>
+  <div id="documents">
+    <%= render partial: 'document', collection: @collection_document_list, as: :document %>
+  </div>
+<% end %>

data/lib/generators/atrium/install/templates/views/shared/_featured_sources.html.erb

@@ -0,0 +1,19 @@
+<div id="Featured documents">
+  <% featured_response,featured_documents = get_solr_documents_from_asset(showcase)%>
+  <% if !featured_documents.blank?-%>
+    <h5>Featured Sources</h5>
+    <% featured_documents.each_with_index do |document, i| %>
+      <% # container for a single doc -%>
+      <div class="document <%= render_document_class document %>">
+        <% # header bar for doc items in index view -%>
+        <div class="documentHeader">
+          <% # main title container for doc partial view -%>
+          <div class="yui-u">
+            <h3 class="index_title"><%= i + 1 + featured_response.params[:start].to_i%>. <%= link_to_document document, :label => document_show_link_field, :results_view => false %></h3>
+          </div>
+        </div>
+        <%= render_document_partial document, :index %>
+      </div>
+    <% end %>
+  <% end %>
+</div>

data/lib/generators/atrium/install/templates/views/shared/_list_descriptions.html.erb

@@ -0,0 +1,25 @@
+<% if descriptions.any? %>
+  <div class="showcase-descriptions">
+    <% descriptions.each do |description| %>
+      <% title = description.pretty_title %>
+      <% if description.show_on_this_page? %>
+        <h3><%= link_to title, description_path(description), :label=>("Essay: \"#{title}\"") %></h3>
+        <blockquote>
+          <%= description.get_summary.html_safe %>
+        </blockquote>
+        <%= link_to "Read the complete essay", description_path(description)%>
+      <% else %>
+        <h3><%= title %></h3>
+        <%if description.get_essay %>
+          <blockquote class="intro"><%= truncate( description.get_essay, :length =>550, :ommision => "…").html_safe%></blockquote>
+          <% if description.get_essay.length>50 %>
+            <a class="heading" href="#">[Read the complete essay]</a>
+            <div style="display: none"class="content" id="<%= description[:id] %>">
+              <%= description.get_essay.html_safe %>
+            </div>
+          <% end %>
+        <% end %>
+      <% end %>
+    <% end %>
+  </div>
+<% end %>

data/lib/generators/atrium/install/templates/views/shared/_masthead.html.erb

@@ -0,0 +1,19 @@
+<hgroup id="title-banner">
+  <h2 class="site_title"><a href="http://www.library.nd.edu/rarebooks/">Rare Books &amp; Special Collections</a></h2>
+  <h3><a href="http://www.library.nd.edu/" rel="external">Hesburgh Libraries of Notre Dame</a></h3>
+</hgroup>
+
+<nav id="collection-listing">
+  <ul>
+  <% Atrium::Collection.all.each do |collection| %>
+     <li><%= link_to_unless (collection.to_param == params[:id]), collection.title, collection_path(collection) %></li>
+  <% end %>
+     <li><%= link_to_unless in_unscoped_catalog_search?, 'Search Across Collections', catalog_index_path %></li>
+  </ul>
+</nav>
+
+<nav id="breadcrumbs">
+  <a href="http://www.library.nd.edu/rarebooks/" class="root">Rare Books &amp; Special Collections</a>
+  <a href="http://www.library.nd.edu/rarebooks/digital_projects/" class="back">Digital Projects</a>
+  <%= breadcrumb_links %>
+</nav>

data/lib/generators/atrium/install/templates/views/shared/_navigation_browse_level.html.erb

@@ -0,0 +1,34 @@
+<%# This partial recursively calls itself as necessary to render the navigation browse level data. %>
+<% unless browse_levels.nil? || browse_facets.nil? || exhibit_number.nil?%>
+    <% browse_level = browse_levels.first %>
+    <% unless browse_level.values.empty? %>
+        <% solr_facet_name = browse_level.solr_facet_name %>
+        <% browse_level.label = facet_field_labels[solr_facet_name] if browse_level.label.blank? %>
+        <h3 class="facet-heading"><%= browse_level.label %></h3>
+        <ul class="browse-facets">
+          <% browse_level.values.each do |value| %>
+              <li class="<%= value.downcase.gsub(/\W/, '-') %>">
+                <% @exhibit ? exhibit_set_from_params = @exhibit.set_number : exhibit_set_from_params = get_exhibit_set_number(exhibit_id) %>
+                <% if !browse_level.selected.nil? && browse_level.selected == value && exhibit_number.to_i == exhibit_set_from_params.to_i%>
+                    <% selected_path = get_selected_browse_facet_path(solr_facet_name, value, browse_facets, exhibit_number, exhibit_id) %>
+                    <span class="selected browse-facet">
+              <%= value %>
+            </span>
+                    <%= link_to("[remove]", selected_path, :class=>"remove") %>
+                    <% if browse_levels.size > 1 && !browse_levels.second.values.empty? %>
+                        <%= render :partial => 'shared/navigation_browse_level',
+                                   :locals => {
+                                           :browse_levels => browse_levels.slice(1, browse_levels.length - 1),
+                                           :browse_facets => browse_facets.slice(1, browse_facets.length - 1),
+                                           :exhibit_number => exhibit_number,
+                                           :exhibit_id => exhibit_id
+                                   } %>
+                    <% end %>
+                <% else %>
+                    <%= link_to(value, get_browse_facet_path(solr_facet_name, value, browse_facets, exhibit_number, exhibit_id)) %>
+                <% end %>
+              </li>
+          <% end %>
+        </ul>
+    <% end %>
+<% end %>

data/lib/generators/atrium/install/templates/views/shared/_showcases.html.erb

@@ -0,0 +1,12 @@
+<% if showcases.any? %>
+  <div id="showcase-display">
+  <% showcases.each do |showcase| %>
+    <div class="showcase">
+      <%= render partial: 'shared/list_descriptions', locals: { descriptions: showcase.descriptions } %>
+      <div class="showcase-items">
+        <%= render partial: 'shared/featured_sources', locals: { showcase: showcase } %>
+      </div>
+    </div>
+  <% end %>
+  </div>
+<% end %>

data/lib/generators/atrium/install/templates/views/shared/_side_bar_navigation.html.erb

@@ -0,0 +1,20 @@
+<div id="browse-navigation" class="facet-list">
+  <% if @exhibit_navigation_data.nil? || @exhibit_navigation_data.empty? %>
+    <b>No browse level defined</b>
+  <% else %>
+    <%# Recursively render the browse sets. %>
+    <% @exhibit_navigation_data.each do |exhibit| %>
+      <h3 class="facet-heading <%= exhibit.pretty_title%>"></h3>
+      <% unless exhibit.browse_levels.nil? || exhibit.browse_levels.empty? %>
+        <%= render(:partial => 'shared/navigation_browse_level',
+                   :locals=>{
+                           :exhibit_number => exhibit.set_number,
+                           :browse_levels => exhibit.browse_levels,
+                           :browse_facets => exhibit.browse_facet_names,
+                           :exhibit_id => exhibit[:id]
+                   }) %>
+
+      <% end %>
+    <% end %>
+  <% end %>
+</div>

data/lib/generators/atrium/service/USAGE

@@ -0,0 +1,9 @@
+Description:
+  This generator provides a means of creating a service
+
+Example:
+  rails generate service ChickenPieService
+
+  This will create:
+    app/services/chicken_pie_service.rb
+    spec/services/chicken_pie_service_spec.rb

data/lib/generators/atrium/service/service_generator.rb

@@ -0,0 +1,16 @@
+class Atrium::ServiceGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_service
+    template(
+      'service.rb.erb',
+      File.join('app/services/', "#{file_name}.rb")
+    )
+  end
+  def create_service_spec
+    template(
+      'service_spec.rb.erb',
+      File.join('spec/services/', "#{file_name}_spec.rb")
+    )
+  end
+end

data/lib/generators/atrium/service/templates/service.rb.erb

@@ -0,0 +1,2 @@
+class <%= class_name %>
+end

data/lib/generators/atrium/service/templates/service_spec.rb.erb

@@ -0,0 +1,4 @@
+require_relative '../spec_helper'
+
+describe <%= class_name %> do
+end

data/lib/generators/atrium/theme/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate the barebones for a new atrium theme.
+
+Example:
+    rails generate atrium:theme HotSauce
+
+    This will create:
+        app/views/layouts/atrium_themes/hot_sauce.html.erb

data/lib/generators/atrium/theme/templates/theme.html.erb

@@ -0,0 +1,14 @@
+<%#
+Look in ATRIUM_ENGINE_ROOT/app/views/layouts/atrium for available
+content_for regions as well as how they are used.
+-%>
+
+<% content_for :footer do %>
+  <p>Powered by <a href="https://github.com/ndlib/atrium">Atrium</a></p>
+<% end %>
+
+<%#
+If you aren't satisfied with the baked in layout, override this
+or remove it.
+%>
+<%= render :template => 'layouts/atrium' %>

data/lib/generators/atrium/theme/theme_generator.rb

@@ -0,0 +1,11 @@
+class Atrium::ThemeGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_theme
+    # TODO: warning magic string "atrium_themes" to refactor
+    copy_file(
+      'theme.html.erb',
+      File.join('app/views/layouts/atrium/themes/', "#{file_name}.html.erb")
+    )
+  end
+end

data/lib/tasks/atrium_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :atrium do
+#   # Task goes here
+# end

data/script/rails

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/atrium/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'
+
+load File.expand_path('../../spec/dummy/script/rails', __FILE__)

data/spec/atrium_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'ostruct'
+
+describe Atrium do
+  context '.configure' do
+    Given(:main_app_config) { OpenStruct.new }
+    When { Atrium.configure(main_app_config) }
+    Then { Atrium.config.should be_instance_of(Atrium::Configuration) }
+  end
+end

data/spec/controllers/atrium/application_controller_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Atrium::ApplicationController do
+  it 'defines helper method #atrium_config' do
+    controller.atrium_config.should == Atrium.config
+  end
+end