Hashery

Homepage | Development | Report Issue | Mailing List | IRC

DESCRIPTION

Among Ruby Facets most common additions were an assortment of Hash-like classes. To better support this collection of libraries it was deemed prudent to create a side project specifically for them. Hence the "Facets" Hashery.

Included in this collection are the widely used OrderedHash, the related but more featured Dictionary class, a number of open classes, similar to the standard OpenStruct, plus a few variations of the standard Hash and a few other yummy morsels.

RELEASE NOTES

Please see the HISTORY file.

HOW TO USE

For usage information, see the individual library files included in this collection.

HOW TO INSTALL

To install with RubyGems simply open a console and type:

$ sudo gem install hashery

Tarball packages are available for manual site installations via Ruby Setup.

AUTHORS

Developers who have contributed code to the project include:

CONTRIBUTE

Don't be a lump on a log. See an issue? Have a suggestion? Want to help? Well git in there!

Testing

Hashery uses QED and Lemon test frameworks. The QED framework to create well tested high-level documentation. Run the QED specs via:

$ qed -Ilib demo/

Lemon is used to create low-level unit tests. Run these via the RubyTest univeral test harness.

$ rubytest -Ilib test/

Patches

Hashery's repository is hosted on GitHub. If you'd like to offer up a fix or feature, fork the repo and submit a pull request (preferably in a topic branch). I assume you have heard all the talk about proper practices, so I won't bug you with it yet again.

Donations

Yes, we FOSS programmers need to eat too! ;-) No seriously, any help you can offer goes a long way toward continued development of Rubyworks projects, including Hashery. See the upper right-hand corner on the Rubyworks hompage. Thanks.

COPYRIGHTS

Copyright (c) 2010 Rubyworks

Licensed under the BSD-2-clause license.

See COPYING.rdoc file for further details.

Some libraries included in the Hashery have special copyrights attributing specific authors. Please see each library script for specifics and the NOITCE.txt file for an overview.