cocoapods 1.10.2 → 1.11.0

data/lib/cocoapods/installer/podfile_validator.rb

@@ -8,11 +8,11 @@ module Pod
       #
       attr_reader :podfile
 
-      # @return [Array<String>] any errors that have occured during the validation
+      # @return [Array<String>] any errors that have occurred during the validation
       #
       attr_reader :errors
 
-      # @return [Array<String>] any warnings that have occured during the validation
+      # @return [Array<String>] any warnings that have occurred during the validation
       #
       attr_reader :warnings
 

data/lib/cocoapods/installer/pre_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 PreIntegrateHooksContext < BaseInstallHooksContext
+    end
+  end
+end

data/lib/cocoapods/installer/project_cache/project_cache_analyzer.rb

@@ -34,6 +34,10 @@ module Pod
         #
         attr_reader :aggregate_targets
 
+        # @return [Hash<Symbol, Object>] Hash of installation options.
+        #
+        attr_reader :installation_options
+
         # @return [Bool] Flag indicating if we want to ignore the cache and force a clean installation.
         #
         attr_reader :clean_install
@@ -47,9 +51,10 @@ module Pod
         # @param [Hash<String, Hash>] podfile_plugins @see #podfile_plugins
         # @param [Array<PodTarget>] pod_targets @see #pod_targets
         # @param [Array<AggregateTarget>] aggregate_targets @see #aggregate_targets
+        # @param [Hash<Symbol, Object>] installation_options @see #installation_options
         # @param [Bool] clean_install @see #clean_install
         #
-        def initialize(sandbox, cache, build_configurations, project_object_version, podfile_plugins, pod_targets, aggregate_targets,
+        def initialize(sandbox, cache, build_configurations, project_object_version, podfile_plugins, pod_targets, aggregate_targets, installation_options,
                        clean_install: false)
           @sandbox = sandbox
           @cache = cache
@@ -58,6 +63,7 @@ module Pod
           @pod_targets = pod_targets
           @aggregate_targets = aggregate_targets
           @project_object_version = project_object_version
+          @installation_options = installation_options
           @clean_install = clean_install
         end
 
@@ -78,7 +84,8 @@ module Pod
           # Bail out early since these properties affect all targets and their associate projects.
           if cache.build_configurations != build_configurations ||
               cache.project_object_version != project_object_version ||
-              YAMLHelper.convert(cache.podfile_plugins) != YAMLHelper.convert(podfile_plugins)
+              YAMLHelper.convert(cache.podfile_plugins) != YAMLHelper.convert(podfile_plugins) ||
+              YAMLHelper.convert(cache.installation_options) != YAMLHelper.convert(installation_options)
             UI.message 'Ignoring project cache due to project configuration changes.'
             return full_install_results
           end

data/lib/cocoapods/installer/project_cache/project_installation_cache.rb

@@ -26,18 +26,25 @@ module Pod
         #
         attr_reader :podfile_plugins
 
+        # @return [Hash<Symbol, Object>]
+        #         Configured installation options
+        #
+        attr_reader :installation_options
+
         # Initializes a new instance.
         #
         # @param [Hash{String => TargetCacheKey}] cache_key_by_target_label @see #cache_key_by_target_label
         # @param [Hash{String => Symbol}] build_configurations @see #build_configurations
         # @param [Integer] project_object_version @see #project_object_version
         # @param [Hash<String, Hash>] podfile_plugins @see #podfile_plugins
+        # @param [Hash<Symbol, Object>] installation_options @see #installation_options
         #
-        def initialize(cache_key_by_target_label = {}, build_configurations = nil, project_object_version = nil, podfile_plugins = {})
+        def initialize(cache_key_by_target_label = {}, build_configurations = nil, project_object_version = nil, podfile_plugins = {}, installation_options = {})
           @cache_key_by_target_label = cache_key_by_target_label
           @build_configurations = build_configurations
           @project_object_version = project_object_version
           @podfile_plugins = podfile_plugins
+          @installation_options = installation_options
         end
 
         def update_cache_key_by_target_label!(cache_key_by_target_label)
@@ -56,6 +63,10 @@ module Pod
           @podfile_plugins = podfile_plugins
         end
 
+        def update_installation_options!(installation_options)
+          @installation_options = installation_options
+        end
+
         def save_as(path)
           Pathname(path).dirname.mkpath
           Sandbox.update_changed_file(path, YAMLHelper.convert(to_hash))
@@ -71,7 +82,8 @@ module Pod
           project_object_version = contents['OBJECT_VERSION']
           build_configurations = contents['BUILD_CONFIGURATIONS']
           podfile_plugins = contents['PLUGINS']
-          ProjectInstallationCache.new(cache_key_by_target_label, build_configurations, project_object_version, podfile_plugins)
+          installation_options = contents['INSTALLATION_OPTIONS']
+          ProjectInstallationCache.new(cache_key_by_target_label, build_configurations, project_object_version, podfile_plugins, installation_options)
         end
 
         def to_hash
@@ -82,6 +94,7 @@ module Pod
           contents['BUILD_CONFIGURATIONS'] = build_configurations if build_configurations
           contents['OBJECT_VERSION'] = project_object_version if project_object_version
           contents['PLUGINS'] = podfile_plugins if podfile_plugins
+          contents['INSTALLATION_OPTIONS'] = installation_options if installation_options
           contents
         end
       end

data/lib/cocoapods/installer/project_cache/target_cache_key.rb

@@ -136,7 +136,7 @@ module Pod
             'PROJECT_NAME' => pod_target.project_name,
           }
           if is_local_pod
-            relative_file_paths = pod_target.all_files.map { |f| Pathname.new(f).relative_path_from(sandbox.root).to_s }
+            relative_file_paths = pod_target.all_files.map { |f| f.relative_path_from(sandbox.root).to_s }
             contents['FILES'] = relative_file_paths.sort_by(&:downcase)
           end
           contents['CHECKOUT_OPTIONS'] = checkout_options if checkout_options
@@ -161,9 +161,12 @@ module Pod
           contents = {
             'BUILD_SETTINGS_CHECKSUM' => build_settings,
           }
-          if aggregate_target.includes_resources?
-            relative_file_paths = aggregate_target.resource_paths_by_config.values.flatten.uniq
-            contents['FILES'] = relative_file_paths.sort_by(&:downcase)
+          if aggregate_target.includes_resources? || aggregate_target.includes_on_demand_resources?
+            relative_resource_file_paths = aggregate_target.resource_paths_by_config.values.flatten.uniq
+            relative_on_demand_resource_file_paths = aggregate_target.on_demand_resources.map do |res|
+              res.relative_path_from(sandbox.project_path.dirname).to_s
+            end
+            contents['FILES'] = (relative_resource_file_paths + relative_on_demand_resource_file_paths).sort_by(&:downcase)
           end
           TargetCacheKey.new(sandbox, :aggregate, contents)
         end

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
         #
@@ -326,11 +327,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 +395,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 +434,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 +566,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 +631,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 +644,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 +750,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,9 @@ 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 +72,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 +82,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
@@ -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
 
@@ -207,20 +211,20 @@ module Pod
           #         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
@@ -302,6 +306,21 @@ 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