nanaimo 0.1.0

data/lib/nanaimo/unicode/quote_maps.rb

@@ -0,0 +1,56 @@
+# frozen-string-literal: true
+module Nanaimo
+  module Unicode
+    QUOTE_MAP = {
+      "\a" => "\\a",
+      "\b" => "\\b",
+      "\f" => "\\f",
+      "\r" => "\\r",
+      "\t" => "\\t",
+      "\v" => "\\v",
+      "\n" => "\\n",
+      "'" => "\\'",
+      "\"" => "\\\"",
+      "\x00" => "\\U0000",
+      "\x01" => "\\U0001",
+      "\x02" => "\\U0002",
+      "\x03" => "\\U0003",
+      "\x04" => "\\U0004",
+      "\x05" => "\\U0005",
+      "\x06" => "\\U0006",
+      "\x0E" => "\\U000e",
+      "\x0F" => "\\U000f",
+      "\x10" => "\\U0010",
+      "\x11" => "\\U0011",
+      "\x12" => "\\U0012",
+      "\x13" => "\\U0013",
+      "\x14" => "\\U0014",
+      "\x15" => "\\U0015",
+      "\x16" => "\\U0016",
+      "\x17" => "\\U0017",
+      "\x18" => "\\U0018",
+      "\x19" => "\\U0019",
+      "\x1A" => "\\U001a",
+      "\e" => "\\U001b",
+      "\x1C" => "\\U001c",
+      "\x1D" => "\\U001d",
+      "\x1E" => "\\U001e",
+      "\x1F" => "\\U001f",
+    }.freeze
+
+    UNQUOTE_MAP = {
+      "\n" => "\n",
+      "a" => "\a",
+      "b" => "\b",
+      "f" => "\f",
+      "r" => "\r",
+      "t" => "\t",
+      "v" => "\v",
+      "n" => "\n",
+      "'" => "'",
+      "\"" => "\"",
+    }.freeze
+
+    QUOTE_REGEXP = /\x07|\x08|\f|\r|\t|\v|\n|'|"|\x00|\x01|\x02|\x03|\x04|\x05|\x06|\x0E|\x0F|\x10|\x11|\x12|\x13|\x14|\x15|\x16|\x17|\x18|\x19|\x1A|\x1B|\x1C|\x1D|\x1E|\x1F/
+  end
+end

data/lib/nanaimo/version.rb

@@ -0,0 +1,3 @@
+module Nanaimo
+  VERSION = '0.1.0'.freeze
+end

data/lib/nanaimo/writer.rb

