xcodeproj 0.9.0 → 0.10.0

data/lib/xcodeproj/project/object/helpers/file_references_factory.rb

@@ -0,0 +1,182 @@
+require 'xcodeproj/project/object/helpers/groupable_helper'
+
+module Xcodeproj
+  class Project
+    module Object
+      class FileReferencesFactory
+        class << self
+
+          # Creates a new reference with the given path and adds it to the
+          # given group. The reference is configured according to the extension
+          # of the path.
+          #
+          # @param  [PBXGroup] group
+          #         The group to which to add the reference.
+          #
+          # @param  [#to_s] path
+          #         The, preferably absolute, path of the reference.
+          #
+          # @param  [Symbol] source_tree
+          #         The source tree key to use to configure the path (@see
+          #         GroupableHelper::SOURCE_TREES_BY_KEY).
+          #
+          # @return [PBXFileReference, XCVersionGroup] The new reference.
+          #
+          def new_reference(group, path, source_tree)
+            if File.extname(path).downcase == '.xcdatamodeld'
+              ref = new_xcdatamodeld(group, path, source_tree)
+            else
+              ref = new_file_reference(group, path, source_tree)
+            end
+
+            configure_defaults_for_file_reference(ref)
+            ref
+          end
+
+          # Creates a file reference to a static library and adds it to the
+          # given group.
+          #
+          # @param  [PBXGroup] group
+          #         The group to which to add the reference.
+          #
+          # @param  [#to_s] product_name
+          #         The name of the static library.
+          #
+          # @return [PBXFileReference] The new file reference.
+          #
+          def new_static_library(group, product_name)
+            ref = new_reference(group, "lib#{product_name}.a", :built_products)
+            ref.include_in_index = '0'
+            ref.set_explicit_file_type
+            ref
+          end
+
+          # Creates a file reference to a new bundle and adds it to the given
+          # group.
+          #
+          # @param  [PBXGroup] group
+          #         The group to which to add the reference.
+          #
+          # @param  [#to_s] product_name
+          #         The name of the bundle.
+          #
+          # @return [PBXFileReference] The new file reference.
+          #
+          def new_bundle(group, product_name)
+            ref = new_reference(group, "#{product_name}.bundle", :built_products)
+            ref.include_in_index = '0'
+            ref.set_explicit_file_type("wrapper.cfbundle")
+            ref
+          end
+
+
+          private
+
+          # @group Private Helpers
+          #-------------------------------------------------------------------#
+
+          # Creates a new file reference with the given path and adds it to the
+          # given group.
+          #
+          # @param  [PBXGroup] group
+          #         The group to which to add the reference.
+          #
+          # @param  [#to_s] path
+          #         The, preferably absolute, path of the reference.
+          #
+          # @param  [Symbol] source_tree
+          #         The source tree key to use to configure the path (@see
+          #         GroupableHelper::SOURCE_TREES_BY_KEY).
+          #
+          # @return [PBXFileReference] The new file reference.
+          #
+          def new_file_reference(group, path, source_tree)
+            path = Pathname.new(path)
+            ref = group.project.new(PBXFileReference)
+            group.children << ref
+            GroupableHelper.set_path_with_source_tree(ref, path, source_tree)
+            ref.set_last_known_file_type
+            ref
+          end
+
+          # Creates a new version group reference to an xcdatamodeled adding
+          # the xcdatamodel files included in the wrapper as children file
+          # references.
+          #
+          # @param  [PBXGroup] group
+          #         The group to which to add the reference.
+          #
+          # @param  [#to_s] path
+          #         The, preferably absolute, path of the reference.
+          #
+          # @param  [Symbol] source_tree
+          #         The source tree key to use to configure the path (@see
+          #         GroupableHelper::SOURCE_TREES_BY_KEY).
+          #
+          # @note  To match Xcode behaviour the current version is read from
+          #         the .xccurrentversion file, if it doesn't exist the last
+          #         xcdatamodel according to its path is set as the current
+          #         version.
+          #
+          # @return [XCVersionGroup] The new reference.
+          #
+          def new_xcdatamodeld(group, path, source_tree)
+            path = Pathname.new(path)
+            ref = group.project.new(XCVersionGroup)
+            group.children << ref
+            GroupableHelper.set_path_with_source_tree(ref, path, source_tree)
+            ref.version_group_type = 'wrapper.xcdatamodel'
+
+            current_version_name = nil
+            if path.exist?
+              path.children.each do |child_path|
+                if File.extname(child_path) == '.xcdatamodel'
+                  child_ref = new_file_reference(ref, child_path, :group)
+                  last_child_ref = child_ref
+                elsif File.basename(child_path) == '.xccurrentversion'
+                  full_path = path + child_path
+                  xccurrentversion = Xcodeproj.read_plist(full_path)
+                  current_version_name = xccurrentversion['_XCCurrentVersionName']
+                end
+              end
+
+              if current_version_name
+                ref.current_version = ref.children.find do |obj|
+                    obj.path.split('/').last == current_version_name
+                end
+              end
+            end
+
+            ref
+          end
+
+          # Configures a file reference according to the extension to math
+          # Xcode behaviour.
+          #
+          # @param  [PBXFileReference] ref
+          #         The file reference to configure.
+          #
+          # @note   To closely match the Xcode behaviour the name attribute of
+          #         the file reference is set only if the path of the file is
+          #         not equal to the path of the group.
+          #
+          # @return [void]
+          #
+          def configure_defaults_for_file_reference(ref)
+            if ref.path.include?('/')
+              ref.name = ref.path.split('/').last
+            end
+
+            if File.extname(ref.path).downcase == '.framework'
+              ref.include_in_index = nil
+            end
+          end
+
+          #-------------------------------------------------------------------#
+
+        end
+      end
+    end
+  end
+end
+

