« Back to Development

Ruby Portlets

Introduction #

Liferay supports developing portlets using the Ruby language by integrating the jRuby interpreter. While anyone can use the interpreter in their own portlets the purpose of the out-of-the-box integration is to allow the development of portlets with no need to develop in Java.

Downloading the Ruby portlet Sample #

The first step to develop a Ruby portlet is to download the sample available in sourceforge. At the moment of writing the latest version can be found in:



This WAR file can be deployed, just like any other Liferay plugin, by copying it to the auto deploy directory or through the Plugin Installer.

Examining the portlet sample #

To start developing your own portlet you should unzip the file to a folder of your computer. You may want to do it inside the Plugin SDK to use its ant tasks or just inside a folder controlled by your favorite IDE.

The main directories and files inside the WAR are:

  • /WEB-INF/ruby: contains the ruby sources of the portlet. These are the files that you'll work with more often. The ruby files are placed inside the WEB-INF directory to make it impossible for someone to download them (your code should never be downloadable!)
  • /WEB-INF/ruby/global : contains (by convention) ruby files that will always be loaded for every request. This files will be referenced from the 'action-file' init parameter of the portlet declaration in /WEB-INF/portlet.xml file.
  • /WEB-INF/src/com/sample/ruby/portlet/RubyPortlet.java: is the Java source code responsible for invoking the ruby files and passing them reference to the needed portlet objects such as: $portletConfig, $portletContext, $preferences, $userInfo, $actionRequest or $renderRequest and $actionResponse or $renderResponse.
  • /WEB-INF/lib: contains the classes needed by the previous class. In particular it contains the jruby.jar file which is the interpreter used to run the ruby code.

Developing complex portlets #

The Ruby portlet provided as an example is very useful to start developing in ruby very fast. Once your needs start becoming more and more complex you may want to extend it with more functionalities. The full source code is provided under the MIT license, so the sky is the limit :)

0 Attachments
Average (2 Votes)
The average rating is 3.0 stars out of 5.
Threaded Replies Author Date
How can I run it in Liferay 6? Is it possible? Jahangir Zinedine January 28, 2012 11:10 PM

How can I run it in Liferay 6? Is it possible?
Posted on 1/28/12 11:10 PM.