dirty_hashy 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+= DirtyHashy CHANGELOG
+
+== Version 0.1.0 (December 22, 2011)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :gem_default do
+  gem "dirty_hashy", :path => "."
+end
+
+group :gem_development do
+  gem "pry"
+end
+
+group :gem_test do
+  gem "minitest"
+  gem "mocha"
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Paul Engel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,88 @@
+h1. DirtyHashy
+
+Dirty tracking within hashes with indifferent access
+
+h2. Introduction
+
+"Dirty tracking / objects":http://ryandaigle.com/articles/2008/3/31/what-s-new-in-edge-rails-dirty-objects is a common programming concept. In short, it is the mechanism to track whether or not the attributes of an object have been changed and if so, which ones.
+
+It is mostly implemented within ORM's, a couple of examples in the Ruby world are "ActiveRecord":http://ar.rubyonrails.org/classes/ActiveRecord/Dirty.html, "DataMapper":http://rubydoc.info/gems/dm-core/1.1.0/file/README.rdoc, "Mongoid":http://mongoid.org/docs/documents/dirty.html and "CouchRest Model":http://www.couchrest.info/model/dirty_tracking.html.
+
+Ironically, I haven't found a gem suited for the simple desire of dirty tracking within Ruby hashes. Eventually, you can compare attributes of an ORM object with a Hash containing values.
+
+h2. Installation
+
+h3. Using Bundler
+
+Add DirtyHashy in @Gemfile@ as a gem dependency:
+
+<pre>
+  gem "dirty_hashy"
+</pre>
+
+Run the following in your console to install with Bundler:
+
+<pre>
+  bundle install
+</pre>
+
+h2. Usage
+
+Using @DirtyHashy@ is pretty straightforward and can be used as follows:
+
+<pre>
+  require "rubygems"
+  require "dirty_hashy"
+
+  h = DirtyHashy.new
+  h.dirty? #=> false
+  h[:name] = "Paul"
+  h.dirty? #=> true
+  h.was :name #=> nil
+  h.change :name #=> [nil, "Paul"]
+  h.clean_up!
+  h.dirty? #=> false
+  h[:name] #=> "Paul"
+  h[:name] = "Paul"
+  h.dirty? #=> false
+  h[:name] = "Engel"
+  h.change :name #=> ["Paul", "Engel"]
+  h[:name] = "Foo"
+  h.was :name #=> "Paul"
+  h.changes #=> {"name"=>["Paul", "Foo"]}
+  h["company"] = "Internetbureau Holder B.V."
+  h.changes #=> {"company"=>[nil, "Internetbureau Holder B.V."], "name"=>["Paul", "Foo"]}
+  h.merge! :name => "Paul"
+  h.changes #=> {"company"=>[nil, "Internetbureau Holder B.V."]}
+  h.clean_up!
+  h.dirty? #=> false
+  h.changes #=> {}
+  h.delete :company
+  h.dirty? #=> true
+  h.was :company #=> "Internetbureau Holder B.V."
+  h.change :company #=> ["Internetbureau Holder B.V.", nil]
+</pre>
+
+h2. Last remarks
+
+Please check out "test/unit/test_dirty_hashy.rb":https://github.com/archan937/dirty_hashy/blob/master/test/unit/test_dirty_hashy.rb the tests available. You can run the unit tests with @rake@ within the terminal.
+
+Also, the DirtyHashy repo is provided with @script/console@ which you can use for testing purposes.
+
+Note: *DirtyHashy is successfully tested using Ruby 1.8.7 and Ruby 1.9.2*
+
+h2. Contact me
+
+For support, remarks and requests please mail me at "paul.engel@holder.nl":mailto:paul.engel@holder.nl.
+
+h2. License
+
+Copyright (c) 2011 Paul Engel, released under the MIT license
+
+"http://holder.nl":http://holder.nl – "http://codehero.es":http://codehero.es – "http://gettopup.com":http://gettopup.com – "http://github.com/archan937":http://github.com/archan937 – "http://twitter.com/archan937":http://twitter.com/archan937 – "paul.engel@holder.nl":mailto:paul.engel@holder.nl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |test|
+  test.pattern = "test/**/test_*.rb"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/dirty_hashy.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paul Engel"]
+  gem.email         = ["paul.engel@holder.nl"]
+  gem.description   = %q{Dirty tracking within hashes with indifferent access}
+  gem.summary       = %q{Dirty tracking within hashes with indifferent access}
+  gem.homepage      = "https://github.com/archan937/dirty_hashy"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "dirty_hashy"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.1.0"
+
+  gem.add_dependency "activesupport", ">= 3.0.0"
+end

