plist 2.1.2 → 3.0.0

data/Rakefile

@@ -61,7 +61,7 @@ end
 
 desc "Strip trailing whitespace and fix newlines for all release files"
 task :fix_whitespace => [ :clean ] do
-  RELEASE_FILES.each do |filename|
+  RELEASE_FILES.reject {|i| i =~ /assets/}.each do |filename|
     next if File.directory? filename
 
     File.open(filename) do |file|
@@ -100,7 +100,7 @@ end
 
 desc "Copy documentation to rubyforge"
 task :update_rdoc => [ :rdoc ] do
-  Rake::SshDirPublisher.new("#{RUBYFORGE_USER}@rubyforge.org", "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/sekr1t", "rdoc").upload
+  Rake::SshDirPublisher.new("#{RUBYFORGE_USER}@rubyforge.org", "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}", "rdoc").upload
 end
 
 # Genereate the RDoc documentation

data/docs/USAGE

@@ -1,4 +1,17 @@
-=== Example Property List
+== Parsing
+
+  result = Plist::parse_xml('path/to/example.plist')
+
+  result.class
+  => Hash
+
+  "#{result['FirstName']} #{result['LastName']}"
+  => "John Public"
+
+  result['ZipPostal']
+  => "12345"
+
+==== Example Property List
 
   <?xml version="1.0" encoding="UTF-8"?>
   <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
@@ -32,20 +45,60 @@
           <string>12345</string>
   </dict>
   </plist>
-  
-=== Parsing
 
-  result = Plist::parse_xml("path/to/example.plist")
+== Generation
 
-  result.class
-  => Hash
+plist also provides the ability to generate plists from Ruby objects.  The following Ruby classes are converted into native plist types:
+  Array, Bignum, Date, DateTime, Fixnum, Float, Hash, Integer, String, Symbol, Time, true, false
 
-  "#{result["FirstName"]} #{result["LastName"]}"
-  => "John Public"
+* +Array+ and +Hash+ are both recursive; their elements will be converted into plist nodes inside the <array> and <dict> containers (respectively).
+* +IO+ (and its descendants) and +StringIO+ objects are read from and their contents placed in a <data> element.
+* User classes may implement +to_plist_node+ to dictate how they should be serialized; otherwise the object will be passed to <tt>Marshal.dump</tt> and the result placed in a <data> element.  See below for more details.
 
-  result["ZipPostal"]
-  => "12345"
-  
-=== Generation
+==== Creating a plist
+
+There are two ways to generate complete plists.  Given an object:
+
+  obj = [1, :two, {'c' => 0xd}]
+
+If you've mixed in <tt>Plist::Emit</tt> (which is already done for +Array+ and +Hash+), you can simply call +to_plist+:
+
+  obj.to_plist
+
+This is equivalent to calling <tt>Plist::Emit.dump(obj)</tt>.  Either one will yield:
+
+  <?xml version="1.0" encoding="UTF-8"?>
+  <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+  <plist version="1.0">
+  <array>
+      <integer>1</integer>
+      <string>two</string>
+      <dict>
+        <key>c</key>
+        <integer>13</integer>
+      </dict>
+  </array>
+  </plist>
+
+You can also dump plist fragments by passing +false+ as the second parameter:
+
+  Plist::Emit.dump('holy cow!', false)
+  => "<string>holy cow!</string>"
+
+==== Custom serialization
+
+If your class can be safely coerced into a native plist datatype, you can implement +to_plist_node+.  Upon encountering an object of a class it doesn't recognize, the plist library will check to see if it responds to +to_plist_node+, and if so, insert the result of that call into the plist output.
+
+An example:
+
+  class MyFancyString
+    ...
+
+    def to_plist_node
+      return "<string>#{self.defancify}</string>"
+    end
+  end
+
+When you attempt to serialize a +MyFancyString+ object, the +to_plist_node+ method will be called and the object's contents will be defancified and placed in the plist.
 
-  coming.soon {|i| i.promise }
+If for whatever reason you can't add this method, your object will be serialized with <tt>Marshal.dump</tt> instead.

data/lib/plist.rb

@@ -10,10 +10,13 @@
 #
 # This is the main file for plist.  Everything interesting happens in Plist and Plist::Emit.
 
+require 'base64'
 require 'cgi'
+require 'stringio'
+
 require 'plist/generator'
 require 'plist/parser'
 
 module Plist
-  VERSION = '2.1.2'
+  VERSION = '3.0.0'
 end

data/lib/plist/generator.rb

