Release Name: 0.5.1
Notes:
= Gibbler - v0.5 ALPHA
Git-like hashes and history for Ruby objects.
== Example 1 -- Basic Usage
require 'gibbler'
"kimmy".gibbler # => c8027100ecc54945ab15ddac529230e38b1ba6a1
:kimmy.gibbler # => 52be7494a602d85ff5d8a8ab4ffe7f1b171587df
config = {}
config.gibbler # => 4fdcadc66a38feb9c57faf3c5a18d5e76a6d29bf
config.gibbled? # => false
config[:server] = {
:users => [:dave, :ali],
:ports => [22, 80, 443]
}
config.gibbled? # => true
config.gibbler # => ef23d605f8c4fc80a8e580f9a0e8dab8426454a8
config[:server][:users] << :yanni
config.gibbler # => 4c558a56bc2abf5f8a845a69e47ceb5e0003683f
config.gibbler.short # => 4c558a56
== Example 2 -- Object History
Gibbler can also keep track of the history of changes to an object. By default Gibbler supports history for Hash, Array, and String objects. The <tt>gibbler_commit</tt> method creates a clone of the current object and stores in an instance variable using the current hash digest as the key.
require 'gibbler'
require 'gibbler/history'
a = { :magic => :original }
a.gibbler_commit # => d7049916ddb25e6cc438b1028fb957e5139f9910
a[:magic] = :updated
a.gibbler_commit # => b668098e16d08898532bf3aa33ce2253a3a4150e
a[:magic] = :changed
a.gibbler_commit # => 0b11c377fccd44554a601e5d2b135c46dc1c4cb1
a.gibbler_history # => d7049916, b668098e, 0b11c377
a.gibbler_revert! 'd7049916' # Return to a specific commit
a.gibbler # => d7049916ddb25e6cc438b1028fb957e5139f9910
a # => { :magic => :original }
a.delete :magic
a.gibbler_revert! # Return to the previous commit
a.gibbler # => 0b11c377fccd44554a601e5d2b135c46dc1c4cb1
a # => { :magic => :changed }
a.gibbler_object 'b668098e' # => { :magic => :updated }
a.gibbler_stamp # => 2009-07-01 18:56:52 -0400
http://delano.github.com/gibbler/img/whoababy.gif
== Supported Classes
Gibbler methods are available only to the classes which explicitly include them (see RDocs[http://delano.github.com/gibbler] for details on which classes are supported by default). You can also extend custom objects:
class FullHouse
include Gibbler::Complex
attr_accessor :roles
end
a = FullHouse.new
a.gibbler # => 4192d4cb59975813f117a51dcd4454ac16df6703
a.roles = [:jesse, :joey, :danny, :kimmy, :michelle, :dj, :stephanie]
a.gibbler # => 6ea546919dc4caa2bab69799b71d48810a1b48fa
Gibbler::Complex creates a digest based on the name of the class and the names and values of the instance variables. See the RDocs[http://delano.github.com/gibbler] for other Gibbler::* types.
If you want to support all Ruby objects, add the following to your application:
class Object
include Gibbler::String
end
Gibbler::String creates a digest based on the name of the class and the output of the to_s method. This is a reasonable default for most objects however any object that includes the object address in to_s (e.g. "<Object:0x0x4ac9f0...") will produce unreliable digests (because the address can change).
== ALPHA Notice
This code is hella fresh (est 2009-06-25). It's barely tested and the interface may change, but it's fun to play with. I'll happily accept patches.
NOTE: Gibbler history is not suitable for very large objects since it keeps complete copies of the object in memory. This is a very early implementation of this feature so don't rely on it for production code.
== News
=== 2009-07-06: Renamed gibbler_revert to gibbler_revert!
The gibbler_revert! modifies the object in place so this was an important change to follow the Ruby convention of appending the exclamation mark. Thanks to ivey[http://news.ycombinator.com/item?id=689750] for pointing this out.
=== 2009-07-01: Major namespace reorganization
Many method names have been modified so this release is not backwards compatible with previous releases. This clears up ambiguity regarding "gibbles". They're now rightly referred to as digests.
== Known Issues
* gibbler or gibbled? must be called at least once before gibbled? will be able to return a useful value (otherwise there is no previous digest value to compare to)
== More Info
* Codes[http://github.com/delano/gibbler]
* RDocs[http://delano.github.com/gibbler]
* Sponsor[http://solutious.com/]
* Inspiration[http://www.youtube.com/watch?v=fipD4DdV48g]
== Credits
* Delano (@solutious.com)
== License
See: LICENSE.txt
Changes:
GIBBLER, CHANGES
#### 0.5.1 (2009-07-06) #################################
* CHANGE: Renamed gibbler_revert to gibbler_revert! (Thanks ivey)
#### 0.5 (2009-07-01) #################################
NOTE: This is a significant change from 0.4. Many method names
have been modified so this release is not backwards compatible.
* CHANGE: Now refer to "gibble" as "digest" in all docs and methods.
* CHANGE: Gibbler#gibble -> Gibbler#gibbler
* CHANGE: Gibble is now Gibbler::Digest
* ADDED: Gibbler::History, supporting gibbler_snapshots and gibbler_revert
for the following objects: Array, Hash
* ADDED: Support for short, 8-character digests
* ADDED: Expanded test coverage
#### 0.4 (2009-06-30) #################################
NOTE: Calculated digests have changed since 0.3. Most digests created with
0.3 and earlier will not match those created in 0.4 for the same object
* FIXED: Hash and Array now use the class of the value for hashing
rather than Hash or Array (respectively).
* FIXED: __gibbler methods now return a digest based on their own class.
Previously, all digests were created by String.__gibbler so the class
name from the original object got lost.
* CHANGE: Gibbler methods are no longer available to all Ruby classes
by default. The default list is now: String, Hash, Array, Symbol,
Class, Fixnum, Bignum.
* CHANGE: Renamed Gibbler.gibbler_digest_type to Gibbler.digest_type
* ADDED: Custom objects can now "include Gibbler::Complex"
#### 0.3 (2009-06-29) #################################
* CHANGE: Renamed to_gibble -> gibble
* CHANGE: Renamed __default_gibbler to __gibbler
* CHANGE: Created Gibbler module, all other modules can
include its junk into their namespace.
* ADDED: Object#hash and performance tryouts
#### 0.2 (2009-06-25) #################################
NOTE: Initial release
|
