plist4r 0.1.0 → 0.1.1

data/lib/plist4r/mixin/ruby_stdlib.rb

@@ -1,4 +1,6 @@
 
+# These methods should all be nemespaced to ::Plist4r
+# we don't want to upset anyone else's code
 
 class Object
   def method_name

data/lib/plist4r/plist.rb

@@ -1,88 +1,92 @@
 
 require 'plist4r/mixin/ordered_hash'
+require 'plist4r/mixin/ruby_stdlib'
+require 'plist4r/plist_cache'
 require 'plist4r/plist_type'
+Dir.glob(File.dirname(__FILE__) + "/plist_type/**/*.rb").each {|t| require File.expand_path t}
 require 'plist4r/backend'
 
-
-class Plist4r::Plist
-  PlistOptionsHash = %w[from_string filename path file_format plist_type unsupported_keys]
-  FileFormats      = %w[binary xml next_step]
+module Plist4r
+  class Plist
+    PlistOptionsHash = %w[from_string filename path file_format plist_type unsupported_keys backends]
+    FileFormats      = %w[binary xml next_step]
   
-  def initialize *args, &blk
-    @hash             = ::ActiveSupport::OrderedHash.new
-    @plist_cache      = PlistCache.new self
-    @plist_type       = plist_type PlistType::Plist
-    @unsupported_keys = Config[:unsupported_keys]
-    @from_string      = nil
-    @filename         = nil
-    @file_format      = nil
-    @path             = Config[:default_path]
+    def initialize *args, &blk
+      @hash             = ::ActiveSupport::OrderedHash.new
+      # @plist_type       = plist_type PlistType::Plist
+      @unsupported_keys = Config[:unsupported_keys]
+      @backends         = Config[:backends]
+      @from_string      = nil
+      @filename         = nil
+      @file_format      = nil
+      @path             = Config[:default_path]
 
-    case args.first
-    when Hash
-      parse_opts args.first
+      case args.first
+      when Hash
+        parse_opts args.first
 
-    when String, Symbol
-      @filename = args.first.to_s
-    when nil
-    else
-      raise "Unrecognized first argument: #{args.first.inspect}"
+      when String, Symbol
+        @filename = args.first.to_s
+      when nil
+      else
+        raise "Unrecognized first argument: #{args.first.inspect}"
+      end
+      
+      @plist_cache = PlistCache.new self
     end
-  end
 
-  def from_string string=nil
-    case string
-    when String
-      plist_format = ::Plist4r.string_detect_format string
-      if plist_format
-        eval "@plist_cache.from_#{format}, string"
+    def from_string string=nil
+      case string
+      when String
+        plist_format = ::Plist4r.string_detect_format string
+        if plist_format
+          eval "@plist_cache.from_#{format}, string"
+        else
+          raise "Unknown plist format for string: #{string}"
+        end
+        @from_string = string
+      when nil
+        @from_string
       else
-        raise "Unknown plist format for string: #{string}"
+        raise "Please specify a string of plist data"
       end
-      @from_string = string
-    when nil
-      @from_string
-    else
-      raise "Please specify a string of plist data"
     end
-  end
 
-  def filename filename=nil
-    case filename
-    when String
-      @filename = filename
-    when nil
-      @filename
-    else
-      raise "Please specify a filename"
+    def filename filename=nil
+      case filename
+      when String
+        @filename = filename
+      when nil
+        @filename
+      else
+        raise "Please specify a filename"
+      end
     end
-  end
 
-  def path path=nil
-    case path
-    when String
-      @path = path
-    when nil
-      @path
-    else
-      raise "Please specify a directory"
+    def path path=nil
+      case path
+      when String
+        @path = path
+      when nil
+        @path
+      else
+        raise "Please specify a directory"
+      end
     end
-  end
 