@@ -1,167 +1,224 @@
-##############################################################
+#--###########################################################
 # Copyright 2006, Ben Bleything <ben@bleything.net> and      #
 # Patrick May <patrick@hexane.org>                           #
 #                                                            #
 # Distributed under the MIT license.                         #
 ##############################################################
-
-# === Save a plist
-# You can turn the variables back into a plist string:
-#
-#   r.to_plist
-#
-# There is a convenience method for saving a variable to a file:
-#
-#   r.save_plist(filename)
-#
-# Only these ruby types can be converted into a plist:
-#
-#   String
-#   Float
-#   DateTime
-#   Integer
-#   FalseClass
-#   TrueClass
-#   Array
-#   Hash
-#
-# Notes:
-#
-# + Array and Hash are recursive -- the elements of an Array and the values of a Hash
-# must convert to a plist.
-# + The keys of the Hash must be strings.
-# + The contents of data elements are returned as a Tempfile.
-# + Data elements can be set with to an open IO or a StringIO
-#
-# If you have suggestions for mapping other Ruby types to the plist types, send a note to:
-#
-#   mailto:plist@hexane.org
-#
-# I'll take a look and probably add it, I'm just reticent to create too many
-# "convenience" methods without at least agreeing with someone :-)
+#++
+# See Plist::Emit.
 module Plist
+  # === Create a plist
+  # You can dump an object to a plist in one of two ways:
+  #
+  # * <tt>Plist::Emit.dump(obj)</tt>
+  # * <tt>obj.to_plist</tt>
+  #   * This requires that you mixin the <tt>Plist::Emit</tt> module, which is already done for +Array+ and +Hash+.
+  #
+  # The following Ruby classes are converted into native plist types:
+  #   Array, Bignum, Date, DateTime, Fixnum, Float, Hash, Integer, String, Symbol, Time, true, false
+  # * +Array+ and +Hash+ are both recursive; their elements will be converted into plist nodes inside the <array> and <dict> containers (respectively).
+  # * +IO+ (and its descendants) and +StringIO+ objects are read from and their contents placed in a <data> element.
+  # * User classes may implement +to_plist_node+ to dictate how they should be serialized; otherwise the object will be passed to <tt>Marshal.dump</tt> and the result placed in a <data> element.
+  #
+  # For detailed usage instructions, refer to USAGE[link:files/docs/USAGE.html] and the methods documented below.
   module Emit
+    # Helper method for injecting into classes.  Calls <tt>Plist::Emit.dump</tt> with +self+.
+    def to_plist(envelope = true)
+      return Plist::Emit.dump(self, envelope)
+    end
+
+    # Helper method for injecting into classes.  Calls <tt>Plist::Emit.save_plist</tt> with +self+.
     def save_plist(filename)
+      Plist::Emit.save_plist(self, filename)
+    end
+
+    # The following Ruby classes are converted into native plist types:
+    #   Array, Bignum, Date, DateTime, Fixnum, Float, Hash, Integer, String, Symbol, Time
+    #
+    # Write us (via RubyForge) if you think another class can be coerced safely into one of the expected plist classes.
+    #
+    # +IO+ and +StringIO+ objects are encoded and placed in <data> elements; other objects are <tt>Marshal.dump</tt>'ed unless they implement +to_plist_node+.
+    #
+    # The +envelope+ parameters dictates whether or not the resultant plist fragment is wrapped in the normal XML/plist header and footer.  Set it to false if you only want the fragment.
+    def self.dump(obj, envelope = true)
+      output = plist_node(obj)
+
+      output = wrap(output) if envelope
+
+      return output
+    end
+
+    # Writes the serialized object's plist to the specified filename.
+    def self.save_plist(obj, filename)
       File.open(filename, 'wb') do |f|
-        f.write(self.to_plist)
+        f.write(obj.to_plist)
       end
     end
 
-    # Only the expected classes can be emitted as a plist:
-    #   String, Float, DateTime, Integer, TrueClass, FalseClass, Array, Hash
-    #
-    # Write me if you think another class can be coerced safely into one of the
-    # expected plist classes (plist@hexane.org)
-    def to_plist( header = true )
-      if (header)
-        Plist::_xml(self.to_plist_node)
+    private
+    def self.plist_node(element)
+      output = ''
+
+      if element.respond_to? :to_plist_node
+        output << element.to_plist_node
       else
