zero_generators 0.0.1

data/README

@@ -0,0 +1,38 @@
+Zero Generators
+=======
+
+Coletânea de geradores de código para Rails que eu acabo tendo que incluir em todos os projetos
+que desenvolvo, e acabei por decidindo criar um plugin.
+
+Geradores
+=======
+
+Basicamente, os geradores são:
+
+* tdd_model, tdd_controller - Geradores que geram "stubs" de testes, em formato RSpec.
+* tdd_scaffold - Gerador para um teste, em RSpec, de um scaffold padrão do Rails. Evita stubs sempre que possível.
+* tdd_scaffold_stub - Gerador para um teste, em RSpec, de um scaffold padrão do Rails, usando stubs 
+sempre que possível (tenta imitar o formato padrão do spec_scaffold, porém em português).
+* factory_scaffold - Gerador para um teste, em RSpec, de um scaffold padrão porém usando fixtures. 
+Utiliza stubs, porém a idéia é ser fácil de retirar estes stubs se for necessário.
+* layout - Cria um layout, inclusive com o arquivo pt_BR.yml.
+* ferret_scaffold - Cria um Scaffold usando Ferret.
+
+NOTA
+======
+
+Estes geradores são altamente "opinados" - todos os geradores que geram também testes usam a sintaxe
+do RSpec, e todos os testes evitam stubs. Na minha concepção, não existe "unit-test" em Controller
+(e, na verdade, o BDD meio que surgiu para evitar a idéia de "unit-test") portanto isolar o Controller
+da Model, em testes, não parece fazer sentido. Isso faz com que uma alteração na Model muitas vezes
+quebre testes no Controller, mas sejamos sinceros, se isso acontecer é porque provavelmente o seu
+Controller está com bugs mesmo, e se o teste não serve para capturar isso, qual o uso dele?
+
+Este é um projeto em andamento, e provavelmente com o tempo o número de geradores aumentará bastante.
+
+Exemplos
+=======
+
+
+
+Copyright (c) 2009 Maurício Szabo, desenvolvido sobre a Artistic License - versão 2.0

data/generators/default_values.rb

@@ -0,0 +1,21 @@
+#coding: utf-8
+#Copiado na íntegra do RSpec-Rails
+module Rails
+  module Generator
+    class GeneratedAttribute
+      def default_value
+        @default_value ||= case type
+          when :int, :integer               then "\"1\""
+          when :float                       then "\"1.5\""
+          when :decimal                     then "\"9.99\""
+          when :datetime, :timestamp, :time then "Time.now"
+          when :date                        then "Date.today"
+          when :string, :text               then "\"valor para #{@name}\""
+          when :boolean                     then "false"
+          else
+            "\"\""
+        end
+      end
+    end
+  end
+end

data/generators/factory_scaffold/USAGE

@@ -0,0 +1,15 @@
+Descrição:
+    Gera um teste, em RSpec, para um scaffold padrão do Rails, usando Factories.
+
+Examplo:
+    ./script/generate factory_scaffold Aluno
+
+    Isto vai criar:
+        spec/models/aluno_spec.rb
+	spec/fixtures/alunos.yml
+        spec/controller/alunos_controller_spec.rb
+        spec/helpers/alunos_helper_spec.rb
+
+    NOTA: Este teste não cria as factories automaticamente, nem adiciona nenhuma informação
+    no arquivo spec_helper de como incluí-las. É necessário criar as factories manualmente
+    após gerar o factory_scaffold.

data/generators/factory_scaffold/factory_scaffold_generator.rb

@@ -0,0 +1,27 @@
+class FactoryScaffoldGenerator < Rails::Generator::NamedBase
+  attr_reader :file_plural, :class_plural
+
+  def manifest
+    record do |m|
+      # m.directory "lib"
+      # m.template 'README', "README"
+      m.class_collisions class_path, class_name
+
+      @file_plural = file_name.pluralize
+      @class_plural = class_name.pluralize
+
+      m.directory 'spec'
+      m.directory 'spec/controllers'
+      m.directory File.join('spec/controllers', class_path)
+      m.template 'controller_spec.rb.erb',  File.join('spec/controllers', class_path, "#{@file_plural}_controller_spec.rb")
+
+      m.directory 'spec/models'
+      m.directory File.join('spec/models', class_path)
+      m.template 'model_spec.rb.erb',  File.join('spec/models', class_path, "#{file_name}_spec.rb")
+
+      m.directory 'spec/helpers'
+      m.directory File.join('spec/helpers', class_path)
+      m.template 'helper_spec.rb.erb',  File.join('spec/helpers', class_path, "#{@file_plural}_helper_spec.rb")
+    end
+  end
+end

data/generators/factory_scaffold/templates/controller_spec.rb.erb

