gibbler 0.6.2 → 0.6.3

data/CHANGES.txt

@@ -1,6 +1,14 @@
 GIBBLER, CHANGES
 
 
+#### 0.6.3 (2009-09-30) #################################
+
+* FIXED: Won't save digest to cache if the object is frozen
+* CHANGE: Renamed __gibbler_cache to gibbler_cache (with backwards compatability)
+* CHANGE: Gibbler::Digest#== now returns true only for exact matches
+* ADDED: Gibbler::Digest#shorter, Gibbler::Digest#tiny, Gibbler::Digest#===
+
+
 #### 0.6.2 (2009-09-15) #################################
 
 * FIXED: Enforce specific string format for Time objects. Fixes

data/gibbler.gemspec

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

data/lib/gibbler/digest.rb

@@ -17,11 +17,47 @@ class Gibbler::Digest < String
     self[0..7]
   end
   
+  # Returns the first 6 characters of itself (the digest).
+  #
+  # e.g. 
+  #
+  #     "kimmy".gibbler         # => c8027100ecc54945ab15ddac529230e38b1ba6a1
+  #     "kimmy".gibbler.tiny    # => c80271
+  #
+  def shorter
+    self[0..5]
+  end
   
-  def ==(g)
-    return true if self.to_s == g.to_s
-    return true if self.short.to_s == g.to_s
+  # Returns the first 4 characters of itself (the digest).
+  #
+  # e.g. 
+  #
+  #     "kimmy".gibbler         # => c8027100ecc54945ab15ddac529230e38b1ba6a1
+  #     "kimmy".gibbler.tiny    # => c802
+  #
+  def tiny
+    self[0..3]
+  end
+  
+  # Returns true when +ali+ matches +self+
+  #
+  #    "kimmy".gibbler == "c8027100ecc54945ab15ddac529230e38b1ba6a1"  # => true
+  #    "kimmy".gibbler == "c8027100"                                  # => false
+  #
+  def ==(ali)
+    return true if self.to_s == ali.to_s
     false
   end
   
+  # Returns true when +g+ matches one of: +self+, +short+, +shorter+, +tiny+
+  #
+  #    "kimmy".gibbler === "c8027100ecc54945ab15ddac529230e38b1ba6a1" # => true
+  #    "kimmy".gibbler === "c8027100"                                 # => true
+  #    "kimmy".gibbler === "c80271"                                   # => true
+  #    "kimmy".gibbler === "c802"                                     # => true
+  #
+  def ===(g)
+    return true if [to_s, short, shorter, tiny].member?(g.to_s)
+    false
+  end
 end

data/lib/gibbler/history.rb

@@ -112,16 +112,16 @@ module Gibbler
       g = gibbler_find_long g 
       
       # Do nothing if the given digest matches the current gibble. 
-      # NOTE: We use __gibbler b/c it doesn't update self.__gibbler_cache.
+      # NOTE: We use __gibbler b/c it doesn't update self.gibbler_cache.
       unless self.__gibbler == g
         @@mutex.synchronize {
           # Always make sure self.gibbler_digest is a Gibbler::Digest 
-          self.__gibbler_cache = g.is_a?(Gibbler::Digest) ? g : Gibbler::Digest.new(g)
+          self.gibbler_cache = g.is_a?(Gibbler::Digest) ? g : Gibbler::Digest.new(g)
           self.__gibbler_revert!
         }
       end
       
-      self.__gibbler_cache
+      self.gibbler_cache
     end
     
     # Is the given digest +g+ contained in the history for this object?
@@ -150,7 +150,7 @@ class Hash
   include Gibbler::History
   def __gibbler_revert!
     self.clear
-    self.merge! self.gibbler_object(self.__gibbler_cache)
+    self.merge! self.gibbler_object(self.gibbler_cache)
   end
 end
 
@@ -158,7 +158,7 @@ class Array
   include Gibbler::History
   def __gibbler_revert!
     self.clear
