cocoapods 1.10.0 → 1.16.0

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

@@ -32,7 +32,8 @@ module Pod
         # For messages extensions, this only applies if it's embedded in a messages
         # application.
         #
-        EMBED_FRAMEWORK_TARGET_TYPES = [:application, :application_on_demand_install_capable, :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
         #
@@ -313,6 +314,7 @@ module Pod
               phase.input_file_list_paths = script_phase[:input_file_lists]
               phase.output_file_list_paths = script_phase[:output_file_lists]
               phase.dependency_file = script_phase[:dependency_file]
+              phase.always_out_of_date = script_phase[:always_out_of_date]
               # At least with Xcode 10 `showEnvVarsInLog` is *NOT* set to any value even if it's checked and it only
               # gets set to '0' if the user has explicitly disabled this.
               if (show_env_vars_in_log = script_phase.fetch(:show_env_vars_in_log, '1')) == '0'
@@ -326,11 +328,18 @@ module Pod
 
           def reorder_script_phase(native_target, script_phase, execution_position)
             return if execution_position == :any || execution_position.to_s.empty?
-            target_phase_type = Xcodeproj::Project::Object::PBXSourcesBuildPhase
+            target_phase_type = case execution_position
+                                when :before_compile, :after_compile
+                                  Xcodeproj::Project::Object::PBXSourcesBuildPhase
+                                when :before_headers, :after_headers
+                                  Xcodeproj::Project::Object::PBXHeadersBuildPhase
+                                else
+                                  raise ArgumentError, "Unknown execution position `#{execution_position}`"
+                                end
             order_before = case execution_position
-                           when :before_compile
+                           when :before_compile, :before_headers
                              true
-                           when :after_compile
+                           when :after_compile, :after_headers
                              false
                            else
                              raise ArgumentError, "Unknown execution position `#{execution_position}`"
@@ -387,10 +396,10 @@ module Pod
 
           # Returns the framework input paths for the given framework paths
           #
-          # @param  [Hash<Array<Xcode::FrameworkPaths>>] framework_paths
+          # @param  [Array<Xcode::FrameworkPaths>] framework_paths
           #         The target's framework paths to map to input paths.
           #
-          # @param  [Hash<Array<XCFramework>>] xcframeworks
+          # @param  [Array<XCFramework>] xcframeworks
           #         The target's xcframeworks to map to input paths.
           #
           # @return [Array<String>] The embed frameworks script input paths
@@ -426,6 +435,119 @@ module Pod
             end
             paths + xcframework_paths
           end
+
+          # Updates a projects native targets to include on demand resources specified by the supplied parameters.
+          # Note that currently, only app level targets are allowed to include on demand resources.
+          #
+          # @param  [Sandbox] sandbox
+          #         The sandbox to use for calculating ODR file references.
+          #
+          # @param  [Xcodeproj::Project] project
+          #         The project to update known asset tags as well as add the ODR group.
+          #
+          # @param  [Xcodeproj::PBXNativeTarget, Array<Xcodeproj::PBXNativeTarget>] native_targets
+          #         The native targets to integrate on demand resources into.
+          #
+          # @param  [Sandbox::FileAccessor, Array<Sandbox::FileAccessor>] file_accessors
+          #         The file accessors that that provide the ODRs to integrate.
+          #
+          # @param  [Xcodeproj::PBXGroup] parent_odr_group
+          #         The group to use as the parent to add ODR file references into.
+          #
+          # @param  [String] target_odr_group_name
+          #         The name to use for the group created that contains the ODR file references.
+          #
+          # @return [void]
+          #
+          def update_on_demand_resources(sandbox, project, native_targets, file_accessors, parent_odr_group,
+                                         target_odr_group_name)
+            category_to_tags = {}
+            file_accessors = Array(file_accessors)
+            native_targets = Array(native_targets)
+
+            # Target no longer provides ODR references so remove everything related to this target.
+            if file_accessors.all? { |fa| fa.on_demand_resources.empty? }
+              old_target_odr_group = parent_odr_group[target_odr_group_name]
+              old_odr_file_refs = old_target_odr_group&.recursive_children_groups&.each_with_object({}) do |group, hash|
+                hash[group.name] = group.files
+              end || {}
+              native_targets.each do |native_target|
+                native_target.remove_on_demand_resources(old_odr_file_refs)
+                update_on_demand_resources_build_settings(native_target, nil => old_odr_file_refs.keys)
+              end
+              old_target_odr_group&.remove_from_project
+              return
+            end
+
+            target_odr_group = parent_odr_group[target_odr_group_name] || parent_odr_group.new_group(target_odr_group_name)
+            current_file_refs = target_odr_group.recursive_children_groups.flat_map(&:files)
+
+            added_file_refs = file_accessors.flat_map do |file_accessor|
+              target_odr_files_refs = Hash[file_accessor.on_demand_resources.map do |tag, value|
+                tag_group = target_odr_group[tag] || target_odr_group.new_group(tag)
+                category_to_tags[value[:category]] ||= []
+                category_to_tags[value[:category]] << tag
+                resources_file_refs = value[:paths].map do |resource|
+                  odr_resource_file_ref = Pathname.new(resource).relative_path_from(sandbox.root)
+                  tag_group.find_file_by_path(odr_resource_file_ref.to_s) || tag_group.new_file(odr_resource_file_ref)
+                end
+                [tag, resources_file_refs]
+              end]
+              native_targets.each do |native_target|
+                native_target.add_on_demand_resources(target_odr_files_refs)
+              end
+              target_odr_files_refs.values.flatten
+            end
+
+            # if the target ODR file references were updated, make sure we remove the ones that are no longer present
+            # for the target.
+            remaining_refs = current_file_refs - added_file_refs
+            remaining_refs.each do |ref|
+              native_targets.each do |user_target|
+                user_target.resources_build_phase.remove_file_reference(ref)
+              end
+              ref.remove_from_project
+            end
+            target_odr_group.recursive_children_groups.each { |g| g.remove_from_project if g.empty? }
+
+            attributes = project.root_object.attributes
+            attributes['KnownAssetTags'] = (attributes['KnownAssetTags'] ||= []) | category_to_tags.values.flatten
+            project.root_object.attributes = attributes
+
+            native_targets.each do |native_target|
+              update_on_demand_resources_build_settings(native_target, category_to_tags)
+            end
+          end
+
+          def update_on_demand_resources_build_settings(native_target, category_to_tags)
+            %w[ON_DEMAND_RESOURCES_INITIAL_INSTALL_TAGS ON_DEMAND_RESOURCES_PREFETCH_ORDER].each do |category_key|
+              native_target.build_configurations.each do |c|
+                key = case category_key
+                      when 'ON_DEMAND_RESOURCES_INITIAL_INSTALL_TAGS'
+                        :initial_install
+                      when 'ON_DEMAND_RESOURCES_PREFETCH_ORDER'
+                        :prefetched
+                      else
+                        :download_on_demand
+                      end
+                tags_for_category = (c.build_settings[category_key] || '').split
+                category_to_tags_dup = category_to_tags.dup
+                tags_to_add = category_to_tags_dup.delete(key) || []
+                tags_to_delete = category_to_tags_dup.values.flatten
+                tags_for_category = (tags_for_category + tags_to_add - tags_to_delete).flatten.compact.uniq
+                if tags_for_category.empty?
+                  val = c.build_settings.delete(category_key)
+                  native_target.project.mark_dirty! unless val.nil?
+                else
+                  tags = tags_for_category.join(' ')
+                  unless c.build_settings[category_key] == tags
+                    c.build_settings[category_key] = tags
+                    native_target.project.mark_dirty!
+                  end
+                end
+              end
+            end
+          end
         end
 
         # Integrates the user project targets. Only the targets that do **not**
@@ -445,6 +567,7 @@ module Pod
             add_copy_resources_script_phase
             add_check_manifest_lock_script_phase
             add_user_script_phases
+            add_on_demand_resources
           end
         end
 
@@ -509,10 +632,12 @@ module Pod
           output_paths_by_config = {}
           if use_input_output_paths
             target.resource_paths_by_config.each do |config, resource_paths|
-              input_paths_key = XCFileListConfigKey.new(target.copy_resources_script_input_files_path(config), target.copy_resources_script_input_files_relative_path)
+              input_paths_key = XCFileListConfigKey.new(target.copy_resources_script_input_files_path(config),
+                                                        target.copy_resources_script_input_files_relative_path)
               input_paths_by_config[input_paths_key] = [script_path] + resource_paths
 
-              output_paths_key = XCFileListConfigKey.new(target.copy_resources_script_output_files_path(config), target.copy_resources_script_output_files_relative_path)
+              output_paths_key = XCFileListConfigKey.new(target.copy_resources_script_output_files_path(config),
+                                                         target.copy_resources_script_output_files_relative_path)
               output_paths_by_config[output_paths_key] = TargetIntegrator.resource_output_paths(resource_paths)
             end
           end
@@ -520,7 +645,9 @@ module Pod
           native_targets.each do |native_target|
             # Static library targets cannot include resources. Skip this phase from being added instead.
             next if native_target.symbol_type == :static_library
-            TargetIntegrator.create_or_update_copy_resources_script_phase_to_target(native_target, script_path, input_paths_by_config, output_paths_by_config)
+            TargetIntegrator.create_or_update_copy_resources_script_phase_to_target(native_target, script_path,
+                                                                                    input_paths_by_config,
+                                                                                    output_paths_by_config)
           end
         end
 
@@ -624,6 +751,20 @@ module Pod
           end
         end
 
+        def add_on_demand_resources
+          target.pod_targets.each do |pod_target|
+            # When integrating with the user's project we are only interested in integrating ODRs from library specs
+            # and not test specs or app specs.
+            library_file_accessors = pod_target.file_accessors.select { |fa| fa.spec.library_specification? }
+            target_odr_group_name = "#{pod_target.label}-OnDemandResources"
+            # The 'Pods' group would always be there for production code however for tests its sometimes not added.
+            # This ensures its always present and makes it easier for existing and new tests.
+            parent_odr_group = target.user_project.main_group['Pods'] || target.user_project.new_group('Pods')
+            TargetIntegrator.update_on_demand_resources(target.sandbox, target.user_project, target.user_targets,
+                                                        library_file_accessors, parent_odr_group, target_odr_group_name)
+          end
+        end
+
         private
 
         # @!group Private Helpers

data/lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb

@@ -45,6 +45,11 @@ module Pod
           #
           attr_reader :info_plist_entries
 
+          # @return [String] product_basename
+          #         The product basename to use for the target.
+          #
+          attr_reader :product_basename
+
           # Initialize a new instance
           #
           # @param [Sandbox] sandbox @see #sandbox
@@ -55,8 +60,10 @@ module Pod
           # @param [String] app_target_label see #app_target_label
           # @param [Boolean] add_main see #add_main
           # @param [Hash] info_plist_entries see #info_plist_entries
+          # @param [String] product_basename see #product_basename
           #
-          def initialize(sandbox, project, platform, subgroup_name, group_name, app_target_label, add_main: true, add_launchscreen_storyboard: platform == :ios, info_plist_entries: {})
+          def initialize(sandbox, project, platform, subgroup_name, group_name, app_target_label, add_main: true,
+                         add_launchscreen_storyboard: platform == :ios, info_plist_entries: {}, product_basename: nil)
             @sandbox = sandbox
             @project = project
             @platform = platform
@@ -66,6 +73,7 @@ module Pod
             @add_main = add_main
             @add_launchscreen_storyboard = add_launchscreen_storyboard
             @info_plist_entries = info_plist_entries
+            @product_basename = product_basename || app_target_label
             target_group = project.pod_group(group_name)
             @group = target_group[subgroup_name] || target_group.new_group(subgroup_name)
           end
@@ -75,9 +83,9 @@ module Pod
           def install!
             platform_name = platform.name
             app_host_target = Pod::Generator::AppTargetHelper.add_app_target(project, platform_name, deployment_target,
-                                                                             app_target_label)
+                                                                             app_target_label, product_basename)
             app_host_target.build_configurations.each do |configuration|
-              configuration.build_settings['PRODUCT_NAME'] = app_target_label
+              configuration.build_settings['PRODUCT_NAME'] = product_basename
               configuration.build_settings['PRODUCT_BUNDLE_IDENTIFIER'] = 'org.cocoapods.${PRODUCT_NAME:rfc1034identifier}'
               if platform == :osx
                 configuration.build_settings['CODE_SIGN_IDENTITY'] = ''

data/lib/cocoapods/installer/xcode/pods_project_generator/file_references_installer.rb

@@ -6,6 +6,9 @@ module Pod
         # specifications in the Pods project.
         #
         class FileReferencesInstaller
+          # Regex for extracting the region portion of a localized file path. Ex. `Resources/en.lproj` --> `en`
+          LOCALIZATION_REGION_FILEPATTERN_REGEX = /(\/|^)(?<region>[^\/]*?)\.lproj(\/|$)/
+
           # @return [Sandbox] The sandbox of the installation.
           #
           attr_reader :sandbox
@@ -18,7 +21,7 @@ module Pod
           #
           attr_reader :pods_project
 
-          # @return [Bool] add support for preserving the file structure of externally sourced pods, in addition to local pods.
+          # @return [Boolean] add support for preserving the file structure of externally sourced pods, in addition to local pods.
           #
           attr_reader :preserve_pod_file_structure
 
@@ -27,7 +30,7 @@ module Pod
           # @param [Sandbox] sandbox @see #sandbox
           # @param [Array<PodTarget>] pod_targets @see #pod_targets
           # @param [Project] pods_project @see #pods_project
-          # @param [Bool] preserve_pod_file_structure @see #preserve_pod_file_structure
+          # @param [Boolean] preserve_pod_file_structure @see #preserve_pod_file_structure
           #
           def initialize(sandbox, pod_targets, pods_project, preserve_pod_file_structure = false)
             @sandbox = sandbox
@@ -126,8 +129,9 @@ module Pod
           #
           def add_resources
             UI.message '- Adding resources' do
-              add_file_accessors_paths_to_pods_group(:resources, :resources, true)
-              add_file_accessors_paths_to_pods_group(:resource_bundle_files, :resources, true)
+              refs = add_file_accessors_paths_to_pods_group(:resources, :resources, true)
+              refs.concat add_file_accessors_paths_to_pods_group(:resource_bundle_files, :resources, true)
+              add_known_regions(refs)
             end
           end
 
@@ -203,24 +207,24 @@ module Pod
           # @param  [Symbol] group_key
           #         The key of the group of the Pods project.
           #
-          # @param  [Bool] reflect_file_system_structure
+          # @param  [Boolean] reflect_file_system_structure
           #         Whether organizing a local pod's files in subgroups inside
           #         the pod's group is allowed.
           #
