xcodeproj 0.4.3 → 0.5.0

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

@@ -19,10 +19,30 @@ module Xcodeproj
         attribute :build_settings, Hash, {}
 
         # @return [PBXFileReference] an optional file reference to a
-        #   configuration file (`.xcconfig`).
+        #         configuration file (`.xcconfig`).
         #
         has_one :base_configuration_reference, PBXFileReference
 
+        #---------------------------------------------------------------------#
+
+        public
+
+        # @!group AbstractObject Hooks
+
+        # @return [Hash{String => Hash}] A hash suitable to display the object
+        #         to the user.
+        #
+        def pretty_print
+          data = {}
+          data['Build Settings'] = build_settings
+          if base_configuration_reference
+            data['Base Configuration'] = base_configuration_reference.pretty_print
+          end
+          { name => data }
+        end
+
+        #---------------------------------------------------------------------#
+
       end
     end
   end

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

@@ -11,19 +11,53 @@ module Xcodeproj
 
         # @return [Hash] the list of build settings for this file.
         #
-        # The contents of this array depend on the phase of the build file.
+        # @note   The contents of this array depend on the phase of the build
+        #         file.
         #
-        # - For PBXHeadersBuildPhase is `{ "ATTRIBUTES" => [:value] }` where
-        #   `:value` can be `Public`, `Private`, or nil (Protected).
+        #         For PBXHeadersBuildPhase is `{ "ATTRIBUTES" => [:value] }`
+        #         where `:value` can be `Public`, `Private`, or nil
+        #         (Protected).
         #
         attribute :settings, Hash, {}
 
         # @return [PBXFileReference] the file that to build.
         #
-        # @todo   I think that is possible to add any kind of groups (for example
-        #         folders linked to a path).
+        # @todo   I think that is possible to add any kind of group (for
+        #         example folders linked to a path).
         #
-        has_one :file_ref, [PBXFileReference, PBXGroup, PBXVariantGroup, XCVersionGroup, PBXReferenceProxy]
+        has_one :file_ref, [
+          PBXFileReference,
+          PBXGroup,
+          PBXVariantGroup,
+          XCVersionGroup,
+          PBXReferenceProxy
+        ]
+
+        #---------------------------------------------------------------------#
+
+        public
+
+        # @!group AbstractObject Hooks
+
+        # @return [String] A name suitable for displaying the object to the
+        #         user.
+        #
+        def display_name
+          file_ref.display_name
+        end
+
+        # @return [Hash{String => Hash}, String] A hash suitable to display the
+        #         object to the user.
+        #
+        def pretty_print
+          if settings.nil? || settings.empty?
+            display_name
+          else
+            { display_name => settings }
+          end
+        end
+
+        #---------------------------------------------------------------------#
 
       end
     end

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

@@ -11,30 +11,105 @@ module Xcodeproj
         # @!group Attributes
 
         # @return [ObjectList<PBXBuildFile>] the files processed by this build
-        #   configuration.
+        #         configuration.
         #
         has_many :files, PBXBuildFile
 
         # @return [String] some kind of magic number which usually is
-        #   '2147483647' (can be also `8` and `12` in PBXCopyFilesBuildPhase,
-        #   one of the masks is run_only_for_deployment_postprocessing).
+        #         '2147483647' (can be also `8` and `12` in
+        #         PBXCopyFilesBuildPhase, one of the masks is
+        #         run_only_for_deployment_postprocessing).
         #
         attribute :build_action_mask, String, '2147483647'
 
         # @return [String] whether or not this should only be processed before
-        #   deployment. Can be either '0', or '1'.
+        #         deployment. Can be either '0', or '1'.
         #
-        # This option is exposed in Xcode in the UI of PBXCopyFilesBuildPhase as
-        # `Copy only when installing` or in PBXShellScriptBuildPhase as `Run
-        # script only when installing`.
+        # @note   This option is exposed in Xcode in the UI of
+        #         PBXCopyFilesBuildPhase as `Copy only when installing` or in
+        #         PBXShellScriptBuildPhase as `Run script only when
+        #         installing`.
         #
         attribute :run_only_for_deployment_postprocessing, String, '0'
 