-        self.to_plist_node
+        case element
+        when Array
+          if element.empty?
+            output << "<array/>\n"
+          else
+            output << tag('array') {
+              element.collect {|e| plist_node(e)}
+            }
+          end
+        when Hash
+          if element.empty?
+            output << "<dict/>\n"
+          else
+            inner_tags = []
+
+            element.keys.sort.each do |k|
+              v = element[k]
+              inner_tags << tag('key', CGI::escapeHTML(k.to_s))
+              inner_tags << plist_node(v)
+            end
+
+            output << tag('dict') {
+              inner_tags
+            }
+          end
+        when true, false
+          output << "<#{element}/>\n"
+        when Time
+          output << tag('date', element.utc.strftime('%Y-%m-%dT%H:%M:%SZ'))
+        when Date # also catches DateTime
+          output << tag('date', element.strftime('%Y-%m-%dT%H:%M:%SZ'))
+        when String, Symbol, Fixnum, Bignum, Integer, Float
+          output << tag(element_type(element), CGI::escapeHTML(element.to_s))
+        when IO, StringIO
+          element.rewind
+          contents = element.read
+          # note that apple plists are wrapped at a different length then
+          # what ruby's base64 wraps by default.
+          # I used #encode64 instead of #b64encode (which allows a length arg)
+          # because b64encode is b0rked and ignores the length arg.
+          data = "\n"
+          Base64::encode64(contents).gsub(/\s+/, '').scan(/.{1,68}/o) { data << $& << "\n" }
+          output << tag('data', data)
+        else
+          output << comment( 'The <data> element below contains a Ruby object which has been serialized with Marshal.dump.' )
+          data = "\n"
+          Base64::encode64(Marshal.dump(element)).gsub(/\s+/, '').scan(/.{1,68}/o) { data << $& << "\n" }
+          output << tag('data', data )
+        end
       end
+
+      return output
     end
-  end
-end
 
-class String
-  include Plist::Emit
-  def to_plist_node
-    "<string>#{CGI::escapeHTML(self)}</string>"
-  end
-end
+    def self.comment(content)
+      return "<!-- #{content} -->\n"
+    end
 
-class Symbol
-  include Plist::Emit
-  def to_plist_node
-    "<string>#{CGI::escapeHTML(self.to_s)}</string>"
-  end
-end
+    def self.tag(type, contents = '', &block)
+      out = nil
 
-class Float
-  include Plist::Emit
-  def to_plist_node
-    "<real>#{self}</real>"
-  end
-end
+      if block_given?
+        out = IndentedString.new
+        out << "<#{type}>"
+        out.raise_indent
 
-class Time
-  include Plist::Emit
-  def to_plist_node
-    "<date>#{self.utc.strftime('%Y-%m-%dT%H:%M:%SZ')}</date>"
-  end
-end
+        out << block.call
 
-class Date
-  include Plist::Emit
-  def to_plist_node
-    "<date>#{self.strftime('%Y-%m-%dT%H:%M:%SZ')}</date>"
-  end
-end
+        out.lower_indent
+        out << "</#{type}>"
+      else
+        out = "<#{type}>#{contents.to_s}</#{type}>\n"
+      end
 
-class Integer
-  include Plist::Emit
-  def to_plist_node
-    "<integer>#{self}</integer>"
-  end
-end
+      return out.to_s
+    end
 
-class FalseClass
-  include Plist::Emit
-  def to_plist_node
-    "<false/>"
-  end
-end
+    def self.wrap(contents)
+      output = ''
 
-class TrueClass
-  include Plist::Emit
-  def to_plist_node
-    "<true/>"
-  end
-end
+      output << '<?xml version="1.0" encoding="UTF-8"?>' + "\n"
+      output << '<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">' + "\n"
+      output << '<plist version="1.0">' + "\n"
 
-class Array
-  include Plist::Emit
-  def to_plist_node
-    fragment = "<array>\n"
-    self.each do |e|
-      element_plist = e.to_plist_node
-      element_plist.each do |l|
-        fragment += "\t#{l.chomp}\n"
+      output << contents
+
+      output << '</plist>' + "\n"
+
+      return output
+    end
+
+    def self.element_type(item)
+      return case item
+        when String, Symbol:          'string'
+        when Fixnum, Bignum, Integer: 'integer'
+        when Float:                   'real'
+        else
+          raise "Don't know about this data type... something must be wrong!"
       end
     end
-    fragment += "</array>"
-    fragment
-  end
-end
+    private
+    class IndentedString #:nodoc:
+      attr_accessor :indent_string
 
