warbler 0.9.14 → 1.0

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org/"
+
+gem "rake", ">= 0.8.7"
+gem "rubyzip"
+gem "jruby-jars"
+gem "jruby-rack"
+gem "rspec"
+gem "diff-lcs"
+gem "rcov", ">= 0.9.8"
+gem "hoe", ">= 2.3.2"

data/History.txt

@@ -1,3 +1,19 @@
+== 1.0
+
+* 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
+  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
+  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
+  custom web.xml files
+
 == 0.9.14
 
 * So, jruby-rack is bundled for one more release. 1.0 will not contain

data/{LICENSES.txt → LICENSE.txt}

@@ -2,7 +2,8 @@
 
 Warbler is provided under the terms of the MIT license.
 
-(c) Copyright 2007-2008 Sun Microsystems, Inc.
+Warbler (c) 2010 Engine Yard, Inc.
+Warbler (c) 2007-2009 Sun Microsystems, Inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation files
@@ -23,15 +24,3 @@ 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/Manifest.txt

@@ -1,24 +1,26 @@
+Gemfile
 History.txt
+LICENSE.txt
 Manifest.txt
 README.txt
-LICENSES.txt
 Rakefile
-web.xml.erb
 bin/warble
-generators/warble
-generators/warble/templates
-generators/warble/templates/warble.rb
-generators/warble/warble_generator.rb
-lib/jruby-rack-0.9.5.jar
+ext/WarblerWar.java
+ext/WarblerWarService.java
 lib/warbler
+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.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
@@ -27,8 +29,18 @@ 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
-tasks/warbler.rake
+spec/warbler/war_spec.rb
+warble.rb
+web.xml.erb

data/README.txt

@@ -9,11 +9,6 @@ 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>.
@@ -23,26 +18,32 @@ dependencies are downloaded.
 == 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
-
-Warbler makes heavy use of Rake's file and directory tasks, so only recently
-updated files will be copied, making repeated assemblies much faster.
+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
+
+If you'd like to control Warbler from your own project's Rakefile,
+simply add the following code somewhere in the Rakefile:
+
+    require 'warbler'
+    Warbler::Task.new
+
+Now you should be able to invoke "rake war" to create your war file.
 
 == Configuration
 
+=== Bundler
+
+Applications that use Bundler (http://gembundler.com/), detected via
+presence of a +Gemfile+, will have the gems packaged up into the war
+file. The .bundle/environment.rb file will be included for you, and
+rewritten to use the paths to the gems inside the war.
+
 === Rails applications
 
 Rails applications are detected automatically and configured appropriately.
@@ -50,7 +51,7 @@ 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)
+  (Rails 2.1 - 2.3)
 * Multi-thread-safe execution (as introduced in Rails 2.2) is detected
   and runtime pooling is disabled.
 
@@ -98,25 +99,9 @@ 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.
+Finally, edit the config/warble.rb to your taste. The generated
+config/warble.rb file is fully-documented with the available options
+and default values.
 
 === Web.xml
 
@@ -140,13 +125,8 @@ 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>.
+If Warbler isn't packaging the files you were expecting, use the
+war:debug task to give you more insight into what's going on.
 
 == Source
 
@@ -159,12 +139,17 @@ You can get the Warbler source using Git, in any of the following ways:
 You can also download a tarball of Warbler source at
 http://github.com/nicksieger/warbler/tree/master.
 
+== Development
+
+You can develop Warbler with any implementation of Ruby. To write
+Warbler code and run specs, you need to have Bundler installed
+and run "bundle install" once.
+
+After that, simply run "rake".
+
 == License
 
 Warbler is provided under the terms of the MIT license.
 
+Warbler (c) 2010 Engine Yard, Inc.
 Warbler (c) 2007-2009 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

@@ -1,8 +1,24 @@
+#--
+# Copyright (c) 2010 Engine Yard, Inc.
+# Copyright (c) 2007-2009 Sun Microsystems, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+begin
+  require 'bundler'
+  Bundler.setup
+rescue LoadError
+  puts "Please install Bundler and run 'bundle install' to ensure you have all dependencies"
+end
+
 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"]
+MANIFEST = FileList["History.txt", "Manifest.txt", "README.txt", "Gemfile",
+                    "LICENSE.txt", "Rakefile", "*.erb", "*.rb", "bin/*",
+                    "ext/**/*", "lib/**/*", "spec/**/*.rb", "spec/sample/**/*.*"
+                   ].to_a.reject{|f| f=~%r{spec/sample/(MANIFEST|web.xml)}}.sort.uniq
 
 begin
   File.open("Manifest.txt", "w") {|f| MANIFEST.each {|n| f << "#{n}\n"} }
@@ -17,8 +33,8 @@ 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.7.3'], ['jruby-jars', '>= 1.3.1']]
-    p.test_globs = ["spec/**/*_spec.rb"]
+    p.extra_deps += [['rake', '>= 0.8.7'], ['jruby-jars', '>= 1.4.0'], ['jruby-rack', '>= 0.9.7'], ['rubyzip', '>= 0.9.4']]
+    p.clean_globs += ['spec/sample/MANIFEST*', 'spec/sample/web.xml*']
   end
   hoe.spec.files = MANIFEST
   hoe.spec.dependencies.delete_if { |dep| dep.name == "hoe" }
@@ -31,15 +47,10 @@ 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[]
-Rake::Task['default'].send :instance_variable_set, "@actions", []
-
-if defined?(JRUBY_VERSION)
-  task :default => :spec
-else
-  task :default => :rcov_verify
+# Leave my tasks alone, Hoe
+%w(default spec rcov).each do |task|
+  Rake::Task[task].prerequisites.clear
+  Rake::Task[task].actions.clear
 end
 
 Spec::Rake::SpecTask.new do |t|
@@ -48,12 +59,33 @@ Spec::Rake::SpecTask.new do |t|
 end
 
 Spec::Rake::SpecTask.new("spec:rcov") do |t|
+  t.spec_opts ||= []
+  t.spec_opts << "--options" << "spec/spec.opts"
   t.rcov = true
 end
 
-# so we don't confuse autotest
-RCov::VerifyTask.new(:rcov_verify) do |t|
+RCov::VerifyTask.new(:rcov => "spec:rcov") do |t|
   t.threshold = 100
 end
 
-task :rcov_verify => "spec:rcov"
+task :default => :spec
+
+begin
+  require 'ant'
+  directory "pkg/classes"
+  task :compile => "pkg/classes" do |t|
+    ant.javac :srcdir => "ext", :destdir => t.prerequisites.first,
+    :source => "1.5", :target => "1.5", :debug => true,
+    :classpath => "${java.class.path}:${sun.boot.class.path}"
+  end
+
+  task :jar => :compile do
+    ant.jar :basedir => "pkg/classes", :destfile => "lib/warbler_war.jar", :includes => "*.class"
+  end
+rescue LoadError
+  task :jar do
+    puts "Run 'jar' with JRuby >= 1.5 to re-compile the java war booster"
+  end
+end
+
+task :package => :jar

data/bin/warble

@@ -1,68 +1,11 @@
 #!/usr/bin/env ruby
 #
 #--
-# (c) Copyright 2007-2008 Sun Microsystems, Inc.
-# See the file LICENSES.txt included with the distribution for
-# software license details.
+# Copyright (c) 2010 Engine Yard, Inc.
+# Copyright (c) 2007-2009 Sun Microsystems, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for 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
+Warbler::Application.new.run

data/ext/WarblerWar.java

@@ -0,0 +1,113 @@
+/**
+ * Copyright (c) 2010 Engine Yard, Inc.
+ * This source code is available under the MIT license.
+ * See the file LICENSE.txt for details.
+ */
+
+import java.io.Closeable;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipOutputStream;
+
+import org.jruby.Ruby;
+import org.jruby.RubyArray;
+import org.jruby.RubyHash;
+import org.jruby.RubyModule;
+import org.jruby.RubyString;
+import org.jruby.anno.JRubyMethod;
+import org.jruby.runtime.Block;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+import org.jruby.util.JRubyFile;
+
+public class WarblerWar {
+    public static void create(Ruby runtime) {
+        RubyModule task = runtime.getClassFromPath("Warbler::War");
+        task.defineAnnotatedMethods(WarblerWar.class);
+    }
+
+    @JRubyMethod
+    public static IRubyObject create_war(ThreadContext context, IRubyObject recv, IRubyObject war_path, IRubyObject entries) {
+        final Ruby runtime = recv.getRuntime();
+
+        if (!(entries instanceof RubyHash)) {
+            throw runtime.newArgumentError("expected a hash for the second argument");
+        }
+
+        RubyHash hash = (RubyHash) entries;
+        try {
+            FileOutputStream file = newFile(war_path);
+            try {
+                ZipOutputStream zip = new ZipOutputStream(file);
+                addEntries(context, zip, hash);
+                zip.finish();
+            } finally {
+                close(file);
+            }
+        } catch (IOException e) {
+            e.printStackTrace();
+            throw runtime.newIOErrorFromException(e);
+        }
+
+        return runtime.getNil();
+    }
+
+    private static void addEntries(ThreadContext context, ZipOutputStream zip, RubyHash entries) throws IOException {
+        RubyArray keys = entries.keys().sort(context, Block.NULL_BLOCK);
+        for (int i = 0; i < keys.getLength(); i++) {
+            IRubyObject key = keys.entry(i);
+            IRubyObject value = entries.op_aref(context, key);
+            addEntry(context, zip, key.convertToString().getUnicodeValue(), value);
+        }
+    }
+
+    private static void addEntry(ThreadContext context, ZipOutputStream zip, String entryName, IRubyObject value) throws IOException {
+        if (value.respondsTo("read")) {
+            RubyString str = (RubyString) value.callMethod(context, "read").checkStringType();
+            byte[] contents = str.getByteList().getUnsafeBytes();
+            zip.putNextEntry(new ZipEntry(entryName));
+            zip.write(contents);
+        } else {
+            File f;
+            if (value.isNil() || (f = getFile(value)).isDirectory()) {
+                zip.putNextEntry(new ZipEntry(entryName + "/"));
+            } else {
+                FileInputStream inFile = openFile(f);
+                try {
+                    zip.putNextEntry(new ZipEntry(entryName));
+                    byte[] buf = new byte[16384];
+                    int bytesRead = -1;
+                    while ((bytesRead = inFile.read(buf)) != -1) {
+                        zip.write(buf, 0, bytesRead);
+                    }
+                } finally {
+                    close(inFile);
+                }
+            }
+        }
+    }
+
+    private static FileOutputStream newFile(IRubyObject war_path) throws IOException {
+        return new FileOutputStream(getFile(war_path));
+    }
+
+    private static FileInputStream openFile(File file) throws IOException {
+        return new FileInputStream(file);
+    }
+
+    private static File getFile(IRubyObject path) {
+        return JRubyFile.create(path.getRuntime().getCurrentDirectory(),
+                                path.convertToString().getUnicodeValue());
+    }
+
+    private static void close(Closeable c) {
+        try {
+            c.close();
+        } catch (IOException e) {
+        }
+    }
+
+}