keyed_archive 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 20bed81f6f133648cf631d3216523aeddbc14eeb
-  data.tar.gz: 2d7912ef9102f3ece3b77a64fc872ed1207676c2
+SHA256:
+  metadata.gz: d932ce3e1c5bf7832937aeba3b66736cc94b9036ae9a242e32ef3d4310cece72
+  data.tar.gz: 74e5020a25d5346e1789fd12d4e4038c00f64c99a9a44f8906bbfa47d677f879
 SHA512:
-  metadata.gz: 3762da9e73d7512f57c2132b04694a94b8b7b34711253b1b1785b88a5c7835c5d3ea558c32094bb5dde4cc7f68b3ffbd1ea0fb5ff7c20f9cfdc6946f1d292c4d
-  data.tar.gz: e68c08996edb3c3e0932c1c5e842de86dd56e263a95ae73ebeba886dd66aea00ec486b428e6878a875b146aed104f61e2cc8254085f3fa062e43dd6f9f914553
+  metadata.gz: 0a0152d78b35fd324d3c48838ce21c19d71530e5d0234dabe668dd89e5dd88fae5f51539dbf6a62162a52fd4fabf1ac4e7ecba7540170acf277c75d5122e53d5
+  data.tar.gz: 5051e71618ab45823bd96fa1e1e00ec0d33c5311af024da0a1e2ec14e31115570b523324c6f64f060bf434da3559c864de0df2f72572b64c81a124280ea3daa6

data/README.md

@@ -18,6 +18,22 @@ Or install it yourself as:
 
 ## Usage
 
+### Basic Syntax
+
+KeyedArchive supports the initializer arguments which CFPropertyList supports: `:file` to read data directly from a file and `:data` to read data from a variable that already has your NSKeyedArchive data within it.
+
+```ruby
+
+# Create KeyedArchive by reading a file directly
+keyed_archive_from_file = KeyedArchive.new(:file => "path/to/file.plist")
+
+# Create KeyedArchive from a variable holding content which can 
+# be parsed as a plist, either XML or binary. 
+file_contents = File.read("path/to/file.plist")
+keyed_archive_from_variable = KeyedArchive.new(:data => file_contents)
+
+```
+
 ### Opening a keyed archive
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
@@ -48,11 +64,12 @@ Or install it yourself as:
 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
+keyed_archive = KeyedArchive.new(:file => "path/to/file.plist")
+keyed_archive.archiver     # "NSKeyedArchiver"
+keyed_archive.objects      # ["$null"]
+keyed_archive.top          # {"root"=>1}
+keyed_archive.version      # 100000
+keyed_archive.unpacked_top # {"root"=>nil}
 ```
 
 ### Unpacking keyed archive objects
@@ -88,14 +105,15 @@ keyed_archive.version   # 100000
 ```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"}]
+keyed_archive = KeyedArchive.new(:file => "path/to/file.plist")
+keyed_archive.objects             # ["$null", {"key"=>"value"}]
+keyed_archive.top                 # {"root"=>1}
+keyed_archive.unpacked_top()      # {"root"=>{"key"=>"value"}}
 ```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/keyed_archive/fork )
+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`)

data/keyed_archive.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "CFPropertyList", "~> 2.2.7"
+  spec.add_dependency "CFPropertyList", "~> 3.0"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "rspec", "~> 3.9"
 end

data/lib/keyed_archive.rb

@@ -1,18 +1,31 @@
 require 'cfpropertylist'
 
-require "keyed_archive/unpacked_objects"
-require "keyed_archive/version"
+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)
+  # 
+  # Take the same sort of arguments as CFPropertyList
+  # :file => filename to load
+  # :data => variable with the data to load directly
+  def initialize(opts={})
+    blob = opts[:data]
+    filename = opts[:file]
 
-    @archiver = data['$archiver']
-    @objects = data['$objects']
-    @top = data['$top']
-    @version = data['$version']
+    plist = CFPropertyList::List.new(:file => filename) unless filename.nil? or !File.exists?(filename)
+    plist = CFPropertyList::List.new(:data => blob) unless blob.nil? or blob.length < 1
+
+    if !plist.nil?
+      data = CFPropertyList.native_types(plist.value)
+
+      @archiver = data['$archiver']
+      @objects = data['$objects']
+      @top = data['$top']
+      @version = data['$version']
+    else
+      raise "Plist not created"
+    end
   end
 end

data/lib/keyed_archive/unpacked_objects.rb

@@ -1,31 +1,75 @@
 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
+
+  # Loops through the entries within '$top' 
+  # to replace any values that are pointers to objects.
+  def unpacked_top
+
+    # Create the return value
+    unpacked_top = Hash.new
+
+    # Loop over each pair in the '$top' hash
+    # to recursively replace the values
+    @top.each_pair do |key, value|
+      unpacked_top[key] = recursive_replace(value, -1, [])
+    end
+
+    # Politely return, our job is done
+    return unpacked_top
+  end
+
+  private
+
+  # Handles the recursive replacement of values within the 
+  # '$objects' array. Tracks the object locations it has 
+  # already touched to prevent infinite loops. 
+  def recursive_replace(value, current_location, locations)
+    # By default we just return the value itself, usually a String
+    to_return = value
+
+    # If the value is really representing nil, change it to nil
+    if value.is_a? String and value == "$null"
+      to_return = nil
+    end
+
+    # If we have an Integer, we want to bring in the object 
+    # that Integer points to
+    if value.is_a? Integer
+
+      # If we ever find a reference to one of our parents, just stop where we are
+      if locations.include?(current_location)
+        to_return = value
+      else
+        to_return = recursive_replace(@objects[value], value, locations.clone.push(current_location)) 
+      end
+
+    # If we have a Hash, we want to check each entry 
+    # and replace any values which need it
+    elsif value.is_a? Hash
+
+      # Build up a new Hash
+      to_return = Hash.new
+
+      # Loop over the pairs to check the key, value, or both
+      value.each_pair do |tmp_key, tmp_value|
+
+        # If this points to an array of objects, 
+        # then we should bring those values in
+        if tmp_key == "NS.objects" or tmp_key == "NS.keys"
+          new_array = Array.new
+          tmp_value.each do |entry|
+            new_array.push(recursive_replace(entry, entry, locations.clone.push(current_location)))
           end
