Class: Ohm::Model::List

Inherits:

Collection

• Object
• Collection
• Ohm::Model::List

show all

Defined in:

lib/ohm.rb

Overview

Instance Attribute Summary

Attributes inherited from Collection

key, model

Instance Method Summary (collapse)

• - (Object) <<(model) (also: #push)

  Thin wrapper around RPUSH.

• - (Object) [](index, limit = nil)

  Returns the element at index, or returns a subarray starting at `start` and continuing for `length` elements, or returns a subarray specified by `range`.

• - (Array<Ohm::Model>) all

  Returns an array representation of this list, with elements of the array being an instance of Collection#model.

• - (Object) each(&block)

  An implementation which relies on LRANGE and yields an instance of Collection#model.

• - (Ohm::Model^?) first

  Convience method for doing list[0], similar to Ruby’s Array#first method.

• - (true, false) include?(model)

  Ruby-like interface wrapper around LRANGE.

• - (Object) inspect
• - (Ohm::Model^?) pop

  Returns the model at the tail of this list, while simultaneously removing it from the list.

• - (Ohm::Model^?) shift

  Returns the model at the head of this list, while simultaneously removing it from the list.

• - (Fixnum) size

  Thin Ruby interface wrapper for LLEN.

• - (Object) unshift(model)

  Prepends an Ohm::Model instance at the beginning of this list.

Methods inherited from Collection

#add, #clear, #empty?, #initialize, #replace, #sort, #sort_by, #to_a

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

class Comment < Ohm::Model
end

p = Post.create
p.comments << Comment.create

808
809
810

# File 'lib/ohm.rb', line 808

def <<(model)
  key.rpush(model.id)
end

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

class Comment < Ohm::Model
end

post = Post.create

10.times { post.comments << Comment.create }

post.comments[0] == Comment[1]
# => true

post.comments[0, 4] == (1..5).map { |i| Comment[i] }
# => true

post.comments[0, 4] == post.comments[0..4]
# => true

post.comments.all == post.comments[0, -1]
# => true

845
846
847
848
849
850
851
852
853
854

# File 'lib/ohm.rb', line 845

def [](index, limit = nil)
  case [index, limit]
  when Pattern[Fixnum, Fixnum] then
    key.lrange(index, limit).collect { |id| model.to_proc[id] }
  when Pattern[Range, nil] then
    key.lrange(index.first, index.last).collect { |id| model.to_proc[id] }
  when Pattern[Fixnum, nil] then
    model[key.lindex(index)]
  end
end

903
904
905

# File 'lib/ohm.rb', line 903

def all
  key.lrange(0, -1).map(&model)
end

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

class Comment < Ohm::Model
end

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

post.comments.each do |comment|
  # do something with the comment
end

# reading the source reveals that this is achieved by doing:
post.comments.key.lrange(0, -1).each do |id|
  comment = Comment[id]
  # do something with the comment
end

786
787
788

# File 'lib/ohm.rb', line 786

def each(&block)
  key.lrange(0, -1).each { |id| block.call(model.to_proc[id]) }
end

861
862
863

# File 'lib/ohm.rb', line 861

def first
  self[0]
end

926
927
928

# File 'lib/ohm.rb', line 926

def include?(model)
  key.lrange(0, -1).include?(model.id)
end

930
931
932

# File 'lib/ohm.rb', line 930

def inspect
  "#<List (#{model}): #{key.lrange(0, -1).inspect}>"
end

873
874
875

# File 'lib/ohm.rb', line 873

def pop
  model[key.rpop]
end

885
886
887

# File 'lib/ohm.rb', line 885

def shift
  model[key.lpop]
end

913
914
915

# File 'lib/ohm.rb', line 913

def size
  key.llen
end

895
896
897

# File 'lib/ohm.rb', line 895

def unshift(model)
  key.lpush(model.id)
end