nanaimo 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 037701ffb338db5f3836b57e4537fd589c8dccff
-  data.tar.gz: ab581715b5317779e1873d7840c85d8b485eb56d
+  metadata.gz: 14c576818f92d08020d63bfcc8d90840f37ec30d
+  data.tar.gz: bca04f1ce7e922722502091d131a6000285352cc
 SHA512:
-  metadata.gz: 031ff566d32a070b3dcace79926ba7cbb9efb214f20a733fc753d591ed668e35289f72b9c85197d0ccac77237543073669d8b8564c5f939aca1d3b85929cfd6a
-  data.tar.gz: 95e44f16c8b0724e16096f364d591762082c9aec7521a5c379cb6a69807031b08c88ee1b45ea8c04f0baf2669afd321af2a1e1b27b890a3954c21efd442b8f1b
+  metadata.gz: e45beaaddb84a3ec4b076f95429fd2ae3040d48ea1b2d066e31990af2121cc0575faeddb1972d124c8a66bc08444547eb0f36dc87da53f32165d41fe34e60877
+  data.tar.gz: 1600ba9301952b7aac138af098c7caba4157609e8715e8189d167827682f6546f39e7d2ee105f87b0aaf7e4dd9c4f748d4e0abbb2a56e7f2f94d37c582298912

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Nanaimo Changelog
 
