warbler 1.0.3 → 1.1.0

data/History.txt

@@ -1,147 +1,167 @@
+== 1.1.0
+
+- Add concept of "features" -- small Rake tasks that run before the
+  creation of the war file and make manipulations to the war file
+  structure.
+- Add 'gemjar' feature: Bundle all gems into a gems.jar to reduce the
+  number of files in the archive (mostly useful for Google AppEngine).
+  Usage: run "warble gemjar war" or set config.features = %w(gemjar) in
+  warble.rb to use this feature.
+- Add 'executable' feature: Bundle an embedded web server in the war
+  file so that the entire application can be run as
+  'java -jar myapp.war'.
+  Usage: run "warble executable war" or set config.features = %w(executable)
+  in warble.rb to use this feature.
+  To see embedded webserver options, add '--help' to the 'java -jar'
+  command line.
+- No longer embed config.ru in web.xml as 'rackup' parameter by
+  default. Instead, config.ru is included in the war file.
+- Bump jruby-rack version requirement to 0.9.8.
+
 == 1.0.3
 
-* Tracking recent Bundler changes - handle locked Gemfiles differently
+- Tracking recent Bundler changes - handle locked Gemfiles differently
   than unlocked ones
-* Handle file-based symlinks, and warn about inoperational directory
+- Handle file-based symlinks, and warn about inoperational directory
   symlinks under non-JRuby versions of Ruby.
 
 == 1.0.2
 
-* Add 'warble pluginize' task back. This task now just creates a
+- Add 'warble pluginize' task back. This task now just creates a
   vendor/plugins/warbler/tasks/warbler.rake file. There's no need to
   "vendor" all of Warbler into your application anymore.
 
 == 1.0.1
 
-* Fix careless bug where Warbler doesn't work with JRuby 1.4
+- Fix careless bug where Warbler doesn't work with JRuby 1.4
 
 == 1.0
 
-* Warbler hits 1.0! There are enough structural changes in Warbler
+- Warbler hits 1.0! There are enough structural changes in Warbler
   that I feel it's time to roll the major version over to 1.0.
-* Add support for Bundler. Detect Gemfiles, make sure gems are
+- Add support for Bundler. Detect Gemfiles, make sure gems are
   included in the war file and rewrite .bundle/environment.rb inside
   the war file.
-* Warbler now uses RubyZip to create the war file in-place, without
+- Warbler now uses RubyZip to create the war file in-place, without
   copying files to a tmp/war staging area. When run in JRuby it uses a
   Java ZipOutputStream for a modest performance boost.
-* Add config option to allow override of gem_home (Daniel Harrington).
-* Stop bundling jruby-rack, as promised.
-* WARBLER-3: don't add from Rails config.gems if they are frozen
-* WARBLER-7: Add config.webinf_files option with more support for
+- Add config option to allow override of gem_home (Daniel Harrington).
+- Stop bundling jruby-rack, as promised.
+- WARBLER-3: don't add from Rails config.gems if they are frozen
+- WARBLER-7: Add config.webinf_files option with more support for
   custom web.xml files
 
 == 0.9.14
 
-* So, jruby-rack is bundled for one more release. 1.0 will not contain
+- So, jruby-rack is bundled for one more release. 1.0 will not contain
   any jar files, I promise!
-* Upgraded jruby-rack to 0.9.5.
-* Unbundled jruby-complete jar in favor of new jruby-jars gem, which
+- Upgraded jruby-rack to 0.9.5.
+- Unbundled jruby-complete jar in favor of new jruby-jars gem, which
   can be upgraded separately.
-* Skip gems which have no loaded_from attribute set
+- Skip gems which have no loaded_from attribute set
   (this happened with the Authlogic gem on Edge Rails)
   (thanks Laszlo Bacsi)
 
 == 0.9.13
 
-* RailsConf 2009 edition.
-* Only bundled JRuby and JRuby-Rack upgrades. Bug fixes will have to come in 0.9.14.
-* This should also be the last release with bundled JRuby and JRuby-Rack.
-* Upgrade to JRuby 1.3.0RC1 and JRuby-Rack 0.9.4. The latter allows 
+- RailsConf 2009 edition.
+- Only bundled JRuby and JRuby-Rack upgrades. Bug fixes will have to come in 0.9.14.
+- This should also be the last release with bundled JRuby and JRuby-Rack.
+- Upgrade to JRuby 1.3.0RC1 and JRuby-Rack 0.9.4. The latter allows 
   Rails 2.3 to work with Warbler.
 
 == 0.9.12
 
-* Allow framework auto-detection to be disabled. Set
-  `Warbler.framework_detection = false` at the top of config/warble.rb
+- Allow framework auto-detection to be disabled. Set
+  `Warbler.framework_detection = false' at the top of config/warble.rb
   or uncomment the line from a newly generated config.
-* Add configuration option to set manifest file (thanks Tommy McGuire)
-* Mitigate RubyGems 1.3 compatibility issue (thanks Jens Norrgrann)
-* Add experimental `war:exploded` task. This allows you to deploy your
+- Add configuration option to set manifest file (thanks Tommy McGuire)
+- Mitigate RubyGems 1.3 compatibility issue (thanks Jens Norrgrann)
+- Add experimental `war:exploded` task. This allows you to deploy your
   application in an exploded mode, thus allowing continual development
   without re-warring and re-deploying. Feedback is appreciated if you
   try this feature; it may not work in all application servers and for
   applications other than Rails.
-* Handle Rails gem dependencies better (thanks Laszlo Bacsi)
-* Auto-detect Merb dependencies (Merb >= 1.0 only). Please give
+- Handle Rails gem dependencies better (thanks Laszlo Bacsi)
+- Auto-detect Merb dependencies (Merb >= 1.0 only). Please give
   feedback if you try Warbler with a Merb 1.0 app.
-* Ignore gem development dependencies
-* Upgrade to JRuby 1.1.6 and JRuby-Rack 0.9.3
+- Ignore gem development dependencies
+- Upgrade to JRuby 1.1.6 and JRuby-Rack 0.9.3
 
 == 0.9.11
 
-* Auto-detect Rails and Merb and configure appropriately
+- Auto-detect Rails and Merb and configure appropriately
   - For Rails, set rails booter, determine max runtimes based on Rails.configuration.threadsafe!,
     add Rails gem, detect Rails version, set gems to be packaged based on
     Rails.configuration.gems if available
   - Rails gems only added if Rails application detected
   - For Merb, set merb booter automatically
-* Auto-detect config.ru rackup script and pass it into config.webxml.rackup
-* rails.env now commented by default in config/warble.rb and internally default
+- Auto-detect config.ru rackup script and pass it into config.webxml.rackup
+- rails.env now commented by default in config/warble.rb and internally default
   the value to 'production'
-* Default directories in config.dirs to only those that are found to be present
-* Allow config.gems array to contain regexps and Gem::Dependency objects as well
+- Default directories in config.dirs to only those that are found to be present
+- Allow config.gems array to contain regexps and Gem::Dependency objects as well
  (assist from Jani Soila)
-* Fix bug ensuring you can += and -= for config.gems
-* Upgrade to JRuby 1.1.4 and JRuby-Rack 0.9.2
-* add [] as a way to specify non-identifier keys, example: config.webxml['!@#$%^'] = 'haha'
+- Fix bug ensuring you can += and -= for config.gems
+- Upgrade to JRuby 1.1.4 and JRuby-Rack 0.9.2
+- add [] as a way to specify non-identifier keys, example: config.webxml['!@#$%^'] = 'haha'
 
 == 0.9.10
 
-* Upgraded to JRuby-Rack 0.9.1. Fixes JRUBY-2620, JRUBY-2594, JRUBY-2507.
-* Now verified to work with Camping and Sinatra. See
+- Upgraded to JRuby-Rack 0.9.1. Fixes JRUBY-2620, JRUBY-2594, JRUBY-2507.
+- Now verified to work with Camping and Sinatra. See
   http://github.com/nicksieger/jruby-rack/tree/master/examples for examples
   of how to configure Warbler to package your Camping and Sinatra apps.
-* Upgraded to JRuby 1.1.3.
-* Log files are no longer packaged in the .war file.
-* Fix #<Warbler::WebxmlOpenStruct ...> appearing in web.xml and document workarounds.
-* Add config.autodeploy_dir that, when specified, will create the war there.
+- Upgraded to JRuby 1.1.3.
+- Log files are no longer packaged in the .war file.
+- Fix #<Warbler::WebxmlOpenStruct ...> appearing in web.xml and document workarounds.
+- Add config.autodeploy_dir that, when specified, will create the war there.
 
 == 0.9.9
 
-* Now shipping with JRuby-Rack 0.9!
-* Upgrade to JRuby 1.1.1
-* warble.rb and web.xml.erb have changed as a result of the change to JRuby-Rack -- we
+- Now shipping with JRuby-Rack 0.9!
+- Upgrade to JRuby 1.1.1
+- warble.rb and web.xml.erb have changed as a result of the change to JRuby-Rack -- we
   recommend comparing the new base copies with any existing configuration you have to
   make sure you pick up the differences.
-* Config changes:
-** config.webxml.booter chooses what kind of application to use (:rails, :merb or plain :rack).
-** config.webxml.pool.* have been replaced by config.webxml.jruby.(min|max).runtimes
-** config.webxml.standalone and config.webxml.jruby_home no longer have any effect.
+- Config changes:
+-- config.webxml.booter chooses what kind of application to use (:rails, :merb or plain :rack).
+-- config.webxml.pool.* have been replaced by config.webxml.jruby.(min|max).runtimes
+-- config.webxml.standalone and config.webxml.jruby_home no longer have any effect.
 
 == 0.9.5
 
-* Fix bug in plugin warbler.rake task file that would favor loading warbler from gems before the version
+- Fix bug in plugin warbler.rake task file that would favor loading warbler from gems before the version
   installed as a plugin
-* Upgrade to JRuby 1.1 final and Goldspike 1.6.1
+- Upgrade to JRuby 1.1 final and Goldspike 1.6.1
 
 == 0.9.4
 
-* Update bundled JRuby to 1.1RC3 and Goldspike to 1.6.
-* Fix inclusion of gems with platform-specific bits (e.g., Hpricot)
+- Update bundled JRuby to 1.1RC3 and Goldspike to 1.6.
+- Fix inclusion of gems with platform-specific bits (e.g., Hpricot)
 
 == 0.9.3
 
-* Update bundled JRuby to 1.1RC2, and Goldspike to 1.5.
-* The bundled JRuby and Goldspike now require JDK 5 or greater. If you wish to use JDK 1.4, use Warbler 0.9.2.
+- Update bundled JRuby to 1.1RC2, and Goldspike to 1.5.
+- The bundled JRuby and Goldspike now require JDK 5 or greater. If you wish to use JDK 1.4, use Warbler 0.9.2.
 
 == 0.9.2
 
-* Update bundled JRuby to version 1.0.3 and Goldspike 1.4.
-* Add config.java_classes to allow you to copy loose Java classes into WEB-INF/classes.
-* Make jar command a single command string so that jar creation doesn't fail (works around bug in JRuby 1.0.2)
-* Use File.join to form staging directory, should produce the proper jar-command path in Windows
+- Update bundled JRuby to version 1.0.3 and Goldspike 1.4.
+- Add config.java_classes to allow you to copy loose Java classes into WEB-INF/classes.
+- Make jar command a single command string so that jar creation doesn't fail (works around bug in JRuby 1.0.2)
+- Use File.join to form staging directory, should produce the proper jar-command path in Windows
 
 == 0.9.1
 
-* Add rake >= 0.7.3 as a dependency in the gem specification.
-* Add debug tasks: war:debug, war:debug:gems, war:debug:public, war:debug:app, war:debug:includes,
+- Add rake >= 0.7.3 as a dependency in the gem specification.
+- Add debug tasks: war:debug, war:debug:gems, war:debug:public, war:debug:app, war:debug:includes,
   war:debug:excludes, war:debug:java_libs gives you a breakdown of what Warbler expects to package.
 
 == 0.9
 
-* Birthday! Warbler is a gem to make a .war file out of a Rails project. The intent is to provide a
+- Birthday! Warbler is a gem to make a .war file out of a Rails project. The intent is to provide a
   minimal, flexible, ruby-like way to bundle up all of your application files for deployment to a
   Java application server.
-* Bundled versions: goldspike-1.4-SNAPSHOT and jruby-complete-1.0.1
-* Works as both a gem (rake application) or a plugin
+- Bundled versions: goldspike-1.4-SNAPSHOT and jruby-complete-1.0.1
+- Works as both a gem (rake application) or a plugin

data/Manifest.txt

@@ -5,6 +5,7 @@ Manifest.txt
 README.txt
 Rakefile
 bin/warble
+ext/Main.java
 ext/WarblerWar.java
 ext/WarblerWarService.java
 lib/warbler

data/README.txt

@@ -13,7 +13,7 @@ to assemble and Just Work.
 
 1. Install the gem: <tt>gem install warbler</tt>.
 2. Run warbler in the top directory of your Rails application: <tt>warble</tt>.
-3. Deploy your railsapp.war file to your favorite Java application server.
+3. Deploy your myapp.war file to your favorite Java application server.
 
 == Usage
 
@@ -21,11 +21,14 @@ Warbler's +warble+ command is just a small wrapper around Rake with internally
 defined tasks.
 
     $ warble -T
-    warble config     # Generate a configuration file to customize your war assembly
-    warble version    # Display version of warbler
-    warble war        # Create the project .war file
-    warble war:clean  # Remove the .war file
-    warble war:debug  # Dump diagnostic information
+    warble config      # Generate a configuration file to customize your war
+    warble executable  # Feature: make an executable archive
+    warble gemjar      # Feature: package gem repository inside a jar
+    warble pluginize   # Install Warbler tasks in your Rails application
+    warble version     # Display version of Warbler
+    warble war         # Create the project .war file
+    warble war:clean   # Remove the .war file
+    warble war:debug   # Dump diagnostic information
 
 If you'd like to control Warbler from your own project's Rakefile,
 simply add the following code somewhere in the Rakefile:
@@ -35,6 +38,31 @@ simply add the following code somewhere in the Rakefile:
 
 Now you should be able to invoke "rake war" to create your war file.
 
+== Features
+
+Warbler "features" are small Rake tasks that run before the creation
+of the war file and make manipulations to the war file structure.
+
+You can either add features to the warbler command line:
+
+    warble FEATURE war
+
+or configure them in config/warble.rb to always be used.
+
+   config.features = %w(FEATURE)
+
+Currently, two features are available.
+
+* +gemjar+: This bundles all gems into a single gem file to reduce the
+  number of files in the .war. This is mostly useful for Google
+  AppEngine where the number of files per application has a limit.
+* +executable+: This bundles an embedded web server into the .war so
+  that it can either be deployed into a traditional java web server or
+  run as a standalone application using 'java -jar myapp.war'.
+
+Features may form the basis for a third-party plugin system in the
+future if there is demand.
+
 == Configuration
 
 === Bundler
@@ -62,10 +90,11 @@ dependencies are packaged.
 
 === Other Rack-based applications
 
-If you have a 'config.ru' file in the top directory of your application, its
-contents will be used as the rackup script for your Rack-based application.
-You will probably need to specify framework and application gems in
-config/warble.rb.
+If you have a 'config.ru' file in the top directory or one of the
+immediate subdirectories of your application, it will be included and
+used as the rackup script for your Rack-based application. You will
+probably need to specify framework and application gems in
+config/warble.rb unless you're using Bundler to manage your gems.
 
 See {the examples in the jruby-rack project}[http://github.com/nicksieger/jruby-rack/tree/master/examples/]
 of how to configure Warbler to package Camping and Sinatra apps.

data/Rakefile

@@ -33,7 +33,7 @@ begin
     p.summary = "Warbler chirpily constructs .war files of your Rails applications."
     p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
     p.description = p.paragraphs_of('README.txt', 1...2).join("\n\n")
-    p.extra_deps += [['rake', '>= 0.8.7'], ['jruby-jars', '>= 1.4.0'], ['jruby-rack', '>= 0.9.7'], ['rubyzip', '>= 0.9.4']]
+    p.extra_deps += [['rake', '>= 0.8.7'], ['jruby-jars', '>= 1.4.0'], ['jruby-rack', '>= 0.9.8'], ['rubyzip', '>= 0.9.4']]
     p.clean_globs += ['spec/sample/MANIFEST*', 'spec/sample/web.xml*']
   end
   hoe.spec.files = MANIFEST

data/ext/Main.java

@@ -0,0 +1,110 @@
+/**
+ * Copyright (c) 2010 Engine Yard, Inc.
+ * This source code is available under the MIT license.
+ * See the file LICENSE.txt for details.
+ */
+
+import java.net.URLClassLoader;
+import java.net.URL;
+import java.lang.reflect.Method;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.File;
+import java.io.FileOutputStream;
+import java.util.Arrays;
+
+public class Main implements Runnable {
+    public static final String MAIN = "/" + Main.class.getName().replace('.', '/') + ".class";
+    public static final String WINSTONE_JAR = "/WEB-INF/winstone.jar";
+
+    private String[] args;
+    private String path, warfile;
+    private boolean debug;
+    private File webroot;
+
+    public Main(String[] args) throws Exception {
+        this.args = args;
+        URL mainClass = getClass().getResource(MAIN);
+        this.path = mainClass.toURI().getSchemeSpecificPart();
+        this.warfile = mainClass.getFile().replace("!" + MAIN, "").replace("file:", "");
+        this.debug = isDebug();
+        this.webroot = File.createTempFile("winstone", "webroot");
+        this.webroot.delete();
+        this.webroot.mkdirs();
+        this.webroot = new File(this.webroot, new File(warfile).getName());
+        Runtime.getRuntime().addShutdownHook(new Thread(this));
+    }
+
+    private URL extractWinstone() throws Exception {
+        InputStream jarStream = new URL("jar:" + path.replace(MAIN, WINSTONE_JAR)).openStream();
+        File jarFile = File.createTempFile("winstone", ".jar");
+        jarFile.deleteOnExit();
+        FileOutputStream outStream = new FileOutputStream(jarFile);
+        try {
+            byte[] buf = new byte[4096];
+            int bytesRead = 0;
+            while ((bytesRead = jarStream.read(buf)) != -1) {
+                outStream.write(buf, 0, bytesRead);
+            }
+        } finally {
+            jarStream.close();
+            outStream.close();
+        }
+        debug("winstone.jar extracted to " + jarFile.getPath());
+        return jarFile.toURI().toURL();
+    }
+
+    private void launchWinstone(URL jar) throws Exception {
+        URLClassLoader loader = new URLClassLoader(new URL[] {jar});
+        Class klass = Class.forName("winstone.Launcher", true, loader);
+        Method main = klass.getDeclaredMethod("main", new Class[] {String[].class});
+        String[] newargs = new String[args.length + 2];
+        newargs[0] = "--warfile=" + warfile;
+        newargs[1] = "--webroot=" + webroot;
+        System.arraycopy(args, 0, newargs, 2, args.length);
+        debug("invoking Winstone with: " + Arrays.deepToString(newargs));
+        main.invoke(null, new Object[] {newargs});
+    }
+
+    private void start() throws Exception {
+        URL u = extractWinstone();
+        launchWinstone(u);
+    }
+
+    private void debug(String msg) {
+        if (debug) {
+            System.out.println(msg);
+        }
+    }
+
+    private void delete(File f) {
+        if (f.isDirectory()) {
+            File[] children = f.listFiles();
+            for (int i = 0; i < children.length; i++) {
+                delete(children[i]);
+            }
+        }
+        f.delete();
+    }
+
+    public void run() {
+        delete(webroot.getParentFile());
+    }
+
+    public static void main(String[] args) {
+        try {
+            new Main(args).start();
+        } catch (Exception e) {
+            System.err.println("error: " + e.toString());
+            if (isDebug()) {
+                e.printStackTrace();
+            }
+            System.exit(1);
+        }
+    }
+
+    private static boolean isDebug() {
+        return System.getProperty("warbler.debug") != null;
+    }
+}
+

data/lib/warbler/application.rb

@@ -26,38 +26,20 @@ class Warbler::Application < Rake::Application
 
     task :default => :war
 
-    desc "Generate a configuration file to customize your war assembly"
-    task :config do
-      if File.exists?(Warbler::Config::FILE) && ENV["FORCE"].nil?
-        puts "There's another bird sitting on my favorite branch"
-        puts "(file '#{Warbler::Config::FILE}' already exists. Pass argument FORCE=1 to override)"
-      elsif !File.directory?("config")
-        puts "I'm confused; my favorite branch is missing"
-        puts "(directory 'config' is missing)"
-      else
-        cp "#{Warbler::WARBLER_HOME}/warble.rb", Warbler::Config::FILE
-      end
-    end
+    desc "Generate a configuration file to customize your war"
+    task :config => "war:config"
 
-    desc "Install Warbler tasks in your Rails application for use by Rake"
-    task :pluginize do
-      if !Dir["vendor/plugins/warbler*"].empty? && ENV["FORCE"].nil?
-        puts "I found an old nest in vendor/plugins; please trash it so I can make a new one"
-        puts "(directory vendor/plugins/warbler* exists)"
-      else
-        rm_rf FileList["vendor/plugins/warbler*"], :verbose => false
-        mkdir_p "vendor/plugins/warbler/tasks"
-        File.open("vendor/plugins/warbler/tasks/warbler.rake", "w") do |f|
-          f.puts "require 'warbler'"
-          f.puts "Warbler::Task.new"
-        end
-      end
-    end
+    desc "Install Warbler tasks in your Rails application"
+    task :pluginize => "war:pluginize"
+
+    desc "Feature: package gem repository inside a jar"
+    task :gemjar => "war:gemjar"
+
+    desc "Feature: make an executable archive"
+    task :executable => "war:executable"
 
     desc "Display version of Warbler"
-    task :version do
-      puts "Warbler version #{Warbler::VERSION}"
-    end
+    task :version => "war:version"
   end
 
   # Loads the project Rakefile in a separate application

data/lib/warbler/config.rb

@@ -15,17 +15,15 @@ module Warbler
     DEFAULT_GEM_PATH = '/WEB-INF/gems'
     BUILD_GEMS = %w(warbler rake rcov)
 
+    # Features: additional options controlling how the jar is built.
+    # Currently the following features are supported:
+    # - gemjar: package the gem repository in a jar file in WEB-INF/lib
+    # - executable: embed a web server and make the war executable
+    attr_accessor :features
+
     # Deprecated: No longer has any effect.
     attr_accessor :staging_dir
 
-    # A hash of files that Warbler will build into the .war file. Keys
-    # to the hash are filenames in the .war, values are either nil
-    # (for a directory entry), the source filenames or IO objects for
-    # temporary file contents. This will be filled with files by the
-    # various Warbler tasks as they run. You can add arbitrary
-    # filenames to this hash if you wish.
-    attr_accessor :files
-
     # Directory where the war file will be written. Can be used to direct
     # Warbler to place your war file directly in your application server's
     # autodeploy directory. Defaults to the root of the Rails directory.
@@ -113,6 +111,7 @@ module Warbler
 
     def initialize(warbler_home = WARBLER_HOME)
       @warbler_home = warbler_home
+      @features    = []
       @dirs        = TOP_DIRS.select {|d| File.directory?(d)}
       @includes    = FileList[]
       @excludes    = FileList[]
@@ -284,9 +283,9 @@ module Warbler
     end
 
     def auto_detect_rackup
-      return false unless File.exist?("config.ru")
+      return false unless File.exist?("config.ru") || !Dir['*/config.ru'].empty?
       @webxml.booter = :rack
-      @webxml.rackup = File.read("config.ru")
+      @webinf_files += [FileList['config.ru', '*/config.ru'].detect {|f| File.exist?(f)}]
       true
     end
   end

data/lib/warbler/task.rb

@@ -60,15 +60,29 @@ module Warbler
       namespace name do
         define_clean_task
         define_files_task
-        define_gemjar_task
         define_jar_task
         define_debug_task
+        define_gemjar_task
+        define_config_task
+        define_pluginize_task
+        define_executable_task
+        define_version_task
       end
     end
 
     def define_main_task
       desc "Create the project .war file"
       task @name do
+        unless @config.features.empty?
+          @config.features.each do |feature|
+            t = "#@name:#{feature}"
+            unless Rake.application.lookup(t)
+              warn "unknown feature `#{feature}', ignoring"
+              next
+            end
+            Rake::Task[t].invoke
+          end
+        end
         # Invoke this way so custom dependencies can be defined before
         # the file find routine is run
         ["#{@name}:files", "#{@name}:jar"].each do |t|