data/lib/xcodeproj/project/object/helpers/groupable_helper.rb

@@ -0,0 +1,210 @@
+module Xcodeproj
+  class Project
+    module Object
+      class GroupableHelper
+        class << self
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [PBXGroup, PBXProject] The parent of the object.
+          #
+          def parent(object)
+            check_parents_integrity(object)
+            object.referrers.first
+          end
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [Array<PBXGroup, PBXProject>] The parents of the object.
+          #
+          def parents(object)
+            if main_group?(object)
+              []
+            else
+              parent = parent(object)
+              parents(parent).push(parent)
+            end
+          end
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [String] A representation of the group hierarchy.
+          #
+          def hierarchy_path(object)
+            unless main_group?(object)
+              "#{parent(object).hierarchy_path}/#{object.display_name}"
+            end
+          end
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [Bool] Wether the object is the main group of the project.
+          #
+          def main_group?(object)
+            object.equal?(object.project.main_group)
+          end
+
+          # Moves the object to a new parent.
+          #
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to move.
+          #
+          # @param  [PBXGroup] new_parent
+          #         The new parent.
+          #
+          # @return [void]
+          #
+          def move(object, new_parent)
+            unless object
+              raise "[Xcodeproj] Attempt to move nil object to `#{new_parent}`."
+            end
+            unless new_parent
+              raise "[Xcodeproj] Attempt to move object `#{object}` to nil parent."
+            end
+            if new_parent.equal?(object)
+              raise "[Xcodeproj] Attempt to move object `#{object}` to itself."
+            end
+            if parents(new_parent).include?(object)
+              raise "[Xcodeproj] Attempt to move object `#{object}` to a child object `#{new_parent}`."
+            end
+
+            object.parent.children.delete(object)
+            new_parent << object
+          end
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [Pathname] The absolute path of the object resolving the
+          #         source tree.
+          #
+          def real_path(object)
+            source_tree = source_tree_real_path(object)
+            path = object.path || ''
+            if source_tree
+              source_tree + path
+            else
+              Pathname(path)
+            end
+          end
+
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object to analyze.
+          #
+          # @return [Pathname] The absolute path of the source tree of the
+          #         object.
+          #
+          def source_tree_real_path(object)
+            case object.source_tree
+            when '<group>'
+              if parent(object).isa == 'PBXProject'
+                object.project.path.dirname
+              else
+                real_path(parent(object))
+              end
+            when 'SOURCE_ROOT'
+              object.project.path.dirname
+            when '<absolute>', 'BUILT_PRODUCTS_DIR', 'DEVELOPER_DIR'
+              nil
+            else
+              raise "[Xcodeproj] Unable to compute the source tree for " \
+                " `#{object.display_name}`: `#{object.source_tree}`"
+            end
+          end
+
+          # @return [Hash{Symbol => String}] The source tree values by they
+          #         symbol representation.
+          #
+          SOURCE_TREES_BY_KEY = {
+            :absolute        => '<absolute>',
+            :group           => '<group>',
+            :project         => 'SOURCE_ROOT',
+            :built_products  => 'BUILT_PRODUCTS_DIR',
+            :developer_dir   => 'DEVELOPER_DIR',
+            :sdk_root        => 'SDKROOT',
+          }.freeze
+
+          # Sets the path of the given object according to the provided source
+          # tree key. The path is converted to relative according to the real
+          # path of the source tree for group and project source trees, if both
+          # paths are relative or absolute. Otherwise the path is set as
+          # provided.
+          #
+          # @param  [PBXGroup, PBXFileReference] object
+          #         The object whose path needs to be set.
+          #
+          # @param  [#to_s] path
+          #         The path.
+          #
+          # @param  [Symbol] source_tree_key
+          #         The source tree type, see {SOURCE_TREES_BY_KEY} for
+          #         acceptable values.
+          #
+          # @return [void]
+          #
+          def set_path_with_source_tree(object, path, source_tree_key)
+            path = Pathname.new(path)
+            source_tree = SOURCE_TREES_BY_KEY[source_tree_key]
+            object.source_tree = source_tree
+
+            unless source_tree
+              raise "[Xcodeproj] Unrecognized source tree option `#{source_tree_key}` for path `#{path}`"
+            end
+
+            if source_tree_key == :absolute
+              unless path.absolute?
+                raise "[Xcodeproj] Attempt to set a relative path with an " \
+                  "absolute source tree: `#{path}`"
+              end
+              object.path = path.to_s
+            elsif source_tree_key == :group || source_tree_key == :project
+              source_tree_real_path = GroupableHelper.source_tree_real_path(object)
+              if source_tree_real_path && source_tree_real_path.absolute? == path.absolute?
+                relative_path = path.relative_path_from(source_tree_real_path)
+                object.path = relative_path.to_s
+              else
+                object.path = path.to_s
+              end
+            else
+              object.path = path.to_s
+            end
+          end
+
+          private
+
+          # @group Helpers
+          #-------------------------------------------------------------------#
+
+          # Checks whether there is a single identifiable parent and raises
+          # otherwise.
+          #
+          # @return [void]
+          #
+          def check_parents_integrity(object)
+            referrers_count = object.referrers.count
+            if referrers_count > 1
+              referrers_count = object.referrers.select{ |obj| obj.isa == 'PBXGroup' }.count
+            end
+
+            if referrers_count == 0
+              raise "[Xcodeproj] Consistency issue: no parent " \
+                "for object `#{object.display_name}`: "\
+                "#{object.referrers}"
+            elsif referrers_count > 1
+              raise "[Xcodeproj] Consistency issue: unexpected multiple parents " \
+                "for object `#{object.display_name}`: "\
+                "#{object.referrers}"
+            end
+          end
+
+          #-------------------------------------------------------------------#
+
+        end
+      end
+    end
+  end
+end

