ulbrich-jruby-enginize 0.4 → 0.5

data/README.rdoc

@@ -3,19 +3,26 @@
 == About
 
 JRuby-Enginize is a generator for Google AppEngine compliant JRuby
-applications. The generator will support several frameworks but only has
-Sinatra on board for the moment being. If you want to learn more about Google
+applications. The generator currently supports Sinatra and Merb with more
+frameworks to come in the future. If you want to learn more about Google
 AppEngine, go to http://code.google.com/appengine and have a look at the
-tutorials.
+tutorials. For more about JRuby, please go to http://www.codehaus.org and see
+what's up running Ruby applications on a Java VM.
 
 == Prerequisites
 
 JRuby-Enginize needs a proper JRuby installation including rake and the
 Google AppEngine SDK for Java. More dependencies depend on the framework
-template to generate an application for: For Sinatra
-(http://www.sinatrarb.com), you will need the "sinatra" gem. Be sure to
-install such gems with <tt>jgem</tt> or <tt>jruby -S gem</tt> as you need
-them for JRuby and not for Ruby.
+template to generate an application for:
+
+For Sinatra (http://www.sinatrarb.com), you will need the "sinatra" gem with
+"haml" and "sass".
+
+For Merb (http://www.merbivore.com), you will need the "merb-core" gem with
+"extlib" and "appengine-apis".
+
+Be sure to install gems with <tt>jgem</tt> or <tt>jruby -S gem</tt> as you
+need them for JRuby and not for Ruby.
 
 You also need an Google AppEngine account to actually publish your code.
 Without account you can still play around with the tool and run applications
@@ -25,7 +32,7 @@ locally.
 
 Install JRuby-Enginize as a gem with
 
-  jgem sources -a http://gems.github.com  # Only needed once!
+  sudo jgem sources -a http://gems.github.com  # Only needed once!
   sudo jgem install ulbrich-jruby-enginize
 
 and be sure to really install with <tt>jgem</tt> as JRuby-Enginize will
@@ -51,7 +58,7 @@ Here are the steps for creating and deploying a new Sinatra application:
 
 * Generate your application. Sample:
 
-  <tt>jruby -S jruby-enginize --email foo@bar.com foobar</tt>
+  <tt>jruby -S jruby-enginize --template merb --email foo@bar.com foobar</tt>
 
 * Go to the new directory, learn about the available rake tasks and try out
   your application: 

data/lib/generator.rb

@@ -5,6 +5,7 @@
 
 require 'ftools'
 require 'find'
+require 'digest/md5'
 
 module JRubyEnginize # :nodoc:
 
@@ -132,16 +133,50 @@ module JRubyEnginize # :nodoc:
       #
       # [source] Source file
       # [target] Target file
+      #
+      # The source files may contain some variables which are replaced on the
+      # fly. All variables are set in double curly brackets and are let passed
+      # without modification if they ar not recognized.
+      #
+      # Supported variables:
+      #
+      # [{{email}}] E-mail address of the Google AppEngine account
+      # [{{name}}] Name of the application
+      # [{{template}}] Name of the template (e.g. "sinatra")
+      # [{{hexrand-xx}}] Hexadecimal random string with xx characters
+      # [{{numrand-xx}}] Random number with xx digits
 
       def process_file(source, target)
-        content = File.read(source).gsub(/\{\{[^}]*\}\}/) do |match|
-          case match
+        content = File.read(source).gsub(/\{\{[^}]*\}\}/) do |variable|
+          case variable
           when '{{email}}'
             email
           when '{{name}}'
             name
           else
-            match
+            if hexrand = variable.match(/{{hexrand-([0-9]+)}}/) and
+              hexrand.length == 2 and (len = hexrand[1].to_i) > 0
+            then
+              str = ''
+
+              while str.length < len do
+                str << Digest::MD5.hexdigest("#{rand}-#{Time.now}-#{rand}")
+              end
+
+              str[0, len]
+            elsif numrand = variable.match(/{{numrand-([0-9]+)}}/) and
+              numrand.length == 2 and (len = numrand[1].to_i) > 0
+            then
+              str = ''
+
+              while str.length < len do
+                str << rand.to_s.sub(/^.*\.0*/, '')
+              end
+
+              str[0, len]
+            else
+              variable
+            end
           end
         end
 

data/templates/merb/.gitignore

@@ -0,0 +1,21 @@
+.DS_Store
+log/*
+tmp/*
+TAGS
+*~
+.#*
+schema/schema.rb
+schema/*_structure.sql
+schema/*.sqlite3
+schema/*.sqlite
+schema/*.db
+*.sqlite
+*.sqlite3
+*.db
+src/*
+.hgignore
+.hg/*
+.svn/*
+gems/gems/*
+gems/specifications/*
+merb_profile_results

data/templates/merb/app.rb

@@ -0,0 +1,31 @@
+# This application files as generated by jruby-enginize.
+
+begin
+  require 'appengine-apis/merb-logger'
+rescue Exception
+end
+
+# Class EngineApp implements the only controller of this application.
+
+class EngineApp < Merb::Controller
+  layout :engine_app
+
+  # Returns the location of the template depending on controller and action.
+  # Modified to match our flat world.
+  #
+  # Parameters:
+  #
+  # [action] Name of the action
+  # [type] Requested format
+  # [controller] Name of the controller
+
+  def _template_location(action, type = nil, controller = controller_name)
+    (controller == 'layout' ? "layout.#{action}.#{type}" : "#{action}.#{type}")
+  end
+
+  # GET /
+
+  def index
+    render
+  end
+end

data/templates/merb/config/framework.rb

@@ -0,0 +1,7 @@
+Merb::Config[:framework] = {
+  :application => Merb.root / "app.rb",
+  :config => [Merb.root / "config", nil],
+  :public => [Merb.root / "public", nil],
+  :view   => Merb.root / "views"
+}
+

data/templates/merb/config/init.rb

@@ -0,0 +1,37 @@
+# Go to http://wiki.merbivore.com/pages/init-rb
+
+#  use_orm :none
+use_test :rspec
+use_template_engine :erb
+
+# Specify a specific version of a dependency
+# dependency "RedCloth", "> 3.0"
+
+Merb::BootLoader.before_app_loads do
+  # This will get executed after dependencies have been loaded but before your app's classes have loaded.
+end
+ 
+Merb::BootLoader.after_app_loads do
+  # This will get executed after your app's classes have been loaded.
+end
+
+# Move this to app.rb if you want it to be reloadable in dev mode.
+Merb::Router.prepare do
+  match('/').to(:controller => "engine_app", :action =>'index')
+
+  default_routes
+end
+
+Merb::Config.use { |c|
+  c[:environment]         = 'production',
+  c[:framework]           = {},
+  c[:log_level]           = :debug,
+  c[:log_stream]          = STDOUT,
+  c[:use_mutex]           = false,
+  c[:session_store]       = 'cookie',
+  c[:session_id_key]      = '_{{name}}_session_id',
+  c[:session_secret_key]  = '{{hexrand-41}}',
+  c[:exception_details]   = false,
+  c[:reload_classes]      = false,
+  c[:reload_templates]    = false
+}

data/templates/merb/config/warble.rb

@@ -0,0 +1,85 @@
+# Disable automatic framework detection by uncommenting/setting to false
+# Warbler.framework_detection = false
+ 
+# Warbler web application assembly configuration file
+Warbler::Config.new do |config|
+  # Temporary directory where the application is staged
+  # config.staging_dir = "tmp/war"
+ 
+  # Application directories to be included in the webapp.
+  config.dirs = %w(lib public views config)
+ 
+  # Additional files/directories to include, above those in config.dirs
+  # config.includes = FileList["db"]
+  config.includes = FileList["appengine-web.xml", "app.rb"]
+  # Additional files/directories to exclude
+  # config.excludes = FileList["lib/tasks/*"]
+ 
+  # Additional Java .jar files to include.  Note that if .jar files are placed
+  # in lib (and not otherwise excluded) then they need not be mentioned here.
+  # JRuby and JRuby-Rack are pre-loaded in this list.  Be sure to include your
+  # own versions if you directly set the value
+  # config.java_libs += FileList["lib/java/*.jar"]
+ 
+  # Loose Java classes and miscellaneous files to be placed in WEB-INF/classes.
+  # config.java_classes = FileList["target/classes/**.*"]
+ 
+  # One or more pathmaps defining how the java classes should be copied into
+  # WEB-INF/classes. The example pathmap below accompanies the java_classes
+  # configuration above. See http://rake.rubyforge.org/classes/String.html#M000017
+  # for details of how to specify a pathmap.
+  # config.pathmaps.java_classes << "%{target/classes/,}p"
+ 
+  # Gems to be included. You need to tell Warbler which gems your application needs
+  # so that they can be packaged in the war file.
+  config.gems = ['merb-core', 'extlib']
+ 
+  # The most recent versions of gems are used.
+  # You can specify versions of gems by using a hash assignment:
+  # config.gems["foo"] = "2.0.2"
+ 
+  # You can also use regexps or Gem::Dependency objects for flexibility or
+  # fine-grained control.
+  # config.gems << /^merb-/
+  # config.gems << Gem::Dependency.new("merb-core", "= 0.9.3")
+ 
+  # Include gem dependencies not mentioned specifically
+  config.gem_dependencies = true
+ 
+  # Files to be included in the root of the webapp.  Note that files in public
+  # will have the leading 'public/' part of the path stripped during staging.
+  # config.public_html = FileList["public/**/*", "doc/**/*"]
+ 
+  # Pathmaps for controlling how public HTML files are copied into the .war
+  # config.pathmaps.public_html = ["%{public/,}p"]
+ 
+  # Name of the war file (without the .war)
+  config.war_name = "{{name}}"
+ 
+  # Name of the MANIFEST.MF template for the war file. Defaults to the
+  # MANIFEST.MF normally generated by `jar cf`.
+  # config.manifest_file = "config/MANIFEST.MF"
+ 
+  # Value of environment variables
+  # config.webxml.foo.env = ENV['FOO_ENV']
+ 
+  # Application booter to use, one of :rack, :rails, or :merb
+  config.webxml.booter = :merb
+ 
+  # When using the :rack booter, "Rackup" script to use.
+  # The script is evaluated in a Rack::Builder to load the application.
+  # Examples:
+  # config.webxml.rackup = %{require './lib/demo'; run Rack::Adapter::Camping.new(Demo)}
+  # config.webxml.rackup = require 'cgi' && CGI::escapeHTML(File.read("config.ru"))
+ 
+  # Control the pool of runtimes. Leaving unspecified means
+  # the pool will grow as needed to service requests. It is recommended
+  # that you fix these values when running a production server!
+  # config.webxml.jruby.min.runtimes = 2
+  # config.webxml.jruby.max.runtimes = 4
+  config.webxml.jruby.min.runtimes = 1
+  config.webxml.jruby.max.runtimes = 1
+  config.webxml.jruby.init.serial = true
+ 
+  config.java_libs = []
+end

data/templates/merb/lib/tasks/merb.rake

@@ -0,0 +1,34 @@
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+include FileUtils
+
+# Load the basic runtime dependencies; this will include 
+# any plugins and therefore plugin rake tasks.
+init_env = ENV['MERB_ENV'] || 'rake'
+Merb.load_dependencies(:environment => init_env)
+     
+# Get Merb plugins and dependencies
+Merb::Plugins.rakefiles.each { |r| require r } 
+
+# Load any app level custom rakefile extensions from lib/tasks
+tasks_path = File.join(File.dirname(__FILE__), "lib", "tasks")
+rake_files = Dir["#{tasks_path}/*.rake"]
+rake_files.each{|rake_file| load rake_file }
+
+require 'spec/rake/spectask'
+require 'merb-core/test/tasks/spectasks'
+
+##############################################################################
+# ADD YOUR CUSTOM TASKS IN /lib/tasks
+# NAME YOUR RAKE FILES file_name.rake
+##############################################################################
+
+namespace :merb do
+  desc 'Start a local test server on port 4000'
+  task :run do
+    puts 'Start a local test server on port 4000'
+    `(jruby -S merb -V) 1>&2`
+  end
+end
+

data/templates/merb/public/stylesheets/default.css

@@ -0,0 +1,55 @@
+body {
+  background: #bbbbbb;
+  color: #000000;
+  font-family: helvetica;
+  font-size: 12pt;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-family: helvetica;
+}
+
+h1 {
+  font-size: 18pt;
+}
+
+h2 {
+  font-size: 16pt;
+}
+
+h3 {
+  font-size: 14pt;
+}
+
+h4, h5, h6 {
+  font-size: 12pt;
+}
+
+a {
+  color: inherit;
+  text-decoration: none;
+  border-bottom: 1px dotted;
+}
+
+a:hover {
+  border-bottom: 1px solid;
+}
+
+div {
+  width: 580px;
+  padding: 3px 5px;
+  text-align: left;
+}
+
+#main {
+  background: #ffffff;
+  margin-top: 50px;
+  height: auto;
+  border: 1px solid #808080;
+}
+
+#footer {
+  padding-left: 0px;
+  font-size: 9pt;
+  color: #404040;
+}

