gibbler 0.7.0 → 0.7.1

data/CHANGES.txt

@@ -1,6 +1,11 @@
 GIBBLER, CHANGES
 
 
+#### 0.7.1 (2009-10-09) #################################
+
+* FIXED: Gibbler::Complex now sorts instance variables before processing. 
+  This resolves the issue of digest compatibility between 1.8, 1.9, and JRuby. 
+
 #### 0.7.0 (2009-10-07) #################################
 
 NOTE: Digest calculation for Proc objects has changed. Procs

data/gibbler.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
 	s.name = "gibbler"
   s.rubyforge_project = "gibbler"
-	s.version = "0.7.0"
+	s.version = "0.7.1"
 	s.summary = "Gibbler: Git-like hashes for Ruby objects"
 	s.description = s.summary
 	s.author = "Delano Mandelbaum"
@@ -35,29 +35,8 @@
   gibbler.gemspec
   lib/gibbler.rb
   lib/gibbler/aliases.rb
-  lib/gibbler/digest.rb
   lib/gibbler/history.rb
   lib/gibbler/mixins.rb
-  lib/gibbler/mixins/string.rb
-  lib/gibbler/object.rb
-  tryouts/01_mixins_tryouts.rb
-  tryouts/02_compat_tryouts.rb
-  tryouts/05_gibbler_digest_tryouts.rb
-  tryouts/10_basic_tryouts.rb
-  tryouts/11_basic_sha256_tryouts.rb
-  tryouts/14_extended_tryouts.rb
-  tryouts/15_file_tryouts.rb
-  tryouts/16_uri_tryouts.rb
-  tryouts/20_time_tryouts.rb
-  tryouts/50_history_tryouts.rb
-  tryouts/51_hash_history_tryouts.rb
-  tryouts/52_array_history_tryouts.rb
-  tryouts/53_string_history_tryouts.rb
-  tryouts/57_arbitrary_history_tryouts.rb
-  tryouts/59_history_exceptions_tryouts.rb
-  tryouts/80_performance_tryouts.rb
-  tryouts/90_alias_tryouts.rb
-  tryouts/object_hash_demo.rb
   )
   
   s.has_rdoc = true

data/lib/gibbler/mixins.rb

@@ -1,4 +1,9 @@
 
 
-require 'gibbler/mixins/string'
-
+class String
+  unless method_defined? :clear
+    def clear
+      replace ""
+    end
+  end
+end

data/lib/gibbler.rb

@@ -8,17 +8,166 @@ require 'digest/sha1'
 # "Hola, Tanneritos"
 #
 module Gibbler
+  VERSION = "0.7.1"
   
-  VERSION = "0.7.0"
-  
-  require 'gibbler/digest'
-  require 'gibbler/object'
   require 'gibbler/mixins'
   
   class Error < RuntimeError
     def initialize(obj); @obj = obj; end
   end
   
+end
+
+
+# = Gibbler::Digest
+#
+# A tiny subclass of String which adds a
+# few digest related convenience methods.
+#
+class Gibbler::Digest < String
+  
+  # Returns the first 8 characters of itself (the digest).
+  #
+  # e.g. 
+  #
+  #     "kimmy".gibbler         # => c8027100ecc54945ab15ddac529230e38b1ba6a1
+  #     "kimmy".gibbler.short   # => c8027100
+  #
+  def short
+    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
+  
+  # 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
+
+module Gibbler
+  module Object
+    
+    def self.included(obj)
+      obj.extend Attic
+      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. 
+    # Objects that are a kind of Hash or Array are processed
+    # recursively. The length of the returned String depends 
+    # on the digest type. Also stores the value in the attic.
+    # 
+    #     obj.gibbler          # => a5b1191a
+    #     obj.gibbler_cache    # => a5b1191a
+    # 
+    # Calling gibbler_cache returns the most recent digest
+    # without calculation.
+    #
+    # If the object is frozen, this will return the value of
+    # <tt>gibbler_cache</tt>.
+    #
+    def gibbler
+      #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
+    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>).
+    # See Attic[http://github.com/delano/attic]
+    def gibbled?
+      self.gibbler_cache ||= self.gibbler
+      was, now = self.gibbler_cache.clone, self.gibbler
+      gibbler_debug :gibbled?, was, now
+      was != now
+    end
+
+    def gibbler_debug(*args)
+      return unless Gibbler.debug?
+      p args
+    end
+    
+    # Creates a digest for the current state of self based on:
+    # * Object#class
+    # * Length of Object#name || 0
+    # * Object#name || ''
+    # 
+    # e.g. Digest::SHA1.hexdigest "Class:6:Object" #=> 
+    #
+    # <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)
+      nom ||= ''
+      a = Gibbler.digest '%s:%s:%s' % [klass, nom.size, nom]
+      gibbler_debug klass, a, [klass, nom.size, nom]
+      a
+    end
+    
+    # A simple override on Object#freeze to create a digest
+    # before the object is frozen. Once the object is frozen
+    # <tt>obj.gibbler</tt> will return the cached value with
+    # out calculation.
+    def freeze() 
+      #gibbler_debug :freeze, caller[0]
+      self.gibbler
+      super
+      self
+    end
+    
+  end
+  
+end
+
+
+module Gibbler
+
   @@gibbler_debug = false
   @@gibbler_digest_type = ::Digest::SHA1
   
