plist 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6419e8cb1fbfdc4d07ec54cf7ca8e2baf6ed33af
-  data.tar.gz: a4c8aa0a95cc0ad9bf25b724963ca8493543a015
+SHA256:
+  metadata.gz: d5fa8e33a6700467ad3d91f7513275c19e020433e4e66b9df83020e38d04c24b
+  data.tar.gz: 2c588eb552e98c74d99b47138434e09a4dc3965857f2a9eb6af84fa14926b2ff
 SHA512:
-  metadata.gz: 973b6bed1abafcffd88e4e51bfa8c304ce38b37a60f9d1424e68360ccdb7b749368f13c645fe5827ca63c11396aa45b6f980b8ff2dac56123a86202ad50c00bf
-  data.tar.gz: 623bd3fca1591131ca3cd8d0dc6a683b444f63ed9aec50a3dc257408de93c3686b45ef4484b34fa43d04d9ca118799b0d7af84734e4cc8fa751abd1ca8de24bb
+  metadata.gz: 4600738237509772e5a8a9299b370e8a3c611e5b5540a40889c4623a5e88c080515f177c2e74e49cf93a29df36afd9097da9787aa82d40af14f75fd076e5c68b
+  data.tar.gz: bf5f666db425a2b664fdbba0b81ae14d38a4d88035ca7a29b66c35bfb9b87defe3216b0bc1cc67e5c960f174ad97b2e47b290cc86aaca56cffc4e325265d43e2

data/CHANGELOG.rdoc

@@ -2,10 +2,16 @@
 
 === Unreleased
 
-https://github.com/patsplat/plist/compare/v3.3.0...HEAD
+https://github.com/patsplat/plist/compare/v3.4.0...HEAD
 
 * Your contribution here!
 
