xcodeproject 0.1.1

data/.gitignore

@@ -0,0 +1,32 @@
+# OSX
+.DS_Store
+._*
+.Spotlight-V100
+.Trashes
+
+# .gitignore
+.gitignore
+
+# vim
+.*.sw[a-z]
+*.un~
+Session.vim
+
+# ruby
+*.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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrey Nesterov
+
+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,14 @@
+XCodeProject
+===
+Ruby API for working with Xcode project files
+
+Installation
+---
+`gem install xcodeproject`
+
+License
+---
+XCodeProject is provided under the terms of the [the MIT license][license]
+
+[license]:http://www.opensource.org/licenses/MIT
+

data/lib/xcodeproject/build_phase_node.rb

@@ -0,0 +1,87 @@
+require 'xcodeproject/node'
+require 'xcodeproject/pbx_build_file'
+
+module XCodeProject
+	class BuildPhaseNode < Node
+		def initialize (root, uuid, data)
+			super(root, uuid, data)
+			@files = data['files']
+		end
+
+		def files
+			build_files.map {|obj| obj.file_ref }
+		end
+
+		def add_file (file_obj)
+			case file_obj
+				when PBXFileReference
+					add_build_file(file_obj.uuid)
+				when PBXBuildFile
+					add_build_file_uuid(file_obj.uuid)
+				else 
+					raise ArgumentError.new("Wrong argument type, expected the PBXFileReference or PBXBuildFile.")
+			end
+		end
+
+		def remove_file (file_obj)
+			case file_obj
+				when PBXFileReference
+					remove_build_file(file_obj.uuid)
+				when PBXBuildFile
+					remove_build_file_uuid(file_obj.uuid)
+				else 
+					raise ArgumentError.new("Wrong argument type, expected the PBXFileReference or PBXBuildFile.")
+			end
+		end
+
+		def doctor
+			@files.each do |uuid|
+				obj = root.object(uuid)
+				if obj.nil?
+					remove_build_file_uuid(uuid)
+					puts "removed #{uuid}"
+				end
+			end
+		end
+
+	private
+
+		def build_files
+			@files.map {|uuid| root.object!(uuid) }
+		end
+
+		def build_file (file_ref_uuid)
+			build_files.select {|obj| obj.file_ref.uuid == file_ref_uuid }.first
+		end
+
+		def add_build_file (file_ref_uuid)
+			obj = build_file(file_ref_uuid)
+			if obj.nil?
+				obj = PBXBuildFile.add(root, file_ref_uuid)
+				add_build_file_uuid(obj.uuid)
+			end
+			obj
+		end
+
+		def remove_build_file (file_ref_uuid)
+			obj = build_file(file_ref_uuid)
+			remove_build_file_uuid(obj.uuid) unless obj.nil?
+		end
+
+		def add_build_file_uuid (build_file_uuid)
+			@files << build_file_uuid unless @files.include?(build_file_uuid)
+		end
+
+		def remove_build_file_uuid (build_file_uuid)
+			@files.delete(build_file_uuid)
+		end
+	end
+
+	class PBXSourcesBuildPhase < BuildPhaseNode; end
+	class PBXHeadersBuildPhase < BuildPhaseNode; end
+	class PBXResourcesBuildPhase < BuildPhaseNode; end
+	class PBXFrameworksBuildPhase < BuildPhaseNode; end
+	class PBXAppleScriptBuildPhase < BuildPhaseNode; end
+	class PBXShellScriptBuildPhase < BuildPhaseNode; end
+	class PBXCopyFilesBuildPhase < BuildPhaseNode; end
+end

data/lib/xcodeproject/data.rb

