gyoku 0.4.3 → 0.4.4

data/.travis.yml

@@ -0,0 +1,7 @@
+script: "rake"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - rbx
+  - jruby

data/CHANGELOG.md

@@ -0,0 +1,55 @@
+## 0.4.4
+
+* Fix: [issue 6](https://github.com/rubiii/gyoku/issues/6) -
+  `Gyoku.xml` does not modify the original Hash.
+
+## 0.4.3
+
+* Fix: Make sure `require "date"` when necessary.
+
+## 0.4.2
+
+* Fix: `Array.to_xml` so that the given :namespace is applied to every element
+  in an Array.
+
+## 0.4.1
+
+* Fix: Alternative formulas and namespaces.
+
+## 0.4.0
+
+* Feature: Added alternative Symbol conversion formulas. You can choose between
+  :lower_camelcase (the default), :camelcase and :none.
+
+      Gyoku.convert_symbols_to :camelcase
+
+  You can even define your own formula:
+
+      Gyoku.convert_symbols_to { |key| key.upcase }
+
+## 0.3.1
+
+* Feature: Gyoku now calls Proc objects and converts their return value.
+
+## 0.3.0
+
+* Feature: Now when all Hash keys need to be namespaced (like with
+  elementFormDefault), you can use options to to trigger this behavior.
+
+      Gyoku.xml hash,
+        :element_form_default => :qualified,
+        :namespace => :v2
+
+## 0.2.0
+
+* Feature: Added support for self-closing tags. Hash keys ending with a forward
+  slash (regardless of their value) are now converted to self-closing tags.
+
+## 0.1.1
+
+* Fix: Allow people to use new versions of builder.
+
+## 0.1.0
+
+* Initial version. Gyoku was born as a core extension inside the
+  [Savon](http://rubygems.org/gems/savon) library.

data/README.md

@@ -1,4 +1,4 @@
-Gyoku
+Gyoku ![http://travis-ci.org/rubiii/gyoku](http://travis-ci.org/rubiii/gyoku.png)
 =====
 
 Gyoku translates Ruby Hashes to XML.

data/Rakefile

@@ -1,42 +1,10 @@
 require "bundler"
 Bundler::GemHelper.install_tasks
 
-begin
-  require "yard"
+require "rspec/core/rake_task"
 
-  YARD::Rake::YardocTask.new do |t|
-    t.files = ["README.md", "lib/**/*.rb"]
-  end
-rescue LoadError
-  desc message = %{"gem install yard" to generate documentation}
-  task("yard") { abort message }
-end
-
-begin
-  require "metric_fu"
-
-  MetricFu::Configuration.run do |c|
-    c.metrics = [:churn, :flog, :flay, :reek, :roodi, :saikuro] # :rcov seems to be broken
-    c.graphs = [:flog, :flay, :reek, :roodi]
-    c.flay = { :dirs_to_flay => ["lib"], :minimum_score => 20 }
-    c.rcov[:rcov_opts] << "-Ilib -Ispec"
-  end
-rescue LoadError
-  desc message = %{"gem install metric_fu" to generate metrics}
-  task("metrics:all") { abort message }
-end
-
-begin
-  require "rspec/core/rake_task"
-
-  RSpec::Core::RakeTask.new do |t|
-    t.pattern = "spec/**/*_spec.rb"
-    t.rspec_opts = %w(-fd -c)
-  end
-rescue LoadError
-  task :spec do
-    abort "Run 'gem install rspec' to be able to run specs"
-  end
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(-c)
 end
 
 task :default => :spec

data/lib/gyoku.rb

@@ -6,7 +6,7 @@ module Gyoku
 
     # Translates a given +hash+ with +options+ to XML.
     def xml(hash, options = {})
-      Hash.to_xml hash, options
+      Hash.to_xml hash.dup, options
     end
 
     # Yields this object for configuration.

data/lib/gyoku/version.rb

@@ -1,5 +1,5 @@
 module Gyoku
 
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 
 end

data/spec/gyoku/array_spec.rb

@@ -3,45 +3,45 @@ require "spec_helper"
 describe Gyoku::Array do
 
   describe ".to_xml" do
-    it "should return the XML for an Array of Hashes" do
+    it "returns the XML for an Array of Hashes" do
       array = [{ :name => "adam" }, { :name => "eve" }]
       result = "<user><name>adam</name></user><user><name>eve</name></user>"
-      
+
       to_xml(array, "user").should == result
     end
 
-    it "should return the XML for an Array of different Objects" do
+    it "returns the XML for an Array of different Objects" do
       array = [:symbol, "string", 123]
       result = "<value>symbol</value><value>string</value><value>123</value>"
-      
+
       to_xml(array, "value").should == result
     end
 
-    it "should default to escape special characters" do
+    it "defaults to escape special characters" do
       array = ["<tag />", "adam & eve"]
       result = "<value>&lt;tag /&gt;</value><value>adam &amp; eve</value>"
-      
+
       to_xml(array, "value").should == result
     end
 
-    it "should not escape special characters when told to" do
+    it "does not escape special characters when told to" do
       array = ["<tag />", "adam & eve"]
       result = "<value><tag /></value><value>adam & eve</value>"
-      
+
       to_xml(array, "value", false).should == result
     end
 
-    it "should add attributes to a given tag" do
+    it "adds attributes to a given tag" do
       array = ["adam", "eve"]
       result = '<value active="true">adam</value><value active="true">eve</value>'
-      
+
       to_xml(array, "value", :escape_xml, :active => true).should == result
     end
 
-    it "should add attributes to duplicate tags" do
+    it "adds attributes to duplicate tags" do
       array = ["adam", "eve"]
       result = '<value id="1">adam</value><value id="2">eve</value>'
-      
+
       to_xml(array, "value", :escape_xml, :id => [1, 2]).should == result
     end
   end

data/spec/gyoku/hash_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Gyoku::Hash do
 
   describe ".to_xml" do
-    describe "should return SOAP request compatible XML" do
+    describe "returns SOAP request compatible XML" do
       it "for a simple Hash" do
         to_xml(:some => "user").should == "<some>user</some>"
       end
@@ -29,20 +29,20 @@ describe Gyoku::Hash do
       end
     end
 
-    it "should convert Hash key Symbols to lowerCamelCase" do
+    it "converts Hash key Symbols to lowerCamelCase" do
       to_xml(:find_or_create => "user").should == "<findOrCreate>user</findOrCreate>"
     end
 
-    it "should not convert Hash key Strings" do
+    it "does not convert Hash key Strings" do
       to_xml("find_or_create" => "user").should == "<find_or_create>user</find_or_create>"
     end
 
-    it "should convert DateTime objects to xs:dateTime compliant Strings" do
+    it "converts DateTime objects to xs:dateTime compliant Strings" do
       to_xml(:before => DateTime.new(2012, 03, 22, 16, 22, 33)).
         should == "<before>2012-03-22T16:22:33+00:00</before>"
     end
 
-    it "should convert Objects responding to to_datetime to xs:dateTime compliant Strings" do
+    it "converts Objects responding to to_datetime to xs:dateTime compliant Strings" do
       singleton = Object.new
       def singleton.to_datetime
         DateTime.new(2012, 03, 22, 16, 22, 33)
@@ -51,40 +51,40 @@ describe Gyoku::Hash do
       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
+    it "calls 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
 
-    it "should properly serialize nil values" do
+    it "properly serializes nil values" do
       to_xml(:some => nil).should == '<some xsi:nil="true"/>'
     end
 
-    it "should create self-closing tags for Hash keys ending with a forward slash" do
+    it "creates self-closing tags for Hash keys ending with a forward slash" do
       to_xml("self-closing/" => nil).should == '<self-closing/>'
     end
 
-    it "should call to_s on any other Object" do
+    it "calls to_s on any other Object" do
       [666, true, false].each do |object|
         to_xml(:some => object).should == "<some>#{object}</some>"
       end
     end
 
-    it "should default to escape special characters" do
+    it "defaults to escape special characters" do
       result = to_xml(:some => { :nested => "<tag />" }, :tag => "<tag />")
       result.should include("<tag>&lt;tag /&gt;</tag>")
       result.should include("<some><nested>&lt;tag /&gt;</nested></some>")
     end
 
-    it "should not escape special characters for keys marked with an exclamation mark" do
+    it "does not escape special characters for keys marked with an exclamation mark" do
       result = to_xml(:some => { :nested! => "<tag />" }, :tag! => "<tag />")
       result.should include("<tag><tag /></tag>")
       result.should include("<some><nested><tag /></nested></some>")
     end
 
-    it "should preserve the order of Hash keys and values specified through :order!" do
+    it "preserves the order of Hash keys and values specified through :order!" do
       hash = { :find_user => { :name => "Lucy", :id => 666, :order! => [:id, :name] } }
       result = "<findUser><id>666</id><name>Lucy</name></findUser>"
       to_xml(hash).should == result
@@ -94,15 +94,17 @@ describe Gyoku::Hash do
       to_xml(hash).should == result
     end
 
-    it "should raise an error if the :order! Array does not match the Hash keys" do
+    it "raises if the :order! Array is missing Hash keys" do
       hash = { :name => "Lucy", :id => 666, :order! => [:name] }
-      lambda { to_xml(hash) }.should raise_error(ArgumentError)
+      lambda { to_xml(hash) }.should raise_error(ArgumentError, "Missing elements in :order! [:id]")
+    end
 
-      hash = { :by_name => { :name => "Lucy", :lname => "Sky", :order! => [:mname, :name] } }
-      lambda { to_xml(hash) }.should raise_error(ArgumentError)
+    it "raises if the :order! Array contains missing Hash keys" do
+      hash = { :by_name => { :first_name => "Lucy", :last_name => "Sky", :order! => [:first_name, :middle_name, :last_name] } }
+      lambda { to_xml(hash) }.should raise_error(ArgumentError, "Spurious elements in :order! [:middle_name]")
     end
 
-    it "should add attributes to Hash keys specified through :attributes!" do
+    it "adds attributes to Hash keys specified through :attributes!" do
       hash = { :find_user => { :person => "Lucy", :attributes! => { :person => { :id => 666 } } } }
       result = '<findUser><person id="666">Lucy</person></findUser>'
       to_xml(hash).should == result
@@ -111,7 +113,7 @@ describe Gyoku::Hash do
       to_xml(hash).should include('id="666"', 'city="Hamburg"')
     end
 
-    it "should add attributes to duplicate Hash keys specified through :attributes!" do
+    it "adds attributes to duplicate Hash keys specified through :attributes!" 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
@@ -121,25 +123,33 @@ describe Gyoku::Hash do
       to_xml(hash).should == result
     end
 
+    it "adds attributes to self-closing tags" do
+      hash = {
+        "category/" => "",
+        :attributes! => { "category/" => { :id => 1 }  }
+      }
+
+      to_xml(hash).should == '<category id="1"/>'
+    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" } }
+      it "adds the given :namespace to every element" do
+        hash = { :first => { "first_name" => "Lucy" }, ":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>",
+          "<v1:first><v1:first_name>Lucy</v1:first_name></v1:first>",
           "<second><firstName>Anna</firstName></second>",
           "<v2:third><v2:firstName>Danie</v2:firstName></v2:third>"
         )
       end
 
-      it "should add given :namespace to every element in an array" do
-        hash = { :array => [ :first  => "Luvy", :second => "Anna" ]}
+      it "adds given :namespace to every element in an array" do
+        hash = { :array => [ :first  => "Lucy", :second => "Anna" ]}
         result = to_xml hash, :element_form_default => :qualified, :namespace => :v1
 
-        result.should include("<v1:array>", "<v1:first>Luvy</v1:first>", "<v1:second>Anna</v1:second>")
+        result.should include("<v1:array>", "<v1:first>Lucy</v1:first>", "<v1:second>Anna</v1:second>")
       end
-
     end
   end
 

data/spec/gyoku/xml_key_spec.rb

@@ -3,35 +3,35 @@ require "spec_helper"
 describe Gyoku::XMLKey do
 
   describe ".create" do
-    it "should remove exclamation marks from the end of a String" do
+    it "removes exclamation marks from the end of a String" do
       create("value!").should == "value"
     end
 
-    it "should remove forward slashes from the end of a String" do
+    it "removes forward slashes from the end of a String" do
       create("self-closing/").should == "self-closing"
     end
 
-    it "should not convert snake_case Strings" do
+    it "does not convert snake_case Strings" do
       create("lower_camel_case").should == "lower_camel_case"
     end
 
-    it "should convert snake_case Symbols to lowerCamelCase Strings" do
+    it "converts snake_case Symbols to lowerCamelCase Strings" do
       create(:lower_camel_case).should == "lowerCamelCase"
       create(: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
+      it "adds the given namespace" do
         key = create :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
+      it "does not add the given namespace if the key starts with a colon" do
         key = create ":qualify", :element_form_default => :qualified, :namespace => :v1
         key.should == "qualify"
       end
 
-      it "should add a given :namespace after converting the key" do
+      it "adds a given :namespace after converting the key" do
         Gyoku::XMLKey.symbol_converter = :camelcase
 
         key = create :username, :element_form_default => :qualified, :namespace => :v1
@@ -45,26 +45,26 @@ describe Gyoku::XMLKey do
   describe ".symbol_converter" do
     after { Gyoku::XMLKey.symbol_converter = :lower_camelcase }  #reset
 
-    it "should return the default lower_camelcase converter" do
+    it "returns the default lower_camelcase converter" do
       Gyoku::XMLKey.symbol_converter.call("snake_case").should == "snakeCase"
     end
 
-    it "should accept :lower_camelcase" do
+    it "accepts :lower_camelcase" do
       Gyoku::XMLKey.symbol_converter = :lower_camelcase
       Gyoku::XMLKey.create(:snake_case).should == "snakeCase"
     end
 
-    it "should accept :camelcase" do
+    it "accepts :camelcase" do
       Gyoku::XMLKey.symbol_converter = :camelcase
       Gyoku::XMLKey.create(:snake_case).should == "SnakeCase"
     end
 
-    it "should accept :none" do
+    it "accepts :none" do
       Gyoku::XMLKey.symbol_converter = :none
       Gyoku::XMLKey.create(:snake_Case).should == "snake_Case"
     end
 
-    it "should allow to set a custom converter" do
+    it "allows to set a custom converter" do
       Gyoku::XMLKey.symbol_converter = Proc.new { |key| key.upcase }
       Gyoku::XMLKey.create(:snake_case).should == "SNAKE_CASE"
     end

data/spec/gyoku/xml_value_spec.rb

@@ -7,23 +7,23 @@ describe Gyoku::XMLValue do
 
   describe ".create" do
     context "for DateTime objects" do
-      it "should return an xs:dateTime compliant String" do
+      it "returns an xs:dateTime compliant String" do
         create(datetime).should == datetime_string
       end
     end
 
-    it "should return the String value and escape special characters" do
+    it "returns the String value and escapes special characters" do
       create("string").should == "string"
       create("<tag>").should == "&lt;tag&gt;"
       create("at&t").should == "at&amp;t"
       create('"quotes"').should == "&quot;quotes&quot;"
     end
 
-    it "should just return the String value without escaping special characters" do
+    it "returns the String value without escaping special characters" do
       create("<tag>", false).should == "<tag>"
     end
 
-    it "should return an xs:dateTime compliant String for Objects responding to #to_datetime" do
+    it "returns an xs:dateTime compliant String for Objects responding to #to_datetime" do
       singleton = Object.new
       def singleton.to_datetime
         DateTime.new 2012, 03, 22, 16, 22, 33
@@ -32,12 +32,12 @@ describe Gyoku::XMLValue do
       create(singleton).should == "2012-03-22T16:22:33+00:00"
     end
 
-    it "should #call Proc objects and convert their return value" do
+    it "calls Proc objects and converts their return value" do
       object = lambda { DateTime.new 2012, 03, 22, 16, 22, 33 }
       create(object).should == "2012-03-22T16:22:33+00:00"
     end
 
-    it "should call #to_s unless the Object responds to #to_datetime" do
+    it "calls #to_s unless the Object responds to #to_datetime" do
       create("value").should == "value"
     end
   end

data/spec/gyoku_spec.rb

@@ -3,14 +3,28 @@ require "spec_helper"
 describe Gyoku do
 
   describe ".xml" do
-    it "should translate a given Hash to XML" do
-      Gyoku::Hash.expects(:to_xml).with({:id => 1}, :element_form_default => :qualified)
-      Gyoku.xml({ :id => 1 }, :element_form_default => :qualified)
+    it "translates a given Hash to XML" do
+      Gyoku.xml({ :id => 1 }, :element_form_default => :qualified).should == "<id>1</id>"
+    end
+
+    it "does not modify the original Hash" do
+      hash = {
+        :person => {
+          :first_name => "Lucy",
+          :last_name => "Sky",
+          :order! => [:first_name, :last_name]
+        },
+        :attributes! => { :person => { :id => "666" } }
+      }
+      original_hash = hash.dup
+
+      Gyoku.xml(hash)
+      original_hash.should == hash
     end
   end
 
   describe ".configure" do
-    it "should yield the Gyoku module" do
+    it "yields the Gyoku module" do
       Gyoku.configure { |config| config.should respond_to(:convert_symbols_to) }
     end
   end
@@ -18,12 +32,12 @@ describe Gyoku do
   describe ".convert_symbols_to" do
     after { Gyoku.convert_symbols_to(:lower_camelcase) }  # reset
 
-    it "should accept a predefined formula" do
+    it "accepts a predefined formula" do
       Gyoku.convert_symbols_to(:camelcase)
       Gyoku::XMLKey.create(:snake_case).should == "SnakeCase"
     end
 
-    it "should accept a block" do
+    it "accepts a block" do
       Gyoku.convert_symbols_to { |key| key.upcase }
       Gyoku::XMLKey.create(:snake_case).should == "SNAKE_CASE"
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gyoku
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 4
-  - 3
-  version: 0.4.3
+  - 4
+  version: 0.4.4
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-04 00:00:00 +02:00
-default_executable: 
+date: 2011-05-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder
@@ -92,6 +91,8 @@ files:
 - .gemtest
 - .gitignore
 - .rspec
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -111,7 +112,6 @@ files:
 - spec/gyoku/xml_value_spec.rb
 - spec/gyoku_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/rubiii/gyoku
 licenses: []
 
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gyoku
-rubygems_version: 1.4.1
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Converts Ruby Hashes to XML