jrhicks-static-generators 0.1.6

data/rails_generators/static_gen_specs/templates/model_gen_specs.rb

@@ -0,0 +1,145 @@
+require File.join(RAILS_ROOT,"static_scaffold","generator_specs.rb")
+
+class <%=class_name%>GenSpecs < GeneratorSpecs
+  attr_accessor :model_name, :class_name, :table_name, :primary_key, :singular_name, :plural_name,
+          :plural_label, :singular_label, :plural_title, :singular_title,
+          :authentication_method, :authorization_method,
+          :order_preference_columns, :order_preference,
+          :public_root_path, :private_root_path, :will_paginate
+          
+  def initialize()
+    @model_name = <%=model_name.inspect%>
+    @table_name = <%=table_name.inspect%>
+    @primary_key = "id"
+    @plural_name = <%=model_name.underscore.downcase.pluralize.inspect%>
+    @singular_name = <%=model_name.underscore.downcase.singularize.inspect%>
+    @plural_label = <%=model_name.pluralize.humanize.inspect%>
+    @singular_label = <%=model_name.humanize.inspect%>
+    @plural_title = <%=model_name.pluralize.titleize.inspect%>
+    @singular_title = <%=model_name.titleize.inspect%>
+
+    # Security 
+    @authentication_method = :AuthLogic                # :none
+    @authorization_method  = :static_authorization     # :ACL9, :none
+    
+    # Order
+    @order_preference_columns = <%=guess_ordered_columns.inspect%>
+    @order_preference = "ASC"
+    
+    # File Columns
+    @public_root_path = 'File.join(<%=RAILS_ROOT.inspect%>,"public")'
+    @private_root_path = 'File.join("filestore","private_files","<%=File.basename(RAILS_ROOT)%>")' 
+    
+    # Pagination
+    @will_paginate = true # false
+  end
+  
+  def short_name_columns
+     # Specify the columns that constitute the "name" for example ["first_name", "last_name"]
+    <%=guess_short_name.inspect%>
+  end
+  
+  def table_view_columns
+    [
+<%for c in column_names -%>
+<%if guess_list_columns.include?(c) -%>
+      <%=c.to_sym.inspect%>,
+<%else -%>
+    # <%=c.to_sym.inspect%>,
+<%end -%>
+<%end -%>
+    ]
+  end
+  
+
+  def column_specs
+    {
+<%justifier = CodeJustifier.new(columns) -%>
+<%justifier.add_parameter {|o| ":#{o.name} => "} -%>
+<%justifier.add_parameter {|o| "{:label=>#{label(o.name).inspect}, "} -%>
+<%justifier.add_parameter {|o| ":type=>#{guess_type(o.name).inspect}, "} -%>
+<%justifier.add_parameter {|o| ":access=>:private, "} -%>
+<%justifier.add_parameter {|o| ":units=>#{units(o.name).inspect}, "} -%>
+<%justifier.add_parameter {|o| ":rows=>#{estimate_rows(o.name).inspect}, "} -%>
+<%justifier.add_parameter {|o| ":cols=>#{estimate_cols(o.name).inspect}, "} -%>
+<%justifier.add_parameter {|o| ":required=>#{(not o.null).inspect}, "} -%>
+<%justifier.add_parameter {|o| ":align=>#{guess_alignment(o.name).inspect}, "} -%>
+<%justifier.add_parameter {|o| ":decimals=>#{guess_decimals(o.name).inspect}"} -%>
+<%for o in columns -%>
+      <%=justifier.render(o)%>},
+<%end -%>
+    }
+  end
+  
+  def file_columns
+      column_specs.select {|k,v| v[:type]==:file or v[:type]==:photo}
+  end
+
+  def belongs_to
+    [
+<%justifier = CodeJustifier.new(belongs_to_columns) -%>
+<%justifier.add_parameter {|o| ":name=>#{o.name.slice(0,o.name.length-3).inspect}, "} -%>
+<%justifier.add_parameter {|o| ":model=>#{o.name.slice(0,o.name.length-3).camelize.inspect}, "} -%>
+<%justifier.add_parameter {|o| ":key=>#{o.name.inspect}, "} -%>
+<%for o in belongs_to_columns -%>
+     {<%=justifier.render(o)%>},
+<%end -%>
+    ]
+  end
+
+  def ascendant
+<%justifier = CodeJustifier.new(belongs_to_columns) -%>
+<%justifier.add_parameter {|o| ":name=>#{o.name.slice(0,o.name.length-3).inspect}, "} -%>
+<%justifier.add_parameter {|o| ":model=>#{o.name.slice(0,o.name.length-3).camelize.inspect}, "} -%>
+<%justifier.add_parameter {|o| ":key=>#{o.name.inspect}, "} -%>
+<%for o in belongs_to_columns -%>
+  #  {<%=justifier.render(o)%>}
+<%end -%>
+  end
+
+  def has_many
+    [
+<%justifier = CodeJustifier.new(has_many_columns) -%>
+<%justifier.add_parameter {|o| ":name=>#{o[:table].pluralize.inspect}, "} -%>
+<%justifier.add_parameter {|o| ":model=>#{o[:table].singularize.camelize.inspect}, "} -%>
+<%justifier.add_parameter {|o| ":key=>#{o[:column].inspect}, "} -%>
+<%for o in has_many_columns -%>
+     {<%=justifier.render(o)%>},
+<%end -%>
+    ]
+  end
+  
+  def desendants
+    [
+<%justifier = CodeJustifier.new(has_many_columns) -%>
+<%justifier.add_parameter {|o| ":name=>#{o[:table].pluralize.inspect}, "} -%>
+<%justifier.add_parameter {|o| ":model=>#{o[:table].singularize.camelize.inspect}, "} -%>
+<%justifier.add_parameter {|o| ":key=>#{o[:column].inspect}, "} -%>
+<%for o in has_many_columns -%>
+   # {<%=justifier.render(o)%>},
+<%end -%>
+    ]
+  end
+  
+
+  
+  # These methods are inherited from generator_specs.rb
+  
+  # model_name - <%=model_name.inspect%>
+  # model_file_name - <%=model_name.underscore.inspect%>
+  # class_name - <%=class_name.inspect%>
+  # controller_class_name - <%="#{model_name.pluralize}Controller".inspect%>
+  # controller_file_name - <%="#{model_name.pluralize}Controller".underscore.inspect%>
+  # view_folder_name - <%=model_name.underscore.inspect%>
+
+
+<%keys=[:name, :sql_type, :precision, :type, :default, :limit, :null, :scale] -%>
+  # <%=keys.map { |k| k.to_s.ljust( max_length(columns,k)+2) }.join("")%>
+  # <%=keys.map { |k| "-"*( max_length(columns,k)) +"  "}.join("") %>
+<%for c in columns -%>
+  # <%=keys.map {|k| c.send(k.to_s).inspect.ljust( max_length(columns,k)+2)}.join("")%>
+<%end -%>
+  
+
+
+end

