hashtostruct 0.9.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.9.0 2008-11-29
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/hashtostruct.rb
+script/console
+script/destroy
+script/generate
+spec/hashtostruct_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,59 @@
+= hashtostruct
+
+http://github.com/openback/hashtostruct
+
+== DESCRIPTION:
+
+Takes a Hash and converts it into a Struct with each key as a property and
+each value converted into a native object if possible.
+
+== SYNOPSIS:
+
+  obj = {
+    "string" => "text nonsense",
+    "int" => "45", 
+    "exp"   => "123.45e1", 
+    "date"  => "2008-10-26 12:49:45",
+    "array"  => [ "item_1", "45.2", "123e1" ],
+    "nested" => {
+      "int"    => "32", 
+      "string" => "textie"
+    }
+  }.to_struct
+
+  obj.int === 45
+  obj.date.year === 2008
+  obj.array[2] === 1230.0
+
+== INSTALL:
+
+  sudo gem install hashtostruct
+
+or from GitHub:
+
+  sudo gem install openback-hashtostruct
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Timmothy Caraballo
+
+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/Rakefile

@@ -0,0 +1,26 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/hashtostruct'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('hashtostruct', Hashtostruct::VERSION) do |p|
+  p.developer('Timothy Caraballo', 'openback@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:spec]

data/lib/hashtostruct.rb

@@ -0,0 +1,84 @@
+require 'date'
+
+module Hashtostruct
+  VERSION = '0.9.0'
+
+  module StringToObject
+    # Attempt to parse the string into a native Ruby object using standard formats
+    #
+    # It currently looks for and converts:
+    # * integers
+    # * floats
+    # * exponents into floats
+    # * booleans
+    # * DateTimes in the formats:
+    #   * yyyy-mm-dd
+    #   * yyyy-mm-dd hh:mm:ss
+    #   * hh:mm
+    #   * hh:mm:ss
+    #   * hh:mm:ssZ
+    #   * hh:mm:ss.ss
+    #   * hh:mm:ss(+-)hh:mm
+    #   * hh:mm:ss(+-)hhmm
+    #   * hh:mm:ss(+-)hh
+    def to_obj
+      case self
+      when /^(tru|fals)e$/
+        self == 'true'
+      when /^[+-]?\d+$/
+        self.to_i
+      when /^[+-]?\d+\.\d+$/ # floats
+        self.to_f
+      when /^[+-]?\d+(\.\d+)?[eE][+-]?\d+$/  # exponents
+        self.to_f
+      when /^(null|nil)$/
+        nil
+      when /^\d{2}:\d{2}(:\d{2}(\.\d+)?)?Z?$/
+        DateTime.parse(self)
+      when /^\d{2}:\d{2}:\d{2}[+-]\d{2}(:?\d{2})?$/
+        DateTime.parse(self)
+      when /^\d{4}-\d{2}-\d{2}$/
+        DateTime.parse(self)
+      when /^\d{4}-\d{2}-\d{2}[+-]\d{2}(:?\d{2})?$/
+        DateTime.parse(self)
+      when /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/
+        DateTime.parse(self)
+      else
+        self
+      end
+    end
+  end
+
+  module ArrayToObject
+    # iterates through the array, converting each string element to a native
+    # element if possible and returns it
+    def to_obj
+      self.inject([]) do |res,elem|
+        res << if elem.is_a?(String) or elem.is_a?(Array) or elem.is_a?(Hash)
+                 elem.to_obj
+               else
+                 elem
+               end
+      end
+    end
+  end
+
+  module HashToStruct
+    # Takes a Hash and converts it into a Struct with each key as a property 
+    # each value converted into a native object if possible.
+    def to_struct
+      hash = self
+      Struct.new(*(hash.inject([]) { |res,val| res << val[0].to_sym })).new(*(
+        hash.inject([]) { |res,val| res << val[1].to_obj}
+      ))
+    end
+    
+    def to_obj
+      to_struct
+    end
+  end
+    
+  Array.send  :include, ArrayToObject
+  String.send :include, StringToObject
+  Hash.send   :include, HashToStruct
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/hashtostruct.rb'}"
+puts "Loading hashtostruct gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/hashtostruct_spec.rb

@@ -0,0 +1,197 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Hashtostruct do
+  before(:each) do
+    @obj = {
+      "string" => "text nonsense",
+      "int" => "45", 
+      "negative_int" => "-45", 
+      "float" => "45.4",
+      "exp"   => "123.45e1", 
+      "null"  => "null",
+      "nil"   => "nil",
+      "capital_exp" => "123.45E1", 
+      "negative_exp" => "-123.45e-1",
+      "capital_negative_exp" => "-123.45E-1", 
+      "true"   => "true",
+      "false"  => "false", 
+      "date1"  => "2008-10-26 12:49:45",
+      "date2"  => "2008-10-26",
+      "date3"  => "2008-10", 
+      "time1"  => "12:49:45", 
+      "time2"  => "12:49:45Z", 
+      "time3"  => "12:49", 
+      "time4"  => "12:49:45.55", 
+      "time5"  => "12:49:45+03:00", 
+      "time6"  => "12:49:45+0300", 
+      "time7"  => "12:49:45+03",
+      "time8"  => "12:49:45-03:00", 
+      "time9"  => "12:49:45-0300", 
+      "time10" => "12:49:45-03",
+      "array"  => [ "item_1", "45.2", "123e1" ],
+      "nested" => {
+        "int"    => "32", 
+        "string" => "textie"
+      }
+    }.to_struct
+  end
+  
+  it "should add #to_struct to Hash" do
+    Hash.new.should respond_to('to_struct')
+  end
+  
+  it "should create an object with specified properties" do
+    @obj.should respond_to('string')
+    @obj.should respond_to('float')
+  end
+  
+  it "should set the value as a string" do
+    @obj.string.should eql('text nonsense')
+  end
+
+  it "should set the value as an integer" do
+    @obj.int.should eql(45)
+    @obj.negative_int.should eql(-45)
+  end
+
+  it "should set the value as float" do
+    @obj.float.should eql(45.4)
+  end
+
+  it "should set allow exponential values" do
+    @obj.exp.should eql(1234.5)
+    @obj.negative_exp.should eql(-12.345)
+  end
+
+  it "should set allow exponential values with capitals" do
+    @obj.capital_exp.should eql(1234.5)
+    @obj.capital_negative_exp.should eql(-12.345)
+  end
+
+  it "should parse 'yyyy-mm-dd' as Date" do
+    @obj.date2.should be_an_instance_of(DateTime)
+    @obj.date2.year.should  eql(2008)
+    @obj.date2.month.should eql(10)
+    @obj.date2.day.should eql(26)
+  end
+  
+  it "should parse 'yyyy-mm' as Date" do
+    pending("should it default to the 1st of the month?") do
+      @obj.date3.should be_an_instance_of(DateTime)
+      @obj.date3.year.should  eql(2008)
+      @obj.date3.month.should eql(10)
+    end
+  end
+
+  it "should parse 'hh:mm:ss' as Time" do
+    @obj.time1.should be_an_instance_of(DateTime)
+    @obj.time1.hour.should  eql(12)
+    @obj.time1.min.should   eql(49)
+    @obj.time1.sec.should   eql(45)
+  end
+
+  it "should parse 'hh:mm:ssZ' as Time" do
+    @obj.time2.should be_an_instance_of(DateTime)
+    @obj.time2.hour.should  eql(12)
+    @obj.time2.min.should   eql(49)
+    @obj.time2.sec.should   eql(45)
+    @obj.time2.zone.should eql('+00:00')
+  end
+
+  it "should parse 'hh:mm' as Time" do
+    @obj.time3.should be_an_instance_of(DateTime)
+    @obj.time3.hour.should  eql(12)
+    @obj.time3.min.should   eql(49)
+  end
+
+  it "should parse 'hh:mm:ss.ss' as Time" do
+    @obj.time4.should be_an_instance_of(DateTime)
+    @obj.time4.hour.should  eql(12)
+    @obj.time4.min.should   eql(49)
+    @obj.time4.sec.should   eql(45)
+    pending("check fractional part of the second")do
+      @obj.time4.sec_fraction.to_f.should eql(0.55)
+    end
+  end
+
+  it "should parse 'hh:mm:ss+hh:mm' as Time" do
+    @obj.time5.should be_an_instance_of(DateTime)
+    @obj.time5.hour.should  eql(12)
+    @obj.time5.min.should   eql(49)
+    @obj.time5.sec.should   eql(45)
+    @obj.time5.zone.should eql('+03:00')
+  end
+
+  it "should parse 'hh:mm:ss+hhmm' as Time" do
+    @obj.time6.should be_an_instance_of(DateTime)
+    @obj.time6.hour.should  eql(12)
+    @obj.time6.min.should   eql(49)
+    @obj.time6.sec.should   eql(45)
+    @obj.time6.zone.should eql('+03:00')
+  end
+
+  it "should parse 'hh:mm:ss+hh' as Time" do
+    @obj.time7.should be_an_instance_of(DateTime)
+    @obj.time7.hour.should  eql(12)
+    @obj.time7.min.should   eql(49)
+    @obj.time7.sec.should   eql(45)
+    @obj.time7.zone.should eql('+03:00')
+  end
+
+  it "should parse 'hh:mm:ss-hh:mm' as Time" do
+    @obj.time8.should be_an_instance_of(DateTime)
+    @obj.time8.hour.should  eql(12)
+    @obj.time8.min.should   eql(49)
+    @obj.time8.sec.should   eql(45)
+    @obj.time8.zone.should eql('-03:00')
+  end
+
+  it "should parse 'hh:mm:ss-hhmm' as Time" do
+    @obj.time9.should be_an_instance_of(DateTime)
+    @obj.time9.hour.should  eql(12)
+    @obj.time9.min.should   eql(49)
+    @obj.time9.sec.should   eql(45)
+    @obj.time9.zone.should eql('-03:00')
+  end
+
+  it "should parse 'hh:mm:ss-hh' as Time" do
+    @obj.time10.should be_an_instance_of(DateTime)
+    @obj.time10.hour.should  eql(12)
+    @obj.time10.min.should   eql(49)
+    @obj.time10.sec.should   eql(45)
+    @obj.time10.zone.should eql('-03:00')
+  end
+
+  it "should parse 'yyyy-mm-dd hh:mm:ss' as DateTime" do
+    @obj.date1.should be_an_instance_of(DateTime)
+    @obj.date1.year.should  eql(2008)
+    @obj.date1.month.should eql(10)
+    @obj.date1.day.should   eql(26)
+    @obj.date1.hour.should  eql(12)
+    @obj.date1.min.should   eql(49)
+    @obj.date1.sec.should   eql(45)
+    @obj.date1.zone.should eql('+00:00')
+  end
+
+  it "should properly parse booleans" do
+    @obj.true.should eql(true)
+    @obj.false.should eql(false )
+  end
+
+  it "should properly parse null" do
+    @obj.null.should eql(nil)
+    @obj.nil.should  eql(nil)
+  end
+
+  it "should properly handle nested objects" do
+    @obj.nested.should respond_to("string")
+    @obj.nested.string.should eql("textie")
+    @obj.nested.should respond_to("int")
+    @obj.nested.int.should eql(32)
+  end
+
+  it "should properly parse arrays" do
+    @obj.array.should be_an_instance_of(Array)
+    @obj.array.should eql(["item_1", 45.2, 1230.0])
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'hashtostruct'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: hashtostruct
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Timothy Caraballo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-29 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Takes a Hash and converts it into a Struct with each key as a property and each value converted into a native object if possible.
+email: 
+- openback@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/hashtostruct.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/hashtostruct_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/openback/hashtostruct
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: hashtostruct
+rubygems_version: 1.3.0
+signing_key: 
+specification_version: 2
+summary: Takes a Hash and converts it into a Struct with each key as a property and each value converted into a native object if possible.
+test_files: []
+