gibbler 0.7.7 → 0.8.0

data/CHANGES.txt

@@ -1,5 +1,12 @@
 GIBBLER, CHANGES
 
+#### 0.8.0 (2010-04-??) ###############################
+
+* CHANGE: Gibber::Object#__gibbler now accepts only 1 optional argument: digest_type
+* ADDED: Gibbler::Digest#to_i which assumes base 16
+* ADDED: Gibbler::Object#gibbler now accepts a digest type
+* ADDED: Gibbler::Digest#to_s and #base can take a base argument
+
 #### 0.7.7 (2010-03-29) ###############################
 
 * ADDED: Gibbler::Digest#shorten

data/README.rdoc

@@ -1,12 +1,14 @@
-= Gibbler - v0.7 ALPHA
+= Gibbler - v0.8 
 
 Git-like hashes and history for Ruby objects for Ruby 1.8, 1.9 and JRuby. 
 
 Check out the screencast[http://www.rubypulse.com/episode-0.3-gibbler.html] created by Alex Peuchert.
 
-=== Important Information Regarding Your Digests
+== Some things to keep in mind
 
-<i>Digest calculation changed in the 0.7 release for Proc objects. See "News" below for more info.</i>
+* Digest calculation may change between minor releases (as it did between 0.6 and 0.7)
+* 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. 
+* Don't forget to enjoy what you do!
 
 
 == Example 1 -- Basic Usage
@@ -88,7 +90,7 @@ If you have control over the namespaces of your objects, you can use the method
     a.changed?                   # => true
 
 
-The history methods also have aliases which remove the "gibbler_".
+The history methods also have aliases which remove the "gibbler_" prefix.
     
     require 'gibbler/aliases'
     require 'gibbler/history'
@@ -99,6 +101,40 @@ The history methods also have aliases which remove the "gibbler_".
     a.revert!                    
     # etc...
     
+== Example 4 -- Different Digest types
+
+By default Gibbler creates SHA1 hashes. You can change this globally or per instance. 
+
+    require 'gibbler'
+    
+    Gibbler.digest_type = Digest::MD5
+    
+    :kimmy.gibbler               # => 0c61ff17f46223f355759934154d5dcb
+    
+    :kimmy.gibbler(Digest::SHA1) # => 52be7494a602d85ff5d8a8ab4ffe7f1b171587df
+    
+
+In Jruby, you can grab the digest types from the openssl library. 
+
+    require 'openssl'
+    
+    Gibbler.digest_type = OpenSSL::Digest::SHA256
+    
+    :kimmy.gibbler               # => 1069428e6273cf329436c3dce9b680d4d4e229d7b7...
+    
+    
+== Example 5 -- All your base
+
+    require 'gibbler'
+    
+    :kimmy.gibbler               # => 52be7494a602d85ff5d8a8ab4ffe7f1b171587df
+    :kimmy.gibbler.base(16)      # => 52be7494a602d85ff5d8a8ab4ffe7f1b171587df
+    :kimmy.gibbler.base(36)      # => 9nydr6mpv6w4k8ngo3jtx0jz1n97h7j
+
+    :kimmy.gibbler.base(10)      # => 472384540402900668368761869477227308873774630879
+    :kimmy.gibbler.to_i          # => 472384540402900668368761869477227308873774630879
+
+
 == 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:
@@ -127,42 +163,6 @@ Gibbler::String creates a digest based on the name of the class and the output o
 As of 0.7 all Proc objects have the same digest: <tt>12075835e94be34438376cd7a54c8db7e746f15d</tt>. 
 
 
-== ALPHA Notice
-
-This code is fresh so the interface may change. Some things to keep in mind:
-
-* 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. 
-* Digest calculation may change between minor releases (e.g. 0.6 to 0.7, etc)
-* Don't forget to enjoy what you do!
-
-
-== News
-
-=== 2009-10-07: Digest calculation for Proc objects has changed.
-
-Proc digests are now based on the name of the class and the value of Proc#name (if available). Procs or objects containing Procs will have different digests than those created in previous releases.
-
-After much deliberation, I realized that Gibbler cares about the data and not the code. Procs are code, but a reference to a Proc in an instance variable is data. With this change all Proc objects have the same digest. This decision has the side benefit of increasing compatibility between Ruby 1.8, 1.9 & JRuby. 
-
-This is the only change between 0.6.4 and 0.7.0 so if you prefer the previous calculation for Procs you can find it in that version. 
-
-Happy Digesting!
-
-=== 2009-10-07: Support for freezing and Regexp
-
-In 0.6.4, all Gibbler objects will create a new digest when <tt>obj.freeze</tt> is called. All subsequent calls to <tt>obj.gibbler</tt> will return the most recent digest without having to run the calculation again. 
-
-I've also added support for Regexp out of the box. 
-
-=== 2009-07-20: Digest change for instances of Class, Module, and Proc
-
-Digest calculation has changed for Class, Module, and Proc objects. Digests created with Gibbler 0.5.x and earlier will not match the ones created by 0.6. 
-
-* Class and Module objects were calculating digests based on the output of <tt>self.to_s</tt>. This was a problem because that string contains a memory address which can change arbitrarily. The new calculation is based on the object class, the length of name, and the name itself. e.g. <tt>"Class:6:Object" # => '5620e4a8b10ec6830fece61d33f5d3e9a349b4c2'</tt>
-* Proc objects were including the return value of <tt>self.binding</tt> in the digest calculation. This is not reliable because the binding includes an arbitrary address. The new calculation is based on the class name, the arity, and whether it was created with a lambda. 
-
-Also note that this change affects the digests for Hashes and Arrays that contain instances of Class, Module, or Proc. 
-
 
 == 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.7.7"
+	s.version = "0.8.0"
 	s.summary = "Gibbler: Git-like hashes for Ruby objects"
 	s.description = s.summary
 	s.author = "Delano Mandelbaum"

data/lib/gibbler.rb

@@ -15,7 +15,7 @@ require 'digest/sha1'
 # "Hola, Tanneritos"
 #
 module Gibbler
-  VERSION = "0.7.7"
+  VERSION = "0.8.0"
   
   require 'gibbler/mixins'
   
@@ -33,8 +33,23 @@ end
 #
 class Gibbler::Digest < String
   
+  # Return an integer assuming base 16. 
+  def to_i(base=nil)
+    base ||= 16
+    super(base)
+  end
+  
+  # Returns a string. Takes an optional base. 
+  def to_s(base=nil)
+    base.nil? ? super() : super().to_i(16).to_s(base)
+  end
+  
+  def base(base=16)
+    self.class.new(self.to_i(16).to_s(base))
+  end
+  
   def base36
-    self.class.new self.to_i(16).to_s(36)
+    base(36)
   end
   
   # Shorten the digest to the given (optional) length. 
@@ -127,11 +142,11 @@ module Gibbler
     # If the object is frozen, this will return the value of
     # <tt>gibbler_cache</tt>.
     #
-    def gibbler
+    def gibbler(digest_type=nil)
       #gibbler_debug caller[0]
       gibbler_debug :GIBBLER, self.class, self
       return self.gibbler_cache if self.frozen?
-      self.gibbler_cache = Gibbler::Digest.new self.__gibbler
+      self.gibbler_cache = Gibbler::Digest.new self.__gibbler(digest_type)
     end
 
     # Has this object been modified?
@@ -162,11 +177,11 @@ module Gibbler
     # <b>This is a default method appropriate for only the most 
     # basic objects like Class and Module.</b>
     #
-    def __gibbler(h=self)
-      klass = h.class
-      nom = h.name if h.respond_to?(:name)
+    def __gibbler(digest_type=nil)
+      klass = self.class
+      nom = self.name if self.respond_to?(:name)
       nom ||= ''
-      a = Gibbler.digest '%s:%s:%s' % [klass, nom.size, nom]
+      a = Gibbler.digest '%s:%s:%s' % [klass, nom.size, nom], digest_type
       gibbler_debug klass, a, [klass, nom.size, nom]
       a
     end
@@ -210,8 +225,9 @@ module Gibbler
   # Sends +str+ to Digest::SHA1.hexdigest. If another digest class
   # has been specified, that class will be used instead. 
   # See: digest_type
-  def self.digest(str)
-    @@gibbler_digest_type.hexdigest str
+  def self.digest(str, digest_type=nil)
+    digest_type ||= @@gibbler_digest_type
+    digest_type.hexdigest str
   end
   
   def self.gibbler_debug(*args)
@@ -282,16 +298,16 @@ module Gibbler
     end
     
     # Creates a digest for the current state of self. 
-    def __gibbler(h=self)
-      klass = h.class
+    def __gibbler(digest_type=nil)
+      klass = self.class
       d = []
       gibbler_debug :gibbler_fields, gibbler_fields
       gibbler_fields.each do |n|
         value = instance_variable_get("@#{n}")
-        d << '%s:%s:%s' % [value.class, n, value.__gibbler]
+        d << '%s:%s:%s' % [value.class, n, value.__gibbler(digest_type)]
       end
-      d = d.join(':').__gibbler
-      a = Gibbler.digest "%s:%d:%s" % [klass, d.size, d]
+      d = d.join(':').__gibbler(digest_type)
+      a = Gibbler.digest "%s:%d:%s" % [klass, d.size, d], digest_type
       gibbler_debug klass, a, [klass, d.size, d]
       a
     end
@@ -330,10 +346,10 @@ module Gibbler
     end
     
     # Creates a digest for the current state of self. 
-    def __gibbler(h=self)
-      klass = h.class
-      value = h.nil? ? "\0" : h.to_s
-      a = Gibbler.digest "%s:%d:%s" % [klass, value.size, value]
+    def __gibbler(digest_type=nil)
+      klass = self.class
+      value = self.nil? ? "\0" : self.to_s
+      a = Gibbler.digest "%s:%d:%s" % [klass, value.size, value], digest_type
       gibbler_debug klass, a, [klass, value.size, value]
       a
     end
@@ -365,15 +381,15 @@ module Gibbler
     end
     
     # Creates a digest for the current state of self. 
-    def __gibbler(h=self)
-      klass = h.class
-      d = h.keys.sort { |a,b| a.inspect <=> b.inspect }
+    def __gibbler(digest_type=nil)
+      klass = self.class
+      d = self.keys.sort { |a,b| a.inspect <=> b.inspect }
       d.collect! do |name| 
-        value = h[name]
-        '%s:%s:%s' % [value.class, name, value.__gibbler]
+        value = self[name]
+        '%s:%s:%s' % [value.class, name, value.__gibbler(digest_type)]
       end 
-      d = d.join(':').__gibbler
-      a = Gibbler.digest '%s:%s:%s' % [klass, d.size, d]
+      d = d.join(':').__gibbler(digest_type)
+      a = Gibbler.digest '%s:%s:%s' % [klass, d.size, d], digest_type
       gibbler_debug klass, a, [klass, d.size, d]
       a  
     end
@@ -405,15 +421,15 @@ module Gibbler
     end
     
     # Creates a digest for the current state of self. 
-    def __gibbler(h=self)
-      klass = h.class
+    def __gibbler(digest_type=nil)
+      klass = self.class
       d, index = [], 0
-      h.each do |value| 
-        d << '%s:%s:%s' % [value.class, index, value.__gibbler]
+      self.each do |value| 
+        d << '%s:%s:%s' % [value.class, index, value.__gibbler(digest_type)]
         index += 1
       end
-      d = d.join(':').__gibbler
-      a = Gibbler.digest '%s:%s:%s' % [klass, d.size, d]
+      d = d.join(':').__gibbler(digest_type)
+      a = Gibbler.digest '%s:%s:%s' % [klass, d.size, d], digest_type
       gibbler_debug klass, a, [klass, d.size, d]
       a
     end
@@ -441,10 +457,10 @@ module Gibbler
     end
     
     # Creates a digest for the current state of self. 
-    def __gibbler(h=self)
-      klass = h.class
-      value = h.nil? ? "\0" : h.utc.strftime('%Y-%m-%d %H:%M:%S UTC')
-      a = Gibbler.digest "%s:%d:%s" % [klass, value.size, value]
+    def __gibbler(digest_type=nil)
+      klass = self.class
+      value = self.nil? ? "\0" : self.utc.strftime('%Y-%m-%d %H:%M:%S UTC')
+      a = Gibbler.digest "%s:%d:%s" % [klass, value.size, value], digest_type
       gibbler_debug klass, a, [klass, value.size, value]
       a
     end
@@ -472,10 +488,10 @@ module Gibbler
     end
     
     # Creates a digest for the current state of self. 
-    def __gibbler(h=self)
-      klass = h.class
-      value = h.nil? ? "\0" : h.new_offset(0).to_s
-      a = Gibbler.digest "%s:%d:%s" % [klass, value.size, value]
+    def __gibbler(digest_type=nil)
+      klass = self.class
+      value = self.nil? ? "\0" : self.new_offset(0).to_s
+      a = Gibbler.digest "%s:%d:%s" % [klass, value.size, value], digest_type
       gibbler_debug klass, a, [klass, value.size, value]
       a
     end
@@ -505,11 +521,11 @@ module Gibbler
     end
     
     # Creates a digest for the current state of self. 
-    def __gibbler(h=self)
-      klass = h.class
-      value = h.nil? ? "\0" : h.to_s
-      size = h.nil? ? 0 : h.to_a.size
-      a = Gibbler.digest "%s:%d:%s" % [klass, size, value]
+    def __gibbler(digest_type=nil)
+      klass = self.class
+      value = self.nil? ? "\0" : self.to_s
+      size = self.nil? ? 0 : self.to_a.size
+      a = Gibbler.digest "%s:%d:%s" % [klass, size, value], digest_type
       gibbler_debug klass, a, [klass, size, value]
       a
     end
@@ -531,9 +547,9 @@ module Gibbler
     end
 
     # Creates a digest for the current state of self. 
-    def __gibbler(h=self)
-      klass = h.class
-      a = Gibbler.digest "%s:%s" % [klass, "\0"]
+    def __gibbler(digest_type=nil)
+      klass = self.class
+      a = Gibbler.digest "%s:%s" % [klass, "\0"], digest_type
       gibbler_debug klass, a, [klass, "\0"]
       a
     end
@@ -566,10 +582,10 @@ module Gibbler
     end
     
     # Creates a digest for the current state of self. 
-    def __gibbler(h=self)
-      klass = h.class
-      value = h.nil? ? "\0" : h.path
-      a = Gibbler.digest "%s:%d:%s" % [klass, value.size, value]
+    def __gibbler(digest_type=nil)
+      klass = self.class
+      value = self.nil? ? "\0" : self.path
+      a = Gibbler.digest "%s:%d:%s" % [klass, value.size, value], digest_type
       gibbler_debug klass, a, [klass, value.size, value]
       a
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gibbler
 version: !ruby/object:Gem::Version 
-  version: 0.7.7
+  version: 0.8.0
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-29 00:00:00 -04:00
+date: 2010-04-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency