vraptor-scaffold 0.0.1.rc → 0.0.1

data/lib/generators/scaffold_generator/repository_generator/repository_generator.rb

@@ -1,11 +1,12 @@
 class RepositoryGenerator < BaseScaffold
-  
+
   def self.source_root
-    File.dirname(__FILE__)
+    File.join File.dirname(__FILE__), "templates"
   end
-  
+
   def build
-    template("templates/repository.erb", "src/main/java/app/repositories/#{repository_class_name}.java")
-    template("templates/repository_test.erb", "src/test/java/app/repositories/#{repository_test_class_name}.java")
+    template("repository.erb", Configuration.main_class_path("repositories", "#{repository_interface_name}.java"))
+    template("repository_impl.erb", Configuration.main_class_path("repositories", "#{repository_impl_name}.java"))    
+    template("repository_test.erb", Configuration.test_class_path("repositories", "#{repository_test_class_name}.java"))
   end
 end

data/lib/generators/scaffold_generator/repository_generator/templates/repository.erb

@@ -1,14 +1,22 @@
-package app.repositories;
+package <%= Configuration.package %>.repositories;
 
-import javax.persistence.EntityManager;
+import java.util.List;
 
-import br.com.caelum.vraptor.ioc.Component;
-import app.models.<%= class_name %>;
+import <%= Configuration.package %>.models.<%= class_name %>;
 
-@Component
-public class <%= repository_class_name %> extends Repository<<%= class_name %>> {
+public interface <%= repository_interface_name %> {
+	/*
+	 * Delete the methods you don't want to expose
+	 */
+	 
+	void create(<%= class_name %> entity);
+	
+	void update(<%= class_name %> entity);
+	
+	void destroy(<%= class_name %> entity);
+	
+	<%= class_name %> find(Long id);
+	
+	List<<%= class_name %>> findAll();
 
-	public <%= repository_class_name %>(EntityManager entityManager) {
-		super(entityManager);
-	}
 }

data/lib/generators/scaffold_generator/repository_generator/templates/repository_impl.erb

@@ -0,0 +1,16 @@
+package <%= Configuration.package %>.repositories;
+
+import javax.persistence.EntityManager;
+
+import br.com.caelum.vraptor.ioc.Component;
+import <%= Configuration.package %>.models.<%= class_name %>;
+
+@Component
+public class <%= repository_impl_name %> 
+    extends Repository<<%= class_name %>, Long>
+    implements <%= repository_interface_name %> {
+
+	public <%= repository_impl_name %>(EntityManager entityManager) {
+		super(entityManager);
+	}
+}

data/lib/generators/scaffold_generator/repository_generator/templates/repository_test.erb

@@ -1,4 +1,4 @@
-package app.repositories;
+package <%= Configuration.package %>.repositories;
 
 import static org.junit.Assert.assertNotNull;
 
@@ -7,7 +7,7 @@ import org.junit.Test;
 public class <%= repository_test_class_name %> {
 
     @Test public void fakeTest() {
-  		assertNotNull("put something real.", new <%= repository_class_name %>(null));
+  		assertNotNull("put something real.", new <%= repository_impl_name %>(null));
   	}
 }
 

data/lib/generators/scaffold_generator/scaffold_generator.rb

@@ -1,42 +1,35 @@
-class ScaffoldGenerator
-  
-  attr_accessor :attributes, :model
-  
+class ScaffoldGenerator < VraptorScaffold::Base
+
+  attr_accessor :generated_attributes
+  argument :model
+  argument :attributes, :type => :hash, :default => {}, :banner => "field:type field:type" 
+
+  def self.banner
+    "vraptor scaffold #{self.arguments.map(&:usage).join(' ')}"
+  end
+
   def initialize(args)
-  	@model = args.shift.downcase 
-    @attributes = []
-    validate_scaffold_command(args)
+    super(args)
+    @generated_attributes = []
+    attributes.each { |field, type| 
+      @generated_attributes << Attribute.new(field, type)
+    }
+  end
+
+  def controller_generator
+    ControllerGenerator.new(model, @generated_attributes).build
+  end
+
+  def model_generator
+    ModelGenerator.new(model, @generated_attributes).build
+  end
+
+  def repository_generator
+    RepositoryGenerator.new(model, @generated_attributes).build
   end
-  
-  def build
-  	ModelGenerator.new(model, attributes).build
-  	RepositoryGenerator.new(model, attributes).build
-  	ControllerGenerator.new(model, attributes).build
-  	FreemarkerGenerator.new(model, attributes).build
+
+  def template_engine_generator
+    templates = {"jsp" => JspGenerator, "ftl" => FreemarkerGenerator}
+    templates[Configuration.template_engine].new(model, @generated_attributes).build
   end
-  
-  private 
-    def validate_scaffold_command(args)
-      unless File.exist?("pom.xml")
-        puts "To run scaffold please go to the project root folder."
-        Kernel::exit
-      end
-      validate_attributes(args)
-    end
-  
-    def validate_attributes(args)
-      args.each do |arg|
-        parsedAttribute = arg.split(":")
-        parse_attribute(parsedAttribute)
-      end
-    end
-    
-    def parse_attribute(parsedAttribute) 
-      type = parsedAttribute.last.downcase 
-      unless Attribute.valid_types.include?(type)
-        puts "Attribute #{type} is not supported. The supported attributes types are: #{Attribute.valid_types.join(" ")}"
-        Kernel::exit
-      end
-      @attributes << Attribute.new(parsedAttribute.first, type)
-    end
 end

data/lib/load_paths.rb

@@ -3,8 +3,13 @@ require 'rubygems'
 require 'thor/actions'
 require 'thor/group'
 require 'active_support/inflector'
+require 'yaml'
 
+require File.dirname(__FILE__) + '/configuration'
 require File.dirname(__FILE__) + '/../lib/generators/base'
+require File.dirname(__FILE__) + '/../lib/generators/app_generator/app_generator'
+require File.dirname(__FILE__) + '/../lib/generators/app_generator/freemarker_template_engine'
+require File.dirname(__FILE__) + '/../lib/generators/app_generator/jsp_template_engine'
 require File.dirname(__FILE__) + '/../lib/generators/scaffold_generator/attribute'
 require File.dirname(__FILE__) + '/../lib/generators/scaffold_generator/scaffold_generator'
 require File.dirname(__FILE__) + '/../lib/generators/scaffold_generator/base_scaffold'
@@ -12,5 +17,4 @@ require File.dirname(__FILE__) + '/../lib/generators/scaffold_generator/model_ge
 require File.dirname(__FILE__) + '/../lib/generators/scaffold_generator/repository_generator/repository_generator'
 require File.dirname(__FILE__) + '/../lib/generators/scaffold_generator/controller_generator/controller_generator'
 require File.dirname(__FILE__) + '/../lib/generators/scaffold_generator/freemarker_generator/freemarker_generator'
-require File.dirname(__FILE__) + '/../lib/generators/app_generator/app_generator'
-
+require File.dirname(__FILE__) + '/../lib/generators/scaffold_generator/jsp_generator/jsp_generator'

data/lib/vraptor-scaffold.rb

@@ -2,11 +2,35 @@ require File.dirname(__FILE__) + '/load_paths'
 
 module VraptorScaffold
   class Main
-	def self.execute(args)
-		 action = args.shift
-	    AppGenerator.new.build(args[0]) if action == "new"
-	    ScaffoldGenerator.new(args).build if action == "scaffold"
-	    exec("mvn compile war:inplace jetty:run") if action == "start"
+
+    def self.execute(args)
+      action = args.shift
+      print_help(AppGenerator) if help? action
+      run_app_generator(args.shift, args) if action == "new"
+      run_scaffold_generator(args) if action == "scaffold"
+    end
+
+    def self.run_app_generator(project_path, args)
+      print_help(AppGenerator) if help? project_path
+      AppGenerator.new(project_path, args).invoke_all
+    end
+
+    def self.run_scaffold_generator(args)
+      print_help(ScaffoldGenerator) if help? args.first
+      unless File.exist?("src")
+        puts "To run vraptor scaffold please go to the project root folder."
+        Kernel::exit
+      end
+      ScaffoldGenerator.new(args).invoke_all 
+    end
+
+    def self.print_help(generator)
+      generator.start(["-h"])
+      Kernel::exit
     end
+
+    def self.help?(command)
+      [nil, "-h", "--help"].include?(command)
+    end    
   end
 end

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Configuration do
+
+  it "should configure main source" do
+    Configuration::MAIN_SRC.should == "src/main/java"
+  end
+
+  it "should configure main resources" do
+    Configuration::MAIN_RESOURCES.should == "src/main/resources"
+  end
+
+  it "should configure test source" do
+    Configuration::TEST_SRC.should == "src/test/java"
+  end
+
+  it "should configure test resources" do
+    Configuration::TEST_RESOURCES.should == "src/test/resources"
+  end
+
+  it "should configure webapp" do
+    Configuration::WEB_APP.should == "src/main/webapp"
+  end
+
+  it "should configure web-inf" do
+    Configuration::WEB_INF.should == "#{Configuration::WEB_APP}/WEB-INF"
+  end
+
+  it "should configure meta-inf" do
+    Configuration::META_INF.should == "#{Configuration::WEB_APP}/META-INF"
+  end
+
+  it "should configure properties name" do
+    Configuration::FILENAME.should == "#{Configuration::META_INF}/vraptor-scaffold.properties"
+  end
+
+  context "load config file" do
+    before(:each) do
+      config = {"template_engine" => "jsp", "package" => "br.com.caelum"}
+      YAML.stub!(:load_file).with(Configuration::FILENAME).and_return(config)
+    end
+
+    it "should know template engine" do
+      Configuration.template_engine.should == "jsp"  
+    end
+
+    it "should know base package" do
+      Configuration.package.should == "br.com.caelum"  
+    end
+
+    it "should build main class path with base package" do
+      Configuration.main_class_path("models", "Product.java").should == "src/main/java/br/com/caelum/models/Product.java"
+    end
+
+    it "should build test class path with base package" do
+      Configuration.test_class_path("models", "Product.java").should == "src/test/java/br/com/caelum/models/Product.java"
+    end
+
+  end
+end

data/spec/lib/generators/app_generator/app_generator_spec.rb

@@ -1,199 +1,320 @@
 require File.expand_path(File.dirname(__FILE__) + "/../../../spec_helper")
 
 describe AppGenerator do
-  
-  before(:all) do
-    @project_path = "src/vraptor-scaffold"
-    AppGenerator.new.build(@project_path)
-  end
-  
-  after(:all) do
-    FileUtils.remove_dir("src")
-  end
-   
+
   context "build new application" do
+    before(:all) do
+      @project_path = "src/vraptor-scaffold"
+      AppGenerator.new(@project_path, ["-b=mvn"]).invoke_all
+    end
+
+    after(:all) do
+      FileUtils.remove_dir("src")
+    end
+
     it "should create directory with project name" do
       File.exist?(@project_path).should be_true 
     end
-    
+
     it "should create pom" do
-      from = File.expand_path(File.dirname(__FILE__) + "/templates/pom.xml")
-      to = "#{@project_path}/pom.xml"
-      FileUtils.compare_file(from, to).should be_true
+      source =  File.join File.dirname(__FILE__), "templates", "pom.xml"
+      destination = "#{@project_path}/pom.xml"
+      exists_and_identical?(source, destination)
+    end
+
+    it "cannot create ivy.xml" do
+      File.exist?("#{@project_path}/ivy.xml").should be_false  
     end
     
+    it "cannot create eclipse wtp" do
+      File.exist?("#{@project_path}/.classpath").should be_false
+    end
+
     context "creating main java" do
       before(:all) do
-        @main_java = "#{@project_path}/src/main/java"
+        @main_java = "#{@project_path}/#{Configuration::MAIN_SRC}"
         @app = "#{@main_java}/app"
       end
-       
+
       it "should create source folder" do
         File.exist?(@main_java).should be_true 
       end
-      
+
       it "should create app folder" do
         File.exist?(@app).should be_true 
       end
-      
+
       it "should create controllers folder" do
         File.exist?("#{@app}/controllers").should be_true 
       end
-      
+
       it "should create models folder" do
         File.exist?("#{@app}/models").should be_true 
       end
-      
+
       it "should create generic entity" do
-        from = "#{AppGenerator.source_root}/templates/Entity.java"
-        to = "#{@app}/models/Entity.java"
-        FileUtils.compare_file(from, to).should be_true
+        source = File.join File.dirname(__FILE__), "templates", "Entity.java"
+        destination = "#{@app}/models/Entity.java"
+        exists_and_identical?(source, destination)
       end
-      
-      it "should create infrastructure folder" do
-        File.exist?("#{@app}/infrastructure").should be_true 
-      end
-      
-      it "should create path resolver" do
-        from = "#{AppGenerator.source_root}/templates/FreemarkerPathResolver.java"
-        to = "#{@app}/infrastructure/FreemarkerPathResolver.java"
-        FileUtils.compare_file(from, to).should be_true
-      end
-      
-       it "should create generic repository" do
-        from = "#{AppGenerator.source_root}/templates/Repository.java"
-        to = "#{@app}/repositories/Repository.java"
-        FileUtils.compare_file(from, to).should be_true
+
+      it "should create generic repository" do
+        source =  File.join File.dirname(__FILE__), "templates", "Repository.java"
+        destination = "#{@app}/repositories/Repository.java"
+        exists_and_identical?(source, destination)
       end
     end
-    
+
     context "creating main resources" do
       before(:all) do
-        @main_resources = "#{@project_path}/src/main/resources"
+        @main_resources = "#{@project_path}/#{Configuration::MAIN_RESOURCES}"
         @meta_inf = "#{@main_resources}/META-INF"
       end 
-      
+
       it "should create resource folder" do
-         File.exist?(@main_resources).should be_true 
+        File.exist?(@main_resources).should be_true 
       end
-      
+
       it "should create log4j" do
-        from = "#{AppGenerator.source_root}/templates/log4j.properties"
-        to = "#{@main_resources}/log4j.properties"
-        FileUtils.compare_file(from, to).should be_true
+        source = "#{AppGenerator.source_root}/resources/log4j.properties"
+        destination = "#{@main_resources}/log4j.properties"
+        exists_and_identical?(source, destination)
       end
-      
+
       it "should create messages resource" do
-        from = "#{AppGenerator.source_root}/templates/messages.properties"
-        to = "#{@main_resources}/messages.properties"
-        FileUtils.compare_file(from, to).should be_true
+        source = "#{AppGenerator.source_root}/resources/messages.properties"
+        destination = "#{@main_resources}/messages.properties"
+        exists_and_identical?(source, destination)
       end
-      
+
       it "should create META-INF" do
-         File.exist?(@meta_inf).should be_true 
+        File.exist?(@meta_inf).should be_true 
       end
-      
-       it "should create log4j" do
-        from = "#{AppGenerator.source_root}/templates/persistence.xml"
-        to = "#{@meta_inf}/persistence.xml"
-        FileUtils.compare_file(from, to).should be_true
+
+      it "should create persistence.xml" do
+        source = "#{AppGenerator.source_root}/resources/META-INF/persistence.xml"
+        destination = "#{@meta_inf}/persistence.xml"
+        exists_and_identical?(source, destination)
       end
-    end 
+    end
+
     context "creating webapp" do
       before(:all) do
-        @webapp = "#{@project_path}/src/main/webapp"
-        @web_inf = "#{@webapp}/WEB-INF"
-        @decorators = "#{@webapp}/decorators"
+        @webapp = "#{@project_path}/#{Configuration::WEB_APP}"
+        @web_inf = "#{@project_path}/#{Configuration::WEB_INF}"
       end 
-      
+
       it "should create webapp folder" do
-         File.exist?(@webapp).should be_true 
+        File.exist?(@webapp).should be_true 
       end
-      
+
       it "should create index" do
-        from = "#{AppGenerator.source_root}/templates/index.jsp"
-        to = "#{@webapp}/index.jsp"
-        FileUtils.compare_file(from, to).should be_true
-      end
-      
-      it "should create decorators folder" do
-         File.exist?(@decorators).should be_true 
-      end
-      
-      it "should create decorator file" do
-        from = "#{AppGenerator.source_root}/templates/main.ftl"
-        to = "#{@decorators}/main.ftl"
-        FileUtils.compare_file(from, to).should be_true
+        source = "#{AppGenerator.source_root}/webapp/index.jsp"
+        destination = "#{@webapp}/index.jsp"
+        exists_and_identical?(source, destination)
       end
-      
-      it "should create html macro file" do
-        from = "#{AppGenerator.source_root}/templates/macros/html.ftl"
-        to = "#{@webapp}/macros/html.ftl"
-        FileUtils.compare_file(from, to).should be_true
-      end
-      
+
       it "should create WEB-INF folder" do
-         File.exist?(@web_inf).should be_true 
+        File.exist?(@web_inf).should be_true 
       end
-      
-      it "should create decorators.xml" do
-        from = "#{AppGenerator.source_root}/templates/decorators.xml"
-        to = "#{@web_inf}/decorators.xml"
-        FileUtils.compare_file(from, to).should be_true
-      end
-      
+
       it "should create web.xml" do
-        from = "#{AppGenerator.source_root}/templates/web.xml"
-        to = "#{@web_inf}/web.xml"
-        FileUtils.compare_file(from, to).should be_true
+        source = "#{AppGenerator.source_root}/webapp/WEB-INF/web.xml"
+        destination = "#{@web_inf}/web.xml"
+        exists_and_identical?(source, destination)
       end
-      
-      it "should create views folder" do
-         File.exist?("#{@web_inf}/views").should be_true 
-      end
-      
+
       it "should create scaffold css" do
-        from = "#{AppGenerator.source_root}/templates/stylesheets/scaffold.css"
-        to = "#{@webapp}/stylesheets/scaffold.css"
-        FileUtils.compare_file(from, to).should be_true
+        source = "#{AppGenerator.source_root}/webapp/stylesheets/scaffold.css"
+        destination = "#{@webapp}/stylesheets/scaffold.css"
+        exists_and_identical?(source, destination)
       end
-      
+
       it "should create jquery js" do
-        from = "#{AppGenerator.source_root}/templates/javascripts/jquery-1.4.2.min.js"
-        to = "#{@webapp}/javascripts/jquery-1.4.2.min.js"
-        FileUtils.compare_file(from, to).should be_true
+        source = "#{AppGenerator.source_root}/webapp/javascripts/jquery-1.4.2.min.js"
+        destination = "#{@webapp}/javascripts/jquery-1.4.2.min.js"
+        exists_and_identical?(source, destination)
       end
-      
+
       it "should create images folder" do
-         File.exist?("#{@webapp}/images").should be_true 
+        File.exist?("#{@webapp}/images").should be_true 
       end
     end
+
     context "creating test" do
       before(:all) do
-        @test_java = "#{@project_path}/src/test/java"
-        @test_resource = "#{@project_path}/src/test/java"
+        @test_java = "#{@project_path}/#{Configuration::TEST_SRC}"
+        @test_resource = "#{@project_path}/#{Configuration::TEST_RESOURCES}"
         @app = "#{@test_java}/app"
       end
-      
+
       it "should create test source folder" do
         File.exist?(@test_java).should be_true 
       end
-      
+
       it "should create app folder" do
         File.exist?(@app).should be_true 
       end
-      
+
       it "should create controllers folder" do
         File.exist?("#{@app}/controllers").should be_true 
       end
-      
+
       it "should create models folder" do
         File.exist?("#{@app}/models").should be_true 
       end
-      
+
+      it "should create respositories folder" do
+        File.exist?("#{@app}/repositories").should be_true 
+      end    
+
       it "should create test resource folder" do
         File.exist?(@test_resource).should be_true 
       end
     end    
   end
+
+  context "build app with complex package" do
+
+    before(:all) do
+      @project_path = "src/vraptor-scaffold"
+      AppGenerator.new(@project_path, ["-p=br.com.caelum"]).invoke_all
+      @main_java = "#{@project_path}/#{Configuration::MAIN_SRC}/br/com/caelum"
+      @test_java = "#{@project_path}/#{Configuration::TEST_SRC}/br/com/caelum"
+    end
+
+    after(:all) do
+      FileUtils.remove_dir("src")
+    end
+
+    it "should create main path" do
+      File.exist?(@main_java).should be_true  
+    end
+
+    it "should create test path" do
+      File.exist?(@test_java).should be_true  
+    end
+
+  end
+
+  context "configuring template engine" do
+
+    before(:each) do
+      @project_path = "src/vraptor-scaffold"
+    end
+
+    after(:each) do
+      FileUtils.remove_dir("src")
+    end
+
+    it "should configure freemarker template engine" do
+      template = mock(FreemarkerTemplateEngine)
+      FreemarkerTemplateEngine.stub!(:new).with(@project_path).and_return(template)
+      template.should_receive(:configure)
+      AppGenerator.new(@project_path, ["--template-engine=ftl"]).invoke_all
+    end
+
+    it "should configure jsp template engine" do
+      template = mock(JspTemplateEngine)
+      JspTemplateEngine.stub!(:new).with(@project_path).and_return(template)
+      template.should_receive(:configure)
+      AppGenerator.new(@project_path).invoke_all
+    end
+  end
+
+  context "configuring ant application" do
+
+    before(:all) do
+      @project_path = "vraptor-scaffold"
+      AppGenerator.new(@project_path, ["-b=ant"]).invoke_all
+    end
+
+    after(:all) do
+      FileUtils.remove_dir(@project_path)
+    end
+
+    it "should create build.xml" do
+      source = File.join AppGenerator.source_root, "build.xml"
+      destination = "#{@project_path}/build.xml"
+      exists_and_identical?(source, destination)
+    end
+
+    it "should create build.properties" do
+      source =  File.join File.dirname(__FILE__), "templates", "build.properties"
+      destination = "#{@project_path}/build.properties"
+      exists_and_identical?(source, destination)
+    end
+
+    it "should create ivy.xml" do
+      source =  File.join File.dirname(__FILE__), "templates", "ivy.xml"
+      destination = "#{@project_path}/ivy.xml"
+      exists_and_identical?(source, destination)
+    end
+
+    it "should copy ivy.jar" do
+      ivy = File.join @project_path, AppGenerator::IVY_JAR
+      File.exist?(ivy).should be_true  
+    end
+
+    it "cannot create pom.xml" do
+      File.exist?("#{@project_path}/pom.xml").should be_false  
+    end
+
+    context "eclipse wtp configuration" do
+      it "should create .project" do
+        project = File.join @project_path, ".project"
+        File.exist?(project).should be_true
+      end
+      
+      it "should create .classpath" do
+        class_path = File.join @project_path, ".classpath"
+        File.exist?(class_path).should be_true
+      end
+      
+      it "should create .settings" do
+        settings = File.join @project_path, ".settings"
+        File.exist?(settings).should be_true
+      end      
+    end
+  end
+
+  context "skip eclipse configuration files" do
+    before(:all) do
+      @project_path = "vraptor-scaffold"
+      AppGenerator.new(@project_path, ["--skip-eclipse"]).invoke_all
+    end
+
+    after(:all) do
+      FileUtils.remove_dir(@project_path)
+    end
+
+    it "cannot create .classpath file" do
+      File.exist?("#{@project_path}/.classpath").should be_false
+    end
+  end
+
+  context "valid template engines" do
+    it "jsp should be valid" do
+      AppGenerator::TEMPLATE_ENGINES.include?("jsp").should be_true
+    end
+
+    it "freemarker should be valid" do
+      AppGenerator::TEMPLATE_ENGINES.include?("ftl").should be_true
+    end
+  end
+
+  context "valid build tools" do
+    it "ant should be valid" do
+      AppGenerator::BUILD_TOOLS.include?("ant").should be_true
+    end
+
+    it "maven should be valid" do
+      AppGenerator::BUILD_TOOLS.include?("mvn").should be_true
+    end
+  end
+
+  it "should configure banner" do
+    AppGenerator.banner.should == "vraptor new PROJECT_PATH [options]"
+  end
+
 end