Class: Net::SCP::Version

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/net/scp/version.rb

Overview

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/scp/version'

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

Constant Summary collapse

MAJOR =

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

4
MINOR =

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

0
TINY =

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

0
PRE =

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

nil
CURRENT =

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

new(*[MAJOR, MINOR, TINY, PRE].compact)
STRING =

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

CURRENT.to_s

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(major, minor, tiny, pre = nil) ⇒ Version

Create a new Version object with the given components.



27
28
29
 
# File 'lib/net/scp/version.rb', line 27

def initialize(major, minor, tiny, pre = nil)
  @major, @minor, @tiny, @pre = major, minor, tiny, pre
end

Instance Attribute Details

#major ⇒ Object (readonly)

Returns the value of attribute major.



24
25
26
 
# File 'lib/net/scp/version.rb', line 24

def major
  @major
end

#minor ⇒ Object (readonly)

Returns the value of attribute minor.



24
25
26
 
# File 'lib/net/scp/version.rb', line 24

def minor
  @minor
end

#tiny ⇒ Object (readonly)

Returns the value of attribute tiny.



24
25
26
 
# File 'lib/net/scp/version.rb', line 24

def tiny
  @tiny
end

Class Method Details

.[](major, minor, tiny, pre = nil) ⇒ Object

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



20
21
22
 
# File 'lib/net/scp/version.rb', line 20

def self.[](major, minor, tiny, pre = nil)
  new(major, minor, tiny, pre)
end

Instance Method Details

#<=>(version) ⇒ Object

Compare this version to the given version object.



32
33
34
 
# File 'lib/net/scp/version.rb', line 32

def <=>(version)
  to_i <=> version.to_i
end

#to_i ⇒ Object

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



44
45
46
 
# File 'lib/net/scp/version.rb', line 44

def to_i
  @to_i ||= @major * 1_000_000 + @minor * 1_000 + @tiny
end

#to_s ⇒ Object

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



38
39
40
 
# File 'lib/net/scp/version.rb', line 38

def to_s
  @to_s ||= [@major, @minor, @tiny, @pre].compact.join(".")
end