hydra-tutorial 0.2.0 → 0.2.1

data/HISTORY.md

@@ -0,0 +1,15 @@
+h3. 0.2.1
+
+* Minor edits to various messages and user prompts.
+* Improved the index view.
+* Modified edit view to agree with Record model.
+* Added the --thru option, mainly for developer use.
+
+h3. 0.2.0
+
+* Added ability to run tutorial step-by-step.
+* Added Git to generated Rails app so user can diff changes between steps.
+
+h3. 0.1.0
+
+* Initial versions.

data/development_notes.txt

@@ -1,476 +1,42 @@
-TODO:
-  - Incorporate enhancements from notes.txt info tutorial.
+Incorporate the edits from the last commit (00b010bb) of hydra_walkthrough.
 
-  - Improve README.
-  - Remove monkey-patch to hydra-head.
-  - Write method to extract long messages from the tutorial code.
-  - Support the --pop option.
-  - Implement a --help option.
-  - Support control over verbosity, and tie it to :capture declarations.
-  - Improve tutorial unit tests.
-  - Improve the views in the tutorial.
-  - Write unit tests for the tutorial script itself.
-  - Write an integration test for the entire tutorial.
+See issues submitted by users on Github.
 
+Improve README.
 
-====================================================================
+Remove monkey-patch of hydra-head.
 
-# Install a version of Ruby.
+Write method to extract long messages from the tutorial code.
 
-# Install RVM.
+Support the --pop option.
 
-# Install Ruby 1.9.
+Implement a --list option.
 
-# Create a gemset
-rvm use --rvmrc --create 1.9.3@hydra_walkthrough
+Implement a --help option.
 
-# See current gems.
-gem list
+Support control over verbosity, and tie it to :capture declarations.
 
-# Install bundler and Rails.
-gem install bundler rails
+Improve tutorial unit tests.
 
-# See the effect.
-gem list
+Improve the views in the tutorial.
 
-# Initialize a new Rails application.
-rails new hydra_walkthrough
+Write unit tests for the tutorial script itself.
 
-# Put the .rvmrc file in our project directory.
-mv .rvmrc hydra_walkthrough
+Write an integration test for the entire tutorial.
 
-# Get a copy of the resources directory.
-...
+Edit desc() commands: search for FIX.
 
-# Get a copy the hydra-jetty project.
-git clone git://github.com/projecthydra/hydra-jetty.git
+Use delegate_to().
 
-# Put a copy of it into our Rails project.
-cp -r hydra-jetty hydra_walkthrough/jetty
+Make resources(:records) a separate Git commit.
 
-# Check out the initial Rails app.
-cd hydra_walkthrough
+Various problems evident after the check_the_new_form step:
+  - Delete links are not working.
+  - Keywords are not being saved.
+  - The view has multiple problems and is not in synce with the model.
 
-# Add to .gitignore
-jetty
-.rvmrc
-Gemfile.lock
+run_hydra_generators() produces a large commit. Can we break this apart?
 
-# Git.
-git init
-git add .
-git commit -m 'Initial commit'
+write_model_test()
 