data/lib/dirty_hashy.rb

@@ -0,0 +1,44 @@
+require "active_support/hash_with_indifferent_access"
+require "dirty_hashy/version"
+
+class DirtyHashy < HashWithIndifferentAccess
+
+  alias :_regular_writer :regular_writer
+  def regular_writer(key, value)
+    original_value = changes.key?(key) ? was(key) : self[key]
+    if original_value == value
+      changes.delete key
+    else
+      changes[key] = [original_value, value]
+    end
+    _regular_writer key, value
+  end
+
+  def delete(key)
+    self[key] = nil
+    super
+  end
+
+  def changes
+    @changes ||= HashWithIndifferentAccess.new
+  end
+
+  def changed?(key = nil)
+    key.nil? ? !changes.empty? : changes.key?(key)
+  end
+  alias :dirty? :changed?
+
+  def change(key)
+    changes[key] if changed?(key)
+  end
+
+  def was(key)
+    change(key).first if changed?(key)
+  end
+
+  def clean_up!
+    changes.clear
+    nil
+  end
+
+end

data/lib/dirty_hashy/version.rb

@@ -0,0 +1,7 @@
+class DirtyHashy < HashWithIndifferentAccess
+  MAJOR = 0
+  MINOR = 1
+  TINY  = 0
+
+  VERSION = [MAJOR, MINOR, TINY].join(".")
+end

data/script/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "bundler"
+
+Bundler.require :gem_default, :gem_development
+
+puts "Loading DirtyHashy development environment (#{DirtyHashy::VERSION})"
+puts "[0] pry(main)> @h = DirtyHashy.new"
+
+@h = DirtyHashy.new
+Pry.start

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler"
+
+Bundler.require :gem_default, :gem_test
+
+require "minitest/unit"
+require "minitest/autorun"

data/test/unit/test_dirty_hashy.rb

@@ -0,0 +1,140 @@
+require File.expand_path("../../test_helper", __FILE__)
+
+module Unit
+  class TestDirtyHashy < MiniTest::Unit::TestCase
+
+    describe DirtyHashy do
+      it "should behave as expected" do
+        hashy = DirtyHashy.new
+
+        assert_equal false, hashy.dirty?
+        assert_equal false, hashy.changed?
+        assert_equal({}, hashy.changes)
+
+        hashy["name"] = "Paul"
+
+        assert_equal true, hashy.dirty?
+        assert_equal true, hashy.changed?
+        assert_equal true, hashy.changed?(:name)
+        assert_equal true, hashy.changed?("name")
+        assert_equal [nil, "Paul"], hashy.change(:name)
+        assert_equal [nil, "Paul"], hashy.change("name")
+        assert_equal({"name" => [nil, "Paul"]}, hashy.changes)
+
+        hashy[:name] = nil
+
+        assert_equal false, hashy.dirty?
+        assert_equal false, hashy.changed?
+        assert_equal false, hashy.changed?(:name)
+        assert_equal false, hashy.changed?("name")
+        assert_equal nil, hashy.change(:name)
+        assert_equal nil, hashy.change("name")
+        assert_equal({}, hashy.changes)
+
+        hashy["name"] = "Stephan"
+
+        assert_equal true, hashy.dirty?
+        assert_equal true, hashy.changed?
+        assert_equal true, hashy.changed?(:name)
+        assert_equal true, hashy.changed?("name")
+        assert_equal [nil, "Stephan"], hashy.change(:name)
+        assert_equal [nil, "Stephan"], hashy.change("name")
+        assert_equal({"name" => [nil, "Stephan"]}, hashy.changes)
+
+        hashy.clean_up!
+
+        assert_equal false, hashy.dirty?
+        assert_equal false, hashy.changed?
+        assert_equal false, hashy.changed?(:name)
+        assert_equal false, hashy.changed?("name")
+        assert_equal nil, hashy.change(:name)
+        assert_equal nil, hashy.change("name")
+        assert_equal({}, hashy.changes)
+
+        hashy["name"] = "Chris"
+
+        assert_equal true, hashy.dirty?
+        assert_equal true, hashy.changed?
+        assert_equal true, hashy.changed?(:name)
+        assert_equal true, hashy.changed?("name")
+        assert_equal ["Stephan", "Chris"], hashy.change(:name)
+        assert_equal ["Stephan", "Chris"], hashy.change("name")
+        assert_equal({"name" => ["Stephan", "Chris"]}, hashy.changes)
+
+        hashy["name"] = "Stephan"
+
+        assert_equal false, hashy.dirty?
+        assert_equal false, hashy.changed?
+        assert_equal false, hashy.changed?(:name)
+        assert_equal false, hashy.changed?("name")
+        assert_equal nil, hashy.change(:name)
+        assert_equal nil, hashy.change("name")
+        assert_equal({}, hashy.changes)
+
+        hashy["name"] = "Paul"
+
+        assert_equal true, hashy.dirty?
+        assert_equal true, hashy.changed?
+        assert_equal true, hashy.changed?(:name)
+        assert_equal true, hashy.changed?("name")
+        assert_equal ["Stephan", "Paul"], hashy.change(:name)
+        assert_equal ["Stephan", "Paul"], hashy.change("name")
+        assert_equal({"name" => ["Stephan", "Paul"]}, hashy.changes)
+
+        hashy["name"] = "Tim"
+
+        assert_equal true, hashy.dirty?
+        assert_equal true, hashy.changed?
+        assert_equal true, hashy.changed?(:name)
+        assert_equal true, hashy.changed?("name")
+        assert_equal ["Stephan", "Tim"], hashy.change(:name)
+        assert_equal ["Stephan", "Tim"], hashy.change("name")
+        assert_equal({"name" => ["Stephan", "Tim"]}, hashy.changes)
+
+        hashy["company"] = "Holder"
+
+        assert_equal true, hashy.dirty?
+        assert_equal true, hashy.changed?
+        assert_equal true, hashy.changed?(:name)
+        assert_equal true, hashy.changed?("name")
+        assert_equal true, hashy.changed?(:company)
+        assert_equal true, hashy.changed?("company")
+        assert_equal ["Stephan", "Tim"], hashy.change(:name)
+        assert_equal ["Stephan", "Tim"], hashy.change("name")
+        assert_equal [nil, "Holder"], hashy.change(:company)
+        assert_equal [nil, "Holder"], hashy.change("company")
+        assert_equal({"name" => ["Stephan", "Tim"], "company" => [nil, "Holder"]}, hashy.changes)
+
+        hashy["city"] = "Amsterdam"
+        assert_equal({"name" => ["Stephan", "Tim"], "company" => [nil, "Holder"], "city" => [nil, "Amsterdam"]}, hashy.changes)
+
+        hashy.delete :city
+        assert_equal({"name" => ["Stephan", "Tim"], "company" => [nil, "Holder"]}, hashy.changes)
+
+        hashy.clean_up!
+
+        assert_equal false, hashy.dirty?
+        assert_equal false, hashy.changed?
+        assert_equal false, hashy.changed?(:name)
+        assert_equal false, hashy.changed?("name")
+        assert_equal false, hashy.changed?(:name)
+        assert_equal false, hashy.changed?("name")
+        assert_equal nil, hashy.change(:company)
+        assert_equal nil, hashy.change("company")
+        assert_equal({}, hashy.changes)
+
+        hashy.delete :company
+
+        assert_equal true, hashy.dirty?
+        assert_equal true, hashy.changed?
+        assert_equal true, hashy.changed?(:company)
+        assert_equal true, hashy.changed?("company")
+        assert_equal "Holder", hashy.was(:company)
+        assert_equal "Holder", hashy.was("company")
+        assert_equal ["Holder", nil], hashy.change(:company)
+        assert_equal ["Holder", nil], hashy.change("company")
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: dirty_hashy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Paul Engel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2156836380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156836380
+description: Dirty tracking within hashes with indifferent access
+email:
+- paul.engel@holder.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.rdoc
+- Gemfile
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- dirty_hashy.gemspec
+- lib/dirty_hashy.rb
+- lib/dirty_hashy/version.rb
+- script/console
+- test/test_helper.rb
+- test/unit/test_dirty_hashy.rb
+homepage: https://github.com/archan937/dirty_hashy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Dirty tracking within hashes with indifferent access
+test_files:
+- test/test_helper.rb
+- test/unit/test_dirty_hashy.rb