@@ -26,8 +26,8 @@ SOFTWARE. = Additional Bundled Software -Goldspike (goldspike-*.jar) is distributed under the terms of the MIT license. -See http://jruby-extras.rubyforge.org/svn/trunk/rails-integration/LICENSE.txt +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 @@ -35,11 +35,3 @@ 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). - -JavaBeans Activation Framework (activation-*.jar) is distributed under the -terms of the Common Development and Distribution License (CDDL) v1.0, see -http://www.sun.com/cddl/cddl.html for details. - -Commons-pool (commons-pool-*.jar) is distributed under the terms of the Apache -Software License, version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 -for details. \ No newline at end of file LICENSES.txt @@ -7,7 +7,7 @@ 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 Goldspike servlet for dispatching requests to your application inside +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. @@ -64,7 +64,7 @@ Once Warbler is installed as a plugin, you can use +rake+ to build the war (with === Web.xml -Java web applications are configured mainly through this file, and Warbler creates a suitable default file for you for use with the bundled Goldspike bits. However, if you need to customize it in any way, you have two options. +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>. 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. @@ -80,16 +80,6 @@ If Warbler isn't packaging the files you were expecting, there are several debug assembly. Valid values of <tt>X</tt> are <tt>app, java_libs, gems, public, includes, excludes</tt>. -== Caveats - -Warbler requires that RAILS_ROOT will effectively be set to /WEB-INF when running inside the war, while the application public files will be in the root directory. The purpose is to make the application structure match the Java webapp archive structure, where WEB-INF is a protected directory not visible to the web server. Because of this change, features of Rails that expect the public assets directory to live in RAILS_ROOT/public may not function properly. However, we feel that the added security of conforming to the webapp structure is worth these minor inconveniences. - -For Rails 1.2.3, the items that may need your attention are: - -* Page caching will not work unless you set <tt>ActionController::Base.page_cache_directory = "#{RAILS_ROOT}/.."</tt> -* Asset tag timestamp calculation (e.g., <tt>javascripts/prototype.js?1188482864</tt>) will not happen. The workaround is to control this manually by setting the RAILS_ASSET_ID environment variable. -* Automatic inclusion of <tt>application.js</tt> through <tt>javascript_include_tag :defaults</tt> will not work. The workaround is to include it yourself with <tt>javascript_include_tag "application"</tt>. - == Source You can get the Warbler source using Git, in any of the following ways: @@ -104,7 +94,7 @@ You can also download a tarball of Warbler source at http://github.com/nicksiege Warbler is provided under the terms of the MIT license. - Warbler (c) 2007-08 Nick Sieger <nicksieger@gmail.com> + Warbler (c) 2007-08 Sun Microsystems, Inc. -Warbler also bundles several other pieces of software. Please read the file LICENSES.txt to ensure +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. README.txt @@ -13,8 +13,8 @@ Warbler::Config.new do |config| # 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 Goldspike are pre-loaded in this list. Be sure to include your + # 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"] @@ -48,21 +48,17 @@ Warbler::Config.new do |config| # of RAILS_ROOT # config.war_name = "mywar" - # True if the webapp has no external dependencies - config.webxml.standalone = true - - # Location of JRuby, required for non-standalone apps - # config.webxml.jruby_home = <jruby/home> - # Value of RAILS_ENV for the webapp - config.webxml.rails_env = 'production' + config.webxml.rails.env = 'production' + + # Application booter to use, one of :rack, :rails, or :merb. (Default :rails) + # config.webxml.booter = :rails - # Control the pool of Rails runtimes - # (Goldspike-specific; see README for details) - # config.webxml.pool.maxActive = 4 - # config.webxml.pool.minIdle = 2 - # config.webxml.pool.checkInterval = 0 - # config.webxml.pool.maxWait = 30000 + # 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 # JNDI data source name # config.webxml.jndi = 'jdbc/rails' generators/warble/templates/warble.rb @@ -127,10 +127,10 @@ module Warbler end def default_webxml_config - c = OpenStruct.new - c.standalone = true - c.rails_env = "production" - c.pool = OpenStruct.new + c = WebxmlOpenStruct.new + c.rails.env = "production" + c.public.root = '/' + c.jndi = nil c end @@ -144,6 +144,38 @@ module Warbler gems << "rails" unless File.directory?("vendor/rails") gems end - + end + + class WebxmlOpenStruct < OpenStruct + def initialize + @table = Hash.new {|h,k| h[k] = WebxmlOpenStruct.new } + end + + def servlet_context_listener + case self.booter + when :rack + "org.jruby.rack.RackServletContextListener" + when :merb + "org.jruby.rack.merb.MerbServletContextListener" + else # :rails, default + "org.jruby.rack.rails.RailsServletContextListener" + end + end + + def context_params + params = {} + @table.each do |k,v| + case v + when WebxmlOpenStruct + nested_params = v.context_params + nested_params.each do |nk,nv| + params["#{k}.#{nk}"] = nv + end + else + params[k] = v.to_s + end + end + params + end end end \ No newline at end of file lib/warbler/config.rb @@ -19,7 +19,6 @@ describe Warbler::Config do config.java_libs.should_not be_empty config.war_name.size.should > 0 config.webxml.should be_kind_of(OpenStruct) - config.webxml.pool.should be_kind_of(OpenStruct) config.pathmaps.should be_kind_of(OpenStruct) config.pathmaps.public_html.should == ["%{public/,}p"] end @@ -48,7 +47,35 @@ describe Warbler::Config do config = Warbler::Config.new File.join(Dir.getwd, "vendor", "plugins", "warbler") config.excludes.include?("vendor/plugins/warbler").should == true end - + + it "should generate context parameters from the webxml openstruct" do + config = Warbler::Config.new + config.webxml.a.b.c = "123" + config.webxml.rails.env = 'staging' + config.webxml.jruby.min.runtimes = 2 + config.webxml.jruby.max.runtimes = 4 + params = config.webxml.context_params + params.should have_key('a.b.c') + params.should have_key('rails.env') + params.should have_key('jruby.min.runtimes') + params.should have_key('jruby.max.runtimes') + params['a.b.c'].should == "123" + params['rails.env'].should == "staging" + params['jruby.min.runtimes'].should == "2" + params['jruby.max.runtimes'].should == "4" + end + + it "should determine the context listener from the webxml.booter parameter" do + config = Warbler::Config.new + config.webxml.booter = :rack + config.webxml.servlet_context_listener.should == "org.jruby.rack.RackServletContextListener" + config = Warbler::Config.new + config.webxml.booter = :merb + config.webxml.servlet_context_listener.should == "org.jruby.rack.merb.MerbServletContextListener" + config = Warbler::Config.new + config.webxml.servlet_context_listener.should == "org.jruby.rack.rails.RailsServletContextListener" + end + #it "should automatically gems used by the web application" do # gem "actionpack" # config = Warbler::Config.new spec/warbler/config_spec.rb @@ -18,7 +18,7 @@ describe Warbler::Task do config.gems = ["rake"] config.dirs = %w(bin generators lib) config.public_html = FileList["public/**/*", "tasks/**/*"] - config.webxml.pool.maxActive = 5 + config.webxml.jruby.max.runtimes = 5 end verbose(false) end @@ -73,15 +73,15 @@ describe Warbler::Task do Rake::Task["warble:webxml"].invoke file_list(%r{WEB-INF/web.xml$}).should_not be_empty 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()='jruby.pool.maxActive']" + "context-param/param-name[text()='jruby.max.runtimes']" ).should_not be_empty elements.to_a( - "context-param/param-name[text()='jruby.pool.maxActive']/../param-value" + "context-param/param-name[text()='jruby.max.runtimes']/../param-value" ).first.text.should == "5" end @@ -98,11 +98,11 @@ describe Warbler::Task do it "should use a config/web.xml.erb if it exists" do define_tasks "webxml" mkdir_p "config" - File.open("config/web.xml.erb", "w") {|f| f << "Hi <%= webxml.standalone %>" } + File.open("config/web.xml.erb", "w") {|f| f << "Hi <%= webxml.public.root %>" } Rake::Task["warble:webxml"].invoke files = file_list(%r{WEB-INF/web.xml$}) files.should_not be_empty - File.open(files.first) {|f| f.read}.should == "Hi true" + File.open(files.first) {|f| f.read}.should == "Hi /" end it "should define a java_libs task for copying java libraries" do spec/warbler/task_spec.rb @@ -2,78 +2,31 @@ "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd"> <web-app> - - <context-param> - <param-name>jruby.standalone</param-name> - <param-value><%= webxml.standalone %></param-value> - </context-param> - - <% if !webxml.standalone && webxml.jruby_home %> - <!-- jruby.home can be set either here, or as the system property jruby.home --> - <context-param> - <param-name>jruby.home</param-name> - <param-value><%= webxml.jruby_home %></param-value> - </context-param> - <% end %> - - <context-param> - <param-name>rails.root</param-name> - <param-value>/WEB-INF</param-value> - </context-param> - - <context-param> - <param-name>rails.env</param-name> - <param-value><%= webxml.rails_env || 'production' %></param-value> - </context-param> - - <% webxml.pool.marshal_dump.each do |k,v| %> - <context-param> - <param-name>jruby.pool.<%= k %></param-name> - <param-value><%= v %></param-value> - </context-param> + <% webxml.context_params.each do |k,v| %> + <context-param> + <param-name><%= k %></param-name> + <param-value><%= v %></param-value> + </context-param> <% end %> - <context-param> - <param-name>files.default</param-name> - <param-value>rails</param-value> - <description> - The files servlet should forward to the rails servlet if no file could be found - </description> - </context-param> - - <context-param> - <param-name>files.prefix</param-name> - <param-value></param-value> - <description> - Prefix added to static files - </description> - </context-param> - - <listener> - <listener-class>org.jruby.webapp.RailsContextListener</listener-class> - </listener> - - <servlet> - <servlet-name>rails</servlet-name> - <servlet-class>org.jruby.webapp.RailsServlet</servlet-class> - </servlet> - <servlet> - <servlet-name>files</servlet-name> - <servlet-class>org.jruby.webapp.FileServlet</servlet-class> - </servlet> - - <!-- Allow all requests to go to the files servlet first --> - <servlet-mapping> - <servlet-name><%= webxml.servlet_name || 'files' %></servlet-name> - <url-pattern>/</url-pattern> - </servlet-mapping> - - <% if webxml.jndi %> - <resource-ref> - <res-ref-name><%= webxml.jndi %></res-ref-name> - <res-type>javax.sql.DataSource</res-type> - <res-auth>Container</res-auth> - </resource-ref> - <% end %> - + <filter> + <filter-name>RackFilter</filter-name> + <filter-class>org.jruby.rack.RackFilter</filter-class> + </filter> + <filter-mapping> + <filter-name>RackFilter</filter-name> + <url-pattern>/*</url-pattern> + </filter-mapping> + + <listener> + <listener-class><%= webxml.servlet_context_listener %></listener-class> + </listener> + + <% if webxml.jndi %> + <resource-ref> + <res-ref-name><%= webxml.jndi %></res-ref-name> + <res-type>javax.sql.DataSource</res-type> + <res-auth>Container</res-auth> + </resource-ref> + <% end %> </web-app> \ No newline at end of file web.xml.erb lib/activation-1.1.jar lib/commons-pool-1.3.jar lib/goldspike-1.6.1.jar 8da99db9491fcb55dd67e211dea6cb3c135081e4 Nick Sieger nick@nicksieger.com http://github.com/nicksieger/warbler/commit/a8d5ad6f9a58244334b1ddcfc58ff2b8efde6c3f a8d5ad6f9a58244334b1ddcfc58ff2b8efde6c3f 2008-05-03T11:54:26-07:00 2008-05-03T11:54:26-07:00 Revamp config preparing for jruby-rack switch eacc65748e65b07753241e6c58ac81e5b04900d2 Nick Sieger nick@nicksieger.com