gyoku 0.2.0 → 0.3.0

data/README.md

@@ -25,6 +25,7 @@ Conventions
 
 * Hash key Symbols are converted to lowerCamelCase Strings
 * Hash key Strings are not converted and may contain namespaces
+* Hash keys ending with a forward slash create self-closing tags
 * DateTime values are converted to xs:dateTime Strings
 * Objects responding to :to_datetime (except Strings) are converted to xs:dateTime Strings
 * TrueClass and FalseClass objects are converted to "true" and "false" Strings

data/lib/gyoku.rb

@@ -3,12 +3,9 @@ require "gyoku/hash"
 
 module Gyoku
 
-  def self.xml(object)
-    case object
-      when ::Hash  then Hash.to_xml object
-      when ::Array then Array.to_xml object
-      else              raise ArgumentError, "Expected kind_of Array || Hash"
-    end
+  # Translates a given +hash+ with +options+ to XML.
+  def self.xml(hash, options = {})
+    Hash.to_xml hash, options
   end
 
 end

data/lib/gyoku/array.rb

@@ -37,7 +37,7 @@ module Gyoku
     # for duplicate tags.
     def self.tag_attributes(attributes, index)
       return {} if attributes.empty?
-      
+
       attributes.inject({}) do |hash, (key, value)|
         value = value[index] if value.kind_of? ::Array
         hash.merge key => value

data/lib/gyoku/hash.rb

@@ -9,21 +9,19 @@ module Gyoku
     extend XMLKey
     extend XMLValue
 
-    # Translates a given +hash+ to XML.
-    def self.to_xml(hash)
-      iterate_with_xml hash do |xml, key, attributes|
-        attrs = attributes[key] || {}
-        value = hash[key]
+    # Translates a given +hash+ with +options+ to XML.
+    def self.to_xml(hash, options = {})
+      iterate_with_xml hash do |xml, key, value, attributes|
         self_closing = key.to_s[-1, 1] == "/"
         escape_xml = key.to_s[-1, 1] != "!"
-        key = to_xml_key(key)
-        
+        xml_key = to_xml_key key, options
+
         case
-          when ::Array === value  then xml << Array.to_xml(value, key, escape_xml, attrs)
-          when ::Hash === value   then xml.tag!(key, attrs) { xml << Hash.to_xml(value) }
-          when self_closing       then xml.tag!(key, attrs)
-          when NilClass === value then xml.tag!(key, "xsi:nil" => "true")
-          else                         xml.tag!(key, attrs) { xml << to_xml_value(value, escape_xml) }
+          when ::Array === value  then xml << Array.to_xml(value, xml_key, escape_xml, attributes)
+          when ::Hash === value   then xml.tag!(xml_key, attributes) { xml << Hash.to_xml(value, options) }
+          when self_closing       then xml.tag!(xml_key, attributes)
+          when NilClass === value then xml.tag!(xml_key, "xsi:nil" => "true")
+          else                         xml.tag!(xml_key, attributes) { xml << to_xml_value(value, escape_xml) }
         end
       end
     end
@@ -35,9 +33,9 @@ module Gyoku
     def self.iterate_with_xml(hash)
       xml = Builder::XmlMarkup.new
       attributes = hash.delete(:attributes!) || {}
-      
-      order(hash).each { |key| yield xml, key, attributes }
-      
+
+      order(hash).each { |key| yield xml, key, hash[key], (attributes[key] || {}) }
+
       xml.target!
     end
 
@@ -47,11 +45,11 @@ module Gyoku
     def self.order(hash)
       order = hash.delete :order!
       order = hash.keys unless order.kind_of? ::Array
-      
+
       missing, spurious = hash.keys - order, order - hash.keys
       raise ArgumentError, "Missing elements in :order! #{missing.inspect}" unless missing.empty?
       raise ArgumentError, "Spurious elements in :order! #{spurious.inspect}" unless spurious.empty?
-      
+
       order
     end
 

data/lib/gyoku/version.rb

@@ -1,5 +1,5 @@
 module Gyoku
 
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 
 end

data/lib/gyoku/xml_key.rb

@@ -3,11 +3,19 @@ require "gyoku/core_ext/string"
 module Gyoku
   module XMLKey
 
-    # Converts a given +object+ to an XML key.
-    def to_xml_key(key)
+    # Converts a given +object+ with +options+ to an XML key.
+    def to_xml_key(key, options = {})
+      xml_key = chop_special_characters key.to_s
+
+      if unqualify?(xml_key)
+        xml_key = xml_key.split(":").last
+      elsif qualify?(options) && !xml_key.include?(":")
+        xml_key = "#{options[:namespace]}:#{xml_key}"
+      end
+
       case key
-        when Symbol then chop_special_characters(key.to_s).lower_camelcase
-        else             chop_special_characters(key.to_s)
+        when Symbol then xml_key.lower_camelcase
+        else             xml_key
       end
     end
 
@@ -18,5 +26,15 @@ module Gyoku
       ["!", "/"].include?(string[-1, 1]) ? string.chop : string
     end
 
+    # Returns whether to remove the namespace from a given +key+.
+    def unqualify?(key)
+      key[0, 1] == ":"
+    end
+
+    # Returns whether to namespace all keys (elementFormDefault).
+    def qualify?(options)
+      options[:element_form_default] == :qualified && options[:namespace]
+    end
+
   end
 end

data/spec/gyoku/hash_spec.rb

@@ -47,14 +47,14 @@ describe Gyoku::Hash do
       def singleton.to_datetime
         DateTime.new(2012, 03, 22, 16, 22, 33)
       end
-      
+
       to_xml(:before => singleton).should == "<before>2012-03-22T16:22:33+00:00</before>"
     end
 
     it "should call to_s on Strings even if they respond to to_datetime" do
       object = "gorilla"
       object.expects(:to_datetime).never
-      
+
       to_xml(:name => object).should == "<name>gorilla</name>"
     end
 
@@ -115,15 +115,28 @@ describe Gyoku::Hash do
       hash = { :find_user => { :person => ["Lucy", "Anna"], :attributes! => { :person => { :id => [1, 3] } } } }
       result = '<findUser><person id="1">Lucy</person><person id="3">Anna</person></findUser>'
       to_xml(hash).should == result
-      
+
       hash = { :find_user => { :person => ["Lucy", "Anna"], :attributes! => { :person => { :active => "true" } } } }
       result = '<findUser><person active="true">Lucy</person><person active="true">Anna</person></findUser>'
       to_xml(hash).should == result
     end
+
+    context "with :element_form_default set to :qualified and a :namespace" do
+      it "should add the given :namespace to every element" do
+        hash = { :first => { "first_name" => "Luvy" }, ":second" => { :":first_name" => "Anna" }, "v2:third" => { "v2:firstName" => "Danie" } }
+        result = to_xml hash, :element_form_default => :qualified, :namespace => :v1
+
+        result.should include(
+          "<v1:first><v1:first_name>Luvy</v1:first_name></v1:first>",
+          "<second><firstName>Anna</firstName></second>",
+          "<v2:third><v2:firstName>Danie</v2:firstName></v2:third>"
+        )
+      end
+    end
   end
 
-  def to_xml(hash)
-    Gyoku::Hash.to_xml hash
+  def to_xml(hash, options = {})
+    Gyoku::Hash.to_xml hash, options
   end
 
 end

data/spec/gyoku/xml_key_spec.rb

@@ -20,6 +20,18 @@ describe Gyoku::XMLKey do
       to_xml_key(:lower_camel_case).should == "lowerCamelCase"
       to_xml_key(:lower_camel_case!).should == "lowerCamelCase"
     end
+
+    context "with :element_form_default set to :qualified and a :namespace" do
+      it "should add the given namespace" do
+        key = to_xml_key :qualify, :element_form_default => :qualified, :namespace => :v1
+        key.should == "v1:qualify"
+      end
+
+      it "should not add the given namespace if the key starts with a colon" do
+        key = to_xml_key ":qualify", :element_form_default => :qualified, :namespace => :v1
+        key.should == "qualify"
+      end
+    end
   end
 
 end

data/spec/gyoku_spec.rb

@@ -4,13 +4,8 @@ describe Gyoku do
 
   describe ".xml" do
     it "should translate a given Hash to XML" do
-      Gyoku::Hash.expects(:to_xml).with(:id => 1)
-      Gyoku.xml :id => 1
-    end
-
-    it "should translate a given Array to XML" do
-      Gyoku::Array.expects(:to_xml).with([1, 2, 3])
-      Gyoku.xml [1, 2, 3]
+      Gyoku::Hash.expects(:to_xml).with({:id => 1}, :element_form_default => :qualified)
+      Gyoku.xml({ :id => 1 }, :element_form_default => :qualified)
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gyoku
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-08 00:00:00 +01:00
+date: 2011-01-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency