plist 3.1.0 → 3.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a76784a6b7e953d1cd9b6deaf390eb7556fd0df83e8970db7ac4640c71493b4
+  data.tar.gz: 8324c2b332839aa772eb77a4a760b24e43e24c363c99d01c2b2b4b11e311938a
+SHA512:
+  metadata.gz: c33686b606d723821333314b4a18fe6ac39d65a3712aa1cd43896dbbd4bfb95130aa0a1f62b4a3b260c2a633d44681eec0766fef5651ae70580340a905e4f6e4
+  data.tar.gz: 5b63b55469235ec79f14af6f25c05cbc8e6088ce9532e9dfc5aa0887e533a7ee67424953d62e0b3dfe046c7745d9a2add1e0b8ddf07c34f46c5a551c92a9a158

data/lib/plist.rb

@@ -1,5 +1,5 @@
-#!/usr/bin/env ruby
-#
+# encoding: utf-8
+
 # = plist
 #
 # This is the main file for plist. Everything interesting happens in
@@ -13,9 +13,6 @@ require 'base64'
 require 'cgi'
 require 'stringio'
 
-require 'plist/generator'
-require 'plist/parser'
-
-module Plist
-  VERSION = '3.1.0'
-end
+require_relative 'plist/generator'
+require_relative 'plist/parser'
+require_relative 'plist/version'

data/lib/plist/generator.rb

@@ -1,222 +1,173 @@
-#!/usr/bin/env ruby
-#
+# encoding: utf-8
+
 # = plist
 #
 # Copyright 2006-2010 Ben Bleything and Patrick May
 # Distributed under the MIT License
 #
 
-module Plist ; end
-
-# === Create a plist
-# You can dump an object to a plist in one of two ways:
-#
-# * <tt>Plist::Emit.dump(obj)</tt>
-# * <tt>obj.to_plist</tt>
-#   * This requires that you mixin the <tt>Plist::Emit</tt> module, which is already done for +Array+ and +Hash+.
-#
-# The following Ruby classes are converted into native plist types:
-#   Array, Bignum, Date, DateTime, Fixnum, Float, Hash, Integer, String, Symbol, Time, true, false
-# * +Array+ and +Hash+ are both recursive; their elements will be converted into plist nodes inside the <array> and <dict> containers (respectively).
-# * +IO+ (and its descendants) and +StringIO+ objects are read from and their contents placed in a <data> element.
-# * User classes may implement +to_plist_node+ to dictate how they should be serialized; otherwise the object will be passed to <tt>Marshal.dump</tt> and the result placed in a <data> element.
-#
-# For detailed usage instructions, refer to USAGE[link:files/docs/USAGE.html] and the methods documented below.
-module Plist::Emit
-  # Helper method for injecting into classes.  Calls <tt>Plist::Emit.dump</tt> with +self+.
-  def to_plist(envelope = true)
-    return Plist::Emit.dump(self, envelope)
-  end
-
-  # Helper method for injecting into classes.  Calls <tt>Plist::Emit.save_plist</tt> with +self+.
-  def save_plist(filename)
-    Plist::Emit.save_plist(self, filename)
-  end
-
-  # The following Ruby classes are converted into native plist types:
-  #   Array, Bignum, Date, DateTime, Fixnum, Float, Hash, Integer, String, Symbol, Time
+module Plist
+  # === Create a plist
+  # You can dump an object to a plist in one of two ways:
   #
-  # Write us (via RubyForge) if you think another class can be coerced safely into one of the expected plist classes.
+  # * <tt>Plist::Emit.dump(obj)</tt>
+  # * <tt>obj.to_plist</tt>
+  #   * This requires that you mixin the <tt>Plist::Emit</tt> module, which is already done for +Array+ and +Hash+.
   #
-  # +IO+ and +StringIO+ objects are encoded and placed in <data> elements; other objects are <tt>Marshal.dump</tt>'ed unless they implement +to_plist_node+.
+  # The following Ruby classes are converted into native plist types:
+  #   Array, Bignum, Date, DateTime, Fixnum, Float, Hash, Integer, String, Symbol, Time, true, false
+  # * +Array+ and +Hash+ are both recursive; their elements will be converted into plist nodes inside the <array> and <dict> containers (respectively).
+  # * +IO+ (and its descendants) and +StringIO+ objects are read from and their contents placed in a <data> element.
+  # * User classes may implement +to_plist_node+ to dictate how they should be serialized; otherwise the object will be passed to <tt>Marshal.dump</tt> and the result placed in a <data> element.
   #
