gyoku 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86c09dfdeb5eacb718d25f139c3adfd7ac6689b2
+  data.tar.gz: 1e319e7f75f041a0b4896b2d16985c49a4aa408c
+SHA512:
+  metadata.gz: e81eccda0f368004b95d6a5f6aff630b82d2ac6c677bfa1295cb5eec69a2b41c34a9ff818087a58e77cc20cb4a4ca3397f90e4aa528db97e793f717fa0547c75
+  data.tar.gz: 946a0e3ed65e4eda0b2fb2fef501229cd57f00b548443be5d4d7219ce6d2bfeec04d9b7b6b0d6329386d601d0c1497ddf509ce0e27fbd3587f6bbb84e751fcc0

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - jruby-18mode
   - jruby-19mode
   - rbx-18mode

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.1.0 (2013-07-26)
+
+* Feature: [#30](https://github.com/savonrb/gyoku/pull/30) support for building Arrays
+  of parent tags using @attributes.
+
+* Fix: [#21](https://github.com/savonrb/gyoku/pull/21) stop modifying the original Hash.
+  The original issue is [savonrb/savon#410](https://github.com/savonrb/savon/issues/410).
+
 ## 1.0.0 (2012-12-17)
 
 * Refactoring: Removed the global configuration. This should really only affect the

data/Gemfile

@@ -1,2 +1,5 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
+
+gem 'simplecov', :require => false
+gem 'coveralls', :require => false

data/README.md

@@ -1,25 +1,34 @@
-Gyoku [![Build Status](https://secure.travis-ci.org/rubiii/gyoku.png)](http://travis-ci.org/rubiii/gyoku)
-=====
+# Gyoku
 
-##### Translates Ruby Hashes to XML
-
-Gyoku is available through [Rubygems](http://rubygems.org/gems/gyoku) and can
-be installed via:
+Gyoku translates Ruby Hashes to XML.
 
+``` ruby
+Gyoku.xml(:find_user => { :id => 123, "v1:Key" => "api" })
+# => "<findUser><id>123</id><v1:Key>api</v1:Key></findUser>"
 ```
+
+[![Build Status](https://secure.travis-ci.org/savonrb/gyoku.png?branch=master)](http://travis-ci.org/savonrb/gyoku)
+[![Gem Version](https://badge.fury.io/rb/gyoku.png)](http://badge.fury.io/rb/gyoku)
+[![Code Climate](https://codeclimate.com/github/savonrb/gyoku.png)](https://codeclimate.com/github/savonrb/gyoku)
+[![Coverage Status](https://coveralls.io/repos/savonrb/gyoku/badge.png?branch=master)](https://coveralls.io/r/savonrb/gyoku)
+
+
+## Installation
+
+Gyoku is available through [Rubygems](http://rubygems.org/gems/gyoku) and can be installed via:
+
+``` bash
 $ gem install gyoku
 ```
 
-Gyoku is based on a few conventions.
+or add it to your Gemfile like this:
 
 ``` ruby
-Gyoku.xml(:find_user => { :id => 123, "v1:Key" => "api" })
-# => "<findUser><id>123</id><v1:Key>api</v1:Key></findUser>"
+gem 'gyoku', '~> 1.0'
 ```
 
 
-Hash keys
----------
+## Hash keys
 
 Hash key Symbols are converted to lowerCamelCase Strings.
 
@@ -28,10 +37,11 @@ Gyoku.xml(:lower_camel_case => "key")
 # => "<lowerCamelCase>key</lowerCamelCase>"
 ```
 
-You can change the default conversion formula to :camelcase, :upcase or :none.
+You can change the default conversion formula to `:camelcase`, `:upcase` or `:none`.  
+Note that options are passed as a second Hash to the `.xml` method.
 
 ``` ruby
-Gyoku.xml(:camel_case => "key", :key_converter => :camelcase)
+Gyoku.xml({ :camel_case => "key" }, { :key_converter => :camelcase })
 # => "<CamelCase>key</CamelCase>"
 ```
 
@@ -43,8 +53,7 @@ Gyoku.xml("XML" => "key")
 ```
 
 
-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
@@ -54,8 +63,7 @@ Hash values
 * All other objects are converted to Strings using :to_s
 
 
-Special characters
-------------------
+## Special characters
 
 Gyoku escapes special characters unless the Hash key ends with an exclamation mark.
 
@@ -65,8 +73,7 @@ Gyoku.xml(:escaped => "<tag />", :not_escaped! => "<tag />")
 ```
 
 
-Self-closing tags
------------------
+## Self-closing tags
 
 Hash Keys ending with a forward slash create self-closing tags.
 
@@ -76,10 +83,10 @@ Gyoku.xml(:"self_closing/" => "", "selfClosing/" => nil)
 ```
 
 
-Sort XML tags
--------------
+## 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 the `:order!` key.
 
 ``` ruby
 Gyoku.xml(:name => "Eve", :id => 1, :order! => [:id, :name])
@@ -87,21 +94,21 @@ Gyoku.xml(:name => "Eve", :id => 1, :order! => [:id, :name])
 ```
 
 
-XML attributes
---------------
+## 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 the`:attributes!` key.
 
 ``` ruby
 Gyoku.xml(:person => "Eve", :attributes! => { :person => { :id => 1 } })
 # => "<person id=\"1\">Eve</person>"
 ```
 
-Explicit XML Attributes
------------------------
-In addition to using :attributes!, you may also specify attributes with key names beginning with "@". 
+## Explicit XML Attributes
 
-Since you'll need to set the attribute within the hash containing the node's contents, a :content! key can be used to explicity set the content of the node. The ":content!" value may be a String, Hash, or Array.
+In addition to using the `:attributes!` key, you may also specify attributes through keys beginning with an "@" sign.
+Since you'll need to set the attribute within the hash containing the node's contents, a `:content!` key can be used
+to explicity set the content of the node. The `:content!` value may be a String, Hash, or Array.
 
 This is particularly useful for self-closing tags.
 
@@ -133,17 +140,41 @@ Gyoku.xml(
   })
 # => "<foo baz=\"3\" bar=\"1\" biz=\"2\"/>"
 ```
+
+**Example using "@" to get Array of parent tags each with @attributes & :content!**
+
+``` ruby
+Gyoku.xml(
+  "foo" => [
+    {:@name => "bar", :content! => 'gyoku'}
+    {:@name => "baz", :@some => "attr", :content! => 'rocks!'}
+  ])
+# => "<foo name=\"bar\">gyoku</foo><foo name=\"baz\" some=\"attr\">rocks!</foo>"
+```
+
+Naturally, it would ignore :content! if tag is self-closing:
+
+``` ruby
+Gyoku.xml(
+  "foo/" => [
+    {:@name => "bar", :content! => 'gyoku'}
+    {:@name => "baz", :@some => "attr", :content! => 'rocks!'}
+  ])
+# => "<foo name=\"bar\"/><foo name=\"baz\" some=\"attr\"/>"
+```
+
 This seems a bit more explicit with the attributes rather than having to maintain a hash of attributes.
 
-For backward compatibility, :attributes! will still work. However, "@" keys will override :attributes! keys if there is a conflict.
+For backward compatibility, `:attributes!` will still work. However, "@" keys will override `:attributes!` keys
+if there is a conflict.
 
 ``` ruby
 Gyoku.xml(:person => {:content! => "Adam", :@id! => 0})
 # => "<person id=\"0\">Adam</person>"
 ```
 
-Example with ":content!", :attributes! and "@" keys
---------------------------------------------------
+**Example with ":content!", :attributes! and "@" keys**
+
 ``` ruby
 Gyoku.xml({ 
   :subtitle => { 
@@ -158,4 +189,4 @@ Gyoku.xml({
 The example above shows an example of how you can use all three at the same time. 
 
 Notice that we have the attribute "lang" defined twice.
-The "@lang" value takes precedence over the :attribute![:subtitle]["lang"] value.
+The `@lang` value takes precedence over the `:attribute![:subtitle]["lang"]` value.

data/gyoku.gemspec

@@ -7,11 +7,12 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = "Daniel Harrington"
   s.email       = "me@rubiii.com"
-  s.homepage    = "http://github.com/rubiii/#{s.name}"
-  s.summary     = %q{Converts Ruby Hashes to XML}
-  s.description = %q{Gyoku converts Ruby Hashes to XML}
+  s.homepage    = "https://github.com/savonrb/#{s.name}"
+  s.summary     = "Translates Ruby Hashes to XML"
+  s.description = "Gyoku translates Ruby Hashes to XML"
 
   s.rubyforge_project = "gyoku"
+  s.license = "MIT"
 
   s.add_dependency "builder", ">= 2.1.2"
 

data/lib/gyoku/array.rb

@@ -9,11 +9,17 @@ module Gyoku
     # Translates a given +array+ to XML. Accepts the XML +key+ to add the elements to,
     # whether to +escape_xml+ and an optional Hash of +attributes+.
     def self.to_xml(array, key, escape_xml = true, attributes = {}, options = {})
+      self_closing = options.delete(:self_closing)
       iterate_with_xml array, attributes do |xml, item, attrs, index|
-        case item
-          when ::Hash   then xml.tag!(key, attrs) { xml << Hash.to_xml(item, options) }
-          when NilClass then xml.tag!(key, "xsi:nil" => "true")
-          else               xml.tag!(key, attrs) { xml << XMLValue.create(item, escape_xml) }
+        if self_closing
+          xml.tag!(key, attrs)
+
+        else
+          case item
+            when ::Hash       then xml.tag!(key, attrs) { xml << Hash.to_xml(item, options) }
+            when NilClass     then xml.tag!(key, "xsi:nil" => "true")
+            else              xml.tag!(key, attrs) { xml << XMLValue.create(item, escape_xml) }
+          end
         end
       end
     end
@@ -25,7 +31,16 @@ module Gyoku
     def self.iterate_with_xml(array, attributes)
       xml = Builder::XmlMarkup.new
       array.each_with_index do |item, index|
-        yield xml, item, tag_attributes(attributes, index), index
+        if item.respond_to?(:keys)
+          attrs = item.reduce({}) do |st, v|
+            k = v[0].to_s
+            st[k[1..-1]] = v[1].to_s if k =~ /^@/
+            st
+          end
+        else
+          attrs = {}
+        end
+        yield xml, item, tag_attributes(attributes, index).merge(attrs), index
       end
       xml.target!
     end

data/lib/gyoku/hash.rb

@@ -15,7 +15,8 @@ module Gyoku
         xml_key = XMLKey.create key, options
 
         case
-          when ::Array === value  then xml << Array.to_xml(value, xml_key, escape_xml, attributes, options)
+          when :content! === key  then xml << XMLValue.create(value, escape_xml)
+          when ::Array === value  then xml << Array.to_xml(value, xml_key, escape_xml, attributes, options.merge(:self_closing => self_closing))
           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")
@@ -41,7 +42,7 @@ module Gyoku
         node_attr = attributes[key] || {}
         # node_attr must be kind of ActiveSupport::HashWithIndifferentAccess
         node_attr = ::Hash[node_attr.map { |k,v| [k.to_s, v] }]
-        node_value = hash[key]
+        node_value = hash[key].respond_to?(:keys) ? hash[key].clone : hash[key]
 
         if node_value.respond_to?(:keys)
           explicit_keys = node_value.keys.select{|k| k.to_s =~ /^@/ }
@@ -69,8 +70,8 @@ module Gyoku
       order = hash_without_order.keys unless order.kind_of? ::Array
 
       # Ignore Explicit Attributes
-      orderable = order.delete_if{|k| k =~ /^@/ }
-      hashable = hash_without_order.keys.select{|k| !(k =~ /^@/) }
+      orderable = order.delete_if{|k| k.to_s =~ /^@/ }
+      hashable = hash_without_order.keys.select{|k| !(k.to_s =~ /^@/) }
 
       missing, spurious = hashable - orderable, orderable - hashable
       raise ArgumentError, "Missing elements in :order! #{missing.inspect}" unless missing.empty?

data/lib/gyoku/version.rb

@@ -1,5 +1,5 @@
 module Gyoku
 
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 
 end

data/spec/gyoku/hash_spec.rb

@@ -207,6 +207,50 @@ describe Gyoku::Hash do
       to_xml(hash).should == "<category/>"
     end
 
+    it "recognizes array of attributes" do
+      hash = {
+        "category" => [{:@name => 'one'}, {:@name => 'two'}]
+      }
+      to_xml(hash).should == '<category name="one"></category><category name="two"></category>'
+
+      # issue #31.
+      hash = {
+        :order! => ['foo', 'bar'],
+        'foo' => { :@foo => 'foo' },
+        'bar' => { :@bar => 'bar', 'baz' => { } },
+      }
+      to_xml(hash).should == '<foo foo="foo"></foo><bar bar="bar"><baz></baz></bar>'
+    end
+
+    it "recognizes array of attributes with content in each" do
+      hash = {
+        "foo" => [{:@name => "bar", :content! => 'gyoku'}, {:@name => "baz", :@some => "attr", :content! => 'rocks!'}]
+      }
+
+      [
+        '<foo name="bar">gyoku</foo><foo name="baz" some="attr">rocks!</foo>',
+        '<foo name="bar">gyoku</foo><foo some="attr" name="baz">rocks!</foo>'
+      ].should include to_xml(hash)
+    end
+
+    it "recognizes array of attributes but ignores content in each if selfclosing" do
+      hash = {
+        "foo/" => [{:@name => "bar", :content! => 'gyoku'}, {:@name => "baz", :@some => "attr", :content! => 'rocks!'}]
+      }
+
+      [
+        '<foo name="bar"/><foo name="baz" some="attr"/>',
+        '<foo name="bar"/><foo some="attr" name="baz"/>'
+      ].should include to_xml(hash)
+    end
+
+    it "recognizes array of attributes with selfclosing tag" do
+      hash = {
+        "category/" => [{:@name => 'one'}, {:@name => 'two'}]
+      }
+      to_xml(hash).should == '<category name="one"/><category name="two"/>'
+    end
+
     context "with :element_form_default set to :qualified and a :namespace" do
       it "adds the given :namespace to every element" do
         hash = { :first => { "first_name" => "Lucy" }, ":second" => { :":first_name" => "Anna" }, "v2:third" => { "v2:firstName" => "Danie" } }
@@ -256,6 +300,12 @@ describe Gyoku::Hash do
     end
   end
 
+  it "doesn't modify original hash parameter by deleting its attribute keys" do
+    hash = { :person => {:name => "Johnny", :surname => "Bravo", :"@xsi:type" => "People"} }
+    to_xml(hash)
+    hash.should == {:person=>{:name=>"Johnny", :surname=>"Bravo", :"@xsi:type"=>"People"}}
+  end
+
   def to_xml(hash, options = {})
     Gyoku::Hash.to_xml hash, options
   end

data/spec/spec_helper.rb

@@ -1,2 +1,15 @@
-require "bundler"
-Bundler.require :default, :development
+require 'bundler'
+Bundler.setup(:default, :development)
+
+unless RUBY_PLATFORM =~ /java/
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+end
+
+require 'gyoku'
+require 'rspec'

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: gyoku
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Harrington
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2013-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,12 +48,11 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.10'
-description: Gyoku converts Ruby Hashes to XML
+description: Gyoku translates Ruby Hashes to XML
 email: me@rubiii.com
 executables: []
 extensions: []
@@ -70,7 +63,7 @@ files:
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
-- LICENSE
+- MIT-LICENSE
 - README.md
 - Rakefile
 - gyoku.gemspec
@@ -86,36 +79,30 @@ files:
 - spec/gyoku/xml_value_spec.rb
 - spec/gyoku_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/rubiii/gyoku
-licenses: []
+homepage: https://github.com/savonrb/gyoku
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2627220150066470254
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2627220150066470254
 requirements: []
 rubyforge_project: gyoku
-rubygems_version: 1.8.24
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
-summary: Converts Ruby Hashes to XML
+specification_version: 4
+summary: Translates Ruby Hashes to XML
 test_files:
 - spec/gyoku/array_spec.rb
 - spec/gyoku/hash_spec.rb