Class: Ohm::Collection

Inherits:

Object

• Object
• Ohm::Collection

show all

Includes:

Enumerable

Defined in:

lib/ohm/collection.rb

Instance Attribute Summary (collapse)

• - (Object) db

  Returns the value of attribute db.

• - (Object) key

  Returns the value of attribute key.

Instance Method Summary (collapse)

• - (Object) ==(other)
• - (Object) [](index)
• - (Object) clear

  Clears the values in the collection.

• - (Object) concat(values)

  Appends the given values to the collection.

• - (Object) each(&block)
• - (true, false) empty?

  Returns whether or not the collection is empty.

• - (Ohm::Model^?) first(options = {})

  Sort the model instances by id and return the first instance found.

• - (Collection) initialize(key, db = Ohm.redis) constructor

  A new instance of Collection.

• - (Object) replace(values)

  Replaces the collection with the passed values.

• - (Object) sort(options = {})

  Return the values as model instances, ordered by the options supplied.

• - (Object) to_ary

7
8
9
10

# File 'lib/ohm/collection.rb', line 7

def initialize(key, db = Ohm.redis)
  self.key = key
  self.db = db
end

5
6
7

# File 'lib/ohm/collection.rb', line 5

def db
  @db
end

5
6
7

# File 'lib/ohm/collection.rb', line 5

def key
  @key
end

59
60
61

# File 'lib/ohm/collection.rb', line 59

def ==(other)
  to_ary == other
end

51
52
53

# File 'lib/ohm/collection.rb', line 51

def [](index)
  first(:start => index)
end

69
70
71
72

# File 'lib/ohm/collection.rb', line 69

def clear
  db.del(key)
  self
end

75
76
77
78

# File 'lib/ohm/collection.rb', line 75

def concat(values)
  values.each { |value| self << value }
  self
end

12
13
14

# File 'lib/ohm/collection.rb', line 12

def each(&block)
  all.each(&block)
end

64
65
66

# File 'lib/ohm/collection.rb', line 64

def empty?
  size.zero?
end

46
47
48
49

# File 'lib/ohm/collection.rb', line 46

def first(options = {})
  options = options.merge(:limit => 1)
  sort(options).first
end

81
82
83
84

# File 'lib/ohm/collection.rb', line 81

def replace(values)
  clear
  concat(values)
end

@event.attendees.sort(:by => :name, :order => "ALPHA", :limit => 10)

@blog.posts.sort(:by => :votes, :start => 5, :limit => 10")

32
33
34
35
36
37

# File 'lib/ohm/collection.rb', line 32

def sort(options = {})
  return [] if empty?
  options[:start] ||= 0
  options[:limit] = [options[:start], options[:limit]] if options[:limit]
  db.sort(key, options)
end

55
56
57

# File 'lib/ohm/collection.rb', line 55

def to_ary
  all
end