pbxplorer 1.0.0

data/README.md

@@ -0,0 +1,186 @@
+# pbxplorer
+
+ pbxplorer is a set of Ruby classes for parsing, editing, and saving Xcode project (.pbxproj) files.  It can also be used to explore the contents of a project using the interactive Ruby shell.
+
+### Dependencies
+
+pbxplorer has no Ruby dependencies outside of the standard library.  It uses the OS X **plutil** command to parse the project file.
+
+### Overview
+
+An Xcode project (.pbxproj) file is essentially a hash of objects keyed by UUID.  The objects are hashes of properties keyed by name.  The associated values can be strings, arrays, or hashes.
+
+Each object hash contains an "isa" property that identifies its type.  pbxplorer loads a project file hash and replaces each generic object hash with a specific subclass based on its type.
+
+### Class Hierarchy
+
+PBXObject and PBXBuildPhase are abstract superclasses.  All other subclasses of PBXObject correspond to object hashes in the project, based on their "isa" property.
+
+```
+PBXObject
+    PBXBuildFile
+    PBXBuildPhase
+        PBXFrameworksBuildPhase
+        PBXResourcesBuildPhase
+        PBXShellScriptBuildPhase
+        PBXSourcesBuildPhase
+    PBXFileReference
+    PBXGroup
+    PBXProject
+    PBXNativeTarget
+    XCBuildConfiguration
+    XCConfigurationList
+XCProjectFile
+```
+  
+### Reference Hierarchy
+
+In the project file, objects are referenced from other objects by UUID.  pbxplorer includes convenience methods to return the objects themselves rather than the UUIDs.  Below are the method names and object types returned.
+
+```
+PBXProject
+    build_configuration_list: XCConfigurationList
+    main_group: PBXGroup
+    targets: [PBXNativeTarget]
+  
+XCConfigurationList
+    build_configurations: [XCBuildConfiguration]
+  
+PBXGroup
+    children: [PBXGroup|PBXFileReference]
+    subgroups: [PBXGroup]
+    file_refs: [PBXFileReference]
+
+PBXNativeTarget
+    build_configuration_list: XCBuildConfigurationList
+    build_phases: [PBXBuildPhase]
+    product_file_ref: PBXFileReference
+
+PBXBuildPhase
+    build_files: [PBXBuildFile]
+
+PBXBuildFile
+    file_ref: PBXFileReference
+```
+
+### Interactive Use
+
+To get started:
+
+```ruby
+$ irb
+>> require 'pbxplorer'
+=> true
+>> XCProjectFile.help
+project_file = XCProjectFile.new '/path/to/project.pbxproj'
+=> XCProjectFile
+```
+
+The help displays a suggested statement followed by the type of the assigned result.  Enter the statement in the shell, editing as necessary:
+
+```ruby
+>> project_file = XCProjectFile.new 'project.pbxproj'
+=> {
+  rootObject = "4D0B81831657473000DEF560"
+  objects = < 63 objects >
+}
+``` 
+
+This`XCProjectFile`instance contains a reference to the root object (a`PBXProject`instance), and the collection of all objects.
+
+Get help from the **project_file** object:
+
+```ruby
+>> project_file.help
+project = project_file.project
+=> PBXProject
+```
+
+Enter the statement:
+
+```ruby
+>> project = project_file.project
+=> 4D0B81831657473000DEF560 = {
+  attributes = {"CLASSPREFIX"=>"Example", "LastUpgradeCheck"=>"0450", "ORGANIZATIONNAME"=>"Example"}
+  projectRoot = ""
+  hasScannedForEncodings = "0"
+  mainGroup = "4D0B81811657473000DEF560"
+  buildConfigurationList = "4D0B81861657473000DEF560"
+  compatibilityVersion = "Xcode 3.2"
+  productRefGroup = "4D0B818D1657473000DEF560"
+  projectDirPath = ""
+  knownRegions = ["en"]
+  targets = ["4D0B818B1657473000DEF560", "4D0B81AC1657473100DEF560"]
+  developmentRegion = "English"
+  isa = "PBXProject"
+}
+```
+
+This`PBXProject`instance contains an array of references to targets (`PBXNativeTarget`instances).
+
+Get help from the **project** object:
+
+```ruby
+>> project.help
+target = project.targets.first
+=> PBXNativeTarget
+list = project.build_configuration_list
+=> XCConfigurationList
+group = project.main_group
+=> PBXGroup
+```
+
+This time the help suggests three objects we can retrieve next; the first`PBXNativeTarget`instance, the sole`XCConfigurationList`instance, and the main`PBXGroup`instance.  
+
+Enter the target statement:
+
+```ruby
+>> target = project.targets.first
+=> 4D0B818B1657473000DEF560 = {
+  productName = "Example"
+  productReference = "4D0B818C1657473000DEF560"
+  name = "Example"
+  dependencies = []
+  buildConfigurationList = "4D0B81BF1657473100DEF560"
+  productType = "com.apple.product-type.application"
+  buildPhases = ["4D0B81881657473000DEF560", "4D0B81891657473000DEF560", "4D0B818A1657473000DEF560"]
+  isa = "PBXNativeTarget"
+  buildRules = []
+}
+```
+
+You can continue exploring the object graph in this manner, down to `PBXFileReference`objects, which contain no references to other objects.
+
+### Example: removing a source file
+
+```ruby
+file_ref = project_file.objects_of_class(PBXFileReference, { "path" => "ExampleTests.m" }).first
+build_phases = project_file.objects_of_class PBXBuildPhase
+build_files = project_file.objects_of_class PBXBuildFile, { "fileRef" => file_ref.uuid }
+build_file_uuids = build_files.map { |obj| obj.uuid }
+groups = project_file.objects_of_class PBXGroup
+
+build_phases.each { |phase| phase["files"] -= build_file_uuids }
+build_files.each { |obj| project_file.remove_object obj }
+groups.each { |group| group["children"].delete file_ref }
+project_file.remove_object file_ref
+
+project_file.save
+```
+
+### Example: adding a source file
+
+```ruby
+file_ref = project_file.new_object PBXFileReference, { "path" => "Example.c", "sourceTree" => "<group>",  "lastKnownFileType" => "sourcecode.c.c" }
+build_file = project_file.new_object PBXBuildFile, { "fileRef" => file_ref.uuid }
+
+build_phases = project_file.objects_of_class PBXSourcesBuildPhase
+build_phases.each { |phase| phase["files"] << build_file.uuid }
+
+project_file.save
+```
+
+## LICENSE
+
+MIT license.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/pbxplorer.rb

@@ -0,0 +1,266 @@
+require 'json'
+
+class String
+  alias to_plist to_json
+end
+
+class Array
+  def to_plist
+    items = self.map { |item| "#{item.to_plist}" }
+    "( #{items.join ","} )"
+  end
+end
+
+class Hash
+  def to_plist
+    items = self.map { |key, val| "#{key.to_plist} = #{val.to_plist};\n" }
+    "{ #{items.join} }"
+  end
+end
+
+class PBXObject < Hash
+  attr_accessor :project_file
+  attr_reader :uuid
+  
+  def self.filter objs, attrs
+    objs.select do |obj|
+      attrs.select { |key, val| obj[key] == val }.length == attrs.length
+    end
+  end
+
+  def self.objects_of_class objs, attrs=nil
+   objs = objs.select { |obj| obj.class <= self }
+   objs = self.filter(objs, attrs) if attrs
+   objs
+  end
+  
+  def initialize hash={}, uuid=""
+    24.times { uuid += "0123456789ABCDEF"[rand(16),1] } if uuid.empty?
+    
+    @project = nil
+    @uuid = uuid
+    
+    self.merge! hash
+    self["isa"] ||= self.class.to_s
+  end
+
+  def inspect
+    props = self.map { |key, val| "  #{key} = #{val.inspect}\n" }
+    "#{@uuid} = {\n#{props.join}}"
+  end
+
+  def help
+    puts "(no help available)"
+  end
+end
+
+class PBXFileReference < PBXObject
+end
+
+class PBXBuildFile < PBXObject
+  def file_ref
+    self.project_file.object_with_uuid self["fileRef"]
+  end
+
+  def help
+    puts "file_ref = build_file.file_ref"
+    PBXFileReference
+  end
+end
+
+class PBXBuildPhase < PBXObject
+  def build_files
+    self.project_file.objects_with_uuids self["files"]
+  end
+
+  def help
+    puts "build_file = build_phase.build_files.first"
+    PBXBuildFile
+  end
+end
+
+class PBXSourcesBuildPhase < PBXBuildPhase
+end
+
+class PBXFrameworksBuildPhase < PBXBuildPhase
+end
+
+class PBXResourcesBuildPhase < PBXBuildPhase
+end
+
+class PBXShellScriptBuildPhase < PBXBuildPhase
+end
+
+class PBXGroup < PBXObject
+  def children recursive=false
+    children = self.project_file.objects_with_uuids self["children"]
+
+    if recursive
+      subgroups = PBXGroup.objects_of_class children
+      subgroups.each { |subgroup| children << subgroup.children(true) }
+    end
+
+    children.flatten
+  end
+    
+  def file_refs recursive=false
+    PBXFileReference.objects_of_class self.children(recursive)
+  end
+  
+  def subgroups recursive=false
+    PBXGroup.objects_of_class self.children(recursive)
+  end
+
+  def help
+    puts "file_ref = group.file_refs.first\n=> " + PBXFileReference.to_s
+    puts "group = group.subgroups.first"
+    PBXGroup
+  end
+end
+
+class PBXNativeTarget < PBXObject
+  def build_phases
+    self.project_file.objects_with_uuids self["buildPhases"]
+  end
+
+  def build_configuration_list
+    self.project_file.object_with_uuid self["buildConfigurationList"]
+  end
+
+  def product_file_ref
+    self.project_file.object_with_uuid self["productReference"]
+  end
+
+  def help
+    puts "build_phase = PBXSourcesBuildPhase.objects_of_class(target.build_phases).first"
+    PBXSourcesBuildPhase
+  end
+end
+
+class XCBuildConfiguration < PBXObject
+end
+
+class XCConfigurationList < PBXObject
+  def build_configurations
+    self.project_file.objects_with_uuids self["buildConfigurations"]
+  end
+
+  def help
+    puts "config = list.build_configurations.first"
+    XCBuildConfiguration
+  end
+end
+
+class PBXProject < PBXObject
+  def targets
+    self.project_file.objects_with_uuids self["targets"]
+  end
+  
+  def build_configuration_list
+    self.project_file.object_with_uuid self["buildConfigurationList"]
+  end
+
+  def main_group
+    self.project_file.object_with_uuid self["mainGroup"]
+  end
+
+  def help
+    puts "target = project.targets.first\n=> " + PBXNativeTarget.to_s
+    puts "list = project.build_configuration_list\n=> " + XCConfigurationList.to_s
+    puts "group = project.main_group"
+    PBXGroup
+  end
+end
+
+class XCProjectFile
+  def self.help
+    puts "project_file = XCProjectFile.new '/path/to/project.pbxproj'"
+    XCProjectFile
+  end
+
+  def initialize path
+    @path = path
+    @path += "/project.pbxproj" if File.directory? @path
+
+    @json = JSON.parse(`plutil -convert json -o - "#{@path}"`)
+    
+    objs = @json["objects"]
+    @json["objects"] = {}
+
+    objs.each do |uuid, hash|
+      klass = PBXObject
+      begin
+        klass = Object.const_get hash["isa"]
+      rescue
+      end
+      
+      self.add_object klass.new(hash, uuid)
+    end
+  end
+
+  def save path=nil
+    path ||= @path
+    File.open(path, "w") { |f| f.write @json.to_plist }
+  end
+  
+  def project
+    self.object_with_uuid @json["rootObject"]
+  end
+
+  def uuids
+    @json["objects"].keys
+  end
+
+  def objects
+    @json["objects"].values
+  end
+
+  def objects_of_class klass, attrs=nil
+   klass.objects_of_class self.objects, attrs
+  end
+
+  def objects_with_uuids uuids, attrs=nil
+    objs = uuids.map { |uuid| self.object_with_uuid uuid }.reject { |obj| !obj }
+    objs = PBXObject.filter(objs, attrs) if attrs
+    objs
+  end
+  
+  def object_with_uuid uuid
+    @json["objects"][uuid]
+  end
+  
+  def new_object klass, attrs={}
+    obj = klass.new attrs
+    self.add_object obj
+    obj
+  end
+  
+  def add_object obj
+    obj.project_file = self
+    @json["objects"][obj.uuid] = obj
+  end
+  
+  def remove_object obj
+    obj.project_file = nil
+    @json["objects"].delete obj.uuid
+  end
+  
+  def remove_file_ref file_ref
+    build_files = self.objects_of_class PBXBuildFile, { "fileRef" => file_ref.uuid }
+    build_file_uuids = build_files.map { |obj| obj.uuid }
+    
+    build_files.each { |build_file| self.remove_object build_file }
+    self.objects_of_class(PBXBuildPhase).each { |phase| phase["files"] -= build_file_uuids }
+    self.objects_of_class(PBXGroup).each { |group| group["children"].delete file_ref }
+    self.remove_object file_ref
+  end
+
+  def help
+    puts "project = project_file.project"
+    PBXProject
+  end
+  
+  def inspect
+    "{\n  rootObject = #{@json['rootObject'].inspect}\n  objects = < #{@json['objects'].length} objects >\n}"
+  end
+end

