wax 0.9.4 → 0.9.5

data/lib/address.rb

@@ -0,0 +1,16 @@
+class Address
+  attr_accessor :street, :city, :state, :zip
+
+  def initialize(street, city, state, zip)
+    @street, @city, @state, @zip = street, city, state, zip
+  end
+
+  def to_xml(wax)
+    wax.start('address').
+      child('street', @street).
+      child('city', @city).
+      child('state', @state).
+      child('zip', @zip).
+      end!
+  end
+end

data/lib/car.rb

@@ -0,0 +1,22 @@
+class Car
+  attr_accessor :make, :model, :year
+
+  def initialize(make, model, year)
+    @make, @model, @year = make, model, year
+  end
+
+  def to_xml(wax)
+    wax.start('car').attr('year', @year).
+      child('make', @make).
+      child('model', @model).
+      end!
+  end
+end
+
+if $PROGRAM_NAME == __FILE__ || $PROGRAM_NAME =~ /\/rake/
+  require 'wax'
+  car = Car.new 'Toyota', 'Prius', 2008
+  wax = WAX.new
+  car.to_xml(wax)
+  wax.close
+end

data/lib/instance_exec.rb

@@ -1,6 +1,7 @@
+# This implements the Object#instance_exec method
+# for versions that don't have it (before 1.9).
 # This solution was found at
-# http://www.jroller.com/abstractScope/entry/
-# passing_parameters_to_an_instance
+# http://www.jroller.com/abstractScope/entry/passing_parameters_to_an_instance.
 
 # Add a bind method to the Proc class.
 class Proc

data/lib/person.rb

@@ -0,0 +1,24 @@
+class Person
+  attr_accessor :name, :birthdate, :address
+
+  def initialize(name, birthdate, address)
+    @name, @birthdate, @address = name, birthdate, address
+  end
+
+  def to_xml(wax)
+    wax.start('person').attr('birthdate', @birthdate).child('name', @name)
+    @address.to_xml(wax)
+    wax.end!
+  end
+end
+
+if $PROGRAM_NAME == __FILE__ || $PROGRAM_NAME =~ /\/rake/
+  require 'address'
+  require 'wax'
+
+  address = Address.new('123 Some Street', 'Some City', 'MO', 12345)
+  person = Person.new('R. Mark Volkmann', '4/16/1961', address)
+  wax = WAX.new
+  person.to_xml(wax)
+  wax.close
+end

data/lib/tutorial.rb

@@ -1,190 +1,214 @@
 require 'wax'
 
-# This serves as a tutorial for using WAX.
+# This serves as a tutorial for using WAX for Ruby.
 
 def out(text)
   puts "\n\n#{text}\n"
 end
 
-# When the no-arg WAX constructor is used, XML is written to stdout.
-# There are also WAX constructors that take an IO object.
-wax = WAX.new
+# When nothing is passed to the WAX.write method, XML is written to $stdout.
+# There is also a WAX.write method that takes an IO object.
 
-out "Only a root element:"
-wax.start("car").close
+out 'Only a root element:'
+WAX.write { start 'car' }
 # <car/>
 
-# After a WAX object is closed,
-# a new one must be created to write more XML.
-wax = WAX.new
-
-out "A root element with some text inside:"
-wax.start("car").text("Prius").close
+out 'A root element with some text inside:'
+WAX.write do
+  start 'car'
+  text 'Prius'
+end
 # <car>Prius</car>
 
-out "Text inside a child element:"
-wax = WAX.new
-wax.start("car").start("model").text("Prius").close
+out 'Text inside a child element:'
+WAX.write do
+  start 'car'
+  start 'model'
+  text 'Prius'
+end
 # <car>
 #   <model>Prius</model>
 # </car>
 
-out "The same with the \"child\" convenience method:"
-wax = WAX.new
-wax.start("car").child("model", "Prius").close
+out 'The same with the \'child\' convenience method:'
+WAX.write do
+  start 'car'
+  child 'model', 'Prius'
+end
 # <car>
 #   <model>Prius</model>
 # </car>
 