+## 0.2.0 (2016-11-02)
+
+##### Enhancements
+
+* Add context to parse errors.  
+  [Samuel Giddins](https://github.com/segiddins)
+  [#5](https://github.com/CocoaPods/Nanaimo/issues/5)
+
+* Allow disabling 'strict' mode when writing plists, allowing unknown object
+  types to be serialized as their string representations.  
+  [Samuel Giddins](https://github.com/segiddins)
+
+##### Bug Fixes
+
+* None.  
+
+
 ## 0.1.4 (2016-11-01)
 
 ##### Enhancements

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nanaimo (0.1.4)
+    nanaimo (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/nanaimo.rb

@@ -17,5 +17,4 @@ module Nanaimo
   require 'nanaimo/reader'
   require 'nanaimo/unicode'
   require 'nanaimo/writer'
-  require 'nanaimo/xcode_project_writer'
 end

data/lib/nanaimo/reader.rb

@@ -32,6 +32,32 @@ module Nanaimo
       # @return [String] The contents of the plist.
       #
       attr_accessor :plist_string
+
+      def to_s
+        "[!] #{super}#{context}"
+      end
+
+      def context(n = 2)
+        line_number, column = location
+        line_number -= 1
+        lines = plist_string.split(NEWLINE)
+
+        s = line_number.succ.to_s.size
+        indent     = "#{' ' * s}#  "
+        indicator  = "#{line_number.succ}>  "
+
+        m =  ::String.new("\n")
+        m << "#{indent}-------------------------------------------\n"
+        m << lines[[line_number - n, 0].max...line_number].map do |l|
+          "#{indent}#{l}\n"
+        end.join
+        m << "#{indicator}#{lines[line_number]}\n"
+        m << ' ' * (column + s + 2) << "^\n"
+        m << Array(lines[line_number.succ..[lines.count.pred, line_number + n].min]).map do |l|
+          l.strip.empty? ? '' : "#{indent}#{l}\n"
+        end.join
+        m << "#{indent}-------------------------------------------\n"
+      end
     end
 
     # @param plist_contents [String]
@@ -73,7 +99,7 @@ module Nanaimo
       root_object = parse_object
 
       eat_whitespace!
-      raise_parser_error ParseError, "unrecognized characters #{@scanner.rest.inspect} after parsing" unless @scanner.eos?
+      raise_parser_error ParseError, 'Found additional characters after parsing the root plist object' unless @scanner.eos?
 
       Nanaimo::Plist.new(root_object, plist_format)
     end
@@ -93,7 +119,7 @@ module Nanaimo
     def parse_object
       _comment = skip_to_non_space_matching_annotations
       start_pos = @scanner.pos
-      raise_parser_error ParseError, 'Unexpected eos while parsing' if @scanner.eos?
+      raise_parser_error ParseError, 'Unexpected end of string while parsing' if @scanner.eos?
       if @scanner.skip(/\{/)
         parse_dictionary
       elsif @scanner.skip(/\(/)
@@ -112,15 +138,15 @@ module Nanaimo
 
     def parse_string
       eat_whitespace!
-      unless match = @scanner.scan(%r{[\w/.$-]+}o)
-        raise_parser_error ParseError, "not a valid string at index #{@scanner.pos} (char is #{current_character.inspect})"
+      unless match = @scanner.scan(%r{[\w/.$]+})
+        raise_parser_error ParseError, "Invalid character #{current_character.inspect} in unquoted string"
       end
       Nanaimo::String.new(match, nil)
     end
 
     def parse_quotedstring(quote)
       unless string = @scanner.scan(/(?:([^#{quote}\\]|\\.)*)#{quote}/)
-        raise_parser_error ParseError, "unterminated quoted string started at #{@scanner.pos}, expected #{quote} but never found it"
+        raise_parser_error ParseError, "Unterminated quoted string, expected #{quote} but never found it"
       end
       string = Unicode.unquotify_string(string.chomp!(quote))
       Nanaimo::QuotedString.new(string, nil)
@@ -137,7 +163,7 @@ module Nanaimo
         eat_whitespace!
         break if @scanner.skip(/\)/)
         unless @scanner.skip(/,/)
-          raise_parser_error ParseError, "Array #{objects} missing ',' in between objects"
+          raise_parser_error ParseError, "Array missing ',' in between objects"
         end
       end
 
@@ -153,7 +179,7 @@ module Nanaimo
         key = parse_object
         eat_whitespace!
         unless @scanner.skip(/=/)
-          raise_parser_error ParseError, "Dictionary missing value after key #{key.inspect} at index #{@scanner.pos}, expected '=' and got #{current_character.inspect}"
+          raise_parser_error ParseError, "Dictionary missing value for key #{key.as_ruby.inspect}, expected '=' and found #{current_character.inspect}"
         end
 
         value = parse_object
@@ -162,7 +188,7 @@ module Nanaimo
         eat_whitespace!
         break if @scanner.skip(/}/)
         unless @scanner.skip(/;/)
-          raise_parser_error ParseError, "Dictionary (#{objects}) missing ';' after key-value pair (#{key} = #{value}) at index #{@scanner.pos} (got #{current_character})"
+          raise_parser_error ParseError, "Dictionary missing ';' after key-value pair for #{key.as_ruby.inspect}, found #{current_character.inspect}"
         end
       end
 
@@ -189,7 +215,7 @@ module Nanaimo
 
     def read_singleline_comment
       unless comment = @scanner.scan_until(NEWLINE)
-        raise_parser_error ParseError, "failed to terminate single line comment #{@scanner.rest.inspect}"
+        raise_parser_error ParseError, 'Failed to terminate single line comment'
       end
       comment
     end
@@ -208,7 +234,7 @@ module Nanaimo
 
     def read_multiline_comment
       unless annotation = @scanner.scan(%r{(?:.+?)(?=\*/)}m)
-        raise_parser_error ParseError, "#{@scanner.rest.inspect} failed to terminate multiline comment"
+        raise_parser_error ParseError, 'Failed to terminate multiline comment'
       end
       @scanner.skip(%r{\*/})
 

data/lib/nanaimo/version.rb

@@ -1,3 +1,3 @@
 module Nanaimo
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/nanaimo/writer.rb

@@ -3,8 +3,24 @@ module Nanaimo
   # string representation.
   #
   class Writer
+    autoload :PBXProjWriter, 'nanaimo/writer/pbxproj'
     autoload :XMLWriter, 'nanaimo/writer/xml'
 
+    # Raised when attempting to write a plist containing an object of an
+    # unsupported type.
+    #
+    class UnsupportedPlistTypeError < Error
+      def initialize(plist_format, object)
+        @plist_format = plist_format
+        @object = object
+      end
+
+      def to_s
+        "Unable to write #{@object.inspect}. " \
+          "`#{@object.class}` is an invalid object type to serialize in a #{@plist_format} plist."
+      end
+    end
+
     # The magic comment that denotes a UTF8-encoded plist.
     #
     UTF8 = "// !$*UTF8*$!\n".freeze
@@ -14,12 +30,13 @@ module Nanaimo
     #                         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)
+    def initialize(plist, pretty: true, output: ::String.new, strict: true)
       @plist = plist
       @pretty = pretty
       @output = output
       @indent = 0
       @newlines = true
+      @strict = strict
     end
 
     # Writes the plist to the given output.
@@ -30,11 +47,15 @@ module Nanaimo
       write_newline
     end
 
-    attr_reader :indent, :pretty, :output, :newlines
-    private :indent, :pretty, :output, :newlines
+    attr_reader :indent, :pretty, :output, :newlines, :strict
+    private :indent, :pretty, :output, :newlines, :strict
 
     private
 
+    def plist_format
+      :ascii
+    end
+
     def write_utf8
       output << UTF8
     end
@@ -53,19 +74,28 @@ module Nanaimo
         write_array(object)
       when Dictionary, ::Hash
         write_dictionary(object)
-      when %r{[^\w\./]}, QuotedString, ''
+      when QUOTED_STRING_REGEXP, 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"
+        raise UnsupportedPlistTypeError.new(plist_format, object) if strict
+        write_string_quoted_if_necessary(object)
       end
       write_annotation(object) if pretty
       output
     end
 
+    QUOTED_STRING_REGEXP = %r{[^\w\./]}
+    private_constant :QUOTED_STRING_REGEXP
+
+    def write_string_quoted_if_necessary(object)
+      string = object.to_s
+      string =~ QUOTED_STRING_REGEXP ? write_quoted_string(string) : write_string(string)
+    end
+
     def write_string(object)
       output << value_for(object).to_s
     end

data/lib/nanaimo/writer/pbxproj.rb

@@ -0,0 +1,78 @@
+module Nanaimo
+  class Writer
+    # Transforms native ruby objects or Plist objects into their ASCII Plist
+    # string representation, formatted as Xcode writes Xcode projects.
+    #
+    class PBXProjWriter < 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
+end

data/lib/nanaimo/writer/xml.rb

@@ -17,6 +17,10 @@ module Nanaimo
 
       private
 
+      def plist_format
+        :xml
+      end
+
       def write_object(object)
         case object
         when Float, Integer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nanaimo
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Danielle Tomlinson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-01 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,8 +84,8 @@ files:
 - lib/nanaimo/unicode/quote_maps.rb
 - lib/nanaimo/version.rb
 - lib/nanaimo/writer.rb
+- lib/nanaimo/writer/pbxproj.rb
 - lib/nanaimo/writer/xml.rb
-- lib/nanaimo/xcode_project_writer.rb
 - nanaimo.gemspec
 homepage: https://github.com/CocoaPods/Nanaimo
 licenses:

data/lib/nanaimo/xcode_project_writer.rb

@@ -1,76 +0,0 @@
-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