class Net::SSH::Version

A class for describing the current version of a library. The version consists of three parts: the major number, the minor number, and the tiny (or patch) number.

Two Version instances may be compared, so that you can test that a version of a library is what you require:

require 'net/ssh/version'

if Net::SSH::Version::CURRENT < Net::SSH::Version[2,1,0]
  abort "your software is too old!"
end

Constants

CURRENT

The current version of the Net::SSH library as a Version instance

MAJOR

The major component of this version of the Net::SSH library

MINOR

The minor component of this version of the Net::SSH library

PRE

The prerelease component of this version of the Net::SSH library nil allowed

STRING

The current version of the Net::SSH library as a String

TINY

The tiny component of this version of the Net::SSH library

Attributes

major[R]
minor[R]
tiny[R]

Public Class Methods

[](major, minor, tiny, pre = nil) click to toggle source

A convenience method for instantiating a new Version instance with the given major, minor, and tiny components.

# File lib/net/ssh/version.rb, line 19
def self.[](major, minor, tiny, pre = nil)
  new(major, minor, tiny, pre)
end
new(major, minor, tiny, pre = nil) click to toggle source

Create a new Version object with the given components.

# File lib/net/ssh/version.rb, line 26
def initialize(major, minor, tiny, pre = nil)
  @major, @minor, @tiny, @pre = major, minor, tiny, pre
end

Public Instance Methods

<=>(version) click to toggle source

Compare this version to the given version object.

# File lib/net/ssh/version.rb, line 31
def <=>(version)
  to_i <=> version.to_i
end
to_i() click to toggle source

Converts this version to a canonical integer that may be compared against other version objects.

# File lib/net/ssh/version.rb, line 43
def to_i
  @to_i ||= @major * 1_000_000 + @minor * 1_000 + @tiny
end
to_s() click to toggle source

Converts this version object to a string, where each of the three version components are joined by the '.' character. E.g., 2.0.0.

# File lib/net/ssh/version.rb, line 37
def to_s
  @to_s ||= [@major, @minor, @tiny, @pre].compact.join(".")
end