plist4r 0.2.2 → 1.0.0

data/lib/plist4r/backend/c_f_property_list/rbXMLCFPropertyList.rb

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+
+module CFPropertyList
+  # XML parser
+  class XML < ParserInterface
+    # read a XML file
+    # opts::
+    # * :file - The filename of the file to load
+    # * :data - The data to parse
+    def load(opts)
+      if(opts.has_key?(:file)) then
+        doc = LibXML::XML::Document.file(opts[:file],:options => LibXML::XML::Parser::Options::NOBLANKS|LibXML::XML::Parser::Options::NOENT)
+      else
+        doc = LibXML::XML::Document.string(opts[:data],:options => LibXML::XML::Parser::Options::NOBLANKS|LibXML::XML::Parser::Options::NOENT)
+      end
+
+      root = doc.root.first
+      return import_xml(root)
+    end
+
+    # serialize CFPropertyList object to XML
+    # opts = {}:: Specify options: :formatted - Use indention and line breaks
+    def to_str(opts={})
+      doc = LibXML::XML::Document.new
+
+      doc.root = LibXML::XML::Node.new('plist')
+      doc.encoding = LibXML::XML::Encoding::UTF_8
+
+      doc.root['version'] = '1.0'
+      doc.root << opts[:root].to_xml()
+
+      # ugly hack, but there's no other possibility I know
+      str = doc.to_s(:indent => opts[:formatted])
+      str1 = String.new
+      first = false
+      str.each_line do
+        |line|
+        str1 << line
+        unless(first) then
+          str1 << "<!DOCTYPE plist PUBLIC \"-//Apple Computer//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n" if line =~ /^\s*<\?xml/
+        end
+
+        first = true
+      end
+
+      return str1
+    end
+
+    protected
+
+    # get the value of a DOM node
+    def get_value(n)
+      return n.first.content if n.children?
+      return n.content
+    end
+
+    # import the XML values
+    def import_xml(node)
+      ret = nil
+
+      case node.name
+      when 'dict'
+        hsh = Hash.new
+        key = nil
+
+        if node.children? then
+          node.children.each do
+            |n|
+            next if n.text? # avoid a bug of libxml
+
+            if n.name == "key" then
+              key = get_value(n)
+            else
+              raise CFFormatError.new("Format error!") if key.nil?
+              hsh[key] = import_xml(n)
+              key = nil
+            end
+          end
+        end
+
+        ret = CFDictionary.new(hsh)
+
+      when 'array'
+        ary = Array.new
+
+        if node.children? then
+          node.children.each do
+            |n|
+            ary.push import_xml(n)
+          end
+        end
+
+        ret = CFArray.new(ary)
+
+      when 'true'
+        ret = CFBoolean.new(true)
+      when 'false'
+        ret = CFBoolean.new(false)
+      when 'real'
+        ret = CFReal.new(get_value(node).to_f)
+      when 'integer'
+        ret = CFInteger.new(get_value(node).to_i)
+      when 'string'
+        ret = CFString.new(get_value(node))
+      when 'data'
+        ret = CFData.new(get_value(node))
+      when 'date'
+        ret = CFDate.new(CFDate.parse_date(get_value(node)))
+      end
+
+      return ret
+    end
+  end
+end
+
+# eof

data/lib/plist4r/backend/example.rb

@@ -11,32 +11,55 @@ require 'plist4r/backend_base'
 # as appropriate. Then raise an exception for those situation where backend is unable to continue.
 # 
 # For example, if your backend is only able to load :xml files, then it should raise an exception
-# whenever it encounters :binary or :next_step formatted files. This is intentional.
+# whenever it encounters :binary or :gnustep formatted files. This is intentional.
 # By throwing the error, it means the API call can be picked up and passed on to the next available backend.
 # 
 # @see Plist4r::Backend
 module Plist4r::Backend::Example
   class << self
-    
+
     # Parse a String of plist data and store it into the supplied {Plist4r::Plist}
     # * Please click "View Source" for the example.
     # @param [Plist4r::Plist] plist The plist object to read the string from
     # @return [Plist4r::Plist] the same plist object, but updated to match its from_string
     # @see Plist4r::Plist#from_string
     # @see Plist4r.string_detect_format
