keyed_archive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20bed81f6f133648cf631d3216523aeddbc14eeb
+  data.tar.gz: 2d7912ef9102f3ece3b77a64fc872ed1207676c2
+SHA512:
+  metadata.gz: 3762da9e73d7512f57c2132b04694a94b8b7b34711253b1b1785b88a5c7835c5d3ea558c32094bb5dde4cc7f68b3ffbd1ea0fb5ff7c20f9cfdc6946f1d292c4d
+  data.tar.gz: e68c08996edb3c3e0932c1c5e842de86dd56e263a95ae73ebeba886dd66aea00ec486b428e6878a875b146aed104f61e2cc8254085f3fa062e43dd6f9f914553

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in keyed_archive.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Paul Young
+
+MIT License
+
+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,102 @@
+# KeyedArchive
+
+A Ruby gem for working with files produced by NSKeyedArchiver.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'keyed_archive'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keyed_archive
+
+## Usage
+
+### Opening a keyed archive
+```xml
+<?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">
+<dict>
+  <key>$version</key>
+  <integer>100000</integer>
+  <key>$objects</key>
+  <array>
+    <string>$null</string>
+  </array>
+  <key>$archiver</key>
+  <string>NSKeyedArchiver</string>
+  <key>$top</key>
+  <dict>
+    <key>root</key>
+    <dict>
+      <key>CF$UID</key>
+      <integer>1</integer>
+    </dict>
+  </dict>
+</dict>
+</plist>
+```
+
+```ruby
+require 'keyed_archive'
+
+filename = "path/to/file.plist"
+keyed_archive = KeyedArchive.new("path/to/file.plist")
+keyed_archive.archiver  # "NSKeyedArchiver"
+keyed_archive.objects   # ["$null"]
+keyed_archive.top       # {"root"=>{"CF$UID"=>1}}
+keyed_archive.version   # 100000
+```
+
+### Unpacking keyed archive objects
+```xml
+<?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">
+<dict>
+  <key>$version</key>
+  <integer>100000</integer>
+  <key>$objects</key>
+  <array>
+    <string>$null</string>
+    <dict>
+      <key>key</key>
+      <string>value</string>
+    </dict>
+  </array>
+  <key>$archiver</key>
+  <string>NSKeyedArchiver</string>
+  <key>$top</key>
+  <dict>
+    <key>root</key>
+    <dict>
+      <key>CF$UID</key>
+      <integer>1</integer>
+    </dict>
+  </dict>
+</dict>
+</plist>
+```
+
+```ruby
+require 'keyed_archive'
+
+keyed_archive = KeyedArchive.new("path/to/file.plist")
+keyed_archive.objects             # ["$null", "value", {"reference"=>{"CF$UID"=>3}}, {"key"=>{"CF$UID"=>1}}]
+keyed_archive.unpacked_objects()  # ["$null", {"key"=>"value"}]
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/keyed_archive/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+task :default => :spec

data/keyed_archive.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keyed_archive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keyed_archive"
+  spec.version       = KeyedArchive::VERSION
+  spec.authors       = ["Paul Young"]
+  spec.email         = ["paulyoungonline@gmail.com"]
+  spec.summary       = %q{A Ruby gem for working with files produced by NSKeyedArchiver.}
+  spec.homepage      = "https://github.com/paulyoung/keyed_archive"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "CFPropertyList", "~> 2.2.7"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+end

data/lib/keyed_archive.rb

@@ -0,0 +1,18 @@
+require 'cfpropertylist'
+
+require "keyed_archive/unpacked_objects"
+require "keyed_archive/version"
+
+class KeyedArchive
+  attr_accessor :archiver, :objects, :top, :version
+
+  def initialize(file)
+    plist = CFPropertyList::List.new(:file => file)
+    data = CFPropertyList.native_types(plist.value)
+
+    @archiver = data['$archiver']
+    @objects = data['$objects']
+    @top = data['$top']
+    @version = data['$version']
+  end
+end

data/lib/keyed_archive/unpacked_objects.rb

@@ -0,0 +1,31 @@
+class KeyedArchive
+  def unpacked_objects
+    objects = @objects.clone
+    unpacked_objects = []
+
+    objects.each_with_index do |object, index|
+      if object.is_a? Hash
+        object.each_pair do |key, value|
+          if value.is_a? Hash
+            uid = value['CF$UID']
+
+            if uid
+              new_object = {}
+              new_object[key] = @objects[uid]
+              objects.push new_object
+              unpacked_objects.delete_at(index - 1)
+            end
+          else
+            new_object = {}
+            new_object[key] = value
+            unpacked_objects.push new_object
+          end
+        end
+      else
+        unpacked_objects.push object
+      end
+    end
+
+    return unpacked_objects
+  end
+end

data/lib/keyed_archive/version.rb

@@ -0,0 +1,3 @@
+class KeyedArchive
+  VERSION = "0.1.0"
+end

data/spec/fixtures/double_object_reference.plist

@@ -0,0 +1,37 @@
+<?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">
+<dict>
+	<key>$version</key>
+	<integer>100000</integer>
+	<key>$objects</key>
+	<array>
+		<string>$null</string>
+		<string>value</string>
+		<dict>
+			<key>reference</key>
+			<dict>
+				<key>CF$UID</key>
+				<integer>3</integer>
+			</dict>
+		</dict>
+		<dict>
+			<key>key</key>
+			<dict>
+				<key>CF$UID</key>
+				<integer>1</integer>
+			</dict>
+		</dict>
+	</array>
+	<key>$archiver</key>
+	<string>NSKeyedArchiver</string>
+	<key>$top</key>
+	<dict>
+		<key>root</key>
+		<dict>
+			<key>CF$UID</key>
+			<integer>1</integer>
+		</dict>
+	</dict>
+</dict>
+</plist>

data/spec/fixtures/double_object_reference_unpacked.plist

@@ -0,0 +1,26 @@
+<?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">
+<dict>
+	<key>$version</key>
+	<integer>100000</integer>
+	<key>$objects</key>
+	<array>
+		<string>$null</string>
+		<dict>
+			<key>key</key>
+			<string>value</string>
+		</dict>
+	</array>
+	<key>$archiver</key>
+	<string>NSKeyedArchiver</string>
+	<key>$top</key>
+	<dict>
+		<key>root</key>
+		<dict>
+			<key>CF$UID</key>
+			<integer>1</integer>
+		</dict>
+	</dict>
+</dict>
+</plist>

data/spec/fixtures/empty.plist

@@ -0,0 +1,22 @@
+<?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">
+<dict>
+	<key>$version</key>
+	<integer>100000</integer>
+	<key>$objects</key>
+	<array>
+		<string>$null</string>
+	</array>
+	<key>$archiver</key>
+	<string>NSKeyedArchiver</string>
+	<key>$top</key>
+	<dict>
+		<key>root</key>
+		<dict>
+			<key>CF$UID</key>
+			<integer>1</integer>
+		</dict>
+	</dict>
+</dict>
+</plist>

data/spec/fixtures/single_object_reference.plist

@@ -0,0 +1,30 @@
+<?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">
+<dict>
+	<key>$version</key>
+	<integer>100000</integer>
+	<key>$objects</key>
+	<array>
+		<string>$null</string>
+		<string>value</string>
+		<dict>
+			<key>key</key>
+			<dict>
+				<key>CF$UID</key>
+				<integer>1</integer>
+			</dict>
+		</dict>
+	</array>
+	<key>$archiver</key>
+	<string>NSKeyedArchiver</string>
+	<key>$top</key>
+	<dict>
+		<key>root</key>
+		<dict>
+			<key>CF$UID</key>
+			<integer>1</integer>
+		</dict>
+	</dict>
+</dict>
+</plist>

data/spec/fixtures/single_object_reference_unpacked.plist

@@ -0,0 +1,26 @@
+<?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">
+<dict>
+	<key>$version</key>
+	<integer>100000</integer>
+	<key>$objects</key>
+	<array>
+		<string>$null</string>
+		<dict>
+			<key>key</key>
+			<string>value</string>
+		</dict>
+	</array>
+	<key>$archiver</key>
+	<string>NSKeyedArchiver</string>
+	<key>$top</key>
+	<dict>
+		<key>root</key>
+		<dict>
+			<key>CF$UID</key>
+			<integer>1</integer>
+		</dict>
+	</dict>
+</dict>
+</plist>

data/spec/keyed_archive_spec.rb

@@ -0,0 +1,30 @@
+require "keyed_archive"
+
+describe KeyedArchive, "#initialize" do
+  let(:filename) { 'spec/fixtures/empty.plist' }
+
+  it "should create an instance" do
+    keyed_archive = KeyedArchive.new(filename)
+    expect(keyed_archive).to be_instance_of(KeyedArchive)
+  end
+
+  it "should set the archiver" do
+    keyed_archive = KeyedArchive.new(filename)
+    expect(keyed_archive.archiver).to be_a(String)
+  end
+
+  it "should set the objects" do
+    keyed_archive = KeyedArchive.new(filename)
+    expect(keyed_archive.objects).to be_an(Array)
+  end
+
+  it "should set the top" do
+    keyed_archive = KeyedArchive.new(filename)
+    expect(keyed_archive.top).to be_a(Hash)
+  end
+
+  it "should set the version" do
+    keyed_archive = KeyedArchive.new(filename)
+    expect(keyed_archive.version).to be_an(Integer)
+  end
+end

data/spec/unpacked_objects_spec.rb

@@ -0,0 +1,27 @@
+require "keyed_archive/unpacked_objects"
+
+shared_examples "unpack" do
+  it "should unpack objects" do
+    keyed_archive = KeyedArchive.new(filename)
+    unpacked_objects = keyed_archive.unpacked_objects()
+    fixture_archive = KeyedArchive.new(fixture)
+    expect(unpacked_objects).to eq(fixture_archive.objects)
+  end
+end
+
+describe KeyedArchive, "#unpack" do
+  context "single reference" do
+    it_behaves_like "unpack" do
+      let(:filename) { "spec/fixtures/single_object_reference.plist" }
+      let(:fixture) { "spec/fixtures/single_object_reference_unpacked.plist" }
+    end
+  end
+
+  context "double reference" do
+    it_behaves_like "unpack" do
+      let(:filename) { "spec/fixtures/double_object_reference.plist" }
+      let(:fixture) { "spec/fixtures/double_object_reference_unpacked.plist" }
+    end
+  end
+end
+

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: keyed_archive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Young
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: CFPropertyList
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: 
+email:
+- paulyoungonline@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- keyed_archive.gemspec
+- lib/keyed_archive.rb
+- lib/keyed_archive/unpacked_objects.rb
+- lib/keyed_archive/version.rb
+- spec/fixtures/double_object_reference.plist
+- spec/fixtures/double_object_reference_unpacked.plist
+- spec/fixtures/empty.plist
+- spec/fixtures/single_object_reference.plist
+- spec/fixtures/single_object_reference_unpacked.plist
+- spec/keyed_archive_spec.rb
+- spec/unpacked_objects_spec.rb
+homepage: https://github.com/paulyoung/keyed_archive
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for working with files produced by NSKeyedArchiver.
+test_files:
+- spec/fixtures/double_object_reference.plist
+- spec/fixtures/double_object_reference_unpacked.plist
+- spec/fixtures/empty.plist
+- spec/fixtures/single_object_reference.plist
+- spec/fixtures/single_object_reference_unpacked.plist
+- spec/keyed_archive_spec.rb
+- spec/unpacked_objects_spec.rb