xcodeproj 0.4.0 → 0.4.1

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

@@ -8,6 +8,8 @@ module Xcodeproj
       #
       class XCBuildConfiguration < AbstractObject
 
+        # @!group Attributes
+
         # @return [String] the name of the Target.
         #
         attribute :name, String

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

@@ -7,6 +7,8 @@ module Xcodeproj
       #
       class PBXBuildFile < AbstractObject
 
+        # @!group Attributes
+
         # @return [Hash] the list of build settings for this file.
         #
         # The contents of this array depend on the phase of the build file.

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

@@ -8,6 +8,7 @@ module Xcodeproj
       #
       class AbstractBuildPhase < AbstractObject
 
+        # @!group Attributes
 
         # @return [ObjectList<PBXBuildFile>] the files processed by this build
         #   configuration.
@@ -31,42 +32,60 @@ module Xcodeproj
 
       end
 
-      ### Phases that can appear only once in a target. ########################
+      #-----------------------------------------------------------------------#
 
       # The phase responsible of copying headers (aka `Copy Headers`).
       #
+      # @note This phase can appear only once in a target.
+      #
       class PBXHeadersBuildPhase < AbstractBuildPhase
 
       end
 
+      #-----------------------------------------------------------------------#
+
       # The phase responsible of compiling the files (aka `Compile Sources`).
       #
+      # @note This phase can appear only once in a target.
+      #
       class PBXSourcesBuildPhase < AbstractBuildPhase
 
       end
 
+      #-----------------------------------------------------------------------#
+
       # The phase responsible on linking with frameworks (aka `Link Binary With
       # Libraries`).
       #
+      # @note This phase can appear only once in a target.
+      #
       class PBXFrameworksBuildPhase < AbstractBuildPhase
 
       end
 
+      #-----------------------------------------------------------------------#
+
       # The resources build phase apparently is a specialized copy build phase
       # for resources (aka `Copy Bundle Resources`). It is unclear if this is
       # the only one capable of optimize PNG.
       #
+      # @note This phase can appear only once in a target.
+      #
       class PBXResourcesBuildPhase < AbstractBuildPhase
 
       end
 
-      ### Phases that can appear multiple times in a target. ###################
+      #-----------------------------------------------------------------------#
 
       # Phase that copies the files to the bundle of the target (aka `Copy
       # Files`).
       #
+      # @note This phase can appear multiple times in a target.
+      #
       class PBXCopyFilesBuildPhase < AbstractBuildPhase
 
+        # @!group Attributes
+
         # @return [String] the name of the build phase.
         #
         attribute :name, String
@@ -85,10 +104,16 @@ module Xcodeproj
 
       end
 
+      #-----------------------------------------------------------------------#
+
       # A phase responsible of running a shell script (aka `Run Script`).
       #
+      # @note This phase can appear multiple times in a target.
+      #
       class PBXShellScriptBuildPhase < AbstractBuildPhase
 
+        # @!group Attributes
+
         # @return [String] the name of the build phase.
         #
         attribute :name, String
@@ -119,7 +144,7 @@ module Xcodeproj
         #
         attribute :shell_script, String, ''
 
-        # @return [String] wether or not the ENV variables should be shown in
+        # @return [String] whether or not the ENV variables should be shown in
         #   the build log.
         #
         # Defaults to true (`1`).
@@ -127,17 +152,21 @@ module Xcodeproj
         attribute :show_env_vars_in_log, String, '1'
       end
 
+      #-----------------------------------------------------------------------#
+
       # Apparently a build phase named `Build Carbon Resources` (Observed for
       # kernel extensions targets).
       #
+      # @note This phase can appear multiple times in a target.
+      #
       class PBXRezBuildPhase < AbstractBuildPhase
       end
 
-      class AbstractBuildPhase < AbstractObject
+      #-----------------------------------------------------------------------#
 
-        ## CONVENIENCE METHODS #################################################
+      class AbstractBuildPhase < AbstractObject
 
-        # @!group Convenience methods
+        # @!group Helpers
 
         # @return [Array<PBXFileReference>] the list of all the files
         #   referenced by this build phase.
@@ -179,7 +208,7 @@ module Xcodeproj
         # Removes a build file from the phase and clears its relationship to
         # the file reference.
         #
