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. The Podfile always creates an implicit target, named ‘default`, which links to the first target of the user project.

A podfile can be very simple:

pod 'AFNetworking', '~> 1.0'

An example of a more complex podfile can be:

platform :ios, '6.0'
inhibit_all_warnings!

xcodeproj `MyProject`

pod 'ObjectiveSugar', '~> 0.5'

target :test do
  pod 'OCMock', '~> 2.0.1'
end

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

Dependencies The Podfile specifies the dependencies of each user target. collapse

Target configuration This group list the options to configure a target. collapse

Workspace This group list the options to configure workspace and to set global settings. 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

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



419
420
421
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 419

def generate_bridge_support!
  set_hash_value('generate_bridge_support', true)
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



373
374
375
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 373

def inhibit_all_warnings!
  current_target_definition.inhibit_all_warnings = true
end

#link_with(targets) ⇒ void

This method returns an undefined value.

Specifies the target(s) in the user’s project that this Pods library should be linked in.

If no explicit target is specified, then the Pods target will be linked with the first target in your project. So if you only have one target you do not need to specify the target to link with.

Examples:

Link with an user project target


link_with 'MyApp'

Link with a more user project targets


link_with ['MyApp', 'MyOtherApp']

Parameters:

  • targets (String, Array<String>) —

    the target or the targets to link with.



358
359
360
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 358

def link_with(targets)
  current_target_definition.link_with = targets
end

#platform(name, target = nil) ⇒ void

This method returns an undefined value.

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

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

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 or `:ios` for iOS.

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

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



280
281
282
283
284
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 280

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

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

Note:

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

Note:

Support for inline podspecs has been deprecated.

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` 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

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

For more information, regarding versioning policy, see:

Finally, instead of a version, you can specify the ‘:head` flag. This will use the pod’s latest version spec version, but force the download of the ‘bleeding edge’ version. Use this with caution, as the spec might not be compatible anymore.

pod 'Objection', :head

Dependencies can be obtained also from external sources.

### Using the files from a folder local to the machine.

If you wold like to use develop a Pod in tandem with its client
project you can use the `local` 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 favorite SCM or
even a git submodule of the current repo.

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

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

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 repo:

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

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 repo, if this library does not have a `podspec` file in its repo yet, you will have to use one of the approaches outlined in the sections below.

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

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

pod 'JSONKit', :podspec => 'https://raw.github.com/gist/1346394/1d26570f68ca27377a27430c65841a0880395d72/JSONKit.podspec'



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 149

def pod(name = nil, *requirements, &block)
  if block
    raise StandardError, "Inline specifications are deprecated. Please store the specification in a `podspec` file."
  end

  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 by the 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 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.

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



193
194
195
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 193

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::Hooks::InstallerRepresentation](docs.cocoapods.org/cocoapods/pod/hooks/installerrepresentation/)` as its only argument.

Examples:

Customizing the ‘OTHER_LDFLAGS` of all targets


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


489
490
491
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 489

def post_install(&block)
  @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::Hooks::InstallerRepresentation](docs.cocoapods.org/cocoapods/pod/hooks/installerrepresentation/)` as its only argument.

Examples:

Defining a pre install hook in a Podfile.


pre_install do |installer_representation|
  # Do something fancy!
end


465
466
467
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 465

def pre_install(&block)
  @pre_install_callback = block
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`.



437
438
439
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 437

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

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

This method returns an undefined value.

Defines a new static library target and scopes dependencies defined from the given block. The target will by default include the dependencies defined outside of the block, unless the ‘:exclusive => true` option is given.

The Podfile creates a global target named ‘:default` which produces the `libPods.a` file. This target is linked with the first target of user project if not value is specified for the `link_with` attribute.

Examples:

Defining a target


target :ZipApp do
  pod 'SSZipArchive'
end

Defining an exclusive target


target :ZipApp do
  pod 'SSZipArchive'
  target :test, :exclusive => true do
    pod 'JSONKit'
  end
end

Parameters:

  • name (Symbol, String) —

    the name of the target definition.

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

    a customizable set of options

Options Hash (options):

  • :exclusive (Bool) —

    whether the target should inherit the dependencies of its parent. by default targets are inclusive.



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 232

def target(name, options = {})
  if options && !options.keys.all? { |key| [:exclusive].include?(key) }
    raise Informative, "Unsupported options `#{options}` for target `#{name}`"
  end

  parent = current_target_definition
  definition = TargetDefinition.new(name, parent)
  definition.exclusive = true if options[:exclusive]
  self.current_target_definition = definition
  yield
ensure
  self.current_target_definition = parent
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.



403
404
405
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 403

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

#xcodeproj(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 no explicit project is specified, it will use the Xcode project of the parent target. 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 modeled 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


# Look for target to link with in an Xcode project called
# `MyProject.xcodeproj`.
xcodeproj `MyProject`

target :test do
  # This Pods library links with a target in another project.
  xcodeproj `TestProject`
end

Using custom build configurations


xcodeproj `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`.



331
332
333
334
 
# File 'lib/cocoapods-core/podfile/dsl.rb', line 331

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