= QualitySmith Extensions

[<b>Home page</b>:]        http://qualitysmithext.rubyforge.org/
[<b>Project site</b>:]     http://rubyforge.org/projects/qualitysmithext/
[<b>Gem install</b>:]      <tt>gem install qualitysmith_extensions</tt>
[<b>License</b>:]          {Ruby License}[link:files/License.html]

== Introduction

This is a library of miscellaneous general-purpose, reusable Ruby code, quite similar in purpose and layout to {Ruby Facets}[http://facets.rubyforge.org/]. It is certainly not meant to _compete_ with Facets though!

Developers are encouraged to first check if the method or class they are looking for already exists in one of the fine existing open-source projects (like {Facets}[http://facets.rubyforge.org/] or {Extensions}[http://extensions.rubyforge.org/rdoc/index.html] or {stdlib}[http://www.ruby-doc.org/stdlib/]).

If the code you are needing hasn't already been written by someone else, then you can throw it in this library. Also submit it to an existing extensions project if you think it's any good.

Like Facets, this library contains:
* methods that add functionality to existing Ruby classes (String, Array, etc.)
* as well as new classes that aren't in core Ruby

== Installation

  gem install qualitysmith_extensions

== Usage

  require 'rubygems'
  gem 'qualitysmith_extensions'

And then <b>include as much or as little as you want</b>.

Use the handy <tt>all.rb</tt> files to load everything in a particular directory (and all subdirectories).

To load everything:

  require 'qualitysmith_extensions/all'

To load everything just for one class:

  require 'qualitysmith_extensions/string/all'

To load just an individual method:

  require 'qualitysmith_extensions/array/average'


== Running tests

Tests are self-contained within the file for the code that is under test.

To run the tests directly, you need to use the <tt>exrb</tt> command that is part of the {Ratchets}[http://ratchets.rubyforge.org/] project.

At some point in time, we may extract them into separate files using the Exacto test extractor tool.

<b>QualitySmith developers</b>: If you use <tt>vim</tt>, you can set up your editor to run the tests just by typing the <tt>:Test</tt> command. To set that up, just include <tt>~/svn/devscripts/vim/include.vim</tt> .