xml_data_builder 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,26 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "builder", ">= 3.0.0"
+  gem "rspec", ">= 2.3.0"
+  gem "activesupport", ">= 3.0.0"
+  gem "i18n", ">= 0.5.0"
+end
+
+group :test do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "builder", ">= 3.0.0"
+  gem "rspec", ">= 2.3.0"
+  gem "activesupport", ">= 3.0.0"
+  gem "i18n", ">= 0.5.0"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    builder (3.0.0)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0.0)
+  builder (>= 3.0.0)
+  bundler (~> 1.0.0)
+  i18n (>= 0.5.0)
+  jeweler (~> 1.5.2)
+  rspec (>= 2.3.0)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Travel IQ GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,73 @@
+= xml_data_builder
+
+XmlDataBuilder renders Ruby data structures as XML using Builder.
+It is designed to use the lowest common denominator between JSON and XML.
+When using arrays as input XmlDataBuilder uses the key of the outer hash as a grouping tag and wraps the values in singularized tags.
+Symbols and Strings are equivalent.
+
+Usage is simple: You initialize XmlDataBuilder with ruby data structure and call #document:
+
+  >> puts XmlDataBuilder.new({}).document
+  <?xml version="1.0" encoding="UTF-8"?>
+
+  >> puts XmlDataBuilder.new({:data => 1}).document
+  <?xml version="1.0" encoding="UTF-8"?>
+  <data>1</data>
+
+  >> puts XmlDataBuilder.new({:outer => {:inner => 'data'}}).document
+  <?xml version="1.0" encoding="UTF-8"?>
+  <outer>
+    <inner>data</inner>
+  </outer>
+
+  >> puts XmlDataBuilder.new({:outer => {:inner => 'data'}}, :indent => 0).document
+  <?xml version="1.0" encoding="UTF-8"?><outer><inner>data</inner></outer>
+
+  >> puts XmlDataBuilder.new({:numbers => [1, 2, 3]}).document
+  <?xml version="1.0" encoding="UTF-8"?>
+  <numbers>
+    <number>1</number>
+    <number>2</number>
+    <number>3</number>
+  </numbers>
+
+  >> puts XmlDataBuilder.new({:numbers => [{:value => 1, :type => 'odd'}, {:value => 2, :type => 'even'}]}).document
+  <?xml version="1.0" encoding="UTF-8"?>
+  <numbers>
+    <number>
+      <type>odd</type>
+      <value>1</value>
+    </number>
+    <number>
+      <type>even</type>
+      <value>2</value>
+    </number>
+  </numbers>
+
+  >> puts XmlDataBuilder.new({:verbatim => XmlDataBuilder::CDATA.new('eßcape thïs!')}).document
+  <?xml version="1.0" encoding="UTF-8"?>
+  <verbatim>
+    <![CDATA[eßcape thïs!]]>
+  </verbatim>
+
+== Caveat
+
+The root element has to be a Hash and at least every second level has to be a Hash.
+XML attributes are not supported.
+
+== Installation
+
+    (sudo) gem install xml_data_builder
+    
+== Authors
+
+Dr. Florian Odronitz (odo@mac.com)
+
+== Contact
+
+For questions, contact the authors or developer@traveliq.net
+
+== Copyright
+
+Copyright (c) 2011 www.travel-iq.com. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "xml_data_builder"
+  gem.homepage = "http://github.com/odo/xml_data_builder"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "odo@mac.com"
+  gem.authors = ["odo"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "xml_data_builder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/xml_data_builder.rb

@@ -0,0 +1,61 @@
+require 'builder'
+require 'active_support/inflector'
+class XmlDataBuilder
+
+  class CDATA < String
+
+    def initialize(template = nil)
+      super(template.to_s)
+    end
+
+  end
+  
+  def initialize(data, options = {})
+    @data, @options = data, options
+  end
+
+  def document
+    indent = @options[:indent] || 2
+    output = String.new
+    xml = Builder::XmlMarkup.new(:target => output, :indent => indent)
+    xml.instruct!
+    to_xml(xml, @data)
+    return output
+  end
+
+  private
+
+  def to_xml(parent, data)
+    raise ArgumentError, "Expected a Hash, got #{data.inspect}" unless data.is_a? Hash
+    data.each do |key, value|
+      case value
+      when Hash
+        parent.__send__(key.to_sym) do |child|
+          to_xml(child, value)
+        end
+      when Array
+        parent.__send__(key.to_sym) do
+          value.each do |single_value|
+            case single_value
+            when Hash
+              parent.__send__(key.to_s.singularize.to_sym) do |child|
+                to_xml(child, single_value)
+              end
+            else
+              raise ArgumentError, "Unable to handle nested arrays" if single_value.is_a? Array
+              parent.__send__(key.to_s.singularize.to_sym, single_value)
+            end
+          end
+        end
+      when CDATA
+        parent.__send__(key.to_sym) do |child|
+          parent.cdata! value
+        end         
+      when Symbol
+        parent.__send__(key.to_s.to_sym, value.to_s)
+      else
+        parent.__send__(key.to_s.to_sym, value)
+      end  
+    end
+  end
+end

data/spec/xml_data_builder_spec.rb

@@ -0,0 +1,108 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'xml_data_builder'
+require 'builder'
+require 'active_support/inflector'
+
+describe XmlDataBuilder do
+
+  it "should render an empty document" do
+    data = {}
+    xml = XmlDataBuilder.new(data, :indent => 2)
+    xml.document.strip.should == '<?xml version="1.0" encoding="UTF-8"?>'
+  end
+
+  it "should render integers" do
+    data = {:my_number => 1}
+    xml = XmlDataBuilder.new(data, :indent => 2)
+    xml.document.strip.should ==
+'<?xml version="1.0" encoding="UTF-8"?>
+<my_number>1</my_number>'
+  end
+
+  it "should render floats" do
+    data = {:pi => 3.14}
+    xml = XmlDataBuilder.new(data, :indent => 2)
+    xml.document.strip.should ==
+'<?xml version="1.0" encoding="UTF-8"?>
+<pi>3.14</pi>'
+  end
+
+  it "should render symbold" do
+    data = {:symbol => 'prince'}
+    xml = XmlDataBuilder.new(data, :indent => 2)
+    xml.document.strip.should ==
+'<?xml version="1.0" encoding="UTF-8"?>
+<symbol>prince</symbol>'
+  end
+
+  it "should render strings" do
+    data = {:my_string => 'boring!'}
+    xml = XmlDataBuilder.new(data, :indent => 2)
+    xml.document.strip.should ==
+'<?xml version="1.0" encoding="UTF-8"?>
+<my_string>boring!</my_string>'
+  end
+
+  it "should render CDATA" do
+    data = {:my_cdata => XmlDataBuilder::CDATA.new('<Oh my!/>')}
+    xml = XmlDataBuilder.new(data, :indent => 2)
+    xml.document.strip.should ==
+'<?xml version="1.0" encoding="UTF-8"?>
+<my_cdata>
+  <![CDATA[<Oh my!/>]]>
+</my_cdata>'
+  end
+
+  it "should render nested data" do
+    data = {:my_data => {:one => 1, :two => 2}}
+    xml = XmlDataBuilder.new(data, :indent => 2)
+    xml.document.strip.split("\n").sort.should ==
+'<?xml version="1.0" encoding="UTF-8"?>
+<my_data>
+  <two>2</two>
+  <one>1</one>
+</my_data>'.split("\n").sort
+  end
+
+  it "should render arrays" do
+    data = {:items => ['bread', 'butter']}
+    xml = XmlDataBuilder.new(data, :indent => 2)
+    xml.document.strip.should ==
+'<?xml version="1.0" encoding="UTF-8"?>
+<items>
+  <item>bread</item>
+  <item>butter</item>
+</items>'
+  end
+
+  it "should render complex data" do
+    data = {:nest => {:inner_elements => [{:one => 1.0}, {:two => 'two', :wtf => XmlDataBuilder::CDATA.new(42)}]}}
+    xml = XmlDataBuilder.new(data, :indent => 2)
+    xml.document.strip.split("\n").sort.should ==
+'<?xml version="1.0" encoding="UTF-8"?>
+<nest>
+  <inner_elements>
+    <inner_element>
+      <one>1.0</one>
+    </inner_element>
+    <inner_element>
+      <two>two</two>
+      <wtf>
+        <![CDATA[42]]>
+      </wtf>
+    </inner_element>
+  </inner_elements>
+</nest>'.split("\n").sort
+  end
+
+  it "should not except arrays" do
+    data = [:illegal]
+    lambda{ XmlDataBuilder.new(data, :indent => 2).document }.should raise_error ArgumentError
+  end
+
+  it "should not except nested arrays within the structure" do
+    data = {:illegal => [[:me]]}
+    lambda{ XmlDataBuilder.new(data, :indent => 2).document }.should raise_error ArgumentError
+  end
+
+end

data/xml_data_builder.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{xml_data_builder}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["odo"]
+  s.date = %q{2011-02-22}
+  s.description = %q{XmlDataBuilder renders Ruby data structures as XML using Builder.}
+  s.email = %q{odo@mac.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/xml_data_builder.rb",
+    "spec/xml_data_builder_spec.rb",
+    "xml_data_builder.gemspec"
+  ]
+  s.homepage = %q{http://github.com/odo/xml_data_builder}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{XmlDataBuilder renders Ruby data structures as XML using Builder.}
+  s.test_files = [
+    "spec/xml_data_builder_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<builder>, [">= 3.0.0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_development_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_development_dependency(%q<i18n>, [">= 0.5.0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<builder>, [">= 3.0.0"])
+      s.add_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<i18n>, [">= 0.5.0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<builder>, [">= 3.0.0"])
+    s.add_dependency(%q<rspec>, [">= 2.3.0"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<i18n>, [">= 0.5.0"])
+  end
+end
+

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification 
+name: xml_data_builder
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- odo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :development
+  version_requirements: *id007
+description: XmlDataBuilder renders Ruby data structures as XML using Builder.
+email: odo@mac.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/xml_data_builder.rb
+- spec/xml_data_builder_spec.rb
+- xml_data_builder.gemspec
+has_rdoc: true
+homepage: http://github.com/odo/xml_data_builder
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: XmlDataBuilder renders Ruby data structures as XML using Builder.
+test_files: 
+- spec/xml_data_builder_spec.rb