xcodeproj 1.7.0 → 1.19.0

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

@@ -18,7 +18,7 @@ module Xcodeproj
         #
         attribute :settings, Hash
 
-        # @return [PBXFileReference] the file that to build.
+        # @return [PBXFileReference] the file to build.
         #
         # @todo   I think that is possible to add any kind of group (for
         #         example folders linked to a path).
@@ -31,6 +31,14 @@ module Xcodeproj
           PBXReferenceProxy,
         ]
 
+        # @return [XCSwiftPackageProductDependency] the Swift Package file to build.
+        #
+        has_one :product_ref, XCSwiftPackageProductDependency
+
+        # @return [String] the platform filter for this build file.
+        #
+        attribute :platform_filter, String
+
         #---------------------------------------------------------------------#
 
         public

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

@@ -30,6 +30,16 @@ module Xcodeproj
         #
         attribute :run_only_for_deployment_postprocessing, String, '0'
 
+        # @return [String] whether or not this run script will be forced to
+        #         run even on incremental builds. Can be either '1', or
+        #         missing. By default this option is disabled in Xcode.
+        #
+        # @note   This setting is exposed in Xcode in the UI of
+        #         PBXShellScriptBuildPhase as `Based on
+        #         dependency analysis` (selected by default).
+        #
+        attribute :always_out_of_date, String
+
         # @return [String] Comments associated with this build phase.
         #
         # @note   This is apparently no longer used by Xcode.
@@ -204,6 +214,19 @@ module Xcodeproj
         #
         attribute :dst_subfolder_spec, String, Constants::COPY_FILES_BUILD_PHASE_DESTINATIONS[:resources]
 
+        # @return [Hash{String => Hash}] A hash suitable to display the build
+        #         phase to the user.
+        #
+        def pretty_print
+          {
+            display_name => {
+              'Destination Path' => dst_path,
+              'Destination Subfolder' => Constants::COPY_FILES_BUILD_PHASE_DESTINATIONS.key(dst_subfolder_spec).to_s,
+              'Files' => files.map(&:pretty_print),
+            },
+          }
+        end
+
         # Alias method for #dst_subfolder_spec=, which accepts symbol values
         # instead of numeric string values.
         #
@@ -279,16 +302,34 @@ module Xcodeproj
 
         # @return [String] the actual script to perform.
         #
-        # @note   Defaults to the empty string.
+        # @note   Defaults to a comment string.
         #
-        attribute :shell_script, String, ''
+        attribute :shell_script, String, "# Type a script or drag a script file from your workspace to insert its path.\n"
 
         # @return [String] whether or not the ENV variables should be shown in
         #         the build log.
         #
-        # @note   Defaults to true (`1`).
+        attribute :show_env_vars_in_log, String
+
+        # @return [String] the discovered dependency file to use.
+        #
+        attribute :dependency_file, String
+
+        # @return [Hash{String => Hash}] A hash suitable to display the build
+        #         phase to the user.
         #
-        attribute :show_env_vars_in_log, String, '1'
+        def pretty_print
+          {
+            display_name => {
+              'Input File List Paths' => input_file_list_paths || [],
+              'Input Paths' => input_paths || [],
+              'Output File List Paths' => output_file_list_paths || [],
+              'Output Paths' => output_paths || [],
+              'Shell Path' => shell_path,
+              'Shell Script' => shell_script,
+            },
+          }
+        end
       end
 
       #-----------------------------------------------------------------------#

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

@@ -41,6 +41,11 @@ module Xcodeproj
         #
         attribute :is_editable, String, '1'
 
+        # @return [ObjectList<PBXFileReference>] the file references for the
+        #         input files files.
+        #
+        attribute :input_files, Array
+
         # @return [ObjectList<PBXFileReference>] the file references for the
         #         output files.
         #
@@ -51,6 +56,13 @@ module Xcodeproj
         #
         attribute :output_files_compiler_flags, Array
 
+        # @return [String] whether the rule should be run once per architecture.
+        #
+        # @example
+        #   `0`.
+        #
+        attribute :run_once_per_architecture, String
+
         # @return [String] the content of the script to use for the build rule.
         #
         # @note   This attribute is present if the #{#compiler_spec} is

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'xcodeproj/project/object/helpers/groupable_helper'
 
 module Xcodeproj
@@ -51,7 +52,9 @@ module Xcodeproj
               prefix = 'lib'
             end
             extension = Constants::PRODUCT_UTI_EXTENSIONS[product_type]
-            ref = new_reference(group, "#{prefix}#{target_name}.#{extension}", :built_products)
+            path = "#{prefix}#{target_name}"
+            path += ".#{extension}" if extension
+            ref = new_reference(group, path, :built_products)
             ref.include_in_index = '0'
             ref.set_explicit_file_type
             ref
@@ -177,9 +180,7 @@ module Xcodeproj
             ref = new_file_reference(group, path, source_tree)
             ref.include_in_index = nil
 
