Module: MockRedis::StringMethods

Includes:
Assertions, UtilityMethods
Included in:
Database
Defined in:
lib/mock_redis/string_methods.rb

Instance Method Summary collapse

Instance Method Details

#append(key, value) ⇒ Object


8
9
10
11
12
13
# File 'lib/mock_redis/string_methods.rb', line 8

def append(key, value)
  assert_stringy(key)
  data[key] ||= ''
  data[key] << value
  data[key].length
end

#bitcount(key, start = 0, stop = -1)) ⇒ Object


294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# File 'lib/mock_redis/string_methods.rb', line 294

def bitcount(key, start = 0, stop = -1)
  assert_stringy(key)

  str   = data[key] || ''
  count = 0
  m1    = 0x5555555555555555
  m2    = 0x3333333333333333
  m4    = 0x0f0f0f0f0f0f0f0f
  m8    = 0x00ff00ff00ff00ff
  m16   = 0x0000ffff0000ffff
  m32   = 0x00000000ffffffff

  str.bytes.to_a[start..stop].each do |byte|
    # Naive Hamming weight
    c = byte
    c = (c & m1) + ((c >> 1) & m1)
    c = (c & m2) + ((c >> 2) & m2)
    c = (c & m4) + ((c >> 4) & m4)
    c = (c & m8) + ((c >> 8) & m8)
    c = (c & m16) + ((c >> 16) & m16)
    c = (c & m32) + ((c >> 32) & m32)
    count += c
  end

  count
end

#bitfield(*args) ⇒ Object


15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/mock_redis/string_methods.rb', line 15

def bitfield(*args)
  if args.length < 4
    raise Redis::CommandError, 'ERR wrong number of arguments for BITFIELD'
  end

  key = args.shift
  output = []
  overflow_method = 'wrap'

  until args.empty?
    command = args.shift.to_s

    if command == 'overflow'
      new_overflow_method = args.shift.to_s.downcase

      unless %w[wrap sat fail].include? new_overflow_method
        raise Redis::CommandError, 'ERR Invalid OVERFLOW type specified'
      end

      overflow_method = new_overflow_method
      next
    end

    type, offset = args.shift(2)

    is_signed = type.slice(0) == 'i'
    type_size = type[1..-1].to_i

    if (type_size > 64 && is_signed) || (type_size >= 64 && !is_signed)
      raise Redis::CommandError,
        'ERR Invalid bitfield type. Use something like i16 u8. ' \
        'Note that u64 is not supported but i64 is.'
    end

    if offset.to_s[0] == '#'
      offset = offset[1..-1].to_i * type_size
    end

    bits = []

    type_size.times do |i|
      bits.push(getbit(key, offset + i))
    end

    val = is_signed ? twos_complement_decode(bits) : bits.join('').to_i(2)

    case command
    when 'get'
      output.push(val)
    when 'set'
      output.push(val)

      set_bitfield(key, args.shift.to_i, is_signed, type_size, offset)
    when 'incrby'
      new_val = incr_bitfield(val, args.shift.to_i, is_signed, type_size, overflow_method)

      set_bitfield(key, new_val, is_signed, type_size, offset) if new_val
      output.push(new_val)
    end
  end

  output
end

#decr(key) ⇒ Object


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

def decr(key)
  decrby(key, 1)
end

#decrby(key, n) ⇒ Object


83
84
85
# File 'lib/mock_redis/string_methods.rb', line 83

def decrby(key, n)
  incrby(key, -n)
end

#get(key) ⇒ Object


87
88
89
90
91
# File 'lib/mock_redis/string_methods.rb', line 87

def get(key)
  key = key.to_s
  assert_stringy(key)
  data[key]
end

#getbit(key, offset) ⇒ Object


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/mock_redis/string_methods.rb', line 93

def getbit(key, offset)
  assert_stringy(key)

  offset = offset.to_i
  offset_of_byte = offset / 8
  offset_within_byte = offset % 8

  # String#getbyte would be lovely, but it's not in 1.8.7.
  byte = (data[key] || '').each_byte.drop(offset_of_byte).first

  if byte
    (byte & (2**7 >> offset_within_byte)) > 0 ? 1 : 0
  else
    0
  end
end

#getrange(key, start, stop) ⇒ Object


110
111
112
113
# File 'lib/mock_redis/string_methods.rb', line 110

def getrange(key, start, stop)
  assert_stringy(key)
  (data[key] || '')[start..stop]
end

#getset(key, value) ⇒ Object


115
116
117
118
119
# File 'lib/mock_redis/string_methods.rb', line 115

def getset(key, value)
  retval = get(key)
  set(key, value)
  retval
end

#incr(key) ⇒ Object


121
122
123
# File 'lib/mock_redis/string_methods.rb', line 121

def incr(key)
  incrby(key, 1)
end

#incrby(key, n) ⇒ Object


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/mock_redis/string_methods.rb', line 125

def incrby(key, n)
  assert_stringy(key)
  unless can_incr?(data[key])
    raise Redis::CommandError, 'ERR value is not an integer or out of range'
  end

  unless looks_like_integer?(n.to_s)
    raise Redis::CommandError, 'ERR value is not an integer or out of range'
  end

  new_value = data[key].to_i + n.to_i
  data[key] = new_value.to_s
  # for some reason, redis-rb doesn't return this as a string.
  new_value
end

#incrbyfloat(key, n) ⇒ Object


141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/mock_redis/string_methods.rb', line 141

