Class: Brigit::Version

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/brigit/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 = 
9
TINY = 
3
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.



50
51
52
 
# File 'lib/brigit/version.rb', line 50

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

Instance Attribute Details

#major ⇒ Object (readonly)

Returns the value of attribute major.



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

def major
  @major
end

#minor ⇒ Object (readonly)

Returns the value of attribute minor.



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

def minor
  @minor
end

#tiny ⇒ Object (readonly)

Returns the value of attribute tiny.



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

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.



36
37
38
 
# File 'lib/brigit/version.rb', line 36

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

.rails ⇒ Object 



40
41
42
43
44
45
 
# File 'lib/brigit/version.rb', line 40

def self.rails
  @rails ||= begin
    # handle ::Rails::VERSION not being set
    Version.new(::Rails::VERSION::MAJOR, ::Rails::VERSION::MINOR, ::Rails::VERSION::TINY) rescue Version.new(0,0,0)
  end
end

Instance Method Details

#<=>(version) ⇒ Object

Compare this version to the given version object.



55
56
57
 
# File 'lib/brigit/version.rb', line 55

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

#to_a ⇒ Object 



71
72
73
 
# File 'lib/brigit/version.rb', line 71

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.



67
68
69
 
# File 'lib/brigit/version.rb', line 67

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.



61
62
63
 
# File 'lib/brigit/version.rb', line 61

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