xcodeproj 1.19.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72f6eb6645b557dea09ae4be0fd400e48b0d4f1e42c31b7b61af87fd3c31a9cd
-  data.tar.gz: 0c0bcfa7abc28721f61f48e295198da53576e90d62161c50a6cc7333c1e94455
+  metadata.gz: e0788725232bb312e7454dbec2640d078bd514c469deeeff4e57544e837187ac
+  data.tar.gz: fc1af51df95f4fdcaee3040adafdb0afaf5de03e036a32d2769c7af9a2d36fd5
 SHA512:
-  metadata.gz: 4f856d8cbee5b9b7b6bcbe7acce4034e8277fd05ac7caf0d2c317f75d622bb5c518dd2ddee67dac1c6a7fb2773aebb5a5de2cf2232af3fffc2353323fd08623d
-  data.tar.gz: 9cf088a34dea380b56716f005c35fc601d9b193a0a4908556d4f8ccc80408ee328755ccb767dc0ed50adc0bc3e822cc9bcdcdeac405c97fc514f6dd429f746ac
+  metadata.gz: 39a057723656bb7016aa845c427a90c1c6e264f34c3c8eee67b424a7952975371ad56e44569b7e0681154cbd2a4ed2bb82589dc1087a95969d64cfa2c5a5654a
+  data.tar.gz: c9c72a16fe6597d7b6408b49ec6d98083c7e828e444b9e3a17c5155da69e1d3f6869ccfdbaa074eeb13537e81c5e214fb8dc1a975a8633a6c2c718333748fd2b

data/README.md

@@ -1,8 +1,8 @@
 # Xcodeproj
 
