xcodeproj 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04c4429d5bd1901ac79b9057825d4506a3d4677a
-  data.tar.gz: 41170f0792b8529c15600b5837f94949f0114cfb
+  metadata.gz: c1d9e25f8e263946cf8049c3fd87d32eb60774e2
+  data.tar.gz: 1aa69336dac41f7c9192ee45b11157bf2d6ab372
 SHA512:
-  metadata.gz: bd83e86802491f25727e5ea74b1ff9d4edab9cb183254cb89482dd92998bc6ef96051d7a2f43be7d51e1e9dd5d635950d3c61f95e8dc253696b9b43112516553
-  data.tar.gz: 549778943ec9f0d3a9cea8277be5fe90b71b16d5c9404c17917a66caa5a49430bceedd652ccb30244189855aecc96ccb83f60aa52a773f639cdb95eafb4ed42a
+  metadata.gz: c7ddb7c072f0d6ccf2af6bbb5dd1c6093007986edd5f91802ea4d304dcf373d0385a161ae74584b99de9ffa06f37364c39435cb96cb6ba6dbae5b1c597452058
+  data.tar.gz: 01eff04f86c6cfe00adea390ef346c0a2650447dd8a324b624ac3d070a54329afa6b2a20cbb217b24d0a318e62db6193eb10aa22f9ebf9c16b85928fcd75dae7

data/lib/xcodeproj/gem_version.rb

@@ -1,5 +1,5 @@
 module Xcodeproj
   # The version of the xcodeproj gem.
   #
-  VERSION = '1.3.3'.freeze unless defined? Xcodeproj::VERSION
+  VERSION = '1.4.0'.freeze unless defined? Xcodeproj::VERSION
 end

data/lib/xcodeproj/plist.rb

@@ -1,10 +1,10 @@
+autoload :Nanaimo, 'nanaimo'
+autoload :CFPropertyList, 'cfpropertylist'
+
 module Xcodeproj
   # Provides support for loading and serializing property list files.
   #
   module Plist
-    autoload :FFI, 'xcodeproj/plist/ffi'
-    autoload :PlistGem, 'xcodeproj/plist/plist_gem'
-
     # @return [Hash] Returns the native objects loaded from a property list
     #         file.
     #
@@ -16,10 +16,16 @@ module Xcodeproj
       unless File.exist?(path)
         raise Informative, "The plist file at path `#{path}` doesn't exist."
       end
-      if file_in_conflict?(path)
+      contents = File.read(path)
+      if file_in_conflict?(contents)
         raise Informative, "The file `#{path}` is in a merge conflict."
       end
-      implementation.read_from_path(path)
+      case Nanaimo::Reader.plist_type(contents)
+      when :xml, :binary
+        CFPropertyList.native_types(CFPropertyList::List.new(:data => contents).value)
+      else
+        Nanaimo::Reader.new(contents).parse!.as_ruby
+      end
     end
 
     # Serializes a hash as an XML property list file.
@@ -43,47 +49,39 @@ module Xcodeproj
       end
       path = path.to_s
       raise IOError, 'Empty path.' if path.empty?
-      implementation.write_to_path(hash, path)
+
+      File.open(path, 'w') do |f|
+        plist = Nanaimo::Plist.new(hash, :xml)
+        Nanaimo::Writer::XMLWriter.new(plist, true, f).write
+      end
     end
 
     # The known modules that can serialize plists.
     #
-    KNOWN_IMPLEMENTATIONS = [:FFI, :PlistGem]
+    KNOWN_IMPLEMENTATIONS = []
 
     class << self
-      # @return The module used to implement plist serialization.
+      # @deprecated This method will be removed in 2.0
+      #
+      # @return [Nil]
       #
       attr_accessor :implementation
-      def implementation
-        @implementation ||= autoload_implementation
-      end
     end
 
-    # Attempts to autoload a known plist implementation.
+    # @deprecated This method will be removed in 2.0
     #
-    # @return a successfully loaded plist serialization implementation.
+    # @return [Nil]
     #
     def self.autoload_implementation
-      failures = KNOWN_IMPLEMENTATIONS.map do |impl|
-        begin
-          impl = Plist.const_get(impl)
-          failure = impl.attempt_to_load!
-          return impl if failure.nil?
-          failure
-        rescue NameError, LoadError => e
-          e.message
-        end
-      end.compact
-      raise Informative, "Unable to load a plist implementation:\n\n#{failures.join("\n\n")}"
     end
 
     # @return [Bool] Checks whether there are merge conflicts in the file.
     #
     # @param  [#to_s] path
-    #         The path of the file.
+    #         The contents of the file.
     #
-    def self.file_in_conflict?(path)
-      File.read(path).match(/^(<|=|>){7}/)
+    def self.file_in_conflict?(contents)
+      contents.match(/^(<|=|>){7}/)
     end
   end
 end

data/lib/xcodeproj/project.rb

@@ -277,6 +277,24 @@ module Xcodeproj
       plist
     end
 
