Ruby Macro

Last modified by Thomas Mortagne on 2021/10/11 00:27

ruby-16x16.pngRendering macro to execute Ruby script
TypeJAR
Category
Developed by

Thomas Mortagne, XWiki Development Team

Active Installs2
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

Require 7.4 or more.

Installable with the Extension Manager

Description

This is a shortcut for Script Macro equivalent to {{script language="ruby"}} for executing ruby scripts.

Usage

{{ruby}}
require 'java'
include_class 'java.util.TreeSet'
set = TreeSet.new
set.add "foo"
set.add "Bar"
set.add "baz"
set.each do |v|
 puts "value: #{v}"
end
{{/ruby}}

Parameters definition

See the Script Macro for details.

Example

{{ruby}}
if $xcontext.getUser() != "XWiki.XWikiGuest" then
 puts "Hello [[#{$xcontext.getUser()}]]!"
else
 puts "You are not logged in!"
end
{{/ruby}}

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.


To use ruby macro, you need to install following three libraries inside WEB-INF/lib directory of your XE installation:

Once these libraries are in place, you need to restart your XE installation for the changes to take effect.

Release Notes

v9.2.13.0

v9.2.9.0

v9.1.2.0

  • The extension is now a Contrib extension synchronized on JRuby versions.
  • Upgraded to JRuby 9.1.2.0

Dependencies

Dependencies for this extension (org.xwiki.contrib:macro-ruby 9.2.13.1):

  • org.xwiki.platform:xwiki-platform-rendering-macro-script 12.10
  • org.jruby:jruby 9.2.13.0
Tags: ruby script
    

Get Connected