Class: Ohm::Attributes::Collection

Inherits:

Object

Includes:

Enumerable

Defined in:

lib/ohm.rb

Attribute Summary

• - (Object) db Returns the value of attribute db.
• - (Object) key Returns the value of attribute key.
• - (Object) model Returns the value of attribute model.

Method Summary

• - (Object) ==(other)
• - (Object) add(model)
• - (Object) all Return instances of model for all the ids contained in the collection.
• - (Object) clear Clears the values in the collection.
• - (Object) concat(values) Appends the given values to the collection.
• - (Object) each(&block)
• - (true) 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(db, key, model = nil) 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) sort_by(att, options = {}) Sort the model instances by the given attribute.
• - (Object) to_ary

66
67
68
69
70

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

def initialize(db, key, model = nil)
  self.db = db
  self.key = key
  self.model = model
end

64
65
66

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

def db
  @db
end

64
65
66

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

def key
  @key
end

64
65
66

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

def model
  @model
end

138
139
140

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

def ==(other)
  to_ary == other
end

166
167
168

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

def add(model)
  self << model.id
end

77
78
79

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

def all
  instantiate(raw)
end

148
149
150
151

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

def clear
  db.del(key)
  self
end

154
155
156
157

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

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

72
73
74

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

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

143
144
145

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

def empty?
  size.zero?
end

127
128
129
130
131
132

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

def first(options = {})
  options = options.merge(:limit => 1)
  options[:by] ?
    sort_by(options.delete(:by), options).first :
    sort(options).first
end

160
161
162
163

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

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")

97
98
99
100
101
102
103

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

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

  User.create :name => "B"
  User.create :name => "A"

  user = User.all.sort_by(:name, :order => "ALPHA").first
  user.name == "A"
  # => true

115
116
117

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

def sort_by(att, options = {})
  sort(options.merge(:by => model.key("*", att)))
end

134
135
136

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

def to_ary
  all
end