CFPropertyList 2.2.8 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2c18e8671e6aa61b76ef1b99fff2850b2746c4d
-  data.tar.gz: 153b07e4656885b5cd155af83555dad763a17e1a
+  metadata.gz: bc33e5b367dbce4a691398d57944021021aef03f
+  data.tar.gz: 67607311e62f42c8c7db8e41e318342fbb1188a0
 SHA512:
-  metadata.gz: 75f4be2ff85f13c0309b7c7fe390b721a5ee98d454aa45a010ba03288381a0f9c6e90539f7c34921685c5ef92e8803ab7469ce826059bfa777a98d001974d3fe
-  data.tar.gz: b7842bee8b9cb899b432880b16e675c78e4cb87ed64c473efb988c2dd4313266844b1f341f8b659e0baeaca9ad0bf7fa81fbc74f763ea53c8ecedafd149d59a3
+  metadata.gz: 22cfa79f7cde0aeaa04896c06dbbe866a9945853903abe3049fc462a60fa7fd031b384d8a1059338d5655a260091fced46909027321b02b0f012d773715b817b
+  data.tar.gz: 3951e013406ade3ef418b75f188e9c48a0ec49f1dda6eec74fa3f2b3aa722e4f9383ad0b98a4707c3a8f53b587d837a893288c4c74b8a81de563adaf907d3bb7

data/lib/cfpropertylist/rbCFPropertyList.rb

@@ -84,6 +84,7 @@ dirname = File.dirname(__FILE__)
 require dirname + '/rbCFPlistError.rb'
 require dirname + '/rbCFTypes.rb'
 require dirname + '/rbBinaryCFPropertyList.rb'
+require dirname + '/rbPlainCFPropertyList.rb'
 
 require 'iconv' unless "".respond_to?("encode")
 
@@ -218,10 +219,13 @@ module CFPropertyList
     # Format constant for XML format
     FORMAT_XML = 2
 
+    # Format constant for the old plain format
+    FORMAT_PLAIN = 3
+
     # Format constant for automatic format recognizing
     FORMAT_AUTO = 0
 
-    @@parsers = [Binary, CFPropertyList.xml_parser_interface]
+    @@parsers = [Binary, CFPropertyList.xml_parser_interface, PlainParser]
 
     # Path of PropertyList
     attr_accessor :filename
@@ -271,6 +275,12 @@ module CFPropertyList
       load(filename,List::FORMAT_BINARY)
     end
 
+    # read a plain plist file
+    # filename = nil:: The filename to read from; if nil, read from the file defined by instance variable +filename+
+    def load_plain(filename=nil)
+      load(filename,List::FORMAT_PLAIN)
+    end
+
     # load a plist from a XML string
     # str:: The string containing the plist
     def load_xml_str(str=nil)
@@ -283,6 +293,12 @@ module CFPropertyList
       load_str(str,List::FORMAT_BINARY)
     end
 
+    # load a plist from a plain string
+    # str:: The string containing the plist
+    def load_binary_str(str=nil)
+      load_str(str,List::FORMAT_PLAIN)
+    end
+
     # load a plist from a string
     # str = nil:: The string containing the plist
     # format = nil:: The format of the plist
@@ -292,7 +308,7 @@ module CFPropertyList
 
       @value = {}
       case format
-      when List::FORMAT_BINARY, List::FORMAT_XML then
+      when List::FORMAT_BINARY, List::FORMAT_XML, List::FORMAT_PLAIN then
         prsr = @@parsers[format-1].new
         @value = prsr.load({:data => str})
 
@@ -301,13 +317,19 @@ module CFPropertyList
         version = str[6..7]
 
         prsr = nil
+
         if filetype == "bplist" then
           raise CFFormatError.new("Wrong file version #{version}") unless version == "00"
           prsr = Binary.new
           @format = List::FORMAT_BINARY
         else
-          prsr = CFPropertyList.xml_parser_interface.new
-          @format = List::FORMAT_XML
+          if str =~ /^<(\?xml|!DOCTYPE|plist)/
+            prsr = CFPropertyList.xml_parser_interface.new
+            @format = List::FORMAT_XML
+          else
+            prsr = PlainParser.new
+            @format = List::FORMAT_PLAIN
+          end
         end
 
         @value = prsr.load({:data => str})
