dotted_hash 0.9 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13450c3abde2a7100248385cefbafd3a41260c76
-  data.tar.gz: 21ccd452b4ca350acecbf2209dcdc8723ccac4ac
+  metadata.gz: 3dccd5c932fd7197a40555f0ab7d4337a3a9018c
+  data.tar.gz: f3cb641cf1f2e2a3b845f781a7051aaab53e3293
 SHA512:
-  metadata.gz: 163655b8c528a56443d47af75813d1e15aca9617154707bcff3ce6262f95ec78d32a6372cc8c5c7a8c9d5a54031360e6ae2126f046c1ab461490d411bb7fcfba
-  data.tar.gz: 5889f79bf47c38db461b32ef119662ba7695cef4c0d016073d472dfd1fd1dfbc150c4e9d85ced5abf41d084ebd7e54f6a9811efad578b1bf8996f2585de8dc7d
+  metadata.gz: 931abd36ada5a91c9767a20d9a7b2535432364e6a5fdc30a9c3a98a5a5990f67bc7eb0f8889ae4673f5694fa240fce30df86593eaca75e2ec360b2cb855721b6
+  data.tar.gz: c2c0f6756869edd015074ffd0ad3aae5a9543e72ac16c72fb16887d9093c8dec4582c2ca6765630842d2895c97cf3f300c5184f697bba609c6635463570ae329

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 pkg/
+html/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - rbx-2.2.1
+  - jruby-19mode

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in dotted_hash.gemspec
 gemspec
+
+platforms :rbx do
+  gem 'psych', '~> 2.0'
+  gem 'rubysl', '~> 2.0'
+end

data/MIT-LICENSE

@@ -1,4 +1,6 @@
-Copyright 2011 Karel Minarik
+Original Copyright 2011 Karel Minarik
+
+Copyright 2013 Ivan Stana
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/istana/dotted_hash.png)](https://travis-ci.org/istana/dotted_hash)
+
 # DottedHash
 
 Recursive OpenStruct-like or Hash-like object. Uses ActiveModel.
@@ -40,7 +42,6 @@ Or install it yourself as:
 if key has spaces
 
     > document.quotes['Duke Nukem Forever']
-    > document.quotes['Duke Nukem Forever']
 
 nested
 

data/Rakefile

@@ -17,4 +17,14 @@ task :test do
     puts unit
     system("rspec #{unit}")
   end
-end
+end
+
+task :default => [:test]
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.md"
+  rd.rdoc_files.include("README.md", "lib/*.rb")
+  rd.options << "--all"
+  rd.title = "Enjoy DottedHash!"
+end

data/dotted_hash.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files  = [ "README.md", "MIT-LICENSE" ]
   spec.rdoc_options      = [ "--charset=UTF-8" ]
   
-  spec.add_dependency "activemodel", ">= 3.0"
-  spec.add_dependency "activesupport"
+  spec.add_dependency "activemodel", "~> 4.0"
+  spec.add_dependency "activesupport", "~> 4.0"
   
   unless defined?(JRUBY_VERSION)
     spec.add_development_dependency "turn"
@@ -30,5 +30,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-	spec.add_development_dependency "rspec", "~> 2.13"
+  spec.add_development_dependency "rspec", "~> 2.13"
+  spec.add_development_dependency "rdoc", "~> 4.0"
 end

data/lib/dotted_hash.rb

@@ -5,6 +5,7 @@ require 'active_model'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/json'
 
+# See Readme.md in gem/repository directory for usage instructions
 class DottedHash
 	extend  ActiveModel::Naming
 	include ActiveModel::Conversion
@@ -12,22 +13,22 @@ class DottedHash
 
 	## Basic security
 
-	# Maximum depth of whole tree, not keys (keys depth+1)
-	# Counted from 0
-	# Not fully bulletproof, depth may be set to wrong number if careless
+	# Maximum depth of whole tree, not keys (keys depth+1).
+	# Counted from 0.
+	# Not fully bulletproof, depth may be set to wrong number if careless.
 	MAX_DEPTH = 10
 
-	# Maximum count of attributes
-	# Use hash like this to specify each level
+	# Maximum count of attributes.
+	# Use hash like this to specify each level.
 	# MAX_ATTRS = {1 => 20, 2 => 5, default: 10}
 	MAX_ATTRS = 10
 
-	# Maximum size of document, counted from JSON result of document
-	# It is not bulletproof, but if using simple structures, it is enough
-	# Other structures may have much bigger representation in memory than in JSON
+	# Maximum size of document, counted from JSON result of document.
+	# It is not bulletproof, but if using simple structures, it is enough.
+	# Other structures may have much bigger representation in memory than in JSON.
 	MAX_SIZE = 16384
 
-	# Create new instance, recursively converting all Hashes to Item
+	# Create new instance, recursively converting all Hashes to DottedHash
 	# and leaving everything else alone.
 	#
 	def initialize(args={}, level=0)
@@ -40,6 +41,22 @@ class DottedHash
 			assign_value(key, value)
 		end
 	end
+	
+	# Merge with another hash
+	def merge!(obj)
+		if obj.respond_to? :to_h
+		  hash = obj.to_h
+		elsif obj.respond_to? :to_hash
+		  hash = obj.to_hash
+		else
+		  raise('Merge works only with hashlike object')
+		end
+		
+		hash.each do |key, value|
+			assign_value(key, value)
+		end
+		self
+	end
 
 	def assign_value(key, value)
 		max_attrs = if MAX_ATTRS.is_a?(Fixnum)
@@ -76,8 +93,11 @@ class DottedHash
 		end
 	end
 
+	# Always respond to write.
+	# Respond to attribute or defined method.
+	#
 	def respond_to?(method_name, include_private = false)
-		# answer to any write method
+		# answers to any write method
 		if method_name.to_s[-1] == '='
 			true
 		else
@@ -85,6 +105,9 @@ class DottedHash
 		end
 	end
 
+	# Recursively assigns value.
+	# Also creates sub-DottedHashes if they don't exist).
+	#
 	def recursive_assign(key, value)
 		return nil if key.blank?
 		keys = key.split('.')
@@ -101,30 +124,34 @@ class DottedHash
 		end
 	end
 
+	# Provides access to attribute.
+	# Use when you have spaces and other non +a-z_+ characters in attribute name.
+	#
 	def [](key)
 		@attributes[key.to_sym]
 	end
 
+	# Returns +id+ of document
+	#
 	def id
-		@attributes[:_id] || @attributes[:id]
-	end
-
-	def type
-		@attributes[:_type] || @attributes[:type]
+		@attributes[:id]
 	end
 
 	def persisted?
 		!!id
 	end
 
+	# Standard ActiveModel Errors
 	def errors
 		ActiveModel::Errors.new(self)
 	end
 
+	# Always +true+
 	def valid?
 		true
 	end
 
+	# Returns key if key exists
 	def to_key
 		persisted? ? [id] : nil
 	end
@@ -138,11 +165,15 @@ class DottedHash
 
 	alias_method :to_h, :to_hash
 
+	# Returns (filtered) Ruby +Hash+ with characters 
+	# and objects only allowed in JSON.
+	#
 	def as_json(options=nil)
 		hash = to_hash
 		hash.respond_to?(:with_indifferent_access) ? hash.with_indifferent_access.as_json(options) : hash.as_json(options)
 	end
 
+	# JSON string of +as_json+ result
 	def to_json(options=nil)
 		as_json.to_json(options)
 	end

data/lib/dotted_hash/version.rb

@@ -1,3 +1,3 @@
 class DottedHash
-  VERSION = "0.9"
+  VERSION = "1.0"
 end

data/test/dotted_hash_spec.rb

@@ -25,17 +25,8 @@ describe DottedHash do
 		end
 
 		it "should have an 'id' method" do
-			a = DottedHash.new(_id: 1)
-			b = DottedHash.new(id: 1)
+			a = DottedHash.new(id: 1)
 			expect(a.id).to eq(1)
-			expect(b.id).to eq(1)
-		end
-
-		it "should have a 'type' method" do
-			a = DottedHash.new(_type: 'foo')
-			b = DottedHash.new(type: 'foo')
-			expect(a.type).to eq('foo')
-			expect(b.type).to eq('foo')
 		end
 
 		it "should respond to :to_indexed_json" do
@@ -155,6 +146,12 @@ describe DottedHash do
 		it "should be inspectable" do
 			expect(@document.inspect).to match(/<DottedHash .* title|DottedHash .* author/)
 		end
+		
+		it "merge!" do
+			doc = @document.merge!(mergetest: 'foo')
+			expect(doc.mergetest).to eq('foo')
+			expect(doc.title).to eq('Test')
+		end
 
 		context "within Rails" do
 

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: dotted_hash
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '1.0'
 platform: ruby
 authors:
 - Ivan Stana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: Recursive OpenStruct-like or Hash-like object. Based on Tire::Result::Item
   with addition of writing attributes and security limits.
 email:
@@ -105,6 +119,7 @@ extra_rdoc_files:
 - MIT-LICENSE
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - MIT-LICENSE
@@ -137,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Recursive OpenStruct-like object.