gibbler 0.5.1 → 0.5.2

data/CHANGES.txt

@@ -1,6 +1,13 @@
 GIBBLER, CHANGES
 
 
+#### 0.5.2 (2009-07-??) #################################
+
+* CHANGE: Moved Gibbler instance methods to Gibbler::Object
+* ADDED: Proc.gibbler which is included by default
+* ADDED: gibbler aliases to allow shorter methods by request.
+
+
 #### 0.5.1 (2009-07-06) #################################
 
 * CHANGE: Renamed gibbler_revert to gibbler_revert! (Thanks ivey)

data/README.rdoc

@@ -2,6 +2,9 @@
 
 Git-like hashes and history for Ruby objects.
 
+NOTE: Gibbler supports Ruby 1.8, 1.9 and JRuby. 
+
+
 == Example 1 -- Basic Usage
     
     require 'gibbler'
@@ -61,6 +64,35 @@ Gibbler can also keep track of the history of changes to an object. By default G
     
 http://delano.github.com/gibbler/img/whoababy.gif
 
+
+== Example 3 -- Method Aliases
+
+If you have control over the namespaces of your objects, you can use the method aliases to tighten up your code a bit. The "gibbler" and "gibbled?" methods can be accessed via "digest" and "changed?", respectively. (The reason they're not enabled by default is to avoid conflicts.)
+
+    require 'gibbler'
+    require 'gibbler/aliases'
+    
+    "kimmy".digest               # => c8027100ecc54945ab15ddac529230e38b1ba6a1
+    :kimmy.digest                # => 52be7494a602d85ff5d8a8ab4ffe7f1b171587df
+    
+    a = [:a, :b, :c]
+    a.digest                     # => e554061823b8f06367555d1ee4c25b4ffee61944
+    a << :d
+    a.changed?                   # => true
+
+
+The history methods also have aliases which remove the "gibbler_".
+
+    require 'gibbler'
+    require 'gibbler/history'
+    require 'gibbler/aliases'
+    
+    
+    a = { :magic => :original }     
+    a.commit                     
+    a.history                    
+    a.revert!                    
+    # etc...
     
 == Supported Classes
 
@@ -85,7 +117,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. "&lt;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. "Object:0x0x4ac9f0...") will produce unreliable digests (because the address can change).
 
 
 == ALPHA Notice
@@ -97,14 +129,14 @@ NOTE: Gibbler history is not suitable for very large objects since it keeps comp
 
 == News
 
-=== 2009-07-06: Renamed gibbler_revert to gibbler_revert!
+=== 2009-07-07: Added aliases
 
-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. 
+The "gibbler" methods can be cumbersome so I added some aliases which can be included by request. See the example above. 
 
 
-=== 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! method 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. 
 
 
 == 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.1"
+	s.version = "0.5.2"
 	s.summary = "Gibbler: Git-like hashes for Ruby objects"
 	s.description = s.summary
 	s.author = "Delano Mandelbaum"

data/lib/gibbler.rb

@@ -6,8 +6,9 @@ require 'digest/sha1'
 # "Hola, Tanneritos"
 #
 module Gibbler
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
   
+  require 'gibbler/object'
   require 'gibbler/digest'
   require 'gibbler/mixins'
   
@@ -32,22 +33,6 @@ module Gibbler
   def self.disable_debug;  @@gibbler_debug = false; end
   # Returns the current digest class. 
   def self.digest_type; @@gibbler_digest_type; 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. 
-  def gibbler
-    #if h.respond_to? :__custom_gibbler
-    #  d = h.__custom_gibbler
-    #  a = __gibbler '%s:%s:%s' % [klass, d.size, d]
-    #  gibbler_debug [klass, a]
-    #  a
-    #end
-    gibbler_debug :GIBBLER, self.class, self
-    @__gibbler_digest__ = Gibbler::Digest.new self.__gibbler
-    @__gibbler_digest__
-  end
   
   # Sends +str+ to Digest::SHA1.hexdigest. If another digest class
   # has been specified, that class will be used instead. 
@@ -56,46 +41,13 @@ module Gibbler
     @@gibbler_digest_type.hexdigest str
   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
-  # <tt>@__gibbler_digest__</tt>)
-  def gibbled?
-    @__gibbler_digest__ ||= self.gibbler
-    was, now = @__gibbler_digest__.clone, self.gibbler
-    gibbler_debug :gibbled?, was, now
-    was != now
-  end
-  
-  def gibbler_debug(*args)
-    return unless Gibbler.debug?
-    p args
-  end
   def self.gibbler_debug(*args)
     return unless Gibbler.debug?
     p args
   end
   
-  # Gets the list of instance variables from the standard implementation
-  # of the instance_variables method and removes all that 
-  # begin with <tt>@__gibbler</tt>. 
-  # Any class the includes Gibbler or Gibbler::* will use this version of
-  # instance_variables. It's important because we don't want the current
-  # digest value to affect the next gibble.
-  # 
-  # This is also critical for objects that include Gibbler::Complex b/c
-  # it deals explicitly with instance variables. If it sees the __gibbler
-  # variables it will go bananas. 
-  #
-  def instance_variables
-    vars = super
-    vars.reject! { |e| e.to_s =~ /^@__gibble/ }
-    vars
-  end
-
   module Complex
-    include Gibbler
+    include Gibbler::Object
     # Creates a digest based on: 
     # * An Array of instance variable names and values in the format: <tt>CLASS:LENGTH:VALUE</tt>
     #   * The gibbler method is called on each element so if it is a Hash or Array etc it 
@@ -133,7 +85,7 @@ module Gibbler
   end
   
   module String
-    include Gibbler
+    include Gibbler::Object
     # Creates a digest based on: <tt>CLASS:LENGTH:VALUE</tt>. 
     # This method can be used for any class where the <tt>to_s</tt>
     # method returns an appropriate unique value for this instance. 
@@ -159,7 +111,7 @@ module Gibbler
   end
       
   module Hash 
-    include Gibbler
+    include Gibbler::Object
     
     # Creates a digest based on: 
     # * parse each key, value pair into an Array containing keys: <tt>CLASS:KEY:VALUE.__gibbler</tt>
@@ -195,7 +147,7 @@ module Gibbler
   end
   
   module Array
-    include Gibbler
+    include Gibbler::Object
     
     # Creates a digest based on:
     # * parse each element into an Array of digests like: <tt>CLASS:INDEX:VALUE.__gibbler</tt>
@@ -230,6 +182,31 @@ module Gibbler
     end
   end
   
+  # Return the digest for <tt>class:arity:binding</tt>, where:
+  # * class is the current class name (e.g. Proc)
+  # * arity is the value returned by <tt>Proc#arity</tt>
+  # * binding is the value returned by <tt>Proc#binding</tt>
+  #
+  # This method can be used by any subclass of Proc.
+  #
+  # NOTE: This is named "Block" because for some reason if this is 
+  # named "Proc" (as in Gibbler::Proc) and the Rye library is also
+  # required, a runtime error is raised (Ruby 1.9.1 only):
+  #
+  #     undefined method `new' for Gibbler::Proc:Module
+  #     /usr/local/lib/ruby/1.9.1/tempfile.rb:169:in `callback'
+  #     /usr/local/lib/ruby/1.9.1/tempfile.rb:61:in `initialize'
+  #     /Users/delano/Projects/opensource/rye/lib/rye.rb:210:in `new'
+  #
+  module Block
+    include Gibbler::Object
+    def __gibbler(h=self)
+      klass = h.class
+      a = Gibbler.digest '%s:%s:%s' % [klass, h.arity, h.binding]
+      gibbler_debug klass, a, [klass, h.arity, h.binding]
+      a
+    end
+  end
   
   ##--
   ## NOTE: this was used when Gibbler supported "include Gibbler". We
@@ -255,6 +232,10 @@ module Gibbler
     
 end
 
+class Proc
+  include Gibbler::Block
+end
+
 class Hash
   include Gibbler::Hash
 end

metadata

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