def incrbyfloat(key, n)
  assert_stringy(key)
  unless can_incr_float?(data[key])
    raise Redis::CommandError, 'ERR value is not a valid float'
  end

  unless looks_like_float?(n.to_s)
    raise Redis::CommandError, 'ERR value is not a valid float'
  end

  new_value = data[key].to_f + n.to_f
  data[key] = new_value.to_s
  # for some reason, redis-rb doesn't return this as a string.
  new_value
end

#mapped_mget(*keys) ⇒ Object


169
170
171
# File 'lib/mock_redis/string_methods.rb', line 169

def mapped_mget(*keys)
  Hash[keys.zip(mget(*keys))]
end

#mapped_mset(hash) ⇒ Object


188
189
190
# File 'lib/mock_redis/string_methods.rb', line 188

def mapped_mset(hash)
  mset(*hash.to_a.flatten)
end

#mapped_msetnx(hash) ⇒ Object


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

def mapped_msetnx(hash)
  msetnx(*hash.to_a.flatten)
end

#mget(*keys, &blk) ⇒ Object


157
158
159
160
161
162
163
164
165
166
167
# File 'lib/mock_redis/string_methods.rb', line 157

def mget(*keys, &blk)
  keys.flatten!

  assert_has_args(keys, 'mget')

  data = keys.map do |key|
    get(key) if stringy?(key)
  end

  blk ? blk.call(data) : data
end

#mset(*kvpairs) ⇒ Object


173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/mock_redis/string_methods.rb', line 173

def mset(*kvpairs)
  assert_has_args(kvpairs, 'mset')
  kvpairs = kvpairs.first if kvpairs.size == 1 && kvpairs.first.is_a?(Enumerable)

  if kvpairs.length.odd?
    raise Redis::CommandError, 'ERR wrong number of arguments for MSET'
  end

  kvpairs.each_slice(2) do |(k, v)|
    set(k, v)
  end

  'OK'
end

#msetnx(*kvpairs) ⇒ Object


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

def msetnx(*kvpairs)
  assert_has_args(kvpairs, 'msetnx')

  if kvpairs.each_slice(2).any? { |(k, _)| exists?(k) }
    false
  else
    mset(*kvpairs)
    true
  end
end

#set(key, value, ex: nil, px: nil, nx: nil, xx: nil, keepttl: nil) ⇒ Object

Parameer list required to ensure the ArgumentError is returned correctly rubocop:disable Metrics/ParameterLists


209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
# File 'lib/mock_redis/string_methods.rb', line 209

def set(key, value, ex: nil, px: nil, nx: nil, xx: nil, keepttl: nil)
  key = key.to_s
  return_true = false
  if nx
    if exists?(key)
      return false
    else
      return_true = true
    end
  end
  if xx
    if exists?(key)
      return_true = true
    else
      return false
    end
  end
  data[key] = value.to_s

  remove_expiration(key) unless keepttl
  if ex
    if ex == 0
      raise Redis::CommandError, 'ERR invalid expire time in set'
    end
    expire(key, ex)
  end

  if px
    if px == 0
      raise Redis::CommandError, 'ERR invalid expire time in set'
    end
    pexpire(key, px)
  end

  return_true ? true : 'OK'
end

#setbit(key, offset, value) ⇒ Object

rubocop:enable Metrics/ParameterLists


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/mock_redis/string_methods.rb', line 247

def setbit(key, offset, value)
  assert_stringy(key, 'ERR bit is not an integer or out of range')
  retval = getbit(key, offset)

  str = data[key] || ''

  offset = offset.to_i
  offset_of_byte = offset / 8
  offset_within_byte = offset % 8

  if offset_of_byte >= str.bytesize
    str = zero_pad(str, offset_of_byte + 1)
  end

  char_index = byte_index = offset_within_char = 0
  str.each_char do |c|
    if byte_index < offset_of_byte
      char_index += 1
      byte_index += c.bytesize
    else
      offset_within_char = byte_index - offset_of_byte
      break
    end
  end

  char = str[char_index]
  char = char.chr if char.respond_to?(:chr) # ruby 1.8 vs 1.9
  char_as_number = char.each_byte.reduce(0) do |a, byte|
    (a << 8) + byte
  end

  bitmask_length = (char.bytesize * 8 - offset_within_char * 8 - offset_within_byte - 1)
  bitmask = 1 << bitmask_length

  if value.zero?
    bitmask ^= 2**(char.bytesize * 8) - 1
    char_as_number &= bitmask
  else
    char_as_number |= bitmask
  end

  str[char_index] = char_as_number.chr

  data[key] = str
  retval
end

#setex(key, seconds, value) ⇒ Object


321
322
323
324
325
326
327
328
329
# File 'lib/mock_redis/string_methods.rb', line 321

def setex(key, seconds, value)
  if seconds <= 0
    raise Redis::CommandError, 'ERR invalid expire time in setex'
  else
    set(key, value)
    expire(key, seconds)
    'OK'
  end
end

#setnx(key, value) ⇒ Object


331
332
333
334
335
336
337
338
# File 'lib/mock_redis/string_methods.rb', line 331

def setnx(key, value)
  if exists?(key)
    false
  else
    set(key, value)
    true
  end
end

#setrange(key, offset, value) ⇒ Object


340
341
342
343
344
345
346
347
348
# File 'lib/mock_redis/string_methods.rb', line 340

def setrange(key, offset, value)
  assert_stringy(key)
  value = value.to_s
  old_value = (data[key] || '')

  prefix = zero_pad(old_value[0...offset], offset)
  data[key] = prefix + value + (old_value[(offset + value.length)..-1] || '')
  data[key].length
end

#strlen(key) ⇒ Object


350
351
352
353
# File 'lib/mock_redis/string_methods.rb', line 350

def strlen(key)
  assert_stringy(key)
  (data[key] || '').bytesize
end