plist 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dada9257510eabf5ab04f5bd4dd6098a33ce68142d3c63c6278c643630a7761
-  data.tar.gz: f45363442af85f0515c7d30d25a3ca8625f366a91110334c4b2db7717ce9fa98
+  metadata.gz: 2a76784a6b7e953d1cd9b6deaf390eb7556fd0df83e8970db7ac4640c71493b4
+  data.tar.gz: 8324c2b332839aa772eb77a4a760b24e43e24c363c99d01c2b2b4b11e311938a
 SHA512:
-  metadata.gz: cfe9ad984a22f43d24802fc159fca5e53d4ac88e45610d5accb0cafcfcecf99a643d290ed4073147e32f1f34b1c84b1ed8745b1d1c30edc8dc3c0fdc7d225efd
-  data.tar.gz: 91744b0fd7d45ccc1adff2f5279c37a511725896479e4a20261605735067e518f5eb5354605567a796aba2a78724555389b09b162d7218c363759df85d1dcce3
+  metadata.gz: c33686b606d723821333314b4a18fe6ac39d65a3712aa1cd43896dbbd4bfb95130aa0a1f62b4a3b260c2a633d44681eec0766fef5651ae70580340a905e4f6e4
+  data.tar.gz: 5b63b55469235ec79f14af6f25c05cbc8e6088ce9532e9dfc5aa0887e533a7ee67424953d62e0b3dfe046c7745d9a2add1e0b8ddf07c34f46c5a551c92a9a158

data/lib/plist.rb

@@ -13,6 +13,6 @@ require 'base64'
 require 'cgi'
 require 'stringio'
 
-require 'plist/generator'
-require 'plist/parser'
-require 'plist/version'
+require_relative 'plist/generator'
+require_relative 'plist/parser'
+require_relative 'plist/version'

data/lib/plist/generator.rb

@@ -26,13 +26,11 @@ module Plist
 
     # 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)
+      Plist::Emit.dump(self, envelope, options)
     end
 
     # 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
 
@@ -46,177 +44,129 @@ module Plist
     # 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 = PlistBuilder.new(options[:indent]).build(obj)
       output = wrap(output) if envelope
 
-      return output
+      output
     end
 
     # 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
 
     private
-    def self.plist_node(element, options = {})
-      options = { :indent => DEFAULT_INDENT }.merge(options)
-      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', '', options) {
-              element.collect {|e| plist_node(e, options)}
-            }
-          end
-        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
+    class PlistBuilder
+      def initialize(indent_str)
+        @indent_str = indent_str.to_s
+      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)
+      def build(element, level=0)
+        if element.respond_to? :to_plist_node
+          element.to_plist_node
         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)
+          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
       end
 
-      return output
-    end
-
-    def self.comment(content)
-      return "<!-- #{content} -->\n"
-    end
+      private
 
-    def self.tag(type, contents = '', options = {}, &block)
-      options = { :indent => DEFAULT_INDENT }.merge(options)
-      out = nil
+      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
+      end
 
-      if block_given?
-        out = IndentedString.new(options[:indent])
-        out << "<#{type}>"
-        out.raise_indent
+      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.
+        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
 
-        out << block.call
+      def indent(str, level)
+        @indent_str.to_s * level + str
+      end
 
-        out.lower_indent
-        out << "</#{type}>"
-      else
-        out = "<#{type}>#{contents.to_s}</#{type}>\n"
+      def element_type(item)
+        case item
+        when String, Symbol
+          'string'
+        when Integer
+          'integer'
+        when Float
+          'real'
+        else
+          raise "Don't know about this data type... something must be wrong!"
+        end
       end
 
-      return out.to_s
+      def comment_tag(content)
+        return "<!-- #{content} -->\n"
+      end
     end
 
     def self.wrap(contents)
-      output = ''
-
-      output << '<?xml version="1.0" encoding="UTF-8"?>' + "\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 << '</plist>' + "\n"
 
-      return output
-    end
-
-    def self.element_type(item)
-      case item
-      when String, Symbol
-        'string'
-
-      when 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
-
-            @contents << val.gsub(/^/, indent)
-          else
-            @contents << val
-          end
-
-          # it already has a newline, don't add another
-          @contents << "\n" unless val =~ /\n$/
-        end
-      end
+      output
     end
   end
 end

data/lib/plist/parser.rb

@@ -13,6 +13,9 @@
 #
 #   r = Plist.parse_xml(filename_or_xml)
 module Plist
+  # 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.
@@ -46,7 +49,10 @@ module Plist
     end
 
     def text(contents)
-      @open.last.text = contents if @open.last
+      if @open.last
+        @open.last.text ||= ''
+        @open.last.text.concat(contents)
+      end
     end
 
     def tag_end(name)
@@ -72,11 +78,14 @@ module Plist
       @listener = listener
     end
 
-    TEXT       = /([^<]+)/
+    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('|')
@@ -105,10 +114,12 @@ 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

data/lib/plist/version.rb

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

metadata

@@ -1,28 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: plist
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Ben Bleything
 - Patrick May
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-21 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
@@ -56,7 +56,7 @@ dependencies:
 description: Plist is a library to manipulate Property List files, also known as plists.
   It can parse plist files into native Ruby data structures as well as generating
   new plist files from your Ruby objects.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -70,7 +70,7 @@ homepage: https://github.com/patsplat/plist
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,16 +78,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: All-purpose Property List manipulation library
 test_files: []