xcodeproj 0.4.3 → 0.5.0

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

@@ -18,92 +18,103 @@ module Xcodeproj
 
         # @return [String] the source tree to which the file is relative.
         #
-        # Common values are `SOURCE_ROOT`, `SDKROOT` and `BUILT_PRODUCTS_DIR`
+        # @note   Common values are `SOURCE_ROOT`, `SDKROOT` and
+        #         `BUILT_PRODUCTS_DIR`
         #
         attribute :source_tree, String, 'SOURCE_ROOT'
 
         # @return [String] the file type (apparently) used for products
-        #   generated by Xcode (i.e. applications, libraries).
+        #         generated by Xcode (i.e. applications, libraries).
         #
         attribute :explicit_file_type, String
 
         # @return [String] the file type guessed by Xcode.
         #
-        # This attribute is not present if there is an `explicit_file_type`.
+        # @note   This attribute is not present if there is an
+        #         `explicit_file_type`.
         #
         attribute :last_known_file_type, String
 
         # @return [String] whether this file should be indexed. It can
-        #   be either `0` or `1`.
+        #         be either `0` or `1`.
         #
-        # Apparently present only for products generated by Xcode with a value
-        # of `0`.
+        # @note   Apparently present only for products generated by Xcode with
+        #         a value of `0`.
         #
         attribute :include_in_index, String, '1'
 
         # @return [String] a string containing a number which represents the
-        #   encoding format of the file.
+        #         encoding format of the file.
         #
         attribute :fileEncoding, String
 
         # @return [String] a string that specifies the UTI for the syntax
-        #   highlighting.
+        #         highlighting.
         #
-        #   E.g. `xcode.lang.ruby`
+        # @example
+        #   `xcode.lang.ruby`
         #
         attribute :xc_language_specification_identifier, String
 
         # @return [String] a string that specifies the UTI for the structure of
-        #   a plist file.
+        #         a plist file.
         #
-        #   E.g. `com.apple.xcode.plist.structure-definition.iphone.info-plist`
+        # @example
+        #   `com.apple.xcode.plist.structure-definition.iphone.info-plist`
         #
         attribute :plist_structure_definition_identifier, String
 
         # @return [String] Whether Xcode should use tabs for text alignment.
         #
-        #   E.g. `1`
+        # @example
+        #   `1`
         #
         attribute :uses_tabs, String
 
         # @return [String] The width of the indent.
         #
-        #   E.g. `2`
+        # @example
+        #   `2`
         #
         attribute :indent_width, String
 
         # @return [String] The width of the tabs.
         #
-        #   E.g. `2`
+        # @example
+        #   `2`
         #
         attribute :tab_width, String
 
         # @return [String] Whether Xcode should wrap lines.
         #
-        #   E.g. `1`
+        # @example
+        #   `1`
         #
         attribute :wraps_lines, String
 
 
         # @return [String] Apparently whether Xcode should add, if needed, a
-        #   new line feed before saving the file.
+        #         new line feed before saving the file.
         #
-        #   E.g. `0`
+        # @example
+        #   `0`
         #
         attribute :line_ending, String
 
         # @return [String] Comments associated with this file.
         #
-        #   This is apparently no longer used by Xcode.
+        # @note   This is apparently no longer used by Xcode.
         #
         attribute :comments, String
 
         #---------------------------------------------------------------------#
 
+        public
+
         # @!group Helpers
 
         # @return [String] the name of the file taking into account the path if
-        #   needed.
+        #         needed.
         #
         def display_name
           name || File.basename(path)
@@ -122,7 +133,7 @@ module Xcodeproj
         end
 
         # @return [Array<PBXBuildFile>] the build files associated with the
-        #   current file reference.
+        #         current file reference.
         #
         def build_files
           referrers.select { |r| r.class == PBXBuildFile }
@@ -144,6 +155,8 @@ module Xcodeproj
           false
         end
 
+        #---------------------------------------------------------------------#
+
       end
     end
   end

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

@@ -10,59 +10,71 @@ module Xcodeproj
         # @!group Attributes
 
         # @return [ObjectList<PBXGroup, PBXFileReference>]
-        #   the objects contained by the group.
+        #         the objects contained by the group.
         #
         has_many :children, [PBXGroup, PBXFileReference, PBXReferenceProxy]
 
         # @return [String] the source tree to which this group is relative.
         #
-        #   Usually is group <group>.
+        # @note   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.
+        # @note   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.
+        # @note   If path is specified this attribute is not present.
         #
         attribute :name, String
 
         # @return [String] Whether Xcode should use tabs for text alignment.
         #
-        #   E.g. `1`
+        # @example
+        #   `1`
         #
         attribute :uses_tabs, String
 
         # @return [String] The width of the indent.
         #
-        #   E.g. `2`
+        # @example
+        #   `2`
         #
         attribute :indent_width, String
 
         # @return [String] The width of the tabs.
         #
-        #   E.g. `2`
+        # @example
+        #   `2`
         #
         attribute :tab_width, String
 
         # @return [String] Whether Xcode should wrap lines.
         #
-        #   E.g. `1`
+        # @example
+        #   `1`
         #
         attribute :wraps_lines, String
 
-        #-----------------------------------------------------------------------#
+        # @return [String] Comments associated with this group.
+        #
+        # @note   This is apparently no longer used by Xcode.
+        #
+        attribute :comments, String
+
+        #---------------------------------------------------------------------#
+
+        public
 
         # @!group Helpers
 
         # @return [String] the name of the group taking into account the path
-        #   or other factors if needed.
+        #         or other factors if needed.
         #
         def display_name
           if name
@@ -75,21 +87,20 @@ module Xcodeproj
         end
 
         # @return [Array<PBXFileReference>] the files references in the group
-        #   children.
+        #         children.
         #
         def files
           children.select { |obj| obj.class == PBXFileReference }
         end
 
-        # @return [Array<PBXGroup>] the groups in the group
-        #   children.
+        # @return [Array<PBXGroup>] the groups in the group children.
         #
         def groups
           children.select { |obj| obj.class == PBXGroup }
         end
 
         # @return [Array<XCVersionGroup>] the version groups in the group
-        #   children.
+        #         children.
         #
         def version_groups
           children.select { |obj| obj.class == XCVersionGroup }
@@ -98,13 +109,15 @@ module Xcodeproj
         # 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 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  [#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 `/`.
+        # @param  [String] sub_group_path
+        #         an optional subgroup path indicating the groups separated by
+        #         a `/`.
         #
         # @return [PBXFileReference] the new file reference.
         #
@@ -122,12 +135,12 @@ module Xcodeproj
         # Creates a new group with the given name and adds it to the children
         # of the group.
         #
-        # @note (see #new_file)
+        # @note   @see new_file
         #
-        # @param [#to_s] name
-        #   the name of the new group.
+        # @param  [#to_s] name
+        #         the name of the new group.
         #
-        # @param [String] sub_group_path (see #new_file)
+        # @param  [String] sub_group_path @see new_file
         #
         # @return [PBXGroup] the new group.
         #
@@ -143,12 +156,13 @@ module Xcodeproj
         # Creates a file reference to a static library and adds it to the
         # children of the group.
         #
-        # @note (see #new_file)
+        # @note @see new_file
         #
-        # @param [#to_s] product_name
-        #   the name of the new static library.
+        # @param  [#to_s] product_name
+        #         the name of the new static library.
+        #
+        # @param  [String] sub_group_path @see new_file
         #
-        # @param [String] sub_group_path (see #new_file)#
         # @return [PBXFileReference] the new group.
         #
         def new_static_library(product_name, sub_group_path = nil)
@@ -174,14 +188,12 @@ module Xcodeproj
         end
 
         # Traverses the children groups and finds the group with the given
-        # path, optionally, creating any needed group.
-        #
-        # @param path (see #find_subpath)
+        # path, if exists.
         #
-        # @note (see #find_subpath)
+        # @see find_subpath
         #
         def [](path)
-          find_subpath(path)
+          find_subpath(path, false)
         end
 
         # Removes children files and groups under this group.
@@ -211,13 +223,21 @@ module Xcodeproj
         #   g.name #=> 'Frameworks'
         #
         # @return [PBXGroup] the group if found.
+        # @return [Nil] if the path could not be found and should create is
+        #         false.
         #
         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 child.nil?
+            if should_create
+              child = new_group(child_name)
+            else
+              return nil
+            end
+          end
           if path.empty?
             child
           else
@@ -238,7 +258,7 @@ module Xcodeproj
         # @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
+        #         methods not compensated by the corespondent opposite (loss of
         #         UUIDs and objects from the project).
         #
         # @return [void]
@@ -292,6 +312,9 @@ module Xcodeproj
         attribute :version_group_type, String, 'wrapper.xcdatamodel'
 
       end
+
+      #-----------------------------------------------------------------------#
+
     end
   end
 end

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

@@ -14,6 +14,12 @@ module Xcodeproj
         #
         attribute :product_name, String
 
+        # @return [String] Comments associated with this target.
+        #
+        #   This is apparently no longer used by Xcode.
+        #
+        attribute :comments, String
+
         # @return [XCConfigurationList] the list of the build configurations of
         #         the target. This list commonly include two configurations
         #         `Debug` and `Release`.
@@ -24,102 +30,9 @@ module Xcodeproj
         #
         has_many :dependencies, PBXTargetDependency
 
-      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
-
-        # @return [String] the build product type identifier.
-        #
-        attribute :product_type, String, 'com.apple.product-type.library.static'
-
-        # @return [PBXFileReference] the reference to the product file.
-        #
-        has_one :product_reference, PBXFileReference
-
-        # @return [String] the install path of the product.
-        #
-        attribute :product_install_path, String
-
-        # @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
-
-      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.
-        #
-        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
-      # present.
-      #
-      class PBXLegacyTarget < AbstractTarget
-
-        # @!group Attributes
-
-        # @return [String] e.g "Dir"
-        #
-        attribute :build_working_directory, String
-
-        # @return [String] e.g "$(ACTION)"
-        #
-        attribute :build_arguments_string, String
-
-        # @return [String] e.g "1"
-        #
-        attribute :pass_build_settings_in_environment, String
-
-        # @return [String] e.g "/usr/bin/make"
-        #
-        attribute :build_tool_path, String
-
-        # @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
-
-      end
-
-      #----------------------------------------------------------------------#
+        #--------------------------------------#
 
-      class AbstractTarget < AbstractObject
+        public
 
         # @!group Helpers
 
@@ -149,8 +62,6 @@ module Xcodeproj
           end
         end
 
-        #--------------------------------------#
-
         # @return [ObjectList<XCBuildConfiguration>] the build
         #         configurations of the target.
         #
@@ -219,12 +130,62 @@ module Xcodeproj
           phase
         end
 
+        #--------------------------------------#
+
+        public
+
+        # @!group AbstractObject Hooks
+
+        # @return [Hash{String => Hash}] A hash suitable to display the object
+        #         to the user.
+        #
+        def pretty_print
+          {
+            display_name => {
+              'Build Phases' => build_phases.map(&:pretty_print),
+              'Build Configurations' => build_configurations.map(&:pretty_print)
+            }
+          }
+        end
+
       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
+
+        # @return [String] the build product type identifier.
+        #
+        attribute :product_type, String, 'com.apple.product-type.library.static'
+
+        # @return [PBXFileReference] the reference to the product file.
+        #
+        has_one :product_reference, PBXFileReference
+
+        # @return [String] the install path of the product.
+        #
+        attribute :product_install_path, String
+
+        # @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
+
+        #--------------------------------------#
+
+        public
+
         # @!group Helpers
 
         # Adds source files to the target.
@@ -248,7 +209,9 @@ module Xcodeproj
             if (header_extensions.include?(extension))
               headers_build_phase.files << build_file
             else
-              build_file.settings = { 'COMPILER_FLAGS' => compiler_flags } if compiler_flags && !compiler_flags.empty?
+              if compiler_flags && !compiler_flags.empty?
+                build_file.settings = { 'COMPILER_FLAGS' => compiler_flags }
+              end
               source_build_phase.files << build_file
             end
           end
@@ -301,12 +264,12 @@ module Xcodeproj
         # @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
+          phase = build_phases.find { |bp| bp.class == PBXFrameworksBuildPhase }
+          unless phase
+            phase= project.new(PBXFrameworksBuildPhase)
+            build_phases << phase
           end
-          bp
+          phase
         end
 
         # Finds or creates the resources build phase of the target.
@@ -316,14 +279,75 @@ module Xcodeproj
         # @return [PBXResourcesBuildPhase] the resources build phase.
         #
         def resources_build_phase
-          bp = build_phases.find { |bp| bp.class == PBXResourcesBuildPhase }
-          unless bp
-            bp = project.new(PBXResourcesBuildPhase)
-            build_phases << bp
+          phase = build_phases.find { |bp| bp.class == PBXResourcesBuildPhase }
+          unless phase
+            phase = project.new(PBXResourcesBuildPhase)
+            build_phases << phase
           end
-          bp
+          phase
         end
+
       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.
+        #
+        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
+      # present.
+      #
+      class PBXLegacyTarget < AbstractTarget
+
+        # @!group Attributes
+
+        # @return [String] e.g "Dir"
+        #
+        attribute :build_working_directory, String
+
+        # @return [String] e.g "$(ACTION)"
+        #
+        attribute :build_arguments_string, String
+
+        # @return [String] e.g "1"
+        #
+        attribute :pass_build_settings_in_environment, String
+
+        # @return [String] e.g "/usr/bin/make"
+        #
+        attribute :build_tool_path, String
+
+        # @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
+
+      end
+
+      #-----------------------------------------------------------------------#
+
     end
   end
 end