Class: Familia::HashKey

Inherits:
RedisObject show all
Defined in:
lib/familia/redisobject.rb

Instance Attribute Summary

Attributes inherited from RedisObject

#cache, #name, #parent, #redis

Instance Method Summary collapse

Methods inherited from RedisObject

#class?, #clear_cache, #db, #dump_method, #echo, #exists?, #expire, #expireat, #from_redis, inherited, #initialize, #load_method, #move, #multi_from_redis, #parent?, #persist, #qstamp, #realttl, #rediskey, register, registration, #rename, #renamenx, #to_redis, #ttl, #type, #update_expiration

Constructor Details

This class inherits a constructor from Familia::RedisObject

Instance Method Details

#[](n) ⇒ Object Also known as: get



832
833
834
# File 'lib/familia/redisobject.rb', line 832

def [] n
  from_redis redis.hget(rediskey, n)
end

#[]=(n, v) ⇒ Object Also known as: put, store



819
820
821
822
823
824
825
826
827
828
# File 'lib/familia/redisobject.rb', line 819

def []= n, v
  ret = redis.hset rediskey, n, to_redis(v)
  update_expiration
  ret
rescue TypeError => e
  echo :hset, caller[0] if Familia.debug
  klass = v.class
  msg = "Cannot store #{n} => #{v.inspect} (#{klass}) in #{rediskey}"
  raise e.class, msg
end

#allObject Also known as: to_hash, clone



856
857
858
859
# File 'lib/familia/redisobject.rb', line 856

def all
  # TODO: from_redis
  redis.hgetall rediskey
end

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



882
883
884
# File 'lib/familia/redisobject.rb', line 882

def decrement n, by=1
  increment n, -by
end

#delete(n) ⇒ Object Also known as: remove, rem, del



869
870
871
# File 'lib/familia/redisobject.rb', line 869

def delete n
  redis.hdel rediskey, n
end

#empty?Boolean

Returns:

  • (Boolean)


815
816
817
# File 'lib/familia/redisobject.rb', line 815

def empty?
  size == 0
end

#fetch(n, default = nil) ⇒ Object



837
838
839
840
841
842
843
844
845
# File 'lib/familia/redisobject.rb', line 837

def fetch n, default=nil
  ret = self[n]
  if ret.nil?
    raise IndexError.new("No such index for: #{n}") if default.nil?
    default
  else
    ret
  end
end

#has_key?(n) ⇒ Boolean Also known as: include?, member?

Returns:

  • (Boolean)


863
864
865
# File 'lib/familia/redisobject.rb', line 863

def has_key? n
  redis.hexists rediskey, n
end

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



876
877
878
# File 'lib/familia/redisobject.rb', line 876

def increment n, by=1
  redis.hincrby(rediskey, n, by).to_i
end

#keysObject



847
848
849
# File 'lib/familia/redisobject.rb', line 847

def keys
  redis.hkeys rediskey
end

#sizeObject Also known as: length



810
811
812
# File 'lib/familia/redisobject.rb', line 810

def size
  redis.hlen rediskey
end

#update(h = {}) ⇒ Object Also known as: merge!

Raises:

  • (ArgumentError)


888
889
890
891
892
893
894
# File 'lib/familia/redisobject.rb', line 888

def update h={}
  raise ArgumentError, "Argument to bulk_set must be a hash" unless Hash === h
  data = h.inject([]){ |ret,pair| ret << [pair[0], to_redis(pair[1])] }.flatten
  ret = redis.hmset(rediskey, *data)
  update_expiration
  ret
end

#valuesObject



851
852
853
854
# File 'lib/familia/redisobject.rb', line 851

def values
  el = redis.hvals(rediskey)
  multi_from_redis *el
end

#values_at(*names) ⇒ Object



897
898
899
900
# File 'lib/familia/redisobject.rb', line 897

def values_at *names
  el = redis.hmget(rediskey, *names.flatten.compact)
  multi_from_redis *el
end