Class: Pod::AggregateTarget

Inherits:
Target
  • Object
show all
Defined in:
lib/cocoapods/target/aggregate_target.rb

Overview

Stores the information relative to the target used to cluster the targets of the single Pods. The client targets will then depend on this one.

Constant Summary collapse

EMBED_FRAMEWORKS_IN_HOST_TARGET_TYPES =

Product types where the product's frameworks must be embedded in a host target

[:app_extension, :framework, :static_library, :messages_extension, :watch_extension, :xpc_service].freeze

Constants inherited from Target

Target::DEFAULT_BUILD_CONFIGURATIONS, Target::DEFAULT_NAME, Target::DEFAULT_VERSION

Instance Attribute Summary collapse

Attributes inherited from Target

#archs, #host_requires_frameworks, #platform, #sandbox, #user_build_configurations

Support files collapse

Instance Method Summary collapse

Methods inherited from Target

#bridge_support_path, #dummy_source_path, #framework_name, #info_plist_path, #inspect, #module_map_path, #module_map_path_to_write, #name, #product_basename, #product_module_name, #product_name, #product_type, #requires_frameworks?, #static_framework?, #static_library_name, #support_files_dir, #umbrella_header_path, #umbrella_header_path_to_write, #version, #xcconfig_path

Constructor Details

#initialize(sandbox, host_requires_frameworks, user_build_configurations, archs, platform, target_definition, client_root, user_project, user_target_uuids, pod_targets_for_build_configuration) ⇒ AggregateTarget

Initialize a new instance

Parameters:

  • sandbox (Sandbox)

    @see Target#sandbox

  • host_requires_frameworks (Boolean)

    @see Target#host_requires_frameworks

  • user_build_configurations (Hash{String=>Symbol})

    @see Target#user_build_configurations

  • archs (Array<String>)

    @see Target#archs

  • platform (Platform)

    @see #Target#platform

  • target_definition (TargetDefinition)

    @see #target_definition

  • client_root (Pathname)

    @see #client_root

  • user_project (Xcodeproj::Project)

    @see #user_project

  • user_target_uuids (Array<String>)

    @see #user_target_uuids

  • pod_targets_for_build_configuration (Hash{String=>Array<PodTarget>})

    @see #pod_targets_for_build_configuration



68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/cocoapods/target/aggregate_target.rb', line 68

def initialize(sandbox, host_requires_frameworks, user_build_configurations, archs, platform, target_definition,
               client_root, user_project, user_target_uuids, pod_targets_for_build_configuration)
  super(sandbox, host_requires_frameworks, user_build_configurations, archs, platform)
  raise "Can't initialize an AggregateTarget without a TargetDefinition!" if target_definition.nil?
  raise "Can't initialize an AggregateTarget with an abstract TargetDefinition!" if target_definition.abstract?
  @target_definition = target_definition
  @client_root = client_root
  @user_project = user_project
  @user_target_uuids = user_target_uuids
  @pod_targets_for_build_configuration = pod_targets_for_build_configuration
  @pod_targets = pod_targets_for_build_configuration.values.flatten.uniq
  @search_paths_aggregate_targets = []
  @xcconfigs = {}
end

Instance Attribute Details

#client_rootPathname (readonly)

Returns the folder where the client is stored used for computing the relative paths. If integrating it should be the folder where the user project is stored, otherwise it should be the installation root.

Returns:

  • (Pathname)

    the folder where the client is stored used for computing the relative paths. If integrating it should be the folder where the user project is stored, otherwise it should be the installation root.



22
23
24
# File 'lib/cocoapods/target/aggregate_target.rb', line 22

def client_root
  @client_root
end

#pod_targetsArray<PodTarget> (readonly)

Returns The dependencies for this target.

Returns:

  • (Array<PodTarget>)

    The dependencies for this target.



48
49
50
# File 'lib/cocoapods/target/aggregate_target.rb', line 48

def pod_targets
  @pod_targets
end

#search_paths_aggregate_targetsArray<AggregateTarget> (readonly)

