Class: Gem::Dependency
- Inherits:
-
Object
- Object
- Gem::Dependency
- Defined in:
- lib/rubygems/dependency.rb
Constant Summary collapse
- TYPES =
Valid dependency types. – When this list is updated, be sure to change Gem::Specification::CURRENT_SPECIFICATION_VERSION as well.
REFACTOR: This type of constant, TYPES, indicates we might want two classes, used via inheritance or duck typing.
[ :development, :runtime, ]
Instance Attribute Summary collapse
-
#name ⇒ Object
Dependency name or regular expression.
-
#prerelease ⇒ Object
writeonly
Allows you to force this dependency to be a prerelease.
Instance Method Summary collapse
-
#<=>(other) ⇒ Object
Dependencies are ordered by name.
-
#==(other) ⇒ Object
:nodoc:.
-
#=~(other) ⇒ Object
(also: #===)
Uses this dependency as a pattern to compare to
other
. -
#hash ⇒ Object
A dependency’s hash is the XOR of the hashes of
name
,type
, andrequirement
. -
#initialize(name, *requirements) ⇒ Dependency
constructor
Constructs a dependency with
name
andrequirements
. -
#inspect ⇒ Object
:nodoc:.
-
#latest_version? ⇒ Boolean
Is this dependency simply asking for the latest version of a gem?.
-
#match?(obj, version = nil) ⇒ Boolean
DOC: this method needs either documented or :nodoc’d.
-
#matches_spec?(spec) ⇒ Boolean
DOC: this method needs either documented or :nodoc’d.
-
#matching_specs(platform_only = false) ⇒ Object
DOC: this method needs either documented or :nodoc’d.
-
#merge(other) ⇒ Object
Merges the requirements of
other
into this dependency. -
#prerelease? ⇒ Boolean
Does this dependency require a prerelease?.
-
#pretty_print(q) ⇒ Object
:nodoc:.
-
#requirement ⇒ Object
What does this dependency require?.
-
#requirements_list ⇒ Object
DOC: this method needs documentation or :nodoc”d.
-
#specific? ⇒ Boolean
True if the dependency will not always match the latest version.
-
#to_s ⇒ Object
:nodoc:.
-
#to_spec ⇒ Object
DOC: this method needs either documented or :nodoc’d.
-
#to_specs ⇒ Object
DOC: this method needs either documented or :nodoc’d.
-
#type ⇒ Object
Dependency type.
Constructor Details
#initialize(name, *requirements) ⇒ Dependency
Constructs a dependency with name
and requirements
. The last argument can optionally be the dependency type, which defaults to :runtime
.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/rubygems/dependency.rb', line 37 def initialize name, *requirements case name when String then # ok when Regexp then msg = ["NOTE: Dependency.new w/ a regexp is deprecated.", "Dependency.new called from #{Gem.location_of_caller.join(":")}"] warn msg.join("\n") unless Gem::Deprecate.skip else raise ArgumentError, "dependency name must be a String, was #{name.inspect}" end type = Symbol === requirements.last ? requirements.pop : :runtime requirements = requirements.first if 1 == requirements.length # unpack unless TYPES.include? type raise ArgumentError, "Valid types are #{TYPES.inspect}, " + "not #{type.inspect}" end @name = name @requirement = Gem::Requirement.create requirements @type = type @prerelease = false # This is for Marshal backwards compatibility. See the comments in # +requirement+ for the dirty details. @version_requirements = @requirement end |
Instance Attribute Details
#name ⇒ Object
Dependency name or regular expression.
25 26 27 |
# File 'lib/rubygems/dependency.rb', line 25 def name @name end |
#prerelease=(value) ⇒ Object (writeonly)
Allows you to force this dependency to be a prerelease.
30 31 32 |
# File 'lib/rubygems/dependency.rb', line 30 def prerelease=(value) @prerelease = value end |
Instance Method Details
#<=>(other) ⇒ Object
Dependencies are ordered by name.
178 179 180 |
# File 'lib/rubygems/dependency.rb', line 178 def <=> other self.name <=> other.name end |
#==(other) ⇒ Object
:nodoc:
168 169 170 171 172 173 |
# File 'lib/rubygems/dependency.rb', line 168 def == other # :nodoc: Gem::Dependency === other && self.name == other.name && self.type == other.type && self.requirement == other.requirement end |
#=~(other) ⇒ Object Also known as: ===
Uses this dependency as a pattern to compare to other
. This dependency will match if the name matches the other’s name, and other has only an equal version requirement that satisfies this dependency.
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/rubygems/dependency.rb', line 188 def =~ other unless Gem::Dependency === other return unless other.respond_to?(:name) && other.respond_to?(:version) other = Gem::Dependency.new other.name, other.version end return false unless name === other.name reqs = other.requirement.requirements return false unless reqs.length == 1 return false unless reqs.first.first == '=' version = reqs.first.last requirement.satisfied_by? version end |
#hash ⇒ Object
A dependency’s hash is the XOR of the hashes of name
, type
, and requirement
.
72 73 74 |
# File 'lib/rubygems/dependency.rb', line 72 def hash # :nodoc: name.hash ^ type.hash ^ requirement.hash end |
#inspect ⇒ Object
:nodoc:
76 77 78 79 80 81 82 83 84 |
# File 'lib/rubygems/dependency.rb', line 76 def inspect # :nodoc: if @prerelease "<%s type=%p name=%p requirements=%p prerelease=ok>" % [self.class, self.type, self.name, requirement.to_s] else "<%s type=%p name=%p requirements=%p>" % [self.class, self.type, self.name, requirement.to_s] end end |
#latest_version? ⇒ Boolean
Is this dependency simply asking for the latest version of a gem?
97 98 99 |
# File 'lib/rubygems/dependency.rb', line 97 def latest_version? @requirement.none? end |
#match?(obj, version = nil) ⇒ Boolean
DOC: this method needs either documented or :nodoc’d
210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/rubygems/dependency.rb', line 210 def match? obj, version=nil if !version name = obj.name version = obj.version else name = obj end return false unless self.name === name return true if requirement.none? requirement.satisfied_by? Gem::Version.new(version) end |
#matches_spec?(spec) ⇒ Boolean
DOC: this method needs either documented or :nodoc’d
226 227 228 229 230 231 |
# File 'lib/rubygems/dependency.rb', line 226 def matches_spec? spec return false unless name === spec.name return true if requirement.none? requirement.satisfied_by?(spec.version) end |
#matching_specs(platform_only = false) ⇒ Object
DOC: this method needs either documented or :nodoc’d
254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/rubygems/dependency.rb', line 254 def matching_specs platform_only = false matches = Gem::Specification.stubs.find_all { |spec| self.name === spec.name and # TODO: == instead of === requirement.satisfied_by? spec.version }.map(&:to_spec) if platform_only matches.reject! { |spec| not Gem::Platform.match spec.platform } end matches = matches.sort_by { |s| s.sort_obj } # HACK: shouldn't be needed end |
#merge(other) ⇒ Object
Merges the requirements of other
into this dependency
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/rubygems/dependency.rb', line 236 def merge other unless name == other.name then raise ArgumentError, "#{self} and #{other} have different names" end default = Gem::Requirement.default self_req = self.requirement other_req = other.requirement return self.class.new name, self_req if other_req == default return self.class.new name, other_req if self_req == default self.class.new name, self_req.as_list.concat(other_req.as_list) end |
#prerelease? ⇒ Boolean
Does this dependency require a prerelease?
89 90 91 |
# File 'lib/rubygems/dependency.rb', line 89 def prerelease? @prerelease || requirement.prerelease? end |
#pretty_print(q) ⇒ Object
:nodoc:
101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/rubygems/dependency.rb', line 101 def pretty_print q # :nodoc: q.group 1, 'Gem::Dependency.new(', ')' do q.pp name q.text ',' q.breakable q.pp requirement q.text ',' q.breakable q.pp type end end |
#requirement ⇒ Object
What does this dependency require?
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/rubygems/dependency.rb', line 119 def requirement return @requirement if defined?(@requirement) and @requirement # @version_requirements and @version_requirement are legacy ivar # names, and supported here because older gems need to keep # working and Dependency doesn't implement marshal_dump and # marshal_load. In a happier world, this would be an # attr_accessor. The horrifying instance_variable_get you see # below is also the legacy of some old restructurings. # # Note also that because of backwards compatibility (loading new # gems in an old RubyGems installation), we can't add explicit # marshaling to this class until we want to make a big # break. Maybe 2.0. # # Children, define explicit marshal and unmarshal behavior for # public classes. Marshal formats are part of your public API. # REFACTOR: See above if defined?(@version_requirement) && @version_requirement version = @version_requirement.instance_variable_get :@version @version_requirement = nil @version_requirements = Gem::Requirement.new version end @requirement = @version_requirements if defined?(@version_requirements) end |
#requirements_list ⇒ Object
DOC: this method needs documentation or :nodoc”d
149 150 151 |
# File 'lib/rubygems/dependency.rb', line 149 def requirements_list requirement.as_list end |
#specific? ⇒ Boolean
True if the dependency will not always match the latest version.
272 273 274 |
# File 'lib/rubygems/dependency.rb', line 272 def specific? @requirement.specific? end |
#to_s ⇒ Object
:nodoc:
153 154 155 156 157 158 159 |
# File 'lib/rubygems/dependency.rb', line 153 def to_s # :nodoc: if type != :runtime then "#{name} (#{requirement}, #{type})" else "#{name} (#{requirement})" end end |
#to_spec ⇒ Object
DOC: this method needs either documented or :nodoc’d
308 309 310 311 312 |
# File 'lib/rubygems/dependency.rb', line 308 def to_spec matches = self.to_specs matches.find { |spec| spec.activated? } or matches.last end |
#to_specs ⇒ Object
DOC: this method needs either documented or :nodoc’d
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/rubygems/dependency.rb', line 278 def to_specs matches = matching_specs true # TODO: check Gem.activated_spec[self.name] in case matches falls outside if matches.empty? then specs = Gem::Specification.find_all { |s| s.name == name }.map { |x| x.full_name } if specs.empty? total = Gem::Specification.to_a.size error = Gem::LoadError.new \ "Could not find '#{name}' (#{requirement}) among #{total} total gem(s)" else error = Gem::LoadError.new \ "Could not find '#{name}' (#{requirement}) - did find: [#{specs.join ','}]" end error.name = self.name error.requirement = self.requirement raise error end # TODO: any other resolver validations should go here matches end |
#type ⇒ Object
Dependency type.
164 165 166 |
# File 'lib/rubygems/dependency.rb', line 164 def type @type ||= :runtime end |