xcodeproj 0.28.2 → 1.0.0

data/lib/xcodeproj/plist/ffi.rb

@@ -0,0 +1,119 @@
+module Xcodeproj
+  module Plist
+    # Provides support for loading and serializing property list files via
+    # Fiddle and CoreFoundation / Xcode.
+    #
+    module FFI
+      autoload :CoreFoundation, 'xcodeproj/plist/ffi/core_foundation'
+      autoload :DevToolsCore,   'xcodeproj/plist/ffi/dev_tools_core'
+
+      class << self
+        # Attempts to load the `fiddle` and Xcode based plist serializer.
+        #
+        # @return [String,Nil] The loading error message, or `nil` if loading
+        #         was successful.
+        #
+        def attempt_to_load!
+          return @attempt_to_load if defined?(@attempt_to_load)
+          @attempt_to_load = begin
+            require 'fiddle'
+            nil
+          rescue LoadError
+            'Xcodeproj relies on a library called `fiddle` to read and write ' \
+            'Xcode project files. Ensure your Ruby installation includes ' \
+            '`fiddle` and try again.'
+          end
+        end
+
+        # Serializes a hash as an XML property list file.
+        #
+        # @param  [#to_hash] hash
+        #         The hash to store.
+        #
+        # @param  [#to_s] path
+        #         The path of the file.
+        #
+        def write_to_path(hash, path)
+          raise ThreadError, 'Can only write plists from the main thread.' unless Thread.current == Thread.main
+
+          if DevToolsCore.load_xcode_frameworks && path.end_with?('pbxproj')
+            ruby_hash_write_xcode(hash, path)
+          else
+            CoreFoundation.RubyHashPropertyListWrite(hash, path)
+            fix_encoding(path)
+          end
+        end
+
+        # @return [Hash] Returns the native objects loaded from a property list
+        #         file.
+        #
+        # @param  [#to_s] path
+        #         The path of the file.
+        #
+        def read_from_path(path)
+          CoreFoundation.RubyHashPropertyListRead(path)
+        end
+
+        private
+
+        # Simple workaround to escape characters which are outside of ASCII
+        # character-encoding. Relies on the fact that there are no XML characters
+        # which would need to be escaped.
+        #
+        # @note   This is necessary because Xcode (4.6 currently) uses the MacRoman
+        #         encoding unless the `// !$*UTF8*$!` magic comment is present. It
+        #         is not possible to serialize a plist using the NeXTSTEP format
+        #         without access to the private classes of Xcode and that comment
+        #         is not compatible with the XML format. For the complete
+        #         discussion see CocoaPods/CocoaPods#926.
+        #
+        #
+        # @note   Sadly this hack is not sufficient for supporting Emoji.
+        #
+        # @param  [String, Pathname] The path of the file which needs to be fixed.
+        #
+        # @return [void]
+        #
+        def fix_encoding(filename)
+          output = ''
+          input = File.open(filename, 'rb', &:read)
+          input.unpack('U*').each do |codepoint|
+            if codepoint > 127 # ASCII is 7-bit, so 0-127 are valid characters
+              output << "&##{codepoint};"
+            else
+              output << codepoint.chr
+            end
+          end
+          File.open(filename, 'wb') { |file| file.write(output) }
+        end
+
+        # Serializes a hash as an ASCII plist, using Xcode.
+        #
+        # @param  [Hash] hash
+        #         The hash to store.
+        #
+        # @param  [String] path
+        #         The path of the file.
+        #
+        def ruby_hash_write_xcode(hash, path)
+          path = File.expand_path(path)
+          success = true
+
+          begin
+            plist = DevToolsCore::CFDictionary.new(CoreFoundation.RubyHashToCFDictionary(hash))
+            data = DevToolsCore::NSData.new(plist.plistDescriptionUTF8Data)
+            success &= data.writeToFileAtomically(path)
+
+            project = DevToolsCore::PBXProject.new(path)
+            success &= project.writeToFileSystemProjectFile
+            project.close
+          rescue Fiddle::DLError
+            success = false
+          end
+
+          CoreFoundation.RubyHashPropertyListWrite(hash, path) unless success
+        end
+      end
+    end
+  end
+end

data/lib/xcodeproj/plist/plist_gem.rb

@@ -0,0 +1,27 @@
+module Xcodeproj
+  module Plist
+    # @visibility private
+    module PlistGem
+      def self.attempt_to_load!
+        return @attempt_to_load if defined?(@attempt_to_load)
+        @attempt_to_load = begin
+          require 'plist/parser'
+          require 'plist/generator'
+          nil
+        rescue LoadError
+          'Xcodeproj relies on a library called `plist` to read and write ' \
+          'Xcode project files. Ensure you have the `plist` gem installed ' \
+          'and try again.'
+        end
+      end
+
+      def self.write_to_path(hash, path)
+        ::Plist::Emit.save_plist(hash, path)
+      end
+
+      def self.read_from_path(path)
+        ::Plist.parse_xml(path)
+      end
+    end
+  end
+end

data/lib/xcodeproj/plist.rb

@@ -0,0 +1,89 @@
+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.
+    #
+    # @param  [#to_s] path
+    #         The path of the file.
+    #
+    def self.read_from_path(path)
+      path = path.to_s
+      unless File.exist?(path)
+        raise Informative, "The plist file at path `#{path}` doesn't exist."
+      end
+      if file_in_conflict?(path)
+        raise Informative, "The file `#{path}` is in a merge conflict."
+      end
+      implementation.read_from_path(path)
+    end
+
+    # Serializes a hash as an XML property list file.
+    #
+    # @param  [#to_hash] hash
+    #         The hash to store.
+    #
+    # @param  [#to_s] path
+    #         The path of the file.
+    #
+    def self.write_to_path(hash, path)
+      if hash.respond_to?(:to_hash)
+        hash = hash.to_hash
+      else
+        raise TypeError, "The given `#{hash.inspect}` must respond " \
+                          "to #to_hash'."
+      end
+
+      unless path.is_a?(String) || path.is_a?(Pathname)
+        raise TypeError, "The given `#{path}` must be a string or 'pathname'."
+      end
+      path = path.to_s
+      raise IOError, 'Empty path.' if path.empty?
+      implementation.write_to_path(hash, path)
+    end
+
+    # The known modules that can serialize plists.
+    #
+    KNOWN_IMPLEMENTATIONS = [:FFI, :PlistGem]
+
+    class << self
+      # @return The module used to implement plist serialization.
+      #
+      attr_accessor :implementation
+      def implementation
+        @implementation ||= autoload_implementation
+      end
+    end
+
+    # Attempts to autoload a known plist implementation.
+    #
+    # @return a successfully loaded plist serialization implementation.
+    #
+    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.
+    #
+    def self.file_in_conflict?(path)
+      File.read(path).match(/^(<|=|>){7}/)
+    end
+  end
+end

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

@@ -47,6 +47,21 @@ module Xcodeproj
           self.build_settings = sorted_build_settings
         end
 
+        # @return [Boolean] Whether this configuration is configured for
+        #         debugging.
+        #
+        def debug?
+          gcc_preprocessor_definitions = build_settings['GCC_PREPROCESSOR_DEFINITIONS']
+          gcc_preprocessor_definitions && gcc_preprocessor_definitions.include?('DEBUG=1')
+        end
+
+        # @return [Symbol] The symbolic type of this configuration, either
+        #         `:debug` or `:release`.
+        #
+        def type
+          debug? ? :debug : :release
+        end
+
         #---------------------------------------------------------------------#
 
         private

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

@@ -46,12 +46,40 @@ module Xcodeproj
         #
         attribute :output_files, Array
 