-        # @param [PBXBuildFile] file the file to remove
+        # @param [PBXBuildFile] build_file the file to remove
         #
         # @return [void]
         #

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

@@ -6,6 +6,8 @@ module Xcodeproj
       #
       class PBXBuildRule < AbstractObject
 
+        # @!group Attributes
+
         # @return [String] the name of the rule.
         #
         attribute :name, String

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

@@ -7,6 +7,8 @@ module Xcodeproj
       #
       class XCConfigurationList < AbstractObject
 
+        # @!group Attributes
+
         # @return [String] whether the default configuration is visible.
         #
         # Usually `0`.
@@ -24,9 +26,9 @@ module Xcodeproj
         #
         has_many :build_configurations, XCBuildConfiguration
 
-        ## CONVENIENCE METHODS #################################################
+        #---------------------------------------------------------------------#
 
-        # @!group Convenience methods
+        # @!group Helpers
 
         # Returns the build settings of the build configuration with
         # the given name.

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

@@ -20,6 +20,8 @@ module Xcodeproj
       #
       class PBXContainerItemProxy < AbstractObject
 
+        # @!group Attributes
+
         # @return [String] apparently the UUID of the root object
         #   {PBXProject} of the project containing the represented object.
         #

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

@@ -6,6 +6,8 @@ module Xcodeproj
       #
       class PBXFileReference < AbstractObject
 
+        # @!group Attributes
+
         # @return [String] the name of the reference, often not present.
         #
         attribute :name, String
@@ -58,7 +60,7 @@ module Xcodeproj
         #
         attribute :plist_structure_definition_identifier, String
 
-        # @return [String] Whether Xcode should use tabs for text aligment.
+        # @return [String] Whether Xcode should use tabs for text alignment.
         #
         #   E.g. `1`
         #
@@ -92,13 +94,13 @@ module Xcodeproj
 
         # @return [String] Comments associated with this file.
         #
-        #   This is apperantly no longer used by Xcode.
+        #   This is apparently no longer used by Xcode.
         #
         attribute :comments, String
 
-        ## CONVENIENCE METHODS #################################################
+        #---------------------------------------------------------------------#
 
-        # @!group Convenience methods
+        # @!group Helpers
 
         # @return [String] the name of the file taking into account the path if
         #   needed.
@@ -134,7 +136,7 @@ module Xcodeproj
           self.last_known_file_type = Constants::FILE_TYPES_BY_EXTENSION[pathname.extname[1..-1]]
         end
 
-        # Checks wheter the reference is a proxy.
+        # Checks whether the reference is a proxy.
         #
         # @return [Bool] always false for this ISA.
         #

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

@@ -7,6 +7,8 @@ module Xcodeproj
       #
       class PBXGroup < AbstractObject
 
+        # @!group Attributes
+
         # @return [ObjectList<PBXGroup, PBXFileReference>]
         #   the objects contained by the group.
         #
@@ -31,7 +33,7 @@ module Xcodeproj
         #
         attribute :name, String
 
-        # @return [String] Whether Xcode should use tabs for text aligment.
+        # @return [String] Whether Xcode should use tabs for text alignment.
         #
         #   E.g. `1`
         #
@@ -55,38 +57,9 @@ module Xcodeproj
         #
         attribute :wraps_lines, String
 
-      end
-
-      # This class is used to gather localized files into one entry.
-      #
-      class PBXVariantGroup < PBXGroup
-        # @return [String] the file type guessed by Xcode.
-        #
-        attribute :last_known_file_type, String
-      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
-
-        # @return [PBXFileReference] the reference to the current version.
-        #
-        has_one :current_version, PBXFileReference
-
-        # @return [String] the type of the versioned resource.
-        #
-        attribute :version_group_type, String, 'wrapper.xcdatamodel'
-
-      end
-
-      class PBXGroup < AbstractObject
-
-        ## CONVENIENCE METHODS #################################################
+        #-----------------------------------------------------------------------#
 
-        # @!group Convenience methods
+        # @!group Helpers
 
         # @return [String] the name of the group taking into account the path
         #   or other factors if needed.
@@ -262,10 +235,16 @@ module Xcodeproj
 
         # Sorts the children of the group by type and then by name.
         #
+        # @note   This is safe to call in an object list because it modifies it
+        #         in C in Ruby MRI. In other Ruby implementation it can cause
+        #         issues if there is one call to the notification enabled
+        #         methods not compensated by the corespondent oposite (loss of
+        #         UUIDs and objects from the project).
+        #
         # @return [void]
         #
-        def sort_by_type
-          children.sort do |x, y|
+        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)
@@ -277,7 +256,42 @@ module Xcodeproj
             end
           end
         end
-      end # PBXGroup
+
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # This class is used to gather localized files into one entry.
+      #
+      class PBXVariantGroup < PBXGroup
+
+        # @!group Attributes
+
+        # @return [String] the file type guessed by Xcode.
+        #
+        attribute :last_known_file_type, String
+      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
+
+        # @!group Attributes
+
+        # @return [PBXFileReference] the reference to the current version.
+        #
+        has_one :current_version, PBXFileReference
+
+        # @return [String] the type of the versioned resource.
+        #
+        attribute :version_group_type, String, 'wrapper.xcdatamodel'
+
+      end
     end
   end
 end

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

@@ -4,6 +4,8 @@ module Xcodeproj
 
       class AbstractTarget < AbstractObject
 
+        # @!group Attributes
+
         # @return [String] The name of the Target.
         #
         attribute :name, String
@@ -13,8 +15,8 @@ module Xcodeproj
         attribute :product_name, String
 
         # @return [XCConfigurationList] the list of the build configurations of
-        #   the target. This list commonly include two configurations `Debug`
-        #   and `Release`.
+        #         the target. This list commonly include two configurations
+        #         `Debug` and `Release`.
         #
         has_one :build_configuration_list, XCConfigurationList
 
@@ -24,10 +26,14 @@ module Xcodeproj
 
       end
 
+      #-----------------------------------------------------------------------#
+
       # Represents a target handled by Xcode.
       #
       class PBXNativeTarget < AbstractTarget
 
+        # @!group Attributes
+
         # @return [PBXBuildRule] the build rules of this target.
         #
         has_many :build_rules, PBXBuildRule
@@ -46,28 +52,36 @@ module Xcodeproj
 
         # @return [PBXBuildRule] the build phases of the target.
         #
-        # @note Apparently only PBXCopyFilesBuildPhase and
-        #   PBXShellScriptBuildPhase can appear multiple times in a target.
+        # @note   Apparently only PBXCopyFilesBuildPhase and
+        #         PBXShellScriptBuildPhase can appear multiple times in a
+        #         target.
         #
         has_many :build_phases, AbstractBuildPhase
 
       end
 
+      #-----------------------------------------------------------------------#
+
       # Represents a target that only consists in a aggregate of targets.
       #
       # @todo apparently it can't have build rules.
       #
       class PBXAggregateTarget < AbstractTarget
 
+        # @!group Attributes
+
         # @return [PBXBuildRule] the build phases of the target.
         #
-        # @note Apparently only PBXCopyFilesBuildPhase and
-        #   PBXShellScriptBuildPhase can appear multiple times in a target.
+        # @note   Apparently only PBXCopyFilesBuildPhase and
+        #         PBXShellScriptBuildPhase can appear multiple times in a
+        #         target.
         #
         has_many :build_phases, [ PBXCopyFilesBuildPhase, PBXShellScriptBuildPhase ]
 
       end
 
+      #-----------------------------------------------------------------------#
+
       # Represents a legacy target which uses an external build tool.
       #
       # Apparently it can't have any build phase but the attribute can be
@@ -75,6 +89,8 @@ module Xcodeproj
       #
       class PBXLegacyTarget < AbstractTarget
 
+        # @!group Attributes
+
         # @return [String] e.g "Dir"
         #
         attribute :build_working_directory, String
@@ -93,8 +109,9 @@ module Xcodeproj
 
         # @return [PBXBuildRule] the build phases of the target.
         #
-        # @note Apparently only PBXCopyFilesBuildPhase and
-        #   PBXShellScriptBuildPhase can appear multiple times in a target.
+        # @note   Apparently only PBXCopyFilesBuildPhase and
+        #         PBXShellScriptBuildPhase can appear multiple times in a
+        #         target.
         #
         has_many :build_phases, AbstractBuildPhase
 
@@ -104,35 +121,72 @@ module Xcodeproj
 
       class AbstractTarget < AbstractObject
 
-        # @!group Convenience methods
+        # @!group Helpers
+
+        def sdk
+          build_configurations.first.build_settings['SDKROOT'] \
+            || project.build_configurations.first.build_settings['SDKROOT']
+        end
+
+        # @return [Symbol] the name of the platform of the target.
+        #
+        def platform_name
+          if    sdk.include? 'iphoneos' then :ios
+          elsif sdk.include? 'macosx'   then :osx
+          end
+        end
+
+        # @return [String] the deployment target of the target according to its
+        #         platform.
+        #
+        def deployment_target
+          if platform_name == :ios
+            build_configurations.first.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] ||
+              project.build_configurations.first.build_settings['IPHONEOS_DEPLOYMENT_TARGET']
+          else
+            build_configurations.first.build_settings['MACOSX_DEPLOYMENT_TARGET'] ||
+              project.build_configurations.first.build_settings['IPHONEOS_DEPLOYMENT_TARGET']
+          end
+        end
+
+        #--------------------------------------#
 
         # @return [ObjectList<XCBuildConfiguration>] the build
-        #   configurations of the target.
+        #         configurations of the target.
         #
         def build_configurations
           build_configuration_list.build_configurations
         end
 
+        # @param  [String] build_configuration_name
+        #         the name of a build configuration.
+        #
         # @return [Hash] the build settings of the build configuration with the
-        #   given name.
+        #         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
 
+        # @!group Build Phases Helpers
+
+        # @return [PBXFrameworksBuildPhase]
+        #         the copy files build phases of the target.
+        #
+        def frameworks_build_phases
+          build_phases.find { |bp| bp.class == PBXFrameworksBuildPhase }
+        end
 
         # @return [Array<PBXCopyFilesBuildPhase>]
-        #   the copy files build phases of the target.
+        #         the copy files build phases of the target.
         #
         def copy_files_build_phases
           build_phases.select { |bp| bp.class == PBXCopyFilesBuildPhase }
         end
 
         # @return [Array<PBXShellScriptBuildPhase>]
-        #   the copy files build phases of the target.
+        #         the copy files build phases of the target.
         #
         def shell_script_build_phases
           build_phases.select { |bp| bp.class == PBXShellScriptBuildPhase }
@@ -140,8 +194,8 @@ module Xcodeproj
 
         # Creates a new copy files build phase.
         #
-        # @param [String] name
-        #   an optional name for the phase.
+        # @param  [String] name
+        #         an optional name for the phase.
         #
         # @return [PBXCopyFilesBuildPhase] the new phase.
         #
@@ -154,7 +208,7 @@ module Xcodeproj
 
         # Creates a new shell script build phase.
         #
-        # @param (see #new_copy_files_build_phase)
+        # @param  (see #new_copy_files_build_phase)
         #
         # @return [PBXShellScriptBuildPhase] the new phase.
         #
@@ -167,18 +221,20 @@ module Xcodeproj
 
       end
 
+      #-----------------------------------------------------------------------#
+
       class PBXNativeTarget < AbstractTarget
 
-        # @!group Convenience methods
+        # @!group Helpers
 
         # 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  [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.
+        # @param  [Hash{String=>String}] compiler_flags
+        #         the compiler flags for the source files.
         #
         # @return [void]
         #
@@ -201,7 +257,7 @@ module Xcodeproj
 
         # Finds or creates the headers build phase of the target.
         #
-        # @note A target should have only one headers build phase.
+        # @note   A target should have only one headers build phase.
         #
         # @return [PBXHeadersBuildPhase] the headers build phase.
         #
@@ -223,7 +279,7 @@ module Xcodeproj
 
         # Finds or creates the source build phase of the target.
         #
-        # @note A target should have only one source build phase.
+        # @note   A target should have only one source build phase.
         #
         # @return [PBXSourcesBuildPhase] the source build phase.
         #
@@ -241,7 +297,7 @@ module Xcodeproj
 
         # Finds or creates the frameworks build phase of the target.
         #
-        # @note A target should have only one frameworks build phase.
+        # @note   A target should have only one frameworks build phase.
         #
         # @return [PBXFrameworksBuildPhase] the frameworks build phase.
         #
@@ -256,7 +312,7 @@ module Xcodeproj
 
         # Finds or creates the resources build phase of the target.
         #
-        # @note A target should have only one resources build phase.
+        # @note   A target should have only one resources build phase.
         #
         # @return [PBXResourcesBuildPhase] the resources build phase.
         #