@@ -8,4 +8,5 @@ log
log/*
*/log/*
coverage
-.DS_Store
\ No newline at end of file
+.DS_Store
+*.pid
\ No newline at end of file
.gitignore
@@ -1,3 +1,5 @@
+require 'base64'
+
class Hash
class << self
# Converts valid XML into a Ruby Hash structure.
@@ -247,13 +249,34 @@ require 'rexml/light/node'
# This represents the hard part of the work, all I did was change the
# underlying parser.
class REXMLUtilityNode # :nodoc:
- attr_accessor :name, :attributes, :children
+ attr_accessor :name, :attributes, :children, :type
+ cattr_accessor :typecasts, :available_typecasts
+
+ self.typecasts = {}
+ self.typecasts["integer"] = lambda{|v| v.nil? ? nil : v.to_i}
+ self.typecasts["boolean"] = lambda{|v| v.nil? ? nil : (v.strip != "false")}
+ self.typecasts["datetime"] = lambda{|v| v.nil? ? nil : Time.parse(v).utc}
+ self.typecasts["date"] = lambda{|v| v.nil? ? nil : Date.parse(v)}
+ self.typecasts["dateTime"] = lambda{|v| v.nil? ? nil : Time.parse(v).utc}
+ self.typecasts["decimal"] = lambda{|v| BigDecimal(v)}
+ self.typecasts["double"] = lambda{|v| v.nil? ? nil : v.to_f}
+ self.typecasts["float"] = lambda{|v| v.nil? ? nil : v.to_f}
+ self.typecasts["symbol"] = lambda{|v| v.to_sym}
+ self.typecasts["string"] = lambda{|v| v.to_s}
+ self.typecasts["yaml"] = lambda{|v| v.nil? ? nil : YAML.load(v)}
+ self.typecasts["base64Binary"] = lambda{|v| Base64.decode64(v)}
+
+ self.available_typecasts = self.typecasts.keys
def initialize(name, attributes = {})
- @name = name.tr("-", "_")
- @attributes = undasherize_keys(attributes)
- @children = []
- @text = false
+ @name = name.tr("-", "_")
+ # leave the type alone if we don't know what it is
+ @type = self.class.available_typecasts.include?(attributes["type"]) ? attributes.delete("type") : attributes["type"]
+
+ @nil_element = attributes.delete("nil") == "true"
+ @attributes = undasherize_keys(attributes)
+ @children = []
+ @text = false
end
def add_node(node)
@@ -262,26 +285,52 @@ class REXMLUtilityNode # :nodoc:
end
def to_hash
+ if @type == "file"
+ f = StringIO.new(::Base64.decode64(@children.first || ""))
+ class << f
+ attr_accessor :original_filename, :content_type
+ end
+ f.original_filename = attributes['name'] || 'untitled'
+ f.content_type = attributes['content_type'] || 'application/octet-stream'
+ return {name => f}
+ end
+
if @text
return { name => typecast_value( translate_xml_entities( inner_html ) ) }
else
#change repeating groups into an array
- # group by the first key of each element of the array to find repeating groups
groups = @children.inject({}) { |s,e| (s[e.name] ||= []) << e; s }
- hash = {}
- groups.each do |key, values|
- if values.size == 1
- hash.merge! values.first
- else
- hash.merge! key => values.map { |element| element.to_hash[key] }
+ out = nil
+ if @type == "array"
+ out = []
+ groups.each do |k, v|
+ if v.size == 1
+ out << v.first.to_hash.entries.first.last
+ else
+ out << v.map{|e| e.to_hash[k]}
+ end
end
+ out = out.flatten
+
+ else # If Hash
+ out = {}
+ groups.each do |k,v|
+ if v.size == 1
+ out.merge!(v.first)
+ else
+ out.merge!( k => v.map{|e| e.to_hash[k]})
+ end
+ end
+ out.merge! attributes unless attributes.empty?
+ out = out.empty? ? nil : out
+ end
+
+ if @type && out.nil?
+ { name => typecast_value(out) }
+ else
+ { name => out }
end
-
- # merge the arrays, including attributes
- hash.merge! attributes unless attributes.empty?
-
- { name => hash }
end
end
@@ -311,15 +360,9 @@ class REXMLUtilityNode # :nodoc:
# If +self+ does not have a "type" key, or if it's not one of the
# options specified above, the raw +value+ will be returned.
def typecast_value(value)
- return value unless attributes["type"]
-
- case attributes["type"]
- when "integer" then value.to_i
- when "boolean" then value.strip == "true"
- when "datetime" then ::Time.parse(value).utc
- when "date" then ::Date.parse(value)
- else value
- end
+ return value unless @type
+ proc = self.class.typecasts[@type]
+ proc.nil? ? value : proc.call(value)
end
# Convert basic XML entities into their literal values.
@@ -357,7 +400,8 @@ class REXMLUtilityNode # :nodoc:
# ==== Returns
# String:: The HTML node in text form.
def to_html
- "<#{name}#{attributes.to_xml_attributes}>#{inner_html}</#{name}>"
+ attributes.merge!(:type => @type ) if @type
+ "<#{name}#{attributes.to_xml_attributes}>#{@nil_element ? '' : inner_html}</#{name}>"
end
# ==== Alias
lib/merb-core/core_ext/hash.rb
@@ -1,5 +1,6 @@
require File.dirname(__FILE__) + '/../../spec_helper'
require "date"
+require 'bigdecimal'
describe Hash, "environmentize_keys!" do
it "should transform keys to uppercase text" do
@@ -145,7 +146,7 @@ describe Hash, "from_xml" do
end
it "should typecast a false boolean" do
- ["false", "1", "0", "some word" ].each do |w|
+ ["false"].each do |w|
Hash.from_xml("<tag type='boolean'>#{w}</tag>")['tag'].should be_false
end
end
@@ -234,6 +235,277 @@ describe Hash, "from_xml" do
Hash.from_xml(xml).should == hash
end
+
+ it "should properly handle nil values (ActiveSupport Compatible)" do
+ topic_xml = <<-EOT
+ <topic>
+ <title></title>
+ <id type="integer"></id>
+ <approved type="boolean"></approved>
+ <written-on type="date"></written-on>
+ <viewed-at type="datetime"></viewed-at>
+ <content type="yaml"></content>
+ <parent-id></parent-id>
+ </topic>
+ EOT
+
+ expected_topic_hash = {
+ 'title' => nil,
+ 'id' => nil,
+ 'approved' => nil,
+ 'written_on' => nil,
+ 'viewed_at' => nil,
+ 'content' => nil,
+ 'parent_id' => nil
+ }
+ Hash.from_xml(topic_xml)["topic"].should == expected_topic_hash
+ end
+
+ it "should handle a single record from xml (ActiveSupport Compatible)" do
+ topic_xml = <<-EOT
+ <topic>
+ <title>The First Topic</title>
+ <author-name>David</author-name>
+ <id type="integer">1</id>
+ <approved type="boolean"> true </approved>
+ <replies-count type="integer">0</replies-count>
+ <replies-close-in type="integer">2592000000</replies-close-in>
+ <written-on type="date">2003-07-16</written-on>
+ <viewed-at type="datetime">2003-07-16T09:28:00+0000</viewed-at>
+ <content type="yaml">--- \n1: should be an integer\n:message: Have a nice day\narray: \n- should-have-dashes: true\n should_have_underscores: true\n</content>
+ <author-email-address>david@loudthinking.com</author-email-address>
+ <parent-id></parent-id>
+ <ad-revenue type="decimal">1.5</ad-revenue>
+ <optimum-viewing-angle type="float">135</optimum-viewing-angle>
+ <resident type="symbol">yes</resident>
+ </topic>
+ EOT
+
+ expected_topic_hash = {
+ 'title' => "The First Topic",
+ 'author_name' => "David",
+ 'id' => 1,
+ 'approved' => true,
+ 'replies_count' => 0,
+ 'replies_close_in' => 2592000000,
+ 'written_on' => Date.new(2003, 7, 16),
+ 'viewed_at' => Time.utc(2003, 7, 16, 9, 28),
+ # Changed this line where the key is :message. The yaml specifies this as a symbol, and who am I to change what you specify
+ # The line in ActiveSupport is
+ # 'content' => { 'message' => "Have a nice day", 1 => "should be an integer", "array" => [{ "should-have-dashes" => true, "should_have_underscores" => true }] },
+ 'content' => { :message => "Have a nice day", 1 => "should be an integer", "array" => [{ "should-have-dashes" => true, "should_have_underscores" => true }] },
+ 'author_email_address' => "david@loudthinking.com",
+ 'parent_id' => nil,
+ 'ad_revenue' => BigDecimal("1.50"),
+ 'optimum_viewing_angle' => 135.0,
+ 'resident' => :yes
+ }
+
+ Hash.from_xml(topic_xml)["topic"].each do |k,v|
+ v.should == expected_topic_hash[k]
+ end
+ end
+
+ it "should handle multiple records (ActiveSupport Compatible)" do
+ topics_xml = <<-EOT
+ <topics type="array">
+ <topic>
+ <title>The First Topic</title>
+ <author-name>David</author-name>
+ <id type="integer">1</id>
+ <approved type="boolean">false</approved>
+ <replies-count type="integer">0</replies-count>
+ <replies-close-in type="integer">2592000000</replies-close-in>
+ <written-on type="date">2003-07-16</written-on>
+ <viewed-at type="datetime">2003-07-16T09:28:00+0000</viewed-at>
+ <content>Have a nice day</content>
+ <author-email-address>david@loudthinking.com</author-email-address>
+ <parent-id nil="true"></parent-id>
+ </topic>
+ <topic>
+ <title>The Second Topic</title>
+ <author-name>Jason</author-name>
+ <id type="integer">1</id>
+ <approved type="boolean">false</approved>
+ <replies-count type="integer">0</replies-count>
+ <replies-close-in type="integer">2592000000</replies-close-in>
+ <written-on type="date">2003-07-16</written-on>
+ <viewed-at type="datetime">2003-07-16T09:28:00+0000</viewed-at>
+ <content>Have a nice day</content>
+ <author-email-address>david@loudthinking.com</author-email-address>
+ <parent-id></parent-id>
+ </topic>
+ </topics>
+ EOT
+
+ expected_topic_hash = {
+ 'title' => "The First Topic",
+ 'author_name' => "David",
+ 'id' => 1,
+ 'approved' => false,
+ 'replies_count' => 0,
+ 'replies_close_in' => 2592000000,
+ 'written_on' => Date.new(2003, 7, 16),
+ 'viewed_at' => Time.utc(2003, 7, 16, 9, 28),
+ 'content' => "Have a nice day",
+ 'author_email_address' => "david@loudthinking.com",
+ 'parent_id' => nil
+ }
+ # puts Hash.from_xml(topics_xml)['topics'].first.inspect
+ Hash.from_xml(topics_xml)["topics"].first.each do |k,v|
+ v.should == expected_topic_hash[k]
+ end
+ end
+
+ it "should handle a single record from_xml with attributes other than type (ActiveSupport Compatible)" do
+ topic_xml = <<-EOT
+ <rsp stat="ok">
+ <photos page="1" pages="1" perpage="100" total="16">
+ <photo id="175756086" owner="55569174@N00" secret="0279bf37a1" server="76" title="Colored Pencil PhotoBooth Fun" ispublic="1" isfriend="0" isfamily="0"/>
+ </photos>
+ </rsp>
+ EOT
+
+ expected_topic_hash = {
+ 'id' => "175756086",
+ 'owner' => "55569174@N00",
+ 'secret' => "0279bf37a1",
+ 'server' => "76",
+ 'title' => "Colored Pencil PhotoBooth Fun",
+ 'ispublic' => "1",
+ 'isfriend' => "0",
+ 'isfamily' => "0",
+ }
+ Hash.from_xml(topic_xml)["rsp"]["photos"]["photo"].each do |k,v|
+ v.should == expected_topic_hash[k]
+ end
+ end
+
+ it "should handle an emtpy array (ActiveSupport Compatible)" do
+ blog_xml = <<-XML
+ <blog>
+ <posts type="array"></posts>
+ </blog>
+ XML
+ expected_blog_hash = {"blog" => {"posts" => []}}
+ Hash.from_xml(blog_xml).should == expected_blog_hash
+ end
+
+ it "should handle empty array with whitespace from xml (ActiveSupport Compatible)" do
+ blog_xml = <<-XML
+ <blog>
+ <posts type="array">
+ </posts>
+ </blog>
+ XML
+ expected_blog_hash = {"blog" => {"posts" => []}}
+ Hash.from_xml(blog_xml).should == expected_blog_hash
+ end
+
+ it "should handle array with one entry from_xml (ActiveSupport Compatible)" do
+ blog_xml = <<-XML
+ <blog>
+ <posts type="array">
+ <post>a post</post>
+ </posts>
+ </blog>
+ XML
+ expected_blog_hash = {"blog" => {"posts" => ["a post"]}}
+ Hash.from_xml(blog_xml).should == expected_blog_hash
+ end
+
+ it "should handle array with multiple entries from xml (ActiveSupport Compatible)" do
+ blog_xml = <<-XML
+ <blog>
+ <posts type="array">
+ <post>a post</post>
+ <post>another post</post>
+ </posts>
+ </blog>
+ XML
+ expected_blog_hash = {"blog" => {"posts" => ["a post", "another post"]}}
+ Hash.from_xml(blog_xml).should == expected_blog_hash
+ end
+
+ it "should handle file types (ActiveSupport Compatible)" do
+ blog_xml = <<-XML
+ <blog>
+ <logo type="file" name="logo.png" content_type="image/png">
+ </logo>
+ </blog>
+ XML
+ hash = Hash.from_xml(blog_xml)
+ hash.should have_key('blog')
+ hash['blog'].should have_key('logo')
+
+ file = hash['blog']['logo']
+ file.original_filename.should == 'logo.png'
+ file.content_type.should == 'image/png'
+ end
+
+ it "should handle file from xml with defaults (ActiveSupport Compatible)" do
+ blog_xml = <<-XML
+ <blog>
+ <logo type="file">
+ </logo>
+ </blog>
+ XML
+ file = Hash.from_xml(blog_xml)['blog']['logo']
+ file.original_filename.should == 'untitled'
+ file.content_type.should == 'application/octet-stream'
+ end
+
+ it "should handle xsd like types from xml (ActiveSupport Compatible)" do
+ bacon_xml = <<-EOT
+ <bacon>
+ <weight type="double">0.5</weight>
+ <price type="decimal">12.50</price>
+ <chunky type="boolean"> 1 </chunky>
+ <expires-at type="dateTime">2007-12-25T12:34:56+0000</expires-at>
+ <notes type="string"></notes>
+ <illustration type="base64Binary">YmFiZS5wbmc=</illustration>
+ </bacon>
+ EOT
+
+ expected_bacon_hash = {
+ 'weight' => 0.5,
+ 'chunky' => true,
+ 'price' => BigDecimal("12.50"),
+ 'expires_at' => Time.utc(2007,12,25,12,34,56),
+ 'notes' => "",
+ 'illustration' => "babe.png"
+ }
+
+ Hash.from_xml(bacon_xml)["bacon"].should == expected_bacon_hash
+ end
+
+ it "should let type trickle through when unknown (ActiveSupport Compatible)" do
+ product_xml = <<-EOT
+ <product>
+ <weight type="double">0.5</weight>
+ <image type="ProductImage"><filename>image.gif</filename></image>
+
+ </product>
+ EOT
+
+ expected_product_hash = {
+ 'weight' => 0.5,
+ 'image' => {'type' => 'ProductImage', 'filename' => 'image.gif' },
+ }
+
+ Hash.from_xml(product_xml)["product"].should == expected_product_hash
+ end
+
+ it "should handle unescaping from xml (ActiveResource Compatible)" do
+ xml_string = '<person><bare-string>First & Last Name</bare-string><pre-escaped-string>First &amp; Last Name</pre-escaped-string></person>'
+ expected_hash = {
+ 'bare_string' => 'First & Last Name',
+ 'pre_escaped_string' => 'First & Last Name'
+ }
+
+ Hash.from_xml(xml_string)['person'].should == expected_hash
+ end
+
end
describe Hash, 'to_params' do
spec/private/core_ext/hash_spec.rb
d4e533e96774982ff117c82bc209e1245be64a49
Daniel Neighman
has.sox@gmail.com
http://github.com/wycats/merb-core/commit/2368f8f95e17f236ce50abdf77b83d7db587abd4
2368f8f95e17f236ce50abdf77b83d7db587abd4
2008-03-06T05:03:45-08:00
2008-03-06T05:03:45-08:00
Adds specs and changes for compatibility with ActiveSupport. There is one caveat. It will not change YAML generated Hash keys to strings if they are defined as symbols as is currently the behaviour of ActiveSupport.
Closes #134
Squashed commit of the following:
commit 03b56a347cc331fdd3d5566bec1904732481e743
Author: Daniel Neighman <has.sox@gmail.com>
Date: Thu Mar 6 23:52:43 2008 +1100
Adds *.pid to the .gitignore file
commit 213c0792398b3c57965b766547e6d2882154185c
Author: Daniel Neighman <has.sox@gmail.com>
Date: Thu Mar 6 23:51:25 2008 +1100
Added all specs from ActiveSupport Hash#from_xml to Merb core_ext Hash#from_xml
commit f5e566a445f44be446ad63ab9e1d995dc46c0ae1
Author: Daniel Neighman <has.sox@gmail.com>
Date: Thu Mar 6 23:38:31 2008 +1100
Adds more active resource compatible specs
commit abc4c1fd3c97720091f8205f30c7929d8dd9db48
Author: Daniel Neighman <has.sox@gmail.com>
Date: Thu Mar 6 22:35:51 2008 +1100
Adds support for nil="true" attribute
commit c3485f018979674d3ef326fb06da9e2d911c0792
Author: Daniel Neighman <has.sox@gmail.com>
Date: Thu Mar 6 22:12:11 2008 +1100
Adds some specs from ActiveSupport for from_xml
commit da7afbf04c4ff3c1ad3fbabcae1c49980eed06c3
Author: Daniel Neighman <has.sox@gmail.com>
Date: Thu Mar 6 20:54:41 2008 +1100
Fixes nil values
424ab87f320a0374bf0ae141c112056992cb7bf3
Daniel Neighman
has.sox@gmail.com