ajax_scaffold_generator 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Maurycy Pawlowski-Wieronski
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/USAGE

@@ -0,0 +1,31 @@
+Description:
+    The ajax scaffold generator creates a controller to interact with a model.
+    If the model does not exist, it creates the model as well. Unlike the
+    standard scaffold, the ajax scaffold generator uses AJAX.
+
+    The generator takes a model name, an optional controller name, and a
+    list of views as arguments.  Scaffolded actions and views are created
+    automatically.  Any views left over generate empty stubs.
+
+    The scaffolded actions are:
+        index, list, new, edit, destroy
+
+    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 ajax_scaffold 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 ajax_scaffold CreditCard 'admin/credit_card' suspend late_fee
+
+    This will generate a CreditCard model and CreditCardController controller
+    in the admin module.
+

data/ajax_scaffold_generator.rb

@@ -0,0 +1,201 @@
+class ScaffoldingSandbox
+  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 AjaxScaffoldGenerator < 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
+
+    @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, and test 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)
+
+      # 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_scaffolding.rhtml',
+        :sandbox => lambda { create_sandbox },
+        :begin_mark => 'form',
+        :end_mark => 'eoform',
+        :mark_id => singular_name
+
+      # Scaffolded partials.
+      scaffold_partials.each do |action|
+        m.template "partial_#{action}.rhtml",
+                    File.join('app/views',
+                              controller_class_path,
+                              controller_file_name,
+                              "_#{action}.rhtml"),
+                    :assigns => { :action => action }
+      end
+
+      # Scaffolded views.
+      scaffold_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 'script.js',       "public/javascripts/#{controller_file_name}.js"
+      m.template 'style.css',       'public/stylesheets/scaffold.css'
+
+      # Unscaffolded views.
+      unscaffolded_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
+    end
+  end
+
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} ajax_scaffold ModelName [ControllerName] [action, ...]"
+    end
+
+    def model_name
+      class_name.demodulize
+    end
+
+    def scaffold_actions
+      %w( edit destroy index list new )
+    end
+
+    def scaffold_partials
+      %w( edit error item new )
+    end
+
+    def scaffold_views
+      %w( list )
+    end
+
+    def unscaffolded_actions
+      args - scaffold_actions
+    end
+
+    def suffix
+      "_#{singular_name}" if options[:suffix]
+    end
+
+    def create_sandbox
+      sandbox = ScaffoldingSandbox.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 scaffolding 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

data/templates/controller.rb

@@ -0,0 +1,49 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  verify :method => :post, :only => %w( destroy edit new )
+
+<% unless suffix -%>
+  def index
+    list
+    render :action => 'list'
+  end
+<% end -%>
+
+<% for action in unscaffolded_actions -%>
+  def <%= action %><%= suffix %>
+  end
+  
+<% end -%>
+  def list<%= suffix %>
+    @<%= plural_name %> = <%= model_name %>.find :all
+  end
+
+  def new<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.new params[:<%= singular_name %>]
+
+    if @<%= singular_name %>.save
+      @headers['<%= model_name %>ID'] = @<%= singular_name %>.id
+      @headers['Content-Type'] = 'text/html; charset=utf-8'
+      
+      render :partial => 'item'
+    else
+      render :partial => 'error', :status => 500
+    end
+  end
+
+  def edit<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.find params[:id]
+
+    if @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+      @headers['Content-Type'] = 'text/html; charset=utf-8'
+
+      render :partial => 'item'
+    else
+      render :partial => 'error', :status => 500
+    end
+  end
+
+  def destroy<%= suffix %>
+    <%= model_name %>.find(params[:id]).destroy
+    render :nothing => true
+  end
+end

data/templates/form.rhtml

@@ -0,0 +1 @@
+<%= template_for_inclusion %>

data/templates/form_scaffolding.rhtml

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

data/templates/functional_test.rb

@@ -0,0 +1,71 @@
+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 unscaffolded_actions -%>
+  def test_<%= action %>
+    get :<%= action %>
+    assert_response :success
+    assert_template '<%= action %>'
+  end
+
+<% end -%>
+<% unless suffix -%>
+  def test_index
+    get :index
+    assert_response :success
+    assert_template 'list'
+  end
+
+<% end -%>
+  def test_list<%= suffix %>
+    get :list<%= suffix %>
+
+    assert_response :success
+    assert_template 'list<%= suffix %>'
+
+    assert_not_nil assigns(:<%= plural_name %>)
+  end
+
+  def test_new<%= suffix %>
+    num_<%= plural_name %> = <%= model_name %>.count
+    
+    post :new<%= suffix %>, :<%= singular_name %> => {}
+
+    assert_response :success
+    assert_template '_item'
+
+    assert_equal num_<%= plural_name %> + 1, <%= model_name %>.count
+  end
+
+  def test_edit<%= suffix %>
+    post :edit<%= suffix %>, :id => 1
+
+    assert_response :success
+    assert_template '_item'
+  end
+
+  def test_destroy<%= suffix %>
+    assert_not_nil <%= model_name %>.find(1)
+
+    post :destroy<%= suffix %>, :id => 1
+
+    assert_response :success
+    assert_template nil
+    
+    assert_raise(ActiveRecord::RecordNotFound) {
+      <%= model_name %>.find(1)
+    }
+  end
+end

data/templates/helper.rb

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

data/templates/layout.rhtml

@@ -0,0 +1,14 @@
+<html>
+<head>
+  <title><%= controller_class_name %>: <%%= controller.action_name %></title>
+  <%%= stylesheet_link_tag 'scaffold' %>
+  <%%= javascript_include_tag 'prototype' %>
+  <%%= javascript_include_tag 'effects' %>
+  <%%= javascript_include_tag '<%= singular_name %>' %>
+</head>
+<body>
+
+<%%= @content_for_layout %>
+
+</body>
+</html>

data/templates/partial_edit.rhtml

@@ -0,0 +1,13 @@
+<div id="<%%= "edit_<%= singular_name %>_error_#{@<%= singular_name %>.id}" %>">
+<%%= render :partial => 'error' %>
+</div>
+
+<%%= form_remote_tag :url => { :action => 'edit', :id => @<%= singular_name %> },
+      :update => { :success => "<%= singular_name %>_#{@<%= singular_name %>.id}", :failure => "edit_<%= singular_name %>_error_#{@<%= singular_name %>.id}" },
+      :success => "<%= plural_name %>Block.editSuccess(#{@<%= singular_name %>.id})",
+      :html => { :id => "edit_<%= singular_name %>_form_#{@<%= singular_name %>.id}" } %> 
+  <%%= render :partial => 'form' %>
+  <%%= submit_tag "Update" %>
+<%%= end_form_tag %>
+
+<%%= link_to_function 'Cancel', "<%= plural_name %>Block.editCancel(#{@<%= singular_name %>.id})" %>

data/templates/partial_error.rhtml

@@ -0,0 +1,3 @@
+<%% unless @<%= singular_name %>.nil? %>
+<%%= error_messages_for '<%= singular_name %>' %>
+<%% end -%>

data/templates/partial_item.rhtml

@@ -0,0 +1,16 @@
+<div id="<%= singular_name %>_<%%= @<%= singular_name %>.id %>">
+
+<%% for column in <%= model_name %>.content_columns %>
+<p><b><%%= column.human_name %>:</b> <%%=h @<%= singular_name %>.send(column.name) %></p>
+<%% end %>
+
+<%%= link_to_function 'Edit', "<%= plural_name %>Block.edit(#{@<%= singular_name %>.id})" %>
+<%%= link_to_remote 'Destroy',
+      :url => { :action => 'destroy', :id => @<%= singular_name %> },
+      :complete => visual_effect(:fade, "<%= singular_name %>_#{@<%= singular_name %>.id}"),
+      :confirm => "Are you sure you want to delete this item?" %>
+</div>
+
+<div id="edit_<%= singular_name %>_dialog_<%%= @<%= singular_name %>.id %>" style="display: none">
+<%%= render :partial => 'edit' %>
+</div>

