property-list 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cccb65a32fea2d625572d56e271741ad40ed0e57
+  data.tar.gz: 321a139923120337ab64a16c9836386e3ab5feaa
+SHA512:
+  metadata.gz: e7fe9ed9590b7a55622509048b7d51f44a011ca8dc223acd717e3cdcbcad0802627bb9075be536f511a27cf7245a2bdc5962a71d9e82dd1f87a165025f2a5777
+  data.tar.gz: 4ef25397d9e969d28bc97943f11c9e075c00b12b36479e5cad80c47c6eec9a2fbdc94ad5c7c454c65ae1fab4a13550e8e747a425a9406c7f7ce21dfd80bb06aa

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2017, luikore
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,52 @@
+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.
+
+## Install
+
+Requires Ruby 1.9+
+
+    gem ins property-list
+
+## Usage
+
+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
+
+## Data type mapping
+
+Data type mapping in `PropertyList.load`:
+
+    real:    Float
+    string:  String
+    integer: Integer
+    data:    StringIO
+    date:    DateTime
+    true:    true
+    false:   false
+    uid:     PropertyList::Uid # obj.uid is the integer index
+
+Reverse mapping in `PropertyList.dump_*`:
+
+    Float:                real
+    String, Symbol:       string
+    Integer:              integer
+    StringIO, IO:         data
+    Time, DateTime, Date: date
+    true:                 true
+    false:                false
+    PropertyList::Uid:    uid
+
+## Credits
+
+The binary generating code is modified from https://github.com/jarib/plist with bug fixes and performance tuning.

data/Rakefile

@@ -0,0 +1,7 @@
+desc "run tests"
+task :test do
+  Dir.glob './test/test_*.rb' do |f|
+    p f
+    require f
+  end
+end

