trestle_generator 1.0.0

data/USAGE

@@ -0,0 +1,35 @@
+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 generator takes a model name, an optional controller name, and a
+    list of views as arguments. Trestled actions and views are created
+    automatically. Any views left over generate empty stubs.
+    
+    The trestled actions are:
+        index, new, edit, destroy
+    
+    The trestled views are:
+        _index_without_id, _index_with_id, new, edit
+    
+    If a controller name is not given, the plural form of the model name
+    will be used. The model and controller names may be given in CamelCase
+    or under_score and should not be suffixed with 'Model' or 'Controller'.
+    Both model and controller names may be prefixed with a module like a
+    file path; see the Modules Example for usage.
+
+Example:
+    ./script/generate trestle Account Bank debit credit
+    
+    This will generate an Account model and BankController with a full test
+    suite and a basic user interface. Now create the accounts table in your
+    database and browse to http://localhost/bank/ -- voila, you're on Rails!
+
+Modules Example:
+    ./script/generate trestle CreditCard 'admin/credit_card' suspend late_fee
+    
+    This will generate a CreditCard model and CreditCardController controller
+    in the admin module.

data/templates/controller.rb

@@ -0,0 +1,56 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  verify :only => [ :edit<%= suffix %>, :destroy<%= suffix %> ],
+         :params => :id,
+         :add_flash => { :notice => 'Missing <%= singular_name %> ID.' },
+         :redirect_to => { :action => '<%= suffix || 'index' %>' }
+  
+<% for action in untrestled_actions -%>
+  def <%= action %><%= suffix %>
+  end
+  
+<% end -%>
+  def destroy<%= suffix %>
+    if request.post?
+      <%= model_name %>.find(params[:id]).destroy
+      flash[:notice] = 'The <%= singular_name %> was successfully destroyed.'
+      redirect_to :action => '<%= suffix || 'index' %>'
+    else
+      flash[:notice] = 'Click Destroy to destroy the <%= model_name %>.'
+      redirect_to :action => 'edit<%= suffix %>', :id => params[:id]
+    end
+  end
+  
+  def edit<%= suffix %>
+    if request.post?
+      @<%= singular_name %> = <%= model_name %>.find(params[:id])
+      if @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+        flash[:notice] = 'The <%= singular_name %> was successfully edited.'
+        redirect_to :action => '<%= suffix || 'index' %>', :id => @<%= singular_name %>
+      end
+    else
+      @<%= singular_name %> = <%= model_name %>.find(params[:id])
+    end
+  end
+  
+  def <%= suffix || 'index' %>
+    if params[:id]
+      @<%= singular_name %> = <%= model_name %>.find(params[:id])
+      render '<%= plural_name %>/_<%= suffix || 'index' %>_with_id'
+    else
+      @<%= singular_name %>_pages, @<%= plural_name %> = paginate(:<%= plural_name %>)
+      render '<%= plural_name %>/_<%= suffix || 'index' %>_without_id'
+    end
+  end
+  
+  def new<%= suffix %>
+    if request.post?
+      @<%= singular_name %> = <%= model_name %>.new(params[:<%= singular_name %>])
+      if @<%= singular_name %>.save
+        flash[:notice] = 'A new <%= singular_name %> was successfully added.'
+        redirect_to :action => '<%= suffix || 'index' %>'
+      end
+    else
+      @<%= singular_name %> = <%= model_name %>.new
+    end
+  end
+end

data/templates/form.rhtml

@@ -0,0 +1,3 @@
+<%%= error_messages_for '<%= singular_name %>' %>
+
+<%= template_for_inclusion %>

data/templates/form_trestle.rhtml

@@ -0,0 +1 @@
+<%= all_input_tags(@model_instance, @singular_name, {}) %>