+        # @return [ObjectList<String>] the compiler flags used when creating the
+        #         respective output files.
+        #
+        attribute :output_files_compiler_flags, Array
+
         # @return [String] the content of the script to use for the build rule.
         #
         # @note   This attribute is present if the #{#compiler_spec} is
         #         `com.apple.compilers.proxy.script`
         #
         attribute :script, String
+
+        # @!group Helpers
+
+        # Adds an output file with the specified compiler flags.
+        #
+        # @param  [PBXFileReference] file the file to add.
+        #
+        # @param  [String] compiler_flags the compiler flags for the file.
+        #
+        # @return [Void]
+        #
+        def add_output_file(file, compiler_flags = '')
+          (self.output_files ||= []) << file
+          (self.output_files_compiler_flags ||= []) << compiler_flags
+        end
+
+        # @return [Array<[PBXFileReference, String]>]
+        #         An array containing tuples of output files and their compiler
+        #         flags.
+        #
+        def output_files_and_flags
+          (output_files || []).zip(output_files_compiler_flags || [])
+        end
       end
     end
   end

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

@@ -264,6 +264,34 @@ module Xcodeproj
           group
         end
 
+        # Creates a new variant group and adds it to the group
+        #
+        # @note   @see new_group
+        #
+        # @param  [#to_s] name
+        #         the name of the new group.
+        #
+        # @param  [#to_s] path
+        #         The, preferably absolute, path of the variant group.
+        #         Pass the path of the folder containing all the .lproj bundles,
+        #         that contain files for the variant group.
+        #         Do not pass the path of a specific bundle (such as en.lproj)
+        #
+        # @param  [Symbol] source_tree
+        #         The source tree key to use to configure the path (@see
+        #         GroupableHelper::SOURCE_TREES_BY_KEY).
+        #
+        # @return [PBXVariantGroup] the new variant group.
+        #
+        def new_variant_group(name, path = nil, source_tree = :group)
+          group = project.new(PBXVariantGroup)
+          children << group
+          group.name = name
+          group.set_source_tree(source_tree)
+          group.set_path(path)
+          group
+        end
+
         # Traverses the children groups and finds the group with the given
         # path, if exists.
         #

data/lib/xcodeproj/project/object/helpers/file_references_factory.rb

@@ -139,7 +139,7 @@ module Xcodeproj
                   new_file_reference(ref, child_path, :group)
                 elsif File.basename(child_path) == '.xccurrentversion'
                   full_path = path + File.basename(child_path)
-                  xccurrentversion = Xcodeproj.read_plist(full_path)
+                  xccurrentversion = Plist.read_from_path(full_path)
                   current_version_name = xccurrentversion['_XCCurrentVersionName']
                 end
               end

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

@@ -108,15 +108,34 @@ module Xcodeproj
           sdk.scan(/[0-9.]+/).first
         end
 
+        # @visibility private
+        #
+        # @return [Hash<Symbol, String>]
+        #         The name of the setting for the deployment target by platform
+        #         name.
+        #
+        DEPLOYMENT_TARGET_SETTING_BY_PLATFORM_NAME = {
+          :ios => 'IPHONEOS_DEPLOYMENT_TARGET',
+          :osx => 'MACOSX_DEPLOYMENT_TARGET',
+          :tvos => 'TVOS_DEPLOYMENT_TARGET',
+          :watchos => 'WATCHOS_DEPLOYMENT_TARGET',
+        }.freeze
+
         # @return [String] the deployment target of the target according to its
         #         platform.
         #
         def deployment_target
-          case platform_name
-          when :ios then common_resolved_build_setting('IPHONEOS_DEPLOYMENT_TARGET')
-          when :osx then common_resolved_build_setting('MACOSX_DEPLOYMENT_TARGET')
-          when :tvos then common_resolved_build_setting('TVOS_DEPLOYMENT_TARGET')
-          when :watchos then common_resolved_build_setting('WATCHOS_DEPLOYMENT_TARGET')
+          return unless setting = DEPLOYMENT_TARGET_SETTING_BY_PLATFORM_NAME[platform_name]
+          common_resolved_build_setting(setting)
+        end
+
+        # @param  [String] deployment_target the deployment target to set for
+        #         the target according to its platform.
+        #
+        def deployment_target=(deployment_target)
+          return unless setting = DEPLOYMENT_TARGET_SETTING_BY_PLATFORM_NAME[platform_name]
+          build_configurations.each do |config|
+            config.build_settings[setting] = deployment_target
           end
         end
 
