hash_to_object 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -5,11 +5,19 @@ PATH
 
 GEM
   specs:
-    rspec (1.2.9)
+    diff-lcs (1.1.3)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   hash_to_object!
-  rspec
+  rspec (~> 2.3)

data/README.md

@@ -1,9 +1,9 @@
 HashToObject
 ============
 
-HashToObject is a mixin for converting hashes into ruby objects.  For instance, if you wanted an Order class that could be instantiated from a hash, you could define it as such:
+HashToObject is a mixin for converting hashes into ruby objects.  For instance, if you wanted to build Foo objects, you could define it as such:
 
-    class Order
+    class Foo
       include HashToObject
 
       def initialize(options = {})
@@ -11,20 +11,52 @@ HashToObject is a mixin for converting hashes into ruby objects.  For instance,
       end
     end
 
-And you have a hash like such:
- 
-    hash_to_object = {:amount => 25, :type => "credit", :admin => false}
-
-Then you can call `Order.new(hash_to_object)` and get an `Order` object with instance variables `@amount`, `@type`, `@admin`.
+You can now build new Foo objects with arbitrary key value pairs and have access to them.
+    
+    foo = Foo.new('bar' => 'baz', 'qux' => [1,2,3])
+    
+    foo.bar
+    => "baz"
+    foo.bar = "garply"
+    => "garply"
+    
+    quux = Foo.new('corge' => 'grault')
+    
+    quux.bar
+    => NoMethodError: undefined method 'bar'
+    quux.corge
+    => "grault"
+
+
+Recursion and Nesting
+=====================
+HashToObject also supports nesting of object creation.  Note that you will need classes that correspond to the hash structure.
+
+    class Foo::Item
+      include HashToObject
 
-Nesting
-=======
-HashToObject also supports nesting of object creation.  It defines the nested objects' class based on the name of the parent class and the singularized key name of the nested value.
+      def initialize(options = {})
+        objectify(options)
+      end
+    end
+    
+    class Foo::Lolipop
+      include HashToObject
 
-Example:
+      def initialize(options = {})
+        objectify(options)
+      end
 
-    Order.new({:item => {:name => "foo"}, :transactions => [{:id => "bar"},{:id => "baz"}])
+      def waldo
+        "Where in the world is #{@id}?"
+      end
+    end
 
-This would create an object of type `Order`, with instance variables `@item` and `@transactions` linking to objects of type `Order::Item` (with instance variable `@name`), and `Order::Transaction` (with instance variable `@id`).  
+    foo = Foo.new('item' => {'name' => 'foo'}, 'lolipops' => [{'id'=> 'bar'}, {'id'=> 'baz'}])
 
-The only caveat is that you need to have `Order::Item` and `Order::Transaction` defined, and mix-in HashToObject similarly to `Order` above.
+    foo.item
+    => #<Foo::Item:0x007fbf40ee1e78 @name="foo">
+    foo.lolipops
+    => [#<Foo::Lolipop:0x007fbf429d4780 @id="bar">, #<Foo::Lolipop:0x007fbf42bc1a48 @id="baz">]
+    foo.lolipops.first.waldo
+    => "Where in the world is bar?"

data/hash_to_object.gemspec

@@ -1,44 +1,19 @@
-## This is the rakegem gemspec template. Make sure you read and understand
-## all of the comments. Some sections require modification, and others can
-## be deleted if you don't need them. Once you understand the contents of
-## this file, feel free to delete any comments that begin with two hash marks.
-## You can find comprehensive Gem::Specification documentation, at
-## http://docs.rubygems.org/read/chapter/20
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.rubygems_version = '1.3.5'
 
-  ## Leave these as is they will be modified for you by the rake gemspec task.
-  ## If your rubyforge_project name is different, then edit it and comment out
-  ## the sub! line in the Rakefile
-  s.name              = 'hash_to_object'
-  s.version           = '0.1.0'
-  s.date              = '2011-09-26'
-
-  ## Make sure your summary is short. The description may be as long
-  ## as you like.
-  s.summary     = "Converts json-like hashes into ruby objects."
-  s.description = ""
-
-  ## List the primary authors. If there are a bunch of authors, it's probably
-  ## better to set the email to an email list or something. If you don't have
-  ## a custom homepage, consider using your GitHub URL or the like.
+  s.name     = 'hash_to_object'
+  s.version  = '0.1.1'
+  s.date     = '2011-09-26'
+  s.summary  = "Converts hashes into ruby objects."
   s.authors  = ["Phillip Birtcher"]
   s.email    = 'philbirt@gmail.com'
   s.homepage = 'https://github.com/philbirt/hash_to_object'
-
-  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
-  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
   s.require_paths = %w[lib]
+  
+  s.add_development_dependency('rspec', "~> 2.3")
 
-  ## List your development dependencies here. Development dependencies are
-  ## those that are only needed during development
-  s.add_development_dependency('rspec')
-
-  ## Leave this section as-is. It will be automatically generated from the
-  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
-  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
   # = MANIFEST =
   s.files = %w[
     Gemfile
@@ -51,7 +26,5 @@ Gem::Specification.new do |s|
   ]
   # = MANIFEST =
 
-  ## Test files will be grabbed from the file list. Make sure the path glob
-  ## matches what you actually use.
   s.test_files = s.files.select { |path| path =~ /^spec\/*._spec\.rb/ }
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hash_to_object
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Phillip Birtcher
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-26 00:00:00 -05:00
-default_executable: 
+date: 2011-09-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -24,15 +23,16 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 5
         segments: 
-        - 0
-        version: "0"
+        - 2
+        - 3
+        version: "2.3"
   type: :development
   version_requirements: *id001
-description: ""
+description: 
 email: philbirt@gmail.com
 executables: []
 
@@ -48,7 +48,6 @@ files:
 - hash_to_object.gemspec
 - lib/hash_to_object.rb
 - spec/hash_to_object_spec.rb
-has_rdoc: true
 homepage: https://github.com/philbirt/hash_to_object
 licenses: []
 
@@ -78,9 +77,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 2
-summary: Converts json-like hashes into ruby objects.
+summary: Converts hashes into ruby objects.
 test_files: []