gibbler 0.9.0 → 0.10.0

data/lib/gibbler.rb

@@ -1,38 +1,26 @@
-unless defined?(GIBBLER_LIB_HOME)
-  GIBBLER_LIB_HOME = File.expand_path File.dirname(__FILE__) 
-end
+# frozen_string_literal: true
 
-%w{attic}.each do |dir|
-  $:.unshift File.join(GIBBLER_LIB_HOME, '..', '..', dir, 'lib')
+unless defined?(GIBBLER_LIB_HOME)
+  GIBBLER_LIB_HOME = File.expand_path File.dirname(__FILE__)
 end
 
-require 'thread'
 require 'attic'
 require 'digest/sha1'
 
+
 # = Gibbler
-# 
+#
 # "Hola, Tanneritos"
 #
 class Gibbler < String
-  module VERSION
-    def self.to_s
-      load_config
-      [@version[:MAJOR], @version[:MINOR], @version[:PATCH]].join('.')
-    end
-    alias_method :inspect, :to_s
-    def self.load_config
-      require 'yaml'
-      @version ||= YAML.load_file(::File.join(GIBBLER_LIB_HOME, '..', 'VERSION.yml'))
-    end
-  end
-  
+
+
   @default_base = 16
   @secret = nil
   class << self
     attr_accessor :secret, :default_base
   end
-  
+
   class Error < RuntimeError
     def initialize(obj); @obj = obj; end
   end
@@ -44,37 +32,37 @@ end
 # few digest related convenience methods.
 #
 class Gibbler::Digest < String
-  
+
   module InstanceMethods
-    # Return an integer assuming base is Gibbler.default_base. 
+    # Return an integer assuming base is Gibbler.default_base.
     def to_i(base=nil)
       base ||= Gibbler.default_base
       super(base)
     end
-  
-    # Returns a string. Takes an optional base. 
+
+    # Returns a string. Takes an optional base.
     def to_s(base=nil)
       base.nil? ? super() : super().to_i(Gibbler.default_base).to_s(base)
     end
-  
+
     def base(base=Gibbler.default_base)
       v = self.to_i(Gibbler.default_base).to_s(base)
       v.extend Gibbler::Digest::InstanceMethods
       self.class.new v
     end
-  
+
     def base36
       base(36)
     end
-  
-    # Shorten the digest to the given (optional) length. 
+
+    # Shorten the digest to the given (optional) length.
     def shorten(len=20)
       self[0..len-1]
     end
-  
+
     # Returns the first 8 characters of itself (the digest).
     #
-    # e.g. 
+    # e.g.
     #
     #     "kimmy".gibbler         # => c8027100ecc54945ab15ddac529230e38b1ba6a1
     #     "kimmy".gibbler.short   # => c8027100
@@ -82,10 +70,10 @@ class Gibbler::Digest < String
     def short
       shorten(8)
     end
-  
+
     # Returns the first 6 characters of itself (the digest).
     #
-    # e.g. 
+    # e.g.
     #
     #     "kimmy".gibbler         # => c8027100ecc54945ab15ddac529230e38b1ba6a1
     #     "kimmy".gibbler.shorter # => c80271
@@ -93,10 +81,10 @@ class Gibbler::Digest < String
     def shorter
       shorten(6)
     end
-  
+
     # Returns the first 4 characters of itself (the digest).
     #
-    # e.g. 
+    # e.g.
     #
     #     "kimmy".gibbler         # => c8027100ecc54945ab15ddac529230e38b1ba6a1
     #     "kimmy".gibbler.tiny    # => c802
@@ -104,7 +92,7 @@ class Gibbler::Digest < String
     def tiny
       shorten(4)
     end
-  
+
     # Returns true when +ali+ matches +self+
     #
     #    "kimmy".gibbler == "c8027100ecc54945ab15ddac529230e38b1ba6a1"  # => true
@@ -114,7 +102,7 @@ class Gibbler::Digest < String
       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
@@ -132,45 +120,44 @@ end
 
 class Gibbler < String
   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
-    
+
     def self.gibbler_fields
     end
     def gibbler_fields
     end
-    
-    # Calculates a digest for the current object instance. 
+
+    # 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 
+    # 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>.
+    # `gibbler_cache`.
     #
     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(digest_type)
+      ret = Gibbler::Digest.new self.__gibbler(digest_type)
+      self.gibbler_cache = ret unless self.frozen?
+      ret
     end
 
     # Has this object been modified?
     #
-    # This method compares the return value from digest with the 
+    # 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 `gibbler_cache`).
     # See Attic[http://github.com/delano/attic]
     def gibbled?
       self.gibbler_cache ||= self.gibbler
@@ -183,15 +170,15 @@ class Gibbler < String
       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 
+    # 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(digest_type=nil)
@@ -202,10 +189,10 @@ class Gibbler < String
       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
+    # `obj.gibbler` will return the cached value with
     # out calculation.
     def freeze()
       gibbler_debug :FREEZE, self.class, caller[0] if Gibbler.debug?
@@ -213,9 +200,9 @@ class Gibbler < String
       super
       self
     end
-    
+
   end
-  
+
 end
 
 class Gibbler < String
@@ -226,7 +213,7 @@ class Gibbler < String
   # Creates a digest from the given +input+. See Gibbler.digest.
   #
   # If only one argument is given and it's a digest, this will
-  # simply create an instance of that digest. In other words, 
+  # simply create an instance of that digest. In other words,
   # it won't calculate a new digest based on that input.
   def initialize *input
     if input.size == 1 && Gibbler::Digest::InstanceMethods === input.first
@@ -235,15 +222,15 @@ class Gibbler < String
       input.collect!(&:to_s)
       super Gibbler.digest(input) || ''
     end
-  end  
+  end
   def digest_type
     @digest_type || self.class.digest_type
   end
-  
+
   def digest *input
     replace Gibbler.digest(input, digest_type)
   end
-  
+
 end
 
 class Gibbler < String
@@ -251,11 +238,11 @@ class Gibbler < String
   @debug = false
   @digest_type = ::Digest::SHA1
   @delimiter = ':'
-  
+
   class << self
-    # Specify a different digest class. The default is +Digest::SHA1+. You 
-    # could try +Digest::SHA256+ by doing this: 
-    # 
+    # Specify a different digest class. The default is +Digest::SHA1+. You
+    # could try +Digest::SHA256+ by doing this:
+    #
     #     Object.digest_type = Digest::SHA256
     #
     attr_accessor :digest_type
@@ -267,11 +254,11 @@ class Gibbler < String
     # Returns the current debug status (true or false)
     def debug?;  @debug != false; end
   end
-  
+
   # Sends +input+ to Digest::SHA1.hexdigest. If another digest class
-  # has been specified, that class will be used instead. 
+  # has been specified, that class will be used instead.
   # If Gibbler.secret is set, +str+ will be prepended with the
-  # value. 
+  # value.
   #
   # If +input+ is an Array, it will be flattened and joined.
   #
@@ -285,12 +272,12 @@ class Gibbler < String
     dig = dig.to_i(16).to_s(Gibbler.default_base) if 16 != Gibbler.default_base
     dig
   end
-  
+
   def self.gibbler_debug(*args)
     return unless Gibbler.debug?
     p args
   end
-  
+
   # Raises an exception. The correct usage is to include a Gibbler::Object:
   # * Gibbler::Complex
   # * Gibbler::String
@@ -299,20 +286,20 @@ class Gibbler < String
   def self.included(obj)
     raise "You probably want to include Gibbler::Complex or Gibbler::Object"
   end
-  
-  
-  # Creates a digest based on: 
-  # * An Array of instance variable names or method 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 
+
+
+  # Creates a digest based on:
+  # * An Array of instance variable names or method names and values in the format: `CLASS:LENGTH:VALUE`
+  #   * The gibbler method is called on each element so if it is a Hash or Array etc it
   #     will be parsed recursively according to the gibbler method for that class type.
-  # * Digest the Array of digests  
-  # * Return the digest for <tt>class:length:value</tt> where:
+  # * Digest the Array of digests
+  # * Return the digest for `class:length:value` where:
   #   * "class" is equal to the current object class (e.g. FullHouse).
   #   * "length" is the size of the Array of digests (which should equal
   #     the number of instance variables in the object).
   #   * "value" is the Array of digests joined with a colon (":").
   #
-  # This method can be used by any class which stores values in instance variables. 
+  # This method can be used by any class which stores values in instance variables.
   #
   #     class Episodes
   #       include Gibbler::Complex
@@ -321,7 +308,7 @@ class Gibbler < String
   #
   module Complex
     include Gibbler::Object
-    
+
     def self.included(obj)
       obj.extend Attic
       obj.attic :gibbler_cache
@@ -343,7 +330,7 @@ class Gibbler < String
         end
       end
     end
-    
+
     def gibbler_fields
       f = [self.class.gibbler_fields].compact.flatten
       if f.empty?
@@ -353,8 +340,8 @@ class Gibbler < String
       end
       f
     end
-    
-    # Creates a digest for the current state of self. 
+
+    # Creates a digest for the current state of self.
     def __gibbler(digest_type=nil)
       klass = self.class
       d = []
@@ -372,7 +359,7 @@ class Gibbler < String
       gibbler_debug klass, a, [klass, d.size, d]
       a
     end
-    
+
     def __gibbler_revert!
       state = self.gibbler_object self.gibbler_cache
       state.instance_variables do |n|
@@ -381,31 +368,31 @@ class Gibbler < String
       end
     end
   end
-  
-  # 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. 
-  # It's used by default for Symbol, Class, Fixnum, and Bignum.
+
+  # Creates a digest based on: `CLASS:LENGTH:VALUE`.
+  # This method can be used for any class where the `to_s`
+  # method returns an appropriate unique value for this instance.
+  # It's used by default for Symbol, Class, Integer.
   # e.g.
-  # 
+  #
   #     "str" => String:3:str => 509a839ca1744c72e37759e7684ff0daa3b61427
   #     :sym  => Symbol:3:sym => f3b7b3ca9529002c6826b1ef609d3583c356c8c8
   #
   # To use use method in other classes simply:
   #
-  #     class MyStringLikeClass 
+  #     class MyStringLikeClass
   #       include Gibbler::String
   #     end
   #
   module String
     include Gibbler::Object
-    
+
     def self.included(obj)
       obj.extend Attic
       obj.attic :gibbler_cache
     end
-    
-    # Creates a digest for the current state of self. 
+
+    # Creates a digest for the current state of self.
     def __gibbler(digest_type=nil)
       klass = self.class
       value = self.nil? ? "\0" : self.to_s
@@ -414,81 +401,81 @@ class Gibbler < String
       a
     end
   end
-  
-  # Creates a digest based on: 
-  # * parse each key, value pair into an Array containing keys: <tt>CLASS:KEY:VALUE.__gibbler</tt>
-  #   * The gibbler method is called on each element so if it is a Hash or Array etc it 
+
+  # Creates a digest based on:
+  # * parse each key, value pair into an Array containing keys: `CLASS:KEY:VALUE.__gibbler`
+  #   * The gibbler method is called on each element so if it is a Hash or Array etc it
   #     will be parsed recursively according to the gibbler method for that class type.
-  # * Digest the Array of digests  
-  # * Return the digest for <tt>class:length:value</tt> where:
+  # * Digest the Array of digests
+  # * Return the digest for `class:length:value` where:
   #   * "class" is equal to the current object class (e.g. Hash).
   #   * "length" is the size of the Array of digests (which should equal
   #     the number of keys in the original Hash object).
   #   * "value" is the Array of digests joined with a colon (":").
   #
-  # This method can be used by any class with a <tt>keys</tt> method. 
+  # This method can be used by any class with a `keys` method.
   #
   #     class MyOrderedHash
   #       include Gibbler::Hash
   #     end
   #
-  module Hash 
+  module Hash
     include Gibbler::Object
-    
+
     def self.included(obj)
       obj.extend Attic
       obj.attic :gibbler_cache
     end
-    
-    # Creates a digest for the current state of self. 
+
+    # Creates a digest for the current state of self.
     def __gibbler(digest_type=nil)
       klass = self.class
       d = self.keys.sort { |a,b| a.inspect <=> b.inspect }
-      d.collect! do |name| 
+      d.collect! do |name|
         value = self[name]
         unless value.respond_to? :__gibbler
           gibbler_debug klass, :skipping, name
           next
         end
         '%s:%s:%s' % [value.class, name, value.__gibbler(digest_type)]
-      end 
+      end
       d = d.join(Gibbler.delimiter).__gibbler(digest_type)
       a = Gibbler.digest '%s:%s:%s' % [klass, d.size, d], digest_type
       gibbler_debug klass, a, [klass, d.size, d]
-      a  
+      a
     end
   end
-  
+
   # Creates a digest based on:
-  # * parse each element into an Array of digests like: <tt>CLASS:INDEX:VALUE.__gibbler</tt>
-  #   * The gibbler method is called on each element so if it is a Hash or Array etc it 
-  #     will be parsed recursively according to the gibbler method for that class type. 
-  # * Digest the Array of digests 
-  # * Return the digest for <tt>class:length:value</tt> where:
+  # * parse each element into an Array of digests like: `CLASS:INDEX:VALUE.__gibbler`
+  #   * The gibbler method is called on each element so if it is a Hash or Array etc it
+  #     will be parsed recursively according to the gibbler method for that class type.
+  # * Digest the Array of digests
+  # * Return the digest for `class:length:value` where:
   #   * "class" is equal to the current object class (e.g. Array).
   #   * "length" is the size of the Array of digests (which should equal
   #     the number of elements in the original Array object).
   #   * "value" is the Array of digests joined with a colon (":").
   #
-  # This method can be used by any class with an <tt>each</tt> method.
+  # This method can be used by any class with an `each` method.
   #
-  #     class MyNamedArray 
+  #     class MyNamedArray
   #       include Gibbler::Array
   #     end
   #
   module Array
     include Gibbler::Object
-    
+
     def self.included(obj)
       obj.extend Attic
       obj.attic :gibbler_cache
     end
-    
-    # Creates a digest for the current state of self. 
+
+    # Creates a digest for the current state of self.
     def __gibbler(digest_type=nil)
       klass = self.class
       d, index = [], 0
-      self.each_with_index do |value,idx| 
+      self.each_with_index do |value,idx|
         unless value.respond_to? :__gibbler
           gibbler_debug klass, :skipping, idx
           next
@@ -502,29 +489,29 @@ class Gibbler < String
       a
     end
   end
-  
-  # Creates a digest based on: <tt>CLASS:LENGTH:TIME</tt>. 
-  # Times are calculated based on the equivalent time in UTC. 
+
+  # Creates a digest based on: `CLASS:LENGTH:TIME`.
+  # Times are calculated based on the equivalent time in UTC.
   # e.g.
-  # 
+  #
   #     Time.parse('2009-08-25 16:43:53 UTC')     => 73b4635f
   #     Time.parse('2009-08-25 12:43:53 -04:00')  => 73b4635f
   #
   # To use use method in other classes simply:
   #
-  #     class ClassLikeTime 
+  #     class ClassLikeTime
   #       include Gibbler::Time
   #     end
   #
   module Time
     include Gibbler::Object
-    
+
     def self.included(obj)
       obj.extend Attic
       obj.attic :gibbler_cache
     end
-    
-    # Creates a digest for the current state of self. 
+
+    # Creates a digest for the current state of self.
     def __gibbler(digest_type=nil)
       klass = self.class
       value = self.nil? ? "\0" : self.utc.strftime('%Y-%m-%d %H:%M:%S UTC')
@@ -533,29 +520,29 @@ class Gibbler < String
       a
     end
   end
-  
-  # Creates a digest based on: <tt>CLASS:LENGTH:DATETIME</tt>. 
-  # Dates are calculated based on the equivalent datetime in UTC. 
+
+  # Creates a digest based on: `CLASS:LENGTH:DATETIME`.
+  # Dates are calculated based on the equivalent datetime in UTC.
   # e.g.
-  # 
+  #
   #     DateTime.parse('2009-08-25T17:00:40+00:00')  => ad64c769
   #     DateTime.parse('2009-08-25T13:00:40-04:00')  => ad64c769
   #
   # To use use method in other classes simply:
   #
-  #     class ClassLikeTime 
+  #     class ClassLikeTime
   #       include Gibbler::Time
   #     end
   #
   module DateTime
     include Gibbler::Object
-    
+
     def self.included(obj)
       obj.extend Attic
       obj.attic :gibbler_cache
     end
-    
-    # Creates a digest for the current state of self. 
+
+    # Creates a digest for the current state of self.
     def __gibbler(digest_type=nil)
       klass = self.class
       value = self.nil? ? "\0" : self.new_offset(0).to_s
@@ -563,36 +550,36 @@ class Gibbler < String
       gibbler_debug klass, a, [klass, value.size, value]
       a
     end
-    
+
   end
-  
-  # Creates a digest based on: <tt>CLASS:EXCLUDE?:FIRST:LAST</tt>
+
+  # Creates a digest based on: `CLASS:EXCLUDE?:FIRST:LAST`
   # where EXCLUDE? is a boolean value whether the Range excludes
   # the last value (i.e. 1...100) and FIRST and LAST are the values
   # returned by Range#first and Range#last.
   # e.g.
-  #     
+  #
   #     (1..100)   =>  Range:false:1:100  =>  54506352
   #     (1...100)  =>  Range:true:1:100   =>  f0cad8cc
   #
   # To use use method in other classes simply:
   #
-  #     class ClassLikeRange 
+  #     class ClassLikeRange
   #       include Gibbler::Range
   #     end
   #
   module Range
     include Gibbler::Object
-    
+
     def self.included(obj)
       obj.extend Attic
       obj.attic :gibbler_cache
     end
-    
-    # Creates a digest for the current state of self. 
+
+    # Creates a digest for the current state of self.
     def __gibbler(digest_type=nil)
       klass = self.class
-      if self.nil? 
+      if self.nil?
         first, last, exclude = "\0", "\0", "\0"
       else
         first, last, exclude = self.first, self.last, self.exclude_end?
@@ -601,10 +588,10 @@ class Gibbler < String
       gibbler_debug klass, a, [klass, exclude, first, last]
       a
     end
-    
+
   end
-  
-  # Creates a digest based on: <tt>CLASS:\0</tt>
+
+  # Creates a digest based on: `CLASS:\0`
   #
   # e.g.
   #
@@ -618,7 +605,7 @@ class Gibbler < String
       obj.attic :gibbler_cache
     end
 
-    # Creates a digest for the current state of self. 
+    # Creates a digest for the current state of self.
     def __gibbler(digest_type=nil)
       klass = self.class
       a = Gibbler.digest "%s:%s" % [klass, "\0"], digest_type
@@ -626,34 +613,34 @@ class Gibbler < String
       a
     end
   end
-  
-  # Creates a digest based on: <tt>CLASS:PATHLENGTH:PATH</tt>
+
+  # Creates a digest based on: `CLASS:PATHLENGTH:PATH`
   # where PATHLENGTH is the length of the PATH string. PATH is
   # not modified in any way (it is not converted to an absolute
-  # path). 
-  # 
+  # path).
+  #
   # NOTE: You may expect this method to include other information
   # like the file contents and modified date (etc...). The reason
   # we do not is because Gibbler is concerned only about Ruby and
   # not the outside world. There are many complexities in parsing
   # file data and attributes which would make it difficult to run
-  # across platforms and Ruby versions / engines. If you want to 
+  # across platforms and Ruby versions / engines. If you want to
   #
   # e.g.
-  #    
+  #
   #    File.new('.')        # => c8bc8b3a
   #    File.new('/tmp')     # => 3af85a19
   #    File.new('/tmp/')    # => 92cbcb7d
-  #   
+  #
   module File
     include Gibbler::Object
-    
+
     def self.included(obj)
       obj.extend Attic
       obj.attic :gibbler_cache
     end
-    
-    # Creates a digest for the current state of self. 
+
+    # Creates a digest for the current state of self.
     def __gibbler(digest_type=nil)
       klass = self.class
       value = self.nil? ? "\0" : self.path
@@ -662,29 +649,7 @@ class Gibbler < String
       a
     end
   end
-  
-  ##--
-  ## NOTE: this was used when Gibbler supported "include Gibbler". We
-  ## now recommend the "include Gibbler::String" approach. This was an 
-  ## interesting approach so I'm keeping the code here for reference. 
-  ##def self.included(klass)
-  ##  # Find the appropriate Gibbler::* module for the inheriting class
-  ##  gibbler_module = Gibbler.const_get("#{klass}") rescue Gibbler::String
-  ##  
-  ##  # If a Gibbler module is not defined, const_get bubbles up
-  ##  # through the stack to find the constant. This will return 
-  ##  # the global class (likely itself) so we enforce a default.
-  ##  gibbler_module = Gibbler::String if gibbler_module == klass
-  ##  gibbler_debug :constant, klass, gibbler_module
-  ##  
-  ##  klass.module_eval do
-  ##    include gibbler_module
-  ##  end
-  ##  
-  ##end
-  ##++
-
-    
+
 end
 
 class String
@@ -694,8 +659,3 @@ class String
     end
   end
 end
-
-
-
-
-