builder 1.2.4 → 2.0.0

data/CHANGES

@@ -1,8 +1,16 @@
 = Change Log
 
+== Version 2.0.0
+
+* Added doc directory
+* Added unit tests for XmlEvents.
+* Added XChar module and used it in the _escape method.
+* Attributes are now quoted by default when strings.  Use Symbol
+  attribute values for unquoted behavior.
+
 == Version 1.2.4
 
-* Added a cdata! command to an XML Builder.
+* Added a cdata! command to an XML Builder (from Josh Knowles).
 
 == Version 1.2.3
 

data/README

@@ -37,10 +37,41 @@ or
   # <person>
   #   <name>Jim</name>
   #   <phone>555-1234</phone>
-  # </person
+  # </person>
 
 == Compatibility
 
+=== Version 2.0.0 Compatibility Changes
+
+Version 2.0.0 introduces automatically escaped attribute values for
+the first time.  Versions prior to 2.0.0 did not insert escape
+characters into attribute values in the XML markup.  This allowed
+attribute values to explicitly reference entities, which was
+occasionally used by a small number of developers.  Since strings
+could always be explicitly escaped by hand, this was not a major
+restriction in functionality.
+
+However, it did suprise most users of builder.  Since the body text is
+normally escaped, everybody expected the attribute values to be
+escaped as well.  Escaped attribute values were the number one support
+request on the 1.x Builder series.
+
+Starting with Builder version 2.0.0, all attribute values expressed as
+strings will be processed and the appropriate characters will be
+escaped (e.g. "&" will be tranlated to "&amp;").  Attribute values
+that are expressed as Symbol values will not be processed for escaped
+characters and will be unchanged in output. (Yes, this probably counts
+as Symbol abuse, but the convention is convenient and flexible).
+
+Example:
+
+  xml = Builder::XmlMarkup.new
+  xml.sample(:escaped=>"This&That", :unescaped=>:"Here&amp;There")
+  xml.target!  =>
+    <sample escaped="This&amp;That" unescaped="Here&amp;There"/>
+
+=== Version 1.0.0 Compatibility Changes
+
 Version 1.0.0 introduces some changes that are not backwards
 compatible with earlier releases of builder.  The main areas of
 incompatibility are:
@@ -76,14 +107,14 @@ incompatibility are:
     require_gem 'builder', "~> 0.0"   # Gets the old version
     require_gem 'builder', "~> 1.0"   # Gets the new version
 
-== New Features
+== Features
 
-* XML Comments are now supported ...
+* XML Comments are supported ...
 
     xml_markup.comment! "This is a comment"
       #=>  <!-- This is a comment -->
 
-* XML processing instructions are now supported ...
+* XML processing instructions are supported ...
 
     xml_markup.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
       #=>  <?xml version="1.0" encoding="UTF-8"?>
@@ -107,18 +138,19 @@ incompatibility are:
 
   If you need to have an argument to declare! be inserted without
   quotes, but the arguement does not conform to the typical Ruby
-  syntax for symbols, then use the +intern+ method on a string to
-  convert it to a symbol.
+  syntax for symbols, then use the :"string" form to specify a symbol.
 
-    xml_markup.declare! :ELEMENT, :chapter, "(title,para+)".intern
+  For example:
+
+    xml_markup.declare! :ELEMENT, :chapter, :"(title,para+)"
       #=>  <!ELEMENT chapter (title,para+)>
 
   Nested entity declarations are allowed.  For example:
 
     @xml_markup.declare! :DOCTYPE, :chapter do |x|
-      x.declare! :ELEMENT, :chapter, "(title,para+)".intern
-      x.declare! :ELEMENT, :title, "(#PCDATA)".intern
-      x.declare! :ELEMENT, :para, "(#PCDATA)".intern
+      x.declare! :ELEMENT, :chapter, :"(title,para+)"
+      x.declare! :ELEMENT, :title, :"(#PCDATA)"
+      x.declare! :ELEMENT, :para, :"(#PCDATA)"
     end
 
     #=>
@@ -129,7 +161,7 @@ incompatibility are:
       <!ELEMENT para (#PCDATA)>
     ]>
 
-* Direct support for XML namespaces is now available.  If the first
+* Some support for XML namespaces is now available.  If the first
   argument to a tag call is a symbol, it will be joined to the tag to
   produce a namespace:tag combination.  It is easier to show this than
   describe it.
@@ -140,6 +172,36 @@ incompatibility are:
   right form for builder (e.g. "<tt>SOAP:Envelope</tt>" =>
   "<tt>xml.SOAP :Envelope</tt>")
 
+* String attribute values are <em>now</em> escaped by default by
+  Builder (<b>NOTE:</b> this is _new_ behavior as of version 2.0).
+
+  However, occasionally you need to use entities in attribute values.
+  Using a symbols (rather than a string) for an attribute value will
+  cause Builder to not run its quoting/escaping algorithm on that
+  particular value.
+
+  (<b>Note:</b> The +escape_attrs+ option for builder is now
+  obsolete).
+
+  Example:
+
+    xml = Builder::XmlMarkup.new
+    xml.sample(:escaped=>"This&That", :unescaped=>:"Here&amp;There")
+    xml.target!  =>
+      <sample escaped="This&amp;That" unescaped="Here&amp;There"/>
+
+* UTF-8 Support
+
+  Builder correctly translates UTF-8 characters into valid XML.  (New
+  in version 2.0.0).  Thanks to Sam Ruby for the translation code.
+
+  Example:
+
+    xml = Builder::Markup.new
+    xml.sample("I�t�rn�ti�n�l")
+    xml.target!  =>
+      "<sample>I&#241;t&#235;rn&#226;ti&#244;n&#224;l</sample>"
+
 == Contact
 
 Author::     Jim Weirich

data/Rakefile

@@ -1,6 +1,6 @@
 # Rakefile for rake        -*- ruby -*-
 
-# Copyright 2004 by Jim Weirich (jim@weirichhouse.org).
+# Copyright 2004, 2005, 2006 by Jim Weirich (jim@weirichhouse.org).
 # All rights reserved.
 
 # Permission is granted for use, copying, modification, distribution,
@@ -17,20 +17,29 @@ rescue Exception
   nil
 end
 
-PKG_VERSION = "1.2.4"
+# Determine the current version of the software
+
+CURRENT_VERSION = '2.0.0'
+PKG_VERSION = ENV['REL'] ? ENV['REL'] : CURRENT_VERSION
 
 SRC_RB = FileList['lib/**/*.rb']
 
 # The default task is run if rake is given no explicit arguments.
 
 desc "Default Task"
-task :default => :test
+task :default => :test_all
 
 # Test Tasks ---------------------------------------------------------
 
-Rake::TestTask.new do |t|
+desc "Run all tests"
+task :test_all => [:test_units]
+task :ta => [:test_all]
+
+task :tu => [:test_units]
+
+Rake::TestTask.new("test_units") do |t|
   t.test_files = FileList['test/test*.rb']
-  t.verbose = true
+  t.verbose = false
 end
 
 # Create a task to build the RDOC documentation tree.
@@ -39,8 +48,8 @@ rd = Rake::RDocTask.new("rdoc") { |rdoc|
   rdoc.rdoc_dir = 'html'
   rdoc.title    = "Builder for Markup"
   rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
-  rdoc.rdoc_files.include('lib/**/*.rb', '[A-Z]*')
-  rdoc.template = 'jamis'
+  rdoc.rdoc_files.include('lib/**/*.rb', '[A-Z]*', 'doc/**/*.rdoc')
+  rdoc.template = 'doc/jamis.rb'
 }
 
 # ====================================================================
@@ -52,6 +61,8 @@ PKG_FILES = FileList[
   'test/**/*.rb',
   'scripts/**/*.rb'
 ]
+PKG_FILES.exclude('test/testcssbuilder.rb')
+PKG_FILES.exclude('lib/builder/css.rb')
 
 if ! defined?(Gem)
   puts "Package Target requires RubyGEMs"
@@ -68,15 +79,14 @@ Builder provides a number of builder objects that make creating structured data
 simple to do.  Currently the following builder objects are supported:
 
 * XML Markup
-* XML Events	
+* XML Events
 EOS
 
     s.files = PKG_FILES.to_a
-
     s.require_path = 'lib'
     s.autorequire = 'builder'
 
-    s.test_files = Dir['test/test*.rb']
+    s.test_files = PKG_FILES.select { |fn| fn =~ /^test\/test/ }
 
     s.has_rdoc = true
     s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
@@ -90,7 +100,116 @@ EOS
     s.homepage = "http://onestepback.org"
   end
 
-  Rake::GemPackageTask.new(spec) do  end
+    Rake::GemPackageTask.new(spec) do |t|
+      t.need_tar = true
+    end
+end
+
+desc "Look for Debugging print lines"
+task :dbg do
+  FileList['**/*.rb'].egrep /\bDBG|\bbreakpoint\b/
+end
+  
+# --------------------------------------------------------------------
+# Creating a release
+
+def announce(msg='')
+  STDERR.puts msg
+end
+
+desc "Make a new release"
+task :release => [
+  :prerelease,
+  :clobber,
+  :test_all,
+  :update_version,
+  :package,
+  :tag] do
+  
+  announce 
+  announce "**************************************************************"
+  announce "* Release #{PKG_VERSION} Complete."
+  announce "* Packages ready to upload."
+  announce "**************************************************************"
+  announce 
+end
+
+# Validate that everything is ready to go for a release.
+task :prerelease do
+  announce 
+  announce "**************************************************************"
+  announce "* Making RubyGem Release #{PKG_VERSION}"
+  announce "* (current version #{CURRENT_VERSION})"
+  announce "**************************************************************"
+  announce  
+
+  # Is a release number supplied?
+  unless ENV['REL']
+    fail "Usage: rake release REL=x.y.z [REUSE=tag_suffix]"
+  end
+
+  # Is the release different than the current release.
+  # (or is REUSE set?)
+  if PKG_VERSION == CURRENT_VERSION && ! ENV['REUSE']
+    fail "Current version is #{PKG_VERSION}, must specify REUSE=tag_suffix to reuse version"
+  end
+
+  # Are all source files checked in?
+  if ENV['RELTEST']
+    announce "Release Task Testing, skipping checked-in file test"
+  else
+    announce "Checking for unchecked-in files..."
+    data = `cvs -q update`
+    unless data =~ /^$/
+      fail "CVS update is not clean ... do you have unchecked-in files?"
+    end
+    announce "No outstanding checkins found ... OK"
+  end
+end
+
+task :update_version => [:prerelease] do
+  if PKG_VERSION == CURRENT_VERSION
+    announce "No version change ... skipping version update"
+  else
+    announce "Updating Builder version to #{PKG_VERSION}"
+    open("Rakefile") do |rakein|
+      open("Rakefile.new", "w") do |rakeout|
+	rakein.each do |line|
+	  if line =~ /^CURRENT_VERSION\s*=\s*/
+	    rakeout.puts "CURRENT_VERSION = '#{PKG_VERSION}'"
+	  else
+	    rakeout.puts line
+	  end
+	end
+      end
+    end
+    mv "Rakefile.new", "Rakefile"
+    if ENV['RELTEST']
+      announce "Release Task Testing, skipping commiting of new version"
+    else
+      sh %{cvs commit -m "Updated to version #{PKG_VERSION}" Rakefile}
+    end
+  end
+end
+
+desc "Tag all the CVS files with the latest release number (REL=x.y.z)"
+task :tag => [:prerelease] do
+  reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
+  reltag << ENV['REUSE'].gsub(/\./, '_') if ENV['REUSE']
+  announce "Tagging CVS with [#{reltag}]"
+  if ENV['RELTEST']
+    announce "Release Task Testing, skipping CVS tagging"
+  else
+    sh %{cvs tag #{reltag}}
+  end
+end
+
+desc "Install the jamis RDoc template"
+task :install_jamis_template do
+  require 'rbconfig'
+  dest_dir = File.join(Config::CONFIG['rubylibdir'], "rdoc/generators/template/html")
+  fail "Unabled to write to #{dest_dir}" unless File.writable?(dest_dir)
+  install "doc/jamis.rb", dest_dir, :verbose => true
 end
 
 require 'scripts/publish'

data/doc/releases/builder-1.2.4.rdoc

@@ -0,0 +1,31 @@
+= Builder 1.2.4 Released.
+
+Added a "CDATA" method to the XML Markup builder (from Josh Knowles).
+
+== What is Builder?
+
+Builder::XmlMarkup allows easy programmatic creation of XML markup.
+For example:
+
+  builder = Builder::XmlMarkup.new(:target=>STDOUT, :indent=>2)
+  builder.person { |b| b.name("Jim"); b.phone("555-1234") }
+  puts builder.target!
+
+will generate:
+
+  <person>
+    <name>Jim</name>
+    <phone>555-1234</phone>
+  </person>
+
+== Availability
+
+The easiest way to get and install builder is via RubyGems ...
+
+  gem install builder    (you may need root/admin privileges)
+
+== Thanks
+
+* Josh Knowles for the cdata! patch.
+
+-- Jim Weirich

data/doc/releases/builder-2.0.0.rdoc

@@ -0,0 +1,46 @@
+= Builder 2.0.0 Released.
+
+== Changes in 2.0.0
+
+* UTF-8 characters in data are now correctly translated to their XML
+  equivalents. (Thanks to Sam Ruby)
+
+* Attribute values are now escaped by default.  See the README
+  file for details.
+
+<b>NOTE:</b> The escaping attribute values by default is different
+than in previous releases of Builder.  This makes version 2.0.0
+somewhat incompatible with the 1.x series of Builder.  If you use "&",
+"<", or ">" in attributes values, you may have to change your
+code. (Essentially you remove the manual escaping.  The new way is
+easier, believe me).
+
+== What is Builder?
+
+Builder::XmlMarkup is a library that allows easy programmatic creation
+of XML markup.  For example:
+
+  builder = Builder::XmlMarkup.new(:target=>STDOUT, :indent=>2)
+  builder.person { |b| b.name("Jim"); b.phone("555-1234") }
+
+will generate:
+
+  <person>
+    <name>Jim</name>
+    <phone>555-1234</phone>
+  </person>
+
+== Availability
+
+The easiest way to get and install builder is via RubyGems ...
+
+  gem install builder    (you may need root/admin privileges)
+
+== Thanks
+
+* Sam Ruby for the XChar module and the related UTF-8 translation
+  tools.
+* Also to Sam Ruby for gently persuading me to start quoting attribute
+  values.
+
+-- Jim Weirich

data/lib/builder/blankslate.rb

@@ -16,6 +16,9 @@ module Builder
   # depend upon <tt>method_missing</tt> (e.g. dynamic proxies).
   class BlankSlate
     class << self
+
+      # Hide the method named +name+ in the BlankSlate class.  Don't
+      # hide +instance_eval+ or any method beginning with "__".
       def hide(name)
 	undef_method name if
 	  instance_methods.include?(name.to_s) and
@@ -29,10 +32,14 @@ end
 
 # Since Ruby is very dynamic, methods added to the ancestors of
 # BlankSlate <em>after BlankSlate is defined</em> will show up in the
-# list of available BlankSlate methods.  We handle this by defining a hook in the Object and Kernel classes that will hide any defined 
+# list of available BlankSlate methods.  We handle this by defining a
+# hook in the Object and Kernel classes that will hide any defined
 module Kernel
   class << self
     alias_method :blank_slate_method_added, :method_added
+
+    # Detect method additions to Kernel and remove them in the
+    # BlankSlate class.
     def method_added(name)
       blank_slate_method_added(name)
       return if self != Kernel
@@ -44,6 +51,9 @@ end
 class Object
   class << self
     alias_method :blank_slate_method_added, :method_added
+
+    # Detect method additions to Object and remove them in the
+    # BlankSlate class.
     def method_added(name)
       blank_slate_method_added(name)
       return if self != Object

data/lib/builder/xchar.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+
+# The XChar library is provided courtesy of Sam Ruby (See
+# http://intertwingly.net/stories/2005/09/28/xchar.rb)
+
+# --------------------------------------------------------------------
+
+# If the Builder::XChar module is not currently defined, fail on any
+# name clashes in standard library classes.
+
+module Builder
+  def self.check_for_name_collision(klass, method_name, defined_constant=nil)
+    if klass.instance_methods.include?(method_name)
+      fail RuntimeError,
+	"Name Collision: Method '#{method_name}' is already defined in #{klass}"
+    end
+  end
+end
+
+if ! defined?(Builder::XChar)
+  Builder.check_for_name_collision(String, "to_xs")
+  Builder.check_for_name_collision(Fixnum, "xchr")
+end
+
+######################################################################
+module Builder
+
+  ####################################################################
+  # XML Character converter, from Sam Ruby:
+  # (see http://intertwingly.net/stories/2005/09/28/xchar.rb). 
+  #
+  module XChar # :nodoc:
+
+    # See
+    # http://intertwingly.net/stories/2004/04/14/i18n.html#CleaningWindows
+    # for details.
+    CP1252 = {			# :nodoc:
+      128 => 8364,		# euro sign
+      130 => 8218,		# single low-9 quotation mark
+      131 =>  402,		# latin small letter f with hook
+      132 => 8222,		# double low-9 quotation mark
+      133 => 8230,		# horizontal ellipsis
+      134 => 8224,		# dagger
+      135 => 8225,		# double dagger
+      136 =>  710,		# modifier letter circumflex accent
+      137 => 8240,		# per mille sign
+      138 =>  352,		# latin capital letter s with caron
+      139 => 8249,		# single left-pointing angle quotation mark
+      140 =>  338,		# latin capital ligature oe
+      142 =>  381,		# latin capital letter z with caron
+      145 => 8216,		# left single quotation mark
+      146 => 8217,		# right single quotation mark
+      147 => 8220,		# left double quotation mark
+      148 => 8221,		# right double quotation mark
+      149 => 8226,		# bullet
+      150 => 8211,		# en dash
+      151 => 8212,		# em dash
+      152 =>  732,		# small tilde
+      153 => 8482,		# trade mark sign
+      154 =>  353,		# latin small letter s with caron
+      155 => 8250,		# single right-pointing angle quotation mark
+      156 =>  339,		# latin small ligature oe
+      158 =>  382,		# latin small letter z with caron
+      159 =>  376,		# latin capital letter y with diaeresis
+    }
+
+    # See http://www.w3.org/TR/REC-xml/#dt-chardata for details.
+    PREDEFINED = {
+      38 => '&',		# ampersand
+      60 => '<',		# left angle bracket
+      62 => '>',		# right angle bracket
+    }
+
+    # See http://www.w3.org/TR/REC-xml/#charsets for details.
+    VALID = [
+      [0x9, 0xA, 0xD],
+      (0x20..0xD7FF), 
+      (0xE000..0xFFFD),
+      (0x10000..0x10FFFF)
+    ]
+  end
+
+end
+
+
+######################################################################
+# Enhance the Fixnum class with a XML escaped character conversion.
+#
+class Fixnum
+  XChar = Builder::XChar if ! defined?(XChar)
+
+  # XML escaped version of chr
+  def xchr
+    n = XChar::CP1252[self] || self
+    n = 42 unless XChar::VALID.find {|range| range.include? n}
+    XChar::PREDEFINED[n] or (n<128 ? n.chr : "&##{n};")
+  end
+end
+
+
+######################################################################
+# Enhance the String class with a XML escaped character version of
+# to_s.
+#
+class String
+  # XML escaped version of to_s
+  def to_xs
+    unpack('U*').map {|n| n.xchr}.join # ASCII, UTF-8
+  rescue
+    unpack('C*').map {|n| n.xchr}.join # ISO-8859-1, WIN-1252
+  end
+end

data/lib/builder/xmlbase.rb

@@ -13,7 +13,7 @@ module Builder
 
     # Create an XML markup builder.
     #
-    # out::     Object receiving the markup.1  +out+ must respond to
+    # out::     Object receiving the markup.  +out+ must respond to
     #           <tt><<</tt>.
     # indent::  Number of spaces used for indentation (0 implies no
     #           indentation and no line breaks).
@@ -111,11 +111,13 @@ module Builder
 
     private
     
+    require 'builder/xchar'
     def _escape(text)
-      text.
-	gsub(%r{&}, '&amp;').
-	gsub(%r{<}, '&lt;').
-	gsub(%r{>}, '&gt;')
+      text.to_xs
+    end
+
+    def _escape_quote(text)
+      _escape(text).gsub(%r{"}, '&quot;')  # " WART
     end
 
     def _capture_outer_self(block)

data/lib/builder/xmlmarkup.rb

@@ -165,13 +165,23 @@ module Builder
     # :target=><em>target_object</em>::
     #    Object receiving the markup.  +out+ must respond to the
     #    <tt><<</tt> operator.  The default is a plain string target.
+    #    
     # :indent=><em>indentation</em>::
     #    Number of spaces used for indentation.  The default is no
     #    indentation and no line breaks.
+    #    
     # :margin=><em>initial_indentation_level</em>::
     #    Amount of initial indentation (specified in levels, not
     #    spaces).
     #    
+    # :escape_attrs=><b>OBSOLETE</em>::
+    #    The :escape_attrs option is no longer supported by builder
+    #    (and will be quietly ignored).  String attribute values are
+    #    now automatically escaped.  If you need unescaped attribute
+    #    values (perhaps you are using entities in the attribute
+    #    values), then give the value as a Symbol.  This allows much
+    #    finer control over escaping attribute values.
+    #    
     def initialize(options={})
       indent = options[:indent] || 0
       margin = options[:margin] || 0
@@ -290,10 +300,19 @@ module Builder
       return if attrs.nil?
       order.each do |k|
 	v = attrs[k]
-	@target << %{ #{k}="#{v}"} if v
+	@target << %{ #{k}="#{_attr_value(v)}"} if v
       end
       attrs.each do |k, v|
-	@target << %{ #{k}="#{v}"} unless order.member?(k)
+	@target << %{ #{k}="#{_attr_value(v)}"} unless order.member?(k)
+      end
+    end
+
+    def _attr_value(value)
+      case value
+      when Symbol
+	value.to_s
+      else
+	_escape_quote(value.to_s)
       end
     end
 

data/test/performance.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'builder/xmlmarkup'
+require 'benchmark'
+
+text = "This is a test of the new xml markup. I�t�rn�ti�n�liz�ti�n\n" * 10000
+
+include Benchmark          # we need the CAPTION and FMTSTR constants
+include Builder
+n = 50
+Benchmark.benchmark do |bm|
+  tf = bm.report("base")   {
+    n.times do
+      x = XmlMarkup.new
+      x.text(text)
+      x.target!
+    end
+  }
+  def XmlMarkup._escape(text)
+    text.to_xs
+  end
+  tf = bm.report("to_xs")   {
+    n.times do
+      x = XmlMarkup.new
+      x.text(text)
+      x.target!
+    end
+  }
+end
+

data/test/test_xchar.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'builder/xchar'
+
+class TestXmlEscaping < Test::Unit::TestCase
+  def test_ascii
+    assert_equal 'abc', 'abc'.to_xs
+  end
+
+  def test_predefined
+    assert_equal '&amp;', '&'.to_xs              # ampersand
+    assert_equal '&lt;',  '<'.to_xs              # left angle bracket
+    assert_equal '&gt;',  '>'.to_xs              # right angle bracket
+  end
+
+  def test_invalid
+    assert_equal '*', "\x00".to_xs               # null
+    assert_equal '*', "\x0C".to_xs               # form feed
+    assert_equal '*', "\xEF\xBF\xBF".to_xs       # U+FFFF
+  end
+
+  def test_iso_8859_1
+    assert_equal '&#231;', "\xE7".to_xs          # small c cedilla
+    assert_equal '&#169;', "\xA9".to_xs          # copyright symbol
+  end
+
+  def test_win_1252
+    assert_equal '&#8217;', "\x92".to_xs         # smart quote
+    assert_equal '&#8364;', "\x80".to_xs         # euro
+  end
+
+  def test_utf8
+    assert_equal '&#8217;', "\xE2\x80\x99".to_xs # right single quote
+    assert_equal '&#169;',  "\xC2\xA9".to_xs     # copy
+  end
+end

data/test/testeventbuilder.rb

@@ -0,0 +1,133 @@
+class TestEvents < Test::Unit::TestCase
+
+  class Target
+    attr_reader :events
+
+    def initialize
+      @events = []
+    end
+
+    def start_tag(tag, attrs)
+      @events << [:start_tag, tag, attrs]
+    end
+
+    def end_tag(tag)
+      @events << [:end_tag, tag]
+    end
+    
+    def text(string)
+      @events << [:text, string]
+    end
+    
+  end
+
+
+  def setup
+    @target = Target.new
+    @xml = Builder::XmlEvents.new(:target=>@target)
+  end
+
+  def test_simple
+    @xml.one
+    expect [:start_tag, :one, nil]
+    expect [:end_tag, :one]
+    expect_done
+  end
+
+  def test_nested
+    @xml.one { @xml.two }
+    expect [:start_tag, :one, nil]
+    expect [:start_tag, :two, nil]
+    expect [:end_tag, :two]
+    expect [:end_tag, :one]
+    expect_done
+  end
+
+  def test_text
+    @xml.one("a")
+    expect [:start_tag, :one, nil]
+    expect [:text, "a"]
+    expect [:end_tag, :one]
+    expect_done
+  end
+
+  def test_special_text
+    @xml.one("H&R")
+    expect [:start_tag, :one, nil]
+    expect [:text, "H&R"]
+    expect [:end_tag, :one]
+    expect_done
+  end
+
+  def test_text_with_entity
+    @xml.one("H&amp;R")
+    expect [:start_tag, :one, nil]
+    expect [:text, "H&amp;R"]
+    expect [:end_tag, :one]
+    expect_done
+  end
+
+  def test_attributes
+    @xml.a(:b=>"c", :x=>"y")
+    expect [:start_tag, :a, {:x => "y", :b => "c"}]
+    expect [:end_tag, :a]
+    expect_done
+  end
+
+  def test_moderately_complex
+    @xml.tag! "address-book" do |x|
+      x.entry :id=>"1" do
+	x.name {
+	  x.first "Bill"
+	  x.last "Smith"
+	}
+	x.address "Cincinnati"
+      end
+      x.entry :id=>"2" do
+	x.name {
+	  x.first "John"
+	  x.last "Doe"
+	}
+	x.address "Columbus"
+      end
+    end
+    expect [:start_tag, "address-book".intern, nil]
+    expect [:start_tag, :entry, {:id => "1"}]
+    expect [:start_tag, :name, nil]
+    expect [:start_tag, :first, nil]
+    expect [:text, "Bill"]
+    expect [:end_tag, :first]
+    expect [:start_tag, :last, nil]
+    expect [:text, "Smith"]
+    expect [:end_tag, :last]
+    expect [:end_tag, :name]
+    expect [:start_tag, :address, nil]
+    expect [:text, "Cincinnati"]
+    expect [:end_tag, :address]
+    expect [:end_tag, :entry]
+    expect [:start_tag, :entry, {:id => "2"}]
+    expect [:start_tag, :name, nil]
+    expect [:start_tag, :first, nil]
+    expect [:text, "John"]
+    expect [:end_tag, :first]
+    expect [:start_tag, :last, nil]
+    expect [:text, "Doe"]
+    expect [:end_tag, :last]
+    expect [:end_tag, :name]
+    expect [:start_tag, :address, nil]
+    expect [:text, "Columbus"]
+    expect [:end_tag, :address]
+    expect [:end_tag, :entry]
+    expect [:end_tag, "address-book".intern]
+    expect_done
+  end
+
+  def expect(value)
+    assert_equal value, @target.events.shift
+  end
+
+  def expect_done
+    assert_nil @target.events.shift
+  end
+
+end

data/test/testmarkupbuilder.rb

@@ -1,5 +1,15 @@
 #!/usr/bin/env ruby
 
+#--
+# Portions copyright 2004 by Jim Weirich (jim@weirichhouse.org).
+# Portions copyright 2005 by Sam Ruby (rubys@intertwingly.net).
+# 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.
+#++
+
 require 'test/unit'
 require 'test/preload'
 require 'builder'
@@ -34,6 +44,31 @@ class TestMarkup < Test::Unit::TestCase
     assert_equal %{<ref id="12"/>}, @xml.target!
   end
 
+  def test_string_attributes_are_quoted_by_default
+    @xml.ref(:id => "H&R")
+    assert_equal %{<ref id="H&amp;R"/>}, @xml.target!
+  end
+
+  def test_symbol_attributes_are_unquoted_by_default
+    @xml.ref(:id => :"H&amp;R")
+    assert_equal %{<ref id="H&amp;R"/>}, @xml.target!
+  end
+
+  def test_attributes_quoted_can_be_turned_on
+    @xml = Builder::XmlMarkup.new
+    @xml.ref(:id => "<H&R \"block\">")
+    assert_equal %{<ref id="&lt;H&amp;R &quot;block&quot;&gt;"/>}, @xml.target!
+  end
+
+  def test_mixed_attribute_quoting_with_nested_builders
+    x = Builder::XmlMarkup.new(:target=>@xml)
+    @xml.ref(:id=>:"H&amp;R") {
+      x.element(:tag=>"Long&Short")
+    }
+    assert_equal "<ref id=\"H&amp;R\"><element tag=\"Long&amp;Short\"/></ref>",
+      @xml.target!
+  end
+
   def test_multiple_attributes
     @xml.ref(:id => 12, :name => "bill")
     assert_match %r{^<ref( id="12"| name="bill"){2}/>$}, @xml.target!
@@ -96,7 +131,7 @@ class TestMarkup < Test::Unit::TestCase
   end
 
   def test_non_escaping
-    @xml.div("ns:xml"=>"&xml;") { |x| x << "<h&i>"; x.em("H&R Block") }
+    @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>}, @xml.target!
   end
 
@@ -116,6 +151,44 @@ class TestMarkup < Test::Unit::TestCase
   end
 end
 
+class TestAttributeEscaping < Test::Unit::TestCase
+
+  def setup
+    @xml = Builder::XmlMarkup.new
+  end
+
+  def test_element_gt
+    @xml.title('1<2')
+    assert_equal '<title>1&lt;2</title>', @xml.target!
+  end
+
+  def test_element_amp
+    @xml.title('AT&T')
+    assert_equal '<title>AT&amp;T</title>', @xml.target!
+  end
+
+  def test_element_amp2
+    @xml.title('&amp;')
+    assert_equal '<title>&amp;amp;</title>', @xml.target!
+  end
+
+  def test_attr_less
+    @xml.a(:title => '2>1')
+    assert_equal '<a title="2&gt;1"/>', @xml.target!
+  end
+
+  def test_attr_amp
+    @xml.a(:title => 'AT&T')
+    assert_equal '<a title="AT&amp;T"/>', @xml.target!
+  end
+
+  def test_attr_quot
+    @xml.a(:title => '"x"')
+    assert_equal '<a title="&quot;x&quot;"/>', @xml.target!
+  end
+
+end
+
 class TestNameSpaces < Test::Unit::TestCase
   def setup
     @xml = Builder::XmlMarkup.new(:indent=>2)
@@ -130,11 +203,11 @@ class TestNameSpaces < Test::Unit::TestCase
     xml = Builder::XmlMarkup.new(:indent=>2)
     xml.instruct!
     xml.rdf :RDF, 
-      "xmlns:rdf" => "&rdf;",
-      "xmlns:rdfs" => "&rdfs;",
-      "xmlns:xsd" => "&xsd;",
-      "xmlns:owl" => "&owl;" do
-      xml.owl :Class, 'rdf:ID'=>'Bird' do
+      "xmlns:rdf" => :"&rdf;",
+      "xmlns:rdfs" => :"&rdfs;",
+      "xmlns:xsd" => :"&xsd;",
+      "xmlns:owl" => :"&owl;" do
+      xml.owl :Class, :'rdf:ID'=>'Bird' do
 	xml.rdfs :label, 'bird'
 	xml.rdfs :subClassOf do
 	  xml.owl :Restriction do

metadata

@@ -1,62 +1,73 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10.4
+rubygems_version: 0.8.11.6
 specification_version: 1
 name: builder
 version: !ruby/object:Gem::Version 
-  version: 1.2.4
-date: 2005-07-01 00:00:00 -04:00
+  version: 2.0.0
+date: 2006-02-05 00:00:00 -05:00
 summary: Builders for MarkUp.
 require_paths: 
-  - lib
+- lib
 email: jim@weirichhouse.org
 homepage: http://onestepback.org
 rubyforge_project: 
-description: "Builder provides a number of builder objects that make creating structured data
-  simple to do.  Currently the following builder objects are supported:  * XML
-  Markup * XML Events"
+description: "Builder provides a number of builder objects that make creating structured data simple to do.  Currently the following builder objects are supported:  * XML Markup * XML Events"
 autorequire: builder
 default_executable: 
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
 authors: 
-  - Jim Weirich
+- Jim Weirich
 files: 
-  - lib/builder.rb
-  - lib/builder/xmlmarkup.rb
-  - lib/builder/xmlbase.rb
-  - lib/builder/blankslate.rb
-  - lib/builder/xmlevents.rb
-  - test/testmarkupbuilder.rb
-  - test/testblankslate.rb
-  - test/preload.rb
-  - scripts/publish.rb
-  - README
-  - Rakefile
-  - CHANGES
+- lib/builder.rb
+- lib/builder/xmlmarkup.rb
+- lib/builder/xmlbase.rb
+- lib/builder/blankslate.rb
+- lib/builder/xmlevents.rb
+- lib/builder/xchar.rb
+- test/testmarkupbuilder.rb
+- test/testblankslate.rb
+- test/preload.rb
+- test/test_xchar.rb
+- test/testeventbuilder.rb
+- test/performance.rb
+- scripts/publish.rb
+- README
+- Rakefile
+- CHANGES
+- doc/releases/builder-1.2.4.rdoc
+- doc/releases/builder-2.0.0.rdoc
 test_files: 
-  - test/testmarkupbuilder.rb
-  - test/testblankslate.rb
+- test/testmarkupbuilder.rb
+- test/testblankslate.rb
+- test/test_xchar.rb
+- test/testeventbuilder.rb
 rdoc_options: 
-  - "--title"
-  - "Builder -- Easy XML Building"
-  - "--main"
-  - README
-  - "--line-numbers"
+- --title
+- Builder -- Easy XML Building
+- --main
+- README
+- --line-numbers
 extra_rdoc_files: 
-  - README
-  - Rakefile
-  - CHANGES
+- README
+- Rakefile
+- CHANGES
+- doc/releases/builder-1.2.4.rdoc
+- doc/releases/builder-2.0.0.rdoc
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+