ajax_grid_generator 0.5.0

data/USAGE

@@ -0,0 +1,30 @@
+Description:
+    The Ajax_grid generator generates a fully functional, ajax based CRUD
+    grid for a given table.   It is based heavily on the scaffold generator.
+    The generated code, with only some css help, is usable as is for CRUD 
+    operations on a single table.
+    
+    Like it's scaffolding forbearer, ajax_grid 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 and views are:
+        index, list, show, new, create, edit, update, destroy
+
+    All of these, except index are implemented as partials to be rendered
+    in updateable divs on the client.
+
+    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_grid product
+
+    This will generate a Product model and ProductController with a full test
+    suite and an ajax user interface. 
+
+

data/ajax_grid_generator.rb

@@ -0,0 +1,202 @@
+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| 
+			size=column.limit ? column.limit : 10 
+			size=10 if size<10 
+			"<div class=\"#{column.name}\">#{input(record, column.name, :size => size)}</div>" 
+		}
+  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 AjaxGridGenerator < 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, 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
+
+			# Stylsheet
+      m.template 'style.css', 'public/stylesheets/ajax_grid.css'
+      m.template 'controller_specific.css', "public/stylesheets/#{@plural_name}.css"
+
+      # 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
+			# Scaffolded partials.
+			scaffold_partials.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
+      m.template 'layout.rhtml',  "app/views/layouts/#{controller_file_name}.rhtml"
+
+
+      # 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} scaffold ModelName [ControllerName] [action, ...]"
+    end
+
+    def scaffold_views
+      %w(index)
+    end
+		def scaffold_partials
+      %w(list item new edit)
+		end
+
+    def scaffold_actions
+      scaffold_views + scaffold_partials + %w(create update destroy)
+    end
+    
+    def model_name 
+      class_name.demodulize
+    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,54 @@
+class <%= controller_class_name %>Controller < ApplicationController
+	paginate :<%= plural_name %>, :per_page => 10
+<% unless suffix -%>
+  def index
+  end
+<% end -%>
+
+<% for action in unscaffolded_actions -%>
+  def <%= action %><%= suffix %>
+  end
+
+<% end -%>
+  def list<%= suffix %>
+		render :partial => 'list'
+  end
+
+  def show<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.find(params[:id])
+		render :partial =>'item'
+  end
+
+  def new<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.new
+		render :partial => 'new'
+  end
+
+  def create<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.new(params[:<%= singular_name %>])
+    if @<%= singular_name %>.save
+			list
+    else
+      render :partial => 'new'
+    end
+  end
+
+  def edit<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.find(params[:id])
+		render :partial => 'edit'
+  end
+
+  def update
+    @<%= singular_name %> = <%= model_name %>.find(params[:id])
+    if @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+      render :partial => 'item'
+    else
+      render :partial => 'edit'
+    end
+  end
+
+  def destroy<%= suffix %>
+    <%= model_name %>.find(params[:id]).destroy
+		render :nothing => true
+  end
+end

data/templates/controller_specific.css

@@ -0,0 +1,12 @@
+#<%= controller_name %> { border: solid 1px #000; height: 27em; margin: 2ex; padding: 2ex; position: relative;}
+
+.<%= singular_name %> { clear: both; position:relative;}
+.<%= singular_name %> a {display: block}
+.<%= singular_name %> div, #headers div, .<%= singular_name %> a { float:left; padding: 1ex; }
+
+<% model_instance.class.content_columns.each do |column|
+	size=column.limit ? column.limit : 10 
+	size=10 if size<10 
+	size *=1.5 %>
+.<%= column.name %> {width: <%= size %>ex;}
+<% end %>

data/templates/form.rhtml

@@ -0,0 +1,3 @@
+<%%= error_messages_for '<%= singular_name %>' %>
+
+<%= 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,98 @@
+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_show<%= suffix %>
+    get :show<%= suffix %>, :id => 1
+
+    assert_response :success
+    assert_template 'show'
+
+    assert_not_nil assigns(:<%= singular_name %>)
+    assert assigns(:<%= singular_name %>).valid?
+  end
+
+  def test_new<%= suffix %>
+    get :new<%= suffix %>
+
+    assert_response :success
+    assert_template 'new<%= suffix %>'
+
+    assert_not_nil assigns(:<%= singular_name %>)
+  end
+
+  def test_create
+    num_<%= plural_name %> = <%= model_name %>.count
+
+    post :create<%= suffix %>, :<%= singular_name %> => {}
+
+    assert_response :redirect
+    assert_redirected_to :action => 'list<%= suffix %>'
+
+    assert_equal num_<%= plural_name %> + 1, <%= model_name %>.count
+  end
+
+  def test_edit<%= suffix %>
+    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_update<%= suffix %>
+    post :update<%= suffix %>, :id => 1
+    assert_response :redirect
+    assert_redirected_to :action => 'show<%= suffix %>', :id => 1
+  end
+
+  def test_destroy<%= suffix %>
+    assert_not_nil <%= model_name %>.find(1)
+
+    post :destroy, :id => 1
+    assert_response :redirect
+    assert_redirected_to :action => 'list<%= suffix %>'
+
+    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,26 @@
+<html>
+<head>
+	<title><%= model_name %> Management</title>
+	<%%= javascript_include_tag "prototype" %>
+	<%%= javascript_include_tag "effects" %>
+  <%%= stylesheet_link_tag 'ajax_grid' %>
+	<%%= stylesheet_link_tag '<%= plural_name %>' %>
+</head>
+<body>
+
+	<%%= link_to_remote "New <%= singular_name %>", 
+	{:update => '<%=controller_name%>',
+	:url => {:action => 'new'},
+	:complete => "new Effect.Appear('<%= controller_name %>')"}  %>
+<div id="headers">
+	<%% for column in <%=model_name %>.content_columns %>
+	<div class="<%%= column.name -%>"><%%= column.human_name -%></div>
+  <%% end %>
+</div>
+
+<div id="<%= controller_name %>">
+	<%%= @content_for_layout %>
+</div>
+
+</body>
+</html>

data/templates/style.css

@@ -0,0 +1,81 @@
+body { 
+	background-color: #fff; color: #000; 
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   16px;
+  line-height: 18px;
+}
+
+#headers { font-weight:bold;  height: 1em; text-decoration: underline;margin: 2ex; padding: 2ex;}
+
+#navlinks {text-align:center; position:absolute; bottom:0;padding: 2ex;width:100%;}
+
+body, p, ol, ul, td {
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+.fieldWithErrors {
+  background-color: red;
+}
+
+#ErrorExplanation {
+	position:absolute;
+	top: 3em;
+	z-index:100;
+  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_edit.rhtml

@@ -0,0 +1,14 @@
+
+<%%= form_remote_tag :update => @<%= singular_name %>.id, 
+	:url => {:action => 'update', :id => @<%= singular_name %>},
+	:loading => "new Effect.Fade(#{@<%= singular_name %>.id})",
+	:complete => "new Effect.Appear(#{@<%= singular_name %>.id})" %>
+
+  <%%= render :partial => 'form' %>
+	<div class="ctlSave"><%%= submit_tag 'save'%></div>
+	<%%= link_to_remote 'Cancel',
+		:update=>@<%= singular_name %>.id,
+		:url => {:action => 'show', :id => @<%= singular_name %>},
+		:loading => "new Effect.Fade(#{@<%= singular_name %>.id})",
+		:complete => "new Effect.Appear(#{@<%= singular_name %>.id})" %>
+<%%= end_form_tag %>

data/templates/view_index.rhtml

@@ -0,0 +1 @@
+<%%= render :partial => 'list' %>

data/templates/view_item.rhtml

@@ -0,0 +1,15 @@
+	<%% for column in <%= model_name -%>.content_columns %>
+	<div class="<%%= column.name -%>"><%%=h @<%= singular_name -%>.send(column.name) -%></div>
+	<%% end %>
+	<%%= link_to_remote 'Edit',
+		{:update => @<%= singular_name %>.id, 
+			:url => {:action => 'edit', :id => @<%= singular_name -%> },
+			:loading => "new Effect.Fade(#{@<%= singular_name -%>.id})",
+			:complete => "new Effect.Appear(#{@<%= singular_name -%>.id})"},
+		:class => 'edit_link' %>
+	<%%= link_to_remote 'Destroy', 
+	{:update => @<%= singular_name %>.id,
+		:url => {:action => 'destroy', :id => @<%= singular_name -%> }, 
+		:confirm => 'Are you sure?',
+		:complete => "new Effect.Puff(#{@<%= singular_name %>.id})"}, 
+	:class => 'destroy_link' %>

data/templates/view_list.rhtml

@@ -0,0 +1,19 @@
+<%% for @<%= singular_name %> in @<%= controller_name %> %>
+<div class="<%= singular_name %>" id="<%%= @<%= singular_name -%>.id -%>">
+	<%%= render :partial => 'item' %>
+</div>
+<%% end %>
+
+<div id='navLinks'>
+	<%%= link_to_remote 'Previous page',
+		{ :update=>'<%= controller_name %>', 
+			:url=>{:action => 'list', :page => @<%= singular_name %>_pages.current.previous },
+			:complete => "new Effect.Appear ('<%= controller_name %>')"}, 
+		:class => 'navLink' if @<%= singular_name %>_pages.current.previous %>
+	<%%= link_to_remote 'Next page', 
+		{ :update=>'<%= controller_name %>',
+			:url=>{:action => 'list', :page => @<%= singular_name %>_pages.current.next },
+			:complete => "new Effect.Appear ('<%= controller_name %>')"}, 
+		:class => 'navLink' if @<%= singular_name %>_pages.current.next %> 
+</div>
+

data/templates/view_new.rhtml

@@ -0,0 +1,7 @@
+<div class="<%= singular_name -%> edit" id="<%%= @<%= singular_name %>.id %>">
+	<%%= form_remote_tag :update => '<%= controller_name %>', :url => {:action => 'create'} %>
+  <%%= render :partial => 'form' %>
+	<div class="ctlSave"><%%= submit_tag "Create" %></div>
+	<%%= link_to_remote 'Cancel', :update=>'<%= controller_name %>', :url => {:action => 'list'} %>
+<%%= end_form_tag %>
+</div>

metadata

@@ -0,0 +1,67 @@
+!ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: ajax_grid_generator
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+date: 2006-01-15 00:00:00 +00:00
+summary: "[Rails] Ajax Grid generator."
+require_paths: 
+- .
+email: evronm@dtcinc.net
+homepage: http://www.rubyonrails.org/show/Generators
+rubyforge_project: 
+description: Generates Rails code implementing an Ajax based CRUD grid for a single table.
+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: 
+- Michael Evron
+files: 
+- USAGE
+- ajax_grid_generator.rb
+- templates/controller.rb
+- templates/controller_specific.css
+- templates/form.rhtml
+- templates/form_scaffolding.rhtml
+- templates/functional_test.rb
+- templates/helper.rb
+- templates/layout.rhtml
+- templates/style.css
+- templates/view_edit.rhtml
+- templates/view_index.rhtml
+- templates/view_item.rhtml
+- templates/view_list.rhtml
+- templates/view_new.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: