plist4r 0.2.2 → 1.0.0

data/lib/plist4r/backend/ruby_cocoa.rb

@@ -1,15 +1,60 @@
 
 require 'plist4r/backend_base'
+require 'plist4r/mixin/ruby_stdlib'
 
-# This backend only works on MacOSX. It supports everything except {Backend::Example.to_next_step}, 
-# and saving in the :next_step file format. Here we are calling the stock OSX Ruby in a seperate process. 
+module Plist4r
+  class StringIOData
+    attr_accessor :string
+    def initialize string
+      @string = string
+    end
+
+    def to_s
+      @string
+    end
+
+    def _dump arg
+      @string
+    end
+
+    def self._load string
+      bstr = String.new(string)
+      bstr.blob = true
+      bstr
+    end
+  end
+end
+
+class String
+  def _dump arg
+    if self.blob?
+      string_io_data = Plist4r::StringIOData.new(self)
+      string_io_data._dump arg
+    else
+      self
+    end
+  end
+  
+  def self._load string
+    String.new string
+  end
+end
+
+# This backend only works on MacOSX. It supports everything except {Backend::Example.to_gnustep}, 
+# and saving in the :gnustep file format. This is Because RubyCocoa uses the 
+# NSPropertyListSerialization class, which doesnt support writing to OpenStep Format.
+# 
+# Here we are calling the stock OSX Ruby in a seperate process. 
 # It isolates the runtime from any shared lib (.so) LoadErrors. And allows calling from other installed 
 # Ruby instances (eg REE), which dont usually have RubyCocoa enabled.
 # 
 # This Backend 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).
+# It will do nothing on non-mac platforms (eg Linux etc).
+# @author Dreamcat4 (dreamcat4@gmail.com)
 module Plist4r::Backend::RubyCocoa
   class << self
+    # A seperate ruby script, which runs in its own process.
+    # @see ruby_cocoa_exec
     def ruby_cocoa_wrapper_rb
       @ruby_cocoa_wrapper_rb ||= <<-'EOC'
 #!/usr/bin/ruby
