hydra-head 3.2.0 → 3.2.1

data/GIT_WORKFLOW.textile

@@ -1,3 +1,25 @@
+h1. Using a checkout from git as your hydra-head or active-fedora gem:
+
+h2. Advanced usage: Running against the freshest version of the hydra-head code from Github
+
+*We don't recommend this for new users or for production applications*, but it is very useful during active development.
+
+If you are in a position where you want/need to run your application with the very latest hydra-head code from Github, this is easy to do.  Simply update the line in your Gemfile that lists hydra-head as a dependency and enter this instead:
+
+<pre>
+  gem "hydra-head", :git => "git://github.com/projecthydra/hydra-head.git"
+</pre> 
+
+After updating the Gemfile, re-run 'bundle install'.
+
+You can also do this with other gems.  For example, if you want to force your app to use the latest active-fedora code from the "HYDRA-721" branch on GitHub, you can put this in your Gemfile:
+
+<pre>
+gem "active-fedora", :git=>'git://github.com/mediashelf/active_fedora.git'
+</pre>
+  
+
+
 h1. Git Workflow (with command line examples) for working on Hydra Projects
 
 h2. Reference Material/Reading:

data/HISTORY.textile

@@ -1,3 +1,7 @@
+h3. 3.2.1
+* SubmissionWorkflow was not being required
+* Removed JettyCleaner (broken and unused)
+
 h3. 3.2.0
 * Update to Blacklight 3.1.2
 * Update to ActiveFedora 3.2.0

data/README.textile

@@ -16,32 +16,12 @@ This is a Ruby on Rails 3 gem.
 
 h2. Installation/Setup
 
-h3. Use RVM (for your own Sanity)
-
-This isn't absolutely required, but working without RVM makes life really difficult.
-
-See "https://rvm.beginrescueend.com/rvm/install/":https://rvm.beginrescueend.com/rvm/install/ for instructions on installing and running RVM.  
-
-After installing RVM, set it up to use "rvmrc":http://beginrescueend.com/workflow/rvmrc/ files when they're available.  This will cause RVM to automatically switch Ruby versions and gemsets when you cd into different code bases.  Currently all Hydra software uses Ruby Enterprise Edition 1.8.7 (ree-1.8.7) and each component or Hydra Head uses its own gemsets (ie. hydra-head uses a gemset called hyhead,  hypatia uses a gemset called hypatia so that you can install a different set of dependencies for each. ) 
-
-For information about using and setting up RVM to use .rvmrc files, see "http://beginrescueend.com/workflow/rvmrc/":http://beginrescueend.com/workflow/rvmrc/
-
-h3. Make sure you have the right version of Ruby
-
-Currently all Hydra software uses Ruby Enterprise Edition 1.8.7 (ree-1.8.7) 
-
-If you are using RVM, you can install ree-1.8.7 with the following call:
-
-<pre>rvm install ree-1.8.7</pre>
-
-If you are not using RVM, consult the appropriate online documentation for installing Ruby on your operating system.
-
 h3. Install Rails, Bundler and Devise
 
 Currently hydra-head is compatible with Rails 3.0.x and incompatible with Rails 3.1
 
 <pre>
-gem install 'rails' --version '~>3.0.10'
+gem install 'rails' --version '~>3.0.11'
 gem install 'bundler'
 </pre>
   
@@ -52,18 +32,6 @@ rails new my_hydra_head
 cd my_hydra_head
 </pre>
 
-h3. Init the git Repository
-
-First, put a .gitignore file into the root of your project to keep your repository clean.  You could start with the ".gitignore file from the hydra-head gem":https://github.com/projecthydra/hydra-head/blob/master/.gitignore
-
-Now init the git repository and add the initial set of files
-
-<pre>
-  git init
-  git add .
-  git commit -m"Initial Commit: empty rails app"
-</pre>
-
 h3. Install Dependencies
 
 First, add them to the "Gemfile":http://gembundler.com/gemfile.html of your application:
@@ -71,14 +39,14 @@ First, add them to the "Gemfile":http://gembundler.com/gemfile.html of your appl
 <pre>
   source 'http://rubygems.org'
 
-  gem 'rails', '~>3.0.10'
+  gem 'rails', '~>3.0.11'
 
-  gem 'blacklight', '~> 3.0.0'
-  gem 'hydra-head', '~> 3.1.0'
+  gem 'blacklight', '~> 3.1.2'
+  gem 'hydra-head', '~> 3.2.0'
 
   # We will assume that you're using sqlite3 for testing/demo, 
   # but in a production setup you probably want to use a real sql database like mysql or postgres
-  gem 'sqlite3-ruby', :require => 'sqlite3'
+  gem 'sqlite3'
 
   #  We will assume you're using devise in tutorials/documentation. 
   # You are free to implement your own User/Authentication solution in its place.
@@ -111,29 +79,11 @@ Even if all of the dependencies are satisfied, this will take a _very_ long time
 
 <pre>
   gem install blacklight
-  gem install hydra-head -v 3.1.4
+  gem install hydra-head -v 3.2.0
 </pre>
 
 Then re-run bundle install and it will run slightly faster.
 
-h3. Advanced usage: Running against the freshest version of the hydra-head code from Github
-
-*We don't recommend this for new users or for production applications*, but it is very useful during active development.
-
-If you are in a position where you want/need to run your application with the very latest hydra-head code from Github, this is easy to do.  Simply update the line in your Gemfile that lists hydra-head as a dependency and enter this instead:
-
-<pre>
-  gem "hydra-head", :git => "git://github.com/projecthydra/hydra-head.git", :branch=>'rails3'
-</pre> 
-
-After updating the Gemfile, re-run 'bundle install'.
-
-You can also do this with other gems.  For example, if you want to force your app to use the latest active-fedora code from the "HYDRA-721" branch on GitHub, you can put this in your Gemfile:
-
-<pre>
-gem "active-fedora", :git=>'git://github.com/mediashelf/active_fedora.git', :branch=>'HYDRA-721'
-</pre>
-  
 h3. Run the generators and migrations:
 
 Run the blacklight generator
@@ -151,100 +101,11 @@ rake db:migrate
 rake db:test:prepare
 </pre>
 
-h3. Add all the generated code to the Git repository
-
-<pre>
-  git add .
-  git commit -m"Ran Blacklight, Hydra-Head, and Cucumber Generators"
-</pre>
-
 h3. You're done.
 
 Congratulations.  You've set up the code for your Hydra Head.  
 
-Read the next section on Tools for Developing and Testing, then read "How to Get Started":http://hudson.projecthydra.org/job/hydra-head-rails3-plugin/Documentation/file.HOW_TO_GET_STARTED.html to get a sense of what you can do with your Hydra Head.
-
-h2. Tools to Help You Develop and Test your Application
-
-h3. The Hydra Jetty
-
-The Hydra project provides a copy of Jetty with Fedora and Solr pre-installed.  This is useful for running tests against and for running your code against while you're actively working on your hydra head.
-
-Most projects add hydra jetty to their code as a git submodule
-
-<pre>
-  git submodule add git://github.com/projecthydra/hydra-jetty.git jetty
-  git commit -m"added jetty submodule"
-</pre>
-
-Now that you've added the submodule to your git repository, whenever you grab a new working copy of the code, you can get hydra-jetty by running:
-
-<pre>
-git submodule init
-git submodule update
-</pre>
-
-*Important*: To apply the your application's solrconfig.xml and schema.xml to the copy of solr in hydra-jetty, run this:
-
-<pre>
-  rake hydra:jetty:config
-</pre>
-
-Now you're ready to start jetty.  We've written a useful gem that gives you rake tasks for starting and stopping jetty.  Make sure you have jettywrapper in your Gemfile
-
-<pre>
-  gem "jettywrapper"
-</pre>
-
-Then run <pre>  bundle install <pre>
-
-Now that you have jettywrapper installed, to start jetty use
-
-<pre>
-  rake jetty:start
-</pre>
-
-To stop jetty
-
-<pre>
-  rake jetty:stop
-</pre>
-
-For more information about using jettywrapper, see http://hudson.projecthydra.org/job/jettywrapper/Documentation/
-
-h3.  RSpec and Cucumber for Testing
-
-We STRONGLY recommend that you write tests for every local change you make.  This will allow you to ensure that upgrading the core code doesn't break any local changes you have made.
-
-(when should it be a feature rather than a spec)
-very basic rule:  if it's testing something created with view, use a cucumber feature to test.  If it's not created by view code, use a spec to test. 
-
-h4. RSpec for Functional Tests
-
-Most Ruby projects use either RSpec or Shoulda to write and run their Functional Tests.  We use RSpec for all of the Hydra software.
-
-To set up all the files you need to use rspec to test your Rails application, simply run the rspec generator.  This will create a directory called "spec" and put all of the necessary files into it.
-
-<pre>
-    rails g rspec:install
-</pre>
-
-h4. Cucumber to Test User Experience 
-
-If you will be writing cucumber tests, run the cucumber generator.  This will create a directory called "features" and populate it with all the basic parts you need to run Cucumber tests on your Rails application.
-
-<pre>rails g cucumber:install</pre>
-
-h4.  (optional) Move everything into the test_support Directory
-
-Within the blacklight and hydra-head code bases, we have started putting all of our test-related code into a directory called test_support.  If you want to follow this convention, move the generated spec and features directories into test_support, so that you have:
-
-<pre>
-test_support/
-  features/
-  fixtures/
-  spec/
-</pre>
+Read "Tools for Developing and Testing":http://hudson.projecthydra.org/job/hydra-head-rails3-plugin/Documentation/file.Tools.html, then read "How to Get Started":http://hudson.projecthydra.org/job/hydra-head-rails3-plugin/Documentation/file.HOW_TO_GET_STARTED.html to get a sense of what you can do with your Hydra Head.
 
 h2. Modifying and Testing the hydra-head Gem 
 