@@ -325,12 +347,12 @@ module CFPropertyList
       raise IOError.new("File #{file} not readable!") unless File.readable? file
 
       case format
-      when List::FORMAT_BINARY, List::FORMAT_XML then
+      when List::FORMAT_BINARY, List::FORMAT_XML, List::FORMAT_PLAIN then
         prsr = @@parsers[format-1].new
         @value = prsr.load({:file => file})
 
       when List::FORMAT_AUTO then # what we now do is ugly, but neccessary to recognize the file format
-        magic_number = IO.read(file,8)
+        magic_number = IO.read(file,12)
         raise IOError.new("File #{file} is empty.") unless magic_number
         filetype = magic_number[0..5]
         version = magic_number[6..7]
@@ -341,8 +363,13 @@ module CFPropertyList
           prsr = Binary.new
           @format = List::FORMAT_BINARY
         else
-          prsr = CFPropertyList.xml_parser_interface.new
-          @format = List::FORMAT_XML
+          if magic_number =~ /^<(\?xml|!DOCTYPE|plist)/
+            prsr = CFPropertyList.xml_parser_interface.new
+            @format = List::FORMAT_XML
+          else
+            prsr = PlainParser.new
+            @format = List::FORMAT_PLAIN
+          end
         end
 
         @value = prsr.load({:file => file})
@@ -358,7 +385,9 @@ module CFPropertyList
       format = @format if format.nil?
       file = @filename if file.nil?
 
-      raise CFFormatError.new("Format #{format} not supported, use List::FORMAT_BINARY or List::FORMAT_XML") if format != FORMAT_BINARY && format != FORMAT_XML
+      if format != FORMAT_BINARY && format != FORMAT_XML && format != FORMAT_PLAIN
+        raise CFFormatError.new("Format #{format} not supported, use List::FORMAT_BINARY or List::FORMAT_XML")
+      end
 
       if(!File.exists?(file)) then
         raise IOError.new("File #{file} not writable!") unless File.writable?(File.dirname(file))
@@ -383,7 +412,9 @@ module CFPropertyList
     # format = List::FORMAT_BINARY:: The format to save the plist
     # opts={}:: Pass parser options
     def to_str(format=List::FORMAT_BINARY,opts={})
-      raise CFFormatError.new("Format #{format} not supported, use List::FORMAT_BINARY or List::FORMAT_XML") if format != FORMAT_BINARY && format != FORMAT_XML
+      if format != FORMAT_BINARY && format != FORMAT_XML && format != FORMAT_PLAIN
+        raise CFFormatError.new("Format #{format} not supported, use List::FORMAT_BINARY or List::FORMAT_XML")
+      end
 
       prsr = @@parsers[format-1].new
 

data/lib/cfpropertylist/rbCFTypes.rb

@@ -37,7 +37,11 @@ module CFPropertyList
     def to_xml(parser)
     end
 
-    def to_binary(bplist) end
+    def to_binary(bplist)
+    end
+
+    def to_plain(plist)
+    end
   end
 
   # This class holds string values, both, UTF-8 and UTF-16BE
@@ -54,6 +58,44 @@ module CFPropertyList
     def to_binary(bplist)
       bplist.string_to_binary(@value);
     end
+
+    def to_plain(plist)
+      if @value =~ /^\w+$/
+        @value
+      else
+        quoted
+      end
+    end
+
+    def quoted
+      str = '"'
+      @value.each_char do |c|
+        str << case c
+        when '"'
+          '\\"'
+        when '\\'
+          '\\'
+        when "\a"
+          "\\a"
+        when "\b"
+          "\\b"
+        when "\f"
+          "\\f"
+        when "\n"
+          "\n"
+        when "\v"
+          "\\v"
+        when "\r"
+          "\\r"
+        when "\t"
+          "\\t"
+        else
+          c
+        end
+      end
+
+      str << '"'
+    end
   end
 
   # This class holds integer/fixnum values
@@ -69,6 +111,10 @@ module CFPropertyList
     def to_binary(bplist)
       bplist.num_to_binary(self)
     end
+
+    def to_plain(plist)
+      @value.to_s
+    end
   end
 
   # This class holds float values
@@ -84,6 +130,10 @@ module CFPropertyList
     def to_binary(bplist)
       bplist.num_to_binary(self)
     end
+
+    def to_plain(plist)
+      @value.to_s
+    end
   end
 
   # This class holds Time values. While Apple uses seconds since 2001,
