nanaimo 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 090d05915f386fcbf6f5324805f7bd16f873678e
-  data.tar.gz: baa8d42469bd66dc1f7b0a6eae353698d6fe99e3
+SHA256:
+  metadata.gz: d44e0a3c7b1780d4f3599d2e8c215577fd518a95a8a581c9f322e0b607127df2
+  data.tar.gz: 3610b29faf500e0a9489a5f3e6fda8d6f3d0da4fa38eba6c28c66cd34521c221
 SHA512:
-  metadata.gz: 2833cad61d387df8c5ac6e45118d109333484c0555a307ac566cd0d6bd50925ae5a5003191645e96d523f0d9d6e171aca7a7f3891a95f42f3119b516d77ac081
-  data.tar.gz: 7faf48d2d57caa6076f13f8d10c1b1dbac3895f7a54d2e217609574fa48316dde4f12a6e2f1054741e3982ad0a4489b0aaca5767165f53d848921663f8e3db21
+  metadata.gz: f1bc93d5f8536a491ccbb93f6f22571e11201d08d8db3116c73c4707bfc54945ca65ad4f30fe09eb04ef700a9ac55b91779aff5f7bfefc9efdb88847d86874e7
+  data.tar.gz: e637b3f427c8507ff47f92ecea660416673fa7f5d5243b0a6f992cb7ac2133427041d96fe52f0a95ce11a0429fc8dc566f3e1af653166867dfd552622ebb229e

data/.rubocop.yml

@@ -2,6 +2,7 @@ inherit_from:
   - .rubocop_todo.yml
 
 AllCops:
+  TargetRubyVersion: 2.1
   Exclude:
     - 'lib/nanaimo/unicode/**/*.rb'
     - 'vendor/**/*'

data/.rubocop_todo.yml

@@ -1,7 +1,104 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-10-15 01:47:18 -0500 using RuboCop version 0.43.0.
+# on 2018-02-13 09:45:35 -0800 using RuboCop version 0.52.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 22
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Layout/IndentHeredoc:
+  Exclude:
+    - 'Rakefile'
+    - 'lib/nanaimo/writer/xml.rb'
+    - 'spec/nanaimo/reader_spec.rb'
+    - 'spec/nanaimo/writer/xml_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: Blacklist.
+# Blacklist: END, (?-mix:EO[A-Z]{1})
+Naming/HeredocDelimiterNaming:
+  Exclude:
+    - 'lib/nanaimo/writer/xml.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Performance/RegexpMatch:
+  Exclude:
+    - 'lib/nanaimo/unicode.rb'
+    - 'lib/nanaimo/writer.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: compact, expanded
+Style/EmptyMethod:
+  Exclude:
+    - 'lib/nanaimo/writer/xml.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'nanaimo.gemspec'
+
+# Offense count: 2
+# Configuration parameters: .
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+# Offense count: 2
+Style/IdenticalConditionalBranches:
+  Exclude:
+    - 'lib/nanaimo/unicode.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/nanaimo/reader.rb'
+    - 'lib/nanaimo/unicode.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/nanaimo/writer.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'lib/nanaimo/reader.rb'
+    - 'lib/nanaimo/unicode.rb'
+    - 'spec/nanaimo/reader_spec.rb'
+    - 'spec/nanaimo/unicode_spec.rb'
+    - 'spec/nanaimo/writer/xml_spec.rb'
+    - 'spec/nanaimo/writer_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantFreeze:
+  Exclude:
+    - 'lib/nanaimo/reader.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Offense count: 56
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 331

data/.travis.yml

@@ -1,3 +1,5 @@
+dist: trusty
+bundler_args: --without debugging documentation
 branches:
   only:
     - master
@@ -6,8 +8,11 @@ language: ruby
 cache: bundler
 rvm:
   # The latest ruby version
-  - 2.3.1
+  - 2.7.0
+  - 2.6.2
+  - 2.5.0
+  - 2.4.2
   # OS X 10.9.5-10.10.0 (2.0.0-p481)
   - 2.0.0-p481
-  # OS X 10.9.3-10.9.4
-  - 2.0.0-p451
+before_install:
+  - gem install bundler -v "~> 1.17"

data/CHANGELOG.md

@@ -1,5 +1,67 @@
 # Nanaimo Changelog
 