-out "Text in a CDATA section:"
-wax = WAX.new
-wax.start("car").start("model").cdata("1<2>3&4'5\"6").close
+out 'Text in a CDATA section:'
+WAX.write do
+  start 'car'
+  start 'model'
+  cdata "1<2>3&4'5\"6"
+end
 # <car>
 #   <model>
 #     <![CDATA[1<2>3&4'5\"6]]>
 #   </model>
 # </car>
 
-out "Without indentation, on a single line:"
-wax = WAX.new
-wax.set_indent(nil)
-wax.start("car").child("model", "Prius").close
+out 'Without indentation, on a single line:'
+WAX.write do
+  set_indent nil
+  start 'car'
+  child 'model', 'Prius'
+end
 # <car><model>Prius</model></car>
 
-out "Indent with four spaces instead of the default of two:"
-wax = WAX.new
-wax.set_indent("    ")
-wax.start("car").child("model", "Prius").close
+out 'Indent with four spaces instead of the default of two:'
+WAX.write do
+  set_indent '    ' # could also pass 4
+  start 'car'
+  child 'model', 'Prius'
+end
 # <car>
 #     <model>Prius</model>
 # </car>
 
-out "Add an attribute:"
-wax = WAX.new
-wax.start("car").attr("year", 2008).child("model", "Prius").close
-# <car year="2008">
+out 'Add an attribute:'
+WAX.write do
+  start 'car'
+  attr 'year', 2008
+  child 'model', 'Prius'
+end
+# <car year='2008'>
 #   <model>Prius</model>
 # </car>
 
-out "XML declaration:"
-wax = WAX.new($stdout, "1.0")
-wax.start("car").attr("year", 2008).child("model", "Prius").close
-# <?xml version="1.0" encoding="UTF-8"?>
-# <car year="2008">
+out 'XML declaration:'
+WAX.write($stdout, '1.0') do
+  start 'car'
+  attr 'year', 2008
+  child 'model', 'Prius'
+end
+# <?xml version='1.0' encoding='UTF-8'?>
+# <car year='2008'>
 #   <model>Prius</model>
 # </car>
 
-out "Comment:"
+out 'Comment:'
 WAX.write do
-  comment "This is a hybrid car."
-  start "car"
-  child "model", "Prius"
+  comment 'This is a hybrid car.'
+  start 'car'
+  child 'model', 'Prius'
 end
 # <!-- This is a hybrid car. -->
 # <car>
 #   <model>Prius</model>
 # </car>
 
-out "Processing instruction:"
+out 'Processing instruction:'
 WAX.write do
-  processing_instruction "target", "data"
-  start "car"
-  attr "year", 2008
-  child "model", "Prius"
+  processing_instruction 'target', 'data'
+  start 'car'
+  attr 'year', 2008
+  child 'model', 'Prius'
 end
 # <?target data?>
-# <car year="2008">
+# <car year='2008'>
 #   <model>Prius</model>
 # </car>
 
-out "Associate an XSLT stylesheet:"
+out 'Associate an XSLT stylesheet:'
 WAX.write do
-  xslt "car.xslt"
-  start "car"
-  attr "year", 2008
-  child "model", "Prius"
+  xslt 'car.xslt'
+  start 'car'
+  attr 'year', 2008
+  child 'model', 'Prius'
 end
-# <?xml-stylesheet type="text/xsl" href="car.xslt"?>
-# <car year="2008">
+# <?xml-stylesheet type='text/xsl' href='car.xslt'?>
+# <car year='2008'>
 #   <model>Prius</model>
 # </car>
 
-out "Associate a default namespace:"
+out 'Associate a default namespace:'
 WAX.write do
-  xslt "car.xslt"
-  start "car"
-  attr "year", 2008
-  namespace "http://www.ociweb.com/cars"
-  child "model", "Prius"
+  xslt 'car.xslt'
+  start 'car'
+  attr 'year', 2008
+  namespace 'http://www.ociweb.com/cars'
+  child 'model', 'Prius'
 end
-# <car year="2008"
-#   xmlns="http://www.ociweb.com/cars">
+# <car year='2008'
+#   xmlns='http://www.ociweb.com/cars'>
 #   <model>Prius</model>
 # </car>
 
-out "Associate a non-default namespace with the XML:"
-prefix = "c"
+out 'Associate a non-default namespace with the XML:'
+prefix = 'c'
 WAX.write do
-  start prefix, "car"
-  attr "year", 2008
-  namespace prefix, "http://www.ociweb.com/cars"
-  child prefix, "model", "Prius"
+  start prefix, 'car'
+  attr 'year', 2008
+  namespace prefix, 'http://www.ociweb.com/cars'
+  child prefix, 'model', 'Prius'
 end
-# <c:car year="2008"
-#   xmlns:c="http://www.ociweb.com/cars">
+# <c:car year='2008'
+#   xmlns:c='http://www.ociweb.com/cars'>
 #   <c:model>Prius</c:model>
 # </c:car>
 
-out "Associate an XML Schema:"
+out 'Associate an XML Schema:'
 WAX.write do
-  start "car"
-  attr "year", 2008
-  namespace nil, "http://www.ociweb.com/cars", "car.xsd"
-  child "model", "Prius"
+  start 'car'
+  attr 'year', 2008
+  namespace nil, 'http://www.ociweb.com/cars', 'car.xsd'
+  child 'model', 'Prius'
 end
-# <car year="2008"
-#   xmlns="http://www.ociweb.com/cars"
-#   xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
-#   xsi:schemaLocation="http://www.ociweb.com/cars car.xsd">
+# <car year='2008'
+#   xmlns='http://www.ociweb.com/cars'
+#   xmlns:xsi='http://www.w3.org/1999/XMLSchema-instance'
+#   xsi:schemaLocation='http://www.ociweb.com/cars car.xsd'>
 #   <model>Prius</model>
 # </car>
 
-out "Associate multiple XML Schemas:"
+out 'Associate multiple XML Schemas:'
 WAX.write do
-  start "car"
-  attr "year", 2008
-  namespace nil, "http://www.ociweb.com/cars", "car.xsd"
-  namespace "m", "http://www.ociweb.com/model", "model.xsd"
-  child "m", "model", "Prius"
+  start 'car'
+  attr 'year', 2008
+  namespace nil, 'http://www.ociweb.com/cars', 'car.xsd'
+  namespace 'm', 'http://www.ociweb.com/model', 'model.xsd'
+  child 'm', 'model', 'Prius'
 end
-# <car year="2008"
-#   xmlns="http://www.ociweb.com/cars"
-#   xmlns:m="http://www.ociweb.com/model"
-#   xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance"
-#   xsi:schemaLocation="http://www.ociweb.com/cars car.xsd
-#     http://www.ociweb.com/model model.xsd">
+# <car year='2008'
+#   xmlns='http://www.ociweb.com/cars'
+#   xmlns:m='http://www.ociweb.com/model'
+#   xmlns:xsi='http://www.w3.org/1999/XMLSchema-instance'
+#   xsi:schemaLocation='http://www.ociweb.com/cars car.xsd
+#     http://www.ociweb.com/model model.xsd'>
 #   <m:model>Prius</m:model>
 # </car>
 
-out "Associate a DTD:"
+out 'Associate a DTD:'
 WAX.write do
-  dtd "car.dtd"
-  start "car"
-  attr "year", 2008
-  child "model", "Prius"
+  dtd 'car.dtd'
+  start 'car'
+  attr 'year', 2008
+  child 'model', 'Prius'
 end
-# <!DOCTYPE car SYSTEM "car.dtd">
-# <car year="2008">
+# <!DOCTYPE car SYSTEM 'car.dtd'>
+# <car year='2008'>
 #   <model>Prius</model>
 # </car>
 
-out "Entity definitions in DOCTYPE:"
-String url = "http://www.ociweb.com/xml/";
+out 'Entity definitions in DOCTYPE:'
+String url = 'http://www.ociweb.com/xml/';
 WAX.write do
-  entity_def "oci", "Object Computing, Inc."
-  external_entity_def "moreData", url + "moreData.xml"
-  start "root"
-  text "The author works at &oci; in St. Louis, Missouri.",
+  entity_def 'oci', 'Object Computing, Inc.'
+  external_entity_def 'moreData', url + 'moreData.xml'
+  start 'root'
+  text 'The author works at &oci; in St. Louis, Missouri.',
     true, false # turning escaping off for entity reference
