xml-fu 0.1.5 → 0.1.6

data/.travis-yml

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

data/README.md

@@ -1,4 +1,4 @@
-# Xml::Fu
+# XmlFu [![Build Status](http://travis-ci.org/CITguy/xml-fu.png)](http://travis-ci.org/CITguy/xml-fu)
 
 Convert Ruby Hashes to XML
 
@@ -243,7 +243,7 @@ XmlFu.xml(
 Since with simple values, you cannot infer the value of their node container purely on their value, simple values
 are currently ignored in arrays and only Hashes are translated.
 
-``` ruby
+```ruby
   "foo" => [
     {:bar => "biz"},
     nil, # ignored
@@ -257,10 +257,14 @@ are currently ignored in arrays and only Hashes are translated.
   #=> "<foo><bar>biz</bar></foo>"
 ```
 
+## Options
+* **:instruct** => true
+  * Adds &lt;xml version="1.0" encoding="UTF-8"?&gt; to generated XML
+
 
-### Cheat Sheet
+## Cheat Sheet
 
-#### Key
+### Key
   1. if key denotes self-closing node (key/)
     * attributes are preserved with Hash values
     * value and "=" values are ignored
@@ -273,7 +277,7 @@ are currently ignored in arrays and only Hashes are translated.
     * Array is flattened
     * Only Hash items in array are translated
 
-#### Value
+### Value
   1. if value is Hash:
     * "@" keys are attributes of the node
     * "=" key can be used in conjunction with any "@" keys to specify content of node

data/Rakefile

@@ -1,2 +1,13 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+##!/usr/bin/env rake
+#require "bundler/gem_tasks"
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = %w(-c)
+end
+
+task :default => :spec
+task :test => :spec

data/lib/xml-fu.rb

@@ -24,7 +24,10 @@ module XmlFu
     # an array of one hash (the root node hash)
     #
     #     <foo><bar/><baz/></foo> => [{"foo" => [{"bar/" => ""},{"baz/" => ""}] }]
-    def parse(xml, options)
+    def parse(xml=nil, options={})
+      parsed_xml = xml
+
+      return Array(parsed_xml)
     end
 
     def configure

data/lib/xml-fu/array.rb

@@ -69,6 +69,9 @@ module XmlFu
     # @param [Hash] opts Hash of options to pass to the iteration
     def self.each_with_xml(arr, opts={})
       xml = Builder::XmlMarkup.new
+      xml.instruct! if opts[:instruct] == true
+      opts.delete(:instruct)
+
 
       arr.each do |item|
         key = opts.fetch(:key, "")

data/lib/xml-fu/hash.rb

@@ -11,7 +11,7 @@ module XmlFu
 
     # Convert Hash to XML String
     def self.to_xml(hash, options={})
-      each_with_xml hash do |xml, name, value, attributes|
+      each_with_xml hash, options do |xml, name, value, attributes|
         xml << Node.new(name, value, attributes).to_xml 
       end
     end#self.to_xml
@@ -37,8 +37,10 @@ module XmlFu
 
     # Provides a convenience function to iterate over the hash
     # Logic will filter out attribute and content keys from hash values
-    def self.each_with_xml(hash)
+    def self.each_with_xml(hash, opts)
       xml = Builder::XmlMarkup.new
+      xml.instruct! if opts[:instruct] == true
+      opts.delete(:instruct)
 
       hash.each do |key,value|
         node_value = value

data/lib/xml-fu/version.rb

@@ -1,3 +1,3 @@
 module XmlFu
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/spec/lib/array_spec.rb

@@ -27,6 +27,19 @@ describe XmlFu::Array do
     #  XmlFu.infer_simple_value_nodes = false
     #end
 
+    it "should return plain xml with simple args" do
+      result = XmlFu::Array.to_xml([{:foo => "bar"}])
+      result.should == "<foo>bar</foo>"
+    end
+
+    it "should add XML doctype when :instruct => true" do
+      result = XmlFu::Array.to_xml([{:foo => "bar"}], :instruct => true)
+      result.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?><foo>bar</foo>"
+
+      result = XmlFu.xml([{:foo => "bar"}], :instruct => true)
+      result.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?><foo>bar</foo>"
+    end
+
     it "should flatten nested arrays properly" do
       hash = { 
         :foo => [

data/spec/lib/hash_spec.rb

@@ -3,8 +3,14 @@ require 'spec_helper'
 describe XmlFu::Hash do
 
   describe ".to_xml" do
-    it "for a simple Hash" do
-      XmlFu::Hash.to_xml(:some => "body").should == "<some>body</some>"
+    it "should return plain xml with simple args" do
+      result = XmlFu::Hash.to_xml({:foo=>"bar"})
+      result.should == "<foo>bar</foo>"
+    end
+
+    it "should add XML doctype if :instruct => true" do
+      result = XmlFu::Hash.to_xml({:foo=>"bar"}, :instruct => true)
+      result.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?><foo>bar</foo>"
     end
 
     it "for a nested Hash" do

data/spec/xmlfu_spec.rb

@@ -29,11 +29,11 @@ describe XmlFu do
     it "should return correct value based on nested array of hashes" do
       hash = {
         "SecretAgents" => [
-          {"agent/" => {"@id"=>"006", "@name"=>"Alec Trevelyan"}}, 
-          {"agent/" => {"@id"=>"007", "@name"=>"James Bond"}}
+          {"agent/" => {"@name"=>"Alec Trevelyan"}}, 
+          {"agent/" => {"@name"=>"James Bond"}}
         ]
       }
-      expected = "<SecretAgents><agent name=\"Alec Trevelyan\" id=\"006\"/><agent name=\"James Bond\" id=\"007\"/></SecretAgents>" 
+      expected = "<SecretAgents><agent name=\"Alec Trevelyan\"/><agent name=\"James Bond\"/></SecretAgents>" 
       XmlFu.xml(hash).should == expected
     end
 
@@ -77,13 +77,22 @@ describe XmlFu do
         xf.should respond_to(:infer_simple_value_nodes)
       end
     end
+
+    it "should set XmlFu Module variable 'infer_simple_value_nodes'" do
+      XmlFu.infer_simple_value_nodes.should == false
+      XmlFu.infer_simple_value_nodes = true
+      XmlFu.infer_simple_value_nodes.should == true
+      XmlFu.infer_simple_value_nodes = false
+      XmlFu.infer_simple_value_nodes.should == false
+    end
   end
 
-  it "should set XmlFu Module variable 'infer_simple_value_nodes'" do
-    XmlFu.infer_simple_value_nodes.should == false
-    XmlFu.infer_simple_value_nodes = true
-    XmlFu.infer_simple_value_nodes.should == true
-    XmlFu.infer_simple_value_nodes = false
-    XmlFu.infer_simple_value_nodes.should == false
+  describe ".parse" do
+    it "should always return an array" do
+      ::Array === XmlFu.parse()
+      ::Array === XmlFu.parse("foo")
+      ::Array === XmlFu.parse("foo", {:bar => true})
+    end
   end
+
 end

data/xml-fu.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "builder", ">= 2.1.2"
 
   gem.add_development_dependency "rspec", ">= 2.4.0"
+  gem.add_development_dependency "rake"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xml-fu
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Ryan Johnson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-16 00:00:00 Z
+date: 2012-03-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder
@@ -49,6 +49,20 @@ dependencies:
         version: 2.4.0
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  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
 description: "\n    Inspired by the Gyoku gem for hash to xml conversion, \n    XmlFu is designed to require no meta tagging for \n    node attributes and content. (i.e. no :attributes! and no :order!)\n  "
 email: 
 - rhino.citguy@gmail.com
@@ -60,6 +74,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis-yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE