Modelize MongoDB Documents

gem install modelize

# Enable / disable Modelize on the fly
Modelize.enable = true

# Tell Modelize in which module to find your model class
Modelize.module = ''

# If your model class is in the Fu::Models module
Modelize.module = 'Fu::Models'

# Debug option
Modelize.debug = false

# If you don't have bundler set up
require 'modelize'

# Create your model, no includes necessary
class Model
  # Your model definitions here ...
end

# Without Modelize, just pure Ruby driver
models = find(:models).to_a     # => [BSON::Document, BSON::Document]
model = first(:models)          # => BSON::Document

# With Modelize and Minimongo
models = find(:models).to_a     # => [Model, Model]
model = first(:models)          # => Model

# With Modelize and the Mongodb Ruby driver
models = $db[:models].find.to_a # => [Model, Model]
model = $db[:models].find.first # => Model

model = first(:models)

# The original BSON::Document
model.doc # => BSON::Document instance

# The model class accepts any method that BSON::Document accepts
model.to_h # => {'_id' => BSON::ObjectId('586c4ac80aec08424e3a5287')}

# You can read and write variables
model.description = 'we need truth'
model.light = 'yes'
model.description # => 'we need truth'
model.light # => 'yes'

# And then save the changes (Minimongo)
model.earth = 'undiscovered'
update(:models, {:_id => m._id}, m.to_h)

# Refetch it and it's saved
model = first(:models, :_id => m._id)
m.earth # => 'undiscovered'

# Returns nil if not found, doesn't raise an error
model.darkness # => nil