Class: Redis::Set

Inherits:
BaseObject show all
Includes:
Enumerable, Helpers::CoreCommands, Helpers::Serialize
Defined in:
lib/redis/set.rb

Overview

Class representing a set.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Helpers::Serialize

#from_redis, #to_redis

Methods included from Helpers::CoreCommands

#exists?, #expire, #expireat, #persist, #rename, #renamenx, #sort, #ttl, #type

Methods inherited from BaseObject

#initialize, #redis

Constructor Details

This class inherits a constructor from Redis::BaseObject

Instance Attribute Details

#key ⇒ Object (readonly)

Returns the value of attribute key.



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

def key
  @key
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Instance Method Details

#<<(value) ⇒ Object

Works like add. Can chain together: list << ‘a’ << ‘b’



18
19
20
21
 
# File 'lib/redis/set.rb', line 18

def <<(value)
  add(value)
  self  # for << 'a' << 'b'
end

#==(x) ⇒ Object 



172
173
174
 
# File 'lib/redis/set.rb', line 172

def ==(x)
  members == x
end

#add(value) ⇒ Object

Add the specified value to the set only if it does not exist already. Redis: SADD



25
26
27
 
# File 'lib/redis/set.rb', line 25

def add(value)
  redis.sadd(key, to_redis(value))
end

#delete(value) ⇒ Object

Delete the value from the set. Redis: SREM



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

def delete(value)
  redis.srem(key, to_redis(value))
end

#delete_if(&block) ⇒ Object

Delete if matches block



59
60
61
62
63
64
65
66
67
 
# File 'lib/redis/set.rb', line 59

def delete_if(&block)
  res = false
  redis.smembers(key).each do |m|
    if block.call(from_redis(m))
      res = redis.srem(key, m)
    end
  end
  res
end

#difference(*sets) ⇒ Object Also known as: diff, ^, -

Return the difference vs another set. Can pass it either another set object or set name. Also available as ^ or - which is a bit cleaner:

members_difference = set1 ^ set2
members_difference = set1 - set2

If you want to specify multiple sets, you must use difference:

members_difference = set1.difference(set2, set3, set4)
members_difference = set1.diff(set2, set3, set4)

Redis: SDIFF



134
135
136
 
# File 'lib/redis/set.rb', line 134

def difference(*sets)
  from_redis redis.sdiff(key, *keys_from_objects(sets))
end

#diffstore(name, *sets) ⇒ Object

Calculate the diff and store it in Redis as name. Returns the number of elements in the stored union. Redis: SDIFFSTORE



143
144
145
 
# File 'lib/redis/set.rb', line 143

def diffstore(name, *sets)
  redis.sdiffstore(name, key, *keys_from_objects(sets))
end

#each(&block) ⇒ Object

Iterate through each member of the set. Redis::Objects mixes in Enumerable, so you can also use familiar methods like collect, detect, and so forth.



71
72
73
 
# File 'lib/redis/set.rb', line 71

def each(&block)
  members.each(&block)
end

#empty? ⇒ Boolean

Returns true if the set has no members. Redis: SCARD == 0

Returns:

  • (Boolean) 


168
169
170
 
# File 'lib/redis/set.rb', line 168

def empty?
  length == 0
end

#intersection(*sets) ⇒ Object Also known as: intersect, inter, &

Return the intersection with another set. Can pass it either another set object or set name. Also available as & which is a bit cleaner:

members_in_both = set1 & set2

If you want to specify multiple sets, you must use intersection:

members_in_all = set1.intersection(set2, set3, set4)
members_in_all = set1.inter(set2, set3, set4)  # alias

Redis: SINTER



86
87
88
 
# File 'lib/redis/set.rb', line 86

def intersection(*sets)
  from_redis redis.sinter(key, *keys_from_objects(sets))
end

#interstore(name, *sets) ⇒ Object

Calculate the intersection and store it in Redis as name. Returns the number of elements in the stored intersection. Redis: SUNIONSTORE



95
96
97
 
# File 'lib/redis/set.rb', line 95

def interstore(name, *sets)
  redis.sinterstore(name, key, *keys_from_objects(sets))
end

#length ⇒ Object Also known as: size, count

The number of members in the set. Aliased as size. Redis: SCARD



161
162
163
 
# File 'lib/redis/set.rb', line 161

def length
  redis.scard(key)
end

#member?(value) ⇒ Boolean Also known as: include?

Returns true if the specified value is in the set. Redis: SISMEMBER

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/redis/set.rb', line 48

def member?(value)
  redis.sismember(key, to_redis(value))
end

#members ⇒ Object Also known as: get

Return all members in the set. Redis: SMEMBERS



41
42
43
44
 
# File 'lib/redis/set.rb', line 41

def members
  v = from_redis redis.smembers(key)
  v.nil? ? [] : v
end

#merge(*values) ⇒ Object

Adds the specified values to the set. Only works on redis > 2.4 Redis: SADD



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

def merge(*values)
  redis.sadd(key, values.flatten.map{|v| to_redis(v)})
end

#move(value, destination) ⇒ Object

Moves value from one set to another. Destination can be a String or Redis::Set.

set.move(value, "name_of_key_in_redis")
set.move(value, set2)

Returns true if moved successfully.

Redis: SMOVE



156
157
158
 
# File 'lib/redis/set.rb', line 156

def move(value, destination)
  redis.smove(key, destination.is_a?(Redis::Set) ? destination.key : destination.to_s, value)
end

#pop ⇒ Object

Remove and return a random member. Redis: SPOP



30
31
32
 
# File 'lib/redis/set.rb', line 30

def pop
  from_redis redis.spop(key)
end

#to_s ⇒ Object 



176
177
178
 
# File 'lib/redis/set.rb', line 176

def to_s
  members.join(', ')
end

#union(*sets) ⇒ Object Also known as: |, +

Return the union with another set. Can pass it either another set object or set name. Also available as | and + which are a bit cleaner:

members_in_either = set1 | set2
members_in_either = set1 + set2

If you want to specify multiple sets, you must use union:

members_in_all = set1.union(set2, set3, set4)

Redis: SUNION



110
111
112
 
# File 'lib/redis/set.rb', line 110

def union(*sets)
  from_redis redis.sunion(key, *keys_from_objects(sets))
end

#unionstore(name, *sets) ⇒ Object

Calculate the union and store it in Redis as name. Returns the number of elements in the stored union. Redis: SUNIONSTORE



118
119
120
 
# File 'lib/redis/set.rb', line 118

def unionstore(name, *sets)
  redis.sunionstore(name, key, *keys_from_objects(sets))
end