Class: MockRedis::Database

Inherits:
Object
  • Object
show all
Includes:
ConnectionMethod, GeospatialMethods, HashMethods, InfoMethod, ListMethods, MemoryMethod, SetMethods, SortMethod, StreamMethods, StringMethods, UtilityMethods, ZsetMethods
Defined in:
lib/mock_redis/database.rb

Constant Summary

Constants included from GeospatialMethods

GeospatialMethods::D_R, GeospatialMethods::EARTH_RADIUS_IN_METERS, GeospatialMethods::LAT_RANGE, GeospatialMethods::LNG_RANGE, GeospatialMethods::STEP, GeospatialMethods::UNITS

Constants included from InfoMethod

InfoMethod::ALL_INFO, InfoMethod::CLIENTS_INFO, InfoMethod::COMMAND_STATS_COMBINED_INFO, InfoMethod::COMMAND_STATS_SOLO_INFO, InfoMethod::CPU_INFO, InfoMethod::DEFAULT_INFO, InfoMethod::KEYSPACE_INFO, InfoMethod::MEMORY_INFO, InfoMethod::PERSISTENCE_INFO, InfoMethod::REPLICATION_INFO, InfoMethod::SERVER_INFO, InfoMethod::STATS_INFO

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MemoryMethod

#memory

Methods included from ConnectionMethod

#connection

Methods included from StreamMethods

#xadd, #xlen, #xrange, #xread, #xrevrange, #xtrim

Methods included from GeospatialMethods

#geodist, #geohash, #geopos

Methods included from InfoMethod

#info

Methods included from SortMethod

#sort

Methods included from ZsetMethods

#zadd, #zcard, #zcount, #zincrby, #zinterstore, #zmscore, #zpopmax, #zpopmin, #zrange, #zrangebyscore, #zrank, #zrem, #zremrangebyrank, #zremrangebyscore, #zrevrange, #zrevrangebyscore, #zrevrank, #zscan, #zscan_each, #zscore, #zunionstore

Methods included from StringMethods

#append, #bitcount, #bitfield, #decr, #decrby, #get, #getbit, #getdel, #getrange, #getset, #incr, #incrby, #incrbyfloat, #mapped_mget, #mapped_mset, #mapped_msetnx, #mget, #mset, #msetnx, #psetex, #set, #setbit, #setex, #setnx, #setrange, #strlen

Methods included from SetMethods

#sadd, #sadd?, #scard, #sdiff, #sdiffstore, #sinter, #sinterstore, #sismember, #smembers, #smismember, #smove, #spop, #srandmember, #srem, #srem?, #sscan, #sscan_each, #sunion, #sunionstore

Methods included from ListMethods

#blmove, #blpop, #brpop, #brpoplpush, #lindex, #linsert, #llen, #lmove, #lmpop, #lpop, #lpush, #lpushx, #lrange, #lrem, #lset, #ltrim, #rpop, #rpoplpush, #rpush, #rpushx

Methods included from HashMethods

#hdel, #hexists, #hget, #hgetall, #hincrby, #hincrbyfloat, #hkeys, #hlen, #hmget, #hmset, #hscan, #hscan_each, #hset, #hsetnx, #hvals, #mapped_hmget, #mapped_hmset

Constructor Details

#initialize(base, *_args) ⇒ Database

Returns a new instance of Database.



34
35
36
37
38
 
# File 'lib/mock_redis/database.rb', line 34

def initialize(base, *_args)
  @base = base
  @data = MockRedis::IndifferentHash.new
  @expire_times = []
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



32
33
34
 
# File 'lib/mock_redis/database.rb', line 32

def data
  @data
end

#expire_times ⇒ Object (readonly)

Returns the value of attribute expire_times.



32
33
34
 
# File 'lib/mock_redis/database.rb', line 32

def expire_times
  @expire_times
end

Instance Method Details

#auth(_) ⇒ Object 



57
58
59
 
# File 'lib/mock_redis/database.rb', line 57

def auth(_)
  'OK'
end

#bgrewriteaof ⇒ Object 



61
62
63
 
# File 'lib/mock_redis/database.rb', line 61

def bgrewriteaof
  'Background append only file rewriting started'
end

#bgsave ⇒ Object 



65
66
67
 
# File 'lib/mock_redis/database.rb', line 65

def bgsave
  'Background saving started'
end

#call(*command, &_block) ⇒ Object

FIXME: Current implementation of ‘call` does not work propetly with kwarg-options. i.e. `call(“EXPIRE”, “foo”, 40, “NX”)` (which redis-rb will simply transmit to redis-server) will be passed to `#expire` without keywords transformation.



51
52
53
54
55
 
# File 'lib/mock_redis/database.rb', line 51

def call(*command, &_block)
  # allow for single array argument or multiple arguments
  command = command[0] if command.length == 1
  public_send(command[0].downcase, *command[1..])
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
 
# File 'lib/mock_redis/database.rb', line 75

def connected?
  true
end

#dbsize ⇒ Object 



79
80
81
 
# File 'lib/mock_redis/database.rb', line 79

def dbsize
  data.keys.length
end

#del(*keys) ⇒ Object Also known as: unlink 



83
84
85
86
87
88
89
90
91
92
 
# File 'lib/mock_redis/database.rb', line 83

def del(*keys)
  keys = keys.flatten.map(&:to_s)
  # assert_has_args(keys, 'del') # no longer errors in redis > v4.5

  keys.
    find_all { |key| data[key] }.
    each { |k| persist(k) }.
    each { |k| data.delete(k) }.
    length
end

#disconnect ⇒ Object Also known as: close 



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

def disconnect
  nil
end

#dump(key) ⇒ Object 



156
157
158
159
 
# File 'lib/mock_redis/database.rb', line 156

def dump(key)
  value = data[key]
  value ? Marshal.dump(value) : nil
end

#echo(msg) ⇒ Object 



95
96
97
 
# File 'lib/mock_redis/database.rb', line 95

def echo(msg)
  msg.to_s
end

#eval(*args) ⇒ Object 



303
 
# File 'lib/mock_redis/database.rb', line 303

def eval(*args); end

#evalsha(*args) ⇒ Object 



301
 
# File 'lib/mock_redis/database.rb', line 301

def evalsha(*args); end

#exists(*keys) ⇒ Object 



142
143
144
 
# File 'lib/mock_redis/database.rb', line 142

def exists(*keys)
  keys.count { |key| data.key?(key) }
end

#exists?(*keys) ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
149
 
# File 'lib/mock_redis/database.rb', line 146

def exists?(*keys)
  keys.each { |key| return true if data.key?(key) }
  false
end

#expire(key, seconds, nx: nil, xx: nil, lt: nil, gt: nil) ⇒ Object

rubocop:disable Metrics/ParameterLists



99
100
101
102
103
 
# File 'lib/mock_redis/database.rb', line 99

def expire(key, seconds, nx: nil, xx: nil, lt: nil, gt: nil) # rubocop:disable Metrics/ParameterLists
  seconds = Integer(seconds)

  pexpire(key, seconds.to_i * 1000, nx: nx, xx: xx, lt: lt, gt: gt)
end

#expire_keys ⇒ Object

This method isn’t private, but it also isn’t a Redis command, so it doesn’t belong up above with all the Redis commands.



393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/mock_redis/database.rb', line 393

def expire_keys
  now_sec, miliseconds = now
  now_ms = now_sec * 1_000 + miliseconds

  to_delete = expire_times.take_while do |(time, _key)|
    (time.to_r * 1_000).to_i <= now_ms
  end

  to_delete.each do |(_time, key)|
    del(key)
  end
end

#expireat(key, timestamp, nx: nil, xx: nil, lt: nil, gt: nil) ⇒ Object

rubocop:disable Metrics/ParameterLists



113
114
115
116
117
 
# File 'lib/mock_redis/database.rb', line 113

def expireat(key, timestamp, nx: nil, xx: nil, lt: nil, gt: nil) # rubocop:disable Metrics/ParameterLists
  timestamp = Integer(timestamp)

  pexpireat(key, timestamp.to_i * 1000, nx: nx, xx: xx, lt: lt, gt: gt)
end

#flushdb ⇒ Object 



151
152
153
154
 
# File 'lib/mock_redis/database.rb', line 151

def flushdb
  data.each_key { |k| del(k) }
  'OK'
end

#initialize_copy(_source) ⇒ Object 



40
41
42
43
44
 
# File 'lib/mock_redis/database.rb', line 40

def initialize_copy(_source)
  @data = @data.clone
  @data.each_key { |k| @data[k] = @data[k].clone }
  @expire_times = @expire_times.map(&:clone)
end

#keys(format = '*') ⇒ Object 



172
173
174
 
# File 'lib/mock_redis/database.rb', line 172

def keys(format = '*')
  data.keys.grep(redis_pattern_to_ruby_regex(format))
end

#lastsave ⇒ Object 



190
191
192
 
# File 'lib/mock_redis/database.rb', line 190

def lastsave
  now.first
end

#now ⇒ Object Also known as: time 



272
273
274
275
276
 
# File 'lib/mock_redis/database.rb', line 272

def now
  current_time = @base.options[:time_class].now
  miliseconds = (current_time.to_r - current_time.to_i) * 1_000
  [current_time.to_i, miliseconds.to_i]
end

#persist(key) ⇒ Object 



194
195
196
197
198
199
200
201
 
# File 'lib/mock_redis/database.rb', line 194

def persist(key)
  if exists?(key) && has_expiration?(key)
    remove_expiration(key)
    true
  else
    false
  end
end

#pexpire(key, ms, nx: nil, xx: nil, lt: nil, gt: nil) ⇒ Object

rubocop:disable Metrics/ParameterLists



105
106
107
108
109
110
111
 
# File 'lib/mock_redis/database.rb', line 105

def pexpire(key, ms, nx: nil, xx: nil, lt: nil, gt: nil) # rubocop:disable Metrics/ParameterLists
  ms = Integer(ms)

  now, miliseconds = @base.now
  now_ms = (now * 1000) + miliseconds
  pexpireat(key, now_ms + ms.to_i, nx: nx, xx: xx, lt: lt, gt: gt)
end

#pexpireat(key, timestamp_ms, nx: nil, xx: nil, lt: nil, gt: nil) ⇒ Object

rubocop:disable Metrics/ParameterLists



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/mock_redis/database.rb', line 119

def pexpireat(key, timestamp_ms, nx: nil, xx: nil, lt: nil, gt: nil) # rubocop:disable Metrics/ParameterLists
  timestamp_ms = Integer(timestamp_ms)

  if nx && gt || gt && lt || lt && nx || nx && xx
    raise Error.command_error(
      'ERR NX and XX, GT or LT options at the same time are not compatible',
      self
    )
  end

  return false unless exists?(key)

  expiry = expiration(key)
  new_expiry = @base.time_at(Rational(timestamp_ms.to_i, 1000))

  if should_update_expiration?(expiry, new_expiry, nx: nx, xx: xx, lt: lt, gt: gt)
    set_expiration(key, new_expiry)
    true
  else
    false
  end
end

#ping(response = 'PONG') ⇒ Object 



203
204
205
 
# File 'lib/mock_redis/database.rb', line 203

def ping(response = 'PONG')
  response
end

#pttl(key) ⇒ Object 



259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/mock_redis/database.rb', line 259

def pttl(key)
  now, miliseconds = @base.now
  now_ms = now * 1000 + miliseconds

  if !exists?(key)
    -2
  elsif has_expiration?(key)
    (expiration(key).to_r * 1000).to_i - now_ms
  else
    -1
  end
end

#quit ⇒ Object 



207
208
209
 
# File 'lib/mock_redis/database.rb', line 207

def quit
  'OK'
end

#randomkey ⇒ Object 



211
212
213
 
# File 'lib/mock_redis/database.rb', line 211

def randomkey
  data.keys[rand(data.length)]
end

#rename(key, newkey) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/mock_redis/database.rb', line 215

def rename(key, newkey)
  unless data.include?(key)
    raise Error.command_error('ERR no such key', self)
  end

  if key != newkey
    data[newkey] = data.delete(key)
    if has_expiration?(key)
      set_expiration(newkey, expiration(key))
      remove_expiration(key)
    end
  end

  'OK'
end

#renamenx(key, newkey) ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/mock_redis/database.rb', line 231

def renamenx(key, newkey)
  unless data.include?(key)
    raise Error.command_error('ERR no such key', self)
  end

  if exists?(newkey)
    false
  else
    rename(key, newkey)
    true
  end
end

#restore(key, ttl, value, replace: false) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/mock_redis/database.rb', line 161

def restore(key, ttl, value, replace: false)
  if !replace && exists?(key)
    raise Error.command_error('BUSYKEY Target key name already exists.', self)
  end
  data[key] = Marshal.load(value) # rubocop:disable Security/MarshalLoad
  if ttl > 0
    pexpire(key, ttl)
  end
  'OK'
end

#save ⇒ Object 



244
245
246
 
# File 'lib/mock_redis/database.rb', line 244

def save
  'OK'
end

#scan(cursor, opts = {}) ⇒ Object 



176
177
178
 
# File 'lib/mock_redis/database.rb', line 176

def scan(cursor, opts = {})
  common_scan(data.keys, cursor, opts)
end

#scan_each(opts = {}, &block) ⇒ Object 



180
181
182
183
184
185
186
187
188
 
# File 'lib/mock_redis/database.rb', line 180

def scan_each(opts = {}, &block)
  return to_enum(:scan_each, opts) unless block_given?
  cursor = 0
  loop do
    cursor, keys = scan(cursor, opts)
    keys.each(&block)
    break if cursor == '0'
  end
end

#script(subcommand, *args) ⇒ Object 



299
 
# File 'lib/mock_redis/database.rb', line 299

def script(subcommand, *args); end

#ttl(key) ⇒ Object 



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/mock_redis/database.rb', line 248

def ttl(key)
  if !exists?(key)
    -2
  elsif has_expiration?(key)
    now, = @base.now
    expiration(key).to_i - now
  else
    -1
  end
end

#type(key) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/mock_redis/database.rb', line 279

def type(key)
  if !exists?(key)
    'none'
  elsif hashy?(key)
    'hash'
  elsif stringy?(key)
    'string'
  elsif listy?(key)
    'list'
  elsif sety?(key)
    'set'
  elsif zsety?(key)
    'zset'
  elsif streamy?(key)
    'stream'
  else
    raise ArgumentError, "Not sure how #{data[key].inspect} got in here"
  end
end