plist 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006, Ben Bleything <ben@bleything.net>
+
+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,10 @@
+= Ruby PropertyList (plist) Generator
+
+plist adds Array#to_plist and Hash#to_plist, as well as providing
+infrastructure so that you can add plist serialization to your own
+objects.
+
+== License and Copyright
+
+plist is released under the MIT License (see the MIT-LICENSE file) and
+is Copyright 2006, Ben Bleything.

data/Rakefile

@@ -0,0 +1,129 @@
+##############################################################
+# Copyright 2006, Ben Bleything.                             #
+#                <ben@bleything.net>                         #
+#                                                            #
+# Based heavily on Geoffrey Grosenbach's Rakefile for gruff. #
+# Includes whitespace-fixing code based on code from Typo.   #
+#                                                            #
+# Distributed under the MIT license.                         #
+##############################################################
+
+require 'fileutils'
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+$:.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    = "bleything"
+
+TEST_FILES    = Dir.glob('test/test_*.rb').delete_if {|item| item.include?( "\.svn" ) }
+RELEASE_FILES = [ "Rakefile", "README", "MIT-LICENSE" ] + TEST_FILES + Dir.glob( "lib/*" ).delete_if { |item| item.include?( "\.svn" ) }
+
+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 and docs, remove .bak files"
+task :clean => [ :clobber_rdoc, :clobber_package ] do
+  puts cmd = "find . -type f -name *.bak -delete"
+  `#{cmd}`
+end
+
+desc "Strip trailing whitespace and fix newlines for all release files"
+task :fix_whitespace => [ :clean ] do
+  RELEASE_FILES.each do |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}", "docs").upload
+end
+
+# Genereate the RDoc documentation
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'docs'
+  rdoc.title    = "PropertyList Generator -- plist"
+#  rdoc.options << '--line-numbers --inline-source --main README --accessor adv_attr_accessor=M'
+  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/plist.rb')
+}
+
+# Create compressed packages
+spec = Gem::Specification.new do |s|
+  s.name    = PKG_NAME
+  s.version = PKG_VERSION
+
+  s.summary     = "Serialize your data as a Property List (aka plist)."
+  s.description = <<-EOD
+The Property List (plist) Generator allows you to serialize your data to Property Lists.  This is especially useful when writing system-level code for Mac OS X, but has other applications as well.  The basic Ruby datatypes (numbers, strings, symbols, dates/times, arrays, and hashes) can be natively converted to plist types, and other types are Marshal'ed into the plist <data> type.
+EOD
+
+  s.author   = "Ben Bleything"
+  s.email    = "ben@bleything.net"
+  s.homepage = "http://projects.bleything.net/plist"
+
+  s.rubyforge_project = RUBYFORGE_PROJECT
+
+  s.has_rdoc = true
+
+  s.files      = RELEASE_FILES
+  s.test_files = TEST_FILES
+
+  s.autorequire = 'plist'
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end

data/lib/plist.rb

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+
+######################################
+# Copyright 2006, Ben Bleything.     #
+#                <ben@bleything.net> #
+#                                    #
+# Distributed under the MIT license. #
+######################################
+
+#
+# plist data types:
+#
+# CFString -> String
+# CFNumber -> Float(?)
+# CFBoolean -> <true/> or <false/>
+# CFDate -> Date
+# CFData -> binary data
+#
+# CFArray -> Array
+# CFDictionary -> Hash (important: all keys must be CFString/String)
+#
+
+require 'date'
+
+module Plist
+  VERSION = '0.0.1'
+
+  def to_plist(header = true)
+    output = []
+
+    if header
+      output << '<?xml version="1.0" encoding="UTF-8"?>'
+      output << '<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">'
+      output << '<plist version="1.0">'
+    end
+
+    output << plist_node(self)
+
+    output << '</plist>' if header
+
+    return output.join
+  end
+
+  private
+  def plist_node(element)
+    output = ''
+    case element
+    when Array
+      output << tag('array') {
+        element.collect {|e| plist_node(e)}.join
+      }
+    when Hash
+      inner_tags = []
+
+      element.each do |k,v|
+        inner_tags << tag('key', k.to_s)
+        inner_tags << plist_node(v)
+      end
+
+      output << tag('dict') {
+        inner_tags.join
+      }
+    when true, false
+      output << "<#{element}/>"
+    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), element.to_s)
+    else
+      output << tag('data', Marshal.dump(element))
+    end
+
+    return output
+  end
+
+  def tag(type, contents = '', &block)
+    contents << block.call if block_given?
+
+    return "<#{type}>#{contents.to_s}</#{type}>"
+  end
+
+  def element_type(item)
+    return case item
+      when Array:                   'array'
+      when String, Symbol:          'string'
+      when Fixnum, Bignum, Integer: 'integer'
+      when Float:                   'real'
+      when Array:                   'array'
+      when Hash:                    'dict'
+      else
+        raise "Don't know about this data type... something must be wrong!"
+    end
+  end
+end
+
+class Array
+  include Plist
+end
+
+class Hash
+  include Plist
+end

data/test/test_basic_types.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+######################################
+# Copyright 2006, Ben Bleything.     #
+#                <ben@bleything.net> #
+#                                    #
+# Distributed under the MIT license. #
+######################################
+
+require 'test/unit'
+require 'plist'
+
+class TestBasicTypes < Test::Unit::TestCase
+  def wrap(tag, content)
+    return "<array><#{tag}>#{content}</#{tag}></array>"
+  end
+
+  def test_strings
+    expected = wrap('string', 'testdata')
+
+    assert_equal expected, ['testdata'].to_plist(false)
+    assert_equal expected, [:testdata].to_plist(false)
+  end
+
+  def test_integers
+    [42, 2376239847623987623, -8192].each do |i|
+      assert_equal wrap('integer', i), [i].to_plist(false)
+    end
+  end
+
+  def test_floats
+    [3.14159, -38.3897, 2398476293847.9823749872349980].each do |i|
+      assert_equal wrap('real', i), [i].to_plist(false)
+    end
+  end
+
+  def test_booleans
+    assert_equal '<array><true/></array>',  [true].to_plist(false)
+    assert_equal '<array><false/></array>', [false].to_plist(false)
+  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)
+  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
+end

data/test/test_collections.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+######################################
+# Copyright 2006, Ben Bleything.     #
+#                <ben@bleything.net> #
+#                                    #
+# Distributed under the MIT license. #
+######################################
+
+require 'test/unit'
+require 'plist'
+
+class TestCollections < Test::Unit::TestCase
+  def test_true
+    assert true
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: plist
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2006-07-31 00:00:00 -07:00
+summary: Serialize your data as a Property List (aka plist).
+require_paths: 
+- lib
+email: ben@bleything.net
+homepage: http://projects.bleything.net/plist
+rubyforge_project: plist
+description: The Property List (plist) Generator allows you to serialize your data to Property Lists.  This is especially useful when writing system-level code for Mac OS X, but has other applications as well.  The basic Ruby datatypes (numbers, strings, symbols, dates/times, arrays, and hashes) can be natively converted to plist types, and other types are Marshal'ed into the plist <data> type.
+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
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Ben Bleything
+files: 
+- Rakefile
+- README
+- MIT-LICENSE
+- test/test_basic_types.rb
+- test/test_collections.rb
+- lib/plist.rb
+test_files: 
+- test/test_basic_types.rb
+- test/test_collections.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+