xcodeproj 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 529ed72e9f63e78ad2b0ca1a550ff4316ef1606f
-  data.tar.gz: 43bfe6819ebde4b4e6d1a1f4ce8bd49891663254
+  metadata.gz: 17c13e04abd44c7e6dceedf68acf67a1d8ba2f37
+  data.tar.gz: 44fdf17f6e7ea9ca3a9f08dece0112eacffe746c
 SHA512:
-  metadata.gz: 16a8b646d24a0cf360732816343f08daa455271e8909ae6c2ccc7b1fe9f05f4f4750544ea9af40798969e8aa4f7de30efc7ec53adc42f928fdc71897b3e75e25
-  data.tar.gz: ba101e58ee80931f8991c64f23b0a001bfb59ec27f6decd7c22e22b625f15b65da3aa1c0ec032ef336db39b92e7ef23a483d2853492418c049663f5d1ed61698
+  metadata.gz: a6cd8393ddfa58f805c14e0e2dface2ae60d24bd4774b78f81faa6c40f228ec2b3d9fd7eb24b6b6ebf05027227db84c1e9c5cc8b52b07235e0ad955b004f35c1
+  data.tar.gz: 979709a8376c2e40be97fcba4d554a0e53277a173a99fe56cf70380c54d240c783c248a6b275cb4ccff589c4e02cf66dc93f722acc136228345debb7960eef8a

data/ext/xcodeproj/extconf.rb

@@ -24,6 +24,14 @@ checking_for "-std=c99 option to compiler" do
   $CFLAGS += " -std=c99" if try_compile '', '-std=c99'
 end
 
+# From `man ld`:
+#
+#     -Z          Do not search the standard directories when searching for libraries and frameworks.
+#
+# This is typically used when you want compilation against Xcode SDK as opposed to the frameworks installed
+# in the running system, which is our use case.
+$LDFLAGS.gsub!(/\s-Z\s/,' ')
+
 unless have_framework('CoreFoundation')
   if have_library('CoreFoundation')
     # this is needed for opencflite, assume it's on linux

data/lib/xcodeproj.rb

@@ -1,5 +1,4 @@
 module Xcodeproj
-  VERSION = '0.9.0' unless defined? Xcodeproj::VERSION
 
   class PlainInformative < StandardError
   end
@@ -10,13 +9,14 @@ module Xcodeproj
     end
   end
 
+  require 'xcodeproj/user_interface'
+
   autoload :Command,          'xcodeproj/command'
   autoload :Config,           'xcodeproj/config'
   autoload :Constants,        'xcodeproj/constants'
   autoload :Differ,           'xcodeproj/differ'
   autoload :Helper,           'xcodeproj/helper'
   autoload :Project,          'xcodeproj/project'
-  autoload :UI,               'xcodeproj/user_interface'
   autoload :Workspace,        'xcodeproj/workspace'
   autoload :XCScheme,         'xcodeproj/scheme'
   autoload :XcodebuildHelper, 'xcodeproj/xcodebuild_helper'

data/lib/xcodeproj/config.rb

@@ -150,9 +150,9 @@ module Xcodeproj
         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 = flags.scan(/(?:\A|\s)-framework\s+([^\s]+)/).map { |m| m[0] }
+        weak_frameworks = flags.scan(/(?:\A|\s)-weak_framework\s+([^\s]+)/).map { |m| m[0] }
+        libraries  = flags.scan(/(?:\A|\s)-l ?([^\s]+)/).map { |m| m[0] }
         @frameworks.merge frameworks
         @weak_frameworks.merge weak_frameworks
         @libraries.merge libraries

data/lib/xcodeproj/constants.rb

@@ -159,7 +159,7 @@ module Xcodeproj
       }.freeze,
       :debug => {
         # TODO: enable after Xcode 4
-        # 'ONLY_ACTIVE_ARCH'                  => 'YES',
+        # 'ONLY_ACTIVE_ARCH' => 'YES',
       }.freeze,
     }.freeze
 

data/lib/xcodeproj/gem_version.rb

@@ -0,0 +1,6 @@
+module Xcodeproj
+  # The version of the xcodeproj gem.
+  #
+  VERSION = '0.10.0' unless defined? Xcodeproj::VERSION
+end
+

data/lib/xcodeproj/project.rb

@@ -3,6 +3,7 @@ require 'pathname'
 require 'xcodeproj/xcodeproj_ext'
 require 'xcodeproj/project/object'
 require 'xcodeproj/project/project_helper'
+require 'xcodeproj/project/xcproj_helper'
 
 module Xcodeproj
 
