xcoder 0.1.2 → 0.1.3

data/Gemfile

@@ -5,6 +5,7 @@ gem 'builder'
 gem 'json'
 gem 'plist'
 gem 'rest-client'
+gem 'yard'
 
 group :test do
   gem 'rspec'

data/README.md

@@ -2,6 +2,8 @@
 
 A ruby wrapper around various xcode tools and project, schemes and workspace configuration files
 
+Full documentation can be found here: http://rayh.github.com/xcoder/
+
 ## Example Usage
 
 You will need to install the gem:

data/Rakefile

@@ -1,4 +1,6 @@
 require "bundler/gem_tasks"
+require "yard"
+require "yard/rake/yardoc_task"
 
 task :default => [:specs, :build]
 
@@ -10,6 +12,13 @@ task :integration do
   system "rspec --color --format d --tag integration"
 end
 
+namespace :doc do 
+  desc "Generate YARD docs"
+  YARD::Rake::YardocTask.new(:generate) do |t|
+    t.files   = ['lib/**/*.rb',  '-', 'README.md']   # optional
+    t.options = ["-o ../xcoder-doc"]
+  end
+end
 
 task :reset => ['test_project:reset']
 

data/lib/xcode/build_file.rb

@@ -14,8 +14,10 @@ module Xcode
     # @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 }
+    def self.buildfile(file_identifier,settings)
+      properties = { 'isa' => "PBXBuildFile", 'fileRef' => file_identifier }
+      properties.merge!('settings' => settings) unless settings.empty?
+      properties
     end
     
   end

data/lib/xcode/build_phase.rb

@@ -45,6 +45,17 @@ module Xcode
         'runOnlyForDeploymentPostprocessing' => '0' }
     end
     
+    #
+    # Return the BuildFile given the file name.
+    #
+    # @param [String] name of the FileReference that is being built.
+    # @return [BuildFile] the BuildFile that links to the file specified with 
+    #   the name.
+    # 
+    def file(name)
+      files.find {|file| file.file_ref.name == name or file.file_ref.path == name  }
+    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.
@@ -59,7 +70,12 @@ module Xcode
     
     #
     # Find the first file that has the name or path that matches the specified
-    # parameter. 
+    # parameter.
+    # 
+    # @note this is the FileReference, the file being built and not the instance
+    #   of the BuildFile.
+    # 
+    # @see #file
     # 
     # @param [String] name the name or the path of the file.
     # @return [FileReference] the file referenced that matches the name or path;
@@ -76,17 +92,43 @@ module Xcode
     # entry is added to the particular build phase. A BuildFile identifier must
     # exist for each target.
     # 
+    # @example adding a source file to the sources build phase
+    # 
+    #     spec_file = project.group('Specs/Controller').create_file('FirstControllerSpec.m')
+    #     project.target('Specs').sources_build_phase.add_build_file spec_file
+    # 
+    # @example adding a source file, that does not use ARC, to the sources build phase
+    # 
+    #     spec_file = project.group('Specs/Controller').create_file('FirstControllerSpec.m')
+    #     project.target('Specs').sources_build_phase.add_build_file spec_file, { 'COMPILER_FLAGS' => "-fno-objc-arc" }
+    # 
     # @param [FileReference] file the FileReference Resource to add to the build 
     # phase.
+    # @param [Hash] settings additional build settings that are specifically applied
+    #   to this individual file.
     #
-    def add_build_file(file)
+    def add_build_file(file,settings = {})
       find_file_by = file.name || file.path
       unless build_file(find_file_by)
-        new_build_file = @registry.add_object BuildFile.with_properties(file.identifier)
+        new_build_file = @registry.add_object BuildFile.buildfile(file.identifier,settings)
         @properties['files'] << new_build_file.identifier
       end
     end
     
