2008-08-12T19:54:28Z

155 JRubyRack 1

JRuby-Rack is a lightweight adapter for the Java servlet environment that allows any Rack-based application to run unmodified in a Java servlet container. JRuby-Rack supports Rails, Merb, as well as any Rack-compatible Ruby web framework. For more information on Rack, visit http://rack.rubyforge.org. __TOC__ ==Download== JRuby-Rack 0.9 is the first public release. Download it: http://repository.codehaus.org/org/jruby/rack/jruby-rack/0.9/jruby-rack-0.9.jar JRuby-Rack is also bundled with [http://caldersphere.rubyforge.org/warbler Warbler 0.9.9], which is available as a Ruby gem (<tt>jruby -S gem install warbler</tt>). ==Features== ===Servlet Filter=== JRuby-Rack's main mode of operation is as a servlet filter. This allows requests for static content to pass through and be served by the application server. Dynamic requests only happen for URLs that don't have a corresponding file, much like many Ruby applications expect. ===Goldspike-compatible Servlet=== JRuby-Rack includes a stub RailsServlet and recognizes many of Goldspike's context parameters (e.g., pool size configuration), making it interchangeable with Goldspike, for convenience of migration. One caveat is that static content is served by Rack, which requires acquisition of a JRuby runtime. Your throughput with static files will be much lower than when JRuby-Rack is configured as a servlet filter. You have been warned! ===Servlet environment integration=== * Servlet context is accessible to any application both through the global variable $servlet_context and the Rack environment variable java.servlet_context. * Servlet request object is available in the Rack environment via the key java.servlet_request. * Servlet request attributes are passed through to the Rack environment. * Rack environment variables and headers can be overridden by servlet request attributes. * Java servlet sessions are used as the default session store for both Rails and Merb. Session attributes with String keys and String, numeric, boolean, or java object values are automatically copied to the servlet session for you. ===JRuby Runtime Management=== JRuby runtime management and pooling is done automatically by the framework. In the case of Rails, runtimes are pooled. For Merb and other Rack applications, a single runtime is created and shared for every request. ==Feedback== For simplicity, I haven't set up any separate mailing lists or bug trackers for jruby-rack at this time. Please use the [http://xircles.codehaus.org/lists/user@jruby.codehaus.org jruby-user mailing list] and the [http://jira.codehaus.org/browse/JRUBY JRuby JIRA issue tracker] for feedback. ==Source== The source is currently available from the jruby-contrib subversion repository on codehaus: http://svn.codehaus.org/jruby-contrib/trunk/rack ==Building== Ensure you have JRuby with the buildr and rack gems installed. jruby -S gem install buildr rack Checkout the JRuby Rack code and cd to that directory svn co http://svn.codehaus.org/jruby-contrib/trunk/rack cd rack Resolve dependencies, compile the code, and build the jar file. jruby -S buildr package The generated jar should be found in target/jruby-rack-*.jar. '''NOTE''': The JRuby 1.1.3 release, which bundles Rubygems 1.2, [http://rubyforge.org/tracker/index.php?func=detail&aid=21056&group_id=126&atid=575 has some problems with installing Buildr]. To that end I've prepared a standalone buildr package with JRuby 1.1.2. [http://caldersphere.net/jruby-rack/jruby-buildr.tar.gz Download it], add the jruby-buildr directory to your path, and use the jruby-buildr/buildr script instead of "jruby -S buildr" above.

<p>JRuby-Rack is a lightweight adapter for the Java servlet environment that allows any Rack-based application to run unmodified in a Java servlet container. JRuby-Rack supports Rails, Merb, as well as any Rack-compatible Ruby web framework. </p><p>For more information on Rack, visit <a class='external' href="http://rack.rubyforge.org.">http://rack.rubyforge.org.</a> </p><div id='toc' class='toc'> <div id='toctitle' class='toc-title'> <span>Contents</span> </div> <div id='toccontents' class='toc-contents'><ul><ul><li>1 <a href='#Download'>Download</a></li> <li>2 <a href='#Features'>Features</a></li> <ul><li>2.1 <a href='#Servlet_Filter'>Servlet Filter</a></li> <li>2.2 <a href='#Goldspike-compatible_Servlet'>Goldspike-compatible Servlet</a></li> <li>2.3 <a href='#Servlet_environment_integration'>Servlet environment integration</a></li> <li>2.4 <a href='#JRuby_Runtime_Management'>JRuby Runtime Management</a></li> </ul><li>3 <a href='#Feedback'>Feedback</a></li> <li>4 <a href='#Source'>Source</a></li> <li>5 <a href='#Building'>Building</a></li> </ul></ul></div> </div><p><br /> </p><h2><a name='Download'></a>Download</h2> <p> JRuby-Rack 0.9 is the first public release. Download it: </p><p><a class='external' href="http://repository.codehaus.org/org/jruby/rack/jruby-rack/0.9/jruby-rack-0.9.jar">http://repository.codehaus.org/org/jruby/rack/jruby-rack/0.9/jruby-rack-0.9.jar</a> </p><p>JRuby-Rack is also bundled with <a class='external' href="http://caldersphere.rubyforge.org/warbler">Warbler 0.9.9</a>, which is available as a Ruby gem (<tt>jruby -S gem install warbler</tt>). </p><h2><a name='Features'></a>Features</h2> <h3><a name='Servlet_Filter'></a>Servlet Filter</h3> <p> JRuby-Rack's main mode of operation is as a servlet filter. This allows requests for static content to pass through and be served by the application server. Dynamic requests only happen for URLs that don't have a corresponding file, much like many Ruby applications expect. </p><h3><a name='Goldspike-compatible_Servlet'></a>Goldspike-compatible Servlet</h3> <p> JRuby-Rack includes a stub RailsServlet and recognizes many of Goldspike's context parameters (e.g., pool size configuration), making it interchangeable with Goldspike, for convenience of migration. One caveat is that static content is served by Rack, which requires acquisition of a JRuby runtime. Your throughput with static files will be much lower than when JRuby-Rack is configured as a servlet filter. You have been warned! </p><h3><a name='Servlet_environment_integration'></a>Servlet environment integration</h3> <ul><li> Servlet context is accessible to any application both through the global variable $servlet_context and the Rack environment variable java.servlet_context. </li><li> Servlet request object is available in the Rack environment via the key java.servlet_request. </li><li> Servlet request attributes are passed through to the Rack environment. </li><li> Rack environment variables and headers can be overridden by servlet request attributes. </li><li> Java servlet sessions are used as the default session store for both Rails and Merb. Session attributes with String keys and String, numeric, boolean, or java object values are automatically copied to the servlet session for you. </li></ul><h3><a name='JRuby_Runtime_Management'></a>JRuby Runtime Management</h3> <p> JRuby runtime management and pooling is done automatically by the framework. In the case of Rails, runtimes are pooled. For Merb and other Rack applications, a single runtime is created and shared for every request. </p><h2><a name='Feedback'></a>Feedback</h2> <p> For simplicity, I haven't set up any separate mailing lists or bug trackers for jruby-rack at this time. Please use the <a class='external' href="http://xircles.codehaus.org/lists/user@jruby.codehaus.org">jruby-user mailing list</a> and the <a class='external' href="http://jira.codehaus.org/browse/JRUBY">JRuby JIRA issue tracker</a> for feedback. </p><h2><a name='Source'></a>Source</h2> <p> The source is currently available from the jruby-contrib subversion repository on codehaus: </p><p><a class='external' href="http://svn.codehaus.org/jruby-contrib/trunk/rack">http://svn.codehaus.org/jruby-contrib/trunk/rack</a> </p><h2><a name='Building'></a>Building</h2> <p> Ensure you have JRuby with the buildr and rack gems installed. </p><pre> jruby -S gem install buildr rack </pre><p> Checkout the JRuby Rack code and cd to that directory </p><pre> svn co <a class='external' href="http://svn.codehaus.org/jruby-contrib/trunk/rack">http://svn.codehaus.org/jruby-contrib/trunk/rack</a> cd rack </pre><p> Resolve dependencies, compile the code, and build the jar file. </p><pre> jruby -S buildr package </pre><p> The generated jar should be found in target/jruby-rack-*.jar. </p><p><b>NOTE</b>: The JRuby 1.1.3 release, which bundles Rubygems 1.2, <a class='external' href="http://rubyforge.org/tracker/index.php?func=detail&aid=21056&group_id=126&atid=575">has some problems with installing Buildr</a>. To that end I've prepared a standalone buildr package with JRuby 1.1.2. <a class='external' href="http://caldersphere.net/jruby-rack/jruby-buildr.tar.gz">Download it</a>, add the jruby-buildr directory to your path, and use the jruby-buildr/buildr script instead of "jruby -S buildr" above. </p>

2008-08-12T19:54:28Z

320