vraptor-scaffold 1.1.0 → 1.2.0

data/lib/vraptor-scaffold/version.rb

@@ -1,3 +1,3 @@
 module VraptorScaffold
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/resources/vraptor-scaffold.properties

@@ -1,2 +1,7 @@
+build_tool: mvn
 package: app
 template_engine: jsp
+orm: jpa
+models_package: model
+controllers_package: controller
+repositories_package: repository

data/spec/simple_custom_plugin.rb

@@ -0,0 +1,10 @@
+class SimpleCustomPlugin
+  attr_reader :invoked, :args
+  def initialize(args)
+    @args = args
+  end
+  def invoke_all
+    @invoked = true
+    self
+  end
+end

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'spec/autorun'
 require File.dirname(__FILE__) + '/../lib/vraptor-scaffold'
 
 def build_attributes
-  [Attribute.new("name", "string"), Attribute.new("flag", "boolean")]
+  [Attribute.new("name", "string"), Attribute.new("myFlag", "boolean")]
 end
 
 def mock_config_file
@@ -11,9 +11,8 @@ def mock_config_file
   Configuration.stub!(:config).and_return(file)
 end
 
-def exists_and_identical?(source, destination)
-  File.exists?(destination).should be_true
-  FileUtils.should be_identical(source, destination)
+def exists_and_identical?(source, created)
+  c = File.open(created).read.gsub( /\r/m, "" )
+  c2 = File.open(source).read.gsub( /\r/m, "" )
+  c.should be == c2
 end
-
-

data/spec/vraptor-scaffold/configuration_spec.rb

@@ -30,22 +30,47 @@ describe Configuration do
     Configuration::META_INF.should == "#{Configuration::WEB_APP}/META-INF"
   end
 
-  it "should configure properties name" do
+  it "should configure scaffold properties" 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"}
+      config = {"template_engine" => "jsp", "package" => "br.com.caelum", "orm" => "jpa", "models_package" => "model",
+                "controllers_package" => "controller", "repositories_package" => "repository"}
       YAML.stub!(:load_file).with(Configuration::FILENAME).and_return(config)
     end
 
+    it "should know models package" do
+      Configuration.models_package.should == "model"
+    end
+
+    it "should know controllers package" do
+      Configuration.controllers_package.should == "controller"
+    end
+
+    it "should know repositories package" do
+      Configuration.repositories_package.should == "repository"
+    end
+
+    it "should know full models package" do
+      Configuration.full_models_package.should == "br.com.caelum.model"
+    end
+
     it "should know template engine" do
-      Configuration.template_engine.should == "jsp"  
+      Configuration.template_engine.should == "jsp"
     end
 
     it "should know base package" do
-      Configuration.package.should == "br.com.caelum"  
+      Configuration.package.should == "br.com.caelum"
+    end
+
+    it "should know orm" do
+      Configuration.orm.should == "jpa"
+    end
+
+    it "orm cannot be hibernate" do
+      Configuration.hibernate?.should be_false
     end
 
     it "should build main class path with base package" do
@@ -56,4 +81,63 @@ describe Configuration do
       Configuration.test_class_path("models", "Product.java").should == "src/test/java/br/com/caelum/models/Product.java"
     end
   end
+  context "hibernate" do
+    before(:each) do
+      config = {"template_engine" => "jsp", "package" => "br.com.caelum", "orm" => "hibernate"}
+      YAML.stub!(:load_file).with(Configuration::FILENAME).and_return(config)
+    end
+    it "should know orm" do
+      Configuration.orm.should == "hibernate"
+    end
+
+    it "orm should be hibernate" do
+      Configuration.hibernate?.should be_true
+    end
+  end
+  context "properties without default configs" do
+    before(:each) do
+      config = {}
+      YAML.stub!(:load_file).with(Configuration::FILENAME).and_return(config)
+    end
+
+    it "should know models package" do
+      Configuration.models_package.should == "models"
+    end
+
+    it "should know controllers package" do
+      Configuration.controllers_package.should == "controllers"
+    end
+
+    it "should know repositories package" do
+      Configuration.repositories_package.should == "repositories"
+    end
+
+    it "should know full models package" do
+      Configuration.full_models_package.should == "app.models"
+    end
+
+    it "should know template engine" do
+      Configuration.template_engine.should == "jsp"
+    end
+
+    it "should know base package" do
+      Configuration.package.should == "app"
+    end
+
+    it "should know orm" do
+      Configuration.orm.should == "jpa"
+    end
+
+    it "orm cannot be hibernate" do
+      Configuration.hibernate?.should be_false
+    end
+
+    it "should build main class path with base package" do
+      Configuration.main_class_path("models", "Product.java").should == "src/main/java/app/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/app/models/Product.java"
+    end
+  end
 end

data/spec/vraptor-scaffold/execution_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe VraptorScaffold::Execution do
+
+  before(:each) do
+    @execution = VraptorScaffold::Execution.new
+  end
+
+  context "discover runner for action" do
+    it "should be commands help when no action" do
+      @execution.runner_for(nil).should == VraptorScaffold::Runner::CommandsHelp
+    end
+
+    it "should be app generator when -h action" do
+      @execution.runner_for("-h").should == VraptorScaffold::Runner::Generator
+    end
+
+    it "should be app generator when --help action" do
+      @execution.runner_for("--help").should == VraptorScaffold::Runner::Generator
+    end
+
+    it "should be app generator when new action" do
+      @execution.runner_for("new").should == VraptorScaffold::Runner::Generator
+    end
+
+    it "should be app generator when scaffold action" do
+      @execution.runner_for("scaffold").should == VraptorScaffold::Runner::Scaffold
+    end
+
+    it "should be plugin generator when plugin action" do
+      @execution.runner_for("plugin").should == VraptorScaffold::Runner::Plugin
+    end
+
+    it "should be commands help when scaffold when unknown action" do
+      @execution.runner_for("xpto").should == VraptorScaffold::Runner::CommandsHelp
+    end
+  end
+
+  it "should discover runner and run" do
+    runner = mock(VraptorScaffold::Runner::Generator)
+    runner.stub!(:new).and_return runner
+    runner.should_receive(:run).with(['app'])
+    @execution.stub!(:runner_for).with('new').and_return(runner)
+    @execution.run(['new', 'app'])
+  end
+  
+end

data/spec/vraptor-scaffold/generators/{app_generator → app}/app_generator_spec.rb

@@ -5,7 +5,7 @@ describe AppGenerator do
   context "build new application" do
     before(:all) do
       @project_path = "src/vraptor-scaffold"
-      AppGenerator.new(@project_path, ["-b=mvn"]).invoke_all
+      AppGenerator.new(@project_path, ["-b=mvn", "-r=repository", "-m=domain", "-c=control"]).invoke_all
     end
 
     after(:all) do
@@ -13,7 +13,12 @@ describe AppGenerator do
     end
 
     it "should create directory with project name" do
-      File.exist?(@project_path).should be_true 
+      File.exist?(@project_path).should be_true
+    end
+
+    it "should be invalid when project name already exist" do
+      Kernel.should_receive(:exit)
+      AppGenerator.new(@project_path)
     end
 
     it "should create pom" do
@@ -23,7 +28,7 @@ describe AppGenerator do
     end
 
     it "cannot create ivy.xml" do
-      File.exist?("#{@project_path}/ivy.xml").should be_false  
+      File.exist?("#{@project_path}/ivy.xml").should be_false
     end
 
     it "cannot create build.gradle" do
@@ -34,6 +39,12 @@ describe AppGenerator do
       File.exist?("#{@project_path}/.classpath").should be_false
     end
 
+    it "should configure vraptor-scaffold.properties" do
+      source = File.join File.dirname(__FILE__), "templates", "vraptor-scaffold.properties"
+      destination = "#{@project_path}/#{Configuration::FILENAME}"
+      exists_and_identical?(source, destination)
+    end
+
     context "creating main java" do
       before(:all) do
         @main_java = "#{@project_path}/#{Configuration::MAIN_SRC}"
@@ -41,42 +52,69 @@ describe AppGenerator do
       end
 
       it "should create source folder" do
-        File.exist?(@main_java).should be_true 
+        File.exist?(@main_java).should be_true
       end
 
       it "should create app folder" do
-        File.exist?(@app).should be_true 
+        File.exist?(@app).should be_true
       end
 
       it "should create controllers folder" do
-        File.exist?("#{@app}/controllers").should be_true 
+        File.exist?("#{@app}/control").should be_true
       end
 
       it "should create models folder" do
-        File.exist?("#{@app}/models").should be_true 
+        File.exist?("#{@app}/domain").should be_true
       end
 
       it "should create generic entity" do
         source = File.join File.dirname(__FILE__), "templates", "Entity.java"
-        destination = "#{@app}/models/Entity.java"
+        destination = "#{@app}/domain/Entity.java"
         exists_and_identical?(source, destination)
       end
 
       it "should create generic repository" do
         source =  File.join File.dirname(__FILE__), "templates", "Repository.java"
