Module: Pod::Specification::DSL
- Extended by:
- AttributeSupport
- Included in:
- Pod::Specification
- Defined in:
- lib/cocoapods-core/specification/dsl.rb,
lib/cocoapods-core/specification/dsl/attribute.rb,
lib/cocoapods-core/specification/dsl/deprecations.rb,
lib/cocoapods-core/specification/dsl/platform_proxy.rb,
lib/cocoapods-core/specification/dsl/attribute_support.rb,
lib/cocoapods-core/specification/root_attribute_accessors.rb
Overview
A specification describes a version of Pod library. It includes details about where the source should be fetched from, what files to use, the build settings to apply, and other general metadata such as its name, version, and description.
A stub specification file can be generated by the [pod spec create](commands.html#tab_spec-create) command.
The specification DSL provides great flexibility and dynamism. Moreover, the DSL adopts the [convention over configuration](en.wikipedia.org/wiki/Convention_over_configuration) and thus it can be very simple:
Pod::Spec.new do |s|
s.name = 'Reachability'
s.version = '3.1.0'
s.license = { :type => 'BSD' }
s.homepage = 'https://github.com/tonymillion/Reachability'
s. = { 'Tony Million' => '[email protected]' }
s.summary = 'ARC and GCD Compatible Reachability Class for iOS and OS X. Drop in replacement for Apple Reachability.'
s.source = { :git => 'https://github.com/tonymillion/Reachability.git', :tag => 'v3.1.0' }
s.source_files = 'Reachability.{h,m}'
s.framework = 'SystemConfiguration'
s.requires_arc = true
end
Defined Under Namespace
Modules: AttributeSupport, Deprecations, RootAttributesAccessors Classes: Attribute, PlatformProxy
Root specification A ‘root’ specification stores the information about the specific version of a library. The attributes in this group can only be written to on the ‘root’ specification, **not** on the ‘sub-specifications’. --- The attributes listed in this group are the only one which are required by a podspec. The attributes of the other groups are offered to refine the podspec and follow a convention over configuration approach. A root specification can describe these attributes either directly of through ‘[sub-specifications](#subspec)’. collapse
- LICENSE_KEYS =
The keys accepted by the license attribute.
[ :type, :file, :text ].freeze
- SOURCE_KEYS =
The keys accepted by the hash of the source attribute.
{ :git => [:tag, :branch, :commit, :submodules], :svn => [:folder, :tag, :revision], :hg => [:revision], :http => nil, :path => nil }.freeze
Platform A specification should indicate the platforms and the correspondent deployment targets on which the library is supported. If not defined in a subspec the attributes of this group inherit the value of the parent. collapse
- PLATFORMS =
The names of the platforms supported by the specification class.
[:osx, :ios].freeze
Root specification A ‘root’ specification stores the information about the specific version of a library. The attributes in this group can only be written to on the ‘root’ specification, **not** on the ‘sub-specifications’. --- The attributes listed in this group are the only one which are required by a podspec. The attributes of the other groups are offered to refine the podspec and follow a convention over configuration approach. A root specification can describe these attributes either directly of through ‘[sub-specifications](#subspec)’. collapse
-
#authors=(authors) ⇒ Object
The name and email address of each of the library’s the authors.
-
#description=(description) ⇒ Object
A description of the Pod more detailed than the summary.
-
#documentation_url=(documentation_url) ⇒ Object
An URL for the documentation of the Pod which will be honored by CocoaPods web properties.
-
#homepage=(homepage) ⇒ Object
The URL of the homepage of the Pod.
-
#license=(license) ⇒ Object
The license of the Pod.
-
#name=(name) ⇒ Object
The name of the Pod.
-
#prepare_command=(command) ⇒ Object
A bash script that will be executed after the Pod is downloaded.
-
#screenshots=(screenshots) ⇒ Object
A list of URLs to images showcasing the Pod.
-
#source=(source) ⇒ Object
The location from where the library should be retrieved.
-
#summary=(summary) ⇒ Object
A short (maximum 140 characters) description of the Pod.
-
#version=(version) ⇒ Object
The version of the Pod.
Platform A specification should indicate the platforms and the correspondent deployment targets on which the library is supported. If not defined in a subspec the attributes of this group inherit the value of the parent. collapse
-
#deployment_target=(*args) ⇒ Object
The minimum deployment targets of the supported platforms.
-
#platform=(args) ⇒ Object
The platform on which this Pod is supported.
Build settings In this group are listed the attributes related to the configuration of the build environment that should be used to build the library. If not defined in a subspec the attributes of this group inherit the value of the parent. collapse
-
#compiler_flags=(flags) ⇒ Object
A list of flags which should be passed to the compiler.
-
#dependency(*args) ⇒ Object
Any dependency on other Pods or to a ‘sub-specification’.
-
#frameworks=(*frameworks) ⇒ Object
A list of system frameworks that the user’s target needs to link against.
-
#header_dir=(dir) ⇒ Object
The directory where to store the headers files so they don’t break includes.
-
#header_mappings_dir=(dir) ⇒ Object
A directory from where to preserve the folder structure for the headers files.
-
#libraries=(*libraries) ⇒ Object
A list of libraries that the user’s target (application) needs to link against.
-
#prefix_header_contents=(content) ⇒ Object
Any content to inject in the prefix header of the pod project.
-
#prefix_header_file=(path) ⇒ Object
A path to a prefix header file to inject in the prefix header of the pod project.
-
#requires_arc=(flag) ⇒ Object
Wether the library requires ARC to be compiled.
-
#weak_frameworks=(*frameworks) ⇒ Object
A list of frameworks that the user’s target needs to weakly link against.
-
#xcconfig=(value) ⇒ Object
Any flag to add to the final xcconfig file.
File patterns Podspecs should be located at the **root** of the repository, and paths to files should be specified **relative** to the root of the repository as well. File patterns do not support traversing the parent directory ( `..` ). File patterns may contain the following wildcard patterns: --- ### Pattern: * Matches any file. Can be restricted by other values in the glob. * `*` will match all files * `c*` will match all files beginning with `c` * `*c` will match all files ending with `c` * `*c*` will match all files that have `c` in them (including at the beginning or end) Equivalent to `/.*/x` in regexp. **Note** this will not match Unix-like hidden files (dotfiles). In order to include those in the match results, you must use something like `{*,.*}`. --- ### Pattern: ** Matches directories recursively. --- ### Pattern: ? Matches any one character. Equivalent to `/.{1}/` in regexp. --- ### Pattern: [set] Matches any one character in set. Behaves exactly like character sets in Regexp, including set negation (`[^a-z]`). --- ### Pattern: {p,q} Matches either literal `p` or literal `q`. Matching literals may be more than one character in length. More than two literals may be specified. Equivalent to pattern alternation in regexp. --- ### Pattern: \ Escapes the next meta-character. --- ### Examples Consider these to be evaluated in the source root of [JSONKit](https://github.com/johnezang/JSONKit). "JSONKit.?" #=> ["JSONKit.h", "JSONKit.m"] "*.[a-z][a-z]" #=> ["CHANGELOG.md", "README.md"] "*.[^m]*" #=> ["JSONKit.h"] "*.{h,m}" #=> ["JSONKit.h", "JSONKit.m"] "*" #=> ["CHANGELOG.md", "JSONKit.h", "JSONKit.m", "README.md"] collapse
-
#exclude_files=(exclude_files) ⇒ Object
A list of file patterns that should be excluded from the other file patterns.
-
#preserve_paths=(preserve_paths) ⇒ Object
Any file that should not be removed after being downloaded.
-
#private_header_files=(private_header_files) ⇒ Object
A list of file patterns that should be used to mark private headers.
-
#public_header_files=(public_header_files) ⇒ Object
A list of file patterns that should be used as public headers.
-
#resource_bundles=(*frameworks) ⇒ Object
This attribute allows to define the name and the file of the resource bundles which should be built for the Pod.
-
#resources=(resources) ⇒ Object
A list of resources that should be copied into the target bundle.
-
#source_files=(source_files) ⇒ Object
The source files of the Pod.
-
#vendored_frameworks=(*frameworks) ⇒ Object
The paths of the framework bundles that come shipped with the Pod.
-
#vendored_libraries=(*frameworks) ⇒ Object
The paths of the libraries that come shipped with the Pod.
Subspecs A library can specify a dependency on either another library, a subspec of another library, or a subspec of itself. collapse
-
#default_subspec=(subspec_name) ⇒ Object
The name of the subspec that should be used as preferred dependency.
-
#subspec(name, &block) ⇒ Object
Represents specification for a module of the library.
Multi-Platform support A specification can store values which are specific to only one platform. --- For example one might want to store resources which are specific to only iOS projects. spec.resources = "Resources/**/*.png" spec.ios.resources = "Resources_ios/**/*.png" collapse
-
#ios ⇒ PlatformProxy
Provides support for specifying iOS attributes.
-
#osx ⇒ PlatformProxy
Provides support for specifying OS X attributes.
Class Method Summary collapse
-
.attributes ⇒ Array<Attribute>
The attributes of the class.
Methods included from AttributeSupport
Class Method Details
.attributes ⇒ Array<Attribute>
Returns The attributes of the class.
7 8 9 |
# File 'lib/cocoapods-core/specification/dsl/attribute_support.rb', line 7 def self.attributes @attributes end |
Instance Method Details
#authors=(authors) ⇒ Object
The name and email address of each of the library’s the authors.
126 127 128 129 130 131 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 126 root_attribute :authors, { :types => [ String, Array, Hash ], :container => Hash, :required => true, :singularize => true, } |
#compiler_flags=(flags) ⇒ Object
A list of flags which should be passed to the compiler.
613 614 615 616 617 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 613 attribute :compiler_flags, { :container => Array, :singularize => true, :inherited => true, } |
#default_subspec=(subspec_name) ⇒ Object
The name of the subspec that should be used as preferred dependency. If not specified a specifications requires all its subspecs as dependencies.
A Pod should make available the full library by default. Users can fine tune their dependencies, and exclude unneeded subspecs, once their requirements are known. Therefore, this attribute is rarely needed. It is intended to be used to select a default if there are ‘sub-specifications’ which provide alternative incompatible implementations, or to exclude modules rarely needed (especially if they trigger dependencies on other libraries).
1144 1145 1146 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1144 attribute :default_subspec, { :multi_platform => false, } |
#dependency(*args) ⇒ Object
Any dependency on other Pods or to a ‘sub-specification’.
Dependencies can specify versions requirements. The use of the approximate version indicator ‘~>` is recommended because it provides good control over the version without being too restrictive. For example, `~> 1.0.1` is equivalent to `>= 1.0.1` combined with `< 1.1`. Similarly, `~> 1.0` will match `1.0`, `1.0.1`, `1.1`, but will not upgrade to `2.0`.
Pods with overly restrictive dependencies limit their compatibility with other Pods.
498 499 500 501 502 503 504 505 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 498 def dependency(*args) name, *version_requirements = args raise Informative, "A specification can't require itself as a subspec" if name == self.name raise Informative, "A subspec can't require one of its parents specifications" if @parent && @parent.name.include?(name) raise Informative, "Unsupported version requirements" unless version_requirements.all? { |req| req.is_a?(String) } attributes_hash["dependencies"] ||= {} attributes_hash["dependencies"][name] = version_requirements end |
#deployment_target=(*args) ⇒ Object
The minimum deployment targets of the supported platforms.
The following behavior is regarding the use of GCD and the ‘OS_OBJECT_USE_OBJC` flag. When set to `0`, it will allow code to use `dispatch_release()` on >= iOS 6.0 and OS X >= 10.8.
-
New libraries that do not require ARC don’t need to care about this issue at all.
-
New libraries that do require ARC and have a deployment target of >= iOS 6.0 or OS X >= 10.8:
These *no longer* use ‘dispatch_release()` and should have the `OS_OBJECT_USE_OBJC` flag set to `1`.
Note: this means that these libraries have to specify the
deployment target in their specifications in order to have CocoaPods set the flag to `1` and ensure proper behavior.
-
New libraries that do require ARC, but have a deployment target of < iOS 6.0 or OS X < 10.8:
These contain ‘dispatch_release()` calls and as such need the `OS_OBJECT_USE_OBJC` flag set to `0`.
Note: libraries that do not specify a platform version are
assumed to have a deployment target of < iOS 6.0 or OS X < 10.8.
For more information, see: http://opensource.apple.com/source/libdispatch/libdispatch-228.18/os/object.h
453 454 455 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 453 def deployment_target=(*args) raise Informative, "The deployment target can be declared only per platform." end |
#description=(description) ⇒ Object
A description of the Pod more detailed than the summary.
277 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 277 root_attribute :description |
#documentation_url=(documentation_url) ⇒ Object
An URL for the documentation of the Pod which will be honored by CocoaPods web properties.
317 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 317 root_attribute :documentation_url |
#exclude_files=(exclude_files) ⇒ Object
A list of file patterns that should be excluded from the other file patterns.
1004 1005 1006 1007 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1004 attribute :exclude_files, { :container => Array, :file_patterns => true, } |
#frameworks=(*frameworks) ⇒ Object
A list of system frameworks that the user’s target needs to link against.
550 551 552 553 554 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 550 attribute :frameworks, { :container => Array, :singularize => true, :inherited => true, } |
#header_dir=(dir) ⇒ Object
The directory where to store the headers files so they don’t break includes.
702 703 704 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 702 attribute :header_dir, { :inherited => true } |
#header_mappings_dir=(dir) ⇒ Object
A directory from where to preserve the folder structure for the headers files. If not provided the headers files are flattened.
720 721 722 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 720 attribute :header_mappings_dir, { :inherited => true } |
#homepage=(homepage) ⇒ Object
The URL of the homepage of the Pod.
193 194 195 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 193 root_attribute :homepage, { :required => true, } |
#ios ⇒ PlatformProxy
Provides support for specifying iOS attributes.
1172 1173 1174 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1172 def ios PlatformProxy.new(self, :ios) end |
#libraries=(*libraries) ⇒ Object
A list of libraries that the user’s target (application) needs to link against.
594 595 596 597 598 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 594 attribute :libraries, { :container => Array, :singularize => true, :inherited => true, } |
#license=(license) ⇒ Object
The license of the Pod.
Unless the source contains a file named ‘LICENSE.*` or `LICENCE.*`, the path of the license file or the integral text of the notice commonly used for the license type must be specified.
This information is used by CocoaPods to generate acknowledgement files (markdown and plist) which can be used in the acknowledgements section of the final application.
174 175 176 177 178 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 174 root_attribute :license, { :container => Hash, :keys => LICENSE_KEYS, :required => true, } |
#name=(name) ⇒ Object
The name of the Pod.
82 83 84 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 82 root_attribute :name, { :required => true, } |
#osx ⇒ PlatformProxy
Provides support for specifying OS X attributes.
1183 1184 1185 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1183 def osx PlatformProxy.new(self, :osx) end |
#platform=(args) ⇒ Object
The platform on which this Pod is supported. Leaving this blank means the Pod is supported on all platforms.
396 397 398 399 400 401 402 403 404 405 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 396 def platform=(args) name, deployment_target = args if name attributes_hash["platforms"] = { name.to_s => deployment_target } else attributes_hash["platforms"] = {} end end |
#prefix_header_contents=(content) ⇒ Object
Any content to inject in the prefix header of the pod project.
This attribute is __not recommended__ as Pods should not pollute the prefix header of other libraries or of the user project.
659 660 661 662 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 659 attribute :prefix_header_contents, { :types => [Array, String], :inherited => true, } |
#prefix_header_file=(path) ⇒ Object
A path to a prefix header file to inject in the prefix header of the pod project.
This attribute is __not recommended__ as Pods should not pollute the prefix header of other libraries or of the user project.
683 684 685 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 683 attribute :prefix_header_file, { :inherited => true } |
#prepare_command=(command) ⇒ Object
A bash script that will be executed after the Pod is downloaded. This command can be used to create, delete and modify any file downloaded and will be ran before any paths for other file attributes of the specification are collected.
This command is executed before the Pod is cleaned and before the Pods project is created. The working directory is the root of the Pod.
If the pod is installed with the ‘:path` option this command will not be executed.
349 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 349 root_attribute :prepare_command |
#preserve_paths=(preserve_paths) ⇒ Object
Any file that should not be removed after being downloaded.
By default, CocoaPods removes all files that are not matched by any of the other file pattern.
1031 1032 1033 1034 1035 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1031 attribute :preserve_paths, { :container => Array, :file_patterns => true, :singularize => true } |
#private_header_files=(private_header_files) ⇒ Object
A list of file patterns that should be used to mark private headers.
These patterns are matched against the public headers (or all the headers if no public headers have been specified) to exclude those headers which should not be exposed to the user project and which should not be used to generate the documentation.
868 869 870 871 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 868 attribute :private_header_files, { :container => Array, :file_patterns => true, } |
#public_header_files=(public_header_files) ⇒ Object
A list of file patterns that should be used as public headers.
These are the headers that will be exposed to the user’s project and from which documentation will be generated. If no public headers are specified then all the headers are considered public.
843 844 845 846 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 843 attribute :public_header_files, { :container => Array, :file_patterns => true, } |
#requires_arc=(flag) ⇒ Object
Wether the library requires ARC to be compiled. If true the ‘-fobjc-arc` flag will be added to the compiler flags.
The default value of this attribute is __transitioning__ from ‘false` to `true`, and in the meanwhile this attribute is always required.
526 527 528 529 530 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 526 attribute :requires_arc, { :types => [TrueClass, FalseClass], :default_value => false, :inherited => true, } |
#resource_bundles=(*frameworks) ⇒ Object
This attribute allows to define the name and the file of the resource bundles which should be built for the Pod. They are specified as a hash where the keys represent the name of the bundles and the values the file patterns that they should include.
We strongly recommend library developers to adopt resource bundles as there can be name collisions using the resources attribute.
The names of the bundles should at least include the name of the Pod to minimize the change of name collisions.
To provide different resources per platform namespaced bundles must be used.
950 951 952 953 954 955 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 950 attribute :resource_bundles, { :types => [String, Array], :container => Hash, :file_patterns => true, :singularize => true, } |
#resources=(resources) ⇒ Object
A list of resources that should be copied into the target bundle.
We strongly recommend library developers to adopt [resource bundles](docs.cocoapods.org/specification.html#resources) as there can be name collisions using the resources attribute. Moreover resources specified with this attribute are copied directly to the client target and therefore they are not optimized by Xcode.
980 981 982 983 984 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 980 attribute :resources, { :container => Array, :file_patterns => true, :singularize => true, } |
#screenshots=(screenshots) ⇒ Object
A list of URLs to images showcasing the Pod. Intended for UI oriented libraries.
298 299 300 301 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 298 root_attribute :screenshots, { :singularize => true, :container => Array, } |
#source=(source) ⇒ Object
The location from where the library should be retrieved.
226 227 228 229 230 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 226 root_attribute :source, { :container => Hash, :keys => SOURCE_KEYS, :required => true, } |
#source_files=(source_files) ⇒ Object
The source files of the Pod.
819 820 821 822 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 819 attribute :source_files, { :container => Array, :file_patterns => true, } |
#subspec(name, &block) ⇒ Object
Represents specification for a module of the library.
Subspecs participate on a dual hierarchy.
On one side, a specification automatically inherits as a dependency all it children ‘sub-specifications’ (unless a default subspec is specified).
On the other side, a ‘sub-specification’ inherits the value of the attributes of the parents so common values for attributes can be specified in the ancestors.
Although it sounds complicated in practice it means that subspecs in general do what you would expect:
pod 'ShareKit', '2.0'
Installs ShareKit with all the sharers like ‘ShareKit/Evernote`, `ShareKit/Facebook`, etc, as they are defined a subspecs.
pod 'ShareKit/Twitter', '2.0'
pod 'ShareKit/Pinboard', '2.0'
Installs ShareKit with only the source files for ‘ShareKit/Twitter`, `ShareKit/Pinboard`. Note that, in this case, the ‘sub-specifications’ to compile need the source files, the dependencies, and the other attributes defined by the root specification. CocoaPods is smart enough to handle any issues arising from duplicate attributes.
1113 1114 1115 1116 1117 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1113 def subspec(name, &block) subspec = Specification.new(self, name, &block) @subspecs << subspec subspec end |
#summary=(summary) ⇒ Object
A short (maximum 140 characters) description of the Pod.
The description should be short, yet informative. It represents the tag line of the Pod and there is no need to specify that a Pod is a library (they always are).
The summary is expected to be properly capitalized and containing the correct punctuation.
254 255 256 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 254 root_attribute :summary, { :required => true, } |
#vendored_frameworks=(*frameworks) ⇒ Object
The paths of the framework bundles that come shipped with the Pod.
890 891 892 893 894 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 890 attribute :vendored_frameworks, { :container => Array, :file_patterns => true, :singularize => true, } |
#vendored_libraries=(*frameworks) ⇒ Object
The paths of the libraries that come shipped with the Pod.
913 914 915 916 917 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 913 attribute :vendored_libraries, { :container => Array, :file_patterns => true, :singularize => true, } |
#version=(version) ⇒ Object
The version of the Pod. CocoaPods follows [semantic versioning](semver.org).
100 101 102 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 100 root_attribute :version, { :required => true, } |
#weak_frameworks=(*frameworks) ⇒ Object
A list of frameworks that the user’s target needs to weakly link against.
570 571 572 573 574 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 570 attribute :weak_frameworks, { :container => Array, :singularize => true, :inherited => true, } |
#xcconfig=(value) ⇒ Object
Any flag to add to the final xcconfig file.
632 633 634 635 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 632 attribute :xcconfig, { :container => Hash, :inherited => true, } |