+          to_return[tmp_key] = new_array
+
+        # Otherwise, we just want to replace the value with
+        # its recursive version
+        else
+          to_return[tmp_key] = recursive_replace(tmp_value, tmp_value, locations.clone.push(current_location))
         end
-      else
-        unpacked_objects.push object
       end
     end
 
-    return unpacked_objects
+    # Give back the value, politely
+    return to_return
   end
 end

data/lib/keyed_archive/version.rb

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

data/spec/keyed_archive_spec.rb

@@ -2,29 +2,35 @@ require "keyed_archive"
 
 describe KeyedArchive, "#initialize" do
   let(:filename) { 'spec/fixtures/empty.plist' }
+  let(:blob)     { File.read('spec/fixtures/empty.bplist') }
 
   it "should create an instance" do
-    keyed_archive = KeyedArchive.new(filename)
+    keyed_archive = KeyedArchive.new(:file => filename)
     expect(keyed_archive).to be_instance_of(KeyedArchive)
   end
 
   it "should set the archiver" do
-    keyed_archive = KeyedArchive.new(filename)
+    keyed_archive = KeyedArchive.new(:file => filename)
     expect(keyed_archive.archiver).to be_a(String)
   end
 
   it "should set the objects" do
-    keyed_archive = KeyedArchive.new(filename)
+    keyed_archive = KeyedArchive.new(:file => filename)
     expect(keyed_archive.objects).to be_an(Array)
   end
 
   it "should set the top" do
-    keyed_archive = KeyedArchive.new(filename)
+    keyed_archive = KeyedArchive.new(:file => filename)
     expect(keyed_archive.top).to be_a(Hash)
   end
 
   it "should set the version" do
-    keyed_archive = KeyedArchive.new(filename)
+    keyed_archive = KeyedArchive.new(:file => filename)
+    expect(keyed_archive.version).to be_an(Integer)
+  end
+
+  it "should read data from variables as well" do
+    keyed_archive = KeyedArchive.new(:data => blob)
     expect(keyed_archive.version).to be_an(Integer)
   end
 end

data/spec/unpacked_objects_spec.rb

@@ -2,10 +2,17 @@ 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)
+    keyed_archive = KeyedArchive.new(:file => filename)
+    unpacked_top = keyed_archive.unpacked_top()
+    fixture_archive = KeyedArchive.new(:file => fixture)
+    expect(unpacked_top["root"]).to eq(fixture_archive.objects[1]["key"])
+  end
+
+  it "should handle variables" do
+    keyed_archive = KeyedArchive.new(:data => blob)
+    unpacked_top = keyed_archive.unpacked_top()
+    fixture_archive = KeyedArchive.new(:file => fixture)
+    expect(unpacked_top["root"]).to eq(fixture_archive.objects[1]["key"])
   end
 end
 
@@ -13,6 +20,7 @@ describe KeyedArchive, "#unpack" do
   context "single reference" do
     it_behaves_like "unpack" do
       let(:filename) { "spec/fixtures/single_object_reference.plist" }
+      let(:blob) { File.read("spec/fixtures/single_object_reference.plist") }
       let(:fixture) { "spec/fixtures/single_object_reference_unpacked.plist" }
     end
   end
@@ -20,6 +28,7 @@ describe KeyedArchive, "#unpack" do
   context "double reference" do
     it_behaves_like "unpack" do
       let(:filename) { "spec/fixtures/double_object_reference.plist" }
+      let(:blob) { File.read("spec/fixtures/double_object_reference.plist") }
       let(:fixture) { "spec/fixtures/double_object_reference_unpacked.plist" }
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keyed_archive
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Paul Young
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2020-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.7
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.7
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,15 +58,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
-description: 
+        version: '3.9'
+description:
 email:
 - paulyoungonline@gmail.com
 executables: []
@@ -85,7 +85,9 @@ files:
 - lib/keyed_archive/version.rb
 - spec/fixtures/double_object_reference.plist
 - spec/fixtures/double_object_reference_unpacked.plist
+- spec/fixtures/empty.bplist
 - spec/fixtures/empty.plist
+- spec/fixtures/single_object_reference.bplist
 - spec/fixtures/single_object_reference.plist
 - spec/fixtures/single_object_reference_unpacked.plist
 - spec/keyed_archive_spec.rb
@@ -94,7 +96,7 @@ homepage: https://github.com/paulyoung/keyed_archive
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,15 +111,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.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.bplist
 - spec/fixtures/empty.plist
+- spec/fixtures/single_object_reference.bplist
 - spec/fixtures/single_object_reference.plist
 - spec/fixtures/single_object_reference_unpacked.plist
 - spec/keyed_archive_spec.rb