xcodeproj 0.4.3 → 0.5.0

data/lib/xcodeproj/helper.rb

@@ -16,6 +16,7 @@ module Xcodeproj
       # @return [Array<PBXBuildFile>] A list of source files (that will be
       #   compiled) which are in ‘target 2’ but not in ‘target 1’. The list is
       #   sorted by file path.
+      #
       def new_source_build_files
         @target2.source_build_phase.files.reject do |target2_build_file|
           @target1.source_build_phase.files.any? do |target1_build_file|

data/lib/xcodeproj/project.rb

@@ -1,9 +1,7 @@
 require 'fileutils'
 require 'pathname'
 require 'xcodeproj/xcodeproj_ext'
-
 require 'xcodeproj/project/object'
-require 'xcodeproj/project/recursive_diff'
 
 module Xcodeproj
 
@@ -55,7 +53,7 @@ module Xcodeproj
     attr_reader :object_version
 
     # @return [Hash{String => AbstractObject}] A hash containing all the
-    #   objects of the project by UUID.
+    #         objects of the project by UUID.
     #
     attr_reader :objects_by_uuid
 
@@ -66,15 +64,16 @@ module Xcodeproj
     # Creates a new Project instance or initializes one with the data of an
     # existing Xcode document.
     #
-    # @param [Pathname, String] xcodeproj
-    #   The path to the Xcode project document (xcodeproj).
+    # @param  [Pathname, String] xcodeproj
+    #         The path to the Xcode project document (xcodeproj).
     #
-    # @raise If the project versions are more recent than the ones know to
-    #   Xcodeproj to prevent it from corrupting existing projects.  Naturally,
-    #   this would never happen with a project generated by xcodeproj itself.
+    # @raise  If the project versions are more recent than the ones know to
+    #         Xcodeproj to prevent it from corrupting existing projects.
+    #         Naturally, this would never happen with a project generated by
+    #         xcodeproj itself.
     #
-    # @raise If it can't find the root object. This means that the project is
-    #   malformed.
+    # @raise  If it can't find the root object. This means that the project is
+    #         malformed.
     #
     # @example Opening a project
     #   Project.new("path/to/Project.xcodeproj")
@@ -95,7 +94,7 @@ module Xcodeproj
         root_object_uuid = plist['rootObject']
         @root_object = new_from_plist(root_object_uuid, plist['objects'], self)
 
-      if (@archive_version.to_i > Constants::LAST_KNOWN_ARCHIVE_VERSION || @object_version.to_i > Constants::LAST_KNOWN_OBJECT_VERSION)
+        if (@archive_version.to_i > Constants::LAST_KNOWN_ARCHIVE_VERSION || @object_version.to_i > Constants::LAST_KNOWN_OBJECT_VERSION)
           raise '[Xcodeproj] Unknown archive or object version.'
         end
 
@@ -131,7 +130,7 @@ module Xcodeproj
 
     # Compares the project to another one, or to a plist representation.
     #
-    # @param [#to_hash] other the object to compare.
+    # @param  [#to_hash] other the object to compare.
     #
     # @return [Boolean] whether the project is equivalent to the given object.
     #
@@ -145,7 +144,9 @@ module Xcodeproj
 
     alias :inspect :to_s
 
+    #-------------------------------------------------------------------------#
 
+    public
 
     # @!group Plist serialization
 
@@ -154,26 +155,26 @@ module Xcodeproj
     # The method sets up any relationship of the new object, generating the
     # destination object(s) if not already present in the project.
     #
-    # @note This method is used to generate the root object
-    #       from a plist. Subsequent invocation are called by the
-    #       {AbstractObject#configure_with_plist}. Clients of {Xcodeproj} are
-    #       not expected to call this method.
-    #
-    # @visibility private.
+    # @note   This method is used to generate the root object
+    #         from a plist. Subsequent invocation are called by the
+    #         {AbstractObject#configure_with_plist}. Clients of {Xcodeproj} are
+    #         not expected to call this method.
     #
-    # @param [String] uuid
-    #   the UUID of the object that needs to be generated.
+    # @param  [String] uuid
+    #         The UUID of the object that needs to be generated.
     #
