xcodeproj 0.3.5 → 0.4.0.rc1

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

@@ -2,122 +2,246 @@ module Xcodeproj
   class Project
     module Object
 
-      class AbstractGroupEntry < AbstractPBXObject
-        has_one :group, :inverse_of => :children
-
-        def initialize(project, uuid, attributes)
-          is_new = uuid.nil?
-          super
-          # If there's no root_object yet, then this is probably the main group.
-          if is_new && @project.root_object
-            @project.main_group.children << self
-          end
-        end
+      # This class represents a group. A group can contain other groups
+      # (PBXGroup) and file references (PBXFileReference).
+      #
+      class PBXGroup < AbstractObject
+
+        # @return [ObjectList<PBXGroup, PBXFileReference>]
+        #   the objects contained by the group.
+        #
+        has_many :children, [PBXGroup, PBXFileReference]
+
+        # @return [String] the source tree to which this group is relative.
+        #
+        #   Usually is group <group>.
+        #
+        attribute :source_tree, String, '<group>'
+
+        # @return [String] the path to a folder in the file system.
+        #
+        #   This attribute is present for groups that are linked to a folder in
+        #   the file system.
+        #
+        attribute :path, String
+
+        # @return [String] the name of the group.
+        #
+        #   If path is specified this attribute is not present.
+        #
+        attribute :name, String
 
-        def destroy
-          group.child_references.delete(uuid)
-          super
-        end
+      end
+
+      # The purpose of this subclass is not understood.
+      #
+      class PBXVariantGroup < PBXGroup
 
-        # Sorts groups before files and inside those sorts by name.
-        def <=>(other)
-          if self.is_a?(PBXGroup) && other.is_a?(PBXFileReference)
-            -1
-          elsif self.is_a?(PBXFileReference) && other.is_a?(PBXGroup)
-            1
-          else
-            self.name <=> other.name
-          end
-        end
       end
 
-      # @todo The `source_tree` can probably be more than just `<group>`.
-      class PBXGroup < AbstractGroupEntry
-        # [String] the source tree to which this group is relative. It can be
-        #          `<group>`.
-        attribute :source_tree
-
-        has_many :children, :class => AbstractGroupEntry do |child|
-          # Associating the AbstractGroupEntry instance to this group through
-          # the inverse association will also remove it from the group it was
-          # in.
-          child.group = self
-        end
+      # A group that contains multiple files references to the different
+      # versions of a resource.
+      #
+      # Used to contain the different versions of a `xcdatamodel`.
+      #
+      class XCVersionGroup < PBXGroup
 
-        def initialize(*)
-          super
-          self.source_tree ||= '<group>'
-          self.child_references ||= []
-        end
+        # @return [PBXFileReference] the reference to the current version.
+        #
+        has_one :current_version, PBXFileReference
 
-        def main_group?
-          @project.main_group.uuid == uuid
-        end
+        # @return [String] the type of the versioned resource.
+        #
+        attribute :version_group_type, String, 'wrapper.xcdatamodel'
+
+      end
+
+      class PBXGroup < AbstractObject
 
-        def name
-          if name = super
+        ## CONVENIENCE METHODS #################################################
+
+        # @!group Convenience methods
+
+        # @return [String] the name of the group taking into account the path
+        #   or other factors if needed.
+        #
+        def display_name
+          if name
             name
-          elsif attributes.has_key?('path')
-            File.basename(attributes['path'])
-          elsif main_group?
+          elsif path
+            File.basename(path)
+          elsif self.equal?(project.main_group)
             'Main Group'
           end
         end
 
+        # @return [Array<PBXFileReference>] the files references in the group
+        #   children.
+        #
         def files
