Class: Pod::Installer

Inherits:
Object
  • Object
show all
Includes:
Config::Mixin, InstallationOptions::Mixin
Defined in:
lib/cocoapods/installer.rb,
lib/cocoapods/installer/xcode.rb,
lib/cocoapods/installer/analyzer.rb,
lib/cocoapods/installer/podfile_validator.rb,
lib/cocoapods/installer/pod_source_preparer.rb,
lib/cocoapods/installer/analyzer/pod_variant.rb,
lib/cocoapods/installer/analyzer/specs_state.rb,
lib/cocoapods/installer/installation_options.rb,
lib/cocoapods/installer/pod_source_installer.rb,
lib/cocoapods/installer/xcode/target_validator.rb,
lib/cocoapods/installer/user_project_integrator.rb,
lib/cocoapods/installer/analyzer/analysis_result.rb,
lib/cocoapods/installer/analyzer/pod_variant_set.rb,
lib/cocoapods/installer/analyzer/sandbox_analyzer.rb,
lib/cocoapods/installer/analyzer/target_inspector.rb,
lib/cocoapods/installer/pre_install_hooks_context.rb,
lib/cocoapods/installer/post_install_hooks_context.rb,
lib/cocoapods/installer/xcode/pods_project_generator.rb,
lib/cocoapods/installer/source_provider_hooks_context.rb,
lib/cocoapods/installer/analyzer/podfile_dependency_cache.rb,
lib/cocoapods/installer/analyzer/target_inspection_result.rb,
lib/cocoapods/installer/analyzer/locking_dependency_analyzer.rb,
lib/cocoapods/installer/user_project_integrator/target_integrator.rb,
lib/cocoapods/installer/xcode/pods_project_generator/target_installer.rb,
lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb,
lib/cocoapods/installer/xcode/pods_project_generator/pod_target_installer.rb,
lib/cocoapods/installer/xcode/pods_project_generator/pod_target_integrator.rb,
lib/cocoapods/installer/xcode/pods_project_generator/target_installer_helper.rb,
lib/cocoapods/installer/xcode/pods_project_generator/file_references_installer.rb,
lib/cocoapods/installer/xcode/pods_project_generator/aggregate_target_installer.rb,
lib/cocoapods/installer/xcode/pods_project_generator/target_installation_result.rb,
lib/cocoapods/installer/user_project_integrator/target_integrator/xcconfig_integrator.rb

Overview

The Installer is responsible of taking a Podfile and transform it in the Pods libraries. It also integrates the user project so the Pods libraries can be used out of the box.

The Installer is capable of doing incremental updates to an existing Pod installation.

The Installer gets the information that it needs mainly from 3 files:

- Podfile: The specification written by the user that contains
  information about targets and Pods.
- Podfile.lock: Contains information about the pods that were previously
  installed and in concert with the Podfile provides information about
  which specific version of a Pod should be installed. This file is
  ignored in update mode.
- Manifest.lock: A file contained in the Pods folder that keeps track of
  the pods installed in the local machine. This files is used once the
  exact versions of the Pods has been computed to detect if that version
  is already installed. This file is not intended to be kept under source
  control and is a copy of the Podfile.lock.

The Installer is designed to work in environments where the Podfile folder is under source control and environments where it is not. The rest of the files, like the user project and the workspace are assumed to be under source control.

Defined Under Namespace

Classes: Analyzer, InstallationOptions, PodSourceInstaller, PodSourcePreparer, PodfileValidator, PostInstallHooksContext, PreInstallHooksContext, SourceProviderHooksContext, UserProjectIntegrator, Xcode

Installation results collapse

Instance Attribute Summary collapse

Attributes included from InstallationOptions::Mixin

#installation_options

Hooks collapse

Convenience Methods collapse

Instance Method Summary collapse

Methods included from InstallationOptions::Mixin

included

Methods included from Config::Mixin

#config

Constructor Details

#initialize(sandbox, podfile, lockfile = nil) ⇒ Installer

Initialize a new instance

Parameters:

  • sandbox (Sandbox) —

    @see #sandbox

  • podfile (Podfile) —

    @see #podfile

  • lockfile (Lockfile) (defaults to: nil) —

    @see #lockfile