-[![Build Status](https://img.shields.io/travis/CocoaPods/Xcodeproj/master.svg?style=flat)](https://travis-ci.org/CocoaPods/Xcodeproj)
-[![Coverage](https://img.shields.io/codeclimate/coverage/github/CocoaPods/Xcodeproj.svg?style=flat)](https://codeclimate.com/github/CocoaPods/Xcodeproj)
-[![Code Climate](https://img.shields.io/codeclimate/maintainability/CocoaPods/Xcodeproj.svg?style=flat&label=code%20climate)](https://codeclimate.com/github/CocoaPods/Xcodeproj)
+[![Build Status](https://img.shields.io/github/workflow/status/CocoaPods/Xcodeproj/Specs)](https://github.com/CocoaPods/Xcodeproj/actions)
+[![Maintainability](https://api.codeclimate.com/v1/badges/40ae104586c859d3581e/maintainability)](https://codeclimate.com/github/CocoaPods/Xcodeproj/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/40ae104586c859d3581e/test_coverage)](https://codeclimate.com/github/CocoaPods/Xcodeproj/test_coverage)
 
 Xcodeproj lets you create and modify Xcode projects from [Ruby][ruby].
 Script boring management tasks or build Xcode-friendly libraries. Also includes
@@ -10,7 +10,7 @@ support for Xcode workspaces (`.xcworkspace`), configuration files (`.xcconfig`)
 Xcode Scheme files (`.xcscheme`).
 
 It is used in [CocoaPods](https://github.com/CocoaPods/CocoaPods) to create a
-a collection of supplemental libraries or frameworks, for all platforms Xcode supports.
+collection of supplemental libraries or frameworks, for all platforms Xcode supports.
 
 The API reference can be found [here](http://www.rubydoc.info/gems/xcodeproj).
 
@@ -64,6 +64,7 @@ project.targets.each do |target|
     config.build_settings['MY_CUSTOM_FLAG'] ||= 'TRUE'
   end
 end
+project.save
 ```
 
 ## Command Line Tool

data/lib/xcodeproj/command/sort.rb

@@ -9,22 +9,33 @@ module Xcodeproj
 
       self.summary = 'Sorts the given project.'
 
+      def self.options
+        [
+          ['--group-option=[above|below]', 'The position of the groups when sorting. If no option is specified, sorting will interleave groups and files.'],
+        ].concat(super)
+      end
+
       self.arguments = [
         CLAide::Argument.new('PROJECT', false),
       ]
 
       def initialize(argv)
         self.xcodeproj_path = argv.shift_argument
+        @group_option = argv.option('group-option')
+        @group_option &&= @group_option.to_sym
         super
       end
 
       def validate!
         super
+        unless [nil, :above, :below].include?(@group_option)
+          help! "Unknown format `#{@group_option}`"
+        end
         open_project!
       end
 
       def run
-        xcodeproj.sort
+        xcodeproj.sort(:groups_position => @group_option)
         xcodeproj.save
         puts "The `#{File.basename(xcodeproj_path)}` project was sorted"
       end

data/lib/xcodeproj/command.rb

@@ -33,11 +33,14 @@ module Xcodeproj
         elsif projects.size > 1
           raise Informative, 'There are more than one Xcode project documents ' \
                              'in the current working directory. Please specify ' \
-                             'which to use with the `--project` option.'
+                             'the project as the first argument, or specify ' \
+                             'which to use with the --project option if using ' \
+                             'target-diff.'
         else
           raise Informative, 'No Xcode project document found in the current ' \
-                             'working directory. Please specify which to use ' \
-                             'with the `--project` option.'
+                             'working directory. Please specify the project ' \
+                             'as the first argument, or specify which to use ' \
+                             'with the --project option if using target-diff.' \
         end
         @xcodeproj_path = Pathname.new(xcodeproj_path).expand_path
       end

data/lib/xcodeproj/config/other_linker_flags_parser.rb

@@ -16,6 +16,7 @@ module Xcodeproj
           :frameworks => [],
           :weak_frameworks => [],
           :libraries => [],
+          :arg_files => [],
           :simple => [],
           :force_load => [],
         }
@@ -32,6 +33,8 @@ module Xcodeproj
             key = :weak_frameworks
           when '-l'
             key = :libraries
+          when '@'
+            key = :arg_files
           when '-force_load'
             key = :force_load
           else
@@ -58,6 +61,8 @@ module Xcodeproj
         flags.strip.shellsplit.flat_map do |string|
           if string =~ /\A-l.+/
             ['-l', string[2..-1]]
+          elsif string =~ /\A@.+/
+            ['@', string[1..-1]]
           else
             string
           end

data/lib/xcodeproj/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shellwords'
 require 'xcodeproj/config/other_linker_flags_parser'
 
@@ -58,7 +59,7 @@ module Xcodeproj
       @attributes = {}
       @includes = []
       @other_linker_flags = {}
-      [:simple, :frameworks, :weak_frameworks, :libraries, :force_load].each do |key|
+      [:simple, :frameworks, :weak_frameworks, :libraries, :arg_files, :force_load].each do |key|
         @other_linker_flags[key] = Set.new
       end
       merge!(extract_hash(xcconfig_hash_or_file))
@@ -125,9 +126,10 @@ module Xcodeproj
         :frameworks => '-framework ',
         :weak_frameworks => '-weak_framework ',
         :libraries => '-l',
+        :arg_files => '@',
         :force_load => '-force_load',
       }
-      [:libraries, :frameworks, :weak_frameworks, :force_load].each do |key|
+      [:libraries, :frameworks, :weak_frameworks, :arg_files, :force_load].each do |key|
         modifier = modifiers[key]
         sorted = other_linker_flags[key].to_a.sort
         if key == :force_load
@@ -180,6 +182,13 @@ module Xcodeproj
       other_linker_flags[:libraries]
     end
 
+    # @return [Set<String>] The list of the arg files required by this
+    #         settings file.
+    #
+    def arg_files
+      other_linker_flags[:arg_files]
+    end
+
     public
 
     # @!group Merging
@@ -254,6 +263,7 @@ module Xcodeproj
     # @return [Hash]
     #
     def extract_hash(argument)
+      return argument if argument.is_a?(Hash)
       if argument.respond_to? :read
         @filepath = Pathname.new(argument.to_path)
         hash_from_file_content(argument.read)

data/lib/xcodeproj/constants.rb

@@ -32,15 +32,15 @@ module Xcodeproj
 
     # @return [String] The last known object version to Xcodeproj.
     #
-    LAST_KNOWN_OBJECT_VERSION = 54
+    LAST_KNOWN_OBJECT_VERSION = 56
 
-    # @return [String] The last known object version to Xcodeproj.
+    # @return [String] The last known Xcode version to Xcodeproj.
     #
-    LAST_UPGRADE_CHECK = '1100'
+    LAST_UPGRADE_CHECK = '1300'
 
-    # @return [String] The last known object version to Xcodeproj.
+    # @return [String] The last known Xcode version to Xcodeproj.
     #
-    LAST_SWIFT_UPGRADE_CHECK = '1100'
+    LAST_SWIFT_UPGRADE_CHECK = '1300'
 
     # @return [String] The version of `.xcscheme` files supported by Xcodeproj
     #
@@ -128,6 +128,8 @@ module Xcodeproj
     # @return [Hash] The compatibility version string for different object versions.
     #
     COMPATIBILITY_VERSION_BY_OBJECT_VERSION = {
+      56 => 'Xcode 14.0',
+      55 => 'Xcode 13.0',
       54 => 'Xcode 12.0',
       53 => 'Xcode 11.4',
       52 => 'Xcode 11.0',
@@ -453,5 +455,12 @@ module Xcodeproj
       $(inherited)
       ${inherited}
     ).freeze
+
+    # @return [Hash] Possible types for a scheme's 'ExecutionAction' node
+    #
+    EXECUTION_ACTION_TYPE = {
+      :shell_script  => 'Xcode.IDEStandardExecutionActionsCore.ExecutionActionType.ShellScriptAction',
+      :send_email    => 'Xcode.IDEStandardExecutionActionsCore.ExecutionActionType.SendEmailAction',
+    }.freeze
   end
 end

data/lib/xcodeproj/differ.rb

@@ -113,8 +113,8 @@ module Xcodeproj
       ensure_class(value_2, Array)
       return nil if value_1 == value_2
 
-      new_objects_value_1 = (value_1 - value_2)
-      new_objects_value_2 = (value_2 - value_1)
+      new_objects_value_1 = array_non_unique_diff(value_1, value_2)
+      new_objects_value_2 = array_non_unique_diff(value_2, value_1)
       return nil if value_1.empty? && value_2.empty?
 
       matched_diff = {}
@@ -234,6 +234,37 @@ module Xcodeproj
       raise "Wrong type `#{object.inspect}`" unless object.is_a?(klass)
     end
 
+    # Returns the difference between two arrays, taking into account the number of times an element
+    # repeats in both arrays.
+    #
+    # @param  [Array] value_1
+    #         First array to the difference operation.
+    #
+    # @param  [Array] value_2
+    #         Second array to the difference operation.
+    #
+    # @return [Array]
+    #
+    def self.array_non_unique_diff(value_1, value_2)
+      value_2_elements_by_count = value_2.reduce({}) do |hash, element|
+        updated_element_hash = hash.key?(element) ? { element => hash[element] + 1 } : { element => 1 }
+        hash.merge(updated_element_hash)
+      end
+
+      value_1_elements_by_deletions =
+        value_1.to_set.map do |element|
+          times_to_delete_element = value_2_elements_by_count[element] || 0
+          next [element, times_to_delete_element]
+        end.to_h
+
+      value_1.select do |element|
+        if value_1_elements_by_deletions[element] > 0
+          value_1_elements_by_deletions[element] -= 1
+          next false
+        end
+        next true
+      end
+    end
     #-------------------------------------------------------------------------#
   end
 end

data/lib/xcodeproj/gem_version.rb

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

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

@@ -12,7 +12,7 @@ module Xcodeproj
 
         # @!group Attributes
 
-        # @return [String] the name of the Target.
+        # @return [String] the name of the configuration.
         #
         attribute :name, String
 

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

@@ -39,6 +39,10 @@ module Xcodeproj
         #
         attribute :platform_filter, String
 
+        # @return [Array<String>] the platform filters for this build file.
+        #
+        attribute :platform_filters, Array
+
         #---------------------------------------------------------------------#
 
         public
@@ -49,7 +53,9 @@ module Xcodeproj
         #         user.
         #
         def display_name
-          if file_ref
+          if product_ref
+            product_ref.display_name
+          elsif file_ref
             file_ref.display_name
           else
             super

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

@@ -145,6 +145,27 @@ module Xcodeproj
         def ascii_plist_annotation
           " #{display_name} "
         end
+
+        # Sorts the build files of the phase according to the display
+        # name or the path.
+        #
+        # @param  [Hash] _options
+        #         Not used.
+        #
+        # @return [void]
+        #
+        def sort(_options = nil)
+          files.sort! do |x, y|
+            result = File.basename(x.display_name.downcase, '.*') <=> File.basename(y.display_name.downcase, '.*')
+            if result.zero?
+              result = File.extname(x.display_name.downcase) <=> File.extname(y.display_name.downcase)
+              if result.zero? && x.file_ref.respond_to?(:full_path) && y.file_ref.respond_to?(:full_path)
+                result = x.file_ref.full_path.to_s.downcase <=> y.file_ref.full_path.to_s.downcase
+              end
+            end
+            result
+          end
+        end
       end
 
       #-----------------------------------------------------------------------#

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

@@ -17,6 +17,13 @@ module Xcodeproj
         #
         attribute :compiler_spec, String
 
+        # @return [String] the discovered dependency file to use.
+        #
+        # @example
+        #   `$(DERIVED_FILES_DIR)/$(INPUT_FILE_NAME).d`.
+        #
+        attribute :dependency_file, String
+
         # @return [String] the type of the files that should be processed by
         #         this rule.
         #

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

@@ -313,8 +313,7 @@ module Xcodeproj
         end
 
         # In addition to removing the file reference, this will also remove any
-        # items related to this reference in case it represents an external
-        # Xcode project.
+        # items related to this reference.
         #
         # @see AbstractObject#remove_from_project
         #
@@ -327,6 +326,8 @@ module Xcodeproj
             project_reference[:product_group].remove_from_project
             project.root_object.project_references.delete(project_reference)
           end
+
+          build_files.each(&:remove_from_project)
           super
         end
 

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

@@ -226,24 +226,24 @@ module Xcodeproj
         # Creates a file reference to a static library and adds it to the
         # group.
         #
-        # @param  [#to_s] product_name
+        # @param  [#to_s] product_basename
         #         The name of the static library.
         #
         # @return [PBXFileReference] The new file reference.
         #
-        def new_product_ref_for_target(target_name, product_type)
-          FileReferencesFactory.new_product_ref_for_target(self, target_name, product_type)
+        def new_product_ref_for_target(product_basename, product_type)
+          FileReferencesFactory.new_product_ref_for_target(self, product_basename, product_type)
         end
 
         # Creates a file reference to a new bundle.
         #
-        # @param  [#to_s] product_name
+        # @param  [#to_s] product_basename
         #         The name of the bundle.
         #
         # @return [PBXFileReference] The new file reference.
         #
-        def new_bundle(product_name)
-          FileReferencesFactory.new_bundle(self, product_name)
+        def new_bundle(product_basename)
+          FileReferencesFactory.new_bundle(self, product_basename)
         end
 
         # Creates a file reference to a new bundle and adds it to the group.
@@ -440,12 +440,33 @@ module Xcodeproj
 
             result = File.basename(x.display_name.downcase, '.*') <=> File.basename(y.display_name.downcase, '.*')
             if result.zero?
-              File.extname(x.display_name.downcase) <=> File.extname(y.display_name.downcase)
-            else
-              result
+              result = File.extname(x.display_name.downcase) <=> File.extname(y.display_name.downcase)
+              if result.zero? && !(x.path.nil? || y.path.nil?)
+                result = x.path.downcase <=> y.path.downcase
+              end
             end
+            result
           end
         end
+
+        # @return [Array<PBXBuildFile>] the build files associated with the
+        #         current reference proxy.
+        #
+        def build_files
+          referrers.grep(PBXBuildFile)
+        end
+
+        # In addition to removing the reference proxy, this will also remove any
+        # items related to this reference.
+        #
+        # @see AbstractObject#remove_from_project
+        #
+        # @return [void]
+        #
+        def remove_from_project
+          build_files.each(&:remove_from_project)
+          super
+        end
       end
 
       #-----------------------------------------------------------------------#

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

@@ -42,17 +42,17 @@ module Xcodeproj
           # @param  [PBXGroup] group
           #         The group to which to add the reference.
           #
-          # @param  [#to_s] product_name
+          # @param  [#to_s] product_basename
           #         The name of the static library.
           #
           # @return [PBXFileReference] The new file reference.
           #
-          def new_product_ref_for_target(group, target_name, product_type)
+          def new_product_ref_for_target(group, product_basename, product_type)
             if product_type == :static_library
               prefix = 'lib'
             end
             extension = Constants::PRODUCT_UTI_EXTENSIONS[product_type]
-            path = "#{prefix}#{target_name}"
+            path = "#{prefix}#{product_basename}"
             path += ".#{extension}" if extension
             ref = new_reference(group, path, :built_products)
             ref.include_in_index = '0'
@@ -66,13 +66,13 @@ module Xcodeproj
           # @param  [PBXGroup] group
           #         The group to which to add the reference.
           #
-          # @param  [#to_s] product_name
+          # @param  [#to_s] product_basename
           #         The name of the bundle.
           #
           # @return [PBXFileReference] The new file reference.
           #
-          def new_bundle(group, product_name)
-            ref = new_reference(group, "#{product_name}.bundle", :built_products)
+          def new_bundle(group, product_basename)
+            ref = new_reference(group, "#{product_basename}.bundle", :built_products)
             ref.include_in_index = '0'
             ref.set_explicit_file_type('wrapper.cfbundle')
             ref

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

@@ -205,7 +205,7 @@ module Xcodeproj
           # @return [void]
           #
           def set_path_with_source_tree(object, path, source_tree)
-            path = Pathname.new(path)
+            path = Pathname(path)
             source_tree = normalize_source_tree(source_tree)
             object.source_tree = source_tree
 

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

@@ -552,6 +552,49 @@ module Xcodeproj
           end
         end
 
+        # Adds on demand resources to the resources build phase of the target.
+        #
+        # @param  {String => [Array<PBXFileReference>]} on_demand_resource_tag_files
+        #         the files references of the on demand resources to add to the target keyed by the tag.
+        #
+        # @return [void]
+        #
+        def add_on_demand_resources(on_demand_resource_tag_files)
+          on_demand_resource_tag_files.each do |tag, file_refs|
+            file_refs.each do |file_ref|
+              if resources_build_phase.include?(file_ref)
+                existing_build_file = resources_build_phase.build_file(file_ref)
+                existing_build_file.settings ||= {}
+                existing_build_file.settings['ASSET_TAGS'] ||= []
+                existing_build_file.settings['ASSET_TAGS'] << tag
+                existing_build_file.settings['ASSET_TAGS'].uniq!
+                next
+              end
+              build_file = resources_build_phase.add_file_reference(file_ref, true)
+              build_file.settings = (build_file.settings ||= {}).merge('ASSET_TAGS' => [tag])
+            end
+          end
+        end
+
+        # Remove on demand resources from the resources build phase of the target.
+        #
+        # @param  {String => [Array<PBXFileReference>]} on_demand_resource_tag_files
+        #         the files references of the on demand resources to add to the target keyed by the tag.
+        #
+        # @return [void]
+        #
+        def remove_on_demand_resources(on_demand_resource_tag_files)
+          on_demand_resource_tag_files.each do |tag, file_refs|
+            file_refs.each do |file_ref|
+              build_file = resources_build_phase.build_file(file_ref)
+              next if build_file.nil?
+              asset_tags = build_file.settings['ASSET_TAGS']
+              asset_tags.delete(tag)
+              resources_build_phase.remove_file_reference(file_ref) if asset_tags.empty?
+            end
+          end
+        end
+
         # Finds or creates the headers build phase of the target.
         #
         # @note   A target should have only one headers build phase.

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

@@ -61,6 +61,25 @@ module Xcodeproj
           return path if path
           super
         end
+
+        # @return [Array<PBXBuildFile>] the build files associated with the
+        #         current reference proxy.
+        #
+        def build_files
+          referrers.grep(PBXBuildFile)
+        end
+
+        # In addition to removing the reference proxy, this will also remove any
+        # items related to this reference.
+        #
+        # @see AbstractObject#remove_from_project
+        #
+        # @return [void]
+        #
+        def remove_from_project
+          build_files.each(&:remove_from_project)
+          super
+        end
       end
     end
   end

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

@@ -13,6 +13,16 @@ module Xcodeproj
         # @return [String] the product name of this Swift package.
         #
         attribute :product_name, String
+
+        # @!group AbstractObject Hooks
+        #--------------------------------------#
+
+        # @return [String] the name of the Swift package.
+        #
+        def display_name
+          return product_name if product_name
+          super
+        end
       end
     end
   end

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

@@ -13,6 +13,20 @@ module Xcodeproj
         # @return [Hash] the version requirements for this Swift package.
         #
         attribute :requirement, Hash
+
+        # @!group AbstractObject Hooks
+        #--------------------------------------#
+
+        def ascii_plist_annotation
+          " #{isa} \"#{File.basename(display_name)}\" "
+        end
+
+        # @return [String] the name of the Swift package repository.
+        #
+        def display_name
+          return repositoryURL if repositoryURL
+          super
+        end
       end
     end
   end

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

@@ -30,9 +30,14 @@ module Xcodeproj
         #
         attribute :platform_filter, String
 
-        # @return [String] the product reference for this target dependency.
+        # @return [Array<String>] the platform filters for this target dependency.
         #
-        attribute :product_ref, String
+        attribute :platform_filters, Array
+
+        # @return [XCSwiftPackageProductDependency] the Swift Package product
+        #         for this target dependency.
+        #
+        has_one :product_ref, XCSwiftPackageProductDependency
 
         public
 
@@ -45,20 +50,22 @@ module Xcodeproj
           return name if name
           return target.name if target
           return target_proxy.remote_info if target_proxy
+          return product_ref.product_name if product_ref
         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
-        #         a target proxy
+        # @return [String] the uuid of the target if the dependency is a native
+        #         target, the uuid of the target in the sub-project if the
+        #         dependency is a target proxy, nil if the dependency is a Swift
+        #         Package.
         #
         def native_target_uuid
           return target.uuid if target
           return target_proxy.remote_global_id_string if target_proxy
+          return nil if product_ref
           raise "Expected target or target_proxy, from which to fetch a uuid for target '#{display_name}'." \
             "Find and clear the PBXTargetDependency entry with uuid '#{@uuid}' in your .xcodeproj."
         end