vraptor-scaffold 1.2.3 → 1.3.0.rc

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+== 1.3.0 / 2011-??-??
+
+* New Features
+    * GAE support (vraptor new app --gae).
+    * Customizing templates.
+    * Added start command (vraptor start).
+
 == 1.2.3 / 2011-11-15
 
 * Bugfixes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vraptor-scaffold (1.2.2)
+    vraptor-scaffold (1.3.0)
       activesupport (= 3.0.1)
       rake (= 0.9.2)
       thor (= 0.14.6)

data/README.textile

@@ -44,6 +44,7 @@ h2. Contributors
  * Felipe Fontoura
  * Guilherme Silveira
  * José Guilherme Camara Ribeiro
+ * Laécio Freitas
  * Lucas Cavalcanti
  * Luiz Fernando Signorelli
  * Toshi Kurauchi

data/lib/vraptor-scaffold/execution.rb

@@ -1,12 +1,12 @@
 module VraptorScaffold
 
   class Execution
-    
+
     def run(args)
       action = args.shift
       runner_for(action).new.run(args)
     end
-    
+
     def runner_for(action)
       VraptorScaffold::COMMANDS.fetch(action, Runner::CommandsHelp)
     end
@@ -14,11 +14,12 @@ module VraptorScaffold
   end
 
   COMMANDS = {"--help" => Runner::Generator,
-    "-h" => Runner::Generator,
-    "new" => Runner::Generator,
-    "scaffold" => Runner::Scaffold,
-    "plugin" => Runner::Plugin
-    #"configure" => Runner::Configure
+              "-h" => Runner::Generator,
+              "new" => Runner::Generator,
+              "scaffold" => Runner::Scaffold,
+              "plugin" => Runner::Plugin,
+              "start" => Runner::Start
+              #"configure" => Runner::Configure
   }
-  
+
 end

data/lib/vraptor-scaffold/generators/app/app_generator.rb

@@ -2,7 +2,7 @@ class AppGenerator < VraptorScaffold::Base
 
   TEMPLATE_ENGINES = %w( jsp ftl )
   BUILD_TOOLS = %w( ant mvn gradle )
-  ORMS = %w( jpa hibernate )
+  ORMS = %w( jpa hibernate objectify )
   IVY_JAR = "ivy-2.2.0.jar"
 
   argument :project_path
@@ -22,6 +22,9 @@ class AppGenerator < VraptorScaffold::Base
   class_option :heroku, :type => :boolean, :aliases => "-h",
                :desc => "heroku project"
 
+  class_option :gae, :type => :boolean, :aliases => "-g",
+               :desc => "google app engine project"
+
   class_option :repositories_package, :aliases => "-r", :default => "repositories",
                :desc => "Define repositories package"
 
@@ -72,12 +75,22 @@ class AppGenerator < VraptorScaffold::Base
       template("ivy.erb", "ivy.xml")
       copy_file(IVY_JAR)
     end
+    if options[:gae]
+      copy_file("gae/ivysettings.xml", "ivysettings.xml")
+    end
   end
 
   def configure_gradle
     template("build.gradle.erb", "build.gradle") if build_tool == "gradle"
   end
 
+  def configure_vraptor_packages
+    vraptor_util_package = "br.com.caelum.vraptor.util"
+    @vraptor_packages = []
+    @vraptor_packages += ["#{vraptor_util_package}.#{orm}"] if orm == "jpa" or orm == "hibernate"
+    @vraptor_packages += ["#{vraptor_util_package}.gae"] if options[:gae]
+  end
+
   def create_main_java
     empty_directory Configuration::MAIN_SRC
     @src = File.join(Configuration::MAIN_SRC, options[:package].gsub(".", File::Separator))
@@ -93,13 +106,17 @@ class AppGenerator < VraptorScaffold::Base
   def create_models_directory
     models_folder = File.join @src, options[:models_package]
     empty_directory models_folder
-    template("models/Entity.erb", "#{models_folder}/Entity.java")
+    template("models/Entity.erb", "#{models_folder}/Entity.java") unless options[:gae]
   end
 
   def create_repositories_directory
     repositories_folder = File.join @src, options[:repositories_package]
     empty_directory repositories_folder
-    template("orm/Repository-#{options[:orm]}.java.tt", "#{repositories_folder}/Repository.java")
+    if options[:gae]
+      template("orm/Repository-objectify.java.tt", "#{repositories_folder}/Repository.java")
+    else
+      template("orm/Repository-#{orm}.java.tt", "#{repositories_folder}/Repository.java")
+    end
   end
 
   def create_main_resources
@@ -107,8 +124,12 @@ class AppGenerator < VraptorScaffold::Base
   end
 
   def configure_orm
-    if (options[:orm] == "hibernate")
+    if (orm == "hibernate")
       copy_file("orm/hibernate.cfg.xml", (File.join Configuration::MAIN_RESOURCES, "hibernate.cfg.xml"))
+    elsif orm == "objectify"
+      infra_folder = File.join @src, "infra"
+      empty_directory infra_folder
+      template("gae/ObjectifyFactory.java.tt", "#{@src}/infra/ObjectifyFactory.java")
     else
       metainf = File.join Configuration::MAIN_RESOURCES, 'META-INF'
       empty_directory metainf
@@ -118,6 +139,10 @@ class AppGenerator < VraptorScaffold::Base
 
   def create_webapp
     directory("webapp", Configuration::WEB_APP)
+    if @options[:gae]
+      template("gae/appengine-web.xml.tt", "#{Configuration::WEB_INF}/appengine-web.xml")
+      copy_file("gae/logging.properties", "#{Configuration::WEB_INF}/logging.properties")
+    end
   end
 
   def create_javascripts
@@ -149,13 +174,25 @@ class AppGenerator < VraptorScaffold::Base
   private
   def build_tool
     return "mvn" if options[:heroku]
+    return "ant" if options[:gae]
     options[:build_tool]
   end
 
+  def orm
+    return "objectify" if options[:gae]
+    options[:orm]
+  end
+
   def create_eclipse_files
-    template("eclipse/project.erb", ".project")
-    template("eclipse/classpath.erb", ".classpath")
-    directory("eclipse/settings", ".settings")
+    if options[:gae]
+      template("eclipse/classpath-gae.erb", ".classpath")
+      template("eclipse/project-gae.erb", ".project")
+      directory("eclipse/settings-gae", ".settings")
+    else
+      template("eclipse/classpath.erb", ".classpath")
+      template("eclipse/project.erb", ".project")
+      directory("eclipse/settings", ".settings")
+    end
   end
 
   def validate
@@ -167,8 +204,13 @@ class AppGenerator < VraptorScaffold::Base
       puts "Template engine #{options[:template_engine]} is not supported. The supported template engines are: #{TEMPLATE_ENGINES.join(", ")}"
       Kernel::exit
     end
-    unless ORMS.include? options[:orm]
-      puts "ORM #{options[:orm]} is not supported. The supported object-relational mapping are: #{ORMS.join(", ")}"
+    unless ORMS.include? orm
+      puts "ORM #{orm} is not supported. The supported object-relational mapping are: #{ORMS.join(", ")}"
+      Kernel::exit
+    end
+
+    if options[:heroku] and options[:gae]
+      puts "You cannot create gae and heroku template project together"
       Kernel::exit
     end
 

data/lib/vraptor-scaffold/generators/app/dependency_manager.rb

@@ -9,6 +9,7 @@ class DependencyManager
   def compile_scope
     dependencies = append_freemarker_dependency_if_necessary default_dependencies
     dependencies = append_heroku_dependencies_if_necessary dependencies
+    dependencies = append_gae_dependencies_if_necessary dependencies
     dependencies
   end
 
@@ -27,15 +28,27 @@ class DependencyManager
 
   private
   def default_dependencies
-    hibernate_version = "3.6.7.Final"
-    [Dependency.new("br.com.caelum", "vraptor", "3.4.0"),
-     Dependency.new("org.hsqldb", "hsqldb", "2.2.4"),
-     Dependency.new("opensymphony", "sitemesh", "2.4.2"), Dependency.new("javax.servlet", "jstl", "1.2"),
-     Dependency.new("org.hibernate", "hibernate-entitymanager", hibernate_version),
-     Dependency.new("org.hibernate", "hibernate-c3p0", hibernate_version),
-     Dependency.new("org.hibernate", "hibernate-validator", "4.2.0.Final"),
-     Dependency.new("joda-time", "joda-time", "2.0"),
-     Dependency.new("com.thoughtworks.xstream", "xstream", "1.4.1")]
+    dependencies = []
+    if options[:gae]
+      dependencies += [Dependency.new("br.com.caelum", "vraptor", "3.3.1")]
+    else
+      dependencies += [Dependency.new("br.com.caelum", "vraptor", "3.4.0")]
+    end
+
+    dependencies += [Dependency.new("opensymphony", "sitemesh", "2.4.2"),
+                    Dependency.new("javax.servlet", "jstl", "1.2")]
+
+    unless @options[:gae]
+      hibernate_version = "3.6.7.Final"
+      dependencies += [Dependency.new("org.hsqldb", "hsqldb", "2.2.4"),
+                       Dependency.new("org.hibernate", "hibernate-entitymanager", hibernate_version),
+                       Dependency.new("org.hibernate", "hibernate-c3p0", hibernate_version)]
+    end
+
+    dependencies += [Dependency.new("org.hibernate", "hibernate-validator", "4.2.0.Final"),
+                     Dependency.new("joda-time", "joda-time", "2.0"),
+                     Dependency.new("com.thoughtworks.xstream", "xstream", "1.4.1")]
+    dependencies
   end
 
   def append_heroku_dependencies_if_necessary dependencies
@@ -47,6 +60,22 @@ class DependencyManager
     dependencies
   end
 
+  def append_gae_dependencies_if_necessary dependencies
+    if @options[:gae]
+      appengine_version = "1.6.0"
+      dependencies += [Dependency.new("com.googlecode.objectify", "objectify", "3.1"),
+                       Dependency.new("br.com.caelum", "vraptor-gae", "1.0"),
+                       Dependency.new("commons-fileupload", "commons-fileupload", "1.2.2"),
+                       Dependency.new("com.google.appengine", "appengine-api-1.0-sdk", appengine_version),
+                       Dependency.new("com.google.appengine", "appengine-api-labs", appengine_version),
+                       Dependency.new("com.google.appengine", "appengine-jsr107cache", appengine_version),
+                       Dependency.new("net.sf.jsr107cache", "jsr107cache", "1.1"),
+                       Dependency.new("org.apache.geronimo.specs", "geronimo-jpa_3.0_spec", "1.1.1")]
+    end
+
+    dependencies
+  end
+
   def append_freemarker_dependency_if_necessary dependencies
     dependencies << Dependency.new("org.freemarker", "freemarker", "2.3.18") if @options[:template_engine] == 'ftl'
     dependencies

data/lib/vraptor-scaffold/generators/app/templates/build.xml

