xcodeproject 0.1.1

data/lib/xcodeproject/root_node.rb

@@ -0,0 +1,117 @@
+#--
+# Copyright 2012 by Andrey Nesterov (ae.nesterov@gmail.com)
+#
+# 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.
+#++
+
+require 'xcodeproject/xc_build_configuration'
+require 'xcodeproject/pbx_native_target'
+require 'xcodeproject/pbx_project'
+require 'xcodeproject/pbx_group'
+require 'xcodeproject/build_phase_node'
+require 'xcodeproject/uuid_generator'
+require 'xcodeproject/exceptions'
+require 'xcodeproject/extend/string'
+require 'xcodeproject/extend/array'
+require 'xcodeproject/extend/hash'
+
+module XCodeProject
+	class RootNode
+		def initialize (data, wd)
+			@data, @wd = data, Pathname.new(wd)
+
+			@objects = data['objects']
+			@uuid_generator = UUIDGenerator.new
+		end
+
+		def project
+			find_object!('PBXProject')
+		end
+	
+		def build_files (file_ref_uuid)
+			find_objects('PBXBuildFile', {'fileRef' => file_ref_uuid})
+		end
+		
+		def object (uuid)
+			data = @objects[uuid]
+			XCodeProject.const_get(data['isa']).new(self, uuid, data) unless data.nil?
+		end
+
+		def object! (uuid)
+			obj = object(uuid)
+			raise ParseError.new("Object with uuid = #{uuid} not found.") if obj.nil?; obj
+		end
+
+		def select_objects
+			objs = @objects.select {|uuid, data| yield uuid, data }
+			objs.map {|uuid, data| object(uuid) }
+		end
+
+		def find_objects (isa, hash = Hash.new)
+			hash.merge!(Hash[ 'isa',  isa ])
+			select_objects {|uuid, data| data.values_at(*hash.keys) == hash.values }
+		end
+
+		def find_objects! (isa, hash = Hash.new)
+			objs = find_objects(isa, hash)
+			raise ParseError.new("Object with isa = #{isa} and #{hash} not found.") if objs.empty?; objs
+		end
+		
+		def find_object (isa, hash = Hash.new)
+			find_objects(isa, hash).first
+		end
+
+		def find_object! (isa, hash = Hash.new)
+			obj = find_object(isa, hash)
+			raise ParseError if obj.nil?; obj
+		end
+
+		def find_object2 (isa, h1 = Hash.new, h2 = Hash.new)
+			obj = find_object(isa, h1)
+			obj.nil? ? find_object(isa, h2) : obj
+		end
+
+		def find_object2! (isa, h1 = Hash.new, h2 = Hash.new)
+			obj = find_object2(isa, h1, h2)
+			raise ParseError if obj.nil?; obj
+		end
+
+		def add_object (data)
+			@objects.merge!(Hash[ uuid = generate_object_uuid, data ]); [uuid, data]
+		end
+
+		def remove_object (uuid)
+			@objects.delete(uuid)
+		end
+
+		def absolute_path (path)
+			path = Pathname.new(path)
+			path = path.absolute? ? path : @wd.join(path)
+			path.cleanpath
+		end
+
+		def generate_object_uuid
+			@uuid_generator.generate
+		end
+
+		def to_plist (fmtr = Formatter.new)
+			@data.to_plist
+		end
+	end
+end

data/lib/xcodeproject/spec/build_phase_node_spec.rb