+    #
+    # Add the specified file to the Build Phase.
+    #
+    #  
+    # 
+    # @param [FileReference] file the FileReference Resource to add to the build 
+    # phase.
+    # @param [Hash] settings additional build settings that are specifically applied
+    #   to this individual file.
+    #
+    def add_build_file_without_arc(file)
+      add_build_file file, { 'COMPILER_FLAGS' => "-fno-objc-arc" }
+    end
+    
   end
   
 end

data/lib/xcode/builder.rb

@@ -13,7 +13,7 @@ module Xcode
         config = config.launch
       end
       
-      puts "CONFIG: #{config}"
+      #puts "CONFIG: #{config}"
       @target = config.target
       @sdk = @target.project.sdk
       @config = config
@@ -38,6 +38,7 @@ module Xcode
     def build(sdk=@sdk)    
       cmd = build_command(@sdk)
       Xcode::Shell.execute(cmd)
+      self
     end
     
     def test
@@ -55,16 +56,17 @@ module Xcode
       
       exit parser.exit_code if parser.exit_code!=0
       
-      parser
+      self
     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
+      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)
+      self
     end
     
     def clean
@@ -87,6 +89,7 @@ module Xcode
       # cmd = []
       # cmd << "rm -Rf #{build_path}"
       # Xcode::Shell.execute(cmd)
+      self
     end    
     
     def sign
@@ -98,6 +101,7 @@ module Xcode
       cmd << "--entitlements \"#{entitlements_path}\""
       cmd << "\"#{ipa_path}\""
       Xcode::Shell.execute(cmd)
+      self
     end
     
     def package
@@ -132,6 +136,7 @@ module Xcode
       cmd << "\"#{dsym_path}\""
       Xcode::Shell.execute(cmd)
 
+      self
     end
     
     def configuration_build_path

data/lib/xcode/buildfile.rb

@@ -57,7 +57,7 @@ module Xcode
      Keychain.temp_keychain(@values[:project]) do |kc|
        kc.import @values[:certificate], @values[:password]
        
-       builder.identity = @values[:identity] || kc.certificates.first
+       builder.identity = @values[:identity] || kc.identities.first
        builder.keychain = kc
        
        puts "[#{label}] CLEAN"

data/lib/xcode/configuration.rb

@@ -125,7 +125,7 @@ module Xcode
     # @see Builder
     # 
     def builder
-      puts "Making a Builder with #{self} #{self.methods}"
+      #puts "Making a Builder with #{self} #{self.methods}"
       Xcode::Builder.new(self)
     end
     

data/lib/xcode/file_reference.rb

@@ -41,10 +41,19 @@ module Xcode
     #
     # Generate the properties for a system framework.
     # 
-    # @param [String] name of the system framework
+    # @example CoreGraphics.framework
+    # 
+    #     FileReference.system_framework "CoreGraphics.framework"
+    #     FileReference.system_framework "Foundation"
+    # 
+    # @param [String] name of the system framework which can be specified with or
+    #   without the ".framework" suffix / extension.
     # @param [Hash] properties the parameters to override for the system framework
     #
     def self.system_framework(name,properties = {})
+
+      name = name[/(.+)(?:\.framework)?$/,1]
+      
       default_properties = { 'isa' => 'PBXFileReference',
         'lastKnownFileType' => 'wrapper.framework', 
         'name' => "#{name}.framework",
@@ -54,6 +63,27 @@ module Xcode
       default_properties.merge(properties)
     end
     
+    #
+    # Generate the properties for a system library
+    # 
+    # @example libz.dylib
+    # 
+    #     FileReference.system_library "libz.dylib"
+    # 
+    # @param [String] name of the system library, which can be found by default
+    #   in the /usr/lib folder.
+    # @param [Types] properties the parameters to override for the system library
+    #
+    def self.system_library(name,properties = {})
+      default_properties = { 'isa' => 'PBXFileReference',
+        'lastKnownFileType' => 'compiled.mach-o.dylib', 
+        'name' => name,
+        'path' => "usr/lib/#{name}",
+        "sourceTree" => "SDKROOT" }
+        
+      default_properties.merge(properties)
+    end
+    
     #
     # @example app product properties
     # 
@@ -72,6 +102,17 @@ module Xcode
         'sourceTree' => "BUILT_PRODUCTS_DIR" }
     end
     
