xcocoapods 1.5.3

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

@@ -0,0 +1,116 @@
+module Pod
+  class Installer
+    class Xcode
+      class PodsProjectGenerator
+        # This class is responsible for integrating a pod target. This includes integrating
+        # the test targets included by each pod target.
+        #
+        class PodTargetIntegrator
+          # @return [TargetInstallationResult] the installation result of the target that should be integrated.
+          #
+          attr_reader :target_installation_result
+
+          # Initialize a new instance
+          #
+          # @param  [TargetInstallationResult] target_installation_result @see #target_installation_result
+          #
+          def initialize(target_installation_result)
+            @target_installation_result = target_installation_result
+          end
+
+          # Integrates the pod target.
+          #
+          # @return [void]
+          #
+          def integrate!
+            UI.section(integration_message) do
+              target_installation_result.test_specs_by_native_target.each do |test_native_target, test_specs|
+                add_embed_frameworks_script_phase(test_native_target)
+                add_copy_resources_script_phase(test_native_target)
+                UserProjectIntegrator::TargetIntegrator.create_or_update_user_script_phases(script_phases_for_specs(test_specs), test_native_target)
+              end
+              specs = target.non_test_specs
+              UserProjectIntegrator::TargetIntegrator.create_or_update_user_script_phases(script_phases_for_specs(specs), target_installation_result.native_target)
+            end
+          end
+
+          # @return [String] a string representation suitable for debugging.
+          #
+          def inspect
+            "#<#{self.class} for target `#{target.label}'>"
+          end
+
+          private
+
+          # @!group Integration steps
+          #---------------------------------------------------------------------#
+
+          # Find or create a 'Copy Pods Resources' build phase
+          #
+          # @return [void]
+          #
+          def add_copy_resources_script_phase(native_target)
+            test_type = target.test_type_for_product_type(native_target.symbol_type)
+            script_path = "${PODS_ROOT}/#{target.copy_resources_script_path_for_test_type(test_type).relative_path_from(target.sandbox.root)}"
+            resource_paths = target.all_dependent_targets.flat_map do |dependent_target|
+              spec_paths_to_include = dependent_target == target ? dependent_target.specs.map(&:name) : dependent_target.non_test_specs.map(&:name)
+              dependent_target.resource_paths.values_at(*spec_paths_to_include).flatten.compact
+            end
+            input_paths = []
+            output_paths = []
+            unless resource_paths.empty?
+              resource_paths_flattened = resource_paths.flatten.uniq
+              input_paths = [script_path, *resource_paths_flattened]
+              output_paths = UserProjectIntegrator::TargetIntegrator.resource_output_paths(resource_paths_flattened)
+            end
+            UserProjectIntegrator::TargetIntegrator.validate_input_output_path_limit(input_paths, output_paths)
+            UserProjectIntegrator::TargetIntegrator.create_or_update_copy_resources_script_phase_to_target(native_target, script_path, input_paths, output_paths)
+          end
+
+          # Find or create a 'Embed Pods Frameworks' Copy Files Build Phase
+          #
+          # @return [void]
+          #
+          def add_embed_frameworks_script_phase(native_target)
+            test_type = target.test_type_for_product_type(native_target.symbol_type)
+            script_path = "${PODS_ROOT}/#{target.embed_frameworks_script_path_for_test_type(test_type).relative_path_from(target.sandbox.root)}"
+            framework_paths = target.all_dependent_targets.flat_map do |dependent_target|
+              spec_paths_to_include = dependent_target == target ? dependent_target.specs.map(&:name) : dependent_target.non_test_specs.map(&:name)
+              dependent_target.framework_paths.values_at(*spec_paths_to_include).flatten.compact.uniq
+            end
+            input_paths = []
+            output_paths = []
+            unless framework_paths.empty?
+              input_paths = [script_path, *framework_paths.flat_map { |fw| [fw[:input_path], fw[:dsym_input_path]] }.compact]
+              output_paths = framework_paths.flat_map { |fw| [fw[:output_path], fw[:dsym_output_path]] }.compact
+            end
+            UserProjectIntegrator::TargetIntegrator.validate_input_output_path_limit(input_paths, output_paths)
+            UserProjectIntegrator::TargetIntegrator.create_or_update_embed_frameworks_script_phase_to_target(native_target, script_path, input_paths, output_paths)
+          end
+
+          # @return [String] the message that should be displayed for the target
+          #         integration.
+          #
+          def integration_message
+            "Integrating target `#{target.name}`"
+          end
+
+          # @return [PodTarget] the target part of the installation result.
+          #
+          def target
+            target_installation_result.target
+          end
+
+          # @param [Array<Specification] specs
+          #         the specs to return script phrases from.
+          #
+          # @return [Array<Hash<Symbol=>String>] an array of all combined script phases from the specs.
+          #
+          def script_phases_for_specs(specs)
+            specs.flat_map { |spec| spec.consumer(target.platform).script_phases }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+module Pod
+  class Installer
+    class Xcode
+      class PodsProjectGenerator
+        # A simple container produced after a target installation is completed.
+        #
+        class TargetInstallationResult
+          # @return [Target] target
+          #         The target this installation result is for.
+          #
+          attr_reader :target
+
+          # @return [PBXNativeTarget] native_target
+          #         The native target that was produced for this target.
+          #
+          attr_reader :native_target
+
+          # @return [Array<PBXNativeTarget>] resource_bundle_targets
+          #         The resource bundle targets that were produced for this target. Can be empty if the target had
+          #         no resource bundles.
+          #
+          attr_reader :resource_bundle_targets
+
+          # @return [Array<PBXNativeTarget>] test_native_targets
+          #         The test native targets that were produced for this target. Can be empty if there were no test
+          #         native targets created (e.g. no test specs present).
+          #
+          attr_reader :test_native_targets
+
+          # @return [Hash{String=>Array<PBXNativeTarget>}] test_resource_bundle_targets
+          #         The test resource bundle targets that were produced for this target keyed by test spec name.
+          #         Can be empty if the target had no resource bundles for any tests.
+          #
+          attr_reader :test_resource_bundle_targets
+
+          # Initialize a new instance
+          #
+          # @param [Target] target @see #target
+          # @param [PBXNativeTarget] native_target @see #native_target
+          # @param [Array<PBXNativeTarget>] resource_bundle_targets @see #resource_bundle_targets
+          # @param [Array<PBXNativeTarget>] test_native_targets @see #test_native_targets
+          # @param [Hash{String=>Array<PBXNativeTarget>}] test_resource_bundle_targets @see #test_resource_bundle_targets
+          #
+          def initialize(target, native_target, resource_bundle_targets = [], test_native_targets = [],
+                         test_resource_bundle_targets = {})
+            @target = target
+            @native_target = native_target
+            @resource_bundle_targets = resource_bundle_targets
+            @test_native_targets = test_native_targets
+            @test_resource_bundle_targets = test_resource_bundle_targets
+          end
+
+          # Returns the corresponding native target to use based on the provided specification.
+          #
+          # @param  [Specification] spec
+          #         The specification to base from in order to find the native target.
+          #
+          # @return [PBXNativeTarget] the native target to use or `nil` if none is found.
+          #
+          def native_target_for_spec(spec)
+            return native_target unless spec.test_specification?
+            test_native_target_from_spec(spec)
+          end
+
+          # @return [Hash{Array => Specification}] a hash where the keys are the test native targets and the value
+          #         an array of all the test specs associated with this native target.
+          #
+          def test_specs_by_native_target
+            test_specs_by_native_target = target.test_specs.group_by do |test_spec|
+              test_native_target_from_spec(test_spec)
+            end
+            test_specs_by_native_target.delete_if { |k, _| k.nil? }
+          end
+
+          private
+
+          def test_native_target_from_spec(spec)
+            test_native_targets.find do |test_native_target|
+              test_native_target.symbol_type == target.product_type_for_test_type(spec.test_type)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,256 @@
+require 'stringio'
+
+module Pod
+  class Installer
+    class Xcode
+      class PodsProjectGenerator
+        # Controller class responsible of creating and configuring the static
+        # library target in Pods project. It also creates the support file needed
+        # by the target.
+        #
+        class TargetInstaller
+          include TargetInstallerHelper
+
+          # @return [Sandbox] sandbox
+          #         The sandbox where the support files should be generated.
+          #
+          attr_reader :sandbox
+
+          # @return [Pod::Project]
+          #         The `Pods/Pods.xcodeproj` to install the target into.
+          #
+          attr_reader :project
+
+          # @return [Target] target
+          #         The library whose target needs to be generated.
+          #
+          attr_reader :target
+
+          # Initialize a new instance
+          #
+          # @param [Sandbox] sandbox @see #sandbox
+          # @param [Pod::Project] project @see #project
+          # @param [Target] target  @see #target
+          #
+          def initialize(sandbox, project, target)
+            @sandbox = sandbox
+            @project = project
+            @target = target
+          end
+
+          private
+
+          #-----------------------------------------------------------------------#
+
+          # @!group Installation steps
+
+          # Adds the target for the library to the Pods project with the
+          # appropriate build configurations.
+          #
+          # @note   The `PODS_HEADERS_SEARCH_PATHS` overrides the xcconfig.
+          #
+          # @return [PBXNativeTarget] the native target that was added.
+          #
+          def add_target
+            product_type = target.product_type
+            name = target.label
+            platform = target.platform.name
+            language = target.uses_swift? ? :swift : :objc
+            native_target = project.new_target(product_type, name, platform, deployment_target, nil, language)
+
+            product_name = target.product_name
+            product = native_target.product_reference
+            product.name = product_name
+
+            target.user_build_configurations.each do |bc_name, type|
+              native_target.add_build_configuration(bc_name, type)
+            end
+
+            native_target.build_configurations.each do |configuration|
+              configuration.build_settings.merge!(custom_build_settings)
+            end
+
+            native_target
+          end
+
+          # @return [String] The deployment target.
+          #
+          def deployment_target
+            target.platform.deployment_target.to_s
+          end
+
+          # Returns the customized build settings which are overridden in the build
+          # settings of the user target.
+          #
+          # @return [Hash{String => String}]
+          #
+          def custom_build_settings
+            settings = {}
+
+            unless target.archs.empty?
+              settings['ARCHS'] = target.archs
+            end
+
+            if target.requires_frameworks?
+              if target.static_framework?
+                settings['MACH_O_TYPE'] = 'staticlib'
+              end
+            else
+              settings.merge!('OTHER_LDFLAGS' => '', 'OTHER_LIBTOOLFLAGS' => '')
+            end
+
+            settings
+          end
+
+          # Creates the directory where to store the support files of the target.
+          #
+          def create_support_files_dir
+            target.support_files_dir.mkpath
+          end
+
+          # Remove temp file whose store .prefix/config/dummy file.
+          #
+          def clean_support_files_temp_dir
+            support_files_temp_dir.rmtree if support_files_temp_dir.exist?
+          end
+
+          # @return [String] The temp file path to store temporary files.
+          #
+          def support_files_temp_dir
+            sandbox.target_support_files_dir('generated_files_tmp')
+          end
+
+          # Creates the Info.plist file which sets public framework attributes
+          #
+          # @param  [Pathname] path
+          #         the path to save the generated Info.plist file.
+          #
+          # @param  [PBXNativeTarget] native_target
+          #         the native target to link the generated Info.plist file into.
+          #
+          # @param  [Version] version
+          #         the version to use for when generating this Info.plist file.
+          #
+          # @param  [Platform] platform
+          #         the platform to use for when generating this Info.plist file.
+          #
+          # @param  [Symbol] bundle_package_type
+          #         the CFBundlePackageType of the target this Info.plist file is for.
+          #
+          # @return [void]
+          #
+          def create_info_plist_file(path, native_target, version, platform, bundle_package_type = :fmwk)
+            create_info_plist_file_with_sandbox(@sandbox, path, native_target, version, platform, bundle_package_type)
+            add_file_to_support_group(path)
+          end
+
+          # Creates the module map file which ensures that the umbrella header is
+          # recognized with a customized path
+          #
+          # @param  [PBXNativeTarget] native_target
+          #         the native target to link the module map file into.
+          #
+          # @return [void]
+          #
+          def create_module_map(native_target)
+            path = target.module_map_path_to_write
+            UI.message "- Generating module map file at #{UI.path(path)}" do
+              generator = Generator::ModuleMap.new(target)
+              yield generator if block_given?
+              update_changed_file(generator, path)
+              add_file_to_support_group(path)
+
+              linked_path = target.module_map_path
+              if path != linked_path
+                linked_path.dirname.mkpath
+                FileUtils.ln_sf(path, linked_path)
+              end
+
+              relative_path_string = target.module_map_path.relative_path_from(sandbox.root).to_s
+              native_target.build_configurations.each do |c|
+                c.build_settings['MODULEMAP_FILE'] = relative_path_string
+              end
+            end
+          end
+
+          # Generates a header which ensures that all header files are exported
+          # in the module map
+          #
+          # @param  [PBXNativeTarget] native_target
+          #         the native target to link the umbrella header file into.
+          #
+          # @yield_param [Generator::UmbrellaHeader]
+          #              yielded once to configure the imports
+          #
+          # @return [void]
+          #
+          def create_umbrella_header(native_target)
+            path = target.umbrella_header_path_to_write
+            UI.message "- Generating umbrella header at #{UI.path(path)}" do
+              generator = Generator::UmbrellaHeader.new(target)
+              yield generator if block_given?
+              update_changed_file(generator, path)
+
+              # Add the file to the support group and the native target,
+              # so it will been added to the header build phase
+              file_ref = add_file_to_support_group(path)
+              build_file = native_target.headers_build_phase.add_file_reference(file_ref)
+
+              linked_path = target.umbrella_header_path
+              if path != linked_path
+                linked_path.dirname.mkpath
+                FileUtils.ln_sf(path, linked_path)
+              end
+
+              acl = target.requires_frameworks? ? 'Public' : 'Project'
+              build_file.settings ||= {}
+              build_file.settings['ATTRIBUTES'] = [acl]
+            end
+          end
+
+          # Generates a dummy source file for each target so libraries that contain
+          # only categories build.
+          #
+          # @param  [PBXNativeTarget] native_target
+          #         the native target to link the dummy source file into.
+          #
+          # @return [void]
+          #
+          def create_dummy_source(native_target)
+            path = target.dummy_source_path
+            UI.message "- Generating dummy source at #{UI.path(path)}" do
+              generator = Generator::DummySource.new(target.label)
+              update_changed_file(generator, path)
+              file_reference = add_file_to_support_group(path)
+              native_target.source_build_phase.add_file_reference(file_reference)
+            end
+          end
+
+          private
+
+          #-----------------------------------------------------------------------#
+
+          # @!group Private helpers.
+
+          # @return [PBXGroup] the group where the file references to the support
+          #         files should be stored.
+          #
+          attr_reader :support_files_group
+
+          # Adds a reference to the given file in the support group of this target.
+          #
+          # @param  [Pathname] path
+          #         The path of the file to which the reference should be added.
+          #
+          # @return [PBXFileReference] the file reference of the added file.
+          #
+          def add_file_to_support_group(path)
+            support_files_group.new_file(path)
+          end
+
+          #-----------------------------------------------------------------------#
+        end
+      end
+    end
+  end
+end