data/templates/functional_test.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + '<%= "/.." * controller_class_nesting_depth %>/../test_helper'
+require '<%= controller_file_path %>_controller'
+
+# Re-raise errors caught by the controller.
+class <%= controller_class_name %>Controller; def rescue_action(e) raise e end; end
+
+class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
+  fixtures :<%= table_name %>
+  
+  def setup
+    @controller = <%= controller_class_name %>Controller.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+  
+<% for action in untrestled_actions -%>
+  def test_<%= action %>
+    get :<%= action %>
+    assert_response :success
+    assert_template '<%= action %>'
+  end
+  
+<% end -%>
+  def test_<%= suffix || 'index' %>
+    get :<%= suffix || 'index' %>
+    assert_response :success
+    assert_template '<%= plural_name %>/_<%= suffix || 'index' %>_without_id'
+  end
+  
+  def test_destroy<%= suffix %>_using_get
+    assert_not_nil <%= model_name %>.find(1)
+    
+    get :destroy<%= suffix %>, :id => 1
+    assert_response :redirect
+    assert_redirected_to :action => 'edit<%= suffix %>'
+    
+    assert_not_nil <%= model_name %>.find(1)
+  end
+  
+  def test_destroy<%= suffix %>_using_post
+    assert_not_nil <%= model_name %>.find(1)
+    
+    post :destroy<%= suffix %>, :id => 1
+    assert_response :redirect
+    assert_redirected_to :action => '<%= suffix || 'index' %>'
+    
+    assert_raise(ActiveRecord::RecordNotFound) { <%= model_name %>.find(1) }
+  end
+  
+  def test_edit<%= suffix %>_using_get
+    get :edit<%= suffix %>, :id => 1
+    
+    assert_response :success
+    assert_template 'edit<%= suffix %>'
+    
+    assert_not_nil assigns(:<%= singular_name %>)
+    assert assigns(:<%= singular_name %>).valid?
+  end
+  
+  def test_edit<%= suffix %>_using_post
+    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' %>
+    
+    assert_response :success
+    assert_template '<%= plural_name %>/_<%= suffix || 'index' %>_without_id'
+    
+    assert_not_nil assigns(:<%= plural_name %>)
+  end
+  
+  def test_<%= suffix || 'index' %>_with_id
+    get :<%= suffix || 'index' %>, :id => 1
+    
+    assert_response :success
+    assert_template '<%= plural_name %>/_<%= suffix || 'index' %>_with_id'
+    
+    assert_not_nil assigns(:<%= singular_name %>)
+    assert assigns(:<%= singular_name %>).valid?
+  end
+  
+  def test_new<%= suffix %>_using_get
+    get :new<%= suffix %>
+    
+    assert_response :success
+    assert_template 'new<%= suffix %>'
+    
+    assert_not_nil assigns(:<%= singular_name %>)
+  end
+  
+  def test_new<%= suffix %>_using_post
+    num_<%= plural_name %> = <%= model_name %>.count
+    
+    post :new<%= suffix %>, :<%= singular_name %> => {}
+    
+    assert_response :redirect
+    assert_redirected_to :action => '<%= suffix || 'index' %>'
+    
+    assert_equal num_<%= plural_name %> + 1, <%= model_name %>.count
+  end
+end

data/templates/helper.rb

@@ -0,0 +1,2 @@
+module <%= controller_class_name %>Helper
+end

data/templates/layout.rhtml

@@ -0,0 +1,13 @@
+<html>
+<head>
+  <title><%= controller_class_name %>: <%%= controller.action_name %></title>
+  <%%= stylesheet_link_tag 'trestle' %>
+</head>
+<body>
+
+<p style="color: green"><%%= flash[:notice] %></p>
+
+<%%= @content_for_layout %>
+
+</body>
+</html>

data/templates/routes.rb