@@ -91,21 +105,6 @@ module Warbler
       end
     end
 
-    def define_gemjar_task
-      gem_jar = Warbler::War.new
-      task "gemjar" => "files" do
-        gem_path = Regexp::quote(config.relative_gem_path)
-        gems = war.files.select{|k,v| k =~ %r{#{gem_path}/} }
-        gems.each do |k,v|
-          gem_jar.files[k.sub(%r{#{gem_path}/}, '')] = v
-        end
-        war.files["WEB-INF/lib/gems.jar"] = "tmp/gems.jar"
-        war.files.reject!{|k,v| k =~ /#{gem_path}/ }
-        mkdir_p "tmp"
-        gem_jar.create("tmp/gems.jar")
-      end
-    end
-
     def define_jar_task
       task "jar" do
         war.create(config)
@@ -128,5 +127,91 @@ module Warbler
         puts *war.webinf_filelist.exclude
       end
     end
+
+    def define_gemjar_task
+      task "gemjar" do
+        task "#@name:jar" => "#@name:make_gemjar"
+      end
+
+      gem_jar = Warbler::War.new
+      task "make_gemjar" => "files" do
+        gem_path = Regexp::quote(config.relative_gem_path)
+        gems = war.files.select{|k,v| k =~ %r{#{gem_path}/} }
+        gems.each do |k,v|
+          gem_jar.files[k.sub(%r{#{gem_path}/}, '')] = v
+        end
+        war.files["WEB-INF/lib/gems.jar"] = "tmp/gems.jar"
+        war.files.reject!{|k,v| k =~ /#{gem_path}/ }
+        mkdir_p "tmp"
+        gem_jar.add_manifest
+        gem_jar.create("tmp/gems.jar")
+      end
+    end
+
+    def define_config_task
+      task "config" do
+        if File.exists?(Warbler::Config::FILE) && ENV["FORCE"].nil?
+          puts "There's another bird sitting on my favorite branch"
+          puts "(file '#{Warbler::Config::FILE}' already exists. Pass argument FORCE=1 to override)"
+        elsif !File.directory?("config")
+          puts "I'm confused; my favorite branch is missing"
+          puts "(directory 'config' is missing)"
+        else
+          cp "#{Warbler::WARBLER_HOME}/warble.rb", Warbler::Config::FILE
+        end
+      end
+    end
+
+    def define_pluginize_task
+      task "pluginize" do
+        if !Dir["vendor/plugins/warbler*"].empty? && ENV["FORCE"].nil?
+          puts "I found an old nest in vendor/plugins; please trash it so I can make a new one"
+          puts "(directory vendor/plugins/warbler* exists)"
+        else
+          rm_rf FileList["vendor/plugins/warbler*"], :verbose => false
+          mkdir_p "vendor/plugins/warbler/tasks"
+          File.open("vendor/plugins/warbler/tasks/warbler.rake", "w") do |f|
+            f.puts "require 'warbler'"
+            f.puts "Warbler::Task.new"
+          end
+        end
+      end
+    end
+
+    def define_executable_task
+      winstone_type = ENV["WINSTONE"] || "winstone-lite"
+      winstone_version = ENV["WINSTONE_VERSION"] || "0.9.10"
+      winstone_path = "net/sourceforge/winstone/#{winstone_type}/#{winstone_version}/#{winstone_type}-#{winstone_version}.jar"
+      winstone_jar = File.expand_path("~/.m2/repository/#{winstone_path}")
+      file winstone_jar do |t|
+        # Not always covered in tests as these lines may not get
+        # executed every time if the jar is cached.
+        puts "Downloading #{winstone_type}.jar" #:nocov:
+        mkdir_p File.dirname(t.name)            #:nocov:
+        require 'open-uri'                      #:nocov:
+        maven_repo = ENV["MAVEN_REPO"] || "http://repo2.maven.org/maven2" #:nocov:
+        open("#{maven_repo}/#{winstone_path}") do |stream| #:nocov:
+          File.open(t.name, "wb") do |f|  #:nocov:
+            while buf = stream.read(4096) #:nocov:
+              f << buf                    #:nocov:
+            end                           #:nocov:
+          end                             #:nocov:
+        end                               #:nocov:
+      end
+
+      task "executable" => winstone_jar do
+        war.files['META-INF/MANIFEST.MF'] = StringIO.new(War::DEFAULT_MANIFEST.chomp + "Main-Class: Main\n")
+        war.files['Main.class'] = Zip::ZipFile.open("#{WARBLER_HOME}/lib/warbler_war.jar") do |zf|
+          zf.get_input_stream('Main.class') {|io| StringIO.new(io.read) }
+        end
+        war.files['WEB-INF/winstone.jar'] = winstone_jar
+      end
+    end
+
+    def define_version_task
+      task "version" do
+        puts "Warbler version #{Warbler::VERSION}"
+      end
+    end
   end
 end

data/lib/warbler/version.rb

@@ -6,5 +6,5 @@
 #++
 
 module Warbler
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/lib/warbler/war.rb

@@ -1,3 +1,5 @@
+require 'zip/zip'
+
 module Warbler
   # Class that holds the files that will be stored in the war file.
   # The #files attribute contains a hash of pathnames inside the war
@@ -6,6 +8,8 @@ module Warbler
   # * Any object responding to +read+ representing an in-memory blob
   # * A String filename pointing to a file on disk
   class War
+    DEFAULT_MANIFEST = %{Manifest-Version: 1.0\nCreated-By: Warbler #{Warbler::VERSION}\n\n}
+
     attr_reader :files
     attr_reader :webinf_filelist
 
@@ -56,11 +60,13 @@ module Warbler
     end
 
     # Add a manifest file either from config or by making a default manifest.
-    def add_manifest(config)
-      if config.manifest_file
-        @files['META-INF/MANIFEST.MF'] = config.manifest_file
-      else
-        @files['META-INF/MANIFEST.MF'] = StringIO.new(%{Manifest-Version: 1.0\nCreated-By: Warbler #{VERSION}\n\n})
+    def add_manifest(config = nil)
+      unless @files.keys.detect{|k| k =~ /^META-INF\/MANIFEST\.MF$/i}
+        if config && config.manifest_file
+          @files['META-INF/MANIFEST.MF'] = config.manifest_file
+        else
+          @files['META-INF/MANIFEST.MF'] = StringIO.new(DEFAULT_MANIFEST)
+        end
       end
     end
 

data/lib/warbler.rb

@@ -28,10 +28,10 @@ module Warbler
   self.framework_detection = true
 end
 
+require 'warbler/version'
 require 'warbler/gems'
 require 'warbler/config'
 require 'warbler/war'
 require 'warbler/task'
 require 'warbler/application'
 require 'warbler/runtime'
-require 'warbler/version'

data/spec/warbler/application_spec.rb

@@ -77,7 +77,6 @@ describe Warbler::Application do
 
   it "should define a pluginize task for adding the tasks to a Rails application" do
     ARGV.unshift "pluginize"
-#     silence { Warbler::Application.new.run }
     Warbler::Application.new.run
     File.exist?("vendor/plugins/warbler/tasks/warbler.rake").should be_true
   end
@@ -85,4 +84,10 @@ describe Warbler::Application do
   it "should provide a means to load the project Rakefile" do
     Warbler::Application.new.load_project_rakefile
   end
+
+  it "should define a gemjar task for setting up gem packaging inside a jar" do
+    ARGV.unshift "gemjar"
+    Warbler::Application.new.run
+    Rake::Task['war:jar'].prerequisites.should include('war:make_gemjar')
+  end
 end

data/spec/warbler/task_spec.rb

@@ -40,8 +40,8 @@ describe Warbler::Task do
     File.exist?(war_file).should == false
   end
 
-  it "should define a gemjar task for storing gems in a jar file" do
-    silence { Rake::Task["warble:gemjar"].invoke }
+  it "should define a make_gemjar task for storing gems in a jar file" do
+    silence { Rake::Task["warble:make_gemjar"].invoke }
     File.exist?("tmp/gems.jar").should == true
     @task.war.files.keys.should_not include(%r{WEB-INF\/gems})
     @task.war.files.keys.should include("WEB-INF/lib/gems.jar")
@@ -62,6 +62,22 @@ describe Warbler::Task do
     File.exist?("#{@config.war_name}.war").should == true
   end
 
+  it "should invoke feature tasks configured in config.features" do
+    @config.features << "gemjar"
+    silence { Rake::Task["warble"].invoke }
+    @task.war.files.keys.should include("WEB-INF/lib/gems.jar")
+  end
+
+  it "should warn and skip unknown features configured in config.features" do
+    @config.features << "bogus"
+    capture { Rake::Task["warble"].invoke }.should =~ /unknown feature `bogus'/
+  end
+
+  it "should define an executable task for embedding a server in the war file" do
+    silence { Rake::Task["warble:executable"].invoke }
+    @task.war.files.keys.should include('WEB-INF/winstone.jar')
+  end
+
   it "should be able to define all tasks successfully" do
     Warbler::Task.new "warble", @config
   end

data/spec/warbler/war_spec.rb

@@ -158,6 +158,12 @@ describe Warbler::War do
     @war.files['META-INF/MANIFEST.MF'].should == "manifest"
   end
 
+  it "should not add a manifest if one already exists" do
+    @war.files['META-INF/MANIFEST.MF'] = 'manifest'
+    @war.add_manifest(@config)
+    @war.files['META-INF/MANIFEST.MF'].should == "manifest"
+  end
+
   it "should be able to exclude files from the .war" do
     @config.excludes += FileList['lib/tasks/utils.rake']
     @war.apply(@config)
@@ -290,8 +296,8 @@ describe Warbler::War do
     rackup = "run Proc.new {|env| [200, {}, ['Hello World']]}"
     File.open("config.ru", "w") {|f| f << rackup }
     @config = Warbler::Config.new
-    @config.webxml.booter.should == :rack
-    @config.webxml.rackup.should == rackup
+    @war.apply(@config)
+    @war.files['WEB-INF/config.ru'].should == 'config.ru'
   end
 
   it "should automatically add Rails.configuration.gems to the list of gems" do

data/warble.rb

@@ -3,6 +3,11 @@
 
 # Warbler web application assembly configuration file
 Warbler::Config.new do |config|
+  # Features: additional options controlling how the jar is built.
+  # Currently the following features are supported:
+  # - gemjar: package the gem repository in a jar file in WEB-INF/lib
+  # config.features = %w(gemjar)
+
   # Application directories to be included in the webapp.
   config.dirs = %w(app config lib log vendor tmp)
 
@@ -93,8 +98,15 @@ Warbler::Config.new do |config|
   # config.webxml.booter = :rails
 
   # When using the :rack booter, "Rackup" script to use.
+  # - For 'rackup.path', the value points to the location of the rackup
+  # script in the web archive file. You need to make sure this file
+  # gets included in the war, possibly by adding it to config.includes
+  # or config.webinf_files above.
+  # - For 'rackup', the rackup script you provide as an inline string
+  #   is simply embedded in web.xml.
   # The script is evaluated in a Rack::Builder to load the application.
   # Examples:
+  # config.webxml.rackup.path = 'WEB-INF/hello.ru'
   # config.webxml.rackup = %{require './lib/demo'; run Rack::Adapter::Camping.new(Demo)}
   # config.webxml.rackup = require 'cgi' && CGI::escapeHTML(File.read("config.ru"))
 

metadata

@@ -3,90 +3,90 @@ name: warbler
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-    - 1
-    - 0
-    - 3
-  version: 1.0.3
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
-  - Nick Sieger
+- Nick Sieger
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-05-11 00:00:00 -05:00
+date: 2010-05-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: rake
-    version_requirements: &id001 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            segments: 
-              - 0
-              - 8
-              - 7
-            version: 0.8.7
-    prerelease: false
-    type: :runtime
-    requirement: *id001
-  - !ruby/object:Gem::Dependency 
-    name: jruby-jars
-    version_requirements: &id002 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            segments: 
-              - 1
-              - 4
-              - 0
-            version: 1.4.0
-    prerelease: false
-    type: :runtime
-    requirement: *id002
-  - !ruby/object:Gem::Dependency 
-    name: jruby-rack
-    version_requirements: &id003 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            segments: 
-              - 0
-              - 9
-              - 7
-            version: 0.9.7
-    prerelease: false
-    type: :runtime
-    requirement: *id003
-  - !ruby/object:Gem::Dependency 
-    name: rubyzip
-    version_requirements: &id004 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            segments: 
-              - 0
-              - 9
-              - 4
-            version: 0.9.4
-    prerelease: false
-    type: :runtime
-    requirement: *id004
-  - !ruby/object:Gem::Dependency 
-    name: rubyforge
-    version_requirements: &id005 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            segments: 
-              - 2
-              - 0
-              - 4
-            version: 2.0.4
-    prerelease: false
-    type: :development
-    requirement: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  prerelease: false
+  type: :runtime
+  name: rake
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  prerelease: false
+  type: :runtime
+  name: jruby-jars
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  prerelease: false
+  type: :runtime
+  name: jruby-rack
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 4
+        version: 0.9.4
+  prerelease: false
+  type: :runtime
+  name: rubyzip
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  prerelease: false
+  type: :development
+  name: rubyforge
+  version_requirements: *id005
 description: |-
   Warbler is a gem to make a .war file out of a Rails, Merb, or Rack-based
   application. The intent is to provide a minimal, flexible, ruby-like way to
@@ -94,87 +94,88 @@ description: |-
   server.
 email: nick@nicksieger.com
 executables: 
-  - warble
+- warble
 extensions: []
 
 extra_rdoc_files: 
-  - History.txt
-  - LICENSE.txt
-  - Manifest.txt
-  - README.txt
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
 files: 
-  - Gemfile
-  - History.txt
-  - LICENSE.txt
-  - Manifest.txt
-  - README.txt
-  - Rakefile
-  - bin/warble
-  - ext/WarblerWar.java
-  - ext/WarblerWarService.java
-  - lib/warbler.rb
-  - lib/warbler/application.rb
-  - lib/warbler/config.rb
-  - lib/warbler/gems.rb
-  - lib/warbler/runtime.rb
-  - lib/warbler/task.rb
-  - lib/warbler/version.rb
-  - lib/warbler/war.rb
-  - lib/warbler_war.jar
-  - spec/sample/app/controllers/application.rb
-  - spec/sample/app/helpers/application_helper.rb
-  - spec/sample/config/boot.rb
-  - spec/sample/config/database.yml
-  - spec/sample/config/environment.rb
-  - spec/sample/config/environments/development.rb
-  - spec/sample/config/environments/production.rb
-  - spec/sample/config/environments/test.rb
-  - spec/sample/config/initializers/inflections.rb
-  - spec/sample/config/initializers/mime_types.rb
-  - spec/sample/config/initializers/new_rails_defaults.rb
-  - spec/sample/config/routes.rb
-  - spec/sample/lib/tasks/utils.rake
-  - spec/sample/public/404.html
-  - spec/sample/public/422.html
-  - spec/sample/public/500.html
-  - spec/sample/public/favicon.ico
-  - spec/sample/public/index.html
-  - spec/sample/public/robots.txt
-  - spec/spec_helper.rb
-  - spec/warbler/application_spec.rb
-  - spec/warbler/config_spec.rb
-  - spec/warbler/gems_spec.rb
-  - spec/warbler/task_spec.rb
-  - spec/warbler/war_spec.rb
-  - warble.rb
-  - web.xml.erb
+- Gemfile
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/warble
+- ext/Main.java
+- ext/WarblerWar.java
+- ext/WarblerWarService.java
+- lib/warbler.rb
+- lib/warbler/application.rb
+- lib/warbler/config.rb
+- lib/warbler/gems.rb
+- lib/warbler/runtime.rb
+- lib/warbler/task.rb
+- lib/warbler/version.rb
+- lib/warbler/war.rb
+- lib/warbler_war.jar
+- spec/sample/app/controllers/application.rb
+- spec/sample/app/helpers/application_helper.rb
+- spec/sample/config/boot.rb
+- spec/sample/config/database.yml
+- spec/sample/config/environment.rb
+- spec/sample/config/environments/development.rb
+- spec/sample/config/environments/production.rb
+- spec/sample/config/environments/test.rb
+- spec/sample/config/initializers/inflections.rb
+- spec/sample/config/initializers/mime_types.rb
+- spec/sample/config/initializers/new_rails_defaults.rb
+- spec/sample/config/routes.rb
+- spec/sample/lib/tasks/utils.rake
+- spec/sample/public/404.html
+- spec/sample/public/422.html
+- spec/sample/public/500.html
+- spec/sample/public/favicon.ico
+- spec/sample/public/index.html
+- spec/sample/public/robots.txt
+- spec/spec_helper.rb
+- spec/warbler/application_spec.rb
+- spec/warbler/config_spec.rb
+- spec/warbler/gems_spec.rb
+- spec/warbler/task_spec.rb
+- spec/warbler/war_spec.rb
+- warble.rb
+- web.xml.erb
 has_rdoc: true
 homepage: http://caldersphere.rubyforge.org/warbler
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-  - --main
-  - README.txt
-  - -SHN
-  - -f
-  - darkfish
+- --main
+- README.txt
+- -SHN
+- -f
+- darkfish
 require_paths: 
-  - lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-          - 0
-        version: "0"
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-          - 0
-        version: "0"
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: caldersphere