-    def from_string plist
-      plist_string = plist.from_string
-      plist_format = Plist4r.string_detect_format plist.from_string
-      unless [:supported_fmt1,:supported_fmt2].include? plist_format
-        raise "#{self} - cant convert string of format #{plist_format}"
-      end
+    def from_xml plist
+      xml_string = plist.from_string
       hash = ::Plist4r::OrderedHash.new
       # import / convert plist data into ruby ordered hash
       plist.import_hash hash
-      plist.file_format plist_format
       return plist
     end
 
+    # Parse a String of plist data and store it into the supplied {Plist4r::Plist}
+    # * Please click "View Source" for the example.
+    # @param [Plist4r::Plist] plist The plist object to read the string from
+    # @return [Plist4r::Plist] the same plist object, but updated to match its from_string
+    # @see Plist4r::Plist#from_string
+    # @see Plist4r.string_detect_format
+    def from_binary plist
+      binary_string = plist.from_string
+      hash = ::Plist4r::OrderedHash.new
+      # import / convert plist data into ruby ordered hash
+      plist.import_hash hash
+      return plist
+    end
+
+    # Parse a String of plist data and store it into the supplied {Plist4r::Plist}
+    # * Please click "View Source" for the example.
+    # @param [Plist4r::Plist] plist The plist object to read the string from
+    # @return [Plist4r::Plist] the same plist object, but updated to match its from_string
+    # @see Plist4r::Plist#from_string
+    # @see Plist4r.string_detect_format
+    def from_gnustep plist
+      gnustep_string = plist.from_string
+      hash = ::Plist4r::OrderedHash.new
+      # import / convert plist data into ruby ordered hash
+      plist.import_hash hash
+      return plist
+    end
+    
     # Convert a {Plist4r::Plist} into an "xml" formatted plist String
     # * Please click "View Source" for the example.
     # @param [Plist4r::Plist] plist The plist object to convert
@@ -57,52 +80,14 @@ module Plist4r::Backend::Example
       return binary_string
     end
 
-    # Convert a {Plist4r::Plist} into a "next_step" formatted plist String
-    # * Please click "View Source" for the example.
-    # @param [Plist4r::Plist] plist The plist object to convert
-    # @return [String] the next_step string
-    def to_next_step plist
-      hash = plist.to_hash
-      next_step_string = "Convert the plists's nested ruby hash into next_step format here"
-      return next_step_string
-    end
-
-    # Open a plist file and store the contents into the supplied {Plist4r::Plist}
+    # Convert a {Plist4r::Plist} into a "gnustep" formatted plist String
     # * Please click "View Source" for the example.
     # @param [Plist4r::Plist] plist The plist object to convert
-    # @return [String] the next_step string
-    # @see Plist4r.file_detect_format
-    def open plist
-      filename = plist.filename_path
-      file_format = Plist4r.file_detect_format filename
-      unless [:supported_fmt1,:supported_fmt2].include? file_format
-        raise "#{self} - cant load file of format #{file_format}"
-      end
-      plist_file_as_string = File.read(filename)
-      hash = ::Plist4r::OrderedHash.new
-      # import / convert plist data into ruby ordered hash
-      plist.import_hash hash
-      plist.file_format file_format
-      return plist
-    end
-
-    # @param [Plist4r::Plist] plist The plist object to read the filename from
-    # @return [Plist4r::Plist] the same plist object, but updated to match the file contents
-    # @see Plist4r::Plist#filename_path
-    def save plist
-      filename = plist.filename_path
-      file_format = plist.file_format || Config[:default_format]
-      unless [:xml,:binary].include? file_format
-        raise "#{self} - cant save file of format #{file_format}"
-      end
+    # @return [String] the gnustep string
+    def to_gnustep plist
       hash = plist.to_hash
-      output_string = String.new
-      # convert plist's @hash representation into an output_string, 
-      # and formatted to your supported plist file_format(s)
-      File.open(filename,'w') do |out|
-        out << output_string
-      end
-      return true
+      gnustep_string = "Convert the plists's nested ruby hash into gnustep format here"
+      return gnustep_string
     end
   end
 end

data/lib/plist4r/backend/haml.rb

@@ -1,11 +1,16 @@
 
 require 'plist4r/backend_base'
+require 'plist4r/mixin/ruby_stdlib'
+require 'haml'
+require 'base64'
+require 'date'
 
-# Requires Haml. Implements writing and saving for the :xml file format only.
+# This backend uses haml to generate xml plists
+# @author Dreamcat4 (dreamcat4@gmail.com)
 module Plist4r::Backend::Haml
