hash_to_object 0.1.0

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/Gemfile.lock

@@ -0,0 +1,15 @@
+PATH
+  remote: .
+  specs:
+    hash_to_object (0.1.0)
+
+GEM
+  specs:
+    rspec (1.2.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hash_to_object!
+  rspec

data/README.md

@@ -0,0 +1,30 @@
+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:
+
+    class Order
+      include HashToObject
+
+      def initialize(options = {})
+        objectify(options)
+      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`.
+
+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.
+
+Example:
+
+    Order.new({:item => {:name => "foo"}, :transactions => [{:id => "bar"},{:id => "baz"}])
+
+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`).  
+
+The only caveat is that you need to have `Order::Item` and `Order::Transaction` defined, and mix-in HashToObject similarly to `Order` above.

data/Rakefile

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/hash_to_object.gemspec

@@ -0,0 +1,57 @@
+## 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.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]
+
+  ## 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
+    Gemfile.lock
+    README.md
+    Rakefile
+    hash_to_object.gemspec
+    lib/hash_to_object.rb
+    spec/hash_to_object_spec.rb
+  ]
+  # = 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

data/lib/hash_to_object.rb

@@ -0,0 +1,53 @@
+require 'active_support/inflector'
+
+module HashToObject
+  VERSION = '0.1.0'
+
+  class << self
+    alias_method :build_new_object, :build_new_object
+  end
+  
+  def objectify(hash_parameters)
+    hash_parameters.each do |key, value|
+      if value.is_a?(Array)
+        objects = value.map{|item| build_new_object(build_class_string(key), item)}
+        define_attribute(key, objects)
+      elsif value.is_a?(Hash)
+        define_attribute(key, build_new_object(build_class_string(key), value))
+      else
+        define_attribute(key.to_s, value)
+      end
+    end
+  end
+
+  def build_class_string(class_string)
+    @settings ||= load_settings
+    class_string = class_string.singularize.underscore
+
+    if @settings && @settings.send(class_string.to_sym)
+      @settings.send(class_string.to_sym)
+    else
+      "#{self.class}::#{class_string.singularize.camelcase}"
+    end
+  end
+  
+  def build_new_object(class_string, hash_parameters)
+    class_string.constantize.new(hash_parameters)
+  end
+
+  def define_attribute(key, value)
+    metaclass.send :attr_accessor, key.underscore
+    send "#{key}=".underscore.to_sym, value    
+  end
+
+  def metaclass
+    class << self
+      self
+    end
+  end
+
+  def load_settings
+    #implement this
+    nil
+  end
+end

data/spec/hash_to_object_spec.rb

@@ -0,0 +1,88 @@
+require 'lib/hash_to_object.rb'
+
+describe HashToObject do
+  class Dummy
+    include HashToObject
+    def initialize(options = {})
+      objectify(options)
+    end
+  end
+
+  class Dummy::Item
+    include HashToObject
+    def initialize(options = {})
+      objectify(options)
+    end
+  end
+
+  class TopLevel
+    include HashToObject
+    def initialize(options = {})
+      objectify(options)
+    end
+  end
+
+  before do
+    Settings = stub unless Object.const_defined?(:Settings)
+    Settings.stub_chain(:hash_to_object, :send).and_return(nil)
+  end
+  
+  context "creates a new object based on a class and a hash" do
+    before :each do
+      @dummy = Dummy.new({"amount" => 1, "body" => "text", "admin" => true})
+    end
+    it "has a class that matches the parameters" do
+      @dummy.class.should == Dummy
+    end
+
+    it "creates instance variables based on the hash" do
+      @dummy.amount.should == 1
+      @dummy.body.should == "text"
+      @dummy.admin.should == true
+    end
+
+    context "creates associations" do
+      context "creates a new object if the association is 1:1" do
+        before :each do
+        @dummy = Dummy.new({"amount" => 1, "body" => "text", "admin" => true, "item" => {"foo" => "bar"}})
+        end
+        it "has a class that matches the parameters" do
+          @dummy.item.class.should == Dummy::Item
+        end
+
+        it "creates instance variables based on the hash" do
+          @dummy.item.foo.should == "bar"
+        end          
+      end
+
+      context "creates an array of new objects if the association is 1:many" do
+        before :each do
+        @dummy = Dummy.new({"amount" => 1, "body" => "text", "admin" => true, "items" => [{"foo" => "bar"}, {"bar" => "baz"}]})
+        end
+        it "creates an instance variable based on the array" do
+          @dummy.items.class.should == Array
+        end
+        it "creates objects of the desired class in the array" do
+          @dummy.items.first.class.should == Dummy::Item
+        end
+      end
+    end
+  end
+
+  context "throws exceptions if classes are undefined" do
+    it "throws a NameError if the parent class provided is undefined" do
+      lambda{Foo.new({"foo" => "bar"})}.should raise_error(NameError)
+    end
+
+    it "throws a NameError if a subclass is undefined" do
+      lambda{Dummy.new({"foo" => "bar", "bar" => {"admin" => true}})}.should raise_error(NameError)
+    end
+  end
+
+  it "creates objects of pre-defined classes if they are in hash_to_object.yml config" do
+    pending
+    Settings.stub_chain(:hash_to_object, :send).and_return('TopLevel')
+    @dummy = Dummy.new({"amount" => 1, "body" => "text", "admin" => true, "top_level" => {"foo" => "bar"}})
+    @dummy.top_level.class.should == TopLevel
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: hash_to_object
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Phillip Birtcher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: ""
+email: philbirt@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- 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: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 2
+summary: Converts json-like hashes into ruby objects.
+test_files: []
+