xcoder 0.1.6 → 0.1.7

data/.gitignore

@@ -1,3 +1,5 @@
+# Mac 
+.DS_Store
 
 # Dependency management
 

data/Gemfile

@@ -1,6 +1,8 @@
 source "http://rubygems.org"
 
 gemspec
+gem 'rake'
+
 gem 'builder'
 gem 'json'
 gem 'plist'

data/README.md

@@ -43,7 +43,7 @@ You can either use the user's login keychain, another named keychain, or simply
 
 #### Creating a temporary keychain
 
-	Xcode::Keychain.temp_keychain('ProjectKeychain.keychain') do |keychain|
+	Xcode::Keychain.temp do |keychain|
 		# import certs into the keychain
 		# perform builds within this keychain's context
 	end	# Keychain is deleted
@@ -130,10 +130,63 @@ You can also optionally set a .proxy= property or just set the HTTP_PROXY enviro
 You can invoke your test target/bundle from the builder
 
 	builder.test do |report|
-		report.write 'test-reports', :junit
+		report.debug = false	# default false, set to true to see raw output from xcodebuild
+		
+		# The following is the default setup, you wouldnt normally need to do this unless
+		# you want to add new formatters
+		report.formatters = []
+		report.add_formatter :junit, 'test-reports'	# Output JUnit format results to test-reports/
+		report.add_formatter :stdout				# Output a simplified output to STDOUT
 	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.
+This will invoke the test target, capture the output and write the junit reports to the test-reports directory.  Currently only junit is supported, although you can write your own formatter quite easily (for an example, look at Xcode::Test::Formatters::JunitFormatter).
+
+## Rake Tasks
+
+Xcoder provides a rake task to assist with make it easier to perform common Xcode project actions from the command-line.
+
+Within your `Rakefile` add the following:
+
+    require 'xcoder/rake_task'
+    
+Then define your Rake Task:
+
+    Xcode::RakeTask.new
+
+By default this will generate rake tasks within the 'xcode' namespace for
+all the projects (within the current working directory), all their targets, 
+and all their configs. This will also generate tasks for all of a projects
+schemes as well.
+
+    All names from the project, schemes, targets, and configs are remove
+    the camel-casing and replacing the cameling with underscores. Spaces
+    are replaced with dashes (-)
+
+This will generate rake tasks that appear similar to the following:
+
+      rake xcode:project-name:targetname:debug:build   
+      rake xcode:project-name:targetname:debug:clean         
+      # ...
+
+You can specify a parameter to change the root rake namespace:
+
+     Xcode::RakeTask.new :apple
+     
+     # Resulting Rake Tasks:
+     # rake apple:project-name:targetname:debug:build
+     # rake apple:project-name:targetname:debug:clean
+     # ...
+
+You can also supply a block to provide additional configuration to specify the folder to search for projects and the projects that should generate tasks for:
+
+     Xcode::RakeTask.new :hudson do |xcoder|
+       xcoder.directory = "projects"
+       xcoder.projects = [ "Project Alpha", "Project Beta" ]
+     end
+     
+     rake hudson:project-alpha:targetname:debug:build
+     # ...
+
 
 ## Manipulating a Project
 

data/Rakefile

@@ -16,7 +16,7 @@ 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"]
+    # t.options = ["-o ../xcoder-doc"]
   end
 end
 
@@ -27,7 +27,7 @@ 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"
+    puts "Removing any User schemes generated in the project"
     system "rm -rf spec/TestProject/TestProject.xcodeproj/xcuserdata"
     puts "Removing any installed files"
     system "git clean -df spec/TestProject"
@@ -35,3 +35,9 @@ namespace :test_project do
   
 end
 
+
+require './lib/xcoder/rake_task'
+
+Xcode::RakeTask.new :xcode do |xcoder|
+  xcoder.directory = 'spec'
+end

data/lib/xcode/buildfile.rb

@@ -54,7 +54,7 @@ module Xcode
        puts "[#{label}] Set build profile to #{@values[:profile]}"
      end
      
-     Keychain.temp_keychain(@values[:project]) do |kc|
+     Keychain.temp do |kc|
        kc.import @values[:certificate], @values[:password]
        
        builder.identity = @values[:identity] || kc.identities.first

data/lib/xcode/configuration.rb

@@ -4,6 +4,7 @@ require 'xcode/configurations/targeted_device_family_property'
 require 'xcode/configurations/string_property'
 require 'xcode/configurations/boolean_property'
 require 'xcode/configurations/array_property'
+require 'xcode/configurations/key_value_array_property'
 
 module Xcode
   
@@ -84,7 +85,18 @@ module Xcode
       # Define a getter method
 
       define_method property_name do