-  text "&moreData;", true, false
-end
+  text '&moreData;', true, false
+end
+# <!DOCTYPE root [
+#  <!ENTITY oci "Object Computing, Inc.">
+#  <!ENTITY moreData SYSTEM "http://www.ociweb.com/xml/moreData.xml">
+#>
+#<root>
+#  The author works at &oci; in St. Louis, Missouri.
+#  &moreData;
+# </root>

data/lib/wax.rb

@@ -35,7 +35,7 @@ class WAX
   # Creates a WAX object, invokes the specified block on it
   # and calls close on the WAX object.
   # The writer can be a String file path, an IO object such as a File,
-  # or unspecified to write $stdout.
+  # or unspecified to out $stdout.
   # If the version isn't specified then no XML declaration will be written.
   def self.write(writer=$stdout, version=nil, &proc)
     writer = File.new(writer, "w") if writer.kind_of?(String)
@@ -94,10 +94,10 @@ class WAX
     if new_line
       write_indent
     else
-      write ' '
+      out ' '
     end
         
-    write "#{qname}=\"#{value}\""
+    out "#{qname}=\"#{value}\""
 
     self
   end
@@ -123,7 +123,7 @@ class WAX
   end
 
   # A convenience method that is a shortcut for
-  # start(prefix, name).text(text).end_element().
+  # start(prefix, name).text(text).end!().
   def child(p1, p2, p3=nil)
     if (p3 == nil)
       # only specified element name and text
@@ -134,7 +134,7 @@ class WAX
     end
 
     bad_state("child") if @check_me and @state == :after_root
-    start(prefix, name).text(text).end_element
+    start(prefix, name).text(text).end!
   end
 
   # Terminates all unterminated elements,
@@ -145,7 +145,7 @@ class WAX
     bad_state("close") if @check_me and @state == :in_prolog
 
     # End all the unended elements.
-    while @parent_stack.size > 0; end_element; end
+    while @parent_stack.size > 0; end!; end
 
     if @close_stream
       @writer.close
@@ -167,8 +167,8 @@ class WAX
     terminate_start
     write_indent if @parent_stack.size > 0
 
-    write "<!-- #{text} -->"
-    write "\n" if will_indent and @parent_stack.size == 0
+    out "<!-- #{text} -->"
+    out "\n" if will_indent and @parent_stack.size == 0
 
     self
   end
@@ -187,7 +187,8 @@ class WAX
   # Terminates the current element.
   # It does so in the shorthand way (/&gt;) if the element has no content,
   # and in the long way (&lt;/name&gt;) if it does.
-  def end_element
+  # The name of this method ends in ! because end is a keyword in Ruby.
+  def end!
     if @check_me
       bad_state("end") if @state == :in_prolog or @state == :after_root
       verify_prefixes
@@ -203,9 +204,9 @@ class WAX
 
     if @has_content
       write_indent if @has_indented_content
-      write "</#{name}>"
+      out "</#{name}>"
     else
-      write "/>"
+      out "/>"
     end
 
     @has_content = @has_indented_content = true # new setting for parent
@@ -290,12 +291,12 @@ class WAX
     if will_indent
       write_indent
     else
-      write ' '
+      out ' '
     end
         
-    write "xmlns"
-    write(':' + prefix) if has_prefix
-    write "=\"#{uri}\""
+    out "xmlns"
+    out(':' + prefix) if has_prefix
+    out "=\"#{uri}\""
         
     if schema_path != nil
       @namespace_uri_to_schema_path_map[uri] = schema_path
@@ -331,8 +332,8 @@ class WAX
     terminate_start
     write_indent if @parent_stack.size > 0
 
-    write "<?#{target} #{data}?>"
-    write("\n") if will_indent and @parent_stack.size == 0
+    out "<?#{target} #{data}?>"
+    out("\n") if will_indent and @parent_stack.size == 0
 
     self
   end
@@ -437,7 +438,7 @@ class WAX
     has_prefix = prefix != nil and prefix.length > 0
     qname = has_prefix ? prefix + ':' + name : name
 
-    write '<' + qname
+    out '<' + qname
 
     @parent_stack.push(qname)
 
@@ -455,13 +456,13 @@ class WAX
     verify_prefixes if @check_me
     return if @state != :in_start_tag
     write_schema_locations
-    write '>'
+    out '>'
     @attr_on_new_line = false # reset
     @state = :in_element
   end
 
   # Writes text inside the content of the current element.
