Ruby scripting for pentaho-kettle

An plugin for Pentaho kettle (PDI) allowing to include ruby scripts as transformation steps.

The elegance of the ruby language is paired with ultimate row processing flexibility. The step allows scripts to read, write, aggregate, consume and redirect rows to accomplish the most complex of data processing tasks in one place.

The implementation is based on JRuby. Thanks to JRuby's great Java interop, the scripting step also enables easy Java scripting in kettle.

Supported versions of pentaho-kettle

The plugin works with Kettle versions 5.x - 8.x.

How to get it?

Grab the latest release from the releases page. You can also get the plugin zip as a maven dependency from maven central.

How to install?

Decompress the release zip to <kettle-dir>/plugins and restart Spoon. The "Ruby Script" step will appear in the "Scripting" section of a transformation.

How do I write ruby scripts in kettle?

The ruby scripting step comes with a lot of samples. You can access them by opening a ruby step dialog and exploring the samples section on the left.

Features at a glance

rows are represented as hashes, indexed by field name
automatic conversion between all kettle data types and ruby types
steps with no input can be used as row generators
can redirect rows to an error handling stream
can read from specific info steps
can write to specific target steps
can call your favorite Java libraries
can use ruby gems
kettle's step $step and transformation $trans objects are available in ruby scope for advanced scripting

Where do I report bugs and issues?

Just open issues on github.

What about ruby gems?

You can use gems, see the Ruby gems article on the project wiki. As long as JRuby likes the gem, which usually means that the gem has no unsupported native bindings, you may use gems as with any other ruby program.

How do I build the project?

mvn clean package

It creates the plugin zip in target/ruby-for-pentaho-kettle-{version}-plugin.zip.

How do I run the test suite?

Create a package, then run the tests. The packaging process unzips the plugin into target/ruby-for-pentaho-kettle, which enables kettle to find the plugin when running integration tests.

mvn clean package
mvn -DskipTests=false test

How can I contribute?

If you'd like to contribute please fork the project, add the feature or bugfix and send a pull request. If your change majorly alters the way the plugin works, we should discuss it via an open issue first.

License

The ruby-for-pentaho-kettle plugin uses the LGPL 2.1 license.

Support

Open source does not mean you're on your own. The ruby-for-pentaho-kettle plugin is developed by Twineworks GmbH. Twineworks offers commercial support and consulting services. Contact us if you'd like us to help with a project.

twineworks/ruby-for-pentaho-kettle