BT

IDE scripting with Ruby and Eclipse Monkey

by Werner Schuster on Oct 30, 2007 |
IDEs such as Eclipse have gained a lot of users in the past by taking ideas from Smalltalk IDEs - incremental compilation and local version management being just a few of them. But one area where Smalltalk IDEs (or editors such as Emacs) still have an edge is automation of the IDE itself: scripting tedious tasks in the IDE. Where Smalltalk users just use Smalltalk to access IDE objects, Emacs users use LISP to do the same - and can do that interactively and at runtime.

Eclipse has a solution for this problem with Eclipse Monkey - the name comes from the Firefox plugin GreaseMonkey.  While the first versions used Javascript (Java-based Rhino) as scripting language, Christopher Williams announced recently that Ruby (using JRuby) is now supported as scripting language as well:
If you're unfamiliar with EclipseMonkey, it is a set of plugins for Eclipse that allows users to interact with and script the IDE using languages other than Java (initially just Javascript). For more details you may want to take a peek at http://www.eclipse.org/dash/monkey-help.php?key=writing.
The EclipseMonkey Ruby extension opens up the ability to script the IDE in Ruby code.

This initial version exposes an Editor DOM, that allows you to manipulate editors with your scripts. We already have some Help pages up on the wiki that describe the details and give more information about the API of the Editor DOM. We've also included some sample scripts that show how to use this feature.
The design of Eclipse Monkey is an exercise in simplicity - for a reason: one of the project's creators and designers was Ward Cunningham, who - among other things - came up with Wikis in the 1990s. Scripts are text files in a project; any kind of metadata is included in the file itself. Metadata can be dependencies, or a declaration of a shortcut that will run the script. This can  go as far as hooking a script up to any event in Eclipse, for instance a file change, file save or the launch of a program.

Here a sample Eclipse Monkey script in Ruby for converting a String to a Symbol in an editor:
=begin
 Menu: Ruby > String to Symbol
 Kudos: Christopher Williams
 Key: M1+Shift+;
 License: EPL 1.0
 DOM: http://download.eclipse.org/technology/dash/update/org.eclipse.eclipsemonkey.lang.ruby
=end
 # If the current token is a string containing alnums, change it to
 # a symbol
 editor = $editors.get_active_editor
 selection = editor.selection_range
 selected_src = editor.source[selection]
 # if entire selection is a string with no dynamic content, then
 # convert the string to a symbol
 match = selected_src.match(/(['"])([_a-zA-Z][_\w]*)\1/)
 return if match.nil? || match.size != 3
 symbol = ":" + match[2]
 editor.apply_edit(selection.first, selection.size - 1, symbol)
The other concept of Eclipse Monkey is the DOM, not to be confused with the HTML or XML DOM, which stands for  Domain Object Model. It is an object that provides a simpler interface to some functionality for a particular domain.

In the above code sample, for instance, the $editors variable points to a DOM for handling everything to do with Editors. DOMs are necessary to make scripting an IDE such as Eclipse easy. It would be possible to do the same things by directly accessing Eclipse objects, systems and APIs, but the scripts would often be more complicated. This stems from the fact that the Eclipse design is very flexible, and has various concepts that make it as extensible as it is - but this means that a call such as $editors.get_active_editor would be 2-3 lines of code instead of a single expression.

The DOMs are ordinary Eclipse plugins that contribute to an extension point org.eclipse.eclipsemonkey.dom, so writing a simplified interface to functionality is very easy, given Eclipse's Plugin Development Environment (PDE). Eclipse Monkey metadata also helps with configuration management for DOMs: a script's metadata section can specify the update site for the required DOM(s), which are fetched by the system when the script runs.

Since Eclipse Monkey scripts run in the JVM of Eclipse, it's also possible to write scripts that make use of all of Java's APIs and all JRuby's standard libraries. Many Eclipse Monkey DOMs are available, and give access to the wealth of code and functionality that Eclipse and the Eclipse plugin ecosystem provide.

For instance, controlling a JVM via JMX is done with the JMX DOM. This allows to call all JMX operations or query JMX attributes with a simple script. Ideas for this would be to run an application from Eclipse, and set attributes - such as log levels - or invoke operations - such as running the Garbage Collector - in one go. Other DOMs provide access to Eclipse plugins for CVS/SVN, the Workspace, the JDT, and much more.

Further resources can be found Aptana's Eclipse Monkey site or the official pages at the Eclipse Monkey site.

Hello stranger!

You need to Register an InfoQ account or or login to post comments. But there's so much more behind being registered.

Get the most out of the InfoQ experience.

Tell us what you think

Allowed html: a,b,br,blockquote,i,li,pre,u,ul,p

Email me replies to any of my messages in this thread

Looks interesting by Sebastien Auvray

At least some interesting feature Intellij Idea is missing from Eclipse!

Re: Looks interesting by igor ganapolsky

The link to ScriptMonkey does not work. Get a 404 page error.

Allowed html: a,b,br,blockquote,i,li,pre,u,ul,p

Email me replies to any of my messages in this thread

Allowed html: a,b,br,blockquote,i,li,pre,u,ul,p

Email me replies to any of my messages in this thread

2 Discuss

Educational Content

General Feedback
Bugs
Advertising
Editorial
InfoQ.com and all content copyright © 2006-2014 C4Media Inc. InfoQ.com hosted at Contegix, the best ISP we've ever worked with.
Privacy policy
BT