data/gems.locked

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    property-list (1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    docile (1.1.5)
+    hoe (3.16.1)
+      rake (>= 0.8, < 13.0)
+    json (2.1.0)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (12.0.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    slop (3.6.0)
+    test-unit (1.2.3)
+      hoe (>= 1.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15.4)
+  property-list!
+  pry (~> 0.10.4)
+  rake (~> 12.0.0)
+  simplecov (~> 0.14.1)
+  test-unit (~> 1.2.3)
+
+BUNDLED WITH
+   1.15.4

data/gems.rb

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/lib/property-list.rb

@@ -0,0 +1,83 @@
+require 'date'
+require 'set'
+require 'base64'
+require 'cgi'
+require 'stringio'
+require 'strscan'
+
+require_relative 'property-list/xml_generator'
+require_relative 'property-list/xml_parser'
+require_relative 'property-list/ascii_generator'
+require_relative 'property-list/ascii_parser'
+require_relative 'property-list/binary_markers'
+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
+  def self.load data
+    case data.byteslice(0, 8)
+    when /\Abplist\d\d/n
+      load_binary data.force_encoding('binary')
+    when /\A<\?xml\ /n
+      load_xml data.force_encoding('utf-8')
+    else
+      load_ascii data.force_encoding('utf-8')
+    end
+  end
+
+  class SyntaxError < RuntimeError
+  end
+
+  # binary plist v0x elements:
+
+  class UID
+    def initialize uid
+      @uid = uid
+    end
+    attr_reader :uid
+  end
+
+  # binary plist v1x elements:
+
+  class URL
+    def initialize url
+      @url = url
+    end
+    attr_reader :url
+  end
+
+  class UUID
+    def initialize uuid
+      @uuid = uuid
+    end
+    attr_reader :uuid
+  end
+
+  class OrderedSet
+    def initialize elements
+      @elements = elements.uniq
+    end
+
+    def each
+      @elements.each do |e|
+        yield e
+      end
+    end
+  end
+end

data/lib/property-list/ascii_generator.rb

@@ -0,0 +1,148 @@
+module PropertyList
+  # options can be:
+  #
+  # [:indent_unit] the indent unit, default value is <code>"\t"</code>, set to <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>
+  #
+  # [: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
+    generator.output << "// !$*UTF8*$!\n" if encoding_comment
+    generator.generate obj, wrap
+    generator.output << "\n" if wrap and obj.is_a?(Hash)
+    generator.output.join
+  end
+
+  class AsciiGenerator #:nodoc:
+    def initialize indent_unit: "\t", initial_indent: '', sort_keys: true
+      @indent_unit = indent_unit
+      @indent_level = 0
+      @initial_indent = initial_indent
+      @indent = @initial_indent + @indent_unit * @indent_level
+      @sort_keys = sort_keys
+      @output = []
+    end
+    attr_reader :output
+
+    def generate object, wrap=true
+      # See also
+      # http://www.gnustep.org/resources/documentation/Developer/Base/Reference/NSPropertyList.html
+      # The <...> extensions are from GNUStep
+
+      case object
+      when Array
+        ascii_collection '(', ')' do
+          object.each do |e|
+            generate e
+            @output << ",\n"
+          end
+        end
+      when Hash
+        if wrap
+          ascii_collection '{', '}' do
+            ascii_hash_content object
+          end
+        else
+          ascii_hash_content object
+        end
+      when true
+        ascii_value "<*BY>"
+      when false
+        ascii_value "<*BN>"
+      when Float
+        if object.to_i == object
+          object = object.to_i
+        end
+        ascii_value "<*R#{object}>"
+      when Integer
+        ascii_value "<*I#{object}>"
+      when Time, Date # also covers DateTime
+        ascii_value "<*D#{object.strftime '%Y-%m-%d %H:%M:%S %z'}>"
+      when String
+        ascii_string object
+      when Symbol
+        ascii_string object.to_s
+      when IO, StringIO
+        object.rewind
+        contents = object.read
+        ascii_data contents
+      else
+        raise "Generating of this class is not supported"
+      end
+    end
+
+    def ascii_value v
+      @output << @indent
+      @output << v
+    end
+
+    TABLE_FOR_ASCII_STRING_ESCAPE = {
+      "\\".ord => "\\\\",
+      '"'.ord => '\\"',
+      "\b".ord => '\b',
+      "\n".ord => "\\n",
+      "\r".ord => "\\r",
+      "\t".ord => "\\t"
+    }.freeze
+    def ascii_string s
+      @output << @indent
+
+      if s =~ /\A[\w\.\/]+\z/
+        @output << s
+        return
+      end
+
+      # there is also single quote string, in which we can use new lines and '' for single quote
+      @output << '"'
+      s.unpack('U*').each do |c|
+        if c > 127
+          # there is also a \OOO format, but we only generate the \U format
+          @output << "\\U#{c.to_s(16).rjust 4, '0'}"
+        elsif (escaped_c = TABLE_FOR_ASCII_STRING_ESCAPE[c])
+          @output << escaped_c
+        else
+          @output << c.chr
+        end
+      end
+      @output << '"'
+    end
+
+    def ascii_collection start_delim, end_delim
+      @output << @indent
+      @output << start_delim
+      @output << "\n"
+      @indent = @initial_indent + @indent_unit * (@indent_level += 1)
+      yield
+      @indent = @initial_indent + @indent_unit * (@indent_level -= 1)
+      @output << @indent
+      @output << end_delim
+    end
+
+    def ascii_hash_content object
+      keys = object.keys
+      keys.sort_by! &:to_s if @sort_keys
+      keys.each do |k|
+        v = object[k]
+        reset_indent = @indent
+        ascii_string k.to_s
+        @output << ' = '
+        @indent = '' # ignores the indent for first line
+        generate v
+        @output << ";\n"
+        @indent = reset_indent
+      end
+    end
+
+    def ascii_data content
+      hex, _ = content.unpack 'H*'
+      hex.gsub! /(.{2})/, "\\1 "
+      @output << "< #{hex}>"
+    end
+  end
+end

data/lib/property-list/ascii_parser.rb

@@ -0,0 +1,217 @@
+module PropertyList
+  def self.load_ascii(data)
+    AsciiParser.new(data).parse
+  end
+
+  class AsciiParser
+    def initialize src
+      @lexer = StringScanner.new src.strip
+    end
+
+    def parse
+      res = parse_object
+      skip_space_and_comment
+      if !@lexer.eos? or res.nil?
+        syntax_error "Unrecognized token"
+      end
+      res
+    end
+
+    def skip_space_and_comment
+      @lexer.skip(%r{(?:
+        [\x0A\x0D\u2028\u2029\x09\x0B\x0C\x20]+ # newline and space
+        |
+        //[^\x0A\x0D\u2028\u2029]* # one-line comment
+        |
+        /\*(?:.*?)\*/ # multi-line comment
+      )+}mx)
+    end
+
+    def parse_object
+      skip_space_and_comment
+      case @lexer.peek(1)
+      when '{'
+        parse_dict
+      when '('
+        parse_array
+      when '"'
+        parse_string '"'
+      when "'"
+        parse_string "'" # NOTE: not in GNU extension
+      when '<'
+        parse_extension_value
+      when /[\w\.\/]/
+        parse_unquoted_string
+      end
+    end
+
+    def parse_dict
+      @lexer.pos += 1
+      hash = {}
+      while (skip_space_and_comment; @lexer.peek(1) != '}')
+        k = \
+          case @lexer.peek(1)
+          when '"'
+            parse_string '"'
+          when "'"
+            parse_string "'"
+          when /\w/
+            parse_unquoted_string
+          end
+        if !k
+          syntax_error "Expect dictionary key"
+        end
+
+        skip_space_and_comment
+        if !@lexer.scan(/=/)
+          syntax_error "Expect '=' after dictionary key"
+        end
+        skip_space_and_comment
+
+        v = parse_object
+        if v.nil?
+          syntax_error "Expect dictionary value"
+        end
+
+        skip_space_and_comment
+        if !@lexer.scan(/;/)
+          syntax_error "Expect ';' after dictionary value"
+        end
+        skip_space_and_comment
+
+        hash[k] = v
+      end
+      if @lexer.getch != '}'
+        syntax_error "Unclosed hash"
+      end
+      hash
+    end
+
+    def parse_array
+      @lexer.pos += 1
+      array = []
+      while (skip_space_and_comment; @lexer.peek(1) != ')')
+        obj = parse_object
+        if obj.nil?
+          syntax_error "Failed to parse array element"
+        end
+        array << obj
+        skip_space_and_comment
+        @lexer.scan(/,/)
+      end
+      if @lexer.getch != ')'
+        syntax_error "Unclosed array"
+      end
+      array
+    end
+
+    def parse_string delim
+      @lexer.pos += 1
+
+      # TODO (TextMate only, xcode cannot parse it) when delim is ', '' is the escape
+
+      chars = []
+      while (ch = @lexer.getch) != delim
+        case ch
+        when '\\'
+          case @lexer.getch
+          when '\\'
+            chars << '\\'
+          when '"'
+            chars << '"'
+          when "'"
+            chars << "'"
+          when 'b'
+            chars << "\b"
+          when 'n'
+            chars << "\n"
+          when 'r'
+            chars << "\r"
+          when 't'
+            chars << "\t"
+          when 'U'
+            if (hex = @lexer.scan /[0-9a-h]{4}/i)
+              chars << [hex].pack('U')
+            else
+              syntax_error "Expect 4 digit hex code"
+            end
+          else
+            if (oct = @lexer.scan /[0-7]{3}/)
+              chars << [oct.to_i(8)].pack('U')
+            else
+              syntax_error "Expect 3 digit oct code"
+            end
+          end
+        else
+          chars << ch
+        end
+      end
+      chars.join
+    end
+
+    def parse_unquoted_string
+      @lexer.scan /[\w\.\/]+/
+    end
+
+    def parse_extension_value
+      @lexer.pos += 1
+
+      case @lexer.peek(2)
+      when '*D' # date
+        @lexer.pos += 2
+        if (d = @lexer.scan /\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [+\-]\d{4}\>/)
+          Date.strptime d.chop, "%Y-%m-%d %H:%M:%S %z"
+        else
+          syntax_error "Expect date value"
+        end
+
+      when '*I' # integer
+        @lexer.pos += 2
+        if (i = @lexer.scan /[\+\-]?\d+\>/)
+          i.chop.to_i
+        else
+          syntax_error "Expect integer value"
+        end
+
+      when '*R' # real
+        @lexer.pos += 2
+        if (r = @lexer.scan /[\+\-]?\d+(\.\d+)?([eE][\+\-]?\d+)?\>/)
+          r.chop.to_f
+        else
+          syntax_error "Expect real value"
+        end
+
+      when '*B' # boolean
+        @lexer.pos += 2
+        case @lexer.scan(/[YN]\>/)
+        when 'Y>'
+          true
+        when 'N>'
+          false
+        else
+          syntax_error "Expect boolean value"
+        end
+
+      else
+        parse_data
+      end
+    end
+
+    def parse_data
+      if (h = @lexer.scan /[0-9a-f\s]*\>/i)
+        h = h.gsub /[\s\>]/, ''
+        data = [h].pack 'H*'
+        StringIO.new data
+      else
+        syntax_error "Expect hex value"
+      end
+    end
+
+    def syntax_error msg
+      pre = @lexer.string[0...@lexer.pos]
+      line = pre.count("\n") + 1
+      col = pre.size - pre.rindex("\n")
+      raise SyntaxError, msg + " at line: #{line} col: #{col} #{@lexer.inspect}", caller
+    end
+  end
+end