xcoder 0.1.13 → 0.1.14

data/lib/xcode/builder/base_builder.rb

@@ -0,0 +1,204 @@
+module Xcode
+  module Builder
+    #
+    # This class tries to pull various bits of Xcoder together to provide a higher-level API for common 
+    # project build tasks.
+    #
+    class BaseBuilder
+      attr_accessor :profile, :identity, :build_path, :keychain, :sdk, :objroot, :symroot
+      attr_reader   :config, :target
+
+      def initialize(target, config)
+        @target = target
+        @config = config
+        
+        @sdk = @target.project.sdk
+        @build_path = "#{File.dirname(@target.project.path)}/build/"
+        @objroot = @build_path
+        @symroot = @build_path
+      end
+      
+      def common_environment
+        env = {}
+        env["OBJROOT"]  = "\"#{@objroot}\""
+        env["SYMROOT"]  = "\"#{@symroot}\""
+        env
+      end
+      
+      def build_environment
+        profile = install_profile        
+        env = common_environment
+        env["OTHER_CODE_SIGN_FLAGS"]  = "'--keychain #{@keychain.path}'" unless @keychain.nil?
+        env["CODE_SIGN_IDENTITY"]     = "\"#{@identity}\"" unless @identity.nil?
+        env["PROVISIONING_PROFILE"]   = "#{profile.uuid}" unless profile.nil?
+        env
+      end
+
+
+      def build(options = {:sdk => @sdk})    
+        cmd = xcodebuild
+        cmd << "-sdk #{options[:sdk]}" unless options[:sdk].nil?
+
+        with_keychain do
+          cmd.execute
+        end
+        self
+      end
+
+      # 
+      # Invoke the configuration's test target and parse the resulting output
+      #
+      # If a block is provided, the report is yielded for configuration before the test is run
+      #
+      def test(options = {:sdk => 'iphonesimulator'}) #, :parser => :OCUnit })
+        cmd = xcodebuild
+        cmd << "-sdk #{options[:sdk]}" unless options[:sdk].nil?
+        cmd.env["TEST_AFTER_BUILD"]="YES"
+
+        report = Xcode::Test::Report.new
+        if block_given?
+          yield(report)
+        else
+          report.add_formatter :stdout
+          report.add_formatter :junit, 'test-reports'
+        end
+
+        parser = Xcode::Test::Parsers::OCUnitParser.new report
+
+        begin
+          cmd.execute(false) do |line|
+            parser << line
+          end
+        rescue Xcode::Shell::ExecutionError => e
+          puts "Test platform exited: #{e.message}"
+        ensure
+          parser.flush
+        end
+
+        report
+      end
+
+      def testflight(api_token, team_token)
+        raise "Can't find #{ipa_path}, do you need to call builder.package?" unless File.exists? ipa_path
+        raise "Can't fins #{dsym_zip_path}, do you need to call builder.package?" 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 = xcodebuild 
+        cmd << "-sdk #{@sdk}" unless @sdk.nil?          
+        cmd << "clean"
+        cmd.execute
+
+        @built = false
+        @packaged = false
+        self
+      end    
+
+      def sign
+        cmd = Xcode::Shell::Command.new 'codesign'
+        cmd << "--force"
+        cmd << "--sign \"#{@identity}\""
+        cmd << "--resource-rules=\"#{app_path}/ResourceRules.plist\""
+        cmd << "--entitlements \"#{entitlements_path}\""
+        cmd << "\"#{ipa_path}\""
+        cmd.execute
+        
+        
+        self
+      end
+
+      def package
+        raise "Can't find #{app_path}, do you need to call builder.build?" unless File.exists? app_path
+
+        #package IPA
+        cmd = Xcode::Shell::Command.new 'xcrun'     
+        cmd << "-sdk #{@sdk}" unless @sdk.nil?
+        cmd << "PackageApplication"
+        cmd << "-v \"#{app_path}\""
+        cmd << "-o \"#{ipa_path}\""
+    
+        unless @profile.nil?
+          cmd << "--embed \"#{@profile}\""
+        end
+
+        with_keychain do
+          cmd.execute
+        end
+
+        # package dSYM
+        cmd = Xcode::Shell::Command.new 'zip' 
+        cmd << "-r"
+        cmd << "-T"
+        cmd << "-y \"#{dsym_zip_path}\""
+        cmd << "\"#{dsym_path}\""
+        cmd.execute
+
+        self
+      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 with_keychain(&block)
+        if @keychain.nil?
+          yield
+        else
+          Xcode::Keychains.with_keychain_in_search_path @keychain, &block
+        end
+      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 xcodebuild #:yield: Xcode::Shell::Command
+        Xcode::Shell::Command.new 'xcodebuild', build_environment
+      end
+
+    end
+  end
+end