-        substitute type.open(build_settings[setting_name])
+        
+        # When the build setting is missing from the existing configuration, look
+        # for the configuration of the target's project (only if we are currently
+        # at the Target level).
+        
+        if not build_settings.key?(setting_name) and target.is_a?(Target)
+          project_config = target.project.global_config(name)
+          project_config.send(property_name)
+        else
+          substitute type.open(build_settings[setting_name])
+        end
+        
       end
 
       # Define a setter method
@@ -92,7 +104,39 @@ module Xcode
       define_method "#{property_name}=" do |value|
         build_settings[setting_name] = unsubstitute(type.save(value))
       end
+
+      # Define an append method
+      
+      define_method "append_to_#{property_name}" do |value|
+        build_settings[setting_name] = unsubstitute type.append(build_settings[setting_name],value)
+      end
+      
+      # Define a environment name method (to return the settings name)
+      
+      define_method "env_#{property_name}" do
+        setting_name
+      end
+      
+      # Define a raw getter
+      
+      define_method "raw_#{property_name}" do
+        build_settings[setting_name]
+      end
+      
+      # Define a raw setter
+      
+      define_method "raw_#{property_name}=" do |value|
+        build_settings[setting_name] = value
+      end
+      
       
+      @setting_name_to_property = {} unless @setting_name_to_property
+      @setting_name_to_property[setting_name] = property_name
+      
+    end
+    
+    def self.setting_name_to_property(name)
+      @setting_name_to_property[name]
     end
     
     #
@@ -149,7 +193,7 @@ module Xcode
     # @attribute
     # Build Setting - "OTHER_CFLAGS"
     # @see https://developer.apple.com/library/mac/documentation/DeveloperTools/Reference/XcodeBuildSettingRef/1-Build_Setting_Reference/build_setting_ref.html#//apple_ref/doc/uid/TP40003931-CH3-SW17
-    property :other_c_flags, "OTHER_CFLAGS", ArrayProperty
+    property :other_c_flags, "OTHER_CFLAGS", KeyValueArrayProperty
 
     # @attribute
     # Build Setting - "GCC_C_LANGUAGE_STANDARD"
@@ -202,6 +246,11 @@ module Xcode
     # @see https://developer.apple.com/library/mac/#documentation/DeveloperTools/Reference/XcodeBuildSettingRef/1-Build_Setting_Reference/build_setting_ref.html#//apple_ref/doc/uid/TP40003931-CH3-SW144
     property :copy_phase_strip, "COPY_PHASE_STRIP", BooleanProperty
     
+    # @attribute
+    # Build Setting - "OTHER_LDFLAGS"
+    # @see https://developer.apple.com/library/mac/#documentation/DeveloperTools/Reference/XcodeBuildSettingRef/1-Build_Setting_Reference/build_setting_ref.html#//apple_ref/doc/uid/TP40003931-CH3-SW76
+    property :other_linker_flags, "OTHER_LDFLAGS", SpaceDelimitedString
+    
     #
     # Opens the info plist associated with the configuration and allows you to 
     # edit the configuration.
@@ -236,7 +285,11 @@ module Xcode
     # @return [String,Array,Hash] the value stored for the specified configuration
     #  
     def get(name)
-      build_settings[name]
+      if Configuration.setting_name_to_property(name)
+        send Configuration.setting_name_to_property(name)
+      else
+        build_settings[name]
+      end
     end
     
     #
@@ -246,7 +299,27 @@ module Xcode
     # @param [String,Array,Hash] value the value to store for the specific setting
     #
     def set(name, value)
-      build_settings[name] = value
+      if Configuration.setting_name_to_property(name)
+        send("#{Configuration.setting_name_to_property(name)}=",value)
+      else
+        build_settings[name] = value
+      end
+    end
+    
+    #
+    # Append a value to the the configuration value for the given name
+    #
+    # @param [String] name of the the configuration setting
+    # @param [String,Array,Hash] value the value to store for the specific setting
+    #
+    def append(name, value)
+      if Configuration.setting_name_to_property(name)
+        send("append_to_#{Configuration.setting_name_to_property(name)}",value)
+      else
+        # @todo this will likely raise some errors if trying to append a string
+        #   to an array, but that likely means a new property should be defined.
+        build_settings[name] = build_settings[name] + value
+      end
     end
     
     #

data/lib/xcode/configuration_owner.rb