-# Run the Rails server in a second terminal window.
-rails server
-open http://localhost:3000
-
-# Check before we add some gems.
-rake -T
-
-# Add some lines to Gemfile.
-# In the :assets block.
-gem 'execjs'
-gem 'therubyracer', :platforms => :ruby
-
-# In the :development block.
-gem 'jettywrapper'
-gem 'debugger'
-
-# Git.
-git add .
-git commit -m 'Added some gems: execjs, therubyracer, jettywrapper, debugger'
-
-# Set up SOLR and Fedora config files.
-cp ../resources/solr.yml   config
-cp ../resources/fedora.yml config
-
-# Git.
-git add -A
-git commit -m 'Created SOLR and Fedora config files'
-
-# Bundle.
-bundle install
-
-# Check after: note the jetty tasks.
-rake -T
-
-# Start the Jetty server that will run Fedora and SOLR.
-rake jetty:start
-
-# Check them out.
-open http://localhost:8983/fedora/
-open http://localhost:8983/solr/development/admin/
-
-# More Gemile.
-gem 'active-fedora'
-gem 'om'
-
-# Bundle.
-bundle install
-
-# Git.
-git add .
-git commit -m 'Added active-fedora and OM gems'
-
-# Create a basic model.
-cp ../resources/basic_af_model.rb app/models/record.rb
-
-# Git.
-git add -A
-git commit -m 'Created a basic Record model with a descMetadata datastream'
-
-# Check it out.
-rails console
-
-    ## CREATE
-    > obj = Record.new
-    > xml = '<xyz><foo>ABC</foo><foo>DEF</foo><bar>123</bar></xyz>'
-    > obj.descMetadata.content = xml
-    > obj.save
-
-    > pid = obj.pid
-
-    ## RETRIEVE
-    > obj = Record.find(pid)
-    > ds = obj.descMetadata
-    > puts ds.content
-
-    ## UPDATE
-    > doc = ds.ng_xml
-    > elements = doc.xpath '//foo'
-    > elements.each { |e| puts e }
-    > exit
-
-# Check it out in the browser.
-open http://localhost:8983/fedora/objects/
-  -> click search
-  -> click the hyperlink of the object's PID (eg, 'changeme:1')
-  -> click hyperlink to view the object's datastreams list
-  -> click hyperlink to view the content of the descMetadata datastream
-
-# Back in the Rails console:
-
-    rails console
-
-    ## DELETE
-    > obj = Record.find('changeme:1')
-    > obj.delete
-    > exit
-
-# Check it out in the browser.
-# And click search button.
-open http://localhost:8983/fedora/objects/
-
-# Enhance our datastream.
-cp ../resources/basic_om_model.rb app/models/record.rb
-
-# Git.
-git commit -am 'Added an OM terminology'
-
-# Check it out.
-rails console
-
-    > obj = Record.new
-    > obj.descMetadata.title = "My object title"
-    > obj.save
-    > puts obj.descMetadata.content
-    > obj.delete
-    > exit
-
-# Modify record.rb
-# Add this after the has_metadata call.
-
-  delegate :title, :to => 'descMetadata'
-
-# Git.
-git commit -am 'Added delegate() to the model'
-
-# Check it out.
-rails console
-
-    > obj = Record.new
-    > obj.title = "My object title"
-    > obj.save
-    > puts obj.descMetadata.content
-    > puts obj.title.inspect
-    > obj.delete
-    > exit
-
-# Use delegate_to().
-# Replace the delete() line.
-
-  delegate_to 'descMetadata', [:title, :author, :url, :description], :unique => true
-
-# Git.
-git commit -am 'Switched to delegate_to()'
-
-# Check it out.
-rails console
-
-    > obj = Record.new
-    > obj.title = "Some title"
-    > obj.title
-    > obj.author = 'Some author'
-    > obj.save
-    > puts obj.descMetadata.contnet
-    > puts obj.descMetadata.content
-    > obj.delete
-    > exit
-
-# Enhance our model.
-# This example is too complicated.
-# Also, it undoes the delegate_to().
-cp ../resources/basic_mods_model.rb   app/models/record.rb
-cp ../resources/mods_desc_metadata.rb app/models/mods_desc_metadata.rb
-
-# Git.
-git add -A
-git commit -m 'Added a more extensive OM example'
-
-# Check it out.
-rails console
-
-    > obj = Record.new
-    > obj.title = "My object title"
-    > obj.save
-    > puts obj.descMetadata.content
-    > obj.delete
-    > exit
-
-# Initialize a controller and views for our Record model.
-rails generate scaffold_controller Record --no-helper --skip-test-framework
-
-# Git.
-git add -A
-git commit -m 'Added a basic controller and views for the Record model'
-
-# Check files that were created.
-app/controlers/records_controller.rb
-app/views/records/
-
-# Modify config/routes.rb
-resources :records
-
-# Git.
-git commit -am 'Set up resourceful routing for the Record model'
-
-# Put some files in place.
-cp ../resources/_form.html.erb app/views/records/_form.html.erb
-cp ../resources/show.html.erb    app/views/records/show.html.erb
-
-# Git.
-git commit -am 'Fleshed out the edit form and show page'
-
-# Try it out.
-# Delete links are not working.
-# Keywords are not being saved.
-# The view has multiple problems and is not in synce with the model.
-open http://localhost:3000/records/new
-
-# More Gemile.
-gem 'blacklight'
-gem 'hydra-head'
-gem 'devise'
-
-# Git.
-git commit -am 'Added blacklight, hydra-head, and devise'
-
-# Bundle.
-bundle install
-
-# Remove some files.
-rm public/index.html
-rm config/solr.yml
-
-# Set up devise.
-rails generate blacklight --devise
-
-# Git.
-git add -A
-git commit -m 'Set up devise'
-
-# Remove some files.
-rm config/solr.yml
-rm app/controllers/catalog_controller.rb
-
-# Set up a User model for hydra-head.
-rails generate hydra:head User
-
-# Do some stuff.
-rake db:migrate
-rake db:test:prepare
-rake jetty:stop
-rake hydra:jetty:config
-rake jetty:start
-
-# Git.
-git add -A
-git commit -m 'Set up User model under hydra-head'
-
-# Various edits:
-
-    # app/controllers/records_controller.rb
-    include Hydra::AssetsControllerHelper
-    include Hydra::AccessControlsEnforcement
-    before_filter :enforce_access_controls
-
-    # app/controllers/records_controller.rb
-    # In create(), after @record is set.
-    apply_depositor_metadata(@record)
-
-    # app/models/record.rb
-    include Hydra::ModelMixins::CommonMetadata
-    include Hydra::ModelMethods
-
-    # app/models/solr_document.rb
-    # After other includes.
-    include Hydra::Solr::Document
-
-    # app/assets/javascripts/application.js
-    # At end of file.
-    Blacklight.do_search_context_behavior = function() { }
-
-# Git.
-git commit -am 'Included hydra-head into our model, controller, etc.'
-
-# Check it out.
-# Needed to edit hydra-head:  _user_util_links.html.erb
-open http://localhost:3000/records/new
-    -> Click sign up.
-    -> Enter any email and password.
-
-# Add some gems for testing.
-# In the :test group (and :development group?)
-gem 'rspec'
-gem 'rspec-rails'
-
-# Git.
-git commit -am 'Added rspec gem'
-
-# Bundle
-bundle install
-
-# Set up rspec.
-rails generate rspec:install
-
-# Git.
-git add -A
-git commit -m 'Initialized rspec directory'
-
-# Create a test.
-# This test should do something real.
-mkdir spec/controllers
-cp ../resources/records_controller_spec.rb spec/controllers/records_controller_spec.rb
-
-# Git.
-git add -A
-git commit -m 'Create a placeholder test'
-
-# Run the test
-rspec
-
-# Add some gems for testing.
-# In the :test group (and :development group?)
-gem 'capybara'
-
-# Bundle
-bundle install
-
-# Git.
-git commit -am 'Added capybara gem'
-
-# Create a test.
-mkdir spec/integration
-cp ../resources/integration_spec.rb spec/integration/integration_spec.rb
-
-# Git.
-git add -A
-git commit -m 'Created a few integration tests'
-
-# Run the tests
-rspec
-
-# Create a ci rake task.
-cp ../resources/ci.rake lib/tasks/ci.rake
-
-# Git.
-git add -A
-git commit -m 'Created a ci rake task'
-
-# Run it.
-rake jetty:stop
-rake ci
-rake jetty:start
-
-# Add a gem for test coverage.
-# In the :test group (and :development group?)
-gem 'simplecov'
-
-# Bundle
-bundle install
-
-# Git.
-git commit -am 'Added simplecov gem'
-
-# ci.rake
-# After Rails.env is set.
-ENV['COVERAGE'] ||= 'true'
-
-# spec/spec_helper.rb
-# After ENV['RAILS_ENV'] is set.
-if ENV['COVERAGE'] == "true"
-  require 'simplecov'
-  SimpleCov.start do
-    add_filter "config/"
-    add_filter "spec/"
-  end
-end
-
-# Add to .gitignore
-coverage
-
-# Git
-git commit -am 'Set up test coverage'
-
-# Run it.
-rake jetty:stop
-rake ci
-rake jetty:start
-
-# Check test coverage
-open coverage/index.html
-
-# app/models/record.rb
-# After has_metadata
-has_file_datastream :name => 'content', :type => ActiveFedora::Datastream
-
-# app/controllers/records_controller.rb
-include Hydra::Controller::UploadBehavior
-
-# app/controllers/records_controller.rb
-# After: apply_depositor_metadata().
-@record.label = params[:record][:title] # this is a bad hack to work around an AF bug
-add_posted_blob_to_asset(@record, params[:filedata]) if params.has_key?(:filedata)
-
-# app/views/records/_form.html.erb
-# Delete first line. Use this instead:
-<%= form_for(@record, :html => { :multipart => true } ) do |f| -%>
-  <h2>File</h2>
-  <%= file_field_tag "filedata"  %>
-
-# Get stuff.
-cp ../resources/_add_assets_links.html.erb app/views/_add_assets_links.html.erb
-
-# Git.
-git add -A
-git commit -m 'Add some styling and link to new Record in the header of the layout'
-
-# Run the app.
-rake jetty:stop
-rake jetty:start
-rails server
-
-# Wrap up.
-Shut down rails server (CTRL-C)
-rake jetty:stop
+run_integration_test_fail(): seems to small of a step: combine with previous?

