property-list 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa876b36addfa71b3f6ae9e2cbda72bf85644cad
-  data.tar.gz: 4a9757255bc2bf508d8db8a3a0aae5b6a2c7c59c
+  metadata.gz: 6a77c93353f4ae1b3e24f38e0976a133a68251ec
+  data.tar.gz: 2c68650d8755fc85dd1752951e930f153624a372
 SHA512:
-  metadata.gz: a54bf12b89e339523d7a29de13096d32ddb4e7c99ab6a6ff5f09cb09b480848883b2379826b6759472b8c1b8447b5b88b6f615dca6ada8fe1bce37dcabad543a
-  data.tar.gz: 3d9320c8aee3e89789ccc5d3212a70f1fcc119a5b9ca34412a2622a91ac15471e6e951d5c0b4b104c69c6a48292a7ec992e887b7892767a30472d1760ac72b32
+  metadata.gz: 786bb0eaba6ebf83dee461f951ce9966b51c649e945fd1a06ebb3d6a7176ebd886abb6c773172ae85455a310a23a9b93ed00b567b18d58b5bc74cc4696985e4d
+  data.tar.gz: 4c64f96962192fa6cea63ceb476baaa9129996ec33f322465134b169b19b270ff136836419ca18ddd96fe5a804a35948fa89bdb6c0f8dc89dc4cc8fee4f10ed4

data/.rdoc_options

@@ -0,0 +1,23 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+- "."
+charset: UTF-8
+exclude:
+- "test"
+hyperlink_all: false
+line_numbers: false
+locale: 
+locale_dir: locale
+locale_name: 
+main_page: 
+markup: markdown
+output_decoration: true
+page_dir: 
+show_hash: false
+tab_width: 8
+template_stylesheets: []
+title: 
+visibility: :protected
+webcvs: 

data/README.md

@@ -1,6 +1,6 @@
-This is a full-featured property list library which supports XML/Binary/ASCII format plists, and performance is tuned for large property list files.
-
-The code is as clean and complete as possible. There is no runtime dependency to any other gems or libplist or other libraries.
+Fully featured propertylist library.
+Can load and dump XML/ASCII/Binary plists and offer fine-grained formatting options.
+Cross platform, clean code, performance tuned, no dependency.
 
 ## Install
 
@@ -25,20 +25,22 @@ Generate a plist file data
 
 XML formatting options for `PropertyList.dump_xml object, options`
 
-- `segment:` whether wrap the xml output is a segment or wrapped with `<?xml>` and `<plist>` tags. default is `false`.
+- `segment:` whether output an XML segment (not wrapped with `<?xml>`, `<DOCTYPE>`, `<plist>` tags), default is `false`.
 - `xml_version:` you can also specify `"1.1"` for https://www.w3.org/TR/xml11/, default is `"1.0"`, no effect if `:segment` is set to `true`.
-- `indent_unit:` the indent unit, default value is `"\t"`, set to `nil` or `''` if you don't need indent.
+- `gnu_dtd:` use GNUStep DTD instead (which is a bit different in string escaping), default is `false`.
+- `indent_unit:` the indent unit, default value is `"\t"`, set to or `''` if you don't need indent.
 - `initial_indent:` initial indent space, default is `''`, the indentation per line equals to `initial_indent + indent * current_indent_level`.
 - `base64_width:` the width of characters per line when serializing data with Base64, default value is `68`, must be multiple of `4`.
 - `base64_indent:` whether indent the Base64 encoded data, you can use `false` for compatibility to generate same output for other frameworks, default value is `true`.
 
 ASCII formatting options for `PropertyList.dump_ascii object, options`
 
-- `indent_unit:` the indent unit, default value is `"\t"`, set to `''` if you don't need indent
-- `initial_indent:` initial indent space, default is `''`, the indentation per line equals to `initial_indent + indent * current_indent_level`
+- `indent_unit:` the indent unit, default value is `"\t"`, set to `''` if you don't need indent.
+- `initial_indent:` initial indent space, default is `''`, the indentation per line equals to `initial_indent + indent * current_indent_level`.
 - `wrap:` wrap the top level output with `{...}` when obj is a Hash, default is `true`.
