nanaimo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbb3b9ff9683a0feb685639f1eff5091040b384d
+  data.tar.gz: 66bbab5c9d4685f5617984bef6a2a9cc4698f4c4
+SHA512:
+  metadata.gz: b10a6d849f8705545701a326b3613063e4d8dd50ade13abd7a79bb2932ff4565385c45bdca54cf1dc165c322e77e00f788cf54cd92aa3a4373f4c8736a45e116
+  data.tar.gz: f55afc7cbac079879f1e5c98078e90875da358b7ea6edc95f584f5608939bf5820750714636b9f42dec030e23ad4a7c1b2a4f059d1f755963780fe6c97e8c0c0

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_from:
+  - .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'lib/nanaimo/unicode/**/*.rb'
+    - 'vendor/**/*'
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Metrics:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-10-15 01:47:18 -0500 using RuboCop version 0.43.0.
+# 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.

data/.travis.yml

@@ -0,0 +1,13 @@
+branches:
+  only:
+    - master
+
+language: ruby
+cache: bundler
+rvm:
+  # The latest ruby version
+  - 2.3.1
+  # 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

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Nanaimo Changelog
+
+## 0.1.0 (2016-10-21)
+
+##### Enhancements
+
+* Initial implementation.  
+  [Samuel Giddins](https://github.com/segiddins)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at dan@tomlinson.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nanaimo.gemspec
+gemspec
+
+group :development do
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    nanaimo (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.2.5)
+    parser (2.3.1.4)
+      ast (~> 2.2)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      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)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    unicode-display_width (1.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  nanaimo!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   1.13.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Danielle Tomlinson, Samuel Giddins
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Nanaimo
+
+Nanaimo is a simple library that implements ASCII Plist serialization and
+deserialization, entirely with native Ruby code (and zero dependencies). It
+also comes with out-of-the-box support for serializing Xcode projects (complete
+with annotations) and XML plists.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nanaimo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nanaimo
+
+## Usage
+
+```ruby
+require 'nanaimo'
+
+# parse a native ruby object from an ascii plist file
+project_hash = Nanaimo::Reader
+  .from_file("App.xcodeproj/project.pbxproj")
+  .parse!
+  .as_ruby
+
+# change that object
+project_hash['...'] = '...'
+
+# re-serialize it
+ascii_plist_string = Nanaimo::Writer.new(project_hash).write
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,72 @@
+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 :generate_nextstep_mappings do
+  require 'net/http'
+  url = 'http://ftp.unicode.org/Public/MAPPINGS/VENDORS/NEXT/NEXTSTEP.TXT'
+  mappings = Net::HTTP.get(URI(url))
+                      .lines
+                      .grep(/^[^#$]/)
+                      .map { |l| l.split("\t", 3) }
+                      .reduce('') do |f, (ns, uc, cm)|
+    f << "      #{ns} => #{uc}, #{cm}"
+  end
+  map = <<-RUBY
+# frozen-string-literal: true
+module Nanaimo
+  module Unicode
+    # Taken from #{url}
+    NEXT_STEP_MAPPING = {
+#{mappings}    }.freeze
+  end
+end
+  RUBY
+  File.open('lib/nanaimo/unicode/next_step_mapping.rb', 'w') { |f| f << map }
+end
+
+task :generate_quote_maps do
+  quote_map = {
+    "\a" => '\\a',
+    "\b" => '\\b',
+    "\f" => '\\f',
+    "\r" => '\\r',
+    "\t" => '\\t',
+    "\v" => '\\v',
+    "\n" => '\\n',
+    %(') => "\\'",
+    %(") => '\\"'
+  }
+
+  unquote_map = quote_map.each_with_object("\n" => "\n") do |(value, escaped), map|
+    map[escaped[1..-1]] = value
+    map
+  end
+
+  0.upto(31) { |i| quote_map[[i].pack('U')] ||= format('\\U%04x', i) }
+  quote_regexp = Regexp.union(quote_map.keys)
+
+  dump_hash = proc do |hash, indent = 4|
+    hash.reduce("{\n") { |dumped, (k, v)| dumped << "#{' ' * (indent + 2)}#{k.dump} => #{v.dump},\n" } << ' ' * indent << '}.freeze'
+  end
+
+  map = <<-RUBY
+# frozen-string-literal: true
+module Nanaimo
+  module Unicode
+    QUOTE_MAP = #{dump_hash[quote_map]}
+
+    UNQUOTE_MAP = #{dump_hash[unquote_map]}
+
+    QUOTE_REGEXP = #{quote_regexp.inspect}
+  end
+end
+  RUBY
+
+  File.open('lib/nanaimo/unicode/quote_maps.rb', 'w') { |f| f << map }
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'nanaimo'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nanaimo.rb

@@ -0,0 +1,21 @@
+require 'nanaimo/version'
+
+# A native Ruby implementation of ASCII plist parsing and serialization.
+#
+module Nanaimo
+  class Error < StandardError; end
+
+  DEBUG = !ENV['NANAIMO_DEBUG'].nil?
+  private_constant :DEBUG
+  def self.debug
+    return unless DEBUG
+    warn yield
+  end
+
+  require 'nanaimo/object'
+  require 'nanaimo/plist'
+  require 'nanaimo/reader'
+  require 'nanaimo/unicode'
+  require 'nanaimo/writer'
+  require 'nanaimo/xcode_project_writer'
+end

data/lib/nanaimo/object.rb

@@ -0,0 +1,100 @@
+module Nanaimo
+  # An object that belongs to a plist.
+  #
+  class Object
+    # @return The underlying native Ruby value
+    #
+    attr_accessor :value
+
+    # @return [String] The annotation comment
+    #
+    attr_accessor :annotation
+
+    def initialize(value, annotation)
+      self.value = value
+      self.annotation = annotation
+
+      raise 'Item cannot be initialize with a nil value' if value.nil?
+    end
+
+    def ==(other)
+      return unless other
+      if other.is_a?(self.class)
+        other.value == value && annotation == other.annotation
+      elsif other.is_a?(value.class)
+        other == value
+      end
+    end
+    alias eql? ==
+
+    def hash
+      value.hash
+    end
+
+    def <=>(other)
+      other_value = if other.is_a?(Object)
+                      other.value
+                    elsif other.is_a?(value.class)
+                      other
+                    end
+      return unless other_value
+
+      value <=> other_value
+    end
+
+    def to_s
+      format('<%s %s>', self.class, value)
+    end
+
+    # @return A native Ruby object representation
+    #
+    def as_ruby
+      raise 'unimplemented'
+    end
+  end
+
+  # A string object in a Plist.
+  #
+  class String < Object
+    def as_ruby
+      value
+    end
+  end
+
+  # A string object surrounded by quotes in a Plist.
+  #
+  class QuotedString < Object
+    def as_ruby
+      value
+    end
+  end
+
+  # A data object in a Plist, represented by a binary-encoded string.
+  #
+  class Data < Object
+    def initialize(value, annotation)
+      value &&= value.force_encoding(Encoding::BINARY)
+      super(value, annotation)
+    end
+
+    def as_ruby
+      value
+    end
+  end
+
+  # An array object in a Plist.
+  #
+  class Array < Object
+    def as_ruby
+      value.map(&:as_ruby)
+    end
+  end
+
+  # A dictionary object in a Plist.
+  #
+  class Dictionary < Object
+    def as_ruby
+      Hash[value.map { |k, v| [k.as_ruby, v.as_ruby] }]
+    end
+  end
+end