data/hydra-tutorial.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "hydra-tutorial"
-  s.version     = "0.2.0"
+  s.version     = "0.2.1"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Chris Beer", "Monty Hindman"]
   s.email       = ["hydra-tech@googlegroups.com"]

data/templates/_form.wiring_it_into_rails.html.erb

@@ -1,29 +1,35 @@
 <%= form_for(@record) do |f| -%>
-  <h2>Title</h2>
+  <h2>Title and Author</h2>
+
   <div class="row">
       <%= f.label :title, "Title" %>
       <%= f.text_area :title, :value=>@record.title, :required => true %>
   </div>
 
-  <h2>Abstract and keywords</h2>
-
   <div class="row">
-    <%= f.label :abstract %>
-    <%= f.text_area :abstract, :value=>@record.abstract.first, :required=>true %>
+      <%= f.label :author, "Author" %>
+      <%= f.text_area :author, :value=>@record.author, :required => true %>
   </div>
 
+  <h2>Abstract</h2>
+
   <div class="row">
-    <%= label_tag("hydrus_item_keywords", "Keywords") %>
-    <%= text_field_tag("hydrus_item_keywords", @record.descMetadata.subject.topic.join(", ")) -%>
-    <div class="help">separate keywords with commas</div>
+    <%= f.label :abstract %>
+    <%= f.text_area :abstract, :value=>@record.abstract, :required=>true %>
   </div>
 
-  <h2>Citations</h2>
+  <h2>Citation and related URL</h2>
+
   <div class="row">
     <%= f.label :preferred_citation, "Preferred citation for this object", :class => "hidden-tablet" %>
     <%= f.text_area :preferred_citation, :value=>@record.preferred_citation %>
   </div>
 
+  <div class="row">
+    <%= f.label :related_url, "URL of related item", :class => "hidden-tablet" %>
+    <%= f.text_area :related_url, :value=>@record.related_url %>
+  </div>
+
   <input type="submit" class="btn btn-small save-edits" name="save" id="save" />
 
 <% end %>

data/templates/basic_mods_model.rb

@@ -1,13 +1,12 @@
 class Record < ActiveFedora::Base
 
-  has_metadata :name => "descMetadata", :type => ModsDescMetadata
-
-  delegate :title, :to=>'descMetadata', :at => [:mods, :titleInfo, :title], :unique=>true
-  delegate :abstract, :to => "descMetadata"
-  delegate :preferred_citation, :to => "descMetadata", :unique=>true
-  delegate :author, :to=>'descMetadata', :at => [:name, :namePart], :unique=>true
-  delegate :url, :to=>'descMetadata', :at => [:relatedItem, :location, :url], :unique=>true
-  delegate :description, :to=>'descMetadata', :at => [:abstract], :unique=>true
+  has_metadata :name => 'descMetadata', :type => ModsDescMetadata
+
+  delegate :title,              :to => 'descMetadata', :unique=>true, :at => [:mods, :titleInfo, :title]
+  delegate :author,             :to => 'descMetadata', :unique=>true, :at => [:name, :namePart]
+  delegate :abstract,           :to => 'descMetadata', :unique=>true
+  delegate :preferred_citation, :to => 'descMetadata', :unique=>true
+  delegate :related_url,        :to => 'descMetadata', :unique=>true, :at => [:relatedItem, :location, :url]
 
 end
 