@@ -0,0 +1,135 @@
+require 'spec/spec_helper'
+
+describe <%= class_plural %>Controller do
+  integrate_views
+
+  context 'durante a exibição das telas (GET)' do
+    it 'deve exibir corretamente uma listagem' do
+      stub_<%= file_name %>
+      get :index
+      response.body.should include('Nome')
+    end
+
+    it 'deve exibir corretamente uma listagem XML' do
+      stub_<%= file_name %>
+      get :index, :format => 'xml'
+      response.should have_tag('nome', :text => 'Nome')
+    end
+
+    it 'deve exibir corretamente o dado de um <%= file_name %>' do
+      stub_<%= file_name %>
+      get :show, :id => @<%= file_name %>.id
+      response.body.should include('Nome')
+    end
+
+    it 'deve exibir corretamente o dado de um <%= file_name %> via XML' do
+      stub_<%= file_name %>
+      get :show, :id => @<%= file_name %>.id, :format => 'xml'
+      response.should have_tag('nome', :text => 'Nome')
+    end
+
+    it 'deve exibir corretamente uma tela de edição' do
+      stub_<%= file_name %>
+      get :edit, :id => @<%= file_name %>.id
+      response.should have_tag('form')
+    end
+
+    it 'deve exibir corretamente uma tela de criação' do
+      get :new
+      response.should have_tag('form')
+    end
+
+    it 'deve exibir corretamente uma tela de criação via XML' do
+      get :new, :format => 'xml'
+      response.should be_success
+    end
+  end
+
+  context 'na edição ou criação de <%= file_plural %>' do
+    context 'com atributos válidos' do
+      it 'deve criar um registro corretamente e redirecionar para ele' do
+        post :create, :<%= file_name %> => Factory.attributes_for(:<%= file_name %>)
+        response.should redirect_to(<%= file_name %>_url(<%= class_name %>.last))
+      end
+
+      it 'deve criar um registro corretamente via REST e apontar para sua URI' do
+        post :create, :<%= file_name %> => Factory.attributes_for(:<%= file_name %>), :format => 'xml'
+        response.response_code.should == 201
+        response.location.should == <%= file_name %>_url(<%= class_name %>.last)
+      end
+
+      it 'deve atualizar um registro corretamente e redirecionar para ele' do
+        stub_<%= file_name %>
+        @<%= file_name %>.should_receive(:save).and_return(true)
+        put :update, :<%= file_name %> => @<%= file_name %>.attributes
+        response.should redirect_to(<%= file_name %>_url(@<%= file_name %>))
+      end
+
+      it 'deve atualizar um registro corretamente via REST' do
+        stub_<%= file_name %>
+        @<%= file_name %>.should_receive(:save).and_return(true)
+        put :update, :<%= file_name %> => @<%= file_name %>.attributes, :format => 'xml'
+        response.should be_success
+      end
+    end
+
+    context 'com atributos inválidos' do
+      it 'deve impedir a criação de um registro, apresentar os erros e renderizar novamente a tela' do
+        stub_<%= file_name %>
+        <%= class_name %>.stub!(:new).and_return(@<%= file_name %>)
+        @<%= file_name %>.should_receive(:save).and_return(false)
+        @<%= file_name %>.errors.add(:atributo, 'possui um erro')
+        post :create, :<%= file_name %> => Factory.attributes_for(:<%= file_name %>)
+        response.should render_template('new')
+        response.body.should include('Atributo possui um erro')
+      end
+
+      it 'deve impedir a criação de um registro e apresentar um XML com os erros' do
+        stub_<%= file_name %>
+        <%= class_name %>.stub!(:new).and_return(@<%= file_name %>)
+        @<%= file_name %>.should_receive(:save).and_return(false)
+        post :create, :<%= file_name %> => Factory.attributes_for(:<%= file_name %>), :format => 'xml'
+        response.response_code.should == 422
+        response.should have_tag('errors')
+      end
+
+      it 'deve impedir a edição, apresentar os erros e renderizar novamente a tela' do
+        stub_<%= file_name %>
+        @<%= file_name %>.should_receive(:save).and_return(false)
+        @<%= file_name %>.errors.add(:atributo, 'possui um erro')
+        put :update, :<%= file_name %> => @<%= file_name %>.attributes
+        response.should render_template('edit')
+        response.body.should include('Atributo possui um erro')
+      end
+
+      it 'deve impedir a edição apresentar um XML com os erros' do
+        stub_<%= file_name %>
+        @<%= file_name %>.should_receive(:save).and_return(false)
+        put :update, :<%= file_name %> => @<%= file_name %>.attributes, :format => 'xml'
+        response.should have_tag('errors')
+      end
+    end
+  end
+
+  context 'na destruição de um registro' do
+    it 'deve remover o registro e redirecionar para a listagem' do
+      stub_<%= file_name %>
+      @<%= file_name %>.should_receive(:destroy).and_return(true)
+      delete :destroy, :id => @<%= file_name %>.id
+      response.should redirect_to(<%= file_plural %>_url)
+    end
+
+    it 'deve remover o registro via REST' do
+      stub_<%= file_name %>
+      @<%= file_name %>.should_receive(:destroy).and_return(true)
+      delete :destroy, :id => @<%= file_name %>.id, :format => 'xml'
+      response.should be_success
+    end
+  end
+end
+
+def stub_<%= file_name %>(atributos = {})
+  @<%= file_name %> = Factory.stub :<%= file_name %>, atributos
+  <%= class_name %>.stub!(:find).and_return(@<%= file_name %>)
+  <%= class_name %>.stub!(:all).and_return([@<%= file_name %>])
+end

data/generators/factory_scaffold/templates/helper_spec.rb.erb

@@ -0,0 +1,5 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe <%= class_plural %>Helper do
+  include <%= class_plural %>Helper
+end

data/generators/factory_scaffold/templates/model_spec.rb.erb

@@ -0,0 +1,8 @@
+require 'spec/spec_helper'
+
+describe <%= class_name %> do
+  it "deve ser válido com os dados corretos" do
+    @<%= file_plural %> = Factory.build(:<%= file_name %>)
+    @<%= file_plural %>.should be_valid
+  end
+end

data/generators/ferret_scaffold/USAGE

@@ -0,0 +1,12 @@
+Descrição:
+    ferret_scaffold é semelhante ao scaffold normal do Rails, porém cria telas
+    mais simples, em português, e com suporte para o Ferret (inclusive
+    removendo acentuação das strings de busca).
+
+    Passe o nome do modelo no singular, e uma lista de atributos:tipo, assim
+    como seria feito no scaffold normal.
+
+Exemplos:
+    `./script/generate ferret_scaffold post`
+    `./script/generate ferret_scaffold post title:string body:text published:boolean`
+    `./script/generate ferret_scaffold purchase order_id:integer amount:decimal`

data/generators/ferret_scaffold/ferret_scaffold_generator.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/../default_values'
+
+class FerretScaffoldGenerator < Rails::Generator::NamedBase
+  default_options :skip_timestamps => false, :skip_migration => false, :force_plural => false, :skip_spec => false
+
+  attr_reader :file_plural, :class_plural
+
+  def manifest
+    record do |m|
+      m.class_collisions class_path, class_name
+
+      @file_plural = file_name.pluralize
+      @class_plural = class_name.pluralize
+      
+      m.directory 'app'
+      m.directory 'app/controllers'
+      m.directory File.join('app/controllers', class_path)
+      m.template 'controller.rb.erb', File.join('app/controllers', class_path, "#{@file_plural}_controller.rb")
+
+      m.directory 'app'
+      m.directory 'app/models'
+      m.directory File.join('app/models', class_path)
+      m.template 'model.rb.erb', File.join('app/models', class_path, "#{file_name}.rb")
+
+      m.directory 'app'
+      m.directory 'app/helpers'
+      m.directory File.join('app/helpers', class_path)
+      m.template 'helper.rb.erb', File.join('app/helpers', class_path, "#{@file_plural}_helper.rb")
+
+      m.directory 'app'
+      m.directory 'app/views'
+      m.directory "app/views/#{@file_plural}"
+      m.template 'views/_dados_model.html.erb', File.join("app/views/#{@file_plural}", class_path, "_dados_#{file_name}.html.erb")
+      m.template 'views/_dados_busca.html.erb', File.join("app/views/#{@file_plural}", class_path, "_dados_busca.html.erb")
+      m.template 'views/index.html.erb', File.join("app/views/#{@file_plural}", class_path, "index.html.erb")
+      m.template 'views/new.html.erb', File.join("app/views/#{@file_plural}", class_path, "new.html.erb")
+      m.template 'views/edit.html.erb', File.join("app/views/#{@file_plural}", class_path, "edit.html.erb")
+      m.template 'views/show.html.erb', File.join("app/views/#{@file_plural}", class_path, "show.html.erb")
+
+      m.route_resources @file_plural
+
+      unless options[:skip_specs]
+        m.directory 'spec'
+        m.directory 'spec/controllers'
+        m.directory File.join('spec/controllers', class_path)
+        m.template 'controller_spec.rb.erb',  File.join('spec/controllers', class_path, "#{@file_plural}_controller_spec.rb")
+        
+        m.directory 'spec'
+        m.directory 'spec/models'
+        m.directory File.join('spec/models', class_path)
+        m.template 'model_spec.rb.erb',  File.join('spec/models', class_path, "#{file_name}_spec.rb")
+  
+        m.directory 'spec'
+        m.directory 'spec/helpers'
+        m.directory File.join('spec/helpers', class_path)
+        m.template 'helper_spec.rb.erb',  File.join('spec/helpers', class_path, "#{@file_plural}_helper_spec.rb")
+
+        m.directory 'spec/fixtures'
+        m.template 'model:fixtures.yml',  File.join('spec/fixtures', "#{table_name}.yml")
+      end
+
+      unless options[:skip_migrations]
+        m.migration_template(
+          'migration.rb.erb', 'db/migrate',
+          :assigns => {
+            :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}",
+            :attributes     => attributes
+          },
+          :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+        )
+      end
+    end
+  end
+
+  protected
+  def banner
+    "Uso: #{$0} ferret_scaffold NomeModelo [campo:tipo campo:tipo ...] [opções]"
+  end
+
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Opções:'
+    opt.on("--skip-timestamps",
+           "Não adiciona a hora de criação e de alteração no modelo") { |v| options[:skip_timestamps] = v }
+    opt.on("--skip-migration",
+           "Não gera um migration para o modelo") { |v| options[:skip_migration] = v }
+    opt.on("--skip-specs",
+           "Não gera os SPECs para o código gerado") { |v| options[:skip_specs] = v }
+    opt.on('--skip-lock',
+           'Não cria o lock_version na base de dados') { |v| options[:skip_lock] = v }
+  end
+end