@@ -0,0 +1,86 @@
+module Xcode
+  module ConfigurationOwner
+    
+    #
+    # @return [Array<BuildConfiguration>] the configurations that this target
+    #   or project supports. These are generally 'Debug' or 'Release' but may be 
+    #   custom created configurations.
+    # 
+    def configs
+      build_configuration_list.build_configurations.map do |config|
+        config.target = self
+        config
+      end
+    end
+    
+    #
+    # Return a specific build configuration. 
+    # 
+    # @note an exception is raised if no configuration matches the specified name.
+    # 
+    # @param [String] name of a configuration to return
+    # 
+    # @return [BuildConfiguration] a specific build configuration that 
+    #   matches the specified name.
+    #
+    def config(name)
+      config = configs.select {|config| config.name == name.to_s }.first
+      raise "No such config #{name}, available configs are #{configs.map {|c| c.name}.join(', ')}" if config.nil?
+      yield config if block_given?
+      config
+    end
+    
+    #
+    # Create a configuration for the target or project.
+    # 
+    # @example creating a new 'App Store Submission' configuration for a project
+    # 
+    #     project.create_config 'App Store Submission' # => Configuration
+    # 
+    # @example creating a new 'Ad Hoc' configuration for a target
+    # 
+    #   target.create_config 'Ad Hoc' do |config|
+    #     # configuration the new debug config.
+    #   end
+    # 
+    # @param [String] name of the configuration to create
+    # @return [BuildConfiguration] that is created
+    #
+    def create_configuration(name)
+      # To create a configuration, we need to create or retrieve the configuration list
+      
+      created_config = build_configuration_list.create_config(name) do |config|
+        yield config if block_given?
+      end
+      
+      created_config
+    end
+    
+    #
+    # Create multiple configurations for a target or project.
+    # 
+    # @example creating 'Release' and 'Debug for a new target
+    # 
+    #     new_target = project.create_target 'UniversalBinary'
+    #     new_target.create_configurations 'Debug', 'Release' do |config|
+    #       # set up the configurations
+    #     end
+    # 
+    # @param [String,Array<String>] configuration_names the names of the 
+    #   configurations to create.
+    #
+    def create_configurations(*configuration_names)
+      
+      configuration_names.compact.flatten.map do |config_name|
+        created_config = create_configuration config_name do |config|
+          yield config if block_given?
+        end
+        
+        created_config.save!
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/xcode/configurations/array_property.rb

@@ -16,7 +16,7 @@ module Xcode
       # @param [Array] value to be parsed into the correct format
       #
       def open(value)
-        value.to_a
+        Array(value)
       end
     
       #
@@ -24,7 +24,11 @@ module Xcode
       #   be in a multitude of formats as long as it responds_to? #to_a
       #
       def save(value)
-        value.to_s
+        Array(value)
+      end
+      
+      def append(original,value)
+        (Array(original) + Array(value)).uniq
       end
   
     end

data/lib/xcode/configurations/boolean_property.rb

@@ -35,6 +35,10 @@ module Xcode
       def save(value)
         value.to_s =~ /^(?:NO|false)$/ ? "NO" : "YES"
       end
+      
+      def append(original,value)
+        save(original) | save(value)
+      end
   
     end
     

data/lib/xcode/configurations/key_value_array_property.rb

@@ -0,0 +1,42 @@
+
+module Xcode
+  module Configuration
+    
+    #
+    # Within the a build settings for a configuration there are a number of
+    # settings that are stored as key-value pairs in Arrays.
+    # 
+    module KeyValueArrayProperty
+      extend self
+  
+      #
+      # As arrays are stored as arrays this is not particularly different.
+      # 
+      # @param [Array] value to be parsed into the correct format
+      #
+      def open(value)
+        Array(value)
+      end
+    
+      #
+      # @param [Nil,Array,String] value that is being saved back which can
+      #   be in a multitude of formats as long as it responds_to? #to_a
+      #
+      def save(value)
+        Array(value)
+      end
+      
+      #
+      # To ensure uniqueness, the original value array is added to the new value
+      # array and then all the key-values pairs are placed in a Hash then mapped
+      # back out to a key=value pair array.
+      # 
+      def append(original,value)
+        all_values = (Array(original) + Array(value)).map {|key_value| key_value.split("=") }.flatten
+        Hash[*all_values].map {|k,v| "#{k}=#{v}" }
+      end
+  
+    end
+    
+  end
+end

data/lib/xcode/configurations/space_delimited_string_property.rb

@@ -40,6 +40,10 @@ module Xcode
       def save(value)
         Array(value).join(" ")
       end
+      
+      def append(original,value)
+        save( ( open(original) + open(value) ).uniq )
+      end
   
     end
     

data/lib/xcode/configurations/string_property.rb

@@ -18,6 +18,10 @@ module Xcode
       def save(value)
         value.to_s
       end
+      
+      def append(original,value)
+        original.to_s + value.to_s
+      end
   
     end
     

data/lib/xcode/configurations/targeted_device_family_property.rb

@@ -23,16 +23,26 @@ module Xcode
       end
     
       #