+        # @return [String] Comments associated with this build phase.
+        #
+        # @note   This is apparently no longer used by Xcode.
+        #
+        attribute :comments, String
+
+        #--------------------------------------#
+
+        public
+
+        # @!group Helpers
+
+        # @return [Array<PBXFileReference>] the list of all the files
+        #         referenced by this build phase.
+        #
+        def files_references
+          files.map { |bf| bf.file_ref }.uniq
+        end
+
+        # Adds a new build file, initialized with the given file reference, to
+        # the phase.
+        #
+        # @param  [PBXFileReference] file
+        #         the file reference that should be added to the build phase.
+        #
+        # @return [PBXBuildFile] the build file generated.
+        #
+        def add_file_reference(file)
+          build_file = project.new(PBXBuildFile)
+          build_file.file_ref = file
+          files << build_file
+          build_file
+        end
+
+        # Removes the build file associated with the given file reference from
+        # the phase.
+        #
+        # @param  [PBXFileReference] file the file to remove
+        #
+        # @return [void]
+        #
+        def remove_file_reference(file)
+          build_file = files.find { |bf| bf.file_ref == file }
+          if build_file
+            build_file.file_ref = nil
+            build_file.remove_from_project
+          end
+        end
+
+        # Removes a build file from the phase and clears its relationship to
+        # the file reference.
+        #
+        # @param  [PBXBuildFile] build_file the file to remove
+        #
+        # @return [void]
+        #
+        def remove_build_file(build_file)
+          build_file.file_ref = nil
+          build_file.remove_from_project
+        end
+
+        # Removes all the build files from the phase and clears their
+        # relationship to the file reference.
+        #
+        # @return [void]
+        #
+        def clear_build_files
+          files.objects.each do |bf|
+            remove_build_file(bf)
+          end
+        end
+
       end
 
       #-----------------------------------------------------------------------#
 
-      # The phase responsible of copying headers (aka `Copy Headers`).
+      # The phase responsible of copying headers. Known as `Copy Headers` in
+      # the UI.
       #
       # @note This phase can appear only once in a target.
       #
@@ -44,7 +119,8 @@ module Xcodeproj
 
       #-----------------------------------------------------------------------#
 
-      # The phase responsible of compiling the files (aka `Compile Sources`).
+      # The phase responsible of compiling the files. Known as `Compile
+      # Sources` in the UI.
       #
       # @note This phase can appear only once in a target.
       #
@@ -54,8 +130,8 @@ module Xcodeproj
 
       #-----------------------------------------------------------------------#
 
-      # The phase responsible on linking with frameworks (aka `Link Binary With
-      # Libraries`).
+      # The phase responsible on linking with frameworks. Known as `Link Binary
+      # With Libraries` in the UI.
       #
       # @note This phase can appear only once in a target.
       #
@@ -66,8 +142,8 @@ module Xcodeproj
       #-----------------------------------------------------------------------#
 
       # 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.
+      # for resources. Known as `Copy Bundle Resources` in the UI. It is
+      # unclear if this is the only one capable of optimizing PNG.
       #
       # @note This phase can appear only once in a target.
       #
@@ -91,14 +167,14 @@ module Xcodeproj
         attribute :name, String
 
         # @return [String] the subpath of `dst_subfolder_spec` where this file
-        #   should be copied to.
+        #         should be copied to.
         #
-        #   Can accept environment variables like `$(PRODUCT_NAME)`.
+        # @note   Can accept environment variables like `$(PRODUCT_NAME)`.
         #
         attribute :dst_path, String, ''
 
         # @return [String] the path (destination) where the files should be
-        #   copied to.
+        #         copied to.
         #
         attribute :dst_subfolder_spec, String, Constants::COPY_FILES_BUILD_PHASE_DESTINATIONS[:resources]
 
@@ -134,20 +210,20 @@ module Xcodeproj
 
         # @return [String] the path to the script interpreter.
         #
