hashify 0.0.1

data/README.rdoc

@@ -0,0 +1,47 @@
+= Hashify
+
+Utterly simple hash creation for the your favorite objects
+
+== Usage
+
+  class Person
+    include Hashify
+    
+    attr_accessor :name, :address, :date_of_birth
+    hash_accessor :name, :address
+  end
+  
+  >> p = Person.new
+  >> p.name = 'my name'
+  >> p.address = 'my address'
+  >> p.to_hash
+  => {:name=>"my name", :address=>"my address"}
+  
+What about that pesky dob?
+
+  class Person
+    hash_convert :date_of_birth => Hashify::Convert::Time
+  end
+  
+  >> p.date_of_birth = Time.local(2000, "jan", 1, 0, 0, 0)
+  >> p.to_hash
+  => {:date_of_birth=>946702800, :name=>"my name", :address=>"my address"}
+  
+How we have these beautiful hashes, lets get a person back out of it.
+
+  >> Person.from_hash(:date_of_birth=>946702800, :name=>"my name", :address=>"my address")
+  => #<Person:0x10187b660 @date_of_birth=Sat Jan 01 00:00:00 -0500 2000, @address="my address", @name="my name">
+
+For bonus points, lets do json too
+
+  class Person
+    include Hashify::Json
+  end
+  
+  >> p.to_json
+  => "{\"address\":\"my address\",\"date_of_birth\":946702800,\"name\":\"my name\"}"
+  
+And of course,
+
+  >> Person.from_json("{\"address\":\"my address\",\"date_of_birth\":946702800,\"name\":\"my name\"}")
+  => #<Person:0x101809150 @date_of_birth=Sat Jan 01 00:00:00 -0500 2000, @address="my address", @name="my name">

data/Rakefile

@@ -0,0 +1,47 @@
+libdir = File.expand_path("lib")
+$:.unshift(libdir) unless $:.include?(libdir)
+
+require 'hashify'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "hashify"
+    s.description = s.summary = "Simple to_hash, to_json <-> from_hash, from_json"
+    s.email = "joshbuddy@gmail.com"
+    s.homepage = "http://github.com/joshbuddy/hashify"
+    s.authors = ["Joshua Hull"]
+    s.files = FileList["[A-Z]*", "{lib,spec}/**/*"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec'
+require 'spec/rake/spectask'
+task :spec => 'spec:all'
+namespace(:spec) do
+  Spec::Rake::SpecTask.new(:all) do |t|
+    t.spec_opts ||= []
+    t.spec_opts << "-rubygems"
+    t.spec_opts << "--options" << "spec/spec.opts"
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('spec_with_rcov') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+
+require 'rake/rdoctask'
+desc "Generate documentation"
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.rdoc_dir = 'rdoc'
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/hashify.rb

@@ -0,0 +1,55 @@
+module Hashify
+
+  autoload :Json, File.join(File.dirname(__FILE__), 'hashify', 'json')
+  autoload :Convert, File.join(File.dirname(__FILE__), 'hashify', 'convert')
+  
+  def self.included(cls)
+    
+    cls.const_set(:HashConvertTable, {}) unless cls.const_defined?(:HashConvertTable)
+    cls.instance_eval(<<-CLASS_DOC, __FILE__, __LINE__)
+    def self.hash_convert_table
+      self.const_set(:HashConvertTable, {}) unless self.const_defined?(:HashConvertTable)
+      send(:const_get, :HashConvertTable)
+    end
+    
+    def self.hash_accessor(*args)
+      args.each {|a| hash_convert_table[a] = nil }
+    end
+      
+    def self.hash_convert(map)
+      hash_convert_table.merge!(map)
+    end
+    
+    def self.from_hash(map)
+      convert_map = assembled_hash_convert
+      instance = new
+      map.each do |name, val|
+        convert_map[name.to_sym] ? 
+          instance.send((name.to_s + '=').to_sym, convert_map[name.to_sym].last.call(val)) :
+          instance.send((name.to_s + '=').to_sym, val)
+      end
+      instance
+    end
+    
+    def self.assembled_hash_convert
+      map = hash_convert_table.dup
+      parent = self.superclass
+      while (parent and parent.respond_to?(:hash_convert_table))
+        map.merge!(parent.hash_convert_table) {|key, old_value, new_value| old_value || new_value }
+        parent = parent.superclass
+      end
+      map
+    end
+    CLASS_DOC
+  end
+  
+  def to_hash
+    self.class.assembled_hash_convert.inject({}) do |hash, (name, converter)|
+      converter ? 
+        hash[name] = converter.first.call(self.send(name)) :
+        hash[name] = self.send(name)
+      hash
+    end
+  end
+  
+end

data/lib/hashify/convert.rb

@@ -0,0 +1,6 @@
+module Hashify
+  module Convert
+    Pass = nil
+    Time = [Proc.new{|x| x.nil? ? nil : x.to_i}, Proc.new{|x| x.nil? ? nil : ::Time.at(x.to_i)}]
+  end
+end

data/lib/hashify/json.rb

@@ -0,0 +1,18 @@
+require 'json' unless Object.respond_to?(:to_json)
+
+module Hashify
+  module Json
+    def self.included(cls)
+      cls.instance_eval "
+      def self.from_json(json)
+        from_hash(JSON.parse(json))
+      end
+      "
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+
+  end
+end

data/spec/convert_spec.rb

@@ -0,0 +1,20 @@
+require 'spec/spec_helper'
+
+describe "Basic object", "conversions" do
+  it "should run conversions" do
+    
+    test = Class.new do 
+      include Hashify
+      attr_accessor :prop1
+      hash_convert :prop1 => [proc{|x| x.to_i}, proc{|x| Time.at(x)}]
+    end
+    
+    t = test.from_hash(:prop1 => 12345)
+    
+    t.prop1.should == Time.at(12345)
+    
+    t.to_hash.should == {:prop1 => 12345}
+  end
+
+
+end

data/spec/from_hash_spec.rb

@@ -0,0 +1,61 @@
+require 'spec/spec_helper'
+
+describe "Basic object", "from_hash" do
+  it "should convert from a hash" do
+    
+    test = Class.new do 
+      include Hashify
+      attr_accessor :prop1, :prop2, :prop3, :prop4
+      hash_accessor :prop1, :prop2, :prop3, :prop4
+    end
+    
+    t = test.from_hash(:prop1 => 'prop_val_1', :prop2 => 'prop_val_2', :prop3 => 'prop_val_3', :prop4 => 'prop_val_4')
+    
+    t.prop1.should == "prop_val_1"
+    t.prop2.should == "prop_val_2"
+    t.prop3.should == "prop_val_3"
+    t.prop4.should == "prop_val_4"
+  end
+
+  it "should convert from a hash for a subclass" do
+    
+    test = Class.new do 
+      include Hashify
+      attr_accessor :prop1, :prop2, :prop3, :prop4
+      hash_accessor :prop1, :prop2, :prop3, :prop4
+    end
+    
+    test2 = Class.new(test)
+    
+    t = test2.from_hash(:prop1 => 'prop_val_1', :prop2 => 'prop_val_2', :prop3 => 'prop_val_3', :prop4 => 'prop_val_4')
+    
+    t.prop1.should == "prop_val_1"
+    t.prop2.should == "prop_val_2"
+    t.prop3.should == "prop_val_3"
+    t.prop4.should == "prop_val_4"
+  end
+
+  it "should convert from a hash for subclasses with specific hash accessors" do
+    
+    test = Class.new do 
+      include Hashify
+      attr_accessor :prop1, :prop2, :prop3, :prop4
+      hash_accessor :prop1, :prop2, :prop3, :prop4
+    end
+    
+    test2 = Class.new(test) do 
+      attr_accessor :prop5, :prop6
+      hash_accessor :prop5, :prop6
+    end
+    
+    t = test2.from_hash(:prop1 => 'prop_val_1', :prop2 => 'prop_val_2', :prop3 => 'prop_val_3', :prop4 => 'prop_val_4', :prop5 => 'prop_val_5', :prop6 => 'prop_val_6')
+    t.prop1.should == "prop_val_1"
+    t.prop2.should == "prop_val_2"
+    t.prop3.should == "prop_val_3"
+    t.prop4.should == "prop_val_4"
+    t.prop5.should == "prop_val_5"
+    t.prop6.should == "prop_val_6"
+  end
+
+
+end

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+specdoc
+--loadby
+mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+libdir = File.expand_path("lib")
+$:.unshift(libdir) unless $:.include?(libdir)
+
+require 'hashify'

data/spec/to_hash_spec.rb

@@ -0,0 +1,62 @@
+require 'spec/spec_helper'
+
+describe "Basic object", 'to_hash' do
+  it "should convert into a hash" do
+    
+    test = Class.new do 
+      include Hashify
+      attr_accessor :prop1, :prop2, :prop3, :prop4
+      hash_accessor :prop1, :prop2, :prop3, :prop4
+    end
+    
+    t = test.new
+    t.prop1 = "prop_val_1"
+    t.prop2 = "prop_val_2"
+    t.prop3 = "prop_val_3"
+    t.prop4 = "prop_val_4"
+    t.to_hash.should == {:prop1 => 'prop_val_1', :prop2 => 'prop_val_2', :prop3 => 'prop_val_3', :prop4 => 'prop_val_4'}
+  end
+
+  it "should convert into a hash for subclasses" do
+    
+    test = Class.new do 
+      include Hashify
+      attr_accessor :prop1, :prop2, :prop3, :prop4
+      hash_accessor :prop1, :prop2, :prop3, :prop4
+    end
+    
+    test2 = Class.new(test) do 
+    end
+    
+    t = test2.new
+    t.prop1 = "prop_val_1"
+    t.prop2 = "prop_val_2"
+    t.prop3 = "prop_val_3"
+    t.prop4 = "prop_val_4"
+    t.to_hash.should == {:prop1 => 'prop_val_1', :prop2 => 'prop_val_2', :prop3 => 'prop_val_3', :prop4 => 'prop_val_4'}
+  end
+
+  it "should convert into a hash for subclasses with specific hash accessors" do
+    
+    test = Class.new do 
+      include Hashify
+      attr_accessor :prop1, :prop2, :prop3, :prop4
+      hash_accessor :prop1, :prop2, :prop3, :prop4
+    end
+    
+    test2 = Class.new(test) do 
+      attr_accessor :prop5, :prop6
+      hash_accessor :prop5, :prop6
+    end
+    
+    t = test2.new
+    t.prop1 = "prop_val_1"
+    t.prop2 = "prop_val_2"
+    t.prop3 = "prop_val_3"
+    t.prop4 = "prop_val_4"
+    t.prop5 = "prop_val_5"
+    t.prop6 = "prop_val_6"
+    t.to_hash.should == {:prop1 => 'prop_val_1', :prop2 => 'prop_val_2', :prop3 => 'prop_val_3', :prop4 => 'prop_val_4', :prop5 => 'prop_val_5', :prop6 => 'prop_val_6'}
+  end
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: hashify
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshua Hull
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-31 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Simple to_hash, to_json <-> from_hash, from_json
+email: joshbuddy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/hashify.rb
+- lib/hashify/convert.rb
+- lib/hashify/json.rb
+- spec/convert_spec.rb
+- spec/from_hash_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/to_hash_spec.rb
+has_rdoc: true
+homepage: http://github.com/joshbuddy/hashify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple to_hash, to_json <-> from_hash, from_json
+test_files: 
+- spec/convert_spec.rb
+- spec/from_hash_spec.rb
+- spec/spec_helper.rb
+- spec/to_hash_spec.rb