-- `encoding_comment:` add encoding comment `// !$*UTF8*$!` on top of file, default is `false`
-- `sort_keys:` sort dict keys, default is `true`
+- `encoding_comment:` add encoding comment `// !$*UTF8*$!` on top of file, default is `false`.
+- `sort_keys:` sort dict keys, default is `true`.
+- `gnu_extension` whether allow GNUStep extensions for ASCII plist to support serializing more types, default is `true`.
 
 ## Data type mapping
 
@@ -51,7 +53,10 @@ Data type mapping in `PropertyList.load`:
     date:    DateTime
     true:    true
     false:   false
-    uid:     PropertyList::Uid # obj.uid is the integer index
+    uid:     PropertyList::UID  # only in binary plist, obj.uid is the integer index
+    array:   Array
+    dict:    Hash
+    set:     Set                # only in binary plist
 
 Reverse mapping in `PropertyList.dump_*`:
 
@@ -62,7 +67,12 @@ Reverse mapping in `PropertyList.dump_*`:
     Time, DateTime, Date: date
     true:                 true
     false:                false
-    PropertyList::Uid:    uid
+    PropertyList::Uid:    uid      # only in binary plist
+    Dict:                 dict
+    Array:                array
+    Set:                  set      # only in binary plist
+
+Type mappings in ASCII plist depends on the DTD.
 
 ## Credits
 

data/lib/property-list.rb

@@ -14,22 +14,17 @@ require_relative 'property-list/binary_generator'
 require_relative 'property-list/binary_parser'
 require_relative 'property-list/version'
 
-# === Load a plist file
-#
-#   PropertyList.load_xml File.read "some_plist.xml"
-#   PropertyList.load_binary File.binread "some_binary.plist"
-#   PropertyList.load_ascii File.read "some_ascii.strings"
-#   PropertyList.load File.binread "unknown_format.plist"
-#
-# === Generate a plist file data
-#
-#   PropertyList.dump_xml obj
-#   PropertyList.dump_binary obj
-#   PropertyList.dump_ascii obj
-#
 module PropertyList
-  # load plist (binary or xml or ascii) into a ruby object
-  # auto detect the format
+  # Load plist from file
+  #
+  # Auto detects format
+  def self.load_file file_name
+    load File.binread file_name
+  end
+
+  # Load plist (binary or xml or ascii) into a ruby object.
+  #
+  # Auto detects format.
   def self.load data
     case data.byteslice(0, 8)
     when /\Abplist\d\d/n
@@ -44,6 +39,9 @@ module PropertyList
   class SyntaxError < RuntimeError
   end
 
+  class UnsupportedTypeError < RuntimeError
+  end
+
   # binary plist v0x elements:
 
   class UID

data/lib/property-list/ascii_generator.rb

@@ -1,18 +1,17 @@
 module PropertyList
-  # options can be:
+  # Generate ASCII (Plain) plist.
   #
-  # [:indent_unit] the indent unit, default value is <code>"\t"</code>, set to <code>''</code> if you don't need indent
+  # Options:
   #
-  # [:initial_indent] initial indent space, default is <code>''</code>, the indentation per line equals to <code>initial_indent + indent * current_indent_level</code>
+  # - `indent_unit:` the indent unit, default value is `"\t"`, set to `''` if you don't need indent.
+  # - `initial_indent:` initial indent space, default is `''`, the indentation per line equals to `initial_indent + indent * current_indent_level`.
+  # - `wrap:` wrap the top level output with `{...}` when obj is a Hash, default is `true`.
+  # - `encoding_comment:` add encoding comment `// !$*UTF8*$!` on top of file, default is `false`.
+  # - `sort_keys:` sort dict keys, default is `true`.
+  # - `gnu_extension` whether allow GNUStep extensions for ASCII plist to support serializing more types, default is `true`.
   #
