jruby-enginize 0.8 → 0.9

data/README.rdoc

@@ -9,32 +9,35 @@ AppEngine, go to http://code.google.com/appengine and have a look at the
 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 (http://code.google.com/appengine/downloads.html) for
-Java. Make sure that the AppEngine configuration tool "appcfg.sh" is in your
-PATH as that's what parts of the software are wrapping.
-
-More dependencies depend on the framework template to generate an application
-for, but installation of additional gems is done with tools provided by
-Google (so below).
-
-== Installation
-
-The Google people worked hard to make JRuby easier to deploy than it was at
-the beginning, so don't blindly trust all those blog posts and samples you'll
+The Google people work hard to make JRuby easier to deploy with each release
+of their tools, so don't blindly trust all those blog posts and samples you'll
 find but use the newest version of jruby-enginize and have a look at the Wiki
 page of the Google AppEngine JRuby tools
 (http://code.google.com/p/appengine-jruby/wiki/GettingStarted)
 to learn about the details beyond.
 
+If you used JRuby-Enginize before, you will note two bigger changes:
+
+* There is no need for a separate JRuby installation anymore, as the
+  google-appengine gem does that for you.
+
+* Gem handling changed as Google now uses bundler and all required gems have
+  to be registered in a new file called "Gemfile". These gems are loaded on
+  the fly when you call "rake appengine:run" or "rake appengine:deploy". Quite
+  elegant...
+
+== Installation
+
 These are the steps for installing the Google tools plus JRuby-Enginize
 running on top of it to streamline your first steps:
 
-  sudo gem sources -a http://gems.github.com  # Only needed once!
+  sudo gem sources -a http://gemcutter.org  # Only needed once!
   sudo gem install google-appengine
-  sudo gem install ulbrich-jruby-enginize
+  sudo gem install jruby-enginize
+
+!!Warning: As Github cancelled gem support, we moved the gem from Github.com
+to Gemcutter.org. If you install from Github, you will not get the newest
+version! See http://gemcutter.org/gems/jruby-enginize for details.
 
 You also need an Google AppEngine account to actually publish your code.
 Without account you can still play around with the tools and run applications
@@ -54,22 +57,15 @@ Here are the steps for creating and deploying a new Sinatra application:
 
 * Register with Google AppEngine and create a new application ID.
 
-* Generate your application with that new ID as directory name. Sample:
-
-  <tt>jruby-enginize --template sinatra jruby-enginize</tt>
+* Generate your application with that new ID as directory name and the e-mail
+  address of your Google account. Optionally choose a template ("sinatra" or
+  "merb" for now).
 
-* Go to the new directory and install the missing gems first (depends on the
-  template you have chosen):
+  Sample:
 
-  <tt>rake template:gems</tt>
+  <tt>jruby-enginize --email john@doe.com --template sinatra jruby-enginize</tt>
 
-  !!Attention: Whenever you want to install additional gems, be sure
-  to use <tt>appcfg.rb gem</tt> provided by the Google AppEngine JRuby tools 
-  and not <tt>jgem</tt> as Google maintains a local repository per project and
-  bundles the files to upload from that information. You will run into missing
-  gems on the server if you bypass this! Best approach is to use a separate
-  JRuby installation for AppEngine development to run into missing gems when
-  running the application locally, too.
+* Go to the new directory
 
 * Learn about the available rake tasks
 
@@ -77,7 +73,12 @@ Here are the steps for creating and deploying a new Sinatra application:
 
 * Try out your application locally: 
 
-  <tt>sudo rake appengine:run</tt>
+  <tt>rake appengine:run</tt>
+
+  !!Attention: Whenever you want to require additional gems, be sure
+  to add them to the bundler configuration in <tt>Gemfile</tt> instead of
+  using <tt>jgem</tt> as the Google toole maintains a local repository per
+  project and bundle the files to upload from that information.
 
 * Deploy the application:
 
@@ -87,9 +88,9 @@ Here are the steps for creating and deploying a new Sinatra application:
   password to confirm your upload to the server.
 
 You can repeat the deployment whenever you want. Be sure to set the version
-number in the AppEngine::Rack.configure_app part of "config.ru" to a new
-value, when you are experimenting with an unstable version and don't want to
-risk your users getting exceptions.
+number in the <tt>AppEngine::Rack.configure_app</tt> part of <tt>config.ru</tt>
+to a new value, when you are experimenting with an unstable version and don't
+want to risk your users getting exceptions.
 
 You can try the new version by opening e.g.
 

data/lib/generator.rb

@@ -78,9 +78,8 @@ module JRubyEnginize # :nodoc:
       if not dryrun
         puts "Done with directory \"#{self.path}\"."
 
-        puts "\nYour next steps:\n  cd #{self.path}\n\n  rake template:gems"
-        puts "\n  rake\n  rake --tasks"
-        puts "\n  sudo rake appengine:run # First call may fail: Just retry!"
+        puts "\nYour next steps:\n  cd #{self.path}\n\n  rake\n  rake --tasks"
+        puts "\n  rake appengine:run"
         puts "\n  rake appengine:deploy"
       end
     end

data/templates/merb/Gemfile

@@ -0,0 +1,20 @@
+# Basics for using Google AppEngine.
+
+disable_system_gems
+disable_rubygems
+
+bundle_path '.gems/bundler_gems'
+
+source 'http://gemcutter.org'
+
+gem 'appengine-rack'
+gem 'appengine-apis'
+
+# Dependencies for using Merb.
+
+gem 'extlib'
+gem 'rubygems-update'
+gem 'merb-core'
+
+# Add more dependencies below...
+

data/templates/merb/config.ru

@@ -1,12 +1,31 @@
+# Load rubygems update and modify load paths to help Merb do some Gem
+# extension work.
+
 require 'rubygems'
-require 'appengine-rack'
+gem 'rubygems-update'
+
+$LOAD_PATH.each do |path|
+  if (match = path.match(/(.*)\/hide_lib_for_update/))
+    $LOAD_PATH << "#{match[1]}/lib"
+  end
+end
 
+# Require standard libraries plus Merb and a Merb::Bootloader patch.
+
+require 'appengine-rack'
 require 'merb-core'
 
+require 'lib/bootloader_patch'
+
+# Configure and run the application. Attention: Modify the version number
+# whenever you want to test the live environment without breaking the current
+# release...
+
 AppEngine::Rack.configure_app(
   # :ssl_enabled => true,
   :application => '{{name}}',
-  :version => 1)
+  :precompilation_enabled => true,
+  :version => '1')
 
 Merb::Config.setup(:merb_root => File.dirname(__FILE__),
                    :environment => ENV['RACK_ENV'])
@@ -14,6 +33,8 @@ Merb::Config.setup(:merb_root => File.dirname(__FILE__),
 Merb.environment = Merb::Config[:environment]
 Merb.root = Merb::Config[:merb_root]
 
-Merb::BootLoader.run
- 
-run Merb::Rack::Application.new
+Merb::BootLoader.gaerun
+
+use Merb::Rack::Static, Merb.dir_for(:public) 
+
+run Merb::Rack::Application.new 

data/templates/merb/lib/bootloader_patch.rb

@@ -0,0 +1,39 @@
+# Adds a reduced version of the run method of the boot loader skipping stuff
+# incompatible or unneeded on Google AppEngine.
+
+class Merb::BootLoader
+  
+  # Just the same as the run method but with skipping some subclasses.
+
+  def self.gaerun
+    Merb.started = true
+
+    ignored = ['Merb::BootLoader::Logger',
+                'Merb::BootLoader::BackgroundServices',
+                'Merb::BootLoader::ReloadClasses']
+    
+    subklasses = subclasses.dup
+
+    until subclasses.empty?
+      time = Time.now.to_i
+      bootloader = subclasses.shift
+
+      next if ignored.include? bootloader
+
+      if (ENV['DEBUG'] || $DEBUG || Merb::Config[:verbose]) && Merb.logger
+        Merb.logger.debug!("Loading: #{bootloader}")
+      end
+
+      Object.full_const_get(bootloader).run
+
+      if (ENV['DEBUG'] || $DEBUG || Merb::Config[:verbose]) && Merb.logger
+        Merb.logger.debug!("It took: #{Time.now.to_i - time}")
+      end
+
+      self.finished << bootloader
+    end
+
+    self.subclasses = subklasses
+    nil
+  end
+end

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

@@ -25,18 +25,6 @@ begin
 rescue Exception
 end
 
-# Task for loading gems needed by this template. Bootstrap to get installed...
-
-namespace :template do
-  desc 'Load missing gems to local gem repository'
-  task :gems do
-    appcfg = which_executable('appcfg.rb')
-
-    puts 'Load missing gems to local gem repository'
-    `(sudo #{appcfg} gem install appengine-apis extlib merb-core) 1>&2`
-  end
-end
-
 # Add your own tasks...
 
 namespace :merb do

data/templates/merb/spec/spec_helper.rb

@@ -1,5 +1,3 @@
-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?

data/templates/shared/Gemfile

@@ -0,0 +1,14 @@
+# Basics for using Google AppEngine.
+
+disable_system_gems
+disable_rubygems
+
+bundle_path '.gems/bundler_gems'
+
+source 'http://gemcutter.org'
+
+gem 'appengine-rack'
+gem 'appengine-apis'
+
+# Add more dependencies below...
+

data/templates/shared/README

@@ -3,18 +3,16 @@ README
 This is a generic README generated by jruby-enginize. Please replace with
 something more meaningful... ;-)
 
-INSTALL MISSING GEMS
+DEVELOPMENT
 
-As a basic requirement, you have to install missing gems required by the
-template (this task is implemented individually for each template):
+You can start a local development server by running the following command:
 
-  rake template:gems
+  rake appengine:run
 
-!!Attention: Whenever you want to install additional gems, be sure to use
-"appcfg.rb gem" provided by the Google AppEngine JRuby tools and not "jgem" as
-Google maintains a local repository per project and bundles the files to
-upload from that information. You will run into missing gems on the server if
-you bypass this!
+Whenever you want to require additional gems, be sure to add them to the
+bundler configuration in "Gemfile" instead of using jgem: The Google tools
+maintain a local repository per project and bundle the files to upload from
+that information.
 
 GOOGLE APPENGINE DEPLOYMENT
 
@@ -26,7 +24,7 @@ and open
 
   http://{{name}}.appspot.com
 
-to have a first test.
+to test it live.
 
 Be sure to set the version number in the AppEngine::Rack.configure_app part
 of "config.ru" to a new value, when you are experimenting with an unstable
@@ -47,8 +45,8 @@ and setting a new default.
 
 SOME MORE INFO
 
-- Gems installed with "appcfg.rb gem" reside in directory ".gems". Again: Do
-  not use "jgem" at all!
+- Gems have to be added to bundler config in "Gemfile". Again: Do not use
+  "jgem" at all!
 
 - Some gems will throw exceptions during bundling: Have a look for paths
   assembled using ".." to reach the parent directory and replace with
@@ -57,15 +55,17 @@ SOME MORE INFO
 
 - Data uploaded to the server is gathered in directory "WEB-INF" as with any
   Java project. The first time "rake appengine:run" or "rake appengine:deploy"
-  is called, this directory will be created and "jruby-rack-xx.jar" is
-  downloaded from its homepage.
-  
-  The first call to "rake appengine:run" or "rake appengine:deploy" with 
-  downloading the rack jar will fail. Just ignore and retry.
+  is called, this directory will be created and some gems will be downloaded.
 
-- "WEB-INF/lib/gems.jar" is only created or updated after a call to
-  "appcfg.rb gem". This is enforced by "rake appengine:deploy" but not by
-  "rake appengine:update".
+- Java stuff is bundled in "WEB-INF/lib/gems.jar" on the fly. You might want
+  to enforce a rebuild from time to time by calling "rake appengine:rebundle".
 
 - Sometimes the local test server keeps running after Ctrl-C, so have a look
   at "ps" and manually kill the process if needed.
+
+- If you get something like the following error message
+
+    Permission denied - ~/.appcfg_rb_nag (Errno::EACCES)
+
+  you need to remove that file with "rm ~/.appcfg_rb_nag" or at least change
+  ownership as it was created earlier with starting an app with "sudo".

data/templates/shared/Rakefile

@@ -52,22 +52,28 @@ end
 task :default => [:help]
 
 namespace :appengine do
-  desc 'Start a local test server'
+  desc 'Start a local development server'
   task :run do
-    puts 'Start a local test server'
+    puts 'Start a local development server'
     `(dev_appserver.rb .) 1>&2`
   end
 
+  desc 'Start a local Rack based server'
+  task :run do
+    puts 'Start a local Rack based server'
+    `(appcfg.rb run bin/rackup config.ru) 1>&2`
+  end
+
   desc 'Force rebuilding "WEB-INF/lib/gems.jar"'
-  task :rebuildgems do
+  task :rebundle do
     puts 'Force rebuilding "WEB-INF/lib/gems.jar"'
-    `(appcfg.rb gem help install) 2> /dev/null 1>&2`
+    `(appcfg.rb bundle --update .) 2> /dev/null 1>&2`
   end
 
   desc 'Build the application package'
   task :bundle do
     puts 'Build the application package.'
-    `(appcfg.rb --email={{email}} --enable_jar_splitting bundle .) 1>&2`
+    `(appcfg.rb bundle .) 1>&2`
   end
 
   desc 'Upload the application code to the server'
@@ -83,5 +89,5 @@ namespace :appengine do
   end
 
   desc 'Deploy the application (build package and upload application code)'
-  task :deploy => [:rebuildgems, :bundle, :update]
+  task :deploy => [:bundle, :update]
 end

data/templates/sinatra/Gemfile

@@ -0,0 +1,19 @@
+# Basics for using Google AppEngine
+
+disable_system_gems
+disable_rubygems
+
+bundle_path '.gems/bundler_gems'
+
+source 'http://gemcutter.org'
+
+gem 'appengine-rack'
+gem 'appengine-apis'
+
+# Dependencies for using Sinatra.
+
+gem 'haml'
+gem 'sinatra'
+
+# Add more dependencies below...
+

data/templates/sinatra/config.ru

@@ -1,12 +1,17 @@
-require 'rubygems'
-require 'appengine-rack'
+# Require standard libraries plus Sinatra.
 
+require 'appengine-rack'
 require 'sinatra'
 
+# Configure and run the application. Attention: Modify the version number
+# whenever you want to test the live environment without breaking the current
+# release...
+
 AppEngine::Rack.configure_app(
   # :ssl_enabled => true,
   :application => '{{name}}',
-  :version => 1)
+  :precompilation_enabled => true,
+  :version => '1')
 
 require 'app'
  

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

@@ -1,18 +1,3 @@
-# Task for loading gems needed by this template. Bootstrap to get installed...
-
-namespace :template do
-  desc 'Load missing gems to local gem repository'
-  task :gems do
-    appcfg = which_executable('appcfg.rb')
-    patch = which_executable('patch')
-
-    puts 'Load missing gems to local gem repository'
-    `(sudo #{appcfg} gem install appengine-apis haml sinatra) 1>&2`
-    puts 'Add patch for Haml 2.2.2 if needed'
-    `(sudo #{patch} --batch --silent .gems/gems/haml-2.2.2/lib/haml/util.rb < lib/tasks/haml-2_2_2-util.patch) 2> /dev/null 1>&2`
-  end
-end
-
 # Add your own tasks...
 
 namespace :sinatra do

metadata

@@ -1,7 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: jruby-enginize
 version: !ruby/object:Gem::Version 
-  version: "0.8"
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  version: "0.9"
 platform: ruby
 authors: 
 - Jan Ulbrich
@@ -9,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-04 00:00:00 +01:00
+date: 2010-02-25 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -30,7 +34,7 @@ files:
 - templates/sinatra/views/index.haml
 - templates/sinatra/public/images/sinatra_logo.png
 - templates/sinatra/lib/tasks/sinatra.rake
-- templates/sinatra/lib/tasks/haml-2_2_2-util.patch
+- templates/sinatra/Gemfile
 - templates/sinatra/config.ru
 - templates/sinatra/app.rb
 - templates/sinatra/.gitignore
@@ -39,12 +43,15 @@ files:
 - templates/shared/public/robots.txt
 - templates/shared/public/images/appengine_logo.png
 - templates/shared/public/favicon.ico
+- templates/shared/Gemfile
 - 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/lib/bootloader_patch.rb
+- templates/merb/Gemfile
 - templates/merb/config.ru
 - templates/merb/config/init.rb
 - templates/merb/config/framework.rb
@@ -72,18 +79,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A package for generating Google AppEngine compliant JRuby projects.

data/templates/sinatra/lib/tasks/haml-2_2_2-util.patch

@@ -1,5 +0,0 @@
-18c18
-<       File.join(File.dirname(__FILE__), '..', '..', file)
----
->       File.join(File.dirname(File.dirname(File.dirname(__FILE__))), file)
-