Class: Rocksteady::Version

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/rocksteady/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 = 
0
MINOR = 
8
TINY = 
0
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.



42
43
44
 
# File 'lib/rocksteady/version.rb', line 42

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

Instance Attribute Details

#major ⇒ Object (readonly)

Returns the value of attribute major.



39
40
41
 
# File 'lib/rocksteady/version.rb', line 39

def major
  @major
end

#minor ⇒ Object (readonly)

Returns the value of attribute minor.



39
40
41
 
# File 'lib/rocksteady/version.rb', line 39

def minor
  @minor
end

#tiny ⇒ Object (readonly)

Returns the value of attribute tiny.



39
40
41
 
# File 'lib/rocksteady/version.rb', line 39

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.



35
36
37
 
# File 'lib/rocksteady/version.rb', line 35

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

Instance Method Details

#<=>(version) ⇒ Object

Compare this version to the given version object.



47
48
49
 
# File 'lib/rocksteady/version.rb', line 47

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

#to_a ⇒ Object 



63
64
65
 
# File 'lib/rocksteady/version.rb', line 63

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.



59
60
61
 
# File 'lib/rocksteady/version.rb', line 59

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.



53
54
55
 
# File 'lib/rocksteady/version.rb', line 53

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