-class Hash
-  include Plist::Emit
-  def to_plist_node
-    fragment = "<dict>\n"
-    self.keys.sort.each do |k|
-      fragment += "\t<key>#{CGI::escapeHTML(k)}</key>\n"
-      element_plist = self[k].to_plist_node
-      element_plist.each do |l|
-        fragment += "\t#{l.chomp}\n"
+      @@indent_level = 0
+
+      def initialize(str = "\t")
+        @indent_string = str
+        @contents = ''
+      end
+
+      def to_s
+        return @contents
+      end
+
+      def raise_indent
+        @@indent_level += 1
+      end
+
+      def lower_indent
+        @@indent_level -= 1 if @@indent_level > 0
+      end
+
+      def <<(val)
+        if val.is_a? Array
+          val.each do |f|
+            self << f
+          end
+        else
+          # if it's already indented, don't bother indenting further
+          unless val =~ /\A#{@indent_string}/
+            indent = @indent_string * @@indent_level
+
+            @contents << val.gsub(/^/, indent)
+          else
+            @contents << val
+          end
+
+          # it already has a newline, don't add another
+          @contents << "\n" unless val =~ /\n$/
+        end
       end
     end
-    fragment += "</dict>"
-    fragment
   end
 end
 
-require 'stringio'
-[ IO, StringIO ].each do |io_class|
-  io_class.module_eval do
-    include Plist::Emit
-    def to_plist_node
-      self.rewind
-      data = self.read
+# we need to add this so sorting hash keys works properly
+class Symbol #:nodoc:
+  def <=> (other)
+    self.to_s <=> other.to_s
+  end
+end
 
-      output = "<data>\n"
-      Base64::encode64(data).gsub(/\s+/, '').scan(/.{1,68}/o) { output << $& << "\n" }
-      output << "</data>"
+class Array #:nodoc:
+  include Plist::Emit
+end
 
-      output
-    end
-  end
+class Hash #:nodoc:
+  include Plist::Emit
 end

data/lib/plist/parser.rb

@@ -1,10 +1,10 @@
-##############################################################
+#--###########################################################
 # Copyright 2006, Ben Bleything <ben@bleything.net> and      #
 # Patrick May <patrick@hexane.org>                           #
 #                                                            #
 # Distributed under the MIT license.                         #
 ##############################################################
-#
+#++
 # Plist parses Mac OS X xml property list files into ruby data structures.
 #
 # === Load a plist file
@@ -12,17 +12,6 @@
 #
 #   r = Plist::parse_xml( filename_or_xml )
 module Plist
-  TEMPLATE = <<-XML
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-%plist%
-</plist>
-XML
-  def Plist::_xml( xml )
-    TEMPLATE.sub( /%plist%/, xml )
-  end
-
 # Note that I don't use these two elements much:
 #
 #  + Date elements are returned as DateTime objects.
