xcodeproj 0.9.0 → 0.10.0

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

@@ -32,6 +32,18 @@ module Xcodeproj
 
         # @!group Helpers
 
+        # Returns the build configuration with the given name.
+        #
+        # @param  [String] name
+        #         The name of the build configuration.
+        #
+        # @return [XCBuildConfiguration] The build configuration.
+        # @return [Nil] If not build configuration with the given name is found.
+        #
+        def [](name)
+          build_configurations.find { |bc| bc.name == name }
+        end
+
         # Returns the build settings of the build configuration with
         # the given name.
         #
@@ -41,8 +53,9 @@ module Xcodeproj
         # @return [Hash {String=>String}] the build settings
         #
         def build_settings(build_configuration_name)
-          config = build_configurations.find { |bc| bc.name == build_configuration_name }
-          config.build_settings if config
+          if config = self[build_configuration_name]
+            config.build_settings
+          end
         end
 
         #---------------------------------------------------------------------#

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

@@ -1,3 +1,5 @@
+require 'xcodeproj/project/object/helpers/groupable_helper'
+
 module Xcodeproj
   class Project
     module Object
@@ -16,10 +18,17 @@ module Xcodeproj
         #
         attribute :path, String
 
-        # @return [String] the source tree to which the file is relative.
+        # @return [String] the directory to which the path is relative.
         #
-        # @note   Common values are `SOURCE_ROOT`, `SDKROOT` and
-        #         `BUILT_PRODUCTS_DIR`
+        # @note   The accepted values are:
+        #         - `<absolute>` for absolute paths
+        #         - `<group>` for paths relative to the group
+        #         - `SOURCE_ROOT` for paths relative to the project
+        #         - `DEVELOPER_DIR` for paths relative to the developer
+        #           directory.
+        #         - `BUILT_PRODUCTS_DIR` for paths relative to the build
+        #           products directory.
+        #         - `SDKROOT` for paths relative to the SDK directory.
         #
         attribute :source_tree, String, 'SOURCE_ROOT'
 
@@ -92,7 +101,6 @@ module Xcodeproj
         #
         attribute :wraps_lines, String
 
-
         # @return [String] Apparently whether Xcode should add, if needed, a
         #         new line feed before saving the file.
         #
@@ -117,19 +125,37 @@ module Xcodeproj
         #         needed.
         #
         def display_name
-          name || File.basename(path)
+          name || (File.basename(path) if path)
+        end
+
+        # @return [PBXGroup, PBXProject] the parent of the file.
+        #
+        def parent
+          GroupableHelper.parent(self)
+        end
+
+        # @return [String] A representation of the reference hierarchy.
+        #
+        def hierarchy_path
+          GroupableHelper.hierarchy_path(self)
         end
 
-        # @return [Pathname] the path of the file.
+        # Moves the reference to a new parent.
+        #
+        # @param  [PBXGroup] new_parent
+        #         The new parent.
         #
-        def pathname
-          Pathname.new(path)
+        # @return [void]
+        #
+        def move(new_parent)
+          GroupableHelper.move(self, new_parent)
         end
 
-        # @return [PBXGroup] the group that contains the current file reference.
+        # @return [Pathname] the absolute path of the file resolving the
+        # source tree.
         #
-        def group
-          referrers.select { |r| r.class == PBXGroup }.first
+        def real_path
+          GroupableHelper.real_path(self)
         end
 
         # @return [Array<PBXBuildFile>] the build files associated with the
@@ -141,10 +167,30 @@ module Xcodeproj
 
         # Sets the last known file type according to the extension of the path.
         #
-        # @return [String] the computed file type.
+        # @return [void]
+        #
+        def set_last_known_file_type(type = nil)
+          if type
+            self.last_known_file_type = type
+          elsif path
+            extension = Pathname(path).extname[1..-1]
+            self.last_known_file_type = Constants::FILE_TYPES_BY_EXTENSION[extension]
+          end
+        end
+
+        # Sets the explicit file type according to the extension of the path,
+        # and clears the last known file type.
+        #
+        # @return [void]
         #
