gisikw-restful_controller_generator 0.1.4

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-07-09
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/restful_controller
+lib/restful_controller.rb
+test/test_restful_controller.rb
+restful_controller_generator.rb
+templates/controller.rb
+templates/controller_spec.rb
+templates/controller_test.rb
+templates/helper.rb
+templates/helper_spec.rb
+templates/helper_test.rb

data/README.rdoc

@@ -0,0 +1,40 @@
+= RESTful Controller Generator
+
+Views change, models change, but RESTful controllers could stand some foundational code.
+This generator will create
+* A RESTful controller
+* A Test::Unit or Rspec test to cover each action
+
+== REQUIREMENTS:
+
+To ensure that all actions are fully covered, both Test::Unit and Rspec require the Mocha stubbing framework (or go in and write your own tests for the create and update actions).
+
+== INSTALL:
+
+  # Install the gem:
+  sudo gem install restful_controller_generator
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIX
+
+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/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "restful_controller_generator"
+    gem.summary = %Q{Generator for a RESTful controller}
+    gem.description = %Q{Generator for a RESTful controller}
+    gem.email = "kevin.gisi@gmail.com"
+    gem.homepage = "http://github.com/gisikw/restful_controller_generator"
+    gem.authors = ["Kevin W. Gisi"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "restful_controller_generator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.4

data/bin/restful_controller

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/example/foos_controller.rb

@@ -0,0 +1,41 @@
+class FoosController < ApplicationController
+
+  before_filter :new_foo, :only => [:new,:create]
+  before_filter :find_foo, :only => [:show,:edit,:update,:destroy]
+
+  def index
+    @foos = Foo.all
+  end
+
+  def create
+    if @foo.save
+      redirect_to foos_url
+    else
+      render :action => 'new'
+    end
+  end
+
+  def update
+    if @foo.update_attributes(params[:foo])
+      redirect_to foos_url
+    else
+      render :action => 'edit'
+    end
+  end
+
+  def destroy
+    @foo.destroy
+    redirect_to foos_url
+  end
+
+  protected
+
+  def new_foo
+    @foo = Foo.new(params[:foo])
+  end
+
+  def find_foo
+    @foo = Foo.find(params[:id])
+  end
+
+end

data/example/foos_controller_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe FooController do
+
+  before
+    @foo = Foo.new.save(false)
+  end
+
+  describe 'index action' do
+    before do
+      get :index
+    end
+    it 'should render index template' do
+      response.should render_template('index')
+    end
+  end
+
+  describe 'new action' do
+    before do
+      get :new
+    end
+    it 'should render new template' do
+      response.should render_template('new')
+    end
+  end
+
+  describe 'edit action' do
+    before do
+      get :edit, :id => @foo.id
+    end
+    it 'should render edit template' do
+      response.should render_template('edit')
+    end
+  end
+
+  describe 'show action' do
+    before do
+      get :show, :id => @foo.id
+    end
+    it 'should render show template' do
+      response.should render_template('show')
+    end
+  end
+
+  describe 'create action' do
+    describe 'on save' do
+      before do
+        Foo.any_instance.stubs(:save).returns(true)
+        post :create
+      end
+      it 'should redirect to index' do
+        response.should redirect_to(foos_url)
+      end
+    end
+    describe 'on failed save' do
+      before do
+        Foo.any_instance.stubs(:save).returns(true)
+        post :create
+      end
+      it 'should render new action' do
+        response.should render_remplate('new')
+      end
+    end
+  end
+
+  describe 'update action' do
+    describe 'on update' do
+      before do
+        Foo.any_instance.stubs(:update_attributes).returns(true)
+        put :update, :id => @foo.id
+      end
+      it 'should redirect to index' do
+        response.should redirect_to(foos_url)
+      end
+    end
+    describe 'on failed update' do
+      before do
+        Foo.any_instance.stubs(:update_attributes).returns(false)
+        put :update, :id => @foo.id
+      end
+      it 'should render edit template' do
+        response.should render_template('edit')
+      end
+    end
+  end
+
+  describe 'destroy action' do
+    before do
+      delete :destroy, @foo.id
+    end
+    it 'should redirect to index action' do
+      response.should redirect_to(foos_url)
+    end
+  end
+
+end

data/example/foos_controller_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class FoosControllerTest < ActionController::TestCase
+
+  def setup
+    @foo = Foo.new.save(false)
+  end
+
+  test "index action should render index template" do
+    get :index
+    assert_template :index
+  end
+
+  test "new action should render new template" do
+    get :new
+    assert_template :new
+  end
+
+  test "edit action should render edit template" do
+    get :edit, :id => @foo.id
+    assert_template :edit
+  end
+
+  test "show action should render show template" do
+    get :show, :id => @foo.id
+  end
+
+  test "create action on save should redirect to index" do
+    Foo.any_instance.stubs(:save).returns(true)
+    post :create
+    assert_redirected_to :action => 'index'
+  end
+
+  test "create action on failed save should render new action" do
+    Foo.any_instance.stubs(:save).returns(false)
+    post :create
+    assert_template :new
+  end
+
+  test "update action on update should redirect to index" do
+    Foo.any_instance.stubs(:update_attributes).returns(true)
+    put :update, :id => @foo.id
+    assert_redirected_to :action => 'index'
+  end
+
+  test "update action on failed update should render edit template" do
+    Foo.any_instance.stubs(:update_attributes).returns(false)
+    put :update, :id => @foo.id
+    assert_template :edit
+  end
+
+  test "destroy action should redirect to index action" do
+    delete :destroy, :id => @foo.id
+    assert_redirected_to :action => 'index'
+  end
+
+end

data/lib/restful_controller.rb

@@ -0,0 +1,3 @@
+class RestfulController
+  VERSION = '1.0.0'
+end

data/restful_controller_generator.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{restful_controller_generator}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kevin W. Gisi"]
+  s.date = %q{2009-08-12}
+  s.default_executable = %q{restful_controller}
+  s.description = %q{Generator for a RESTful controller}
+  s.email = %q{kevin.gisi@gmail.com}
+  s.executables = ["restful_controller"]
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".autotest",
+     "History.txt",
+     "Manifest.txt",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/restful_controller",
+     "example/foos_controller.rb",
+     "example/foos_controller_spec.rb",
+     "example/foos_controller_test.rb",
+     "lib/restful_controller.rb",
+     "restful_controller_generator.gemspec",
+     "restful_controller_generator.rb",
+     "templates/controller.rb",
+     "templates/controller_spec.rb",
+     "templates/controller_test.rb",
+     "templates/helper.rb",
+     "templates/helper_spec.rb",
+     "templates/helper_test.rb",
+     "test/test_restful_controller.rb"
+  ]
+  s.homepage = %q{http://github.com/gisikw/restful_controller_generator}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Generator for a RESTful controller}
+  s.test_files = [
+    "test/test_restful_controller.rb"
+  ]
+
+  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/restful_controller_generator.rb

@@ -0,0 +1,38 @@
+class RestfulControllerGenerator < Rails::Generator::NamedBase
+
+  attr_accessor :models_name, :model_name, :controller_name
+
+  def manifest
+    record do |m|
+      @controller_name = "#{@class_name}Controller"
+      @models_name = @class_name.downcase
+      @model_name = @models_name.singularize
+      m.directory('app/controllers')
+      m.directory('app/helpers')
+      m.directory(File.join('app/views',@models_name))
+      m.template('controller.rb',"app/controllers/#{@models_name}_controller.rb")
+      m.template('helper.rb',"app/helpers/#{models_name}_helper.rb")
+      m.route_resources @models_name
+      if options[:spec]
+        m.directory('spec/controllers')
+        m.directory('spec/helpers')
+        m.directory(File.join('spec/views',@model_names))
+        m.template spec/controllers/foos_controller_spec.rb
+        m.template('helper_spec.rb',"spec/helpers/#{models_name}_helper_spec.rb")
+      else
+        m.directory('test/function')
+        m.directory('test/unit/helpers')
+        m.template('controller_test.rb',"test/functional/#{models_name}_controller_test.rb")
+        m.template('helper_test.rb',"test/unit/helpers/#{models_name}_helper_test.rb")
+      end
+    end
+  end
+
+  protected
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--spec","Create a spec file rather than a test::unit file"){|v| options[:spec] = v}
+  end
+end

data/templates/controller.rb

@@ -0,0 +1,41 @@
+class <%= controller_name %> < ApplicationController
+
+  before_filter :new_<%= model_name %>, :only => [:new,:create]
+  before_filter :find_<%= model_name %>, :only => [:show,:edit,:update.:destroy]
+
+  def index
+    @<%= models_name %> = <%= model_name.capitalize %>.all
+  end
+
+  def create
+    if @<%= model_name %>.save
+      redirect_to <%= models_name %>_url
+    else
+      render :action => 'new'
+    end
+  end
+
+  def update
+    if @<%= model_name %>.update_attributes(params[:<%= model_name %>])
+      redirect_to <%= models_name %>_url
+    else
+      render :action => 'edit'
+    end
+  end
+
+  def destroy
+    @<%= model_name %>.destroy
+    redirect_to <%= models_name %>_url
+  end
+
+  protected
+
+  def new_<%= model_name %>
+    @<%= model_name %> = <%= model_name.capitalize %>.new(params[:<%= model_name %>])
+  end
+
+  def find_<%= model_name %>
+    @<%= model_name %> = <%= model_name.capitalize %>.find(params[:id])
+  end
+
+end

data/templates/controller_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe <%= controller_name %> do
+
+  before
+    @<%= model_name %> = <%= model_name.capitalize %>.new.save(false)
+
+  describe 'index action' do
+    before do
+      get :index
+    end
+    it 'should render index template' do
+      response.should render_template('index')
+    end
+  end
+
+  describe 'new action' do
+    before do
+      get :new
+    end
+    it 'should render new template' do
+      response.should render_template('new')
+    end
+  end
+
+  describe 'edit action' do
+    before do
+      get :edit, :id => @<%= model_name %>.id
+    end
+    it 'should render edit template' do
+      response.should render_template('edit')
+    end
+  end
+
+  describe 'show action' do
+    before do
+      get :show, :id => @<%= model_name %>.id
+    end
+    it 'should render show template' do
+      response.should render_template('show')
+    end
+  end
+
+  describe 'create action' do
+    describe 'on save' do
+      before do
+        <%= model_name.capitalize %>.any_instance.stubs(:save).returns(true)
+        post :create
+      end
+      it 'should redirect to index' do
+        response.should redirect_to(<%= models_name %>_url)
+      end
+    end
+    describe 'on failed save' do
+      before do
+        <%= model_name.capitalize %>.any_instance.stubs(:save).returns(true)
+        post :create
+      end
+      it 'should render new action' do
+        response.should render_remplate('new')
+      end
+    end
+  end
+
+  describe 'update action' do
+    describe 'on update' do
+      before do
+        <%= model_name.capitalize %>.any_instance.stubs(:update_attributes).returns(true)
+        put :update, :id => @<%= model_name %>.id
+      end
+      it 'should redirect to index' do
+        response.should redirect_to(<%= models_name %>_url)
+      end
+    end
+    describe 'on failed update' do
+      before do
+        <%= model_name.capitalize %>.any_instance.stubs(:update_attributes).returns(false)
+        put :update, :id => @<%= model_name %>.id
+      end
+      it 'should render edit template' do
+        response.should render_template('edit')
+      end
+    end
+  end
+
+  describe 'destroy action' do
+    before do
+      delete :destroy, :id => @<%= model_name %>.id
+    end
+    it 'should redirect to index action' do
+      response.should redirect_to(<%= models_name %>_url)
+    end
+  end
+

data/templates/controller_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class <%= controller_name %>Test < ActionController::TestCase
+
+  def setup
+    <%= model_name %> = <%= model_name.capitalize %>.new.save(false)
+  end
+
+  test "index action should render index template" do
+    get :index
+    assert_template :index
+  end
+
+  test "new action should render new template" do
+    get :new
+    assert_template :new
+  end
+
+  test "edit action should render edit template" do
+    get :edit, :id => @<%= model_name %>.id
+    assert_template :edit
+  end
+
+  test "show action should render show template" do
+    get :show, :id => @<%= model_name %>.id
+  end
+
+  test "create action on save should redirect to index" do
+    <%= model_name.capitalize %>.any_instance.stubs(:save).returns(true)
+    post :create
+    assert_redirected_to :action => 'index'
+  end
+
+  test "create action on failed save should render new action" do
+    <%= model_name.capitalize %>.any_instance.stubs(:save).returns(false)
+    post :create
+    assert_template :new
+  end
+
+  test "update action on update should redirect to index" do
+    <%= model_name.capitalize %>.any_instance.stubs(:update_attributes).returns(true)
+    put :update, :id => @<%= model_name %>.id
+    assert_redirected_to :action => 'index'
+  end
+
+  test "update action on failed update should render edit template" do
+    <%= model_name.capitalize %>.any_instance.stubs(:update_attributes).returns(false)
+    put :update, :id => @<%= model_name %>.id
+    assert_template :edit
+  end
+
+  test "destroy action should redirect to index action" do
+    delete :destroy, :id => @<%= model_name %>.id
+    assert_redirected_to :action => 'index'
+  end
+
+end

data/templates/helper.rb

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

data/templates/helper_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe <%= class_name %>Helper do
+  
+  #Delete this example and add some real ones or delete this file
+  it "should be included in the object returned by #helper" do
+    included_modules = (class << helper; self; end).send :included_modules
+    included_modules.should include(<%= class_name %>Helper)
+  end
+
+end

data/templates/helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class <%= class_name.capitalize %>HelperTest < ActionView::TestCase
+end

data/test/test_restful_controller.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "restful_controller"
+
+class TestRestfulController < Test::Unit::TestCase
+  def test_sanity
+    #flunk "write tests or I will kneecap you"
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: gisikw-restful_controller_generator
+version: !ruby/object:Gem::Version 
+  version: 0.1.4
+platform: ruby
+authors: 
+- Kevin W. Gisi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-12 00:00:00 -07:00
+default_executable: restful_controller
+dependencies: []
+
+description: Generator for a RESTful controller
+email: kevin.gisi@gmail.com
+executables: 
+- restful_controller
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/restful_controller
+- example/foos_controller.rb
+- example/foos_controller_spec.rb
+- example/foos_controller_test.rb
+- lib/restful_controller.rb
+- restful_controller_generator.gemspec
+- restful_controller_generator.rb
+- templates/controller.rb
+- templates/controller_spec.rb
+- templates/controller_test.rb
+- templates/helper.rb
+- templates/helper_spec.rb
+- templates/helper_test.rb
+- test/test_restful_controller.rb
+has_rdoc: false
+homepage: http://github.com/gisikw/restful_controller_generator
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Generator for a RESTful controller
+test_files: 
+- test/test_restful_controller.rb