Class: Pod::Dependency
- Inherits:
-
Object
- Object
- Pod::Dependency
- Defined in:
- lib/cocoapods-core/dependency.rb
Overview
The Dependency allows to specify dependencies of a Podfile or a Specification on a Pod. It stores the name of the dependency, version requirements and external sources information.
This class is based on the dependency class of RubyGems and mimics its implementation with adjustments specific to CocoaPods. RubyGems is available under the [MIT license](github.com/rubygems/rubygems/blob/master/MIT.txt).
Instance Attribute Summary collapse
-
#external_source ⇒ Hash{Symbol=>String}
A hash describing the external source where the pod should be fetched.
-
#name ⇒ String
The name of the Pod described by this dependency.
-
#podspec_repo ⇒ String
The source URL of the podspec repo to use to resolve this dependency.
-
#specific_version ⇒ Version
Whether the dependency points to a specific version.
Class Method Summary collapse
-
.from_string(string) ⇒ Dependency
Generates a dependency from its string representation.
Instance Method Summary collapse
-
#<=>(other) ⇒ Fixnum
How the dependency should be sorted respect to another one according to its name.
-
#==(other) ⇒ Bool
(also: #eql?)
Whether the dependency is equal to another taking into account the loaded specification, the head options and the external source.
-
#compatible?(other) ⇒ Bool
Checks if a dependency would be satisfied by the requirements of another dependency.
-
#external? ⇒ Bool
Whether the dependency points to an external source.
-
#hash ⇒ Object
@return [Fixnum] The hash value based on the name and on the requirements.
-
#initialize(name = nil, *requirements) ⇒ Dependency
constructor
A new instance of Dependency.
-
#inspect ⇒ String
A string representation suitable for debugging.
-
#local? ⇒ Bool
Whether the dependency points to a local path.
-
#match?(name, version) ⇒ Bool
Checks whether the dependency would be satisfied by the specification with the given name and version.
-
#merge(other) ⇒ Dependency
Merges the version requirements of the dependency with another one.
-
#prerelease? ⇒ Bool
Whether the dependency has any pre-release requirements.
-
#requirement ⇒ Requirement
The requirement of this dependency (a set of one or more version restrictions).
-
#root_name ⇒ String
Returns the name of the Pod that the dependency is pointing to.
-
#subspec_dependency? ⇒ Bool
Whether the dependency points to a subspec.
-
#to_root_dependency ⇒ Dependency
Creates a new dependency with the name of the top level spec and the same version requirements.
-
#to_s ⇒ String
Creates a string representation of the dependency suitable for serialization and de-serialization without loss of information.
Constructor Details
#initialize(name, requirements) ⇒ Dependency #initialize(name, external_source) ⇒ Dependency #initialize(name, requirements, podspec_repo) ⇒ Dependency #initialize(name, is_head) ⇒ Dependency
Returns a new instance of Dependency.
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/cocoapods-core/dependency.rb', line 86 def initialize(name = nil, *requirements) if requirements.last.is_a?(Hash) additional_params = requirements.pop.select { |_, v| !v.nil? } additional_params = nil if additional_params.empty? if additional_params && @podspec_repo = additional_params[:source] # This dependency specifies the exact source podspec repo to use. additional_params.delete(:source) unless additional_params.empty? raise Informative, 'A dependency with a specified podspec repo may ' \ "not include other source parameters (#{name})." end elsif @external_source = additional_params unless requirements.empty? raise Informative, 'A dependency with an external source may not ' \ "specify version requirements (#{name})." end end elsif requirements.last == :head raise Informative, '`:head` dependencies have been removed. Please use ' \ "normal external source dependencies (`:git => 'GIT_REPO_URL'`) " \ "instead of `:head` for `#{name}`." end if requirements.length == 1 && requirements.first.is_a?(Requirement) requirements = requirements.first end @name = name @requirement = Requirement.create(requirements) end |
Instance Attribute Details
#external_source ⇒ Hash{Symbol=>String}
Returns a hash describing the external source where the pod should be fetched. The external source has to provide its own Specification file.
20 21 22 |
# File 'lib/cocoapods-core/dependency.rb', line 20 def external_source @external_source end |
#name ⇒ String
Returns The name of the Pod described by this dependency.
14 15 16 |
# File 'lib/cocoapods-core/dependency.rb', line 14 def name @name end |
#podspec_repo ⇒ String
Returns The source URL of the podspec repo to use to resolve this dependency. If not set then the standard source list should be used to resolve the dependency.
25 26 27 |
# File 'lib/cocoapods-core/dependency.rb', line 25 def podspec_repo @podspec_repo end |
#specific_version ⇒ Version
Returns whether the dependency points to a specific version.
120 121 122 |
# File 'lib/cocoapods-core/dependency.rb', line 120 def specific_version @specific_version end |
Class Method Details
.from_string(string) ⇒ Dependency
Remove the ‘HEAD` code once everyone has migrated past 1.0.
The information about external sources is not completely serialized in the string representation and should be stored a part by clients that need to create a dependency equal to the original one.
Generates a dependency from its string representation.
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 |
# File 'lib/cocoapods-core/dependency.rb', line 364 def self.from_string(string) match_data = string.match(/((?:\s?[^\s(])+)( (?:.*))?/) name = match_data[1] version = match_data[2] version = version.gsub(/[()]/, '') if version case version when / HEAD( \(based on #{Pod::Version::VERSION_PATTERN}\))?/ CoreUI.warn "Ignoring obsolete `HEAD` specifier in `#{string}`" Dependency.new(name) when nil, /from `(.*)(`|')/ Dependency.new(name) else version_requirements = version.split(',') if version Dependency.new(name, version_requirements) end end |
Instance Method Details
#<=>(other) ⇒ Fixnum
Returns How the dependency should be sorted respect to another one according to its name.
233 234 235 |
# File 'lib/cocoapods-core/dependency.rb', line 233 def <=>(other) name <=> other.name end |
#==(other) ⇒ Bool Also known as: eql?
Returns whether the dependency is equal to another taking into account the loaded specification, the head options and the external source.
214 215 216 217 218 219 220 |
# File 'lib/cocoapods-core/dependency.rb', line 214 def ==(other) self.class == other.class && name == other.name && requirement == other.requirement && external_source == other.external_source && podspec_repo == other.podspec_repo end |
#compatible?(other) ⇒ Bool
This is used by the Lockfile to check if a stored dependency is still compatible with the Podfile.
Checks if a dependency would be satisfied by the requirements of another dependency.
201 202 203 204 205 206 207 208 |
# File 'lib/cocoapods-core/dependency.rb', line 201 def compatible?(other) return false unless name == other.name return false unless external_source == other.external_source other.requirement.requirements.all? do |_operator, version| requirement.satisfied_by? Version.new(version) end end |
#external? ⇒ Bool
Returns whether the dependency points to an external source.
145 146 147 |
# File 'lib/cocoapods-core/dependency.rb', line 145 def external? !@external_source.nil? end |
#hash ⇒ Object
@return [Fixnum] The hash value based on the name and on the
requirements.
226 227 228 |
# File 'lib/cocoapods-core/dependency.rb', line 226 def hash name.hash ^ requirement.hash end |
#inspect ⇒ String
Returns a string representation suitable for debugging.
383 384 385 386 |
# File 'lib/cocoapods-core/dependency.rb', line 383 def inspect "<#{self.class} name=#{name} requirements=#{requirement} " \ "source=#{podspec_repo || 'nil'} external_source=#{external_source || 'nil'}>" end |
#local? ⇒ Bool
Returns whether the dependency points to a local path.
151 152 153 154 155 |
# File 'lib/cocoapods-core/dependency.rb', line 151 def local? if external_source external_source[:path] end end |
#match?(name, version) ⇒ Bool
Checks whether the dependency would be satisfied by the specification with the given name and version.
309 310 311 312 313 |
# File 'lib/cocoapods-core/dependency.rb', line 309 def match?(name, version) return false unless self.name == name return true if requirement.none? requirement.satisfied_by?(Version.new(version)) end |
#merge(other) ⇒ Dependency
If one of the dependencies specifies an external source or is head, the resulting dependency preserves this attributes.
Merges the version requirements of the dependency with another one.
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/cocoapods-core/dependency.rb', line 248 def merge(other) unless name == other.name raise ArgumentError, "#{self} and #{other} have different names" end default = Requirement.default self_req = requirement other_req = other.requirement req = if other_req == default self_req elsif self_req == default other_req else self_req.as_list.concat(other_req.as_list) end opts = {} if external_source || other.external_source opts. merge!(external_source || {}). merge!(other.external_source || {}) req_to_set = req req = [] end if podspec_repo && other.podspec_repo && podspec_repo != other.podspec_repo raise ArgumentError, "#{self} and #{other} have different podspec repos" end if repo = podspec_repo || other.podspec_repo opts[:source] = repo end self.class.new(name, *req, opts).tap do |dep| dep.instance_variable_set(:@requirement, Requirement.create(req_to_set)) if req_to_set end end |
#prerelease? ⇒ Bool
Whether the dependency has any pre-release requirements
293 294 295 296 |
# File 'lib/cocoapods-core/dependency.rb', line 293 def prerelease? @prerelease ||= requirement.requirements. any? { |r| Version.new(r[1].version).prerelease? } end |
#requirement ⇒ Requirement
The specific version is stripped from head information because because its string representation would not parse. It would be better to add something like Version#display_string.
Returns the requirement of this dependency (a set of one or more version restrictions).
129 130 131 132 133 134 135 |
# File 'lib/cocoapods-core/dependency.rb', line 129 def requirement if specific_version Requirement.new(Version.new(specific_version.version)) else @requirement end end |
#root_name ⇒ String
In case this is a dependency for a subspec, e.g. ‘RestKit/Networking’, this returns ‘RestKit’, which is what the Pod::Source needs to know to retrieve the correct Specification from disk.
Returns the name of the Pod that the dependency is pointing to.
186 187 188 |
# File 'lib/cocoapods-core/dependency.rb', line 186 def root_name subspec_dependency? ? @name.split('/').first : @name end |
#subspec_dependency? ⇒ Bool
Returns whether the dependency points to a subspec.
139 140 141 |
# File 'lib/cocoapods-core/dependency.rb', line 139 def subspec_dependency? @name.include?('/') end |
#to_root_dependency ⇒ Dependency
This should not use ‘dup`. The `name` property should be an attr_reader.
This is used by the Specification::Set class to merge dependencies and resolve the required version of a Pod regardless what particular specification (subspecs or top level) is required.
Creates a new dependency with the name of the top level spec and the same version requirements.
171 172 173 174 175 |
# File 'lib/cocoapods-core/dependency.rb', line 171 def to_root_dependency dep = dup dep.name = root_name dep end |
#to_s ⇒ String
This representation is used by the Lockfile.
Creates a string representation of the dependency suitable for serialization and de-serialization without loss of information. The string is also suitable for UI.
337 338 339 340 341 342 343 344 345 346 347 |
# File 'lib/cocoapods-core/dependency.rb', line 337 def to_s version = '' if external? version << external_source_description(external_source) elsif requirement != Requirement.default version << requirement.to_s end result = @name.dup result << " (#{version})" unless version.empty? result end |