cocoapods 1.9.3 → 1.10.0.beta.1

data/lib/cocoapods/installer/pod_source_installer.rb

@@ -90,7 +90,8 @@ module Pod
       #
       def lock_files!(file_accessors)
         return if local?
-        FileUtils.chmod('u-w', source_files(file_accessors))
+        unlocked_files = source_files(file_accessors).reject { |f| (File.stat(f).mode & 0o200).zero? }
+        FileUtils.chmod('u-w', unlocked_files)
       end
 
       # Unlocks the source files if appropriate.

data/lib/cocoapods/installer/post_install_hooks_context.rb

@@ -3,133 +3,7 @@ module Pod
     # Context object designed to be used with the HooksManager which describes
     # the context of the installer.
     #
-    class PostInstallHooksContext
-      # @return [Sandbox] The Sandbox for the project.
-      #
-      attr_reader :sandbox
-
-      # @return [String] The path to the sandbox root (`Pods` directory).
-      #
-      attr_reader :sandbox_root
-
-      # @return [Xcodeproj::Project] The Pods Xcode project.
-      #
-      attr_reader :pods_project
-
-      # @return [Array<UmbrellaTargetDescription>] The list of
-      #         the CocoaPods umbrella targets generated by the installer.
-      #
-      attr_reader :umbrella_targets
-
-      # Initialize a new instance
-      #
-      # @param [Sandbox] sandbox see #sandbox
-      # @param [String] sandbox_root see #sandbox_root
-      # @param [Xcodeproj::Project] pods_project see #pods_project
-      # @param [Array<UmbrellaTargetDescription>] umbrella_targets see #umbrella_targets
-      #
-      def initialize(sandbox, sandbox_root, pods_project, umbrella_targets)
-        @sandbox = sandbox
-        @sandbox_root = sandbox_root
-        @pods_project = pods_project
-        @umbrella_targets = umbrella_targets
-      end
-
-      # @return [PostInstallHooksContext] Convenience class generator method
-      #
-      # @param  [Sandbox] sandbox
-      #         The sandbox
-      #
-      # @param  [Project] pods_project
-      #         The pods project.
-      #
-      # @param  [Array<AggregateTarget>] aggregate_targets
-      #         The aggregate targets, which will been presented by an adequate
-      #         {UmbrellaTargetDescription} in the generated context.
-      #
-      # @return [HooksContext] Convenience class method to generate the
-      #         static context.
-      #
-      def self.generate(sandbox, pods_project, aggregate_targets)
-        umbrella_targets_descriptions = aggregate_targets.map do |umbrella|
-          user_project = umbrella.user_project
-          user_targets = umbrella.user_targets
-          specs = umbrella.specs
-          platform_name = umbrella.platform.name
-          platform_deployment_target = umbrella.platform.deployment_target.to_s
-          cocoapods_target_label = umbrella.label
-          UmbrellaTargetDescription.new(user_project, user_targets, specs, platform_name, platform_deployment_target, cocoapods_target_label)
-        end
-
-        new(sandbox, sandbox.root.to_s, pods_project, umbrella_targets_descriptions)
-      end
-
-      # Pure data class which describes an umbrella target.
-      #
-      class UmbrellaTargetDescription
-        # @return [Xcodeproj::Project] The user project into which this target
-        #         is integrated.
-        #
-        attr_reader :user_project
-
-        # @return [Array<PBXNativeTarget>]
-        #         The list of user targets integrated by this umbrella target.
-        #
-        attr_reader :user_targets
-
-        # @return [Array<Specification>] The list of the
-        #         specifications of the target.
-        #
-        attr_reader :specs
-
-        # @return [Symbol] The platform (either `:ios`, `:watchos`, `:tvos`, or `:osx`).
-        #
-        attr_reader :platform_name
-
-        # @return [String] The deployment target.
-        #
-        attr_reader :platform_deployment_target
-
-        # @return [String] The label for the target.
-        #
-        attr_reader :cocoapods_target_label
-
-        # Initialize a new instance
-        #
-        # @param [Xcodeproj::Project] user_project see #user_project
-        # @param [Array<PBXNativeTarget>] user_targets see #user_targets
-        # @param [Array<Specification>] specs see #specs
-        # @param [Symbol] platform_name see #platform_name
-        # @param [String] platform_deployment_target see #platform_deployment_target
-        # @param [String] cocoapods_target_label see #cocoapods_target_label
-        #
-        def initialize(user_project, user_targets, specs, platform_name, platform_deployment_target, cocoapods_target_label)
-          @user_project = user_project
-          @user_targets = user_targets
-          @specs = specs
-          @platform_name = platform_name
-          @platform_deployment_target = platform_deployment_target
-          @cocoapods_target_label = cocoapods_target_label
-        end
-
-        # @return [String] The path of the user project
-        #         integrated by this target.
-        #
-        def user_project_path
-          user_project.path if user_project
-        end
-
-        # @return [Array<String>] The list of the UUIDs of the
-        #         user targets integrated by this umbrella
-        #         target.  They can be used to find the
-        #         targets opening the project They can be used
-        #         to find the targets opening the project with
-        #         Xcodeproj.
-        #
-        def user_target_uuids
-          user_targets.map(&:uuid)
-        end
-      end
+    class PostInstallHooksContext < BaseInstallHooksContext
     end
   end
 end