data/lib/xcode/builder/project_target_config_builder.rb

@@ -0,0 +1,14 @@
+module Xcode
+  module Builder
+    class ProjectTargetConfigBuilder < BaseBuilder
+        
+      def xcodebuild
+        cmd = super
+        cmd << "-project \"#{@target.project.path}\""
+        cmd << "-target \"#{@target.name}\""
+        cmd << "-config \"#{@config.name}\""
+        cmd
+      end
+    end
+  end
+end

data/lib/xcode/builder/scheme_builder.rb

@@ -0,0 +1,32 @@
+module Xcode  
+  
+  class Workspace
+    def to_xcodebuild_option
+      "-workspace \"#{self.path}\""
+    end
+  end
+  
+  class Project
+    def to_xcodebuild_option
+      "-project \"#{self.path}\""
+    end
+  end
+  
+  module Builder
+    class SchemeBuilder < BaseBuilder
+  
+      def initialize(scheme)
+        @scheme     = scheme        
+        super @scheme.build_targets.last, @scheme.build_config
+      end
+        
+      def xcodebuild
+        cmd = super
+        cmd << @scheme.parent.to_xcodebuild_option        
+        cmd << "-scheme \"#{@scheme.name}\""
+        cmd
+      end
+      
+    end
+  end
+end

data/lib/xcode/configuration.rb

@@ -418,7 +418,7 @@ module Xcode
     # @see Builder
     # 
     def builder
-      Xcode::Builder.new(self)
+      Xcode::Builder::ProjectTargetConfigBuilder.new(@target, self)
     end
     
     private

data/lib/xcode/keychain.rb

@@ -37,11 +37,10 @@ module Xcode
         "\"#{kc.path}\""
       end
       
-      cmd = []
-      cmd << "security"
+      cmd = Xcode::Shell::Command.new "security"
       cmd << "list-keychain"
       cmd << "-s #{search_list.join(' ')}"
-      Xcode::Shell.execute(cmd)
+      cmd.execute
     end
   end
   
@@ -70,13 +69,12 @@ module Xcode
     # @param [String] the password to open the certificate file
     #
     def import(cert, password)
-      cmd = []
-      cmd << "security"
+      cmd = Xcode::Shell::Command.new "security"
       cmd << "import '#{cert}'"
       cmd << "-k \"#{@path}\""
       cmd << "-P #{password}"
       cmd << "-T /usr/bin/codesign"
-      Xcode::Shell.execute(cmd)
+      cmd.execute
     end
     
     #
@@ -86,12 +84,11 @@ module Xcode
     #
     def identities
       names = []
-      cmd = []
-      cmd << "security"
+      cmd = Xcode::Shell::Command.new "security"
       cmd << "find-certificate"
       cmd << "-a"
       cmd << "\"#{@path}\""
-      data = Xcode::Shell.execute(cmd, false).join("")
+      data = cmd.execute(false).join("")
       data.scan /\s+"labl"<blob>="([^"]+)"/ do |m|
         names << m[0]
       end
@@ -102,11 +99,10 @@ module Xcode
     # Secure the keychain 
     #
     def lock
-      cmd = []
-      cmd << "security"
+      cmd = Xcode::Shell::Command.new "security"
       cmd << "lock-keychain"
       cmd << "\"#{@path}\""
-      Xcode::Shell.execute(cmd)
+      cmd.execute
     end
     
     #
@@ -115,12 +111,11 @@ module Xcode
     # @param [String] the password to open the keychain
     #
     def unlock(password)
-      cmd = []
-      cmd << "security"
+      cmd = Xcode::Shell::Command.new "security"
       cmd << "unlock-keychain"
       cmd << "-p #{password}"
       cmd << "\"#{@path}\""
-      Xcode::Shell.execute(cmd)
+      cmd.execute
     end
     
     #