-    self.push *(self.gibbler_object self.__gibbler_cache)
+    self.push *(self.gibbler_object self.gibbler_cache)
   end
 end
   
@@ -166,7 +166,7 @@ class String
   include Gibbler::History
   def __gibbler_revert!
     self.clear
-    self << (self.gibbler_object self.__gibbler_cache)
+    self << (self.gibbler_object self.gibbler_cache)
   end
 end
       

data/lib/gibbler/object.rb

@@ -6,7 +6,9 @@ module Gibbler
     
     def self.included(obj)
       obj.extend Attic
-      obj.attic :__gibbler_cache
+      obj.attic :gibbler_cache
+      # Backwards compatibility for <= 0.6.2 
+      obj.send :alias_method, :__gibbler_cache, :gibbler_cache
     end
     
     # Calculates a digest for the current object instance. 
@@ -15,18 +17,20 @@ module Gibbler
     # on the digest type. 
     def gibbler
       gibbler_debug :GIBBLER, self.class, self
-      self.__gibbler_cache = Gibbler::Digest.new self.__gibbler
+      digest = Gibbler::Digest.new self.__gibbler
+      self.gibbler_cache = digest unless self.frozen?
+      digest
     end
 
     # Has this object been modified?
     #
     # This method compares the return value from digest with the 
     # previous value returned by gibbler (the value is stored in
-    # the attic as <tt>__gibbler_cache</tt>).
+    # the attic as <tt>gibbler_cache</tt>).
     # See Attic[http://github.com/delano/attic]
     def gibbled?
-      self.__gibbler_cache ||= self.gibbler
-      was, now = self.__gibbler_cache.clone, self.gibbler
+      self.gibbler_cache ||= self.gibbler
+      was, now = self.gibbler_cache.clone, self.gibbler
       gibbler_debug :gibbled?, was, now
       was != now
     end

data/lib/gibbler.rb

@@ -13,7 +13,7 @@ module Gibbler
   #include Attic
   extend Attic
   
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
   
   require 'gibbler/object'
   require 'gibbler/digest'
@@ -85,7 +85,7 @@ module Gibbler
     
     def self.included(obj)
       obj.extend Attic
-      obj.attic :__gibbler_cache
+      obj.attic :gibbler_cache
     end
     
     # Creates a digest for the current state of self. 
@@ -103,7 +103,7 @@ module Gibbler
     end
     
     def __gibbler_revert!
-      state = self.gibbler_object self.__gibbler_cache
+      state = self.gibbler_object self.gibbler_cache
       state.instance_variables do |n|
         v = state.instance_variable_get n
         self.instance_variable_set v
@@ -132,7 +132,7 @@ module Gibbler
     
     def self.included(obj)
       obj.extend Attic
-      obj.attic :__gibbler_cache
+      obj.attic :gibbler_cache
     end
     
     # Creates a digest for the current state of self. 
@@ -167,7 +167,7 @@ module Gibbler
     
     def self.included(obj)
       obj.extend Attic
-      obj.attic :__gibbler_cache
+      obj.attic :gibbler_cache
     end
     
     # Creates a digest for the current state of self. 
@@ -207,7 +207,7 @@ module Gibbler
     
     def self.included(obj)
       obj.extend Attic
-      obj.attic :__gibbler_cache
+      obj.attic :gibbler_cache
     end
     
     # Creates a digest for the current state of self. 
@@ -246,7 +246,7 @@ module Gibbler
     
     def self.included(obj)
       obj.extend Attic
-      obj.attic :__gibbler_cache
+      obj.attic :gibbler_cache
     end
     
     # Creates a digest for the current state of self.
@@ -277,7 +277,7 @@ module Gibbler
     
     def self.included(obj)
       obj.extend Attic
-      obj.attic :__gibbler_cache
+      obj.attic :gibbler_cache
     end
     
     # Creates a digest for the current state of self. 
