atrium 0.0.1 → 0.1.1

data/Guardfile

@@ -1,10 +1,40 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-notification :gntp
-guard 'rspec', :notrify => 'true', :cli => '--color', :spec_paths => 'test_support/spec' do
-  watch(%r|^app/(.*)\.rb|) { |m|
-    "test_support/spec/#{m[1]}_spec.rb"
-  }
-  watch(%r|^test_support/spec/(.*)_spec\.rb|)
-  watch('test_support/spec/spec_helper.rb') { 'test_support/spec' }
-end
+guard 'rspec', :cli => '--color --format nested' do
+  if RUBY_PLATFORM =~ /linux/
+    require 'libnotify'
+    notification :libnotify 
+  end
+  if RUBY_PLATFORM =~ /darwin/
+    require 'ruby_gntp'
+    notification :ruby_gntp
+  end
+  watch('spec/spec_helper.rb') {
+    'spec'
+  }
+  watch('config/routes.rb') {
+    'spec/routing'
+  }
+  watch('app/controllers/atrium/application_controller.rb')  {
+    'spec/controllers'
+  }
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/\w*/atrium/.+_spec\.rb$})
+
+  watch(%r{^app/(.+)\.rb$}) { |m|
+    "spec/#{m[1]}_spec.rb"
+  }
+
+  watch(%r{^app/(.*)(\.erb)$}) { |m|
+    "spec/#{m[1]}#{m[2]}_spec.rb"
+  }
+
+  watch(%r{^lib/(.+)\.rb$}) { |m|
+    "spec/lib/#{m[1]}_spec.rb"
+  }
+
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$}) { |m| [
+    "spec/routing/#{m[1]}_routing_spec.rb",
+    "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb",
+    "spec/acceptance/#{m[1]}_spec.rb"
+  ]}
+end

data/LICENSE

@@ -0,0 +1,14 @@
+##########################################################################
+# Copyright 2012 University of Notre Dame
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

data/README.mkd

@@ -1,53 +1,37 @@
 # Atrium
 
