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
-
#install!(installation_method, options = {}) ⇒ void
Specifies the installation method and options to be used when CocoaPods installs this Podfile.
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
-
#abstract!(abstract = true) ⇒ void
Denotes that the current target is abstract, and thus will not directly link against an Xcode target.
-
#abstract_target(name) ⇒ void
Defines a new abstract target that can be used for convenient target dependency inheritance.
-
#inherit!(inheritance) ⇒ void
Sets the inheritance mode for the current target.
-
#pod(name = nil, *requirements) ⇒ void
Specifies a dependency of the project.
-
#podspec(options = nil) ⇒ void
Use just the dependencies of a Pod defined in the given podspec file.
-
#script_phase(options) ⇒ void
Adds a script phase to be integrated with this target.
-
#target(name, options = nil) ⇒ void
Defines a CocoaPods target and scopes dependencies defined within the given block.
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
-
#inhibit_all_warnings! ⇒ Object
Inhibits all the warnings from the CocoaPods libraries.
-
#platform(name, target = nil) ⇒ void
Specifies the platform for which a static library should be built.
-
#project(path, build_configurations = {}) ⇒ void
Specifies the Xcode project that contains the target that the Pods library should be linked with.
-
#use_frameworks!(flag = true) ⇒ Object
Use frameworks instead of static libraries for Pods.
-
#use_modular_headers! ⇒ Object
Use modular headers for all CocoaPods static libraries.
Workspace This group list the options to configure workspace and to set global settings. collapse
-
#generate_bridge_support! ⇒ void
Specifies that a BridgeSupport metadata document should be generated from the headers of all installed Pods.
-
#set_arc_compatibility_flag! ⇒ void
Specifies that the -fobjc-arc flag should be added to the ‘OTHER_LD_FLAGS`.
-
#workspace(path) ⇒ void
Specifies the Xcode workspace that should contain all the projects.
Sources The Podfile retrieves specs from a given list of sources (repositories). Sources are __global__ and they are not stored per target definition. collapse
-
#source(source) ⇒ void
Specifies the location of specs.
Hooks The Podfile provides hooks that will be called during the installation process. Hooks are __global__ and not stored per target definition. collapse
-
#plugin(name, options = {}) ⇒ void
Specifies the plugins that should be used during installation.
-
#post_install(&block) ⇒ void
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.
-
#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.
-
#supports_swift_versions(*requirements) ⇒ void
Specifies the Swift version requirements this target definition supports.
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.
490 491 492 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 490 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.
478 479 480 481 482 483 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 478 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.
732 733 734 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 732 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.
518 519 520 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 518 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
656 657 658 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 656 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.
66 67 68 69 70 71 72 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 66 def install!(installation_method, = {}) 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' => ) 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`.
557 558 559 560 561 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 557 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.
824 825 826 827 828 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 824 def plugin(name, = {}) hash_plugins = get_hash_value('plugins') || {} (hash_plugins[name] ||= {}).merge!(.deep_stringify_keys) set_hash_value('plugins', hash_plugins) end |
#pod(name = nil, *requirements) ⇒ void
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.
-
‘~> 0.1.3-beta.0` Beta and release versions for 0.1.3, release versions
up to 0.2 excluding 0.2. Components separated by a dash (-) will not be considered for the version requirement.
A list of version requirements can be specified for even more fine grained control.
For more information, regarding versioning policy, see:
-
[Semantic Versioning](semver.org)
-
[RubyGems Versioning Policies](guides.rubygems.org/patterns/#semantic-versioning)
### 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.
### Modular Headers
If you would like to use modular headers per Pod you can use the following syntax:
pod 'SSZipArchive', :modular_headers => true
Additionally, when you use the ‘use_modular_headers!` attribute, you can exclude a particular Pod from modular headers using the following:
pod 'SSZipArchive', :modular_headers => false
### Source
By default the sources specified at the global level are searched in the order they are specified for a dependency match. This behaviour can be altered for a specific dependency by specifying the source with the dependency:
pod 'PonyDebugger', :source => 'https://github.com/CocoaPods/Specs.git'
In this case only the specified source will be searched for the dependency and any global sources ignored.
### 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']
### Test Specs
Test specs can be optionally included via the ‘:testspecs` option. By default, none of a Pod’s test specs are included.
You may specify a list of test spec names to install using the following:
pod 'AFNetworking', :testspecs => ['UnitTests', 'SomeOtherTests']
The values provided to ‘:testspecs` correspond to the name provided to the `test_spec` DSL attribute in a Podspec.
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'
271 272 273 274 275 276 277 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 271 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
This method uses the dependencies declared for the platform of the target definition.
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.
313 314 315 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 313 def podspec( = nil) current_target_definition.store_podspec() 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.
868 869 870 871 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 868 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.
844 845 846 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 844 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`.
609 610 611 612 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 609 def project(path, build_configurations = {}) current_target_definition.user_project_path = path current_target_definition.build_configurations = build_configurations end |
#script_phase(options) ⇒ void
This method returns an undefined value.
Adds a script phase to be integrated with this target. A script phase can be used to execute an arbitrary script that can use all Xcode environment variables during execution. A target may include multiple script phases which they will be added in the order they were declared. Deleting a script phase will effectively remove it from the target if it has been added previously.
427 428 429 430 431 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 427 def script_phase() raise Informative, 'Script phases can only be added within target definitions.' if current_target_definition.root? raise Informative, 'Script phases cannot be added to abstract targets.' if current_target_definition.abstract? current_target_definition.store_script_phase() 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`.
750 751 752 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 750 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.
786 787 788 789 790 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 786 def source(source) hash_sources = get_hash_value('sources') || [] hash_sources << source set_hash_value('sources', hash_sources.uniq) end |
#supports_swift_versions(*requirements) ⇒ void
This method returns an undefined value.
Specifies the Swift version requirements this target definition supports.
Note These requirements are inherited from the parent, if specified and if none are specified at the root level then all versions are considered to be supported.
902 903 904 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 902 def supports_swift_versions(*requirements) current_target_definition.store_swift_version_requirements(*requirements) 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.
365 366 367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 365 def target(name, = nil) if raise Informative, "Unsupported 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.
686 687 688 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 686 def use_frameworks!(flag = true) current_target_definition.use_frameworks!(flag) end |
#use_modular_headers! ⇒ Object
Use modular headers for all CocoaPods static libraries.
This attribute is inherited by child target definitions.
If you would like to use modular headers per Pod you can use the following syntax:
pod 'SSZipArchive', :modular_headers => true
Additionally, when you use the ‘use_modular_headers!` attribute, you can exclude a particular Pod from modular headers using the following:
pod 'SSZipArchive', :modular_headers => false
676 677 678 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 676 def use_modular_headers! current_target_definition.use_modular_headers_for_all_pods = true 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.
716 717 718 |
# File 'lib/cocoapods-core/podfile/dsl.rb', line 716 def workspace(path) set_hash_value('workspace', path.to_s) end |