gibbler 0.5.0 → 0.5.1

data/CHANGES.txt

@@ -1,6 +1,11 @@
 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  

data/README.rdoc

@@ -6,6 +6,9 @@ Git-like hashes and history for Ruby objects.
     
     require 'gibbler'
     
+    "kimmy".gibbler              # => c8027100ecc54945ab15ddac529230e38b1ba6a1
+    :kimmy.gibbler               # => 52be7494a602d85ff5d8a8ab4ffe7f1b171587df
+        
     config = {}
     config.gibbler               # => 4fdcadc66a38feb9c57faf3c5a18d5e76a6d29bf
     config.gibbled?              # => false
@@ -42,13 +45,13 @@ Gibbler can also keep track of the history of changes to an object. By default G
     
     a.gibbler_history            # => d7049916, b668098e, 0b11c377
     
-    a.gibbler_revert 'd7049916'  # Return to a specific commit
+    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_revert!            # Return to the previous commit  
     a.gibbler                    # => 0b11c377fccd44554a601e5d2b135c46dc1c4cb1
     a                            # => { :magic => :changed }
         
@@ -82,7 +85,7 @@ If you want to support all Ruby objects, add the following to your application:
       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).
+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. "&lt;Object:0x0x4ac9f0...") will produce unreliable digests (because the address can change).
 
 
 == ALPHA Notice
@@ -94,14 +97,14 @@ NOTE: Gibbler history is not suitable for very large objects since it keeps comp
 
 == News
 
-=== 2009-07-01: Major namespace reorganization
+=== 2009-07-06: Renamed gibbler_revert to gibbler_revert!
 
-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. 
+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-06-30: Digests have changed in 0.4
+=== 2009-07-01: Major namespace reorganization
 
-Digests have changed between 0.3 and 0.4. Ones created with 0.3 and earlier will not match ones created with 0.4 for the same object. 
+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

data/gibbler.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
 	s.name = "gibbler"
   s.rubyforge_project = "gibbler"
-	s.version = "0.5.0"
+	s.version = "0.5.1"
 	s.summary = "Gibbler: Git-like hashes for Ruby objects"
 	s.description = s.summary
 	s.author = "Delano Mandelbaum"

data/lib/gibbler/history.rb

@@ -89,19 +89,19 @@ module Gibbler
     # will revert to that point. 
     #
     # Ruby does not support replacing self (<tt>self = previous_self</tt>) so each 
-    # object type needs to implement its own __gibbler_revert method. This default
-    # run some common checks and then defers to self.__gibbler_revert. 
+    # object type needs to implement its own __gibbler_revert! method. This default
+    # run some common checks and then defers to self.__gibbler_revert!. 
     # 
     # Raise the following exceptions:
-    # * NoRevert: if this object doesn't have a __gibbler_revert method
+    # * NoRevert: if this object doesn't have a __gibbler_revert! method
     # * NoHistory: This object has no commits
     # * BadDigest: The given digest is not in the history for this object
     #
     # If +g+ matches the current digest value this method does nothing. 
     #
     # Returns the new digest (+g+). 
-    def gibbler_revert(g=nil)
-      raise NoRevert unless self.respond_to?(:__gibbler_revert)
+    def gibbler_revert!(g=nil)
+      raise NoRevert unless self.respond_to?(:__gibbler_revert!)
       raise NoHistory, self.class unless gibbler_history?
       raise BadDigest, g if !g.nil? && !gibbler_valid?(g)
       
@@ -114,7 +114,7 @@ module Gibbler
         @@mutex.synchronize {
           # Always make sure @__gibbler_digest__ is a Gibbler::Digest 
           @__gibbler_digest__ = g.is_a?(Gibbler::Digest) ? g : Gibbler::Digest.new(g)
-          self.__gibbler_revert
+          self.__gibbler_revert!
         }
       end
       
@@ -145,7 +145,7 @@ end
 
 class Hash
   include Gibbler::History
-  def __gibbler_revert
+  def __gibbler_revert!
     self.clear
     self.merge! self.gibbler_object @__gibbler_digest__
   end
