xcodeproj 0.4.0 → 0.4.1

data/ext/xcodeproj/xcodeproj_ext.c

@@ -21,13 +21,10 @@ static VALUE
 cfstr_to_str(const void *cfstr) {
   CFDataRef data = CFStringCreateExternalRepresentation(NULL, cfstr, kCFStringEncodingUTF8, 0);
   assert(data != NULL);
-  long len = (long)CFDataGetLength(data);
-  char *buf = (char *)malloc(len+1);
-  assert(buf != NULL);
-  CFDataGetBytes(data, CFRangeMake(0, len), buf);
+  long  len = (long)CFDataGetLength(data);
+  char *buf = (char *)CFDataGetBytePtr(data);
 
   register VALUE str = rb_str_new(buf, len);
-  free(buf);
 
   // force UTF-8 encoding in Ruby 1.9+
   ID forceEncodingId = rb_intern("force_encoding");
@@ -35,6 +32,7 @@ cfstr_to_str(const void *cfstr) {
     rb_funcall(str, forceEncodingId, 1, rb_str_new("UTF-8", 5));
   }
 
+  CFRelease(data);
   return str;
 }
 

data/lib/xcodeproj.rb

@@ -1,5 +1,5 @@
 module Xcodeproj
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 
   class PlainInformative < StandardError
   end

data/lib/xcodeproj/config.rb

@@ -12,17 +12,17 @@ module Xcodeproj
     #
     attr_accessor :attributes
 
-    # @return [Array<String>] The list of the frameworks required by this
+    # @return [Set<String>] The list of the frameworks required by this
     #   settings file.
     #
     attr_accessor :frameworks
 
-    # @return [Array<String>] The list of the *weak* frameworks required by
+    # @return [Set<String>] The list of the *weak* frameworks required by
     #   this settings file.
     #
     attr_accessor :weak_frameworks
 
-    # @return [Array<String>] The list of the libraries required by this
+    # @return [Set<String>] The list of the libraries required by this
     #   settings file.
     #
     attr_accessor :libraries
@@ -43,19 +43,21 @@ module Xcodeproj
       merge!(extract_hash(xcconfig_hash_or_file))
     end
 
+    #-------------------------------------------------------------------------#
 
-    #@! group Serialization
+    # @!group Serialization
 
-    # Serializes the internal data in the xcconfig format.
+    # Sorts the internal data by setting name and serializes it in the xcconfig
+    # format.
     #
     # @example
     #
     #   config = Config.new('PODS_ROOT' => '"$(SRCROOT)/Pods"', 'OTHER_LDFLAGS' => '-lxml2')
-    #   config.to_s # => "PODS_ROOT = \"$(SRCROOT)/Pods\"\nOTHER_LDFLAGS = -lxml2"
+    #   config.to_s # => "OTHER_LDFLAGS = -lxml2\nPODS_ROOT = \"$(SRCROOT)/Pods\""
     #
     # @return [String]  The serialized internal data.
     def to_s
-      to_hash.map { |key, value| "#{key} = #{value}" }.join("\n")
+      to_hash.sort_by(&:first).map { |k, v| "#{k} = #{v}" }.join("\n")
     end
 
     # @return [void] Writes the serialized representation of the internal data
@@ -83,13 +85,13 @@ module Xcodeproj
       hash
     end
 
+    #-------------------------------------------------------------------------#
 
-
-    #@! group Merging
+    # @!group Merging
 
     # Merges the given xcconfig hash or Config into the internal data.
     #
-    # If a key in the given hash already exists, in the internal data, then its
+    # If a key in the given hash already exists in the internal data then its
     # value is appended to the value in the internal data.
     #
     # @example
@@ -103,41 +105,42 @@ module Xcodeproj
     def merge!(xcconfig)
       if xcconfig.is_a? Config
         @attributes.merge!(xcconfig.attributes) { |key, v1, v2| "#{v1} #{v2}" }
-        @libraries.merge   xcconfig.libraries
-        @frameworks.merge  xcconfig.frameworks
-        @weak_frameworks.merge  xcconfig.weak_frameworks
+        @libraries.merge(xcconfig.libraries)
+        @frameworks.merge(xcconfig.frameworks)
+        @weak_frameworks.merge(xcconfig.weak_frameworks)
       else
-      @attributes.merge!(xcconfig.to_hash) { |key, v1, v2| "#{v1} #{v2}" }
-      # Parse frameworks and libraries. Then remove the from the linker flags
-      flags = @attributes['OTHER_LDFLAGS']
-      return unless flags
-
-      frameworks = flags.scan(/-framework\s+([^\s]+)/).map { |m| m[0] }
-      weak_frameworks = flags.scan(/-weak_framework\s+([^\s]+)/).map { |m| m[0] }
-      libraries  = flags.scan(/-l ?([^\s]+)/).map { |m| m[0] }
-      @frameworks.merge frameworks
-      @weak_frameworks.merge weak_frameworks
-      @libraries.merge libraries
-
-      new_flags = flags.dup
-      frameworks.each {|f| new_flags.gsub!("-framework #{f}", "") }
-      weak_frameworks.each {|f| new_flags.gsub!("-weak_framework #{f}", "") }
-      libraries.each  {|l| new_flags.gsub!("-l#{l}", ""); new_flags.gsub!("-l #{l}", "") }
-      @attributes['OTHER_LDFLAGS'] = new_flags.gsub("\w*", ' ').strip
+        @attributes.merge!(xcconfig.to_hash) { |key, v1, v2| "#{v1} #{v2}" }
+        # Parse frameworks and libraries. Then remove the from the linker flags
+        flags = @attributes['OTHER_LDFLAGS']
+        return unless flags
+
+        frameworks = flags.scan(/-framework\s+([^\s]+)/).map { |m| m[0] }
+        weak_frameworks = flags.scan(/-weak_framework\s+([^\s]+)/).map { |m| m[0] }
+        libraries  = flags.scan(/-l ?([^\s]+)/).map { |m| m[0] }
+        @frameworks.merge frameworks
+        @weak_frameworks.merge weak_frameworks
+        @libraries.merge libraries
+
+        new_flags = flags.dup
+        frameworks.each {|f| new_flags.gsub!("-framework #{f}", "") }
+        weak_frameworks.each {|f| new_flags.gsub!("-weak_framework #{f}", "") }
+        libraries.each  {|l| new_flags.gsub!("-l#{l}", ""); new_flags.gsub!("-l #{l}", "") }
+        @attributes['OTHER_LDFLAGS'] = new_flags.gsub("\w*", ' ').strip
       end
     end
     alias_method :<<, :merge!
 
     def merge(config)
-      self.dup.tap { |x|x.merge!(config) }
+      self.dup.tap { |x| x.merge!(config) }
     end
 
     def dup
       Xcodeproj::Config.new(self.to_hash.dup)
     end
 
+    #-------------------------------------------------------------------------#
 
-    #@! group Object methods
+    # @!group Object methods
 
     def inspect
       to_hash.inspect
@@ -147,6 +150,10 @@ module Xcodeproj
       other.respond_to?(:to_hash) && other.to_hash == self.to_hash
     end
 
+    #-------------------------------------------------------------------------#
+
+    # @!group Private Helpers
+
     private
 
     def extract_hash(argument)

data/lib/xcodeproj/constants.rb

@@ -4,6 +4,14 @@ module Xcodeproj
   #
   module Constants
 
+    # The last known iOS SDK (stable).
+    #
+    LAST_KNOWN_IOS_SDK = '6.0'
+
+    # The last known OS X SDK (stable).
+    #
+    LAST_KNOWN_OSX_SDK  = '10.8'
+
     # The last known archive version to Xcodeproj.
     #
     LAST_KNOWN_ARCHIVE_VERSION = 1

data/lib/xcodeproj/project.rb

@@ -309,7 +309,7 @@ module Xcodeproj
       @available_uuids += uniques
     end
 
-    ## CONVENIENCE METHODS #####################################################
+    #-------------------------------------------------------------------------#
 
     # @!group Convenience accessors
 
@@ -352,7 +352,7 @@ module Xcodeproj
     #   frameworks.name #=> 'Frameworks'
     #   main_group.children.include? frameworks #=> True
     #
-    # @param [String] group_path
+    # @param [String] group_path @see MobileCoreServices
     #
     # @return [PBXGroup] the group at the given subpath.
     #
@@ -411,7 +411,7 @@ module Xcodeproj
 
 
 
-    # @!group Convenience methods for generating objects
+    # @!group Helpers for generating objects
 
     # Creates a new file reference at the given subpath of the main group.
     #
@@ -438,55 +438,81 @@ module Xcodeproj
     # The file reference can then be added to the build files of a
     # {PBXFrameworksBuildPhase}.
     #
-    # @example
+    # @example Adding QuartzCore
     #
-    #     framework = project.add_system_framework('QuartzCore')
+    #     framework = project.add_system_framework('QuartzCore', :ios)
     #
     #     target = project.targets.first
     #     build_phase = target.frameworks_build_phases.first
     #     build_phase.files << framework.buildFiles.new
     #
-    # @param [String] name        The name of a framework in the SDK System
-    #                             directory.
-    # @return [PBXFileReference]  The file reference object.
+    # @param  [String] name
+    #         The name of a framework.
+    #
+    # @param  [PBXNativeTarget] target
+    #         The target for which to add the framework.
+    #
+    # @note   This method adds a reference to the highest know SDK for the
+    #         given platform.
+    #
+    # @return [PBXFileReference] The generated file reference.
     #
-    def add_system_framework(name)
-      path = "System/Library/Frameworks/#{name}.framework"
-      if file = frameworks_group.files.first { |f| f.path == path }
+    def add_system_framework(name, target)
+      sdk = target.sdk
+      raise "Unable to find and SDK for the target `#{target.name}`" unless sdk
+      if sdk.include?('iphoneos')
+        if sdk == 'iphoneos'
+          base_dir = "Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS#{Constants::LAST_KNOWN_IOS_SDK}.sdk/"
+        else
+          base_dir = "Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS#{sdk.gsub('iphoneos', '')}.sdk/"
+        end
+      elsif sdk.include?('macosx')
+        if sdk == 'macosx'
+          base_dir = "Platforms/MacOSX.platform/Developer/SDKs/MacOSX#{Constants::LAST_KNOWN_OSX_SDK}.sdk/"
+        else
+          base_dir = "Platforms/MacOSX.platform/Developer/SDKs/MacOSX#{sdk.gsub('iphoneos', '')}.sdk/"
+        end
+      end
+      path = base_dir + "System/Library/Frameworks/#{name}.framework"
+
+      if file = frameworks_group.files.find { |f| f.path == path }
         file
       else
         framework_ref = frameworks_group.new_file(path)
         framework_ref.name = "#{name}.framework"
-        framework_ref.source_tree = 'SDKROOT'
+        framework_ref.source_tree = 'DEVELOPER_DIR'
+        framework_ref.last_known_file_type = "wrapper.framework"
         framework_ref
       end
     end
 
-    # @return [PBXNativeTarget] Creates a new target and adds it to the
-    #   project.
+    # Creates a new target and adds it to the project.
+    #
+    # The target is configured for the given platform and its file reference it
+    # is added to the {products_group}.
     #
-    #   The target is configured for the given platform and its file reference
-    #   it is added to the {products_group}.
+    # The target is pre-populated with common build phases, and all the
+    # Frameworks of the project are added to to its Frameworks phase.
     #
-    #   The target is pre-populated with common build phases, and all the
-    #   Frameworks of the project are added to to its Frameworks phase.
+    # @todo   Adding all the Frameworks is required by CocoaPods and should be
+    #         performed there.
     #
-    # @todo Adding all the Frameworks is required by CocoaPods and should be
-    #       performed there.
+    # @param  [Symbol] type
+    #         the type of target. Can be `:application`, `:dynamic_library` or
+    #         `:static_library`.
     #
-    # @param [Symbol] type
-    #   the type of target.
-    #   Can be `:application`, `:dynamic_library` or `:static_library`.
+    # @param  [String] name
+    #         the name of the static library product.
     #
-    # @param [String] name
-    #   the name of the static library product.
+    # @param  [Symbol] platform
+    #         the platform of the static library. Can be `:ios` or `:osx`.
     #
-    # @param [Symbol] platform
-    #   the platform of the static library.
-    #   Can be `:ios` or `:osx`.
+    # @param  [String] deployment_target
+    #         the deployment target for the platform.
     #
-    def new_target(type, name, platform)
-      add_system_framework(platform == :ios ? 'Foundation' : 'Cocoa')
+    # @return [PBXNativeTarget] the target.
+    #
+    def new_target(type, name, platform, deployment_target = nil)
 
       # Target
       target = new(PBXNativeTarget)
@@ -494,16 +520,20 @@ module Xcodeproj
       target.name = name
       target.product_name = name
       target.product_type = Constants::PRODUCT_TYPE_UTI[type]
-      target.build_configuration_list = configuration_list(platform)
+      target.build_configuration_list = configuration_list(platform, deployment_target)
 
       # Product
       product = products_group.new_static_library(name)
       target.product_reference = product
 
+      # Frameworks
+      framework_name = (platform == :ios) ? 'Foundation' : 'Cocoa'
+      framework_ref = add_system_framework(framework_name, target)
+
       # Build phases
       target.build_phases << new(PBXSourcesBuildPhase)
       frameworks_phase = new(PBXFrameworksBuildPhase)
-      frameworks_group.files.each { |framework| frameworks_phase.add_file_reference(framework) }
+      frameworks_phase.add_file_reference(framework_ref)
       target.build_phases << frameworks_phase
 
       target