-    # @param [Hash {String => Hash}] objects_by_uuid_plist
-    #   the `objects` hash of the plist representation of the project.
+    # @param  [Hash {String => Hash}] objects_by_uuid_plist
+    #         The `objects` hash of the plist representation of the project.
     #
-    # @param [Boolean] root_object
-    #   whether the requested object is the root object and needs to be
-    #   retained by the project before configuration to add it to the `objects`
-    #   hash and avoid infinite loops.
+    # @param  [Boolean] root_object
+    #         Whether the requested object is the root object and needs to be
+    #         retained by the project before configuration to add it to the
+    #         `objects` hash and avoid infinite loops.
     #
     # @return [AbstractObject] the new object.
     #
+    # @visibility private.
+    #
     def new_from_plist(uuid, objects_by_uuid_plist, root_object = false)
       attributes = objects_by_uuid_plist[uuid]
       if attributes
@@ -202,16 +203,16 @@ module Xcodeproj
     alias :to_plist :to_hash
 
     # Converts the objects tree to a hash substituting the hash
-    # of the referenced to their uuid reference. As a consequene the hash of an
-    # object might appear multiple times and the information about their
+    # of the referenced to their UUID reference. As a consequence the hash of
+    # an object might appear multiple times and the information about their
     # uniqueness is lost.
     #
-    # This method is designed to work in conjuction with {Hash#recursive_diff}
-    # to provie a complete, yet redable, diff of two projects *not* affected by
-    # isa differences.
+    # This method is designed to work in conjunction with {Hash#recursive_diff}
+    # to provide a complete, yet readable, diff of two projects *not* affected
+    # by differences in UUIDs.
     #
-    # @return [Hash] a hash reppresentation of the project different from the
-    #   plist one.
+    # @return [Hash] a hash representation of the project different from the
+    #         plist one.
     #
     def to_tree_hash
       hash = {}
@@ -224,16 +225,28 @@ module Xcodeproj
       hash
     end
 
+    # @return [Hash{String => Hash}] A hash suitable to display the project
+    #         to the user.
+    #
+    def pretty_print
+      build_configurations = root_object.build_configuration_list.build_configurations
+      {
+        'File References' => root_object.main_group.pretty_print.values.first,
+        'Targets' => root_object.targets.map(&:pretty_print),
+        'Build Configurations' => build_configurations.map(&:pretty_print)
+      }
+    end
+
     # Serializes the internal data as a property list and stores it on disk at
     # the given path (`xcodeproj` file).
     #
     # @example Saving a project
     #   project.save_as("path/to/Project.xcodeproj") #=> true
     #
-    # @param [String, Pathname] projpath  The path where the data should be
-    #                                     stored.
+    # @param  [String, Pathname] projpath
+    #         The path where the data should be stored.
     #
-    # @return [Boolean]                   Whether or not saving was successful.
+    # @return [Boolean] Whether or not saving was successful.
     #
     def save_as(projpath)
       projpath = projpath.to_s
@@ -241,7 +254,9 @@ module Xcodeproj
       Xcodeproj.write_plist(to_plist, File.join(projpath, 'project.pbxproj'))
     end
 
+    #-------------------------------------------------------------------------#
 
+    public
 
     # @!group Creating objects
 
@@ -251,8 +266,8 @@ module Xcodeproj
     # attributes, for this reason it is better to use the convenience methods
     # offered by the {AbstractObject} subclasses or by this class.
     #
-    # @param [Class] klass     The concrete subclass of AbstractObject for new
-    #                          object.
+    # @param  [Class] klass
+    #         The concrete subclass of AbstractObject for new object.
     #
     # @return [AbstractObject] the new object.
     #
@@ -264,13 +279,13 @@ module Xcodeproj
 
     # Generates a UUID unique for the project.
     #
-    # @note UUIDs are not guaranteed to be generated unique because we need to
-    #       trim the ones generated in the xcodeproj extension.
+    # @note   UUIDs are not guaranteed to be generated unique because we need
+    #         to trim the ones generated in the xcodeproj extension.
     #
