gyoku 0.4.6 → 0.5.0

data/.gitignore

@@ -4,6 +4,7 @@ doc
 coverage
 tmp
 *~
+*.swp
 *.gem
 .bundle
-Gemfile.lock
+Gemfile.lock

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.5.0 (2012-12-15)
+
+Feature: [#19](https://github.com/savonrb/gyoku/pull/19) adds support for explicit XML attributes.
+
+Feature: [#17](https://github.com/savonrb/gyoku/pull/17) adds an `:upcase` formula.
+
 ## 0.4.6 (2012-06-28)
 
 * Fix: [#16](https://github.com/rubiii/gyoku/issues/16) Date objects were mapped like DateTime objects.

data/README.md

@@ -31,7 +31,7 @@ Gyoku.xml(:lower_camel_case => "key")
 You can change the default conversion formula.
 
 ``` ruby
-Gyoku.convert_symbols_to :camelcase  # or one of [:none, :lower_camelcase]
+Gyoku.convert_symbols_to :camelcase  # or one of [:none, :lower_camelcase, :upcase]
 
 Gyoku.xml(:camel_case => "key")
 # => "<CamelCase>key</CamelCase>"
@@ -40,10 +40,10 @@ Gyoku.xml(:camel_case => "key")
 And you can also define your own formula.
 
 ``` ruby
-Gyoku.convert_symbols_to { |key| key.upcase }
+Gyoku.convert_symbols_to { |key| key.sub(/^prefixed_/, '') }
 
-Gyoku.xml(:upcase => "key")
-# => "<UPCASE>key</UPCASE>"
+Gyoku.xml(:prefixed_attribute => "key")
+# => "<attribute>key</attribute>"
 ```
 
 Hash key Strings are not converted and may contain namespaces.
@@ -107,3 +107,66 @@ Adding XML attributes is rather ugly, but it can be done by specifying an additi
 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 "@". 
+
+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.
+
+**Using :attributes!**
+
+``` ruby
+Gyoku.xml(
+  "foo/" => "", 
+  :attributes! => {
+    "foo/" => {
+      "bar" => "1", 
+      "biz" => "2", 
+      "baz" => "3"
+    }
+  }
+)
+# => "<foo baz=\"3\" bar=\"1\" biz=\"2\"/>"
+```
+
+**Using "@" keys and ":content!"**
+
+``` ruby
+Gyoku.xml(
+  "foo/" => {
+    :@bar => "1",
+    :@biz => "2",
+    :@baz => "3",
+    :content! => ""
+  })
+# => "<foo baz=\"3\" bar=\"1\" biz=\"2\"/>"
+```
+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.
+
+``` ruby
+Gyoku.xml(:person => {:content! => "Adam", :@id! => 0})
+# => "<person id=\"0\">Adam</person>"
+```
+
+Example with ":content!", :attributes! and "@" keys
+--------------------------------------------------
+``` ruby
+Gyoku.xml({ 
+  :subtitle => { 
+    :@lang => "en", 
+    :content! => "It's Godzilla!" 
+  }, 
+  :attributes! => { :subtitle => { "lang" => "jp" } } 
+}
+# => "<subtitle lang=\"en\">It's Godzilla!</subtitle>"
+```
+
+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.

data/lib/gyoku/hash.rb

@@ -28,13 +28,33 @@ module Gyoku
 
     # Iterates over a given +hash+ and yields a builder +xml+ instance, the current
     # Hash +key+ and any XML +attributes+.
+    #
+    # Keys beginning with "@" are treated as explicit attributes for their container.
+    # You can use both :attributes! and "@" keys to specify attributes.
+    # In the event of a conflict, the "@" key takes precedence.
     def self.iterate_with_xml(hash)
       xml = Builder::XmlMarkup.new
       attributes = hash[:attributes!] || {}
       hash_without_attributes = hash.reject { |key, value| key == :attributes! }
 
-      order(hash_without_attributes).each do |key|
-        yield xml, key, hash_without_attributes[key], (attributes[key] || {})
+      order(hash_without_attributes).each do |key| 
+        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]
+
+        if node_value.respond_to?(:keys)
+          explicit_keys = node_value.keys.select{|k| k.to_s =~ /^@/ }
+          explicit_attr = {}
+          explicit_keys.each{|k| explicit_attr[k.to_s[1..-1]] = node_value[k]}
+          node_attr.merge!(explicit_attr)
+          explicit_keys.each{|k| node_value.delete(k) }
+
+          node_value = node_value.delete(:content!) || node_value
+          node_value = "" if node_value.empty?
+        end
+
+        yield xml, key, node_value, node_attr
       end
 
       xml.target!
@@ -48,7 +68,11 @@ module Gyoku
       hash_without_order = hash.reject { |key, value| key == :order! }
       order = hash_without_order.keys unless order.kind_of? ::Array
 
-      missing, spurious = hash_without_order.keys - order, order - hash_without_order.keys
+      # Ignore Explicit Attributes
+      orderable = order.delete_if{|k| k =~ /^@/ }
+      hashable = hash_without_order.keys.select{|k| !(k =~ /^@/) }
+
+      missing, spurious = hashable - orderable, orderable - hashable
       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.6"
+  VERSION = "0.5.0"
 
 end

data/lib/gyoku/xml_key.rb

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

data/spec/gyoku/hash_spec.rb

@@ -140,6 +140,73 @@ describe Gyoku::Hash do
       to_xml(hash).should == '<category id="1"/>'
     end
 
+    it "recognizes @attribute => value along :attributes!" do
+      hash = {
+        "category" => {
+          :content! => "users",
+          :@id => 1
+        }
+      }
+      to_xml(hash).should == '<category id="1">users</category>'
+    end
+
+    it "recognizes @attribute => value along :attributes! in selfclosed tags" do
+      hash = {
+        "category/" => {
+          :@id => 1
+        }
+      }
+      to_xml(hash).should == '<category id="1"/>'
+    end
+
+    it ":@attribute => value takes over :attributes!" do
+      hash = {
+        "category/" => {
+          :@id => 1
+        },
+        :attributes! => {
+          "category/" => {
+            'id' => 2, # will be ignored
+            'type' => 'admins'
+          }
+        }
+      }
+      # attribute order is undefined
+      ['<category id="1" type="admins"/>','<category type="admins" id="1"/>'].should include to_xml(hash)
+
+      # with symbols
+      hash = {
+        "category/" => {
+          :@id => 1
+        },
+        :attributes! => {
+          "category/" => {
+            :id => 2, # will be ignored
+            :type => 'admins'
+          }
+        }
+      }
+      ['<category id="1" type="admins"/>','<category type="admins" id="1"/>'].should include to_xml(hash)
+    end
+
+    it "recognizes :content! => value as tag content" do
+      hash = {
+        "category" => {
+          :content! => "users"
+        }
+      }
+      to_xml(hash).should == "<category>users</category>"
+    end
+
+    it "ignores :content! if self-closing mark present" do
+      hash = {
+        "category/" => {
+          :content! => "users"
+        }
+      }
+      to_xml(hash).should == "<category/>"
+    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" } }

data/spec/gyoku/xml_key_spec.rb

@@ -59,6 +59,11 @@ describe Gyoku::XMLKey do
       Gyoku::XMLKey.create(:snake_case).should == "SnakeCase"
     end
 
+    it "accepts :upcase" do
+      Gyoku::XMLKey.symbol_converter = :upcase
+      Gyoku::XMLKey.create(:snake_case).should == "SNAKE_CASE"
+    end
+
     it "accepts :none" do
       Gyoku::XMLKey.symbol_converter = :none
       Gyoku::XMLKey.create(:snake_Case).should == "snake_Case"

metadata

@@ -1,77 +1,70 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gyoku
-version: !ruby/object:Gem::Version 
-  hash: 3
+version: !ruby/object:Gem::Version
+  version: 0.5.0
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 6
-  version: 0.4.6
 platform: ruby
-authors: 
+authors:
 - Daniel Harrington
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2012-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 1
-        - 2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.1.2
-  name: builder
   type: :runtime
   prerelease: false
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
+    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
+        version: '0.9'
   type: :development
   prerelease: false
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 10
-        version: "2.10"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
   type: :development
   prerelease: false
-  requirement: *id003
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
 description: Gyoku converts Ruby Hashes to XML
 email: me@rubiii.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
@@ -95,38 +88,35 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/rubiii/gyoku
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -3740829974448807903
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -3740829974448807903
 requirements: []
-
 rubyforge_project: gyoku
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Converts Ruby Hashes to XML
-test_files: 
+test_files:
 - spec/gyoku/array_spec.rb
 - spec/gyoku/hash_spec.rb
 - spec/gyoku/xml_key_spec.rb