-          children.list_by_class(PBXFileReference)
-        end
-
-        def create_file(path)
-          files.new("path" => path)
-        end
-
-        def create_files(paths)
-          paths.map { |path| create_file(path) }
-        end
-
-        def source_files
-          children.list_by_class(PBXFileReference) do |list|
-            list.let(:uuid_scope) do
-              files.reject { |file| file.build_files.empty? }.map(&:uuid)
-            end
-          end
+          children.select { |obj| obj.class == PBXFileReference }
         end
 
+        # @return [Array<PBXGroup>] the groups in the group
+        #   children.
+        #
         def groups
-          children.list_by_class(PBXGroup)
+          children.select { |obj| obj.class == PBXGroup }
         end
 
-        def create_group(name)
-          groups.new("name" => name)
+        # @return [Array<XCVersionGroup>] the version groups in the group
+        #   children.
+        #
+        def version_groups
+          children.select { |obj| obj.class == XCVersionGroup }
+        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`
+        #
+        # @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)
+          file = project.new(PBXFileReference)
+          file.path = path.to_s
+          file.name = file.pathname.basename.to_s
+          file.update_last_known_file_type
+
+          target = find_subpath(sub_group_path, true)
+          target.children << file
+          file
+        end
+
+        # Creates a new group with the given name and adds it to the children
+        # of the group.
+        #
+        # @note (see #new_file)
+        #
+        # @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)
+          group = project.new(PBXGroup)
+          group.name = name
+
+          target = find_subpath(sub_group_path, true)
+          target.children << group
+          group
         end
 
-        def version_groups
-          children.list_by_class(XCVersionGroup)
+        # 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 group.
+        #
+        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 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, optionally, creating any needed group.
+        #
+        # @param path (see #find_subpath)
+        #
+        # @note (see #find_subpath)
+        #
+        def [](path)
+          find_subpath(path)
+        end
+
+        # Traverses the children groups and finds the children with the given
+        # path, optionally, creating any needed group. If the given path is
+        # `nil` it returns itself.
+        #
+        # @param [String] path
+        #   a string with the names of the groups separated by a '`/`'.
+        #
+        # @param [Boolean] should_create
+        #   whether the path should be created.
+        #
+        # @note The path is matched against the {#display_name} of the groups.
+        #
+        # @example
+        #   g = main_group['Frameworks']
+        #   g.name #=> 'Frameworks'
+        #
+        # @return [PBXGroup] the group if found.
+        #
+        def find_subpath(path, should_create = false)
+          return self unless path
+          path = path.split('/') unless path.is_a?(Array)
+          child_name = path.shift
+          child = children.find{ |c| c.display_name == child_name }
+          child = new_group(child_name) if child.nil? && should_create
+          if path.empty?
+            child
+          else
+            child.find_subpath(path, should_create)
+          end
         end
 
+        # Adds an object to the group.
+        #
+        # @return [ObjectList<AbstractObject>] the children list.
+        #
         def <<(child)
           children << child
         end
-      end
 
-      class XCVersionGroup < PBXGroup
-
-        attribute :version_group_type
-        attribute :current_version
-        attribute :path
-
-        def self.new_xcdatamodel_group(project, xcdatamodel_path)
-          group = new(project, nil, 'path' => xcdatamodel_path, 'versionGroupType' => 'wrapper.xcdatamodel')
-          file = group.files.new(
-            'path' => xcdatamodel_path.sub(/xcdatamodeld$/, 'xcdatamodel'),
-            'lastKnownFileType' => 'wrapper.xcdatamodel'
-          )
-          group.current_version = file.uuid
-          group
+        # Sorts the children of the group by type and then by name.
+        #
+        # @return [void]
+        #
+        def sort_by_type
+          children.sort do |x, y|
+            if x.is_a?(PBXGroup) && y.is_a?(PBXFileReference)
+              -1
+            elsif x.is_a?(PBXFileReference) && y.is_a?(PBXGroup)
+              1
+            elsif x.respond_to?(:name) && y.respond_to?(:name)
+              x.name <=> y.name
+            else
+              0
+            end
+          end
         end
-      end
-
+      end # PBXGroup
     end
   end
 end

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

@@ -2,160 +2,217 @@ module Xcodeproj
   class Project
     module Object
 
-      class PBXNativeTarget < AbstractPBXObject
-        STATIC_LIBRARY = 'com.apple.product-type.library.static'
+      # Represents a target.
+      #
+      class PBXNativeTarget < AbstractObject
 
-        # [String] the name of the build product
-        attribute :product_name
-
-        # [String] the build product type identifier
-        attribute :product_type
-
-        has_many :build_phases
-        has_many :dependencies # TODO :class => ?
-        has_many :build_rules # TODO :class => ?
-        has_one :build_configuration_list, :class => XCConfigurationList
-        has_one :product, :uuid => :product_reference
-
-        def self.new_static_library(project, platform, name)
-          project.add_system_framework(platform == :ios ? 'Foundation' : 'Cocoa')
-
-          target = new(project, nil, 'productType' => STATIC_LIBRARY, 'productName' => name)
-          target.product.path = "lib#{name}.a"
+        # @return [String] The name of the Target.
+        #
+        attribute :name, String
 
-          target.build_configurations.each do |config|
-            config.build_settings.merge!(XCBuildConfiguration::COMMON_BUILD_SETTINGS[platform])
+        # @return [XCConfigurationList] the list of the build configurations of
+        #   the target. This list commonly include two configurations `Debug`
+        #   and `Release`.
+        #
+        has_one :build_configuration_list, XCConfigurationList
 
-            # E.g. [:ios, :release]
-            extra_settings_key = [platform, config.name.downcase.to_sym]
-            if extra_settings = XCBuildConfiguration::COMMON_BUILD_SETTINGS[extra_settings_key]
-              config.build_settings.merge!(extra_settings)
-            end
-          end
+        # @return [PBXBuildRule] the build phases of the target.
+        #
+        # @note Apparently only PBXCopyFilesBuildPhase and
+        #   PBXShellScriptBuildPhase can appear multiple times in a target.
+        #
+        has_many :build_phases, AbstractBuildPhase
 
-          target
-        end
+        # @return [PBXBuildRule] the build rules of this target.
+        #
+        has_many :build_rules, PBXBuildRule
 
-        # You need to specify a product. For a static library you can use
-        # PBXFileReference.new_static_library.
-        def initialize(project, *)
-          super
-          self.name ||= product_name
-          self.build_rule_references  ||= []
-          self.dependency_references  ||= []
+        # @return [PBXNativeTarget] the targets necessary to build this target.
+        #
+        has_many :dependencies, PBXTargetDependency
 
-          unless build_phase_references
-            self.build_phase_references = []
+        # @return [String] the name of the build product.
+        #
+        attribute :product_name, String
 
-            source_build_phases.new
-            copy_files_build_phases.new
-            #shell_script_build_phases.new
+        # @return [String] the build product type identifier.
+        #
+        attribute :product_type, String, 'com.apple.product-type.library.static'
 
-            phase = frameworks_build_phases.new
-            if frameworks_group = @project.groups.where(:name => 'Frameworks')
-              frameworks_group.files.each { |framework| phase << framework }
-            end
-          end
+        # @return [PBXFileReference] the reference to the product file.
+        #
+        has_one :product_reference, PBXFileReference
 
-          unless build_configuration_list
-            self.build_configuration_list = project.objects.add(XCConfigurationList, {
-              'defaultConfigurationIsVisible' => '0',
-              'defaultConfigurationName' => 'Release',
-            })
-            # TODO or should this happen in buildConfigurationList?
-            build_configuration_list.build_configurations.new_debug
-            build_configuration_list.build_configurations.new_release
-          end
+        # @return [String] the install path of the product.
+        #
+        attribute :product_install_path, String
 
-          unless product
-            self.product = @project.files.new_static_library(product_name)
-          end
-        end
+        ## CONVENIENCE METHODS #################################################
 
-        alias_method :_product=, :product=
-        def product=(product)
-          self._product = product
-          @project.products << product
-        end
+        # @!group Convenience methods
 
+        # @return [ObjectList<XCBuildConfiguration>] the build
+        #   configurations of the target.
+        #
         def build_configurations
           build_configuration_list.build_configurations
         end
 
+        # @return [Hash] the build settings of the build configuration with the
+        #   given name.
+        #
+        # @param [String] build_configuration_name
+        #   the name of a build configuration.
+        #
         def build_settings(build_configuration_name)
           build_configuration_list.build_settings(build_configuration_name)
         end
 
-        def source_build_phases
-          build_phases.list_by_class(PBXSourcesBuildPhase)
+        # Adds source files to the target.
+        #
+        # @param [Array<PBXFileReference>] file_references
+        #   The files references of the source files that should be added to
+        #   the target.
+        #
+        # @param [Hash{String=>String}] compiler_flags
+        #   The compiler flags for the source files.
+        #
+        # @return [void]
+        #
+        def add_file_references(file_references, compiler_flags = {})
+          file_references.each do |file|
+            build_file = project.new(PBXBuildFile)
+            build_file.file_ref = file
+
+            extension = File.extname(file.path)
+            header_extensions = Constants::HEADER_FILES_EXTENSIONS
+            if (header_extensions.include?(extension))
+              build_file.settings = { 'ATTRIBUTES' => ["Public"] }
+              phase = headers_build_phase
+              phase.files << build_file
+            else
+              build_file.settings = { 'COMPILER_FLAGS' => compiler_flags } if compiler_flags && !compiler_flags.empty?
+              source_build_phase.files << build_file
+            end
+          end
         end
 
-        def copy_files_build_phases
-          build_phases.list_by_class(PBXCopyFilesBuildPhase)
-        end
 
-        def frameworks_build_phases
-          build_phases.list_by_class(PBXFrameworksBuildPhase)
+        # @!group Accessing build phases
+
+        # Finds or creates the headers build phase of the target.
+        #
+        # @note A target should have only one headers build phase.
+        #
+        # @return [PBXHeadersBuildPhase] the headers build phase.
+        #
+        def headers_build_phase
+          unless @headers_build_phase
+            headers_build_phase = build_phases.find { |bp| bp.class == PBXHeadersBuildPhase }
+            unless headers_build_phase
+              # Working around a bug in Xcode 4.2 betas, remove this once the
+              # Xcode bug is fixed:
+              # https://github.com/alloy/cocoapods/issues/13
+              # phase = copy_header_phase || headers_build_phases.first
+              headers_build_phase = project.new(PBXHeadersBuildPhase)
+              build_phases << headers_build_phase
+            end
+            @headers_build_phase = headers_build_phase
+          end
+          @headers_build_phase
         end
 
-        def shell_script_build_phases
-          build_phases.list_by_class(PBXShellScriptBuildPhase)
+        # Finds or creates the source build phase of the target.
+        #
+        # @note A target should have only one source build phase.
+        #
+        # @return [PBXSourcesBuildPhase] the source build phase.
+        #
+        def source_build_phase
+          unless @source_build_phase
+            source_build_phase = build_phases.find { |bp| bp.class == PBXSourcesBuildPhase }
+            unless source_build_phase
+              source_build_phase = project.new(PBXSourcesBuildPhase)
+              build_phases << source_build_phase
+            end
+            @source_build_phase = source_build_phase
+          end
+          @source_build_phase
         end
 
-        def resources_build_phases
-          build_phases.list_by_class(PBXResourcesBuildPhase)
+        # Finds or creates the frameworks build phase of the target.
+        #
+        # @note A target should have only one frameworks build phase.
+        #
+        # @return [PBXFrameworksBuildPhase] the frameworks build phase.
+        #
+        def frameworks_build_phase
+          bp = build_phases.find { |bp| bp.class == PBXFrameworksBuildPhase }
+          unless bp
+            bp = project.new(PBXFrameworksBuildPhase)
+            build_phases << bp
+          end
+          bp
         end
 
-        # Adds source files to the target.
+        # Finds or creates the resources build phase of the target.
         #
-        # @note
-        #   It finds an existing file reference or creates a new one.
+        # @note A target should have only one resources build phase.
         #
-        # @param source_file_descriptions [Array<SourceFileDescription>] The
-        #   description of the source files to add.
+        # @return [PBXResourcesBuildPhase] the resources build phase.
         #
-        # @return [Array<PBXFileReference>]
+        def resources_build_phase
+          bp = build_phases.find { |bp| bp.class == PBXResourcesBuildPhase }
+          unless bp
+            bp = project.new(PBXResourcesBuildPhase)
+            build_phases << bp
+          end
+          bp
+        end
+
+        # @return [Array<PBXCopyFilesBuildPhase>]
+        #   the copy files build phases of the target.
         #
-        def add_source_files(source_file_descriptions)
-          # Cache the files for performance.
-          files = @project.files.to_a
-          new_files = []
-          source_file_descriptions.each do |source_file_description|
-            path              = source_file_description.path
-            copy_header_phase = source_file_description.copy_header_phase
-            compiler_flags    = source_file_description.compiler_flags
+        def copy_files_build_phases
+          build_phases.select { |bp| bp.class == PBXCopyFilesBuildPhase }
+        end
 
-            file = (files + new_files).find { |file| file.path == path.to_s } || @project.files.new('path' => path.to_s)
-            build_file = file.build_files.new
-            if (path.extname == '.h' || path.extname == '.hpp' || path.extname == '.hh')
-              build_file.settings = { 'ATTRIBUTES' => ["Public"] }
-              # Working around a bug in Xcode 4.2 betas, remove this once the Xcode bug is fixed:
-              # https://github.com/alloy/cocoapods/issues/13
-              #phase = copy_header_phase || headers_build_phases.first
-              phase = copy_header_phase || copy_files_build_phases.first
-              phase.build_files << build_file
-            else
-              build_file.settings = { 'COMPILER_FLAGS' => compiler_flags } if compiler_flags && !compiler_flags.empty?
-              source_build_phases.first.build_files << build_file
-            end
-            new_files << file
-          end
-          new_files
+        # @return [Array<PBXShellScriptBuildPhase>]
+        #   the copy files build phases of the target.
+        #
+        def shell_script_build_phases
+          build_phases.select { |bp| bp.class == PBXShellScriptBuildPhase }
         end
 
-        # Struct representing the description needed to add a source file to
-        # the target.
+
+        # @!group Creating build phases
+
+        # Creates a new copy files build phase.
         #
-        # @!attribute path
-        #   @return [Pathname] The path of the file.
+        # @param [String] name
+        #   an optional name for the pahse.
         #
-        # @!attribute compiler_flags
-        #   @return [String] Any compiler flag.
+        # @return [PBXCopyFilesBuildPhase] the new phase.
         #
-        # @!attribute copy_header_phase
-        #   @return [PBXCopyFilesBuildPhase].
+        def new_copy_files_build_phase(name = nil)
+          phase = project.new(PBXCopyFilesBuildPhase)
+          phase.name = name
+          build_phases << phase
+          phase
+        end
+
+        # Creates a new shell script build phase.
+        #
+        # @param (see #new_copy_files_build_phase)
         #
-        SourceFileDescription = Struct.new(:path, :compiler_flags, :copy_header_phase)
+        # @return [PBXShellScriptBuildPhase] the new phase.
+        #
+        def new_shell_script_build_phase(name = nil)
+          phase = project.new(PBXShellScriptBuildPhase)
+          phase.name = name
+          build_phases << phase
+          phase
+        end
       end
     end
   end