-  class << self
-    def to_xml_haml
-      @to_xml_haml ||= <<-'EOC'
+	class << self
+		def to_xml_haml
+			@to_xml_haml ||= <<-'EOC'
 !!! XML UTF-8
 <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN"
 "http://www.apple.com/DTDs/PropertyList-1.0.dtd" >
@@ -20,56 +25,62 @@ module Plist4r::Backend::Haml
 						<#{v}/>
 					- when String
 						%key #{k}
-						%string #{v}
-					- when Fixnum
+						- if v.blob?
+							- data = Base64::encode64(v)
+							%data #{data}
+						- else
+							%string #{v}
+					- when Integer
 						%key #{k}
 						%integer #{v}
+					- when Float
+						%key #{k}
+						%real #{v}
+					- when Time
+						%key #{k}
+						%date #{v.utc.strftime('%Y-%m-%dT%H:%M:%SZ')}
+					- when Date
+						%key #{k}
+						%date #{v.strftime('%Y-%m-%dT%H:%M:%SZ')}
 					- when Array
 						%key #{k}
 						%array
 							- v.compact.each do |e|
 								- case e
 									- when TrueClass, FalseClass
-										<#{v}/>
+										<#{e}/>
 									- when String
-										%string #{e}
-									- when Fixnum
-										%integer #{v}
+										- if e.blob?
+											- data = Base64::encode64(e)
+											%data #{data}
+										- else
+											%string #{e}
+									- when Integer
+										%integer #{e}
+									- when Float
+										%real #{e}
+									- when Time
+										%date #{e.utc.strftime('%Y-%m-%dT%H:%M:%SZ')}
+									- when Date
+										%date #{e.strftime('%Y-%m-%dT%H:%M:%SZ')}
 									- when Hash
 										%dict
 											- tab_up ; block.call(e, block) ; tab_down
-									- else
-										- raise "Invalid input. Array: #{v.inspect} can only contain elements of type String (<string>) or Hash (<dict>). Found element: #{e.inspect} of type: \"#{e.class}\""
 					- when Hash
 						%key #{k}
 						%dict
 							- tab_up ; block.call(v, block) ; tab_down
-					- else
-						- raise "Invalid input. Hash: #{data.inspect} can only contain values of type true, false, String (<string>) Fixnum (<integer>) Array (<array>) or Hash (<dict>). Found value: #{v.inspect} of type: \"#{v.class}\""
-		- p.call( @hash, p)
-EOC
-    end
 
-    def to_xml plist
-      require 'haml'
-      # engine = Haml::Engine.new File.read("launchd_plist.haml")
-      engine = Haml::Engine.new to_xml_haml
-      rendered_xml_output = engine.render self
-      File.open(@filename,'w') do |o|
-        o << rendered_xml_output
-      end
-    end
+		- p.call( @plist.to_hash, p)
+EOC
+		end
 
-    def save plist
-      file_format = plist.file_format || Config[:default_format]
-      raise "#{self} - cant save file format #{file_format}" unless file_format == :xml
+		def to_xml plist
+			@plist = plist
+			engine = Haml::Engine.new to_xml_haml
+			rendered_xml_output = engine.render self
+		end
 
-      hash = plist.to_hash
-      filename = plist.filename_path
-      File.open(filename,'w') do |out|
-        out << to_xml(plist)
-      end
-    end
-  end
+	end
 end
 

data/lib/plist4r/backend/libxml4r.rb

@@ -1,7 +1,11 @@
 
 require 'plist4r/backend_base'
+require 'libxml4r'
+require 'base64'
+require 'date'
 
-# Requires Libxml4r. Implements loading / parsing for the :xml file format only.
+# This backend uses Libxml4r / Libxml-Ruby to parse xml plists
+# @author Dreamcat4 (dreamcat4@gmail.com)
 module Plist4r::Backend::Libxml4r
   class << self
     def tree_hash n
@@ -17,12 +21,18 @@ module Plist4r::Backend::Libxml4r
           hash[k] = vnode.inner_xml
         when "integer"
           hash[k] = vnode.inner_xml.to_i
+        when "real"
+          hash[k] = vnode.inner_xml.to_f
+        when "date"
+          hash[k] = Time.parse vnode.inner_xml
+        when "data"
+          bstr = Base64.decode64(vnode.inner_xml)
+          bstr.blob = true
+          hash[k] = bstr
         when "array"
           hash[k] = tree_array(vnode)
         when "dict"
           hash[k] = tree_hash(vnode)