@@ -1,146 +1,146 @@
-<project name="vraptor-scaffold" default="war" xmlns:ivy="antlib:org.apache.ivy.ant">
-
-	<property file="build.properties" />
-
-	<!-- paths -->
-	<path id="lib.path.id">
-		<fileset dir="${lib.dir}" />
-		<fileset dir="lib/provided" />
-	</path>
-	<path id="test.path.id">
-		<fileset dir="lib/test" />
-		<path refid="lib.path.id" />
-		<pathelement location="${test.build.dir}" />
-		<pathelement location="${build.dir}" />
-	</path>
-
-	<!-- ================================= 
-          target: resolve              
-         ================================= -->
-	<target name="resolve" description="--> retrieve dependencies with ivy">
-		<path id="ivy.lib.path">
-			<pathelement location="${ivy.jar.file}" />
-		</path>
-		<taskdef resource="org/apache/ivy/ant/antlib.xml" uri="antlib:org.apache.ivy.ant" classpathref="ivy.lib.path" />
-
-		<ivy:retrieve pattern="lib/[conf]/[artifact]-[revision].[ext]" sync="true" />
-		<delete dir="${lib.dir}" includes="**/*.*" />
-		<copy todir="${lib.dir}">
-			<fileset dir="lib/default">
-				<include name="*.jar" />
-			</fileset>
-		</copy>
-	</target>
-
-	<!-- ================================= 
-          target: compile
-         ================================= -->
-	<target name="compile" depends="resolve" description="--> compile">
-		<mkdir dir="${build.dir}" />
-		<delete dir="${build.dir}" includes="**/*.*" />
-		<javac srcdir="${src.dir}" destdir="${build.dir}" classpathref="lib.path.id" debug="on" />
-		<copy todir="${build.dir}">
-			<fileset dir="${resources.dir}">
-				<include name="**/*.*" />
-			</fileset>
-		</copy>
-	</target>
-
-	<!-- ================================= 
-	      target: compile test
-	     ================================= -->
-	<target name="compile-test" depends="compile" description="--> compile test">
-		<mkdir dir="${test.build.dir}" />
-		<delete dir="${test.build.dir}" includes="**/*.*" />
-		<javac srcdir="${test.src.dir}" destdir="${test.build.dir}" classpathref="test.path.id" debug="on" />
-		<copy todir="${test.build.dir}">
-			<fileset dir="${test.resources.dir}">
-				<include name="**/*.*" />
-			</fileset>
-		</copy>
-	</target>
-
-	<!-- ================================= 
-          target: run tests
-         ================================= -->
-	<target name="test" depends="compile-test" description="--> run all tests">
-		<mkdir dir="${output.dir}/test-results" />
-		<junit haltonfailure="yes">
-			<batchtest fork="yes" todir="${output.dir}/test-results">
-				<fileset dir="${test.src.dir}">
-					<include name="**/*Test.java" />
-				</fileset>
-			</batchtest>
-			<formatter type="brief" usefile="false" />
-			<formatter type="xml" />
-			<classpath refid="test.path.id" />
-		</junit>
-	</target>
-
-	<!-- ================================= 
-          target: war
-         ================================= -->
-	<target name="war" description="--> generate war file" depends="test">
-		<war destfile="${output.dir}/${project.name}.war">
-			<zipfileset dir="${webapp.dir}" />
-		</war>
-	</target>
-
-	<!-- ================================= 
-          target: jetty.run              
-         ================================= -->
-	<target name="jetty.run" description="--> run jetty server" depends="compile">
-		<path id="jetty.path.id">
-		    <fileset dir="lib/jetty" />
-		</path>
-		<taskdef classpathref="jetty.path.id" resource="tasks.properties" loaderref="jetty.loader" />
-		<jetty tempDirectory="${output.dir}/jetty-temp">
-            <webApp name="${project.name}" warfile="${webapp.dir}" contextpath="/" scanIntervalSeconds="3">
-                <scanTargets dir="${build.dir}">
-                    <include name="**/*"/>
-                </scanTargets>
-            </webApp>
-		</jetty>
-	</target>
-
-	<!-- ================================= 
-          target: minify              
-         ================================= -->
-	<target name="minify" depends="resolve" description="minify js and css">
-		<property name="yuicompressor.jar" value="lib/minify/yuicompressor-2.3.6.jar" />
-
-		<fileset dir="${js.dir}" includes="*.js" excludes="all.min.js" id="alljs" />
-		<fileset dir="${css.dir}" includes="*.css" excludes="*.min.css" id="allcss" />
-
-		<delete file="${css.dir}/all.css" />
-		<concat destfile="${css.dir}/all.css" fixlastline="true">
-			<fileset refid="allcss" />
-		</concat>
-
-		<java jar="${yuicompressor.jar}" fork="true">
-			<arg value="${css.dir}/all.css" />
-			<arg value="-o" />
-			<arg value="${css.dir}/all.min.css" />
-		</java>
-
-		<delete file="${js.dir}/all.js" />
-		<concat destfile="${js.dir}/all.js" fixlastline="true">
-			<fileset refid="alljs" />
-		</concat>
-
-		<java jar="${yuicompressor.jar}" fork="true">
-			<arg value="${js.dir}/all.js" />
-			<arg value="-o" />
-			<arg value="${js.dir}/all.min.js" />
-		</java>
-	</target>
-
-	<!-- ================================= 
-          target: report              
-         ================================= -->
-	<target name="report" depends="resolve" description="--> generates a report of dependencies">
-		<mkdir dir="${output.dir}/reports" />
-		<ivy:report todir="${output.dir}/reports" />
-	</target>
-
-</project>
+<project name="vraptor-scaffold" default="war" xmlns:ivy="antlib:org.apache.ivy.ant">
+
+	<property file="build.properties" />
+
+	<!-- paths -->
+	<path id="lib.path.id">
+		<fileset dir="${lib.dir}" />
+		<fileset dir="lib/provided" />
+	</path>
+	<path id="test.path.id">
+		<fileset dir="lib/test" />
+		<path refid="lib.path.id" />
+		<pathelement location="${test.build.dir}" />
+		<pathelement location="${build.dir}" />
+	</path>
+
+	<!-- ================================= 
+          target: resolve              
+         ================================= -->
+	<target name="resolve" description="--> retrieve dependencies with ivy">
+		<path id="ivy.lib.path">
+			<pathelement location="${ivy.jar.file}" />
+		</path>
+		<taskdef resource="org/apache/ivy/ant/antlib.xml" uri="antlib:org.apache.ivy.ant" classpathref="ivy.lib.path" />
+
+		<ivy:retrieve pattern="lib/[conf]/[artifact]-[revision].[ext]" sync="true" />
+		<delete dir="${lib.dir}" includes="**/*.*" />
+		<copy todir="${lib.dir}">
+			<fileset dir="lib/default">
+				<include name="*.jar" />
+			</fileset>
+		</copy>
+	</target>
+
+	<!-- ================================= 
+          target: compile
+         ================================= -->
+	<target name="compile" depends="resolve" description="--> compile">
+		<mkdir dir="${build.dir}" />
+		<delete dir="${build.dir}" includes="**/*.*" />
+		<javac srcdir="${src.dir}" destdir="${build.dir}" classpathref="lib.path.id" debug="on" />
+		<copy todir="${build.dir}">
+			<fileset dir="${resources.dir}">
+				<include name="**/*.*" />
+			</fileset>
+		</copy>
+	</target>
+
+	<!-- ================================= 
+	      target: compile test
+	     ================================= -->
+	<target name="compile-test" depends="compile" description="--> compile test">
+		<mkdir dir="${test.build.dir}" />
+		<delete dir="${test.build.dir}" includes="**/*.*" />
+		<javac srcdir="${test.src.dir}" destdir="${test.build.dir}" classpathref="test.path.id" debug="on" />
+		<copy todir="${test.build.dir}">
+			<fileset dir="${test.resources.dir}">
+				<include name="**/*.*" />
+			</fileset>
+		</copy>
+	</target>
+
+	<!-- ================================= 
+          target: run tests
+         ================================= -->
+	<target name="test" depends="compile-test" description="--> run all tests">
+		<mkdir dir="${output.dir}/test-results" />
+		<junit haltonfailure="yes">
+			<batchtest fork="yes" todir="${output.dir}/test-results">
+				<fileset dir="${test.src.dir}">
+					<include name="**/*Test.java" />
+				</fileset>
+			</batchtest>
+			<formatter type="brief" usefile="false" />
+			<formatter type="xml" />
+			<classpath refid="test.path.id" />
+		</junit>
+	</target>
+
+	<!-- ================================= 
+          target: war
+         ================================= -->
+	<target name="war" description="--> generate war file" depends="test">
+		<war destfile="${output.dir}/${project.name}.war">
+			<zipfileset dir="${webapp.dir}" />
+		</war>
+	</target>
+
+	<!-- ================================= 
+          target: jetty.run              
+         ================================= -->
+	<target name="jetty.run" description="--> run jetty server" depends="compile">
+		<path id="jetty.path.id">
+		    <fileset dir="lib/jetty" />
+		</path>
+		<taskdef classpathref="jetty.path.id" resource="tasks.properties" loaderref="jetty.loader" />
+		<jetty tempDirectory="${output.dir}/jetty-temp">
+            <webApp name="${project.name}" warfile="${webapp.dir}" contextpath="/" scanIntervalSeconds="3">
+                <scanTargets dir="${build.dir}">
+                    <include name="**/*"/>
+                </scanTargets>
+            </webApp>
+		</jetty>
+	</target>
+
+	<!-- ================================= 
+          target: minify              
+         ================================= -->
+	<target name="minify" depends="resolve" description="minify js and css">
+		<property name="yuicompressor.jar" value="lib/minify/yuicompressor-2.3.6.jar" />
+
+		<fileset dir="${js.dir}" includes="*.js" excludes="all.min.js" id="alljs" />
+		<fileset dir="${css.dir}" includes="*.css" excludes="*.min.css" id="allcss" />
+
+		<delete file="${css.dir}/all.css" />
+		<concat destfile="${css.dir}/all.css" fixlastline="true">
+			<fileset refid="allcss" />
+		</concat>
+
+		<java jar="${yuicompressor.jar}" fork="true">
+			<arg value="${css.dir}/all.css" />
+			<arg value="-o" />
+			<arg value="${css.dir}/all.min.css" />
+		</java>
+
+		<delete file="${js.dir}/all.js" />
+		<concat destfile="${js.dir}/all.js" fixlastline="true">
+			<fileset refid="alljs" />
+		</concat>
+
+		<java jar="${yuicompressor.jar}" fork="true">
+			<arg value="${js.dir}/all.js" />
+			<arg value="-o" />
+			<arg value="${js.dir}/all.min.js" />
+		</java>
+	</target>
+
+	<!-- ================================= 
+          target: report              
+         ================================= -->
+	<target name="report" depends="resolve" description="--> generates a report of dependencies">
+		<mkdir dir="${output.dir}/reports" />
+		<ivy:report todir="${output.dir}/reports" />
+	</target>
+
+</project>