@@ -0,0 +1,21 @@
+ActionController::Routing::Routes.draw do |map|
+  # Add your own custom routes here.
+  # The priority is based upon order of creation: first created -> highest priority.
+  
+  # Here's a sample route:
+  # map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # You can have the root of your site routed by hooking up '' 
+  # -- just remember to delete public/index.html.
+  # map.connect '', :controller => "welcome"
+
+  # Allow downloading Web Service WSDL as a file with an extension
+  # instead of a file named 'wsdl'
+  map.connect ':controller/service.wsdl', :action => 'wsdl'
+
+  # Install the default route as the lowest priority.
+  map.connect ':controller/:action', :action => 'index', :requirements => { :action => /[^\d]+/ }
+  map.connect ':controller/:id', :action => 'index', :requirements => { :id => /[\d]+/ }
+  map.connect ':controller/:id/:action'
+end

data/templates/style.css

@@ -0,0 +1,74 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+.fieldWithErrors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#ErrorExplanation {
+  width: 400px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 12px;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#ErrorExplanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#ErrorExplanation p {
+  color: #333;
+  margin-bottom: 0;
+  padding: 5px;
+}
+
+#ErrorExplanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+div.uploadStatus {
+  margin: 5px;
+}
+
+div.progressBar {
+  margin: 5px;
+}
+
+div.progressBar div.border {
+  background-color: #fff;
+  border: 1px solid grey;
+  width: 100%;
+}
+
+div.progressBar div.background {
+  background-color: #333;
+  height: 18px;
+  width: 0%;
+}
+

data/templates/view__index_with_id.rhtml

@@ -0,0 +1,8 @@
+<%% for column in <%= model_name %>.content_columns %>
+<p>
+  <b><%%= column.human_name %>:</b> <%%= h @<%= singular_name %>.send(column.name) %>
+</p>
+<%% end %>
+
+<%%= link_to 'Edit', :action => 'edit<%= suffix %>', :id => @<%= singular_name %> %> |
+<%%= link_to 'Back to list', :action => '<%= suffix || 'index' %>' %>

data/templates/view__index_without_id.rhtml

@@ -0,0 +1,27 @@
+<h1>Listing <%= plural_name %></h1>
+
+<table>
+  <tr>
+  <%% for column in <%= model_name %>.content_columns %>
+    <th><%%= column.human_name %></th>
+  <%% end %>
+  </tr>
+  
+<%% for <%= singular_name %> in @<%= plural_name %> %>
+  <tr>
+  <%% for column in <%= model_name %>.content_columns %>
+    <td><%%=h <%= singular_name %>.send(column.name) %></td>
+  <%% end %>
+    <td><%%= link_to 'Show', :action => '<%= suffix || 'index' %>', :id => <%= singular_name %> %></td>
+    <td><%%= link_to 'Edit', :action => 'edit<%= suffix %>', :id => <%= singular_name %> %></td>
+    <td><%%= link_to 'Destroy', { :action => 'destroy<%= suffix %>', :id => <%= singular_name %> }, :post => true, :confirm => 'Are you sure you want to destroy this <%= singular_name %>?' %>
+  </tr>
+<%% end %>
+</table>
+
+<%%= link_to 'Previous page', { :page => @<%= singular_name %>_pages.current.previous } if @<%= singular_name %>_pages.current.previous %>
+<%%= link_to 'Next page', { :page => @<%= singular_name %>_pages.current.next } if @<%= singular_name %>_pages.current.next %> 
+
+<br />
+
+<%%= link_to 'New <%= singular_name %>', :action => 'new<%= suffix %>' %>

data/templates/view_edit.rhtml

@@ -0,0 +1,10 @@
+<h1>Editing <%= singular_name %></h1>
+
+<%%= start_form_tag :action => 'edit<%= @suffix %>', :id => @<%= singular_name %> %>
+  <%%= render :partial => 'form' %>
+  <%%= submit_tag 'Save' %>
+<%%= end_form_tag %>
+<%%= button_to 'Destroy', { :action => 'destroy<%= suffix %>', :id => @<%= singular_name %> }, :confirm => 'Are you sure you want to destroy this <%= singular_name %>?' %>
+
+<%%= link_to 'Show', :action => '<%= suffix || 'index' %>', :id => @<%= singular_name %> %> |
+<%%= link_to 'Back to list', :action => '<%= suffix || 'index' %>' %>