-  # The +envelope+ parameters dictates whether or not the resultant plist fragment is wrapped in the normal XML/plist header and footer.  Set it to false if you only want the fragment.
-  def self.dump(obj, envelope = true)
-    output = plist_node(obj)
+  # For detailed usage instructions, refer to USAGE[link:files/docs/USAGE.html] and the methods documented below.
+  module Emit
+    DEFAULT_INDENT = "\t"
 
-    output = wrap(output) if envelope
+    # Helper method for injecting into classes.  Calls <tt>Plist::Emit.dump</tt> with +self+.
+    def to_plist(envelope = true, options = {})
+      Plist::Emit.dump(self, envelope, options)
+    end
 
-    return output
-  end
+    # Helper method for injecting into classes.  Calls <tt>Plist::Emit.save_plist</tt> with +self+.
+    def save_plist(filename, options = {})
+      Plist::Emit.save_plist(self, filename, options)
+    end
 
-  # Writes the serialized object's plist to the specified filename.
-  def self.save_plist(obj, filename)
-    File.open(filename, 'wb') do |f|
-      f.write(obj.to_plist)
+    # The following Ruby classes are converted into native plist types:
+    #   Array, Bignum, Date, DateTime, Fixnum, Float, Hash, Integer, String, Symbol, Time
+    #
+    # Write us (via RubyForge) if you think another class can be coerced safely into one of the expected plist classes.
+    #
+    # +IO+ and +StringIO+ objects are encoded and placed in <data> elements; other objects are <tt>Marshal.dump</tt>'ed unless they implement +to_plist_node+.
+    #
+    # The +envelope+ parameters dictates whether or not the resultant plist fragment is wrapped in the normal XML/plist header and footer.  Set it to false if you only want the fragment.
+    def self.dump(obj, envelope = true, options = {})
+      options = { :indent => DEFAULT_INDENT }.merge(options)
+
+      output = PlistBuilder.new(options[:indent]).build(obj)
+      output = wrap(output) if envelope
+
+      output
     end
-  end
 
-  private
-  def self.plist_node(element)
-    output = ''
-
-    if element.respond_to? :to_plist_node
-      output << element.to_plist_node
-    else
-      case element
-      when Array
-        if element.empty?
-          output << "<array/>\n"
+    # Writes the serialized object's plist to the specified filename.
+    def self.save_plist(obj, filename, options = {})
+      File.open(filename, 'wb') do |f|
+        f.write(obj.to_plist(true, options))
+      end
+    end
+
+    private
+
+    class PlistBuilder
+      def initialize(indent_str)
+        @indent_str = indent_str.to_s
+      end
+
+      def build(element, level=0)
+        if element.respond_to? :to_plist_node
+          element.to_plist_node
         else
-          output << tag('array') {
-            element.collect {|e| plist_node(e)}
-          }
+          case element
+          when Array
+            if element.empty?
+              tag('array', nil, level)
+            else
+              tag('array', nil, level) {
+                element.collect {|e| build(e, level + 1) }.join
+              }
+            end
+          when Hash
+            if element.empty?
+              tag('dict', nil, level)
+            else
+              tag('dict', '', level) do
+                element.sort_by{|k,v| k.to_s }.collect do |k,v| 
+                  tag('key', CGI.escapeHTML(k.to_s), level + 1) +
+                  build(v, level + 1)
+                end.join
+              end
+            end
+          when true, false
+            tag(element, nil, level)
+          when Time
+            tag('date', element.utc.strftime('%Y-%m-%dT%H:%M:%SZ'), level)
+          when Date # also catches DateTime
+            tag('date', element.strftime('%Y-%m-%dT%H:%M:%SZ'), level)
+          when String, Symbol, Integer, Float
+            tag(element_type(element), CGI.escapeHTML(element.to_s), level)
+          when IO, StringIO
+            data = element.tap(&:rewind).read 
+            data_tag(data, level)
+          else
+            data = Marshal.dump(element)
+            comment_tag('The <data> element below contains a Ruby object which has been serialized with Marshal.dump.') +
+            data_tag(data, level)
+          end
         end