-          # @return [void]
+          # @return [Array<PBXFileReference>] the added file references
           #
           def add_file_accessors_paths_to_pods_group(file_accessor_key, group_key = nil, reflect_file_system_structure = false)
-            file_accessors.each do |file_accessor|
+            file_accessors.flat_map do |file_accessor|
               paths = file_accessor.send(file_accessor_key)
               paths = allowable_project_paths(paths)
-              next if paths.empty?
+              next [] if paths.empty?
 
               pod_name = file_accessor.spec.name
               preserve_pod_file_structure_flag = (sandbox.local?(pod_name) || preserve_pod_file_structure) && reflect_file_system_structure
               base_path = preserve_pod_file_structure_flag ? common_path(paths) : nil
               actual_group_key = preserve_pod_file_structure_flag ? nil : group_key
               group = pods_project.group_for_spec(pod_name, actual_group_key)
-              paths.each do |path|
+              paths.map do |path|
                 pods_project.add_file_reference(path, group, preserve_pod_file_structure_flag, base_path)
               end
             end
@@ -239,6 +243,10 @@ module Pod
           def allowable_project_paths(paths)
             lproj_paths = Set.new
             lproj_paths_with_files = Set.new
+
+            # Remove all file ref under .docc folder, but preserve the .docc folder
+            paths = merge_to_docc_folder(paths)
+
             allowable_paths = paths.select do |path|
               path_str = path.to_s
 
@@ -302,9 +310,54 @@ module Pod
             return result unless result.to_s == '' || result.to_s == '/'
           end
 
+          # Adds the known localization regions to the root of the project
+          #
+          # @param [Array<PBXFileReferences>] file_references the resource file references
+          #
+          def add_known_regions(file_references)
+            pattern = LOCALIZATION_REGION_FILEPATTERN_REGEX
+            regions = file_references.map do |ref|
+              if (match = ref.path.to_s.match(pattern))
+                match[:region]
+              end
+            end.compact
+
+            pods_project.root_object.known_regions = (pods_project.root_object.known_regions | regions).sort
+          end
+
           #-----------------------------------------------------------------------#
         end
       end
     end
   end
 end
+
+# If we have an non-empty .docc folder, remove all paths under the folder
+# but keep the folder itself
+#
+# @param [Array<Pathname>] paths the paths to inspect
+#
+# @return [Array<Pathname>] The resulted list of paths.
+#
+def merge_to_docc_folder(paths)
+  docc_paths_with_files = Set.new
+  allowable_paths = paths.select do |path|
+    path_str = path.to_s
+
+    if path_str =~ /\.docc(\/|$)/i
+
+      # we want folder with files
+      next if path.directory?
+
+      # remove everything after ".docc", but keep ".docc"
+      folder_path = path_str.split("\.docc")[0] + "\.docc"
+
+      docc_paths_with_files << Pathname(folder_path)
+      next
+
+    end
+    true
+  end
+
+  allowable_paths + docc_paths_with_files.to_a
+end

data/lib/cocoapods/installer/xcode/pods_project_generator/pod_target_dependency_installer.rb

