Module: Moneta::IncrementSupport Private

Included in:

Adapters::DBM, Adapters::Daybreak, Adapters::GDBM, Adapters::LRUHash, Adapters::LevelDB, Adapters::Memory, Adapters::SDBM, Adapters::Sqlite, Adapters::TDB, Adapters::TokyoCabinet, WeakIncrement

Defined in:

lib/moneta/mixins.rb

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Class Method Summary

• .included(base) ⇒ Object private

Instance Method Summary

• #increment(key, amount = 1, options = {}) ⇒ Object

  Atomically increment integer value with key.

Class Method Details

.included(base) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/moneta/mixins.rb', line 415

def self.included(base)
  base.supports(:increment) if base.respond_to?(:supports)
end

Instance Method Details

#increment(key, amount = 1, options = {}) ⇒ Object

Note:

Not every Moneta store implements this method, a NotImplementedError is raised if it is not supported.

Atomically increment integer value with key

This method also accepts negative amounts.

Parameters:

• key (Object)
• amount (Integer) (defaults to: 1)
• options (Hash) (defaults to: {})

Options Hash (options):

• :prefix (String) —

  Prefix key (See Transformer)

• Other (Object) —

  options as defined by the adapters or middleware

Returns:

• (Object) —

  value from store

# File 'lib/moneta/mixins.rb', line 408

def increment(key, amount = 1, options = {})
  existing = load(key, options)
  value = (existing == nil ? 0 : Integer(existing)) + amount
  store(key, value.to_s, options)
  value
end