+    def to_ascii_plist
+      plist = {}
+      objects_dictionary = {}
+      objects
+        .sort_by { |o| [o.isa, o.uuid] }
+        .each do |obj|
+          key = Nanaimo::String.new(obj.uuid, obj.ascii_plist_annotation)
+          value = obj.to_ascii_plist.tap { |a| a.annotation = nil }
+          objects_dictionary[key] = value
+        end
+      plist['archiveVersion'] =  archive_version.to_s
+      plist['classes']        =  classes
+      plist['objectVersion']  =  object_version.to_s
+      plist['objects']        =  objects_dictionary
+      plist['rootObject']     =  Nanaimo::String.new(root_object.uuid, root_object.ascii_plist_annotation)
+      Nanaimo::Plist.new.tap { |p| p.root_object = plist }
+    end
+
     # Converts the objects tree to a hash substituting the hash
     # of the referenced to their UUID reference. As a consequence the hash of
     # an object might appear multiple times and the information about their
@@ -332,7 +350,7 @@ module Xcodeproj
       @dirty = false if save_path == path
       FileUtils.mkdir_p(save_path)
       file = File.join(save_path, 'project.pbxproj')
-      Plist.write_to_path(to_hash, file)
+      File.open(file, 'w') { |f| Nanaimo::XcodeProjectWriter.new(to_ascii_plist, true, f).write }
     end
 
     # Marks the project as dirty, that is, modified from what is on disk.

data/lib/xcodeproj/project/object.rb

@@ -373,6 +373,10 @@ module Xcodeproj
         #       array.
         #
         def to_hash
+          to_hash_as
+        end
+
+        def to_hash_as(method = :to_hash)
           plist = {}
           plist['isa'] = isa
 
@@ -383,21 +387,39 @@ module Xcodeproj
 
           to_one_attributes.each do |attrb|
             obj = attrb.get_value(self)
-            plist[attrb.plist_name] = obj.uuid if obj
+            plist[attrb.plist_name] = nested_object_for_hash(obj, method) if obj
           end
 
           to_many_attributes.each do |attrb|
             list = attrb.get_value(self)
-            plist[attrb.plist_name] = list.uuids
+            plist[attrb.plist_name] = list.map { |o| nested_object_for_hash(o, method) }
           end
 
           references_by_keys_attributes.each do |attrb|
             list = attrb.get_value(self)
-            plist[attrb.plist_name] = list.map(&:to_hash)
+            plist[attrb.plist_name] = list.map(&method)
           end
 
           plist
         end
+        private :to_hash_as
+
+        def nested_object_for_hash(object, method)
+          case method
+          when :to_ascii_plist
+            Nanaimo::String.new(object.uuid, object.ascii_plist_annotation)
+          else
+            object.uuid
+          end
+        end
+
+        def ascii_plist_annotation
+          " #{display_name} "
+        end
+
+        def to_ascii_plist
+          Nanaimo::Dictionary.new(to_hash_as(:to_ascii_plist), ascii_plist_annotation)
+        end
 
         # Returns a cascade representation of the object without UUIDs.
         #

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

@@ -38,6 +38,12 @@ module Xcodeproj
           { name => data }
         end
 
+        def to_hash_as(method = :to_hash)
+          super.tap do |hash|
+            normalize_array_settings(hash['buildSettings'])
+          end
+        end
+
         # Sorts the build settings. Valid only in Ruby > 1.9.2 because in
         # previous versions the hash are not sorted.
         #
@@ -74,6 +80,52 @@ module Xcodeproj
           sorted
         end
 