+=== 3.4.0 (2017-12-08)
+
+https://github.com/patsplat/plist/compare/v3.3.0...v3.4.0
+
+* Support custom indent string (https://github.com/patsplat/plist/pull/44)
+
 === 3.3.0 (2017-04-28)
 
 https://github.com/patsplat/plist/compare/dece870...v3.3.0

data/README.rdoc

@@ -7,9 +7,14 @@ Plist is a library to manipulate Property List files, also known as plists.  It
 
 == Usage
 
+=== Security considerations
+
+Plist.parse_xml uses Marshal.load for <data/> attributes. If the <data/> attribute contains malicious data, an attacker can gain code execution.
+You should never use Plist.parse_xml with untrusted plists!
+
 === Parsing
 
-  result = Plist::parse_xml('path/to/example.plist')
+  result = Plist.parse_xml('path/to/example.plist')
 
   result.class
   => Hash
@@ -112,15 +117,32 @@ When you attempt to serialize a +MyFancyString+ object, the +to_plist_node+ meth
 
 If for whatever reason you can't add this method, your object will be serialized with <tt>Marshal.dump</tt> instead.
 
+==== Custom indent
+
+You can customize the default indent foramt (default format is tab) or specify the indent format on each serialization. For example, if you want to reduce size of plist output, you can set the indent to <tt>nil</tt>.
+
+An example to change default indent format:
+
+  Plist::Emit::DEFAULT_INDENT = nil
+
+An example to specify indent format on dump:
+
+  Plist::Emit.dump({:foo => :bar}, false)
+  => "<dict>\n\t<key>foo</key>\n\t<string>bar</string>\n</dict>\n"
+
+  Plist::Emit.dump({:foo => :bar}, false, :indent => nil)
+  => "<dict>\n<key>foo</key>\n<string>bar</string>\n</dict>\n"
+
+
 == Links
 
-[Project Page]  http://plist.rubyforge.org
-[GitHub]        http://github.com/bleything/plist
-[RDoc]          http://plist.rubyforge.org
+[Rubygems]      https://rubygems.org/gems/plist
+[GitHub]        https://github.com/bleything/plist
+[RDoc]          http://www.rubydoc.info/gems/plist
 
 == Credits
 
-plist is maintained by Ben Bleything <mailto:ben@bleything.net> and Patrick May <mailto:patrick@hexane.org>.  Patrick wrote most of the code; Ben is a recent addition to the project, having merged in his plist generation library.
+plist was authored by Ben Bleything <mailto:ben@bleything.net> and Patrick May <mailto:patrick@hexane.org>. Patrick wrote most of the code; Ben contributed his plist generation library. The project is currently maintained by @mattbrictson[https://github.com/mattbrictson].
 
 Other folks who have helped along the way:
 
@@ -129,6 +151,7 @@ Other folks who have helped along the way:
 [<b>Mat Schaffer</b>] who supplied code and test cases for <tt><data></tt> elements
 [<b>Michael Granger</b>] for encouragement and help
 [<b>Carsten Bormann, Chris Hoffman, Dana Contreras, Hongli Lai, Johan Sørensen</b>] for contributing Ruby 1.9.x compatibility fixes
+And thank you to all of the other GitHub contributors[https://github.com/patsplat/plist/graphs/contributors] not mentioned here!
 
 == License and Copyright
 

data/lib/plist.rb

@@ -16,6 +16,3 @@ require 'stringio'
 require 'plist/generator'
 require 'plist/parser'
 require 'plist/version'
-
-module Plist
-end

data/lib/plist/generator.rb

@@ -6,208 +6,216 @@
 # 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"
+
+    # Helper method for injecting into classes.  Calls <tt>Plist::Emit.dump</tt> with +self+.
+    def to_plist(envelope = true, options = {})
+      options = { :indent => DEFAULT_INDENT }.merge(options)
+      return Plist::Emit.dump(self, envelope, options)
+    end
 
-    output = wrap(output) if envelope
+    # Helper method for injecting into classes.  Calls <tt>Plist::Emit.save_plist</tt> with +self+.
+    def save_plist(filename, options = {})
+      options = { :indent => DEFAULT_INDENT }.merge(options)
+      Plist::Emit.save_plist(self, filename, options)
+    end
 
-    return output
-  end
+    # 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 = plist_node(obj, options)
+
+      output = wrap(output) if envelope
+
+      return output
+    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)
+    # Writes the serialized object's plist to the specified filename.
+    def self.save_plist(obj, filename, options = {})
+      options = { :indent => DEFAULT_INDENT }.merge(options)
+      File.open(filename, 'wb') do |f|
+        f.write(obj.to_plist(true, options))
+      end
     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"
-        else
-          output << tag('array') {
-            element.collect {|e| plist_node(e)}
-          }
-        end
-      when Hash
-        if element.empty?
-          output << "<dict/>\n"
-        else
-          inner_tags = []
+    private
+    def self.plist_node(element, options = {})
+      options = { :indent => DEFAULT_INDENT }.merge(options)
+      output = ''
 
-          element.keys.sort_by{|k| k.to_s }.each do |k|
-            v = element[k]
-            inner_tags << tag('key', CGI::escapeHTML(k.to_s))
-            inner_tags << plist_node(v)
+      if element.respond_to? :to_plist_node
+        output << element.to_plist_node
+      else
+        case element
+        when Array
+          if element.empty?
+            output << "<array/>\n"
+          else
+            output << tag('array', '', options) {
+              element.collect {|e| plist_node(e, options)}
+            }
           end
-
-          output << tag('dict') {
-            inner_tags
-          }
+        when Hash
+          if element.empty?
+            output << "<dict/>\n"
+          else
+            inner_tags = []
+
+            element.keys.sort_by{|k| k.to_s }.each do |k|
+              v = element[k]
+              inner_tags << tag('key', CGI.escapeHTML(k.to_s), options)
+              inner_tags << plist_node(v, options)
+            end
+
+            output << tag('dict', '', options) {
+              inner_tags
+            }
+          end
+        when true, false
+          output << "<#{element}/>\n"
+        when Time
+          output << tag('date', element.utc.strftime('%Y-%m-%dT%H:%M:%SZ'), options)
+        when Date # also catches DateTime
+          output << tag('date', element.strftime('%Y-%m-%dT%H:%M:%SZ'), options)
+        when String, Symbol, Integer, Float
+          output << tag(element_type(element), CGI.escapeHTML(element.to_s), options)
+        when IO, StringIO
+          element.rewind
+          contents = element.read
+          # 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, options)
+        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, options)
         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, Integer, Float
-        output << tag(element_type(element), CGI::escapeHTML(element.to_s))
-      when IO, StringIO
-        element.rewind
-        contents = element.read
-        # 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 )
       end
+
+      return output
     end
 
-    return output
-  end
+    def self.comment(content)
+      return "<!-- #{content} -->\n"
+    end
 
-  def self.comment(content)
-    return "<!-- #{content} -->\n"
-  end
+    def self.tag(type, contents = '', options = {}, &block)
+      options = { :indent => DEFAULT_INDENT }.merge(options)
+      out = nil
 
-  def self.tag(type, contents = '', &block)
-    out = nil
+      if block_given?
+        out = IndentedString.new(options[:indent])
+        out << "<#{type}>"
+        out.raise_indent
 
-    if block_given?
-      out = IndentedString.new
-      out << "<#{type}>"
-      out.raise_indent
+        out << block.call
 
-      out << block.call
+        out.lower_indent
+        out << "</#{type}>"
+      else
+        out = "<#{type}>#{contents.to_s}</#{type}>\n"
+      end
 
-      out.lower_indent
-      out << "</#{type}>"
-    else
-      out = "<#{type}>#{contents.to_s}</#{type}>\n"
+      return out.to_s
     end
 
-    return out.to_s
-  end
+    def self.wrap(contents)
+      output = ''
 
-  def self.wrap(contents)
-    output = ''
+      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 << '<?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 << contents
-
-    output << '</plist>' + "\n"
-
-    return output
-  end
+      output << '</plist>' + "\n"
 
-  def self.element_type(item)
-    case item
-    when String, Symbol
-      'string'
+      return output
+    end
 
-    when Integer
-      'integer'
+    def self.element_type(item)
+      case item
+      when String, Symbol
+        'string'
 
-    when Float
-      'real'
+      when Integer
+        'integer'
 
-    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
+      when Float
+        'real'
 
-    def to_s
-      return @contents
+      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 raise_indent
-      @indent_level += 1
-    end
+      def to_s
+        return @contents
+      end
 
-    def lower_indent
-      @indent_level -= 1 if @indent_level > 0
-    end
+      def raise_indent
+        @indent_level += 1
+      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 lower_indent
+        @indent_level -= 1 if @indent_level > 0
+      end
 
-          @contents << val.gsub(/^/, indent)
+      def <<(val)
+        if val.is_a? Array
+          val.each do |f|
+            self << f
+          end
         else
-          @contents << val
-        end
+          # if it's already indented, don't bother indenting further
+          unless val =~ /\A#{@indent_string}/
+            indent = @indent_string * @indent_level
 
-        # it already has a newline, don't add another
-        @contents << "\n" unless val =~ /\n$/
+            @contents << val.gsub(/^/, indent)
+          else
+            @contents << val
+          end
+
+          # it already has a newline, don't add another
+          @contents << "\n" unless val =~ /\n$/
+        end
       end
     end
   end

data/lib/plist/parser.rb

@@ -11,41 +11,41 @@
 # === 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 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 send your plist file to
-# plist@hexane.org so that I can implement the proper support.
-  def Plist::parse_xml( filename_or_xml )
+  # 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 )
+    def text(contents)
       @open.last.text = contents if @open.last
     end
 
@@ -60,11 +60,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.exist? plist_data_or_file
-        @xml = File.read( plist_data_or_file )
+        @xml = File.read(plist_data_or_file)
       else
         @xml = plist_data_or_file
       end
@@ -78,15 +78,14 @@ module Plist
     COMMENT_START = /\A<!--/
     COMMENT_END = /.*?-->/m
 
-
     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)
@@ -132,22 +131,21 @@ module Plist
   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
@@ -163,7 +161,7 @@ module Plist
 
   class PDict < PTag
     def to_ruby
-      dict = Hash.new
+      dict = {}
       key = nil
 
       children.each do |c|
@@ -181,13 +179,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
 

data/lib/plist/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Plist
-  VERSION = '3.3.0'.freeze
+  VERSION = '3.4.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plist
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Ben Bleything
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-28 00:00:00.000000000 Z
+date: 2017-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: All-purpose Property List manipulation library