data/lib/cocoapods/installer/post_integrate_hooks_context.rb

@@ -0,0 +1,9 @@
+module Pod
+  class Installer
+    # Context object designed to be used with the HooksManager which describes
+    # the context of the installer.
+    #
+    class PostIntegrateHooksContext < BaseInstallHooksContext
+    end
+  end
+end

data/lib/cocoapods/installer/sandbox_dir_cleaner.rb

@@ -67,8 +67,9 @@ module Pod
             sandbox.pod_target_project_path(pod_target.project_name)
           end
           project_dir_names = sandbox_project_dir_names - [sandbox.project_path]
+          user_project_dir_names = aggregate_targets.map(&:user_project_path).uniq
 
-          removed_project_dir_names = project_dir_names - project_dir_names_to_install
+          removed_project_dir_names = project_dir_names - user_project_dir_names - project_dir_names_to_install
           removed_project_dir_names.each { |dir| remove_dir(dir) }
         end
       end

data/lib/cocoapods/installer/user_project_integrator/target_integrator.rb

@@ -1,5 +1,6 @@
 require 'active_support/core_ext/string/inflections'
 require 'cocoapods/xcode/framework_paths'
+require 'cocoapods/target/build_settings'
 
 module Pod
   class Installer
@@ -31,27 +32,41 @@ module Pod
         # For messages extensions, this only applies if it's embedded in a messages
         # application.
         #
-        EMBED_FRAMEWORK_TARGET_TYPES = [:application, :unit_test_bundle, :ui_test_bundle, :watch2_extension, :messages_application].freeze
+        EMBED_FRAMEWORK_TARGET_TYPES = [:application, :application_on_demand_install_capable, :unit_test_bundle, :ui_test_bundle, :watch2_extension, :messages_application].freeze
 
         # @return [String] the name of the embed frameworks phase
         #
         EMBED_FRAMEWORK_PHASE_NAME = 'Embed Pods Frameworks'.freeze
 
-        # @return [String] the name of the embed frameworks phase
+        # @return [String] the name of the copy xcframeworks phase
         #
-        PREPARE_ARTIFACTS_PHASE_NAME = 'Prepare Artifacts'.freeze
+        COPY_XCFRAMEWORKS_PHASE_NAME = 'Copy XCFrameworks'.freeze
 
         # @return [String] the name of the copy resources phase
         #
         COPY_PODS_RESOURCES_PHASE_NAME = 'Copy Pods Resources'.freeze
 
+        # @return [String] the name of the copy dSYM files phase
+        #
+        COPY_DSYM_FILES_PHASE_NAME = 'Copy dSYMs'.freeze
+
         # @return [Integer] the maximum number of input and output paths to use for a script phase
         #
         MAX_INPUT_OUTPUT_PATHS = 1000
 
-        # @return [String] the path to the artifact lists file used in the prepare & embed scripts
+        # @return [Array<String>] names of script phases that existed in previous versions of CocoaPods
+        #
+        REMOVED_SCRIPT_PHASE_NAMES = [
+          'Prepare Artifacts'.freeze,
+        ].freeze
+
+        # @return [float] Returns Minimum Xcode Compatibility version for FileLists
         #
