RAKE – Ruby Make

This package contains Rake, a simple ruby build program with capabilities similar to make.

Rake has the following features:

Installation

Gem Installation

Download and install rake with the following.

gem install rake

Usage

Simple Example

First, you must write a “Rakefile” file which contains the build rules. Here's a simple example:

task :default => [:test]

task :test do
  ruby "test/unittest.rb"
end

This Rakefile has two tasks:

Running the “rake” command without any options will cause it to run the “default” task in the Rakefile:

% ls
Rakefile     test/
% rake
(in /home/some_user/Projects/rake)
ruby test/unittest.rb
....unit test output here...

Type “rake –help” for all available options.

More Information

Development

Source Repository

Rake is currently hosted at github. The github web page is github.com/jimweirich/rake . The public git clone URL is

Running the Rake Test Suite

If you wish to run the unit and functional tests that come with Rake:

Issues and Bug Reports

Feature requests and bug reports can be made here

Online Resources

Rake References

Presentations and Articles about Rake

Other Make Reinvisionings …

Rake is a late entry in the make replacement field. Here are links to other projects with similar (and not so similar) goals.

Credits

Ryan Dlugosz

For the initial conversation that sparked Rake.

nobu.nokada@softhome.net

For the initial patch for rule support.

Tilman Sauerbeck <tilman@code-monkey.de>

For the recursive rule patch.

Eric Hodel

For aid in maintaining rake.

License

Rake is available under an MIT-style license.

Copyright © 2003, 2004 Jim Weirich

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Support

The Rake homepage is rake.rubyforge.org. You can find the Rake RubyForge page at rubyforge.org/projects/rake.

Feel free to submit commits or feature requests. If you send a patch, remember to update the corresponding unit tests. In fact, I prefer new feature to be submitted in the form of new unit tests.

For other information, feel free to ask on the ruby-talk mailing list (which is mirrored to comp.lang.ruby) or contact jim dot weirich at gmail.com.


Other stuff

Author

Jim Weirich <jim.weirich@gmail.com>

Requires

Ruby 1.8.7 or later

License

Copyright 2003-2013 by Jim Weirich. Released under an MIT-style license. See the MIT-LICENSE file included in the distribution.

Warranty

This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.