-      when Hash
-        if element.empty?
-          output << "<dict/>\n"
-        else
-          inner_tags = []
+      end
 
-          element.keys.sort.each do |k|
-            v = element[k]
-            inner_tags << tag('key', CGI::escapeHTML(k.to_s))
-            inner_tags << plist_node(v)
-          end
+      private
 
-          output << tag('dict') {
-            inner_tags
-          }
+      def tag(type, contents, level, &block)
+        if block_given?
+          indent("<#{type}>\n", level) +
+          block.call +
+          indent("</#{type}>\n", level)
+        elsif contents.to_s.empty?
+          indent("<#{type}/>\n", level)
+        else
+          indent("<#{type}>#{contents.to_s}</#{type}>\n", level)
         end
-      when true, false
-        output << "<#{element}/>\n"
-      when Time
-        output << tag('date', element.utc.strftime('%Y-%m-%dT%H:%M:%SZ'))
-      when Date # also catches DateTime
-        output << tag('date', element.strftime('%Y-%m-%dT%H:%M:%SZ'))
-      when String, Symbol, Fixnum, Bignum, Integer, Float
-        output << tag(element_type(element), CGI::escapeHTML(element.to_s))
-      when IO, StringIO
-        element.rewind
-        contents = element.read
+      end
+
+      def data_tag(data, level)
         # note that apple plists are wrapped at a different length then
         # what ruby's base64 wraps by default.
         # I used #encode64 instead of #b64encode (which allows a length arg)
         # because b64encode is b0rked and ignores the length arg.
-        data = "\n"
-        Base64::encode64(contents).gsub(/\s+/, '').scan(/.{1,68}/o) { data << $& << "\n" }
-        output << tag('data', data)
-      else
-        output << comment( 'The <data> element below contains a Ruby object which has been serialized with Marshal.dump.' )
-        data = "\n"
-        Base64::encode64(Marshal.dump(element)).gsub(/\s+/, '').scan(/.{1,68}/o) { data << $& << "\n" }
-        output << tag('data', data )
+        tag('data', nil, level) do
+          Base64.encode64(data)
+                .gsub(/\s+/, '')
+                .scan(/.{1,68}/o)
+                .collect { |line| indent(line, level) }
+                .join("\n")
+                .concat("\n")
+        end
       end
-    end
-
-    return output
-  end
-
-  def self.comment(content)
-    return "<!-- #{content} -->\n"
-  end
-
-  def self.tag(type, contents = '', &block)
-    out = nil
-
-    if block_given?
-      out = IndentedString.new
-      out << "<#{type}>"
-      out.raise_indent
-
-      out << block.call
-
-      out.lower_indent
-      out << "</#{type}>"
-    else
-      out = "<#{type}>#{contents.to_s}</#{type}>\n"
-    end
-
-    return out.to_s
-  end
-
-  def self.wrap(contents)
-    output = ''
-
-    output << '<?xml version="1.0" encoding="UTF-8"?>' + "\n"
-    output << '<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">' + "\n"
-    output << '<plist version="1.0">' + "\n"
-
-    output << contents
-
-    output << '</plist>' + "\n"
-
-    return output
-  end
-
-  def self.element_type(item)
-    case item
-    when String, Symbol
-      'string'
-
-    when Fixnum, Bignum, Integer
-      'integer'
-
-    when Float
-      'real'
 
-    else
-      raise "Don't know about this data type... something must be wrong!"
-    end
-  end
-  private
-  class IndentedString #:nodoc:
-    attr_accessor :indent_string
-
-    def initialize(str = "\t")
-      @indent_string = str
-      @contents = ''
-      @indent_level = 0
-    end
-
-    def to_s
-      return @contents
-    end
-
-    def raise_indent
-      @indent_level += 1
-    end
-
-    def lower_indent
-      @indent_level -= 1 if @indent_level > 0
-    end
-
-    def <<(val)
-      if val.is_a? Array
-        val.each do |f|
-          self << f
-        end
-      else
-        # if it's already indented, don't bother indenting further
-        unless val =~ /\A#{@indent_string}/
-          indent = @indent_string * @indent_level
+      def indent(str, level)
+        @indent_str.to_s * level + str
+      end
 