@@ -92,7 +142,7 @@ module CFPropertyList
   # geht the timestamp or the Apple timestamp
   class CFDate < CFType
     TIMESTAMP_APPLE = 0
-    TIMESTAMP_UNIX  = 1;
+    TIMESTAMP_UNIX  = 1
     DATE_DIFF_APPLE_UNIX = 978307200
 
     # create a XML date strimg from a time object
@@ -151,6 +201,10 @@ module CFPropertyList
     def to_binary(bplist)
       bplist.date_to_binary(@value)
     end
+
+    def to_plain(plist)
+      @value.strftime("%Y-%m-%d %H:%M:%S %z")
+    end
   end
 
   # This class contains a boolean value
@@ -164,6 +218,10 @@ module CFPropertyList
     def to_binary(bplist)
       bplist.bool_to_binary(@value);
     end
+
+    def to_plain(plist)
+      @value ? "true" : "false"
+    end
   end
 
   # This class contains binary data values
@@ -203,6 +261,10 @@ module CFPropertyList
     def to_binary(bplist)
       bplist.data_to_binary(decoded_value())
     end
+
+    def to_plain(plist)
+      "<" + decoded_value.unpack("H*").join("") + ">"
+    end
   end
 
   # This class contains an array of values
@@ -225,6 +287,11 @@ module CFPropertyList
     def to_binary(bplist)
       bplist.array_to_binary(self)
     end
+
+    def to_plain(plist)
+      ary = @value.map { |v| v.to_plain(plist) }
+      "( " + ary.join(", ") + " )"
+    end
   end
 
   # this class contains a hash of values
@@ -249,6 +316,18 @@ module CFPropertyList
     def to_binary(bplist)
       bplist.dict_to_binary(self)
     end
+
+    def to_plain(plist)
+      str = "{ "
+      cfstr = CFString.new()
+
+      @value.each do |k,v|
+        cfstr.value = k
+        str << cfstr.to_plain(plist) + " = " + v.to_plain(plist) + "; "
+      end
+
+      str << "}"
+    end
   end
 
   class CFUid < CFType
@@ -260,6 +339,10 @@ module CFPropertyList
     def to_binary(bplist)
       bplist.uid_to_binary(@value)
     end
+
+    def to_plain(plist)
+      CFDictionary.new({'CF$UID' => CFInteger.new(@value)}).to_plain(plist)
+    end
   end
 end
 

data/lib/cfpropertylist/rbPlainCFPropertyList.rb