@@ -0,0 +1,174 @@
+module Nanaimo
+  # Transforms native ruby objects or Plist objects into their ASCII Plist
+  # string representation.
+  #
+  class Writer
+    autoload :XMLWriter, 'nanaimo/writer/xml'
+
+    # The magic comment that denotes a UTF8-encoded plist.
+    #
+    UTF8 = "// !$*UTF8*$!\n".freeze
+
+    # @param plist [Plist,String,Hash,Array] The plist obejct to write
+    # @param pretty [Boolean] Whether to serialize annotations and add
+    #                         spaces and newlines to make output more legible
+    # @param output [#<<] The output stream to write the plist to
+    #
+    def initialize(plist, pretty = true, output = ::String.new)
+      @plist = plist
+      @pretty = pretty
+      @output = output
+      @indent = 0
+      @newlines = true
+    end
+
+    # Writes the plist to the given output.
+    #
+    def write
+      write_utf8
+      write_object(@plist.root_object)
+      write_newline
+    end
+
+    attr_reader :indent, :pretty, :output, :newlines
+    private :indent, :pretty, :output, :newlines
+
+    private
+
+    def write_utf8
+      output << UTF8
+    end
+
+    def write_newline
+      output << if newlines
+                  "\n"
+                else
+                  ' '
+                end
+    end
+
+    def write_object(object)
+      case object
+      when Array, ::Array
+        write_array(object)
+      when Dictionary, ::Hash
+        write_dictionary(object)
+      when %r{[^\w\./]}, QuotedString, ''
+        write_quoted_string(object)
+      when String, ::String, Symbol
+        write_string(object)
+      when Data
+        write_data(object)
+      else
+        raise "Cannot write #{object} to an ascii plist"
+      end
+      write_annotation(object) if pretty
+      output
+    end
+
+    def write_string(object)
+      output << value_for(object).to_s
+    end
+
+    def write_quoted_string(object)
+      output << '"' << Unicode.quotify_string(value_for(object)) << '"'
+    end
+
+    def write_data(object)
+      output << '<'
+      value_for(object).unpack('H*').first.chars.each_with_index do |c, i|
+        output << "\n" if i > 0 && (i % 16).zero?
+        output << ' ' if i > 0 && (i % 4).zero?
+        output << c
+      end
+      output << '>'
+    end
+
+    def write_array(object)
+      write_array_start
+      value = value_for(object)
+      value.each do |v|
+        write_array_element(v)
+      end
+      write_array_end
+    end
+
+    def write_array_start
+      output << '('
+      write_newline if newlines
+      push_indent!
+    end
+
+    def write_array_end
+      pop_indent!
+      write_indent
+      output << ')'
+    end
+
+    def write_array_element(object)
+      write_indent
+      write_object(object)
+      output << ','
+      write_newline
+    end
+
+    def write_dictionary(object)
+      write_dictionary_start
+      value = value_for(object)
+      value.each do |key, val|
+        write_dictionary_key_value_pair(key, val)
+      end
+      write_dictionary_end
+    end
+
+    def write_dictionary_start
+      output << '{'
+      write_newline if newlines
+      push_indent!
+    end
+
+    def write_dictionary_end
+      pop_indent!
+      write_indent
+      output << '}'
+    end
+
+    def write_dictionary_key_value_pair(key, value)
+      write_indent
+      write_object(key)
+      output << ' = '
+      write_object(value)
+      output << ';'
+      write_newline
+    end
+
+    def write_annotation(object)
+      return output unless object.is_a?(Nanaimo::Object)
+      annotation = object.annotation
+      return output unless annotation && !annotation.empty?
+      output << " /*#{annotation}*/"
+    end
+
+    def value_for(object)
+      if object.is_a?(Nanaimo::Object)
+        object.value
+      else
+        object
+      end
+    end
+
+    def push_indent!
+      @indent += 1
+    end
+
+    def pop_indent!
+      @indent -= 1
+      @indent = 0 if @indent < 0
+    end
+
+    def write_indent
+      output << "\t" * indent if newlines
+      output
+    end
+  end
+end

data/lib/nanaimo/writer/xml.rb

@@ -0,0 +1,131 @@
+module Nanaimo
+  class Writer
+    # Transforms native ruby objects or Plist objects into their XML Plist
+    # string representation.
+    #
+    class XMLWriter < Writer
+      autoload :Base64, 'base64'
+
+      def write
+        write_xml_header
+        write_object(@plist.root_object)
+        write_newline
+        write_xml_footer
+      end
+
+      private
+
+      def write_object(object)
+        case object
+        when Float, Integer
+          write_number(object)
+        when Time, Date, DateTime
+          write_date(object)
+        when true, false
+          write_boolean(object)
+        else
+          super
+        end
+      end
+
+      def write_xml_header
+        output << <<-EOS
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+        EOS
+      end
+
+      def write_xml_footer
+        output << <<-EOS
+</plist>
+        EOS
+      end
+
+      def write_annotation(_)
+      end
+
+      def write_number(object)
+        type = object.integer? ? 'integer' : 'real'
+        output << "<#{type}>#{object}</#{type}>"
+      end
+
+      def write_boolean(object)
+        output << "<#{object}/>"
+      end
+
+      def write_date(object)
+        output << '<date>' << object.iso8601 << '</date>'
+      end
+
+      def write_string(object)
+        output << '<string>' << Unicode.xml_escape_string(value_for(object)) << '</string>'
+      end
+
+      def write_quoted_string(object)
+        write_string(object)
+      end
+
+      def write_data(object)
+        output << '<data>'
+        data = Base64.encode64(value_for(object)).delete("\n")
+        data = data.scan(/.{1,76}/).join("\n") if pretty
+        output << data << '</data>'
+      end
+
+      def write_array(object)
+        return output << '<array/>' if value_for(object).empty?
+        super
+      end
+
+      def write_array_start
+        output << '<array>'
+        write_newline if newlines
+        push_indent!
+      end
+
+      def write_array_end
+        pop_indent!
+        write_indent
+        output << '</array>'
+      end
+
+      def write_array_element(object)
+        write_indent
+        write_object(object)
+        write_newline
+      end
+
+      def write_dictionary(object)
+        object = value_for(object)
+        return output << '<dict/>' if object.empty?
+        keys = object.keys.sort_by(&:to_s)
+        object = keys.each_with_object({}) do |key, hash|
+          hash[key.to_s] = object[key]
+        end
+        super(object)
+      end
+
+      def write_dictionary_start
+        output << '<dict>'
+        write_newline if newlines
+        push_indent!
+      end
+
+      def write_dictionary_end
+        pop_indent!
+        write_indent
+        output << '</dict>'
+      end
+
+      def write_dictionary_key_value_pair(key, value)
+        write_indent
+        output << '<key>' << Unicode.xml_escape_string(value_for(key)) << '</key>'
+        write_newline
+        write_indent
+        write_object(value)
+        write_newline
+      end
+    end
+  end
+end