@@ -18,8 +63,62 @@ raise "No path given to plist4r" unless ARGV[0] && File.exists?("#{ARGV[0]}/plis
 dir = ARGV[0]
 $LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
 
-require 'plist4r/mixin/ordered_hash'
 require 'osx/cocoa'
+require 'date'
+require 'plist4r/mixin/ordered_hash'
+require 'plist4r/mixin/ruby_stdlib'
+
+module Plist4r
+  class StringIOData
+    attr_accessor :string
+    def initialize string
+      @string = string
+    end
+
+    def to_s
+      @string
+    end
+
+    def _dump arg
+      @string
+    end
+
+    def self._load string
+      OSX::NSData.dataWithRubyString(string)
+    end
+  end
+end
+
+class String
+  def _dump arg
+    self
+  end
+  
+  def self._load string
+    String.new(string)
+  end
+end
+
+# Property list API.
+module OSX
+  def object_to_plist(object, format=nil)
+    format ||= OSX::NSPropertyListXMLFormat_v1_0
+    data, error = OSX::NSPropertyListSerialization.objc_send \
+      :dataFromPropertyList, object,
+      :format, format,
+      :errorDescription
+    raise error.to_s if data.nil?
+    case format
+      when OSX::NSPropertyListXMLFormat_v1_0, 
+           OSX::NSPropertyListOpenStepFormat
+        OSX::NSString.alloc.initWithData_encoding(data, 
+          OSX::NSUTF8StringEncoding).to_s
+      else
+        data.bytes.bytestr(data.length)
+    end
+  end
+  module_function :object_to_plist
+end
 
 class OSX::NSObject
   def to_ruby
@@ -32,6 +131,8 @@ class OSX::NSObject
       self.integer? ? self.to_i : self.to_f
     when OSX::NSString
       self.to_s
+    when OSX::NSData
+      Plist4r::StringIOData.new self.rubyString
     when OSX::NSAttributedString
       self.string.to_s
     when OSX::NSArray
@@ -50,44 +151,39 @@ class OSX::NSObject
   end
 end
 
-module Plist
-  def to_xml hash
+module Plist  
+  def write_result_file obj
+    File.open @result_file, 'w' do |o|
+      o << obj
+    end
+  end
+
+  def to_xml input_file
     # to_plist defaults to NSPropertyListXMLFormat_v1_0
+    hash = Marshal.load(File.read(input_file))
     x = hash.to_plist
-    puts "#{x}"
+    write_result_file x
   end
 
-  def to_binary hash
+  def to_binary input_file
     # Here 200 == NSPropertyListBinaryFormat_v1_0
+    hash = Marshal.load(File.read(input_file))
     x = hash.to_plist 200
-    puts "#{x}"
+    write_result_file x
   end
 
   def open filename
     plist_dict = ::OSX::NSDictionary.dictionaryWithContentsOfFile(filename)
-    if plist_dict
-      puts "#{plist_dict.to_ruby.inspect}"
-    else
+    unless plist_dict
       plist_array = ::OSX::NSArray.arrayWithContentsOfFile(filename) unless plist_dict
       raise "Couldnt parse file: #{filename}" unless plist_array
       plist_dict = ::Plist4r::OrderedHash.new
       plist_dict["Array"] = plist_array.to_ruby
-      puts "#{plist_dict.inspect}"
     end
-  end
 
-  def save hash, filename, file_format
-    case file_format.to_sym
-    when :xml
-      x = hash.to_plist # NSPropertyListXMLFormat_v1_0
-    when :binary
-      x = hash.to_plist 200 # NSPropertyListBinaryFormat_v1_0
-    when :next_step
-      raise "File format #{file_format.inspect} is not supported by RubyCocoa"
-    else
-      raise "File format #{file_format.inspect} not recognised"
+    File.open @result_file, 'w' do |o|
+      o.write Marshal.dump(plist_dict.to_ruby)
     end
-    File.open(filename,'w'){ |o| o << x }
   end
 end
 
@@ -95,6 +191,7 @@ class RubyCocoaWrapper
   include Plist
 
   def exec stdin
+    @result_file = ARGV[1]
     instance_eval stdin
     exit 0
   end
@@ -106,6 +203,9 @@ wrapper.exec stdin
 EOC
     end
 
+    # Write a temporary script to the filesystem, then execute it
+    # @param [String] stdin_str The command to run
+    # @return [Array] cmd, status, stdout_result, stderr_result
     def ruby_cocoa_exec stdin_str
       rubycocoa_framework = "/System/Library/Frameworks/RubyCocoa.framework"
       raise "RubyCocoa Framework not found. Searched in: #{rubycocoa_framework}" unless File.exists? rubycocoa_framework
@@ -119,16 +219,29 @@ EOC
         @rb_script.close
         File.chmod 0755, @rb_script.path
       end
-      
-      plist4r_root = File.expand_path File.join(File.dirname(__FILE__), "..", "..")
+
       cmd = @rb_script.path
+      plist4r_root = File.expand_path File.join(File.dirname(__FILE__), "..", "..")
+      @result_file = Tempfile.new("result_file.rb")
+      @result_file.close
 
-      pid, stdin, stdout, stderr = ::Plist4r::Popen4::popen4 [cmd, plist4r_root]
+      pid, stdin, stdout, stderr = ::Plist4r::Popen4::popen4 [cmd, plist4r_root, @result_file.path]
 
         stdin.puts stdin_str
-
         stdin.close
-        ignored, status = Process::waitpid2 pid
+
+        ignored, status = [nil,nil]
+
+        begin
+          Timeout::timeout(Plist4r::Config[:backend_timeout]) do
+            ignored, status = Process::waitpid2 pid
+          end
+        rescue Timeout::Error => exc
+          puts "#{exc.message}, killing pid #{pid}"
+          Process::kill('TERM', pid)
+          # Process::kill('HUP', pid)
+          ignored, status = Process::waitpid2 pid
+        end
 
         stdout_result = stdout.read.strip
         stderr_result = stderr.read.strip
@@ -136,12 +249,20 @@ EOC
       return [cmd, status, stdout_result, stderr_result]    
     end
 
+    def read_result_file
+      File.read @result_file.path
+    end
+
     def to_xml plist
-      hash = plist.to_hash
-      result = ruby_cocoa_exec "to_xml(#{hash.inspect})"
+      require 'tempfile'
+      input_file = Tempfile.new "input_file.rb."
+      input_file.puts Marshal.dump(plist.to_hash)
+      input_file.close
+      result = ruby_cocoa_exec "to_xml(\"#{input_file.path}\")"
+      
       case result[1].exitstatus
       when 0
-        xml_string = result[2]
+        xml_string = read_result_file
         return xml_string
       else
         $stderr.puts result[3]
@@ -150,31 +271,35 @@ EOC
     end
 
     def to_binary plist
-      hash = plist.to_hash
-      result = ruby_cocoa_exec "to_binary(#{hash.inspect})"
+      require 'tempfile'
+      input_file = Tempfile.new "input_file.rb."
+      input_file.puts Marshal.dump(plist.to_hash)
+      input_file.close
+      result = ruby_cocoa_exec "to_binary(\"#{input_file.path}\")"
+
       case result[1].exitstatus
       when 0
-        binary_string = result[2]
+        binary_string = read_result_file
         return binary_string
       else
         $stderr.puts result[3]
         raise "Error executing #{result[0]}. See stderr for more information"
       end
     end
-    
+
     def open_with_args plist, filename
+      require 'date'
+
       result = ruby_cocoa_exec "open(\"#{filename}\")"
       case result[1].exitstatus
       when 0
         hash = ::Plist4r::OrderedHash.new
-        eval("hash.replace("+result[2]+")")
+        hash.replace Marshal.load(read_result_file)
         plist.import_hash hash
       else
         $stderr.puts result[3]
         raise "Error executing #{result[0]}. See stderr for more information"
       end
-      file_format = Plist4r.file_detect_format filename
-      plist.file_format file_format
       return plist
     end
 
@@ -187,23 +312,16 @@ EOC
       return open_with_args plist, filename
     end
 
-    def open plist
-      return open_with_args plist, plist.filename
+    def from_xml plist
+      from_string plist
     end
 
-    def save hash, filename, file_format
-      filename = plist.filename_path
-      file_format = plist.file_format || Config[:default_format]
-      raise "#{self} - cant save file of format #{file_format}" unless [:xml,:binary].include? file_format
+    def from_binary plist
+      from_string plist
+    end
 
-      hash = plist.to_hash
-      result = ruby_cocoa_exec "save(\"#{hash.inspect}\",#{filename},#{file_format})"
-      case result[1].exitstatus
-      when 0
-        return true
-      else
-        raise "Error executing #{result[0]}. See stderr for more information"
-      end
+    def from_gnustep plist
+      from_string plist
     end
   end
 end

data/lib/plist4r/backend/test/data_types.rb

@@ -0,0 +1,163 @@
+
+module Plist4r
+  class Backend
+    module Test
+
+      class DataTypes
+        PlistDataTypes =  [:bool, :integer, :float, :string, :time, :array, :hash, :data]
+
+        def initialize *args, &blk
+          @plists = Plist4r::OrderedHash.new
+          PlistDataTypes.each do |pdt|
+            @plist = Plist4r.new
+            self.send "gen_#{pdt}"
+            @plists[pdt] = @plist
+          end
+          
+          @plist_1024 = gen_plist_1024
+        end
+
+        def method_missing meth, *args, &blk
+          @plists[meth] if PlistDataTypes.include?(meth)
+        end
+
+        def plists
+          @plists
+        end
+
+        def plist_1024
+          @plist_1024
+        end
+
+        def gen_bool
+          [true,false].each do |bool|
+            @plist.store "BoolKey#{bool.to_s.capitalize}", bool
+          end
+        end
+
+        def gen_integer
+          (0..9).each do |i|
+            @plist.store "IntegerKey#{(65+i).chr}", i
+          end
+        end
+
+        def gen_float
+          (0..100).each do |i|
+            @plist.store "RealKey#{i}", i.to_f / 100
+          end
+        end
+
+        def gen_string
+          (0..25).each do |i|
+            @plist.store "StringKey#{(65+i).chr}", "#{(97+i).chr}"*(i+1)
+          end
+        end
+
+        def gen_time
+          require 'date'
+          (0..25).each do |i|
+            @plist.store "DateKey#{(65+i).chr}", Time.parse("2010-04-#{sprintf("%.2i",i+1)}T19:50:01Z")
+          end
+        end
+
+        def gen_data
+          # a = []
+          (0..25).each do |i|
+            s = "1"*i
+            bstr = "DataBytes#{s}"
+            bstr.blob = true
+            @plist.store "DataKey#{(65+i).chr}", bstr
+            # a << bstr
+          end
+          # @plist.store "BinaryArray", a
+        end
+
+        def gen_array
+          (0..25).each do |i|
+            a = []
+            (0..i).each do |j|
+              a << "String#{(65+j).chr}"
+            end
+            @plist.store "ArrayKey#{(65+i).chr}", a
+          end
+        end
+
+        def gen_hash
+          (0..25).each do |i|
+            h = Plist4r::OrderedHash.new
+            (0..i).each do |j|
+              h["String#{(65+j).chr}"] = "#{(97+j).chr}"*(j+1)
+            end
+            @plist.store "HashKey#{(65+i).chr}", h
+          end
+        end
+
+        def gen_mixed
+          @plist.edit do
+            [true,false].each do |bool|
+              store "BoolKey#{bool.to_s.capitalize}", bool
+            end
+        
+            (0..9).each do |i|
+              store "IntegerKey#{(65+i).chr}", i
+            end
+        
+            (0..25).each do |i|
+              store "StringKey#{(65+i).chr}", "#{(97+i).chr}"*(i+1)
+            end
+
+            (0..25).each do |i|
+              a = []
+              (0..i).each do |j|
+                a << "String#{(65+j).chr}"
+              end
+              store "ArrayKey#{(65+i).chr}", a
+            end
+
+            (0..25).each do |i|
+              h = Plist4r::OrderedHash.new
+              (0..i).each do |j|
+                h["String#{(65+j).chr}"] = "#{(97+j).chr}"*(j+1)
+              end
+              store "HashKey#{(65+i).chr}", h
+            end
+          end
+        end
+
+        def gen_plist_1024
+          @plist_1024 ||= Plist4r.new do
+            coarse_multiplier = 18
+            (0..coarse_multiplier).each do |i|
+
+              a = []
+              (0..25).each do |j|
+                a << "String#{(65+j).chr}"
+              end
+              store "ArrayKey#{i}", a
+
+              h = Plist4r::OrderedHash.new
+              (0..25).each do |j|
+                h["String#{(65+j).chr}"] = "#{(97+j).chr}"*(j+1)
+              end
+              store "HashKey#{i}", h
+            end
+
+            a = []
+            (0..11).each do |j|
+              a << "String#{(65+j).chr}"
+            end
+            store "ArrayKeyPad1", a
+
+            a = []
+            (0..23).each do |j|
+              a << "String#{(65+j).chr}"
+            end
+            store "ArrayKeyPad2", a
+          end
+          @plist_1024
+        end
+
+      end
+    end
+  end
+end