-  def filename_path filename_path=nil
-    case path
-    when String
-      @filename = File.basename filename_path
-      @path     = File.dirname  filename_path
-    when nil
-      File.expand_path @filename, @path    
-    else
-      raise "Please specify directory + filename"
+    def filename_path filename_path=nil
+      case path
+      when String
+        @filename = File.basename filename_path
+        @path     = File.dirname  filename_path
+      when nil
+        File.expand_path @filename, @path    
+      else
+        raise "Please specify directory + filename"
+      end
     end
-  end
 
-  def file_format file_format=nil
-    begin
+    def file_format file_format=nil
       case file_format
       when Symbol, String
         if FileFormats.include? file_format.to_s.snake_case
@@ -95,111 +99,114 @@ class Plist4r::Plist
       else
         raise "Please specify a valid plist file format, #{FileFormats.inspect}"
       end
-    rescue
-      raise "Please specify a valid plist file format, #{FileFormats.inspect}"
     end
-  end
 
-  def plist_type plist_type=nil
-    begin
-      case plist_type
-      when Class
-        @plist_type = PlistType::Plist.new :hash => @hash
-      when Symbol, String
-        eval "pt_klass = PlistType::#{plist_type.to_s.camelcase}"
-        @plist_type = pt_klass.new :hash => @hash
+    def plist_type plist_type=nil
+      begin
+        case plist_type
+        when Class
+          @plist_type = PlistType::Plist.new :hash => @hash
+        when Symbol, String
+          eval "pt_klass = PlistType::#{plist_type.to_s.camelcase}"
+          @plist_type = pt_klass.new :hash => @hash
+        when nil
+          @plist_type
+        else
+          raise "Please specify a valid plist class name, eg ::Plist4r::PlistType::ClassName, \"class_name\" or :class_name"
+        end
+      rescue
+        raise "Please specify a valid plist class name, eg ::Plist4r::PlistType::ClassName, \"class_name\" or :class_name"
+      end
+    end
+  
+    def unsupported_keys bool
+      case bool
+      when true,false
+        @unsupported_keys = bool
       when nil
-        @plist_type
+        @unsupported_keys
       else
-        raise "Please specify a valid plist class name, eg ::Plist4r::PlistType::ClassName, \"class_name\" or :class_name"
+        raise "Please specify true or false to enable / disable this option"
       end
-    rescue
-      raise "Please specify a valid plist class name, eg ::Plist4r::PlistType::ClassName, \"class_name\" or :class_name"
     end
-  end
   
-  def unsupported_keys bool
-    case bool
-    when true,false
-      @unsupported_keys = bool
-    when nil
-      @unsupported_keys
-    else
-      raise "Please specify true or false to enable / disable this option"
+    def backends backends=nil
+      case backends
+      when Array
+        @backends = backends
+      when nil
+        @backends
+      else
+        raise "Please specify an array of valid Plist4r Backends"
+      end
     end
-  end
   
-  def parse_opts opts
-    PlistOptionsHash.each do |opt|
-      eval "@#{opt} = #{opts[opt.to_sym]}" if opts[opt.to_sym]
+    def parse_opts opts
+      PlistOptionsHash.each do |opt|
+        eval "@#{opt} = #{opts[opt.to_sym]}" if opts[opt.to_sym]
+      end
     end
-  end
 
-  def open filename=nil
-    @filename = filename if filename
-    raise "No filename specified" unless @filename
-    @hash = @plist_cache.open
-  end
+    def open filename=nil
+      @filename = filename if filename
+      raise "No filename specified" unless @filename
+      # @hash = @plist_cache.open
+      @plist_cache.open
+    end
 
-  def << *args, &blk
-    edit *args, &blk
-  end
+    def << *args, &blk
+      edit *args, &blk
+    end
 
-  def edit *args, &blk
-    instance_eval &blk
-  end
+    def edit *args, &blk
+      instance_eval &blk
+    end
   
-  def method_missing method_sym, *args, &blk
-    @plist_type.send method_sym, *args, &blk
-  end
+    def method_missing method_sym, *args, &blk
+      @plist_type.send method_sym, *args, &blk
+    end
   
