gyoku 0.4.4 → 0.4.5

data/.travis.yml

@@ -1,7 +1,11 @@
-script: "rake"
+language: "ruby"
+script: "bundle exec rake"
 rvm:
   - 1.8.7
   - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
   - ree
-  - rbx
-  - jruby

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.4.5 (2012-05-28)
+
+* Fix: [issue 8](https://github.com/rubiii/gyoku/issues/8) -
+  Conflict between camelcase methods in Rails.
+
+* Fix: [pull request 15](https://github.com/rubiii/gyoku/pull/15) -
+  Gyoku generates blank attribute values if there are fewer attribute
+  values in attributes! than elements.
+
+* Fix: [issue 12](https://github.com/rubiii/gyoku/issues/12) -
+  Don't remove special keys from the original Hash.
+
 ## 0.4.4
 
 * Fix: [issue 6](https://github.com/rubiii/gyoku/issues/6) -

data/README.md

@@ -1,34 +1,61 @@
-Gyoku ![http://travis-ci.org/rubiii/gyoku](http://travis-ci.org/rubiii/gyoku.png)
+Gyoku [![Build Status](https://secure.travis-ci.org/rubiii/gyoku.png)](http://travis-ci.org/rubiii/gyoku)
 =====
 
-Gyoku translates Ruby Hashes to XML.
+##### Translates Ruby Hashes to XML
 
-[Bugs](http://github.com/rubiii/gyoku/issues) | [Docs](http://rubydoc.info/gems/gyoku/frames)
+Gyoku is available through [Rubygems](http://rubygems.org/gems/gyoku) and can
+be installed via:
 
-Installation
-------------
+```
+$ gem install gyoku
+```
 
-The gem is available through [Rubygems](http://rubygems.org/gems/gyoku) and can be installed via:
+Gyoku is based on a few conventions.
 
-    $ gem install gyoku
+``` ruby
+Gyoku.xml(:find_user => { :id => 123, "v1:Key" => "api" })
+# => "<findUser><id>123</id><v1:Key>api</v1:Key></findUser>"
+```
 
-An example
-----------
 
-    Gyoku.xml :find_user => { :id => 123, "wsdl:Key" => "api" }
-    # => "<findUser><id>123</id><wsdl:Key>api</wsdl:Key></findUser>"
+Hash keys
+---------
 
-As you might notice, Gyoku follows a couple of conventions for translating Hashes into XML.
+Hash key Symbols are converted to lowerCamelCase Strings.
 
-Conventions
------------
+``` ruby
+Gyoku.xml(:lower_camel_case => "key")
+# => "<lowerCamelCase>key</lowerCamelCase>"
+```
+
+You can change the default conversion formula.
+
+``` ruby
+Gyoku.convert_symbols_to :camelcase  # or one of [:none, :lower_camelcase]
+
+Gyoku.xml(:camel_case => "key")
+# => "<CamelCase>key</CamelCase>"
+```
+
+And you can also define your own formula.
+
+``` ruby
+Gyoku.convert_symbols_to { |key| key.upcase }
+
+Gyoku.xml(:upcase => "key")
+# => "<UPCASE>key</UPCASE>"
+```
+
+Hash key Strings are not converted and may contain namespaces.
 
-### Hash keys
+``` ruby
+Gyoku.xml("XML" => "key")
+# => "<XML>key</XML>"
+```
 
-* Symbols are converted to lowerCamelCase Strings
-* Strings are not converted and may contain namespaces
 
-### Hash values
+Hash values
+-----------
 
 * DateTime objects are converted to xs:dateTime Strings
 * Objects responding to :to_datetime (except Strings) are converted to xs:dateTime Strings
@@ -37,45 +64,46 @@ Conventions
 * These conventions are also applied to the return value of objects responding to :call
 * All other objects are converted to Strings using :to_s
 
-Symbols are converted to lowerCamelCase?
-----------------------------------------
-
-That's the default. But you can use one of the other conversion formulas:
-
-    Gyoku.convert_symbols_to :camelcase  # or one of [:none, :lower_camelcase]
-
-or even define you own one:
-
-    Gyoku.convert_symbols_to { |key| key.upcase }
 
 Special characters
 ------------------
 
-Gyoku escapes special characters unless the Hash key ends with an exclamation mark:
+Gyoku escapes special characters unless the Hash key ends with an exclamation mark.
+
+``` ruby
+Gyoku.xml(:escaped => "<tag />", :not_escaped! => "<tag />")
+# => "<escaped>&lt;tag /&gt;</escaped><notEscaped><tag /></notEscaped>"
+```
 
-    Gyoku.xml :escaped => "<tag />", :not_escaped! => "<tag />"
-    # => "<escaped>&lt;tag /&gt;</escaped><notEscaped><tag /></notEscaped>"
 
 Self-closing tags
 -----------------
 
-Hash Keys ending with a forward slash create self-closing tags:
+Hash Keys ending with a forward slash create self-closing tags.
+
+``` ruby
+Gyoku.xml(:"self_closing/" => "", "selfClosing/" => nil)
+# => "<selfClosing/><selfClosing/>"
+```
 
-    Gyoku.xml :"self_closing/" => "", "selfClosing/" => nil
-    # => "<selfClosing/><selfClosing/>"
 
 Sort XML tags
 -------------
 
-In case you need the XML tags to be in a specific order, you can specify the order through an additional Array stored under an :order! key:
+In case you need the XML tags to be in a specific order, you can specify the order through an additional Array stored under an `:order!` key.
+
+``` ruby
+Gyoku.xml(:name => "Eve", :id => 1, :order! => [:id, :name])
+# => "<id>1</id><name>Eve</name>"
+```
 
-    Gyoku.xml :name => "Eve", :id => 1, :order! => [:id, :name]
-    # => "<id>1</id><name>Eve</name>"
 
 XML attributes
 --------------
 
-Adding XML attributes is rather ugly, but it can be done by specifying an additional Hash stored under an :attributes! key:
+Adding XML attributes is rather ugly, but it can be done by specifying an additional Hash stored under an `:attributes!` key.
 
-    Gyoku.xml :person => "Eve", :attributes! => { :person => { :id => 1 } }
-    # => "<person id=\"1\">Eve</person>"
+``` ruby
+Gyoku.xml(:person => "Eve", :attributes! => { :person => { :id => 1 } })
+# => "<person id=\"1\">Eve</person>"
+```

data/Rakefile

@@ -1,4 +1,5 @@
 require "bundler"
+require "bundler/setup"
 Bundler::GemHelper.install_tasks
 
 require "rspec/core/rake_task"

data/gyoku.gemspec

@@ -15,9 +15,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency "builder", ">= 2.1.2"
 
-  s.add_development_dependency "rspec", "~> 2.4.0"
-  s.add_development_dependency "autotest"
-  s.add_development_dependency "mocha", "~> 0.9.9"
+  s.add_development_dependency "rake",  "~> 0.9"
+  s.add_development_dependency "rspec", "~> 2.10"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/gyoku/array.rb

@@ -37,7 +37,7 @@ module Gyoku
 
       attributes.inject({}) do |hash, (key, value)|
         value = value[index] if value.kind_of? ::Array
-        hash.merge key => value
+        value ? hash.merge(key => value) : hash
       end
     end
 

data/lib/gyoku/hash.rb

@@ -30,9 +30,12 @@ module Gyoku
     # Hash +key+ and any XML +attributes+.
     def self.iterate_with_xml(hash)
       xml = Builder::XmlMarkup.new
-      attributes = hash.delete(:attributes!) || {}
+      attributes = hash[:attributes!] || {}
+      hash_without_attributes = hash.reject { |key, value| key == :attributes! }
 
-      order(hash).each { |key| yield xml, key, hash[key], (attributes[key] || {}) }
+      order(hash_without_attributes).each do |key|
+        yield xml, key, hash_without_attributes[key], (attributes[key] || {})
+      end
 
       xml.target!
     end
@@ -41,10 +44,11 @@ module Gyoku
     # Defaults to return the actual keys of the Hash if no :order! key could be found.
     # Raises an ArgumentError in case the :order! Array does not match the Hash keys.
     def self.order(hash)
-      order = hash.delete :order!
-      order = hash.keys unless order.kind_of? ::Array
+      order = hash[:order!]
+      hash_without_order = hash.reject { |key, value| key == :order! }
+      order = hash_without_order.keys unless order.kind_of? ::Array
 
-      missing, spurious = hash.keys - order, order - hash.keys
+      missing, spurious = hash_without_order.keys - order, order - hash_without_order.keys
       raise ArgumentError, "Missing elements in :order! #{missing.inspect}" unless missing.empty?
       raise ArgumentError, "Spurious elements in :order! #{spurious.inspect}" unless spurious.empty?
 

data/lib/gyoku/version.rb

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

data/lib/gyoku/xml_key.rb

@@ -1,12 +1,13 @@
-require "gyoku/core_ext/string"
-
 module Gyoku
   module XMLKey
     class << self
 
+      CAMELCASE = lambda { |key| key.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } }
+      LOWER_CAMELCASE = lambda { |key| key[0].chr.downcase + CAMELCASE.call(key)[1..-1] }
+
       FORMULAS = {
-        :lower_camelcase => lambda { |key| key.lower_camelcase },
-        :camelcase       => lambda { |key| key.camelcase },
+        :lower_camelcase => lambda { |key| LOWER_CAMELCASE.call(key) },
+        :camelcase       => lambda { |key| CAMELCASE.call(key) },
         :none            => lambda { |key| key }
       }
 

data/spec/gyoku/array_spec.rb

@@ -44,6 +44,13 @@ describe Gyoku::Array do
 
       to_xml(array, "value", :escape_xml, :id => [1, 2]).should == result
     end
+
+    it "skips attribute for element without attributes if there are fewer attributes than elements" do
+      array = ["adam", "eve", "serpent"]
+      result = '<value id="1">adam</value><value id="2">eve</value><value>serpent</value>'
+
+      to_xml(array, "value", :escape_xml, :id => [1, 2]).should == result
+    end
   end
 
   def to_xml(*args)

data/spec/gyoku/hash_spec.rb

@@ -52,10 +52,12 @@ describe Gyoku::Hash do
     end
 
     it "calls to_s on Strings even if they respond to to_datetime" do
-      object = "gorilla"
-      object.expects(:to_datetime).never
+      singleton = "gorilla"
+      def singleton.to_datetime
+        DateTime.new(2012, 03, 22, 16, 22, 33)
+      end
 
-      to_xml(:name => object).should == "<name>gorilla</name>"
+      to_xml(:name => singleton).should == "<name>gorilla</name>"
     end
 
     it "properly serializes nil values" do
@@ -123,6 +125,12 @@ describe Gyoku::Hash do
       to_xml(hash).should == result
     end
 
+    it "skips attribute for element without attributes if there are fewer attributes than elements" do
+      hash = { :find_user => { :person => ["Lucy", "Anna", "Beth"], :attributes! => { :person => { :id => [1, 3] } } } }
+      result = '<findUser><person id="1">Lucy</person><person id="3">Anna</person><person>Beth</person></findUser>'
+      to_xml(hash).should == result
+    end
+
     it "adds attributes to self-closing tags" do
       hash = {
         "category/" => "",
@@ -151,6 +159,34 @@ describe Gyoku::Hash do
         result.should include("<v1:array>", "<v1:first>Lucy</v1:first>", "<v1:second>Anna</v1:second>")
       end
     end
+
+    it "does not remove special keys from the original Hash" do
+      hash = {
+        :persons => {
+          :first => "Lucy",
+          :second => "Anna",
+          :order! => [:second, :first],
+          :attributes! => { :first => { :first => true } }
+        },
+        :countries => [:de, :us],
+        :order! => [:countries, :persons],
+        :attributes! => { :countries => { :array => true } }
+      }
+
+      to_xml(hash)
+
+      hash.should == {
+        :persons => {
+          :first => "Lucy",
+          :second => "Anna",
+          :order! => [:second, :first],
+          :attributes! => { :first => { :first => true } }
+        },
+        :countries => [:de, :us],
+        :order! => [:countries, :persons],
+        :attributes! => { :countries => { :array => true } }
+      }
+    end
   end
 
   def to_xml(hash, options = {})

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gyoku
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 4
-  - 4
-  version: 0.4.4
+  - 5
+  version: 0.4.5
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -15,12 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-15 00:00:00 Z
+date: 2012-05-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: builder
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,54 +29,40 @@ dependencies:
         - 1
         - 2
         version: 2.1.2
+  name: builder
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 25
         segments: 
-        - 2
-        - 4
         - 0
-        version: 2.4.0
+        - 9
+        version: "0.9"
+  name: rake
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: autotest
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id003
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 41
+        hash: 23
         segments: 
-        - 0
-        - 9
-        - 9
-        version: 0.9.9
+        - 2
+        - 10
+        version: "2.10"
+  name: rspec
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  requirement: *id003
 description: Gyoku converts Ruby Hashes to XML
 email: me@rubiii.com
 executables: []
@@ -88,7 +72,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- .gemtest
 - .gitignore
 - .rspec
 - .travis.yml
@@ -100,13 +83,11 @@ files:
 - gyoku.gemspec
 - lib/gyoku.rb
 - lib/gyoku/array.rb
-- lib/gyoku/core_ext/string.rb
 - lib/gyoku/hash.rb
 - lib/gyoku/version.rb
 - lib/gyoku/xml_key.rb
 - lib/gyoku/xml_value.rb
 - spec/gyoku/array_spec.rb
-- spec/gyoku/core_ext/string_spec.rb
 - spec/gyoku/hash_spec.rb
 - spec/gyoku/xml_key_spec.rb
 - spec/gyoku/xml_value_spec.rb
@@ -141,13 +122,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gyoku
-rubygems_version: 1.7.2
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Converts Ruby Hashes to XML
 test_files: 
 - spec/gyoku/array_spec.rb
-- spec/gyoku/core_ext/string_spec.rb
 - spec/gyoku/hash_spec.rb
 - spec/gyoku/xml_key_spec.rb
 - spec/gyoku/xml_value_spec.rb

data/lib/gyoku/core_ext/string.rb

@@ -1,19 +0,0 @@
-module Gyoku
-  module CoreExt
-    module String
-
-      # Returns the String in lowerCamelCase.
-      def lower_camelcase
-        self[0].chr.downcase + self.camelcase[1..-1]
-      end
-
-      # Returns the String in CamelCase.
-      def camelcase
-        self.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
-      end
-
-    end
-  end
-end
-
-String.send :include, Gyoku::CoreExt::String

data/spec/gyoku/core_ext/string_spec.rb

@@ -1,17 +0,0 @@
-require "spec_helper"
-
-describe String do
-
-  describe "#lower_camelcase" do
-    it "converts a snakecase String to lowerCamelCase" do
-      "lower_camel_case".lower_camelcase.should == "lowerCamelCase"
-    end
-  end
-
-  describe "#camelcase" do
-    it "converts a snakecase String to CamelCase" do
-      "camel_case".camelcase.should == "CamelCase"
-    end
-  end
-
-end