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 



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

def auth(_)
  'OK'
end

#bgrewriteaof ⇒ Object 



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

def bgrewriteaof
  'Background append only file rewriting started'
end

#bgsave ⇒ Object 



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

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
56
57
58
59
60
 
# 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

  if command[0].downcase.to_s.include?('expire')
    send_expires(command)
  else
    public_send(command[0].downcase, *command[1..])
  end
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


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

def connected?
  true
end

#dbsize ⇒ Object 



84
85
86
 
# File 'lib/mock_redis/database.rb', line 84

def dbsize
  data.keys.length
end

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



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/mock_redis/database.rb', line 88

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 



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

def disconnect
  nil
end

#dump(key) ⇒ Object 



161
162
163
164
 
# File 'lib/mock_redis/database.rb', line 161

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

#echo(msg) ⇒ Object 



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

def echo(msg)
  msg.to_s
end

#eval(*args) ⇒ Object 



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

def eval(*args); end

#evalsha(*args) ⇒ Object 



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

def evalsha(*args); end

#exists(*keys) ⇒ Object 



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

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

#exists?(*keys) ⇒ Boolean

Returns:

  • (Boolean) 


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

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



104
105
106
107
108
 
# File 'lib/mock_redis/database.rb', line 104

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.



403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/mock_redis/database.rb', line 403

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



118
119
120
121
122
 
# File 'lib/mock_redis/database.rb', line 118

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 



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

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 



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

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

#lastsave ⇒ Object 



195
196
197
 
# File 'lib/mock_redis/database.rb', line 195

def lastsave
  now.first
end

#now ⇒ Object Also known as: time 



277
278
279
280
281
 
# File 'lib/mock_redis/database.rb', line 277

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 



199
200
201
202
203
204
205
206
 
# File 'lib/mock_redis/database.rb', line 199

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



110
111
112
113
114
115
116
 
# File 'lib/mock_redis/database.rb', line 110

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/mock_redis/database.rb', line 124

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 



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

def ping(response = 'PONG')
  response
end

#pttl(key) ⇒ Object 



264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/mock_redis/database.rb', line 264

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 



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

def quit
  'OK'
end

#randomkey ⇒ Object 



216
217
218
 
# File 'lib/mock_redis/database.rb', line 216

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

#rename(key, newkey) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/mock_redis/database.rb', line 220

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 



236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/mock_redis/database.rb', line 236

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 



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/mock_redis/database.rb', line 166

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 



249
250
251
 
# File 'lib/mock_redis/database.rb', line 249

def save
  'OK'
end

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



181
182
183
 
# File 'lib/mock_redis/database.rb', line 181

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

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



185
186
187
188
189
190
191
192
193
 
# File 'lib/mock_redis/database.rb', line 185

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 



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

def script(subcommand, *args); end

#ttl(key) ⇒ Object 



253
254
255
256
257
258
259
260
261
262
 
# File 'lib/mock_redis/database.rb', line 253

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 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/mock_redis/database.rb', line 284

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