@@ -131,12 +126,11 @@ module Xcode
     # @return [Xcode::Keychain] an object representing the new keychain
     #
     def self.create(path, password)
-      cmd = []
-      cmd << "security"
+      cmd = Xcode::Shell::Command.new "security"
       cmd << "create-keychain"
       cmd << "-p #{password}"
       cmd << "\"#{path}\""
-      Xcode::Shell.execute(cmd)
+      cmd.execute
       
       kc = Xcode::Keychain.new(path)
       yield(kc) if block_given?
@@ -149,10 +143,9 @@ module Xcode
     # FIXME: dangerous
     #
     def delete
-      cmd = []
-      cmd << "security"
+      cmd = Xcode::Shell::Command.new "security"
       cmd << "delete-keychain \"#{@path}\""
-      Xcode::Shell.execute(cmd)
+      cmd.execute
     end
     
     #

data/lib/xcode/project.rb

@@ -3,145 +3,145 @@ require 'xcode/resource'
 require 'xcode/registry'
 
 module Xcode
-  
+
   #
   # The project is the representation of an Xcode Project folder, the `*.xcodeproj`,
   # folder that contains a number of workspace files and project files like
-  # `project.pbxproj`. 
-  # 
-  # 
+  # `project.pbxproj`.
+  #
+  #
   # The Project represents encapsulates the an actual Resource that is ProjectReference
   # and other objects.
-  # 
-  class Project 
-    
-    # @return [String] the name of the project; This value is deteremined from the 
-    #   first part of the Xcode project folder name (e.g. "TestProject.xcodeproj" 
+  #
+  class Project
+
+    # @return [String] the name of the project; This value is deteremined from the
+    #   first part of the Xcode project folder name (e.g. "TestProject.xcodeproj"
     #   name is "TestProject")
     attr_reader :name
-    
+
     # @return [String] the sdks for the project. This is specified during the project
     #   initialization. If none are provided this currently defaults to "iphoneos"
     attr_reader :sdk
-    
+
     # @return [String] the expanded file path for the project. This is expanded from the
     #   file path specified during initialization.
     attr_reader :path
-    
+
     # @return [Array<Scheme>] the schemes that are found within the project path.
     attr_reader :schemes
-    
+
     # @return [Registry] the data that is parsed from the project.pbxproj, it is
     #   in most part a Hash with additional methods included to provide core
     #   functionality.
     attr_reader :registry
-    
-    # @return [ProjectReference] the project object that is contained in the 
+
+    # @return [ProjectReference] the project object that is contained in the
     #   project file that contains additional information
     attr_reader :project
-    
+
     #
     # Initialized with a specific path and sdk.
-    # 
+    #
     # This initialization is not often used. Instead projects are generated
     # through the Xcode#project method.
-    # 
+    #
     # @see Xcode
     #
     # @param [String] path of the project to open.
-    # @param [String] sdk the sdk value of the project. This will default to 
+    # @param [String] sdk the sdk value of the project. This will default to
     #   `iphoneos`.
-    # 
+    #
     def initialize(path, sdk=nil)
       @sdk = sdk || "iphoneos"  # FIXME: should support OSX/simulator too
       @path = File.expand_path path
       @schemes = nil
       @groups = []
       @name = File.basename(@path).gsub(/\.xcodeproj/,'')
-      
+
       # Parse the Xcode project file and create the registry
-      
+
       @registry = parse_pbxproj
       raise "Unable to parse project at #{@path}" if @registry.nil?
-      @project = Xcode::Resource.new @registry.root, @registry      
+      @project = Xcode::Resource.new @registry.root, @registry
     end
-    
+
     #
     # @return [Array<Xcode::Scheme>] available schemes for the project
     #
     def schemes
       return @schemes unless @schemes.nil?
-      @schemes = Xcode::Scheme.find_in_path @path
+      @schemes = Xcode::Scheme.find_in_project self
     end
-    
-    
+
+
     #
     # @return [Fixnum] the project's object version
-    # 
+    #
     def object_version
       @registry.object_version
     end
 
     #
     # @return [Fixnum] the project's archive version
-    # 
+    #
     def archive_version
       @registry.archive_version
     end
-    
+
     #
     # @return [Array<Configuration>] a list of configurations global to the project