data/lib/xcodeproj/project/object/native_target.rb

@@ -71,6 +71,29 @@ module Xcodeproj
           build_configuration_list.build_configurations
         end
 
+        # Adds a new build configuration to the target and populates its with
+        # default settings according to the provided type.
+        #
+        # @note   If a build configuration with the given name is already
+        #         present no new build configuration is added.
+        #
+        # @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.
+        #
+        def add_build_configuration(name, type, skip_existing_names = true)
+          unless build_configuration_list[name]
+            build_configuration = project.new(XCBuildConfiguration)
+            build_configuration.name = name
+            build_configuration.build_settings = ProjectHelper.common_build_settings(type, platform_name, deployment_target, product_type)
+            build_configuration_list.build_configurations << build_configuration
+            build_configuration
+          end
+        end
+
         # @param  [String] build_configuration_name
         #         the name of a build configuration.
         #

data/lib/xcodeproj/project/project_helper.rb

@@ -49,16 +49,14 @@ module Xcodeproj
         product = product_group.new_static_library(name)
         target.product_reference = product
 
+        # Build phases
+        target.build_phases << project.new(PBXSourcesBuildPhase)
+        target.build_phases << project.new(PBXFrameworksBuildPhase)
+
         # Frameworks
         framework_name = (platform == :ios) ? 'Foundation' : 'Cocoa'
         framework_ref = project.add_system_framework(framework_name, target)
 
-        # Build phases
-        target.build_phases << project.new(PBXSourcesBuildPhase)
-        frameworks_phase = project.new(PBXFrameworksBuildPhase)
-        frameworks_phase.add_file_reference(framework_ref)
-        target.build_phases << frameworks_phase
-
         target
       end
 
@@ -88,20 +86,9 @@ module Xcodeproj
         target.product_name = name
         target.product_type = Constants::PRODUCT_TYPE_UTI[:bundle]
 
-        # Configuration List
-        build_settings = {
-          'PRODUCT_NAME' => '$(TARGET_NAME)',
-          'WRAPPER_EXTENSION' => 'bundle',
-          'SKIP_INSTALL' => 'YES'
-        }
-
-        if platform == :osx
-          build_settings['COMBINE_HIDPI_IMAGES'] = 'YES'
-          build_settings['SDKROOT'] = 'macosx'
-        else
-          build_settings['SDKROOT'] = 'iphoneos'
-        end
+        build_settings = common_build_settings(nil, platform, nil, target.product_type)
 
+        # Configuration List
         cl = project.new(XCConfigurationList)
         cl.default_configuration_is_visible = '0'
         cl.default_configuration_name = 'Release'
@@ -132,10 +119,8 @@ module Xcodeproj
 
       #-----------------------------------------------------------------------#
 
-      # 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.
       #
       # @param  [Project] project
       #         the project to which the configuration list should be added.
@@ -144,12 +129,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 self.add_system_framework(project, name, target)
         sdk = target.sdk
@@ -171,13 +156,13 @@ module Xcodeproj
         end
 
         path = base_dir + "System/Library/Frameworks/#{name}.framework"
-        if ref = project.frameworks_group.files.find { |f| f.path == path }
-          ref
-        else
-          ref = project.frameworks_group.new_file(path)
-          ref.source_tree = 'DEVELOPER_DIR'
-          ref
+        ref = project.frameworks_group.files.find { |f| f.path == path }
+        unless ref
+          ref = project.frameworks_group.new_file(path, :developer_dir)
         end
+
+        target.frameworks_build_phase.add_file_reference(ref)
+        ref
       end
 
       # @!group Private Helpers
@@ -231,20 +216,36 @@ module Xcodeproj
       #
       # @return [Hash] The common build settings
       #
-      def self.common_build_settings(type, platform, deployment_target = nil)
-        common_settings = Constants::COMMON_BUILD_SETTINGS
-        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
+      def self.common_build_settings(type, platform, deployment_target = nil, target_product_type = nil)
+        if target_product_type == Constants::PRODUCT_TYPE_UTI[:bundle]
+          build_settings = {
+            'PRODUCT_NAME' => '$(TARGET_NAME)',
+            'WRAPPER_EXTENSION' => 'bundle',
+            'SKIP_INSTALL' => 'YES'
+          }
+
+          if platform == :osx
+            build_settings['COMBINE_HIDPI_IMAGES'] = 'YES'
+            build_settings['SDKROOT'] = 'macosx'
+          else
+            build_settings['SDKROOT'] = 'iphoneos'
+          end
+          build_settings
+        else
+          common_settings = Constants::COMMON_BUILD_SETTINGS
+          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
-        settings
       end
 
       #-----------------------------------------------------------------------#