-  # [:wrap] wrap the top level output with '{}' when obj is a Hash, default is true.
-  #
-  # [:encoding_comment] add encoding comment '!$*UTF8*$!' on top of file, default is false
-  #
-  # [:sort_keys] sort dict keys, default is true
-  #
-  def self.dump_ascii obj, indent_unit: "\t", initial_indent: '', wrap: true, encoding_comment: false, sort_keys: true
-    generator = AsciiGenerator.new indent_unit: indent_unit, initial_indent: initial_indent, sort_keys: sort_keys
+  def self.dump_ascii obj, indent_unit: "\t", initial_indent: '', wrap: true, encoding_comment: false, sort_keys: true, gnu_extension: true
+    generator = AsciiGenerator.new indent_unit: indent_unit, initial_indent: initial_indent, sort_keys: sort_keys, gnu_extension: gnu_extension
     generator.output << "// !$*UTF8*$!\n" if encoding_comment
     generator.generate obj, wrap
     generator.output << "\n" if wrap and obj.is_a?(Hash)
@@ -20,12 +19,13 @@ module PropertyList
   end
 
   class AsciiGenerator #:nodoc:
-    def initialize indent_unit: "\t", initial_indent: '', sort_keys: true
+    def initialize indent_unit: "\t", initial_indent: '', sort_keys: true, gnu_extension: true
       @indent_unit = indent_unit
       @indent_level = 0
       @initial_indent = initial_indent
       @indent = @initial_indent + @indent_unit * @indent_level
       @sort_keys = sort_keys
+      @gnu_extension = gnu_extension
       @output = []
     end
     attr_reader :output
@@ -52,18 +52,38 @@ module PropertyList
           ascii_hash_content object
         end
       when true
-        ascii_value "<*BY>"
+        if @gnu_extension
+          ascii_value "<*BY>"
+        else
+          raise UnsupportedTypeError, 'TrueClass'
+        end
       when false
-        ascii_value "<*BN>"
+        if @gnu_extension
+          ascii_value "<*BN>"
+        else
+          raise UnsupportedTypeError, 'FalseClass'
+        end
       when Float
-        if object.to_i == object
-          object = object.to_i
+        if @gnu_extension
+          if object.to_i == object
+            object = object.to_i
+          end
+          ascii_value "<*R#{object}>"
+        else
+          raise UnsupportedTypeError, 'Float'
         end
-        ascii_value "<*R#{object}>"
       when Integer
-        ascii_value "<*I#{object}>"
+        if @gnu_extension
+          ascii_value "<*I#{object}>"
+        else
+          raise UnsupportedTypeError, 'Integer'
+        end
       when Time, Date # also covers DateTime
-        ascii_value "<*D#{object.strftime '%Y-%m-%d %H:%M:%S %z'}>"
+        if @gnu_extension
+          ascii_value "<*D#{object.strftime '%Y-%m-%d %H:%M:%S %z'}>"
+        else
+          raise UnsupportedTypeError, object.class.to_s
+        end
       when String
         ascii_string object
       when Symbol
@@ -73,7 +93,7 @@ module PropertyList
         contents = object.read
         ascii_data contents
       else
-        raise "Generating of this class is not supported"
+        raise UnsupportedTypeError, object.class.to_s
       end
     end
 

data/lib/property-list/ascii_parser.rb

@@ -1,9 +1,10 @@
 module PropertyList
-  def self.load_ascii(data)
-    AsciiParser.new(data).parse
+  # Parse ASCII plist into a Ruby object
+  def self.load_ascii text
+    AsciiParser.new(text).parse
   end
 
-  class AsciiParser
+  class AsciiParser #:nodoc:
     def initialize src
       @lexer = StringScanner.new src.strip
     end

data/lib/property-list/binary_generator.rb

@@ -1,6 +1,7 @@
 # encoding: binary
 
 module PropertyList
+  # Generate binary plist, the version is auto detected
   def self.dump_binary obj, options=nil
     generator = BinaryGenerator.new options
     generator.generate obj
@@ -11,7 +12,7 @@ module PropertyList
   #   https://github.com/jarib/plist/blob/master/lib/plist/binary.rb
   #
   # With improved performance