+## 0.3.0 (2020-07-17)
+
+##### Enhancements
+
+* None.  
+
+##### Bug Fixes
+
+* None.  
+
+
+## 0.2.6 (2018-07-01)
+
+##### Enhancements
+
+* None.  
+
+##### Bug Fixes
+
+* Fix parse errors crashing when attempting to show context when the error
+  occurs on the first character in the plist.  
+  [Samuel Giddins](https://github.com/segiddins)
+
+
+## 0.2.5 (2018-04-04)
+
+##### Enhancements
+
+* None.  
+
+##### Bug Fixes
+
+* Fix parsing arrays that contain a comment after a trailing comma.  
+  [Samuel Giddins](https://github.com/segiddins)
+  [#26](https://github.com/CocoaPods/Nanaimo/issues/26)
+
+
+## 0.2.4 (2018-03-22)
+
+##### Enhancements
+
+* Enable frozen string literals to improve performance.  
+  [Samuel Giddins](https://github.com/segiddins)
+
+##### Bug Fixes
+
+* None.  
+
+
+## 0.2.3 (2016-11-30)
+
+##### Enhancements
+
+* None.  
+
+##### Bug Fixes
+
+* Quote the empty string `nil` is implicitly written as in non-strict mode.  
+  [Samuel Giddins](https://github.com/segiddins)
+  [Xcodeproj#453](https://github.com/CocoaPods/Xcodeproj/issues/453)
+
+
 ## 0.2.2 (2016-11-04)
 
 ##### Enhancements

data/Gemfile

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in nanaimo.gemspec
 gemspec
 
 group :development do
-  gem 'rubocop'
+  gem 'rake', '~> 12.0'
+  gem 'rspec'
+  gem 'rubocop', install_if: RUBY_VERSION >= '2.1'
 end

data/Gemfile.lock

@@ -1,39 +1,41 @@
 PATH
   remote: .
   specs:
-    nanaimo (0.2.2)
+    nanaimo (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.3.0)
-    diff-lcs (1.2.5)
-    parser (2.3.1.4)
-      ast (~> 2.2)
+    ast (2.4.0)
+    diff-lcs (1.3)
+    parallel (1.12.1)
+    parser (2.5.0.2)
+      ast (~> 2.4.0)
     powerpack (0.1.1)
-    rainbow (2.1.0)
-    rake (10.5.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    rubocop (0.43.0)
-      parser (>= 2.3.1.1, < 3.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    unicode-display_width (1.1.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
@@ -41,9 +43,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.12)
   nanaimo!
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake (~> 12.0)
+  rspec
   rubocop
 
 BUNDLED WITH
-   1.13.5
+   1.17.3

data/README.md

@@ -47,7 +47,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nanaimo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/CocoaPods/nanaimo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/Rakefile

@@ -1,11 +1,17 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new
 
-task default: [:spec, :rubocop]
+task default: [:spec]
+
+if RUBY_VERSION >= '2.1'
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+  task default: :rubocop
+end
 
 task :generate_nextstep_mappings do
   require 'net/http'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'nanaimo'

data/lib/nanaimo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nanaimo/version'
 
 # A native Ruby implementation of ASCII plist parsing and serialization.

data/lib/nanaimo/object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nanaimo
   # An object that belongs to a plist.
   #
@@ -73,7 +75,7 @@ module Nanaimo
   #
   class Data < Object
     def initialize(value, annotation)
-      value &&= value.force_encoding(Encoding::BINARY)
+      value &&= value.dup.force_encoding(Encoding::BINARY)
       super(value, annotation)
     end
 

data/lib/nanaimo/plist.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nanaimo
   # A Plist.
   #

data/lib/nanaimo/reader.rb

@@ -1,4 +1,5 @@
 # frozen-string-literal: true
+
 module Nanaimo
   # Transforms plist strings into Plist objects.
   #
@@ -123,8 +124,8 @@ module Nanaimo
       # TODO
     end
 
-    def parse_object
-      _comment = skip_to_non_space_matching_annotations
+    def parse_object(already_parsed_comment: false)
+      _comment = skip_to_non_space_matching_annotations unless already_parsed_comment
       start_pos = @scanner.pos
       raise_parser_error ParseError, 'Unexpected end of string while parsing' if @scanner.eos?
       if @scanner.skip(/\{/)
@@ -162,10 +163,10 @@ module Nanaimo
     def parse_array
       objects = []
       until @scanner.eos?
-        eat_whitespace!
+        _comment = skip_to_non_space_matching_annotations
         break if @scanner.skip(/\)/)
 
-        objects << parse_object
+        objects << parse_object(already_parsed_comment: true)
 
         eat_whitespace!
         break if @scanner.skip(/\)/)
@@ -180,10 +181,10 @@ module Nanaimo
     def parse_dictionary
       objects = {}
       until @scanner.eos?
-        skip_to_non_space_matching_annotations
+        _comment = skip_to_non_space_matching_annotations
         break if @scanner.skip(/}/)
 
-        key = parse_object
+        key = parse_object(already_parsed_comment: true)
         eat_whitespace!
         unless @scanner.skip(/=/)
           raise_parser_error ParseError, "Dictionary missing value for key #{key.as_ruby.inspect}, expected '=' and found #{current_character.inspect}"
@@ -262,8 +263,6 @@ module Nanaimo
           next
         end
 
-        eat_whitespace!
-
         break
       end
       annotation
@@ -273,6 +272,7 @@ module Nanaimo
       pos = scanner.charpos
       line = scanner.string[0..scanner.charpos].scan(NEWLINE).size + 1
       column = pos - (scanner.string.rindex(NEWLINE, pos - 1) || -1)
+      column = [1, column].max
       [line, column]
     end
 

data/lib/nanaimo/unicode.rb

@@ -1,4 +1,5 @@
 # frozen-string-literal: true
+
 require 'nanaimo/unicode/next_step_mapping'
 require 'nanaimo/unicode/quote_maps'
 module Nanaimo
@@ -11,7 +12,7 @@ module Nanaimo
     module_function
 
     def quotify_string(string)
-      string.gsub(QUOTE_REGEXP) { |s| QUOTE_MAP[s] }
+      string.gsub(QUOTE_REGEXP, QUOTE_MAP)
     end
 
     ESCAPE_PREFIXES = %W(
@@ -82,7 +83,7 @@ module Nanaimo
     XML_STRING_ESCAPE_REGEXP = Regexp.union(XML_STRING_ESCAPES.keys)
 
     def xml_escape_string(string)
-      string.to_s.gsub(XML_STRING_ESCAPE_REGEXP) { |m| XML_STRING_ESCAPES[m] }
+      string.to_s.gsub(XML_STRING_ESCAPE_REGEXP, XML_STRING_ESCAPES)
     end
   end
 end

data/lib/nanaimo/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nanaimo
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/nanaimo/writer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nanaimo
   # Transforms native ruby objects or Plist objects into their ASCII Plist
   # string representation.
@@ -25,7 +27,7 @@ module Nanaimo
     #
     UTF8 = "// !$*UTF8*$!\n".freeze
 
-    # @param plist [Plist,String,Hash,Array] The plist obejct to write
+    # @param plist [Plist,String,Hash,Array] The plist object 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
@@ -74,7 +76,7 @@ module Nanaimo
         write_array(object)
       when Dictionary, ::Hash
         write_dictionary(object)
-      when QUOTED_STRING_REGEXP, QuotedString, ''
+      when QUOTED_STRING_REGEXP, QuotedString
         write_quoted_string(object)
       when String, ::String, Symbol
         write_string(object)
@@ -88,7 +90,7 @@ module Nanaimo
       output
     end
 
-    QUOTED_STRING_REGEXP = %r{[^\w\./]}
+    QUOTED_STRING_REGEXP = %r{\A\z|[^\w\./]|\A___}
     private_constant :QUOTED_STRING_REGEXP
 
     def write_string_quoted_if_necessary(object)

data/lib/nanaimo/writer/pbxproj.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nanaimo
   class Writer
     # Transforms native ruby objects or Plist objects into their ASCII Plist
@@ -7,8 +9,8 @@ module Nanaimo
       ISA = String.new('isa', '')
       private_constant :ISA
 
-      def initialize(*)
-        super
+      def initialize(plist, **args)
+        super(plist, **args)
         @objects_section = false
       end
 
@@ -26,7 +28,7 @@ module Nanaimo
           write_newline
           output << "/* Begin #{isa} section */"
           write_newline
-          sort_dictionary(kvs).each do |k, v|
+          sort_dictionary(kvs, key_can_be_isa: false).each do |k, v|
             write_dictionary_key_value_pair(k, v)
           end
           output << "/* End #{isa} section */"
@@ -38,31 +40,34 @@ module Nanaimo
       end
 
       def write_dictionary_key_value_pair(k, v)
-        @objects_section = true if value_for(k) == 'objects'
+        # since the objects section is always at the top-level,
+        # we can avoid checking if we're starting the 'objects'
+        # section if we're further "indented" (aka deeper) in the project
+        @objects_section = true if indent == 1 && value_for(k) == 'objects'
+
         super
       end
 
-      def sort_dictionary(dictionary)
+      def sort_dictionary(dictionary, key_can_be_isa: true)
         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
+        hash.sort_by do |k, _v|
+          k = value_for(k)
+          if key_can_be_isa
+            k == 'isa' ? '' : k
+          else
+            k
+          end
         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)
+        if isa = dictionary['isa']
+          value_for(isa)
+        elsif isa = dictionary[ISA]
+          value_for(isa)
+        end
       end
 
       def flat_dictionary?(dictionary)

data/lib/nanaimo/writer/xml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nanaimo
   class Writer
     # Transforms native ruby objects or Plist objects into their XML Plist

data/nanaimo.gemspec

@@ -1,4 +1,6 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'nanaimo/version'
@@ -19,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nanaimo
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Danielle Tomlinson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-04 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -106,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A library for (de)serialization of ASCII Plists.