hydra-head 4.0.0.rc5 → 4.0.0.rc6

data/README_RAILS3_CHANGES.textile

@@ -1,67 +0,0 @@
-
-h2. Views
-
-Security has been tightened in Rails3, forcing you to include _authenticity_token__ with all requests.  If you have forms or javascript that submits requests without this token, Rails will destroy the user session, effectively logging the user out (see http://weblog.rubyonrails.org/2011/2/8/csrf-protection-bypass-in-ruby-on-rails).  The easiest way to make sure this token is properly included in your forms is to generate the forms using the +form_tag+ or +form_for+ view helpers from Rails.
-
-h2. Fixtures
-
-Fixtures are loaded from a directory _within the test app_, which is updated when you run rake hyhead:setup_test_app so in order to update a fixture, you must change it in test_support/fixtures and then either re-run rake hyhead:setup_test_app or copy the fixture into tmp/test_app/test_support/fixtures
-
-h2. Cucumber tests
-
-We have switched from Webrat to Capybara as the driver for our Cucumber tests.  If you have been writing your own cucumber tests (you should!) and want to stay in sync with the rest of the hydra developers, you should switch to Capybara and pull all of the "step definitions from the hydra code":https://github.com/projecthydra/hydra-head/tree/rails3/test_support/features/step_definitions into your local app.
-
-Sometime soon, we hope to wrap our step definitions into the Hydra code itself so that you can use them without having to manually copy the files into your step_definitions directory.  This will probably be done in a way that imitates the "Factory Girl step definitions":http://robots.thoughtbot.com/post/284805810/gimme-three-steps
-
-h2. User objects
-
-Blacklight has switched to using devise instead of authlogic as its default user/authentication system.  As part of this switch, no longer have a "login" attribute as their unique identifier.  Instead, you must use email as the unique identifier.  We have added a "login" method that 
-
-h2. User Attributes
-
-User attributes (first_name, last_name, full_name, affiliation and photo) have been removed from HydraHead.
-
-h2. Controllers
-
-* Removed Djatoka (JPEG 2000) support and the GetController
-
-h2. Views
-
-* removed fluid infusion javascript
-* moved javascripts from the plugin directory.  Update your views to remove ":plugin=>:hydra_repository"
-
-h3. What this means:
-
-* Our sample user "archivist1" is now "archivist1@example.com".  
-* Your cucumber features and rspec tests must use email addresses as the unique identifier for Users
-
-Change your features and role_map YAML files accordingly.
-
-
-
-
-h2. How to upgrade
-
-The sureest and easiest path to upgrading a hydra head application from Rails 2 to Rails 3, is to start a new project from scratch.
-
-* Create a new rails 3 project
-* Add ```gem 'blacklight'``` and ```gem 'hydra-head'``` to the Gemfile
-* run ```bundle install```
-* cp -r old_project/vendor/plugin/old_project_plugin/app/* new_project/app
-* cp -r old_project/vendor/plugin/old_project_plugin/lib/* new_project/lib
-<<<<<<< HEAD
-* copy any tests (test, spec, feature, etc) from the old_project_plugin directory to the new project
-* Run the generators 
-```rails g blackight -devise```
-Run the hydra-head generator
-```rails g hydra:head -df```
-Run the database migrations
-```rake db:migrate
-rake db:migrate RAILS_ENV=test```
-
-* If you will be writing cucumber tests, run the cucumber generator
-```rails g cucumber:install```
-* copy any tests (test, spec, feature, etc) from the old_project_plugin directory to the new project 
-* update your solrconfig.xml
-* update your role_map_...yml files to use appropriate identifiers
-

data/README_RAKE_TASKS.textile

@@ -1,107 +0,0 @@
-h2. Getting info about the rake tasks from the command line
-
-<pre>rake -T</pre>
-
-To narrow down the output, use grep. For example:
-
-<pre>rake -T | grep hy</pre>
-
-
-h2. hydra:jetty Tasks
-
-h3. The main tasks: load, start, stop
-
-<pre>
-  rake hydra:jetty:load                       # Copies the default SOLR config files and starts up the fedora instance.
-  rake hydra:jetty:restart                    # Restarts the bundled Hydra Testing Server
-  rake hydra:jetty:start                      # Starts the bundled Hydra Testing Server
-  rake hydra:jetty:status                     # Returns the status of the Hydra::TestingServer.
-  rake hydra:jetty:stop                       # Stops the bundled Hydra Testing Server
-</pre>
-
-h3. Subtasks: config, config_fedora, config_solr
-
-<pre>
-  rake hydra:jetty:config                     # Copies the default Solr & Fedora configs into the bundled Hydra Testing Server
-  rake hydra:jetty:config_fedora              # Copies a custom fedora config for the bundled Hydra Testing Server
-  rake hydra:jetty:config_solr                # Copies the default SOLR config for the bundled Hydra Testing Server
-</pre>
-  
-h2. hyhead Continuous Integration Tasks
-
-h3. hyhead Full Continuous Integration Build: ci
-
-<pre>
-  rake hyhead:ci                              # Execute Continuous Integration build (docs, tests with coverage)
-</pre>
-
-h2. hyhead Test Host Setup: setup_test_host
-
-Many of the other tasks call this for you.
-
-<pre>
-  rake hyhead:setup_test_host                 # Copy all of the necessary code into the test host
-</pre>
-
-h3. Subtasks for setting up test host
-
-These are the tasks used by setup_test_host
-
-<pre>
-  rake hyhead:copy_plugin_to_host             # Copy the current plugin code into hydra-plugin_test_host/vendor/plugins/hydra-head
-  rake hyhead:remove_plugin_from_host         # Remove hydra-plugin_test_host/vendor/plugins/hydra-head
-  rake hyhead:copy_features_to_host           # Copy current contents of the features directory into hydra-plugin_test_host/features
-  rake hyhead:remove_features_from_host       # Remove hydra-plugin_test_host/features
-  rake hyhead:copy_fixtures_to_host           # Copy current contents of the spec/fixtures directory into hydra-plugin_test_host/spec/fixtures
-  rake hyhead:remove_fixtures_from_host       # Remove hydra-plugin_test_host/spec/fixtures
-</pre>
-  
-h2. hyhead RSpec Tasks
-
-h3. The main RSpec task: spec
-
-<pre>
-  rake hyhead:spec                            # Easiest way to run rspec tests.
-</pre> 
-
-This is the same as calling 
-
-<pre>
-  rake hyhead:rspec:setup_and_run             # Sets up test host, loads fixtures, then runs specs - need to have jetty running.
-</pre>
-
-h4. Rspec subtasks
-
-To run the rspec tests without any setup, use 
-
-<pre>
-  rake hyhead:rspec:run                       # Run the hydra-head specs - need to have jetty running, test host set up and fixtures loaded.
-</pre>
-
-h2. hyhead Cucumber Tasks
-
-h3. The main Cucumber task: cucumber
-
-<pre>
-  rake hyhead:cucumber                        # Easieset way to run cucumber tests.
-</pre>  
-
-This is the same as calling
-
-<pre>
-  rake hyhead:cucumber:setup_and_run          # Sets up test host, loads fixtures, then runs cucumber features - need to have jetty running.
-</pre>
-
-h3. Cucumber subtasks
-
-To run the cucumber tests without any setup, use 
-
-<pre>
-  rake hyhead:cucumber:run                    # Run cucumber tests for hyhead - need to have jetty running, test host set up and fixtures loaded.
-</pre>
-
-h3. Generating RDocs
-
-<pre>
-  rake hyhead:doc                             # Generate YARD Documentation
-</pre>

data/README_SUBTREE.textile

@@ -1,87 +0,0 @@
-h1. Tracking Plugins with Git Subtree
-
-We are now tracking all of the Hydra plugins in their own Git repositories.  We are doing this with the git subtree tool.  This allows each hydra head to have a full copy of each plugin in its working copy.  When you want to commit plugin changes back to the shared plugin git repository, use the git subtree tool to "split" that plugin's code and commit log into its own branch, then merge your changes into the shared plugin repository.
-
-h2. Getting the git subtree tool
-
-You can checkout the git subtree tool from https://github.com/apenwarr/git-subtree
-
-The tool itself is just a single-file shell script that you need to install into where the rest of your git scripts are stored.  See the "INSTALL instructions":https://github.com/apenwarr/git-subtree/blob/master/INSTALL
-
-Once you've got it installed, refer to  "git-subtree.txt":https://github.com/apenwarr/git-subtree/blob/master/git-subtree.txt for details on how to use the script.  For our purposes, you can mostly rely on the info below.
-
-h2. Using the git subtree tool 
-
-Say I'm working on the HyHull project and I need to commit changes from my head back to the shared hydrangea_articles plugin
-
-First, add the hydrangea_articles git repository to your remote repositories
-
-<pre>
-git remote add articles-repo git@github.com:projecthydra/hydrangea_articles.git
-</pre>
-  
-Then, use git subtree to split your copy of the plugin into a new branch in your local git repository.  Include the name of your hydra head in the --annotate value. This will be appended to all of your commits.
-
-<pre>
-git subtree split --prefix=vendor/plugins/hydrangea_articles --annotate="(HyHull) " -b articles
-</pre>
-  
-This will create a new branch called "articles"
-
-Now checkout your articles branch, rebase to the master branch of the shared plugin, and then push your changes to the shared plugin
-
-<pre>
-git checkout articles
-git rebase articles-repo/master
-git push articles-repo articles:master
-</pre>
-  
-If you don't want to push your updates directly into the master branch of the shared plugin, push to a new remote branch with the name of the ticket you're working on and ask another committer to review your changes and/or apply them.
-
-<pre>
-git push articles-repo articles:my-ticket-number
-</pre>
-
-If you just want to share a replica of your copy of the plugin without rebasing, you can use git subtree push to post a copy of your work as a branch on the shared plugin's git repo:
-
-Ex:
-</pre>
-git subtree push --prefix=vendor/plugins/hydrangea_books --annotate="(HyHull) " -b HYHULL-219
-<pre>
-  
-Complete example with shell outputs:
-
-In this example, I 
-
-* split the plugin subtree into its own branch
-* checkout the new plugin branch
-* rebase the plugin branch against the plugin repository's master branch
-* push my updates into the plugin repository's master branch
-
-<pre>
-hydrangea matt$ git subtree split --prefix=vendor/plugins/hydrangea_datasets --annotate="(hydrangea)  " -b datasets
-Created branch 'datasets'
-f2d9407ada9744f3b8bcabac83ddb1cd3fb47e28
-
-hydrangea matt$ git checkout datasets
-warning: unable to rmdir jetty: Directory not empty
-Checking out files: 100% (4723/4723), done.
-Switched to branch 'datasets'
-
-hydrangea matt$ git fetch datasets-remote
-From github.com:projecthydra/hydrangea_datasets
- * [new branch]      master     -> datasets-remote/master
-
-hydrangea matt$ git rebase datasets-remote/master
-First, rewinding head to replay your work on top of it...
-Applying: (hydrangea)  fixing licenses in plugins
-
-hydrangea matt$ git push datasets datasets-remote:master
-Counting objects: 4, done.
-Delta compression using up to 2 threads.
-Compressing objects: 100% (3/3), done.
-Writing objects: 100% (3/3), 708 bytes, done.
-Total 3 (delta 1), reused 0 (delta 0)
-To git@github.com:projecthydra/hydrangea_datasets.git
-   656bf34..20ba2ba  datasets -> master
-</pre>

data/README_TERSE.textile

@@ -1,92 +0,0 @@
-h2. Installation/Setup
-
-h3. (1) Grab the code
-
-<pre>
-git clone git@github.com:projecthydra/hydra-head.git
-</pre>
-
-h3. (2) Grab jetty and the test host application
-
-The git repository includes references to git submodules containing hydra-jetty and a sample Blacklight app that you can install the hydra-head plugin into.
-
-<pre>
-cd hydra-head
-git submodule init
-git submodule update
-bundle install
-</pre>
-
-
-h3. (3) IMPORTANT: Put a copy of the plugin into the host app
-
-*If you don't run this, you will not be able to run the test host app or its rake tasks*
-
-The host application needs a copy of the plugin in its vendor/plugins directory.  We provide a rake task for this.  The rake task will copy all of the plugin code into hydra-plugin_test_host/vendor/plugins
-
-<pre>
-rake hyhead:copy_to_host_plugins_dir
-</pre>
-
-
-h3. (4) Migrate the host app's databases
-
-<pre>
-cd hydra-plugin_test_host
-rake db:drop:all
-rake db:migrate
-rake db:migrate RAILS_ENV=test  
-cd ..
-</pre>
-
-h2. Running the full Continuous Integration build
-
-_Stop any copies of jetty that you have running before running this._
-
-This will spin up jetty, import your fixtures into it run the tests, and stop jetty.
-
-<pre>
-rake hyhead:ci RAILS_ENV=test 
-</pre>
-
-h2. Running the Tests Manually
-
-h3. Start Jetty and load the fixtures
-
-<pre>
-rake hydra:jetty:load RAILS_ENV=test
-rake hydra:default_fixtures:refresh environment=test
-</pre>
-
-h3. Run the RSpec Tests
-
-<pre>
-rake hyhead:spec
-</pre>
-
-OR
-
-<pre>
-rake hyhead:remove_from_host_plugins_dir
-rake hyhead:copy_to_host_plugins_dir
-rake hyhead:rspec
-</pre>
-
-
-h2. Running the App
-
-The test host app is a regular Rails app with Blacklight installed.  Its configured with the assumption that the hydra-head plugin is installed into vendor/plugins/hydra-head.
-
-Before starting the app, make sure that you have the latest copy of the plugin code copied into its plugins directory.
-
-<pre>
-rake hyhead:remove_from_host_plugin
-rake hyhead:copy_to_host_plugins_dir
-</pre>
-
-After copying the plugin code, cd into the root of the test app and start it like you normally start any rails app.
-
-<pre>
-cd hydra-plugin_test_host
-script/server
-</pre>

data/RELEASE_NOTES.textile

@@ -1,8 +0,0 @@
-h2. 3.0.0
-
-If you have been testing out the Release Candidates, you need to add this line to your CatalogController:
-
-<pre>
-  # This filters out objects that you want to exclude from search results.  By default, it filters out FileAssets  
-  CatalogController.solr_search_params_logic << :exclude_unwanted_models
-</pre>

data/TESTING.textile

@@ -1,85 +0,0 @@
-h1. Directions to Clone and Test the Rails 3 hydra-head Code
-
-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>
-# 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>
-# test <pre>rake hyhead:ci</pre> This command:
-## creates the test app in tmp/test_app
-## spins up jetty (in jettywrapper)
-## imports fixtures
-## runs rspec & cucumber tests
-## kills jetty (in jettywrapper)
-
-h2. More Detailed Instructions & Notes
-
-h3. The Hydra Jetty
-
-In order to test the gem during development, the hydra-jetty is included as a submodule to provide both a fedora and solr instance.  Once you have cloned the github repository, 
-run the following commands to load the jetty:
-
-<pre>
-git submodule init
-git submodule update
-</pre>
-
-To start the jetty:
-
-<pre>
-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:
-
-<pre>
-rake hydra:jetty:load
-</pre>
-
-
-h3.  Testing the gem
-
-The specs and features for testing the gem within the context of a rails 3 app are all contained within the test_support directory.  Once you have 
-installed the test app, you will be able to run the specs/features from within that app via the provided rake tasks.
-
-A rake task is provided for setting up a rails 3 test app in the tmp/test_app directory.  To generate the app, run:
-
-<pre>
-rake hyhead:setup_test_app
-</pre>
-
-Once you have done this and have a jetty running, you are ready to run the specs and cucumbers:
-
-<pre>
-rake hyhead:test
-</pre>
-
-This will run the specs and cucumber features from within the test application.
-
-In order to run a single spec or cucumber feature, use the following from the command line:
-
-<pre>
-export RAILS_ROOT="tmp/test_app"
-rspec test_support/spec/controllers/catalog_controller_spec.rb  # path to the spec file you wish to run
-cucumber test_support/features/mods_asset_show.feature          # path to the feature file you wish to run
-</pre>
-
-h2. Note about vendor/cache directory
-
-In order to more quickly install the required gems, the gems have been cached and are stored in the vendor/cache directory.  Initially this was done to avoid the 
-excessive amount of time bundler was taking to install all the gems and their dependencies.  To get all the requisite gems, simply run:
-
-<pre>
-bundle install --local
-</pre>
-
-The cached gems also provide a quick means for generating a gemset for the test_app.  
-
-When developing the hydra-head gem, be sure to commit changes to the vendor/cache directory when you update or install a new gem.
-
-h2. Note about solr and fedora config files
-
-When you change the solr and fedora config files, you must update them in the generator templates directory (lib/generators/hydra-head) as well as root of the hydra_head code.
-