Returns The aggregate targets whose pods this target must be able to import, but will not directly link against.

Returns:

  • (Array<AggregateTarget>)

    The aggregate targets whose pods this target must be able to import, but will not directly link against.



53
54
55
# File 'lib/cocoapods/target/aggregate_target.rb', line 53

def search_paths_aggregate_targets
  @search_paths_aggregate_targets
end

#target_definitionTargetDefinition (readonly)

Returns the target definition of the Podfile that generated this target.

Returns:

  • (TargetDefinition)

    the target definition of the Podfile that generated this target.



15
16
17
# File 'lib/cocoapods/target/aggregate_target.rb', line 15

def target_definition
  @target_definition
end

#user_projectXcodeproj::Project (readonly)

Returns the user project that this target will integrate as identified by the analyzer.

Returns:

  • (Xcodeproj::Project)

    the user project that this target will integrate as identified by the analyzer.



27
28
29
# File 'lib/cocoapods/target/aggregate_target.rb', line 27

def user_project
  @user_project
end

#user_target_uuidsArray<String> (readonly)

Note:

The target instances are not stored to prevent editing different instances.

Returns the list of the UUIDs of the user targets that will be integrated by this target as identified by the analyzer.

Returns:

  • (Array<String>)

    the list of the UUIDs of the user targets that will be integrated by this target as identified by the analyzer.



35
36
37
# File 'lib/cocoapods/target/aggregate_target.rb', line 35

def user_target_uuids
  @user_target_uuids
end

#xcconfigsHash<String, Xcodeproj::Config> (readonly)

Note:

The configurations are generated by the TargetInstaller and used by UserProjectIntegrator to check for any overridden values.

Returns Map from configuration name to configuration file for the target

Returns:

  • (Hash<String, Xcodeproj::Config>)

    Map from configuration name to configuration file for the target



44
45
46
# File 'lib/cocoapods/target/aggregate_target.rb', line 44

def xcconfigs
  @xcconfigs
end

Instance Method Details

#acknowledgements_basepathPathname

Note:

The acknowledgements generators add the extension according to the file type.

Returns The absolute path of acknowledgements file.

Returns:

  • (Pathname)

    The absolute path of acknowledgements file.



279
280
281
# File 'lib/cocoapods/target/aggregate_target.rb', line 279

def acknowledgements_basepath
  support_files_dir + "#{label}-acknowledgements"
end

#bridge_support_filePathname

Returns the path of the bridge support file relative to the sandbox or `nil` if bridge support is disabled.

Returns:

  • (Pathname)

    the path of the bridge support file relative to the sandbox or `nil` if bridge support is disabled.



266
267
268
# File 'lib/cocoapods/target/aggregate_target.rb', line 266

def bridge_support_file
  bridge_support_path.relative_path_from(sandbox.root) if podfile.generate_bridge_support?
end

#build_settings(configuration_name = nil) ⇒ Object



101
102
103
104
105
106
107
108
109
# File 'lib/cocoapods/target/aggregate_target.rb', line 101

def build_settings(configuration_name = nil)
  if configuration_name
    @build_settings[configuration_name] ||
      raise(ArgumentError, "#{self} does not contain a build setting for the #{configuration_name.inspect} configuration, only #{@build_settings.keys.inspect}")
  else
    @build_settings.each_value.first ||
      raise(ArgumentError, "#{self} does not contain any build settings")
  end
end

#check_manifest_lock_script_output_file_pathString

Returns The output file path fo the check manifest lock script.

Returns:

  • (String)

    The output file path fo the check manifest lock script.



297
298
299
# File 'lib/cocoapods/target/aggregate_target.rb', line 297

def check_manifest_lock_script_output_file_path
  "$(DERIVED_FILE_DIR)/#{label}-checkManifestLockResult.txt"
end

#copy_resources_script_pathPathname

Returns The absolute path of the copy resources script.

Returns:

  • (Pathname)

    The absolute path of the copy resources script.



285
286
287
# File 'lib/cocoapods/target/aggregate_target.rb', line 285

def copy_resources_script_path
  support_files_dir + "#{label}-resources.sh"
end

#copy_resources_script_relative_pathString

Returns The path of the copy resources script relative to the root of the Pods project.

Returns:

  • (String)

    The path of the copy resources script relative to the root of the Pods project.



335
336
337
# File 'lib/cocoapods/target/aggregate_target.rb', line 335

def copy_resources_script_relative_path
  "${PODS_ROOT}/#{relative_to_pods_root(copy_resources_script_path)}"
end

#embed_frameworks_script_pathPathname

Returns The absolute path of the embed frameworks script.

Returns:

  • (Pathname)

    The absolute path of the embed frameworks script.



291
292
293
# File 'lib/cocoapods/target/aggregate_target.rb', line 291

def embed_frameworks_script_path
  support_files_dir + "#{label}-frameworks.sh"
end

#embed_frameworks_script_relative_pathString

Returns The path of the embed frameworks relative to the root of the Pods project.

Returns:

  • (String)

    The path of the embed frameworks relative to the root of the Pods project.



342
343
344
# File 'lib/cocoapods/target/aggregate_target.rb', line 342

def embed_frameworks_script_relative_path
  "${PODS_ROOT}/#{relative_to_pods_root(embed_frameworks_script_path)}"
end

#framework_paths_by_configHash{String => Array<FrameworkPaths>}

Returns The vendored dynamic artifacts and framework target input and output paths grouped by config

Returns:

  • (Hash{String => Array<FrameworkPaths>})

    The vendored dynamic artifacts and framework target input and output paths grouped by config



230
231
232
233
234
235
236
237
238
239
240
241
242
# File 'lib/cocoapods/target/aggregate_target.rb', line 230

def framework_paths_by_config
  @framework_paths_by_config ||= begin
    framework_paths_by_config = {}
    user_build_configurations.keys.each do |config|
      relevant_pod_targets = pod_targets_for_build_configuration(config)
      framework_paths_by_config[config] = relevant_pod_targets.flat_map do |pod_target|
        non_test_specs = pod_target.non_test_specs.map(&:name)
        pod_target.framework_paths.values_at(*non_test_specs).flatten.compact.uniq
      end
    end
    framework_paths_by_config
  end
end

#includes_frameworks?Boolean

Returns Whether the target contains framework to be embedded into the user target

Returns:

  • (Boolean)

    Whether the target contains framework to be embedded into the user target



223
224
225
# File 'lib/cocoapods/target/aggregate_target.rb', line 223

def includes_frameworks?
  !framework_paths_by_config.values.all?(&:empty?)
end

#includes_resources?Boolean

Returns Whether the target contains any resources

Returns:

  • (Boolean)

    Whether the target contains any resources



216
217
218
# File 'lib/cocoapods/target/aggregate_target.rb', line 216

def includes_resources?
  !resource_paths_by_config.values.all?(&:empty?)
end

#labelString

Returns the label for the target.

Returns:

  • (String)

    the label for the target.



141
142
143
# File 'lib/cocoapods/target/aggregate_target.rb', line 141

def label
  target_definition.label.to_s
end

#library?Boolean

Returns True if the user_target refers to a library (framework, static or dynamic lib).

Returns:

  • (Boolean)

    True if the user_target refers to a library (framework, static or dynamic lib).

Raises:

  • (ArgumentError)


114
115
116
117
118
119
120
121
# File 'lib/cocoapods/target/aggregate_target.rb', line 114

def library?
  # Without a user_project, we can't say for sure
  # that this is a library
  return false if user_project.nil?
  symbol_types = user_targets.map(&:symbol_type).uniq
  raise ArgumentError, "Expected single kind of user_target for #{name}. Found #{symbol_types.join(', ')}." unless symbol_types.count == 1
  [:framework, :dynamic_library, :static_library].include? symbol_types.first
end

#merge_embedded_pod_targets(embedded_pod_targets_for_build_configuration) ⇒ AggregateTarget