@@ -78,6 +67,8 @@ XML
     TEXT       = /([^<]+)/
     XMLDECL_PATTERN = /<\?xml\s+(.*?)\?>*/um
     DOCTYPE_PATTERN = /\s*<!DOCTYPE\s+(.*?)(\[|>)/um
+    COMMENT_START = /\A<!--/u
+    COMMENT_END = /.*?-->/um
 
 
     def parse
@@ -86,13 +77,20 @@ XML
       end_tag    = /<\/(#{plist_tags})[^>]*>/i
 
       require 'strscan'
-      @scanner = StringScanner.new( if (File.exists? @filename_or_xml)
-                                      File.open(@filename_or_xml, "r") {|f| f.read}
-                                    else
-                                      @filename_or_xml
-                                    end )
+
+      contents = (
+        if (File.exists? @filename_or_xml)
+          File.open(@filename_or_xml) {|f| f.read}
+        else
+          @filename_or_xml
+        end
+      )
+
+      @scanner = StringScanner.new( contents )
       until @scanner.eos?
-        if @scanner.scan(XMLDECL_PATTERN)
+        if @scanner.scan(COMMENT_START)
+          @scanner.scan(COMMENT_END)
+        elsif @scanner.scan(XMLDECL_PATTERN)
         elsif @scanner.scan(DOCTYPE_PATTERN)
         elsif @scanner.scan(start_tag)
           @listener.tag_start(@scanner[1], nil)
@@ -136,7 +134,7 @@ XML
 
   class PList < PTag
     def to_ruby
-      children.first.to_ruby
+      children.first.to_ruby if children.first
     end
   end
 
@@ -212,19 +210,16 @@ XML
   require 'base64'
   class PData < PTag
     def to_ruby
-      # replacing Tempfile with StringIO
-      # think it might be a bit nicer
-      #require 'tempfile'
-      #tf = Tempfile.new("plist.tmp")
-      #tf.write Base64.decode64(text.gsub(/\s+/,''))
-      #tf.close
-      # is this a good idea?
-      #tf.open
-      #tf
-      io = StringIO.new
-      io.write Base64.decode64(text.gsub(/\s+/,''))
-      io.rewind
-      io
+      data = Base64.decode64(text.gsub(/\s+/, ''))
+
+      begin
+        return Marshal.load(data)
+      rescue Exception => e
+        io = StringIO.new
+        io.write data
+        io.rewind
+        return io
+      end
     end
   end
 end

data/test/assets/commented.plist

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<!-- I am a comment! -->
+<!--
+  I am a multi-line comment!
+  hooray!
+-->
+</plist>

data/test/assets/test_data_elements.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>stringio</key>
+    <data>dGhpcyBpcyBhIHN0cmluZ2lvIG9iamVjdA==
+    </data>
+    <key>file</key>
+    <data>AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+    AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+    AAAAAAAAAAAAAA==
+    </data>
+    <key>io</key>
+    <data>AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+    AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+    AAAAAAAAAAAAAA==
+    </data>
+    <key>marshal</key>
+    <!-- The <data> element below contains a Ruby object which has been serialized with Marshal.dump. -->
+    <data>BAhvOhZNYXJzaGFsYWJsZU9iamVjdAY6CUBmb28iHnRoaXMgb2JqZWN0IHdh
+    cyBtYXJzaGFsZWQ=
+    </data>
+  </dict>
+</plist>

data/test/assets/test_empty_key.plist

@@ -10,4 +10,4 @@
       <string>2</string>
     </dict>
   </dict>
-</plist>
+</plist>

data/test/test_data_elements.rb

@@ -0,0 +1,115 @@
+##############################################################
+# Copyright 2006, Ben Bleything <ben@bleything.net> and      #
+#                 Patrick May <patrick@hexane.org>           #
+#                                                            #
+# Distributed under the MIT license.                         #
+##############################################################
+
+require 'test/unit'
+require 'plist'
+require 'stringio'
+
+class MarshalableObject
+  attr_accessor :foo
+
+  def initialize(str)
+    @foo = str
+  end
+end
+
+class TestDataElements < Test::Unit::TestCase
+  @@result = Plist::parse_xml('test/assets/test_data_elements.plist')
+
+  def test_marshal
+    expected = <<END
+<!-- The <data> element below contains a Ruby object which has been serialized with Marshal.dump. -->
+<data>
+BAhvOhZNYXJzaGFsYWJsZU9iamVjdAY6CUBmb28iHnRoaXMgb2JqZWN0IHdhcyBtYXJz
+aGFsZWQ=
+</data>
+END
+
+    mo = MarshalableObject.new('this object was marshaled')
+
+    assert_equal expected.chomp, Plist::Emit.dump(mo, false).chomp
+
+    assert_instance_of MarshalableObject, @@result['marshal']
+
+    assert_equal mo.foo, @@result['marshal'].foo
+  end
+
+  def test_generator_io_and_file
+    expected = <<END
+<data>
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA==
+</data>
+END
+
+    expected.chomp!
+
+    fd = IO.sysopen('test/assets/example_data.bin')
+    io = IO.open(fd, 'r')
+
+    # File is a subclass of IO, so catching IO in the dispatcher should work for File as well...
+    f = File.open('test/assets/example_data.bin')
+
+    assert_equal expected, Plist::Emit.dump(io, false).chomp
+    assert_equal expected, Plist::Emit.dump(f, false).chomp
+
+    assert_instance_of StringIO, @@result['io']
+    assert_instance_of StringIO, @@result['file']
+
+    io.rewind
+    f.rewind
+
+    assert_equal io.read, @@result['io'].read
+    assert_equal f.read,  @@result['file'].read
+
+    io.close
+    f.close
+  end
+
+  def test_generator_string_io
+    expected = <<END
+<data>
+dGhpcyBpcyBhIHN0cmluZ2lvIG9iamVjdA==
+</data>
+END
+
+    sio = StringIO.new('this is a stringio object')
+
+    assert_equal expected.chomp, Plist::Emit.dump(sio, false).chomp
+
+    assert_instance_of StringIO, @@result['stringio']
+
+    sio.rewind
+    assert_equal sio.read, @@result['stringio'].read
+  end
+
+  # this functionality is credited to Mat Schaffer,
+  # who discovered the plist with the data tag
+  # supplied the test data, and provided the parsing code.
+  def test_data
+    # test reading plist <data> elements
+    data = Plist::parse_xml("test/assets/example_data.plist");
+    assert_equal( File.open("test/assets/example_data.jpg"){|f| f.read }, data['image'].read )
+
+    # test writing data elements
+    expected = File.read("test/assets/example_data.plist")
+    result   = data.to_plist
+    #File.open('result.plist', 'w') {|f|f.write(result)} # debug
+    assert_equal( expected, result )
+
+    # Test changing the <data> object in the plist to a StringIO and writing.
+    # This appears extraneous given that plist currently returns a StringIO,
+    # so the above writing test also flexes StringIO#to_plist_node.
+    # However, the interface promise is to return an IO, not a particular class.
+    # plist used to return Tempfiles, which was changed solely for performance reasons.
+    data['image'] = StringIO.new( File.read("test/assets/example_data.jpg"))
+
+    assert_equal(expected, data.to_plist )
+
+  end
+
+end

data/test/test_generator.rb

@@ -0,0 +1,59 @@
+##############################################################
+# Copyright 2006, Ben Bleything <ben@bleything.net> and      #
+#                 Patrick May <patrick@hexane.org>           #
+#                                                            #
+# Distributed under the MIT license.                         #
+##############################################################
+
+require 'test/unit'
+require 'plist'
+
+class SerializableObject
+  attr_accessor :foo
+
+  def initialize(str)
+    @foo = str
+  end
+
+  def to_plist_node
+    return "<string>#{CGI::escapeHTML @foo}</string>"
+  end
+end
+
+class TestGenerator < Test::Unit::TestCase
+  def test_to_plist_vs_plist_emit_dump_no_envelope
+    source   = [1, :b, true]
+
+    to_plist = source.to_plist(false)
+    plist_emit_dump = Plist::Emit.dump(source, false)
+
+    assert_equal to_plist, plist_emit_dump
+  end
+
+  def test_to_plist_vs_plist_emit_dump_with_envelope
+    source   = [1, :b, true]
+
+    to_plist = source.to_plist
+    plist_emit_dump = Plist::Emit.dump(source)
+
+    assert_equal to_plist, plist_emit_dump
+  end
+
+  def test_dumping_serializable_object
+    str = 'this object implements #to_plist_node'
+    so = SerializableObject.new(str)
+
+    assert_equal "<string>#{str}</string>", Plist::Emit.dump(so, false)
+  end
+
+  def test_write_plist
+    data = [1, :two, {:c => 'dee'}]
+
+    data.save_plist('test.plist')
+    file = File.open('test.plist') {|f| f.read}
+
+    assert_equal file, data.to_plist
+
+    File.unlink('test.plist')
+  end
+end

data/test/test_generator_basic_types.rb

@@ -8,79 +8,51 @@
 require 'test/unit'
 require 'plist'
 
-class TestBasicTypes < Test::Unit::TestCase
+class TestGeneratorBasicTypes < Test::Unit::TestCase
   def wrap(tag, content)
-    return "<array>\n\t<#{tag}>#{content}</#{tag}>\n</array>"
+    return "<#{tag}>#{content}</#{tag}>"
   end
 
   def test_strings
     expected = wrap('string', 'testdata')
 
-    assert_equal expected, ['testdata'].to_plist(false)
-    assert_equal expected, [:testdata].to_plist(false)
+    assert_equal expected, Plist::Emit.dump('testdata', false).chomp
+    assert_equal expected, Plist::Emit.dump(:testdata, false).chomp
+  end
+
+  def test_strings_with_escaping
+    expected = wrap('string', "&lt;Fish &amp; Chips&gt;")
+
+    assert_equal expected, Plist::Emit.dump('<Fish & Chips>', false).chomp
   end
 
   def test_integers
     [42, 2376239847623987623, -8192].each do |i|
-      assert_equal wrap('integer', i), [i].to_plist(false)
+      assert_equal wrap('integer', i), Plist::Emit.dump(i, false).chomp
     end
   end
 
   def test_floats
     [3.14159, -38.3897, 2398476293847.9823749872349980].each do |i|
-      assert_equal wrap('real', i), [i].to_plist(false)
+      assert_equal wrap('real', i), Plist::Emit.dump(i, false).chomp
     end
   end
 
   def test_booleans
-    assert_equal "<array>\n\t<true/>\n</array>",  [true].to_plist(false)
-    assert_equal "<array>\n\t<false/>\n</array>", [false].to_plist(false)
+    assert_equal "<true/>",  Plist::Emit.dump(true, false).chomp
+    assert_equal "<false/>", Plist::Emit.dump(false, false).chomp
   end
 
   def test_time
     test_time = Time.now
-    assert_equal wrap('date', test_time.utc.strftime('%Y-%m-%dT%H:%M:%SZ')), [test_time].to_plist(false)
+    assert_equal wrap('date', test_time.utc.strftime('%Y-%m-%dT%H:%M:%SZ')), Plist::Emit.dump(test_time, false).chomp
   end
 
   def test_dates
     test_date = Date.today
     test_datetime = DateTime.now
 
-    assert_equal wrap('date', test_date.strftime('%Y-%m-%dT%H:%M:%SZ')), [test_date].to_plist(false)
-    assert_equal wrap('date', test_datetime.strftime('%Y-%m-%dT%H:%M:%SZ')), [test_datetime].to_plist(false)
-  end
-
-  # generater tests from patrick's plist.rb code
-  def test_to_plist
-    assert_equal( Plist::_xml("<string>Hello, World</string>"),     "Hello, World".to_plist )
-    assert_equal( Plist::_xml("<real>151936595.697543</real>"),     151936595.697543.to_plist )
-    assert_equal( Plist::_xml("<date>2006-04-21T16:47:58Z</date>"), DateTime.parse("2006-04-21T16:47:58Z").to_plist )
-    assert_equal( Plist::_xml("<integer>999000</integer>"),         999000.to_plist )
-    assert_equal( Plist::_xml("<false/>"),                          false.to_plist )
-    assert_equal( Plist::_xml("<true/>"),                           true.to_plist )
-
-    assert_equal( Plist::_xml("<array>\n\t<true/>\n\t<false/>\n</array>"),
-                  [ true, false ].to_plist )
-
-    assert_equal( Plist::_xml("<dict>\n\t<key>False</key>\n\t<false/>\n\t<key>True</key>\n\t<true/>\n</dict>"),
-                  { 'True' => true, 'False' => false }.to_plist )
-
-    source = File.open("test/assets/AlbumData.xml") { |f| f.read }
-
-    result = Plist::parse_xml(source)
-
-    assert_equal( result, Plist::parse_xml(result.to_plist) )
-
-    File.delete('hello.plist') if File.exists?('hello.plist')
-    "Hello, World".save_plist('hello.plist')
-    assert_equal( Plist::_xml("<string>Hello, World</string>"),
-                  File.open('hello.plist') {|f| f.read }        )
-    File.delete('hello.plist') if File.exists?('hello.plist')
+    assert_equal wrap('date', test_date.strftime('%Y-%m-%dT%H:%M:%SZ')), Plist::Emit.dump(test_date, false).chomp
+    assert_equal wrap('date', test_datetime.strftime('%Y-%m-%dT%H:%M:%SZ')), Plist::Emit.dump(test_datetime, false).chomp
   end
-
-  def test_escape_string_values
-    assert_equal( Plist::_xml("<string>&lt;plist&gt;</string>"),    "<plist>".to_plist )
-    assert_equal( Plist::_xml("<string>Fish &amp; Chips</string>"), "Fish & Chips".to_plist )
-  end
-
 end

data/test/test_generator_collections.rb

@@ -0,0 +1,82 @@
+##############################################################
+# Copyright 2006, Ben Bleything <ben@bleything.net> and      #
+#                 Patrick May <patrick@hexane.org>           #
+#                                                            #
+# Distributed under the MIT license.                         #
+##############################################################
+
+require 'test/unit'
+require 'plist'
+
+class TestGeneratorCollections < Test::Unit::TestCase
+  def test_array
+    expected = <<END
+<array>
+	<integer>1</integer>
+	<integer>2</integer>
+	<integer>3</integer>
+</array>
+END
+
+    assert_equal expected, [1,2,3].to_plist(false)
+  end
+
+  def test_empty_array
+    expected = <<END
+<array/>
+END
+
+    assert_equal expected, [].to_plist(false)
+  end
+
+  def test_hash
+    expected = <<END
+<dict>
+	<key>abc</key>
+	<integer>123</integer>
+	<key>foo</key>
+	<string>bar</string>
+</dict>
+END
+    # thanks to recent changes in the generator code, hash keys are sorted before emission,
+    # so multi-element hash tests should be reliable.  We're testing that here too.
+    assert_equal expected, {:foo => :bar, :abc => 123}.to_plist(false)
+  end
+
+  def test_empty_hash
+    expected = <<END
+<dict/>
+END
+
+    assert_equal expected, {}.to_plist(false)
+  end
+
+  def test_hash_with_array_element
+    expected = <<END
+<dict>
+	<key>ary</key>
+	<array>
+		<integer>1</integer>
+		<string>b</string>
+		<string>3</string>
+	</array>
+</dict>
+END
+    assert_equal expected, {:ary => [1,:b,'3']}.to_plist(false)
+  end
+
+  def test_array_with_hash_element
+    expected = <<END
+<array>
+	<dict>
+		<key>foo</key>
+		<string>bar</string>
+	</dict>
+	<string>b</string>
+	<integer>3</integer>
+</array>
+END
+
+    assert_equal expected, [{:foo => 'bar'}, :b, 3].to_plist(false)
+  end
+end

data/test/test_parser.rb

@@ -6,11 +6,10 @@
 ##############################################################
 
 require 'test/unit'
-require 'pp'
 
 require 'plist'
 
-class TestPlist < Test::Unit::TestCase
+class TestParser < Test::Unit::TestCase
   def test_Plist_parse_xml
     result = Plist::parse_xml("test/assets/AlbumData.xml")
 
@@ -59,7 +58,6 @@ class TestPlist < Test::Unit::TestCase
   #  plist = Plist::parse_xml( "~/Pictures/iPhoto Library/AlbumData.xml" )
   #end
 
-
   # date fields are credited to
   def test_date_fields
     result = Plist::parse_xml("test/assets/Cookies.plist")
@@ -67,22 +65,6 @@ class TestPlist < Test::Unit::TestCase
     assert_equal( "2007-10-25T12:36:35Z", result.first['Expires'].to_s )
   end
 
-  # this functionality is credited to Mat Schaffer,
-  # who discovered the plist with the data tag
-  # supplied the test data, and provided the parsing code.
-  def test_data
-    data = Plist::parse_xml("test/assets/example_data.plist");
-    assert_equal( File.open("test/assets/example_data.jpg"){|f| f.read }, data['image'].read )
-    assert_equal( File.open("test/assets/example_data.plist"){|f| f.read }, data.to_plist )
-
-    data['image'] = StringIO.new( File.open("test/assets/example_data.jpg"){ |f| f.read } )
-    File.open('temp.plist', 'w'){|f| f.write data.to_plist }
-    assert_equal( File.open("test/assets/example_data.plist"){|f| f.read }, data.to_plist )
-
-    File.delete('temp.plist') if File.exists?('temp.plist')
-
-  end
-
   # bug fix for empty <key>
   # reported by Matthias Peick <matthias@peick.de>
   # reported and fixed by Frederik Seiffert <ego@frederikseiffert.de>
@@ -94,9 +76,15 @@ class TestPlist < Test::Unit::TestCase
   # bug fix for decoding entities
   #  reported by Matthias Peick <matthias@peick.de>
   def test_decode_entities
-    data = Plist::parse_xml(Plist::_xml('<string>Fish &amp; Chips</string>'))
+    data = Plist::parse_xml('<string>Fish &amp; Chips</string>')
     assert_equal('Fish & Chips', data)
   end
+
+  def test_comment_handling_and_empty_plist
+    assert_nothing_raised do
+      assert_nil( Plist::parse_xml( File.read('test/assets/commented.plist') ) )
+    end
+  end
 end
 
 __END__

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: plist
 version: !ruby/object:Gem::Version 
-  version: 2.1.2
+  version: 3.0.0
 date: 2006-09-20 00:00:00 -07:00
 summary: All-purpose Property List manipulation library.
 require_paths: 
@@ -37,15 +37,24 @@ files:
 - lib/plist.rb
 - lib/plist/generator.rb
 - lib/plist/parser.rb
+- test/test_data_elements.rb
+- test/test_generator.rb
 - test/test_generator_basic_types.rb
+- test/test_generator_collections.rb
 - test/test_parser.rb
 - test/assets/AlbumData.xml
+- test/assets/commented.plist
 - test/assets/Cookies.plist
+- test/assets/example_data.bin
 - test/assets/example_data.jpg
 - test/assets/example_data.plist
+- test/assets/test_data_elements.plist
 - test/assets/test_empty_key.plist
 test_files: 
+- test/test_data_elements.rb
+- test/test_generator.rb
 - test/test_generator_basic_types.rb
+- test/test_generator_collections.rb
 - test/test_parser.rb
 rdoc_options: []