@@ -88,7 +237,8 @@ module Gibbler
     def __gibbler(h=self)
       klass = h.class
       d = []
-      instance_variables.each do |n|
+      gibbler_debug :ivars, instance_variables.sort
+      instance_variables.sort.each do |n|
         value = instance_variable_get(n)
         d << '%s:%s:%s' % [value.class, n, value.__gibbler]
       end
@@ -209,12 +359,17 @@ module Gibbler
     # Creates a digest for the current state of self. 
     def __gibbler(h=self)
       klass = h.class
-      d, index = [], 0
-      h.each do |value| 
-        d << '%s:%s:%s' % [value.class, index, value.__gibbler]
-        index += 1
+      d, idx = [], 0
+      shorts = ['String', 'Fixnum', 'Symbol']
+      h.each do |v| # Some Array-like classes don't have each_with_index
+        if shorts.member?(v.class.to_s) 
+          d << '%s:%s:%s:%s' % [v.class, idx, v.to_s.size, v.to_s]
+        else
+          d << '%s:%s:%s' % [v.class, idx, v.__gibbler]
+        end
+        idx += 1
       end
-      d = d.join(':').__gibbler
+      d = d.join(':')
       a = Gibbler.digest '%s:%s:%s' % [klass, d.size, d]
       gibbler_debug klass, a, [klass, d.size, d]
       a
@@ -401,6 +556,7 @@ module Gibbler
     
 end
 
+
 class NilClass;            include Gibbler::Nil;       end
 class Class;               include Gibbler::Object;    end
 class Module;              include Gibbler::Object;    end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gibbler
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-07 00:00:00 -04:00
+date: 2009-11-23 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,29 +39,8 @@ files:
 - gibbler.gemspec
 - lib/gibbler.rb
 - lib/gibbler/aliases.rb
-- lib/gibbler/digest.rb
 - lib/gibbler/history.rb
 - lib/gibbler/mixins.rb
-- lib/gibbler/mixins/string.rb
-- lib/gibbler/object.rb
-- tryouts/01_mixins_tryouts.rb
-- tryouts/02_compat_tryouts.rb
-- tryouts/05_gibbler_digest_tryouts.rb
-- tryouts/10_basic_tryouts.rb
-- tryouts/11_basic_sha256_tryouts.rb
-- tryouts/14_extended_tryouts.rb
-- tryouts/15_file_tryouts.rb
-- tryouts/16_uri_tryouts.rb
-- tryouts/20_time_tryouts.rb
-- tryouts/50_history_tryouts.rb
-- tryouts/51_hash_history_tryouts.rb
-- tryouts/52_array_history_tryouts.rb
-- tryouts/53_string_history_tryouts.rb
-- tryouts/57_arbitrary_history_tryouts.rb
-- tryouts/59_history_exceptions_tryouts.rb
-- tryouts/80_performance_tryouts.rb
-- tryouts/90_alias_tryouts.rb
-- tryouts/object_hash_demo.rb
 has_rdoc: true
 homepage: http://github.com/delano/gibbler
 licenses: []
@@ -90,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gibbler
-rubygems_version: 1.3.2
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: "Gibbler: Git-like hashes for Ruby objects"

data/lib/gibbler/digest.rb

@@ -1,63 +0,0 @@
-
-# = Gibbler::Digest
-#
-# A tiny subclass of String which adds a
-# few digest related convenience methods.
-#
-class Gibbler::Digest < String
-  
-  # Returns the first 8 characters of itself (the digest).
-  #
-  # e.g. 
-  #
-  #     "kimmy".gibbler         # => c8027100ecc54945ab15ddac529230e38b1ba6a1
-  #     "kimmy".gibbler.short   # => c8027100
-  #
-  def short
-    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
-  
-  # 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/mixins/string.rb

@@ -1,9 +0,0 @@
-
-
-class String
-  unless method_defined? :clear
-    def clear
-      replace ""
-    end
-  end
-end

data/lib/gibbler/object.rb

@@ -1,79 +0,0 @@
-
-
-module Gibbler
-  
-  module Object
-    
-    def self.included(obj)
-      obj.extend Attic
-      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. 
-    # Objects that are a kind of Hash or Array are processed
-    # recursively. The length of the returned String depends 
-    # on the digest type. Also stores the value in the attic.
-    # 
-    #     obj.gibbler          # => a5b1191a
-    #     obj.gibbler_cache    # => a5b1191a
-    # 
-    # Calling gibbler_cache returns the most recent digest
-    # without calculation.
-    #
-    # If the object is frozen, this will return the value of
-    # <tt>gibbler_cache</tt>.
-    #
-    def gibbler
-      gibbler_debug :GIBBLER, self.class, self
-      return self.gibbler_cache if self.frozen?
-      self.gibbler_cache = Gibbler::Digest.new self.__gibbler
-    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>).
-    # See Attic[http://github.com/delano/attic]
-    def gibbled?
-      self.gibbler_cache ||= self.gibbler
-      was, now = self.gibbler_cache.clone, self.gibbler
-      gibbler_debug :gibbled?, was, now
-      was != now
-    end
-
-    def gibbler_debug(*args)
-      return unless Gibbler.debug?
-      p args
-    end
-    
-    # Creates a digest for the current state of self based on:
-    # * Object#class
-    # * Length of Object#name || 0
-    # * Object#name || ''
-    # 
-    # e.g. Digest::SHA1.hexdigest "Class:6:Object" #=> 
-    #
-    # <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)
-      nom ||= ''
-      a = Gibbler.digest '%s:%s:%s' % [klass, nom.size, nom]
-      gibbler_debug klass, a, [klass, nom.size, nom]
-      a
-    end
-    
-    # A simple override on Object#freeze to create a digest
-    # before the object is frozen. Once the object is frozen
-    # <tt>obj.gibbler</tt> will return the cached value with
-    # out calculation.
-    def freeze() self.gibbler; super; self end
-    
-  end
-  
-end

data/tryouts/01_mixins_tryouts.rb

@@ -1,13 +0,0 @@
-
-library :gibbler, 'lib'
-
-group "Mixins"
-
-tryouts "String" do
-  
-  drill "has String#clear" do
-    "".respond_to? :clear
-  end
-  
-end
-

data/tryouts/02_compat_tryouts.rb

@@ -1,25 +0,0 @@
-
-library :gibbler, 'lib'
-
-group "Gibbler::Digest"
-
-tryouts "Backwards compatability" do
-  
-  dream true
-  drill "Gibbler Objects have gibbler_cache method" do
-    "kimmy".respond_to? :gibbler_cache
-  end
-  
-  dream true
-  drill "Gibbler Objects have __gibbler_cache method" do
-    "kimmy".respond_to? :__gibbler_cache
-  end
-  
-  dream true
-  drill "__gibbler_cache returns the same value as gibbler_cache" do
-    a = "kimmy" and a.gibbler
-    a.__gibbler_cache == a.gibbler_cache
-  end
-
-end
-

data/tryouts/05_gibbler_digest_tryouts.rb

@@ -1,31 +0,0 @@
-
-library :gibbler, 'lib'
-
-group "Gibbler::Digest"
-
-tryouts "All methods" do
-  
-  
-  dream :class, Gibbler::Digest
-  dream 'c8027100'  
-  drill "has short method" do
-    "kimmy".gibbler.short
-  end
-  
-  dream :class, Gibbler::Digest
-  dream "12345678"
-  drill "can Gibbler::Digest#short" do
-    Gibbler::Digest.new("1234567890").short
-  end
-  
-  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
-