plist 2.1.1 → 2.1.2

data/Rakefile

@@ -29,8 +29,10 @@ RELEASE_NAME  = "REL #{PKG_VERSION}"
 RUBYFORGE_PROJECT = "plist"
 RUBYFORGE_USER    = ENV['RUBYFORGE_USER']
 
-TEST_FILES    = Dir.glob('test/**/*').delete_if {|item| item.include?( "\.svn" ) }
-RELEASE_FILES = [ "Rakefile", "README", "MIT-LICENSE" ] + TEST_FILES + Dir.glob( "lib/*" ).delete_if { |item| item.include?( "\.svn" ) }
+TEST_FILES    = Dir.glob('test/test_*').delete_if { |item| item.include?( "\.svn" ) }
+TEST_ASSETS   = Dir.glob('test/assets/*').delete_if { |item| item.include?( "\.svn" ) }
+LIB_FILES     = Dir.glob('lib/**/*').delete_if { |item| item.include?( "\.svn" ) }
+RELEASE_FILES = [ "Rakefile", "README", "MIT-LICENSE", "docs/USAGE" ] + LIB_FILES + TEST_FILES + TEST_ASSETS
 
 task :default => [ :test ]
 # Run the unit tests

data/docs/USAGE

@@ -0,0 +1,51 @@
+=== 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">
+  <plist version="1.0">
+  <dict>
+          <key>FirstName</key>
+          <string>John</string>
+
+          <key>LastName</key>
+          <string>Public</string>
+
+          <key>StreetAddr1</key>
+          <string>123 Anywhere St.</string>
+
+          <key>StateProv</key>
+          <string>CA</string>
+
+          <key>City</key>
+          <string>Some Town</string>
+
+          <key>CountryName</key>
+          <string>United States</string>
+
+          <key>AreaCode</key>
+          <string>555</string>
+
+          <key>LocalPhoneNumber</key>
+          <string>5551212</string>
+
+          <key>ZipPostal</key>
+          <string>12345</string>
+  </dict>
+  </plist>
+  
+=== Parsing
+
+  result = Plist::parse_xml("path/to/example.plist")
+
+  result.class
+  => Hash
+
+  "#{result["FirstName"]} #{result["LastName"]}"
+  => "John Public"
+
+  result["ZipPostal"]
+  => "12345"
+  
+=== Generation
+
+  coming.soon {|i| i.promise }

data/lib/plist.rb

@@ -15,5 +15,5 @@ require 'plist/generator'
 require 'plist/parser'
 
 module Plist
-  VERSION = '2.1.1'
+  VERSION = '2.1.2'
 end

data/lib/plist/generator.rb

@@ -0,0 +1,167 @@
+##############################################################
+# 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 :-)
+module Plist
+  module Emit
+    def save_plist(filename)
+      File.open(filename, 'wb') do |f|
+        f.write(self.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)
+      else
+        self.to_plist_node
+      end
+    end
+  end
+end
+
+class String
+  include Plist::Emit
+  def to_plist_node
+    "<string>#{CGI::escapeHTML(self)}</string>"
+  end
+end
+
+class Symbol
+  include Plist::Emit
+  def to_plist_node
+    "<string>#{CGI::escapeHTML(self.to_s)}</string>"
+  end
+end
+
+class Float
+  include Plist::Emit
+  def to_plist_node
+    "<real>#{self}</real>"
+  end
+end
+
+class Time
+  include Plist::Emit
+  def to_plist_node
+    "<date>#{self.utc.strftime('%Y-%m-%dT%H:%M:%SZ')}</date>"
+  end
+end
+
+class Date
+  include Plist::Emit
+  def to_plist_node
+    "<date>#{self.strftime('%Y-%m-%dT%H:%M:%SZ')}</date>"
+  end
+end
+
+class Integer
+  include Plist::Emit
+  def to_plist_node
+    "<integer>#{self}</integer>"
+  end
+end
+
+class FalseClass
+  include Plist::Emit
+  def to_plist_node
+    "<false/>"
+  end
+end
+
+class TrueClass
+  include Plist::Emit
+  def to_plist_node
+    "<true/>"
+  end
+end
+
+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"
+      end
+    end
+    fragment += "</array>"
+    fragment
+  end
+end
+
+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"
+      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
+
+      output = "<data>\n"
+      Base64::encode64(data).gsub(/\s+/, '').scan(/.{1,68}/o) { output << $& << "\n" }
+      output << "</data>"
+
+      output
+    end
+  end
+end

data/lib/plist/parser.rb

@@ -0,0 +1,230 @@
+##############################################################
+# 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
+# This is the main point of the library:
+#
+#   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.
+#  + Data elements are implemented as Tempfiles
+#
+# Plist::parse_xml will blow up if it encounters a data element.
+# If you encounter such an error, or if you have a Date element which
+# can't be parsed into a Time object, please send your plist file to
+# plist@hexane.org so that I can implement the proper support.
+  def Plist::parse_xml( filename_or_xml )
+    listener = Listener.new
+    #parser = REXML::Parsers::StreamParser.new(File.new(filename), listener)
+    parser = StreamParser.new(filename_or_xml, listener)
+    parser.parse
+    listener.result
+  end
+
+  class Listener
+    #include REXML::StreamListener
+
+    attr_accessor :result, :open
+
+    def initialize
+      @result = nil
+      @open   = Array.new
+    end
+
+
+    def tag_start(name, attributes)
+      @open.push PTag::mappings[name].new
+    end
+
+    def text( contents )
+      @open.last.text = contents if @open.last
+    end
+
+    def tag_end(name)
+      last = @open.pop
+      if @open.empty?
+        @result = last.to_ruby
+      else
+        @open.last.children.push last
+      end
+    end
+  end
+
+  class StreamParser
+    def initialize( filename_or_xml, listener )
+      @filename_or_xml = filename_or_xml
+      @listener = listener
+    end
+
+    TEXT       = /([^<]+)/
+    XMLDECL_PATTERN = /<\?xml\s+(.*?)\?>*/um
+    DOCTYPE_PATTERN = /\s*<!DOCTYPE\s+(.*?)(\[|>)/um
+
+
+    def parse
+      plist_tags = PTag::mappings.keys.join('|')
+      start_tag  = /<(#{plist_tags})([^>]*)>/i
+      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 )
+      until @scanner.eos?
+        if @scanner.scan(XMLDECL_PATTERN)
+        elsif @scanner.scan(DOCTYPE_PATTERN)
+        elsif @scanner.scan(start_tag)
+          @listener.tag_start(@scanner[1], nil)
+          if (@scanner[2] =~ /\/$/)
+            @listener.tag_end(@scanner[1])
+          end
+        elsif @scanner.scan(TEXT)
+          @listener.text(@scanner[1])
+        elsif @scanner.scan(end_tag)
+          @listener.tag_end(@scanner[1])
+        else
+          raise "Unimplemented element"
+        end
+      end
+    end
+  end
+
+  class PTag
+    @@mappings = { }
+    def PTag::mappings
+      @@mappings
+    end
+
+    def PTag::inherited( sub_class )
+      key = sub_class.to_s.downcase
+      key.gsub!(/^plist::/, '' )
+      key.gsub!(/^p/, '')  unless key == "plist"
+
+      @@mappings[key] = sub_class
+    end
+
+    attr_accessor :text, :children
+    def initialize
+      @children = Array.new
+    end
+
+    def to_ruby
+      raise "Unimplemented: " + self.class.to_s + "#to_ruby on #{self.inspect}"
+    end
+  end
+
+  class PList < PTag
+    def to_ruby
+      children.first.to_ruby
+    end
+  end
+
+  class PDict < PTag
+    def to_ruby
+      dict = Hash.new
+      key = nil
+
+      children.each do |c|
+        if key.nil?
+          key = c.to_ruby
+        else
+          dict[key] = c.to_ruby
+          key = nil
+        end
+      end
+
+      dict
+    end
+  end
+
+  class PKey < PTag
+    def to_ruby
+      CGI::unescapeHTML(text || '')
+    end
+  end
+
+  class PString < PTag
+    def to_ruby
+      CGI::unescapeHTML(text || '')
+    end
+  end
+
+  class PArray < PTag
+    def to_ruby
+      children.collect do |c|
+        c.to_ruby
+      end
+    end
+  end
+
+  class PInteger < PTag
+    def to_ruby
+      text.to_i
+    end
+  end
+
+  class PTrue < PTag
+    def to_ruby
+      true
+    end
+  end
+
+  class PFalse < PTag
+    def to_ruby
+      false
+    end
+  end
+
+  class PReal < PTag
+    def to_ruby
+      text.to_f
+    end
+  end
+
+  require 'date'
+  class PDate < PTag
+    def to_ruby
+      DateTime.parse(text)
+    end
+  end
+
+  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
+    end
+  end
+end

metadata

@@ -1,61 +1,61 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11.3
+rubygems_version: 0.9.0
 specification_version: 1
 name: plist
 version: !ruby/object:Gem::Version 
-  version: 2.1.1
-date: 2006-09-10 00:00:00 -04:00
+  version: 2.1.2
+date: 2006-09-20 00:00:00 -07:00
 summary: All-purpose Property List manipulation library.
 require_paths: 
-  - lib
+- lib
 email: 
 homepage: http://plist.rubyforge.org
 rubyforge_project: plist
-description: "Plist is a library to manipulate Property List files, also known as plists.  It
-  can parse plist files into native Ruby data structures as well as generating new
-  plist files from your Ruby objects."
+description: Plist is a library to manipulate Property List files, also known as plists.  It can parse plist files into native Ruby data structures as well as generating new plist files from your Ruby objects.
 autorequire: plist
 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: 
+post_install_message: 
 authors: 
-  - Ben Bleything and Patrick May
+- Ben Bleything and Patrick May
 files: 
-  - Rakefile
-  - README
-  - MIT-LICENSE
-  - test/assets
-  - test/test_generator_basic_types.rb
-  - test/test_parser.rb
-  - test/assets/AlbumData.xml
-  - test/assets/Cookies.plist
-  - test/assets/example_data.jpg
-  - test/assets/example_data.plist
-  - test/assets/test_empty_key.plist
-  - lib/plist
-  - lib/plist.rb
+- Rakefile
+- README
+- MIT-LICENSE
+- docs/USAGE
+- lib/plist
+- lib/plist.rb
+- lib/plist/generator.rb
+- lib/plist/parser.rb
+- test/test_generator_basic_types.rb
+- test/test_parser.rb
+- test/assets/AlbumData.xml
+- test/assets/Cookies.plist
+- test/assets/example_data.jpg
+- test/assets/example_data.plist
+- test/assets/test_empty_key.plist
 test_files: 
-  - test/assets
-  - test/test_generator_basic_types.rb
-  - test/test_parser.rb
-  - test/assets/AlbumData.xml
-  - test/assets/Cookies.plist
-  - test/assets/example_data.jpg
-  - test/assets/example_data.plist
-  - test/assets/test_empty_key.plist
+- test/test_generator_basic_types.rb
+- test/test_parser.rb
 rdoc_options: []
+
 extra_rdoc_files: []
+
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+