-        else
-          raise "Unsupported / not recognized plist key: #{vnode.name}"
         end
       end
       return hash
@@ -38,20 +48,24 @@ module Plist4r::Backend::Libxml4r
           array << node.inner_xml
         when "integer"
           array << node.inner_xml.to_i
+        when "real"
+          array << node.inner_xml.to_f
+        when "date"
+          array << Time.parse(node.inner_xml)
+        when "data"
+          bstr = bstr = Base64.decode64(node.inner_xml)
+          bstr.blob = true
+          array << bstr
         when "array"
           array << tree_array(node)
         when "dict"
           array << tree_hash(node)
-        else
-          raise "Unsupported / not recognized plist key: #{vnode.name}"
         end
       end
       return array
     end
 
     def parse_plist_xml string
-      require 'rubygems'
-      require 'libxml4r'
       ::LibXML::XML.default_keep_blanks = false
       doc = string.to_xmldoc
       doc.strip!
@@ -70,22 +84,12 @@ module Plist4r::Backend::Libxml4r
       ordered_hash
     end
 
-    def from_string plist, string
-      plist_format = Plist4r.string_detect_format string
-      raise "#{self} - cant convert string of format #{plist_format}" unless plist_format == :xml
-      hash = parse_plist_xml string
+    def from_xml plist
+      hash = parse_plist_xml plist.from_string
       plist.import_hash hash
-      plist.file_format plist_format
+      plist.file_format "xml"
       return plist
     end
-
-    def open plist
-      filename = plist.filename_path
-      file_format = Plist4r.file_detect_format filename
-      raise "#{self} - cant load file of format #{file_format}" unless file_format == :xml
-
-      return from_string plist, File.read(filename)
-    end
   end
 end
 

data/lib/plist4r/backend/osx_plist.rb

@@ -0,0 +1,82 @@
+
+require 'plist4r/backend_base'
+
+# Source: http://github.com/kballard/osx-plist
+# 
+# This backend only works on MacOSX. It supports everything using a compiled CoreFoundation helper
+# in ext directory, and uses native Cocoa CoreFoundation API calls. This backend invokes 
+# CFPropertyListWriteToStream.
+# 
+# Should work for any 10.5 (Leopard), 10.6 (Snow Leopard) Mac OSX distribution.
+# It will do nothing on non-mac platforms (eg Linux etc).
+# @author Kevin Ballard (http://github.com/kballard)
+module Plist4r::Backend::OsxPlist
+  class << self
+
+    def require_c_ext
+      core_foundation_framework = "/System/Library/Frameworks/CoreFoundation.framework"
+      unless File.exists? core_foundation_framework
+        raise "CoreFoundation Framework not found. Searched in: #{core_foundation_framework}"
+      end
+      require "#{File.dirname(__FILE__)}/osx_plist/ext/osx_plist"
+    end
+
+    def from_string plist
+      require_c_ext
+      ruby_object = Plist4r::Backend::OsxPlist.load(plist.from_string, nil)
+
+      hash_obj = nil
+      if ruby_object.is_a? Hash
+        hash_obj = ruby_object
+
+      elsif ruby_object
+        hash_obj = { ruby_object.class.to_s => ruby_object }
+
+      else
+        raise "Conversion tp plist object failed"
+      end
+
+      hash = ::Plist4r::OrderedHash.new
+      hash.replace hash_obj
+      plist.import_hash hash
+
+      return plist
+    end
+
+    def from_xml plist
+      from_string plist
+    end
+
+    def from_binary plist
+      from_string plist
+    end
+
+    def from_gnustep plist
+      from_string plist
+    end
+
+    def to_fmt plist, fmt
+      require_c_ext
+      string = ""
+      sio = StringIO.new(string, "w")
+      Plist4r::Backend::OsxPlist.dump(sio, plist.to_hash, fmt)
+      return string
+    end
+
+    def to_xml plist
+      to_fmt plist, :xml1
+    end
+
+    def to_binary plist
+      to_fmt plist, :binary1
+    end
+
+    # alas, no longer supported by the apple apis :(
+    # def to_gnustep plist
+    #   to_fmt plist, :openstep
+    # end
+  end
+end
+
+
+