Merges this aggregate target with additional pod targets that are part of embedded aggregate targets.

Parameters:

  • embedded_pod_targets_for_build_configuration (Hash{String=>Array<PodTarget>})

    The pod targets to merge with.

Returns:

  • (AggregateTarget)

    a new instance of this aggregate target with additional pod targets to be used from pod targets of embedded aggregate targets.



91
92
93
94
95
96
97
98
99
# File 'lib/cocoapods/target/aggregate_target.rb', line 91

def merge_embedded_pod_targets(embedded_pod_targets_for_build_configuration)
  merged = @pod_targets_for_build_configuration.merge(embedded_pod_targets_for_build_configuration) do |_, before, after|
    (before + after).uniq
  end
  AggregateTarget.new(sandbox, host_requires_frameworks, user_build_configurations, archs, platform,
                      target_definition, client_root, user_project, user_target_uuids, merged).tap do |aggregate_target|
    aggregate_target.search_paths_aggregate_targets.concat(search_paths_aggregate_targets).freeze
  end
end

#pod_targets_for_build_configuration(build_configuration) ⇒ Array<PodTarget>

Returns the pod targets for the given build configuration.

Parameters:

  • build_configuration (String)

    The build configuration for which the the pod targets should be returned.

Returns:

  • (Array<PodTarget>)

    the pod targets for the given build configuration.



180
181
182
# File 'lib/cocoapods/target/aggregate_target.rb', line 180

def pod_targets_for_build_configuration(build_configuration)
  @pod_targets_for_build_configuration[build_configuration] || []
end

#podfilePodfile

Returns The podfile which declares the dependency

Returns:

  • (Podfile)

    The podfile which declares the dependency



147
148
149
# File 'lib/cocoapods/target/aggregate_target.rb', line 147

def podfile
  target_definition.podfile
end

#podfile_dir_relative_pathString

Returns The path of the Podfile directory relative to the root of the user project.

Returns:

  • (String)

    The path of the Podfile directory relative to the root of the user project.



317
318
319
320
321
322
# File 'lib/cocoapods/target/aggregate_target.rb', line 317

def podfile_dir_relative_path
  podfile_path = target_definition.podfile.defined_in_file
  return "${SRCROOT}/#{podfile_path.relative_path_from(client_root).dirname}" unless podfile_path.nil?
  # Fallback to the standard path if the Podfile is not represented by a file.
  '${PODS_ROOT}/..'
end

#relative_pods_rootString

Returns The xcconfig path of the root from the `$(SRCROOT)` variable of the user's project.

Returns:

  • (String)

    The xcconfig path of the root from the `$(SRCROOT)` variable of the user's project.



310
311
312
# File 'lib/cocoapods/target/aggregate_target.rb', line 310

def relative_pods_root
  "${SRCROOT}/#{relative_pods_root_path}"
end

#relative_pods_root_pathPathname

Returns The relative path of the Pods directory from user project's directory.

Returns:

  • (Pathname)

    The relative path of the Pods directory from user project's directory.



303
304
305
# File 'lib/cocoapods/target/aggregate_target.rb', line 303

def relative_pods_root_path
  sandbox.root.relative_path_from(client_root)
end

#requires_host_target?Boolean

Returns True if the user_target's pods are for an extension and must be embedded in a host, target, otherwise false.

Returns:

  • (Boolean)

    True if the user_target's pods are for an extension and must be embedded in a host, target, otherwise false.

Raises:

  • (ArgumentError)


127
128
129
130
131
132
133
134
135
136
137
# File 'lib/cocoapods/target/aggregate_target.rb', line 127

def requires_host_target?
  # If we don't have a user_project, then we can't
  # glean any info about how this target is going to
  # be integrated, so return false since we can't know
  # for sure that this target refers to an extension
  # target that would require a host target
  return false if user_project.nil?
  symbol_types = user_targets.map(&:symbol_type).uniq
  raise ArgumentError, "Expected single kind of user_target for #{name}. Found #{symbol_types.join(', ')}." unless symbol_types.count == 1
  EMBED_FRAMEWORKS_IN_HOST_TARGET_TYPES.include?(symbol_types[0])
end

#resource_paths_by_configHash{String => Array<String>}

Returns Uniqued Resources grouped by config

Returns:

  • (Hash{String => Array<String>})

    Uniqued Resources grouped by config



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/cocoapods/target/aggregate_target.rb', line 246

def resource_paths_by_config
  @resource_paths_by_config ||= begin
    relevant_pod_targets = pod_targets.reject do |pod_target|
      pod_target.should_build? && pod_target.requires_frameworks? && !pod_target.static_framework?
    end
    user_build_configurations.keys.each_with_object({}) do |config, resources_by_config|
      targets = relevant_pod_targets & pod_targets_for_build_configuration(config)
      resources_by_config[config] = targets.flat_map do |pod_target|
        non_test_specs = pod_target.non_test_specs.map(&:name)
        resource_paths = pod_target.resource_paths.values_at(*non_test_specs).flatten
        resource_paths << bridge_support_file
        resource_paths.compact.uniq
      end
    end
  end
end

#spec_consumersArray<Specification::Consumer>

Returns The consumers of the Pod.

Returns:

  • (Array<Specification::Consumer>)

    The consumers of the Pod.



204
205
206
# File 'lib/cocoapods/target/aggregate_target.rb', line 204

def spec_consumers
  specs.map { |spec| spec.consumer(platform) }
end

#specsArray<Specification>

Returns The specifications used by this aggregate target.

Returns:

  • (Array<Specification>)

    The specifications used by this aggregate target.



186
187
188
# File 'lib/cocoapods/target/aggregate_target.rb', line 186

def specs
  pod_targets.flat_map(&:specs)
end

#specs_by_build_configurationHash{Symbol => Array<Specification>}

Returns The pod targets for each build configuration.

Returns:

  • (Hash{Symbol => Array<Specification>})

    The pod targets for each build configuration.



193
194
195
196
197
198
199
200
# File 'lib/cocoapods/target/aggregate_target.rb', line 193

def specs_by_build_configuration
  result = {}
  user_build_configurations.keys.each do |build_configuration|
    result[build_configuration] = pod_targets_for_build_configuration(build_configuration).
      flat_map(&:specs)
  end
  result
end

#user_project_pathPathname

Returns the path of the user project that this target will integrate as identified by the analyzer.

Returns:

  • (Pathname)

    the path of the user project that this target will integrate as identified by the analyzer.



154
155
156
# File 'lib/cocoapods/target/aggregate_target.rb', line 154

def user_project_path
  user_project.path if user_project
end

#user_targetsArray<PBXNativeTarget>

List all user targets that will be integrated by this #target.

Returns:

  • (Array<PBXNativeTarget>)


162
163
164
165
166
167
168
169
170
171
172
# File 'lib/cocoapods/target/aggregate_target.rb', line 162

def user_targets
  return [] unless user_project
  user_target_uuids.map do |uuid|
    native_target = user_project.objects_by_uuid[uuid]
    unless native_target
      raise Informative, '[Bug] Unable to find the target with ' \
        "the `#{uuid}` UUID for the `#{self}` integration library"
    end
    native_target
  end
end

#uses_swift?Boolean

Returns Whether the target uses Swift code

Returns:

  • (Boolean)

    Whether the target uses Swift code



210
211
212
# File 'lib/cocoapods/target/aggregate_target.rb', line 210

def uses_swift?
  pod_targets.any?(&:uses_swift?)
end

#xcconfig_relative_path(config_name) ⇒ String

Returns The path of the xcconfig file relative to the root of the user project.

Parameters:

  • config_name (String)

    The build configuration name to get the xcconfig for

Returns:

  • (String)

    The path of the xcconfig file relative to the root of the user project.



328
329
330
# File 'lib/cocoapods/target/aggregate_target.rb', line 328

def xcconfig_relative_path(config_name)
  xcconfig_path(config_name).relative_path_from(client_root).to_s
end