data/templates/merb/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require "rubygems"
+
+# Add the local gems dir if found within the app root; any dependencies loaded
+# hereafter will try to load from the local gems before loading system gems.
+if (local_gem_dir = File.join(File.dirname(__FILE__), '..', 'gems')) && $BUNDLE.nil?
+  $BUNDLE = true; Gem.clear_paths; Gem.path.unshift(local_gem_dir)
+end
+
+require "spec"
+require "merb-core"
+
+Merb::Config.use do |c|
+  c[:session_store] = "memory"
+end
+
+Merb.start_environment(:testing => true,
+                       :adapter => 'runner',
+                       :environment => ENV['MERB_ENV'] || 'test')
+
+Spec::Runner.configure do |config|
+  config.include(Merb::Test::ViewHelper)
+  config.include(Merb::Test::RouteHelper)
+  config.include(Merb::Test::ControllerHelper)
+end

data/templates/merb/views/index.html.erb

@@ -0,0 +1,26 @@
+<center>
+  <div id='main'>
+    <center>
+      <p>
+        <img src='/images/appengine_logo.png' />
+      </p>
+      <h1>
+        Hi folks! Nice to meet you here!
+      </h1>
+      <p>
+        This is
+        <a href='http://code.google.com/appengine'>Google AppEngine</a>
+        running the
+        <a href='http://www.merbivore.com'>Merb</a>
+        framework.
+      </p>
+      <p>
+        <img src='/images/merb_logo.png' />
+      </p>
+    </center>
+  </div>
+  <div id='footer'>
+    This tiny sample application was generated by
+    <a href='http://github.com/ulbrich/jruby-enginize'>JRuby-Enginize</a>
+  </div>
+</center>