-    # @note Implementation detail: as objects usually are created serially this
-    #       method creates a batch of UUID and stores the not colliding ones,
-    #       so the search for collisions with known UUIDS (a performance
-    #       bottleneck) is performed is performed less often.
+    # @note   Implementation detail: as objects usually are created serially
+    #         this method creates a batch of UUID and stores the not colliding
+    #         ones, so the search for collisions with known UUIDS (a
+    #         performance bottleneck) is performed is performed less often.
     #
     # @return [String] A UUID unique to the project.
     #
@@ -283,9 +298,9 @@ module Xcodeproj
 
     # @return [Array<String>] the list of all the generated UUIDs.
     #
-    #   Used for checking new UUIDs for duplicates with UUIDs already generated
-    #   but used for objects which are not yet part of the `objects` hash but
-    #   which might be added at a later time.
+    # @note   Used for checking new UUIDs for duplicates with UUIDs already
+    #         generated but used for objects which are not yet part of the
+    #         `objects` hash but which might be added at a later time.
     #
     attr_reader :generated_uuids
 
@@ -293,12 +308,12 @@ module Xcodeproj
     # performance when the rough number of objects that will be created is
     # known in advance.
     #
-    # @param [Integer] count
-    #   the number of UUIDs that should be generated.
+    # @param  [Integer] count
+    #         the number of UUIDs that should be generated.
     #
-    # @note This method might generated a minor number of uniques UUIDs than
-    #       the given count, because some might be duplicated a thus will be
-    #       discarded.
+    # @note   This method might generated a minor number of uniques UUIDs than
+    #         the given count, because some might be duplicated a thus will be
+    #         discarded.
     #
     # @return [void]
     #
@@ -311,6 +326,8 @@ module Xcodeproj
 
     #-------------------------------------------------------------------------#
 
+    public
+
     # @!group Convenience accessors
 
     # @return [Array<AbstractObject>] all the objects of the project.
@@ -326,7 +343,7 @@ module Xcodeproj
     end
 
     # @return [Array<AbstractObject>] all the objects of the project with a
-    #   given isa.
+    #         given ISA.
     #
     def list_by_class(klass)
       objects.select { |o| o.class == klass }
@@ -339,7 +356,7 @@ module Xcodeproj
     end
 
     # @return [ObjectList<PBXGroup>] a list of all the groups in the
-    #   project.
+    #         project.
     #
     def groups
       main_group.groups
@@ -352,7 +369,7 @@ module Xcodeproj
     #   frameworks.name #=> 'Frameworks'
     #   main_group.children.include? frameworks #=> True
     #
-    # @param [String] group_path @see MobileCoreServices
+    # @param  [String] group_path @see MobileCoreServices
     #
     # @return [PBXGroup] the group at the given subpath.
     #
@@ -361,14 +378,14 @@ module Xcodeproj
     end
 
     # @return [ObjectList<PBXFileReference>] a list of all the files in the
-    #   project.
+    #         project.
     #
     def files
       objects.select { |obj| obj.class == PBXFileReference }
     end
 
     # @return [ObjectList<PBXNativeTarget>] A list of all the targets in the
-    #   project.
+    #         project.
     #
     def targets
       root_object.targets
@@ -381,7 +398,7 @@ module Xcodeproj
     end
 
     # @return [ObjectList<PBXFileReference>] A list of the product file
-    #   references.
+    #         references.
     #
     def products
       products_group.children
@@ -394,28 +411,33 @@ module Xcodeproj
     end
 
     # @return [ObjectList<XCBuildConfiguration>] A list of project wide
-    #   build configurations.
+    #         build configurations.
     #
     def build_configurations
       root_object.build_configuration_list.build_configurations
     end
 
-    # @param [String] name  The name of a project wide build configuration.
+    # Returns the build settings of the project wide build configuration with
+    # the given name.
+    #
+    # @param  [String] name
+    #         The name of a project wide build configuration.
     #
-    # @return [Hash]        The build settings of the project wide build
-    #                       configuration with the given name.
+    # @return [Hash] The build settings.
     #
     def build_settings(name)
       root_object.build_configuration_list.build_settings(name)
     end
 
+    #-------------------------------------------------------------------------#
 
+    public
 
     # @!group Helpers for generating objects
 
     # Creates a new file reference at the given subpath of the main group.
     #
-    # @param (see PBXGroup#new_file)
+    # @param  @see PBXGroup#new_file
     #
     # @return [PBXFileReference] the new file.
     #
@@ -425,7 +447,7 @@ module Xcodeproj
 
     # Creates a new group at the given subpath of the main group.
     #
-    # @param (see PBXGroup#new_group)
+    # @param  @see PBXGroup#new_group
     #
     # @return [PBXGroup] the new group.
     #
@@ -440,11 +462,11 @@ module Xcodeproj
     #
     # @example Adding QuartzCore
     #
-    #     framework = project.add_system_framework('QuartzCore', :ios)
+    #         framework = project.add_system_framework('QuartzCore', :ios)
     #
-    #     target = project.targets.first
-    #     build_phase = target.frameworks_build_phases.first
-    #     build_phase.files << framework.buildFiles.new
+    #         target = project.targets.first
+    #         build_phase = target.frameworks_build_phases.first
+    #         build_phase.files << framework.buildFiles.new
     #
     # @param  [String] name
     #         The name of a framework.
@@ -599,5 +621,7 @@ module Xcodeproj
       settings
     end
 
+    #-------------------------------------------------------------------------#
+
   end
 end

data/lib/xcodeproj/project/object.rb

@@ -113,10 +113,16 @@ module Xcodeproj
         # @return [String] a name for the object.
         #
         def display_name
-          result = name if respond_to?(:name)
-          result || isa.gsub(/^(PBX|XC)/, '')
+          declared_name = name if self.respond_to?(:name)
+          if declared_name && !declared_name.empty?
+            declared_name
+          else
+            isa.gsub(/^(PBX|XC)/, '')
+          end
         end
 
+        alias :to_s :display_name
+
         # @!group Reference counting
 
         # @return [Array<ObjectList>] The list of the objects that have a
@@ -179,6 +185,8 @@ module Xcodeproj
 
         #---------------------------------------------------------------------#
 
+        public
+
         # @!group Plist related methods
 
         # Configures the object with the objects hash from a plist.
@@ -265,13 +273,13 @@ module Xcodeproj
         #
         def object_with_uuid(uuid, objects_by_uuid_plist, attribute)
           unless object = project.objects_by_uuid[uuid] || project.new_from_plist(uuid, objects_by_uuid_plist)
-            STDERR.puts "`#{inspect}` attempted to initialize an object with "\
+            UI.warn "`#{inspect}` attempted to initialize an object with " \
               "an unknown UUID. `#{uuid}` for attribute: `#{attribute.name}`."\
-              " This can be the result of a merge and the unkonw UUID is "    \
+              " This can be the result of a merge and the unknown UUID is "    \
               "being discarded."
           end
           object
-        rescue NameError => exception
+        rescue NameError
           attributes = objects_by_uuid_plist[uuid]
           raise "`#{isa}` attempted to initialize an object with unknown ISA "\
                 "`#{attributes['isa']}` from attributes: `#{attributes}`\n"   \
@@ -325,7 +333,7 @@ module Xcodeproj
         #
         def to_tree_hash
           hash = {}
-          hash['displayName'] = display_name if self.respond_to?(:display_name)
+          hash['displayName'] = display_name
           hash['isa'] = isa
 
           simple_attributes.each do |attrb|
@@ -351,6 +359,22 @@ module Xcodeproj
           hash
         end
 
+        # @return [Hash{String => Hash}] A hash suitable to display the object
+        #         to the user.
+        #
+        def pretty_print
+          if to_many_attributes.count == 1
+            children = to_many_attributes.first.get_value(self)
+            {display_name => children.map(&:pretty_print)}
+          else
+            display_name
+          end
+        end
+
+        #---------------------------------------------------------------------#
+
+        public
+
         # @!group Object methods
 
         def ==(other)
@@ -362,9 +386,8 @@ module Xcodeproj
         end
 
         def inspect
-          s = "#<UUID: `#{uuid}', isa: `#{isa}'>"
-          s << ", name: `#{name}'" if respond_to?(:name) && name
-          s
+          name_part = " name=#{self.name}" if respond_to?(:name)
+          "<#{self.class}#{name_part} UUID=#{uuid}>"
         end
       end
     end