zerg_xcode 0.3.4 → 0.3.5

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.3.5. Under-the-hood functionality.
+
 v0.3.4. Removed warnings, improved tests.
 
 v0.3.3. Fixed wrong error message in addtarget.

data/Manifest

@@ -1,5 +1,13 @@
-bin/zerg-xcode
 CHANGELOG
+LICENSE
+Manifest
+README.textile
+RUBYFORGE
+Rakefile
+bin/zerg-xcode
+lib/zerg_xcode.rb
+lib/zerg_xcode/builder/runner.rb
+lib/zerg_xcode/builder/sdks.rb
 lib/zerg_xcode/file_format/archiver.rb
 lib/zerg_xcode/file_format/encoder.rb
 lib/zerg_xcode/file_format/lexer.rb
@@ -23,17 +31,24 @@ lib/zerg_xcode/plugins/ls.rb
 lib/zerg_xcode/plugins/lstargets.rb
 lib/zerg_xcode/plugins/retarget.rb
 lib/zerg_xcode/shortcuts.rb
-lib/zerg_xcode.rb
-LICENSE
-Manifest
-Rakefile
-README.textile
-RUBYFORGE
+test/builder/runner_test.rb
+test/builder/sdk_test.rb
 test/file_format/archiver_test.rb
 test/file_format/encoder_test.rb
 test/file_format/lexer_test.rb
 test/file_format/parser_test.rb
 test/file_format/path_test.rb
+test/fixtures/ClosedLib/ClosedLib.xcodeproj/project.pbxproj
+test/fixtures/ClosedLib/ClosedLib_Prefix.pch
+test/fixtures/ClosedLib/ClosedNative.c
+test/fixtures/ClosedLib/ClosedNative.h
+test/fixtures/FlatTestApp/FlatTestApp.xcodeproj/project.pbxproj
+test/fixtures/TestApp/TestApp.xcodeproj/project.pbxproj
+test/fixtures/TestApp30.xcodeproj/project.pbxproj
+test/fixtures/TestLib30.xcodeproj/project.pbxproj
+test/fixtures/ZergSupport.xcodeproj/project.pbxproj
+test/fixtures/project.pbxproj
+test/fixtures/project.pbxproj.compat
 test/objects/pbx_build_file_test.rb
 test/objects/pbx_build_phase_test.rb
 test/objects/pbx_container_item_proxy_test.rb
@@ -52,10 +67,3 @@ test/plugins/ls_test.rb
 test/plugins/lstargets_test.rb
 test/plugins/retarget_test.rb
 test/shortcuts_test.rb
-testdata/FlatTestApp/FlatTestApp.xcodeproj/project.pbxproj
-testdata/project.pbxproj
-testdata/project.pbxproj.compat
-testdata/TestApp/TestApp.xcodeproj/project.pbxproj
-testdata/TestApp30.xcodeproj/project.pbxproj
-testdata/TestLib30.xcodeproj/project.pbxproj
-testdata/ZergSupport.xcodeproj/project.pbxproj

data/Rakefile

@@ -1,3 +1,9 @@
+# Rakefile for the zerg_xcode gem.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
 require 'rubygems'
 require 'echoe'
 

data/lib/zerg_xcode.rb

@@ -1,6 +1,8 @@
-module ZergXcode; end
-module ZergXcode::Objects; end
-
+# Main include file for the zerg_xcode gem.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
 
 require 'zerg_xcode/file_format/archiver.rb'
 require 'zerg_xcode/file_format/encoder.rb'
@@ -8,6 +10,9 @@ require 'zerg_xcode/file_format/lexer.rb'
 require 'zerg_xcode/file_format/parser.rb'
 require 'zerg_xcode/file_format/paths.rb'
 
+require 'zerg_xcode/builder/runner.rb'
+require 'zerg_xcode/builder/sdks.rb'
+
 require 'zerg_xcode/objects/xcode_object.rb'
 require 'zerg_xcode/objects/pbx_build_file.rb'
 require 'zerg_xcode/objects/pbx_build_phase.rb'

data/lib/zerg_xcode/builder/runner.rb