@@ -0,0 +1,87 @@
+#--
+# 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/root_node'
+
+module XCodeProject
+	class Data
+		def initialize (data, wd)
+			@root = RootNode.new(data, wd)
+		end
+
+		def project
+			@root.project
+		end
+
+		def targets
+			project.targets
+		end
+
+		def target (name)
+			project.target(name)
+		end
+
+		def main_group
+			project.main_group
+		end
+
+		def group (gpath)
+			main_group.group(gpath)
+		end
+
+		def add_group (gpath)
+			main_group.add_group(gpath)
+		end
+
+		def add_dir(parent_gpath, path)
+			main_group.add_group(parent_gpath).add_dir(path)
+		end
+
+		def remove_group (gpath)
+			main_group.remove_group(gpath)
+		end
+		
+		def file (gpath)
+			main_group.file(gpath)
+		end
+
+		def add_file (parent_gpath, path)
+			main_group.add_group(parent_gpath).add_file(path)
+		end
+
+		def remove_file (gpath)
+			main_group.remove_file(gpath)
+		end
+
+		def doctor
+			targets.each {|target| target.doctor }
+		end
+
+		def to_plist (fmtr = Formatter.new)
+			@root.to_plist
+		end
+
+	private
+		attr_accessor :root
+
+	end
+end

data/lib/xcodeproject/exceptions.rb

@@ -0,0 +1,5 @@
+module XCodeProject
+	class ParseError < StandardError; end
+	class FilePathError < StandardError; end
+	class GroupPathError < StandardError; end
+end

data/lib/xcodeproject/extend/array.rb

