# README.txt

Path: | README.txt
Last Update: | Wed Dec 10 05:13:00 +0000 2008

# Warbler

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.

Warbler provides a sane set of out-of-the box defaults that should allow most Rails applications without external gem dependencies (aside from Rails itself) to assemble and Just Work.

Warbler bundles JRuby and the JRuby-Rack servlet adapter for dispatching requests to your application inside the java application server, and assembles all jar files in WARBLER_HOME/lib/*.jar into your application. No external dependencies are downloaded.

## Getting Started

1. Install the gem: `gem install warbler`.
2. Run warbler in the top directory of your Rails application: `warble`.
3. Deploy your railsapp.war file to your favorite Java application server.

## Usage

Warbler‘s `warble` command is just a small wrapper around Rake with internally defined tasks. (Notice "rake" still prints out in the message, but you should substitute "warble" for "rake" on the command line when running this way.)

        $ warble -T
        rake config         # Generate a configuration file to customize your war assembly
        rake pluginize      # Unpack warbler as a plugin in your Rails application
        rake war            # Create trunk.war
        rake war:app        # Copy all application files into the .war
        rake war:clean      # Clean up the .war file and the staging area
        rake war:gems       # Unpack all gems into WEB-INF/gems
        rake war:jar        # Run the jar command to create the .war
        rake war:java_libs  # Copy all java libraries into the .war
        rake war:public     # Copy all public HTML files to the root of the .war
        rake war:webxml     # Generate a web.xml file for the webapp

Warble makes heavy use of Rake‘s file and directory tasks, so only recently updated files will be copied, making repeated assemblies much faster.

## Configuration

The default configuration puts application files (`app`, `config`, `lib`, `log`, `vendor`, `tmp`) under the .war file‘s WEB-INF directory, and files in `public` in the root of the .war file. Any Java .jar files stored in lib will automatically be placed in WEB-INF/lib for placement on the web app‘s classpath.

To customize files, libraries, and gems included in the .war file, you‘ll need a config/warble.rb file. There a two ways of doing this. With the gem, simply run

        warble config

If you have Warbler installed as a plugin, use the generator:

        script/generate warble

Finally, edit the config/warble.rb to your taste. If you install the gem but later decide you‘d like to have it as a plugin, use the `pluginize` command:

        warble pluginize

If you wish to upgrade or switch one or more java libraries from what‘s bundled in the Warbler gem, simply change the jars in WARBLER_HOME/lib, or modify the `java_libs` attribute of Warbler::Config to include the files you need.

Once Warbler is installed as a plugin, you can use `rake` to build the war (with the same set of tasks as above).

### Web.xml

Java web applications are configured mainly through this file, and Warbler creates a suitable default file for you for use. However, if you need to customize it in any way, you have two options.

1. If you just want a static web.xml file whose contents you manually control, you may copy the one generated for you in `tmp/war/WEB-INF/web.xml` to `config/web.xml`. It will be copied into the webapp for you.
2. If you want to inject some dynamic information into the file, copy the `WARBLER_HOME/web.xml.erb` to `config/web.xml.erb`. Its contents will be evaluated for you and put in the webapp. Note that you can also pass arbitrary properties to the ERb template by setting `config.webxml.customkey` values in your `config/warble.rb` file.

For more information on configuration, see Warbler::Config.

### Troubleshooting

If Warbler isn‘t packaging the files you were expecting, there are several debug tasks available to give you more insight into what‘s going on.

- `war:debug` prints a YAML dump of the current configuration
- `war:debug:X` prints a list of files that Warbler will include during that stage of assembly. Valid values of `X` are `app, java_libs, gems, public, includes, excludes`.

## Source

You can get the Warbler source using Git, in any of the following ways:

        git clone git://git.caldersphere.net/warbler.git
        git clone http://git.caldersphere.net/warbler.git
        git clone git://github.com/nicksieger/warbler.git

You can also download a tarball of Warbler source at github.com/nicksieger/warbler/tree/master.

## License

Warbler is provided under the terms of the MIT license.

        Warbler (c) 2007-08 Sun Microsystems, Inc.

Warbler also bundles several other pieces of software for convenience. Please read the file LICENSES.txt to ensure that you agree with the terms of all the components.

[Validate]