-          @contents << val.gsub(/^/, indent)
+      def element_type(item)
+        case item
+        when String, Symbol
+          'string'
+        when Integer
+          'integer'
+        when Float
+          'real'
         else
-          @contents << val
+          raise "Don't know about this data type... something must be wrong!"
         end
+      end
 
-        # it already has a newline, don't add another
-        @contents << "\n" unless val =~ /\n$/
+      def comment_tag(content)
+        return "<!-- #{content} -->\n"
       end
     end
-  end
-end
 
-# we need to add this so sorting hash keys works properly
-class Symbol #:nodoc:
-  def <=> (other)
-    self.to_s <=> other.to_s
+    def self.wrap(contents)
+      output =  '<?xml version="1.0" encoding="UTF-8"?>' + "\n"
+      output << '<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">' + "\n"
+      output << '<plist version="1.0">' + "\n"
+      output << contents
+      output << '</plist>' + "\n"
+
+      output
+    end
   end
 end
 

data/lib/plist/parser.rb

@@ -1,5 +1,5 @@
-#!/usr/bin/env ruby
-#
+# encoding: utf-8
+
 # = plist
 #
 # Copyright 2006-2010 Ben Bleything and Patrick May
@@ -11,42 +11,48 @@
 # === Load a plist file
 # This is the main point of the library:
 #
-#   r = Plist::parse_xml( filename_or_xml )
+#   r = Plist.parse_xml(filename_or_xml)
 module Plist
-# Note that I don't use these two elements much:
-#
-#  + Date elements are returned as DateTime objects.
-#  + Data elements are implemented as Tempfiles
-#
-# Plist::parse_xml will blow up if it encounters a data element.
-# If you encounter such an error, or if you have a Date element which
-# can't be parsed into a Time object, please send your plist file to
-# plist@hexane.org so that I can implement the proper support.
-  def Plist::parse_xml( filename_or_xml )
+  # Raised when an element is not implemented
+  class UnimplementedElementError < RuntimeError; end
+
+  # Note that I don't use these two elements much:
+  #
+  #  + Date elements are returned as DateTime objects.
+  #  + Data elements are implemented as Tempfiles
+  #
+  # Plist.parse_xml will blow up if it encounters a Date element.
+  # If you encounter such an error, or if you have a Date element which
+  # can't be parsed into a Time object, please create an issue
+  # attaching your plist file at https://github.com/patsplat/plist/issues
+  # so folks can implement the proper support.
+  def self.parse_xml(filename_or_xml)
     listener = Listener.new
-    #parser = REXML::Parsers::StreamParser.new(File.new(filename), listener)
+    # parser = REXML::Parsers::StreamParser.new(File.new(filename), listener)
     parser = StreamParser.new(filename_or_xml, listener)
     parser.parse
     listener.result
   end
 
   class Listener
-    #include REXML::StreamListener
+    # include REXML::StreamListener
 
     attr_accessor :result, :open
 
     def initialize
       @result = nil
-      @open   = Array.new
+      @open   = []
     end
 
-
     def tag_start(name, attributes)
-      @open.push PTag::mappings[name].new
+      @open.push PTag.mappings[name].new
     end
 
-    def text( contents )
-      @open.last.text = contents if @open.last
+    def text(contents)
+      if @open.last
+        @open.last.text ||= ''
+        @open.last.text.concat(contents)
+      end
     end
 
     def tag_end(name)
@@ -60,11 +66,11 @@ module Plist
   end
 
   class StreamParser
-    def initialize( plist_data_or_file, listener )
+    def initialize(plist_data_or_file, listener)
       if plist_data_or_file.respond_to? :read
         @xml = plist_data_or_file.read
-      elsif File.exists? plist_data_or_file
-        @xml = File.read( plist_data_or_file )
+      elsif File.exist? plist_data_or_file
+        @xml = File.read(plist_data_or_file)
       else
         @xml = plist_data_or_file
       end
@@ -72,26 +78,35 @@ module Plist
       @listener = listener
     end
 
