CFPropertyList 2.0.7 → 2.0.8

data/README

@@ -1,8 +1,10 @@
 CFPropertyList implementation
 class to read, manipulate and write both XML and binary property list
-files (plist(5)) as defined by Apple
+files (plist(5)) as defined by Apple. Have a look at CFPropertyList::List
+for more documentation.
 
 == Example
+  require 'cfpropertylist'
 
   # create a arbitrary data structure of basic data types
   data = {
@@ -30,5 +32,5 @@ files (plist(5)) as defined by Apple
 
 Author::    Christian Kruse (mailto:cjk@wwwtech.de)
 Copyright:: Copyright (c) 2010
-License::   Distributes under the same terms as Ruby
+License::   MIT License
 

data/lib/cfpropertylist.rb

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+
+require File.dirname(__FILE__) + '/rbCFPropertyList.rb'
+
+
+# eof

data/lib/rbBinaryCFPropertyList.rb

@@ -1,13 +1,7 @@
 # -*- coding: utf-8 -*-
-#
-# CFPropertyList implementation
-# parser class to read, manipulate and write binary property list files (plist(5)) as defined by Apple
-#
-# Author::    Christian Kruse (mailto:cjk@wwwtech.de)
-# Copyright:: Copyright (c) 2010
-# License::   Distributes under the same terms as Ruby
 
 module CFPropertyList
+  # Binary PList parser class
   class Binary
     # Read a binary plist file
     def load(opts)

data/lib/rbCFPlistError.rb

@@ -1,11 +1,17 @@
 # -*- coding: utf-8 -*-
 #
-# CFFormatError implementation
+# Exceptions used:
+# CFPlistError:: General base exception
+# CFFormatError:: Format error
+# CFTypeError:: Type error
+#
+# Easy and simple :-)
 #
 # Author::    Christian Kruse (mailto:cjk@wwwtech.de)
 # Copyright:: Copyright (c) 2010
 # License::   MIT License
 
+# general plist error. All exceptions thrown are derived from this class.
 class CFPlistError < Exception
 end
 
@@ -13,6 +19,7 @@ end
 class CFFormatError < CFPlistError
 end
 
+# Exception thrown when type errors occur
 class CFTypeError < CFPlistError
 end
 

data/lib/rbCFPropertyList.rb

@@ -1,10 +1,18 @@
 # -*- coding: utf-8 -*-
+
+require 'libxml'
+require 'kconv'
+require 'date'
+
 #
 # CFPropertyList implementation
+#
 # class to read, manipulate and write both XML and binary property list
-# files (plist(5)) as defined by Apple
+# files (plist(5)) as defined by Apple. Have a look at CFPropertyList::List
+# for more documentation.
 #
 # == Example
+#   require 'cfpropertylist'
 #
 #   # create a arbitrary data structure of basic data types
 #   data = {
@@ -33,12 +41,7 @@
 #
 # Author::    Christian Kruse (mailto:cjk@wwwtech.de)
 # Copyright:: Copyright (c) 2010
-# License::   Distributes under the same terms as Ruby
-
-require 'libxml'
-require 'kconv'
-require 'date'
-
+# License::   MIT License
 module CFPropertyList
   # interface class for PList parsers
   class ParserInterface
@@ -144,6 +147,7 @@ module CFPropertyList
 
   module_function :guess, :native_types
 
+  # Class representing a CFPropertyList. Instanciate with #new
   class List
     # Format constant for binary format
     FORMAT_BINARY = 1
@@ -163,6 +167,13 @@ module CFPropertyList
     # the root value in the plist file
     attr_accessor :value
 
+    # initialize a new CFPropertyList, arguments are:
+    #
+    # :file:: Parse a file
+    # :format:: Format is one of FORMAT_BINARY or FORMAT_XML. Defaults to FORMAT_AUTO
+    # :data:: Parse a string
+    #
+    # All arguments are optional
     def initialize(opts={})
       @filename = opts[:file]
       @format = opts[:format] || FORMAT_AUTO
@@ -294,6 +305,7 @@ module CFPropertyList
 end
 
 class Array
+  # convert an array to plist format
   def to_plist(options={})
     options[:plist_format] ||= CFPropertyList::List::FORMAT_BINARY
 
@@ -304,6 +316,7 @@ class Array
 end
 
 class Hash
+  # convert a hash to plist format
   def to_plist(options={})
     options[:plist_format] ||= CFPropertyList::List::FORMAT_BINARY
 

data/lib/rbCFTypes.rb

@@ -5,7 +5,7 @@
 #
 # Author::    Christian Kruse (mailto:cjk@wwwtech.de)
 # Copyright:: Copyright (c) 2009
-# License::   Distributes under the same terms as Ruby
+# License::   MIT License
 
 require 'base64'
 

data/lib/rbXMLCFPropertyList.rb

@@ -1,10 +1,4 @@
 # -*- coding: utf-8 -*-
-# CFPropertyList implementation
-# parser class to read, manipulate and write XML property list files (plist(5)) as defined by Apple
-#
-# Author::    Christian Kruse (mailto:cjk@wwwtech.de)
-# Copyright:: Copyright (c) 2010
-# License::   Distributes under the same terms as Ruby
 
 module CFPropertyList
   # XML parser

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: CFPropertyList
 version: !ruby/object:Gem::Version 
-  version: 2.0.7
+  hash: 31
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 8
+  version: 2.0.8
 platform: ruby
 authors: 
 - Christian Kruse
@@ -14,24 +20,36 @@ default_executable:
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: libxml-ruby
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rake
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 7
+        - 0
         version: 0.7.0
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: This is a module to read, write and manipulate both binary and XML property lists as defined by apple.
 email: cjk@wwwtech.de
 executables: []
@@ -41,6 +59,7 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
+- lib/cfpropertylist.rb
 - lib/rbBinaryCFPropertyList.rb
 - lib/rbCFPlistError.rb
 - lib/rbCFPropertyList.rb
@@ -57,21 +76,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: cfpropertylist
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Read, write and manipulate both binary and XML property lists as defined by apple