document_hash 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in document.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Giancarlo Palavicini
+
+MIT License
+
+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.md

@@ -0,0 +1,30 @@
+# Document
+
+Manages a Document, the document contains multiple nested objects, but changes on any sub-level is notified to the parent
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'document'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install document
+
+## Usage
+
+It mainly iterates from a hash, so any way that's valid for creating a hash should be valid for creating a Document, be aware that if you create a document with a multi-level hash, it will convert any inner hash to a Document in order to privide its main functionality
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/document_hash.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'document_hash/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "document_hash"
+  gem.version       = Document::VERSION
+  gem.authors       = ["Giancarlo Palavicini"]
+  gem.email         = ["kasthor@gmail.com"]
+  gem.description   = %q{Implements a multi-level nested document, that notifies about changes, and some other related features}
+  gem.summary       = %q{Document Object}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+end

data/lib/document.rb

@@ -0,0 +1,59 @@
+require "document_hash/version"
+
+module Document
+  class Core < Hash
+    def self.[] *attr
+      super(*attr).tap do|new|
+        new.each do |k,v|
+          p v.class
+          new[k] = new.class[v] if v.is_a?(Hash) && ! v.is_a?(self.class)
+        end
+      end
+    end
+
+    def changed
+      changed_attributes.dup.freeze
+    end
+
+    def changed? 
+      ! changed.empty?
+    end
+
+    def [] key
+      super key.to_sym
+    end
+
+    def []= key, val
+      key = key.to_sym
+
+      if val.is_a? Hash
+        val = self.class[val] 
+        val.__send__ :parent=, self;
+        val.__send__ :parent_key=, key;
+      end
+
+      super key, val
+      changed_key key
+
+      parent.__send__ :changed_key, parent_key if parent
+    end
+
+    def reset!
+      changed_attributes.clear
+    
+      values.select{|v| v.is_a? self.class }.each{ |v| v.reset! }
+    end
+
+    private 
+
+    attr_accessor :parent, :parent_key
+
+    def changed_key key
+      changed_attributes << key
+    end
+
+    def changed_attributes 
+      @changed ||= Set.new
+    end
+  end
+end

data/lib/document_hash/version.rb

@@ -0,0 +1,3 @@
+module Document
+  VERSION = "0.0.1"
+end

data/spec/lib/document_spec.rb

@@ -0,0 +1,71 @@
+describe Document::Core do
+  it "inherits from a hash" do
+    subject.is_a? Hash
+  end
+
+  it "knows when a key has changed" do
+    subject[:test] = :test
+
+    subject.should be_changed
+  end
+
+  it "enumerates the changed keys" do
+    subject[:test] = :test
+
+    subject.should include :test
+  end
+
+  it "matches string keys to symbols" do
+    subject[:test] = "test"
+
+    subject["test"].should == "test"
+  end
+
+  it "converts any internal hashes to Documents" do
+    subject[:test] = { inner: "test" }
+
+    subject[:test].should be_a_kind_of Document::Core
+  end
+
+  it "makes it child documents to refer its parent" do
+    subject[:test] = { inner: "test" }
+
+    subject[:test].__send__(:parent).should == subject
+    subject[:test].__send__(:parent_key).should == :test
+  end
+
+  it "notifies its parent when a change ocurr" do
+    subject[:test] = { inner: "test" }
+    subject.__send__(:changed_attributes).should_receive(:<<).with(:test)
+    subject[:test][:inner] = "modified"
+  end
+
+  it "reset its changed status" do
+    subject[:test] = "xxx"
+    expect{
+      subject.reset!
+    }.to change(subject, :changed?).from(true).to(false)
+  end
+
+  it "has a changed status if a child changed" do
+    subject[:test] = { inner: "test" }
+    subject.reset!
+    expect{
+      subject[:test][:inner] = "modified"
+    }.to change(subject, :changed?).from(false).to(true)
+  end
+
+  it "resets child changed status when reseting the root" do
+    subject[:test] = { inner: "test" }
+    subject[:test][:inner] = "modified"
+    subject.reset!
+
+    subject[:test].should_not be_changed
+  end
+
+  it "converts inner hashes into Documents" do
+    subject = Document::Core[ { test: { inner: "test" } } ]
+
+    subject[:test].should be_a_kind_of Document::Core
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require './lib/document'
+
+RSpec.configure do |config|
+
+  config.order = 'random'
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: document_hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Giancarlo Palavicini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Implements a multi-level nested document, that notifies about changes,
+  and some other related features
+email:
+- kasthor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- document_hash.gemspec
+- lib/.document.rb.swo
+- lib/.document.rb.swp
+- lib/document.rb
+- lib/document_hash/.version.rb.swp
+- lib/document_hash/version.rb
+- spec/.spec_helper.rb.swp
+- spec/lib/.document_spec.rb.swo
+- spec/lib/.document_spec.rb.swp
+- spec/lib/document_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.24
+signing_key: 
+specification_version: 3
+summary: Document Object
+test_files:
+- spec/.spec_helper.rb.swp
+- spec/lib/.document_spec.rb.swo
+- spec/lib/.document_spec.rb.swp
+- spec/lib/document_spec.rb
+- spec/spec_helper.rb