plist2 3.1.0

data/test/assets/test_data_elements.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//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

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>key</key>
+    <dict>
+      <key></key>
+      <string>1</string>
+      <key>subkey</key>
+      <string>2</string>
+    </dict>
+  </dict>
+</plist>

data/test/test_data_elements.rb

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'plist'
+require 'stringio'
+
+class MarshalableObject
+  attr_accessor :foo
+
+  def initialize(str)
+    @foo = str
+  end
+end
+
+class TestDataElements < Test::Unit::TestCase
+
+  def setup
+    @result = Plist.parse_xml( 'test/assets/test_data_elements.plist' )
+  end
+
+  def test_data_object_header
+    expected = <<END
+<!-- The <data> element below contains a Ruby object which has been serialized with Marshal.dump. -->
+<data>
+BAhvOhZNYXJzaGFsYWJsZU9iamVjdAY6CUBmb28iHnRoaXMgb2JqZWN0IHdhcyBtYXJz
+aGFsZWQ=
+</data>
+END
+    expected_elements = expected.chomp.split( "\n" )
+
+    actual = Plist::Emit.dump( Object.new, false )
+    actual_elements = actual.chomp.split( "\n" )
+
+    # check for header
+    assert_equal expected_elements.shift, actual_elements.shift
+
+    # check for opening and closing data tags
+    assert_equal expected_elements.shift, actual_elements.shift
+    assert_equal expected_elements.pop, actual_elements.pop
+  end
+
+  def test_marshal_round_trip
+    expected = MarshalableObject.new('this object was marshaled')
+    actual   = Plist.parse_xml( Plist::Emit.dump(expected, false) )
+
+    assert_kind_of expected.class, actual
+    assert_equal expected.foo, actual.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,110 @@
+#!/usr/bin/env ruby
+
+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
+
+  def spaces_to_tabs(s)
+    return s.gsub("\s\s", "\t")
+  end
+
+  # The hash in this test was failing with 'hsh.keys.sort',
+  # we are making sure it works with 'hsh.keys.sort_by'.
+  def test_sorting_keys
+    hsh = {:key1 => 1, :key4 => 4, 'key2' => 2, :key3 => 3}
+    expected = <<-STR
+<dict>
+  <key>key1</key>
+  <integer>1</integer>
+  <key>key2</key>
+  <integer>2</integer>
+  <key>key3</key>
+  <integer>3</integer>
+  <key>key4</key>
+  <integer>4</integer>
+</dict>
+    STR
+    expected = spaces_to_tabs(expected)
+    assert_equal expected, Plist::Emit.dump(hsh, false)
+  end
+
+  def test_hash_is_sorted
+    expected = <<END
+<dict>
+  <key>a</key>
+  <string>a</string>
+  <key>b</key>
+  <string>b</string>
+</dict>
+END
+    h = Hash.new
+    h['b'] = 'b'
+    h['a'] = 'a'
+    expected = spaces_to_tabs(expected)
+    assert_equal expected, Plist::Emit.dump(h, false)
+  end
+
+  def test_hash_keeps_order_when_desired
+    expected = <<END
+<dict>
+  <key>b</key>
+  <string>b</string>
+  <key>a</key>
+  <string>a</string>
+</dict>
+END
+    h = Hash.new
+    h['b'] = 'b'
+    h['a'] = 'a'
+    expected = spaces_to_tabs(expected)
+    assert_equal expected, Plist::Emit.dump(h, false, :sort => false)
+  end
+end

data/test/test_generator_basic_types.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'plist'
+
+class TestGeneratorBasicTypes < Test::Unit::TestCase
+  def wrap(tag, content)
+    return "<#{tag}>#{content}</#{tag}>"
+  end
+
+  def test_strings
+    expected = wrap('string', 'testdata')
+
+    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), 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), Plist::Emit.dump(i, false).chomp
+    end
+  end
+
+  def test_booleans
+    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')), 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')), 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
+end

data/test/test_generator_collections.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+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

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require 'plist'
+
+class TestParser < Test::Unit::TestCase
+  def test_Plist_parse_xml
+    result = Plist::parse_xml("test/assets/AlbumData.xml")
+
+    # dict
+    assert_kind_of( Hash, result )
+
+    expected = [
+      "List of Albums",
+      "Minor Version",
+      "Master Image List",
+      "Major Version",
+      "List of Keywords",
+      "Archive Path",
+      "List of Rolls",
+      "Application Version"
+    ]
+    assert_equal( expected.sort, result.keys.sort )
+
+    # array
+    assert_kind_of( Array, result["List of Rolls"] )
+    assert_equal( [ {"PhotoCount"=>1,
+                     "KeyList"=>["7"],
+                     "Parent"=>999000,
+                     "Album Type"=>"Regular",
+                     "AlbumName"=>"Roll 1",
+                     "AlbumId"=>6}],
+                  result["List of Rolls"] )
+
+    # string
+    assert_kind_of( String, result["Application Version"] )
+    assert_equal( "5.0.4 (263)", result["Application Version"] )
+
+    # integer
+    assert_kind_of( Integer, result["Major Version"] )
+    assert_equal( 2, result["Major Version"] )
+
+    # true
+    assert_kind_of( TrueClass, result["List of Albums"][0]["Master"] )
+    assert( result["List of Albums"][0]["Master"] )
+
+    # false
+    assert_kind_of( FalseClass, result["List of Albums"][1]["SlideShowUseTitles"] )
+    assert( ! result["List of Albums"][1]["SlideShowUseTitles"] )
+
+  end
+
+  # uncomment this test to work on speed optimization
+  #def test_load_something_big
+  #  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")
+    assert_kind_of( DateTime, result.first['Expires'] )
+    assert_equal DateTime.parse( "2007-10-25T12:36:35Z" ), result.first['Expires']
+  end
+
+  # bug fix for empty <key>
+  # reported by Matthias Peick <matthias@peick.de>
+  # reported and fixed by Frederik Seiffert <ego@frederikseiffert.de>
+  def test_empty_dict_key
+    data = Plist::parse_xml("test/assets/test_empty_key.plist");
+    assert_equal("2", data['key']['subkey'])
+  end
+
+  # bug fix for decoding entities
+  #  reported by Matthias Peick <matthias@peick.de>
+  def test_decode_entities
+    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
+
+  def test_filename_or_xml_is_stringio
+    require 'stringio'
+
+    str = StringIO.new
+    data = Plist::parse_xml(str)
+
+    assert_nil data
+  end
+
+end
+
+__END__