Class: Sohm::List

Inherits:
Object
  • Object
show all
Includes:
Collection
Defined in:
lib/sohm.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Collection

#each, #empty?, #fetch, #to_a, #to_json

Constructor Details

#initialize(key, namespace, model) ⇒ List

Returns a new instance of List.



189
190
191
192
193
 
# File 'lib/sohm.rb', line 189

def initialize(key, namespace, model)
  @key = key
  @namespace = namespace
  @model = model
end

Instance Attribute Details

#key ⇒ Object (readonly)

Returns the value of attribute key.



185
186
187
 
# File 'lib/sohm.rb', line 185

def key
  @key
end

#model ⇒ Object (readonly)

Returns the value of attribute model.



187
188
189
 
# File 'lib/sohm.rb', line 187

def model
  @model
end

#namespace ⇒ Object (readonly)

Returns the value of attribute namespace.



186
187
188
 
# File 'lib/sohm.rb', line 186

def namespace
  @namespace
end

Instance Method Details

#delete(model) ⇒ Object

Delete a model from the list.

Note: If your list contains the model multiple times, this method will delete all instances of that model in one go.

Example:

class Comment < Sohm::Model
end

class Post < Sohm::Model
  list :comments, :Comment
end

p = Post.create
c = Comment.create

p.comments.push(c)
p.comments.push(c)

p.comments.delete(c)

p.comments.size == 0
# => true



284
285
286
287
288
 
# File 'lib/sohm.rb', line 284

def delete(model)
  # LREM key 0 <id> means remove all elements matching <id>
  # @see http://redis.io/commands/lrem
  redis.call("LREM", key, 0, model.id)
end

#first ⇒ Object

Returns the first element of the list using LINDEX.



201
202
203
 
# File 'lib/sohm.rb', line 201

def first
  model[redis.call("LINDEX", key, 0)]
end

#ids ⇒ Object

Returns an array with all the ID’s of the list.

class Comment < Sohm::Model
end

class Post < Sohm::Model
  list :comments, :Comment
end

post = Post.create
post.comments.push(Comment.create)
post.comments.push(Comment.create)
post.comments.push(Comment.create)

post.comments.map(&:id)
# => ["1", "2", "3"]

post.comments.ids
# => ["1", "2", "3"]



310
311
312
 
# File 'lib/sohm.rb', line 310

def ids
  redis.call("LRANGE", key, 0, -1)
end

#include?(model) ⇒ Boolean

Checks if the model is part of this List.

An important thing to note is that this method loads all of the elements of the List since there is no command in Redis that allows you to actually check the list contents efficiently.

You may want to avoid doing this if your list has say, 10K entries.

Returns:

  • (Boolean) 


245
246
247
 
# File 'lib/sohm.rb', line 245

def include?(model)
  ids.include?(model.id)
end

#last ⇒ Object

Returns the last element of the list using LINDEX.



206
207
208
 
# File 'lib/sohm.rb', line 206

def last
  model[redis.call("LINDEX", key, -1)]
end

#push(model) ⇒ Object

Pushes the model to the end of the list using RPUSH.



250
251
252
 
# File 'lib/sohm.rb', line 250

def push(model)
  redis.call("RPUSH", key, model.id)
end

#range(start, stop) ⇒ Object

Returns an array of elements from the list using LRANGE. #range receives 2 integers, start and stop

Example:

class Comment < Sohm::Model
end

class Post < Sohm::Model
  list :comments, :Comment
end

c1 = Comment.create
c2 = Comment.create
c3 = Comment.create

post = Post.create

post.comments.push(c1)
post.comments.push(c2)
post.comments.push(c3)

[c1, c2] == post.comments.range(0, 1)
# => true



234
235
236
 
# File 'lib/sohm.rb', line 234

def range(start, stop)
  fetch(redis.call("LRANGE", key, start, stop))
end

#size ⇒ Object

Returns the total size of the list using LLEN.



196
197
198
 
# File 'lib/sohm.rb', line 196

def size
  redis.call("LLEN", key)
end

#unshift(model) ⇒ Object

Pushes the model to the beginning of the list using LPUSH.



255
256
257
 
# File 'lib/sohm.rb', line 255

def unshift(model)
  redis.call("LPUSH", key, model.id)
end