data/templates/partial_new.rhtml

@@ -0,0 +1,13 @@
+<div id="add_<%= singular_name %>_error">
+<%%= render :partial => 'error' %>
+</div>
+
+<%%= form_remote_tag :url => { :action => 'new' },
+      :success => '<%= plural_name %>Block.addSuccess(request)',
+      :failure => '<%= plural_name %>Block.addFailure(request)',
+      :html => { :id => 'add_<%= singular_name %>_form' } %>
+  <%%= render :partial => 'form' %>
+  <%%= submit_tag "Create" %>
+<%%= end_form_tag %>
+
+<%%= link_to_function 'Cancel', '<%= plural_name %>Block.addCancel()' %>

data/templates/script.js

@@ -0,0 +1,47 @@
+var <%= plural_name %>Block = {
+  edit: function(id) {
+    Element.hide('<%= singular_name %>_' + id);
+    Element.show('edit_<%= singular_name %>_dialog_' + id);
+  },
+
+  editSuccess: function(id) {
+    this.editCancel(id);
+    
+    new Effect.Highlight('<%= singular_name %>_' + id);
+  },
+
+  editCancel: function(id) {
+    $('edit_<%= singular_name %>_error_' + id).innerHTML = '';
+    
+    Element.show('<%= singular_name %>_' + id);
+    Element.hide('edit_<%= singular_name %>_dialog_' + id);
+  },
+
+  add: function() {
+    Element.hide('add_<%= singular_name %>');
+    Element.show('add_<%= singular_name %>_dialog');
+    Form.reset('add_<%= singular_name %>_form');
+  },
+
+  addSuccess: function(request) {  
+    this.addCancel();
+    
+    new Insertion.Bottom('<%= plural_name %>', request.responseText);
+    new Effect.Highlight('<%= singular_name %>_' + this.getNewId(request));
+  },
+
+  addFailure: function(request) {
+    $('add_<%= singular_name %>_error').innerHTML = request.responseText;
+  },
+
+  addCancel: function() {
+    $('add_<%= singular_name %>_error').innerHTML = '';
+    
+    Element.show('add_<%= singular_name %>');
+    Element.hide('add_<%= singular_name %>_dialog');
+  },
+
+  getNewId: function(request) {
+    return request.getResponseHeader('<%= model_name %>ID');
+  }
+}

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_list.rhtml

@@ -0,0 +1,15 @@
+<h1>Listing <%= plural_name %></h1>
+
+<div id="add_<%= singular_name %>">
+<%%= link_to_function 'New <%= singular_name %>', "<%= plural_name %>Block.add()" %>
+</div>
+
+<div id="add_<%= singular_name %>_dialog" style="display: none">
+<%%= render :partial => 'new' %>
+</div>
+
+<div id="<%= plural_name %>">
+<%% for @<%= singular_name %> in @<%= plural_name %>%>
+<%%= render :partial => 'item' %>
+<%% end -%>
+</div>

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: ajax_scaffold_generator
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2005-11-30 00:00:00 +01:00
+summary: "[Rails] Ajax scaffold."
+require_paths: 
+  - "."
+email: maurycypw@gmail.com
+homepage: http://www.rubyonrails.org/show/Generators
+rubyforge_project: 
+description: "This is the generator for a Ruby on Rails framework, that creates scaffold for
+  AJAX applications."
+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
+signing_key: 
+cert_chain: 
+authors: 
+  - Maurycy Pawlowski-Wieronski
+files: 
+  - MIT-LICENSE
+  - USAGE
+  - ajax_scaffold_generator.rb
+  - templates/controller.rb
+  - templates/form.rhtml
+  - templates/form_scaffolding.rhtml
+  - templates/functional_test.rb
+  - templates/helper.rb
+  - templates/layout.rhtml
+  - templates/partial_edit.rhtml
+  - templates/partial_error.rhtml
+  - templates/partial_item.rhtml
+  - templates/partial_new.rhtml
+  - templates/script.js
+  - templates/style.css
+  - templates/view_list.rhtml
+test_files: []
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rails
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.10.0
+      version: