kballard-osx-plist 1.0.2 → 1.0.3

data/History.txt

@@ -1,2 +1,12 @@
+== 1.0.3 / 2009-09-21
+  * Add two new methods OSX::PropertyList.load_file and OSX::PropertyList.dump_file
+  * Clean up the RDoc documentation
+
+== 1.0.2 / 2009-09-17
+  * Build properly under Mac OS X 10.6
+
+== 1.0.1 / 2009-02-05
+  * Ruby 1.9.1 compatibility
+
 == 1.0 / 2008-04-25
   * First public release

data/Manifest.txt

@@ -4,6 +4,7 @@ README.txt
 Rakefile
 ext/plist/extconf.rb
 ext/plist/plist.c
+lib/osx/plist.rb
 test/fixtures/xml_plist
 test/suite.rb
 test/test_plist.rb

data/README.txt

@@ -1,11 +1,11 @@
-== osx/plist
+== osx-plist
 
 * http://github.com/kballard/osx-plist
 * by Kevin Ballard
 
 == DESCRIPTION:
 
-osx/plist is a Ruby library for manipulating Property Lists natively using the built-in support in OS X.
+osx-plist is a Ruby library for manipulating Property Lists natively using the built-in support in OS X.
 
 == REQUIREMENTS:
 
@@ -18,7 +18,7 @@ osx/plist is a Ruby library for manipulating Property Lists natively using the b
 
 == SOURCE:
 
-osx/plist's git repo is available on GitHub, which can be browsed at:
+osx-plist's git repo is available on GitHub, which can be browsed at:
 
   http://github.com/kballard/osx-plist
 

data/Rakefile

@@ -3,7 +3,14 @@ require 'hoe'
 
 Hoe.spec 'osx-plist' do
   developer("Kevin Ballard", "kevin@sb.org")
-  self.version = "1.0.2"
+  self.version = "1.0.3"
   self.summary = "Property List manipulation for OS X"
   self.spec_extras = {:extensions => "ext/plist/extconf.rb"}
 end
+
+# override Hoe's default :test task
+Rake::Task["test"].clear
+desc "Run the unit tests"
+task :test do
+  ruby "test/test_plist.rb"
+end

data/ext/plist/extconf.rb

@@ -2,4 +2,4 @@
 require 'mkmf'
 $LDFLAGS += ' -framework CoreFoundation -undefined suppress -flat_namespace'
 $LIBRUBYARG_SHARED=""
-create_makefile("osx/plist")
+create_makefile("osx/plist/ext/plist")

data/ext/plist/plist.c

@@ -43,19 +43,6 @@
  *
  */
 
-/*
- * Document-class: PropertyList
- *
- * The PropertyList module provides a means of converting a
- * Ruby Object to a Property List.
- *
- * The various Objects that can be converted are the ones
- * with an equivalent in CoreFoundation. This includes: String,
- * Integer, Float, Boolean, Time, Hash, and Array.
- *
- * See also: String#blob?, String#blob=, and Object#to_plist
- */
-
 #include <ruby.h>
 #if HAVE_RUBY_ST_H
 #include <ruby/st.h>
@@ -117,14 +104,13 @@ void raiseError(CFStringRef error) {
 }
 
 /* call-seq:
- *    PropertyList.load(obj)         -> object
- *    PropertyList.load(obj, format) -> [object, format]
+ *    load(obj, format = false)
  *
  * Loads a property list from an IO stream or a String and creates
  * an equivalent Object from it.
  *
- * If +format+ is provided, it returns one of
- * <tt>:xml1</tt>, <tt>:binary1</tt>, or <tt>:openstep</tt>.
+ * If +format+ is +true+, it returns an array of <tt>[object, format]</tt>
+ * where +format+ is one of <tt>:xml1</tt>, <tt>:binary1</tt>, or <tt>:openstep</tt>.
  */
 VALUE plist_load(int argc, VALUE *argv, VALUE self) {
 	VALUE io, retFormat;
@@ -331,8 +317,7 @@ VALUE convertPlistToString(CFPropertyListRef plist, CFPropertyListFormat format)
 }
 
 /* call-seq:
- *    PropertyList.dump(io, obj)         -> Integer
- *    PropertyList.dump(io, obj, format) -> Integer
+ *    dump(io, obj, format = :xml1)
  *
  * Writes the property list representation of +obj+
  * to the IO stream (must be open for writing).
@@ -375,8 +360,7 @@ VALUE plist_dump(int argc, VALUE *argv, VALUE self) {
 }
 
 /* call-seq:
- *    object.to_plist         -> String
- *    object.to_plist(format) -> String
+ *    object.to_plist(format = :xml1)
  *
  * Converts the object to a property list representation
  * and returns it as a string.
@@ -534,7 +518,7 @@ CFDateRef convertTime(VALUE obj) {
 }
 
 /* call-seq:
- *    str.blob? -> Boolean
+ *    str.blob?
  *
  * Returns whether or not +str+ is a blob.
  */
@@ -548,7 +532,7 @@ VALUE str_blob(VALUE self) {
 }
 
 /* call-seq:
- *    str.blob = bool -> bool
+ *    str.blob = bool
  *
  * Sets the blob status of +str+.
  */
@@ -561,8 +545,25 @@ VALUE str_setBlob(VALUE self, VALUE b) {
 	}
 }
 
-/* Bridge to CoreFoundation for reading/writing Property Lists.
- * Only works when CoreFoundation is available.
+/*
+ * Document-module: OSX
+ */
+
+/*
+ * Document-module: OSX::PropertyList
+ *
+ * The PropertyList module provides a means of converting a
+ * Ruby Object to a Property List.
+ *
+ * The various Objects that can be converted are the ones
+ * with an equivalent in CoreFoundation. This includes: String,
+ * Integer, Float, Boolean, Time, Hash, and Array.
+ *
+ * See also: String#blob?, String#blob=, and Object#to_plist
+ */
+
+/*
+ * Document-class: OSX::PropertyListError
  */
 void Init_plist() {
 	mOSX = rb_define_module("OSX");
@@ -575,6 +576,7 @@ void Init_plist() {
 	ePropertyListError = rb_define_class_under(mOSX, "PropertyListError", rb_eStandardError);
 	id_gm = rb_intern("gm");
 	timeEpoch = rb_funcall(rb_cTime, id_gm, 1, INT2FIX(2001));
+	/* Time.gm(2001): The Cocoa epoch of January 1st, 2001*/
 	rb_define_const(mPlist, "EPOCH", timeEpoch);
 	id_plus = rb_intern("+");
 	id_minus = rb_intern("-");

data/lib/osx/plist.rb

@@ -0,0 +1,18 @@
+require "#{File.dirname(__FILE__)}/plist/ext/plist"
+
+module OSX
+  module PropertyList
+    # Loads a property list from the file at +filepath+ using OSX::PropertyList.load.
+    def self.load_file(filepath, format = false)
+      File.open(filepath, "r") do |f|
+        OSX::PropertyList.load(f, format)
+      end
+    end
+    # Writes the property list representation of +obj+ to the file at +filepath+ using OSX::PropertyList.dump.
+    def self.dump_file(filepath, obj, format = :xml1)
+      File.open(filepath, "w") do |f|
+        OSX::PropertyList.dump(f, obj, format)
+      end
+    end
+  end
+end

data/test/test_plist.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'osx/plist'
 require 'stringio'
+require 'tempfile'
 require 'test/unit'
 
 class TestPlist < Test::Unit::TestCase
@@ -66,4 +67,22 @@ class TestPlist < Test::Unit::TestCase
     hash = setup_hash()
     assert_equal(hash, OSX::PropertyList.load(hash.to_plist))
   end
+
+  def test_load_file
+    plist, format = OSX::PropertyList.load_file("#{File.dirname(__FILE__)}/fixtures/xml_plist", true)
+
+    hash = setup_hash
+
+    assert_equal(hash, plist)
+    assert_equal(:xml1, format)
+  end
+
+  def test_dump_file
+    hash = setup_hash
+    Tempfile.open("test_plist") do |temp|
+      OSX::PropertyList.dump_file(temp.path, hash)
+      hash2 = OSX::PropertyList.load_file(temp.path)
+      assert_equal(hash, hash2)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kballard-osx-plist
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - Kevin Ballard
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-17 00:00:00 -07:00
+date: 2009-09-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.3.3
     version: 
-description: osx/plist is a Ruby library for manipulating Property Lists natively using the built-in support in OS X.
+description: osx-plist is a Ruby library for manipulating Property Lists natively using the built-in support in OS X.
 email: 
 - kevin@sb.org
 executables: []
@@ -40,10 +40,11 @@ files:
 - Rakefile
 - ext/plist/extconf.rb
 - ext/plist/plist.c
+- lib/osx/plist.rb
 - test/fixtures/xml_plist
 - test/suite.rb
 - test/test_plist.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/kballard/osx-plist
 licenses: 
 post_install_message: 
@@ -51,6 +52,7 @@ rdoc_options:
 - --main
 - README.txt
 require_paths: 
+- lib
 - ext
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
@@ -69,7 +71,7 @@ requirements: []
 rubyforge_project: osx-plist
 rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Property List manipulation for OS X
 test_files: 
 - test/test_plist.rb