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.
-
#head ⇒ Bool
(also: #head?)
Whether the dependency should use the podspec with the highest know version but force the downloader to checkout the ‘head` of the source repository.
-
#name ⇒ String
The name of the Pod described by 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.
-
#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, is_head) ⇒ Dependency
Returns a new instance of Dependency.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/cocoapods-core/dependency.rb', line 72 def initialize(name = nil, *requirements) if requirements.last.is_a?(Hash) @external_source = requirements.pop unless requirements.empty? raise Informative, "A dependency with an external source may not " \ "specify version requirements (#{name})." end elsif requirements.last == :head @head = true requirements.pop unless requirements.empty? raise Informative, "A `:head` dependency may not specify version " \ "requirements (#{name})." end 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.
22 23 24 |
# File 'lib/cocoapods-core/dependency.rb', line 22 def external_source @external_source end |
#head ⇒ Bool Also known as: head?
Returns whether the dependency should use the podspec with the highest know version but force the downloader to checkout the ‘head` of the source repository.
28 29 30 |
# File 'lib/cocoapods-core/dependency.rb', line 28 def head @head end |
#name ⇒ String
Returns The name of the Pod described by this dependency.
16 17 18 |
# File 'lib/cocoapods-core/dependency.rb', line 16 def name @name end |
#specific_version ⇒ Version
Returns whether the dependency points to a specific version.
98 99 100 |
# File 'lib/cocoapods-core/dependency.rb', line 98 def specific_version @specific_version end |
Class Method Details
.from_string(string) ⇒ Dependency
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.
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/cocoapods-core/dependency.rb', line 319 def self.from_string(string) match_data = string.match(/(\S*)( (.*))?/) name = match_data[1] version = match_data[2] version = version.gsub(/[()]/, '') if version case version when nil || /from `(.*)(`|')/ Dependency.new(name) when /HEAD/ Dependency.new(name, :head) 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.
212 213 214 |
# File 'lib/cocoapods-core/dependency.rb', line 212 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.
193 194 195 196 197 198 199 |
# File 'lib/cocoapods-core/dependency.rb', line 193 def ==(other) self.class == other.class && name == other.name && requirement == other.requirement && head? == other.head? && external_source == other.external_source 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.
179 180 181 182 183 184 185 186 187 |
# File 'lib/cocoapods-core/dependency.rb', line 179 def compatible?(other) return false unless name == other.name return false unless head? == other.head? 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.
123 124 125 |
# File 'lib/cocoapods-core/dependency.rb', line 123 def external? !@external_source.nil? end |
#hash ⇒ Object
@return [Fixnum] The hash value based on the name and on the
requirements.
205 206 207 |
# File 'lib/cocoapods-core/dependency.rb', line 205 def hash name.hash ^ requirement.hash end |
#inspect ⇒ String
Returns a string representation suitable for debugging.
337 338 339 340 |
# File 'lib/cocoapods-core/dependency.rb', line 337 def inspect "<#{self.class} name=#{name} requirements=#{requirement} " \ "external_source=#{external_source || 'nil'}>" end |
#local? ⇒ Bool
Returns whether the dependency points to a local path.
129 130 131 132 133 |
# File 'lib/cocoapods-core/dependency.rb', line 129 def local? if external_source !(external_source[:path] || external_source[:local]).nil? end end |
#match?(name, version) ⇒ Bool
Checks whether the dependency would be satisfied by the specification with the given name and version.
263 264 265 266 267 |
# File 'lib/cocoapods-core/dependency.rb', line 263 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 decencies specifies an external source or is head, the resulting dependency preserves this attributes.
Merges the version requirements of the dependency with another one.
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/cocoapods-core/dependency.rb', line 227 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 if other_req == default dep = self.class.new(name, self_req) elsif self_req == default dep = self.class.new(name, other_req) else dep = self.class.new(name, self_req.as_list.concat(other_req.as_list)) end dep.head = head? || other.head? if external_source || other.external_source self_external_source = external_source || {} other_external_source = other.external_source || {} dep.external_source = self_external_source.merge(other_external_source) end dep 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).
107 108 109 110 111 112 113 |
# File 'lib/cocoapods-core/dependency.rb', line 107 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.
164 165 166 |
# File 'lib/cocoapods-core/dependency.rb', line 164 def root_name subspec_dependency? ? @name.split('/').first : @name end |
#subspec_dependency? ⇒ Bool
Returns whether the dependency points to a subspec.
117 118 119 |
# File 'lib/cocoapods-core/dependency.rb', line 117 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.
149 150 151 152 153 |
# File 'lib/cocoapods-core/dependency.rb', line 149 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.
292 293 294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/cocoapods-core/dependency.rb', line 292 def to_s version = '' if external? version << external_source_description(external_source) elsif head? version << 'HEAD' elsif requirement != Requirement.default version << requirement.to_s end result = @name.dup result << " (#{version})" unless version.empty? result end |