-## A note from the developers
+Atrium is a [mountable Rails engine](http://guides.rubyonrails.org/engines.html)
+that adds additional functionality to the
+[blacklight](https://github.com/projectblacklight/blacklight) Rails engine.
 
-_0.0.1 is an alpha release. Treat it accordingly_
+Think of Atrium as a lightweight Content Management System for your Blacklight
+application. An Atrium::Collection is analogous to one of your managed sites. An
+Atrium::Exhibit is analogous to one of the top-level pages of your site. These
+"pages" can be decorated with additional information via the Atrium::Showcase.
 
-_"master" is going through a major refactor. THINGS MAY BREAK. THE WORLD MAY
-END_
+The Atrium::BrowseLevel is similar to a group of pages (i.e. directory) at some
+location in your site's navigation. However, instead of explicitly creating
+pages in each directory, the Atrium::BrowseLevel interacts with your Blacklight
+configuration and Solr index to auto-generate these pages.
 
-Atrium is a project that has been gestating for a while. Consider the present
-state of the code a proof-of-concept implementation. There are lots of things we
-would do differently if we started over again. For more information see
-`ROADMAP.mkd`. The development process is coordinated in a [public-facing
-JIRA][1]
+## Getting Started
 
-## What it's for
+Make sure your Rails application first has
+[blacklight](https://github.com/projectblacklight/blacklight) installed. Then,
+from the command line:
 
-Atrium is a tool for extending a [Blacklight][2]-enabled application by:
+    $ cd /path/to/rails-project
+    $ rake atrium:install:migrations
+    $ rails generate atrium:install
+    $ rake db:migrate
 
-  - Grouping items
-  - Adding context
-  - Customizing presentation
+In the all too likely scenario that you want a custom theme for an
+Atrium::Collection use the following command:
 
-Atrium provides four mechanisms to achieve this end:
-
-  - Collections
-  - Exhibits
-  - Showcases
-  - Themes
-
-### Collections
-A 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. A collection description and or featured items form the
-collection can be displayed at the top level collection page. Collections can be
-themed independently of the base application and other collections.
-
-### Exhibits
-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. An exhibit may also have a description and a list
-of featured items.
-
-### Showcases
-A showcase is a container for storing feature 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 an exhibit.
+    $ rails generate atrium:theme NAME_OF_THEME
 
 ### Themes
+
 At present, themes are a wrapper around the existing rails templating system. A
 theme is simply a [nested layout][3] that works in conjunction with some `yeild`
 blocks in the base atrium layout. This is a pretty flexible solution but

data/ROADMAP.mkd

@@ -3,6 +3,36 @@
 The following issues need to be addressed before it would be considered a 1.0
 release candidate:
 
+## Milestone 0.1.0
+
+* Saved Search Integration with Collection and Exhibit creation
+* Write a two sentence explanation of each of the models
+* Collection presentation (i.e. an exhibit is displayed in the left navigation
+as item #2 in the display)
+* Update GETTING_STARTED
+* Atrium in-development app put up on Github
+
+* Get the in-development app running for Dan and Jeremy
+  * Banu walks Dan and Jeremy through the current "temp" app
+  * Tour of the admin
+  * Add Currency and Inquisition solr docs into one index (for in-development
+  app)
+
+* Steps to create the collection/showcase/etc.
+  * Review routes, with an eye on what needs to be there. Reference
+  Routing.mdown
+  * Add ability to create a Showcase in the admin
+  * Tweak existing admin pages
+  * Extract display helpers from Blacklight
+
+* Steps to render the collection/showcase/etc.
+  * Do the work in the atrium_temp_app
+  * Extract the views/helpers into generators
+  * Consider Liquid templating for views
+  * End-to-end specs for the in-development app (i.e. how does Blacklight tie-in
+  to the Atrium application)
+
+
 ### Atrium should be a mountable Rails engine -- but isn't
 Atrium was based on an early version of [hydra-head][1] which, in turn, shared
 code with [Blacklight][5] which was a Rails 2 plugin at the time. As such the
@@ -17,13 +47,23 @@ Blacklight in undesirable ways. Now that [Blacklight][5] provides Solr helper
 methods for both the Lucene query handler as well as the DisMax query handler we
 should be able to avoid this problem.
 
-### The routs are ugly
+### The routes are ugly
 The routes of an application is it's public API. They should be human-readable
 and should try to conform to be [resourceful][3] whenever possible. The routes
 in Atrium will be overhauled when the gem is converted to a modern Rails engine.
 The days of `/atrium_*` are numbered. Bonus points if collections have a
 [frendliy_id][4] style identifier. See `doc/Routing.mdown` for more.
 
+### The management interface is confusing
+There is a collision of concerns when managing a collection and the exhibits and
+showcases it contains. Keeping all of the possible customizations straight and
+conveying _what they actually mean_ hasn't been done effectively. There are lots
+of little changes that could be made to the present interface that would make a
+difference but more dramatic refactoring may be required to achieve the desired
+result.
+
+## Milestone 0.2.0
+
 ### Keeping track of the internal application state is fragile
 The application behaves as it should under normal circumstances but it lacks
 resilience. This stems from the complexity of interacting with the same data in
@@ -47,14 +87,6 @@ Some of these issues may be able to be addressed with better routes but
 preventing these kinds of problems entirely will require refactoring a lot of
 the application logic to make stateless interactions possible.
 
-### The management interface is confusing
-There is a collision of concerns when managing a collection and the exhibits and
-showcases it contains. Keeping all of the possible customizations straight and
-conveying _what they actually mean_ hasn't been done effectively. There are lots
-of little changes that could be made to the present interface that would make a
-difference but more dramatic refactoring may be required to achieve the desired
-result.
-
 ### The theming and templating options are underwhelming
 In order to make significant changes in the look and feel of a collection in
 Atrium you will need to know HTML, CSS, be familiar with [how Rails renders

data/Rakefile

@@ -1,6 +1,41 @@
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'bundler'
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'yard/rake/yardoc_task'
+
+namespace :doc do
+  YARD::Rake::YardocTask.new(:app) do |t|
+    t.files += [
+      'app/**/*.rb',
+      'spec/**/*_spec.rb',
+      '-',
+       "*.md",
+       "*.mkd"
+     ]
+  end
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
 Bundler::GemHelper.install_tasks
 
-Dir.glob('tasks/*.rake').each { |r| import r }
+#require 'rake/testtask'
+#
+#Rake::TestTask.new(:test) do |t|
+#  t.libs << 'lib'
+#  t.libs << 'test'
+#  t.pattern = 'test/**/*_test.rb'
+#  t.verbose = false
+#end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/{atrium/atrium.js → atrium.js}

@@ -1,12 +1,13 @@
+//= require jquery
+//= require jquery_ujs
+//= require jquery-ui-1.8.23.custom.min
 //= require chosen.jquery
-//= require ckeditor-jquery
-//= include jquery.colorbox
 //= require jquery.jeditable
+//= require ckeditor-jquery
 //= require ckeditor/jquery.generateId
 //= require ckeditor/jquery.jeditable.ckeditor
 
 
-
 (function($){
 
   $.fn.outerHTML = function() {
@@ -36,13 +37,14 @@
 
     $('.sortable').sortable({
       update: function(e, ui){
-        var $target        = $(e.target).closest('ol'),
+        var $target        = $(e.target),
             orderedItems   = {},
             resourceURL    = $target.attr('data-resource'),
-            childTag       = $target.children().first()[0].nodeName.toLowerCase(),
+            childTag       = $target.children()[0].nodeName.toLowerCase(),
             primaryLabel   = $target.attr('data-primary-label'),
             secondaryLabel = $target.attr('data-secondary-label');
-        $(childTag, $(e.target).closest('ol')).each(function(index, element){
+
+        $(childTag, $target).each(function(index, element){
           var objectId = $(element).attr('data-id');
           orderedItems[objectId] = (index + 1);
         });
@@ -65,123 +67,6 @@
       }
     });
 
-    $('.select_colorbox').colorbox({
-      width:'880px',
-      height:'80%',
-      iframe:true,
-      onClosed:function(){
-        var url = $(this).attr('action');
-        $.ajax({
-          type: 'GET',
-          url: url,
-          dataType: 'html',
-          cache: true,
-          beforeSend: function() {
-            $('#cboxLoadedContent').empty();
-            $('#cboxLoadingGraphic').show();
-          },
-          complete: function() {
-            $('#cboxLoadingGraphic').hide();
-          },
-          success: function(data) {
-            $('#show-selected').html(data);
-            $('#catalog-form').show();
-          }
-        });
-      }
-    });
-
-    $('.description_colorbox').colorbox({
-      width:'880px',
-      height:'80%',
-      iframe:true,
-      onClosed:function(){
-        var url = $(this).attr('action');
-        $.ajax({
-          type: 'GET',
-          url: url,
-          cache: true,
-          beforeSend: function() {
-            $('#cboxLoadedContent').empty();
-            $('#cboxLoadingGraphic').show();
-          },
-          complete: function() {
-            $('#cboxLoadingGraphic').hide();
-          },
-          success: function(data) {
-            var html= loadMore(data);
-            $('#show-description').html(html);
-            $('#catalog-form').show();
-
-
-          }
-        });
-      }
-    });
-
-    function getParams() {
-        var $html = $(response);
-        $html.find('a.description_colorbox').colorbox({ width: '960px', height: '90%', iframe: true });
-        return $html;
-    }
-
-    function loadMore(response) {
-        var $html = $(response);
-        $html.find('a.description_colorbox').colorbox({ width: '960px', height: '90%', iframe: true });
-        return $html;
-    }
-
-
-    //$('.description').hide();
-    $('.add_description').click(function(){
-        var $this = $(this);
-        $this.parent()
-          .children('.description')
-          .slideToggle(300, function(){
-            if ($this.text() == 'Add Description'){
-              $this.text('Hide Description');
-            }else{
-              $this.text('Add Description');
-            }
-          });
-    });
-
-    $("a.destroy_description", this).live("click", function(e) {
-       var $descNode = $(this).closest('dl')
-       var url = $(this).attr('action');
-       $.ajax({
-         type: "DELETE",
-         url: url,
-         dataType: "html",
-         beforeSend: function() {
-   			$descNode.animate({'backgroundColor':'#fb6c6c'},300);
-         },
-         success: function() {
-           $descNode.slideUp(300,function() {
-             $descNode.remove();
-           });
-         }
-       });
-    });
-
-    $("a.remove_featured", this).live("click", function(e) {
-       var $docNode = $(this).closest('div.document')
-       var url = $(this).attr('action');
-       $.ajax({
-         type: "POST",
-         url: url,
-         dataType: "html",
-         beforeSend: function() {
-   			$docNode.animate({'backgroundColor':'#fb6c6c'},300);
-         },
-         success: function(data) {
-           $docNode.slideUp(300,function() {
-             $docNode.remove();
-           });
-           //$("#show-selected").before('<div id="flash_notice"> data </div>'); // This could be implemented better
-         }
-       });
-    });
 
     $('.edit-text').editable(submitEditableText,{
          indicator : 'Saving...',
@@ -266,35 +151,5 @@
         $(this).text($(this).text() == '[Read the complete essay]' ? '[Hide essay]' : '[Read the complete essay]');
     });
 
-    $("div.ckeditor h3.index_title a").click( function(){
-      var href = $(this).attr('href');
-      var dialog = window.opener.CKEDITOR.dialog.getCurrent();
-      var parent = window.opener.document;
-      dialog.setValueOf('info','url',href);  // Populates the URL field in the Links dialogue.
-      dialog.setValueOf('info','protocol','');  // This sets the Link's Protocol to Other which loads the file from the same folder the link is on
-      dialog.setValueOf('info','displayField',$(this).html());  // Populates the display field in the Links dialogue
-      window.close(); // closes the popup window
-      return false;
-    });
-
-    $(".add_description h3.index_title a").click( function(){
-      var href = $(this).attr('href');
-      alert(href)
-       $.ajax({
-         type: "GET",
-         url: url,
-         dataType: "html",
-         beforeSend: function() {
-   			$descNode.animate({'backgroundColor':'#fb6c6c'},300);
-         },
-         success: function() {
-           $descNode.slideUp(300,function() {
-             $descNode.remove();
-           });
-         }
-       });
-      return false;
-    });
-
   });
 })(jQuery);