-        ARTIFACT_LIST_FILE = '${BUILT_PRODUCTS_DIR}/cocoapods-artifacts-${CONFIGURATION}.txt'.freeze
+        MIN_FILE_LIST_COMPATIBILITY_VERSION = 9.3
+
+        # @return [String] Returns Minimum Xcode Object version for FileLists
+        #
+        MIN_FILE_LIST_OBJECT_VERSION = 50
 
         # @return [AggregateTarget] the target that should be integrated.
         #
@@ -83,7 +98,14 @@ module Pod
           #         should be stored in a file list file.
           #
           def input_output_paths_use_filelist?(object)
-            object.project.object_version.to_i >= 50
+            unless object.project.root_object.compatibility_version.nil?
+              version_match = object.project.root_object.compatibility_version.match(/Xcode ([0-9]*\.[0-9]*)/).to_a
+            end
+            if version_match&.at(1).nil?
+              object.project.object_version.to_i >= MIN_FILE_LIST_OBJECT_VERSION
+            else
+              Pod::Version.new(version_match[1]) >= Pod::Version.new(MIN_FILE_LIST_COMPATIBILITY_VERSION)
+            end
           end
 
           # Sets the input & output paths for the given script build phase.
@@ -143,8 +165,17 @@ module Pod
             TargetIntegrator.set_input_output_paths(phase, input_paths_by_config, output_paths_by_config)
           end
 
-          # Adds a shell script build phase responsible to copy xcframeworks slices
-          # generated by the TargetDefinition to the build directory.
+          # Delete a 'Embed Pods Frameworks' Script Build Phase if present
+          #
+          # @param [PBXNativeTarget] native_target
+          #        The native target to remove the script phase from.
+          #
+          def remove_embed_frameworks_script_phase_from_target(native_target)
+            remove_script_phase_from_target(native_target, EMBED_FRAMEWORK_PHASE_NAME)
+          end
+
+          # Adds a shell script build phase responsible to copy the xcframework slice
+          # to the intermediate build directory.
           #
           # @param [PBXNativeTarget] native_target
           #        The native target to add the script phase into.
@@ -160,31 +191,30 @@ module Pod
           #
           # @return [void]
           #
-          def create_or_update_prepare_artifacts_script_phase_to_target(native_target, script_path, input_paths_by_config = {}, output_paths_by_config = {})
-            phase = TargetIntegrator.create_or_update_shell_script_build_phase(native_target, BUILD_PHASE_PREFIX + PREPARE_ARTIFACTS_PHASE_NAME)
+          def create_or_update_copy_xcframeworks_script_phase_to_target(native_target, script_path, input_paths_by_config = {}, output_paths_by_config = {})
+            phase = TargetIntegrator.create_or_update_shell_script_build_phase(native_target, BUILD_PHASE_PREFIX + COPY_XCFRAMEWORKS_PHASE_NAME)
             phase.shell_script = %("#{script_path}"\n)
-            reorder_script_phase(native_target, phase, :before_compile)
             TargetIntegrator.set_input_output_paths(phase, input_paths_by_config, output_paths_by_config)
+            reorder_script_phase(native_target, phase, :before_compile)
           end
 
-          # Delete a 'Embed Pods Frameworks' Copy Files Build Phase if present
+          # Delete a 'Copy XCFrameworks' Script Build Phase if present
           #
           # @param [PBXNativeTarget] native_target
           #        The native target to remove the script phase from.
           #
-          def remove_embed_frameworks_script_phase_from_target(native_target)
-            remove_script_phase_from_target(native_target, EMBED_FRAMEWORK_PHASE_NAME)
+          def remove_copy_xcframeworks_script_phase_from_target(native_target)
+            remove_script_phase_from_target(native_target, COPY_XCFRAMEWORKS_PHASE_NAME)
           end
 
-          # Delete a 'Embed Pods Frameworks' Copy Files Build Phase if present
+          # Removes a script phase from a native target by name
           #
           # @param [PBXNativeTarget] native_target