@@ -153,7 +153,7 @@ end
 
 class Array
   include Gibbler::History
-  def __gibbler_revert
+  def __gibbler_revert!
     self.clear
     self.push *(self.gibbler_object @__gibbler_digest__)
   end
@@ -161,7 +161,7 @@ end
   
 class String
   include Gibbler::History
-  def __gibbler_revert
+  def __gibbler_revert!
     self.clear
     self << (self.gibbler_object @__gibbler_digest__)
   end

data/lib/gibbler.rb

@@ -6,7 +6,7 @@ require 'digest/sha1'
 # "Hola, Tanneritos"
 #
 module Gibbler
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
   
   require 'gibbler/digest'
   require 'gibbler/mixins'
@@ -122,7 +122,7 @@ module Gibbler
       a
     end
     
-    def __gibbler_revert
+    def __gibbler_revert!
       state = self.gibbler_object @__gibbler_digest__
       state.instance_variables do |n|
         v = state.instance_variable_get n

data/tryouts/51_hash_history_tryouts.rb

@@ -44,7 +44,7 @@ tryouts "Hash History" do
     a = { :magic => :original }
     a.gibbler_commit
     a[:magic] = :updated
-    a.gibbler_revert
+    a.gibbler_revert!
   end
   
   drill "knows a valid gibble", true do
@@ -67,7 +67,7 @@ tryouts "Hash History" do
     a.gibbler_commit
     a[:magic] = :changed
     a.gibbler_commit
-    a.gibbler_revert 'd7049916ddb25e6cc438b1028fb957e5139f9910'
+    a.gibbler_revert! 'd7049916ddb25e6cc438b1028fb957e5139f9910'
     a
   end
   
@@ -76,7 +76,7 @@ tryouts "Hash History" do
   drill "revert does nothing if digest is the same as current one" do
     a = { :magic => :original }
     a.gibbler_commit
-    a.gibbler_revert
+    a.gibbler_revert!
     a
   end
   
@@ -85,7 +85,7 @@ tryouts "Hash History" do
     a = { :magic => :original }
     a.gibbler_commit
     a[:magic] = :updated
-    a.gibbler_revert 'd7049916'
+    a.gibbler_revert! 'd7049916'
   end
   
 end

data/tryouts/52_array_history_tryouts.rb

@@ -37,7 +37,7 @@ tryouts "Array History" do
     stash :original, a.gibbler_commit
     a << :joey
     stash :updated, a.gibbler
-    a.gibbler_revert
+    a.gibbler_revert!
   end
   
   

data/tryouts/53_string_history_tryouts.rb

@@ -36,7 +36,7 @@ tryouts "String History" do
     stash :original, a.gibbler_commit
     a << " gibbler"
     stash :updated, a.gibbler
-    a.gibbler_revert
+    a.gibbler_revert!
   end
   
 end

data/tryouts/57_arbitrary_history_tryouts.rb

@@ -38,7 +38,7 @@ tryouts "Arbitrary Object History" do
     stash :original, a.gibbler_commit
     a.roles = [:jesse]
     stash :updated, a.gibbler
-    a.gibbler_revert
+    a.gibbler_revert!
   end
   
 end

data/tryouts/59_history_exceptions_tryouts.rb

@@ -13,18 +13,18 @@ tryouts "Exceptions" do
   drill "raises exception when reverting to unknown gibble" do
     a = {}
     a.gibbler_commit
-    a.gibbler_revert '2222222222222222222222222222222222222222'
+    a.gibbler_revert! '2222222222222222222222222222222222222222'
   end
   
   dream :exception, Gibbler::NoHistory
   drill "raises exception when reverting and there's no history" do
     a = []
-    a.gibbler_revert
+    a.gibbler_revert!
   end
   
   dream :exception, NoMethodError
   drill "raises exception when reverting an unsupported object" do
-    :kimmy.gibbler_revert
+    :kimmy.gibbler_revert!
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gibbler
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-01 00:00:00 -04:00
+date: 2009-07-06 00:00:00 -04:00
 default_executable: 
 dependencies: []