@@ -0,0 +1,95 @@
+require "spec_helper"
+
+describe XCodeProject::BuildPhaseNode do
+	let(:root)       { prepare_example_project.read.send(:root) }
+	let(:file_ref)   { root.project.main_group.file_ref('group1a/file2c.m') }
+	let(:build_file) { root.project.target('example').sources_build_phase.send(:build_file, file_ref.uuid) }
+	let(:obj)        { obj = root.project.target('example').sources_build_phase }
+
+	describe "#files" do
+		it "returns an array of files" do
+			obj.files.should be_an_instance_of(Array)
+			obj.files.each {|obj| obj.should be_an_instance_of(XCodeProject::PBXFileReference) }
+		end
+	end
+	
+	describe "#add_file" do
+		context "if passed an object of the PBXFileReference type" do
+			it "=> add_build_file" do
+				mock(obj).add_build_file(file_ref.uuid)
+				obj.add_file(file_ref)
+			end
+		end
+		context "if passed an object of the PBXBuildFile type" do
+			it "=> add_build_file_uuid" do
+				mock(obj).add_build_file_uuid(build_file.uuid)
+				obj.add_file(build_file)
+			end
+		end
+		context "if passed the object of unsupported type" do
+			it "raise an exception" do
+				lambda { obj.add_file(stub) }.should raise_exception(ArgumentError)
+			end
+		end
+	end
+	
+	describe "#remove_file" do
+		context "if passed an object of the PBXFileReference type" do
+			it "=> remove_build_file_uuid" do
+				mock(obj).remove_build_file_uuid(root.project.target('example').sources_build_phase.send(:build_file, file_ref.uuid).uuid)
+				obj.remove_file(file_ref)
+			end
+		end
+		context "if passed an object of the PBXBuildFile type" do
+			it "=> remove_build_file_uuid" do
+				mock(obj).remove_build_file_uuid(build_file.uuid)
+				obj.remove_file(build_file)
+			end
+		end
+		context "if passed the object of unsupported type" do
+			it "raise an exception" do
+				lambda { obj.remove_file(stub) }.should raise_exception(ArgumentError)
+			end
+		end
+	end
+
+	describe "#build_files" do
+		it "returns an array of files" do
+			obj.send(:build_files).should be_an_instance_of(Array)
+			obj.send(:build_files).each {|obj| obj.should be_an_instance_of(XCodeProject::PBXBuildFile) }
+		end
+	end
+
+	describe "#build_file" do
+		it "returns the object" do
+			obj.send(:build_file, file_ref.uuid).should be_an_instance_of(XCodeProject::PBXBuildFile)
+		end
+	end
+
+	describe "#add_build_file" do
+		it "adds the build file, returns the object" do
+			obj.send(:add_build_file, file_ref.uuid).should be_an_instance_of(XCodeProject::PBXBuildFile)
+		end
+	end
+
+	describe "#remove_build_file" do
+		it "=> remove_build_file_uuid" do
+			mock(obj).remove_build_file_uuid(build_file.uuid)
+			obj.send(:remove_build_file, file_ref.uuid)
+		end
+	end
+
+	describe "#add_build_file_uuid" do
+		it "adds the build file uuid to the build list" do
+			obj.send(:add_build_file_uuid, build_file.uuid)
+			obj.send(:build_files).map {|obj| obj.uuid }.should include(build_file.uuid)
+		end
+	end
+
+	describe "#remove_build_file_uuid" do
+		it "removes the build file uuid from the build list" do
+			obj.send(:remove_build_file_uuid, build_file.uuid)
+			obj.send(:build_files).map {|obj| obj.uuid }.should_not include(build_file.uuid)
+		end
+	end
+end

data/lib/xcodeproject/spec/file_node_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+
+describe XCodeProject::FileNode do
+	let(:data_name)      { Hash['name', 'file.name'] }
+	let(:data_path)      { Hash['path', 'path/to/file.name'] }
+	let(:data_path_name) { data_path.merge!(data_name) }
+	let(:data_empty)     { Hash.new }
+
+	describe "#name" do
+		context "if the name is initialized " do
+			it "returns the name as is" do
+				[data_name, data_path_name].each do |data|
+					XCodeProject::FileNode.new(stub, stub, data).name.should eql(data['name'])
+				end
+			end
+		end
+		context "if the name isn't initialized" do
+			context "and the path is initialized " do
+				it "returns the name as basename of the path" do
+					XCodeProject::FileNode.new(stub, stub, data_path).name.should eql(File.basename(data_path['path']))
+				end
+			end
+			context "and the path isn't initialized" do
+				it "returns nil" do
+					XCodeProject::FileNode.new(stub, stub, data_empty).name.should be_nil
+				end
+			end
+		end
+	end
+	
+	describe "#path" do
+		context "if the path is initialized " do
+			it "returns the path as is" do
+				[data_path, data_path_name].each do |data|
+					XCodeProject::FileNode.new(stub, stub, data_path).path.should eql(data['path'])
+				end
+			end
+		end
+		context "if the path isn't initialized" do
+			it "returns nil" do
+				XCodeProject::FileNode.new(stub, stub, data_empty).path.should be_nil
+			end
+		end
+	end
+		
+	describe "#parent" do
+		let(:root) { prepare_example_project.read.send(:root) }
+
+		context "if the current object is the main group" do
+			it "returns nil" do
+				root.project.main_group.parent.should be_nil
+			end
+		end
+	end
+
+	shared_examples_for "a file node" do
+		describe "#parent" do
+			context "if the object is nested file node" do
+				it "returns the parent object" do
+					file_nodes_gpaths do |gpath| 
+						main_group.child(gpath).parent.should be_an_instance_of(XCodeProject::PBXGroup)
+					end
+				end
+			end
+		end
+		
+		describe "#group_path" do
+			it "returns the abstract path from project main group" do
+				file_nodes_gpaths.map do |gpath| 
+					main_group.child(gpath).group_path
+				end.should eql(file_nodes_gpaths.map {|gpath| Pathname.new(gpath) })
+			end
+		end
+		
+		describe "#total_path" do
+			it "returns the absolute file path" do
+				file_nodes_gpaths.map do |gpath| 
+					main_group.child(gpath).total_path
+				end.should eql(file_nodes_total_paths.map {|gpath| Pathname.new(gpath) })
+			end
+		end
+	end
+end

data/lib/xcodeproject/spec/pbx_build_file_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe XCodeProject::PBXBuildFile do
+	let(:root)         { prepare_example_project.read.send(:root) }
+	let(:obj_file_ref) { root.project.main_group.file_ref("group1a/file2c.m") }
+	let(:obj)          { root.project.target('example').sources_build_phase.send(:build_file, obj_file_ref.uuid) }
+
+	describe "#file_ref" do
+		it "returns the object" do
+			obj.file_ref.should be_an_instance_of(XCodeProject::PBXFileReference)
+		end
+	end
+
+	describe "#remove!" do
+		it "removes the current build file" do
+			obj.remove!
+			root.project.target('example').sources_build_phase.send(:build_file, obj_file_ref.uuid).should be_nil
+		end
+		it "removes the current build file from all targets" do
+			root.project.targets.each do |target|
+				target.sources.map {|obj| obj.uuid }.should_not include(obj.uuid)
+			end
+		end
+	end
+end

data/lib/xcodeproject/spec/pbx_file_reference_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe XCodeProject::PBXFileReference do
+	let(:root)      { prepare_example_project.read.send(:root) }
+	let(:obj_gpath) { "group1a/file2c.m" }
+	let(:obj)       { root.project.main_group.file_ref(obj_gpath) }
+
+	describe "#remove!" do
+		it "removes the current file reference" do
+			obj.remove!
+			root.project.main_group.file_ref(obj_gpath).should be_nil
+		end
+		it "removes build files which has been bonded with the current file reference" do
+			obj.remove!
+			root.build_files(obj.uuid).should be_empty
+		end
+	end
+	
+	it_behaves_like "a file node" do
+		let(:main_group) {
+			root.project.main_group
+		}
+		let(:file_nodes_gpaths) {[
+			"group1a/dir2c/dir3a/dir4a/file5a-a.m",
+			"group1a/dir2c/dir3a/dir4a/file5a-r.m",
+			"group1a/file2c.m"
+		]}
+		let(:file_nodes_total_paths) {[
+			"#{example_project_dir}/dir1a/dir2a/dir3a/dir4a/file5a-a.m",
+			"#{example_project_dir}/dir1a/dir2a/dir3a/dir4a/file5a-r.m",
+			"#{example_project_dir}/dir1c/file2c.m"
+		]}
+	end
+end

data/lib/xcodeproject/spec/pbx_group_spec.rb

@@ -0,0 +1,274 @@
+require "spec_helper"
+
+describe XCodeProject::PBXGroup do
+	let(:root) { prepare_example_project.read.send(:root) }
+	let(:obj)  { root.project.main_group.group('group1a') }
+
+	describe "#children" do
+		context "if children exists" do
+			it "returns an array of children objects" do
+				obj.children.should be_an_instance_of(Array)
+				obj.children.size.should > 0
+			end
+		end
+		context "if children doesn't exist" do
+			let(:empty_group_obj) { root.project.main_group.group("group1a/group2a") }
+
+			it "returns an empty array" do
+				empty_group_obj.children.should be_an_instance_of(Array)
+				empty_group_obj.children.size.should eql(0)
+			end
+		end
+	end
+
+	describe "#child" do
+		context "if passed '.'" do
+			it "returns the self" do
+				obj.child('.').uuid.should eql(obj.uuid)
+			end
+		end
+		context "if passed '..'" do
+			it "returns the parent" do
+				obj.child('..').uuid.should eql(obj.parent.uuid)
+			end
+		end
+		context "if passed a child name" do
+			it "returns the child object" do
+				[
+					'group2a',
+					'dir2c',
+					'file2c.m'
+				].each do |name|
+					obj.child(name).should_not be_nil
+				end
+			end
+		end
+		context "if passed the group path" do
+			it "returns the child object" do
+				[
+					'dir2c/dir3a',
+					'dir2c/dir3a/dir4a/file5a-a.m',
+					'dir2c/dir3a/dir4a/file5a-r.m',
+					'dir2c/../dir2c/dir3a/./dir4a/file5a-r.m'
+				].each do |gpath|
+					obj.child(gpath).should_not be_nil
+				end
+			end
+		end
+		context "if child doesn't exist" do
+			it "returns nil" do
+				[
+					'group2a_ghost',
+					'group2a_ghost/file3c_ghost.m',
+					'dir2c/file3c_ghost.m'
+				].each do |gpath|
+					obj.child(gpath).should be_nil
+				end
+			end
+		end
+	end
+
+	describe "#group?" do
+		let(:dir_obj) { obj.child('dir2c') }
+
+		context "if the current group is abstract" do
+			it "returns true" do
+				obj.group?.should eql(true)
+			end
+		end
+		context "if the current group is directory" do
+			it "returns false" do
+				dir_obj.group?.should eql(false)
+			end
+		end
+	end
+
+	describe "#dir?" do
+		let(:dir_obj) { obj.child('dir2c') }
+
+		context "if the current group is directory" do
+			it "returns true" do
+				dir_obj.dir?.should eql(true)
+			end
+		end
+		context "if the current group is abstract" do
+			it "returns false" do
+				obj.dir?.should eql(false)
+			end
+		end
+	end
+
+	describe "#group" do
+		context "if the group exists" do
+			it "returns the object" do
+				obj.group('group2a').should be_an_instance_of(XCodeProject::PBXGroup)
+			end
+		end
+		context "if the group doesn't exist" do
+			it "returns nil" do
+				obj.group('group2a_ghost').should be_nil
+			end
+		end
+	end
+
+	describe "#file_ref" do
+		context "if the file reference exists" do
+			it "returns the object" do
+				obj.file_ref('file2c.m').should be_an_instance_of(XCodeProject::PBXFileReference)
+			end
+		end
+		context "if the file reference doesn't exist" do
+			it "returns nil" do
+				obj.file_ref('file2c_ghost.m').should be_nil
+			end
+		end
+	end
+
+	describe "#add_file_ref" do
+		context "if passed the relative path" do
+			it "adds the file reference, returns the object" do
+				obj.send(:add_file_ref, 'dir1b/file2b.m').should be_an_instance_of(XCodeProject::PBXFileReference)
+			end
+		end
+		context "if passed the absolute path" do
+			it "adds the file reference, returns the object" do
+				obj.send(:add_file_ref, "#{example_project_dir}/dir1b/file2b.m").should be_an_instance_of(XCodeProject::PBXFileReference)
+			end
+		end
+		context "if file reference already exists" do
+			it "new object has same uuid as existing" do
+				uuid = obj.file_ref('file2c.m').uuid
+				obj.send(:add_file_ref, 'dir1c/file2c.m').uuid.should eql(uuid)
+			end
+		end
+		context "if file doesn't exit" do
+			it "raise an exception " do
+				lambda { obj.send(:add_file_ref, "file2c_ghost.m") }.should raise_exception(XCodeProject::FilePathError)
+			end
+		end
+	end
+
+	describe "#add_group" do
+		it "adds the group, returns the object" do
+			group_obj = obj.add_group("group2a_ghost")
+			group_obj.should be_an_instance_of(XCodeProject::PBXGroup)
+			group_obj.group?.should eql(true)
+		end
+	end
+
+	describe "#add_dir" do
+		it "adds the group, returns the object" do
+			group_obj = obj.add_dir("dir1c")
+			group_obj.should be_an_instance_of(XCodeProject::PBXGroup)
+			group_obj.dir?.should eql(true)
+		end
+		it "adds all dir's children" do
+			obj.add_dir('dir1c')
+			[
+				obj.group('dir1c'),
+				obj.group('dir1c/dir2c'),
+				obj.file('dir1c/file2c.m')
+			].each {|obj| obj.should_not be_nil }
+		end
+		context "if dir doesn't exit" do
+			it "raise an exception " do
+				lambda { obj.add_dir("dir2c_ghost") }.should raise_exception(XCodeProject::FilePathError)
+			end
+		end
+	end
+
+	describe "#create_group" do
+		context "if passed a group name" do
+			it "creates and returns the group object" do
+				obj.create_group('group2a_ghost').should be_an_instance_of(XCodeProject::PBXGroup)
+			end
+		end
+		context "if passed a group path" do
+			it "creates missed groups and returns the last group object" do
+				[
+					'group2a/group3a_ghost',
+					'group2a_ghost/group3a_ghost',
+					'group2a_ghost/../create_group2a_ghost/./group3a_ghost'
+				].each do |gpath|
+					obj.create_group(gpath).should be_an_instance_of(XCodeProject::PBXGroup)
+				end
+			end
+		end
+		context "if group already exists" do
+			it "new object has same uuid as existing" do
+				uuid = obj.child('group2a').uuid
+				obj.create_group('group2a').uuid.should eql(uuid)
+			end
+		end
+	end
+
+	describe "#remove_group" do
+		context "if the group exists" do
+			it "removes the object" do
+				obj.remove_group('group2a')
+				obj.group('group2a').should be_nil
+			end
+		end
+		context "if the group doesn't exist" do
+			it "returns nil" do
+				obj.remove_group('group2a_ghost').should be_nil
+			end
+		end
+	end
+
+	describe "#remove!" do
+		it "removes the current group" do
+			obj.remove!
+			root.project.main_group.group('group1a').should be_nil
+		end
+	end
+
+	describe "#absolute_path" do
+		let(:dir_obj) { root.project.main_group.group('group1a/dir2c/dir3a') }
+
+		it "makes the absolute path" do
+			[
+				"dir4a/file5a-a.m",
+				"#{example_project_dir}/dir1a/dir2a/dir3a/dir4a/file5a-a.m"
+			].map {|path| dir_obj.absolute_path(path) }.should eql([
+				Pathname.new("#{example_project_dir}/dir1a/dir2a/dir3a/dir4a/file5a-a.m"),
+				Pathname.new("#{example_project_dir}/dir1a/dir2a/dir3a/dir4a/file5a-a.m")
+			]) 
+		end
+	end
+
+	describe "#relative_path" do
+		let(:dir_obj) { root.project.main_group.group('group1a/dir2c/dir3a') }
+
+		it "makes the relative path" do
+			[
+				"dir4a/file5a-a.m",
+				"#{example_project_dir}/dir1a/dir2a/dir3a/dir4a/file5a-a.m"
+			].map {|path| dir_obj.relative_path(path) }.should eql([
+				Pathname.new("dir4a/file5a-a.m"),
+				Pathname.new("dir4a/file5a-a.m")
+			]) 
+		end
+	end
+
+	it_behaves_like "a file node" do
+		let(:main_group) {
+			root.project.main_group
+		}
+		let(:file_nodes_gpaths) {[
+			"group1a/dir2c/dir3a/dir4a",
+			"group1a/dir2c/dir3a",
+			"group1a/dir2c",
+			"group1a/group2a",
+			"group1a"
+		]}
+		let(:file_nodes_total_paths) {[
+			"#{example_project_dir}/dir1a/dir2a/dir3a/dir4a",
+			"#{example_project_dir}/dir1a/dir2a/dir3a",
+			"#{example_project_dir}/dir1c/dir2c",
+			example_project_dir,
+			example_project_dir
+		]}
+	end
+end
+