-            product_group_ref = group.project.new(PBXGroup)
-            product_group_ref.name = 'Products'
-            product_group_ref.source_tree = '<group>'
+            product_group_ref = find_products_group_ref(group, true)
 
             subproj = Project.open(path)
             subproj.products_group.files.each do |product_reference|
@@ -230,6 +231,12 @@ module Xcodeproj
             end
           end
 
+          def find_products_group_ref(group, should_create = false)
+            product_group_ref =
+              (group.project.root_object.product_ref_group ||= group.project.main_group.find_subpath('Products', should_create))
+            product_group_ref
+          end
+
           #-------------------------------------------------------------------#
         end
       end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Xcodeproj
   class Project
     module Object
@@ -98,7 +99,7 @@ module Xcodeproj
           #
           def real_path(object)
             source_tree = source_tree_real_path(object)
-            path = object.path || ''
+            path = object.path || ''.freeze
             if source_tree
               source_tree + path
             else
@@ -115,11 +116,16 @@ module Xcodeproj
           def full_path(object)
             folder =  case object.source_tree
                       when '<group>'
-                        parent(object).isa != 'PBXProject' ? full_path(parent(object)) : nil
+                        object_parent = parent(object)
+                        if object_parent.isa == 'PBXProject'.freeze
+                          nil
+                        else
+                          full_path(object_parent)
+                        end
                       when 'SOURCE_ROOT'
                         nil
                       when '<absolute>'
-                        Pathname.new('/')
+                        Pathname.new('/'.freeze)
                       else
                         Pathname.new("${#{object.source_tree}}")
                       end
@@ -140,10 +146,11 @@ module Xcodeproj
           def source_tree_real_path(object)
             case object.source_tree
             when '<group>'
-              if parent(object).isa == 'PBXProject'
-                object.project.project_dir
+              object_parent = parent(object)
+              if object_parent.isa == 'PBXProject'.freeze
+                object.project.project_dir + object.project.root_object.project_dir_path
               else
-                real_path(parent(object))
+                real_path(object_parent)
               end
             when 'SOURCE_ROOT'
               object.project.project_dir

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

@@ -42,7 +42,7 @@ module Xcodeproj
         #        the key of the build setting.
         #
         # @param [Bool] resolve_against_xcconfig
-        #        wether the resolved setting should take in consideration any
+        #        whether the resolved setting should take in consideration any
         #        configuration file present.
         #
         # @return [Hash{String => String}] The value of the build setting
@@ -60,7 +60,7 @@ module Xcodeproj
               if target_val.is_a? String
                 target_val.gsub(Regexp.union(Constants::INHERITED_KEYWORDS), proj_val)
               else
-                target_val.map { |value| Constants::INHERITED_KEYWORDS.include?(value) ? proj_val : value }.flatten
+                target_val.flat_map { |value| Constants::INHERITED_KEYWORDS.include?(value) ? proj_val : value }
               end
             else
               target_val || proj_val
@@ -74,6 +74,10 @@ module Xcodeproj
         # @param [String] key
         #        the key of the build setting.
         #
+        # @param [Boolean] resolve_against_xcconfig
+        #        whether the resolved setting should take in consideration any
+        #        configuration file present.
+        #
         # @raise  If the build setting has multiple values.
         #
         # @note   As it is common not to have a setting with no value for
@@ -83,8 +87,8 @@ module Xcodeproj
         #
         # @return [String] The value of the build setting.
         #
-        def common_resolved_build_setting(key)
-          values = resolved_build_setting(key).values.compact.uniq
+        def common_resolved_build_setting(key, resolve_against_xcconfig: false)
+          values = resolved_build_setting(key, resolve_against_xcconfig).values.compact.uniq
           if values.count <= 1
             values.first
           else
@@ -309,7 +313,7 @@ module Xcodeproj
         # Adds a file reference for one or more system framework to the project
         # if needed and adds them to the Frameworks build phases.
         #
-        # @param  [Array<String>, String] name
+        # @param  [Array<String>, String] names
         #         The name or the list of the names of the framework.
         #
         # @note   Xcode behaviour is following: if the target has the same SDK
@@ -356,17 +360,22 @@ module Xcodeproj
         end
         alias_method :add_system_frameworks, :add_system_framework
 
-        # Adds a file reference for one or more system libraries to the project
+        # Adds a file reference for one or more system dylib libraries to the project
         # if needed and adds them to the Frameworks build phases.
         #
-        # @param  [Array<String>, String] name
+        # @param  [Array<String>, String] names
         #         The name or the list of the names of the libraries.
         #
         # @return [void]
         #
         def add_system_library(names)
+          add_system_library_extension(names, 'dylib')
+        end
+        alias_method :add_system_libraries, :add_system_library
+
+        def add_system_library_extension(names, extension)
           Array(names).each do |name|
-            path = "usr/lib/lib#{name}.dylib"
+            path = "usr/lib/lib#{name}.#{extension}"
             files = project.frameworks_group.files
             unless reference = files.find { |ref| ref.path == path }
               reference = project.frameworks_group.new_file(path, :sdk_root)
@@ -375,7 +384,20 @@ module Xcodeproj
             reference
           end
         end
-        alias_method :add_system_libraries, :add_system_library
+        private :add_system_library_extension
+
+        # Adds a file reference for one or more system tbd libraries to the project
+        # if needed and adds them to the Frameworks build phases.
+        #
+        # @param  [Array<String>, String] names
+        #         The name or the list of the names of the libraries.
+        #
+        # @return [void]
+        #
+        def add_system_library_tbd(names)
+          add_system_library_extension(names, 'tbd')
+        end
+        alias_method :add_system_libraries_tbd, :add_system_library_tbd
 
         public
 
@@ -414,6 +436,11 @@ module Xcodeproj
         #
         has_one :product_reference, PBXFileReference
 
+        # @return [ObjectList<XCSwiftPackageProductDependency>] the Swift package products necessary to
+        #         build this target.
+        #
+        has_many :package_product_dependencies, XCSwiftPackageProductDependency
+
         # @return [String] the install path of the product.
         #
         attribute :product_install_path, String
@@ -604,6 +631,22 @@ module Xcodeproj
             end
           end
         end
+
+        def to_hash_as(method = :to_hash)
+          hash_as = super
+          if !hash_as['packageProductDependencies'].nil? && hash_as['packageProductDependencies'].empty?
+            hash_as.delete('packageProductDependencies')
+          end
+          hash_as
+        end
+
+        def to_ascii_plist
+          plist = super
+          if !plist.value['packageProductDependencies'].nil? && plist.value['packageProductDependencies'].empty?
+            plist.value.delete('packageProductDependencies')
+          end
+          plist
+        end
       end
 
       #-----------------------------------------------------------------------#

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

@@ -34,7 +34,7 @@ module Xcodeproj
 
         # @return [String] the development region of the project.
         #
-        attribute :development_region, String, 'English'
+        attribute :development_region, String, 'en'
 
         # @return [String] whether the project has scanned for encodings.
         #
@@ -42,7 +42,7 @@ module Xcodeproj
 
         # @return [Array<String>] the list of known regions.
         #
-        attribute :known_regions, Array, ['en']
+        attribute :known_regions, Array, %w(en Base)
 
         # @return [PBXGroup] the main group of the project. The one displayed
         #         by Xcode in the Project Navigator.
@@ -62,6 +62,10 @@ module Xcodeproj
         #
         attribute :project_root, String, ''
 
+        # @return [Array<XCRemoteSwiftPackageReference>] the list of Swift package references.
+        #
+        has_many :package_references, XCRemoteSwiftPackageReference
+
         # @return [Array<ObjectDictionary>] any reference to other projects.
         #
         has_many_references_by_keys :project_references,
@@ -76,9 +80,18 @@ module Xcodeproj
           ' Project object '
         end
 
+        def to_hash_as(method = :to_hash)
+          hash_as = super
+          if !hash_as['packageReferences'].nil? && hash_as['packageReferences'].empty?
+            hash_as.delete('packageReferences') if !hash_as['packageReferences'].nil? && hash_as['packageReferences'].empty?
+          end
+          hash_as
+        end
+
         def to_ascii_plist
           plist = super
           plist.value.delete('projectReferences') if plist.value['projectReferences'].empty?
+          plist.value.delete('packageReferences') if !plist.value['packageReferences'].nil? && plist.value['packageReferences'].empty?
           plist
         end
       end

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

@@ -0,0 +1,19 @@
+module Xcodeproj
+  class Project
+    module Object
+      # This class represents a Swift package product dependency.
+      #
+      class XCSwiftPackageProductDependency < AbstractObject
+        # @!group Attributes
+
+        # @return [XCRemoteSwiftPackageReference] the Swift package reference.
+        #
+        has_one :package, XCRemoteSwiftPackageReference
+
+        # @return [String] the product name of this Swift package.
+        #
+        attribute :product_name, String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Xcodeproj
+  class Project
+    module Object
+      # This class represents a Swift package reference.
+      #
+      class XCRemoteSwiftPackageReference < AbstractObject
+        # @!group Attributes
+
+        # @return [String] the repository url this Swift package was installed from.
+        #
+        attribute :repositoryURL, String
+
+        # @return [Hash] the version requirements for this Swift package.
+        #
+        attribute :requirement, Hash
+      end
+    end
+  end
+end

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

@@ -26,6 +26,14 @@ module Xcodeproj
         #
         attribute :name, String
 
+        # @return [String] the platform filter for this target dependency.
+        #
+        attribute :platform_filter, String
+
+        # @return [String] the product reference for this target dependency.
+        #
+        attribute :product_ref, String
+
         public
 
         # @!group AbstractObject Hooks
@@ -65,6 +73,7 @@ module Xcodeproj
           hash = {}
           hash['displayName'] = display_name
           hash['isa'] = isa
+          hash['targetProxy'] = target_proxy.to_tree_hash
           hash
         end