-          #        The native target to remove the script phase from.
+          #        The target from which the script phased should be removed
+          #
+          # @param [String] phase_name
+          #        The name of the script phase to remove
           #
-          def remove_prepare_artifacts_script_phase_from_target(native_target)
-            remove_script_phase_from_target(native_target, PREPARE_ARTIFACTS_PHASE_NAME)
-          end
-
           def remove_script_phase_from_target(native_target, phase_name)
             build_phase = native_target.shell_script_build_phases.find { |bp| bp.name && bp.name.end_with?(phase_name) }
             return unless build_phase.present?
@@ -239,7 +269,7 @@ module Pod
           #        The value to set for show environment variables in the log during execution of this script phase or
           #        `nil` for not setting the value at all.
           #
-          # @return [void]
+          # @return [PBXShellScriptBuildPhase] The existing or newly created shell script build phase.
           #
           def create_or_update_shell_script_build_phase(native_target, script_phase_name, show_env_vars_in_log = '0')
             build_phases = native_target.build_phases.grep(Xcodeproj::Project::Object::PBXShellScriptBuildPhase)
@@ -263,7 +293,9 @@ module Pod
           def create_or_update_user_script_phases(script_phases, native_target)
             script_phase_names = script_phases.map { |k| k[:name] }
             # Delete script phases no longer present in the target.
-            native_target_script_phases = native_target.shell_script_build_phases.select { |bp| !bp.name.nil? && bp.name.start_with?(USER_BUILD_PHASE_PREFIX) }
+            native_target_script_phases = native_target.shell_script_build_phases.select do |bp|
+              !bp.name.nil? && bp.name.start_with?(USER_BUILD_PHASE_PREFIX)
+            end
             native_target_script_phases.each do |script_phase|
               script_phase_name_without_prefix = script_phase.name.sub(USER_BUILD_PHASE_PREFIX, '')
               unless script_phase_names.include?(script_phase_name_without_prefix)
@@ -293,18 +325,27 @@ module Pod
           end
 
           def reorder_script_phase(native_target, script_phase, execution_position)
-            return if execution_position == :any
-            compile_build_phase_index = native_target.build_phases.index do |bp|
-              bp.is_a?(Xcodeproj::Project::Object::PBXSourcesBuildPhase)
+            return if execution_position == :any || execution_position.to_s.empty?
+            target_phase_type = Xcodeproj::Project::Object::PBXSourcesBuildPhase
+            order_before = case execution_position
+                           when :before_compile
+                             true
+                           when :after_compile
+                             false
+                           else
+                             raise ArgumentError, "Unknown execution position `#{execution_position}`"
+                           end
+
+            target_phase_index = native_target.build_phases.index do |bp|
+              bp.is_a?(target_phase_type)
             end
-            unless compile_build_phase_index.nil?
-              script_phase_index = native_target.build_phases.index do |bp|
-                bp.is_a?(Xcodeproj::Project::Object::PBXShellScriptBuildPhase) && !bp.name.nil? && bp.name == script_phase.name
-              end
-              if (execution_position == :before_compile && script_phase_index > compile_build_phase_index) ||
-                (execution_position == :after_compile && script_phase_index < compile_build_phase_index)
-                native_target.build_phases.move_from(script_phase_index, compile_build_phase_index)
-              end
+            return if target_phase_index.nil?
+            script_phase_index = native_target.build_phases.index do |bp|
+              bp.is_a?(Xcodeproj::Project::Object::PBXShellScriptBuildPhase) && !bp.name.nil? && bp.name == script_phase.name
+            end
+            if (order_before && script_phase_index > target_phase_index) ||
+              (!order_before && script_phase_index < target_phase_index)
+              native_target.build_phases.move_from(script_phase_index, target_phase_index)
             end
           end
 
@@ -327,27 +368,6 @@ module Pod
             end
           end
 
-          # Returns an extension in the target that corresponds to the
-          # resource's input extension.
-          #
-          # @param [String] input_extension
-          #        The input extension to map to.
-          #
-          # @return [String] The output extension.
-          #
-          def output_extension_for_resource(input_extension)
-            case input_extension
-            when '.storyboard'        then '.storyboardc'
-            when '.xib'               then '.nib'
-            when '.framework'         then '.framework'
-            when '.xcdatamodel'       then '.mom'
-            when '.xcdatamodeld'      then '.momd'
-            when '.xcmappingmodel'    then '.cdm'
-            when '.xcassets'          then '.car'
-            else                      input_extension
-            end
-          end
-
           # Returns the resource output paths for all given input paths.
           #
           # @param [Array<String>] resource_input_paths