data/lib/xcodeproject/spec/pbx_native_target_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe XCodeProject::PBXNativeTarget do
+	before(:each) { @data = prepare_example_project.read }
+	let(:obj)     { obj = @data.target('example') }
+
+	describe "#sources" do
+		it "=> PBXSourcesBuildPhase#files" do
+			files = mock
+			mock(obj).sources_build_phase.mock!.files { files }
+			obj.sources.should eql(files)
+		end
+	end
+
+	describe "#add_source" do
+		it "=> PBXSourcesBuildPhase#add_file" do
+			file = mock
+			mock(obj).sources_build_phase.mock!.add_file(file)
+			obj.add_source(file)
+		end
+	end
+
+	describe "#remove_source" do
+		it "=> PBXSourcesBuildPhase#remove_file" do
+			file = mock
+			mock(obj).sources_build_phase.mock!.remove_file(file)
+			obj.remove_source(file)
+		end
+	end
+
+	describe "#build_configurations_list" do
+		it "returns the build configuration list object" do
+			obj.build_configurations_list.should be_an_instance_of(XCodeProject::XCConfigurationList)
+		end
+	end
+
+	describe "#configs" do
+		it "=> XCConfigurationList#build_configurations" do
+			res = mock
+			mock(obj).build_configurations_list.mock!.build_configurations { res }
+			obj.configs.should eql(res)
+		end
+	end
+
+	describe "#config" do
+		it "=> XCConfigurationList#build_configuration" do
+			name, res = mock, mock
+			mock(obj).build_configurations_list.mock!.build_configuration(name) { res }
+			obj.config(name).should eql(res)
+		end
+	end
+
+	describe "#build_phases" do
+		it "returns the array of build phase objects" do
+			obj.build_phases.should be_an_instance_of(Array)
+		end
+	end
+end