@@ -512,23 +542,26 @@ module Xcodeproj
     # Returns a new configuration list, populated with release and debug
     # configurations with common build settings for the given platform.
     #
-    # @param [Symbol] platform
-    #   the platform for the configuration list, can be `:ios` or `:osx`.
+    # @param  [Symbol] platform
+    #         the platform for the configuration list, can be `:ios` or `:osx`.
+    #
+    # @param  [String] deployment_target
+    #         the deployment target for the platform.
     #
     # @return [XCConfigurationList] the generated configuration list.
     #
-    def configuration_list(platform)
+    def configuration_list(platform, deployment_target = nil)
       cl = new(XCConfigurationList)
       cl.default_configuration_is_visible = '0'
       cl.default_configuration_name = 'Release'
 
       release_conf = new(XCBuildConfiguration)
       release_conf.name = 'Release'
-      release_conf.build_settings = configuration_list_settings(platform, :release)
+      release_conf.build_settings = common_build_settings(:release, platform, deployment_target)
 
       debug_conf = new(XCBuildConfiguration)
       debug_conf.name = 'Debug'
-      debug_conf.build_settings = configuration_list_settings(platform, :debug)
+      debug_conf.build_settings = common_build_settings(:debug, platform, deployment_target)
 
       cl.build_configurations << release_conf
       cl.build_configurations << debug_conf
@@ -538,21 +571,32 @@ module Xcodeproj
     # Returns the common build settings for a given platform and configuration
     # name.
     #
-    # @param [Symbol] platform
-    #   the platform for the build settings, can be `:ios` or `:osx`.
+    # @param  [Symbol] type
+    #         the type of the build configuration, can be `:release` or
+    #         `:debug`.
+    #
+    # @param  [Symbol] platform
+    #         the platform for the build settings, can be `:ios` or `:osx`.
     #
-    # @param [Symbol] name
-    #   the name of the build configuration, can be `:release` or `:debug`.
+    # @param  [String] deployment_target
+    #         the deployment target for the platform.
     #
     # @return [Hash] The common build settings
     #
-    def configuration_list_settings(platform, name)
+    def common_build_settings(type, platform, deployment_target = nil)
       common_settings = Constants::COMMON_BUILD_SETTINGS
-      bs = common_settings[:all].dup
-      bs = bs.merge(common_settings[name])
-      bs = bs.merge(common_settings[platform])
-      bs = bs.merge(common_settings[[platform, name]])
-      bs
+      settings = common_settings[:all].dup
+      settings.merge!(common_settings[type])
+      settings.merge!(common_settings[platform])
+      settings.merge!(common_settings[[platform, type]])
+      if deployment_target
+        if platform == :ios
+          settings['IPHONEOS_DEPLOYMENT_TARGET'] = deployment_target
+        elsif platform == :osx
+          settings['MACOSX_DEPLOYMENT_TARGET'] = deployment_target
+        end
+      end
+      settings
     end
 
   end

data/lib/xcodeproj/project/object.rb

@@ -35,7 +35,9 @@ module Xcodeproj
       #
       class AbstractObject
 
-        # @return [String] the isa of the class.
+        # @!group AbstractObject
+
+        # @return [String] the ISA of the class.
         #
         def self.isa
           @isa ||= name.split('::').last
@@ -57,6 +59,8 @@ module Xcodeproj
         # @param [String] uuid
         #   the UUID of the new object.
         #
+        # @visibility private
+        #
         def initialize(project, uuid)
           @project, @uuid = project, uuid
           @isa = self.class.isa
@@ -67,11 +71,13 @@ module Xcodeproj
         # Initializes the object with the default values of simple attributes.
         #
         # This method is called by the {Project#new} and is not performed on
-        # initialization to prevet adding defaults to objects generated by a
+        # initialization to prevent adding defaults to objects generated by a
         # plist.
         #
         # @return [void]
         #
+        # @visibility private
+        #
         def initialize_defaults
           simple_attributes.each { |a| a.set_default(self) }
         end
@@ -116,6 +122,8 @@ module Xcodeproj
         # @return [Array<ObjectList>] The list of the objects that have a
         #   reference to this object.
         #
+        # @visibility private
+        #
         attr_reader :referrers
 
         # Informs the object that another object is referencing it. If the
@@ -124,6 +132,8 @@ module Xcodeproj
         #
         # @return [void]
         #
+        # @visibility private
+        #
         def add_referrer(referrer)
           @referrers << referrer
           @project.objects_by_uuid[uuid] = self
@@ -135,6 +145,8 @@ module Xcodeproj
         #
         # @return [void]
         #
+        # @visibility private
+        #
         def remove_referrer(referrer)
           @referrers.delete(referrer)
           if @referrers.count == 0
@@ -146,6 +158,8 @@ module Xcodeproj
         #
         # @return [void]
         #
+        # @visibility private
+        #
         def remove_reference(object)
           to_one_attributes.each do |attrb|
             value = attrb.get_value(self)
@@ -163,6 +177,8 @@ module Xcodeproj
           end
         end
 
+        #---------------------------------------------------------------------#
+
         # @!group Plist related methods
 
         # Configures the object with the objects hash from a plist.
@@ -173,6 +189,8 @@ module Xcodeproj
         #
         # @return [void]
         #
+        # @visibility private
+        #
         def configure_with_plist(objects_by_uuid_plist)
           object_plist = objects_by_uuid_plist[uuid].dup
 
@@ -188,7 +206,7 @@ module Xcodeproj
             ref_uuid = object_plist[attrb.plist_name]
             if ref_uuid
               ref = object_with_uuid(ref_uuid, objects_by_uuid_plist, attrb)
-              attrb.set_value(self, ref)
+              attrb.set_value(self, ref) if ref
             end
             object_plist.delete(attrb.plist_name)
           end
@@ -197,7 +215,8 @@ module Xcodeproj
             ref_uuids = object_plist[attrb.plist_name] || []
             list = attrb.get_value(self)
             ref_uuids.each do |uuid|
-              list << object_with_uuid(uuid, objects_by_uuid_plist, attrb)
+              ref = object_with_uuid(uuid, objects_by_uuid_plist, attrb)
+              list << ref if ref
             end
             object_plist.delete(attrb.plist_name)
           end
@@ -208,7 +227,8 @@ module Xcodeproj
             hashes.each do |hash|
               dictionary = ObjectDictionary.new(attrb, self)
               hash.each do |key, uuid|
-                dictionary[key] = object_with_uuid(uuid, objects_by_uuid_plist, attrb)
+                ref = object_with_uuid(uuid, objects_by_uuid_plist, attrb)
+                dictionary[key] = ref if ref
               end
               list << dictionary
             end
@@ -222,7 +242,7 @@ module Xcodeproj
           end
         end
 
-        # Initializes and returns the object with the given uuid.
+        # Initializes and returns the object with the given UUID.
         #
         # @param  [String] uuid
         #         The UUID of the object that should be initialized.
@@ -237,15 +257,18 @@ module Xcodeproj
         #
         # @raise  If the hash for the given UUID contains an unknown ISA.
         #
-        # @raise  If the UUID can't be found in the objects hash.
-        #
         # @return [AbstractObject] the initialized object.
+        # @return [Nil] if the UUID could not be found in the objects hash. In
+        #         this case a warning is printed to STDERR.
+        #
+        # @visibility private
         #
         def object_with_uuid(uuid, objects_by_uuid_plist, attribute)
           unless object = project.objects_by_uuid[uuid] || project.new_from_plist(uuid, objects_by_uuid_plist)
-            raise "`#{inspect}` attempted to initialize an object with an unknown UUID: "\
-                  "`#{uuid}` for attribute: `#{attribute.name}`\n"   \
-                  "Please file and issue: https://github.com/CocoaPods/Xcodeproj/issues/new"
+            STDERR.puts "`#{inspect}` attempted to initialize an object with "\
+              "an unknown UUID. `#{uuid}` for attribute: `#{attribute.name}`."\
+              " This can be the result of a merge and the unkonw UUID is "    \
+              "being discarded."
           end
           object
         rescue NameError => exception
@@ -289,14 +312,16 @@ module Xcodeproj
 
         # Returns a cascade representation of the object without UUIDs.
         #
-        # This method is designed to work in conjuction with {Hash#recursive_diff}
-        # to provie a complete, yet redable, diff of two projects *not* affected by
-        # isa differences.
+        # This method is designed to work in conjunction with
+        # {Hash#recursive_diff} to provide a complete, yet readable, diff of
+        # two projects *not* affected by ISA differences.
+        #
+        # @todo   The current implementation might lead to infinite loops.
         #
-        # @todo current implementation might cause infinite loops.
+        # @return [Hash] a hash representation of the project different from
+        #         the plist one.
         #
-        # @return [Hash] a hash reppresentation of the project different from the
-        #   plist one.
+        # @visibility private
         #
         def to_tree_hash
           hash = {}
@@ -326,7 +351,7 @@ module Xcodeproj
           hash
         end
 
-        # !@group Object methods
+        # @!group Object methods
 
         def ==(other)
           other.is_a?(AbstractObject) && self.to_plist == other.to_plist