Module: Pod::Podfile::DSL

Included in:
Pod::Podfile
Defined in:
lib/cocoapods-core/podfile/dsl.rb

Overview

The Podfile is a specification that describes the dependencies of the targets of one or more Xcode projects.

A Podfile can be very simple:

target 'MyApp'
pod 'AFNetworking', '~> 1.0'

An example of a more complex Podfile can be:

platform :ios, '9.0'
inhibit_all_warnings!

target 'MyApp' do
  pod 'ObjectiveSugar', '~> 0.5'

  target "MyAppTests" do
    inherit! :search_paths
    pod 'OCMock', '~> 2.0.1'
  end
end

post_install do |installer|
  installer.pods_project.targets.each do |target|
    puts "#{target.name}"
  end
end

Root Options Configuration that applies to the Podfile as a whole. * `install!` declares the installation method and options to be used during installation. collapse

Dependencies The Podfile specifies the dependencies of each user target. * `pod` is the way to declare a specific dependency. * `podspec` provides an easy API for the creation of podspecs. * `target` is how you scope your dependencies to specific targets in your Xcode projects. collapse

Target configuration These settings are used to control the CocoaPods generated project. This starts out simply with stating what `platform` you are working on. `xcodeproj` allows you to state specifically which project to link with. collapse

Workspace This group list the options to configure workspace and to set global settings. collapse

Sources The Podfile retrieves specs from a given list of sources (repositories). Sources are __global__ and they are not stored per target definition. collapse

Hooks The Podfile provides hooks that will be called during the installation process. Hooks are __global__ and not stored per target definition. collapse

Instance Method Details

#abstract!(abstract = true) ⇒ void

This method returns an undefined value.

Denotes that the current target is abstract, and thus will not directly link against an Xcode target.



394
395
396
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 394

def abstract!(abstract = true)
  current_target_definition.abstract = abstract
end

#abstract_target(name) ⇒ void

This method returns an undefined value.

Defines a new abstract target that can be used for convenient target dependency inheritance.

Examples:

Defining an abstract target


abstract_target 'Networking' do
  pod 'AlamoFire'

  target 'Networking App 1'
  target 'Networking App 2'
end

Defining an abstract_target wrapping Pods to multiple targets


# Note: There are no targets called "Shows" in any of this workspace's Xcode projects
abstract_target 'Shows' do
  pod 'ShowsKit'

  # The target ShowsiOS has its own copy of ShowsKit (inherited) + ShowWebAuth (added here)
  target 'ShowsiOS' do
    pod 'ShowWebAuth'
  end

  # The target ShowsTV has its own copy of ShowsKit (inherited) + ShowTVAuth (added here)
  target 'ShowsTV' do
    pod 'ShowTVAuth'
  end

  # Our tests target has its own copy of
  # our testing frameworks, and has access
  # to ShowsKit as well because it is
  # a child of the abstract target 'Shows'

  target 'ShowsTests' do
    inherit! :search_paths
    pod 'Specta'
    pod 'Expecta'
  end
end

Parameters:

  • name (Symbol, String) —

    the name of the target.



382
383
384
385
386
387
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 382

def abstract_target(name)
  target(name) do
    abstract!
    yield if block_given?
  end
end

#generate_bridge_support! ⇒ void

This method returns an undefined value.

Specifies that a BridgeSupport metadata document should be generated from the headers of all installed Pods.

This is for scripting languages such as [MacRuby](macruby.org), [Nu](programming.nu/index), and [JSCocoa](inexdo.com/JSCocoa), which use it to bridge types, functions, etc.



616
617
618
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 616

def generate_bridge_support!
  set_hash_value('generate_bridge_support', true)
end

#inherit!(inheritance) ⇒ void

This method returns an undefined value.

Sets the inheritance mode for the current target.

Examples:

Inheriting only search paths


target 'App' do
  target 'AppTests' do
    inherit! :search_paths
  end
end

Parameters:

  • inheritance (Symbol) —

    the inheritance mode to set.

    **Available Modes:** + ‘:complete` The target inherits all behaviour from the parent. + `:none` The target inherits none of the behaviour from the parent. + `:search_paths` The target inherits the search paths of the parent only.



422
423
424
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 422

def inherit!(inheritance)
  current_target_definition.inheritance = inheritance
end

#inhibit_all_warnings! ⇒ Object

Inhibits all the warnings from the CocoaPods libraries.

This attribute is inherited by child target definitions.

If you would like to inhibit warnings per Pod you can use the following syntax:

pod 'SSZipArchive', :inhibit_warnings => true

Additionally, when you use ‘inhibit_all_warnings!` attribute, you can exclude a particular Pod from being inhibited using the following:

pod 'SSZipArchive', :inhibit_warnings => false



560
561
562
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 560

def inhibit_all_warnings!
  current_target_definition.inhibit_all_warnings = true
end

#install!(installation_method, options = {}) ⇒ void

This method returns an undefined value.

Specifies the installation method and options to be used when CocoaPods installs this Podfile.

The first parameter indicates the installation method to use; next parameters indicate installation options.

For now the only accepted installation method is ‘’cocoapods’‘, so you’ll always use this value for the first parameter; but more installation methods might be available in future versions.

Examples:

Specifying custom CocoaPods installation options


install! 'cocoapods',
         :deterministic_uuids => false,
         :integrate_targets => false

Parameters:

  • installation_method (String) —

    the name of the installation strategy.

  • options (Hash) (defaults to: {}) —

    the installation options.



66
67
68
69
70
71
72
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 66

def install!(installation_method, options = {})
  unless current_target_definition.root?
    raise Informative, 'The installation method can only be set at the root level of the Podfile.'
  end

  set_hash_value('installation_method', 'name' => installation_method, 'options' => options)
end

#platform(name, target = nil) ⇒ void

This method returns an undefined value.

Specifies the platform for which a static library should be built.

CocoaPods provides a default deployment target if one is not specified. The current default values are ‘4.3` for iOS, `10.6` for OS X, `9.0` for tvOS and `2.0` for watchOS.

If the deployment target requires it (iOS < ‘4.3`), `armv6` architecture will be added to `ARCHS`.

Examples:

Specifying the platform


platform :ios, '4.0'
platform :ios

Parameters:

  • name (Symbol) —

    the name of platform, can be either ‘:osx` for OS X, `:ios` for iOS, `:tvos` for tvOS, or `:watchos` for watchOS.

  • target (String, Version) (defaults to: nil) —

    The optional deployment. If not provided a default value according to the platform name will be assigned.



461
462
463
464
465
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 461

def platform(name, target = nil)
  # Support for deprecated options parameter
  target = target[:deployment_target] if target.is_a?(Hash)
  current_target_definition.set_platform!(name, target)
end

#plugin(name, options = {}) ⇒ void

This method returns an undefined value.

Specifies the plugins that should be used during installation.

Use this method to specify a plugin that should be used during installation, along with the options that should be passed to the plugin when it is invoked.

Examples:

Specifying to use the ‘slather` and `cocoapods-keys` plugins.


plugin 'cocoapods-keys', :keyring => 'Eidolon'
plugin 'slather'

Parameters:

  • name (String) —

    The name of the plugin.

  • options (Hash) (defaults to: {}) —

    The optional options that should be passed to the plugin when its hooks are invoked.



709
710
711
712
713
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 709

def plugin(name, options = {})
  hash_plugins = get_hash_value('plugins') || {}
  (hash_plugins[name] ||= {}).merge!(options.deep_stringify_keys)
  set_hash_value('plugins', hash_plugins)
end

#pod(name = nil, *requirements) ⇒ void

Note:

This method allow a nil name and the raises to be more informative.

This method returns an undefined value.

Specifies a dependency of the project.

A dependency requirement is defined by the name of the Pod and optionally a list of version requirements.

When starting out with a project it is likely that you will want to use the latest version of a Pod. If this is the case, simply omit the version requirements.

pod 'SSZipArchive'

Later on in the project you may want to freeze to a specific version of a Pod, in which case you can specify that version number.

pod 'Objection', '0.9'

Besides no version, or a specific one, it is also possible to use operators:

  • ‘= 0.1` Version 0.1.

  • ‘> 0.1` Any version higher than 0.1.

  • ‘>= 0.1` Version 0.1 and any higher version.

  • ‘< 0.1` Any version lower than 0.1.

  • ‘<= 0.1` Version 0.1 and any lower version.

  • ‘~> 0.1.2` Version 0.1.2 and the versions up to 0.2, not including 0.2.

    This operator works based on _the last component_ that you
specify in your version requirement. The example is equal to
`>= 0.1.2` combined with `< 0.2.0` and will always match the
latest known version matching your requirements.

A list of version requirements can be specified for even more fine grained control.

For more information, regarding versioning policy, see:

### Build configurations

By default dependencies are installed in all the build configurations of the target. For debug purposes or for other reasons, they can be only enabled on a list of build configurations.

pod 'PonyDebugger', :configurations => ['Debug', 'Beta']

Alternatively, you can specify to have it included on a single build configuration.

pod 'PonyDebugger', :configuration => 'Debug'

Note that transitive dependencies are included in all configurations and you have to manually specify build configurations for them as well in case this is not desired.

### Subspecs

