vraptor-scaffold 1.1.0 → 1.2.0

data/lib/vraptor-scaffold/configuration.rb

@@ -9,15 +9,39 @@ class Configuration
   FILENAME = "#{META_INF}/vraptor-scaffold.properties"
 
   def self.config
-    YAML.load_file Configuration::FILENAME
+    YAML.load_file FILENAME
   end
 
   def self.template_engine
-    config["template_engine"]
+    config["template_engine"] ? config["template_engine"] : 'jsp'
   end
 
   def self.package
-    config["package"]
+    config["package"] ? config["package"] : 'app'
+  end
+
+  def self.models_package
+    config["models_package"] ? config["models_package"] : 'models'
+  end
+
+  def self.controllers_package
+    config["controllers_package"] ? config["controllers_package"] : 'controllers'
+  end
+
+  def self.repositories_package
+    config["repositories_package"] ? config["repositories_package"] : 'repositories'
+  end
+
+  def self.full_models_package
+    "#{package}.#{models_package}"
+  end
+
+  def self.orm
+    config["orm"] ? config["orm"] : 'jpa'
+  end
+
+  def self.hibernate?
+    orm.eql? "hibernate"
   end
 
   def self.main_class_path *path
@@ -27,5 +51,4 @@ class Configuration
   def self.test_class_path *path
     File.join TEST_SRC, package.gsub(".", File::Separator), path
   end
-
 end

data/lib/vraptor-scaffold/execution.rb

@@ -0,0 +1,24 @@
+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
+
+  end
+
+  COMMANDS = {"--help" => Runner::Generator,
+    "-h" => Runner::Generator,
+    "new" => Runner::Generator,
+    "scaffold" => Runner::Scaffold,
+    "plugin" => Runner::Plugin
+    #"configure" => Runner::Configure
+  }
+  
+end

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