-    # 
+    #
     def global_configs
       @project.configs
     end
-    
+
     #
     # @param [String,Symbol] name of the configuration for the project
-    # 
+    #
     # @return [Configuration] the project level configuration with the given name;
     #   raise an exception if no configuration exists with that name.
     #
     def global_config(name)
       @project.config(name)
     end
-    
+
     #
     # Returns the main group of the project where all the files reside.
-    # 
+    #
     # @todo this really could use a better name then groups as it is the main group
     #   but it should likely be something like main_group, root or something
     #   else that conveys that this is the project root for files, and such.
-    # 
+    #
     # @return [Group] the main group, the heart of the action of the file
     #   explorer for the Xcode project. From here all other groups and items
     #   may be found.
-    # 
+    #
     def groups
       @project.main_group
     end
-    
+
     #
     # Returns the group specified. If any part of the group does not exist along
-    # the path the group is created. Also paths can be specified to make the 
+    # the path the group is created. Also paths can be specified to make the
     # traversing of the groups easier.
-    # 
+    #
     # @note this will attempt to find the paths specified, if it fails to find them
     #   it will create one and then continue traversing.
     #
     # @example Traverse a path through the various sub-groups.
-    # 
+    #
     #     project.group('Vendor/MyCode/Support Files')
     #     # is equivalent to ...
     #     project.group('Vendor').first.group('MyCode').first.group('Supporting Files')
-    # 
+    #
     # @note this path functionality current is only exercised from the project level
     #   all groups will treat the path division `/` as simply a character.
-    # 
+    #
     # @param [String] name the group name to find/create
-    # 
+    #
     # @return [Group] the group with the specified name.
-    # 
+    #
     def group(name,options = {},&block)
       @project.group(name,options,&block)
     end
@@ -157,81 +157,81 @@ module Xcode
       path, name = File.split(name_with_path)
       group(path).file(name).first
     end
-    
+
     #
-    # Most Xcode projects have a products group where products are placed. This 
+    # Most Xcode projects have a products group where products are placed. This
     # will generate an exception if there is no products group.
-    # 
+    #
     # @return [Group] the 'Products' group of the project.
     def products_group
       current_group = groups.group('Products').first
       current_group.instance_eval(&block) if block_given? and current_group
       current_group
     end
-    
+
     #
-    # Most Xcode projects have a Frameworks gorup where all the imported 
+    # Most Xcode projects have a Frameworks gorup where all the imported
     # frameworks are shown. This will generate an exception if there is no
     # Frameworks group.
-    # 
+    #
     # @return [Group] the 'Frameworks' group of the projet.
     def frameworks_group
       current_group = groups.group('Frameworks').first
       current_group.instance_eval(&block) if block_given? and current_group
       current_group
     end
-    
+
     #
-    # This will convert the current project file into a supported Xcode Plist 
+    # This will convert the current project file into a supported Xcode Plist
     # format. This format is not json or a traditional plist so several core
     # Ruby objects gained the #to_xcplist method to save it properly.
-    # 
-    # Specifically this will add the necessary file header information and the 
+    #
+    # Specifically this will add the necessary file header information and the
     # surrounding mustache braces around the xcode plist format of the registry.
-    # 
+    #
     # @return [String] Xcode Plist format of the project.
     def to_xcplist
-      
+
       # @note The Hash#to_xcplist, which the Registry will save out as xcode,
-      #   saves a semi-colon at the end which needs to be removed to ensure 
+      #   saves a semi-colon at the end which needs to be removed to ensure
       #   the project file can be opened.