data/generators/ferret_scaffold/templates/controller.rb.erb

@@ -0,0 +1,128 @@
+class <%= class_plural %>Controller < ApplicationController
+  # GET /<%= file_plural %>
+  # GET /<%= file_plural %>.xml
+  # GET /<%= file_plural %>.xml?busca=filtro
+  # GET /<%= file_plural %>.xml?atributo=valor
+  #
+  #Quando pede um XML, apresenta ou todos os registros, ou quando for buscado
+  #por um atributo, apresenta apenas os registros que satisfazem aquele atributo.
+  #Também é possível passar o parâmetro "busca", e fazer a busca com Ferret.
+  def index
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  do
+        if(params[:busca])
+          @<%= file_plural %> = <%= class_name %>.find_with_ferret(params[:busca])
+        else
+          conditions = {}
+          <%= class_name %>.column_names.each do |campo|
+            conditions.update(campo => params[campo]) if(params[campo])
+          end
+          @<%= file_plural %> = <%= class_name %>.all :conditions => conditions
+        end
+        render :xml => @<%= file_plural %>
+      end
+    end
+  end
+
+  # GET /<%= file_plural %>/1
+  # GET /<%= file_plural %>/1.xml
+  #
+  #Exibe uma tela com os dados do <%= file_name %>, ou um XML com os dados do <%= file_name %>.
+  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 /<%= file_plural %>/new
+  # GET /<%= file_plural %>/new.xml
+  #
+  #Renderiza uma tela com um formulário de adição de <%= file_plural %>.
+  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 /<%= file_plural %>/1/edit
+  #
+  #Renderiza uma tela de edição para um <%= file_name %>.
+  def edit
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+  end
+
+  # POST /<%= file_plural %>/buscar
+  #
+  #Busca, com o Ferret, os dados dos <%= file_plural %>.
+  def buscar
+    @<%= file_plural %> = <%= class_name %>.find_with_ferret(params[:busca])
+    render :partial => 'dados_busca'
+  end
+
+  # POST /<%= file_plural %>
+  # POST /<%= file_plural %>.xml
+  #
+  #Cria um <%= file_name %>, rodando suas validações e redirecionando para o
+  #registro criado.
+  def create
+    @<%= file_name %> = <%= class_name %>.new(params[:<%= file_name %>])
+
+    respond_to do |format|
+      if @<%= file_name %>.save
+        flash[:notice] = '<%= class_name %> foi criado com sucesso.'
+        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 /<%= file_plural %>/1
+  # PUT /<%= file_plural %>/1.xml
+  #
+  #Atualiza os dados de um <%= file_name %>, rodando suas validações, e redirecionando
+  #para o registro atualizado.
+  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 %> foi atualizado com sucesso.'
+        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 /<%= file_plural %>/1
+  # DELETE /<%= file_plural %>/1.xml
+  #
+  #Deleta um registro.
+  def destroy
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+
+    respond_to do |format|
+      if(@<%= file_name %>.destroy)
+        format.html { redirect_to(<%= file_plural %>_url) }
+        format.xml  { head :ok }
+      else
+        dependents = @<%= file_name %>.errors.collect { |campo, erros| campo }
+        flash[:notice] = "Não foi possível deletar. Há #{dependents.join(' ou ')} cadastrados."
+        format.html { redirect_to(<%= file_plural %>_url) }
+        format.xml  { render :xml => @<%= file_name %>.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+end