@@ -41,31 +42,34 @@ module Xcodeproj
 
     include Object
 
-    # @return [String] the archive version.
+    # @return [Pathname] the path of the project.
     #
-    attr_reader :archive_version
+    attr_reader :path
 
-    # @return [Hash] an dictionary whose purpose is unknown.
+    # @param  [Pathname, String] path @see path
+    # @param  [Bool] skip_initialization
+    #         Wether the project should be initialized from scratch.
     #
-    attr_reader :classes
-
-    # @return [String] the objects version.
-    #
-    attr_reader :object_version
-
-    # @return [Hash{String => AbstractObject}] A hash containing all the
-    #         objects of the project by UUID.
+    # @example Creating a project
+    #         Project.new("path/to/Project.xcodeproj")
     #
-    attr_reader :objects_by_uuid
-
-    # @return [PBXProject] the root object of the project.
-    #
-    attr_reader :root_object
+    def initialize(path, skip_initialization = false)
+      @path = Pathname.new(path)
+      @objects_by_uuid = {}
+      @generated_uuids = []
+      @available_uuids = []
+      unless skip_initialization
+        initialize_from_scratch
+      end
+      unless skip_initialization.is_a?(TrueClass) || skip_initialization.is_a?(FalseClass)
+        raise ArgumentError, "[Xcodeproj] Initialization parameter expected to " \
+          "be a boolean #{skip_initialization}"
+      end
+    end
 
-    # Creates a new Project instance or initializes one with the data of an
-    # existing Xcode document.
+    # Opens the project at the given path.
     #
-    # @param  [Pathname, String] xcodeproj
+    # @param  [Pathname, String] path
     #         The path to the Xcode project document (xcodeproj).
     #
     # @raise  If the project versions are more recent than the ones know to
@@ -77,57 +81,37 @@ module Xcodeproj
     #         malformed.
     #
     # @example Opening a project
-    #   Project.new("path/to/Project.xcodeproj")
+    #         Project.open("path/to/Project.xcodeproj")
     #
-    def initialize(xcodeproj = nil)
-      @objects_by_uuid = {}
-      @generated_uuids = []
-      @available_uuids = []
-
-      if xcodeproj
-        file = File.join(xcodeproj, 'project.pbxproj')
-        plist = Xcodeproj.read_plist(file.to_s)
+    def self.open(path)
+      unless Pathname.new(path).exist?
+        raise "[Xcodeproj] Unable to open `#{path}` because it doesn't exist."
+      end
+      project = new(path, true)
+      project.send(:initialize_from_file)
+      project
+    end
 
-        @archive_version =  plist['archiveVersion']
-        @object_version  =  plist['objectVersion']
-        @classes         =  plist['classes']
+    # @return [String] the archive version.
+    #
+    attr_reader :archive_version
 
-        root_object_uuid = plist['rootObject']
-        @root_object = new_from_plist(root_object_uuid, plist['objects'], self)
+    # @return [Hash] an dictionary whose purpose is unknown.
+    #
+    attr_reader :classes
 
-        if (@archive_version.to_i > Constants::LAST_KNOWN_ARCHIVE_VERSION || @object_version.to_i > Constants::LAST_KNOWN_OBJECT_VERSION)
-          raise '[Xcodeproj] Unknown archive or object version.'
-        end
+    # @return [String] the objects version.
+    #
+    attr_reader :object_version
 
-        unless @root_object
-          raise "[Xcodeproj] Unable to find a root object in #{file}."
-        end
-      else
-        @archive_version =  Constants::LAST_KNOWN_ARCHIVE_VERSION.to_s
-        @object_version  =  Constants::LAST_KNOWN_OBJECT_VERSION.to_s
-        @classes         =  {}
-
-        root_object = new(PBXProject)
-        root_object.main_group = new(PBXGroup)
-        root_object.product_ref_group = root_object.main_group.new_group('Products')
-
-        config_list = new(XCConfigurationList)
-        config_list.default_configuration_name = 'Release'
-        config_list.default_configuration_is_visible = '0'
-        root_object.build_configuration_list = config_list
-
-        %w| Release Debug |.each do |name|
-          build_configuration = new(XCBuildConfiguration)
-          build_configuration.name = name
-          build_configuration.build_settings =  Constants::PROJECT_DEFAULT_BUILD_SETTINGS[name.downcase.to_sym].dup
-          config_list.build_configurations << build_configuration
-        end
+    # @return [Hash{String => AbstractObject}] A hash containing all the
+    #         objects of the project by UUID.
+    #
+    attr_reader :objects_by_uuid
 
