plist.newline 3.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed4d6f700b002cacfed0bbad6c2030fac4e88f38
+  data.tar.gz: 5390812b66f121a78c3bced5d8cc8380ecdf0514
+SHA512:
+  metadata.gz: 151ff81767f020c2fc5db1d13b3f7f68bfb042fa7086f0e1dd791e9f0057939c9343115610dbf7b44e20c4ff630ee8eed6db023a5fa014868bbdf8eb380a022c
+  data.tar.gz: f398bd3464ac90be712b14514a9ad5feb28607ba9b465c051643fc07e81aa99e4a0b02412930f0859166d3cd50bf6b1f71b3be4eb7f5a9b0d7c24363f1949e67

data/.gitignore

@@ -0,0 +1,3 @@
+rdoc
+coverage
+pkg

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+  - 1.8.7
+  - ree

data/CHANGELOG

@@ -0,0 +1,103 @@
+= plist - All-purpose Property List manipulation library
+
+=== Release version 3.0.0!
+
+2010-02-23:
+ * Ruby 1.9.x compatibility!
+
+2010-02-16:
+ * excise a bunch of unnecessary @@ variables
+ * fix up some tests for cross-version compatibility
+
+2010-02-14:
+ * generalized cleanup:
+   * fix old file headers
+   * modernize rakefile
+   * clean up rdoc
+
+2010-01-08:
+ * move from RubyForge Subversion to GitHub
+
+2007-02-22 (r81):
+ * make the plist parser accept strings contain XML or any object that responds to #read (File and StringIO being the intended targets here).  Test and idea contributed by Chuck Remes.
+
+2006-09-20 (r80):
+ * tweak a comment in generator.rb to make it clear that we're not using Base64.b64encode because it's broken.
+
+=== Release version 3.0.0!
+
+2006-09-20 (r77 - r79):
+ * move IndentedString inside Plist::Emit and :nodoc: it
+ * Tag 3.0.0! (from rev 78)
+
+2006-09-19 (r73 - r75):
+ * Really fix the rakefile this time (apparently I deleted some code that I needed...)
+ * alter the fix_whitespace rake task to ignore the assets directory
+ * cleanup whitespace
+
+2006-09-18 (r70 - r72):
+ * Update this file ;)
+ * Fix Rakefile
+   * gem install -t now works correctly
+   * Remove super-sekr1t rdoc staging area from rdoc publishing task
+
+2006-09-15 (r64 - r69):
+* Change behavior of empty collection elements to match What Apple Does
+* Fix some gem packaging infrastructure
+
+2006-09-13 (r61 - r63):
+* Merge generator injection removal branch into trunk!
+
+2006-09-13 (r52 - r60):
+* Fix indentation/newlines in generator (finally!)
+* Refix indentation to be more faithful to the way Apple emits their plists
+* Remove horrific regex and replace it with proper comment parsing
+* Empty plists return nil when parsed
+* Sort hash keys before emitting (now we can test multi-element hashes!)
+* Inject #<=> into Symbol so that sorting Symbol-keyed hashes won't freak out
+
+2006-09-12 (r47 - r51):
+* More test rejiggering
+* New tests to expose some bugs
+
+2006-09-10 (r33 - r46):
+* Update tests for new generator code
+* Rejigger some tests
+* Make the generator try to call #to_plist_node on any object it tries to serialize, thus allowing class authors to define how their objects will be serialized
+* Marshal.dump unrecognized objects into <data> elements
+* Make the parser strip out comments and Marshal.load <data> elements if possible
+* Update some rdoc
+
+=== Release version 2.1.1!
+
+2006-09-10 (r31 - r32):
+* Added encoding / decoding for entities (&amp; etc)
+* Changed parsing of <data> elements to return StringIO objects
+* Fixed bug with empty <key> tags
+
+2006-08-24 (r25 - r30):
+* Invert ownership of methods in the generator, allowing us to remove the self.extend(self)
+* New branch to remove method inject from parser
+
+2006-08-23 (r22 - r24):
+* Add rcov task to Rakefile
+* Add some tests
+
+2006-08-20 (r9 - r21):
+* Add a bunch of rdoc and rdoc infrastructure
+* Add rake task to clean up errant whitespace
+* Spin off a branch to remove a bunch of method injection in the generator code
+* Rename some tests for clarity's sake
+* Replace NARF generation code with Ben's generation code
+  * Update tests
+  * This broke indentation (will be fixed later)
+* Add Plist::Emit.dump, so you can dump objects which don't include Plist::Emit, update tests to match
+* Fix a bug with the method that wraps output in the plist header/footer
+
+2006-08-19 (r1 - r8):
+* The beginnings of merging the plist project into the NARF plist library (under the plist project's name)
+  * fancier project infrastructure (more tests, Rakefile, the like)
+  * Add/update copyright notices in the source files
+  * Move a bunch of documentation out to README
+  * Split library into chunks
+* Properly delete files when cleaning up from tests

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2010, Ben Bleything and Patrick May
+
+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.rdoc

@@ -0,0 +1,164 @@
+= All-purpose Property List manipulation library
+
+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.
+
+== Info
+
+  This version of the plist gem fixes the additional whitespace in front of every line of multiline text values.
+
+== Usage
+
+=== Install
+    gem install plist.newline
+
+=== 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//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//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.
+
+== Links
+
+[Project Page]  http://plist.rubyforge.org
+[GitHub]        http://github.com/bleything/plist
+[RDoc]          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
+[<b>Carsten Bormann, Chris Hoffman, Dana Contreras, Hongli Lai, Johan Sørensen</b>] for contributing Ruby 1.9.x compatibility fixes
+
+== 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
+
+Copyright (c) 2006-2010, 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/Rakefile

@@ -0,0 +1,154 @@
+#
+# Plist Rakefile
+#
+# Based heavily on Geoffrey Grosenbach's Rakefile for gruff.
+# Includes whitespace-fixing task based on code from Typo.
+#
+# Copyright 2006-2010 Ben Bleything and Patrick May
+# Distributed under the MIT License
+#
+
+require 'fileutils'
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rubygems/package_task'
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'plist'
+
+PKG_NAME      = 'plist'
+PKG_VERSION   = Plist::VERSION
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBYFORGE_PROJECT = "plist"
+RUBYFORGE_USER    = ENV['RUBYFORGE_USER']
+
+TEST_FILES    = Dir.glob('test/test_*')
+TEST_ASSETS   = Dir.glob('test/assets/*')
+LIB_FILES     = Dir.glob('lib/**/*')
+RELEASE_FILES = [ "Rakefile", "README.rdoc", "CHANGELOG", "LICENSE" ] + LIB_FILES + TEST_FILES + TEST_ASSETS
+
+task :default => [ :test ]
+# Run the unit tests
+Rake::TestTask.new { |t|
+  t.libs << "test"
+  t.test_files = TEST_FILES
+  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
+
+desc "Copy documentation to rubyforge"
+task :update_rdoc => [ :rdoc ] do
+  Rake::SshDirPublisher.new("#{RUBYFORGE_USER}@rubyforge.org", "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}", "rdoc").upload
+end
+
+begin
+  require 'rdoc/task'
+
+  # Generate the RDoc documentation
+  RDoc::Task.new do |rdoc|
+    rdoc.title = "All-purpose Property List manipulation library"
+    rdoc.main  = "README.rdoc"
+
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'CHANGELOG')
+    rdoc.rdoc_files.include('lib/**')
+
+    rdoc.options = [
+      '-H', # show hash marks on method names in comments
+      '-N', # show line numbers
+    ]
+  end
+rescue LoadError
+  $stderr.puts "Could not load rdoc tasks"
+end
+
+# 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."
+  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.
+EOD
+
+  s.authors  = "Ben Bleything and Patrick May"
+  s.homepage = "http://plist.rubyforge.org"
+
+  s.rubyforge_project = RUBYFORGE_PROJECT
+
+  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/lib/plist/generator.rb

@@ -0,0 +1,201 @@
+#!/usr/bin/env ruby
+#
+# = plist
+#
+# Copyright 2006-2010 Ben Bleything and Patrick May
+# Distributed under the MIT License
+#
+
+module Plist ; end
+
+# === 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 Plist::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(obj.to_plist)
+    end
+  end
+
+  private
+  def self.plist_node(element)
+    output = ''
+
+    if element.respond_to? :to_plist_node
+      output << element.to_plist_node
+    else
+      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_by{|k| k.to_s }.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
+
+  def self.comment(content)
+    return "<!-- #{content} -->\n"
+  end
+
+  def self.tag(type, contents = '', &block)
+    out = nil
+
+    if block_given?
+      out = RecursiveString.new
+      out << "<#{type}>"
+
+      out << block.call
+
+      out << "</#{type}>"
+    else
+      out = "<#{type}>#{contents.to_s}</#{type}>\n"
+    end
+
+    return out.to_s
+  end
+
+  def self.wrap(contents)
+    output = ''
+
+    output << '<?xml version="1.0" encoding="UTF-8"?>' + "\n"
+    output << '<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">' + "\n"
+    output << '<plist version="1.0">' + "\n"
+
+    output << contents
+
+    output << '</plist>' + "\n"
+
+    return output
+  end
+
+  def self.element_type(item)
+    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
+
+  class RecursiveString #:nodoc:
+    attr_accessor :indent_string
+
+    def initialize(str = "\t")
+      @indent_string = str
+      @contents = ''
+    end
+
+    def to_s
+      @contents
+    end
+
+    def <<(val)
+      if val.is_a? Array
+        val.each do |f|
+          self << f
+        end
+      else
+        @contents << val
+      end
+    end
+  end
+end
+
+class Array #:nodoc:
+  include Plist::Emit
+end
+
+class Hash #:nodoc:
+  include Plist::Emit
+end