@@ -36,25 +36,24 @@ module Pod
             pod_target = pod_target_installation_result.target
             native_target = pod_target_installation_result.native_target
             project = native_target.project
-            frameworks_group = project.frameworks_group
 
             # First, wire up all resource bundles.
             wire_resource_bundle_targets(pod_target_installation_result.resource_bundle_targets,
                                          native_target, pod_target)
             # Wire up all dependencies to this pod target, if any.
             wire_target_dependencies(pod_target, native_target, project, pod_target_installation_results,
-                                     metadata_cache, frameworks_group)
+                                     metadata_cache)
 
             # Wire up test native targets.
             unless pod_target_installation_result.test_native_targets.empty?
               wire_test_native_targets(pod_target, pod_target_installation_result, pod_target_installation_results,
-                                       project, frameworks_group, metadata_cache)
+                                       project, metadata_cache)
             end
 
             # Wire up app native targets.
             unless pod_target_installation_result.app_native_targets.empty?
               wire_app_native_targets(pod_target, pod_target_installation_result, pod_target_installation_results,
-                                      project, frameworks_group, metadata_cache)
+                                      project, metadata_cache)
             end
           end
         end
@@ -70,8 +69,7 @@ module Pod
           end
         end
 
-        def wire_target_dependencies(pod_target, native_target, project,
-                                     pod_target_installation_results, metadata_cache, frameworks_group)
+        def wire_target_dependencies(pod_target, native_target, project, pod_target_installation_results, metadata_cache)
           dependent_targets = pod_target.dependent_targets
           dependent_targets.each do |dependent_target|
             is_local = sandbox.local?(dependent_target.pod_name)
@@ -81,7 +79,6 @@ module Pod
                 project.add_pod_subproject(dependent_project, is_local)
               end
               native_target.add_dependency(installation_result.native_target)
-              add_framework_file_reference_to_native_target(native_target, pod_target, dependent_target, frameworks_group)
             else
               # Hit the cache
               cached_dependency = metadata_cache.target_label_by_metadata[dependent_target.label]
@@ -91,7 +88,7 @@ module Pod
           end
         end
 
-        def wire_test_native_targets(pod_target, installation_result, pod_target_installation_results, project, frameworks_group, metadata_cache)
+        def wire_test_native_targets(pod_target, installation_result, pod_target_installation_results, project, metadata_cache)
           installation_result.test_specs_by_native_target.each do |test_native_target, test_spec|
             resource_bundle_native_targets = installation_result.test_resource_bundle_targets[test_spec.name] || []
             resource_bundle_native_targets.each do |test_resource_bundle_target|
@@ -107,7 +104,6 @@ module Pod
                   project.add_pod_subproject(dependent_test_project, is_local)
                 end
                 test_native_target.add_dependency(dependency_installation_result.native_target)
-                add_framework_file_reference_to_native_target(test_native_target, pod_target, test_dependent_target, frameworks_group)
               else
                 # Hit the cache
                 cached_dependency = metadata_cache.target_label_by_metadata[test_dependent_target.label]
@@ -162,7 +158,7 @@ module Pod
           end
         end
 
-        def wire_app_native_targets(pod_target, installation_result, pod_target_installation_results, project, frameworks_group, metadata_cache)
+        def wire_app_native_targets(pod_target, installation_result, pod_target_installation_results, project, metadata_cache)
           installation_result.app_specs_by_native_target.each do |app_native_target, app_spec|
             resource_bundle_native_targets = installation_result.app_resource_bundle_targets[app_spec.name] || []
             resource_bundle_native_targets.each do |app_resource_bundle_target|
@@ -184,7 +180,6 @@ module Pod
                   project.add_pod_subproject(dependency_project, is_local)
                 end
                 app_native_target.add_dependency(dependency_installation_result.native_target)
-                add_framework_file_reference_to_native_target(app_native_target, pod_target, app_dependent_target, frameworks_group)
               else
                 # Hit the cache
                 cached_dependency = metadata_cache.target_label_by_metadata[app_dependent_target.label]
@@ -194,14 +189,6 @@ module Pod
             end
           end
         end
-
-        def add_framework_file_reference_to_native_target(native_target, pod_target, dependent_target, frameworks_group)
-          if pod_target.should_build? && pod_target.build_as_dynamic? && dependent_target.should_build?
-            product_ref = frameworks_group.files.find { |f| f.path == dependent_target.product_name } ||
-                frameworks_group.new_product_ref_for_target(dependent_target.product_basename, dependent_target.product_type)
-            native_target.frameworks_build_phase.add_file_reference(product_ref, true)
-          end
-        end
       end
     end
   end