data/TESTING.textile

@@ -4,7 +4,6 @@ h2. For the Impatient
 
 # clone the hydra-head code (to a fresh working copy) <pre>git clone git@github.com:projecthydra/hydra-head.git</pre>
 # switch tot he hydra-head directory <pre>cd hydra-head</pre>
-# checkout the rails3 branch <pre>git checkout rails3</pre>
 # install bundler gem <pre>gem install bundler</pre>
 # Get the project dependencies <pre>bundle install</pre>
 # grab the jetty submodule <pre>git submodule init; git submodule update</pre>
@@ -13,6 +12,7 @@ h2. For the Impatient
 ## spins up jetty (in jettywrapper)
 ## imports fixtures
 ## runs rspec & cucumber tests
+## kills jetty (in jettywrapper)
 
 h2. More Detailed Instructions & Notes
 
@@ -29,7 +29,7 @@ git submodule update
 To start the jetty:
 
 <pre>
-rake hydra:jetty:start
+rake jetty:start
 </pre>
 
 Note: the first time you start the jetty, you must use the following command in order to properly configure the jetty:

data/TESTING_PLUGIN.textile

@@ -22,7 +22,7 @@ See below to reset jetty when re-running tests, or when running a simultaneous d
 
 _Stop any copies of jetty (or anything else using port 8983) before running this command._
 
-You must do this at the root of the <b><i>hydra-head plugin</i> directory</b>, not within the hydra-plugin_test_host directory.
+You must do this at the root of the <b><i>hydra-head plugin</i> directory</b>, not within the tmp/test_app_ directory.
 
 Note that java 1.6 must be invoked by the "java" command or Fedora won't work.
 
@@ -34,7 +34,7 @@ This will start up jetty on port 8983.
 
 h4. (2) Load test fixtures into Fedora/Solr.
 
-You must do this at the root of the <b><i>hydra-head plugin</i> directory</b>, not within the hydra-plugin_test_host directory.
+You must do this at the root of the <b><i>hydra-head plugin</i> directory</b>, not within the tmp/test_app directory.
 
 NOTE: to ensure that the tests do not rely on non-test data, do this first: 
 
@@ -57,9 +57,8 @@ h4. (3) Run specs.
 OR
 
 <pre>
-  rake hyhead:remove_plugin_from_host
-  rake hyhead:copy_plugin_to_host
-  rake hyhead:rspec
+  rake hyhead:setup_test_app
+  rake hyhead:spec
 </pre>
 
 
@@ -87,7 +86,7 @@ To stop jetty:
 From the rails application directory  (my-hydra-head-test-app)
 
 <pre>
-  rake hydra:jetty:stop
+  rake jetty:stop
 </pre>
 
 Use ps to ensure the java process has stopped.  If not, kill it manually.
@@ -97,7 +96,7 @@ h4. Clean out and reload the fixtures:
 1. Stop jetty
 
 <pre>
-  rake hydra:jetty:stop
+  rake jetty:stop
 </pre>
 
 Use ps to ensure the java process has stopped.  If not, kill it manually.

data/Tools.textile

