sj-plist 3.2

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2006, Ben Bleything <ben@bleything.net>
+and Patrick May <patrick@hexane.org>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,40 @@
+= All-purpose Property List manipulation library (w/ binary support)
+
+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.
+
+This fork includes support for binary plists.
+
+== Usage
+
+    gem install 'sj-plist'
+
+See USAGE[link:files/docs/USAGE.html].
+
+== Links
+
+[<b>Project Page</b>]          http://plist.rubyforge.org
+[<b>Subversion repository</b>] svn://rubyforge.org//var/svn/plist
+[<b>RDoc (on RubyForge)</b>]   http://plist.rubyforge.org
+
+== Credits
+
+plist is maintained by Ben Bleything <mailto:ben@bleything.net> and Patrick May <mailto:patrick@hexane.org>.  Patrick wrote most of the code; Ben is a recent addition to the project, having merged in his plist generation library.
+
+Other folks who have helped along the way:
+
+[<b>Martin Dittus</b>] who pointed out that +Time+ wasn't enough for plist <tt>Dates</tt>, especially those in <tt>~/Library/Cookies/Cookies.plist</tt>
+[<b>Chuck Remes</b>] who pushed Patrick towards implementing <tt>#to_plist</tt>
+[<b>Mat Schaffer</b>] who supplied code and test cases for <tt><data></tt> elements
+[<b>Michael Granger</b>] for encouragement and help
+
+== License and Copyright
+
+plist is released under the MIT License.
+
+Portions of the code (notably the Rakefile) contain code pulled and/or adapted from other projects.  These files contain a comment at the top describing what was used.
+
+=== MIT License
+
+:include: MIT-LICENSE
+
+

data/Rakefile

@@ -0,0 +1,135 @@
+##############################################################
+# Copyright 2006, Ben Bleything <ben@bleything.net> and      #
+#                 Patrick May <patrick@hexane.org>           #
+#                                                            #
+# Based heavily on Geoffrey Grosenbach's Rakefile for gruff. #
+# Includes whitespace-fixing task based on code from Typo.   #
+#                                                            #
+# Distributed under the MIT license.                         #
+##############################################################
+
+require 'fileutils'
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rdoc/task'
+require 'rubygems/package_task'
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'plist'
+
+PKG_NAME      = 'sj-plist'
+PKG_VERSION   = Plist::VERSION
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+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
+Rake::TestTask.new { |t|
+  t.libs << "test"
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+}
+
+desc "Clean pkg, coverage, and rdoc; remove .bak files"
+task :clean => [ :clobber_rdoc, :clobber_package, :clobber_coverage ] do
+  puts cmd = "find . -type f -name *.bak -delete"
+  `#{cmd}`
+end
+
+task :clobber_coverage do
+  puts cmd = "rm -rf coverage"
+  `#{cmd}`
+end
+
+desc "Generate coverage analysis with rcov (requires rcov to be installed)"
+task :rcov => [ :clobber_coverage ] do
+  puts cmd = "rcov -Ilib --xrefs -T test/*.rb"
+  puts `#{cmd}`
+end
+
+desc "Strip trailing whitespace and fix newlines for all release files"
+task :fix_whitespace => [ :clean ] do
+  RELEASE_FILES.reject {|i| i =~ /assets/}.each do |filename|
+    next if File.directory? filename
+
+    File.open(filename) do |file|
+      newfile = ''
+      needs_love = false
+
+      file.readlines.each_with_index do |line, lineno|
+        if line =~ /[ \t]+$/
+          needs_love = true
+          puts "#{filename}: trailing whitespace on line #{lineno}"
+          line.gsub!(/[ \t]*$/, '')
+        end
+
+        if line.chomp == line
+          needs_love = true
+          puts "#{filename}: no newline on line #{lineno}"
+          line << "\n"
+        end
+
+        newfile << line
+      end
+
+      if needs_love
+        tempname = "#{filename}.new"
+
+        File.open(tempname, 'w').write(newfile)
+        File.chmod(File.stat(filename).mode, tempname)
+
+        FileUtils.ln filename, "#{filename}.bak"
+        FileUtils.ln tempname, filename, :force => true
+        File.unlink(tempname)
+      end
+    end
+  end
+end
+
+# Genereate the RDoc documentation
+RDoc::Task.new { |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "All-purpose Property List manipulation library"
+  rdoc.options << '-SNmREADME'
+  rdoc.template = "docs/jamis-template.rb"
+  rdoc.rdoc_files.include('README', 'MIT-LICENSE', 'CHANGELOG')
+  rdoc.rdoc_files.include Dir.glob('docs/**').delete_if {|f| f.include? 'jamis' }
+  rdoc.rdoc_files.include('lib/**')
+}
+
+# Create compressed packages
+spec = Gem::Specification.new do |s|
+  s.name    = PKG_NAME
+  s.version = PKG_VERSION
+
+  s.summary     = "All-purpose Property List manipulation library (w/ binary support)."
+  s.description = <<-EOD
+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.
+
+  This fork includes support for binary plists.
+EOD
+
+  s.authors  = "Ben Bleything and Patrick May. Binary support merged by Sijmen Mulder."
+  s.homepage = "http://github.com/sjmulder/plist"
+
+  s.has_rdoc = true
+
+  s.files      = RELEASE_FILES
+  s.test_files = TEST_FILES
+
+  s.autorequire = 'plist'
+end
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end