+        # yes, they are case-sensitive.
+        # no, Xcode doesn't do this for other PathList settings nor other
+        # settings ending in SEARCH_PATHS.
+        ARRAY_SETTINGS = %w(
+          ALTERNATE_PERMISSIONS_FILES
+          ARCHS
+          BUILD_VARIANTS
+          EXCLUDED_SOURCE_FILE_NAMES
+          FRAMEWORK_SEARCH_PATHS
+          GCC_PREPROCESSOR_DEFINITIONS
+          GCC_PREPROCESSOR_DEFINITIONS_NOT_USED_IN_PRECOMPS
+          HEADER_SEARCH_PATHS
+          INFOPLIST_PREPROCESSOR_DEFINITIONS
+          LIBRARY_SEARCH_PATHS
+          OTHER_CFLAGS
+          OTHER_CPLUSPLUSFLAGS
+          OTHER_LDFLAGS
+          REZ_SEARCH_PATHS
+          SECTORDER_FLAGS
+          WARNING_CFLAGS
+          WARNING_LDFLAGS
+        ).freeze
+        private_constant :ARRAY_SETTINGS
+
+        def normalize_array_settings(settings)
+          return unless settings
+          settings.keys.each do |key|
+            next unless value = settings[key]
+            case value
+            when String
+              next unless ARRAY_SETTINGS.include?(key)
+              array_value = split_build_setting_array_to_string(value)
+              next unless array_value.size > 1
+              settings[key] = array_value
+            when Array
+              next if value.size > 1 && ARRAY_SETTINGS.include?(key)
+              settings[key] = value.join(' ')
+            end
+          end
+        end
+
+        def split_build_setting_array_to_string(string)
+          regexp = / *((['"]?).*?[^\\]\2)(?=( |\z))/
+          string.scan(regexp).map(&:first)
+        end
+
         #---------------------------------------------------------------------#
       end
     end

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

@@ -59,6 +59,10 @@ module Xcodeproj
           end
         end
 
+        def ascii_plist_annotation
+          " #{display_name} in #{GroupableHelper.parent(self).display_name} "
+        end
+
         #---------------------------------------------------------------------#
       end
     end

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

@@ -127,6 +127,14 @@ module Xcodeproj
           end
         end
         alias_method :clear_build_files, :clear
+
+        def display_name
+          super.gsub(/BuildPhase$/, '')
+        end
+
+        def ascii_plist_annotation
+          " #{display_name} "
+        end
       end
 
       #-----------------------------------------------------------------------#

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

@@ -80,6 +80,10 @@ module Xcodeproj
         def output_files_and_flags
           (output_files || []).zip(output_files_compiler_flags || [])
         end
+
+        def ascii_plist_annotation
+          " #{isa} "
+        end
       end
     end
   end

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

@@ -90,7 +90,16 @@ module Xcodeproj
           end
         end
 
+        def target
+          return project.root_object if project.build_configuration_list.uuid == uuid
+          project.targets.find { |t| t.build_configuration_list.uuid == uuid }
+        end
+
         #---------------------------------------------------------------------#
+
+        def ascii_plist_annotation
+          " Build configuration list for #{target.isa} \"#{target}\" "
+        end
       end
     end
   end

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

@@ -79,13 +79,36 @@ module Xcodeproj
         # @return [AbstractObject]
         #
         def proxied_object
+          container_portal_object.objects_by_uuid[remote_global_id_string]
+        end
+
+        def container_portal_object
           if remote?
             container_portal_file_ref = project.objects_by_uuid[container_portal]
-            container_portal_object = Project.open(container_portal_file_ref.real_path)
+            Project.open(container_portal_file_ref.real_path)
           else
-            container_portal_object = project
+            project
           end
-          container_portal_object.objects_by_uuid[remote_global_id_string]
+        end
+
+        def container_portal_annotation
+          if remote?
+            " #{File.basename(project.objects_by_uuid[container_portal].real_path)} "
+          else
+            project.root_object.ascii_plist_annotation
+          end
+        end
+
+        def to_hash_as(method = :to_hash)
+          hash = super
+          if method == :to_ascii_plist
+            hash['containerPortal'] = Nanaimo::String.new(container_portal, container_portal_annotation)
+          end
+          hash
+        end
+
+        def ascii_plist_annotation
+          " #{isa} "
         end
       end
     end

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

@@ -123,7 +123,13 @@ module Xcodeproj
         #         needed.
         #
         def display_name
-          name || (File.basename(path) if path)
+          if name
+            name
+          elsif (class << GroupableHelper; self; end)::SOURCE_TREES_BY_KEY[:built_products] == source_tree
+            path
+          elsif path
+            File.basename(path)
+          end
         end
 
         # @return [PBXGroup, PBXProject] the parent of the file.

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

@@ -412,6 +412,10 @@ module Xcodeproj
           end
         end
 
+        def ascii_plist_annotation
+          super unless self.equal?(project.main_group)
+        end
+
         # Sorts the to many attributes of the object according to the display
         # name.
         #

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

@@ -48,6 +48,10 @@ module Xcodeproj
         end
 
         #---------------------------------------------------------------------#
+
+        def ascii_plist_annotation
+          " #{name || path && File.basename(path)} "
+        end
       end
     end
   end

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

@@ -67,6 +67,20 @@ module Xcodeproj
         has_many_references_by_keys :project_references,
                                     :project_ref   => PBXFileReference,
                                     :product_group => PBXGroup
+
+        def name
+          project.path.basename('.xcodeproj').to_s
+        end
+
+        def ascii_plist_annotation
+          ' Project object '
+        end
+
+        def to_ascii_plist
+          plist = super
+          plist.value.delete('projectReferences') if plist.value['projectReferences'].empty?
+          plist
+        end
       end
     end
   end

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

@@ -39,6 +39,10 @@ module Xcodeproj
           return target_proxy.remote_info if target_proxy
         end
 
+        def ascii_plist_annotation
+          " #{isa} "
+        end
+
         # @return [String] uuid of the target, if the dependency
         #         is a native target, otherwise the uuid of the
         #         target in the sub-project if the dependency is

data/lib/xcodeproj/project/object_dictionary.rb

@@ -117,12 +117,16 @@ module Xcodeproj
         each do |key, obj|
           if obj
             plist_key = Object::CaseConverter.convert_to_plist(key, nil)
-            result[plist_key] = obj.uuid
+            result[plist_key] = Nanaimo::String.new(obj.uuid, obj.ascii_plist_annotation)
           end
         end
         result
       end
 
+      def to_ascii_plist
+        to_hash
+      end
+
       # @return [Hash<String => String>] Returns a cascade representation of
       #         the object without UUIDs.
       #