Class: Pod::Specification
- Inherits:
-
Object
- Object
- Pod::Specification
- Includes:
- DSL, DSL::Deprecations, JSONSupport, RootAttributesAccessors
- Defined in:
- lib/cocoapods-core/specification.rb,
lib/cocoapods-core/specification/dsl.rb,
lib/cocoapods-core/specification/set.rb,
lib/cocoapods-core/specification/json.rb,
lib/cocoapods-core/specification/linter.rb,
lib/cocoapods-core/specification/consumer.rb,
lib/cocoapods-core/specification/dsl/attribute.rb,
lib/cocoapods-core/specification/set/presenter.rb,
lib/cocoapods-core/specification/set/statistics.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
The Specification provides a DSL to describe a Pod. A pod is defined as a library originating from a source. A specification can support detailed attributes for modules of code through subspecs.
Usually it is stored in files with ‘podspec` extension.
Defined Under Namespace
Modules: DSL, JSONSupport Classes: Consumer, Linter, Set
Constant Summary
Constants included from DSL::Deprecations
DSL::Deprecations::DEPRECATED_METHODS
Constants included from DSL
DSL::LICENSE_KEYS, DSL::PLATFORMS, DSL::SOURCE_KEYS
Deprecated Hooks support collapse
-
#post_install_callback ⇒ Proc
readonly
The post install callback if defined.
-
#pre_install_callback ⇒ Proc
readonly
The pre install callback if defined.
Instance Attribute Summary collapse
-
#attributes_hash ⇒ Hash
The hash that stores the information of the attributes of the specification.
-
#parent ⇒ Specification
readonly
The parent of the specification unless the specification is a root.
-
#subspecs ⇒ Array<Specification>
The subspecs of the specification.
Hierarchy collapse
-
#root ⇒ Specification
The root specification or itself if it is root.
-
#root? ⇒ Bool
Whether the specification is root.
-
#subspec? ⇒ Bool
Whether the specification is a subspec.
Dependencies & Subspecs collapse
-
#all_dependencies(platform = nil) ⇒ Array<Dependency>
All the dependencies of the specification.
-
#consumer(platform) ⇒ Specification::Consumer
Returns a consumer to access the multi-platform attributes.
-
#default_subspec ⇒ String
The name of the default subspec if provided.
-
#dependencies(platform = nil) ⇒ Array<Dependency>
Returns the dependencies on other Pods or subspecs of other Pods.
-
#recursive_subspecs ⇒ Array<Specifications>
The recursive list of all the subspecs of a specification.
-
#subspec_by_name(relative_name) ⇒ Specification
Returns the subspec with the given name or the receiver if the name is nil or equal to the name of the receiver.
-
#subspec_dependencies(platform = nil) ⇒ Array<Dependency>
Returns the dependencies on subspecs.
DSL helpers collapse
-
#available_platforms ⇒ Array<Platform>
The platforms that the Pod is supported on.
-
#deployment_target(platform_name) ⇒ String, Nil
Returns the deployment target for the specified platform.
-
#local? ⇒ Bool
Whether the specification should use a directory as it source.
-
#supported_on_platform?(*platform) ⇒ Bool
Whether the specification is supported in the given platform.
Deprecated Hooks support collapse
-
#post_install!(target_installer) ⇒ Bool
Calls the post install callback if defined.
-
#pre_install!(pod, target_definition) ⇒ Bool
Calls the pre install callback if defined.
DSL attribute writers collapse
-
#store_attribute(name, value, platform_name = nil) ⇒ Object
Sets the value for the attribute with the given name.
File representation collapse
-
.from_file(path, subspec_name = nil) ⇒ Specification
Loads a specification form the given path.
-
.from_string(spec_contents, path, subspec_name = nil) ⇒ Specification
Loads a specification with the given string.
- #checksum ⇒ String, Nil
-
#defined_in_file ⇒ String
The path where the specification is defined, if loaded from a file.
Class Method Summary collapse
-
.from_hash(hash, parent = nil) ⇒ Specification
Configures a new specification from the given hash.
-
.from_json(json) ⇒ Specification
Configures a new specification from the given JSON representation.
-
.name_and_version_from_string(string_representation) ⇒ Array<String, Version>
The name and the version of a pod.
-
.root_name(full_name) ⇒ String
Returns the root name of a specification.
Instance Method Summary collapse
-
#==(other) ⇒ Bool
Checks if a specification is equal to the given one according its name and to its version.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Return the hash value for this specification according to its attributes hash.
-
#initialize(parent = nil, name = nil) {|_self| ... } ⇒ Specification
constructor
A new instance of Specification.
-
#inspect ⇒ String
A string suitable for debugging.
-
#to_s ⇒ String
A string suitable for representing the specification in clients.
Methods included from JSONSupport
#safe_to_hash?, #to_hash, #to_json
Methods included from DSL::Deprecations
#clean_paths=, #documentation=, #post_install, #pre_install, #preferred_dependency=, #singleton_method_added
Methods included from DSL
attributes, #authors=, #compiler_flags=, #default_subspec=, #dependency, #deployment_target=, #description=, #docset_url=, #documentation_url=, #exclude_files=, #frameworks=, #header_dir=, #header_mappings_dir=, #homepage=, #ios, #libraries=, #license=, #name=, #osx, #platform=, #prefix_header_contents=, #prefix_header_file=, #prepare_command=, #preserve_paths=, #private_header_files=, #public_header_files=, #requires_arc=, #resource_bundles=, #resources=, #screenshots=, #social_media_url=, #source=, #source_files=, #subspec, #summary=, #vendored_frameworks=, #vendored_libraries=, #version=, #weak_frameworks=, #xcconfig=
Methods included from DSL::AttributeSupport
Constructor Details
#initialize(parent = nil, name = nil) {|_self| ... } ⇒ Specification
Returns a new instance of Specification.
33 34 35 36 37 38 39 40 41 |
# File 'lib/cocoapods-core/specification.rb', line 33 def initialize(parent = nil, name = nil) @attributes_hash = {} @subspecs = [] @consumers = {} @parent = parent attributes_hash['name'] = name yield self if block_given? end |
Instance Attribute Details
#attributes_hash ⇒ Hash
Returns the hash that stores the information of the attributes of the specification.
46 47 48 |
# File 'lib/cocoapods-core/specification.rb', line 46 def attributes_hash @attributes_hash end |
#parent ⇒ Specification (readonly)
Returns the parent of the specification unless the specification is a root.
26 27 28 |
# File 'lib/cocoapods-core/specification.rb', line 26 def parent @parent end |
#post_install_callback ⇒ Proc (readonly)
Returns the post install callback if defined.
389 390 391 |
# File 'lib/cocoapods-core/specification.rb', line 389 def post_install_callback @post_install_callback end |
#pre_install_callback ⇒ Proc (readonly)
Returns the pre install callback if defined.
385 386 387 |
# File 'lib/cocoapods-core/specification.rb', line 385 def pre_install_callback @pre_install_callback end |
#subspecs ⇒ Array<Specification>
Returns The subspecs of the specification.
50 51 52 |
# File 'lib/cocoapods-core/specification.rb', line 50 def subspecs @subspecs end |
Class Method Details
.from_file(path, subspec_name = nil) ⇒ Specification
Loads a specification form the given path.
531 532 533 534 535 536 537 538 539 540 541 542 543 544 |
# File 'lib/cocoapods-core/specification.rb', line 531 def self.from_file(path, subspec_name = nil) path = Pathname.new(path) unless path.exist? raise Informative, "No podspec exists at path `#{path}`." end string = File.open(path, 'r:utf-8') { |f| f.read } # Work around for Rubinius incomplete encoding in 1.9 mode if string.respond_to?(:encoding) && string.encoding.name != "UTF-8" string.encode!('UTF-8') end from_string(string, path, subspec_name) end |
.from_hash(hash, parent = nil) ⇒ Specification
Configures a new specification from the given hash.
54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/cocoapods-core/specification/json.rb', line 54 def self.from_hash(hash, parent = nil) spec = Spec.new(parent) attributes_hash = hash.dup subspecs = attributes_hash.delete('subspecs') spec.attributes_hash = attributes_hash if subspecs spec.subspecs = subspecs.map do |s_hash| Specification.from_hash(s_hash, spec) end end spec end |
.from_json(json) ⇒ Specification
Configures a new specification from the given JSON representation.
41 42 43 44 45 |
# File 'lib/cocoapods-core/specification/json.rb', line 41 def self.from_json(json) require 'json' hash = JSON.parse(json) from_hash(hash) end |
.from_string(spec_contents, path, subspec_name = nil) ⇒ Specification
Loads a specification with the given string.
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 |
# File 'lib/cocoapods-core/specification.rb', line 556 def self.from_string(spec_contents, path, subspec_name = nil) path = Pathname.new(path) case path.extname when '.podspec' spec = ::Pod._eval_podspec(spec_contents, path) unless spec.is_a?(Specification) raise Informative, "Invalid podspec file at path `#{path}`." end when '.json' spec = Specification.from_json(spec_contents) else raise Informative, "Unsupported specification format `#{path.extname}`." end spec.defined_in_file = path spec.subspec_by_name(subspec_name) end |
.name_and_version_from_string(string_representation) ⇒ Array<String, Version>
Returns the name and the version of a pod.
126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/cocoapods-core/specification.rb', line 126 def self.name_and_version_from_string(string_representation) match_data = string_representation.match(/(\S*) \((.*)\)/) unless match_data raise Informative, "Invalid string representation for a " \ "Specification: `#{string_representation}`." \ "String representation should include the name and " \ "the version of a pod." end name = match_data[1] vers = Version.new(match_data[2]) [name, vers] end |
.root_name(full_name) ⇒ String
Returns the root name of a specification.
145 146 147 |
# File 'lib/cocoapods-core/specification.rb', line 145 def self.root_name(full_name) full_name.split('/').first end |
Instance Method Details
#==(other) ⇒ Bool
Not sure if comparing only the name and the version is the way to go. This is used by the installer to group specifications by root spec.
Checks if a specification is equal to the given one according its name and to its version.
64 65 66 67 68 69 70 71 72 |
# File 'lib/cocoapods-core/specification.rb', line 64 def ==(other) # TODO # self.class === other && # attributes_hash == other.attributes_hash && # subspecs == other.subspecs && # pre_install_callback == other.pre_install_callback && # post_install_callback == other.post_install_callback to_s == other.to_s end |
#all_dependencies(platform = nil) ⇒ Array<Dependency>
Returns all the dependencies of the specification.
267 268 269 |
# File 'lib/cocoapods-core/specification.rb', line 267 def all_dependencies(platform = nil) dependencies(platform) + subspec_dependencies(platform) end |
#available_platforms ⇒ Array<Platform>
If no platform is specified, this method returns all known platforms.
Returns The platforms that the Pod is supported on.
322 323 324 325 326 |
# File 'lib/cocoapods-core/specification.rb', line 322 def available_platforms names = supported_platform_names names = PLATFORMS if names.empty? names.map { |name| Platform.new(name, deployment_target(name)) } end |
#checksum ⇒ String, Nil
501 502 503 504 505 506 507 508 |
# File 'lib/cocoapods-core/specification.rb', line 501 def checksum require 'digest' unless defined_in_file.nil? checksum = Digest::SHA1.hexdigest(File.read(defined_in_file)) checksum = checksum.encode('UTF-8') if checksum.respond_to?(:encode) checksum end end |
#consumer(platform) ⇒ Specification::Consumer
Returns a consumer to access the multi-platform attributes.
278 279 280 281 |
# File 'lib/cocoapods-core/specification.rb', line 278 def consumer(platform) platform = platform.to_sym @consumers[platform] ||= Consumer.new(self, platform) end |
#default_subspec ⇒ String
Returns the name of the default subspec if provided.
221 222 223 |
# File 'lib/cocoapods-core/specification.rb', line 221 def default_subspec attributes_hash["default_subspec"] end |
#defined_in_file ⇒ String
Returns the path where the specification is defined, if loaded from a file.
513 514 515 |
# File 'lib/cocoapods-core/specification.rb', line 513 def defined_in_file root? ? @defined_in_file : root.defined_in_file end |
#dependencies(platform = nil) ⇒ Array<Dependency>
External dependencies are inherited by subspecs
Returns the dependencies on other Pods or subspecs of other Pods.
255 256 257 258 259 260 261 262 263 |
# File 'lib/cocoapods-core/specification.rb', line 255 def dependencies(platform = nil) if platform consumer(platform).dependencies || [] else available_platforms.map do |spec_platform| consumer(spec_platform).dependencies end.flatten.uniq end end |
#deployment_target(platform_name) ⇒ String, Nil
Returns the deployment target for the specified platform.
336 337 338 339 340 |
# File 'lib/cocoapods-core/specification.rb', line 336 def deployment_target(platform_name) result = platform_hash[platform_name.to_s] result ||= parent.deployment_target(platform_name) if parent result end |
#eql?(other) ⇒ Boolean
76 77 78 |
# File 'lib/cocoapods-core/specification.rb', line 76 def eql?(other) self == other end |
#hash ⇒ Fixnum
This function must have the property that a.eql?(b) implies a.hash == b.hash.
This method is used by the Hash class.
Return the hash value for this specification according to its attributes hash.
90 91 92 |
# File 'lib/cocoapods-core/specification.rb', line 90 def hash to_s.hash end |
#inspect ⇒ String
Returns A string suitable for debugging.
109 110 111 |
# File 'lib/cocoapods-core/specification.rb', line 109 def inspect "#<#{self.class.name} name=#{name.inspect}>" end |
#local? ⇒ Bool
Returns whether the specification should use a directory as it source.
292 293 294 |
# File 'lib/cocoapods-core/specification.rb', line 292 def local? !(source[:path] || source[:local]).nil? rescue false end |
#post_install!(target_installer) ⇒ Bool
Calls the post install callback if defined.
419 420 421 422 423 |
# File 'lib/cocoapods-core/specification.rb', line 419 def post_install!(target_installer) return false unless @post_install_callback @post_install_callback.call(target_installer) true end |
#pre_install!(pod, target_definition) ⇒ Bool
Calls the pre install callback if defined.
404 405 406 407 408 |
# File 'lib/cocoapods-core/specification.rb', line 404 def pre_install!(pod, target_definition) return false unless @pre_install_callback @pre_install_callback.call(pod, target_definition) true end |
#recursive_subspecs ⇒ Array<Specifications>
Returns the recursive list of all the subspecs of a specification.
182 183 184 185 186 187 188 189 |
# File 'lib/cocoapods-core/specification.rb', line 182 def recursive_subspecs mapper = lambda do |spec| spec.subspecs.map do |subspec| [subspec, *mapper.call(subspec)] end.flatten end mapper.call(self) end |
#root ⇒ Specification
Returns The root specification or itself if it is root.
157 158 159 |
# File 'lib/cocoapods-core/specification.rb', line 157 def root parent ? parent.root : self end |
#root? ⇒ Bool
Returns whether the specification is root.
163 164 165 |
# File 'lib/cocoapods-core/specification.rb', line 163 def root? parent.nil? end |
#store_attribute(name, value, platform_name = nil) ⇒ Object
If the provides value is Hash the keys are converted to a string.
Sets the value for the attribute with the given name.
446 447 448 449 450 451 452 453 454 455 456 |
# File 'lib/cocoapods-core/specification.rb', line 446 def store_attribute(name, value, platform_name = nil) name = name.to_s value = convert_keys_to_string(value) if value.is_a?(Hash) if platform_name platform_name = platform_name.to_s attributes_hash[platform_name] ||= {} attributes_hash[platform_name][name] = value else attributes_hash[name] = value end end |
#subspec? ⇒ Bool
Returns whether the specification is a subspec.
169 170 171 |
# File 'lib/cocoapods-core/specification.rb', line 169 def subspec? !parent.nil? end |
#subspec_by_name(relative_name) ⇒ Specification
Returns the subspec with the given name or the receiver if the name is nil or equal to the name of the receiver.
204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/cocoapods-core/specification.rb', line 204 def subspec_by_name(relative_name) if relative_name.nil? || relative_name == base_name self else remainder = relative_name[base_name.size + 1..-1] subspec_name = remainder.split('/').shift subspec = subspecs.find { |s| s.name == "#{name}/#{subspec_name}" } unless subspec raise Informative, "Unable to find a specification named " \ "`#{relative_name}` in `#{name} (#{version})`." end subspec.subspec_by_name(remainder) end end |
#subspec_dependencies(platform = nil) ⇒ Array<Dependency>
A specification has a dependency on either the #default_subspec or each of its children subspecs that are compatible with its platform.
Returns the dependencies on subspecs.
233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/cocoapods-core/specification.rb', line 233 def subspec_dependencies(platform = nil) if default_subspec specs = [subspec_by_name("#{name}/#{default_subspec}")] else specs = subspecs.compact end if platform specs = specs.select { |s| s.supported_on_platform?(platform) } end specs.map { |s| Dependency.new(s.name) } end |
#supported_on_platform?(platform) ⇒ Bool #supported_on_platform?(symbolic_name, deployment_target) ⇒ Bool
Returns whether the specification is supported in the given platform.
312 313 314 315 |
# File 'lib/cocoapods-core/specification.rb', line 312 def supported_on_platform?(*platform) platform = Platform.new(*platform) available_platforms.any? { |available| platform.supports?(available) } end |
#to_s ⇒ String
Returns A string suitable for representing the specification in clients.
97 98 99 100 101 102 103 104 105 |
# File 'lib/cocoapods-core/specification.rb', line 97 def to_s if name && !version.version.empty? "#{name} (#{version})" elsif name name else "No-name" end end |