xbuilder 0.9

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem "blankslate"
+gem "libxml-ruby", ">= 2.3.3"
+
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov", require: false
+
+  # For performance comparison:
+  gem "nokogiri"
+  gem "builder"
+end

data/README.rdoc

@@ -0,0 +1,96 @@
+= Xbuilder
+
+Xbuilder is an API-compatible Builder implementation using <tt>libxml</tt>. Also it's almost <b>2 times faster</b> than Builder and Nokogiri (see <tt>test/performance.rb</tt> output for details).
+
+Feel free to open an issue on any incompatibility with Builder API. The list of known incompatibilities is given below.
+
+== Usage
+
+Xbuilder supports almost all of the Builder's features. Here is a small example:
+
+  xml = Xbuilder.new(indent: 2)
+  xml.node attr: 1 do |xml|     #=> <node attr="1">
+    xml.ns :child, attr: 2      #=>   <ns:child attr="2"/>
+  end                           #=> </node>
+
+== With Rails
+
+  # some.xml.xbuilder
+  xml.node do |xml|
+    # The first argument is your partial name, the second is a hash of locals.
+    xml.partial!("partial", value: 1)
+  end
+
+  # _partial.xml.xbuilder
+  xml.child(value)
+
+will render:
+
+  <?xml version="1.0" encoding="UTF-8"?>
+  <node><child>1</child></node>
+
+== Notes
+
+* Child blocks with 0 arguments are not supported. So, instead of:
+
+    xml.node do
+      xml.node
+    end
+
+  write:
+
+    xml.node do |xml|
+      xml.node
+    end
+
+* XML instruction will be added automatically.
+
+    xml = Xbuilder.new(encoding: "ISO-8859-1")
+    xml.node "test"
+    puts xml.target!
+
+  will print:
+
+    <?xml version="1.0" encoding="ISO-8859-1"?>
+    <node>test</node>
+
+* <tt>libxml-ruby</tt> gem has an issue ({#46}[https://github.com/xml4r/libxml-ruby/pull/46]) with node content encoding:
+
+    xml.esc "escaped & text"
+    #=> without fix: <esc>escaped </esc>
+    #=> with fix: <esc>escaped &amp; text</esc>
+
+  For now I've used temporary workaround (see <tt>Xbuilder#__escape</tt>).
+
+
+== Incompatibilities With Builder
+
+* Builder-like unescaped symbol attributes are not supported.
+  It's currently a restriction of <tt>libxml</tt> (see <tt>xmlAttrSerializeContent</tt> implementation).
+
+    xml.node(attr: :"&esc") #=> <node attr="&amp;esc"/>
+
+* Custom XML processing instructions are not supported yet. Instruction will be auto-generated depending on
+  encoding and version provided.
+
+* XML entity declarations are not yet supported.
+
+== Contributing to Xbuilder
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Authors
+
+Builder gem was created by Jim Weirich.
+
+Xbuilder gem was created by Nikita Afanasenko. The project is hosted on Github: http://github.com/nikitug/xbuilder.
+
+Copyright © 2012 Nikita Afanasenko, released under the MIT license.
+
+* http://www.opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+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 = "xbuilder"
+  gem.version = "0.9"
+  gem.homepage = "http://github.com/nikitug/xbuilder"
+  gem.summary = %[API-compatible Builder implementation using libxml.]
+  gem.email = "nikita@afanasenko.name"
+  gem.authors = ["Nikita Afanasenko"]
+  # dependencies defined in Gemfile
+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
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Xbuilder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/xbuilder.rb

@@ -0,0 +1,185 @@
+require 'blankslate'
+require 'libxml'
+
+# == Usage
+#
+# Xbuilder supports almost all of the Builder's features. Here is a small example:
+#
+#   xml = Xbuilder.new(indent: 2)
+#   xml.node attr: 1 do |xml|     #=> <node attr="1">
+#     xml.ns :child, attr: 2      #=>   <ns:child attr="2"/>
+#   end                           #=> </node>
+class Xbuilder < BlankSlate
+  XML = ::LibXML::XML #:nodoc:
+  define_method(:__class, find_hidden_method(:class))
+
+  # Create an XML builder. Available options are:
+  #
+  # :root::
+  #   Root element. All nodes created by the builder will be attached to it.
+  #
+  # :encoding::
+  #   Document encoding, e.g. "UTF-8".
+  #   Will be used in XML instruction: <tt><?xml version="1.0" encoding="UTF-8"?></tt>
+  #
+  # Builder compatibility options:
+  # :indent:: Number of spaces used for indentation. Default is 0.
+  # :margin:: Amount of initial indentation (specified in levels, not spaces).
+  def initialize(options = {})
+    if options[:target]
+      ::Kernel.raise ::ArgumentError, "':target' option is not supported."
+    end
+
+    @indent = options[:indent].to_i
+    @margin = options[:margin].to_i
+    @root = options[:root] || XML::Document.new
+    @encoding = options[:encoding] || "UTF-8"
+  end
+
+  # Append a tag with the method's name to the output.
+  #   xml.node { |xml| xml.child } #=> <node><child/></node>
+  def method_missing(name, *args, &block)
+    name = "#{name}:#{args.shift}" if args.first.kind_of?(::Symbol)
+    node = XML::Node.new(name.to_s)
+    text = nil
+
+    args.each do |arg|
+      case arg
+      when ::Hash
+        arg.each do |key, val|
+          k = key.to_s
+          v = val.to_s
+          node[k] = v
+        end
+      else
+        text ||= ''
+        text << arg.to_s
+      end
+    end
+
+    if block && text
+      ::Kernel.raise ::ArgumentError, "Cannot mix a text argument with a block"
+    end
+
+    # FIXME `__escape` is a temp solution till bugfix release.
+    # https://github.com/xml4r/libxml-ruby/pull/46
+    node.content = __escape(text) if text
+
+    if block
+      unless block.arity > 0
+        ::Kernel.raise ::ArgumentError, "Provide at least 1 block argument: `xml.node { |xml| xml.child }'"
+      end
+      block.call(__new_instance(root: node))
+    end
+
+    __append_node(node)
+  end
+
+  # Append a tag to the output. The first argument is a tag name.
+  # The rest of arguments are the same as <tt>method_missing</tt> ones.
+  #   xml.tag!("node") { |xml| xml.tag!("child") } #=> <node><child/></node>
+  def tag!(name, *args, &block)
+    method_missing(name, *args, &block)
+  end
+
+  # Append text to the output. Escape by default.
+  #
+  #   xml.node { xml.text!("escaped & text") } #=> <node>escaped &amp; text</node>
+  def text!(text, escape = true)
+    __ensure_no_block(::Kernel.block_given?)
+    node = XML::Node.new_text(text)
+    node.output_escaping = escape
+    __append_node(node)
+  end
+
+  # Append text to the output. Do not escape by default.
+  #   xml.node { xml << "unescaped & text" } #=> <node>unescaped & text</node>
+  def <<(text, escape = false)
+    __ensure_no_block(::Kernel.block_given?)
+    text!(text, escape)
+  end
+
+  # Returns the target XML string.
+  def target!
+    # FIXME Temp solution for encoding constant lookup.
+    # (till bugfix release https://github.com/xml4r/libxml-ruby/pull/45 to be published)
+    const_name = @encoding.upcase.gsub!("-", "_")
+    encoding = XML::Encoding.const_get(const_name)
+
+    XML.indent_tree_output = (@indent > 0)
+    XML.default_tree_indent_string = (" " * @indent)
+
+    @root.to_s(encoding: encoding, indent: XML.indent_tree_output).tap do |xml|
+      if @margin > 0
+        xml.gsub!(/^/, (" " * @indent) * @margin)
+      end
+    end
+  end
+
+  # Insert comment node.
+  def comment!(comment_text)
+    __ensure_no_block(::Kernel.block_given?)
+    node = XML::Node.new_comment(comment_text)
+    __append_node(node)
+  end
+
+  # XML declarations are not yet supported.
+  def declare!(inst, *args, &block)
+    __warn("XML declarations are not yet supported. Pull requests are welcome!")
+  end
+
+  # Custom XML instructions are not supported.
+  # Left here for Builder API compatibility.
+  def instruct!(*args)
+    # TODO should we switch XML instruction off if `instruct!` is not called?
+    __warn("Custom XML instructions are not supported")
+  end
+
+  # Insert CDATA node.
+  def cdata!(text)
+    __ensure_no_block(::Kernel.block_given?)
+    node = XML::Node.new_cdata(text)
+    __append_node(node)
+  end
+
+  private
+
+  def __escape(text)
+    text.tap do |t|
+      t.gsub!(/&(?![a-zA-Z]+;)|<|>|'|"/) do |match|
+        case match
+        when "&" then "&amp;"
+        when "<" then "&lt;"
+        when ">" then "&gt;"
+        when "'" then "&apos;"
+        when '"' then "&quot;"
+        end
+      end
+    end
+  end
+
+  def __append_node(node)
+    if @root.kind_of?(XML::Document)
+      @root.root = node
+    else
+      @root << node
+    end
+  end
+
+  def __new_instance(root)
+    __class.new(root)
+  end
+
+  def __ensure_no_block(given)
+    if given
+      ::Kernel.raise ArgumentError.new("Blocks are not allowed on XML instructions")
+    end
+  end
+
+  def __warn(msg)
+    ::Kernel.warn("Xbuilder WARNING: #{msg}")
+  end
+
+end
+
+require "xbuilder/template" if defined?(ActionView::Template)

data/lib/xbuilder_template.rb

@@ -0,0 +1,49 @@
+class XbuilderTemplate < Xbuilder
+  define_method(:__instance_variable_set, find_hidden_method(:instance_variable_set))
+
+  def self.encode(context)
+    xml = self.new
+    xml.__instance_variable_set(:@context, context)
+    yield xml
+    xml.target!
+  end
+
+  def partial!(options, locals = {})
+    case options
+    when Hash
+      options[:locals] ||= {}
+      options[:locals].merge!(xml: self)
+      @context.render(options)
+    else
+      @context.render(options, locals.merge(xml: self))
+    end
+  end
+
+  private
+
+  def __new_instance(*args)
+    super.tap do |xml|
+      xml.__instance_variable_set(:@context, @context)
+    end
+  end
+
+end
+
+class XbuilderHandler
+  cattr_accessor :default_format
+  self.default_format = Mime::XML
+
+  def self.call(template)
+    %[
+      if defined?(xml)
+        #{template.source}
+      else
+        XbuilderTemplate.encode(self) do |xml|
+          #{template.source}
+        end
+      end
+    ]
+  end
+end
+
+ActionView::Template.register_template_handler :xbuilder, XbilderHandler

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'simplecov'
+SimpleCov.start
+
+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 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'xbuilder'
+
+class Test::Unit::TestCase
+  def without_instruct(xml)
+    xml.gsub(/^\s*<\?xml[^>]*>\n/, "").rstrip
+  end
+end

data/test/performance.rb

@@ -0,0 +1,71 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'xbuilder'
+require 'builder'
+require 'nokogiri'
+require 'benchmark'
+
+xml_block = proc do |xml|
+  xml.root do |xml|
+    10.times do
+      xml.node "text"
+      xml.node2 do |xml|
+        xml.test args: 1, args2: 4 do |xml|
+          xml.child arg: "text" do |xml|
+            xml.one_more arg: 1, arg: "2123"
+          end
+        end
+      end
+    end
+  end
+end
+
+repeat = 200
+xmls = []
+Benchmark.bm do |x|
+  x.report "builder" do
+    repeat.times do
+      xml = Builder::XmlMarkup.new
+      xml.instruct!
+      xml_block.call(xml)
+      xmls << xml.target!
+    end
+  end
+  x.report "nokogiri" do
+    repeat.times do
+      builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+        xml_block.call(xml)
+      end
+      xmls << builder.to_xml(indent: 0)
+    end
+  end
+  x.report "xbuilder" do
+    repeat.times do
+      xml = Xbuilder.new
+      xml_block.call(xml)
+      xmls << xml.target!
+    end
+  end
+end
+
+# Enshure all xmls are the same.
+xml = xmls.first.split.join
+xmls.each do |xml2|
+  if xml != xml2.split.join
+    puts xml
+    puts xml2
+    exit
+  end
+end
+
+require 'ruby-prof'
+
+RubyProf.start
+repeat.times do
+  xml = Xbuilder.new
+  xml_block.call(xml)
+  xmls << xml.target!
+end
+result = RubyProf.stop
+
+printer = RubyProf::FlatPrinter.new(result)
+printer.print(STDOUT)

data/test/test_xbuilder.rb

@@ -0,0 +1,384 @@
+require 'helper'
+
+#--
+# To enshure compatibility, a significant part of this test was taken from Builder gem.
+#
+# Portions copyright 2004 by Jim Weirich (jim@weirichhouse.org).
+# Portions copyright 2005 by Sam Ruby (rubys@intertwingly.net).
+# Portions copyright 2012 by Nikita Afanasenko (nikita@afanasenko.name).
+# All rights reserved.
+
+# Permission is granted for use, copying, modification, distribution,
+# and distribution of modified versions of this work as long as the
+# above copyright notice is included.
+#++
+
+class TestXbuilder < Test::Unit::TestCase
+  def setup
+    @xml = Xbuilder.new
+  end
+
+  def test_simple
+    @xml.simple
+    assert_equal "<simple/>", without_instruct(@xml.target!)
+  end
+
+  def test_value
+    @xml.value("hi")
+    assert_equal "<value>hi</value>", without_instruct(@xml.target!)
+  end
+
+  def test_nested
+    @xml.outer { |x| x.inner("x") }
+    assert_equal "<outer><inner>x</inner></outer>", without_instruct(@xml.target!)
+  end
+
+  def test_attributes
+    @xml.ref(:id => 12)
+    assert_equal %{<ref id="12"/>}, without_instruct(@xml.target!)
+  end
+
+  def test_string_attributes_are_quoted_by_default
+    @xml.ref(:id => "H&R")
+  end
+
+  def test_symbol_attributes_are_unquoted_by_default
+    skip "Unquoted symbol attributes are not supported."
+    @xml.ref(:id => :"H&amp;R")
+    assert_equal %{<ref id="H&amp;R"/>}, without_instruct(@xml.target!)
+  end
+
+  def test_attributes_quoted_can_be_turned_on
+    @xml.ref(:id => "<H&R \"block\">")
+    assert_equal %{<ref id="&lt;H&amp;R &quot;block&quot;&gt;"/>}, without_instruct(@xml.target!)
+  end
+
+  def test_multiple_attributes
+    @xml.ref(:id => 12, :name => "bill")
+    assert_match %r{^<ref( id="12"| name="bill"){2}/>$}, without_instruct(@xml.target!)
+  end
+
+  def test_attributes_with_text
+    @xml.a("link", :href=>"http://onestepback.org")
+    assert_equal %{<a href="http://onestepback.org">link</a>}, without_instruct(@xml.target!)
+  end
+
+  def test_complex
+    @xml.body(:bg=>"#ffffff") { |x|
+      x.title("T", :style=>"red")
+    }
+    assert_equal %{<body bg="#ffffff"><title style="red">T</title></body>}, without_instruct(@xml.target!)
+  end
+
+  def test_funky_symbol
+    @xml.tag!("non-ruby-token", :id=>1) { |x| x.ok }
+    assert_equal %{<non-ruby-token id="1"><ok/></non-ruby-token>}, without_instruct(@xml.target!)
+  end
+
+  def test_tag_can_handle_private_method
+    @xml.tag!("loop", :id=>1) { |x| x.ok }
+    assert_equal %{<loop id="1"><ok/></loop>}, without_instruct(@xml.target!)
+  end
+
+  def test_no_explicit_marker
+    @xml.p { |x| x.b("HI") }
+    assert_equal "<p><b>HI</b></p>", without_instruct(@xml.target!)
+  end
+
+  def test_reference_local_vars
+    n = 3
+    @xml.ol { |x| n.times { x.li(n) } }
+    assert_equal "<ol><li>3</li><li>3</li><li>3</li></ol>", without_instruct(@xml.target!)
+  end
+
+  def test_reference_methods
+    @xml.title { |x| x.a { |x| x.b(name) } }
+    assert_equal "<title><a><b>bob</b></a></title>", without_instruct(@xml.target!)
+  end
+
+  def test_append_text
+    @xml.p { |x| x.br; x.text! "HI" }
+    assert_equal "<p><br/>HI</p>", without_instruct(@xml.target!)
+  end
+
+  def test_ambiguous_markup
+    ex = assert_raise(ArgumentError) {
+      @xml.h1("data1") { b }
+    }
+    assert_match /\btext\b/, ex.message
+    assert_match /\bblock\b/, ex.message
+  end
+
+  def test_capitalized_method
+    @xml.P { |x| x.B("hi"); x.BR(); x.EM { |x| x.text! "world" } }
+    assert_equal "<P><B>hi</B><BR/><EM>world</EM></P>", without_instruct(@xml.target!)
+  end
+
+  def test_escaping
+    @xml.div { |x| x.text! "<hi>"; x.em("H&R Block") }
+    assert_equal %{<div>&lt;hi&gt;<em>H&amp;R Block</em></div>}, without_instruct(@xml.target!)
+  end
+
+  def test_non_escaping
+    @xml.div("ns:xml"=>"xml") { |x| x << "<h&i>"; x.em("H&R Block") }
+    assert_equal %{<div ns:xml="xml"><h&i><em>H&amp;R Block</em></div>}, without_instruct(@xml.target!)
+  end
+
+  def test_content_non_escaping
+    @xml.div { |x| x << "<h&i>" }
+    assert_equal %{<div><h&i></div>}, without_instruct(@xml.target!)
+  end
+
+  def test_content_escaping
+    @xml.div { |x| x.text!("<hi>") }
+    assert_equal %{<div>&lt;hi&gt;</div>}, without_instruct(@xml.target!)
+  end
+
+  def test_return_value
+    str = @xml.x("men").to_s
+    assert_equal without_instruct(@xml.target!), str
+  end
+
+  def test_stacked_builders
+    ex = assert_raise(ArgumentError) { Xbuilder.new( :target => @xml ) }
+    assert_match /target/, ex.message
+  end
+
+  def name
+    "bob"
+  end
+end
+
+class TestAttributeEscaping < Test::Unit::TestCase
+  def setup
+    @xml = Xbuilder.new
+  end
+
+  def test_element_gt
+    @xml.title('1<2')
+    assert_equal '<title>1&lt;2</title>', without_instruct(@xml.target!)
+  end
+
+  def test_element_amp
+    @xml.title('AT&T')
+    assert_equal '<title>AT&amp;T</title>', without_instruct(@xml.target!)
+  end
+
+  def test_element_amp2
+    @xml.title('&amp;')
+    assert_equal '<title>&amp;</title>', without_instruct(@xml.target!)
+  end
+
+  def test_attr_less
+    @xml.a(:title => '2>1')
+    assert_equal '<a title="2&gt;1"/>', without_instruct(@xml.target!)
+  end
+
+  def test_attr_amp
+    @xml.a(:title => 'AT&T')
+    assert_equal '<a title="AT&amp;T"/>', without_instruct(@xml.target!)
+  end
+
+  def test_attr_quot
+    @xml.a(:title => '"x"')
+    assert_equal '<a title="&quot;x&quot;"/>', without_instruct(@xml.target!)
+  end
+
+end
+
+class TestNameSpaces < Test::Unit::TestCase
+  def setup
+    @xml = Xbuilder.new(:indent=>2)
+  end
+
+  def test_simple_name_spaces
+    @xml.rdf :RDF
+    assert_equal "<rdf:RDF/>", without_instruct(@xml.target!)
+  end
+end
+
+class TestSpecialMarkup < Test::Unit::TestCase
+  def setup
+    @xml = Xbuilder.new(:indent=>2)
+  end
+
+  def test_comment
+    @xml.comment!("COMMENT")
+    assert_equal "<!--COMMENT-->", without_instruct(@xml.target!)
+  end
+
+  def test_indented_comment
+    @xml.p { |x| x.comment! "OK" }
+    assert_equal "<p>\n  <!--OK-->\n</p>", without_instruct(@xml.target!)
+  end
+
+  def test_instruct
+    skip "Custom instructs are not supported yet."
+    @xml.instruct! :abc, :version=>"0.9"
+    assert_equal "<?abc version=\"0.9\"?>\n", without_instruct(@xml.target!)
+  end
+
+  def test_indented_instruct
+    skip "Custom instructs are not supported yet."
+    @xml.p { @xml.instruct! :xml }
+    assert_match %r{<p>\n  <\?xml version="1.0" encoding="UTF-8"\?>\n</p>\n},
+      without_instruct(@xml.target!)
+  end
+
+  def test_instruct_without_attributes
+    skip "Custom instructs are not supported yet."
+    @xml.instruct! :zz
+    assert_equal "<?zz?>\n", without_instruct(@xml.target!)
+  end
+
+  def test_xml_instruct
+    #@xml.instruct!
+    assert_match /^<\?xml version="1.0" encoding="UTF-8"\?>$/, @xml.target!
+  end
+
+  def test_xml_instruct_with_overrides
+    skip "Custom instructs are not supported yet."
+    # FIXME shoud deal with encodings
+    @xml.instruct! :xml, :encoding=>"UCS-2"
+    assert_match /^<\?xml version="1.0" encoding="UCS-2"\?>$/, without_instruct(@xml.target!)
+  end
+
+  def test_xml_instruct_with_standalong
+    skip "Custom instructs are not supported yet."
+    @xml.instruct! :xml, :encoding=>"UCS-2", :standalone=>"yes"
+    assert_match /^<\?xml version="1.0" encoding="UCS-2" standalone="yes"\?>$/, without_instruct(@xml.target!)
+  end
+
+  def test_no_blocks
+    assert_raise(ArgumentError) do
+      @xml.cdata!("test") { |x| x.hi }
+    end
+    assert_raise(ArgumentError) do
+      @xml.comment!(:element) { |x| x.hi }
+    end
+  end
+
+  def test_block_arity_check
+    assert_raise(ArgumentError) do
+      @xml.node { x.hi }
+    end
+  end
+
+  def test_cdata
+    @xml.cdata!("TEST")
+    assert_equal "<![CDATA[TEST]]>", without_instruct(@xml.target!)
+  end
+
+  def test_cdata_with_ampersand
+    @xml.cdata!("TEST&CHECK")
+    assert_equal "<![CDATA[TEST&CHECK]]>", without_instruct(@xml.target!)
+  end
+end
+
+class TestIndentedXmlMarkup < Test::Unit::TestCase
+  def setup
+    @xml = Xbuilder.new(:indent=>2)
+  end
+
+  def test_one_level
+    @xml.ol { |x| x.li "text" }
+    assert_equal "<ol>\n  <li>text</li>\n</ol>", without_instruct(@xml.target!)
+  end
+
+  def test_two_levels
+    @xml.p { |x|
+      x.ol { |x| x.li "text" }
+      x.br
+    }
+    assert_equal "<p>\n  <ol>\n    <li>text</li>\n  </ol>\n  <br/>\n</p>", without_instruct(@xml.target!)
+  end
+
+  def test_initial_level
+    @xml = Xbuilder.new(:indent=>2, :margin=>4)
+    @xml.name { |x| x.first("Jim") }
+    assert_equal "        <name>\n          <first>Jim</first>\n        </name>", without_instruct(@xml.target!)
+  end
+end
+
+# FIXME should it be supported?
+#
+#class TestUtfMarkup < Test::Unit::TestCase
+  #if ! String.method_defined?(:encode)
+    #def setup
+      #@old_kcode = $KCODE
+    #end
+
+    #def teardown
+      #$KCODE = @old_kcode
+    #end
+
+    #def test_use_entities_if_no_encoding_is_given_and_kcode_is_none
+      #$KCODE = 'NONE'
+      #xml = Xbuilder.new
+      #xml.p("\xE2\x80\x99")
+      #assert_match(%r(<p>&#8217;</p>), xml.target!) #
+    #end
+
+    #def test_use_entities_if_encoding_is_utf_but_kcode_is_not
+      #$KCODE = 'NONE'
+      #xml = Xbuilder.new
+      #xml.instruct!(:xml, :encoding => 'UTF-8')
+      #xml.p("\xE2\x80\x99")
+      #assert_match(%r(<p>&#8217;</p>), xml.target!) #
+    #end
+  #else
+    ## change in behavior.  As there is no $KCODE anymore, the default
+    ## moves from "does not understand utf-8" to "supports utf-8".
+
+    #def test_use_entities_if_no_encoding_is_given_and_kcode_is_none
+      #xml = Xbuilder.new
+      #xml.p("\xE2\x80\x99")
+      #assert_match("<p>\u2019</p>", xml.target!) #
+    #end
+
+    #def test_use_entities_if_encoding_is_utf_but_kcode_is_not
+      #xml = Xbuilder.new
+      #xml.instruct!(:xml, :encoding => 'UTF-8')
+      #xml.p("\xE2\x80\x99")
+      #assert_match("<p>\u2019</p>", xml.target!) #
+    #end
+  #end
+
+  #def encode string, encoding
+    #if !String.method_defined?(:encode)
+      #$KCODE = encoding
+      #string
+    #elsif encoding == 'UTF8'
+      #string.force_encoding('UTF-8')
+    #else
+      #string
+    #end
+  #end
+
+  #def test_use_entities_if_kcode_is_utf_but_encoding_is_something_else
+    #xml = Xbuilder.new
+    #xml.instruct!(:xml, :encoding => 'UTF-16')
+    #xml.p(encode("\xE2\x80\x99", 'UTF8'))
+    #assert_match(%r(<p>&#8217;</p>), xml.target!) #
+  #end
+
+  #def test_use_utf8_if_encoding_defaults_and_kcode_is_utf8
+    #xml = Xbuilder.new
+    #xml.p(encode("\xE2\x80\x99",'UTF8'))
+    #assert_equal encode("<p>\xE2\x80\x99</p>",'UTF8'), xml.target!
+  #end
+
+  #def test_use_utf8_if_both_encoding_and_kcode_are_utf8
+    #xml = Xbuilder.new
+    #xml.instruct!(:xml, :encoding => 'UTF-8')
+    #xml.p(encode("\xE2\x80\x99",'UTF8'))
+    #assert_match encode("<p>\xE2\x80\x99</p>",'UTF8'), xml.target!
+  #end
+
+  #def test_use_utf8_if_both_encoding_and_kcode_are_utf8_with_lowercase
+    #xml = Xbuilder.new
+    #xml.instruct!(:xml, :encoding => 'utf-8')
+    #xml.p(encode("\xE2\x80\x99",'UTF8'))
+    #assert_match encode("<p>\xE2\x80\x99</p>",'UTF8'), xml.target!
+  #end
+#end

data/xbuilder.gemspec

@@ -0,0 +1,66 @@
+# 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 = "xbuilder"
+  s.version = "0.9"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nikita Afanasenko"]
+  s.date = "2012-08-26"
+  s.email = "nikita@afanasenko.name"
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "README.rdoc",
+    "Rakefile",
+    "lib/xbuilder.rb",
+    "lib/xbuilder_template.rb",
+    "test/helper.rb",
+    "test/performance.rb",
+    "test/test_xbuilder.rb",
+    "xbuilder.gemspec"
+  ]
+  s.homepage = "http://github.com/nikitug/xbuilder"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "API-compatible Builder implementation using libxml."
+
+  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_runtime_dependency(%q<blankslate>, [">= 0"])
+      s.add_runtime_dependency(%q<libxml-ruby>, [">= 2.3.3"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<builder>, [">= 0"])
+    else
+      s.add_dependency(%q<blankslate>, [">= 0"])
+      s.add_dependency(%q<libxml-ruby>, [">= 2.3.3"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<builder>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<blankslate>, [">= 0"])
+    s.add_dependency(%q<libxml-ruby>, [">= 2.3.3"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<builder>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: xbuilder
+version: !ruby/object:Gem::Version
+  version: '0.9'
+  prerelease: 
+platform: ruby
+authors:
+- Nikita Afanasenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blankslate
+  requirement: &70319835213640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70319835213640
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  requirement: &70319835224860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70319835224860
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70319835220600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70319835220600
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70319835218740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70319835218740
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70319835238360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70319835238360
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70319835236620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70319835236620
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70319835235820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70319835235820
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &70319835234380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70319835234380
+description: 
+email: nikita@afanasenko.name
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/xbuilder.rb
+- lib/xbuilder_template.rb
+- test/helper.rb
+- test/performance.rb
+- test/test_xbuilder.rb
+- xbuilder.gemspec
+homepage: http://github.com/nikitug/xbuilder
+licenses: []
+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: -2434364586004529730
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: API-compatible Builder implementation using libxml.
+test_files: []