@@ -0,0 +1,8 @@
+require 'xcodeproject/formatter'
+
+class Array
+	def to_plist (fmtr = XCodeProject::Formatter.new)
+		items = map { |item| "#{item.to_plist(fmtr)}" }
+		%{(#{fmtr.t2}#{items.join(",#{fmtr.t2}")}#{fmtr.t1})}
+	end
+end

data/lib/xcodeproject/extend/hash.rb

@@ -0,0 +1,11 @@
+require 'xcodeproject/formatter'
+
+class Hash
+	def to_plist (fmtr = XCodeProject::Formatter.new)
+		fmtr.inc
+		items = map { |key, value| "#{key.to_plist(fmtr)} = #{value.to_plist(fmtr)};" }
+		fmtr.dec
+
+		%{{#{fmtr.t2}#{items.join("#{fmtr.t2}")}#{fmtr.t1}}}
+	end
+end

data/lib/xcodeproject/extend/string.rb

@@ -0,0 +1,7 @@
+require 'json'
+
+class String
+	def to_plist (fmtr = nil)
+		to_json
+	end
+end

data/lib/xcodeproject/file_node.rb

@@ -0,0 +1,63 @@
+require 'xcodeproject/node'
+require 'pathname'
+
+module XCodeProject
+	class FileNode < Node
+		attr_reader :name
+		attr_reader :path
+		attr_reader :source_tree
+
+		def initialize (root, uuid, data)
+			super(root, uuid, data)
+
+			@source_tree = data['sourceTree']
+			@name ||= data['name']
+			@path ||= data['path']
+
+			@name ||= File.basename(@path) unless @path.nil?
+		end
+
+		def source_tree
+			SourceTreeMap[@source_tree]
+		end
+
+		def parent
+			root.select_objects do |uuid, data|
+				(data['children'].include?(self.uuid) if data['isa'] == 'PBXGroup') ? true : false
+			end.first
+		end
+
+		def group_path
+			obj = self
+			res = ''
+			begin
+				pn = obj.name ? obj.name : ''
+				res = Pathname.new(pn).join(res)
+			end while obj = obj.parent;
+			res.cleanpath
+		end
+
+		def total_path
+			res = ''
+			case source_tree
+				when :source_root
+					res = path
+				when :group
+					pn = path.nil? ? '' : path
+					res = parent.total_path.join(pn) unless parent.nil?
+				else
+					raise ParseError.new("No such '#{source_tree}' source tree type.")
+			end
+			root.absolute_path(res)
+		end
+
+	private
+
+		SourceTreeMap = {
+			'SOURCE_ROOT' => :source_root,
+			'<group>'     => :group
+		}
+
+	end
+end
+

data/lib/xcodeproject/formatter.rb

@@ -0,0 +1,23 @@
+module XCodeProject
+	class Formatter
+		def initialize
+			@counter = 0
+		end
+
+		def inc
+			@counter += 1
+		end
+
+		def dec
+			@counter -= 1
+		end
+
+		def t1
+			"\n" + "\t" * @counter
+		end
+
+		def t2
+			"\n" + "\t" * (@counter + 1)
+		end
+	end
+end

data/lib/xcodeproject/node.rb

@@ -0,0 +1,15 @@
+module XCodeProject
+	class Node
+		attr_reader :uuid
+		attr_reader :isa
+
+		def initialize (root, uuid, data)
+			@root, @uuid, @data = root, uuid, data
+			@isa = data['isa']
+		end
+		
+		protected
+			attr_accessor :root
+			attr_accessor :data
+	end
+end

data/lib/xcodeproject/pbx_build_file.rb

@@ -0,0 +1,37 @@
+require 'xcodeproject/node'
+
+module XCodeProject
+	class PBXBuildFile < Node
+		attr_reader :file_ref
+
+		def initialize (root, uuid, data)
+			super(root, uuid, data)
+
+			@file_ref = data['fileRef']
+		end
+
+		def file_ref
+			root.object!(@file_ref)
+		end
+
+		def remove!
+			root.project.targets.each {|target| target.remove_source(self) }
+			root.remove_object(uuid)
+		end
+
+		def self.add(root, file_ref_uuid)
+			uuid, data = root.add_object(self.create_object_hash(file_ref_uuid)) 
+			self.new(root, uuid, data)
+		end
+
+	private
+
+		def self.create_object_hash (file_ref_uuid)
+			data = []
+			data << ['isa', 'PBXBuildFile']
+			data << ['fileRef', file_ref_uuid]
+			
+			Hash[ data ]
+		end
+	end
+end

data/lib/xcodeproject/pbx_file_reference.rb

@@ -0,0 +1,53 @@
+require 'xcodeproject/file_node'
+require 'xcodeproject/exceptions'
+
+module XCodeProject
+	class PBXFileReference < FileNode
+		def initialize (root, uuid, data)
+			super(root, uuid, data)
+		end
+
+		def remove!
+			root.build_files(uuid).each do |build_file_obj|
+				build_file_obj.remove!
+			end
+			
+			parent.remove_child_uuid(uuid)
+			root.remove_object(uuid)
+		end
+
+		def self.add(root, path)
+			uuid, data = root.add_object(self.create_object_hash(path)) 
+			self.new(root, uuid, data)
+		end
+
+	private
+
+		def self.create_object_hash (path)
+			path = path.to_s
+			name = File.basename(path)
+			ext = File.extname(path)
+			raise ParseError.new("No such file type '#{name}'.") if !FileTypeMap.include?(ext)
+			
+			data = []
+			data << ['isa', 'PBXFileReference']
+			data << ['sourceTree', '<group>']
+			data << ['fileEncoding', '4'] # utf-8
+			data << ['lastKnownFileType', FileTypeMap[ext]]
+			data << ['path', path]
+			data << ['name', name] if name != path
+
+			Hash[ data ]
+		end
+
+		FileTypeMap = {
+			'.h'   => 'sourcecode.c.h',
+			'.c'   => 'sourcecode.c.c',
+			'.m'   => 'sourcecode.c.objc',
+			'.mm'  => 'sourcecode.cpp.objcpp',
+			'.hpp' => 'sourcecode.cpp.h',
+			'.cpp' => 'sourcecode.cpp.cpp',
+			'.cc'  => 'sourcecode.cpp.cpp'
+		}
+	end
+end

data/lib/xcodeproject/pbx_group.rb

@@ -0,0 +1,169 @@
+require 'xcodeproject/pbx_file_reference'
+require 'xcodeproject/exceptions'
+require 'pathname'
+
+module XCodeProject
+	class PBXGroup < FileNode
+		def initialize (root, uuid, data)
+			super(root, uuid, data)
+			@children = data['children']
+		end
+
+		def children
+			@children.map {|uuid| root.object!(uuid)}
+		end
+
+		def child (gpath)
+			gpath = Pathname.new(gpath).cleanpath
+			
+			if gpath == gpath.basename
+				name = gpath.to_s
+				case name
+					when '.'
+						self
+					when '..'
+						parent
+					else
+						chs = children.select {|obj| obj.name == name }
+						raise GroupPathError.new("The group contains two children with the same name.") if chs.size > 1
+						chs.first
+				end
+			else
+				pn, name = gpath.split
+				group = child(pn)
+				group.child(name) if group.is_a?(PBXGroup)
+			end
+		end
+		
+		def file_ref (gpath)
+			obj = child(gpath)
+			obj.is_a?(PBXFileReference) ? obj : nil
+		end
+
+		def group?
+			data['path'].nil?
+		end
+
+		def dir?
+			not group?
+		end
+
+		def group (gpath)
+			obj = child(gpath)
+			obj.is_a?(PBXGroup) ? obj : nil
+		end
+
+		def add_group (gpath)
+			create_group(gpath)
+		end
+
+		def add_dir (path, gpath = nil)
+			path = absolute_path(path)
+			raise FilePathError.new("No such directory '#{path}'.") unless path.exist?
+
+			gpath ||= path.basename
+			parent = create_group(gpath, path)
+
+			chs = path.entries.select {|obj| obj.to_s =~ /\A\./ ? false : true }
+			chs.each do |pn|
+				parent.absolute_path(pn).directory? ? parent.add_dir(pn) : parent.add_file(pn)
+			end
+			parent
+		end
+	
+		def create_group (gpath, path = nil)
+			gpath = Pathname.new(gpath).cleanpath
+			
+			if gpath == gpath.basename
+				name = gpath.to_s
+				case name
+					when '.'
+						self
+					when '..'
+						parent
+					else
+						obj = group(name)
+						if obj.nil?
+							path = relative_path(path) unless path.nil?
+							obj = PBXGroup.add(root, name, path)
+							add_child_uuid(obj.uuid)
+						end
+						obj
+					end
+			else
+				pn, name = gpath.split
+				create_group(pn).create_group(name)
+			end
+		end
+
+		def add_child_uuid (uuid)
+			@children << uuid
+		end
+
+		def remove_child_uuid (uuid)
+			@children.delete(uuid)
+		end
+
+		def absolute_path (path)
+			path = Pathname.new(path)
+			path.absolute? ? path : root.absolute_path(total_path.join(path))
+		end
+
+		def relative_path (path)
+			path = Pathname.new(path)
+			path.relative? ? path : path.relative_path_from(total_path)
+		end
+
+		def remove_group (gpath)
+			obj = group(gpath)
+			obj.remove! unless obj.nil?
+		end
+
+		def remove!
+			return if parent.nil?
+
+			children.each do |obj|
+				obj.remove!
+			end
+
+			parent.remove_child_uuid(uuid)
+			root.remove_object(uuid)
+		end
+		
+		def add_file_ref (path)
+			raise FilePathError.new("No such file '#{absolute_path(path)}'.") unless absolute_path(path).exist?
+
+			name = File.basename(path)
+			obj = file_ref(name)
+			if obj.nil?
+				obj = PBXFileReference.add(root, relative_path(path))
+				add_child_uuid(obj.uuid)
+			end
+			obj
+		end
+
+		def self.add(root, name, path = nil)
+			uuid, data = root.add_object(self.create_object_hash(name, path))
+			PBXGroup.new(root, uuid, data)
+		end
+
+		alias :file     :file_ref
+		alias :add_file :add_file_ref
+
+	private
+
+		def self.create_object_hash (name, path = nil)
+			path = path.to_s
+
+			data = []
+			data << ['isa', 'PBXGroup']
+			data << ['children', []]
+			data << ['name', name]
+			data << ['path', path] unless path.empty?
+			data << ['sourceTree', '<group>']
+
+			Hash[ data ]
+		end
+	end
+end
+