data/pbxplorer.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name        = "pbxplorer"
+  s.version     = "1.0.0"
+  s.date        = "2013-03-19"
+  s.summary     = "Xcode project file editor"
+  s.description = "pbxplorer is a set of Ruby classes for parsing, editing, and saving Xcode project (.pbxproj) files. It can also be used to explore the contents of a project using the interactive Ruby shell."
+  s.authors     = ["Mark Smith"]
+  s.email       = "mark@camazotz.com"
+  s.files       = Dir["{test,lib}/**/*"] + ["README.md", "Rakefile", "pbxplorer.gemspec"]
+  s.homepage    = "http://github.com/mjmsmith/pbxplorer"
+end

data/test/project.pbxproj

@@ -0,0 +1,445 @@
+// !$*UTF8*$!
+{
+	archiveVersion = 1;
+	classes = {
+	};
+	objectVersion = 46;
+	objects = {
+
+/* Begin PBXBuildFile section */
+		4D0B81911657473000DEF560 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 4D0B81901657473000DEF560 /* UIKit.framework */; };
+		4D0B81931657473000DEF560 /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 4D0B81921657473000DEF560 /* Foundation.framework */; };
+		4D0B81951657473000DEF560 /* CoreGraphics.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 4D0B81941657473000DEF560 /* CoreGraphics.framework */; };
+		4D0B819B1657473000DEF560 /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = 4D0B81991657473000DEF560 /* InfoPlist.strings */; };
+		4D0B819D1657473000DEF560 /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = 4D0B819C1657473000DEF560 /* main.m */; };
+		4D0B81A11657473000DEF560 /* ExampleAppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = 4D0B81A01657473000DEF560 /* ExampleAppDelegate.m */; };
+		4D0B81A31657473000DEF560 /* Default.png in Resources */ = {isa = PBXBuildFile; fileRef = 4D0B81A21657473000DEF560 /* Default.png */; };
+		4D0B81A51657473000DEF560 /* Default@2x.png in Resources */ = {isa = PBXBuildFile; fileRef = 4D0B81A41657473000DEF560 /* Default@2x.png */; };
+		4D0B81A71657473000DEF560 /* Default-568h@2x.png in Resources */ = {isa = PBXBuildFile; fileRef = 4D0B81A61657473000DEF560 /* Default-568h@2x.png */; };
+		4D0B81AF1657473100DEF560 /* SenTestingKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 4D0B81AE1657473100DEF560 /* SenTestingKit.framework */; };
+		4D0B81B01657473100DEF560 /* UIKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 4D0B81901657473000DEF560 /* UIKit.framework */; };
+		4D0B81B11657473100DEF560 /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 4D0B81921657473000DEF560 /* Foundation.framework */; };
+		4D0B81B91657473100DEF560 /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = 4D0B81B71657473100DEF560 /* InfoPlist.strings */; };
+		4D0B81BC1657473100DEF560 /* ExampleTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 4D0B81BB1657473100DEF560 /* ExampleTests.m */; };
+/* End PBXBuildFile section */
+
+/* Begin PBXContainerItemProxy section */
+		4D0B81B21657473100DEF560 /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = 4D0B81831657473000DEF560 /* Project object */;
+			proxyType = 1;
+			remoteGlobalIDString = 4D0B818B1657473000DEF560;
+			remoteInfo = Example;
+		};
+/* End PBXContainerItemProxy section */
+
+/* Begin PBXFileReference section */
+		4D0B818C1657473000DEF560 /* Example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Example.app; sourceTree = BUILT_PRODUCTS_DIR; };
+		4D0B81901657473000DEF560 /* UIKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = UIKit.framework; path = System/Library/Frameworks/UIKit.framework; sourceTree = SDKROOT; };
+		4D0B81921657473000DEF560 /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = System/Library/Frameworks/Foundation.framework; sourceTree = SDKROOT; };
+		4D0B81941657473000DEF560 /* CoreGraphics.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreGraphics.framework; path = System/Library/Frameworks/CoreGraphics.framework; sourceTree = SDKROOT; };
+		4D0B81981657473000DEF560 /* Example-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = "Example-Info.plist"; sourceTree = "<group>"; };
+		4D0B819A1657473000DEF560 /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/InfoPlist.strings; sourceTree = "<group>"; };
+		4D0B819C1657473000DEF560 /* main.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = main.m; sourceTree = "<group>"; };
+		4D0B819E1657473000DEF560 /* Example-Prefix.pch */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Example-Prefix.pch"; sourceTree = "<group>"; };
+		4D0B819F1657473000DEF560 /* ExampleAppDelegate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = ExampleAppDelegate.h; sourceTree = "<group>"; };
+		4D0B81A01657473000DEF560 /* ExampleAppDelegate.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = ExampleAppDelegate.m; sourceTree = "<group>"; };
+		4D0B81A21657473000DEF560 /* Default.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = Default.png; sourceTree = "<group>"; };
+		4D0B81A41657473000DEF560 /* Default@2x.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = "Default@2x.png"; sourceTree = "<group>"; };
+		4D0B81A61657473000DEF560 /* Default-568h@2x.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = "Default-568h@2x.png"; sourceTree = "<group>"; };
+		4D0B81AD1657473100DEF560 /* ExampleTests.octest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = ExampleTests.octest; sourceTree = BUILT_PRODUCTS_DIR; };
+		4D0B81AE1657473100DEF560 /* SenTestingKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = SenTestingKit.framework; path = Library/Frameworks/SenTestingKit.framework; sourceTree = DEVELOPER_DIR; };
+		4D0B81B61657473100DEF560 /* ExampleTests-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = "ExampleTests-Info.plist"; sourceTree = "<group>"; };
+		4D0B81B81657473100DEF560 /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/InfoPlist.strings; sourceTree = "<group>"; };
+		4D0B81BA1657473100DEF560 /* ExampleTests.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = ExampleTests.h; sourceTree = "<group>"; };
+		4D0B81BB1657473100DEF560 /* ExampleTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = ExampleTests.m; sourceTree = "<group>"; };
+/* End PBXFileReference section */
+
+/* Begin PBXFrameworksBuildPhase section */
+		4D0B81891657473000DEF560 /* Frameworks */ = {
+			isa = PBXFrameworksBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				4D0B81911657473000DEF560 /* UIKit.framework in Frameworks */,
+				4D0B81931657473000DEF560 /* Foundation.framework in Frameworks */,
+				4D0B81951657473000DEF560 /* CoreGraphics.framework in Frameworks */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+		4D0B81A91657473100DEF560 /* Frameworks */ = {
+			isa = PBXFrameworksBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				4D0B81AF1657473100DEF560 /* SenTestingKit.framework in Frameworks */,
+				4D0B81B01657473100DEF560 /* UIKit.framework in Frameworks */,
+				4D0B81B11657473100DEF560 /* Foundation.framework in Frameworks */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+/* End PBXFrameworksBuildPhase section */
+
+/* Begin PBXGroup section */
+		4D0B81811657473000DEF560 = {
+			isa = PBXGroup;
+			children = (
+				4D0B81961657473000DEF560 /* Example */,
+				4D0B81B41657473100DEF560 /* ExampleTests */,
+				4D0B818F1657473000DEF560 /* Frameworks */,
+				4D0B818D1657473000DEF560 /* Products */,
+			);
+			sourceTree = "<group>";
+		};
+		4D0B818D1657473000DEF560 /* Products */ = {
+			isa = PBXGroup;
+			children = (
+				4D0B818C1657473000DEF560 /* Example.app */,
+				4D0B81AD1657473100DEF560 /* ExampleTests.octest */,
+			);
+			name = Products;
+			sourceTree = "<group>";
+		};
+		4D0B818F1657473000DEF560 /* Frameworks */ = {
+			isa = PBXGroup;
+			children = (
+				4D0B81901657473000DEF560 /* UIKit.framework */,
+				4D0B81921657473000DEF560 /* Foundation.framework */,
+				4D0B81941657473000DEF560 /* CoreGraphics.framework */,
+				4D0B81AE1657473100DEF560 /* SenTestingKit.framework */,
+			);
+			name = Frameworks;
+			sourceTree = "<group>";
+		};
+		4D0B81961657473000DEF560 /* Example */ = {
+			isa = PBXGroup;
+			children = (
+				4D0B819F1657473000DEF560 /* ExampleAppDelegate.h */,
+				4D0B81A01657473000DEF560 /* ExampleAppDelegate.m */,
+				4D0B81971657473000DEF560 /* Supporting Files */,
+			);
+			path = Example;
+			sourceTree = "<group>";
+		};
+		4D0B81971657473000DEF560 /* Supporting Files */ = {
+			isa = PBXGroup;
+			children = (
+				4D0B81981657473000DEF560 /* Example-Info.plist */,
+				4D0B81991657473000DEF560 /* InfoPlist.strings */,
+				4D0B819C1657473000DEF560 /* main.m */,
+				4D0B819E1657473000DEF560 /* Example-Prefix.pch */,
+				4D0B81A21657473000DEF560 /* Default.png */,
+				4D0B81A41657473000DEF560 /* Default@2x.png */,
+				4D0B81A61657473000DEF560 /* Default-568h@2x.png */,
+			);
+			name = "Supporting Files";
+			sourceTree = "<group>";
+		};
+		4D0B81B41657473100DEF560 /* ExampleTests */ = {
+			isa = PBXGroup;
+			children = (
+				4D0B81BA1657473100DEF560 /* ExampleTests.h */,
+				4D0B81BB1657473100DEF560 /* ExampleTests.m */,
+				4D0B81B51657473100DEF560 /* Supporting Files */,
+			);
+			path = ExampleTests;
+			sourceTree = "<group>";
+		};
+		4D0B81B51657473100DEF560 /* Supporting Files */ = {
+			isa = PBXGroup;
+			children = (
+				4D0B81B61657473100DEF560 /* ExampleTests-Info.plist */,
+				4D0B81B71657473100DEF560 /* InfoPlist.strings */,
+			);
+			name = "Supporting Files";
+			sourceTree = "<group>";
+		};
+/* End PBXGroup section */
+
+/* Begin PBXNativeTarget section */
+		4D0B818B1657473000DEF560 /* Example */ = {
+			isa = PBXNativeTarget;
+			buildConfigurationList = 4D0B81BF1657473100DEF560 /* Build configuration list for PBXNativeTarget "Example" */;
+			buildPhases = (
+				4D0B81881657473000DEF560 /* Sources */,
+				4D0B81891657473000DEF560 /* Frameworks */,
+				4D0B818A1657473000DEF560 /* Resources */,
+			);
+			buildRules = (
+			);
+			dependencies = (
+			);
+			name = Example;
+			productName = Example;
+			productReference = 4D0B818C1657473000DEF560 /* Example.app */;
+			productType = "com.apple.product-type.application";
+		};
+		4D0B81AC1657473100DEF560 /* ExampleTests */ = {
+			isa = PBXNativeTarget;
+			buildConfigurationList = 4D0B81C21657473100DEF560 /* Build configuration list for PBXNativeTarget "ExampleTests" */;
+			buildPhases = (
+				4D0B81A81657473100DEF560 /* Sources */,
+				4D0B81A91657473100DEF560 /* Frameworks */,
+				4D0B81AA1657473100DEF560 /* Resources */,
+				4D0B81AB1657473100DEF560 /* ShellScript */,
+			);
+			buildRules = (
+			);
+			dependencies = (
+				4D0B81B31657473100DEF560 /* PBXTargetDependency */,
+			);
+			name = ExampleTests;
+			productName = ExampleTests;
+			productReference = 4D0B81AD1657473100DEF560 /* ExampleTests.octest */;
+			productType = "com.apple.product-type.bundle";
+		};
+/* End PBXNativeTarget section */
+
+/* Begin PBXProject section */
+		4D0B81831657473000DEF560 /* Project object */ = {
+			isa = PBXProject;
+			attributes = {
+				CLASSPREFIX = Example;
+				LastUpgradeCheck = 0450;
+				ORGANIZATIONNAME = Example;
+			};
+			buildConfigurationList = 4D0B81861657473000DEF560 /* Build configuration list for PBXProject "Example" */;
+			compatibilityVersion = "Xcode 3.2";
+			developmentRegion = English;
+			hasScannedForEncodings = 0;
+			knownRegions = (
+				en,
+			);
+			mainGroup = 4D0B81811657473000DEF560;
+			productRefGroup = 4D0B818D1657473000DEF560 /* Products */;
+			projectDirPath = "";
+			projectRoot = "";
+			targets = (
+				4D0B818B1657473000DEF560 /* Example */,
+				4D0B81AC1657473100DEF560 /* ExampleTests */,
+			);
+		};
+/* End PBXProject section */
+
+/* Begin PBXResourcesBuildPhase section */
+		4D0B818A1657473000DEF560 /* Resources */ = {
+			isa = PBXResourcesBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				4D0B819B1657473000DEF560 /* InfoPlist.strings in Resources */,
+				4D0B81A31657473000DEF560 /* Default.png in Resources */,
+				4D0B81A51657473000DEF560 /* Default@2x.png in Resources */,
+				4D0B81A71657473000DEF560 /* Default-568h@2x.png in Resources */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+		4D0B81AA1657473100DEF560 /* Resources */ = {
+			isa = PBXResourcesBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				4D0B81B91657473100DEF560 /* InfoPlist.strings in Resources */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+/* End PBXResourcesBuildPhase section */
+
+/* Begin PBXShellScriptBuildPhase section */
+		4D0B81AB1657473100DEF560 /* ShellScript */ = {
+			isa = PBXShellScriptBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputPaths = (
+			);
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "# Run the unit tests in this test bundle.\n\"${SYSTEM_DEVELOPER_DIR}/Tools/RunUnitTests\"\n";
+		};
+/* End PBXShellScriptBuildPhase section */
+
+/* Begin PBXSourcesBuildPhase section */
+		4D0B81881657473000DEF560 /* Sources */ = {
+			isa = PBXSourcesBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				4D0B819D1657473000DEF560 /* main.m in Sources */,
+				4D0B81A11657473000DEF560 /* ExampleAppDelegate.m in Sources */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+		4D0B81A81657473100DEF560 /* Sources */ = {
+			isa = PBXSourcesBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				4D0B81BC1657473100DEF560 /* ExampleTests.m in Sources */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+/* End PBXSourcesBuildPhase section */
+
+/* Begin PBXTargetDependency section */
+		4D0B81B31657473100DEF560 /* PBXTargetDependency */ = {
+			isa = PBXTargetDependency;
+			target = 4D0B818B1657473000DEF560 /* Example */;
+			targetProxy = 4D0B81B21657473100DEF560 /* PBXContainerItemProxy */;
+		};
+/* End PBXTargetDependency section */
+
+/* Begin PBXVariantGroup section */
+		4D0B81991657473000DEF560 /* InfoPlist.strings */ = {
+			isa = PBXVariantGroup;
+			children = (
+				4D0B819A1657473000DEF560 /* en */,
+			);
+			name = InfoPlist.strings;
+			sourceTree = "<group>";
+		};
+		4D0B81B71657473100DEF560 /* InfoPlist.strings */ = {
+			isa = PBXVariantGroup;
+			children = (
+				4D0B81B81657473100DEF560 /* en */,
+			);
+			name = InfoPlist.strings;
+			sourceTree = "<group>";
+		};
+/* End PBXVariantGroup section */
+
+/* Begin XCBuildConfiguration section */
+		4D0B81BD1657473100DEF560 /* Debug */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				ALWAYS_SEARCH_USER_PATHS = NO;
+				CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
+				CLANG_CXX_LIBRARY = "libc++";
+				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_EMPTY_BODY = YES;
+				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
+				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
+				COPY_PHASE_STRIP = NO;
+				GCC_C_LANGUAGE_STANDARD = gnu99;
+				GCC_DYNAMIC_NO_PIC = NO;
+				GCC_OPTIMIZATION_LEVEL = 0;
+				GCC_PREPROCESSOR_DEFINITIONS = (
+					"DEBUG=1",
+					"$(inherited)",
+				);
+				GCC_SYMBOLS_PRIVATE_EXTERN = NO;
+				GCC_WARN_ABOUT_RETURN_TYPE = YES;
+				GCC_WARN_UNINITIALIZED_AUTOS = YES;
+				GCC_WARN_UNUSED_VARIABLE = YES;
+				IPHONEOS_DEPLOYMENT_TARGET = 6.0;
+				ONLY_ACTIVE_ARCH = YES;
+				SDKROOT = iphoneos;
+			};
+			name = Debug;
+		};
+		4D0B81BE1657473100DEF560 /* Release */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				ALWAYS_SEARCH_USER_PATHS = NO;
+				CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x";
+				CLANG_CXX_LIBRARY = "libc++";
+				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_EMPTY_BODY = YES;
+				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
+				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
+				COPY_PHASE_STRIP = YES;
+				GCC_C_LANGUAGE_STANDARD = gnu99;
+				GCC_WARN_ABOUT_RETURN_TYPE = YES;
+				GCC_WARN_UNINITIALIZED_AUTOS = YES;
+				GCC_WARN_UNUSED_VARIABLE = YES;
+				IPHONEOS_DEPLOYMENT_TARGET = 6.0;
+				OTHER_CFLAGS = "-DNS_BLOCK_ASSERTIONS=1";
+				SDKROOT = iphoneos;
+				VALIDATE_PRODUCT = YES;
+			};
+			name = Release;
+		};
+		4D0B81C01657473100DEF560 /* Debug */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				GCC_PRECOMPILE_PREFIX_HEADER = YES;
+				GCC_PREFIX_HEADER = "Example/Example-Prefix.pch";
+				INFOPLIST_FILE = "Example/Example-Info.plist";
+				PRODUCT_NAME = "$(TARGET_NAME)";
+				WRAPPER_EXTENSION = app;
+			};
+			name = Debug;
+		};
+		4D0B81C11657473100DEF560 /* Release */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				GCC_PRECOMPILE_PREFIX_HEADER = YES;
+				GCC_PREFIX_HEADER = "Example/Example-Prefix.pch";
+				INFOPLIST_FILE = "Example/Example-Info.plist";
+				PRODUCT_NAME = "$(TARGET_NAME)";
+				WRAPPER_EXTENSION = app;
+			};
+			name = Release;
+		};
+		4D0B81C31657473100DEF560 /* Debug */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				BUNDLE_LOADER = "$(BUILT_PRODUCTS_DIR)/Example.app/Example";
+				FRAMEWORK_SEARCH_PATHS = (
+					"\"$(SDKROOT)/Developer/Library/Frameworks\"",
+					"\"$(DEVELOPER_LIBRARY_DIR)/Frameworks\"",
+				);
+				GCC_PRECOMPILE_PREFIX_HEADER = YES;
+				GCC_PREFIX_HEADER = "Example/Example-Prefix.pch";
+				INFOPLIST_FILE = "ExampleTests/ExampleTests-Info.plist";
+				PRODUCT_NAME = "$(TARGET_NAME)";
+				TEST_HOST = "$(BUNDLE_LOADER)";
+				WRAPPER_EXTENSION = octest;
+			};
+			name = Debug;
+		};
+		4D0B81C41657473100DEF560 /* Release */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				BUNDLE_LOADER = "$(BUILT_PRODUCTS_DIR)/Example.app/Example";
+				FRAMEWORK_SEARCH_PATHS = (
+					"\"$(SDKROOT)/Developer/Library/Frameworks\"",
+					"\"$(DEVELOPER_LIBRARY_DIR)/Frameworks\"",
+				);
+				GCC_PRECOMPILE_PREFIX_HEADER = YES;
+				GCC_PREFIX_HEADER = "Example/Example-Prefix.pch";
+				INFOPLIST_FILE = "ExampleTests/ExampleTests-Info.plist";
+				PRODUCT_NAME = "$(TARGET_NAME)";
+				TEST_HOST = "$(BUNDLE_LOADER)";
+				WRAPPER_EXTENSION = octest;
+			};
+			name = Release;
+		};
+/* End XCBuildConfiguration section */
+
+/* Begin XCConfigurationList section */
+		4D0B81861657473000DEF560 /* Build configuration list for PBXProject "Example" */ = {
+			isa = XCConfigurationList;
+			buildConfigurations = (
+				4D0B81BD1657473100DEF560 /* Debug */,
+				4D0B81BE1657473100DEF560 /* Release */,
+			);
+			defaultConfigurationIsVisible = 0;
+			defaultConfigurationName = Release;
+		};
+		4D0B81BF1657473100DEF560 /* Build configuration list for PBXNativeTarget "Example" */ = {
+			isa = XCConfigurationList;
+			buildConfigurations = (
+				4D0B81C01657473100DEF560 /* Debug */,
+				4D0B81C11657473100DEF560 /* Release */,
+			);
+			defaultConfigurationIsVisible = 0;
+		};
+		4D0B81C21657473100DEF560 /* Build configuration list for PBXNativeTarget "ExampleTests" */ = {
+			isa = XCConfigurationList;
+			buildConfigurations = (
+				4D0B81C31657473100DEF560 /* Debug */,
+				4D0B81C41657473100DEF560 /* Release */,
+			);
+			defaultConfigurationIsVisible = 0;
+		};
+/* End XCConfigurationList section */
+	};
+	rootObject = 4D0B81831657473000DEF560 /* Project object */;
+}