-        # Defaults to `/bin/sh`.
+        # @note   Defaults to `/bin/sh`.
         #
         attribute :shell_path, String, '/bin/sh'
 
         # @return [String] the actual script to perform.
         #
-        # Defaults to the empty string.
+        # @note   Defaults to the empty string.
         #
         attribute :shell_script, String, ''
 
         # @return [String] whether or not the ENV variables should be shown in
-        #   the build log.
+        #         the build log.
         #
-        # Defaults to true (`1`).
+        # @note   Defaults to true (`1`).
         #
         attribute :show_env_vars_in_log, String, '1'
       end
@@ -164,70 +240,6 @@ module Xcodeproj
 
       #-----------------------------------------------------------------------#
 
-      class AbstractBuildPhase < AbstractObject
-
-        # @!group Helpers
-
-        # @return [Array<PBXFileReference>] the list of all the files
-        #   referenced by this build phase.
-        #
-        def files_references
-          files.map { |bf| bf.file_ref }.uniq
-        end
-
-        # Adds a new build file, initialized with the given file reference, to
-        # the phase.
-        #
-        # @param [PBXFileReference] file
-        #   the file reference that should be added to the build phase.
-        #
-        # @return [PBXBuildFile] the build file generated.
-        #
-        def add_file_reference(file)
-          build_file = project.new(PBXBuildFile)
-          build_file.file_ref = file
-          files << build_file
-          build_file
-        end
-
-        # Removes the build file associated with the given file reference from
-        # the phase.
-        #
-        # @param [PBXFileReference] file the file to remove
-        #
-        # @return [void]
-        #
-        def remove_file_reference(file)
-          build_file = files.find { |bf| bf.file_ref == file }
-          if build_file
-            build_file.file_ref = nil
-            build_file.remove_from_project
-          end
-        end
-
-        # Removes a build file from the phase and clears its relationship to
-        # the file reference.
-        #
-        # @param [PBXBuildFile] build_file the file to remove
-        #
-        # @return [void]
-        #
-        def remove_build_file(build_file)
-          build_file.file_ref = nil
-          build_file.remove_from_project
-        end
-
-        # Removes all the build files from the phase and clears their
-        # relationship to the file reference.
-        #
-        # @return [void]
-        #
-        def clear_build_files
-          files.objects.each do |bf|
-            remove_build_file(bf)
-          end
-        end
-      end
     end
   end
 end

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

@@ -14,38 +14,44 @@ module Xcodeproj
 
         # @return [String] a string representing what compiler to use.
         #
-        #   E.g. `com.apple.compilers.proxy.script`.
+        # @example
+        #   `com.apple.compilers.proxy.script`.
         #
         attribute :compiler_spec, String
 
         # @return [String] the type of the files that should be processed by
-        #   this rule.
+        #         this rule.
         #
-        #   E.g. `pattern.proxy`.
+        # @example
+        #   `pattern.proxy`.
         #
         attribute :file_type, String
 
         # @return [String] the pattern of the files that should be processed by
-        #   this rule. This attribute is an alternative to to `file_type`.
+        #         this rule. This attribute is an alternative to to
+        #         `file_type`.
         #
-        #   E.g. `*.css`.
+        # @example
+        #   `*.css`.
         #
         attribute :file_patterns, String
 
         # @return [String] whether the rule is editable.
         #
-        #   E.g. `1`.
+        # @example
+        #   `1`.
         #
         attribute :is_editable, String, '1'
 
         # @return [ObjectList<PBXFileReference>] the file references for the
-        #   output files.
+        #         output files.
         #
         attribute :output_files, Array
 
         # @return [String] the content of the script to use for the build rule.
         #
-        #   Present if the #{#compiler_spec} is `com.apple.compilers.proxy.script`
+        # @note   This attribute is present if the #{#compiler_spec} is
+        #         `com.apple.compilers.proxy.script`
         #
         attribute :script, String
 

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

@@ -28,6 +28,8 @@ module Xcodeproj
 
         #---------------------------------------------------------------------#
 
+        public
+
         # @!group Helpers
 
         # Returns the build settings of the build configuration with