data/templates/view_new.rhtml

@@ -0,0 +1,8 @@
+<h1>New <%= singular_name %></h1>
+
+<%%= start_form_tag :action => 'new<%= @suffix %>' %>
+  <%%= render :partial => 'form' %>
+  <%%= submit_tag 'Save' %>
+<%%= end_form_tag %>
+
+<%%= link_to 'Back to list', :action => '<%= suffix || 'index' %>' %>

data/trestle_generator.rb

@@ -0,0 +1,188 @@
+class TrestleSandbox
+  include ActionView::Helpers::ActiveRecordHelper
+  
+  attr_accessor :form_action, :singular_name, :suffix, :model_instance
+  
+  def sandbox_binding
+    binding
+  end
+  
+  def default_input_block
+    Proc.new { |record, column| "<p><label for=\"#{record}_#{column.name}\">#{column.human_name}</label><br/>\n#{input(record, column.name)}</p>\n" }
+  end
+end
+
+class ActionView::Helpers::InstanceTag
+  def to_input_field_tag(field_type, options={})
+    field_meth = "#{field_type}_field"
+    "<%= #{field_meth} '#{@object_name}', '#{@method_name}' #{options.empty? ? '' : ', '+options.inspect} %>"
+  end
+  
+  def to_text_area_tag(options = {})
+    "<%= text_area '#{@object_name}', '#{@method_name}' #{options.empty? ? '' : ', '+ options.inspect} %>"
+  end
+  
+  def to_date_select_tag(options = {})
+    "<%= date_select '#{@object_name}', '#{@method_name}' #{options.empty? ? '' : ', '+ options.inspect} %>"
+  end
+  
+  def to_datetime_select_tag(options = {})
+    "<%= datetime_select '#{@object_name}', '#{@method_name}' #{options.empty? ? '' : ', '+ options.inspect} %>"
+  end
+end
+
+class TrestleGenerator < Rails::Generator::NamedBase
+  attr_reader  :controller_name,
+               :controller_class_path,
+               :controller_file_path,
+               :controller_class_nesting,
+               :controller_class_nesting_depth,
+               :controller_class_name,
+               :controller_singular_name,
+               :controller_plural_name
+  alias_method :controller_file_name,  :controller_singular_name
+  alias_method :controller_table_name, :controller_plural_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    
+    # Take controller name from the next argument. Default to the pluralized model name.
+    @controller_name = args.shift
+    @controller_name ||= ActiveRecord::Base.pluralize_table_names ? @name.pluralize : @name
+    
+    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
+    @controller_class_name_without_nesting, @controller_singular_name, @controller_plural_name = inflect_names(base_name)
+    
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+    else
+      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+    end
+  end
+  
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions controller_class_path, "#{controller_class_name}Controller", "#{controller_class_name}ControllerTest", "#{controller_class_name}Helper"
+      
+      # Controller, helper, views, test, and config directories.
+      m.directory File.join('app/controllers', controller_class_path)
+      m.directory File.join('app/helpers', controller_class_path)
+      m.directory File.join('app/views', controller_class_path, controller_file_name)
+      m.directory File.join('test/functional', controller_class_path)
+      m.directory File.join('config', controller_class_path)
+      
+      # Depend on model generator but skip if the model exists.
+      m.dependency 'model', [singular_name], :collision => :skip
+      
+      # Scaffolded forms.
+      m.complex_template "form.rhtml",
+        File.join('app/views',
+                  controller_class_path,
+                  controller_file_name,
+                  "_form.rhtml"),
+        :insert => 'form_trestle.rhtml',
+        :sandbox => lambda { create_sandbox },
+        :begin_mark => 'form',
+        :end_mark => 'eoform',
+        :mark_id => singular_name
+      
+      # Scaffolded views.
+      trestle_views.each do |action|
+        m.template "view_#{action}.rhtml",
+                   File.join('app/views',
+                             controller_class_path,
+                             controller_file_name,
+                             "#{action}.rhtml"),
+                   :assigns => { :action => action }
+      end
+      
+      # Controller class, functional test, helper, and views.
+      m.template 'controller.rb',
+                  File.join('app/controllers',
+                            controller_class_path,
+                            "#{controller_file_name}_controller.rb")
+      
+      m.template 'functional_test.rb',
+                  File.join('test/functional',
+                            controller_class_path,
+                            "#{controller_file_name}_controller_test.rb")
+      
+      m.template 'helper.rb',
+                  File.join('app/helpers',
+                            controller_class_path,
+                            "#{controller_file_name}_helper.rb")
+      
+      # Layout and stylesheet.
+      m.template 'layout.rhtml',  "app/views/layouts/#{controller_file_name}.rhtml"
+      m.template 'style.css',     'public/stylesheets/trestle.css'
+      
+      
+      # Untrestled views.
+      untrestled_actions.each do |action|
+        path = File.join('app/views',
+                          controller_class_path,
+                          controller_file_name,
+                          "#{action}.rhtml")
+        m.template "controller:view.rhtml", path,
+                   :assigns => { :action => action, :path => path}
+      end
+      
+      # Routes.
+      m.template 'routes.rb', 'config/routes.rb'
+    end
+  end
+  
+  
+  protected
+  
+  # Override with your own usage banner.
+  def banner
+    "Usage: #{$0} trestle ModelName [ControllerName] [action, ...]"
+  end
+  
+  def trestle_views
+    %w(edit _index_without_id _index_with_id new)
+  end
+  
+  def trestle_actions
+    %w(destroy edit index new)
+  end
+  
+  def model_name 
+    class_name.demodulize
+  end
+  
+  def untrestled_actions
+    args - trestle_actions
+  end
+  
+  def suffix
+    "_#{singular_name}" if options[:suffix]
+  end
+  
+  def create_sandbox
+    sandbox = TrestleSandbox.new
+    sandbox.singular_name = singular_name
+    begin
+      sandbox.model_instance = model_instance
+      sandbox.instance_variable_set("@#{singular_name}", sandbox.model_instance)
+    rescue ActiveRecord::StatementInvalid => e
+      logger.error "Before updating trestle from new DB schema, try creating a table for your model (#{class_name})"
+      raise SystemExit
+    end
+    sandbox.suffix = suffix
+    sandbox
+  end
+  
+  def model_instance
+    base = class_nesting.split('::').inject(Object) do |base, nested|
+      break base.const_get(nested) if base.const_defined?(nested)
+      base.const_set(nested, Module.new)
+    end
+    unless base.const_defined?(@class_name_without_nesting)
+      base.const_set(@class_name_without_nesting, Class.new(ActiveRecord::Base))
+    end
+    class_name.constantize.new
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+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."
+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."
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+authors: 
+  - Nils Jonsson
+files: 
+  - trestle_generator.rb
+  - USAGE
+  - templates/controller.rb
+  - templates/form.rhtml
+  - templates/form_trestle.rhtml
+  - templates/functional_test.rb
+  - templates/helper.rb
+  - templates/layout.rhtml
+  - templates/routes.rb
+  - templates/style.css
+  - templates/view_edit.rhtml
+  - templates/view_new.rhtml
+  - templates/view__index_without_id.rhtml
+  - templates/view__index_with_id.rhtml
+test_files: []
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: 
+  - Ruby on Rails v1.0.0
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rails
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">="
+          - !ruby/object:Gem::Version 
+            version: 1.0.0
+      version: