gibbler 0.9.0 → 0.10.0

data/try/02_compat_try.rb

@@ -1,14 +1,5 @@
-require 'gibbler/mixins'
+require_relative '../lib/gibbler/mixins'
 
 ## Gibbler Objects have gibbler_cache method
   "kimmy".respond_to? :gibbler_cache
 #=> true
-
-## Gibbler Objects have __gibbler_cache method
-  "kimmy".respond_to? :__gibbler_cache
-#=> true
-
-## __gibbler_cache returns the same value as gibbler_cache
-  @a = "kimmy" and @a.gibbler
-  @a.gibbler_cache
-#=> @a.__gibbler_cache

data/try/11_basic_try.rb

@@ -13,7 +13,7 @@ require 'gibbler/mixins'
 
 # Symbol digests are consistent
   :kimmy.gibbler
-#=> '52be7494a602d85ff5d8a8ab4ffe7f1b171587df' 
+#=> '52be7494a602d85ff5d8a8ab4ffe7f1b171587df'
 
 # String digests are consistent
   'kimmy'.gibbler
@@ -27,29 +27,29 @@ require 'gibbler/mixins'
   Class.gibbler
 #=> '25ac269ae3ef18cdb4143ad02ca315afb5026de9'
 
-# Fixnum instance digests are consistent
+# Integer instance digests are consistent
   1.gibbler
 #=> 'a9cad665549bd22a4346fcf602d9d3c3b0482bbe'
 
-# Bignum instance
-  100000000000.gibbler
+# Large Integer instance
+  100_000_000_000.gibbler
 #=> '608256db120251843843bba57e9b2c7adb7342aa'
 
 # Empty Hash instance digests are consistent
   Hash.new.gibbler
 #=> '4fdcadc66a38feb9c57faf3c5a18d5e76a6d29bf'
-  
+
 # Populated Hash instance
   { :a => [1,2,3, [4,5,6]], :b => { :c => Class } }.gibbler
-#=> "1d4b62e1e9f2c097b0cefb6877bf47c2015cdd21"
-  
+#=> "8faca3e967c94fe996fac1b5a5f595ef77e10df4"
+
 # Empty Array instance
-  Array.new.gibbler
-#=> '48fda57c05684c9e5c3259557851943572183a21' 
+  Array.gibbler
+#=> '83c4994bb01eefc06aa267aa99aa12b55696616e'
 
 # Populated Array instance
   [1, 2, :runtime, [3, "four", [Object, true]]].gibbler
-#=> "3e1d79d113a409a96a13ca3879fc4c42027aa74b"
+#=> "067c28147176992b95b9301817846abc85cbd7e4"
 
 # Knows when a Hash has not changed
   a = { :magic => true }
@@ -65,25 +65,32 @@ require 'gibbler/mixins'
   a.gibbled?
 #=> true
 
-# Two Symbol digests don't cross streams
-  a, b = :something, :anything
-  a.gibbler
-  b.gibbler
-  [a.gibbler_cache.short, b.gibbler_cache.short]
-#=> ["667ce086", "92d5f7cd"]
-
 # Two String digests don't cross streams"
-  a, b = 'something', 'anything'
-  a.gibbler
-  b.gibbler
-  [a.gibbler_cache.short, b.gibbler_cache.short]
+a, b = 'something', 'anything'
+a.gibbler
+b.gibbler
+[a.gibbler_cache.short, b.gibbler_cache.short]
 #=> ["ce0c7694", "c13b2f02"]
 
+# Strings aren't inherently "frozen" so their gibbler cache
+# values are primed after running gibbler the first time.
+  a = 'something'
+  a.gibbler
+  [a.frozen?, a.gibbler_cache]
+#=> [false, "ce0c7694"]
+
+# Symbols are inherently "frozen" so their gibbler cache
+# values are never populated.
+a = :something
+a.gibbler
+[a.frozen?, a.gibbler_cache]
+#=> [true, nil]
+
 ## DISABLED: If gibbler/history is required, there will be an
 ## additional attic_var (:gibbler_history), but only if the
 ## gibbler_history method has been called already (the history
 ## remains nil by default). The fix is not straightfroward and
-## tests are not important anyway so disabling them is fine. 
+## tests are not important anyway so disabling them is fine.
 ## Symbol has list of attic vars", [:gibbler_cache]
 #  Symbol.attic_vars
 #end
@@ -98,8 +105,8 @@ require 'gibbler/mixins'
 
 # Freezing an object will update the digest
   a = { :a => 1 }
-  pre  = a.gibbler; 
-  a[:a] = 2 
+  pre  = a.gibbler;
+  a[:a] = 2
   post = a.freeze.gibbler
   pre != post && post == a.gibbler_cache
 #=> true
@@ -127,4 +134,3 @@ require 'gibbler/mixins'
   a.gibbler
   a.gibbler_cache
 #=> 'c8027100ecc54945ab15ddac529230e38b1ba6a1'
-

data/try/15_file_try.rb

@@ -2,15 +2,15 @@ require 'tempfile'
 require 'gibbler/mixins'
 
 @tempfile = "tryouts-9000-awesome.txt"
-  
+
 ## File can gibbler
-  file = File.new(File.join('.', 'CHANGES.txt'))
+  file = File.new(File.join('.', 'LICENSE.txt'))
   file.gibbler
-#=>  'c052e87bd0acb7e08c98dad7f8b09b4382a08ef6' 
- 
+#=>  'c052e87bd0acb7e08c98dad7f8b09b4382a08ef6'
+
 ## Gibbler is different for each path
-  file1 = File.new(File.join('.', 'CHANGES.txt'))
-  file2 = File.new(File.join('.', 'README.rdoc'))
+  file1 = File.new(File.join('.', 'LICENSE.txt'))
+  file2 = File.new(File.join('.', 'README.md'))
   file1.gibbler == file2.gibbler
 #=> false
 
@@ -30,7 +30,7 @@ require 'gibbler/mixins'
 #=>  '6d93f752fc23f36bffa5ddf9ee97d04be82efbdb'
 
 ## JRuby doesn't like to use File.new with directories
-###=>  '92cbcb7de73d7748b28d9e911f461013de34410f' 
+###=>  '92cbcb7de73d7748b28d9e911f461013de34410f'
 ### "File gibbler cares about trailing slash (/tmp/)", File.new(__FILE__)
 
-File.unlink @tempfile if File.exists? @tempfile
+File.unlink @tempfile if File.exist? @tempfile

metadata

@@ -1,34 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: gibbler
 version: !ruby/object:Gem::Version
-  version: 0.9.0
-  prerelease: 
+  version: 0.10.0
 platform: ruby
 authors:
 - Delano Mandelbaum
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2013-01-08 00:00:00.000000000 Z
-dependencies: []
-description: Git-like hashes for Ruby objects
-email: delano@solutious.com
+date: 2024-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: tryouts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: 'About Gibbler: Git-like hashes for Ruby objects'
+email: gems@solutious.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.rdoc
+extra_rdoc_files: []
 files:
-- CHANGES.txt
+- ".github/workflows/main.yml"
+- ".github/workflows/ruby-rake.yaml"
+- ".gitignore"
+- ".pre-commit-config.yaml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
-- README.rdoc
-- Rakefile
+- README.md
 - VERSION.yml
+- bin/console
+- bin/setup
 - gibbler.gemspec
+- img/whoababy.gif
 - lib/gibbler.rb
 - lib/gibbler/aliases.rb
 - lib/gibbler/history.rb
 - lib/gibbler/mixins.rb
+- lib/gibbler/version.rb
 - try/01_core_ext_try.rb
 - try/02_compat_try.rb
 - try/05_gibbler_digest_try.rb
@@ -50,28 +100,27 @@ files:
 - try/59_history_exceptions_try.rb
 - try/80_performance_try.rb
 - try/90_alias_try.rb
-homepage: http://github.com/delano/gibbler
-licenses: []
-post_install_message: 
+homepage: https://github.com/delano/gibbler
+licenses:
+- MIT
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.8
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: gibbler
-rubygems_version: 1.8.10
-signing_key: 
-specification_version: 3
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
 summary: Git-like hashes for Ruby objects
 test_files: []

data/README.rdoc

@@ -1,236 +0,0 @@
-= Gibbler - v0.9
-
-Git-like hashes and history for Ruby objects for Ruby 1.8, 1.9 and JRuby. 
-
-Check out the screencast[http://www.rubypulse.com/episode-0.3-gibbler.html] created by Alex Peuchert.
-
-== Some things to keep in mind
-
-* Digest calculation may change between minor releases (as it did between 0.6 and 0.7)
-* Gibbler history is not suitable for very large objects since it keeps complete copies of the object in memory. This is a very early implementation of this feature so don't rely on it for production code. 
-* Don't forget to enjoy your life!
-
-
-== Example 1 -- Standalone Usage
-    
-    require 'gibbler'
-    
-    g = Gibbler.new 'id', 1001   # => f4fb3796ababa3788d1bded8fdc589ab1ccb1c3d
-    g.base(36)                   # => sm71s7eam4hm5jlsuzlqkbuktwpe5h9
-    
-    g == 'f4fb3796ababa3788d1bded8fdc589ab1ccb1c3d'   # => true
-    g === 'f4fb379'              # => true
-    
-== Example 2 -- Mixins Usage
-    
-    require 'gibbler/mixins'
-    
-    "kimmy".gibbler              # => c8027100ecc54945ab15ddac529230e38b1ba6a1
-    :kimmy.gibbler               # => 52be7494a602d85ff5d8a8ab4ffe7f1b171587df
-    
-    config = {}
-    config.gibbler               # => 4fdcadc66a38feb9c57faf3c5a18d5e76a6d29bf
-    config.gibbled?              # => false
-    
-    config[:server] = {          
-      :users => [:dave, :ali],   
-      :ports => [22, 80, 443]    
-    }                            
-    config.gibbled?              # => true
-    config.gibbler               # => ef23d605f8c4fc80a8e580f9a0e8dab8426454a8 
-    
-    config[:server][:users] << :yanni
-    
-    config.gibbler               # => 4c558a56bc2abf5f8a845a69e47ceb5e0003683f
-    
-    config.gibbler.short         # => 4c558a56
-
-    config.gibbler.base36        # => 8x00l83jov4j80i9vfzpaxr9jag23wf
-    
-    config.gibbler.base36.short  # => 8x00l83j
-    
-    
-== Example 3 -- Object History 
-    
-Gibbler can also keep track of the history of changes to an object. By default Gibbler supports history for Hash, Array, and String objects. The <tt>gibbler_commit</tt> method creates a clone of the current object and stores in an instance variable using the current hash digest as the key. 
-
-    require 'gibbler/mixins'
-    require 'gibbler/history'
-    
-    a = { :magic => :original }     
-    a.gibbler_commit             # => d7049916ddb25e6cc438b1028fb957e5139f9910
-    
-    a[:magic] = :updated           
-    a.gibbler_commit             # => b668098e16d08898532bf3aa33ce2253a3a4150e
-    
-    a[:magic] = :changed 
-    a.gibbler_commit             # => 0b11c377fccd44554a601e5d2b135c46dc1c4cb1
-    
-    a.gibbler_history            # => d7049916, b668098e, 0b11c377
-    
-    a.gibbler_revert! 'd7049916' # Return to a specific commit
-    a.gibbler                    # => d7049916ddb25e6cc438b1028fb957e5139f9910
-    a                            # => { :magic => :original } 
-    
-    a.delete :magic
-    
-    a.gibbler_revert!            # Return to the previous commit  
-    a.gibbler                    # => 0b11c377fccd44554a601e5d2b135c46dc1c4cb1
-    a                            # => { :magic => :changed }
-        
-    
-    a.gibbler_object 'b668098e'  # => { :magic => :updated }
-    a.gibbler_stamp              # => 2009-07-01 18:56:52 -0400
-    
-http://delano.github.com/gibbler/img/whoababy.gif
-
-
-== Example 4 -- 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/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_" prefix.
-    
-    require 'gibbler/aliases'
-    require 'gibbler/history'
-    
-    a = { :magic => :original }     
-    a.commit                     
-    a.history                    
-    a.revert!                    
-    # etc...
-    
-== Example 5 -- Different Digest types
-
-By default Gibbler creates SHA1 hashes. You can change this globally or per instance. 
-
-    require 'gibbler/mixins'
-    
-    Gibbler.digest_type = Digest::MD5
-    
-    :kimmy.gibbler               # => 0c61ff17f46223f355759934154d5dcb
-    
-    :kimmy.gibbler(Digest::SHA1) # => 52be7494a602d85ff5d8a8ab4ffe7f1b171587df
-    
-
-In Jruby, you can grab the digest types from the openssl library. 
-
-    require 'openssl'
-    
-    Gibbler.digest_type = OpenSSL::Digest::SHA256
-    
-    :kimmy.gibbler               # => 1069428e6273cf329436c3dce9b680d4d4e229d7b7...
-    
-    
-== Example 6 -- All your base
-
-    require 'gibbler/mixins'
-    
-    :kimmy.gibbler               # => 52be7494a602d85ff5d8a8ab4ffe7f1b171587df
-    :kimmy.gibbler.base(16)      # => 52be7494a602d85ff5d8a8ab4ffe7f1b171587df
-    :kimmy.gibbler.base(36)      # => 9nydr6mpv6w4k8ngo3jtx0jz1n97h7j
-
-    :kimmy.gibbler.base(10)      # => 472384540402900668368761869477227308873774630879
-    :kimmy.gibbler.to_i          # => 472384540402900668368761869477227308873774630879
-
-
-== Example 7 -- Global secret
-
-Gibbler can prepend all digest inputs with a global secret. You can set this once per project to ensure your project's digests are unique. 
-
-    require 'gibbler/mixins'
-    
-    :kimmy.gibbler               # => 52be7494a602d85ff5d8a8ab4ffe7f1b171587df
-    
-    Gibbler.secret = "sUp0r5ekRu7"
-    
-    :kimmy.gibbler               # => 6c5f5aff4d809cec7e7da091214a35a2698489f8
-    
-
-== Supported Classes
-
-Gibbler methods are available only to the classes which explicitly include them (see RDocs[http://delano.github.com/gibbler] for details on which classes are supported by default). You can also extend custom objects:
-
-    class FullHouse
-      include Gibbler::Complex
-      attr_accessor :roles
-    end
-    
-    a = FullHouse.new
-    a.gibbler                    # => 4192d4cb59975813f117a51dcd4454ac16df6703
-    
-    a.roles = [:jesse, :joey, :danny, :kimmy, :michelle, :dj, :stephanie]
-    a.gibbler                    # => 6ea546919dc4caa2bab69799b71d48810a1b48fa
-    
-Gibbler::Complex creates a digest based on the name of the class and the names and values of the instance variables. See the RDocs[http://delano.github.com/gibbler] for other Gibbler::* types. 
-
-If you want to support all Ruby objects, add the following to your application:
-
-    class Object
-      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. "Object:0x0x4ac9f0...") will produce unreliable digests (because the address can change).
-
-As of 0.7 all Proc objects have the same digest: <tt>12075835e94be34438376cd7a54c8db7e746f15d</tt>. 
-
-
-
-== Known Issues
-
-* 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)
-* Digests for Bignum objects are different between Ruby and JRuby. Why?
-* Digests for Proc objects are different between Ruby 1.8 and 1.9 because Proc.arity returns different values and 1.8 has no lambda? method.
-
-
-== Installation
-
-Via Rubygems:
-
-    $ gem install 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]
-
-
-== What People Are Saying
-
-* "nice approach - everything is an object, every object is 'gittish'" -- @olgen_morten[http://twitter.com/olgen_morten/statuses/2629909133]
-* "gibbler is just awesome" -- @TomK32[http://twitter.com/TomK32/statuses/2618542872]
-* "wie cool ist Gibbler eigentlich?" -- @we5[http://twitter.com/we5/statuses/2615274279]
-* "it's nice idea and implementation!" -- HristoHristov[http://www.rubyinside.com/gibbler-git-like-hashes-and-history-for-ruby-objects-1980.html#comment-39092]
-
-== More Info
-
-* Codes[http://github.com/delano/gibbler]
-* RDocs[http://delano.github.com/gibbler]
-* Sponsor[http://solutious.com/]
-* Inspiration[http://www.youtube.com/watch?v=fipD4DdV48g]
-
-
-== Thanks
-
-* Kalin Harvey (krrh[http://github.com/krrh]) for the early feedback and artistic direction. 
-* Alex Peuchert (aaalex[http://github.com/aaalex]) for creating the screencast.
-
-
-== Credits
-
-* [Delano Mandelbaum](http://delanotes.com/) (@solutious.com)
-
-
-== License
-
-See: LICENSE.txt

data/Rakefile

@@ -1,39 +0,0 @@
-require "rubygems"
-require "rake"
-require "rake/clean"
-require 'yaml'
-
-require 'rdoc/task'
-
-config = YAML.load_file("VERSION.yml")
-task :default => ["build"]
-CLEAN.include [ 'pkg', 'rdoc' ]
-name = "gibbler"
-
-begin
-  require "jeweler"
-  Jeweler::Tasks.new do |gem|
-    gem.version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}"
-    gem.name = name
-    gem.rubyforge_project = gem.name
-    gem.summary = "Git-like hashes for Ruby objects"
-    gem.description = "Git-like hashes for Ruby objects"
-    gem.email = "delano@solutious.com"
-    gem.homepage = "http://github.com/delano/gibbler"
-    gem.authors = ["Delano Mandelbaum"]
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-RDoc::Task.new do |rdoc|
-  version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}"
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title = "#{name} #{version}"
-  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include("LICENSE.txt")
-  rdoc.rdoc_files.include("bin/*.rb")
-  rdoc.rdoc_files.include("lib/**/*.rb")
-end
-