@@ -360,31 +380,51 @@ module Pod
               base_path = '${TARGET_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}'
               extname = File.extname(resource_input_path)
               basename = extname == '.xcassets' ? 'Assets' : File.basename(resource_input_path)
-              output_extension = TargetIntegrator.output_extension_for_resource(extname)
+              output_extension = Target.output_extension_for_resource(extname)
               File.join(base_path, File.basename(basename, extname) + output_extension)
             end.uniq
           end
 
-          # Returns the framework output paths for the given input paths
+          # Returns the framework input paths for the given framework paths
           #
-          # @param  [Array<Xcode::FrameworkPaths>] framework_input_paths
+          # @param  [Hash<Array<Xcode::FrameworkPaths>>] framework_paths
+          #         The target's framework paths to map to input paths.
+          #
+          # @param  [Hash<Array<XCFramework>>] xcframeworks
+          #         The target's xcframeworks to map to input paths.
+          #
+          # @return [Array<String>] The embed frameworks script input paths
+          #
+          def embed_frameworks_input_paths(framework_paths, xcframeworks)
+            input_paths = framework_paths.map(&:source_path)
+            # Only include dynamic xcframeworks as the input since we will not be copying static xcframework slices
+            xcframeworks.select { |xcf| xcf.build_type.dynamic_framework? }.each do |xcframework|
+              name = xcframework.name
+              input_paths << "#{Pod::Target::BuildSettings.xcframework_intermediate_dir(xcframework)}/#{name}.framework/#{name}"
+            end
+            input_paths
+          end
+
+          # Returns the framework output paths for the given framework paths
+          #
+          # @param  [Array<Xcode::FrameworkPaths>] framework_paths
           #         The framework input paths to map to output paths.
           #
-          # @return [Array<String>] The framework output paths
-          #
-          def framework_output_paths(framework_input_paths)
-            framework_input_paths.flat_map do |framework_path|
-              framework_output_path = "${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/#{File.basename(framework_path.source_path)}"
-              dsym_output_path = if (dsym_input_path = framework_path.dsym_path)
-                                   "${DWARF_DSYM_FOLDER_PATH}/#{File.basename(dsym_input_path)}"
-                                 end
-              bcsymbol_output_paths = unless framework_path.bcsymbolmap_paths.nil?
-                                        framework_path.bcsymbolmap_paths.map do |bcsymbolmap_path|
-                                          "${BUILT_PRODUCTS_DIR}/#{File.basename(bcsymbolmap_path)}"
-                                        end
-                                      end
-              [framework_output_path, dsym_output_path, *bcsymbol_output_paths]
-            end.compact.uniq
+          # @param  [Array<XCFramework>] xcframeworks
+          #         The installed xcframeworks.
+          #
+          # @return [Array<String>] The embed framework script output paths
+          #
+          def embed_frameworks_output_paths(framework_paths, xcframeworks)
+            paths = framework_paths.map do |framework_path|
+              "${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/#{File.basename(framework_path.source_path)}"
+            end.uniq
+            # Static xcframeworks are not copied to the build dir
+            # so only include dynamic artifacts that will be copied to the build folder
+            xcframework_paths = xcframeworks.select { |xcf| xcf.build_type.dynamic_framework? }.map do |xcframework|
+              "${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/#{xcframework.name}.framework"
+            end
+            paths + xcframework_paths
           end
         end
 
@@ -398,9 +438,9 @@ module Pod
           UI.section(integration_message) do
             XCConfigIntegrator.integrate(target, native_targets)
 
+            remove_obsolete_script_phases
             add_pods_library
             add_embed_frameworks_script_phase
-            add_prepare_artifacts_script_phase
             remove_embed_frameworks_script_phase_from_embedded_targets
             add_copy_resources_script_phase
             add_check_manifest_lock_script_phase