-      # @param [Array<String>] value convert the array of platform names 
+      # @param [String,Array<String>] value convert the array of platform names 
       # @return [String] the comma-delimited list of numeric values representing 
       #   the platforms.
       #
       def save(value)
         Array(value).map do |platform_name|
           platforms.map {|number,name| number if name.to_s == platform_name.to_s.downcase }
-        end.flatten.compact.join(",")
+        end.flatten.compact.uniq.join(",")
       end
-  
+      
+      #
+      # @param [String] original is the current string value stored in the configuration
+      #   that needs to be converted into an Array of names.
+      # @param [String,Array<String>] value the new values to include in the device
+      #   family.
+      # 
+      def append(original,value)
+        save(open(original) + Array(value))
+      end
+    
       private
   
       def platforms

data/lib/xcode/project.rb

@@ -9,9 +9,9 @@ module Xcode
   # folder that contains a number of workspace files and project files like
   # `project.pbxproj`. 
   # 
-  # The Project represents the top-most element within the structure. It contains 
-  # most of the methods that allow you to traverse through the targets and
-  # configurations that it is composed.
+  # 
+  # The Project represents encapsulates the an actual Resource that is ProjectReference
+  # and other objects.
   # 
   class Project 
     
@@ -78,6 +78,14 @@ module Xcode
       @registry.archive_version
     end
     
+    def global_configs
+      @project.configs
+    end
+    
+    def global_config(name)
+      @project.config(name)
+    end
+    
     #
     # Returns the main group of the project where all the files reside.
     # 
@@ -115,31 +123,9 @@ module Xcode
     # @return [Group] the group with the specified name.
     # 
     def group(name,options = {},&block)
-      # By default create missing groups along the way
-      options = { :create => true }.merge(options)
-      
-      current_group = @project.main_group
-      
-      # @todo consider this traversing and find/create as a normal procedure when
-      #   traversing the project.
-      
-      name.split("/").each do |path_component|
-        found_group = current_group.group(path_component).first
-        
-        if options[:create] and found_group.nil?
-          found_group = current_group.create_group(path_component)
-        end
-        
-        current_group = found_group
-        
-        break unless current_group
-      end
-      
-      current_group.instance_eval(&block) if block_given? and current_group
-      
-      current_group
+      @project.group(name,options,&block)
     end
-    
+
     #
     # Return the file that matches the specified path. This will traverse
     # the project's groups and find the file at the end of the path.
@@ -159,9 +145,7 @@ module Xcode
     # @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
     
@@ -173,9 +157,7 @@ module Xcode
     # @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
     

data/lib/xcode/project_reference.rb

@@ -0,0 +1,55 @@
+module Xcode
+  
+  module ProjectReference
+    
+    #
+    # 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 
+    # 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)
+      # By default create missing groups along the way
+      options = { :create => true }.merge(options)
+      
+      current_group = main_group
+      
+      # @todo consider this traversing and find/create as a normal procedure when
+      #   traversing the project.
+      
+      name.split("/").each do |path_component|
+        found_group = current_group.group(path_component).first
+        
+        if options[:create] and found_group.nil?
+          found_group = current_group.create_group(path_component)
+        end
+        
+        current_group = found_group
+        
+        break unless current_group
+      end
+      
+      current_group.instance_eval(&block) if block_given? and current_group
+      
+      current_group
+    end
+    
+    
+    
+  end
+end

data/lib/xcode/provisioning_profile.rb

@@ -1,17 +1,31 @@
 module Xcode
   class ProvisioningProfile
-    attr_reader :path, :name, :uuid, :identifiers
+    attr_reader :path, :name, :uuid, :identifiers, :devices, :appstore
     def initialize(path)
       
       raise "Provisioning profile '#{path}' does not exist" unless File.exists? path
       
       @path = path
       @identifiers = []
+      @devices = []
+      @appstore = true
       
       # TODO: im sure this could be done in a nicer way.  maybe read out the XML-like stuff and use the plist -> json converter
       uuid = nil
       File.open(path, "rb") do |f|
         input = f.read
+        
+        if input=~/ProvisionedDevices/
+          @appstore = false
+        end
+        
+        if input=~/<key>ProvisionedDevices<\/key>.*?<array>(.*?)<\/array>/im
+          $1.split(/<string>/).each do |id|
+            next if id.nil? or id.strip==""
+            @devices << id.gsub(/<\/string>/,'').strip
+          end
+        end
+        
         input=~/<key>UUID<\/key>.*?<string>(.*?)<\/string>/im
         @uuid = $1.strip
                 
@@ -26,6 +40,10 @@ module Xcode
       end
     
     end
+    
+    def appstore?
+      @appstore
+    end
 
     def self.profiles_path
       File.expand_path "~/Library/MobileDevice/Provisioning\\ Profiles/"