data/test/test_pbxplorer.rb

@@ -0,0 +1,132 @@
+require "rubygems"
+require "tempfile"
+require "test/unit"
+require "pbxplorer"
+
+class XCProjectFileTest < Test::Unit::TestCase
+	def setup
+		@pf = XCProjectFile.new "test"
+	end
+
+	def test_read
+		assert_not_nil @pf.project
+		assert_equal @pf.uuids.length, 63
+		assert_equal @pf.objects.length, 63
+	end
+	
+	def test_objects_of_class
+		assert_equal @pf.objects_of_class(PBXObject).length, 63
+		assert_equal @pf.objects_of_class(PBXBuildPhase).length, 7
+		assert_equal @pf.objects_of_class(PBXSourcesBuildPhase).length, 2
+		
+		assert_equal @pf.objects_of_class(PBXFileReference).length, 19
+		objs = @pf.objects_of_class PBXFileReference, {"name" => "Foundation.framework"}
+		assert_equal objs.length, 1
+		assert_equal @pf.objects_of_class(PBXBuildFile, {"fileRef" => objs.first.uuid}).length, 2
+	end
+	
+	def test_objects_with_uuids
+		fr = @pf.objects_of_class(PBXFileReference, {"name" => "Foundation.framework"}).first
+		objs = @pf.objects_of_class(PBXBuildFile, {"fileRef" => fr.uuid})
+		uuids = objs.map {|obj| obj.uuid}
+	
+		assert_equal @pf.objects_with_uuids(uuids).length, 2
+		uuids << "garbage"
+		assert_equal @pf.objects_with_uuids(uuids).length, 2
+	end
+	
+	def test_object_with_uuid
+		assert_not_nil @pf.object_with_uuid(@pf.project.uuid)
+		assert_nil @pf.object_with_uuid("garbage")
+	end
+	
+	def test_create_remove_object
+		obj = @pf.add_object PBXFileReference.new
+		assert_equal @pf.objects.length, 64
+		assert_not_nil @pf.object_with_uuid(obj.uuid)
+
+		@pf.remove_object obj
+		assert_equal @pf.objects.length, 63
+		assert_nil @pf.object_with_uuid(obj.uuid)
+	end
+	
+	def test_add_remove_object
+		obj = PBXFileReference.new
+		@pf.add_object obj
+		assert_equal @pf.objects.length, 64
+		assert_not_nil @pf.object_with_uuid(obj.uuid)
+		
+		@pf.remove_object obj
+		assert_equal @pf.objects.length, 63
+		assert_nil @pf.object_with_uuid(obj.uuid)
+	end
+	
+	def test_save
+			path = nil
+			Tempfile.open("test_save_") { |f| path = f.path }
+			@pf.save path
+			new_pf = XCProjectFile.new path
+
+			assert_not_nil new_pf
+			assert_equal @pf.objects.length, new_pf.objects.length
+	end
+	
+	def test_edit_save
+		  path = nil
+			Tempfile.open("test_save_") { |f| path = f.path }
+
+			obj = @pf.add_object PBXFileReference.new
+			@pf.save path
+
+			old_pf = XCProjectFile.new "test"
+			new_pf = XCProjectFile.new path
+			
+			assert_not_nil new_pf
+			assert_equal (old_pf.objects.length + 1), new_pf.objects.length
+			assert_nil old_pf.object_with_uuid obj.uuid
+			assert_not_nil new_pf.object_with_uuid obj.uuid
+	end
+	
+	def test_remove_file_ref
+			path = nil
+		  Tempfile.open("test_save_") { |f| path = f.path }
+
+			fr = @pf.objects_of_class(PBXFileReference, {"name" => "Foundation.framework"}).first
+			bfs = @pf.objects_of_class(PBXBuildFile, {"fileRef" => fr.uuid})
+			@pf.remove_file_ref fr
+			@pf.save path
+		  
+		  old_pf = XCProjectFile.new "test"
+		  new_pf = XCProjectFile.new path
+		  
+		  assert_not_nil new_pf
+		  assert_equal (old_pf.objects.length - 3), new_pf.objects.length
+		  (bfs + [fr]).each do |obj|
+  			assert_not_nil old_pf.object_with_uuid obj.uuid
+	  	  assert_nil new_pf.object_with_uuid obj.uuid
+	  	end
+	end
+end
+
+class PBXProjectTest < Test::Unit::TestCase
+	def setup
+		@project = XCProjectFile.new("test").project
+	end
+
+	def test_properties
+		assert_equal @project.targets.length, 2
+		assert_equal @project.build_configuration_list.uuid, "4D0B81861657473000DEF560"
+		assert_equal @project.main_group.uuid, "4D0B81811657473000DEF560"
+	end
+end
+
+class XCConfigurationListTest < Test::Unit::TestCase
+	def setup
+		@list = XCProjectFile.new("test").project.build_configuration_list
+	end
+	
+	def test_properties
+		assert_equal @list.build_configurations.length, 2
+	end
+end
+

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: pbxplorer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Mark Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-03-19 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: pbxplorer is a set of Ruby classes for parsing, editing, and saving Xcode project (.pbxproj) files. It can also be used to explore the contents of a project using the interactive Ruby shell.
+email: mark@camazotz.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- test/project.pbxproj
+- test/test_pbxplorer.rb
+- lib/pbxplorer.rb
+- README.md
+- Rakefile
+- pbxplorer.gemspec
+has_rdoc: true
+homepage: http://github.com/mjmsmith/pbxplorer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Xcode project file editor
+test_files: []
+