-  class BinaryGenerator
+  class BinaryGenerator #:nodoc:
     include BinaryMarkers
 
     def initialize opts

data/lib/property-list/binary_markers.rb

@@ -1,5 +1,5 @@
 module PropertyList
-  module BinaryMarkers
+  module BinaryMarkers #:nodoc:
     # These marker bytes are prefixed to objects in a binary property list to
     # indicate the type of the object.
     MARKER_NULL           = 0b0000_0000 # v1?+ only

data/lib/property-list/binary_parser.rb

@@ -1,11 +1,12 @@
 module PropertyList
-  def self.load_binary(data)
+  # Parse binary plist into a Ruby object
+  def self.load_binary data
     BinaryParser.new(data).parse
   end
 
   # Reference:
   #   https://opensource.apple.com/source/CF/CF-1151.16/CFBinaryPList.c.auto.html
-  class BinaryParser
+  class BinaryParser #:nodoc:
     include BinaryMarkers
 
     def initialize src

data/lib/property-list/version.rb

@@ -1,3 +1,3 @@
 module PropertyList
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.0.2'.freeze
 end

data/lib/property-list/xml_generator.rb

@@ -1,31 +1,34 @@
 module PropertyList
 
-  # options can be:
+  # Generate ASCII (Plain) plist.
   #
-  # [:segment] whether wrap the xml output is a segment or wrapped with &lt;?xml&gt; and &lt;plist&gt; tags. default is <code>false</code>.
+  # Options:
   #
-  # [:xml_version] you can also specify <code>"1.1"</code> for https://www.w3.org/TR/xml11/, default is <code>"1.0"</code>, no effect if <code>:segment</code> is set to <code>true</code>
+  # - `segment:` whether output an XML segment (not wrapped with `<?xml>`, `<DOCTYPE>`, `<plist>` tags), default is `false`.
+  # - `xml_version:` you can also specify `"1.1"` for https://www.w3.org/TR/xml11/, default is `"1.0"`, no effect if `:segment` is set to `true`.
+  # - `gnu_dtd:` use GNUStep DTD instead (which is a bit different in string escaping), default is `false`.
+  # - `indent_unit:` the indent unit, default value is `"\t"`, set to or `''` if you don't need indent.
+  # - `initial_indent:` initial indent space, default is `''`, the indentation per line equals to `initial_indent + indent * current_indent_level`.
+  # - `base64_width:` the width of characters per line when serializing data with Base64, default value is `68`, must be multiple of `4`.
+  # - `base64_indent:` whether indent the Base64 encoded data, you can use `false` for compatibility to generate same output for other frameworks, default value is `true`.
   #
-  # [:indent_unit] the indent unit, default value is <code>"\t"</code>, set to <code>nil</code> or <code>''</code> if you don't need indent
-  #
-  # [:initial_indent] initial indent space, default is <code>''</code>, the indentation per line equals to <code>initial_indent + indent * current_indent_level</code>
-  #
-  # [:base64_width] the width of characters per line when serializing data with Base64, default value is <code>68</code>, must be multiple of <code>4</code>
-  #
-  # [:base64_indent] whether indent the Base64 encoded data, you can use <code>false</code> for compatibility to generate same output for other frameworks, default value is <code>true</code>
-  #
-  def self.dump_xml obj, segment: false, xml_version: '1.0', base64_width: 68, base64_indent: true, indent_unit: "\t", initial_indent: ''
+  def self.dump_xml obj, segment: false, xml_version: '1.0', gnu_dtd: false, base64_width: 68, base64_indent: true, indent_unit: "\t", initial_indent: ''
     if !base64_width.is_a?(Integer) or base64_width <= 0 or base64_width % 4 != 0
       raise ArgumentError, "option :base64_width must be a positive integer and a multiple of 4"
     end
 
-    generator = XmlGenerator.new base64_width: base64_width, base64_indent: base64_indent, indent_unit: indent_unit, initial_indent: initial_indent
+    generator = XmlGenerator.new gnu_dtd: gnu_dtd, base64_width: base64_width, base64_indent: base64_indent, indent_unit: indent_unit, initial_indent: initial_indent
     if segment
       generator.generate obj
     else
       generator.output << %|<?xml version="#{xml_version}" encoding="UTF-8"?>\n|
-      generator.output << %|<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n|
-      generator.output << %|<plist version="1.0">\n|
+      if gnu_dtd
+        generator.output << %|<!DOCTYPE plist PUBLIC "-//GNUstep//DTD plist 0.9//EN" "http://www.gnustep.org/plist-0_9.xml">\n|
+        generator.output << %|<plist>\n|
+      else
+        generator.output << %|<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">\n|
+        generator.output << %|<plist version="1.0">\n|
+      end
       generator.generate obj
       generator.output << %|</plist>\n|
     end
@@ -33,7 +36,8 @@ module PropertyList
   end
 
   class XmlGenerator #:nodoc:
-    def initialize base64_width: 68, base64_indent: true, indent_unit: "\t", initial_indent: ''
+    def initialize gnu_dtd: false, base64_width: 68, base64_indent: true, indent_unit: "\t", initial_indent: ''
+      @gnu_dtd = gnu_dtd
       @indent_unit = indent_unit
       @indent_level = 0
       @initial_indent = initial_indent
@@ -101,7 +105,7 @@ module PropertyList
         contents = obj.read
         data_tag contents
       else
-        raise "Unsupported class: #{obj.class}"
+        raise UnsupportedTypeError, obj.class.to_s
       end
     end
 
@@ -139,9 +143,15 @@ module PropertyList
     TABLE_FOR_ESCAPE = {"&" => "&amp;", "<" => "&lt;", ">" => "&gt;"}.freeze
     def escape_string s
       # Likes CGI.escapeHTML but leaves `'` or `"` as mac plist does
-      s.gsub /[&<>]/ do |c|
+      s = s.gsub /[&<>]/ do |c|
         TABLE_FOR_ESCAPE[c]
       end
+      if @gnu_dtd
+        # use \u to escape all control chars
+        s.gsub(/[[:cntrl:]]/) {|c| "\\U#{c.ord.to_s(16).rjust 4, '0'}" }
+      else
+        s
+      end
     end
   end
 end

data/lib/property-list/xml_parser.rb

@@ -1,9 +1,10 @@
 module PropertyList
+  # Parse XML plist into a Ruby object
   def self.load_xml xml
     XmlParser.new(xml).parse
   end
 
-  class XmlParser
+  class XmlParser #:nodoc:
     def initialize src
       @lexer = StringScanner.new src
     end

data/property-list.gemspec

@@ -6,8 +6,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Luikore"]
   spec.email         = 'no@email'
 
-  spec.summary       = "Property List (plist) library with all formats support"
-  spec.description   = "Full-featured property list library. Supports XML/ASCII/Binary plist generate and parse. Finely-tuned formatting options. No line-ending bug like plist gem. Cross platform. No dependency."
+  spec.summary       = "Property List (plist, propertylist) library with all formats support"
+  spec.description   = "Fully featured propertylist library.
+Can load and dump XML/ASCII/Binary plists and offer fine-grained formatting options.
+Cross platform, clean code, performance tuned, no dependency."
   spec.homepage      = "https://github.com/luikore/property-list"
   spec.license       = "BSD-3-Clause"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: property-list
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Luikore
@@ -80,15 +80,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
-description: Full-featured property list library. Supports XML/ASCII/Binary plist
-  generate and parse. Finely-tuned formatting options. No line-ending bug like plist
-  gem. Cross platform. No dependency.
+description: |-
+  Fully featured propertylist library.
+  Can load and dump XML/ASCII/Binary plists and offer fine-grained formatting options.
+  Cross platform, clean code, performance tuned, no dependency.
 email: no@email
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rdoc_options"
 - LICENSE
 - README.md
 - Rakefile
@@ -127,5 +129,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Property List (plist) library with all formats support
+summary: Property List (plist, propertylist) library with all formats support
 test_files: []