Class: Redis::Counter

Inherits:
BaseObject show all
Includes:
Helpers::CoreCommands
Defined in:
lib/redis/counter.rb

Overview

Class representing a Redis counter. This functions like a proxy class, in that you can say @object.counter_name to get the value and then directly, or you can use the counter :foo class method in your class to define a counter.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers::CoreCommands

#delete, #exists?, #expire, #expireat, #marshal, #move, #persist, #rename, #renamenx, #sort, #ttl, #type, #unmarshal

Methods inherited from BaseObject

expiration_filter, #redis, #set_expiration

Constructor Details

#initialize(key, *args) ⇒ Counter

Returns a new instance of Counter

Raises:

  • (ArgumentError)


16
17
18
19
20
21
# File 'lib/redis/counter.rb', line 16

def initialize(key, *args)
  super(key, *args)
  @options[:start] ||= @options[:default] || 0
  raise ArgumentError, "Marshalling redis counters does not make sense" if @options[:marshal]
  redis.setnx(key, @options[:start]) unless @options[:start] == 0 || @options[:init] === false
end

Instance Attribute Details

#keyObject (readonly)

Returns the value of attribute key



15
16
17
# File 'lib/redis/counter.rb', line 15

def key
  @key
end

#optionsObject (readonly)

Returns the value of attribute options



15
16
17
# File 'lib/redis/counter.rb', line 15

def options
  @options
end

Instance Method Details

#decrbyfloat(by = 1.0, &block) ⇒ Object

Decrement a floating point counter atomically. Redis uses separate API's to interact with integers vs floats.



96
97
98
99
# File 'lib/redis/counter.rb', line 96

def decrbyfloat(by=1.0, &block)
  val = redis.incrbyfloat(key, -by).to_f
  block_given? ? rewindable_block(:incrbyfloat, -by, val, &block) : val
end

#decrement(by = 1, &block) ⇒ Object Also known as: decr, decrby

Decrement the counter atomically and return the new value. If passed a block, that block will be evaluated with the new value of the counter as an argument. If the block returns nil or throws an exception, the counter will automatically be incremented to its previous value. This method is aliased as decr() for brevity.



80
81
82
83
# File 'lib/redis/counter.rb', line 80

def decrement(by=1, &block)
  val = redis.decrby(key, by).to_i
  block_given? ? rewindable_block(:increment, by, val, &block) : val
end

#getset(to = options[:start]) ⇒ Object

Reset the counter to its starting value, and return previous value. Use this to “reap” the counter and save it somewhere else. This is atomic in that no increments or decrements are lost if you process the returned value.



36
37
38
# File 'lib/redis/counter.rb', line 36

def getset(to=options[:start])
  redis.getset(key, to.to_i).to_i
end

#incrbyfloat(by = 1.0, &block) ⇒ Object

Increment a floating point counter atomically. Redis uses separate API's to interact with integers vs floats.



89
90
91
92
# File 'lib/redis/counter.rb', line 89

def incrbyfloat(by=1.0, &block)
  val = redis.incrbyfloat(key, by).to_f
  block_given? ? rewindable_block(:decrbyfloat, by, val, &block) : val
end

#increment(by = 1, &block) ⇒ Object Also known as: incr, incrby

Increment the counter atomically and return the new value. If passed a block, that block will be evaluated with the new value of the counter as an argument. If the block returns nil or throws an exception, the counter will automatically be decremented to its previous value. This method is aliased as incr() for brevity.



68
69
70
71
# File 'lib/redis/counter.rb', line 68

def increment(by=1, &block)
  val = redis.incrby(key, by).to_i
  block_given? ? rewindable_block(:decrement, by, val, &block) : val
end

#nil?Boolean



105
# File 'lib/redis/counter.rb', line 105

def nil?; value.nil? end

#reset(to = options[:start]) ⇒ Object

Reset the counter to its starting value. Not atomic, so use with care. Normally only useful if you're discarding all sub-records associated with a parent and starting over (for example, restarting a game and disconnecting all players).



27
28
29
30
# File 'lib/redis/counter.rb', line 27

def reset(to=options[:start])
  redis.set key, to.to_i
  true  # hack for redis-rb regression
end

#to_fObject

Like .value but casts to float since Redis addresses these differently.



59
60
61
# File 'lib/redis/counter.rb', line 59

def to_f
  redis.get(key).to_f
end

#to_sObject

Proxy methods to help make @object.counter == 10 work



103
# File 'lib/redis/counter.rb', line 103

def to_s; value.to_s; end

#valueObject Also known as: get, to_i

Returns the current value of the counter. Normally just calling the counter will lazily fetch the value, and only update it if increment or decrement is called. This forces a network call to redis-server to get the current value.



44
45
46
# File 'lib/redis/counter.rb', line 44

def value
  redis.get(key).to_i
end

#value=(val) ⇒ Object Also known as: set



49
50
51
52
53
54
55
# File 'lib/redis/counter.rb', line 49

def value=(val)
  if val.nil?
    delete
  else
    redis.set key, val
  end
end