-        @root_object = root_object
-        root_object.add_referrer(self)
-        new_group('Frameworks')
-      end
-    end
+    # @return [PBXProject] the root object of the project.
+    #
+    attr_reader :root_object
 
     # Compares the project to another one, or to a plist representation.
     #
@@ -140,16 +124,75 @@ module Xcodeproj
     end
 
     def to_s
-      "Project with root object UUID: #{root_object.uuid}"
+      "#<#{self.class}> path:`#{path}` UUID:`#{root_object.uuid}`"
     end
 
     alias :inspect :to_s
 
+    # @return [Bool] Whether the xcproj conversion should be disabled.
+    #
+    attr_accessor :disable_xcproj
+
+
+    public
+
+    # @!group Initialization
     #-------------------------------------------------------------------------#
 
+    # Initializes the instance from scratch.
+    #
+    def initialize_from_scratch
+      @archive_version =  Constants::LAST_KNOWN_ARCHIVE_VERSION.to_s
+      @object_version  =  Constants::LAST_KNOWN_OBJECT_VERSION.to_s
+      @classes         =  {}
+
+      root_object.remove_referrer(self) if root_object
+      @root_object = new(PBXProject)
+      root_object.add_referrer(self)
+
+      root_object.main_group = new(PBXGroup)
+      root_object.product_ref_group = root_object.main_group.new_group('Products')
+
+      config_list = new(XCConfigurationList)
+      root_object.build_configuration_list = config_list
+      config_list.default_configuration_name = 'Release'
+      config_list.default_configuration_is_visible = '0'
+      add_build_configuration('Debug', :debug)
+      add_build_configuration('Release', :release)
+
+      new_group('Frameworks')
+    end
+
+    # Initializes the instance with the project stored in the `path` attribute.
+    #
+    def initialize_from_file
+      pbxproj_path = path + 'project.pbxproj'
+      plist = Xcodeproj.read_plist(pbxproj_path.to_s)
+      root_object_uuid = plist['rootObject']
+      root_object.remove_referrer(self) if root_object
+      @root_object = new_from_plist(root_object_uuid, plist['objects'], self)
+      @archive_version =  plist['archiveVersion']
+      @object_version  =  plist['objectVersion']
+      @classes         =  plist['classes']
+
+      unless root_object
+        raise "[Xcodeproj] Unable to find a root object in #{pbxproj_path}."
+      end
+
+      if (archive_version.to_i > Constants::LAST_KNOWN_ARCHIVE_VERSION)
+        raise '[Xcodeproj] Unknown archive version.'
+      end
+
+      if (object_version.to_i > Constants::LAST_KNOWN_OBJECT_VERSION)
+        raise '[Xcodeproj] Unknown object version.'
+      end
+    end
+
+
     public
 
     # @!group Plist serialization
+    #-------------------------------------------------------------------------#
 
     # Creates a new object from the given UUID and `objects` hash (of a plist).
     #
@@ -232,27 +275,32 @@ module Xcodeproj
       {
         'File References' => root_object.main_group.pretty_print.values.first,
         'Targets' => root_object.targets.map(&:pretty_print),
-        'Build Configurations' => build_configurations.map(&:pretty_print)
+        'Build Configurations' => build_configurations.sort_by(&:name).map(&:pretty_print)
       }
     end
 
-    # Serializes the internal data as a property list and stores it on disk at
-    # the given path (`xcodeproj` file).
+    # Serializes the project in the xcodeproj format using the path provided
+    # during initialization or the given path (`xcodeproj` file). If a path is
+    # provided file references depending on the root of the project are not
+    # updated automatically, thus clients are responsible to perform any needed
+    # modification before saving.
     #
-    # @example Saving a project
-    #   project.save_as("path/to/Project.xcodeproj") #=> true
+    # @param  [String, Pathname] path
+    #         The optional path where the project should be saved.
     #
-    # @param  [String, Pathname] projpath
-    #         The path where the data should be stored.
+    # @example Saving a project
+    #   project.save
+    #   project.save
     #
-    # @return [Boolean] Whether or not saving was successful.
+    # @return [void]
     #
-    def save_as(projpath)
-      projpath = projpath.to_s
-      FileUtils.mkdir_p(projpath)
-      file = File.join(projpath, 'project.pbxproj')
+    def save(save_path = nil)
+      save_path ||= path
+      FileUtils.mkdir_p(save_path)
+      file = File.join(save_path, 'project.pbxproj')
       Xcodeproj.write_plist(to_hash, file)
       fix_encoding(file)
+      XCProjHelper.touch(save_path) unless disable_xcproj
     end
 
     # Simple workaround to escape characters which are outside of ASCII