+    #
+    # Remove the given file from the project and the supergroup of the file.
+    # 
+    def remove!
+      # @todo the removal here does not consider if the files have
+      #   been specified within a build phase.
+      yield self if block_given?
+      supergroup.children.delete identifier if supergroup
+      @registry.remove_object identifier
+    end
+    
   end
   
 end

data/lib/xcode/group.rb

@@ -110,6 +110,14 @@ module Xcode
     # Add a file to the specified group. Currently the file creation requires
     # the path to the physical file.
     # 
+    # @example creating a file with just a path
+    # 
+    #     project.main_group.create_file 'AppDelegate.m'
+    # 
+    # @example creating a file with a name and path
+    # 
+    #     project.main_group.create_file 'name' => 'AppDelegate.m', 'path' => 'Subfolder/AppDelegate.m'
+    # 
     # @param [String,Hash] path to the file that is being added or a hash that 
     #   contains the values would be merged with the default values.
     #
@@ -127,6 +135,7 @@ module Xcode
       unless found_or_created_file
         found_or_created_file = create_child_object FileReference.file(file_properties)
       end
+      found_or_created_file.supergroup = self
       
       found_or_created_file
     end
@@ -134,20 +143,43 @@ module Xcode
     #
     # Create a framework within this group.
     # 
+    # @example Custom.Framework
+    # 
+    #     project.frameworks_group.create_framework 'name' => 'Custom.framework', 
+    #       'path' => 'Vendor/Custom/Custom.framework' 
+    # 
     # @param [Hash] framework_properties the properties to merge with the default
     #   properties.
     #
     def create_framework(framework_properties)
-      create_child_object FileReference.framework(framework_properties)
+      find_or_create_child_object FileReference.framework(framework_properties)
     end
     
     #
     # Create a system framework reference within this group
+    # 
+    # @example creating 'CoreGraphics' and 'Foundation' frameworks
+    # 
+    #     project.frameworks_group.create_system_framework "CoreGraphics.framework"
+    #     project.frameworks_group.create_system_framework "Foundation"
     #
     # @param [String] name the name of the System framework to add to this group.
     #
     def create_system_framework(name)
-      create_child_object FileReference.system_framework(name)
+      find_or_create_child_object FileReference.system_framework(name)
+    end
+
+    #
+    # Create a system library reference within this group
+    #
+    #  @example libz.dylib
+    # 
+    #     project.frameworks_group.create_system_library "libz.dylib"
+    #
+    # @param [String] name the name of the System Library to add to this group.
+    #
+    def create_system_library(name)
+      find_or_create_child_object FileReference.system_library(name)
     end
     
     #
@@ -176,10 +208,29 @@ module Xcode
       create_child_object FileReference.app_product(name)
     end
     
+    #
+    # Remove the resource from the registry. 
+    # 
+    # @note all children objects of this group are removed as well.
+    # 
+    def remove!(&block)
+      
+      # @note #groups and #files is used because it adds the very precious
+      #   supergroup to each of the child items.
+      
+      groups.each {|group| group.remove!(&block) }
+      files.each {|file| file.remove!(&block) }
+      yield self if block_given?
+      
+      child_identifier = identifier
+      supergroup.instance_eval { remove_child_object(child_identifier) }
+      @registry.remove_object identifier
+    end
+    
     private
     
     #
-    # This method is used internally to add objects to the registry and add the
+    # This method is used internally to add object to the registry and add the
     # object as a child of this group.
     # 
     # @param [Hash] child_as_properties the hash of resource to add as a child
@@ -192,6 +243,33 @@ module Xcode
       child_object
     end
     
+    #
+    # This method is used internally to find the specified object or add the object
+    # as a child of this group.
+    # 
+    # @param [Hash] child_properties the hash of resource to add as a child
+    #   object of this group if it does not already exist as a child.
+    #
+    # @return [Resource] returns the resource that was added a child
+    def find_or_create_child_object(child_properties)
+      found_child = children.find {|child| child.name == child_properties['name'] or child.path == child_properties['path'] }
+      found_child = create_child_object(child_properties) unless found_child
+      found_child
+    end
+    
+    #
+    # This method is used internally to remove a child object from this and the
+    # registry.
+    #
+    # @param [String] identifier of the child object to be removed.
+    # @return [Resource] the removed child resource
+    def remove_child_object(identifier)
+      found_child = children.find {|child| child.identifier == identifier }
+      @properties['children'].delete identifier
+      save!
+      found_child
+    end
+    
   end
   
 end

data/lib/xcode/keychain.rb

@@ -10,9 +10,11 @@ module Xcode
     # 
     # @param [String] the name of the keychain
     #
-    def initialize(name)
-      @name = name
-      @path = File.expand_path "~/Library/Keychains/#{name}"
+    def initialize(path)
+      @path = File.expand_path path
+      @name = File.basename path
+      
+      yield(self) if block_given?
     end
     
     #
@@ -25,7 +27,7 @@ module Xcode
       cmd = []
       cmd << "security"
       cmd << "import '#{cert}'"
-      cmd << "-k '#{@path}'"
+      cmd << "-k \"#{@path}\""
       cmd << "-P #{password}"
       cmd << "-T /usr/bin/codesign"
       Xcode::Shell.execute(cmd)
@@ -42,7 +44,7 @@ module Xcode
       cmd << "security"
       cmd << "find-certificate"
       cmd << "-a"
-      cmd << "#{@name}"
+      cmd << "\"#{@path}\""
       data = Xcode::Shell.execute(cmd, false).join("")
       data.scan /\s+"labl"<blob>="([^"]+)"/ do |m|
         names << m[0]
@@ -60,7 +62,7 @@ module Xcode
       cmd << "security"
       cmd << "unlock-keychain"
       cmd << "-p #{password}"
-      cmd << "#{@name}"
+      cmd << "\"#{@path}\""
       Xcode::Shell.execute(cmd)
     end
     
@@ -71,15 +73,17 @@ module Xcode
     # @param [String] the password for the new keychain
     # @return [Xcode::Keychain] an object representing the new keychain
     #
-    def self.create(name, password)
+    def self.create(path, password)
       cmd = []
       cmd << "security"
       cmd << "create-keychain"
       cmd << "-p #{password}"
-      cmd << "#{name}"
+      cmd << "\"#{path}\""
       Xcode::Shell.execute(cmd)
       
-      Xcode::Keychain.new(name)
+      kc = Xcode::Keychain.new(path)
+      yield(kc) if block_given?
+      kc
     end
     
     #
@@ -90,7 +94,7 @@ module Xcode
     def delete
       cmd = []
       cmd << "security"
-      cmd << "delete-keychain #{name}"
+      cmd << "delete-keychain \"#{@path}\""
       Xcode::Shell.execute(cmd)
     end
     
@@ -100,8 +104,8 @@ module Xcode
     # 
     # @param [String] the name of the temporary keychain to create
     #
-    def self.temp_keychain(name, &block)
-      kc = Xcode::Keychain.create(name, TEMP_PASSWORD)
+    def self.temp(&block)
+      kc = Xcode::Keychain.create("/tmp/xcoder#{Time.now.to_i}", TEMP_PASSWORD)
       begin
         kc.unlock(TEMP_PASSWORD)
         block.call(kc)
@@ -115,8 +119,10 @@ module Xcode
     # 
     # @return [Xcode::Keychain] the current user's login keychain
     #
-    def self.login_keychain
-      Xcode::Keychain.new("login.keychain")
+    def self.login
+      kc = Xcode::Keychain.new("~/Library/Keychains/login.keychain")
+      yield(kc) if block_given?
+      kc
     end
   end
 end