xcoder 0.1.1 → 0.1.2

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/TestProject/TestProject.xcodeproj/xcuserdata
+spec/TestProject/TestProject.xcodeproj/project.xcworkspace/
+spec/TestProject/build
+spec/test-reports

data/.rvmrc

@@ -0,0 +1,4 @@
+rvm use 1.9.2@xcoder
+rvm_install_on_use_flag=1
+rvm_project_rvmrc=1
+rvm_gemset_create_on_use_flag=1

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gemspec
+gem 'builder'
+gem 'json'
+gem 'plist'
+gem 'rest-client'
+
+group :test do
+  gem 'rspec'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'ruby-debug19'
+end

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :cli => "--color --format d --tag ~integration" do
+  
+  watch(%r{^spec/.+_spec\.rb$})
+  # As the registry and resource file affect most every file, the entire
+  # suite should be run when they are changed
+  watch(%r{^lib/xcode/(?:registry|resource)\.rb$}) { "spec" }
+  watch(%r{^lib/xcode/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/README.md

@@ -0,0 +1,142 @@
+# XCoder
+
+A ruby wrapper around various xcode tools and project, schemes and workspace configuration files
+
+## Example Usage
+
+You will need to install the gem:
+
+	gem install xcoder
+
+and then require the gem in your project/rakefile/etc
+
+	require 'xcoder'
+	
+### Load a project
+
+    project = Xcode.project('MyProject')  # Can be the name, the file (e.g. MyProject.xcodeproj) or the path
+
+### Finding all projects from the current directory down
+
+	Xcode.find_projects.each {|p| puts p.name }
+	
+### Find a configuration for a target on a project
+
+	config = Xcode.project(:MyProject).target(:Target).config(:Debug)	# returns an Xcode::Configuration object
+
+### Building a configuration
+
+	builder = config.builder
+	builder.profile = 'Profiles/MyAdHoc.mobileprovision'	# This will remove old profiles and install the profile
+	builder.identity = 'iPhone Developer: Ray Hilton'		# The name of the identity to use to sign the IPA (optional)
+	builder.build
+	
+### Working with Keychains
+	
+You will not normally need to worry about manipulating keychains unless you want to automate importing of certificates (in a CI system with many clients) or opening of specific keychains for different builds (the old two-certs-with-same-identity-name workaround).
+
+You can either use the user's login keychain, another named keychain, or simply use a temporary keychain that will be blown away after the build.
+
+#### Creating a temporary keychain
+
+	Xcode::Keychain.temp_keychain('ProjectKeychain.keychain') do |keychain|
+		# import certs into the keychain
+		# perform builds within this keychain's context
+	end	# Keychain is deleted
+		
+#### Importing a certificate
+
+You can import a certificate from a .p12 file into a keychain.  Here we simply create a temporary keychain, import a certificate, set the identity onto the builder and then perform a build.
+ 
+	keychain.import 'Certs/MyCert.p12', 'mycertpassword'		
+	builder.keychain = keychain						# Tell the builder to use the temp keychain
+	builder.identity = keychain.identities.first	# Get the first (only) identity name from the keychain
+	
+### Packaging a built .app
+
+After performing the above build, you can create a versioned, well named .ipa and .dSYM.zip
+
+	builder.package
+	
+This will produce something like: MyProject-Debug-1.0.ipa and MyProject-Debug-1.0.dSYM.zip
+
+### Incrementing the build number
+
+	config.info_plist do |info|
+	  info.version = info.version.to_i + 1
+	  info.save
+	end
+
+### Working with workspaces
+
+Loading workspaces can be done in a similar way to projects:
+
+	Xcode.workspaces.each do |w|
+	  w.describe								# prints a recursive description of the 
+												# structure of the workspace and its projects
+	end
+	
+Or, if you know the name:
+
+	workspace = Xcode.workspace('MyWorkspace')  # Can be the name, the file (e.g. MyWorkspace.xcworkspace) or the path
+	
+	
+### Schemes
+
+There is basic support for schemes, you can enumerate them from a project like so:
+
+	project.schemes.each do |s|
+	  s.builder.build
+	end
+	
+Or, access them by name:
+
+	builder = project.scheme('MyScheme').builder
+	
+Note: The builder behaves the same as the builder for the target/config approach and will force xcodebuild to use the local build/ directory (as per xcode3) rather than a generated temporary directory in DerivedData.  This may or may not be a good thing.
+
+Note: Shared schemes and user (current logged in user) specific schemes are both loaded. They may share names and other similarities that make them hard to distinguish. Currently the priority loading order is shared schemes and then user specific schemes.
+
+### Provisioning profiles
+
+The library provides a mechanism to install/uninstall a provisioning profile.  This normally happens as part of a build (if a profile is provided to the builder, see above), but you can do this manually:
+
+	Xcode::ProvisioningProfile.new("Myprofile.mobileprovision").install	# installs profile into ~/Library
+	
+Or enumerate installed profiles:
+   
+	Xcode::ProvisioningProfile.installed_profiles.each do |p|
+		p.uninstall		# Removes the profile from ~/Library/
+	end
+
+### Testflight
+
+The common output of this build/package process is to upload to testflight.  This is pretty simple with xcoder:
+
+	builder.testflight(API_TOKEN, TEAM_TOKEN) do |tf|
+	  tf.notes = "some release notes"
+ 	  tf.notify = true	# Whether to send a notification to users, default is true
+      tf.lists << "AList"  # The lists to distribute the build to
+	end
+	
+You can also optionally set a .proxy= property or just set the HTTP_PROXY environment variable.
+
+### OCUnit to JUnit reports
+
+You can invoke your test target/bundle from the builder
+
+	builder.test do |report|
+		report.write 'test-reports', :junit
+	end
+	
+This will invoke the test target, capture the output and write the junit reports to the test-reports directory.  Currently only junit is supported.
+
+## Tests
+
+There are some basic RSpec tests in the project which I suspect /wont/ work on machines without my identity installed.  
+
+Currently these tests only assert the basic project file parsing and build code and do not perform file modification tests (e.g. for info plists) or provisioning profile/keychain importing
+	
+## Feedback
+
+Please raise issues if you find defects or have a feature request.  

data/Rakefile

@@ -0,0 +1,28 @@
+require "bundler/gem_tasks"
+
+task :default => [:specs, :build]
+
+task :specs do
+  system "rspec --color --format d --tag ~integration"
+end
+
+task :integration do
+  system "rspec --color --format d --tag integration"
+end
+
+
+task :reset => ['test_project:reset']
+
+namespace :test_project do
+  
+  task :reset do
+    puts "Reseting the TestProject Project File"
+    system "git co -- spec/TestProject"
+    puts "Removing any User schemes generated for in the project"
+    system "rm -rf spec/TestProject/TestProject.xcodeproj/xcuserdata"
+    puts "Removing any installed files"
+    system "git clean -df spec/TestProject"
+  end
+  
+end
+

data/lib/xcode/build_file.rb

@@ -0,0 +1,22 @@
+module Xcode
+  
+  #
+  # PBXBuildFile are entries within the project that create a link between the
+  # file and the PBXFileReference. One is created for each file added to a build
+  # target.
+  # 
+  module BuildFile
+    
+    #
+    # Create the properties hash for a build file with the given file reference
+    # identifier.
+    # 
+    # @param [String] file_identifier the unique identifier for the file
+    # @return [Hash] the properties hash for a default BuildFile.
+    # 
+    def self.with_properties file_identifier
+      { 'isa' => "PBXBuildFile", 'fileRef' => file_identifier }
+    end
+    
+  end
+end

data/lib/xcode/build_phase.rb

@@ -0,0 +1,92 @@
+module Xcode
+  
+  module BuildPhase
+    
+    # 
+    # @return [BuildPhase] the framework specific build phase of the target.
+    # 
+    # @example
+    # 
+    #     7165D44D146B4EA100DE2F0E /* Frameworks */ = {
+    #       isa = PBXFrameworksBuildPhase;                                        
+    #       buildActionMask = 2147483647;                                         
+    #       files = (                                                             
+    #         7165D455146B4EA100DE2F0E /* UIKit.framework in Frameworks */,       
+    #         7165D457146B4EA100DE2F0E /* Foundation.framework in Frameworks */,  
+    #         7165D459146B4EA100DE2F0E /* CoreGraphics.framework in Frameworks */,
+    #       );                                                                    
+    #       runOnlyForDeploymentPostprocessing = 0;                               
+    #     };                                                                      
+    # 
+    def self.framework
+      { 'isa' => 'PBXFrameworksBuildPhase',
+        'buildActionMask' => '2147483647',
+        'files' => [],
+        'runOnlyForDeploymentPostprocessing' => '0' }
+    end
+    
+    #
+    # @return [BuildPhase] the sources specific build phase of the target.
+    # 
+    def self.sources
+      { 'isa' => 'PBXSourcesBuildPhase',
+        'buildActionMask' => '2147483647',
+        'files' => [],
+        'runOnlyForDeploymentPostprocessing' => '0' }
+    end
+    
+    #
+    # @return [BuildPhase] the resources specific build phase of the target.
+    # 
+    def self.resources
+      { 'isa' => 'PBXResourcesBuildPhase',
+        'buildActionMask' => '2147483647',
+        'files' => [],
+        'runOnlyForDeploymentPostprocessing' => '0' }
+    end
+    
+    #
+    # Return the files that are referenced by the build files. This traverses
+    # the level of indirection to make it easier to get to the FileReference.
+    # 
+    # Another method, file, exists which will return the BuildFile references.
+    # 
+    # @return [Array<FileReference>] the files referenced by the build files.
+    # 
+    def build_files
+      files.map {|file| file.file_ref }
+    end
+    
+    #
+    # Find the first file that has the name or path that matches the specified
+    # parameter. 
+    # 
+    # @param [String] name the name or the path of the file.
+    # @return [FileReference] the file referenced that matches the name or path;
+    #   nil if no file is found.
+    # 
+    def build_file(name)
+      build_files.find {|file| file.name == name or file.path == name }
+    end
+    
+    #
+    # Add the specified file to the Build Phase.
+    # 
+    # First a BuildFile entry is created for the file and then the build file
+    # entry is added to the particular build phase. A BuildFile identifier must
+    # exist for each target.
+    # 
+    # @param [FileReference] file the FileReference Resource to add to the build 
+    # phase.
+    #
+    def add_build_file(file)
+      find_file_by = file.name || file.path
+      unless build_file(find_file_by)
+        new_build_file = @registry.add_object BuildFile.with_properties(file.identifier)
+        @properties['files'] << new_build_file.identifier
+      end
+    end
+    
+  end
+  
+end

data/lib/xcode/builder.rb

@@ -0,0 +1,190 @@
+require 'xcode/shell'
+require 'xcode/provisioning_profile'
+require 'xcode/test/ocunit_report_parser.rb'
+require 'xcode/testflight'
+
+module Xcode
+  class Builder
+    attr_accessor :profile, :identity, :build_path, :keychain, :sdk
+    
+    def initialize(config)
+      if config.is_a? Xcode::Scheme
+        @scheme = config
+        config = config.launch
+      end
+      
+      puts "CONFIG: #{config}"
+      @target = config.target
+      @sdk = @target.project.sdk
+      @config = config
+      @build_path = "#{File.dirname(@target.project.path)}/build/"
+    end
+    
+    def install_profile
+      return nil if @profile.nil?
+      # TODO: remove other profiles for the same app?
+      p = ProvisioningProfile.new(@profile)
+      
+      ProvisioningProfile.installed_profiles.each do |installed|
+        if installed.identifiers==p.identifiers and installed.uuid==p.uuid
+          installed.uninstall
+        end
+      end
+      
+      p.install
+      p
+    end
+    
+    def build(sdk=@sdk)    
+      cmd = build_command(@sdk)
+      Xcode::Shell.execute(cmd)
+    end
+    
+    def test
+      cmd = build_command('iphonesimulator')
+      cmd << "TEST_AFTER_BUILD=YES"
+      cmd << "TEST_HOST=''"
+      
+      parser = Xcode::Test::OCUnitReportParser.new
+      Xcode::Shell.execute(cmd, false) do |line|
+        puts line
+        parser << line
+      end
+      
+      yield(parser) if block_given?
+      
+      exit parser.exit_code if parser.exit_code!=0
+      
+      parser
+    end
+    
+    def testflight(api_token, team_token)
+      raise "Can't find #{ipa_path}, do you need to call builder.build?" unless File.exists? ipa_path
+      raise "Can't fins #{dsym_zip_path}, do you need to call builder.build?" unless File.exists? dsym_zip_path
+      
+      testflight = Xcode::Testflight.new(api_token, team_token)
+      yield(testflight) if block_given?
+      testflight.upload(ipa_path, dsym_zip_path)
+    end
+    
+    def clean
+      cmd = []
+      cmd << "xcodebuild"
+      cmd << "-project \"#{@target.project.path}\""
+      
+      cmd << "-scheme #{@scheme.name}" unless @scheme.nil?
+      cmd << "-target \"#{@target.name}\"" if @scheme.nil?
+      cmd << "-configuration \"#{@config.name}\"" if @scheme.nil?
+      
+      cmd << "OBJROOT=\"#{@build_path}\""
+      cmd << "SYMROOT=\"#{@build_path}\""
+      cmd << "clean"
+      Xcode::Shell.execute(cmd)
+      
+      @built = false
+      @packaged = false
+      # FIXME: Totally not safe
+      # cmd = []
+      # cmd << "rm -Rf #{build_path}"
+      # Xcode::Shell.execute(cmd)
+    end    
+    
+    def sign
+      cmd = []
+      cmd << "codesign"
+      cmd << "--force"
+      cmd << "--sign \"#{@identity}\""
+      cmd << "--resource-rules=\"#{app_path}/ResourceRules.plist\""
+      cmd << "--entitlements \"#{entitlements_path}\""
+      cmd << "\"#{ipa_path}\""
+      Xcode::Shell.execute(cmd)
+    end
+    
+    def package
+      raise "Can't find #{app_path}, do you need to call builder.build?" unless File.exists? app_path
+      
+      #package IPA
+      cmd = []      
+      cmd << "xcrun"
+      cmd << "-sdk #{@target.project.sdk.nil? ? "iphoneos" : @target.project.sdk}"
+      cmd << "PackageApplication"
+      cmd << "-v \"#{app_path}\""
+      cmd << "-o \"#{ipa_path}\""
+      
+      # cmd << "OTHER_CODE_SIGN_FLAGS=\"--keychain #{@keychain.path}\"" unless @keychain.nil?
+      # 
+      # unless @identity.nil?
+      #   cmd << "--sign \"#{@identity}\""
+      # end
+      
+      unless @profile.nil?
+        cmd << "--embed \"#{@profile}\""
+      end
+      
+      Xcode::Shell.execute(cmd)
+      
+      # package dSYM
+      cmd = []
+      cmd << "zip"
+      cmd << "-r"
+      cmd << "-T"
+      cmd << "-y \"#{dsym_zip_path}\""
+      cmd << "\"#{dsym_path}\""
+      Xcode::Shell.execute(cmd)
+
+    end
+    
+    def configuration_build_path
+      "#{build_path}/#{@config.name}-#{@sdk}"
+    end
+    
+    def entitlements_path
+      "#{build_path}/#{@target.name}.build/#{name}-#{@target.project.sdk}/#{@target.name}.build/#{@config.product_name}.xcent"
+    end
+    
+    def app_path
+      "#{configuration_build_path}/#{@config.product_name}.app"
+    end
+    
+    def product_version_basename
+      version = @config.info_plist.version
+      version = "SNAPSHOT" if version.nil? or version==""
+      "#{configuration_build_path}/#{@config.product_name}-#{@config.name}-#{version}"
+    end
+
+    def ipa_path
+      "#{product_version_basename}.ipa"
+    end
+    
+    def dsym_path
+      "#{app_path}.dSYM"
+    end
+    
+    def dsym_zip_path
+      "#{product_version_basename}.dSYM.zip"
+    end
+    
+    
+    private 
+    
+    def build_command(sdk=@sdk)
+      profile = install_profile
+      cmd = []
+      cmd << "xcodebuild"
+      cmd << "-sdk #{sdk}" unless sdk.nil?
+      cmd << "-project \"#{@target.project.path}\""
+      
+      cmd << "-scheme #{@scheme.name}" unless @scheme.nil?
+      cmd << "-target \"#{@target.name}\"" if @scheme.nil?
+      cmd << "-configuration \"#{@config.name}\"" if @scheme.nil?
+      
+      cmd << "OTHER_CODE_SIGN_FLAGS=\"--keychain #{@keychain.path}\"" unless @keychain.nil?
+      cmd << "CODE_SIGN_IDENTITY=\"#{@identity}\"" unless @identity.nil?
+      cmd << "OBJROOT=\"#{@build_path}\""
+      cmd << "SYMROOT=\"#{@build_path}\""
+      cmd << "PROVISIONING_PROFILE=#{profile.uuid}" unless profile.nil?
+      cmd
+    end
+    
+  end
+end