-  def import_hash hash=nil
-    case path
-    when ::ActiveSupport::OrderedHash
-      @hash = hash
-    when nil
-      @hash = ::ActiveSupport::OrderedHash.new
-    else
-      raise "Please use ::ActiveSupport::OrderedHash.new for your hashes"
+    def import_hash hash=nil
+      case hash
+      when ::ActiveSupport::OrderedHash
+        @hash = hash
+      when nil
+        @hash = ::ActiveSupport::OrderedHash.new
+      else
+        raise "Please use ::ActiveSupport::OrderedHash.new for your hashes"
+      end
     end
-  end
   
-  def to_hash
-    @hash
-  end
+    def to_hash
+      @hash
+    end
   
-  def to_xml
-    @plist_cache.to_xml
-  end
+    def to_xml
+      @plist_cache.to_xml
+    end
   
-  def to_binary
-    @plist_cache.to_binary
-  end
+    def to_binary
+      @plist_cache.to_binary
+    end
 
-  def to_next_step
-    @plist_cache.to_next_step
-  end
+    def to_next_step
+      @plist_cache.to_next_step
+    end
   
-  def save
-    raise "No filename specified" unless @filename
-    @plist_cache.save
-  end
+    def save
+      raise "No filename specified" unless @filename
+      @plist_cache.save
+    end
   
-  def save_as filename
-    @filename = filename
-    save
+    def save_as filename
+      @filename = filename
+      save
+    end
   end
 end
 
-
-
-# plutil -convert xml1 @filename
-# plutil -convert binary1 @filename
-
-
 module Plist4r
-  class Plist
-    include ::Plist4r::Popen4
+  class OldPlist
   
     def initialize path_prefix, plist_str, &blk
       plist_str << ".plist" unless plist_str =~ /\.plist$/

data/lib/plist4r/plist_cache.rb

@@ -1,66 +1,70 @@
 
 require 'plist4r/backend'
-
-class Plist4r::PlistCache
-  def initialize plist, *args, &blk
-    @plist = plist
-    @backend = Backend.new plist, *args, &blk
-  end
+module Plist4r
+  class PlistCache
+    def initialize plist, *args, &blk
+      @plist = plist
+      @backend = Backend.new plist, *args, &blk
+    end
   
-  def checksum
-    @plist.to_hash.hash
-  end
+    def checksum
+      @plist.to_hash.hash
+    end
   
-  def last_checksum
-    @checksum
-  end
+    def last_checksum
+      @checksum
+    end
 
-  def update_checksum
-    @checksum = @plist.to_hash.hash
-  end
+    def update_checksum
+      @checksum = @plist.to_hash.hash
+    end
 
-  def needs_update
-    checksum != last_checksum
-  end
+    def needs_update
+      checksum != last_checksum
+    end
 
-  def to_xml
-    if needs_update
-      update_checksum
-      @xml = @backend.call :to_xml
-    else
-      @xml
+    def to_xml
+      puts "in to_xml"
+      # if needs_update
+        puts "needs update"
+        update_checksum
+        @xml = @backend.call :to_xml
+      # else
+        # @xml
+      # end
     end
-  end
   
-  def to_binary
-    if needs_update
-      update_checksum
-      @binary = @backend.call :to_binary
-    else
-      @binary
+    def to_binary
+      if needs_update
+        update_checksum
+        @binary = @backend.call :to_binary
+      else
+        @binary
+      end
     end
-  end
 
-  def to_next_step
-    if needs_update
-      update_checksum
-      @next_step = @backend.call :to_next_step
-    else
-      @next_step
+    def to_next_step
+      if needs_update
+        update_checksum
+        @next_step = @backend.call :to_next_step
+      else
+        @next_step
+      end
     end
-  end
-  
-  def open
-    @backend.call :load
-    update_checksum    
-  end
   
-  def save
-    if needs_update
+    def open
+      @backend.call :open
       update_checksum
-      @backend.call :save
-    else
-      true
+      @plist
+    end
+  
+    def save
+      if needs_update
+        update_checksum
+        @backend.call :save
+      else
+        true
+      end
     end
   end
-end
+end