-  def text(text, newline=false, escape=@check_me)
+  def text(obj, newline=false, escape=@check_me)
     if @check_me
       bad_state("text") if @state == :in_prolog or @state == :after_root
     end
@@ -470,12 +471,14 @@ class WAX
     @has_indented_content = newline
     terminate_start
 
-    if text != nil and text.length > 0
+    text = obj.to_s if obj
+
+    if obj != nil and text.length > 0
       write_indent if newline
       text = XMLUtil.escape(text) if escape
-      write text
+      out text
     elsif newline
-      write "\n"
+      out "\n"
     end
 
     self
@@ -500,8 +503,8 @@ class WAX
   end
 
   # Writes the to_s value of an Object to the writer.
-  def write(data)
-    raise "attempting to write XML after close has been called" unless @writer
+  def out(data)
+    raise "attempting to out XML after close has been called" unless @writer
     @writer.write(data.to_s)
   end
 
@@ -509,34 +512,34 @@ class WAX
   def write_doctype(root_element_name)
     return if @dtd_file_path == nil and @entity_defs.empty?
 
-    write "<!DOCTYPE #{root_element_name}"
-    write " SYSTEM \"#{@dtd_file_path}\"" unless @dtd_file_path == nil 
+    out "<!DOCTYPE #{root_element_name}"
+    out " SYSTEM \"#{@dtd_file_path}\"" unless @dtd_file_path == nil 
 
     if not @entity_defs.empty?
-      write " ["
+      out " ["
 
       @entity_defs.each do |entity_def|
-        write "\n" + @indent if will_indent
-        write "<!ENTITY #{entity_def}>"
+        out "\n" + @indent if will_indent
+        out "<!ENTITY #{entity_def}>"
       end
 
-      write "\n" if will_indent
-      write ']'
+      out "\n" if will_indent
+      out ']'
 
       @entity_defs.clear
     end
 
-    write '>'
-    write "\n" if will_indent
+    out '>'
+    out "\n" if will_indent
   end
 
   # Writes the proper amount of indentation
   # given the current nesting of elements.
   def write_indent
     return unless will_indent
-    write "\n"
+    out "\n"
     for i in 0...@parent_stack.size
-      write @indent
+      out @indent
     end
   end
 
@@ -576,7 +579,7 @@ class WAX
     return if version == nil
     XMLUtil.verify_version(version) if @check_me
 
-    write "<?xml version=\"#{version}\" " +
+    out "<?xml version=\"#{version}\" " +
       "encoding=\"#{XMLUtil::DEFAULT_ENCODING}\"?>\n"
   end
 

data/test/test_wax.rb

@@ -71,7 +71,7 @@ class WAXTest < Test::Unit::TestCase
     assert_raise(RuntimeError) do
       WAX.write do
         start "root"
-        end_element
+        end!
         child "child", "text" # can't call child after root is closed
       end
     end
@@ -129,7 +129,7 @@ class WAXTest < Test::Unit::TestCase
   
   def test_bad_end
     assert_raise(RuntimeError) do
-      WAX.write { end_element } # haven't called start yet
+      WAX.write { end! } # haven't called start yet
     end
   end
   
@@ -188,7 +188,7 @@ class WAXTest < Test::Unit::TestCase
         start "parent"
         namespace "foo", "http://www.ociweb.com/foo"
         child "foo", "child1", "one"
-        end_element
+        end!
         child "foo", "child2", "two"
       end
     end
@@ -236,7 +236,7 @@ class WAXTest < Test::Unit::TestCase
       nl_text "text #2"
       start "child2"
       attr "a1", "v1"
-      end_element
+      end!
       nl_text "text #3"
     end
       
@@ -355,8 +355,8 @@ class WAXTest < Test::Unit::TestCase
       WAX.write do
         set_indent nil
         start "root"
-        end_element
-        end_element
+        end!
+        end!
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wax
 version: !ruby/object:Gem::Version 
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors: 
 - R. Mark Volkmann
@@ -22,8 +22,11 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- lib/address.rb
+- lib/car.rb
 - lib/cd_demo.rb
 - lib/instance_exec.rb
+- lib/person.rb
 - lib/tutorial.rb
 - lib/wax.rb
 - lib/xml_util.rb