warbler 1.2.0 → 1.2.1

data/History.txt

@@ -1,3 +1,13 @@
+== 1.2.1
+
+- Add --directoryListings=false to Winstone launch by default. In some
+  cases (sinatra) Winstone's directory listing masks application
+  content. (Fletcher Nichol)
+- Build and add META-INF/init.rb file into the war file. This is
+  recognized and loaded by JRuby-Rack 1.0.3 as a new way to do extra
+  environment initialization before the web framework is loaded. See
+  config.init_contents in Warbler::Config for details.
+
 == 1.2.0
 
 - Drop compatibility with earlier versions of Bundler -- Bundler has

data/Manifest.txt

@@ -14,6 +14,10 @@ lib/warbler/application.rb
 lib/warbler/config.rb
 lib/warbler/gems.rb
 lib/warbler/task.rb
+lib/warbler/templates
+lib/warbler/templates/config.erb
+lib/warbler/templates/rack.erb
+lib/warbler/templates/rails.erb
 lib/warbler/version.rb
 lib/warbler/war.rb
 lib/warbler_war.jar

data/README.txt

@@ -79,11 +79,13 @@ and +:test+ will be excluded by default, unless you specify with
 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.
+* Your application runs in the +production+ environment by default.
+Change it in <tt>config/warble.rb</tt> (see below).
+* The Rails gem is packaged if you haven't vendored Rails (Rails <= 2.x).
 * Other gems configured in Rails.configuration.gems are packaged
-  (Rails 2.1 - 2.3)
+(Rails 2.1 - 2.3)
 * Multi-thread-safe execution (as introduced in Rails 2.2) is detected
-  and runtime pooling is disabled.
+and runtime pooling is disabled.
 
 === Merb applications
 
@@ -97,6 +99,7 @@ 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.
+<tt>ENV['RACK_ENV']</tt> will be set to +production+.
 
 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/ext/Main.java

@@ -58,10 +58,11 @@ public class Main implements Runnable {
         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];
+        String[] newargs = new String[args.length + 3];
         newargs[0] = "--warfile=" + warfile;
         newargs[1] = "--webroot=" + webroot;
-        System.arraycopy(args, 0, newargs, 2, args.length);
+        newargs[2] = "--directoryListings=false";
+        System.arraycopy(args, 0, newargs, 3, args.length);
         debug("invoking Winstone with: " + Arrays.deepToString(newargs));
         main.invoke(null, new Object[] {newargs});
     }

data/lib/warbler/config.rb

@@ -94,6 +94,14 @@ module Warbler
     # compile all .rb files in the application.
     attr_accessor :compiled_ruby_files
 
+    # Warbler writes an "init" file into the war at this location. JRuby-Rack and possibly other
+    # launchers may use this to initialize the Ruby environment.
+    attr_accessor :init_filename
+
+    # Array containing filenames or StringIO's to be concatenated together to form the init file.
+    # If the filename ends in .erb the file will be expanded the same way web.xml.erb is; see below.
+    attr_accessor :init_contents
+
     # Extra configuration for web.xml. Controls how the dynamically-generated web.xml
     # file is generated.
     #
@@ -124,6 +132,7 @@ module Warbler
 
     def initialize(warbler_home = WARBLER_HOME)
       @warbler_home = warbler_home
+      @warbler_templates = "#{WARBLER_HOME}/lib/warbler/templates"
       @features    = []
       @dirs        = TOP_DIRS.select {|d| File.directory?(d)}
       @includes    = FileList[]
@@ -143,12 +152,16 @@ module Warbler
       @bundler     = true
       @bundle_without = ["development", "test"]
       @webinf_files = default_webinf_files
+      @init_filename = 'META-INF/init.rb'
+      @init_contents = ["#{@warbler_templates}/config.erb"]
 
       auto_detect_frameworks
       yield self if block_given?
       update_gem_path
       detect_bundler_gems
 
+      framework_init = "#{@warbler_templates}/#{@webxml.booter}.erb"
+      @init_contents << framework_init if File.exist?(framework_init)
       @compiled_ruby_files ||= FileList[*@dirs.map {|d| "#{d}/**/*.rb"}]
       @excludes += ["tmp/war"] if File.directory?("tmp/war")
       @excludes += warbler_vendor_excludes(warbler_home)
@@ -230,6 +243,7 @@ module Warbler
         definition = Bundler::Definition.build(gemfile, lockfile, nil)
         groups = definition.groups - @bundle_without.map {|g| g.to_sym}
         definition.specs_for(groups).each {|spec| @gems << spec }
+        @init_contents << StringIO.new("ENV['BUNDLE_WITHOUT'] = '#{@bundle_without.join(':')}'\n")
       else
         @bundler = false
       end
@@ -321,7 +335,7 @@ module Warbler
       send("#{key}=", value)
     end
 
-    def context_params
+    def context_params(escape = true)
       require 'cgi'
       params = {}
       @table.each do |k,v|
@@ -329,10 +343,10 @@ module Warbler
         when WebxmlOpenStruct
           nested_params = v.context_params
           nested_params.each do |nk,nv|
-            params["#{CGI::escapeHTML(k.to_s)}.#{nk}"] = nv
+            params["#{escape ? CGI::escapeHTML(k.to_s) : k.to_s}.#{nk}"] = nv
           end
         else
-          params[CGI::escapeHTML(k.to_s)] = CGI::escapeHTML(v.to_s)
+          params[escape ? CGI::escapeHTML(k.to_s) : k.to_s] = escape ? CGI::escapeHTML(v.to_s) : v.to_s
         end
       end
       params.delete_if {|k,v| ['ignored', *ignored].include?(k.to_s) }

data/lib/warbler/templates/config.erb

@@ -0,0 +1 @@
+WARBLER_CONFIG = <%= webxml.context_params(false) .inspect %>

data/lib/warbler/templates/rack.erb

@@ -0,0 +1 @@
+ENV['RACK_ENV'] = '<%= (params = webxml.context_params; params['rack.env'] || params['rails.env']) %>'

data/lib/warbler/templates/rails.erb

@@ -0,0 +1 @@
+ENV['RAILS_ENV'] = '<%= webxml.rails.env %>'

data/lib/warbler/version.rb

@@ -6,5 +6,5 @@
 #++
 
 module Warbler
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/lib/warbler/war.rb

@@ -52,6 +52,7 @@ module Warbler
       add_webxml(config)
       add_manifest(config)
       add_bundler_files(config)
+      add_init_file(config)
     end
 
     # Create the war file. The single argument can either be a
@@ -73,10 +74,7 @@ module Warbler
     def add_webxml(config)
       config.webinf_files.each do |wf|
         if wf =~ /\.erb$/
-          require 'erb'
-          erb = ERB.new(File.open(wf) {|f| f.read })
-          contents = StringIO.new(erb.result(erb_binding(config.webxml)))
-          @files[apply_pathmaps(config, wf, :webinf)] = contents
+          @files[apply_pathmaps(config, wf, :webinf)] = expand_erb(wf, config)
         else
           @files[apply_pathmaps(config, wf, :webinf)] = wf
         end
@@ -174,11 +172,34 @@ module Warbler
       end
     end
 
+    # Add init.rb file to the war file.
+    def add_init_file(config)
+      if config.init_contents
+        contents = ''
+        config.init_contents.each do |file|
+          if file.respond_to?(:read)
+            contents << file.read
+          elsif File.extname(file) == '.erb'
+            contents << expand_erb(file, config).read
+          else
+            contents << File.read(file)
+          end
+        end
+        @files[config.init_filename] = StringIO.new(contents)
+      end
+    end
+
     private
     def add_with_pathmaps(config, f, map_type)
       @files[apply_pathmaps(config, f, map_type)] = f
     end
 
+    def expand_erb(file, config)
+      require 'erb'
+      erb = ERB.new(File.open(file) {|f| f.read })
+      StringIO.new(erb.result(erb_binding(config.webxml)))
+    end
+
     def erb_binding(webxml)
       binding
     end

data/spec/warbler/war_spec.rb

@@ -27,8 +27,8 @@ describe Warbler::War do
 
   after(:each) do
     rm_rf FileList["log", ".bundle", "tmp/war"]
-    rm_f FileList["*.war", "config.ru", "*web.xml*", "config/web.xml*",
-                  "config/warble.rb", "file.txt", 'manifest', 'Gemfile*', 'MANIFEST.MF*']
+    rm_f FileList["*.war", "config.ru", "*web.xml*", "config/web.xml*", "config/warble.rb",
+                  "file.txt", 'manifest', 'Gemfile*', 'MANIFEST.MF*', 'init.rb*']
     Dir.chdir(@pwd)
     @env_save.keys.each {|k| ENV[k] = @env_save[k]}
   end
@@ -452,4 +452,52 @@ describe Warbler::War do
     @war.apply(@config)
     file_list(%r{WEB-INF/gems/gems/rake([^/]+)/test/test_rake.rb}).should be_empty
   end
+
+  it "should create a META-INF/init.rb file with startup config" do
+    @war.apply(@config)
+    file_list(%r{META-INF/init.rb}).should_not be_empty
+  end
+
+  it "should allow adjusting the init file location in the war" do
+    @config.init_filename = 'WEB-INF/init.rb'
+    @war.add_init_file(@config)
+    file_list(%r{WEB-INF/init.rb}).should_not be_empty
+  end
+
+  it "should add RAILS_ENV to init.rb for Rails apps" do
+    @config = Warbler::Config.new { |c| c.webxml.booter = :rails }
+    @war.add_init_file(@config)
+    contents = @war.files['META-INF/init.rb'].read
+    contents.should =~ /ENV\['RAILS_ENV'\]/
+    contents.should =~ /'production'/
+  end
+
+  it "should add RACK_ENV to init.rb for Rack apps" do
+    @config = Warbler::Config.new { |c| c.webxml.booter = :rack }
+    @war.add_init_file(@config)
+    contents = @war.files['META-INF/init.rb'].read
+    contents.should =~ /ENV\['RACK_ENV'\]/
+    contents.should =~ /'production'/
+  end
+
+  it "should add BUNDLE_WITHOUT to init.rb when Bundler is used" do
+    File.open("Gemfile", "w") {|f| f << "gem 'rake'"}
+    @war.add_init_file(Warbler::Config.new)
+    contents = @war.files['META-INF/init.rb'].read
+    contents.should =~ /ENV\['BUNDLE_WITHOUT'\]/
+    contents.should =~ /'development:test'/
+  end
+
+  it "should allow adding custom files' contents to init.rb" do
+    @config = Warbler::Config.new { |c| c.init_contents << "Rakefile" }
+    @war.add_init_file(@config)
+    contents = @war.files['META-INF/init.rb'].read
+    contents.should =~ /require 'rake'/
+  end
+
+  it "should not have escaped HTML in WARBLER_CONFIG" do
+    @config.webxml.dummy = '<dummy/>'
+    @war.apply(@config)
+    @war.files['META-INF/init.rb'].read.should =~ /<dummy\/>/
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
     - 1
     - 2
-    - 0
-  version: 1.2.0
+    - 1
+  version: 1.2.1
 platform: ruby
 authors: 
   - Nick Sieger
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-05 00:00:00 -05:00
+date: 2010-08-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -123,6 +123,9 @@ files:
   - lib/warbler/config.rb
   - lib/warbler/gems.rb
   - lib/warbler/task.rb
+  - lib/warbler/templates/config.erb
+  - lib/warbler/templates/rack.erb
+  - lib/warbler/templates/rails.erb
   - lib/warbler/version.rb
   - lib/warbler/war.rb
   - lib/warbler_war.jar