Class: RTeX::Version

Inherits:
Object
  • Object
show all
Defined in:
lib/rtex/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.

Constant Summary collapse

MAJOR = 
2
MINOR = 
1
TINY = 
1
CURRENT =

The current version as a Version instance

new(MAJOR, MINOR, TINY)
STRING =

The current version as a String

CURRENT.to_s

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(major, minor, tiny) ⇒ Version

Create a new Version object with the given components.



41
42
43
 
# File 'lib/rtex/version.rb', line 41

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

Instance Attribute Details

#major ⇒ Object (readonly)

Returns the value of attribute major.



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

def major
  @major
end

#minor ⇒ Object (readonly)

Returns the value of attribute minor.



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

def minor
  @minor
end

#tiny ⇒ Object (readonly)

Returns the value of attribute tiny.



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

def tiny
  @tiny
end

Class Method Details

.[](major, minor, tiny) ⇒ Object

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



34
35
36
 
# File 'lib/rtex/version.rb', line 34

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

Instance Method Details

#<=>(version) ⇒ Object

Compare this version to the given version object.



46
47
48
 
# File 'lib/rtex/version.rb', line 46

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

#to_a ⇒ Object 



62
63
64
 
# File 'lib/rtex/version.rb', line 62

def to_a
  [@major, @minor, @tiny]
end

#to_i ⇒ Object

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



58
59
60
 
# File 'lib/rtex/version.rb', line 58

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.



52
53
54
 
# File 'lib/rtex/version.rb', line 52

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