miracle_generators 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mark Dodwell
+
+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/Manifest

@@ -0,0 +1,20 @@
+LICENSE
+Manifest
+README.textile
+Rakefile
+lib/miracle_generators.rb
+miracle_generators.gemspec
+rails_generators/miracle_scaffold/USAGE
+rails_generators/miracle_scaffold/miracle_scaffold_generator.rb
+rails_generators/miracle_scaffold/templates/controller.rb
+rails_generators/miracle_scaffold/templates/helper.rb
+rails_generators/miracle_scaffold/templates/migration.rb
+rails_generators/miracle_scaffold/templates/model.rb
+rails_generators/miracle_scaffold/templates/test/controller.rb
+rails_generators/miracle_scaffold/templates/test/model.rb
+rails_generators/miracle_scaffold/templates/views/_form.html.erb
+rails_generators/miracle_scaffold/templates/views/edit.html.erb
+rails_generators/miracle_scaffold/templates/views/index.html.erb
+rails_generators/miracle_scaffold/templates/views/new.html.erb
+rails_generators/miracle_scaffold/templates/views/show.html.erb
+tasks/deployment.rake

data/README.textile

@@ -0,0 +1,13 @@
+h1. Miracle Generators
+
+A simple Rails scaffold generator. 
+
+NB. Requires formtastic gem, and a helper called 'heading' for capturing the title in the view.
+
+h2. Install
+
+  gem install miracle_generators
+
+h2. Usage
+
+Run `script/generate miracle_scaffold` from your Rails project root for usage instructions.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('miracle_generators', '0.1.0') do |p|
+  p.description    = "Just another RESTful scaffold generator for Rails."
+  p.url            = "http://github.com/mkdynamic/miracle_generators"
+  p.author         = 'Mark Dodwell'
+  p.email          = "apps (at) mkdynamic (dot) co (dot) uk"
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/miracle_generators.rb

@@ -0,0 +1,2 @@
+module MiracleGenerators
+end

data/miracle_generators.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{miracle_generators}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Dodwell"]
+  s.date = %q{2010-01-17}
+  s.description = %q{Just another RESTful scaffold generator for Rails.}
+  s.email = %q{apps (at) mkdynamic (dot) co (dot) uk}
+  s.extra_rdoc_files = ["LICENSE", "README.textile", "lib/miracle_generators.rb", "tasks/deployment.rake"]
+  s.files = ["LICENSE", "Manifest", "README.textile", "Rakefile", "lib/miracle_generators.rb", "miracle_generators.gemspec", "rails_generators/miracle_scaffold/USAGE", "rails_generators/miracle_scaffold/miracle_scaffold_generator.rb", "rails_generators/miracle_scaffold/templates/controller.rb", "rails_generators/miracle_scaffold/templates/helper.rb", "rails_generators/miracle_scaffold/templates/migration.rb", "rails_generators/miracle_scaffold/templates/model.rb", "rails_generators/miracle_scaffold/templates/test/controller.rb", "rails_generators/miracle_scaffold/templates/test/model.rb", "rails_generators/miracle_scaffold/templates/views/_form.html.erb", "rails_generators/miracle_scaffold/templates/views/edit.html.erb", "rails_generators/miracle_scaffold/templates/views/index.html.erb", "rails_generators/miracle_scaffold/templates/views/new.html.erb", "rails_generators/miracle_scaffold/templates/views/show.html.erb", "tasks/deployment.rake"]
+  s.homepage = %q{http://github.com/mkdynamic/miracle_generators}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Miracle_generators", "--main", "README.textile"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{miracle_generators}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Just another RESTful scaffold generator for Rails.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/rails_generators/miracle_scaffold/USAGE

@@ -0,0 +1,38 @@
+Description:
+    Scaffolds an entire resource, from model and migration to controller and
+    views. The resource is ready to use as a starting point for your restful,
+    resource-oriented application. Tests are also generated.
+
+    NB. Require formtastic, and generates formtastic code. Also requires a 
+    helper method "heading" for capturing/displaying titles for views.
+    
+Usage:
+    Pass the name of the model, either CamelCased or under_scored, as the first
+    argument, and an optional list of attribute pairs.
+
+    IMPORTANT: If no attribute pairs are specified, no model will be generated.
+    It will try to determine the attributes from an existing model.
+
+    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'.
+
+    For example, `miracle_scaffold post name:string content:text hidden: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 pass --skip-tests=true, the tests will be omitted.
+
+Examples:
+    script/generate miracle_scaffold post
+
+        Will create a restful controller called "posts" along with the views. 
+        A model will NOT be created, instead it will look for an existing 
+        model and use those attributes.
+
+    script/generate miracle_scaffold post name:string content:text
+
+        Will create a Post model and migration file with the name and content
+        attributes. It will also create a restful controller with views.

data/rails_generators/miracle_scaffold/miracle_scaffold_generator.rb

@@ -0,0 +1,96 @@
+class MiracleScaffoldGenerator < Rails::Generator::Base
+
+  attr_accessor :name, :attributes
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if @args.empty?
+
+    @name = @args.first
+
+    @attributes = []    
+    @args[1..-1].each do |arg|
+      @attributes << Rails::Generator::GeneratedAttribute.new(*arg.split(":"))
+    end
+    @attributes.uniq!
+    
+    if @attributes.empty?
+      options[:skip_model] = true 
+      if model_exists?
+        model_columns_for_attributes.each do |column|
+          @attributes << Rails::Generator::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
+        end
+      else
+        @attributes << Rails::Generator::GeneratedAttribute.new('name', 'string')
+      end
+    end
+  end
+
+  def manifest
+    record do |m|
+      # Model
+      unless options[:skip_model]
+        m.directory "app/models"
+        m.template "model.rb", "app/models/#{singular_name}.rb"
+        m.migration_template "migration.rb", "db/migrate", :migration_file_name => "create_#{plural_name}"
+        unless options[:skip_tests]
+          m.directory "test/unit" 
+          m.template "test/model.rb", "test/unit/#{singular_name}_test.rb"
+        end
+      end
+
+      # Controller
+      m.directory "app/controllers"
+      m.template "controller.rb", "app/controllers/#{plural_name}_controller.rb"
+      unless options[:skip_tests]
+        m.directory "test/functional" 
+        m.template "test/controller.rb", "test/functional/#{plural_name}_controller_test.rb"
+      end
+
+      # Helper
+      m.directory "app/helpers"
+      m.template "helper.rb", "app/helpers/#{plural_name}_helper.rb"
+
+      # Views
+      m.directory "app/views/#{plural_name}"
+      m.template "views/index.html.erb", "app/views/#{plural_name}/index.html.erb"
+      m.template "views/show.html.erb", "app/views/#{plural_name}/show.html.erb"
+      m.template "views/new.html.erb", "app/views/#{plural_name}/new.html.erb"
+      m.template "views/edit.html.erb", "app/views/#{plural_name}/edit.html.erb"
+      m.template "views/_form.html.erb", "app/views/#{plural_name}/_form.html.erb"
+
+      # Route
+      m.route_resources plural_name
+
+      # Copy migrate to clipboard
+      system "echo 'rake db:migrate && rake db:test:prepare' | pbcopy"
+    end
+  end
+
+  def singular_name
+    name.underscore
+  end
+
+  def plural_name
+    name.underscore.pluralize
+  end
+
+  def class_name
+    name.camelize
+  end
+
+  def plural_class_name
+    plural_name.camelize
+  end
+  
+  def model_columns_for_attributes
+    class_name.constantize.columns.reject do |column|
+      column.name.to_s =~ /^(id|created_at|updated_at)$/
+    end
+  end
+  
+  def model_exists?
+    File.exist? destination_path("app/models/#{singular_name}.rb")
+  end
+
+end

data/rails_generators/miracle_scaffold/templates/controller.rb

@@ -0,0 +1,51 @@
+class <%= plural_class_name %>Controller < ApplicationController
+  
+  # 
+  # RESTful actions
+  #
+  
+  def index
+    @<%= plural_name %> = <%= class_name %>.all
+  end
+  
+  def show
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+  end
+  
+  def new
+    @<%= singular_name %> = <%= class_name %>.new
+  end
+
+  def create
+    @<%= singular_name %> = <%= class_name %>.new(params[:<%= singular_name %>])
+    
+    if @<%= singular_name %>.save
+      flash[:notice] = "<%= singular_name.titleize %> added successfully."
+      redirect_to <%= plural_name %>_path
+    else
+      render :action => :new
+    end
+  end
+
+  def edit
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+  end
+
+  def update
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+    
+    if @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+      flash[:notice] = "<%= singular_name.titleize %> updated successfully."
+      redirect_to <%= plural_name %>_path
+    else
+      render :action => :edit
+    end
+  end
+  
+  def destroy
+    <%= class_name %>.find(params[:id]).destroy
+    flash[:notice] = "<%= singular_name.titleize %> deleted successfully."
+    redirect_to <%= plural_name %>_path
+  end
+  
+end

data/rails_generators/miracle_scaffold/templates/helper.rb

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

data/rails_generators/miracle_scaffold/templates/migration.rb

@@ -0,0 +1,14 @@
+class Create<%= plural_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= plural_name %> do |t|
+    <%- for attribute in attributes -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+    <%- end -%>
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :<%= plural_name %>
+  end
+end

data/rails_generators/miracle_scaffold/templates/model.rb

@@ -0,0 +1,2 @@
+class <%= class_name %> < ActiveRecord::Base
+end

data/rails_generators/miracle_scaffold/templates/test/controller.rb

@@ -0,0 +1,160 @@
+require 'test_helper'
+
+class <%= class_name %>sControllerTest < ActionController::TestCase
+  context "routing" do
+    # index and create
+    should_route :get, "/<%= plural_name %>", :controller => :<%= plural_name %>, :action => :index
+    should_route :post, "/<%= plural_name %>", :controller => :<%= plural_name %>, :action => :create    
+
+    # new
+    should_route :get, "/<%= plural_name %>/new", :controller => :<%= plural_name %>, :action => :new
+
+    # edit
+    should_route :get, "/<%= plural_name %>/1/edit", :controller => :<%= plural_name %>, :action => :edit, :id => 1
+
+    # show, update, and delete
+    should_route :get, "/<%= plural_name %>/1", :controller => :<%= plural_name %>, :action => :show, :id => 1
+    should_route :put, "/<%= plural_name %>/1", :controller => :<%= plural_name %>, :action => :update, :id => 1
+    should_route :delete, "/<%= plural_name %>/1", :controller => :<%= plural_name %>, :action => :destroy, :id => 1
+  end
+  
+  context "listing" do    
+    should "be successful" do
+      get :index
+      assert_response :success
+    end
+    should "assign <%= plural_name %>" do
+      get :index
+      assert_not_nil assigns(:<%= plural_name %>)
+    end
+  end
+  
+  context "adding" do
+    should "be successful" do
+      get :new
+      assert_response :success
+    end
+    should "assign <%= singular_name %>" do
+      get :new
+      assert_not_nil assigns(:<%= singular_name %>)
+    end
+    should "create new <%= singular_name.titleize.downcase %>" do
+      get :new
+      assert assigns(:<%= singular_name %>).new_record?
+    end
+  end
+  
+  context "creating" do
+    should "assign <%= singular_name %>" do
+      post :create
+      assert_not_nil assigns(:<%= singular_name %>)
+    end
+    context "when valid" do
+      setup do
+        stub.instance_of(<%= class_name %>).valid? { true }
+      end
+      should "set the flash to success" do
+        post :create
+        assert_match /success/i, flash[:notice]
+      end
+      should "redirect to <%= plural_name.titleize.downcase %> list" do
+        post :create
+        assert_redirected_to <%= plural_name %>_path
+      end
+    end
+    context "when invalid" do
+      setup do
+        stub.instance_of(<%= class_name %>).valid? { false }
+      end
+      should "render new template" do
+        post :create
+        assert_template "new"
+      end
+    end
+  end
+  
+  context "showing" do
+    setup do
+      stub(<%= class_name %>).find { Factory(:<%= singular_name %>) }
+    end
+    should "be successful" do      
+      get :show, :id => 1
+      assert_response :success
+    end
+    should "assign <%= singular_name %>" do
+      get :show, :id => 1
+      assert_not_nil assigns(:<%= singular_name %>)
+    end
+  end
+  
+  context "editing" do
+    setup do
+      stub(<%= class_name %>).find { Factory(:<%= singular_name %>) }
+    end
+    should "be successful" do      
+      get :edit, :id => 1
+      assert_response :success
+    end
+    should "assign <%= singular_name %>" do
+      get :edit, :id => 1
+      assert_not_nil assigns(:<%= singular_name %>)
+    end    
+  end
+  
+  context "updating" do
+    setup do
+      @<%= singular_name %> = Factory(:<%= singular_name %>)
+      stub(<%= class_name %>).find { @<%= singular_name %> }
+    end
+    should "assign <%= singular_name %>" do
+      put :update, :id => 1
+      assert_not_nil assigns(:<%= singular_name %>)
+    end
+    should "update <%= singular_name.titleize.downcase %>" do
+      mock.proxy(@<%= singular_name %>).update_attributes(anything)
+      put :update, :id => 1
+    end
+    context "when valid" do
+      setup do
+        stub(@<%= singular_name %>).valid? { true }
+      end
+      should "set the flash to success" do
+        put :update, :id => 1
+        assert_match /success/i, flash[:notice]
+      end
+      should "redirect to <%= plural_name.titleize.downcase %> list" do
+        put :update, :id => 1
+        assert_redirected_to <%= plural_name %>_path
+      end
+    end
+    context "when invalid" do
+      setup do
+        stub(@<%= singular_name %>).valid? { false }
+      end
+      should "render new template" do
+        put :update, :id => 1
+        assert_template "edit"
+      end
+    end
+  end
+  
+  context "deleting" do
+    setup do
+      @<%= singular_name %> = Factory(:<%= singular_name %>)
+      stub(<%= class_name %>).find { @<%= singular_name %> }
+    end
+    should "destroy <%= singular_name.titleize.downcase %>" do
+      mock.proxy(@<%= singular_name %>).destroy
+      delete :destroy, :id => 1
+    end
+    should "set flash to success" do
+      delete :destroy, :id => 1
+      assert_match /success/i, flash[:notice]
+    end
+    should "redirect to <%= plural_name.titleize.downcase %> list" do
+      delete :destroy, :id => 1
+      assert_redirected_to <%= plural_name %>_path
+    end
+  end
+  
+end

data/rails_generators/miracle_scaffold/templates/test/model.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class <%= class_name %>Test < ActiveSupport::TestCase
+end

data/rails_generators/miracle_scaffold/templates/views/_form.html.erb

@@ -0,0 +1,11 @@
+<%% semantic_form_for @<%= singular_name %> do |form| %>
+	<%%= form.error_messages %>
+	
+	<%% form.inputs do %>
+	<%- for attribute in attributes -%>
+		<%%= form.input :<%= attribute.name %> %>
+	<%- end -%>
+	<%% end %>
+		
+	<%%= form.buttons %>
+<%% end %>

data/rails_generators/miracle_scaffold/templates/views/edit.html.erb

@@ -0,0 +1,7 @@
+<%% heading "Edit <%= singular_name.titleize %>" %>
+
+<p>
+	<%%= link_to "&larr; Back", <%= plural_name %>_path %>
+</p>
+
+<%%= render "form" %>

data/rails_generators/miracle_scaffold/templates/views/index.html.erb

@@ -0,0 +1,28 @@
+<%% heading "<%= plural_name.titleize %>" %>
+
+<p>
+	<%%= link_to "New <%= singular_name.titleize %>", new_<%= singular_name %>_path %>
+</p>
+
+<table class="scaffold">
+  <thead>
+		<tr>
+	  <%- for attribute in attributes -%>
+	    <th><%= attribute.column.human_name.titleize %></th>
+	  <%- end -%>
+			<th colspan="3">Actions</th>
+	  </tr>
+	</thead>
+	<tbody id="<%= plural_name %>">
+  <%% 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 "Delete", <%= singular_name %>, :confirm => 'Are you sure?', :method => :delete %></td>
+    </tr>
+  <%% end %>
+	</tbody>
+</table>

data/rails_generators/miracle_scaffold/templates/views/new.html.erb

@@ -0,0 +1,7 @@
+<%% heading "New <%= singular_name.titleize %>" %>
+
+<p>
+	<%%= link_to "&larr; Back", <%= plural_name %>_path %>
+</p>
+
+<%%= render "form" %>

data/rails_generators/miracle_scaffold/templates/views/show.html.erb

@@ -0,0 +1,14 @@
+<%% heading "Show <%= singular_name.titleize %>" %>
+
+<p>
+	<%%= link_to "&larr; Back", <%= plural_name %>_path %> | 
+	<%%= link_to "Edit", edit_<%= singular_name %>_path(@<%= singular_name %>) %> |
+  <%%= link_to "Delete", @<%= singular_name %>, :confirm => 'Are you sure?', :method => :delete %>
+</p>
+
+<%- for attribute in attributes -%>
+<p>
+  <strong><%= attribute.column.human_name.titleize %>:</strong>
+  <%%=h @<%= singular_name %>.<%= attribute.name %> %>
+</p>
+<%- end -%>

data/tasks/deployment.rake

@@ -0,0 +1,2 @@
+desc "Build the manifest and gemspec files."
+task :build => [:build_manifest, :build_gemspec]

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: miracle_generators
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mark Dodwell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-17 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Just another RESTful scaffold generator for Rails.
+email: apps (at) mkdynamic (dot) co (dot) uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+- lib/miracle_generators.rb
+- tasks/deployment.rake
+files: 
+- LICENSE
+- Manifest
+- README.textile
+- Rakefile
+- lib/miracle_generators.rb
+- miracle_generators.gemspec
+- rails_generators/miracle_scaffold/USAGE
+- rails_generators/miracle_scaffold/miracle_scaffold_generator.rb
+- rails_generators/miracle_scaffold/templates/controller.rb
+- rails_generators/miracle_scaffold/templates/helper.rb
+- rails_generators/miracle_scaffold/templates/migration.rb
+- rails_generators/miracle_scaffold/templates/model.rb
+- rails_generators/miracle_scaffold/templates/test/controller.rb
+- rails_generators/miracle_scaffold/templates/test/model.rb
+- rails_generators/miracle_scaffold/templates/views/_form.html.erb
+- rails_generators/miracle_scaffold/templates/views/edit.html.erb
+- rails_generators/miracle_scaffold/templates/views/index.html.erb
+- rails_generators/miracle_scaffold/templates/views/new.html.erb
+- rails_generators/miracle_scaffold/templates/views/show.html.erb
+- tasks/deployment.rake
+has_rdoc: true
+homepage: http://github.com/mkdynamic/miracle_generators
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Miracle_generators
+- --main
+- README.textile
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: miracle_generators
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Just another RESTful scaffold generator for Rails.
+test_files: []
+