data/templates/merb/views/layout.engine_app.html.erb

@@ -0,0 +1,9 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <link href='/stylesheets/default.css' rel='stylesheet' type='text/css' />
+  </head>
+  <body>
+    <%= catch_content :for_layout %>
+  </body>
+</html>

data/templates/shared/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/templates/sinatra/lib/tasks/sinatra.rake

@@ -1,7 +1,7 @@
 namespace :sinatra do
-  desc 'Start a local test server on part 4567'
+  desc 'Start a local test server on port 4567'
   task :run do
-    puts 'Start a local test server on part 4567'
+    puts 'Start a local test server on port 4567'
     `(jruby -S app.rb) 1>&2`
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ulbrich-jruby-enginize
 version: !ruby/object:Gem::Version 
-  version: "0.4"
+  version: "0.5"
 platform: ruby
 authors: 
 - Jan Ulbrich
@@ -35,9 +35,21 @@ files:
 - templates/sinatra/app.rb
 - templates/shared/README
 - templates/shared/Rakefile
+- templates/shared/public/robots.txt
 - templates/shared/public/images/appengine_logo.png
 - templates/shared/lib/jruby-rack-0.9.4.jar
 - templates/shared/appengine-web.xml
+- templates/merb/views/layout.engine_app.html.erb
+- templates/merb/views/index.html.erb
+- templates/merb/spec/spec_helper.rb
+- templates/merb/public/stylesheets/default.css
+- templates/merb/public/images/merb_logo.png
+- templates/merb/lib/tasks/merb.rake
+- templates/merb/config/warble.rb
+- templates/merb/config/init.rb
+- templates/merb/config/framework.rb
+- templates/merb/app.rb
+- templates/merb/.gitignore
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/ulbrich/jruby-enginize