data/rails_generators/static_scaffold/USAGE

@@ -0,0 +1,29 @@
+Description:
+    Scaffolds an entire resource, from model and migration to controller and
+    views, along with a full test suite. The resource is ready to use as a
+    starting point for your RESTful, resource-oriented application.
+
+    Pass the name of the model (in singular form), either CamelCased or
+    under_scored, as the first argument, and an optional list of attribute
+    pairs.
+
+    Attribute pairs are column_name:sql_type arguments specifying the
+    model's attributes. Timestamps are added by default, so you don't have to
+    specify them by hand as 'created_at:datetime updated_at:datetime'.
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the resource immediately.
+
+    For example, 'scaffold post title:string body:text published:boolean'
+    gives you a model with those three attributes, a controller that handles
+    the create/show/update/destroy, forms to create and edit your posts, and
+    an index that lists them all, as well as a map.resources :posts
+    declaration in config/routes.rb.
+
+    If you want to remove all the generated files, run
+    'script/destroy scaffold ModelName'.
+
+Examples:
+    `./script/generate scaffold post`
+    `./script/generate scaffold post title:string body:text published:boolean`
+    `./script/generate scaffold purchase order_id:integer amount:decimal`

data/rails_generators/static_scaffold/static_scaffold_generator.rb

@@ -0,0 +1,150 @@
+class StaticScaffoldGenerator < Rails::Generator::NamedBase
+  default_options :skip_timestamps => false, :skip_migration => false, :force_plural => false
+  
+  attr_reader   :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_underscore_name,
+                :controller_singular_name,
+                :controller_plural_name
+  alias_method  :controller_file_name,  :controller_underscore_name
+  alias_method  :controller_table_name, :controller_plural_name
+  attr_accessor :count
+
+  # The Scaffold Generator is configured with a ruby class
+  spec_files = Dir.glob(File.join(RAILS_ROOT,"static_scaffold","*.rb"))
+  for f in spec_files
+      load f
+  end
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    if @name == @name.pluralize && !options[:force_plural]
+      logger.warning "Plural version of the model detected, using singularized version.  Override with --force-plural."
+      @name = @name.singularize
+    end
+    @count=0
+    @controller_name = @name.pluralize
+
+    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_underscore_name, @controller_plural_name = inflect_names(base_name)
+    @controller_singular_name=base_name.singularize
+    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 next_count
+      @count=@count+1
+      return @count
+  end
+
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions("#{controller_class_name}Controller", "#{controller_class_name}Helper")
+      m.class_collisions(class_name)
+
+      # Controller, helper, views, test and stylesheets directories.
+      m.directory(File.join('app/models', class_path))
+      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('app/views/layouts', controller_class_path))
+      m.directory(File.join('test/functional', controller_class_path))
+      m.directory(File.join('test/unit', class_path))
+      m.directory(File.join('test/unit/helpers', class_path))
+      m.directory(File.join('public/stylesheets', class_path))
+
+      # Model
+      m.template(
+            "model.rb",
+            File.join('app/models',"#{@controller_singular_name.downcase}.rb"))
+
+      for action in scaffold_views
+        m.template(
+          "view_#{action}.html.erb",
+          File.join('app/views', controller_class_path, controller_file_name, "#{action}.html.erb")
+        )
+      end
+
+      # Layout and stylesheet.
+      m.template('layout.html.erb', File.join('app/views/layouts', controller_class_path, "#{controller_file_name}.html.erb"))
+
+      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"))
+      m.template('helper_test.rb',     File.join('test/unit/helpers',    controller_class_path, "#{controller_file_name}_helper_test.rb"))
+
+      m.route_resources controller_file_name
+
+      #m.dependency 'model', [name] + @args, :collision => :skip
+    end
+  end
+
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} static_scaffold ModelName"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-timestamps",
+             "Don't add timestamps to the migration file for this model") { |v| options[:skip_timestamps] = v }
+      opt.on("--skip-migration",
+             "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+      opt.on("--force-plural",
+             "Forces the generation of a plural ModelName") { |v| options[:force_plural] = v }
+    end
+
+    def scaffold_views
+      %w[ index show new edit ]
+    end
+
+    def model_name
+      class_name.demodulize
+    end
+    
+    # generator specs
+    def gen_spec(mname=nil)
+        mname = model_name if not mname
+        gen_specs_mname = "#{mname}GenSpecs"
+        Object::const_get(gen_specs_mname).new()
+    end
+    
+    class CodeJustifier   
+        # This class is designed to generate readable code, but is a hypocrate
+
+        attr_accessor :objects, :parameters
+
+        def initialize(objects)
+            self.objects = objects
+            self.parameters = []
+        end
+
+        def add_parameter(&p)
+            self.parameters << p
+        end
+
+        def render(object,delimiter)
+            self.parameters.map {|p| p.call(o).ljust(max_length(p))+1}.join(delimeter)
+        end
+
+        def max_length(parameter)
+            self.objects.map {|o| parameter.call(o).to_s.length }.max
+        end
+    end
+end
+
+