@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+
+require 'strscan'
+
+module CFPropertyList
+  # XML parser
+  class PlainParser < XMLParserInterface
+    # read a XML file
+    # opts::
+    # * :file - The filename of the file to load
+    # * :data - The data to parse
+    def load(opts)
+      @doc = nil
+
+      if(opts.has_key?(:file)) then
+        File.open(opts[:file], :external_encoding => "ASCII") do |fd|
+          @doc = StringScanner.new(fd.read)
+        end
+      else
+        @doc = StringScanner.new(opts[:data])
+      end
+
+      if @doc
+        root = import_plain
+        raise CFFormatError.new('content after root object') unless @doc.eos?
+
+        return root
+      end
+
+      raise CFFormatError.new('invalid plist string or file not found')
+    end
+
+    SPACES_AND_COMMENTS =  %r{((?:/\*.*?\*/)|(?://.*?$\n?)|(?:\s*))+}x
+
+    # serialize CFPropertyList object to XML
+    # opts = {}:: Specify options: :formatted - Use indention and line breaks
+    def to_str(opts={})
+      opts[:root].to_plain(self)
+    end
+
+    protected
+    def skip_whitespaces
+      @doc.skip SPACES_AND_COMMENTS
+    end
+
+    def read_dict
+      skip_whitespaces
+      hsh = {}
+
+      while not @doc.scan(/\}/)
+        key = import_plain
+        raise CFFormatError.new("invalid dictionary format") if !key
+
+        if key.is_a?(CFString)
+          key = key.value
+        elsif key.is_a?(CFInteger) or key.is_a?(CFReal)
+          key = key.value.to_s
+        else
+          raise CFFormatError.new("invalid key format")
+        end
+
+        skip_whitespaces
+
+        raise CFFormatError.new("invalid dictionary format") unless @doc.scan(/=/)
+
+        skip_whitespaces
+        val = import_plain
+
+        skip_whitespaces
+        raise CFFormatError.new("invalid dictionary format") unless @doc.scan(/;/)
+        skip_whitespaces
+
+        hsh[key] = val
+        raise CFFormatError.new("invalid dictionary format") if @doc.eos?
+      end
+
+      CFDictionary.new(hsh)
+    end
+
+    def read_array
+      skip_whitespaces
+      ary = []
+
+      while not @doc.scan(/\)/)
+        val = import_plain
+
+        return nil if not val or not val.value
+        skip_whitespaces
+
+        if not @doc.skip(/,\s*/)
+          if @doc.scan(/\)/)
+            ary << val
+            return CFArray.new(ary)
+          end
+
+          raise CFFormatError.new("invalid array format")
+        end
+
+        ary << val
+        raise CFFormatError.new("invalid array format") if @doc.eos?
+      end
+
+      CFArray.new(ary)
+    end
+
+    def escape_char
+      case @doc.matched
+      when '"'
+        '"'
+      when '\\'
+        '\\'
+      when 'a'
+        "\a"
+      when 'b'
+        "\b"
+      when 'f'
+        "\f"
+      when 'n'
+        "\n"
+      when 'v'
+        "\v"
+      when 'r'
+        "\r"
+      when 't'
+        "\t"
+      end
+    end
+
+    def read_quoted
+      str = ''
+
+      while not @doc.scan(/"/)
+        if @doc.scan(/\\/)
+          @doc.scan(/./)
+          str << escape_char
+
+        elsif @doc.eos?
+          raise CFFormatError.new("unterminated string")
+
+        else @doc.scan(/./)
+          str << @doc.matched
+        end
+      end
+
+      CFString.new(str)
+    end
+
+    def read_unquoted
+      raise CFFormatError.new("unexpected end of file") if @doc.eos?
+
+      if @doc.scan(/(\d\d\d\d)-(\d\d)-(\d\d)\s+(\d\d):(\d\d):(\d\d)(?:\s+(\+|-)(\d\d)(\d\d))?/)
+        year,month,day,hour,min,sec,pl_min,tz_hour, tz_min = @doc[1], @doc[2], @doc[3], @doc[4], @doc[5], @doc[6], @doc[7], @doc[8], @doc[9]
+        CFDate.new(Time.new(year, month, day, hour, min, sec, pl_min ? sprintf("%s%s:%s", pl_min, tz_hour, tz_min) : nil))
+
+      elsif @doc.scan(/-?\d+?\.\d+\b/)
+        CFReal.new(@doc.matched.to_f)
+
+      elsif @doc.scan(/-?\d+\b/)
+        CFInteger.new(@doc.matched.to_i)
+
+      elsif @doc.scan(/\b(true|false)\b/)
+        CFBoolean.new(@doc.matched == 'true')
+      else
+        CFString.new(@doc.scan(/\w+/))
+      end
+    end
+
+    def read_binary
+      @doc.scan(/(.*?)>/)
+
+      hex_str = @doc[1].gsub(/ /, '')
+      CFData.new([hex_str].pack("H*"), CFData::DATA_RAW)
+    end
+
+    # import the XML values
+    def import_plain
+      skip_whitespaces
+      ret = nil
+
+      if @doc.scan(/\{/) # dict
+        ret = read_dict
+      elsif @doc.scan(/\(/) # array
+        ret = read_array
+      elsif @doc.scan(/"/) # string
+        ret = read_quoted
+      elsif @doc.scan(/</) # binary
+        ret = read_binary
+      else # string w/o quotes
+        ret = read_unquoted
+      end
+
+      return ret
+    end
+  end
+end
+
+# eof

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: CFPropertyList
 version: !ruby/object:Gem::Version
-  version: 2.2.8
+  version: 2.3.0
 platform: ruby
 authors:
 - Christian Kruse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-10 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -40,6 +40,7 @@ files:
 - lib/cfpropertylist/rbCFTypes.rb
 - lib/cfpropertylist/rbLibXMLParser.rb
 - lib/cfpropertylist/rbNokogiriParser.rb
+- lib/cfpropertylist/rbPlainCFPropertyList.rb
 - lib/cfpropertylist/rbREXMLParser.rb
 homepage: http://github.com/ckruse/CFPropertyList
 licenses:
@@ -61,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Read, write and manipulate both binary and XML property lists as defined