P4Ruby: Ruby interface to the Perforce API |
So, what's it all about? Well in a nutshell P4Ruby allows you to write beautiful Ruby code that interacts with a Perforce server. The main features are:
Writing Ruby code is a joy for all programmers, and P4Ruby makes that experience available to Perforce users. Enjoy it!
This extension is distributed under the terms of this license, which is basically the BSD license. You use it at your own risk.
FreeBSD users can just use pkg_add to install ruby as there's a FreeBSD port for it.
Windows users can download a Windows installer for Ruby from http://rubyinstaller.sourceforge.net/ They can also grab a P4Ruby installer from the links below - useful if you don't have Visual Studio installed. If you do this, then obviously you don't need to do any of the other build steps.
Otherwise you can download the source for Ruby from http://www.ruby-lang.org which is the main Ruby home page.
Extract the files in the p4api.tar tarfile (WinZip can handle it for Windows users) into a new empty directory and remember its location.
Stable release | P4Ruby-1.1750.tar.gz (first stable release) | |
Current release |
P4Ruby.tar.gz
installer for Windows |
View the latest changes |
Once you've done that, unpack the tarball and see the README file for build instructions.
P4Ruby's documentation is here
Platform | Perforce API Build | Ruby Versions | Notes |
---|---|---|---|
Linux (glibc 2.2, gcc 2.96 and 2.95.3) | 2001.1 Linux 2.2 | Ruby 1.6.4 | |
Linux (glibc 2.2, gcc 2.96 and 2.95.3) | 2002.1 Linux 2.4 | Ruby 1.6.6 | |
Linux (glibc 2.2, gcc 2.95.3) | 2002.1 Linux 2.4 | Ruby 1.6.7 | |
FreeBSD 4 (gcc 2.95.3) | 2002.1 FreeBSD 4 | Ruby 1.6.6 | |
Windows 2000 | 2001.1 NTx86 | Ruby 1.6.5 | |
Windows 2000 | 2002.1 NTx86 | Ruby 1.6.7 |
require "P4" template = "my-client-template" client_root = "c:\\p4-work" p4 = P4.new p4.parse_forms p4.connect begin # Run a "p4 client -t template -o" and convert it into a Ruby hash spec = p4.fetch_client( "-t", template ) # Now edit the fields in the form spec[ "Root" ] = client_root spec[ "Options" ] = spec[ "Options" ].sub( "normdir", "rmdir" ) # Now save the udpated spec p4.save_client( spec ) # And sync it. p4.run_sync rescue P4Exception # If any errors occur, we'll jump in here. Just log them # and raise the exception up to the higher level p4.errors.each { |e| $stderr.puts( e ) } raise end
Thanks to Dave Thomas and Andy Hunt at The Pragmatic Programmers for their superb book and kindly giving me permission to use the funky Ruby image at the top of this page.
And of course, thanks to Matz for Ruby.