class Pod::DyInstaller::Analyzer

Analyzes the Podfile, the Lockfile, and the sandbox manifest to generate the information relative to a CocoaPods installation.

Attributes

allow_pre_downloads[RW]

@return [Bool] Whether the analysis allows pre-downloads and thus

modifications to the sandbox.

@note This flag should not be used in installations.

@note This is used by the `pod outdated` command to prevent

modification of the sandbox in the resolution process.
allow_pre_downloads?[RW]

@return [Bool] Whether the analysis allows pre-downloads and thus

modifications to the sandbox.

@note This flag should not be used in installations.

@note This is used by the `pod outdated` command to prevent

modification of the sandbox in the resolution process.
has_dependencies[RW]

@return [Bool] Whether the analysis has dependencies and thus

sources must be configured.

@note This is used by the `pod lib lint` command to prevent

update of specs when not needed.
has_dependencies?[RW]

@return [Bool] Whether the analysis has dependencies and thus

sources must be configured.

@note This is used by the `pod lib lint` command to prevent

update of specs when not needed.
locked_dependencies[R]

@return [Molinillo::DependencyGraph<Dependency>] the dependencies

generated by the lockfile that prevent the resolver to update a
Pod.
lockfile[R]

@return [Lockfile] The Lockfile that stores the information about the

Pods previously installed on any machine.
plugin_sources[R]

@return [Array<Source>] Sources provided by plugins

podfile[R]

@return [Podfile] The Podfile specification that contains the

information of the Pods that should be installed.
result[RW]
sandbox[R]

@return [Sandbox] The sandbox where the Pods should be installed.

specs_updated[RW]

@return [Bool] Whether the analysis has updated sources repositories.

specs_updated?[RW]

@return [Bool] Whether the analysis has updated sources repositories.

update[RW]

@return [Hash, Boolean, nil] Pods that have been requested to be

updated or true if all Pods should be updated

Public Class Methods

new(sandbox, podfile, lockfile = nil, plugin_sources = nil) click to toggle source

Initialize a new instance

@param [Sandbox] sandbox @see sandbox @param [Podfile] podfile @see podfile @param [Lockfile] lockfile @see lockfile @param [Array<Source>] plugin_sources @see plugin_sources

# File lib/pod/installer/analyzer.rb, line 49
def initialize(sandbox, podfile, lockfile = nil, plugin_sources = nil)
  @sandbox  = sandbox
  @podfile  = podfile
  @lockfile = lockfile
  @plugin_sources = plugin_sources

  @update = false
  @allow_pre_downloads = true
  @has_dependencies = true
  @test_pod_target_analyzer_cache = {}
  @test_pod_target_key = Struct.new(:name, :pod_targets)
  @podfile_dependency_cache = PodfileDependencyCache.from_podfile(podfile)
end

Public Instance Methods

analyze(allow_fetches = true) click to toggle source

Performs the analysis.

The Podfile and the Lockfile provide the information necessary to compute which specification should be installed. The manifest of the sandbox returns which specifications are installed.

@param [Bool] allow_fetches

whether external sources may be fetched

@return [AnalysisResult]

# File lib/pod/installer/analyzer.rb, line 74
def analyze(allow_fetches = true)
  validate_podfile!
  validate_lockfile_version!
  @result = AnalysisResult.new
  @result.podfile_dependency_cache = @podfile_dependency_cache
  if installation_options.integrate_targets?
    @result.target_inspections = inspect_targets_to_integrate
  else
    verify_platforms_specified!
  end
  @result.podfile_state = generate_podfile_state

  store_existing_checkout_options
  fetch_external_sources if allow_fetches

  @locked_dependencies = generate_version_locking_dependencies
  resolver_specs_by_target = resolve_dependencies
  validate_platforms(resolver_specs_by_target)
  @result.specifications  = generate_specifications(resolver_specs_by_target)
  @result.targets         = generate_targets(resolver_specs_by_target)
  @result.sandbox_state   = generate_sandbox_state
  @result.specs_by_target = resolver_specs_by_target.each_with_object({}) do |rspecs_by_target, hash|
    hash[rspecs_by_target[0]] = rspecs_by_target[1].map(&:spec)
  end
  @result.specs_by_source = Hash[resolver_specs_by_target.values.flatten(1).group_by(&:source).map { |source, specs| [source, specs.map(&:spec).uniq] }]
  sources.each { |s| @result.specs_by_source[s] ||= [] }
  @result
end
needs_install?() click to toggle source

@return [Bool] Whether an installation should be performed or this

CocoaPods project is already up to date.
# File lib/pod/installer/analyzer.rb, line 108
def needs_install?
  analysis_result = analyze(false)
  podfile_needs_install?(analysis_result) || sandbox_needs_install?(analysis_result)
end
podfile_needs_install?(analysis_result) click to toggle source

@param [AnalysisResult] analysis_result

the analysis result to check for changes

@return [Bool] Whether the podfile has changes respect to the lockfile.

# File lib/pod/installer/analyzer.rb, line 118
def podfile_needs_install?(analysis_result)
  state = analysis_result.podfile_state
  needing_install = state.added + state.changed + state.deleted
  !needing_install.empty?
end
sandbox_needs_install?(analysis_result) click to toggle source

@param [AnalysisResult] analysis_result

the analysis result to check for changes

@return [Bool] Whether the sandbox is in synch with the lockfile.

# File lib/pod/installer/analyzer.rb, line 129
def sandbox_needs_install?(analysis_result)
  state = analysis_result.sandbox_state
  needing_install = state.added + state.changed + state.deleted
  !needing_install.empty?
end
sources() click to toggle source

Returns the sources used to query for specifications

When no explicit Podfile sources or plugin sources are defined, this defaults to the master spec repository. available sources ({config.sources_manager.all}).

@return [Array<Source>] the sources to be used in finding

specifications, as specified by the {#podfile} or all sources.
# File lib/pod/installer/analyzer.rb, line 857
def sources
  @sources ||= begin
    sources = podfile.sources
    plugin_sources = @plugin_sources || []

    # Add any sources specified using the :source flag on individual dependencies.
    dependency_sources = @podfile_dependency_cache.podfile_dependencies.map(&:podspec_repo).compact
    all_dependencies_have_sources = dependency_sources.count == @podfile_dependency_cache.podfile_dependencies.count

    if all_dependencies_have_sources
      sources = dependency_sources
    elsif has_dependencies? && sources.empty? && plugin_sources.empty?
      sources = ['https://github.com/CocoaPods/Specs.git']
    else
      sources += dependency_sources
    end

    result = sources.uniq.map do |source_url|
      config.sources_manager.find_or_create_source_with_url(source_url)
    end
    unless plugin_sources.empty?
      result.insert(0, *plugin_sources)
    end
    result
  end
end
update_mode() click to toggle source

@return [Symbol] Whether and how the dependencies in the Podfile

should be updated.
# File lib/pod/installer/analyzer.rb, line 154
def update_mode
  if !update
    :none
  elsif update == true
    :all
  elsif !update[:pods].nil?
    :selected
  end
end
update_mode?() click to toggle source

@return [Bool] Whether the version of the dependencies which did not

change in the Podfile should be locked.
# File lib/pod/installer/analyzer.rb, line 147
def update_mode?
  update != nil
end
update_repositories() click to toggle source

Updates the git source repositories.

# File lib/pod/installer/analyzer.rb, line 251
def update_repositories
  sources.each do |source|
    if source.git?
      config.sources_manager.update(source.name, true)
    else
      UI.message "Skipping `#{source.name}` update because the repository is not a git source repository."
    end
  end
  @specs_updated = true
end

Private Instance Methods

analyze_host_targets_in_podfile(aggregate_targets, embedded_aggregate_targets) click to toggle source

Raises an error if there are embedded targets in the Podfile, but their host targets have not been declared in the Podfile. As it finds host targets, it collection information on host target types.

@param [Array<AggregateTarget>] aggregate_targets the generated

aggregate targets

@param [Array<AggregateTarget>] embedded_aggregate_targets the aggregate targets

representing the embedded targets to be integrated
# File lib/pod/installer/analyzer.rb, line 312
def analyze_host_targets_in_podfile(aggregate_targets, embedded_aggregate_targets)
  target_definitions_by_uuid = {}
  # Collect aggregate target definitions by uuid to later lookup host target
  # definitions and verify their compatiblity with their embedded targets
  aggregate_targets.each do |target|
    target.user_targets.map(&:uuid).each do |uuid|
      target_definitions_by_uuid[uuid] = target.target_definition
    end
  end
  aggregate_target_user_projects = aggregate_targets.map(&:user_project)
  embedded_targets_missing_hosts = []
  host_uuid_to_embedded_target_definitions = {}
  # Search all of the known user projects for each embedded target's hosts
  embedded_aggregate_targets.each do |target|
    host_uuids = []
    aggregate_target_user_projects.product(target.user_targets).each do |user_project, user_target|
      host_uuids += user_project.host_targets_for_embedded_target(user_target).map(&:uuid)
    end
    # For each host, keep track of its embedded target definitions
    # to later verify each embedded target's compatiblity with its host,
    # ignoring the hosts that aren't known to CocoaPods (no target
    # definitions in the Podfile)
    host_uuids.each do |uuid|
      (host_uuid_to_embedded_target_definitions[uuid] ||= []) << target.target_definition if target_definitions_by_uuid.key? uuid
    end
    # If none of the hosts are known to CocoaPods (no target definitions
    # in the Podfile), add it to the list of targets missing hosts
    embedded_targets_missing_hosts << target unless host_uuids.any? do |uuid|
      target_definitions_by_uuid.key? uuid
    end
  end

  unless embedded_targets_missing_hosts.empty?
    embedded_targets_missing_hosts_product_types = Set.new embedded_targets_missing_hosts.flat_map(&:user_targets).map(&:symbol_type)
    target_names = embedded_targets_missing_hosts.map do |target|
      target.name.sub('Pods-', '') # Make the target names more recognizable to the user
    end.join ', '
    #  If the targets missing hosts are only frameworks, then this is likely
    #  a project for doing framework development. In that case, just warn that
    #  the frameworks that these targets depend on won't be integrated anywhere
    if embedded_targets_missing_hosts_product_types.subset?(Set.new([:framework, :static_library]))
      UI.warn "The Podfile contains framework or static library targets (#{target_names}), for which the Podfile does not contain host targets (targets which embed the framework)." \
        "\n" \
        'If this project is for doing framework development, you can ignore this message. Otherwise, add a target to the Podfile that embeds these frameworks to make this message go away (e.g. a test target).'
    else
      raise Informative, "Unable to find host target(s) for #{target_names}. Please add the host targets for the embedded targets to the Podfile." \
                          "\n" \
                          'Certain kinds of targets require a host target. A host target is a "parent" target which embeds a "child" target. These are example types of targets that need a host target:' \
                          "\n- Framework" \
                          "\n- App Extension" \
                          "\n- Watch OS 1 Extension" \
                          "\n- Messages Extension (except when used with a Messages Application)"
    end
  end

  target_mismatches = []
  host_uuid_to_embedded_target_definitions.each do |uuid, target_definitions|
    host_target_definition = target_definitions_by_uuid[uuid]
    target_definitions.each do |target_definition|
      unless host_target_definition.uses_frameworks? == target_definition.uses_frameworks?
        target_mismatches << "- #{host_target_definition.name} (#{host_target_definition.uses_frameworks?}) and #{target_definition.name} (#{target_definition.uses_frameworks?}) do not both set use_frameworks!."
      end
    end
  end

  unless target_mismatches.empty?
    heading = 'Unable to integrate the following embedded targets with their respective host targets (a host target is a "parent" target which embeds a "child" target like a framework or extension):'
    raise Informative, heading + "\n\n" + target_mismatches.sort.uniq.join("\n")
  end
end
checkout_requires_update?(dependency) click to toggle source
# File lib/pod/installer/analyzer.rb, line 723
def checkout_requires_update?(dependency)
  return true unless lockfile && sandbox.manifest
  locked_checkout_options = lockfile.checkout_options_for_pod_named(dependency.root_name)
  sandbox_checkout_options = sandbox.manifest.checkout_options_for_pod_named(dependency.root_name)
  locked_checkout_options != sandbox_checkout_options
end
copy_embedded_target_pod_targets_to_host(aggregate_target, embedded_aggregate_targets, libraries_only) click to toggle source

Copies the pod_targets of any of the app embedded aggregate targets into their potential host aggregate target, if that potential host aggregate target's user_target hosts any of the app embedded aggregate targets' user_targets

@param [AggregateTarget] aggregate_target the aggregate target whose user_target

might host one or more of the embedded aggregate targets' user_targets

@param [Array<AggregateTarget>] embedded_aggregate_targets the aggregate targets

representing the embedded targets to be integrated

@param [Boolean] libraries_only if true, only library-type embedded

targets are considered, otherwise, all other types are have
their pods copied to their host targets as well (extensions, etc.)
# File lib/pod/installer/analyzer.rb, line 278
def copy_embedded_target_pod_targets_to_host(aggregate_target, embedded_aggregate_targets, libraries_only)
  return if aggregate_target.requires_host_target?
  pod_target_names = Set.new(aggregate_target.pod_targets.map(&:name))
  aggregate_user_target_uuids = Set.new(aggregate_target.user_targets.map(&:uuid))
  embedded_aggregate_targets.each do |embedded_aggregate_target|
    # Skip non libraries in library-only mode
    next if libraries_only && !embedded_aggregate_target.library?
    next unless embedded_aggregate_target.user_targets.any? do |embedded_user_target|
      # You have to ask the host target's project for the host targets of
      # the embedded target, as opposed to asking user_project for the
      # embedded targets of the host target. The latter doesn't work when
      # the embedded target lives in a sub-project. The lines below get
      # the host target uuids for the embedded target and checks to see if
      # those match to any of the user_target uuids in the aggregate_target.
      host_target_uuids = Set.new(aggregate_target.user_project.host_targets_for_embedded_target(embedded_user_target).map(&:uuid))
      !aggregate_user_target_uuids.intersection(host_target_uuids).empty?
    end
    # This embedded target is hosted by the aggregate target's user_target; copy over the non-duplicate pod_targets
    aggregate_target.pod_targets = aggregate_target.pod_targets + embedded_aggregate_target.pod_targets.select do |pod_target|
      !pod_target_names.include? pod_target.name
    end
  end
end
dependencies_to_fetch() click to toggle source
# File lib/pod/installer/analyzer.rb, line 702
def dependencies_to_fetch
  @deps_to_fetch ||= begin
    deps_to_fetch = []
    deps_with_external_source = @podfile_dependency_cache.podfile_dependencies.select(&:external_source)

    if update_mode == :all
      deps_to_fetch = deps_with_external_source
    else
      deps_to_fetch = deps_with_external_source.select { |dep| pods_to_fetch.include?(dep.root_name) }
      deps_to_fetch_if_needed = deps_with_external_source.select { |dep| result.podfile_state.unchanged.include?(dep.root_name) }
      deps_to_fetch += deps_to_fetch_if_needed.select do |dep|
        sandbox.specification(dep.root_name).nil? ||
          !dep.external_source[:path].nil? ||
          !sandbox.pod_dir(dep.root_name).directory? ||
          checkout_requires_update?(dep)
      end
    end
    deps_to_fetch.uniq(&:root_name)
  end
end
fetch_external_source(dependency, use_lockfile_options) click to toggle source
# File lib/pod/installer/analyzer.rb, line 691
def fetch_external_source(dependency, use_lockfile_options)
  checkout_options = lockfile.checkout_options_for_pod_named(dependency.root_name) if lockfile
  source = if checkout_options && use_lockfile_options
             ExternalSources.from_params(checkout_options, dependency, podfile.defined_in_file)
           else
             ExternalSources.from_dependency(dependency, podfile.defined_in_file)
  end
  source.can_cache = installation_options.clean?
  source.fetch(sandbox)
end
fetch_external_sources() click to toggle source

Fetches the podspecs of external sources if modifications to the sandbox are allowed.

@note In update mode all the external sources are refreshed while in

normal mode they are refreshed only if added or changed in the
Podfile. Moreover, in normal specifications for unchanged Pods
which are missing or are generated from an local source are
fetched as well.

@note It is possible to perform this step before the resolution

process because external sources identify a single specific
version (checkout). If the other dependencies are not
compatible with the version reported by the podspec of the
external source the resolver will raise.

@return [void]

TODO: Specs

# File lib/pod/installer/analyzer.rb, line 668
def fetch_external_sources
  return unless allow_pre_downloads?

  verify_no_pods_with_different_sources!
  unless dependencies_to_fetch.empty?
    UI.section 'Fetching external sources' do
      dependencies_to_fetch.sort.each do |dependency|
        fetch_external_source(dependency, !pods_to_fetch.include?(dependency.root_name))
      end
    end
  end
end
filter_dependencies(dependencies, pod_targets_by_name, target) click to toggle source
# File lib/pod/installer/analyzer.rb, line 546
def filter_dependencies(dependencies, pod_targets_by_name, target)
  dependencies.map do |root_spec, deps|
    pod_targets_by_name[root_spec.name].find do |t|
      next false if t.platform.symbolic_name != target.platform.symbolic_name ||
          t.requires_frameworks? != target.requires_frameworks?
      spec_names = t.specs.map(&:name)
      deps.all? { |dep| spec_names.include?(dep.name) }
    end
  end
end
filter_pod_targets_for_target_definition(target_definition, pod_targets, resolver_specs_by_target) click to toggle source

Returns a filtered list of pod targets that should or should not be part of the target definition. Pod targets used by tests only are filtered.

@param [TargetDefinition] target_definition

the target definition to use as the base for filtering

@param [Array<PodTarget>] pod_targets

the array of pod targets to check against

@param [Hash{Podfile::TargetDefinition => Array<ResolvedSpecification>}] resolver_specs_by_target

the resolved specifications grouped by target.

@return [Array<PodTarget>] the filtered list of pod targets.

# File lib/pod/installer/analyzer.rb, line 474
def filter_pod_targets_for_target_definition(target_definition, pod_targets, resolver_specs_by_target)
  pod_targets.select do |pod_target|
    included_in_target_definition = pod_target.target_definitions.include?(target_definition)
    used_by_tests_only = resolver_specs_by_target[target_definition].select { |resolver_spec| pod_target.specs.include?(resolver_spec.spec) }.all?(&:used_by_tests_only?)
    included_in_target_definition && !used_by_tests_only
  end
end
generate_pod_target(target_definitions, pod_specs, scope_suffix: nil) click to toggle source

Create a target for each spec group

@param [TargetDefinitions] target_definitions

the aggregate target

@param [Array<Specification>] pod_specs

the specifications of an equal root.

@param [String] scope_suffix

@see PodTarget#scope_suffix

@return [PodTarget]

# File lib/pod/installer/analyzer.rb, line 606
def generate_pod_target(target_definitions, pod_specs, scope_suffix: nil)
  pod_target = PodTarget.new(pod_specs, target_definitions, sandbox, scope_suffix)
  pod_target.host_requires_frameworks = target_definitions.any?(&:uses_frameworks?)

  if installation_options.integrate_targets?
    target_inspections = result.target_inspections.select { |t, _| target_definitions.include?(t) }.values
    pod_target.user_build_configurations = target_inspections.map(&:build_configurations).reduce({}, &:merge)
    pod_target.archs = target_inspections.flat_map(&:archs).compact.uniq.sort
  else
    pod_target.user_build_configurations = {}
    if target_definitions.first.platform.name == :osx
      pod_target.archs = '$(ARCHS_STANDARD_64_BIT)'
    end
  end

  pod_target
end
generate_pod_targets(resolver_specs_by_target) click to toggle source

Setup the pod targets for an aggregate target. Deduplicates resulting targets by grouping by platform and subspec by their root to create a {PodTarget} for each spec.

@param [Hash{Podfile::TargetDefinition => Array<ResolvedSpecification>}] resolver_specs_by_target

the resolved specifications grouped by target.

@return [Array<PodTarget>]

# File lib/pod/installer/analyzer.rb, line 491
def generate_pod_targets(resolver_specs_by_target)
  if installation_options.deduplicate_targets?
    distinct_targets = resolver_specs_by_target.each_with_object({}) do |dependency, hash|
      target_definition, dependent_specs = *dependency
      dependent_specs.group_by(&:root).each do |root_spec, resolver_specs|
        all_specs = resolver_specs.map(&:spec)
        test_specs, specs = all_specs.partition(&:test_specification?)
        pod_variant = PodVariant.new(specs, test_specs, target_definition.platform, target_definition.uses_frameworks?)
        hash[root_spec] ||= {}
        (hash[root_spec][pod_variant] ||= []) << target_definition
        hash[root_spec].keys.find { |k| k == pod_variant }.test_specs.concat(test_specs).uniq!
      end
    end

    pod_targets = distinct_targets.flat_map do |_root, target_definitions_by_variant|
      suffixes = PodVariantSet.new(target_definitions_by_variant.keys).scope_suffixes
      target_definitions_by_variant.flat_map do |variant, target_definitions|
        generate_pod_target(target_definitions, variant.specs + variant.test_specs, :scope_suffix => suffixes[variant])
      end
    end

    all_resolver_specs = resolver_specs_by_target.values.flatten.map(&:spec).uniq
    pod_targets_by_name = pod_targets.group_by(&:pod_name).each_with_object({}) do |(name, values), hash|
      # Sort the target by the number of activated subspecs, so that
      # we prefer a minimal target as transitive dependency.
      hash[name] = values.sort_by { |pt| pt.specs.count }
    end
    pod_targets.each do |target|
      all_specs = all_resolver_specs.to_set
      dependencies = transitive_dependencies_for_specs(target.non_test_specs.to_set, target.platform, all_specs).group_by(&:root)
      test_dependencies = transitive_dependencies_for_specs(target.test_specs.to_set, target.platform, all_specs).group_by(&:root)
      test_dependencies.delete_if { |k| dependencies.key? k }
      target.dependent_targets = filter_dependencies(dependencies, pod_targets_by_name, target)
      target.test_dependent_targets = filter_dependencies(test_dependencies, pod_targets_by_name, target)
    end
  else
    dedupe_cache = {}
    resolver_specs_by_target.flat_map do |target_definition, specs|
      grouped_specs = specs.group_by(&:root).values.uniq
      pod_targets = grouped_specs.flat_map do |pod_specs|
        generate_pod_target([target_definition], pod_specs.map(&:spec)).scoped(dedupe_cache)
      end

      pod_targets.each do |target|
        all_specs = specs.map(&:spec).to_set
        dependencies = transitive_dependencies_for_specs(target.non_test_specs.to_set, target.platform, all_specs).group_by(&:root)
        test_dependencies = transitive_dependencies_for_specs(target.test_specs.to_set, target.platform, all_specs).group_by(&:root)
        test_dependencies.delete_if { |k| dependencies.key? k }
        target.dependent_targets = pod_targets.reject { |t| dependencies[t.root_spec].nil? }
        target.test_dependent_targets = pod_targets.reject { |t| test_dependencies[t.root_spec].nil? }
      end
    end
  end
end
generate_podfile_state() click to toggle source

Compares the {Podfile} with the {Lockfile} in order to detect which dependencies should be locked.

@return [SpecsState] the states of the Podfile specs.

@note As the target definitions share the same sandbox they should have

the same version of a Pod. For this reason this method returns
the name of the Pod (root name of the dependencies) and doesn't
group them by target definition.

@todo [CocoaPods > 0.18] If there isn't a Lockfile all the Pods should

be marked as added.
# File lib/pod/installer/analyzer.rb, line 231
def generate_podfile_state
  if lockfile
    pods_state = nil
    UI.section 'Finding Podfile changes' do
      pods_by_state = lockfile.detect_changes_with_podfile(podfile)
      pods_state = SpecsState.new(pods_by_state)
      pods_state.print
    end
    pods_state
  else
    state = SpecsState.new
    state.added.merge(@podfile_dependency_cache.podfile_dependencies.map(&:root_name))
    state
  end
end
generate_sandbox_state() click to toggle source

Computes the state of the sandbox respect to the resolved specifications.

@return [SpecsState] the representation of the state of the manifest

specifications.
# File lib/pod/installer/analyzer.rb, line 824
def generate_sandbox_state
  sandbox_state = nil
  UI.section 'Comparing resolved specification to the sandbox manifest' do
    sandbox_analyzer = SandboxAnalyzer.new(sandbox, result.specifications, update_mode?, lockfile)
    sandbox_state = sandbox_analyzer.analyze
    sandbox_state.print
  end
  sandbox_state
end
generate_specifications(resolver_specs_by_target) click to toggle source

Returns the list of all the resolved specifications.

@return [Array<Specification>] the list of the specifications.

# File lib/pod/installer/analyzer.rb, line 814
def generate_specifications(resolver_specs_by_target)
  resolver_specs_by_target.values.flatten.map(&:spec).uniq
end
generate_target(target_definition, pod_targets, resolver_specs_by_target) click to toggle source

Setup the aggregate target for a single user target

@param [TargetDefinition] target_definition

the target definition for the user target.

@param [Array<PodTarget>] pod_targets

the pod targets, which were generated.

@param [Hash{Podfile::TargetDefinition => Array<ResolvedSpecification>}] resolver_specs_by_target

the resolved specifications grouped by target.

@return [AggregateTarget]

# File lib/pod/installer/analyzer.rb, line 434
def generate_target(target_definition, pod_targets, resolver_specs_by_target)
  target = AggregateTarget.new(target_definition, sandbox)
  target.host_requires_frameworks |= target_definition.uses_frameworks?

  if installation_options.integrate_targets?
    target_inspection = result.target_inspections[target_definition]
    raise "missing inspection: #{target_definition.name}" unless target_inspection
    target.user_project = target_inspection.project
    target.client_root = target.user_project_path.dirname.realpath
    target.user_target_uuids = target_inspection.project_target_uuids
    target.user_build_configurations = target_inspection.build_configurations
    target.archs = target_inspection.archs
  else
    target.client_root = config.installation_root.realpath
    target.user_target_uuids = []
    target.user_build_configurations = target_definition.build_configurations || { 'Release' => :release, 'Debug' => :debug }
    if target_definition.platform && target_definition.platform.name == :osx
      target.archs = '$(ARCHS_STANDARD_64_BIT)'
    end
  end

  target.pod_targets = filter_pod_targets_for_target_definition(target_definition, pod_targets, resolver_specs_by_target)

  target
end
generate_targets(resolver_specs_by_target) click to toggle source

Creates the models that represent the targets generated by CocoaPods.

@param [Hash{Podfile::TargetDefinition => Array<ResolvedSpecification>}] resolver_specs_by_target

mapping of targets to resolved specs (containing information about test usage)
aggregate targets

@return [Array<AggregateTarget>] the list of aggregate targets generated.

# File lib/pod/installer/analyzer.rb, line 391
def generate_targets(resolver_specs_by_target)
  resolver_specs_by_target = resolver_specs_by_target.reject { |td, _| td.abstract? }
  pod_targets = generate_pod_targets(resolver_specs_by_target)
  aggregate_targets = resolver_specs_by_target.keys.map do |target_definition|
    generate_target(target_definition, pod_targets, resolver_specs_by_target)
  end
  if installation_options.integrate_targets?
    # Copy embedded target pods that cannot have their pods embedded as frameworks to
    # their host targets, and ensure we properly link library pods to their host targets
    embedded_targets = aggregate_targets.select(&:requires_host_target?)
    analyze_host_targets_in_podfile(aggregate_targets, embedded_targets)

    use_frameworks_embedded_targets, non_use_frameworks_embedded_targets = embedded_targets.partition(&:requires_frameworks?)
    aggregate_targets.each do |target|
      # For targets that require frameworks, we always have to copy their pods to their
      # host targets because those frameworks will all be loaded from the host target's bundle
      copy_embedded_target_pod_targets_to_host(target, use_frameworks_embedded_targets, false)

      # For targets that don't require frameworks, we only have to consider library-type
      # targets because their host targets will still need to link their pods
      copy_embedded_target_pod_targets_to_host(target, non_use_frameworks_embedded_targets, true)
    end
  end
  aggregate_targets.each do |target|
    target.search_paths_aggregate_targets.concat(aggregate_targets.select do |aggregate_target|
      target.target_definition.targets_to_inherit_search_paths.include?(aggregate_target.target_definition)
    end).freeze
  end
end
generate_version_locking_dependencies() click to toggle source

Generates dependencies that require the specific version of the Pods that haven't changed in the {Lockfile}.

These dependencies are passed to the {Resolver}, unless the installer is in update mode, to prevent it from upgrading the Pods that weren't changed in the {Podfile}.

@return [Molinillo::DependencyGraph<Dependency>] the dependencies

generated by the lockfile that prevent the resolver to update
a Pod.
# File lib/pod/installer/analyzer.rb, line 635
def generate_version_locking_dependencies
  if update_mode == :all || !lockfile
    LockingDependencyAnalyzer.unlocked_dependency_graph
  else
    pods_to_update = result.podfile_state.changed + result.podfile_state.deleted
    pods_to_update += update[:pods] if update_mode == :selected
    local_pod_names = @podfile_dependency_cache.podfile_dependencies.select(&:local?).map(&:root_name)
    pods_to_unlock = local_pod_names.reject do |pod_name|
      sandbox.specification(pod_name).checksum == lockfile.checksum(pod_name)
    end
    LockingDependencyAnalyzer.generate_version_locking_dependencies(lockfile, pods_to_update, pods_to_unlock)
  end
end
inspect_targets_to_integrate() click to toggle source

Precompute information for each target_definition in the Podfile

@note The platforms are computed and added to each target_definition

because it might be necessary to infer the platform from the
user targets.

@return [Hash{TargetDefinition => TargetInspectionResult}]

# File lib/pod/installer/analyzer.rb, line 912
def inspect_targets_to_integrate
  inspection_result = {}
  UI.section 'Inspecting targets to integrate' do
    inspectors = @podfile_dependency_cache.target_definition_list.map do |target_definition|
      next if target_definition.abstract?
      TargetInspector.new(target_definition, config.installation_root)
    end.compact
    inspectors.group_by(&:compute_project_path).each do |project_path, target_inspectors|
      project = Xcodeproj::Project.open(project_path)
      target_inspectors.each do |inspector|
        target_definition = inspector.target_definition
        results = inspector.compute_results(project)
        inspection_result[target_definition] = results
        UI.message('Using `ARCHS` setting to build architectures of ' \
          "target `#{target_definition.label}`: (`#{results.archs.join('`, `')}`)")
      end
    end
  end
  inspection_result
end
pods_to_fetch() click to toggle source
# File lib/pod/installer/analyzer.rb, line 730
def pods_to_fetch
  @pods_to_fetch ||= begin
    pods_to_fetch = result.podfile_state.added + result.podfile_state.changed
    if update_mode == :selected
      pods_to_fetch += update[:pods]
    elsif update_mode == :all
      pods_to_fetch += result.podfile_state.unchanged + result.podfile_state.deleted
    end
    pods_to_fetch += @podfile_dependency_cache.podfile_dependencies.
      select { |dep| Hash(dep.external_source).key?(:podspec) && sandbox.specification_path(dep.root_name).nil? }.
      map(&:root_name)
    pods_to_fetch
  end
end
resolve_dependencies() click to toggle source

Converts the Podfile in a list of specifications grouped by target.

@note As some dependencies might have external sources the resolver

is aware of the {Sandbox} and interacts with it to download the
podspecs of the external sources. This is necessary because the
resolver needs their specifications to analyze their
dependencies.

@note The specifications of the external sources which are added,

modified or removed need to deleted from the sandbox before the
resolution process. Otherwise the resolver might use an
incorrect specification instead of pre-downloading it.

@note In update mode the resolver is set to always update the specs

from external sources.

@return [Hash{TargetDefinition => Array<Spec>}] the specifications

grouped by target.
# File lib/pod/installer/analyzer.rb, line 772
def resolve_dependencies
  duplicate_dependencies = @podfile_dependency_cache.podfile_dependencies.group_by(&:name).
    select { |_name, dependencies| dependencies.count > 1 }
  duplicate_dependencies.each do |name, dependencies|
    UI.warn "There are duplicate dependencies on `#{name}` in #{UI.path podfile.defined_in_file}:\n\n" \
     "- #{dependencies.map(&:to_s).join("\n- ")}"
  end

  resolver_specs_by_target = nil
  UI.section "Resolving dependencies of #{UI.path(podfile.defined_in_file) || 'Podfile'}" do
    resolver = DyResolver.new(sandbox, podfile, locked_dependencies, sources, specs_updated?)
    resolver_specs_by_target = resolver.resolve
    resolver_specs_by_target.values.flatten(1).map(&:spec).each(&:validate_cocoapods_version)
  end
  resolver_specs_by_target
end
store_existing_checkout_options() click to toggle source
# File lib/pod/installer/analyzer.rb, line 745
def store_existing_checkout_options
  @podfile_dependency_cache.podfile_dependencies.select(&:external_source).each do |dep|
    if checkout_options = lockfile && lockfile.checkout_options_for_pod_named(dep.root_name)
      sandbox.store_checkout_source(dep.root_name, checkout_options)
    end
  end
end
transitive_dependencies_for_specs(specs, platform, all_specs) click to toggle source

Returns the specs upon which the given specs transitively depend.

@note: This is implemented in the analyzer, because we don't have to

care about the requirements after dependency resolution.

@param [Array<Specification>] specs

The specs, whose dependencies should be returned.

@param [Platform] platform

The platform for which the dependencies should be returned.

@param [Array<Specification>] all_specs

All specifications which are installed alongside.

@return [Array<Specification>]

# File lib/pod/installer/analyzer.rb, line 573
def transitive_dependencies_for_specs(specs, platform, all_specs)
  return [] if specs.empty? || all_specs.empty?

  dependent_specs = Set.new
  specs.each do |spec|
    spec.consumer(platform).dependencies.each do |dependency|
      match = all_specs.find do |s|
        next false unless s.name == dependency.name
        next false if specs.include?(s)
        true
      end
      dependent_specs << match if match
    end
  end

  remaining_specs = all_specs - dependent_specs

  dependent_specs.union transitive_dependencies_for_specs(dependent_specs, platform, remaining_specs)
end
validate_lockfile_version!() click to toggle source

@note The warning about the version of the Lockfile doesn't use the

`UI.warn` method because it prints the output only at the end
of the installation. At that time CocoaPods could have crashed.
# File lib/pod/installer/analyzer.rb, line 209
def validate_lockfile_version!
  if lockfile && lockfile.cocoapods_version > Version.new(VERSION)
    STDERR.puts '[!] The version of CocoaPods used to generate ' \
      "the lockfile (#{lockfile.cocoapods_version}) is "\
      "higher than the version of the current executable (#{VERSION}). " \
      'Incompatibility issues may arise.'.yellow
  end
end
validate_platforms(resolver_specs_by_target) click to toggle source

Warns for any specification that is incompatible with its target.

@param [Hash{TargetDefinition => Array<Spec>}] resolver_specs_by_target

the specifications grouped by target.

@return [Hash{TargetDefinition => Array<Spec>}] the specifications

grouped by target.
# File lib/pod/installer/analyzer.rb, line 797
def validate_platforms(resolver_specs_by_target)
  resolver_specs_by_target.each do |target, specs|
    specs.map(&:spec).each do |spec|
      next unless target_platform = target.platform
      unless spec.available_platforms.any? { |p| target_platform.supports?(p) }
        UI.warn "The platform of the target `#{target.name}` "     \
          "(#{target.platform}) may not be compatible with `#{spec}` which has "  \
          "a minimum requirement of #{spec.available_platforms.join(' - ')}."
      end
    end
  end
end
validate_podfile!() click to toggle source
# File lib/pod/installer/analyzer.rb, line 193
def validate_podfile!
  validator = Installer::PodfileValidator.new(podfile, @podfile_dependency_cache)
  validator.validate

  unless validator.valid?
    raise Informative, validator.message
  end
  validator.warnings.uniq.each { |w| UI.warn(w) }
end
verify_no_pods_with_different_sources!() click to toggle source
# File lib/pod/installer/analyzer.rb, line 681
def verify_no_pods_with_different_sources!
  deps_with_different_sources = @podfile_dependency_cache.podfile_dependencies.group_by(&:root_name).
    select { |_root_name, dependencies| dependencies.map(&:external_source).uniq.count > 1 }
  deps_with_different_sources.each do |root_name, dependencies|
    raise Informative, 'There are multiple dependencies with different ' \
    "sources for `#{root_name}` in #{UI.path podfile.defined_in_file}:" \
    "\n\n- #{dependencies.map(&:to_s).join("\n- ")}"
  end
end
verify_platforms_specified!() click to toggle source

Checks whether the platform is specified if not integrating

@return [void]

# File lib/pod/installer/analyzer.rb, line 894
def verify_platforms_specified!
  unless installation_options.integrate_targets?
    @podfile_dependency_cache.target_definition_list.each do |target_definition|
      if !target_definition.empty? && target_definition.platform.nil?
        raise Informative, 'It is necessary to specify the platform in the Podfile if not integrating.'
      end
    end
  end
end