class Origin::Options

The options is a hash representation of options passed to MongoDB queries, such as skip, limit, and sorting criteria.

Public Instance Methods

[]=(key, value) click to toggle source
Alias for: store
fields() click to toggle source

Convenience method for getting the field options.

@example Get the fields options.

options.fields

@return [ Hash ] The fields options.

@since 1.0.0

# File lib/origin/options.rb, line 15
def fields
  self[:fields]
end
limit() click to toggle source

Convenience method for getting the limit option.

@example Get the limit option.

options.limit

@return [ Integer ] The limit option.

@since 1.0.0

# File lib/origin/options.rb, line 27
def limit
  self[:limit]
end
skip() click to toggle source

Convenience method for getting the skip option.

@example Get the skip option.

options.skip

@return [ Integer ] The skip option.

@since 1.0.0

# File lib/origin/options.rb, line 39
def skip
  self[:skip]
end
sort() click to toggle source

Convenience method for getting the sort options.

@example Get the sort options.

options.sort

@return [ Hash ] The sort options.

@since 1.0.0

# File lib/origin/options.rb, line 51
def sort
  self[:sort]
end
store(key, value) click to toggle source

Store the value in the options for the provided key. The options will handle all necessary serialization and localization in this step.

@example Store a value in the options.

options.store(:key, "testing")

@param [ String, Symbol ] key The name of the attribute. @param [ Object ] value The value to add.

@return [ Object ] The stored object.

@since 1.0.0

# File lib/origin/options.rb, line 67
def store(key, value)
  super(key, evolve(value))
end
Also aliased as: []=