Class: Pod::Installer

Inherits:
Object
  • Object
show all
Includes:
Config::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/sandbox_dir_cleaner.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/target_uuid_generator.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/project_cache/project_cache.rb,
lib/cocoapods/installer/xcode/pods_project_generator.rb,
lib/cocoapods/installer/project_cache/target_metadata.rb,
lib/cocoapods/installer/source_provider_hooks_context.rb,
lib/cocoapods/installer/project_cache/target_cache_key.rb,
lib/cocoapods/installer/sandbox_header_paths_installer.rb,
lib/cocoapods/installer/analyzer/podfile_dependency_cache.rb,
lib/cocoapods/installer/analyzer/target_inspection_result.rb,
lib/cocoapods/installer/xcode/multi_pods_project_generator.rb,
lib/cocoapods/installer/project_cache/project_cache_version.rb,
lib/cocoapods/installer/xcode/pods_project_generator_result.rb,
lib/cocoapods/installer/xcode/single_pods_project_generator.rb,
lib/cocoapods/installer/analyzer/locking_dependency_analyzer.rb,
lib/cocoapods/installer/project_cache/project_cache_analyzer.rb,
lib/cocoapods/installer/project_cache/project_metadata_cache.rb,
lib/cocoapods/installer/project_cache/project_installation_cache.rb,
lib/cocoapods/installer/user_project_integrator/target_integrator.rb,
lib/cocoapods/installer/project_cache/project_cache_analysis_result.rb,
lib/cocoapods/installer/xcode/pods_project_generator/target_installer.rb,
lib/cocoapods/installer/xcode/pods_project_generator/project_generator.rb,
lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb,
lib/cocoapods/installer/xcode/pods_project_generator/pods_project_writer.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/xcode/pods_project_generator/pod_target_dependency_installer.rb,
lib/cocoapods/installer/user_project_integrator/target_integrator/xcconfig_integrator.rb,
lib/cocoapods/installer/xcode/pods_project_generator/aggregate_target_dependency_installer.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

Modules: ProjectCache Classes: Analyzer, InstallationOptions, PodSourceInstaller, PodSourcePreparer, PodfileValidator, PostInstallHooksContext, PreInstallHooksContext, SandboxDirCleaner, SandboxHeaderPathsInstaller, SourceProviderHooksContext, TargetUUIDGenerator, UserProjectIntegrator, Xcode

Installation results collapse

Instance Attribute Summary collapse

Hooks collapse

Convenience Methods collapse

Instance Method Summary collapse

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


70
71
72
73
74
75
76
77
78
 
# File 'lib/cocoapods/installer.rb', line 70

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
  @pod_installers = []
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.


362
363
364
 
# File 'lib/cocoapods/installer.rb', line 362

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.


343
344
345
 
# File 'lib/cocoapods/installer.rb', line 343

def analysis_result
  @analysis_result
end

#clean_install ⇒ Boolean Also known as: clean_install?

when incremental installation is enabled.

Returns:

  • (Boolean) —

    Whether installation should ignore the contents of the project cache


112
113
114
 
# File 'lib/cocoapods/installer.rb', line 112

def clean_install
  @clean_install
end

#deployment ⇒ Boolean Also known as: deployment?

Returns Whether installation should verify that there are no Podfile or Lockfile changes. Defaults to false.

Returns:

  • (Boolean) —

    Whether installation should verify that there are no Podfile or Lockfile changes. Defaults to false.


106
107
108
 
# File 'lib/cocoapods/installer.rb', line 106

def deployment
  @deployment
end

#generated_aggregate_targets ⇒ Array<AggregateTarget> (readonly)

Returns The list of aggregate targets that were generated from the installation.

Returns:

  • (Array<AggregateTarget>) —

    The list of aggregate targets that were generated from the installation.


379
380
381
 
# File 'lib/cocoapods/installer.rb', line 379

def generated_aggregate_targets
  @generated_aggregate_targets
end

#generated_pod_targets ⇒ Array<PodTarget> (readonly)

Returns The list of pod targets that were generated from the installation.

Returns:

  • (Array<PodTarget>) —

    The list of pod targets that were generated from the installation.


375
376
377
 
# File 'lib/cocoapods/installer.rb', line 375

def generated_pod_targets
  @generated_pod_targets
end

#generated_projects ⇒ Array<Project> (readonly)

Returns The list of projects generated from the installation.

Returns:

  • (Array<Project>) —

    The list of projects generated from the installation.


371
372
373
 
# File 'lib/cocoapods/installer.rb', line 371

def generated_projects
  @generated_projects
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.


89
90
91
 
