rubycf 0.1.0 → 0.2.0

data/README

@@ -1,20 +1,16 @@
-Ruby extension for dealing with CoreFoundation types.  Mostly designed for marshaling structures through binary plists.
+Ruby extension for dealing with CoreFoundation types.  Mostly designed for reading/writing binary and xml plists.
 
-See tests for usage.
+See RubyCF::PList for available methods.
 
-To get this to work outside of the OS X, you need to compile lib/CoreFoundation and link against it when building the gem.  This isn't build into extconf.rb yet, but it will need to be in the future.
+== Examples
+See the unit tests for examples.
 
-About CFData:
+== About CFData
 Since Ruby doesn't treat strings any differently from raw data and CoreFoundation does, there needed to be a way to specify if a string is a string or if it's just data.  For this purpose, I've created the class RubyCF::Data, which is just a container for a ruby string.  When a RubyCF::Data object is passed into the plist encoder, it will encode the data as CFData.  Likewise, when a CFData object is encountered while decoding a plist, a RubyCF::Data object will be created.
 
-TODO
---------------
-- rubyland convenience methods
+== About CFLite
+To get this to work outside of the OS X, you need to compile lib/CoreFoundation and link against it when building the gem.  This is build into extconf.rb, but you may need to modify it if it can't find the path to your library.
 
-
-==========
-notes:
-
-Building CFLite:
-http://cafeine.crulrg.ulaval.ca/users/dccote/weblog/0514e/CoreFoundation_Lite_on_Linux.html
-http://developer.apple.com/opensource/cflite.html
+See the following for information on building CFLite under Linux.
+* http://cafeine.crulrg.ulaval.ca/users/dccote/weblog/0514e/CoreFoundation_Lite_on_Linux.html
+* http://developer.apple.com/opensource/cflite.html

data/lib/plist.h

@@ -3,8 +3,9 @@
 
 RUBY_EXTERN VALUE rb_cCFData;
 
-VALUE rbcf_plist_parse(VALUE self, VALUE data);
-VALUE rbcf_plist_encode(int argc, VALUE *argv, VALUE self);
+// Moved these declarations to rubycf.c so rdoc can find them (lame)
+// VALUE rbcf_plist_parse(VALUE self, VALUE data);
+// VALUE rbcf_plist_encode(int argc, VALUE *argv, VALUE self);
 
 VALUE rbcf_plist_convert_to_ruby(CFPropertyListRef plist);
 CFPropertyListRef rbcf_plist_convert_to_cf(VALUE structure);

data/lib/rubycf.c

@@ -14,12 +14,47 @@
 static VALUE rb_mRubyCF;
 static VALUE rb_cPlist;
 
+/*
+ *  call-seq:
+ *      parse(string) -> Object
+ *  
+ *  Parse a string containing the property list data.  Any of the 
+ *  property list formats will work, including the deprecated
+ *  OpenStep format.
+ */
+VALUE rbcf_plist_parse(VALUE self, VALUE data);
+
+/*
+ *  call-seq:
+ *      encode(Object) -> string
+ *      encode(Object, :xml) -> string
+ *  
+ *  Encode a compatible object into a property list.  The default
+ *  format is binary, but you can specify :xml to get the xml format
+ *  instead.  The OpenStep format is deprecated by CoreFoundation
+ *  and is not available in RubyCF.  
+ *  
+ *  Compatible formats are:
+ *  * RubyCF::Data
+ *  * Hash
+ *  * Array
+ *  * Number
+ *  * Time
+ *  * Boolean
+ *  * anything that responds to to_hash
+ */
+VALUE rbcf_plist_encode(int argc, VALUE *argv, VALUE self);
+
 void Init_rubycf (void)
 {
   // Add the initialization code of your module here.
     rb_mRubyCF = rb_define_module("RubyCF");
-
+    
+    /*
+     *  Methods for encoding and decoding property lists
+     */
     rb_cPlist = rb_define_class_under(rb_mRubyCF, "PList", rb_cObject);
+
     rb_define_module_function(rb_cPlist, "parse", rbcf_plist_parse, 1);
     rb_define_module_function(rb_cPlist, "encode", rbcf_plist_encode, -1);
  

data/lib/rubycf_extensions.rb

@@ -1,26 +1,30 @@
 # Extensions to the build in C functions
 
 module RubyCF
+
   class PList
     class << self
       alias decode parse
     end
 
+    # Parse a plist from a file path or handle
     def self.parse_file file
       self.parse(file.is_a?(File) ? file.read : File.read(file))
     end
   end
   
   # CF handles raw data different from strings.  Ruby treats them the same.
-  # use RubyCF::Data objects to tell the plist encoder to treat the objects
+  # Use RubyCF::Data objects to tell the plist encoder to treat the objects
   # as data.
   class Data
     attr_reader :data
 
+    # Create a RubyCF::Data object from a file path or handle
     def self.from_file file
       Data.new(file.is_a?(File) ? file.read : File.read(file))
     end
 
+    # Create a RubyCF::Data object from a string
     def initialize string
       self.data = string
     end
@@ -45,15 +49,8 @@ module RubyCF
 end
 
 class Object
-  def to_plist(type = :binary)
-    # supported types
-    # [Integer, Float, String, Array, Hash, RubyCF::Data].each do |klass|
-      return RubyCF::PList.encode(self, type) #if self.is_a? klass
-    # end
-    # 
-    # if self.resond_to? :to_hash
-    # elsif self.resond_to? :to_a
-    # elsif self.resond_to?
-    # 
+  # Shorthand for RubyCF::PList.encode(object, format)
+  def to_plist(format = :binary)
+      RubyCF::PList.encode(self, format)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rubycf
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dave Grijalva
@@ -40,7 +40,7 @@ files:
 - lib/rubycf_extensions.rb
 - README
 has_rdoc: true
-homepage: http://ngmoco.com/
+homepage: http://github.com/ngmoco/rubycf/
 licenses: []
 
 post_install_message: 
@@ -66,6 +66,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Bindings for Apple Core Foundation
+summary: Ruby extension for dealing with CoreFoundation types.  Mostly designed for reading and writing xml and binary property lists.
 test_files: []