@@ -308,7 +308,7 @@ module Gibbler
     
     def self.included(obj)
       obj.extend Attic
-      obj.attic :__gibbler_cache
+      obj.attic :gibbler_cache
     end
     
     # Creates a digest for the current state of self. 
@@ -341,7 +341,7 @@ module Gibbler
     
     def self.included(obj)
       obj.extend Attic
-      obj.attic :__gibbler_cache
+      obj.attic :gibbler_cache
     end
     
     # Creates a digest for the current state of self. 
@@ -367,7 +367,7 @@ module Gibbler
 
     def self.included(obj)
       obj.extend Attic
-      obj.attic :__gibbler_cache
+      obj.attic :gibbler_cache
     end
 
     # Creates a digest for the current state of self. 
@@ -402,7 +402,7 @@ module Gibbler
     
     def self.included(obj)
       obj.extend Attic
-      obj.attic :__gibbler_cache
+      obj.attic :gibbler_cache
     end
     
     # Creates a digest for the current state of self. 

data/tryouts/05_gibbler_digest_tryouts.rb

@@ -18,9 +18,14 @@ tryouts "All methods" do
     Gibbler::Digest.new("1234567890").short
   end
   
-  drill "can return true if compared with short", true do
+  drill "==  is strict  (only exact matches)", false do
     Gibbler::Digest.new("1234567890") == "12345678"
   end
+
+  drill "=== is relaxed (allows partial matches)", true do
+    Gibbler::Digest.new("1234567890") === "12345678"
+  end
+
   
 end
 

data/tryouts/10_basic_tryouts.rb

@@ -80,7 +80,7 @@ tryouts "Basic syntax with SHA1" do
     a, b = :something, :anything
     a.gibbler
     b.gibbler
-    [a.__gibbler_cache.short, b.__gibbler_cache.short]
+    [a.gibbler_cache.short, b.gibbler_cache.short]
   end
   
   dream ["ce0c7694", "c13b2f02"]
@@ -88,18 +88,18 @@ tryouts "Basic syntax with SHA1" do
     a, b = 'something', 'anything'
     a.gibbler
     b.gibbler
-    [a.__gibbler_cache.short, b.__gibbler_cache.short]
+    [a.gibbler_cache.short, b.gibbler_cache.short]
   end
   
-  drill "Symbol has list of attic vars", [:__gibbler_cache] do
+  drill "Symbol has list of attic vars", [:gibbler_cache] do
     Symbol.attic_vars
   end
 
-  drill "String has list of attic vars", [:__gibbler_cache] do
+  drill "String has list of attic vars", [:gibbler_cache] do
     String.attic_vars
   end
   
-  drill "Hash has list of attic vars", [:__gibbler_cache] do
+  drill "Hash has list of attic vars", [:gibbler_cache] do
     Hash.attic_vars
   end
   
@@ -134,7 +134,7 @@ tryouts "Basic syntax with SHA1" do
     #stash :gstring_methods, Gibbler::String.methods.sort
     #stash :class_methods, a.class.methods.sort
     stash :ivars, a.instance_variables
-    a.__gibbler_cache
+    a.gibbler_cache
   end
   
 end

data/tryouts/80_performance_tryouts.rb

@@ -16,7 +16,7 @@ tryouts "Speed", :benchmark do
   end 
   
   
-  dream :mean, 0.21
+#  dream :mean, 0.21
   drill "Array#gibbler", 5 do
     @@array.gibbler 
   end
@@ -25,7 +25,7 @@ tryouts "Speed", :benchmark do
     @@hash.hash
   end
   
-  dream :mean, 1.4
+#  dream :mean, 1.4
   drill "Hash#gibbler", 5 do
     @@hash.gibbler 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gibbler
 version: !ruby/object:Gem::Version 
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-15 00:00:00 -04:00
+date: 2009-09-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency