Class: RedisHash

Inherits:
Object
  • Object
show all
Defined in:
lib/redis_hash.rb

Defined Under Namespace

Classes: InvalidNameException, InvalidRedisConfigException

Constant Summary collapse

VERSION = 
"0.0.2"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, redis_or_options = {}) ⇒ RedisHash

Returns a new instance of RedisHash.

Raises:



11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/redis_hash.rb', line 11

def initialize(name, redis_or_options = {})
	name = name.to_s if name.kind_of? Symbol

	raise InvalidNameException.new unless name.kind_of?(String) && name.size > 0
	@name = name
	@redis = if redis_or_options.kind_of? Redis
		         redis_or_options
		       elsif redis_or_options.kind_of? Hash
			       ::Redis.new redis_or_options
		       else
			       raise InvalidRedisConfigException.new
	         end
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



4
5
6
 
# File 'lib/redis_hash.rb', line 4

def name
  @name
end

Instance Method Details

#all ⇒ Object 



69
70
71
 
# File 'lib/redis_hash.rb', line 69

def all
	@redis.hgetall name
end

#clear ⇒ Object Also known as: flush 



108
109
110
111
 
# File 'lib/redis_hash.rb', line 108

def clear
	@redis.del name
	{}
end

#enumerator(slice_size = 10) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/redis_hash.rb', line 95

def enumerator(slice_size = 10)
	cursor = 0
	Enumerator.new do |yielder|
		loop do
			cursor, items = scan cursor, slice_size
			items.each do |item|
				yielder << {item.first => item.last}
			end
			raise StopIteration if cursor.to_i.zero?
		end
	end
end

#expire(seconds) ⇒ Object 



115
116
117
 
# File 'lib/redis_hash.rb', line 115

def expire seconds
	@redis.expire name, seconds
end

#get(*keys) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/redis_hash.rb', line 25

def get *keys
	keys = keys.flatten
	if keys.size > 0
		values = if 1 == keys.size
			         @redis.hget name, keys.first
			       else
				       @redis.hmget name, *keys
		         end

		keys.each_with_index.map do |k,i|
			[k, values[i]]
		end.to_h
	end
end

#include?(key) ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/redis_hash.rb', line 81

def include? key
	@redis.hexists(name, key)
end

#increment_float_key(key, increment_amount = 1) ⇒ Object 



58
59
60
 
# File 'lib/redis_hash.rb', line 58

def increment_float_key key, increment_amount = 1
	@redis.hincrbyfloat(name, key, increment_amount)
end

#increment_integer_key(key, increment_amount = 1) ⇒ Object 



54
55
56
 
# File 'lib/redis_hash.rb', line 54

def increment_integer_key key, increment_amount = 1
	@redis.hincrby(name, key, increment_amount)
end

#keys ⇒ Object 



73
74
75
 
# File 'lib/redis_hash.rb', line 73

def keys
	@redis.hkeys name
end

#remove(*keys) ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/redis_hash.rb', line 62

def remove *keys
	keys = keys.flatten
	if keys.size > 0
		@redis.hdel name, *keys
	end
end

#scan(cursor = 0, amount = 10, match = "*") ⇒ Object 



91
92
93
 
# File 'lib/redis_hash.rb', line 91

def scan cursor = 0, amount = 10, match = "*"
	@redis.hscan name, cursor, :count => amount, :match => match
end

#set(hash) ⇒ Object 



40
41
42
43
44
45
46
47
48
 
# File 'lib/redis_hash.rb', line 40

def set hash
	if hash.size > 0
		if 1 == hash.size
			@redis.hset name, hash.keys.first, hash.values.first
		else
			@redis.hmset name, *(hash.map { |k, v| [k, v] }.flatten)
		end
	end
end

#set_if_does_not_exist(hash) ⇒ Object 



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

def set_if_does_not_exist hash
	@redis.hsetnx(name, hash.keys.first, hash.values.first)
end

#size ⇒ Object Also known as: count 



85
86
87
 
# File 'lib/redis_hash.rb', line 85

def size
	@redis.hlen name
end

#values ⇒ Object 



77
78
79
 
# File 'lib/redis_hash.rb', line 77

def values
	@redis.hvals name
end