fjc-warbler 0.9.12

data/History.txt

@@ -0,0 +1,91 @@
+== 0.9.12
+
+* 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
+  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.
+* Upgrade to JRuby 1.1.5 and JRuby-Rack 0.9.3
+
+== 0.9.11
+
+* 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
+  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
+ (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'
+
+== 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
+  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.
+
+== 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
+  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.
+
+== 0.9.5
+
+* 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
+
+== 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)
+
+== 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.
+
+== 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
+
+== 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,
+  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
+  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

data/LICENSES.txt

@@ -0,0 +1,37 @@
+= Warbler
+
+Warbler is provided under the terms of the MIT license.
+
+(c) Copyright 2007-2008 Sun Microsystems, Inc.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation files
+(the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+= Additional Bundled Software
+
+JRuby-Rack (jruby-rack-*.jar) is distributed under the terms of the MIT license.
+See http://svn.codehaus.org/jruby-contrib/trunk/rack/LICENSE.txt
+for details.
+
+JRuby (jruby-complete-*.jar) is distrubuted under the terms of the Common
+Public License. See http://www.eclipse.org/legal/cpl-v10.html for details. At
+your option, JRuby is also available under the GPL or LGPL licenses. See the
+file COPYING in the JRuby distribution for details
+(http://svn.codehaus.org/jruby/trunk/jruby/COPYING).

data/README.txt

@@ -0,0 +1,167 @@
+= Warbler
+
+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
+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: <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.
+
+== 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
+
+=== Rails applications
+
+Rails applications are detected automatically and configured appropriately.
+The following items are set up for you:
+
+* The Rails gem is packaged if you haven't vendored Rails.
+* Other gems configured in Rails.configuration.gems are packaged (Rails 2.1 or
+  later)
+* Multi-thread-safe execution (as introduced in Rails 2.2) is detected and
+  runtime pooling is disabled.
+
+=== Merb applications
+
+Merb applications are detected automatically, and the merb-core gem and its
+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.
+
+See http://github.com/nicksieger/jruby-rack/tree/master/examples for examples
+of how to configure Warbler to package Camping and Sinatra apps.
+
+=== Configuration auto-detect notes
+
+* If you don't have database access in the environment where you package your
+  application, you may wish to set `Warbler.framework_detection` to false at
+  the top of config.rb. In this case you may need to specify additional
+  details such as booter, gems and other settings.
+* A more accurate way of detecting a Merb application's gems is needed. Until
+  then, you will have to specify them in config/warble.rb. See below.
+* Is it possible to more generally detect what gems an application uses?
+  Gem.loaded_specs is available, but the application needs to be loaded first
+  before its contents are reliable.
+
+=== Custom 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.
+
+If the default settings are not appropriate for your application, you can
+customize Warbler's behavior. 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).
+
+The generated config/warble.rb file is fully-documented with the available
+options and default values.
+
+=== 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 <tt>tmp/war/WEB-INF/web.xml</tt>
+   to <tt>config/web.xml</tt> and modify as needed. It will be copied into the
+   webapp for you.
+2. If you want to inject some dynamic information into the file, copy the
+   <tt>WARBLER_HOME/web.xml.erb</tt> to <tt>config/web.xml.erb</tt>. 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
+   <tt>config.webxml.customkey</tt> values in your <tt>config/warble.rb</tt>
+   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.
+
+* <tt>war:debug</tt> prints a YAML dump of the current configuration
+* <tt>war:debug:X</tt> prints a list of files that Warbler will include during
+  that stage of assembly. Valid values of <tt>X</tt> are <tt>app, java_libs,
+  gems, public, includes, excludes</tt>.
+
+== 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
+http://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.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+
+MANIFEST = FileList["History.txt", "Manifest.txt", "README.txt", "LICENSES.txt", "Rakefile",
+  "*.erb", "bin/*", "generators/**/*", "lib/**/*", "spec/**/*.rb", "tasks/**/*.rake"]
+
+begin
+  File.open("Manifest.txt", "w") {|f| MANIFEST.each {|n| f << "#{n}\n"} }
+  require 'hoe'
+  require File.dirname(__FILE__) + '/lib/warbler/version'
+  hoe = Hoe.new("warbler", Warbler::VERSION) do |p|
+    p.rubyforge_name = "caldersphere"
+    p.url = "http://caldersphere.rubyforge.org/warbler"
+    p.author = "Nick Sieger"
+    p.email = "nick@nicksieger.com"
+    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', 0...1).join("\n\n")
+    p.extra_deps << ['rake', '>= 0.7.3']
+    p.test_globs = ["spec/**/*_spec.rb"]
+    p.rdoc_pattern = /\.(rb|txt)/
+  end
+  hoe.spec.files = MANIFEST
+  hoe.spec.dependencies.delete_if { |dep| dep.name == "hoe" }
+
+  task :gemspec do
+    File.open("#{hoe.name}.gemspec", "w") {|f| f << hoe.spec.to_ruby }
+  end
+  task :package => :gemspec
+rescue LoadError
+  puts "You really need Hoe installed to be able to package this gem"
+end
+
+# Hoe insists on setting task :default => :test
+# !@#$ no easy way to empty the default list of prerequisites
+Rake::Task['default'].send :instance_variable_set, "@prerequisites", FileList[]
+
+task :default => :rcov
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts ||= []
+  t.spec_opts << "--options" << "spec/spec.opts"
+end
+
+Spec::Rake::SpecTask.new("spec:rcov") do |t|
+  t.rcov = true
+  t.rcov_opts << '--exclude gems/*'
+end
+
+# so we don't confuse autotest
+RCov::VerifyTask.new(:rcov) do |t|
+  t.threshold = 100
+end
+
+task "spec:rcov" do
+  rm_f "Manifest.txt"
+end
+task :rcov => "spec:rcov"

data/bin/warble

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+#
+#--
+# (c) Copyright 2007-2008 Sun Microsystems, Inc.
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+require 'rubygems'
+require 'rake'
+require 'warbler'
+
+application = Rake.application
+
+# Load any application rakefiles to aid in autodetecting applications
+Warbler.project_application = Rake::Application.new
+Rake.application = Warbler.project_application
+Rake::Application::DEFAULT_RAKEFILES.each do |rf|
+  if File.exist?(rf)
+    load rf
+    break
+  end
+end
+
+Rake.application = application
+application.standard_exception_handling do
+  application.init
+
+  # Load the main warbler tasks
+  Warbler::Task.new
+
+  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}/generators/warble/templates/warble.rb", Warbler::Config::FILE
+    end
+  end
+
+  desc "Unpack warbler as a plugin in your Rails application"
+  task :pluginize do
+    if !Dir["vendor/plugins/warbler*"].empty?
+      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)"
+    elsif !File.directory?("vendor/plugins")
+      puts "I can't find a place to build my nest"
+      puts "(directory 'vendor/plugins' is missing)"
+    else
+      Dir.chdir("vendor/plugins") do
+        ruby "-S", "gem", "unpack", "warbler"
+      end
+    end
+  end
+
+  desc "Display version of warbler"
+  task :version do
+    puts "Warbler version #{Warbler::VERSION}"
+  end
+
+  application.top_level
+end

data/generators/warble/templates/warble.rb

@@ -0,0 +1,89 @@
+# 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(app config lib log vendor tmp)
+
+  # Additional files/directories to include, above those in config.dirs
+  # config.includes = FileList["db"]
+
+  # 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.
+  # The Rails gems are included by default unless the vendor/rails directory is present.
+  # config.gems += ["activerecord-jdbcmysql-adapter", "jruby-openssl"]
+  # config.gems << "tzinfo"
+
+  # Uncomment this if you don't want to package rails gem.
+  # config.gems -= ["rails"]
+
+  # The most recent versions of gems are used.
+  # You can specify versions of gems by using a hash assignment:
+  # config.gems["rails"] = "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) -- defaults to the basename
+  # of RAILS_ROOT
+  # config.war_name = "mywar"
+
+  # 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 RAILS_ENV for the webapp -- default as shown below
+  # config.webxml.rails.env = ENV['RAILS_ENV'] || 'production'
+
+  # Application booter to use, one of :rack, :rails, or :merb. (Default :rails)
+  # config.webxml.booter = :rails
+
+  # 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 Rails 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
+
+  # JNDI data source name
+  # config.webxml.jndi = 'jdbc/rails'
+end