@@ -39,10 +41,12 @@ module Xcodeproj
         # @return [Hash {String=>String}] the build settings
         #
         def build_settings(build_configuration_name)
-          if config = build_configurations.find { |bc| bc.name == build_configuration_name }
-            config.build_settings
-          end
+          config = build_configurations.find { |bc| bc.name == build_configuration_name }
+          config.build_settings if config
         end
+
+        #---------------------------------------------------------------------#
+
       end
     end
   end

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

@@ -5,16 +5,16 @@ module Xcodeproj
       # Apparently a proxy for another object which might belong another
       # project contained in the same workspace of the project document.
       #
-      # This class is referenced by {PBXTargetDependency}; for information
-      # about it usage see the specs of that class.
+      # This class is referenced by {PBXTargetDependency} for information about
+      # it usage see the specs of that class.
       #
-      # @note This class references the other objects by UUID instead of
-      #       creating proper relationships because the other objects might be
-      #       part of another project. This implies that the references to
-      #       other objects should not increase the retain count of the
-      #       targets.
+      # @note  This class references the other objects by UUID instead of
+      #        creating proper relationships because the other objects might be
+      #        part of another project. This implies that the references to
+      #        other objects should not increase the retain count of the
+      #        targets.
       #
-      # @todo: this class needs some work to support targets across workspaces,
+      # @todo: This class needs some work to support targets across workspaces,
       #        as the container portal might not be initialized leading
       #        xcodeproj to raise because ti can't find the UUID.
       #
@@ -23,44 +23,46 @@ module Xcodeproj
         # @!group Attributes
 
         # @return [String] apparently the UUID of the root object
-        #   {PBXProject} of the project containing the represented object.
+        #         {PBXProject} of the project containing the represented
+        #         object.
         #
-        # @todo this is an attribute because a it is usually a reference to the
-        #       root object or to a file reference to another project. The
-        #       reference to the root object causes a retain cycle that could
-        #       cause issues (e.g. in to_tree_hash). Usually those objects are
-        #       retained by at least another object (the {Project} for the root
-        #       object and a {PBXGroup} for the reference to another project)
-        #       and so the referenced object should be serialized.
+        # @todo   this is an attribute because a it is usually a reference to
+        #         the root object or to a file reference to another project.
+        #         The reference to the root object causes a retain cycle that
+        #         could cause issues (e.g. in to_tree_hash). Usually those
+        #         objects are retained by at least another object (the
+        #         {Project} for the root object and a {PBXGroup} for the
+        #         reference to another project) and so the referenced object
+        #         should be serialized.
         #
-        #       If this assumption is incorrect, there could be loss of
-        #       information opening and saving an existing project.
+        #         If this assumption is incorrect, there could be loss of
+        #         information opening and saving an existing project.
         #
         attribute :container_portal, String
 
         # @return [String] the type of the proxy.
         #
-        # - {PBXNativeTarget} is `1`.
+        # @note   {PBXNativeTarget} is `1`.
         #
         attribute :proxy_type, String
 
         # @return [String] apparently the UUID of the represented
-        #   object.
+        #         object.
         #
-        # @note If the object is in another project the UUID would not be
-        #       present in the {Project#objects_by_uuid} hash. For this reason
-        #       this is not an `has_one` attribute. It is assumes that if the
-        #       object belongs to the project at least another object should be
-        #       retaining it. This assumption is reasonable because this is a
-        #       proxy class.
+        # @note   If the object is in another project the UUID would not be
+        #         present in the {Project#objects_by_uuid} hash. For this
+        #         reason this is not an `has_one` attribute. It is assumes that
+        #         if the object belongs to the project at least another object
+        #         should be retaining it. This assumption is reasonable because
+        #         this is a proxy class.
         #
-        #       If this assumption is incorrect, there could be loss of
-        #       information opening and saving an existing project.
+        #         If this assumption is incorrect, there could be loss of
+        #         information opening and saving an existing project.
         #
         attribute :remote_global_id_string, String
 
         # @return [String] apparently the name of the object represented by
-        #   the proxy.
+        #         the proxy.
         #
         attribute :remote_info, String