@@ -0,0 +1,51 @@
+# Runs the Xcode build process.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+require 'fileutils'
+
+# :nodoc: namespace
+module ZergXcode::Builder
+
+
+# Runs the Xcode build process.
+module Runner
+  # Builds an Xcode project.
+  #
+  # Returns the directory containing the build products, or nil if the build
+  # failed.
+  def self.build(project, sdk, configuration, options = {})
+    return nil unless action(project, sdk, configuration, options, 'build')
+    Dir.glob(File.join(project.root_path, 'build', configuration + '-*')).first
+  end
+  
+  # Removes the build products for an Xcode project.
+  #
+  # Returns true for success, or false if the removal failed.
+  def self.clean(project, sdk, configuration, options = {})
+    return_value = action(project, sdk, configuration, options, 'clean')
+    FileUtils.rm_rf File.join(project.root_path, 'build')
+    return_value
+  end
+  
+  # Executes an action using the Xcode builder.
+  #
+  # Returns true if the action suceeded, and false otherwise.
+  def self.action(project, sdk, configuration, options, verb)
+    # NOTE: not using -parallelizeTargets so the command line is less brittle,
+    #       and to accomodate projects with bad dependencies
+    command = 'xcodebuild -project ' +
+        File.dirname(project.source_filename).inspect +
+        %Q| -sdk #{sdk[:arg]} -configuration #{configuration.inspect} | +
+        '-alltargets ' + options.map { "#{k}=#{v}".inspect }.join(' ') + ' ' +
+        verb.inspect + ' 2>&1'
+    begin
+      output = Kernel.`(command)
+      return (/\*\* .* SUCCEEDED \*\*/ =~ output) ? true : false
+    end
+  end
+end  # module ZergXcode::Builder::Sdk
+
+end  # namespace ZergXcode::Builder

data/lib/zerg_xcode/builder/sdks.rb

@@ -0,0 +1,34 @@
+# Logic for the multiple SDKs in an Xcode installation. 
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module ZergXcode::Builder
+
+
+# Logic for the multiple SDKs in an Xcode installation. 
+module Sdk
+  @all = nil
+  
+  # All the SDKs installed.
+  def self.all
+    return @all if @all
+    
+    output = `xcodebuild -showsdks`
+    @all = []
+    group = ''
+    output.each_line do |line|
+      if line.index '-sdk '
+        name, arg = *line.split('-sdk ').map { |token| token.strip }
+        @all << { :group => group, :name => name, :arg => arg }
+      elsif line.index ':'
+        group = line.split(':').first.strip
+      end
+    end
+    @all
+  end
+end  # module ZergXcode::Builder::Sdk
+
+end  # namespace ZergXcode::Builder

data/lib/zerg_xcode/file_format/archiver.rb

@@ -1,4 +1,15 @@
-module ZergXcode::Archiver
+# Logic for flattening and restoring  PBX (Xcode project) object graphs.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module ZergXcode
+
+
+# Flattens and restores PBX (Xcode project) object graphs.
+module Archiver
   # Unarchives an Xcode object graph from the contents of a file.
   def self.unarchive(string)
     proj_hash = ZergXcode::Parser.parse string
@@ -84,4 +95,6 @@ module ZergXcode::Archiver
       end
     end
   end
-end
+end  # module ZergXcode::Archiver
+
+end  # namespace ZergXcode

data/lib/zerg_xcode/file_format/encoder.rb

@@ -1,4 +1,15 @@
-module ZergXcode::Encoder  
+# Logic for writing flattened object graphs to .pbxproj files.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module ZergXcode
+
+  
+# Writes flattened object graphs to .xcodeproj files.
+module Encoder  
   def self.encode(project)
     "// !$*UTF8*$!\n" + encode_hash(project, 0) + "\n"
   end
@@ -37,4 +48,6 @@ module ZergXcode::Encoder
   def self.encode_indentation(indentation)
     "\t" * indentation
   end
-end
+end  # module ZergXcode::Encoder
+
+end  # namespace ZergXcode

data/lib/zerg_xcode/file_format/lexer.rb

@@ -1,4 +1,15 @@
-module ZergXcode::Lexer
+# Lexer for flattened object graphs stored in .pbxproj files.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module ZergXcode
+
+
+# Lexer for flattened object graphs stored in .xcodeproj files.
+module Lexer
   def self.tokenize(string)
     
     encoding_match = string.match(/^\/\/ \!\$\*(.*?)\*\$\!/)
@@ -57,4 +68,6 @@ module ZergXcode::Lexer
     end
     return tokens
   end
-end
+end  # module ZergXcode::Lexer
+
+end  # namespace ZergXcode

data/lib/zerg_xcode/file_format/parser.rb

@@ -1,4 +1,15 @@
-module ZergXcode::Parser
+# Parser for flattened object graphs stored in .pbxproj files.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module ZergXcode
+
+
+# Parser for flattened object graphs stored in .xcodeproj files.
+module Parser
   def self.parse(project_string)
     tokens = ZergXcode::Lexer.tokenize project_string
     
@@ -43,4 +54,6 @@ module ZergXcode::Parser
     end
     return context[0][0]
   end  
-end
+end  # module ZergXcode::Parser
+
+end  # namespace ZergXcode

data/lib/zerg_xcode/file_format/paths.rb

@@ -1,4 +1,15 @@
-module ZergXcode::Paths
+# Xcode project path resolver.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module ZergXcode
+  
+
+# Finds the .pbxproj file inside an Xcode project.
+module Paths
   # The most likely project file name for the given path. 
   def self.project_file_at(base_path)
     return base_path if File.exist?(base_path) and File.file?(base_path)
@@ -41,4 +52,6 @@ module ZergXcode::Paths
     file = project_file_at base_path
     File.dirname File.dirname(file)
   end
-end
+end  # module ZergXcode::Paths
+
+end  # module ZergXcode

data/lib/zerg_xcode/objects/pbx_build_file.rb

@@ -1,5 +1,15 @@
-# A file used for building. Points to a PBXFileRef.
-class ZergXcode::Objects::PBXBuildFile < ZergXcode::XcodeObject
+# A build input.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module ZergXcode::Objects
+
+
+# A build input. Points to a PBXFileRef.
+class PBXBuildFile < ZergXcode::XcodeObject
   # The name of the referenced file.
   def filename
     self['fileRef']['path']
@@ -34,4 +44,7 @@ class ZergXcode::Objects::PBXBuildFile < ZergXcode::XcodeObject
   def xref_name
     self['fileRef'].xref_name
   end  
-end
+end  # class ZergXcode::Objects:PBXBuildFile
+
+end  # namespace ZergXcode::Objects
+

data/lib/zerg_xcode/objects/pbx_build_phase.rb

@@ -1,12 +1,24 @@
+# The superclass for all the phases of the Xcode build process.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module ZergXcode::Objects
+
+
 # Superclass for all the Xcode build phases.
 #
 # Subclasses include PBXHeadersBuildPhase, PBXSourcesBuildPhase,
 # PBXFrameworksBuildPhase, and PBXResourcesBuildPhase.
-class ZergXcode::Objects::PBXBuildPhase < ZergXcode::XcodeObject  
+class PBXBuildPhase < ZergXcode::XcodeObject  
   # Creates a new build phase with the given isa type.
   def self.new_phase(isa_type)
     self.new 'isa' => isa_type.to_s, 'dependencies' => [], 'files' => [],
              'buildActionMask' => '2147483647',
              'runOnlyForDeploymentPostprocessing' => '0' 
   end
-end
+end  # class ZergXcode::Objects::PBXBuildPhase
+
+end  # namespace ZergXcode::Objects

data/lib/zerg_xcode/objects/pbx_container_item_proxy.rb

@@ -1,8 +1,18 @@
+# Proxy for another Xcode object.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module ZergXcode::Objects
+
+
 # Proxy for another object.
 #
 # Unsure these are useful, since each object has an unique ID. They are probably
 # implementation artifacts.
-class ZergXcode::Objects::PBXContainerItemProxy < ZergXcode::XcodeObject
+class PBXContainerItemProxy < ZergXcode::XcodeObject
   # The proxied object.
   def target
     self['remoteGlobalIDString']
@@ -20,4 +30,6 @@ class ZergXcode::Objects::PBXContainerItemProxy < ZergXcode::XcodeObject
   def xref_name
     self['remoteInfo']
   end  
-end
+end  # class ZergXcode::Objects::PBXContainerItemProxy
+
+end  # namespace ZergXcode::Objects

data/lib/zerg_xcode/objects/pbx_group.rb

@@ -1,3 +1,43 @@
-# A group of files.
-class ZergXcode::Objects::PBXGroup < ZergXcode::XcodeObject
-end
+# A group of files (shown as a folder) in an Xcode project.
+#
+# Author:: Christopher Garrett
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module ZergXcode::Objects
+
+
+# A group of files (shown as a folder) in an Xcode project.
+class PBXGroup < ZergXcode::XcodeObject
+  def find_group_named(group_name)
+    self['children'].each do |child|
+      if child.isa == :PBXGroup
+        if child.xref_name == group_name
+          return child
+        elsif grandchild = child.find_group_named(group_name)
+          return grandchild
+        end
+      end
+    end
+    return nil
+  end
+  
+  def children
+    self['children']
+  end
+  
+  def create_group(path_name, group_name=nil, source_tree='<group>')
+    group_name = group_name || path_name
+    unless group = find_group_named(group_name)
+      group = ZergXcode::Objects::PBXGroup.new 'name' => group_name, 
+                                               'path' => path_name, 
+                                               'children' => [], 
+                                               'sourceTree' => source_tree
+      self.children << group
+    end
+    group
+  end
+end  # class ZergXcode::Objects::PBXGroup
+
+end  # namespace ZergXcode::Objects

data/lib/zerg_xcode/objects/pbx_native_target.rb

@@ -1,5 +1,15 @@
-# An Xcode target.
-class ZergXcode::Objects::PBXNativeTarget < ZergXcode::XcodeObject
+# An Xcode build target.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+# :nodoc: namespace
+module ZergXcode::Objects
+
+
+# An Xcode build target.
+class PBXNativeTarget < ZergXcode::XcodeObject
   # All the files referenced by this target.
   # Returns:
   #   an array containing a hash for each file with
@@ -16,4 +26,6 @@ class ZergXcode::Objects::PBXNativeTarget < ZergXcode::XcodeObject
     end
     files
   end
-end
+end  # class ZergXcode::Objects::PBXNativeTarget
+
+end  # namespace class ZergXcode::Objects