@@ -515,8 +534,8 @@ module Xcodeproj
           unless phase_class < AbstractBuildPhase
             raise ArgumentError, "#{phase_class} must be a subclass of #{AbstractBuildPhase.class}"
           end
-          @phases[phase_class] ||= build_phases.find { |bp| bp.class == phase_class } \
-            || project.new(phase_class).tap { |bp| build_phases << bp }
+          @phases[phase_class] ||= build_phases.find { |bp| bp.class == phase_class } ||
+            project.new(phase_class).tap { |bp| build_phases << bp }
         end
 
         public

data/lib/xcodeproj/project/object.rb

@@ -59,11 +59,12 @@ module Xcodeproj
         # @visibility private
         #
         def initialize(project, uuid)
-          @project, @uuid = project, uuid
+          @project = project
+          @uuid = uuid
           @isa = self.class.isa
           @referrers = []
-          unless @isa.match(/^(PBX|XC)/)
-            raise '[Xcodeproj] Attempt to initialize an abstract class.'
+          unless @isa =~ /^(PBX|XC)/
+            raise "[Xcodeproj] Attempt to initialize an abstract class (#{self.class})."
           end
         end
 
@@ -98,6 +99,7 @@ module Xcodeproj
         # @return [void]
         #
         def remove_from_project
+          mark_project_as_dirty!
           project.objects_by_uuid.delete(uuid)
 
           referrers.dup.each do |referrer|
@@ -214,6 +216,7 @@ module Xcodeproj
         def remove_referrer(referrer)
           @referrers.delete(referrer)
           if @referrers.count == 0
+            mark_project_as_dirty!
             @project.objects_by_uuid.delete(uuid)
           end
         end
@@ -241,6 +244,16 @@ module Xcodeproj
           end
         end
 
+        # Marks the project that this object belongs to as having been modified.
+        #
+        # @return [void]
+        #
+        # @visibility private
+        #
+        def mark_project_as_dirty!
+          project.mark_dirty!
+        end
+
         #---------------------------------------------------------------------#
 
         public

data/lib/xcodeproj/project/object_attributes.rb

@@ -316,6 +316,14 @@ module Xcodeproj
             define_method("#{attrb.name}=") do |value|
               @simple_attributes_hash ||= {}
               attrb.validate_value(value)
+
+              existing = @simple_attributes_hash[attrb.plist_name]
+              if existing.is_a?(Hash) && value.is_a?(Hash)
+                return value if existing.keys == value.keys && existing == value
+              elsif existing == value
+                return value if existing == value
+              end
+              mark_project_as_dirty!
               @simple_attributes_hash[attrb.plist_name] = value
             end
           end
@@ -352,6 +360,8 @@ module Xcodeproj
               attrb.validate_value(value)
 
               previous_value = send(attrb.name)
+              return value if previous_value == value
+              mark_project_as_dirty!
               previous_value.remove_referrer(self) if previous_value
               instance_variable_set("@#{attrb.name}", value)
               value.add_referrer(self) if value

data/lib/xcodeproj/project/object_dictionary.rb

@@ -187,6 +187,7 @@ module Xcodeproj
       # @return [void]
       #
       def perform_additions_operations(object, key)
+        owner.mark_project_as_dirty!
         object.add_referrer(owner)
         attribute.validate_value_for_key(object, key)
       end
@@ -197,6 +198,7 @@ module Xcodeproj
       # @return [void]
       #
       def perform_deletion_operations(objects)