data/docs/USAGE

@@ -0,0 +1,104 @@
+== 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">
+  <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>
+
+== Generation
+
+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
+
+* +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.
+
+==== 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.
+
+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

@@ -0,0 +1,22 @@
+#--
+##############################################################
+# Copyright 2006, Ben Bleything <ben@bleything.net> and      #
+# Patrick May <patrick@hexane.org>                           #
+#                                                            #
+# Distributed under the MIT license.                         #
+##############################################################
+#++
+# = Plist
+#
+# 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 = '3.2'
+end

data/lib/plist/ascii.rb

@@ -0,0 +1,251 @@
+require 'strscan'
+require "time"
+require "stringio"
+
+module Plist
+
+  #
+  # string - the plist string to parse
+  # opts   - options (see +AsciiParser.new+)
+  #
+
+  def self.parse_ascii(string, opts = {})
+    AsciiParser.new(string, opts).parse
+  end
+
+  #
+  # Plist::AsciiParser
+  #
+  # Parser for the old style ASCII/NextSTEP property lists.
+  #
+  # Created by Jari Bakken on 2008-08-13.
+  #
+  class AsciiParser < StringScanner
+
+    class ParseError < StandardError; end
+
+    SPACE_REGEXP =  %r{   ( /\*.*?\*/   |  # block comments
+                            //.*?$\n?   |  # single-line comments
+                            \s*         )+ # space
+    }mx
+
+    CONTROL_CHAR = {
+      "a" => "\a",
+      "b" => "\b",
+      "n" => "\n",
+      "f" => "\f",
+      "t" => "\t",
+      "r" => "\r",
+      "v" => "\v",
+    }
+
+    BOOLS = {true => "1", false => "0"}
+
+    #
+    # string - the plist string to parse
+    #
+    # options hash:
+    #
+    #   :parse_numbers => true/false   :  Set this to true if you numeric values (float/ints) as the correct Ruby type
+    #   :parse_booleans => true/false  :  Set this to true if you want "true" and "false" to return the boolean Ruby types
+    #
+    #  Note:  Apple's parsers return strings for all old-style plist types.
+    #
+
+    def initialize(string, opts = {})
+      string = case string
+               when StringIO
+                 string.string
+               when IO
+                 string.read
+               else
+                 string
+               end
+
+      @parse_numbers = opts.delete(:parse_numbers)
+      @parse_bools   = opts.delete(:parse_booleans)
+      @debug         = $VERBOSE == true # ruby -W3
+
+      raise ArgumentError, "unknown option #{opts.inspect}" unless opts.empty?
+
+      super(string)
+    end
+
+    def parse
+      res = object
+
+      skip_space
+      error "junk after plist" unless eos?
+
+      res
+    end
+
+    private
+
+    def object
+      skip_space
+
+      if    scan(/\{/) then dictionary
+      elsif scan(/\(/) then array
+      elsif scan(/</)  then data
+      elsif scan(/"/)  then quoted_string
+      else                  unquoted_string
+      end
+    end
+
+    def quoted_string
+      puts "creating quoted string #{inspect}" if @debug
+
+      result = ''
+
+      loop do
+        if scan(/\\/)
+          result << escaped
+        elsif scan(/"/)
+          break
+        elsif eos?
+          error("unterminated quoted string")
+        else scan(/./)
+          error("unterminated quoted string") unless matched
+          result << matched
+        end
+      end
+
+      result
+    end
+
+    def escaped
+      if scan(/"|\\|\\\//)
+        matched
+      elsif scan(/a|b|f|n|v|r|t/)
+        CONTROL_CHAR[matched]
+      elsif scan(/u[0-9a-f]{4}/i)
+        [ matched[1..-1].to_i(16) ].pack("U")
+      elsif scan(/\d{1,3}/)
+        [ matched.to_i(8) ].pack("C")
+      end
+    end
+
+    def unquoted_string
+      puts "creating unquoted string #{inspect}" if @debug
+
+      if scan(/\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} ((\+|-)\d{4})?/)
+        puts "returning time" if @debug
+        require 'date'
+        DateTime.parse(matched)
+      elsif scan(/-?\d+?\.\d+\b/)
+        puts "returning float" if @debug
+        @parse_numbers ? matched.to_f : matched
+      elsif scan(/-?\d+\b/)
+        puts "returning int" if @debug
+        @parse_numbers ? matched.to_i : matched
+      elsif scan(/\b(true|false)\b/)
+        val = matched == 'true'
+        if @parse_bools
+          val
+        else
+          @parse_numbers ? BOOLS[val].to_i : BOOLS[val]
+        end
+      elsif eos?
+        error("unexpected end-of-string")
+      else
+        puts "returning string" if @debug
+        scan(/\w+/)
+      end
+    end
+
+    def data
+      puts "creating data #{inspect}" if @debug
+
+      scan(/(.+?)>/)
+
+      hex = self[1].delete(" ")
+      [hex].pack("H*")
+    end
+
+    def array
+      puts "creating array #{inspect}" if @debug
+
+      skip_space
+
+      arr = []
+      until scan(/\)/)
+        val = object()
+
+        return nil unless val
+        skip_space
+
+        unless skip(/,\s*/)
+          skip_space
+          if scan(/\)/)
+            return arr << val
+          else
+            error "missing ',' or ')' for array"
+          end
+        end
+
+        arr << val
+        error "unexpected end-of-string when parsing array" if eos?
+      end
+
+      arr
+    end
+
+    def dictionary
+      puts "creating dict #{inspect}" if @debug
+
+      skip_space
+
+      dict = {}
+      until scan(/\}/)
+        key = object()
+        p :key => key if @debug
+
+        error "expected terminating '}' for dictionary" unless key
+
+        # dictionary keys must be strings, even if represented as 12345 in the plist
+        if key.is_a?(Integer) && key >= 0
+          key = key.to_s
+        end
+        error "dictionary key must be string (\"quoted\" or alphanumeric)" unless key.is_a? String
+
+        skip_space
+        error "missing '=' in dictionary" unless scan(/=/)
+        skip_space
+
+        val = object()
+        p :val => val if @debug
+
+        skip_space
+        error "missing ';' in dictionary" unless skip(/;/)
+        skip_space
+
+        dict[key] = val
+        error "unexpected end-of-string when parsing dictionary" if eos?
+      end
+
+      dict
+    end
+
+    def error(msg)
+      line = 1
+      string.split(//).each_with_index do |e, i|
+        line += 1 if e == "\n"
+        break if i == pos
+      end
+
+      context = (pos - 10) < 0 ? 0 : pos - 10
+      err = "#{msg} at line #{line}\n"
+      err << "#{string[context..pos+10]}".inspect << "\n"
+
+      err << "\n#{inspect}" if @debug
+      raise ParseError, err
+    end
+
+    def skip_space
+      puts "skipping whitespace" if @debug
+      skip SPACE_REGEXP
+    end
+
+  end
+end