property-list 1.0

data/lib/property-list/version.rb

@@ -0,0 +1,3 @@
+module PropertyList
+  VERSION = '1.0'.freeze
+end

data/lib/property-list/xml_generator.rb

@@ -0,0 +1,147 @@
+module PropertyList
+
+  # options can be:
+  #
+  # [: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>.
+  #
+  # [: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>
+  #
+  # [: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: ''
+    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
+    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|
+      generator.generate obj
+      generator.output << %|</plist>\n|
+    end
+    generator.output.join
+  end
+
+  class XmlGenerator #:nodoc:
+    def initialize base64_width: 68, base64_indent: true, indent_unit: "\t", initial_indent: ''
+      @indent_unit = indent_unit
+      @indent_level = 0
+      @initial_indent = initial_indent
+      @indent = @initial_indent + @indent_unit * @indent_level
+      @base64_bytes_per_line = (base64_width * 6) / 8
+      @base64_indent = base64_indent
+      @output = []
+    end
+    attr_reader :output
+
+    def generate obj
+      if obj.respond_to? :to_plist_xml
+        xml = obj.to_plist_xml
+        if !xml.start_with?(@indent)
+          xml = @indent + xml
+        end
+        if !xml.end_with?("\n")
+          xml += "\n"
+        end
+        @output << xml
+        return
+      end
+
+      case obj
+      when Array
+        if obj.empty?
+          empty_tag 'array'
+        else
+          tag 'array' do
+            obj.each {|e| generate e }
+          end
+        end
+      when Hash
+        if obj.empty?
+          empty_tag 'dict'
+        else
+          tag 'dict' do
+            obj.keys.sort_by(&:to_s).each do |k|
+              v = obj[k]
+              tag 'key', escape_string(k.to_s)
+              generate v
+            end
+          end
+        end
+      when true, false
+        empty_tag obj
+      when Time
+        tag 'date', obj.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+      when Date # also catches DateTime
+        tag 'date', obj.strftime('%Y-%m-%dT%H:%M:%SZ')
+      when String
+        tag 'string', escape_string(obj)
+      when Symbol
+        tag 'string', escape_string(obj.to_s)
+      when Float
+        if obj.to_i == obj
+          tag 'real', obj.to_i
+        else
+          tag 'real', obj
+        end
+      when Integer
+        tag 'integer', obj
+      when IO, StringIO
+        obj.rewind
+        contents = obj.read
+        data_tag contents
+      else
+        raise "Unsupported class: #{obj.class}"
+      end
+    end
+
+    private
+
+    def empty_tag name
+      @output << "#@indent<#{name}/>\n"
+    end
+
+    def data_tag contents
+      # m51 means: 51 bytes for each base64 encode run length, which is (51 * 8 / 6 = 68) chars per line after base64
+      base64 = [contents].pack "m#@base64_bytes_per_line"
+      if @base64_indent
+        base64.gsub! /^/, @indent
+      end
+      @output << "#@indent<data>\n#{base64}#@indent</data>\n"
+    end
+
+    def comment_tag content
+      @output << "#@indent<!-- #{content} -->\n"
+    end
+
+    def tag name, contents=nil
+      if block_given?
+        @output << "#@indent<#{name}>\n"
+        @indent = @initial_indent + @indent_unit * (@indent_level += 1)
+        yield
+        @indent = @initial_indent + @indent_unit * (@indent_level -= 1)
+        @output << "#@indent</#{name}>\n"
+      else
+        @output << "#@indent<#{name}>#{contents}</#{name}>\n"
+      end
+    end
+
+    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|
+        TABLE_FOR_ESCAPE[c]
+      end
+    end
+  end
+end

data/lib/property-list/xml_parser.rb