@@ -298,12 +346,16 @@ module Xcodeproj
     # attributes, for this reason it is better to use the convenience methods
     # offered by the {AbstractObject} subclasses or by this class.
     #
-    # @param  [Class] klass
-    #         The concrete subclass of AbstractObject for new object.
+    # @param  [Class, String] klass
+    #         The concrete subclass of AbstractObject for new object or its
+    #         ISA.
     #
     # @return [AbstractObject] the new object.
     #
     def new(klass)
+      if klass.is_a?(String)
+        klass = Object.const_get(klass)
+      end
       object = klass.new(self, generate_uuid)
       object.initialize_defaults
       object
@@ -467,14 +519,14 @@ module Xcodeproj
 
     # @!group Helpers for generating objects
 
-    # Creates a new file reference at the given subpath of the main group.
+    # Creates a new file reference in the main group.
     #
     # @param  @see PBXGroup#new_file
     #
     # @return [PBXFileReference] the new file.
     #
-    def new_file(path, sub_group_path = nil)
-      main_group.new_file(path, sub_group_path)
+    def new_file(path, source_tree = :group)
+      main_group.new_file(path, source_tree)
     end
 
     # Creates a new group at the given subpath of the main group.
@@ -483,14 +535,12 @@ module Xcodeproj
     #
     # @return [PBXGroup] the new group.
     #
-    def new_group(name, path = nil)
-      main_group.new_group(name, path)
+    def new_group(name, path = nil, source_tree = :group)
+      main_group.new_group(name, path, source_tree)
     end
 
-    # Adds a file reference for a system framework to the project.
-    #
-    # The file reference can then be added to the build files of a
-    # {PBXFrameworksBuildPhase}.
+    # Adds a file reference for a system framework to the project if needed and
+    # adds it to the {PBXFrameworksBuildPhase} of the given target.
     #
     # @example Adding QuartzCore
     #
@@ -504,12 +554,12 @@ module Xcodeproj
     #         The name of a framework.
     #
     # @param  [PBXNativeTarget] target
-    #         The target for which to add the framework.
+    #         The target to 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.
+    # @return [PBXFileReference] The file reference of the framework.
     #
     def add_system_framework(name, target)
       ProjectHelper.add_system_framework(self, name, target)
@@ -564,6 +614,29 @@ module Xcodeproj
       ProjectHelper.new_resources_bundle(self, name, platform, product_group)
     end
 
+    # Adds a new build configuration to the project and populates its with
+    # default settings according to the provided type.
+    #
+    # @param  [String] name
+    #         The name of the build configuration.
+    #
+    # @param  [Symbol] type
+    #         The type of the build configuration used to populate the build
+    #         settings, must be :debug or :release.
+    #
+    # @return [XCBuildConfiguration] The new build configuration.
+    #
+    def add_build_configuration(name, type)
+      build_configuration_list = root_object.build_configuration_list
+      unless build_configuration_list[name]
+        build_configuration = new(XCBuildConfiguration)
+        build_configuration.name = name
+        build_configuration.build_settings = Constants::PROJECT_DEFAULT_BUILD_SETTINGS[type].dup
+        build_configuration_list.build_configurations << build_configuration
+        build_configuration
+      end
+    end
+
     #-------------------------------------------------------------------------#
     # Get list of shared schemes in project
     #

data/lib/xcodeproj/project/object.rb

@@ -99,8 +99,19 @@ module Xcodeproj
         # @return [void]
         #
         def remove_from_project
-          @project.objects_by_uuid.delete(uuid)
-          @referrers.each { |referrer| referrer.remove_reference(self) }
+          project.objects_by_uuid.delete(uuid)
+          referrers.each { |referrer| referrer.remove_reference(self) }
+
+          to_one_attributes.each do |attrb|
+            object = attrb.get_value(self)
+            object.remove_referrer(self) if object
+          end
+
+          to_many_attributes.each do |attrb|
+            list = attrb.get_value(self)
+            list.clear
+          end
+
           raise "[Xcodeproj] BUG: #{self} should have no referrers instead the following objects are still referencing it #{referrers}" unless referrers.count == 0
         end
 
@@ -391,8 +402,10 @@ module Xcodeproj
         end
 
         def inspect
-          name_part = " name=#{self.name}" if respond_to?(:name)
-          "<#{self.class}#{name_part} UUID=#{uuid}>"
+          optional = ''
+          optional << " name=`#{self.name}`" if respond_to?(:name) && self.name
+          optional << " path=`#{self.path}`" if respond_to?(:path) && self.path
+          "<#{self.isa}#{optional} UUID=`#{uuid}`>"
         end
       end
     end