@@ -0,0 +1,196 @@
+class AppGenerator < VraptorScaffold::Base
+
+  TEMPLATE_ENGINES = %w( jsp ftl )
+  BUILD_TOOLS = %w( ant mvn gradle )
+  ORMS = %w( jpa hibernate )
+  IVY_JAR = "ivy-2.2.0.jar"
+
+  argument :project_path
+
+  class_option :template_engine, :default => "jsp", :aliases => "-e",
+               :desc => "Template engine (options: #{TEMPLATE_ENGINES.join(', ')})"
+
+  class_option :package, :default => "app", :aliases => "-p",
+               :desc => "Define base package"
+
+  class_option :models_package, :aliases => "-m", :default => "models",
+               :desc => "Define models package"
+
+  class_option :controllers_package, :aliases => "-c", :default => "controllers",
+               :desc => "Define controllers package"
+
+  class_option :heroku, :type => :boolean, :aliases => "-h",
+               :desc => "heroku project"
+
+  class_option :repositories_package, :aliases => "-r", :default => "repositories",
+               :desc => "Define repositories package"
+
+  class_option :build_tool, :default => "ant", :aliases => "-b",
+               :desc => "Build tools (options: #{BUILD_TOOLS.join(', ')})"
+
+  class_option :orm, :default => "jpa", :aliases => "-o",
+               :desc => "Object-relational mapping (options: #{ORMS.join(', ')})"
+
+  class_option :jquery, :aliases => "-j", :default => "latest version",
+               :desc => "jQuery version"
+
+  class_option :skip_eclipse, :type => :boolean, :aliases => "-E",
+               :desc => "Skip Eclipse files"
+
+  def self.source_root
+    File.join File.dirname(__FILE__), "templates"
+  end
+
+  def self.banner
+    "vraptor new #{self.arguments.map(&:usage).join(' ')} [options]"
+  end
+
+  def initialize(args, opts=[])
+    super([args], opts)
+    validate
+    self.destination_root=(project_path)
+    @project_name = project_path.split("/").last
+    @dependency_manager = DependencyManager.new(options)
+  end
+
+  def create_root_folder
+    empty_directory "."
+    if @options[:heroku]
+      copy_file("heroku/Procfile", "Procfile")
+    end
+  end
+
+  def configure_maven
+    template("pom.erb", "pom.xml") if build_tool == "mvn"
+  end
+
+  def configure_ant
+    if build_tool == "ant"
+      create_eclipse_files unless options[:skip_eclipse]
+      copy_file("build.xml")
+      template("build.properties.erb", "build.properties") 
+      template("ivy.erb", "ivy.xml")
+      copy_file(IVY_JAR)
+    end
+  end
+
+  def configure_gradle
+    template("build.gradle.erb", "build.gradle") if build_tool == "gradle"
+  end
+
+  def create_main_java
+    empty_directory Configuration::MAIN_SRC
+    @src = File.join(Configuration::MAIN_SRC, options[:package].gsub(".", File::Separator))
+    if @options[:heroku]
+      copy_file("heroku/Main.java", "#{Configuration::MAIN_SRC}/Main.java")
+    end
+  end
+
+  def create_controllers_directory
+    empty_directory File.join @src, options[:controllers_package]
+  end
+
+  def create_models_directory
+    models_folder = File.join @src, options[:models_package]
+    empty_directory models_folder
+    template("models/Entity.erb", "#{models_folder}/Entity.java")
+  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")
+  end
+
+  def create_main_resources
+    directory("resources", Configuration::MAIN_RESOURCES)
+  end
+
+  def configure_orm
+    if (options[:orm] == "hibernate")
+      copy_file("orm/hibernate.cfg.xml", (File.join Configuration::MAIN_RESOURCES, "hibernate.cfg.xml"))
+    else
+      metainf = File.join Configuration::MAIN_RESOURCES, 'META-INF'
+      empty_directory metainf
+      copy_file("orm/persistence.xml", (File.join metainf, "persistence.xml"))
+    end
+  end
+
+  def create_webapp
+    directory("webapp", Configuration::WEB_APP)
+  end
+
+  def create_javascripts
+    javascripts = File.join Configuration::WEB_APP, "javascripts"
+    create_file File.join javascripts, "application.js"
+    get jquery_url, (File.join javascripts, "jquery.min.js")
+  end
+
+  def configure_scaffold_properties
+    template("vraptor-scaffold.erb", Configuration::FILENAME)
+  end
+
+  def configure_template_engine
+    templates = {"jsp" => JspTemplateEngine, "ftl" => FreemarkerTemplateEngine}
+    templates[options[:template_engine]].new(project_path).configure if templates[options[:template_engine]]
+  end
+
+  def create_test
+    empty_directory Configuration::TEST_SRC
+    test_src = File.join(Configuration::TEST_SRC, options[:package].gsub(".", File::Separator))
+
+    empty_directory File.join test_src, options[:controllers_package]
+    empty_directory File.join test_src, options[:models_package]
+    empty_directory File.join test_src, options[:repositories_package]
+    
+    directory("resources-test", Configuration::TEST_RESOURCES)
+  end
+
+  private
+  def build_tool
+    return "mvn" if options[:heroku]
+    options[:build_tool]
+  end
+
+  def jquery_url
+    jquery_version = "1" #this mean get latest version
+    jquery_version = options[:jquery] if options[:jquery] != 'latest version'
+    "http://ajax.googleapis.com/ajax/libs/jquery/#{jquery_version}/jquery.min.js"
+  end
+
+  def create_eclipse_files
+    template("eclipse/project.erb", ".project")
+    template("eclipse/classpath.erb", ".classpath")
+    directory("eclipse/settings", ".settings")
+  end
+
+  def validate
+    unless BUILD_TOOLS.include? options[:build_tool]
+      puts "Build tool #{options[:build_tool]} is not supported. The supported build tools are: #{BUILD_TOOLS.join(", ")}"
+      Kernel::exit
+    end
+    unless TEMPLATE_ENGINES.include? options[:template_engine]
+      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(", ")}"
+      Kernel::exit
+    end
+
+    if File.directory? project_path
+      puts "The project #{project_path} already exist"
+      Kernel::exit
+    end
+
+    require 'open-uri'
+    begin
+      Kernel::open(jquery_url)
+    rescue OpenURI::HTTPError => e
+      download_url = "http://docs.jquery.com/Downloading_jQuery"
+      puts "jQuery version #{options[:jquery]} was not found. Please visit the download page to see the versions available #{download_url}."
+      Kernel::exit
+    end
+
+  end
+end

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