-        def update_last_known_file_type
-          self.last_known_file_type = Constants::FILE_TYPES_BY_EXTENSION[pathname.extname[1..-1]]
+        def set_explicit_file_type(type = nil)
+          self.last_known_file_type = nil
+          if type
+            self.explicit_file_type = type
+          elsif path
+            extension = Pathname(path).extname[1..-1]
+            self.explicit_file_type = Constants::FILE_TYPES_BY_EXTENSION[extension]
+          end
         end
 
         # Checks whether the reference is a proxy.

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

@@ -1,3 +1,6 @@
+require 'xcodeproj/project/object/helpers/groupable_helper'
+require 'xcodeproj/project/object/helpers/file_references_factory'
+
 module Xcodeproj
   class Project
     module Object
@@ -14,9 +17,17 @@ module Xcodeproj
         #
         has_many :children, [PBXGroup, PBXFileReference, PBXReferenceProxy]
 
-        # @return [String] the source tree to which this group is relative.
+        # @return [String] the directory to which the path is relative.
         #
-        # @note   Usually is group <group>.
+        # @note   The accepted values are:
+        #         - `<absolute>` for absolute paths
+        #         - `<group>` for paths relative to the group
+        #         - `SOURCE_ROOT` for paths relative to the project
+        #         - `DEVELOPER_DIR` for paths relative to the developer
+        #           directory.
+        #         - `BUILT_PRODUCTS_DIR` for paths relative to the build
+        #           products directory.
+        #         - `SDKROOT` for paths relative to the SDK directory.
         #
         attribute :source_tree, String, '<group>'
 
@@ -86,6 +97,36 @@ module Xcodeproj
           end
         end
 
+        # @return [PBXGroup, PBXProject] The parent of the group.
+        #
+        def parent
+          GroupableHelper.parent(self)
+        end
+
+        # @return [String] A representation of the group hierarchy.
+        #
+        def hierarchy_path
+          GroupableHelper.hierarchy_path(self)
+        end
+
+        # Moves the group to a new parent.
+        #
+        # @param  [PBXGroup] new_parent
+        #         The new parent.
+        #
+        # @return [void]
+        #
+        def move(new_parent)
+          GroupableHelper.move(self, new_parent)
+        end
+
+        # @return [Pathname] the absolute path of the group resolving the
+        # source tree.
+        #
+        def real_path
+          GroupableHelper.real_path(self)
+        end
+
         # @return [Array<PBXFileReference>] the files references in the group
         #         children.
         #
@@ -99,6 +140,13 @@ module Xcodeproj
           children.select { |obj| obj.class == PBXGroup }
         end
 
+        # @return [Array<XCVersionGroup>] the version groups in the group
+        #         children.
+        #
+        def version_groups
+          children.select { |obj| obj.class == XCVersionGroup }
+        end
+
         # @return [Array<PBXGroup,PBXFileReference,PBXReferenceProxy>] the
         #         recursive children of the group.
         #
@@ -111,198 +159,74 @@ module Xcodeproj
           result
         end
 
-        # @return [Array<XCVersionGroup>] the version groups in the group
-        #         children.
+        # @return [Bool] Whether the group is empty.
         #
-        def version_groups
-          children.select { |obj| obj.class == XCVersionGroup }
+        def empty?
+          children.count.zero?
         end
 
-        # Creates a new file reference with the given path and adds it to the
-        # group or to an optional subpath.
-        #
-        # @note   The subpath is created if needed, similar to the UNIX command
-        #         `mkdir -p`
-        #
-        # @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.
+        # Creates a new reference with the given path and adds it to the
+        # group. The reference is configured according to the extension
+        # of the path.
         #
         # @param  [#to_s] path
-        #         the file system path of the file.
-        #
-        # @param  [String] sub_group_path
-        #         an optional subgroup path indicating the groups separated by
-        #         a `/`.
-        #
-        # @return [PBXFileReference] the new file reference.
-        #
-        def new_file(path, sub_group_path = nil)
-          extname = File.extname(path)
-          case
-          when extname == '.framework' then new_framework(path, sub_group_path)
-          when extname == '.xcdatamodeld' then new_xcdatamodeld(path, sub_group_path)
-          else new_file_reference(path, sub_group_path)
-          end
-        end
-
-        # Creates a new file reference with the given path and adds it to the
-        # group or to an optional subpath.
-        #
-        # @note   @see #new_file
+        #         The, preferably absolute, path of the reference.
         #
-        # @param  @see #new_file
+        # @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.
+        # @return [PBXFileReference, XCVersionGroup] The new reference.
         #
-        def new_file_reference(path, sub_group_path = nil)
-          ref = project.new(PBXFileReference)
-          ref.path = path.to_s
-          ref.update_last_known_file_type
-
-          parent_group = find_subpath(sub_group_path, true)
-          parent_group.children << ref
-          set_file_refenrece_name_if_needed(ref, parent_group)
-          ref
+        def new_reference(path, source_tree = :group)
+          FileReferencesFactory.new_reference(self, path, source_tree)
         end
+        alias :new_file :new_reference
 
-        # Sets the name of a reference if needed, to match Xcode behaviour.
-        #
-        # @param  [PBXFileReference, XCVersionGroup] ref
-        #         the reference which needs the name optionally set.
-        #
-        # @return [void]
-        #
-        def set_file_refenrece_name_if_needed(ref, parent_group)
-          same_path_of_group = (parent_group.path == Pathname(ref.path).dirname.to_s)
-          same_path_project = (Pathname(ref.path).dirname.to_s == '.' && parent_group.path.nil?)
-          unless same_path_of_group || same_path_project
-            ref.name = Pathname(ref.path).basename.to_s
-          end
-        end
-
-        # Creates a new file reference to a framework bundle.
-        #
-        # @note   @see #new_file
+        # Creates a file reference to a static library and adds it to the
+        # group.
         #
-        # @param  @see #new_file
+        # @param  [#to_s] product_name
+        #         The name of the static library.
         #
-        # @return [PBXFileReference] the new file reference.
+        # @return [PBXFileReference] The new file reference.
         #
-        def new_framework(path, sub_group_path = nil)
-          ref = new_file_reference(path, sub_group_path = nil)
-          ref.include_in_index = nil
-          ref
+        def new_static_library(product_name)
+          FileReferencesFactory.new_static_library(self, product_name)
         end
 
-        # Creates a new version group reference to an xcdatamodeled adding the
-        # xcdatamodel files included in the wrapper as chidren file references.
-        #
-        # @note  To match Xcode behaviour the last xcdatamodel according to its
-        #        path is set as the current version.
-        #
-        # @note   @see #new_file
+        # Creates a file reference to a new bundle.
         #
-        # @param  @see #new_file
+        # @param  [#to_s] product_name
+        #         The name of the bundle.
         #
-        # @return [XCVersionGroup] the new reference.
+        # @return [PBXFileReference] The new file reference.
         #
-        def new_xcdatamodeld(path, sub_group_path = nil)
-          path = Pathname.new(path)
-          ref = project.new(XCVersionGroup)
-          ref.path = path.to_s
-          ref.source_tree = '<group>'
-          ref.version_group_type = 'wrapper.xcdatamodel'
-
-          last_child_ref = nil
-          if path.exist?
-            path.children.each do |child_path|
-              if File.extname(child_path) == '.xcdatamodel'
-                child_ref = ref.new_file_reference(child_path)
-                child_ref.source_tree = '<group>'
-                last_child_ref = child_ref
-              end
-            end
-            ref.current_version = last_child_ref
-          end
-
-          parent_group = find_subpath(sub_group_path, true)
-          parent_group.children << ref
-          set_file_refenrece_name_if_needed(ref, parent_group)
-          ref
+        def new_bundle(product_name)
+          FileReferencesFactory.new_bundle(self, product_name)
         end
 
-        # Creates a new group with the given name and adds it to the children
-        # of the group.
+        # Creates a file reference to a new bundle and adds it to the group.
         #
-        # @note   @see new_file
+        # @note   @see new_reference
         #
         # @param  [#to_s] name
         #         the name of the new group.
         #
-        # @param  [String] sub_group_path @see new_file
-        #
         # @return [PBXGroup] the new group.
         #
-        def new_group(name, sub_group_path = nil)
+        def new_group(name, path = nil, source_tree = :group)
           group = project.new(PBXGroup)
+          children << group
           group.name = name
-
-          target = find_subpath(sub_group_path, true)
-          target.children << group
+          if path
+            GroupableHelper.set_path_with_source_tree(group, path, source_tree)
+          else
+            group.source_tree = '<group>'
+          end
           group
         end
 
-        # Creates a file reference to a static library and adds it to the
-        # children of the group.
-        #
-        # @note @see new_file
-        #
-        # @param  [#to_s] product_name
-        #         the name of the new static library.
-        #
-        # @param  [String] sub_group_path @see new_file
-        #
-        # @return [PBXFileReference] the new file reference.
-        #
-        def new_static_library(product_name, sub_group_path = nil)
-          file = new_file("lib#{product_name}.a", sub_group_path)
-          file.include_in_index = '0'
-          file.source_tree = 'BUILT_PRODUCTS_DIR'
-          file.explicit_file_type = file.last_known_file_type
-          file.last_known_file_type = nil
-          file
-        end
-
-        # Creates a file reference to a new bundle.
-        #
-        # @param  [#to_s] product_name
-        #         the name of the bundle.
-        #
-        # @return [PBXFileReference] the new file reference.
-        #
-        def new_bundle(product_name)
-          file = new_file("#{product_name}.bundle")
-          file.explicit_file_type = 'wrapper.cfbundle'
-          file.include_in_index = '0'
-          file.source_tree = 'BUILT_PRODUCTS_DIR'
-          file.last_known_file_type = nil
-          file
-        end
-
-        # Creates a new group to represent a `xcdatamodel` file.
-        #
-        # @return [XCVersionGroup] The new group.
-        #
-        def new_xcdatamodel_group(xcdatamodel_path)
-          g = @project.new(XCVersionGroup)
-          g.path = xcdatamodel_path
-          g.version_group_type = 'wrapper.xcdatamodel'
-          file = g.new_file(xcdatamodel_path.sub(/xcdatamodeld$/, 'xcdatamodel'))
-          g.current_version = file
-          g
-        end
-
         # Traverses the children groups and finds the group with the given
         # path, if exists.
         #
@@ -314,12 +238,10 @@ module Xcodeproj
 
         # Removes children files and groups under this group.
         #
+        # @TODO: remove from project should suffice.
+        #
         def remove_children_recursively
-          groups.each do |g|
-            g.remove_children_recursively
-            g.remove_from_project
-          end
-          files.each { |f| f.remove_from_project }
+          children.objects.each(&:remove_from_project)
         end
 
         # Traverses the children groups and finds the children with the given
@@ -379,7 +301,7 @@ module Xcodeproj
         #
         # @return [void]
         #
-        def sort_by_type!
+        def sort_by_type
           children.sort! do |x, y|
             if x.is_a?(PBXGroup) && y.is_a?(PBXFileReference)
               -1
@@ -390,6 +312,15 @@ module Xcodeproj
             end
           end
         end
+
+        # Sorts the group by type recursively.
+        #
+        # @return [void]
+        #
+        def recursively_sort_by_type
+          groups.each { |group| group.recursively_sort_by_type }
+          sort_by_type
+        end
       end
 
       #-----------------------------------------------------------------------#
@@ -403,6 +334,7 @@ module Xcodeproj
         # @return [String] the file type guessed by Xcode.
         #
         attribute :last_known_file_type, String
+
       end
 
       #-----------------------------------------------------------------------#