trestle_generator 1.0.0 → 1.0.1

data/USAGE

@@ -1,18 +1,18 @@
 Description:
-    The trestle generator (an adaptation of the Rails scaffold generator)
-    creates a controller to interact with a model. If the model does not exist,
-    it creates the model as well. The generated code is equivalent to the
-    "scaffold :model" declaration, making it easy to migrate when you wish to
-    customize your controller and views.
+    The trestle generator (a drop-in replacement for the Rails scaffold
+    generator) creates a controller and views to interact with a model. If the
+    model does not exist, it creates the model as well. The generated code is
+    equivalent to the "scaffold :model" declaration, making it easy to migrate
+    when you wish to customize your controller and views.
     
     The generator takes a model name, an optional controller name, and a
-    list of views as arguments. Trestled actions and views are created
+    list of views as arguments. Trestle actions and views are created
     automatically. Any views left over generate empty stubs.
     
-    The trestled actions are:
+    The trestle actions are:
         index, new, edit, destroy
     
-    The trestled views are:
+    The trestle views are:
         _index_without_id, _index_with_id, new, edit
     
     If a controller name is not given, the plural form of the model name

data/templates/controller.rb

@@ -1,10 +1,10 @@
 class <%= controller_class_name %>Controller < ApplicationController
-  verify :only => [ :edit<%= suffix %>, :destroy<%= suffix %> ],
+  verify :only => [ 'destroy<%= suffix %>', 'edit<%= suffix %>' ],
          :params => :id,
          :add_flash => { :notice => 'Missing <%= singular_name %> ID.' },
          :redirect_to => { :action => '<%= suffix || 'index' %>' }
   
-<% for action in untrestled_actions -%>
+<% for action in nontrestle_actions -%>
   def <%= action %><%= suffix %>
   end
   

data/templates/functional_test.rb

@@ -13,16 +13,16 @@ class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
     @response   = ActionController::TestResponse.new
   end
   
-<% for action in untrestled_actions -%>
+<% for action in nontrestle_actions -%>
   def test_<%= action %>
-    get :<%= action %>
+    get '<%= action %>'
     assert_response :success
     assert_template '<%= action %>'
   end
   
 <% end -%>
   def test_<%= suffix || 'index' %>
-    get :<%= suffix || 'index' %>
+    get '<%= suffix || 'index' %>'
     assert_response :success
     assert_template '<%= plural_name %>/_<%= suffix || 'index' %>_without_id'
   end
@@ -30,7 +30,7 @@ class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
   def test_destroy<%= suffix %>_using_get
     assert_not_nil <%= model_name %>.find(1)
     
-    get :destroy<%= suffix %>, :id => 1
+    get 'destroy<%= suffix %>', :id => 1
     assert_response :redirect
     assert_redirected_to :action => 'edit<%= suffix %>'
     
@@ -40,7 +40,7 @@ class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
   def test_destroy<%= suffix %>_using_post
     assert_not_nil <%= model_name %>.find(1)
     
-    post :destroy<%= suffix %>, :id => 1
+    post 'destroy<%= suffix %>', :id => 1
     assert_response :redirect
     assert_redirected_to :action => '<%= suffix || 'index' %>'
     
@@ -48,7 +48,7 @@ class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
   end
   
   def test_edit<%= suffix %>_using_get
-    get :edit<%= suffix %>, :id => 1
+    get 'edit<%= suffix %>', :id => 1
     
     assert_response :success
     assert_template 'edit<%= suffix %>'
@@ -58,13 +58,13 @@ class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
   end
   
   def test_edit<%= suffix %>_using_post
-    post :edit<%= suffix %>, :id => 1
+    post 'edit<%= suffix %>', :id => 1
     assert_response :redirect
     assert_redirected_to :action => '<%= suffix || 'index' %>', :id => 1
   end
   
   def test_<%= suffix || 'index' %>_without_id
-    get :<%= suffix || 'index' %>
+    get '<%= suffix || 'index' %>'
     
     assert_response :success
     assert_template '<%= plural_name %>/_<%= suffix || 'index' %>_without_id'
@@ -73,7 +73,7 @@ class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
   end
   
   def test_<%= suffix || 'index' %>_with_id