data/lib/nanaimo/xcode_project_writer.rb

@@ -0,0 +1,76 @@
+module Nanaimo
+  # Transforms native ruby objects or Plist objects into their ASCII Plist
+  # string representation, formatted as Xcode writes Xcode projects.
+  #
+  class XcodeProjectWriter < Writer
+    ISA = String.new('isa', '')
+    private_constant :ISA
+
+    def initialize(*)
+      super
+      @objects_section = false
+    end
+
+    private
+
+    def write_dictionary(object)
+      n = newlines
+      @newlines = false if flat_dictionary?(object)
+      return super(sort_dictionary(object)) unless @objects_section
+      @objects_section = false
+      write_dictionary_start
+      value = value_for(object)
+      objects_by_isa = value.group_by { |_k, v| isa_for(v) }
+      objects_by_isa.each do |isa, kvs|
+        write_newline
+        output << "/* Begin #{isa} section */"
+        write_newline
+        sort_dictionary(kvs).each do |k, v|
+          write_dictionary_key_value_pair(k, v)
+        end
+        output << "/* End #{isa} section */"
+        write_newline
+      end
+      write_dictionary_end
+    ensure
+      @newlines = n
+    end
+
+    def write_dictionary_key_value_pair(k, v)
+      @objects_section = true if value_for(k) == 'objects'
+      super
+    end
+
+    def sort_dictionary(dictionary)
+      hash = value_for(dictionary)
+      hash.to_a.sort do |(k1, v1), (k2, v2)|
+        v2_isa = isa_for(v2)
+        v1_isa = v2_isa && isa_for(v1)
+        comp = v1_isa <=> v2_isa
+        next comp if !comp.zero? && v1_isa
+
+        key1 = value_for(k1)
+        key2 = value_for(k2)
+        next -1 if key1 == 'isa'
+        next 1 if key2 == 'isa'
+        key1 <=> key2
+      end
+    end
+
+    def isa_for(dictionary)
+      dictionary = value_for(dictionary)
+      return unless dictionary.is_a?(Hash)
+      isa = dictionary.values_at('isa', ISA).map(&method(:value_for)).compact.first
+      isa && value_for(isa)
+    end
+
+    def flat_dictionary?(dictionary)
+      case isa_for(dictionary)
+      when 'PBXBuildFile', 'PBXFileReference'
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/nanaimo.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nanaimo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nanaimo'
+  spec.version       = Nanaimo::VERSION
+  spec.authors       = ['Danielle Tomlinson', 'Samuel Giddins']
+  spec.email         = ['dan@tomlinson.io', 'segiddins@segiddins.me']
+
+  spec.summary       = 'A library for (de)serialization of ASCII Plists.'
+  spec.homepage      = 'https://github.com/CocoaPods/Nanaimo'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end