data/templates/index.html.erb

@@ -0,0 +1,24 @@
+<h1>Listing records</h1>
+
+<table>
+  <tr>
+    <th>Actions</th>
+    <th>Title</th>
+  </tr>
+
+<% @records.each do |record| %>
+  <tr>
+    <td>
+      <%= link_to 'Show', record %> |
+      <%= link_to 'Edit', edit_record_path(record) %> |
+      <%= link_to 'Delete', record, method: :delete, data: { confirm: 'Are you sure?' } %>
+    </td>
+    <td><%= record.title %></td>
+  </tr>
+
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Record', new_record_path %>

data/tutorial.thor

@@ -29,7 +29,7 @@ module HydraTutorialHelpers
   def rails_console
     return if @@conf.quick
     say %Q{
-  We'll launch the console again. Give some of those commands a try.\n}, STATEMENT
+  We'll launch the console again.\n}, STATEMENT
     say %Q{
   Hit Ctrl-D (^D) to stop the Rails console and continue this tutorial.\n}, WAIT
     run "rails c"
@@ -132,6 +132,7 @@ class HydraTutorial < Thor
   HTConf = Struct.new(
     # Command-line options.
     :run_all,        # If true, run all remaining tasks rather than only the next task.
+    :thru,           # Implies :run_all and stores name of last task to be run.
     :quick,          # If true, bypass interactive user confirmations.
     :reset,          # If true, reset the tutorial back to the beginning.
     :gems_from_git,  # If true, get a couple of gems directly from github.
@@ -150,6 +151,7 @@ class HydraTutorial < Thor
   desc('main: FIX', 'FIX')
   method_options(
     :run_all       => :boolean,
+    :thru          => :string,
     :quick         => :boolean,
     :reset         => :boolean,
     :gems_from_git => :boolean,
@@ -190,6 +192,9 @@ class HydraTutorial < Thor
       # Persist the fact that the task was run to the YAML progress file.
       @@conf.done << t
       File.open(@@conf.progress_file, "w") { |f| f.puts(@@conf.to_yaml) }
+
+      # Exit loop if we just ran the task user supplied with --thru option.
+      break if t == @@conf.thru
     end
 
     # Inform user if the tutorial is finished.
@@ -206,6 +211,7 @@ class HydraTutorial < Thor
   def self.initialize_config(opts)
     @@conf                = HTConf.new
     @@conf.run_all        = opts[:run_all]
+    @@conf.thru           = opts[:thru]
     @@conf.quick          = opts[:quick]
     @@conf.reset          = opts[:reset]
     @@conf.gems_from_git  = opts[:gems_from_git]
@@ -216,6 +222,7 @@ class HydraTutorial < Thor
     @@conf.progress_file  = (opts[:progress_file] || '.hydra-tutorial-progress')
     @@conf.done           = nil
     @@conf.templates_path = File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+    @@conf.run_all = true if @@conf.thru
   end
 
   # Initializes the YAML progress file that keeps track of which
@@ -270,21 +277,16 @@ class HydraTutorial < Thor
   def welcome
     say %Q{
   Welcome to this Hydra tutorial. We're going to step through building a
-  working Hydra application. We'll build the application gradually, starting
-  by building our "business logic", wiring in HTML views, and then
-  connecting it to our Rails application.
+  working Hydra application. We'll build the application gradually, starting by
+  building our "business logic", wiring in HTML views, and then connecting it
+  to our Rails application.
 
-  At several points in this tutorial, as we iteratively develop our files,
-  you may be prompted to review conflicts between versions of files. It is
-  safe to blindly accept the changes ('y'), however you may wish to view
-  the diff ('d') to see the things we're change.
+  We'll generate a stub application in the #{@@conf.app} folder. You can change
+  that using the --app option.
 
   This tutorial, a README file, and our bug tracker are at:
 
-      https://github.com/projecthydra/hydra-tutorial
-
-  We'll generate a stub application in the #{@@conf.app}
-  folder. You can change that using the --app option.\n}, STATEMENT
+      https://github.com/projecthydra/hydra-tutorial\n}, STATEMENT
   end
 
   desc('install_ruby: FIX', 'FIX')
@@ -337,8 +339,8 @@ class HydraTutorial < Thor
 
     if File.exists? @@conf.app
       say %Q{
-    #{@@conf.app} already exists. Either remove it or provide
-    a different application name using the --app option.}, WARNING
+  #{@@conf.app} already exists. Either remove it or provide
+  a different application name using the --app option.}, WARNING
       exit
     end
 
@@ -382,8 +384,12 @@ class HydraTutorial < Thor
 
   desc('adding_dependencies: FIX', 'FIX')
   def adding_dependencies
-    gem 'execjs'
-    gem 'therubyracer'
+    say %Q{
+  Now we'll add some Javascript dependencies.\n}, STATEMENT
+    gem_group :assets do
+      gem 'execjs'
+      gem 'therubyracer'
+    end
     run_git('Added gems for Javascript: execjs and therubyracer')
   end
 
@@ -417,19 +423,24 @@ class HydraTutorial < Thor
     copy_file 'fedora.yml', 'config/fedora.yml'
 
     say %Q{
-  Add the 'jettywrapper' gem, which adds Rake tasks to start and stop Jetty.\n}, STATEMENT
+  And we will add the 'jettywrapper' gem, which adds Rake tasks to start
+  and stop Jetty.\n}, STATEMENT
 
-    gem 'jettywrapper'
+    gem_group :development, :test do
+      gem 'jettywrapper'
+    end
     run 'bundle install', :capture => false
     run_git('Solr and Fedora configuration')
+  end
 
+  desc('starting_jetty: FIX', 'FIX')
+  def starting_jetty
     say %Q{
-  Starting Jetty\n}, STATEMENT
+  Now we'll start Jetty.\n}, STATEMENT
     rake 'jetty:start'
 
     say %Q{
-  Take a look around. Jetty should be running on port 8983. You can see
-  the Fedora server at:
+  Jetty should be running on port 8983. You can see the Fedora server at:
 
     http://localhost:8983/fedora/
 
@@ -442,6 +453,8 @@ class HydraTutorial < Thor
 
   desc('remove_public_index: FIX', 'FIX')
   def remove_public_index
+    say %Q{
+  Removing the default home page from Rails. We will replace it later.\n}, STATEMENT
     remove_file 'public/index.html'
     run_git('Removed the Rails index.html file')
   end
@@ -478,28 +491,37 @@ class HydraTutorial < Thor
   launch the Rails interactive console (`rails c`), we can create
   and manipulate our object:
 
-    ## CREATE
-    > obj = Record.new
-    # => #<Record:1571331701243443635 @pid="__DO_NOT_USE__" >
-    > obj.descMetadata.content = e.g. '<my_xml_content />'
-    > obj.save
+      # CREATE
+      > obj = Record.new
+      > xml = '<xyz><foo>ABC</foo><foo>DEF</foo><bar>123</bar></xyz>'
+      > obj.descMetadata.content = xml
+      > obj.save
+
+      > pid = obj.pid
+
+      # RETRIEVE
+      > obj = Record.find(pid)
+      > ds = obj.descMetadata
+      > puts ds.content
 
-    > obj.pid
-    # => e.g. 'changeme:1'
+      # UPDATE
+      > doc = ds.ng_xml
+      > elements = doc.xpath '//foo'
+      > elements.each { |e| puts e }
 
-    ## RETRIEVE
-    > obj = Record.find('changeme:1')
-    > ds = obj.descMetadata
-    # => #<ActiveFedora::NokogiriDatastream:3283711306477137919 ...>
-    > ds.content
-    # => (should be the XML document you added before)
+      # Now check the Fedora object in the browser.
+      #   -> open http://localhost:8983/fedora/objects
+      #   -> click search
+      #   -> click the hyperlink of the object's PID (eg, 'changeme:1')
+      #   -> click hyperlink to view the object's datastreams list
+      #   -> click hyperlink to view the content of the descMetadata datastream
 
-    ## UPDATE
-    # manipulating XML:
-    > ds.ng_xml.xpath('//my_xml_content')
+      # Back in the Rails console.
+
+      # DELETE
+      > obj.delete
+      > exit\n}, STATEMENT
 
-    ## DELETE
-    > obj.delete\n}, STATEMENT
     rails_console
   end
 
@@ -518,34 +540,52 @@ class HydraTutorial < Thor
   desc('experiment_with_om_descmd: FIX', 'FIX')
   def experiment_with_om_descmd
     say %Q{
-  If you launch the Rails interactive console, we can now create and
+  If we launch the Rails interactive console, you can now create and
   manipulate our object using methods provided by OM.
 
     > obj = Record.new
     > obj.descMetadata.title = "My object title"
     > obj.save
-    > obj.descMetadata.content
-    # => An XML document with the title "My object title"\n}, STATEMENT
+
+  Notice also that OM also makes it easy to instantiate an empty version
+  of a datastream. This behavior is controlled by the code in the
+  xml_template() method of our Record model. Having set a value for
+  the title and saved the object, you can now take a look at the entire
+  datastream spawned by OM according to the instructions in the
+  xml_template() method:
+  
+    > puts obj.descMetadata.content
+
+    > obj.delete
+    > exit\n}, STATEMENT
     rails_console
   end
 
   desc('use_the_delegate_method: FIX', 'FIX')
   def use_the_delegate_method
     say %Q{
-  We can use the #delegate method to tell the model-object how
-  to access these attributes.
+  We can use the delegate() method to tell the model object how
+  to access its descMetadata attributes.\n\n}, STATEMENT
+
+    loc = %Q{\nend\n}
+    insert_into_file "app/models/record.rb", :before => loc do
+      "\n  delegate :title, :to => 'descMetadata'"
+    end
+    run_git('Modify Record model to delegate title to descMetadata')
+
+    say %Q{
+  Back in the Rails console you can now access the title attribute directly
+  from the object:
 
     > obj = Record.new
     > obj.title = "My object title"
     > obj.save
-    > obj.descMetadata.content
-    # => An XML document with the title "My object title"\n\n}, STATEMENT
+    > puts obj.descMetadata.content
+    > puts obj.title.inspect
+    > obj.delete
+    > exit\n}, STATEMENT
 
-    loc = 'has_metadata :name => "descMetadata", :type => DatastreamMetadata\n'
-    insert_into_file "app/models/record.rb", :after => loc do
-      "delegate :title, :to => 'descMetadata'\n"
-    end
-    run_git('Modify Record model to delegate title to descMetadata')
+    rails_console
   end
 
   desc('add_mods_model_with_mods_descmd: FIX', 'FIX')
@@ -573,8 +613,8 @@ class HydraTutorial < Thor
     > obj = Record.new
     > obj.title = "My object title"
     > obj.save
-    > obj.descMetadata.content
-    # => A MODS XML document\n}, STATEMENT
+    > puts obj.descMetadata.content
+    > exit\n}, STATEMENT
     rails_console
   end
 
@@ -593,11 +633,12 @@ class HydraTutorial < Thor
     run_git('Used Rails generator to create controller and views for the Record model')
 
     say %Q{
-  If you look in ./app/views/records, you can see a set of
-  Rails ERB templates.
+  You can see a set of Rails ERB templates, along with a controller that
+  ties the Record model to those view, if you look in the following
+  directories of the application:
 
-  ./app/controlers/records_controller.rb contains the controller
-  that ties the model to the views.\n}, STATEMENT
+      app/controlers/records_controller.rb
+      app/views/records/\n}, STATEMENT
 
     continue_prompt
   end
@@ -605,11 +646,12 @@ class HydraTutorial < Thor
   desc('add_new_form: FIX', 'FIX')
   def add_new_form
     say %Q{
-  The scaffold just provided the basic outline for an application, so
-  we need to provide the guts for the web form. Here's a simple one:\n\n}, STATEMENT
+  The scaffold provided only the basic outline for an application, so
+  we need to provide the guts for the web form.\n\n}, STATEMENT
     files = [
       ["_form.wiring_it_into_rails.html.erb", "app/views/records/_form.html.erb"],
       ["show.html.erb",                       "app/views/records/show.html.erb"],
+      ["index.html.erb",                      "app/views/records/index.html.erb"],
     ]
     files.each do |src, dst|
       remove_file dst
@@ -636,7 +678,7 @@ class HydraTutorial < Thor
   patterns that have emerged in the Hydra community, including search,
   gated discovery, etc.
 
-  We'll add a few new gems:
+  We'll add a few gems:
 
     - blacklight provides a discovery interface on top of the Solr index
 
@@ -684,7 +726,7 @@ class HydraTutorial < Thor
   desc('hydra_jetty_config: FIX', 'FIX')
   def hydra_jetty_config
     say %Q{
-  Hydra provides some configuration for Solr and Fedora. Use them.\n}, STATEMENT
+  Hydra provides some configuration for Solr and Fedora. We will use them.\n}, STATEMENT
     rake 'jetty:stop'
     rake 'hydra:jetty:config'
     rake 'jetty:start'
@@ -735,11 +777,19 @@ include Hydra::Solr::Document
   def check_catalog
     say %Q{
   Blacklight and Hydra-Head have added some new functionality to the
-  application. We can now look at a search interface (provided
-  by Blacklight) and use gated discovery over our repository. By default,
-  objects are only visible to their creator.
+  application. We can now look at a search interface (provided by Blacklight)
+  and use gated discovery over our repository. By default, objects are only
+  visible to their creator.
 
-  Create some new objects, and then check out the search catalog at:
+  First create a new user account:
+
+      http://localhost:3000/users/sign_up
+
+  Then create some Record objects:
+
+      http://localhost:3000/records/new
+
+  And then check the search catalog:
 
       http://localhost:3000/catalog\n}, STATEMENT
 
@@ -767,12 +817,12 @@ include Hydra::Solr::Document
   end
 
   # TODO: write the test.
-  desc('write_model_test: FIX', 'FIX')
-  def write_model_test
-    # copy_file 'record_test.rb', 'spec/models/record_test.rb'
-    # run_git('Added a model test')
-    run 'rspec'
-  end
+  # desc('write_model_test: FIX', 'FIX')
+  # def write_model_test
+  #   # copy_file 'record_test.rb', 'spec/models/record_test.rb'
+  #   # run_git('Added a model test')
+  #   run 'rspec'
+  # end
 
   # TODO: this test should do something.
   desc('write_controller_test: FIX', 'FIX')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-tutorial
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-19 00:00:00.000000000 Z
+date: 2012-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -70,6 +70,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- HISTORY.md
 - README.md
 - Rakefile
 - bin/hydra-tutorial
@@ -94,6 +95,7 @@ files:
 - templates/ci.rake
 - templates/ci_with_coverage.rake
 - templates/fedora.yml
+- templates/index.html.erb
 - templates/integration_spec.rb
 - templates/mods_desc_metadata.rb
 - templates/records_controller.rb
@@ -115,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1291579110055489875
+      hash: -2393405687621414256
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -124,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1291579110055489875
+      hash: -2393405687621414256
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24