warbler 1.0 → 1.0.1

data/Gemfile

@@ -1,6 +1,7 @@
 source "http://rubygems.org/"
 
 gem "rake", ">= 0.8.7"
+gem "rdoc"
 gem "rubyzip"
 gem "jruby-jars"
 gem "jruby-rack"

data/History.txt

@@ -1,3 +1,7 @@
+== 1.0.1
+
+* 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

data/README.txt

@@ -39,7 +39,7 @@ Now you should be able to invoke "rake war" to create your war file.
 
 === Bundler
 
-Applications that use Bundler (http://gembundler.com/), detected via
+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.
@@ -67,16 +67,18 @@ 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 <a href="http://jruby-rack.kenai.com/sources/main/show/examples">the examples in the jruby-rack project</a>
+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.
 
 === 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.
+* Warbler will load the "environment" Rake task in a Rails application
+  to try to detect some configuration. 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 that would normally be
+  gleaned from the application configuration.
 * 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.
@@ -110,9 +112,10 @@ 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.
+   control, you may unzip the one generated for you in
+   <tt>yourapp.war:WEB-INF/web.xml</tt> to <tt>config/web.xml</tt> and
+   modify as needed. It will be copied into subsequent copies of the
+   war file 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

data/Rakefile

@@ -38,6 +38,7 @@ begin
   end
   hoe.spec.files = MANIFEST
   hoe.spec.dependencies.delete_if { |dep| dep.name == "hoe" }
+  hoe.spec.rdoc_options += ["-SHN", "-f", "darkfish"]
 
   task :gemspec do
     File.open("#{hoe.name}.gemspec", "w") {|f| f << hoe.spec.to_ruby }

data/lib/warbler/application.rb

@@ -7,6 +7,9 @@
 
 require 'rake'
 
+# Extension of Rake::Application that allows the +warble+ command to
+# report its name properly and inject its own tasks without a
+# Rakefile.
 class Warbler::Application < Rake::Application
   def initialize
     super
@@ -14,6 +17,7 @@ class Warbler::Application < Rake::Application
     @project_loaded = false
   end
 
+  # Sets the application name and loads Warbler's own tasks
   def load_rakefile
     @name = 'warble'
 
@@ -41,6 +45,7 @@ class Warbler::Application < Rake::Application
     end
   end
 
+  # Loads the project Rakefile in a separate application
   def load_project_rakefile
     return if @project_loaded
     # Load any application rakefiles to aid in autodetecting applications
@@ -56,6 +61,8 @@ class Warbler::Application < Rake::Application
     @project_loaded = true
   end
 
+  # Run the application: The equivalent code for the +warble+ command
+  # is simply <tt>Warbler::Application.new.run</tt>.
   def run
     Rake.application = self
     super

data/lib/warbler/config.rb

@@ -8,7 +8,7 @@
 require 'ostruct'
 
 module Warbler
-  # Warbler assembly configuration.
+  # Warbler war file assembly configuration class.
   class Config
     TOP_DIRS = %w(app config lib log vendor)
     FILE = "config/warble.rb"
@@ -69,8 +69,7 @@ module Warbler
     # the Rails application
     attr_accessor :war_name
 
-    # Name of the MANIFEST.MF template.  Defaults to the MANIFEST.MF normally generated
-    # by jar -cf....
+    # Name of a MANIFEST.MF template to use.
     attr_accessor :manifest_file
 
     # Files for WEB-INF directory (next to web.xml). Contains web.xml by default.
@@ -279,6 +278,7 @@ module Warbler
     end
   end
 
+  # Helper class for holding arbitrary config.webxml values for injecting into +web.xml+.
   class WebxmlOpenStruct < OpenStruct
     %w(java com org javax).each {|name| undef_method name if Object.methods.include?(name) }
 

data/lib/warbler/task.rb

@@ -13,6 +13,21 @@ require 'zip/zip'
 module Warbler
   # Warbler Rake task.  Allows defining multiple configurations inside the same
   # Rakefile by using different task names.
+  #
+  # To define multiple Warbler configurations in a single project, use
+  # code like the following in a Rakefile:
+  #
+  #     Warbler::Task.new("war1", Warbler::Config.new do |config|
+  #       config.war_name = "war1"
+  #       # ...
+  #     end
+  #     Warbler::Task.new("war2", Warbler::Config.new do |config|
+  #       config.war_name = "war2"
+  #       # ...
+  #     end
+  #
+  # With this setup, you can create two separate war files two
+  # different configurations by running <tt>rake war1 war2</tt>.
   class Task < Rake::TaskLib
     # Task name
     attr_accessor :name

data/lib/warbler/version.rb

@@ -6,5 +6,5 @@
 #++
 
 module Warbler
-  VERSION = "1.0"
+  VERSION = "1.0.1"
 end

data/lib/warbler/war.rb

@@ -1,4 +1,10 @@
 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
+  # file to their contents. Contents can be one of:
+  # * +nil+ representing a directory entry
+  # * Any object responding to +read+ representing an in-memory blob
+  # * A String filename pointing to a file on disk
   class War
     attr_reader :files
     attr_reader :webinf_filelist
@@ -7,6 +13,8 @@ module Warbler
       @files = {}
     end
 
+    # Apply the information in a Warbler::Config object in order to
+    # look for files to put into this war file.
     def apply(config)
       find_webinf_files(config)
       find_java_libs(config)
@@ -18,6 +26,8 @@ module Warbler
       add_bundler_files(config)
     end
 
+    # Create the war file. The single argument can either be a
+    # Warbler::Config or a filename of the war file to create.
     def create(config_or_path)
       war_path = config_or_path
       if Warbler::Config === config_or_path
@@ -30,6 +40,8 @@ module Warbler
       create_war war_path, @files
     end
 
+    # Add web.xml and other WEB-INF configuration files from
+    # config.webinf_files to the war file.
     def add_webxml(config)
       config.webinf_files.each do |wf|
         if wf =~ /\.erb$/
@@ -43,6 +55,7 @@ module Warbler
       end
     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
@@ -51,22 +64,27 @@ module Warbler
       end
     end
 
+    # Add java libraries to WEB-INF/lib.
     def find_java_libs(config)
       config.java_libs.map {|lib| add_with_pathmaps(config, lib, :java_libs) }
     end
 
+    # Add java classes to WEB-INF/classes.
     def find_java_classes(config)
       config.java_classes.map {|f| add_with_pathmaps(config, f, :java_classes) }
     end
 
+    # Add public/static assets to the root of the war file.
     def find_public_files(config)
       config.public_html.map {|f| add_with_pathmaps(config, f, :public_html) }
     end
 
+    # Add gems to WEB-INF/gems
     def find_gems_files(config)
       config.gems.each {|gem, version| find_single_gem_files(config, gem, version) }
     end
 
+    # Add a single gem to WEB-INF/gems
     def find_single_gem_files(config, gem_pattern, version = nil)
       if Gem::Specification === gem_pattern
         spec = gem_pattern
@@ -100,6 +118,7 @@ module Warbler
       spec.dependencies.each {|dep| find_single_gem_files(config, dep) } if config.gem_dependencies
     end
 
+    # Add all application directories and files to WEB-INF.
     def find_webinf_files(config)
       config.dirs.select do |d|
         exists = File.directory?(d)
@@ -114,6 +133,7 @@ module Warbler
       @webinf_filelist.map {|f| add_with_pathmaps(config, f, :application) }
     end
 
+    # Add Bundler Gemfile and .bundle/environment.rb to the war file.
     def add_bundler_files(config)
       if config.bundler
         @files[apply_pathmaps(config, 'Gemfile', :application)] = 'Gemfile'
@@ -164,6 +184,6 @@ module Warbler
     end
 
     # Java-boosted war creation for JRuby; replaces #create_war with Java version
-    require 'warbler_war' if defined?(JRUBY_VERSION)
+    require 'warbler_war' if defined?(JRUBY_VERSION) && JRUBY_VERSION >= "1.5"
   end
 end

data/lib/warbler.rb

@@ -11,11 +11,16 @@ module Warbler
   WARBLER_HOME = File.expand_path(File.dirname(__FILE__) + '/..') unless defined?(WARBLER_HOME)
 
   class << self
+    # An instance of Warbler::Application used by the +warble+ command.
     attr_accessor :application
+    # Set Warbler.framework_detection to false to disable
+    # auto-detection based on application configuration.
     attr_accessor :framework_detection
     attr_writer :project_application
   end
 
+  # Warbler loads the project Rakefile in a separate Rake application
+  # from the one where the Warbler tasks are run.
   def self.project_application
     application.load_project_rakefile if application
     @project_application || Rake.application

metadata

@@ -5,7 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  version: "1.0"
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Nick Sieger
@@ -13,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-05 00:00:00 -05:00
+date: 2010-04-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -155,6 +156,9 @@ post_install_message:
 rdoc_options: 
 - --main
 - README.txt
+- -SHN
+- -f
+- darkfish
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement