Class: Gitlab::Metrics::Delta

Inherits:
Object
  • Object
show all
Defined in:
lib/gitlab/metrics/delta.rb

Overview

Class for calculating the difference between two numeric values.

Every call to `compared_with` updates the internal value. This makes it possible to use a single Delta instance to calculate the delta over time of an ever increasing number.

Example usage:

delta = Delta.new(0)

delta.compared_with(10) # => 10
delta.compared_with(15) # => 5
delta.compared_with(20) # => 5

Instance Method Summary collapse

Constructor Details

#initialize(value = 0) ⇒ Delta

Returns a new instance of Delta


17
18
19
# File 'lib/gitlab/metrics/delta.rb', line 17

def initialize(value = 0)
  @value = value
end

Instance Method Details

#compared_with(new_value) ⇒ Object

new_value - The value to compare with as a Numeric.

Returns a new Numeric (depending on the type of `new_value`).


24
25
26
27
28
29
# File 'lib/gitlab/metrics/delta.rb', line 24

def compared_with(new_value)
  delta  = new_value - @value
  @value = new_value

  delta
end