@@ -57,8 +57,8 @@ Warbler::Config.new do |config| # 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.min.runtimes = 2 - # config.webxml.max.runtimes = 4 + # config.webxml.jruby.min.runtimes = 2 + # config.webxml.jruby.max.runtimes = 4 # JNDI data source name # config.webxml.jndi = 'jdbc/rails' generators/warble/templates/warble.rb @@ -51,35 +51,25 @@ module Warbler # the Rails application attr_accessor :war_name - # Extra configuration for web.xml/goldspike. These options are particular - # to Goldspike's Rails servlet and web.xml file. - # - # * <tt>webxml.standalone</tt> -- whether the .war file is "standalone", - # meaning JRuby, all java and gem dependencies are completely embedded - # in file. One of +true+ (default) or +false+. - # * <tt>webxml.jruby_home</tt> -- required if standalone is false. The - # directory containing the JRuby installation to use when the app is - # running. - # * <tt>webxml.rails_env</tt> -- the Rails environment to use for the + # Extra configuration for web.xml. Controls how the dynamically-generated web.xml + # file is generated. + # + # * <tt>webxml.jndi</tt> -- the name of one or more JNDI data sources name to be + # available to the application. Places appropriate <resource-ref> entries + # in the file. + # * <tt>webxml.ignored</tt> -- array of key names that will be not used to + # generate a context param. Defaults to ['jndi', 'booter'] + # + # Any other key/value pair placed in the open structure will be dumped as a + # context parameter in the web.xml file. Some of the recognized values are: + # + # * <tt>webxml.rails.env</tt> -- the Rails environment to use for the # running application, usually either development or production (the # default). - # * <tt>webxml.pool.maxActive</tt> -- maximum number of pooled Rails - # application runtimes (default 4) - # * <tt>webxml.pool.minIdle</tt> -- minimum number of pooled runtimes to - # keep around during idle time (default 2) - # * <tt>webxml.pool.checkInterval</tt> -- how often to check whether the - # pool size is within minimum and maximum limits, in milliseconds - # (default 0) - # * <tt>webxml.pool.maxWait</tt> -- how long a waiting thread should wait - # for a runtime before giving up, in milliseconds (default 30000) - # * <tt>webxml.jndi</tt> -- the name of a JNDI data source name to be - # available to the application - # * <tt>webxml.servlet_name</tt> -- the name of the servlet to receive all - # requests. One of +files+ or +rails+. Goldspike's default behavior is - # to route first through the FileServlet, and if the file isn't found, - # it is forwarded to the RailsServlet. Use +rails+ if your application - # server is fronted by Apache or something else that will handle static - # files. + # * <tt>webxml.jruby.min.runtimes</tt> -- minimum number of pooled runtimes to + # keep around during idle time + # * <tt>webxml.jruby.max.runtimes</tt> -- maximum number of pooled Rails + # application runtimes attr_accessor :webxml def initialize(warbler_home = WARBLER_HOME) @@ -131,6 +121,7 @@ module Warbler c.rails.env = "production" c.public.root = '/' c.jndi = nil + c.ignored = %w(jndi booter) c end @@ -175,6 +166,8 @@ module Warbler params[k] = v.to_s end end + params.delete 'ignored' + self.ignored.each {|k| params.delete k } params end end lib/warbler/config.rb @@ -76,6 +76,11 @@ describe Warbler::Config do config.webxml.servlet_context_listener.should == "org.jruby.rack.rails.RailsServletContextListener" end + it "should not include ignored webxml keys in the context params hash" do + Warbler::Config.new.webxml.context_params.should_not have_key('jndi') + Warbler::Config.new.webxml.context_params.should_not have_key('booter') + end + #it "should automatically gems used by the web application" do # gem "actionpack" # config = Warbler::Config.new spec/warbler/config_spec.rb @@ -85,6 +85,51 @@ describe Warbler::Task do ).first.text.should == "5" end + it "should include custom context parameters" do + @config.webxml.some.custom.config = "myconfig" + define_tasks "webxml" + Rake::Task["warble:webxml"].invoke + require 'rexml/document' + elements = File.open("#{@config.staging_dir}/WEB-INF/web.xml") do |f| + REXML::Document.new(f).root.elements + end + elements.to_a( + "context-param/param-name[text()='some.custom.config']" + ).should_not be_empty + elements.to_a( + "context-param/param-name[text()='some.custom.config']/../param-value" + ).first.text.should == "myconfig" + end + + it "should allow one jndi resource to be included" do + @config.webxml.jndi = 'jndi/rails' + define_tasks "webxml" + Rake::Task["warble:webxml"].invoke + require 'rexml/document' + elements = File.open("#{@config.staging_dir}/WEB-INF/web.xml") do |f| + REXML::Document.new(f).root.elements + end + elements.to_a( + "resource-ref/res-ref-name[text()='jndi/rails']" + ).should_not be_empty + end + + it "should allow multiple jndi resources to be included" do + @config.webxml.jndi = ['jndi/rails1', 'jndi/rails2'] + define_tasks "webxml" + Rake::Task["warble:webxml"].invoke + require 'rexml/document' + elements = File.open("#{@config.staging_dir}/WEB-INF/web.xml") do |f| + REXML::Document.new(f).root.elements + end + elements.to_a( + "resource-ref/res-ref-name[text()='jndi/rails1']" + ).should_not be_empty + elements.to_a( + "resource-ref/res-ref-name[text()='jndi/rails2']" + ).should_not be_empty + end + it "should use a config/web.xml if it exists" do define_tasks "webxml" mkdir_p "config" spec/warbler/task_spec.rb @@ -22,11 +22,11 @@ <listener-class><%= webxml.servlet_context_listener %></listener-class> </listener> -<% if webxml.jndi %> +<% if webxml.jndi then webxml.jndi.each do |jndi| %> <resource-ref> - <res-ref-name><%= webxml.jndi %></res-ref-name> + <res-ref-name><%= jndi %></res-ref-name> <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth> </resource-ref> -<% end %> +<% end; end %> </web-app> \ No newline at end of file web.xml.erb a5c01687d1f2b0f4a69e690808df257de94fc16d Nick Sieger nick@nicksieger.com http://github.com/nicksieger/warbler/commit/a453fa37d94732534cf877a3c9f1699e09b21de3 a453fa37d94732534cf877a3c9f1699e09b21de3

2008-05-04T17:18:03-07:00

Further work to support arbitrary custom context parameters in web.xml. - Update config.webxml attribute rdoc - Allow for more than one jndi name/resoure-ref 447659e90e54a2868b104f54b1a9dccebc120435 Nick Sieger nick@nicksieger.com