-    get :<%= suffix || 'index' %>, :id => 1
+    get '<%= suffix || 'index' %>', :id => 1
     
     assert_response :success
     assert_template '<%= plural_name %>/_<%= suffix || 'index' %>_with_id'
@@ -83,7 +83,7 @@ class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
   end
   
   def test_new<%= suffix %>_using_get
-    get :new<%= suffix %>
+    get 'new<%= suffix %>'
     
     assert_response :success
     assert_template 'new<%= suffix %>'
@@ -94,7 +94,7 @@ class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
   def test_new<%= suffix %>_using_post
     num_<%= plural_name %> = <%= model_name %>.count
     
-    post :new<%= suffix %>, :<%= singular_name %> => {}
+    post 'new<%= suffix %>', :<%= singular_name %> => {}
     
     assert_response :redirect
     assert_redirected_to :action => '<%= suffix || 'index' %>'

data/trestle_generator.rb

@@ -75,7 +75,7 @@ class TrestleGenerator < Rails::Generator::NamedBase
       # Depend on model generator but skip if the model exists.
       m.dependency 'model', [singular_name], :collision => :skip
       
-      # Scaffolded forms.
+      # Trestle forms.
       m.complex_template "form.rhtml",
         File.join('app/views',
                   controller_class_path,
@@ -87,7 +87,7 @@ class TrestleGenerator < Rails::Generator::NamedBase
         :end_mark => 'eoform',
         :mark_id => singular_name
       
-      # Scaffolded views.
+      # Trestle views.
       trestle_views.each do |action|
         m.template "view_#{action}.rhtml",
                    File.join('app/views',
@@ -118,8 +118,8 @@ class TrestleGenerator < Rails::Generator::NamedBase
       m.template 'style.css',     'public/stylesheets/trestle.css'
       
       
-      # Untrestled views.
-      untrestled_actions.each do |action|
+      # Non-trestle views.
+      nontrestle_actions.each do |action|
         path = File.join('app/views',
                           controller_class_path,
                           controller_file_name,
@@ -153,7 +153,7 @@ class TrestleGenerator < Rails::Generator::NamedBase
     class_name.demodulize
   end
   
-  def untrestled_actions
+  def nontrestle_actions
     args - trestle_actions
   end
   

metadata

@@ -3,53 +3,56 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: trestle_generator
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2006-01-03
-summary: "[Rails] An adaptation of the scaffold generator that produces production-ready
-  controllers that are safe from state-changing HTTP GET requests and that have
-  streamlined URLs."
+  version: 1.0.1
+date: 2006-01-10
+summary: "[Rails] A drop-in replacement for the scaffold generator that produces
+  production-ready controllers that are safe from state-changing HTTP GET requests
+  and that have streamlined URLs."
 require_paths: 
   - templates
 email: nils@alumni.rice.edu
 homepage: http://www.rubyforge.org/projects/trestle
 rubyforge_project: trestle
-description: "The name of this RubyGem points out that nobody intentionally sends a train
-  across a gorge with nothing but a scaffold to support it. That�s what a trestle
-  is for!  Why use the trestle generator instead of the scaffold generator? The
-  trestle generator produces code that is closer to production-quality in two
-  respects:  SAFETY  The trestle generator uses the HTTP POST method for actions
-  that change data. Well-behaved web applications protect themselves against
-  errant HTTP GET requests (such as come from Google Web Accelerator and the
-  like). The scaffold generator fails to do this.  USABILITY  The trestle
-  generator produces controllers with just four actions (index, new, edit, and
-  destroy). Controllers produced by the scaffold generator have eight actions.
-  Fewer actions exposed to the outside world is better if the behavior of these
-  actions is in line with the semantics of HTTP GET and HTTP POST. The net effect
-  is that you will not have to throw away or tweak as much trestle-generated code
-  as you do scaffold-generated code. Less work for you means your application gets
-  built sooner. Tobias L�tke�s postback_generator RubyGem has the same idea.  The
-  scaffold generator produces a controller with the following public interface for
-  a database table named �people�:  /people - lists existing person records 
-  /people/list - lists existing person records  /people/new - shows an empty
-  person form  /people/create - creates a new person record from request
-  parameters  /people/show/99 - shows the person record having ID 99 
-  /people/edit/99 - shows a person form for the person record having ID 99 
-  /people/update/99 - updates the person record having ID 99 using request
-  parameters  /people/destroy/99 - deletes the person record having ID 99, even
-  for HTTP GET!  Contrast this with the public interface produced by the trestle
-  generator:  /people - lists existing person records  /people/new - HTTP GET
-  shows an empty person form; HTTP POST creates a new person record from request
-  parameters  /people/99 - shows the person record having ID 99  /people/99/edit -
-  HTTP GET shows a person form for the person record having ID 99; HTTP POST
-  updates the person record having ID 99 using request parameters 
-  /people/99/destroy - HTTP GET redirects to /people/99/edit with a notice that
-  the user must click the form�s Destroy button to destroy a record; HTTP POST
-  deletes the person record having ID 99 after prompting the user for confirmation
-  Notice the hierarchical nature of trestle URLs. Because the ID comes before the
-  verb, there are fewer illegal variations that with scaffold URLs. This
-  encourages the user to use the Up One Level button on the Google Toolbar that
-  clips one element off the end of the current URL. Scaffold URLs do not play
-  nicely with the Up One Level button."
+description: "Don�t drive your train across a gorge with nothing but a scaffold underneath it.
+  Use a trestle instead!  The trestle generator is drop-in replacement for the
+  Rails scaffold generator. Unlike scaffolding, trestle controllers protect your
+  models from state-changing HTTP GET requests. They also have streamlined URLs
+  that make your application more usable.  SAFETY  The trestle generator requires
+  the HTTP POST method for actions that change data. Well-behaved web applications
+  protect themselves against errant HTTP GET requests such as come from Google Web
+  Accelerator and the like. Scaffolded controllers fail to do this.  USABILITY 
+  Trestle controllers have just four actions (index, new, edit, and destroy). The
+  scaffold generator produces controllers that have eight actions. Fewer actions
+  exposed to the outside world is better if the behavior of these actions is in
+  line with the semantics of HTTP GET and HTTP POST. The net effect of this design
+  improvement is that you will not have to throw away or tweak as much
+  trestle-generated code as you do scaffold-generated code. Less work for you
+  means your application gets built sooner. Tobias L�tke�s postback_generator
+  RubyGem had the same idea, but trestle goes further.  A scaffold for a database
+  table named �people� has the following HTTP interface:  /people - Lists existing
+  person records  /people/list - Lists existing person records  /people/new -
+  Shows an empty person form  /people/create - Creates a new person record from
+  request parameters  /people/show/99 - Shows the person record having ID 99 
+  /people/edit/99 - Shows a person form for the person record having ID 99 
+  /people/update/99 - Updates the person record having ID 99 using request
+  parameters  /people/destroy/99 - Deletes the person record having ID 99, even
+  for HTTP GET!  Contrast this with the HTTP interface of the equivalent trestle
+  controller:  /people - GET or POST lists existing person records  /people/new -
+  GET shows an empty person form  /people/new - POST creates a new person record
+  from request parameters  /people/99 - GET or POST shows the person record having
+  ID 99  /people/99/edit - GET shows a person form for the person record having ID
+  99  /people/99/edit - POST updates the person record having ID 99 using request
+  parameters /people/99/destroy - GET redirects to /people/99/edit with a notice
+  that the user must click the form�s Destroy button in order to destroy a record 
+  /people/99/destroy - POST deletes the person record having ID 99 after prompting
+  the user for confirmation  Notice the hierarchical nature of trestle URLs.
+  Because the ID comes before the verb, the user can click the Up One Level button
+  on the Google Toolbar to explore the application. (The Up One Level button clips
+  one element off the end of the current URL.) Scaffold URLs do not play nicely
+  with the Up One Level button.  Trestle controllers are pain relief to users who
+  like the Up One Level button. But for a user who likes to type URLs in by hand,
+  it also shows a friendly notice if his request is missing an ID. This is one
+  more way to improve usability."
 autorequire: 
 default_executable: 
 bindir: bin