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](guides.cocoapods.org/terminal/commands.html#pod_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 |spec|
spec.name = 'Reachability'
spec.version = '3.1.0'
spec.license = { :type => 'BSD' }
spec.homepage = 'https://github.com/tonymillion/Reachability'
spec. = { 'Tony Million' => '[email protected]' }
spec.summary = 'ARC and GCD Compatible Reachability Class for iOS and OS X.'
spec.source = { :git => 'https://github.com/tonymillion/Reachability.git', :tag => 'v3.1.0' }
spec.source_files = 'Reachability.{h,m}'
spec.framework = 'SystemConfiguration'
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].freeze, :svn => [:folder, :tag, :revision].freeze, :hg => [:revision].freeze, :http => [:flatten, :type, :sha256, :sha1].freeze, :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, :watchos].freeze
Class Attribute Summary collapse
-
.attributes ⇒ Object
readonly
Returns the value of attribute attributes.
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 addresses of the library maintainers, not the Podspec maintainer.
-
#cocoapods_version=(cocoapods_version) ⇒ Object
The version of CocoaPods that the sepcification supports.
-
#deprecated=(flag) ⇒ Object
Whether the library has been deprecated.
-
#deprecated_in_favor_of=(deprecated_in_favor_of) ⇒ Object
The name of the Pod that this one has been deprecated in favor of.
-
#description=(description) ⇒ Object
A description of the Pod more detailed than the summary.
-
#docset_url=(docset_url) ⇒ Object
The URL for the docset for the Pod.
-
#documentation_url=(documentation_url) ⇒ Object
An optional URL for the documentation of the Pod which will be honoured 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.
-
#social_media_url=(social_media_url) ⇒ Object
The URL for the social media contact of the Pod, CocoaPods web services can use this.
-
#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 system libraries that the user’s target (application) needs to link against.
-
#module_name=(name) ⇒ Object
The name to use for the framework / clang module which will be generated for this specification instead of the default (header_dir if set, otherwise the specification name).
-
#pod_target_xcconfig=(value) ⇒ Object
Any flag to add to the final __private__ pod target xcconfig file.
-
#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
‘requires_arc` allows you to specify which source_files use ARC.
-
#user_target_xcconfig=(value) ⇒ Object
Specifies flags to add to the final aggregate target xcconfig file, which propagates to non-overridden and inheriting build settings to the integrated user targets.
-
#weak_frameworks=(*frameworks) ⇒ Object
A list of frameworks that the user’s target needs to weakly link against.
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.
-
#module_map=(module_map) ⇒ Object
The module map file that should be used when this pod is integrated as a framework.
-
#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_subspecs=(subspec_array) ⇒ Object
An array of subspecs names 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.
- #watchos ⇒ Object
Methods included from AttributeSupport
Class Attribute Details
.attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
7 8 9 |
# File 'lib/cocoapods-core/specification/dsl/attribute_support.rb', line 7 def attributes @attributes end |
Instance Method Details
#authors=(authors) ⇒ Object
The name and email addresses of the library maintainers, not the Podspec maintainer.
142 143 144 145 146 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 142 root_attribute :authors, :types => [String, Array, Hash], :container => Hash, :required => true, :singularize => true |
#cocoapods_version=(cocoapods_version) ⇒ Object
The version of CocoaPods that the sepcification supports.
117 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 117 root_attribute :cocoapods_version |
#compiler_flags=(flags) ⇒ Object
A list of flags which should be passed to the compiler.
731 732 733 734 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 731 attribute :compiler_flags, :container => Array, :singularize => true, :inherited => true |
#default_subspecs=(subspec_array) ⇒ Object
An array of subspecs names 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).
1329 1330 1331 1332 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1329 attribute :default_subspecs, :container => Array, :singularize => true, :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 optimistic 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.
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 594 def dependency(*args) name, *version_requirements = args if name == self.name raise Informative, "A specification can't require itself as a " \ 'subspec' end if @parent composed_name = '' @parent.name.split('/').each do |component| composed_name << component if name == composed_name raise Informative, "A subspec can't require one of its " \ 'parents specifications' else composed_name << '/' end end end unless version_requirements.all? { |req| req.is_a?(String) } raise Informative, 'Unsupported version requirements' end 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 behaviour.
-
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
549 550 551 552 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 549 def deployment_target=(*_args) raise Informative, 'The deployment target can be declared only per ' \ 'platform.' end |
#deprecated=(flag) ⇒ Object
Whether the library has been deprecated.
432 433 434 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 432 root_attribute :deprecated, :types => [TrueClass, FalseClass], :default_value => false |
#deprecated_in_favor_of=(deprecated_in_favor_of) ⇒ Object
The name of the Pod that this one has been deprecated in favor of.
448 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 448 root_attribute :deprecated_in_favor_of |
#description=(description) ⇒ Object
A description of the Pod more detailed than the summary.
345 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 345 root_attribute :description |
#docset_url=(docset_url) ⇒ Object
The URL for the docset for the Pod
184 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 184 root_attribute :docset_url |
#documentation_url=(documentation_url) ⇒ Object
An optional URL for the documentation of the Pod which will be honoured by CocoaPods web properties. Leaving it blank will default to a CocoaDocs generated URL for your library.
385 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 385 root_attribute :documentation_url |
#exclude_files=(exclude_files) ⇒ Object
A list of file patterns that should be excluded from the other file patterns.
1165 1166 1167 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1165 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.
671 672 673 674 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 671 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.
868 869 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 868 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.
885 886 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 885 attribute :header_mappings_dir, :inherited => true |
#homepage=(homepage) ⇒ Object
The URL of the homepage of the Pod.
247 248 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 247 root_attribute :homepage, :required => true |
#ios ⇒ PlatformProxy
Provides support for specifying iOS attributes.
1358 1359 1360 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1358 def ios PlatformProxy.new(self, :ios) end |
#libraries=(*libraries) ⇒ Object
A list of system libraries that the user’s target (application) needs to link against.
713 714 715 716 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 713 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. If a license file is specified, it either must be without a file extensions or be one of `txt`, `md`, or `markdown`.
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.
229 230 231 232 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 229 root_attribute :license, :container => Hash, :keys => LICENSE_KEYS, :required => true |
#module_map=(module_map) ⇒ Object
The module map file that should be used when this pod is integrated as a framework.
By default, CocoaPods creates a module map file based upon the public headers in a specification.
1215 1216 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1215 attribute :module_map, :root_only => true |
#module_name=(name) ⇒ Object
The name to use for the framework / clang module which will be generated for this specification instead of the default (header_dir if set, otherwise the specification name).
852 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 852 root_attribute :module_name |
#name=(name) ⇒ Object
The name of the Pod.
81 82 83 84 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 81 attribute :name, :required => true, :inherited => false, :multi_platform => false |
#osx ⇒ PlatformProxy
Provides support for specifying OS X attributes.
1369 1370 1371 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1369 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.
494 495 496 497 498 499 500 501 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 494 def platform=(args) name, deployment_target = args if name attributes_hash['platforms'] = { name.to_s => deployment_target } else attributes_hash['platforms'] = {} end end |
#pod_target_xcconfig=(value) ⇒ Object
Any flag to add to the final __private__ pod target xcconfig file.
749 750 751 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 749 attribute :pod_target_xcconfig, :container => Hash, :inherited => true |
#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.
810 811 812 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 810 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.
833 834 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 833 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.
417 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 417 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.
1191 1192 1193 1194 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1191 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.
1030 1031 1032 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1030 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.
1006 1007 1008 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1006 attribute :public_header_files, :container => Array, :file_patterns => true |
#requires_arc=(flag) ⇒ Object
‘requires_arc` allows you to specify which source_files use ARC. This can either be the files which support ARC, or true to indicate all of the source_files use ARC.
Files which do not use ARC will have the ‘-fno-objc-arc` compiler flag.
The default value of this attribute is ‘true`.
647 648 649 650 651 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 647 attribute :requires_arc, :types => [TrueClass, FalseClass, String, Array], :file_patterns => true, :default_value => true, :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 minimise the chance of name collisions.
To provide different resources per platform namespaced bundles must be used.
1112 1113 1114 1115 1116 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1112 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](guides.cocoapods.org/syntax/podspec.html#resource_bundles) 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 optimised by Xcode.
1142 1143 1144 1145 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1142 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. CocoaPods recommends the usage of the ‘gif` format.
366 367 368 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 366 root_attribute :screenshots, :singularize => true, :container => Array |
#social_media_url=(social_media_url) ⇒ Object
The URL for the social media contact of the Pod, CocoaPods web services can use this.
For example, the @CocoaPodsFeed notifications will include the Twitter handle (shortening the description) if the URL is relative to Twitter. This does not necessarily have to be a Twitter URL, but only those are included in the Twitter @CocoaPodsFeed notifications.
171 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 171 root_attribute :social_media_url |
#source=(source) ⇒ Object
The location from where the library should be retrieved.
296 297 298 299 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 296 root_attribute :source, :container => Hash, :keys => SOURCE_KEYS, :required => true |
#source_files=(source_files) ⇒ Object
The source files of the Pod.
983 984 985 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 983 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 as 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.
1294 1295 1296 1297 1298 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1294 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 capitalised and containing the correct punctuation.
323 324 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 323 root_attribute :summary, :required => true |
#user_target_xcconfig=(value) ⇒ Object
Specifies flags to add to the final aggregate target xcconfig file, which propagates to non-overridden and inheriting build settings to the integrated user targets.
This attribute is __not recommended__ as Pods should not pollute the build settings of the user project and this can cause conflicts.
Multiple definitions for build settings that take multiple values will be merged. The user is warned on conflicting definitions for custom build settings and build settings that take only one value.
Typically clang compiler flags or precompiler macro definitions go in here if they are required when importing the pod in the user target. Note that, this influences not only the compiler view of the public interface of your pod, but also all other integrated pods alongside to yours. You should always prefer [‘pod_target_xcconfig`]( guides.cocoapods.org/syntax/podspec.html#pod_target_xcconfig), which can contain the same settings, but only influence the toolchain when compiling your pod target.
784 785 786 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 784 attribute :user_target_xcconfig, :container => Hash, :inherited => true |
#vendored_frameworks=(*frameworks) ⇒ Object
The paths of the framework bundles that come shipped with the Pod.
1051 1052 1053 1054 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1051 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.
1073 1074 1075 1076 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1073 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 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 100 root_attribute :version, :required => true |
#watchos ⇒ Object
1373 1374 1375 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 1373 def watchos PlatformProxy.new(self, :watchos) end |
#weak_frameworks=(*frameworks) ⇒ Object
A list of frameworks that the user’s target needs to weakly link against.
690 691 692 693 |
# File 'lib/cocoapods-core/specification/dsl.rb', line 690 attribute :weak_frameworks, :container => Array, :singularize => true, :inherited => true |