Class: Gem::Version
- Inherits:
-
Object
- Object
- Gem::Version
- Includes:
- Comparable
- Defined in:
- lib/rubygems/version.rb,
lib/rubygems/requirement.rb
Overview
The Version class processes string versions into comparable values. A version string should normally be a series of numbers separated by periods. Each part (digits separated by periods) is considered its own number, and these are used for sorting. So for instance, 3.10 sorts higher than 3.2 because ten is greater than two.
If any part contains letters (currently only a-z are supported) then that version is considered prerelease. Versions with a prerelease part in the Nth part sort less than versions with N-1 parts. Prerelease parts are sorted alphabetically using the normal Ruby string sorting rules. If a prerelease part contains both letters and numbers, it will be broken into multiple parts to provide expected sort behavior (1.0.a10 becomes 1.0.a.10, and is greater than 1.0.a9).
Prereleases sort between real releases (newest to oldest):
-
1.0
-
1.0.b1
-
1.0.a.2
-
0.9
If you want to specify a version restriction that includes both prereleases and regular releases of the 1.x series this is the best way:
s.add_dependency 'example', '>= 1.0.0.a', '< 2.0.0'
How Software Changes
Users expect to be able to specify a version constraint that gives them some reasonable expectation that new versions of a library will work with their software if the version constraint is true, and not work with their software if the version constraint is false. In other words, the perfect system will accept all compatible versions of the library and reject all incompatible versions.
Libraries change in 3 ways (well, more than 3, but stay focused here!).
-
The change may be an implementation detail only and have no effect on the client software.
-
The change may add new features, but do so in a way that client software written to an earlier version is still compatible.
-
The change may change the public interface of the library in such a way that old software is no longer compatible.
Some examples are appropriate at this point. Suppose I have a Stack class that supports a push
and a pop
method.
Examples of Category 1 changes:
-
Switch from an array based implementation to a linked-list based implementation.
-
Provide an automatic (and transparent) backing store for large stacks.
Examples of Category 2 changes might be:
-
Add a
depth
method to return the current depth of the stack. -
Add a
top
method that returns the current top of stack (without changing the stack). -
Change
push
so that it returns the item pushed (previously it had no usable return value).
Examples of Category 3 changes might be:
-
Changes
pop
so that it no longer returns a value (you must usetop
to get the top of the stack). -
Rename the methods to
push_item
andpop_item
.
RubyGems Rational Versioning
-
Versions shall be represented by three non-negative integers, separated by periods (e.g. 3.1.4). The first integers is the “major” version number, the second integer is the “minor” version number, and the third integer is the “build” number.
-
A category 1 change (implementation detail) will increment the build number.
-
A category 2 change (backwards compatible) will increment the minor version number and reset the build number.
-
A category 3 change (incompatible) will increment the major build number and reset the minor and build numbers.
-
Any “public” release of a gem should have a different version. Normally that means incrementing the build number. This means a developer can generate builds all day long, but as soon as they make a public release, the version must be updated.
Examples
Let’s work through a project lifecycle using our Stack example from above.
- Version 0.0.1
-
The initial Stack class is release.
- Version 0.0.2
-
Switched to a linked=list implementation because it is cooler.
- Version 0.1.0
-
Added a
depth
method. - Version 1.0.0
-
Added
top
and madepop
return nil (pop
used to return the old top item). - Version 1.1.0
-
push
now returns the value pushed (it used it return nil). - Version 1.1.1
-
Fixed a bug in the linked list implementation.
- Version 1.1.2
-
Fixed a bug introduced in the last fix.
Client A needs a stack with basic push/pop capability. They write to the original interface (no top
), so their version constraint looks like:
gem 'stack', '~> 0.0'
Essentially, any version is OK with Client A. An incompatible change to the library will cause them grief, but they are willing to take the chance (we call Client A optimistic).
Client B is just like Client A except for two things: (1) They use the depth
method and (2) they are worried about future incompatibilities, so they write their version constraint like this:
gem 'stack', '~> 0.1'
The depth
method was introduced in version 0.1.0, so that version or anything later is fine, as long as the version stays below version 1.0 where incompatibilities are introduced. We call Client B pessimistic because they are worried about incompatible future changes (it is OK to be pessimistic!).
Preventing Version Catastrophe:
From: blog.zenspider.com/2008/10/rubygems-howto-preventing-cata.html
Let’s say you’re depending on the fnord gem version 2.y.z. If you specify your dependency as “>= 2.0.0” then, you’re good, right? What happens if fnord 3.0 comes out and it isn’t backwards compatible with 2.y.z? Your stuff will break as a result of using “>=”. The better route is to specify your dependency with an “approximate” version specifier (“~>”). They’re a tad confusing, so here is how the dependency specifiers work:
Specification From ... To (exclusive)
">= 3.0" 3.0 ... ∞
"~> 3.0" 3.0 ... 4.0
"~> 3.0.0" 3.0.0 ... 3.1
"~> 3.5" 3.5 ... 4.0
"~> 3.5.0" 3.5.0 ... 3.6
"~> 3" 3.0 ... 4.0
For the last example, single-digit versions are automatically extended with a zero to give a sensible result.
Constant Summary collapse
- VERSION_PATTERN =
:nodoc:
'[0-9]+(?>\.[0-9a-zA-Z]+)*(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?'
- ANCHORED_VERSION_PATTERN =
:nodoc:
/\A\s*(#{VERSION_PATTERN})?\s*\z/
- Requirement =
This is needed for compatibility with older yaml gemspecs.
Gem::Requirement
- @@all =
{}
Class Method Summary collapse
-
.correct?(version) ⇒ Boolean
True if the
version
string matches RubyGems’ requirements. -
.create(input) ⇒ Object
Factory method to create a Version object.
-
.new(version) ⇒ Object
:nodoc:.
Instance Method Summary collapse
-
#<=>(other) ⇒ Object
Compares this version with
other
returning -1, 0, or 1 if the other version is larger, the same, or smaller than this one. -
#approximate_recommendation ⇒ Object
A recommended version for use with a ~> Requirement.
-
#bump ⇒ Object
Return a new version object where the next to the last revision number is one greater (e.g., 5.3.1 => 5.4).
-
#encode_with(coder) ⇒ Object
:nodoc:.
-
#eql?(other) ⇒ Boolean
A Version is only eql? to another version if it’s specified to the same precision.
-
#hash ⇒ Object
:nodoc:.
-
#init_with(coder) ⇒ Object
:nodoc:.
-
#initialize(version) ⇒ Version
constructor
Constructs a Version from the
version
string. -
#inspect ⇒ Object
:nodoc:.
-
#marshal_dump ⇒ Object
Dump only the raw version string, not the complete object.
-
#marshal_load(array) ⇒ Object
Load custom marshal format.
-
#prerelease? ⇒ Boolean
A version is considered a prerelease if it contains a letter.
-
#pretty_print(q) ⇒ Object
:nodoc:.
-
#release ⇒ Object
The release for this version (e.g. 1.2.0.a -> 1.2.0).
-
#segments ⇒ Object
:nodoc:.
-
#to_yaml_properties ⇒ Object
:nodoc:.
-
#version ⇒ Object
(also: #to_s)
A string representation of this Version.
-
#yaml_initialize(tag, map) ⇒ Object
:nodoc:.
Constructor Details
#initialize(version) ⇒ Version
Constructs a Version from the version
string. A version string is a series of digits or ASCII letters separated by dots.
205 206 207 208 209 210 211 |
# File 'lib/rubygems/version.rb', line 205 def initialize version raise ArgumentError, "Malformed version number string #{version}" unless self.class.correct?(version) @version = version.to_s.strip.gsub("-",".pre.") @segments = nil end |
Class Method Details
.correct?(version) ⇒ Boolean
True if the version
string matches RubyGems’ requirements.
171 172 173 |
# File 'lib/rubygems/version.rb', line 171 def self.correct? version version.to_s =~ ANCHORED_VERSION_PATTERN end |
.create(input) ⇒ Object
183 184 185 186 187 188 189 190 191 |
# File 'lib/rubygems/version.rb', line 183 def self.create input if self === input then # check yourself before you wreck yourself input elsif input.nil? then nil else new input end end |
Instance Method Details
#<=>(other) ⇒ Object
Compares this version with other
returning -1, 0, or 1 if the other version is larger, the same, or smaller than this one. Attempts to compare to something that’s not a Gem::Version
return nil
.
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/rubygems/version.rb', line 330 def <=> other return unless Gem::Version === other return 0 if @version == other.version lhsegments = segments rhsegments = other.segments lhsize = lhsegments.size rhsize = rhsegments.size limit = (lhsize > rhsize ? lhsize : rhsize) - 1 i = 0 while i <= limit lhs, rhs = lhsegments[i] || 0, rhsegments[i] || 0 i += 1 next if lhs == rhs return -1 if String === lhs && Numeric === rhs return 1 if Numeric === lhs && String === rhs return lhs <=> rhs end return 0 end |
#approximate_recommendation ⇒ Object
A recommended version for use with a ~> Requirement.
314 315 316 317 318 319 320 321 322 |
# File 'lib/rubygems/version.rb', line 314 def approximate_recommendation segments = self.segments.dup segments.pop while segments.any? { |s| String === s } segments.pop while segments.size > 2 segments.push 0 while segments.size < 2 "~> #{segments.join(".")}" end |
#bump ⇒ Object
Return a new version object where the next to the last revision number is one greater (e.g., 5.3.1 => 5.4).
Pre-release (alpha) parts, e.g, 5.3.1.b.2 => 5.4, are ignored.
219 220 221 222 223 224 225 226 |
# File 'lib/rubygems/version.rb', line 219 def bump segments = self.segments.dup segments.pop while segments.any? { |s| String === s } segments.pop if segments.size > 1 segments[-1] = segments[-1].succ self.class.new segments.join(".") end |
#encode_with(coder) ⇒ Object
:nodoc:
274 275 276 |
# File 'lib/rubygems/version.rb', line 274 def encode_with coder # :nodoc: coder.add 'version', @version end |
#eql?(other) ⇒ Boolean
A Version is only eql? to another version if it’s specified to the same precision. Version “1.0” is not the same as version “1”.
232 233 234 |
# File 'lib/rubygems/version.rb', line 232 def eql? other self.class === other and @version == other.version end |
#hash ⇒ Object
:nodoc:
236 237 238 |
# File 'lib/rubygems/version.rb', line 236 def hash # :nodoc: @hash ||= segments.hash end |
#init_with(coder) ⇒ Object
:nodoc:
240 241 242 |
# File 'lib/rubygems/version.rb', line 240 def init_with coder # :nodoc: yaml_initialize coder.tag, coder.map end |
#inspect ⇒ Object
:nodoc:
244 245 246 |
# File 'lib/rubygems/version.rb', line 244 def inspect # :nodoc: "#<#{self.class} #{version.inspect}>" end |
#marshal_dump ⇒ Object
Dump only the raw version string, not the complete object. It’s a string for backwards (RubyGems 1.3.5 and earlier) compatibility.
252 253 254 |
# File 'lib/rubygems/version.rb', line 252 def marshal_dump [version] end |
#marshal_load(array) ⇒ Object
Load custom marshal format. It’s a string for backwards (RubyGems 1.3.5 and earlier) compatibility.
260 261 262 |
# File 'lib/rubygems/version.rb', line 260 def marshal_load array initialize array[0] end |
#prerelease? ⇒ Boolean
A version is considered a prerelease if it contains a letter.
281 282 283 |
# File 'lib/rubygems/version.rb', line 281 def prerelease? @prerelease ||= !!(@version =~ /[a-zA-Z]/) end |
#pretty_print(q) ⇒ Object
:nodoc:
285 286 287 |
# File 'lib/rubygems/version.rb', line 285 def pretty_print q # :nodoc: q.text "Gem::Version.new(#{version.inspect})" end |
#release ⇒ Object
The release for this version (e.g. 1.2.0.a -> 1.2.0). Non-prerelease versions return themselves.
293 294 295 296 297 298 299 |
# File 'lib/rubygems/version.rb', line 293 def release return self unless prerelease? segments = self.segments.dup segments.pop while segments.any? { |s| String === s } self.class.new segments.join('.') end |
#segments ⇒ Object
:nodoc:
301 302 303 304 305 306 307 308 309 |
# File 'lib/rubygems/version.rb', line 301 def segments # :nodoc: # segments is lazy so it can pick up version values that come from # old marshaled versions, which don't go through marshal_load. @segments ||= @version.scan(/[0-9]+|[a-z]+/i).map do |s| /^\d+$/ =~ s ? s.to_i : s end end |
#to_yaml_properties ⇒ Object
:nodoc:
270 271 272 |
# File 'lib/rubygems/version.rb', line 270 def to_yaml_properties # :nodoc: ["@version"] end |
#version ⇒ Object Also known as: to_s
A string representation of this Version.
162 163 164 |
# File 'lib/rubygems/version.rb', line 162 def version @version.dup end |
#yaml_initialize(tag, map) ⇒ Object
:nodoc:
264 265 266 267 268 |
# File 'lib/rubygems/version.rb', line 264 def yaml_initialize(tag, map) # :nodoc: @version = map['version'] @segments = nil @hash = nil end |