+        owner.mark_project_as_dirty!
         objects.remove_referrer(owner)
       end
     end

data/lib/xcodeproj/project/object_list.rb

@@ -140,10 +140,10 @@ module Xcodeproj
         super
       end
 
-      # Moves the object at the given given index to the given position.
+      # Moves the given object to the given index.
       #
-      # @param [Fixnum] from
-      #        The current index of the object.
+      # @param [AbstractObject, ObjectDictionary] object
+      #        The object to move.
       #
       # @param [Fixnum] to
       #        The new index for the object.
@@ -151,6 +151,7 @@ module Xcodeproj
       # @return [void]
       #
       def move(object, new_index)
+        return if index(object) == new_index
         if obj = delete(object)
           insert(new_index, obj)
         else
@@ -158,7 +159,7 @@ module Xcodeproj
         end
       end
 
-      # Moves the object at the given given index to the given position.
+      # Moves the object at the given index to the given position.
       #
       # @param [Fixnum] from
       #        The current index of the object.
@@ -169,6 +170,7 @@ module Xcodeproj
       # @return [void]
       #
       def move_from(current_index, new_index)
+        return if current_index == new_index
         if obj = delete_at(current_index)
           insert(new_index, obj)
         else
@@ -176,6 +178,14 @@ module Xcodeproj
         end
       end
 
+      def sort!
+        return super if owner.project.dirty?
+        previous = to_a
+        super
+        owner.mark_project_as_dirty! unless previous == to_a
+        self
+      end
+
       private
 
       # @!group Notification Methods
@@ -190,6 +200,7 @@ module Xcodeproj
       def perform_additions_operations(objects)
         objects = [objects] unless objects.is_a?(Array)
         objects.each do |obj|
+          owner.mark_project_as_dirty!
           obj.add_referrer(owner)
           attribute.validate_value(obj) unless obj.is_a?(ObjectDictionary)
         end
@@ -203,6 +214,7 @@ module Xcodeproj
       def perform_deletion_operations(objects)
         objects = [objects] unless objects.is_a?(Array)
         objects.each do |obj|
+          owner.mark_project_as_dirty!
           obj.remove_referrer(owner) unless obj.is_a?(ObjectDictionary)
         end
       end

data/lib/xcodeproj/project/project_helper.rb

@@ -189,7 +189,7 @@ module Xcodeproj
 
           new_config = project.new(XCBuildConfiguration)
           new_config.name = configuration.name
-          new_config.build_settings = common_build_settings(:release, platform, deployment_target, target_product_type, language)
+          new_config.build_settings = common_build_settings(configuration.type, platform, deployment_target, target_product_type, language)
           cl.build_configurations << new_config
         end
 

data/lib/xcodeproj/project/uuid_generator.rb

@@ -66,6 +66,7 @@ module Xcodeproj
       end
 
       def switch_uuids(objects)
+        @project.mark_dirty!
         objects.each do |object|
           next unless path = @paths_by_object[object]
           uuid = uuid_for_path(path)

data/lib/xcodeproj/project.rb

@@ -4,7 +4,7 @@ require 'securerandom'
 require 'xcodeproj/project/object'
 require 'xcodeproj/project/project_helper'
 require 'xcodeproj/project/uuid_generator'
-require 'xcodeproj/plist_helper'
+require 'xcodeproj/plist'
 
 module Xcodeproj
   # This class represents a Xcode project document.
@@ -55,19 +55,26 @@ module Xcodeproj
     # @example Creating a project
     #         Project.new("path/to/Project.xcodeproj")
     #
+    # @note When initializing the project, Xcodeproj mimics the Xcode behaviour
+    #       including the setup of a debug and release configuration. If you want a
+    #       clean project without any configurations, you should override the
+    #       `initialize_from_scratch` method to not add these configurations and
+    #       manually set the object version.
+    #
     def initialize(path, skip_initialization = false, object_version = Constants::DEFAULT_OBJECT_VERSION)
       @path = Pathname.new(path).expand_path
       @objects_by_uuid = {}
       @generated_uuids = []
       @available_uuids = []
-      unless skip_initialization
-        initialize_from_scratch
-        @object_version = object_version.to_s
-      end
+      @dirty           = true
       unless skip_initialization.is_a?(TrueClass) || skip_initialization.is_a?(FalseClass)
         raise ArgumentError, '[Xcodeproj] Initialization parameter expected to ' \
           "be a boolean #{skip_initialization}"
       end
+      unless skip_initialization
+        initialize_from_scratch
+        @object_version = object_version.to_s
+      end
     end
 
     # Opens the project at the given path.
@@ -190,12 +197,13 @@ module Xcodeproj
     #
     def initialize_from_file
       pbxproj_path = path + 'project.pbxproj'
-      plist = Xcodeproj.read_plist(pbxproj_path.to_s)
+      plist = Plist.read_from_path(pbxproj_path.to_s)
       root_object.remove_referrer(self) if root_object
-      @root_object = new_from_plist(plist['rootObject'], plist['objects'], self)
-      @archive_version =  plist['archiveVersion']
-      @object_version  =  plist['objectVersion']
-      @classes         =  plist['classes']
+      @root_object     = new_from_plist(plist['rootObject'], plist['objects'], self)
+      @archive_version = plist['archiveVersion']
+      @object_version  = plist['objectVersion']
+      @classes         = plist['classes']
+      @dirty           = false
 
       unless root_object
         raise "[Xcodeproj] Unable to find a root object in #{pbxproj_path}."
@@ -318,9 +326,25 @@ module Xcodeproj
     #
     def save(save_path = nil)
       save_path ||= path
+      @dirty = false if save_path == path
       FileUtils.mkdir_p(save_path)
       file = File.join(save_path, 'project.pbxproj')
-      Xcodeproj.write_plist(to_hash, file)
+      Plist.write_to_path(to_hash, file)
+    end
+
+    # Marks the project as dirty, that is, modified from what is on disk.
+    #
+    # @return [void]
+    #
+    def mark_dirty!
+      @dirty = true
+    end
+
+    # @return [Boolean] Whether this project has been modified since read from
+    #         disk or saved.
+    #
+    def dirty?
+      @dirty == true
     end
 
     # Replaces all the UUIDs in the project with deterministic MD5 checksums.
@@ -736,7 +760,7 @@ module Xcodeproj
       end
 
       xcschememanagement_path = schemes_dir + 'xcschememanagement.plist'
-      Xcodeproj.write_plist(xcschememanagement, xcschememanagement_path)
+      Plist.write_to_path(xcschememanagement, xcschememanagement_path)
     end
 
     #-------------------------------------------------------------------------#

data/lib/xcodeproj/scheme/build_action.rb

@@ -76,9 +76,12 @@ module Xcodeproj
         def initialize(target_or_node = nil)
           create_xml_element_with_fallback(target_or_node, 'BuildActionEntry') do
             # Check target type to configure the default entry attributes accordingly
-            is_test_target, is_app_target = [false, false]
+            is_test_target = false
+            is_app_target = false
             if target_or_node && target_or_node.is_a?(::Xcodeproj::Project::Object::PBXNativeTarget)
-              test_types = [Constants::PRODUCT_TYPE_UTI[:octest_bundle], Constants::PRODUCT_TYPE_UTI[:unit_test_bundle]]
+              test_types = [Constants::PRODUCT_TYPE_UTI[:octest_bundle],
+                            Constants::PRODUCT_TYPE_UTI[:unit_test_bundle],
+                            Constants::PRODUCT_TYPE_UTI[:ui_test_bundle]]
               app_types = [Constants::PRODUCT_TYPE_UTI[:application]]
               is_test_target = test_types.include?(target_or_node.product_type)
               is_app_target = app_types.include?(target_or_node.product_type)