@@ -0,0 +1,72 @@
+h1. Tools to Help You Develop and Test your Application
+
+h2. The Hydra Jetty
+
+The Hydra project provides a copy of Jetty with Fedora and Solr pre-installed.  This is useful for running tests against and for running your code against while you're actively working on your hydra head.
+
+Most projects add hydra jetty to their code as a git submodule
+
+<pre>
+  git submodule add git://github.com/projecthydra/hydra-jetty.git jetty
+  git commit -m"added jetty submodule"
+</pre>
+
+Now that you've added the submodule to your git repository, whenever you grab a new working copy of the code, you can get hydra-jetty by running:
+
+<pre>
+git submodule init
+git submodule update
+</pre>
+
+*Important*: To apply the your application's solrconfig.xml and schema.xml to the copy of solr in hydra-jetty, run this:
+
+<pre>
+  rake hydra:jetty:config
+</pre>
+
+Now you're ready to start jetty.  We've written a useful gem that gives you rake tasks for starting and stopping jetty.  Make sure you have jettywrapper in your Gemfile
+
+<pre>
+  gem "jettywrapper"
+</pre>
+
+Then run <pre>bundle install<pre>
+
+Now that you have jettywrapper installed, to start jetty use
+
+<pre>
+  rake jetty:start
+</pre>
+
+To stop jetty
+
+<pre>
+  rake jetty:stop
+</pre>
+
+For more information about using jettywrapper, see http://hudson.projecthydra.org/job/jettywrapper/Documentation/
+
+h2.  RSpec and Cucumber for Testing
+
+We STRONGLY recommend that you write tests for every local change you make.  This will allow you to ensure that upgrading the core code doesn't break any local changes you have made.
+
+(when should it be a feature rather than a spec)
+very basic rule:  if it's testing something created with view, use a cucumber feature to test.  If it's not created by view code, use a spec to test. 
+
+h4. RSpec for Functional Tests
+
+Most Ruby projects use either RSpec or Shoulda to write and run their Functional Tests.  We use RSpec for all of the Hydra software.
+
+To set up all the files you need to use rspec to test your Rails application, simply run the rspec generator.  This will create a directory called "spec" and put all of the necessary files into it.
+
+<pre>
+    rails g rspec:install
+</pre>
+
+h4. Cucumber to Test User Experience 
+
+If you will be writing cucumber tests, run the cucumber generator.  This will create a directory called "features" and populate it with all the basic parts you need to run Cucumber tests on your Rails application.
+
+<pre>rails g cucumber:install</pre>
+
+

data/lib/hydra-head/version.rb

@@ -1,4 +1,4 @@
 module HydraHead
-  VERSION = "3.2.0"
+  VERSION = "3.2.1"
 end
 

data/lib/hydra.rb

@@ -16,6 +16,7 @@ module Hydra
   autoload :ModelMixins
   autoload :ModsGenericContent
   autoload :ModsImage
+  autoload :SubmissionWorkflow
   autoload :SuperuserAttributes
   autoload :User
 end

data/lib/railties/active-fedora.rake

@@ -0,0 +1 @@
+require "active-fedora"  # This causes active-fedora's rake tasks to be loaded

data/tasks/active-fedora.rake

@@ -0,0 +1 @@
+require "active-fedora"  # This causes active-fedora's rake tasks to be loaded

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hydra-head
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 3
   - 2
-  - 0
-  version: 3.2.0
+  - 1
+  version: 3.2.1
 platform: ruby
 authors: 
 - Matt Zumwalt, Bess Sadler, Julie Meloni, Naomi Dushay, Jessie Keck, John Scofield, Justin Coyne & many more.  See https://github.com/projecthydra/hydra-head/contributors
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-09 00:00:00 -06:00
+date: 2012-01-18 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -718,6 +718,7 @@ files:
 - Rakefile
 - TESTING.textile
 - TESTING_PLUGIN.textile
+- Tools.textile
 - app/controllers/assets_controller.rb
 - app/controllers/contributors_controller.rb
 - app/controllers/downloads_controller.rb
@@ -995,11 +996,11 @@ files:
 - lib/hydra/submission_workflow.rb
 - lib/hydra/superuser_attributes.rb
 - lib/hydra/user.rb
-- lib/jetty_cleaner.rb
 - lib/marc_mapper.rb
 - lib/marc_record_ext.rb
 - lib/mediashelf/active_fedora_helper.rb
 - lib/prev_next_links.rb
+- lib/railties/active-fedora.rake
 - lib/railties/all_tests.rake
 - lib/railties/hydra-fixtures.rake
 - lib/railties/hydra_jetty.rake
@@ -1013,6 +1014,7 @@ files:
 - solr_conf/conf/schema.xml
 - solr_conf/conf/solrconfig.xml
 - solr_conf/solr.xml
+- tasks/active-fedora.rake
 - tasks/hydra-head-fixtures.rake
 - tasks/hydra-head.rake
 - tasks/hydra_jetty.rake

data/lib/jetty_cleaner.rb

@@ -1,27 +0,0 @@
-class JettyCleaner
-
-  def self.clean(namespace=nil)
-    objects = Fedora::Repository.instance.find_objects(:limit=>1000000)
-    
-    objects.each do |obj|
-      case obj
-      when ActiveFedora::Base
-        puts "deleting #{obj.pid}"
-      when Fedora::FedoraObject
-        puts "found FedoraObject #{obj.pid}"
-        if namespace
-          if obj.pid.match(/^#{namespace}:/)
-            puts "deleting #{obj.pid} from namespace #{namespace}" 
-            ActiveFedora::Base.load_instance( obj.pid ).delete
-          end
-        else
-          puts "deleting #{obj.pid}"
-          ActiveFedora::Base.load_instance( obj.pid ).delete
-        end
-      else
-        puts "#{obj.pid} is a #{obj.class}. Could not load and delete it."
-      end
-    end
-    nil
-  end
-end