urubatan-mydry_generator 0.2.1

data/README

@@ -0,0 +1,25 @@
+Mydry
+=====
+
+This plugin emulates some of the old "scaffold" functionality, but using RESTFul controllers, will_paginate for pagination, partials for forms and enforces the model first approach.
+
+The basic workflow is this:
+1 - create a migration and define your initial table
+2 - ./script/generate drymodel model_name
+	here the model file generated for you, will have all the validations and belongs defined in the database table
+	you can add more validations, configure relationships, code your model
+3 - ./script/generate dryscaffold model_name
+	here the scaffold will import the model definition (currently it is working with the database, but the next release will import from the model), and generate all the boilerplate code for you.
+
+
+The origin of this plugin was the need to define a validation in the migration (Eg.: :null => false), in the model again (Eg.: validates_presence_of :column), then again in the view, ...
+The way this generators work I define one thing once and it is generated in the other places for me.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2008 Rodrigo Urubatan Ferreira Jardim, released under the MIT license

data/generators/drymodel/drymodel_generator.rb

@@ -0,0 +1,13 @@
+require 'mydry'
+
+class DrymodelGenerator < Mydry::GeneratorBase
+  def manifest
+    load_meta_from_db
+
+    record do |m|
+      m.template 'model.rb', "app/models/#{file_name}.rb"
+      m.template 'fixtures.yml', "test/fixtures/#{file_name.pluralize}.yml"
+      m.template 'unit_test.rb', "test/unit/#{file_name}_test.rb"
+    end
+  end
+end

data/generators/drymodel/templates/fixtures.yml

@@ -0,0 +1,19 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+<% unless attributes.empty? -%>
+one:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+
+two:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+<% else -%>
+# one:
+#   column: value
+#
+# two:
+#   column: value
+<% end -%>

data/generators/drymodel/templates/migration.rb

@@ -0,0 +1,16 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+<% for attribute in attributes -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+<% unless options[:skip_timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/generators/drymodel/templates/model.rb

@@ -0,0 +1,15 @@
+class <%= class_name %> < ActiveRecord::Base
+  #Relationships
+  <% belongs.each do |b| %>belongs_to :<%= b %>
+  <% end %>
+  #Validations
+  <%- notnulls.each do |nn| %>validates_presence_of :<%= nn %>
+  <% end -%>
+  <%- numerics.each do |num| %>validates_numericality_of :<%= num %>, :allow_nil => true
+  <% end -%>
+  <%- lengths.each do |c,s| %>validates_length_of :<%= c %>, :within => 0..<%= s %>, :allow_nil => true
+  <% end -%>
+  <%- belongs.each do |b| %>validates_associated :<%= b %>, :allow_nil => true 
+  <% end -%>
+  
+end

data/generators/drymodel/templates/unit_test.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+class <%= class_name %>Test < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+
+<%- notnulls.each do |nn| %>
+  def test_<%= nn %>_not_null
+    assert false
+  end
+
+<% end -%>
+<%- lengths.each do |nn| %>
+  def test_<%= nn[0] %>_length
+    assert false
+  end
+
+<% end -%>
+<%- numerics.each do |nn| %>
+  def test_<%= nn %>_numeric_only
+    assert false
+  end
+
+<% end -%>
+end

data/generators/dryscaffold/dryscaffold_generator.rb

@@ -0,0 +1,95 @@
+require 'mydry'
+
+class DryscaffoldGenerator < Mydry::GeneratorBase
+  default_options :skip_timestamps => false, :skip_migration => 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
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    @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 manifest
+    load_meta_from_db
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions(controller_class_path, "#{controller_class_name}Controller", "#{controller_class_name}Helper")
+      m.class_collisions(class_path, "#{class_name}")
+
+      # Controller, helper, views, and test 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))
+
+      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('style.css', 'public/stylesheets/scaffold.css')
+
+      m.dependency 'drymodel', [name] + @args, :collision => :skip
+
+      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.route_resources controller_file_name
+    end
+  end
+
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} scaffold ModelName [field:type, field:type]"
+    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 }
+    end
+
+    def scaffold_views
+      %w[ index show new edit ]
+    end
+
+    def model_name
+      class_name.demodulize
+    end  
+end

data/generators/dryscaffold/templates/controller.rb

@@ -0,0 +1,94 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  # GET /<%= table_name %>
+  # GET /<%= table_name %>.xml
+  def index
+    @<%= table_name %> = <%= class_name %>.paginate :page => params[:page]
+
+    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
+    load_relations
+
+    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])
+    load_relations
+  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
+
+  private
+    def load_relations
+      <% belongs.each do |b| %>
+      @<%= b.pluralize %> = <%= b.camelcase %>.find(:all)
+      <% end %>
+    end
+end

data/generators/dryscaffold/templates/functional_test.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+class <%= controller_class_name %>ControllerTest < ActionController::TestCase
+  def test_should_get_index
+    get :index
+    assert_response :success
+    assert_not_nil assigns(:<%= table_name %>)
+  end
+
+  def test_should_get_new
+    get :new
+    assert_response :success
+  end
+
+  def test_should_create_<%= file_name %>
+    assert_difference('<%= class_name %>.count') do
+      post :create, :<%= file_name %> => { }
+    end
+
+    assert_redirected_to <%= file_name %>_path(assigns(:<%= file_name %>))
+  end
+
+  def test_should_show_<%= file_name %>
+    get :show, :id => <%= table_name %>(:one).id
+    assert_response :success
+  end
+
+  def test_should_get_edit
+    get :edit, :id => <%= table_name %>(:one).id
+    assert_response :success
+  end
+
+  def test_should_update_<%= file_name %>
+    put :update, :id => <%= table_name %>(:one).id, :<%= file_name %> => { }
+    assert_redirected_to <%= file_name %>_path(assigns(:<%= file_name %>))
+  end
+
+  def test_should_destroy_<%= file_name %>
+    assert_difference('<%= class_name %>.count', -1) do
+      delete :destroy, :id => <%= table_name %>(:one).id
+    end
+
+    assert_redirected_to <%= table_name %>_path
+  end
+end

data/generators/dryscaffold/templates/helper.rb

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

data/generators/dryscaffold/templates/layout.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title><%= controller_class_name %>: <%%= controller.action_name %></title>
+  <%%= stylesheet_link_tag 'scaffold' %>
+</head>
+<body>
+
+<p style="color: green"><%%= flash[:notice] %></p>
+
+<%%= yield  %>
+
+</body>
+</html>

data/generators/dryscaffold/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 gray;
+  width: 100%;
+}
+
+div.progressBar div.background {
+  background-color: #333;
+  height: 18px;
+  width: 0%;
+}
+

data/generators/dryscaffold/templates/view_edit.html.erb

@@ -0,0 +1,25 @@
+<h1>Editing <%= singular_name %></h1>
+
+<%%= error_messages_for :<%= singular_name %> %>
+
+<%% form_for(@<%= singular_name %>) do |f| %>
+<% for attribute in attributes -%>
+  <p>
+  <%%= f.label :<%= attribute.name %> %><br />
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  </p>
+
+<% end -%>
+<% for rel in belongs -%>
+  <p>
+  <%%= f.label :<%= rel %>_id %><br/>
+  <%%= f.collection_select :<%= rel %>_id, @<%= rel.pluralize %>, 'id', 'id' %>
+  </p>
+<% end -%>
+  <p>
+    <%%= f.submit "Update" %>
+  </p>
+<%% end %>
+
+<%%= link_to 'Show', @<%= singular_name %> %> |
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/generators/dryscaffold/templates/view_index.html.erb

@@ -0,0 +1,25 @@
+<h1>Listing <%= plural_name %></h1>
+
+<table>
+  <tr>
+<% for attribute in attributes -%>
+    <th><%= attribute.column.human_name %></th>
+<% end -%>
+  </tr>
+
+<%% for <%= singular_name %> in @<%= plural_name %> %>
+  <tr>
+<% for attribute in attributes -%>
+    <td><%%=h <%= singular_name %>.<%= attribute.name %> %></td>
+<% end -%>
+    <td><%%= link_to 'Show', <%= singular_name %> %></td>
+    <td><%%= link_to 'Edit', edit_<%= singular_name %>_path(<%= singular_name %>) %></td>
+    <td><%%= link_to 'Destroy', <%= singular_name %>, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<%% end %>
+</table>
+<%%= will_paginate @<%= plural_name %> %>
+
+<br />
+
+<%%= link_to 'New <%= singular_name %>', new_<%= singular_name %>_path %>

data/generators/dryscaffold/templates/view_new.html.erb

@@ -0,0 +1,25 @@
+<h1>New <%= singular_name %></h1>
+
+<%%= error_messages_for :<%= singular_name %> %>
+
+<%% form_for(@<%= singular_name %>) do |f| %>
+<% for attribute in attributes -%>
+  <p>
+  <%%= f.label :<%= attribute.name %> %><br />
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  </p>
+
+<% end -%>
+<% for rel in belongs -%>
+  <p>
+  <%%= f.label :<%= rel %>_id %><br/>
+  <%%= f.collection_select :<%= rel %>_id, @<%= rel.pluralize %>, 'id', 'id' %>
+  </p>
+<% end -%>
+
+  <p>
+    <%%= f.submit "Create" %>
+  </p>
+<%% end %>
+
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/generators/dryscaffold/templates/view_show.html.erb

@@ -0,0 +1,10 @@
+<% for attribute in attributes -%>
+<p>
+  <b><%= attribute.column.human_name %>:</b>
+  <%%=h @<%= singular_name %>.<%= attribute.name %> %>
+</p>
+
+<% end -%>
+
+<%%= link_to 'Edit', edit_<%= singular_name %>_path(@<%= singular_name %>) %> |
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/lib/mydry.rb

@@ -0,0 +1,42 @@
+module Mydry
+   class GeneratorBase < Rails::Generator::NamedBase
+      attr_accessor :notnulls, :lengths, :numerics, :belongs
+
+      def load_meta_from_db
+         con = ActiveRecord::Base.connection
+         cols = con.columns table_name
+         @notnulls = []
+         @lengths = {}
+         @numerics = []
+         @attributes = []
+         @belongs = []
+         cols.each do |c|
+            @notnulls << c.name if !c.null && not_id(c)
+            @lengths[c.name] = c.limit if c.limit && not_id(c) && !is_number(c) 
+            @numerics << c.name if not_id(c) && !is_number(c)
+            @belongs << c.name.gsub(/(.*)_id$/, '\1') if is_ref(c)
+            attrib = Rails::Generator::GeneratedAttribute.new(c.name,c.type)
+            attrib.column = c
+            attrib.default = c.default
+            @attributes << attrib if not_id(c)
+         end
+      end
+      private
+        def not_id(c)
+          !is_ref(c) && c.name != 'id'
+        end
+        def is_number(c)
+          [:integer, :numeric, :decimal, :float].index(c.type) 
+        end
+        def is_ref(c)
+          c.name =~ /_id$/
+        end
+   end
+end
+module Rails
+  module Generator
+    class GeneratedAttribute
+      attr_accessor :default
+    end
+  end
+end

data/test/mydry_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class MydryTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: urubatan-mydry_generator
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Rodrigo Urubatan Ferreira Jardim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+description: mydry is a rails generator that enables you to work in a drier way, using the information you already provided in the migration to create your models, for example all the non nulls, uniques, numerics and relations defined in the database are already defined in the model with the corresponding validation.
+email: rodrigo@urubatan.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- generators/drymodel/drymodel_generator.rb
+- generators/drymodel/templates/fixtures.yml
+- generators/drymodel/templates/migration.rb
+- generators/drymodel/templates/model.rb
+- generators/drymodel/templates/unit_test.rb
+- generators/dryscaffold/dryscaffold_generator.rb
+- generators/dryscaffold/templates/controller.rb
+- generators/dryscaffold/templates/functional_test.rb
+- generators/dryscaffold/templates/helper.rb
+- generators/dryscaffold/templates/layout.html.erb
+- generators/dryscaffold/templates/style.css
+- generators/dryscaffold/templates/view_edit.html.erb
+- generators/dryscaffold/templates/view_index.html.erb
+- generators/dryscaffold/templates/view_new.html.erb
+- generators/dryscaffold/templates/view_show.html.erb
+- generators/drymodel/drymodel_generator.rb
+- generators/drymodel/templates/fixtures.yml
+- generators/drymodel/templates/migration.rb
+- generators/drymodel/templates/model.rb
+- generators/drymodel/templates/unit_test.rb
+- generators/dryscaffold/dryscaffold_generator.rb
+- generators/dryscaffold/templates/controller.rb
+- generators/dryscaffold/templates/functional_test.rb
+- generators/dryscaffold/templates/helper.rb
+- generators/dryscaffold/templates/layout.html.erb
+- generators/dryscaffold/templates/style.css
+- generators/dryscaffold/templates/view_edit.html.erb
+- generators/dryscaffold/templates/view_index.html.erb
+- generators/dryscaffold/templates/view_new.html.erb
+- generators/dryscaffold/templates/view_show.html.erb
+- lib/mydry.rb
+- README
+- test/mydry_test.rb
+has_rdoc: true
+homepage: http://github.com/urubatan/mydry
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: An easy way to generate models for your application based on the information you already provided in the migrations
+test_files: 
+- test/mydry_test.rb