@@ -504,7 +544,7 @@ module Pod
         # @return [void]
         #
         def add_embed_frameworks_script_phase
-          unless target.includes_frameworks? || target.includes_xcframeworks?
+          unless target.includes_frameworks? || (target.xcframeworks_by_config.values.flatten.any? { |xcf| xcf.build_type.dynamic_framework? })
             native_targets_to_embed_in.each do |native_target|
               TargetIntegrator.remove_embed_frameworks_script_phase_from_target(native_target)
             end
@@ -515,16 +555,16 @@ module Pod
           input_paths_by_config = {}
           output_paths_by_config = {}
           if use_input_output_paths?
-            target.framework_paths_by_config.each do |config, framework_paths|
+            configs = Set.new(target.framework_paths_by_config.keys + target.xcframeworks_by_config.keys).sort
+            configs.each do |config|
+              framework_paths = target.framework_paths_by_config[config] || []
+              xcframeworks = target.xcframeworks_by_config[config] || []
+
               input_paths_key = XCFileListConfigKey.new(target.embed_frameworks_script_input_files_path(config), target.embed_frameworks_script_input_files_relative_path)
-              input_paths = input_paths_by_config[input_paths_key] = [script_path]
-              input_paths << ARTIFACT_LIST_FILE if target.includes_xcframeworks?
-              framework_paths.each do |path|
-                input_paths.concat(path.all_paths)
-              end
+              input_paths_by_config[input_paths_key] = [script_path] + TargetIntegrator.embed_frameworks_input_paths(framework_paths, xcframeworks)
 
               output_paths_key = XCFileListConfigKey.new(target.embed_frameworks_script_output_files_path(config), target.embed_frameworks_script_output_files_relative_path)
-              output_paths_by_config[output_paths_key] = TargetIntegrator.framework_output_paths(framework_paths)
+              output_paths_by_config[output_paths_key] = TargetIntegrator.embed_frameworks_output_paths(framework_paths, xcframeworks)
             end
           end
 
@@ -533,36 +573,6 @@ module Pod
           end
         end
 
-        # Find or create a 'Prepare Artifacts' Copy Files Build Phase
-        #
-        # @return [void]
-        #
-        def add_prepare_artifacts_script_phase
-          unless target.includes_xcframeworks?
-            native_targets_to_embed_in.each do |native_target|
-              TargetIntegrator.remove_prepare_artifacts_script_phase_from_target(native_target)
-            end
-            return
-          end
-
-          script_path = target.prepare_artifacts_script_relative_path
-          input_paths_by_config = {}
-          output_paths_by_config = {}
-          if use_input_output_paths?
-            target.xcframeworks_by_config.each do |config, xcframeworks|
-              input_paths_key = XCFileListConfigKey.new(target.prepare_artifacts_script_input_files_path(config), target.prepare_artifacts_script_input_files_relative_path)
-              input_paths = input_paths_by_config[input_paths_key] = [script_path]
-              input_paths.concat(xcframeworks.map { |xcf| "${PODS_ROOT}/#{xcf.path.relative_path_from(target.sandbox.root)}" })
-
-              output_paths_key = XCFileListConfigKey.new(target.prepare_artifacts_script_output_files_path(config), target.prepare_artifacts_script_output_files_relative_path)
-              output_paths_by_config[output_paths_key] = [ARTIFACT_LIST_FILE]
-            end
-          end
-          native_targets_to_embed_in.each do |native_target|
-            TargetIntegrator.create_or_update_prepare_artifacts_script_phase_to_target(native_target, script_path, input_paths_by_config, output_paths_by_config)
-          end
-        end
-
         # Updates all target script phases for the current target, including creating or updating, deleting
         # and re-ordering.
         #
@@ -603,6 +613,17 @@ module Pod
           end
         end
 
+        # @param [Array<String>] removed_phase_names
+        #        The names of the script phases that should be removed
+        #
+        def remove_obsolete_script_phases(removed_phase_names = REMOVED_SCRIPT_PHASE_NAMES)
+          native_targets.each do |native_target|
+            removed_phase_names.each do |phase_name|
+              TargetIntegrator.remove_script_phase_from_target(native_target, phase_name)
+            end
+          end
+        end
+
         private
 
         # @!group Private Helpers