@@ -0,0 +1,53 @@
+class DependencyManager
+
+  attr_accessor :options
+
+  def initialize(options)
+    @options = options
+  end
+
+  def compile_scope
+    dependencies = append_freemarker_dependency_if_necessary default_dependencies
+    dependencies = append_heroku_dependencies_if_necessary dependencies
+    dependencies
+  end
+
+  def test_scope
+    [Dependency.new("junit", "junit", "4.8.2"),
+     Dependency.new("org.hamcrest", "hamcrest-all", "1.1"),
+     Dependency.new("org.mockito", "mockito-all", "1.8.5")]
+  end
+
+  def provided_scope
+    if @options[:heroku]
+      return []
+    end
+    [Dependency.new("javax.servlet", "servlet-api", "2.5"), Dependency.new("javax.servlet.jsp", "jsp-api", "2.1")]
+  end
+
+  private
+  def default_dependencies
+    hibernate_version = "3.6.7.Final"
+    [Dependency.new("br.com.caelum", "vraptor", "3.3.1"),
+     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")]
+  end
+
+  def append_heroku_dependencies_if_necessary dependencies
+    if @options[:heroku]
+      dependencies += [Dependency.new("org.eclipse.jetty", "jetty-webapp", "7.4.4.v20110707"),
+                       Dependency.new("org.mortbay.jetty", "jsp-2.1-glassfish", "2.1.v20100127"),
+                       Dependency.new("javax.servlet", "servlet-api", "2.5")]
+    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
+  end
+end

data/lib/vraptor-scaffold/generators/{app_generator → app}/templates/build.gradle.erb

@@ -1,6 +1,5 @@
 repositories {
     mavenCentral()
-    mavenRepo urls: "https://repository.jboss.org/nexus/content/groups/public-jboss"
 }
 
 apply plugin: 'java'
@@ -13,6 +12,25 @@ sourceCompatibility = 1.6
 targetCompatibility = 1.6
 version = '1.0'
 
+sourceSets {
+    main {
+        java {
+            srcDir '<%= Configuration::MAIN_SRC %>'
+        }
+        resources {
+            srcDir '<%= Configuration::MAIN_RESOURCES %>'
+        }
+    }
+    test {
+        java {
+            srcDir '<%= Configuration::TEST_SRC %>'
+        }
+        resources {
+            srcDir '<%= Configuration::TEST_RESOURCES %>'
+        }
+    }
+}
+
 sourceSets.main.classesDir = new File('<%= Configuration::WEB_INF %>/classes')
 
 jettyRun.scanIntervalSeconds=3

data/lib/vraptor-scaffold/generators/{app_generator → app}/templates/build.xml

@@ -91,11 +91,15 @@
          ================================= -->
 	<target name="jetty.run" description="--> run jetty server" depends="compile">
 		<path id="jetty.path.id">
-			<fileset dir="lib/jetty" />
+		    <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" />
+            <webApp name="${project.name}" warfile="${webapp.dir}" contextpath="/" scanIntervalSeconds="3">
+                <scanTargets dir="${build.dir}">
+                    <include name="**/*"/>
+                </scanTargets>
+            </webApp>
 		</jetty>
 	</target>
 

data/lib/vraptor-scaffold/generators/{app_generator → app}/templates/eclipse/classpath.erb

@@ -5,11 +5,6 @@
 	<classpathentry kind="src" path="src/test/java" output="target/test-classes"/>
 	<classpathentry kind="src" path="src/test/resources" output="target/test-classes"/>
 	<classpathentry kind="output" path="src/main/webapp/WEB-INF/classes"/>
-	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/jdk1.6.0_20">
-		<attributes>
-			<attribute name="owner.project.facets" value="java"/>
-		</attributes>
-	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.jst.server.core.container/org.eclipse.jst.server.tomcat.runtimeTarget/Apache Tomcat v6.0">
 		<attributes>
 			<attribute name="owner.project.facets" value="jst.web"/>

data/lib/vraptor-scaffold/generators/app/templates/heroku/Main.java

@@ -0,0 +1,21 @@
+import org.eclipse.jetty.server.Server;
+import org.eclipse.jetty.webapp.WebAppContext;
+
+public class Main {
+    public static void main(String[] args) throws Exception {
+        String webappDirLocation = "src/main/webapp/";
+        String webPort = System.getenv("PORT");
+        if (webPort == null || webPort.isEmpty()) {
+            webPort = "8080";
+        }
+        Server server = new Server(Integer.valueOf(webPort));
+        WebAppContext root = new WebAppContext();
+        root.setContextPath("/");
+        root.setDescriptor(webappDirLocation + "/WEB-INF/web.xml");
+        root.setResourceBase(webappDirLocation);
+        root.setParentLoaderPriority(true);
+        server.setHandler(root);
+        server.start();
+        server.join();
+    }
+}

data/lib/vraptor-scaffold/generators/app/templates/heroku/Procfile

@@ -0,0 +1 @@
+web: sh target/bin/webapp