When installing a Pod via its name, it will install all of the default subspecs defined in the podspec.

You may install a specific subspec using the following:

pod 'QueryKit/Attribute'

You may specify a collection of subspecs to be installed as follows:

pod 'QueryKit', :subspecs => ['Attribute', 'QuerySet']

Dependencies can be obtained also from external sources.

### Using the files from a local path.

If you would like to use develop a Pod in tandem with its client
project you can use the `path` option.

   pod 'AFNetworking', :path => '~/Documents/AFNetworking'

Using this option CocoaPods will assume the given folder to be the
root of the Pod and will link the files directly from there in the
Pods project. This means that your edits will persist to CocoaPods
installations.

The referenced folder can be a checkout of your your favourite SCM or
even a git submodule of the current repository.

Note that the `podspec` of the Pod file is expected to be in the
folder.

### From a podspec in the root of a library repository.

Sometimes you may want to use the bleeding edge version of a Pod. Or a specific revision. If this is the case, you can specify that with your pod declaration.

To use the ‘master` branch of the repository:

pod 'AFNetworking', :git => 'https://github.com/gowalla/AFNetworking.git'

To use a different branch of the repository:

pod 'AFNetworking', :git => 'https://github.com/gowalla/AFNetworking.git', :branch => 'dev'

To use a tag of the repository:

pod 'AFNetworking', :git => 'https://github.com/gowalla/AFNetworking.git', :tag => '0.7.0'

Or specify a commit:

pod 'AFNetworking', :git => 'https://github.com/gowalla/AFNetworking.git', :commit => '082f8319af'

It is important to note, though, that this means that the version will have to satisfy any other dependencies on the Pod by other Pods.

The ‘podspec` file is expected to be in the root of the repository, if this library does not have a `podspec` file in its repository yet, you will have to use one of the approaches outlined in the sections below.

### From a podspec outside a spec repository, for a library without podspec.

If a podspec is available from another source outside of the library’s repository. Consider, for instance, a podspec available via HTTP:

pod 'JSONKit', :podspec => 'https://example.com/JSONKit.podspec'



229
230
231
232
233
234
235
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 229

def pod(name = nil, *requirements)
  unless name
    raise StandardError, 'A dependency requires a name.'
  end

  current_target_definition.store_pod(name, *requirements)
end

#podspec(options = nil) ⇒ void

Note:

This method uses the dependencies declared for the platform of the target definition.

Note:

This method requires that the Podfile has a non nil value for Pod::Podfile#defined_in_file unless the path option is used.

This method returns an undefined value.

Use just the dependencies of a Pod defined in the given podspec file. If no arguments are passed the first podspec in the root of the Podfile is used. It is intended to be used by the project of a library. Note: this does not include the sources derived from the podspec just the CocoaPods infrastructure.

Examples:

podspec
podspec :name => 'QuickDialog'
podspec :path => '/Documents/PrettyKit/PrettyKit.podspec'

Parameters:

  • options (Hash {Symbol=>String}) (defaults to: nil) —

    the path where to load the Specification. If not provided the first podspec in the directory of the Podfile is used.

Options Hash (options):

  • :path (String) —

    the path of the podspec file

  • :name (String) —

    the name of the podspec



271
272
273
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 271

def podspec(options = nil)
  current_target_definition.store_podspec(options)
end

#post_install(&block) ⇒ void

This method returns an undefined value.

This hook allows you to make any last changes to the generated Xcode project before it is written to disk, or any other tasks you might want to perform.

It receives the [‘Pod::Installer`](rubydoc.info/gems/cocoapods/Pod/Installer/) as its only argument.

Examples:

Customising the build settings of all targets


post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['GCC_ENABLE_OBJC_GC'] = 'supported'
    end
  end
end

Raises:



753
754
755
756
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 753

def post_install(&block)
  raise Informative, 'Specifying multiple `post_install` hooks is unsupported.' if @post_install_callback
  @post_install_callback = block
end

#pre_install(&block) ⇒ Object

This hook allows you to make any changes to the Pods after they have been downloaded but before they are installed.

It receives the [‘Pod::Installer`](rubydoc.info/gems/cocoapods/Pod/Installer/) as its only argument.

Examples:

Defining a pre-install hook in a Podfile.


pre_install do |installer|
  # Do something fancy!
end


729
730
731
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 729

def pre_install(&block)
  @pre_install_callback = block
end

#project(path, build_configurations = {}) ⇒ void

This method returns an undefined value.

Specifies the Xcode project that contains the target that the Pods library should be linked with.

If none of the target definitions specify an explicit project and there is only one project in the same directory as the Podfile then that project will be used.

It is possible also to specify whether the build settings of your custom build configurations should be modelled after the release or the debug presets. To do so you need to specify a hash where the name of each build configuration is associated to either ‘:release` or `:debug`.

Examples:

Specifying the user project


# This Target can be found in a Xcode project called `FastGPS`
target 'MyGPSApp' do
  project 'FastGPS'
  ...
end

# Same Podfile, multiple Xcodeprojects
target 'MyNotesApp' do
  project 'FastNotes'
  ...
end

Using custom build configurations


project 'TestProject', 'Mac App Store' => :release, 'Test' => :debug

Parameters:

  • path (String) —

    the path of the project to link with

  • build_configurations (Hash{String => symbol}) (defaults to: {}) —

    a hash where the keys are the name of the build configurations in your Xcode project and the values are Symbols that specify if the configuration should be based on the ‘:debug` or `:release` configuration. If no explicit mapping is specified for a configuration in your project, it will default to `:release`.



513
514
515
516
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 513

def project(path, build_configurations = {})
  current_target_definition.user_project_path = path
  current_target_definition.build_configurations = build_configurations
end

#set_arc_compatibility_flag! ⇒ void

This method returns an undefined value.

Specifies that the -fobjc-arc flag should be added to the ‘OTHER_LD_FLAGS`.

This is used as a workaround for a compiler bug with non-ARC projects (see #142). This was originally done automatically but libtool as of Xcode 4.3.2 no longer seems to support the ‘-fobjc-arc` flag. Therefore it now has to be enabled explicitly using this method.

Support for this method might be dropped in CocoaPods ‘1.0`.



634
635
636
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 634

def set_arc_compatibility_flag!
  set_hash_value('set_arc_compatibility_flag', true)
end

#source(source) ⇒ void

This method returns an undefined value.

Specifies the location of specs

Use this method to specify sources. The order of the sources is relevant. CocoaPods will use the highest version of a Pod of the first source which includes the Pod (regardless whether other sources have a higher version).

The official CocoaPods source is implicit. Once you specify another source, then it will need to be included.

Examples:

Specifying to first use the Artsy repository and then the

CocoaPods Master Repository

source 'https://github.com/artsy/Specs.git'
source 'https://github.com/CocoaPods/Specs.git'

Parameters:

  • source (String) —

    The URL of a specs repository.



671
672
673
674
675
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 671

def source(source)
  hash_sources = get_hash_value('sources') || []
  hash_sources << source
  set_hash_value('sources', hash_sources.uniq)
end

#target(name, options = nil) ⇒ void

This method returns an undefined value.

Defines a CocoaPods target and scopes dependencies defined within the given block. A target should correspond to an Xcode target. By default the target includes the dependencies defined outside of the block, unless instructed not to ‘inherit!` them.

Examples:

Defining a target


target 'ZipApp' do
  pod 'SSZipArchive'
end

Defining a test target accessing SSZipArchive pod from its parent


target 'ZipApp' do
  pod 'SSZipArchive'

  target 'ZipAppTests' do
    inherit! :search_paths
    pod 'Nimble'
  end
end

Defining a target applies Pods to multiple targets via its parent target


target 'ShowsApp' do
  pod 'ShowsKit'

  # Has its own copy of ShowsKit + ShowTVAuth
  target 'ShowsTV' do
    pod 'ShowTVAuth'
  end

  # Has its own copy of Specta + Expecta
  # and has access to ShowsKit via the app
  # that the test target is bundled into

  target 'ShowsTests' do
    inherit! :search_paths
    pod 'Specta'
    pod 'Expecta'
  end
end

Parameters:

  • name (Symbol, String) —

    the name of the target.



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 323

def target(name, options = nil)
  if options
    raise Informative, "Unsupported options `#{options}` for " \
      "target `#{name}`."
  end

  parent = current_target_definition
  definition = TargetDefinition.new(name, parent)
  self.current_target_definition = definition
  yield if block_given?
ensure
  self.current_target_definition = parent
end

#use_frameworks!(flag = true) ⇒ Object

Use frameworks instead of static libraries for Pods.

This attribute is inherited by child target definitions.



570
571
572
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 570

def use_frameworks!(flag = true)
  current_target_definition.use_frameworks!(flag)
end

#workspace(path) ⇒ void

This method returns an undefined value.

Specifies the Xcode workspace that should contain all the projects.

If no explicit Xcode workspace is specified and only one project exists in the same directory as the Podfile, then the name of that project is used as the workspace’s name.

Examples:

Specifying a workspace


workspace 'MyWorkspace'

Parameters:

  • path (String) —

    path of the workspace.



600
601
602
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 600

def workspace(path)
  set_hash_value('workspace', path.to_s)
end