-        destination = "#{@app}/repositories/Repository.java"
+        destination = "#{@app}/repository/Repository.java"
         exists_and_identical?(source, destination)
       end
     end
 
     context "creating main resources" do
-      before(:all) do
+      before(:each) do
         @main_resources = "#{@project_path}/#{Configuration::MAIN_RESOURCES}"
         @meta_inf = "#{@main_resources}/META-INF"
-      end 
+      end
+
+      context "hibernate orm" do
+        before(:all) do
+          @project_path = "src/vraptor-scaffold-hibernate"
+          @main_resources = "#{@project_path}/#{Configuration::MAIN_RESOURCES}"
+          @meta_inf = "#{@main_resources}/META-INF"
+          AppGenerator.new(@project_path, ["--orm=hibernate"]).invoke_all
+        end
+
+        after(:all) do
+          FileUtils.remove_dir("src/vraptor-scaffold-hibernate")
+        end
+
+        it "should create hibernate.cfg.xml" do
+          source = "#{AppGenerator.source_root}/orm/hibernate.cfg.xml"
+          destination = "#{@main_resources}/hibernate.cfg.xml"
+          exists_and_identical?(source, destination)
+        end
+
+        it "cannot create META-INF" do
+          File.exist?(@meta_inf).should be_false
+        end
+
+        it "cannot create persistence.xml" do
+          File.exist?("#{@meta_inf}/persistence.xml").should be_false
+        end
+      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
@@ -85,18 +123,28 @@ describe AppGenerator do
         exists_and_identical?(source, destination)
       end
 
-      it "should create messages resource" do
+      it "should create messages.properties" do
         source = "#{AppGenerator.source_root}/resources/messages.properties"
         destination = "#{@main_resources}/messages.properties"
         exists_and_identical?(source, destination)
       end
 
+      it "should create hibernate.properties" do
+        source = "#{AppGenerator.source_root}/resources/hibernate.properties"
+        destination = "#{@main_resources}/hibernate.properties"
+        exists_and_identical?(source, destination)
+      end
+
+      it "cannot create hibernate.cfg.xml" do
+        File.exist?("#{@main_resources}/hibernate.cfg.xml").should be_false
+      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 persistence.xml" do
-        source = "#{AppGenerator.source_root}/resources/META-INF/persistence.xml"
+        source = "#{AppGenerator.source_root}/orm/persistence.xml"
         destination = "#{@meta_inf}/persistence.xml"
         exists_and_identical?(source, destination)
       end
@@ -106,10 +154,10 @@ describe AppGenerator do
       before(:all) do
         @webapp = "#{@project_path}/#{Configuration::WEB_APP}"
         @web_inf = "#{@project_path}/#{Configuration::WEB_INF}"
-      end 
+      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
@@ -119,7 +167,7 @@ describe AppGenerator do
       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 scaffold css" do
@@ -141,19 +189,17 @@ describe AppGenerator do
       end
 
       it "should create jquery js" do
-        source = "#{AppGenerator.source_root}/webapp/javascripts/jquery.min.js"
         destination = "#{@webapp}/javascripts/jquery.min.js"
-        exists_and_identical?(source, destination)
+        File.exists?(destination).should be_true
       end
 
       it "should create application js" do
-        source = "#{AppGenerator.source_root}/webapp/javascripts/application.js"
         destination = "#{@webapp}/javascripts/application.js"
-        exists_and_identical?(source, destination)
+        File.exists?(destination).should be_true
       end
 
       it "should create images folder" do
-        File.exist?("#{@webapp}/images").should be_true 
+        File.exist?("#{@webapp}/images").should be_true
       end
     end
 
@@ -165,29 +211,29 @@ describe AppGenerator do
       end
 
       it "should create test source folder" do
-        File.exist?(@test_java).should be_true 
+        File.exist?(@test_java).should be_true
       end
 
       it "should create app folder" do
-        File.exist?(@app).should be_true 
+        File.exist?(@app).should be_true
       end
 
       it "should create controllers folder" do
-        File.exist?("#{@app}/controllers").should be_true 
+        File.exist?("#{@app}/control").should be_true
       end
 
       it "should create models folder" do
-        File.exist?("#{@app}/models").should be_true 
+        File.exist?("#{@app}/domain").should be_true
       end
 
       it "should create respositories folder" do
-        File.exist?("#{@app}/repositories").should be_true 
-      end    
+        File.exist?("#{@app}/repository").should be_true
+      end
 
       it "should create test resource folder" do
-        File.exist?(@test_resource).should be_true 
+        File.exist?(@test_resource).should be_true
       end
-    end    
+    end
   end
 
   context "build app with complex package" do
@@ -204,11 +250,11 @@ describe AppGenerator do
     end
 
     it "should create main path" do
-      File.exist?(@main_java).should be_true  
+      File.exist?(@main_java).should be_true
     end
 
     it "should create test path" do
-      File.exist?(@test_java).should be_true  
+      File.exist?(@test_java).should be_true
     end
 
   end
@@ -237,7 +283,7 @@ describe AppGenerator do
       AppGenerator.new(@project_path).invoke_all
     end
   end
-  
+
   context "configuring ant application" do
 
     before(:all) do
@@ -266,20 +312,14 @@ describe AppGenerator do
       destination = "#{@project_path}/ivy.xml"
       exists_and_identical?(source, destination)
     end
-    
-    it "should create ivysettings.xml" do
-      source = File.join AppGenerator.source_root, "ivysettings.xml"
-      destination = "#{@project_path}/ivysettings.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  
+      File.exist?(ivy).should be_true
     end
 
     it "cannot create pom.xml" do
-      File.exist?("#{@project_path}/pom.xml").should be_false  
+      File.exist?("#{@project_path}/pom.xml").should be_false
     end
 
     it "cannot create build.gradle" do
@@ -300,7 +340,7 @@ describe AppGenerator do
       it "should create .settings" do
         settings = File.join @project_path, ".settings"
         File.exist?(settings).should be_true
-      end      
+      end
     end
   end
 
@@ -318,7 +358,7 @@ describe AppGenerator do
       File.exist?("#{@project_path}/.classpath").should be_false
     end
   end
-  
+
   context "configuring gradle application" do
 
     before(:all) do
@@ -337,11 +377,11 @@ describe AppGenerator do
     end
 
     it "cannot create ivy.xml" do
-      File.exist?("#{@project_path}/ivy.xml").should be_false  
+      File.exist?("#{@project_path}/ivy.xml").should be_false
     end
 
     it "cannot create pom.xml" do
-      File.exist?("#{@project_path}/pom.xml").should be_false  
+      File.exist?("#{@project_path}/pom.xml").should be_false
     end
   end
 
@@ -369,27 +409,69 @@ describe AppGenerator do
     end
   end
 
+  context "valid orm" do
+    it "jpa should be valid" do
+      AppGenerator::ORMS.include?("jpa").should be_true
+    end
+
+    it "hibernate should be valid" do
+      AppGenerator::ORMS.include?("hibernate").should be_true
+    end
+  end
+
   it "should configure banner" do
     AppGenerator.banner.should == "vraptor new PROJECT_PATH [options]"
   end
-  
+
   context "validate options" do
     before(:each) do
       @project_path = "vraptor-scaffold"
     end
 
-    after(:each) do
+    it "should be invalid when build tool is not supported" do
+      Kernel.should_receive(:exit)
+      AppGenerator.new(@project_path, ["-b=maven"])
+    end
+
+    it "should be invalid when template engine is not supported" do
+      Kernel.should_receive(:exit)
+      AppGenerator.new(@project_path, ["-e=velocity"])
+    end
+
+    it "should be invalid when orm mapping is not supported" do
+      Kernel.should_receive(:exit)
+      AppGenerator.new(@project_path, ["-o=toplink"])
+    end
+
+    it "should be invalid when jquery version does not exist" do
+      Kernel.should_receive(:exit)
+      AppGenerator.new(@project_path, ["-j=1.x"])
+    end
+  end
+
+  context "heroku app" do
+    before(:all) do
+      @project_path = "heroku"
+      AppGenerator.new(@project_path, ["--heroku"]).invoke_all
+    end
+
+    after(:all) do
       FileUtils.remove_dir(@project_path)
     end
 
-    it "should be invalid when build tool is not supported" do
-      Kernel.should_receive(:exit) 
-      AppGenerator.new(@project_path, ["-b=maven"]).invoke_all
+    it "should create pom" do
+      source = File.join File.dirname(__FILE__), "templates", "pom-heroku.xml"
+      destination = "#{@project_path}/pom.xml"
+      exists_and_identical?(source, destination)
     end
 
-    it "should be invalid when template engine is not supported" do
-      Kernel.should_receive(:exit) 
-      AppGenerator.new(@project_path, ["-e=velocity"]).invoke_all
+    it "should create Procfile" do
+      File.exist?("#{@project_path}/Procfile").should be_true
+    end
+
+    it "should create main class to run heroku apps" do
+      File.exist?("#{@project_path}/src/main/java/Main.java").should be_true
     end
   end
+
 end