-      
+
       %{// !$*UTF8*$!"\n#{@registry.to_xcplist.gsub(/\};\s*\z/,'}')}}
     end
-    
-    # 
+
+    #
     # Save the current project at the current path that it exists.
-    # 
+    #
     def save!
       save @path
     end
-    
+
     #
     # Saves the current project at the specified path.
-    # 
-    # @note currently this does not support saving the workspaces associated 
+    #
+    # @note currently this does not support saving the workspaces associated
     #   with the project to their new location.
-    # 
+    #
     # @param [String] path the path to save the project
     #
     def save(path)
-      
+
       Dir.mkdir(path) unless File.exists?(path)
       project_filepath = "#{path}/project.pbxproj"
-      
+
       # @toodo Save the workspace when the project is saved
       # FileUtils.cp_r "#{path}/project.xcworkspace", "#{path}/project.xcworkspace"
-  
+
       Xcode::PLUTILProjectParser.save "#{path}/project.pbxproj", to_xcplist
-      
+
     end
-    
+
     #
-    # Return the scheme with the specified name. Raises an error if no schemes 
+    # Return the scheme with the specified name. Raises an error if no schemes
     # match the specified name.
-    # 
+    #
     # @note if two schemes match names, the first matching scheme is returned.
-    # 
+    #
     # @param [String] name of the specific scheme
     # @return [Scheme] the specific scheme that matches the name specified
     #
@@ -241,26 +241,26 @@ module Xcode
       yield scheme if block_given?
       scheme
     end
-    
+
     #
     # All the targets specified within the project.
-    # 
+    #
     # @return [Array<Target>] an array of all the available targets for
     #   the specific project.
-    # 
+    #
     def targets
       @project.targets.map do |target|
         target.project = self
         target
       end
     end
-    
+
     #
     # Return the target with the specified name. Raises an error if no targets
     # match the specified name.
-    # 
+    #
     # @note if two targets match names, the first matching target is returned.
-    # 
+    #
     # @param [String] name of the specific target
     # @return [Target] the specific target that matches the name specified
     #
@@ -270,55 +270,55 @@ module Xcode
       yield target if block_given?
       target
     end
-    
+
     #
     # Creates a new target within the Xcode project. This will by default not
     # generate all the additional build phases, configurations, and files
     # that create a project.
-    # 
+    #
     # Available targts:
-    # 
+    #
     # * native
     # * aggregate
-    # 
+    #
     # @param [String] name the name to provide to the target. This will also
     #   be the value that other defaults will be based on.
     # @param [String,Symbol] type the type of build target to create.
     #
     # @return [Target] the target created.
-    # 
+    #
     def create_target(name,type=:native)
-      
+
       target = @registry.add_object Target.send(type)
       @project.properties['targets'] << target.identifier
-      
+
       target.name = name
-      
+
       build_configuration_list = @registry.add_object(ConfigurationList.configration_list)
       target.build_configuration_list = build_configuration_list.identifier
-      
+
       target.project = self
-      
+
       yield target if block_given?
-      
+
       target.save!
     end
-    
+
     #
     # Remove a target from the Xcode project.
-    # 
+    #
     # @note this will remove the first target that matches the specified name.
-    # 
+    #
     # @note this will remove only the project entry at the moment and not the
-    #   the files that may be associated with the target. All build phases, 
+    #   the files that may be associated with the target. All build phases,
     #   build files, and configurations will automatically be cleaned up when
     #   Xcode is opened.
-    # 
+    #
     # @param [String] name the name of the target to remove from the Xcode
     #   project.
     #
     # @return [Target] the target that has been removed.
-    # 
+    #
     def remove_target(name)
       found_target = targets.find {|target| target.name == name }
       if found_target
@@ -327,9 +327,9 @@ module Xcode
       end
       found_target
     end
-    
-    # 
-    # Prints to STDOUT a description of this project's targets, configuration and schemes.  
+
+    #
+    # Prints to STDOUT a description of this project's targets, configuration and schemes.
     #
     def describe
       puts "Project #{name} contains"
@@ -345,25 +345,25 @@ module Xcode
         puts "    + Test action   => target:#{s.test.target.name}, config:#{s.test.name}" unless s.test.nil?
       end
     end
-    
+
     private
-  
+
     #
-    # Using the sytem tool plutil, the specified project file is parsed and 
-    # converted to JSON, which is then converted to a hash object. This content 
-    # contains all the data within the project file and is used to create the 
+    # Using the sytem tool plutil, the specified project file is parsed and
+    # converted to JSON, which is then converted to a hash object. This content
+    # contains all the data within the project file and is used to create the
     # Registry.
-    # 
+    #
     # @return [Registry] the representation of the project, this is a Hash with
     #   additional methods to provide easier functionality.
-    # 
+    #
     def parse_pbxproj
       registry = Xcode::PLUTILProjectParser.parse "#{@path}/project.pbxproj"
-      
+
       class << registry
         include Xcode::Registry
       end
-      
+
       registry
     end