administrated_scaffold 0.0.1

data/USAGE

@@ -0,0 +1,12 @@
+Description:
+  This functions much like the normal scaffolding, and is based off of its
+  code, but it provides instead a scaffold of a list and show that is
+  visible from the root directory, and a secondary scaffold inside an
+  administrative directory with full action control.
+  
+Example
+  ./script/generate administrated_scaffold Account admin
+  
+  Creates a scaffold for model Account with an administrated director admin.
+  
+  

data/administrated_scaffold_generator.rb

@@ -0,0 +1,214 @@
+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 AdministratedScaffoldGenerator < Rails::Generator::NamedBase
+  attr_reader   :admin_directory,
+                :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.
+    @admin_directory = args.shift
+    @admin_directory ||= "admin"
+    
+    admin_base_name, @admin_class_path, @admin_file_path, @admin_class_nesting, @admin_class_nesting_depth = extract_modules(@admin_directory)
+    @admin_class_name_without_nesting, @admin_singular_name, @admin_plural_name = inflect_names(admin_base_name)
+    
+    @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"
+      m.class_collisions controller_class_path, "Admin::#{controller_class_name}Controller", "Admin::#{controller_class_name}ControllerTest", "Admin::#{controller_class_name}Helper"      
+
+      # Controller, helper, views, and test directories.
+      m.directory File.join('app/controllers', controller_class_path)
+      m.directory File.join('app/controllers', @admin_directory, controller_class_path)
+      m.directory File.join('app/helpers', 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('app/views', @admin_directory, controller_class_path, controller_file_name)      
+      m.directory File.join('test/functional', controller_class_path)
+      m.directory File.join('test/functional', @admin_directory, controller_class_path)      
+
+      # Depend on model generator but skip if the model exists.
+      m.dependency 'model', [singular_name], :collision => :skip, :skip_migration => true
+
+      # Scaffolded forms.
+      m.complex_template "form.rhtml",
+        File.join('app/views',
+                  @admin_directory,
+                  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 views.
+      scaffold_views.each do |action|
+        m.template "view_#{action}.rhtml",
+                   File.join('app/views',
+                             @admin_file_path,
+                             controller_class_path,
+                             controller_file_name,
+                             "#{action}.rhtml"),
+                   :assigns => { :action => action }
+      end
+
+      public_views.each do |action|
+        m.template "view_#{action}_public.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_admin.rb',
+                  File.join('app/controllers',
+                            @admin_file_path,
+                            controller_class_path,
+                            "#{controller_file_name}_controller.rb")
+
+      m.template 'controller.rb',
+                  File.join('app/controllers',
+                            controller_class_path,
+                            "#{controller_file_name}_controller.rb")                            
+
+      m.template 'helper_admin.rb',
+                  File.join('app/helpers',
+                            @admin_file_path,
+                            controller_class_path,
+                            "#{controller_file_name}_helper.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/scaffold.css'
+
+
+      # Unscaffolded views.
+      unscaffolded_actions.each do |action|
+        path = File.join('app/views',
+                          @admin_file_path,
+                          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 [AdminDirectory] [action, ...]"
+    end
+    
+    def admin_directory
+      @admin_file_path
+    end
+    
+    def admin_scope
+      @admin_singular_name
+    end
+    
+    def admin_class
+      @admin_class_name_without_nesting
+    end
+    
+    def scaffold_views
+      %w(list show new edit)
+    end
+
+    def public_views
+      %w(list show)
+    end
+    
+    def scaffold_actions
+      scaffold_views + %w(index create update destroy)
+    end
+    
+    def public_actions
+      scaffold_views + %w(index)
+    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,16 @@
+class <%= controller_class_name %>Controller < ApplicationController
+<% unless suffix -%>
+  def index
+    list
+    render :action => 'list'
+  end
+<% end -%>
+
+  def list<%= suffix %>
+    @<%= singular_name %>_pages, @<%= plural_name %> = paginate :<%= plural_name %>, :per_page => 10
+  end
+
+  def show<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.find(params[:id])
+  end
+end

data/templates/controller_admin.rb

@@ -0,0 +1,59 @@
+class <%= admin_class %>::<%= controller_class_name %>Controller < ApplicationController
+layout '<%= plural_name %>'
+<% unless suffix -%>
+  def index
+    list
+    render :action => 'list'
+  end
+<% end -%>
+
+<% for action in unscaffolded_actions -%>
+  def <%= action %><%= suffix %>
+  end
+
+<% end -%>
+  # GETs should be safe (see http://www.w3.org/2001/tag/doc/whenToUseGet.html)
+  verify :method => :post, :only => [ :destroy<%= suffix %>, :create<%= suffix %>, :update<%= suffix %> ],
+         :redirect_to => { :action => :list<%= suffix %> }
+
+  def list<%= suffix %>
+    @<%= singular_name %>_pages, @<%= plural_name %> = paginate :<%= plural_name %>, :per_page => 10
+  end
+
+  def show<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.find(params[:id])
+  end
+
+  def new<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.new
+  end
+
+  def create<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.new(params[:<%= singular_name %>])
+    if @<%= singular_name %>.save
+      flash[:notice] = '<%= model_name %> was successfully created.'
+      redirect_to :action => 'list<%= suffix %>'
+    else
+      render :action => 'new<%= suffix %>'
+    end
+  end
+
+  def edit<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.find(params[:id])
+  end
+
+  def update
+    @<%= singular_name %> = <%= model_name %>.find(params[:id])
+    if @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+      flash[:notice] = '<%= model_name %> was successfully updated.'
+      redirect_to :action => 'show<%= suffix %>', :id => @<%= singular_name %>
+    else
+      render :action => 'edit<%= suffix %>'
+    end
+  end
+
+  def destroy<%= suffix %>
+    <%= model_name %>.find(params[:id]).destroy
+    redirect_to :action => 'list<%= suffix %>'
+  end
+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/helper_admin.rb

@@ -0,0 +1,2 @@
+module <%= admin_class %>::<%= 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 'scaffold' %>
+</head>
+<body>
+
+<p style="color: green"><%%= flash[:notice] %></p>
+
+<%%= @content_for_layout %>
+
+</body>
+</html>

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

@@ -0,0 +1,9 @@
+<h1>Editing <%= singular_name %></h1>
+
+<%%= start_form_tag :action => 'update<%= @suffix %>', :id => @<%= singular_name %> %>
+  <%%= render :partial => 'form' %>
+  <%%= submit_tag 'Edit' %>
+<%%= end_form_tag %>
+
+<%%= link_to 'Show', :action => 'show<%= suffix %>', :id => @<%= singular_name %> %> |
+<%%= link_to 'Back', :action => 'list<%= suffix %>' %>

data/templates/view_list.rhtml

@@ -0,0 +1,27 @@
+<h1><%= controller_class_name %> Administration</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 => 'show<%= suffix %>', :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 %> }, :confirm => 'Are you sure?', :post => true %></td>
+  </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_list_public.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 => 'show<%= suffix %>', :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 %> }, :confirm => 'Are you sure?', :post => true %></td>
+  </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 'Administrate <%= plural_name %>', :controller => '/<%= admin_scope %>/<%= controller_singular_name %>', :action => 'index<%= suffix %>' %>

data/templates/view_new.rhtml

@@ -0,0 +1,8 @@
+<h1>New <%= singular_name %></h1>
+
+<%%= start_form_tag :action => 'create<%= @suffix %>' %>
+  <%%= render :partial => 'form' %>
+  <%%= submit_tag "Create" %>
+<%%= end_form_tag %>
+
+<%%= link_to 'Back', :action => 'list<%= suffix %>' %>

data/templates/view_show.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', :action => 'list<%= suffix %>' %>

data/templates/view_show_public.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', :action => 'list<%= suffix %>' %>

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: administrated_scaffold
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2006-07-13 00:00:00 -04:00
+summary: A scaffold generator that creates a public and administrative controller and views.
+require_paths: 
+- lib
+email: mbleigh@mbleigh.com
+homepage: http://www.mbleigh.com/software/administrative-scaffold/
+rubyforge_project: 
+description: 
+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 Bleigh
+files: 
+- templates/controller.rb
+- templates/controller_admin.rb
+- templates/form.rhtml
+- templates/form_scaffolding.rhtml
+- templates/functional_test.rb
+- templates/helper.rb
+- templates/helper_admin.rb
+- templates/layout.rhtml
+- templates/style.css
+- templates/view_edit.rhtml
+- templates/view_list.rhtml
+- templates/view_list_public.rhtml
+- templates/view_new.rhtml
+- templates/view_show.rhtml
+- templates/view_show_public.rhtml
+- administrated_scaffold_generator.rb
+- USAGE
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+