# File 'lib/cocoapods/installer.rb', line 89

def has_dependencies
  @has_dependencies
end

#installed_specs ⇒ Array<Specification>

Returns The specifications that were installed.

Returns:

  • (Array<Specification>) —

    The specifications that were installed.


383
384
385
 
# File 'lib/cocoapods/installer.rb', line 383

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.


62
63
64
 
# File 'lib/cocoapods/installer.rb', line 62

def lockfile
  @lockfile
end

#pod_target_subprojects ⇒ Array<Pod::Project> (readonly)

Returns the subprojects nested under pods_project.

Returns:

  • (Array<Pod::Project>) —

    the subprojects nested under pods_project.


356
357
358
 
# File 'lib/cocoapods/installer.rb', line 356

def pod_target_subprojects
  @pod_target_subprojects
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.


367
368
369
 
# File 'lib/cocoapods/installer.rb', line 367

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.


57
58
59
 
# File 'lib/cocoapods/installer.rb', line 57

def podfile
  @podfile
end

#pods_project ⇒ Pod::Project (readonly)

Returns the `Pods/Pods.xcodeproj` project.

Returns:


352
353
354
 
# File 'lib/cocoapods/installer.rb', line 352

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.


94
95
96
 
# File 'lib/cocoapods/installer.rb', line 94

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.


52
53
54
 
# File 'lib/cocoapods/installer.rb', line 52

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


348
349
350
 
# File 'lib/cocoapods/installer.rb', line 348

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.


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

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.


100
101
102
 
# File 'lib/cocoapods/installer.rb', line 100

def use_default_plugins
  @use_default_plugins
end

Class Method Details

.targets_from_sandbox(sandbox, podfile, lockfile) ⇒ Object

Raises:


889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/cocoapods/installer.rb', line 889

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

#analyze_project_cache ⇒ Object 


168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/cocoapods/installer.rb', line 168

def analyze_project_cache
  user_projects = aggregate_targets.map(&:user_project).compact
  object_version = user_projects.min_by { |p| p.object_version.to_i }.object_version.to_i unless user_projects.empty?

  if !installation_options.incremental_installation
    # Run entire installation.
    ProjectCache::ProjectCacheAnalysisResult.new(pod_targets, aggregate_targets, {},
                                                 analysis_result.all_user_build_configurations, object_version)
  else
    UI.message 'Analyzing Project Cache' do
      @installation_cache = ProjectCache::ProjectInstallationCache.from_file(sandbox.project_installation_cache_path)
      @metadata_cache = ProjectCache::ProjectMetadataCache.from_file(sandbox.project_metadata_cache_path)
      @project_cache_version = ProjectCache::ProjectCacheVersion.from_file(sandbox.project_version_cache_path)

      force_clean_install = clean_install || project_cache_version.version != Version.create(VersionMetadata.project_cache_version)
      cache_result = ProjectCache::ProjectCacheAnalyzer.new(sandbox, installation_cache, analysis_result.all_user_build_configurations,
                                                            object_version, pod_targets, aggregate_targets, :clean_install => force_clean_install).analyze
      aggregate_targets_to_generate = cache_result.aggregate_targets_to_generate || []
      pod_targets_to_generate = cache_result.pod_targets_to_generate
      (aggregate_targets_to_generate + pod_targets_to_generate).each do |target|
        UI.message "- Regenerating #{target.label}"
      end
      cache_result
    end
  end
end

#development_pod_targets(targets = 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.

Parameters:

  • targets (Array<PodTarget>) (defaults to: pod_targets)

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.


852
853
854
855
856
 
# File 'lib/cocoapods/installer.rb', line 852

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

#download_dependencies ⇒ Object 


233
234
235
236
237
238
239
 
# File 'lib/cocoapods/installer.rb', line 233

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).


154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/cocoapods/installer.rb', line 154

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 


195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/cocoapods/installer.rb', line 195

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


212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/cocoapods/installer.rb', line 212

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
  end

  UI.section 'Verifying no changes' do
    verify_no_podfile_changes!
    verify_no_lockfile_changes!
  end if deployment?

  analyzer
end

#stage_sandbox(sandbox, pod_targets) ⇒ void

This method returns an undefined value.

Stages the sandbox after analysis.

Parameters:

  • sandbox (Sandbox) —

    The sandbox to stage.

  • pod_targets (Array<PodTarget>) —

    The list of all pod targets.


251
252
253
 
# File 'lib/cocoapods/installer.rb', line 251

def stage_sandbox(sandbox, pod_targets)
  SandboxHeaderPathsInstaller.new(sandbox, pod_targets).install!
end