gibbler 0.5.2 → 0.5.3

data/CHANGES.txt

@@ -1,7 +1,14 @@
 GIBBLER, CHANGES
 
+#### 0.5.3 (2009-07-12) #################################
 
-#### 0.5.2 (2009-07-??) #################################
+* FIXED: Updated gemspec to fix missing files (aliases)
+* CHANGE: conversion to attic instead of weirdo instance 
+  variables (@__gibbler__ and @__gibbler_history)
+* NEW DEPENDENCY: attic
+
+
+#### 0.5.2 (2009-07-07) #################################
 
 * CHANGE: Moved Gibbler instance methods to Gibbler::Object
 * ADDED: Proc.gibbler which is included by default

data/README.rdoc

@@ -144,6 +144,20 @@ The gibbler_revert! method modifies the object in place so this was an important
 * gibbler or gibbled? must be called at least once before gibbled? will be able to return a useful value (otherwise there is no previous digest value to compare to)
 
 
+== Installation
+
+Via Rubygems, one of:
+
+    $ gem install gibbler
+    $ gem install delano-gibbler
+
+
+or via download:
+* gibbler-latest.tar.gz[http://github.com/delano/gibbler/tarball/latest]
+* gibbler-latest.zip[http://github.com/delano/gibbler/zipball/latest]
+
+
+
 == More Info
 
 * Codes[http://github.com/delano/gibbler]

data/gibbler.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
 	s.name = "gibbler"
   s.rubyforge_project = "gibbler"
-	s.version = "0.5.2"
+	s.version = "0.5.3"
 	s.summary = "Gibbler: Git-like hashes for Ruby objects"
 	s.description = s.summary
 	s.author = "Delano Mandelbaum"
@@ -23,6 +23,9 @@
   # Update --main to reflect the default page to display
   s.rdoc_options = ["--line-numbers", "--title", s.summary, "--main", "README.rdoc"]
   
+  # = DEPENDENCIES =
+  s.add_dependency 'attic'
+  
   # = MANIFEST =
   s.files = %w(
   CHANGES.txt
@@ -31,10 +34,12 @@
   Rakefile
   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/05_gibbler_digest_tryouts.rb
   tryouts/10_basic_tryouts.rb
@@ -46,6 +51,7 @@
   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
   )
   

data/lib/gibbler/aliases.rb

@@ -0,0 +1,29 @@
+
+
+module Gibbler
+  
+
+  module Object
+    alias :digest       :gibbler
+    alias :changed?     :gibbled?
+  end
+  
+  #--
+  # Aliases for Gibbler::History methods
+  #
+  # NOTE: we explicitly define the methods rather than use "alias"
+  # in the event that the require 'gibbler/aliases' appears before
+  # require 'gibbler/history' (alias complains about unknown methods)
+  #++
+  module History
+    def history(*args, &b); gibbler_history(*args, &b); end
+    def commit; gibbler_commit; end
+    def object(*args, &b); gibbler_object(*args, &b); end
+    def stamp(*args, &b); gibbler_stamp(*args, &b); end
+    def revert!(*args, &b); gibbler_revert!(*args, &b); end
+    def history?; gibbler_history?; end
+    def valid?(*args, &b); gibbler_valid?(*args, &b); end
+    def find_long(*args, &b); gibbler_find_long(*args, &b); end
+  end
+
+end

data/lib/gibbler/history.rb

@@ -13,6 +13,9 @@ module Gibbler
   end
     
   module History
+    extend Attic
+    
+    attic :__gibbler_history
     
     @@mutex = Mutex.new
     
@@ -23,15 +26,15 @@ module Gibbler
     # to the short 8 character digests.
     def gibbler_history(short=false)
       # Only a single thread should attempt to initialize the store.
-      if @__gibbler_history__.nil?
+      if self.__gibbler_history.nil?
         @@mutex.synchronize {
-          @__gibbler_history__ ||= { :history => [], :objects => {}, :stamp => {} }
+          self.__gibbler_history ||= { :history => [], :objects => {}, :stamp => {} }
         }
       end
       if short == false
-        @__gibbler_history__[:history]
+        self.__gibbler_history[:history]
       else
-        @__gibbler_history__[:history].collect { |g| g.short }
+        self.__gibbler_history[:history].collect { |g| g.short }
       end
     end
     
@@ -42,7 +45,7 @@ module Gibbler
       g = self.gibbler_history.last if g.nil?
 
       return unless gibbler_valid? g
-      @__gibbler_history__[:objects][ g ]
+      self.__gibbler_history[:objects][ g ]
     end
     
     # Returns the timestamp (a Time object) when the digest +g+ was committed. 
@@ -51,7 +54,7 @@ module Gibbler
       g = gibbler_find_long g
       g = self.gibbler_history.last if g.nil?
       return unless gibbler_valid? g
-      @__gibbler_history__[:stamp][ g ]
+      self.__gibbler_history[:stamp][ g ]
     end
     
     # Stores a clone of the current object instance using the current
@@ -68,17 +71,17 @@ module Gibbler
     def gibbler_commit
       now, digest, point = nil,nil,nil
       
-      if @__gibbler_history__.nil?
+      if self.__gibbler_history.nil?
         @@mutex.synchronize {
-          @__gibbler_history__ ||= { :history => [], :objects => {}, :stamp => {} }
+          self.__gibbler_history ||= { :history => [], :objects => {}, :stamp => {} }
         }
       end
       
       @@mutex.synchronize {
         now, digest, point = Time.now, self.gibbler, self.clone
-        @__gibbler_history__[:history] << digest
-        @__gibbler_history__[:stamp][digest] = now
-        @__gibbler_history__[:objects][digest] = point
+        self.__gibbler_history[:history] << digest
+        self.__gibbler_history[:stamp][digest] = now
+        self.__gibbler_history[:objects][digest] = point
       }
       
       digest
@@ -101,7 +104,7 @@ module Gibbler
     #
     # Returns the new digest (+g+). 
     def gibbler_revert!(g=nil)
-      raise NoRevert unless self.respond_to?(:__gibbler_revert!)
+      raise NoRevert unless self.respond_to? :__gibbler_revert!
       raise NoHistory, self.class unless gibbler_history?
       raise BadDigest, g if !g.nil? && !gibbler_valid?(g)
       
@@ -109,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 @@__gibbler_digest__.
+      # NOTE: We use __gibbler b/c it doesn't update self.__gibbler_cache.
       unless self.__gibbler == g
         @@mutex.synchronize {
-          # Always make sure @__gibbler_digest__ is a Gibbler::Digest 
-          @__gibbler_digest__ = g.is_a?(Gibbler::Digest) ? g : Gibbler::Digest.new(g)
+          # 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_revert!
         }
       end
       
-      @__gibbler_digest__
+      self.__gibbler_cache
     end
     
     # Is the given digest +g+ contained in the history for this object?
@@ -147,7 +150,7 @@ class Hash
   include Gibbler::History
   def __gibbler_revert!
     self.clear
-    self.merge! self.gibbler_object @__gibbler_digest__
+    self.merge! self.gibbler_object(self.__gibbler_cache)
   end
 end
 
@@ -155,7 +158,7 @@ class Array
   include Gibbler::History
   def __gibbler_revert!
     self.clear
-    self.push *(self.gibbler_object @__gibbler_digest__)
+    self.push *(self.gibbler_object self.__gibbler_cache)
   end
 end
   
@@ -163,7 +166,7 @@ class String
   include Gibbler::History
   def __gibbler_revert!
     self.clear
-    self << (self.gibbler_object @__gibbler_digest__)
+    self << (self.gibbler_object self.__gibbler_cache)
   end
 end
       

data/lib/gibbler/object.rb

@@ -0,0 +1,39 @@
+
+
+module Gibbler
+  
+  module Object
+    extend Attic
+    
+    attic :__gibbler_cache
+    
+    # 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
+      gibbler_debug :GIBBLER, self.class, self
+      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
+    
+  end
+  
+end

data/lib/gibbler.rb

@@ -1,12 +1,19 @@
 
+local_libs = %w{attic}
+local_libs.each { |dir| $:.unshift File.join(File.dirname(__FILE__), '..', '..', dir, 'lib') }
+
 require 'digest/sha1'
+require 'attic'
 
 # = Gibbler
 # 
 # "Hola, Tanneritos"
 #
 module Gibbler
-  VERSION = "0.5.2"
+  #include Attic
+  extend Attic
+  
+  VERSION = "0.5.3"
   
   require 'gibbler/object'
   require 'gibbler/digest'
@@ -75,7 +82,7 @@ module Gibbler
     end
     
     def __gibbler_revert!
-      state = self.gibbler_object @__gibbler_digest__
+      state = self.gibbler_object self.__gibbler_cache
       state.instance_variables do |n|
         v = state.instance_variable_get n
         self.instance_variable_set v
@@ -86,6 +93,7 @@ module Gibbler
   
   module String
     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. 

data/tryouts/10_basic_tryouts.rb

@@ -52,7 +52,7 @@ tryouts "Basic syntax with SHA1" do
   
   dream :gibbler, "884e5713aa70468333459f80aea1bb05394ca4ba"
   drill "Populated Array instance" do
-    [1, 22222222222, :runtime, [2, "three", [Object, true]]]
+    [1, 2, :runtime, [3, "four", [Object, true]]]
   end 
   
   drill "Knows when a Hash has not changed", false do
@@ -84,9 +84,22 @@ tryouts "Basic syntax with SHA1" do
     a = {}
     a.gibbler  # We need to gibbler first so it sets a value to the instance var
     val = Tryouts.sysinfo.ruby[1] == 9 ? :'@__gibbler_digest__' : '@__gibbler_digest__'
+    stash :ivars, a.instance_variables
+    stash :smeths, Gibbler.singleton_methods
     a.instance_variables.member? val
   end
   
+  drill "previous digest", 'c8027100ecc54945ab15ddac529230e38b1ba6a1' do
+    a = "kimmy"
+    a.gibbler
+    #stash :methods, a.methods.sort
+    #
+    #stash :string_methods, String.methods.sort
+    #stash :gstring_methods, Gibbler::String.methods.sort
+    #stash :class_methods, a.class.methods.sort
+    stash :ivars, a.instance_variables
+    a.__gibbler_cache
+  end
   
 end
 

data/tryouts/51_hash_history_tryouts.rb

@@ -16,10 +16,10 @@ tryouts "Hash History" do
     end
   end
   
-  drill "doesn't reveal @__gibbler_history__ instance variable", false do
+  drill "doesn't reveal self.__gibbler_history instance variable", false do
     a = {}
     a.gibbler  # We need to gibbler first so it sets a value to the instance var
-    val = Tryouts.sysinfo.ruby[1] == 9 ? :'@__gibbler_history__' : '@__gibbler_history__'
+    val = Tryouts.sysinfo.ruby[1] == 9 ? :'self.__gibbler_history' : 'self.__gibbler_history'
     a.instance_variables.member? val
   end
   

data/tryouts/80_performance_tryouts.rb

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

data/tryouts/90_alias_tryouts.rb

@@ -0,0 +1,60 @@
+
+group "Aliases"
+
+library :gibbler, 'lib'
+library 'gibbler/aliases', 'lib'
+library 'gibbler/history', 'lib'
+
+tryouts "Gibbler::Object Aliases" do
+  
+  drill "has digest", true do
+    :kimmy.gibbler == :kimmy.digest
+  end
+  
+  drill "has changed?", true do
+    a = "kimmy"
+    a.digest
+    a << '+ dj'
+    a.gibbled?
+  end
+  
+end
+
+
+tryouts "Gibbler::History Aliases" do
+  
+  dream "d7049916ddb25e6cc438b1028fb957e5139f9910"
+  drill "can convert short digest into long" do
+    a = { :magic => :original }
+    g = a.commit.short
+      stash :short, g
+    a.find_long g
+  end
+  
+  dream :class, Time
+  drill "can return most recent stamp" do
+    a = { :magic => :original }
+    a.commit
+      stash :hist, a.history
+    a.stamp
+  end
+  
+  dream ["d7049916ddb25e6cc438b1028fb957e5139f9910", "0b11c377fccd44554a601e5d2b135c46dc1c4cb1"]
+  drill "can return history" do
+    a = { :magic => :original }
+    a.commit
+    a[:magic] = :changed
+    a.commit
+    a.history
+  end
+  
+  dream ["d7049916", "0b11c377"]
+  drill "can return history (short)" do
+    a = { :magic => :original }
+    a.commit
+    a[:magic] = :changed
+    a.commit
+    a.history(:short)
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gibbler
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-07 00:00:00 -04:00
+date: 2009-07-12 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: attic
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: "Gibbler: Git-like hashes for Ruby objects"
 email: delano@solutious.com
 executables: []
@@ -29,10 +38,12 @@ files:
 - Rakefile
 - 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/05_gibbler_digest_tryouts.rb
 - tryouts/10_basic_tryouts.rb
@@ -44,6 +55,7 @@ files:
 - 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