data/rails_generators/static_scaffold/templates/controller.rb

@@ -0,0 +1,85 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  # GET /<%= table_name %>
+  # GET /<%= table_name %>.xml
+  def index
+    @<%= table_name %> = <%= class_name %>.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @<%= table_name %> }
+    end
+  end
+
+  # GET /<%= table_name %>/1
+  # GET /<%= table_name %>/1.xml
+  def show
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @<%= file_name %> }
+    end
+  end
+
+  # GET /<%= table_name %>/new
+  # GET /<%= table_name %>/new.xml
+  def new
+    @<%= file_name %> = <%= class_name %>.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @<%= file_name %> }
+    end
+  end
+
+  # GET /<%= table_name %>/1/edit
+  def edit
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+  end
+
+  # POST /<%= table_name %>
+  # POST /<%= table_name %>.xml
+  def create
+    @<%= file_name %> = <%= class_name %>.new(params[:<%= file_name %>])
+
+    respond_to do |format|
+      if @<%= file_name %>.save
+        flash[:notice] = '<%= class_name %> was successfully created.'
+        format.html { redirect_to(@<%= file_name %>) }
+        format.xml  { render :xml => @<%= file_name %>, :status => :created, :location => @<%= file_name %> }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @<%= file_name %>.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /<%= table_name %>/1
+  # PUT /<%= table_name %>/1.xml
+  def update
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+
+    respond_to do |format|
+      if @<%= file_name %>.update_attributes(params[:<%= file_name %>])
+        flash[:notice] = '<%= class_name %> was successfully updated.'
+        format.html { redirect_to(@<%= file_name %>) }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @<%= file_name %>.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /<%= table_name %>/1
+  # DELETE /<%= table_name %>/1.xml
+  def destroy
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+    @<%= file_name %>.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(<%= table_name %>_url) }
+      format.xml  { head :ok }
+    end
+  end
+end

data/rails_generators/static_scaffold/templates/functional_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class <%= controller_class_name %>ControllerTest < ActionController::TestCase
+  test "should get index" do
+    get :index
+    assert_response :success
+    assert_not_nil assigns(:<%= table_name %>)
+  end
+
+  test "should get new" do
+    get :new
+    assert_response :success
+  end
+
+  test "should create <%= file_name %>" do
+    assert_difference('<%= class_name %>.count') do
+      post :create, :<%= file_name %> => { }
+    end
+
+    assert_redirected_to <%= file_name %>_path(assigns(:<%= file_name %>))
+  end
+
+  test "should show <%= file_name %>" do
+    get :show, :id => <%= table_name %>(:one).to_param
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get :edit, :id => <%= table_name %>(:one).to_param
+    assert_response :success
+  end
+
+  test "should update <%= file_name %>" do
+    put :update, :id => <%= table_name %>(:one).to_param, :<%= file_name %> => { }
+    assert_redirected_to <%= file_name %>_path(assigns(:<%= file_name %>))
+  end
+
+  test "should destroy <%= file_name %>" do
+    assert_difference('<%= class_name %>.count', -1) do
+      delete :destroy, :id => <%= table_name %>(:one).to_param
+    end
+
+    assert_redirected_to <%= table_name %>_path
+  end
+end