Module: Candy::Piece

Includes:

Crunch, Crunch::Document, Embeddable

Included in:

CandyHash

Defined in:

lib/candy/piece.rb

Overview

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary (collapse)

• - (Object) ==(subject)

  Objects are equal if they point to the same MongoDB record (unless both have IDs of nil, in which case they're never equal.).

• - (Object) [](key)

  Hash-like getter.

• - (Object) []=(key, value)

  Hash-like setter.

• - (Object) candy

  Returns the hash of memoized values.

• - (Object) from_candy(hash)

  Unwraps the values passed to us from MongoDB, setting parent attributes on any embedded Candy objects.

• - (Object) id

  Shortcut to the document ID.

• - (Piece) initialize(*args, &block)

  Our initializer expects the last argument to be a hash of values.

• - (Object) keys

  Returns the keys we've stored.

• - (Object) method_missing(name, *args, &block)

  Candy's magic ingredient.

• - (Object) refresh

  Clears memoized data so that the next read pulls from the database.

• - (Object) to_candy

  Converts the object into a hash for MongoDB storage.

• - (Object) to_s

  Convenience method for debugging.

• - (Object) values

  Returns the values we've stored.

Methods included from Embeddable

#candy_adopt

Methods included from Crunch::Document

#inc, #inc!, #operate, #operate!, #retrieve, #set, #set!

Methods included from Crunch

#collection, #collection=

122
123
124
125
126
127
128
129
130

# File 'lib/candy/piece.rb', line 122

def method_missing(name, *args, &block)
  if name =~ /(.*)=$/  # We're assigning
    self[$1.to_sym] = args[0]
  elsif name =~ /(.*)\?$/  # We're asking
    (self[$1.to_sym] ? true : false)
  else
    self[name]
  end
end

114
115
116
117
118

# File 'lib/candy/piece.rb', line 114

def ==(subject)
  return false if id.nil?
  return false unless subject.respond_to?(:id)
  self.id == subject.id 
end

134
135
136

# File 'lib/candy/piece.rb', line 134

def [](key)
  candy[key] 
end

140
141
142
143
144

# File 'lib/candy/piece.rb', line 140

def []=(key, value)
  property = candy_coat(key, value) # Transform hashes and arrays, and communicate embedding
  candy[key] = property
  set key => property
end

108
109
110

# File 'lib/candy/piece.rb', line 108

def candy
  @__candy ||= retrieve || {}
end

176
177
178
179
180
181
182
183

# File 'lib/candy/piece.rb', line 176

def from_candy(hash) 
  unwrapped = {}
  hash.each do |key, value|
    field = Wrapper.unwrap_key(key)
    unwrapped[field] = Wrapper.unwrap(value, self, field)
  end
  unwrapped
end

102
103
104

# File 'lib/candy/piece.rb', line 102

def id
  @__candy_id
end

89
90
91
92
93
94
95
96
97
98
99

# File 'lib/candy/piece.rb', line 89

def initialize(*args, &block)
  if args[-1].is_a?(Hash)
    data = args.pop
    if data.delete(EMBED_KEY) or @__candy_id = data.delete('_id')  # We're an embedded or existing document
      @__candy = self.from_candy(data)
    else
      data.each {|key, value| send("#{key}=", value)}  # Assign all the data we're given
    end
  end
  super
end

153
154
155

# File 'lib/candy/piece.rb', line 153

def keys
  candy.keys
end

147
148
149
150

# File 'lib/candy/piece.rb', line 147

def refresh
  @__candy = nil
  self
end

170
171
172

# File 'lib/candy/piece.rb', line 170

def to_candy
  candy.merge(CLASS_KEY => self.class.name)
end

163
164
165

# File 'lib/candy/piece.rb', line 163

def to_s
  "#{self.class.name} (#{id})#{candy.inspect}"
end

158
159
160

# File 'lib/candy/piece.rb', line 158

def values
  candy.values
end