68
69
70
71
72
73
74
75
 
# File 'lib/cocoapods/installer.rb', line 68

def initialize(sandbox, podfile, lockfile = nil)
  @sandbox  = sandbox || raise(ArgumentError, 'Missing required argument `sandbox`')
  @podfile  = podfile || raise(ArgumentError, 'Missing required argument `podfile`')
  @lockfile = lockfile

  @use_default_plugins = true
  @has_dependencies = true
end

Instance Attribute Details

#aggregate_targets ⇒ Array<AggregateTarget> (readonly)

Returns The model representations of an aggregation of pod targets generated for a target definition in the Podfile as result of the analyzer.

Returns:

  • (Array<AggregateTarget>) —

    The model representations of an aggregation of pod targets generated for a target definition in the Podfile as result of the analyzer.



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

def aggregate_targets
  @aggregate_targets
end

#analysis_result ⇒ Analyzer (readonly)

Returns the analyzer which provides the information about what needs to be installed.

Returns:

  • (Analyzer) —

    the analyzer which provides the information about what needs to be installed.



201
202
203
 
# File 'lib/cocoapods/installer.rb', line 201

def analysis_result
  @analysis_result
end

#has_dependencies ⇒ Boolean Also known as: has_dependencies?

Returns Whether it has dependencies. Defaults to true.

Returns:

  • (Boolean) —

    Whether it has dependencies. Defaults to true.



86
87
88
 
# File 'lib/cocoapods/installer.rb', line 86

def has_dependencies
  @has_dependencies
end

#installed_specs ⇒ Array<Specification>

Returns The specifications that were installed.

Returns:

  • (Array<Specification>) —

    The specifications that were installed.



225
226
227
 
# File 'lib/cocoapods/installer.rb', line 225

def installed_specs
  @installed_specs
end

#lockfile ⇒ Lockfile (readonly)

Returns The Lockfile that stores the information about the Pods previously installed on any machine.

Returns:

  • (Lockfile) —

    The Lockfile that stores the information about the Pods previously installed on any machine.



60
61
62
 
# File 'lib/cocoapods/installer.rb', line 60

def lockfile
  @lockfile
end

#pod_targets ⇒ Array<PodTarget> (readonly)

Returns The model representations of pod targets generated as result of the analyzer.

Returns:

  • (Array<PodTarget>) —

    The model representations of pod targets generated as result of the analyzer.



221
222
223
 
# File 'lib/cocoapods/installer.rb', line 221

def pod_targets
  @pod_targets
end

#podfile ⇒ Podfile (readonly)

Returns The Podfile specification that contains the information of the Pods that should be installed.

Returns:

  • (Podfile) —

    The Podfile specification that contains the information of the Pods that should be installed.



55
56
57
 
# File 'lib/cocoapods/installer.rb', line 55

def podfile
  @podfile
end

#pods_project ⇒ Pod::Project (readonly)

Returns the ‘Pods/Pods.xcodeproj` project.

Returns:



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

def pods_project
  @pods_project
end

#repo_update ⇒ Boolean Also known as: repo_update?

Returns Whether the spec repos should be updated.

Returns:

  • (Boolean) —

    Whether the spec repos should be updated.



91
92
93
 
# File 'lib/cocoapods/installer.rb', line 91

def repo_update
  @repo_update
end

#sandbox ⇒ Sandbox (readonly)

Returns The sandbox where the Pods should be installed.

Returns:

  • (Sandbox) —

    The sandbox where the Pods should be installed.



50
51
52
 
# File 'lib/cocoapods/installer.rb', line 50

def sandbox
  @sandbox
end

#target_installation_results ⇒ Array<Hash{String, TargetInstallationResult}> (readonly)

Returns the installation results produced by the pods project generator.

Returns:

  • (Array<Hash{String, TargetInstallationResult}>) —

    the installation results produced by the pods project generator



206
207
208
 
# File 'lib/cocoapods/installer.rb', line 206

def target_installation_results
  @target_installation_results
end

#update ⇒ Hash, ...

Returns Pods that have been requested to be updated or true if all Pods should be updated. If all Pods should been updated the contents of the Lockfile are not taken into account for deciding what Pods to install.

Returns:

  • (Hash, Boolean, nil) —

    Pods that have been requested to be updated or true if all Pods should be updated. If all Pods should been updated the contents of the Lockfile are not taken into account for deciding what Pods to install.



82
83
84
 
# File 'lib/cocoapods/installer.rb', line 82

def update
  @update
end

#use_default_plugins ⇒ Boolean Also known as: use_default_plugins?

Returns Whether default plugins should be used during installation. Defaults to true.

Returns:

  • (Boolean) —

    Whether default plugins should be used during installation. Defaults to true.



97
98
99
 
# File 'lib/cocoapods/installer.rb', line 97

def use_default_plugins
  @use_default_plugins
end

Class Method Details

.targets_from_sandbox(sandbox, podfile, lockfile) ⇒ Object

Raises:



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'lib/cocoapods/installer.rb', line 684

def self.targets_from_sandbox(sandbox, podfile, lockfile)
  raise Informative, 'You must run `pod install` to be able to generate target information' unless lockfile

  new(sandbox, podfile, lockfile).instance_exec do
    plugin_sources = run_source_provider_hooks
    analyzer = create_analyzer(plugin_sources)
    analyze(analyzer)
    if analysis_result.podfile_needs_install?
      raise Pod::Informative, 'The Podfile has changed, you must run `pod install`'
    elsif analysis_result.sandbox_needs_install?
      raise Pod::Informative, 'The `Pods` directory is out-of-date, you must run `pod install`'
    end

    aggregate_targets
  end
end

Instance Method Details

#development_pod_targets ⇒ Array<PodTarget>

Returns The targets of the development pods generated by the installation process. This can be used as a convenience method for external scripts.

Returns:

  • (Array<PodTarget>) —

    The targets of the development pods generated by the installation process. This can be used as a convenience method for external scripts.



653
654
655
656
657
 
# File 'lib/cocoapods/installer.rb', line 653

def development_pod_targets
  pod_targets.select do |pod_target|
    sandbox.local?(pod_target.pod_name)
  end
end

#download_dependencies ⇒ Object 



161
162
163
164
165
166
167
 
# File 'lib/cocoapods/installer.rb', line 161

def download_dependencies
  UI.section 'Downloading dependencies' do
    install_pod_sources
    run_podfile_pre_install_hooks
    clean_pod_sources
  end
end

#install! ⇒ void

This method returns an undefined value.

Installs the Pods.

The installation process is mostly linear with a few minor complications to keep in mind:

  • The stored podspecs need to be cleaned before the resolution step otherwise the sandbox might return an old podspec and not download the new one from an external source.

  • The resolver might trigger the download of Pods from external sources necessary to retrieve their podspec (unless it is instructed not to do it).



114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/cocoapods/installer.rb', line 114

def install!
  prepare
  resolve_dependencies
  download_dependencies
  validate_targets
  generate_pods_project
  if installation_options.integrate_targets?
    integrate_user_project
  else
    UI.section 'Skipping User Project Integration'
  end
  perform_post_install_actions
end

#prepare ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/cocoapods/installer.rb', line 128

def prepare
  # Raise if pwd is inside Pods
  if Dir.pwd.start_with?(sandbox.root.to_path)
    message = 'Command should be run from a directory outside Pods directory.'
    message << "\n\n\tCurrent directory is #{UI.path(Pathname.pwd)}\n"
    raise Informative, message
  end
  UI.message 'Preparing' do
    deintegrate_if_different_major_version
    sandbox.prepare
    ensure_plugins_are_installed!
    run_plugins_pre_install_hooks
  end
end

#resolve_dependencies ⇒ Analyzer

Returns The analyzer used to resolve dependencies.

Returns:

  • (Analyzer) —

    The analyzer used to resolve dependencies



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/cocoapods/installer.rb', line 145

def resolve_dependencies
  plugin_sources = run_source_provider_hooks
  analyzer = create_analyzer(plugin_sources)

  UI.section 'Updating local specs repositories' do
    analyzer.update_repositories
  end if repo_update?

  UI.section 'Analyzing dependencies' do
    analyze(analyzer)
    validate_build_configurations
    clean_sandbox
  end
  analyzer
end