-    TEXT       = /([^<]+)/
-    XMLDECL_PATTERN = /<\?xml\s+(.*?)\?>*/um
-    DOCTYPE_PATTERN = /\s*<!DOCTYPE\s+(.*?)(\[|>)/um
-    COMMENT_START = /\A<!--/u
-    COMMENT_END = /.*?-->/um
-
+    TEXT = /([^<]+)/
+    CDATA = /<!\[CDATA\[(.*?)\]\]>/
+    XMLDECL_PATTERN = /<\?xml\s+(.*?)\?>*/m
+    DOCTYPE_PATTERN = /\s*<!DOCTYPE\s+(.*?)(\[|>)/m
+    COMMENT_START = /\A<!--/
+    COMMENT_END = /.*?-->/m
+    UNIMPLEMENTED_ERROR = 'Unimplemented element. ' \
+      'Consider reporting via https://github.com/patsplat/plist/issues'
 
     def parse
-      plist_tags = PTag::mappings.keys.join('|')
+      plist_tags = PTag.mappings.keys.join('|')
       start_tag  = /<(#{plist_tags})([^>]*)>/i
       end_tag    = /<\/(#{plist_tags})[^>]*>/i
 
       require 'strscan'
 
-      @scanner = StringScanner.new( @xml )
+      @scanner = StringScanner.new(@xml)
       until @scanner.eos?
         if @scanner.scan(COMMENT_START)
           @scanner.scan(COMMENT_END)
         elsif @scanner.scan(XMLDECL_PATTERN)
+          encoding = parse_encoding_from_xml_declaration(@scanner[1])
+          next if encoding.nil?
+
+          # use the specified encoding for the rest of the file
+          next unless String.method_defined?(:force_encoding)
+          @scanner.string = @scanner.rest.force_encoding(encoding)
         elsif @scanner.scan(DOCTYPE_PATTERN)
+          next
         elsif @scanner.scan(start_tag)
           @listener.tag_start(@scanner[1], nil)
           if (@scanner[2] =~ /\/$/)
@@ -99,32 +114,49 @@ module Plist
           end
         elsif @scanner.scan(TEXT)
           @listener.text(@scanner[1])
+        elsif @scanner.scan(CDATA)
+          @listener.text(@scanner[1])
         elsif @scanner.scan(end_tag)
           @listener.tag_end(@scanner[1])
         else
-          raise "Unimplemented element"
+          raise UnimplementedElementError.new(UNIMPLEMENTED_ERROR)
         end
       end
     end
+
+    private
+
+    def parse_encoding_from_xml_declaration(xml_declaration)
+      return unless defined?(Encoding)
+
+      xml_encoding = xml_declaration.match(/(?:\A|\s)encoding=(?:"(.*?)"|'(.*?)')(?:\s|\Z)/)
+
+      return if xml_encoding.nil?
+
+      begin
+        Encoding.find(xml_encoding[1])
+      rescue ArgumentError
+        nil
+      end
+    end
   end
 
   class PTag
-    @@mappings = { }
-    def PTag::mappings
-      @@mappings
+    def self.mappings
+      @mappings ||= {}
     end
 
-    def PTag::inherited( sub_class )
+    def self.inherited(sub_class)
       key = sub_class.to_s.downcase
-      key.gsub!(/^plist::/, '' )
+      key.gsub!(/^plist::/, '')
       key.gsub!(/^p/, '')  unless key == "plist"
 
-      @@mappings[key] = sub_class
+      mappings[key] = sub_class
     end
 
     attr_accessor :text, :children
     def initialize
-      @children = Array.new
+      @children = []
     end
 
     def to_ruby
@@ -140,7 +172,7 @@ module Plist
 
   class PDict < PTag
     def to_ruby
-      dict = Hash.new
+      dict = {}
       key = nil
 
       children.each do |c|
@@ -158,13 +190,13 @@ module Plist
 
   class PKey < PTag
     def to_ruby
-      CGI::unescapeHTML(text || '')
+      CGI.unescapeHTML(text || '')
     end
   end
 
   class PString < PTag
     def to_ruby
-      CGI::unescapeHTML(text || '')
+      CGI.unescapeHTML(text || '')
     end
   end
 
@@ -210,11 +242,10 @@ module Plist
   require 'base64'
   class PData < PTag
     def to_ruby
-      data = Base64.decode64(text.gsub(/\s+/, ''))
-
+      data = Base64.decode64(text.gsub(/\s+/, '')) unless text.nil?
       begin
         return Marshal.load(data)
-      rescue Exception => e
+      rescue Exception
         io = StringIO.new
         io.write data
         io.rewind