@@ -0,0 +1,121 @@
+module PropertyList
+  def self.load_xml xml
+    XmlParser.new(xml).parse
+  end
+
+  class XmlParser
+    def initialize src
+      @lexer = StringScanner.new src
+    end
+
+    def skip_space_and_comments
+      @lexer.skip(%r{(?:
+        [\x0A\x0D\u2028\u2029\x09\x0B\x0C\x20]+ # newline and space
+        |
+        <!--(?:.*?)-->
+      )+}mx)
+    end
+
+    def parse
+      @lexer.skip(/<\?xml\s+.*?\?>*/m)
+      # TODO xml_encoding = xml_declaration.match(/(?:\A|\s)encoding=(?:"(.*?)"|'(.*?)')(?:\s|\Z)/)
+
+      skip_space_and_comments
+      # TODO doctype should co-exist with xml
+      @lexer.skip(/\s*<!DOCTYPE\s+.*?>/m)
+      skip_space_and_comments
+
+      if @lexer.scan(/<plist\s*\b[^\/\>]*\/>/)
+        skip_space_and_comments
+        if !@lexer.eos?
+          syntax_error "unrecognized code after plist tag end"
+        end
+        return
+      end
+
+      plist_open = !!@lexer.scan(/<plist\s*\b.*?(?<!\/)>/m)
+
+      res = parse_object
+
+      skip_space_and_comments
+      plist_close = !!@lexer.scan(/<\/plist\s*>/m)
+      skip_space_and_comments
+      if !@lexer.eos?
+        syntax_error "unrecognized code after plist tag end"
+      end
+
+      if plist_open ^ plist_close
+        syntax_error "mismatched <plist> tag"
+      end
+
+      res
+    end
+
+    # pushes obj into stack
+    def parse_object
+      skip_space_and_comments
+      if e = @lexer.scan(/<(true|false|array|dict|data)\s*\/>/m)
+        case e[/\w+/]
+        when 'true'; true
+        when 'false'; false
+        when 'array'; []
+        when 'dict'; {}
+        else; '' # data
+        end
+
+      elsif e = @lexer.scan(/<(integer|real|string|date|data)\s*>[^<>]*<\/\1\s*>/m)
+        tag = e[/\w+/]
+        content = tag_content e
+
+        case tag
+        when 'integer'
+          content.to_i
+        when 'real'
+          content.to_f
+        when 'string'
+          CGI.unescape_html content
+        when 'date'
+          DateTime.parse content
+        else # data
+          StringIO.new Base64.decode64 content
+        end
+
+      elsif e = @lexer.scan(/<array\s*>/m)
+        res = []
+        until (skip_space_and_comments; @lexer.scan(/<\/array\s*>/m))
+          e = parse_object
+          syntax_error 'failed to parse array element' if e.nil?
+          res << e
+        end
+        res
+
+      elsif e = @lexer.scan(/<dict\s*>/)
+        res = {}
+        until (skip_space_and_comments; @lexer.scan(/<\/dict\s*>/m))
+          key_tag = @lexer.scan(/<key\s*>[^<>]*<\/key\s*>/m)
+          syntax_error 'failed to parse dict key' if !key_tag
+
+          key = CGI.unescape_html tag_content key_tag
+          value = parse_object
+          syntax_error 'failed to parse dict value' if value.nil?
+          res[key] = value
+        end
+        res
+
+      else
+        nil
+      end
+    end
+
+    def tag_content e
+      e[(e.index('>') + 1)...(e.rindex '<')]
+    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

data/property-list.gemspec

@@ -0,0 +1,22 @@
+require_relative 'lib/property-list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "property-list"
+  spec.version       = PropertyList::VERSION
+  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.homepage      = "https://github.com/luikore/property-list"
+  spec.license       = "BSD-3-Clause"
+
+  spec.files = `git ls-files -z`.split("\x0").grep_v %r{^(test|spec|features)/}
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 1.2"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "simplecov", "~> 0.14"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: property-list
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Luikore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email: no@email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- Rakefile
+- gems.locked
+- gems.rb
+- lib/property-list.rb
+- lib/property-list/ascii_generator.rb
+- lib/property-list/ascii_parser.rb
+- lib/property-list/binary_generator.rb
+- lib/property-list/binary_markers.rb
+- lib/property-list/binary_parser.rb
+- lib/property-list/version.rb
+- lib/property-list/xml_generator.rb
+- lib/property-list/xml_parser.rb
+- property-list.gemspec
+homepage: https://github.com/luikore/property-list
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Property List (plist) library with all formats support
+test_files: []