module Origin::Selectable

An origin selectable is selectable, in that it has the ability to select document from the database. The selectable module brings all functionality to the selectable that has to do with building MongoDB selectors.

Attributes

negating[RW]

@attribute [rw] negating If the next spression is negated. @attribute [rw] selector The query selector.

selector[RW]

@attribute [rw] negating If the next spression is negated. @attribute [rw] selector The query selector.

Public Instance Methods

all(criterion = nil) click to toggle source

Add the $all criterion.

@example Add the criterion.

selectable.all(field: [ 1, 2 ])

@example Execute an $all in a where query.

selectable.where(:field.all => [ 1, 2 ])

@param [ Hash ] criterion The key value pairs for $all matching.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 27
def all(criterion = nil)
  send(strategy || :__union__, with_array_values(criterion), "$all")
end
Also aliased as: all_in
all_in(criterion = nil) click to toggle source
Alias for: all
all_of(*criterion) click to toggle source
Alias for: and
and(*criterion) click to toggle source

Add the $and criterion.

@example Add the criterion.

selectable.and({ field: value }, { other: value })

@param [ Array<Hash> ] criterion Multiple key/value pair matches that

all must match to return results.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 44
def and(*criterion)
  __multi__(criterion, "$and")
end
Also aliased as: all_of
any_in(criterion = nil) click to toggle source
Alias for: in
any_of(*criterion) click to toggle source
Alias for: or
between(criterion = nil) click to toggle source

Add the range selection.

@example Match on results within a single range.

selectable.between(field: 1..2)

@example Match on results between multiple ranges.

selectable.between(field: 1..2, other: 5..7)

@param [ Hash ] criterion Multiple key/range pairs.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 62
def between(criterion = nil)
  selection(criterion) do |selector, field, value|
    selector.store(
      field,
      { "$gte" => value.min, "$lte" => value.max }
    )
  end
end
elem_match(criterion = nil) click to toggle source

Select with an $elemMatch.

@example Add criterion for a single match.

selectable.elem_match(field: { name: "value" })

@example Add criterion for multiple matches.

selectable.elem_match(
  field: { name: "value" },
  other: { name: "value"}
)

@example Execute an $elemMatch in a where query.

selectable.where(:field.elem_match => { name: "value" })

@param [ Hash ] criterion The field/match pairs.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 90
def elem_match(criterion = nil)
  __override__(criterion, "$elemMatch")
end
excludes(criterion = nil) click to toggle source
Alias for: ne
exists(criterion = nil) click to toggle source

Add the $exists selection.

@example Add a single selection.

selectable.exists(field: true)

@example Add multiple selections.

selectable.exists(field: true, other: false)

@example Execute an $exists in a where query.

selectable.where(:field.exists => true)

@param [ Hash ] criterion The field/boolean existence checks.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 111
def exists(criterion = nil)
  typed_override(criterion, "$exists") do |value|
    ::Boolean.evolve(value)
  end
end
gt(criterion = nil) click to toggle source

Add the $gt criterion to the selector.

@example Add the $gt criterion.

selectable.gt(age: 60)

@example Execute an $gt in a where query.

selectable.where(:field.gt => 10)

@param [ Hash ] criterion The field/value pairs to check.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 133
def gt(criterion = nil)
  __override__(criterion, "$gt")
end
gte(criterion = nil) click to toggle source

Add the $gte criterion to the selector.

@example Add the $gte criterion.

selectable.gte(age: 60)

@example Execute an $gte in a where query.

selectable.where(:field.gte => 10)

@param [ Hash ] criterion The field/value pairs to check.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 151
def gte(criterion = nil)
  __override__(criterion, "$gte")
end
in(criterion = nil) click to toggle source

Adds the $in selection to the selectable.

@example Add $in selection on an array.

selectable.in(age: [ 1, 2, 3 ])

@example Add $in selection on a range.

selectable.in(age: 18..24)

@example Execute an $in in a where query.

selectable.where(:field.in => [ 1, 2, 3 ])

@param [ Hash ] criterion The field/value criterion pairs.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 172
def in(criterion = nil)
  send(strategy || :__intersect__, with_array_values(criterion), "$in")
end
Also aliased as: any_in
lt(criterion = nil) click to toggle source

Add the $lt criterion to the selector.

@example Add the $lt criterion.

selectable.lt(age: 60)

@example Execute an $lt in a where query.

selectable.where(:field.lt => 10)

@param [ Hash ] criterion The field/value pairs to check.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 191
def lt(criterion = nil)
  __override__(criterion, "$lt")
end
lte(criterion = nil) click to toggle source

Add the $lte criterion to the selector.

@example Add the $lte criterion.

selectable.lte(age: 60)

@example Execute an $lte in a where query.

selectable.where(:field.lte => 10)

@param [ Hash ] criterion The field/value pairs to check.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 209
def lte(criterion = nil)
  __override__(criterion, "$lte")
end
max_distance(criterion = nil) click to toggle source

Add a $maxDistance selection to the selectable.

@example Add the $maxDistance selection.

selectable.max_distance(location: 10)

@param [ Hash ] criterion The field/distance pairs.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 224
def max_distance(criterion = nil)
  __add__(criterion, "$maxDistance")
end
mod(criterion = nil) click to toggle source

Adds $mod selection to the selectable.

@example Add the $mod selection.

selectable.mod(field: [ 10, 1 ])

@example Execute an $mod in a where query.

selectable.where(:field.mod => [ 10, 1 ])

@param [ Hash ] criterion The field/mod selections.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 241
def mod(criterion = nil)
  __override__(criterion, "$mod")
end
ne(criterion = nil) click to toggle source

Adds $ne selection to the selectable.

@example Query for a value $ne to something.

selectable.ne(field: 10)

@example Execute an $ne in a where query.

selectable.where(:field.ne => "value")

@param [ Hash ] criterion The field/ne selections.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 259
def ne(criterion = nil)
  __override__(criterion, "$ne")
end
Also aliased as: excludes
near(criterion = nil) click to toggle source

Adds a $near criterion to a geo selection.

@example Add the $near selection.

selectable.near(location: [ 23.1, 12.1 ])

@example Execute an $near in a where query.

selectable.where(:field.near => [ 23.2, 12.1 ])

@param [ Hash ] criterion The field/location pair.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 278
def near(criterion = nil)
  __override__(criterion, "$near")
end
near_sphere(criterion = nil) click to toggle source

Adds a $nearSphere criterion to a geo selection.

@example Add the $nearSphere selection.

selectable.near_sphere(location: [ 23.1, 12.1 ])

@example Execute an $nearSphere in a where query.

selectable.where(:field.near_sphere => [ 10.11, 3.22 ])

@param [ Hash ] criterion The field/location pair.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 296
def near_sphere(criterion = nil)
  __override__(criterion, "$nearSphere")
end
negating?() click to toggle source

Is the current selectable negating the next selection?

@example Is the selectable negating?

selectable.negating?

@return [ true, false ] If the selectable is negating.

@since 1.0.0

# File lib/origin/selectable.rb, line 345
def negating?
  !!negating
end
nin(criterion = nil) click to toggle source

Adds the $nin selection to the selectable.

@example Add $nin selection on an array.

selectable.nin(age: [ 1, 2, 3 ])

@example Add $nin selection on a range.

selectable.nin(age: 18..24)

@example Execute an $nin in a where query.

selectable.where(:field.nin => [ 1, 2, 3 ])

@param [ Hash ] criterion The field/value criterion pairs.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 317
def nin(criterion = nil)
  send(strategy || :__intersect__, with_array_values(criterion), "$nin")
end
Also aliased as: not_in
nor(*criterion) click to toggle source

Adds $nor selection to the selectable.

@example Add the $nor selection.

selectable.nor(field: 1, field: 2)

@param [ Array ] criterion An array of hash criterion.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 333
def nor(*criterion)
  __multi__(criterion, "$nor")
end
not(*criterion) click to toggle source

Negate the next selection.

@example Negate the selection.

selectable.not.in(field: [ 1, 2 ])

@example Add the $not criterion.

selectable.not(name: /Bob/)

@example Execute a $not in a where query.

selectable.where(:field.not => %rBob/)

@param [ Hash ] criterion The field/value pairs to negate.

@return [ Selectable ] The negated selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 365
def not(*criterion)
  (criterion.size == 0) ? tap { |query| query.negating = true } : __override__(criterion.first, "$not")
end
not_in(criterion = nil) click to toggle source
Alias for: nin
or(*criterion) click to toggle source

Adds $or selection to the selectable.

@example Add the $or selection.

selectable.or(field: 1, field: 2)

@param [ Array ] criterion An array of hash criterion.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 380
def or(*criterion)
  __multi__(criterion, "$or")
end
Also aliased as: any_of
where(criterion = nil) click to toggle source

This is the general entry point for most MongoDB queries. This either creates a standard field: value selection, and expanded selection with the use of hash methods, or a $where selection if a string is provided.

@example Add a standard selection.

selectable.where(name: "syd")

@example Add a javascript selection.

selectable.where("this.name == 'syd'")

@param [ String, Hash ] criterion The javascript or standard selection.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 449
def where(criterion = nil)
  criterion.is_a?(String) ? js_query(criterion) : expr_query(criterion)
end
with_size(criterion = nil) click to toggle source

Add a $size selection for array fields.

@example Add the $size selection.

selectable.with_size(field: 5)

@note This method is named with_size not to conflict with any existing

#size method on enumerables or symbols.

@example Execute an $size in a where query.

selectable.where(:field.with_size => 10)

@param [ Hash ] criterion The field/size pairs criterion.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 401
def with_size(criterion = nil)
  typed_override(criterion, "$size") do |value|
    ::Integer.evolve(value)
  end
end
with_type(criterion = nil) click to toggle source

Adds a $type selection to the selectable.

@example Add the $type selection.

selectable.with_type(field: 15)

@example Execute an $type in a where query.

selectable.where(:field.with_type => 15)

@note vurl.me/PGOU contains a list of all types.

@param [ Hash ] criterion The field/type pairs.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 425
def with_type(criterion = nil)
  typed_override(criterion, "$type") do |value|
    ::Integer.evolve(value)
  end
end
within_box(criterion = nil) click to toggle source

Adds the $within/$box selection to the selectable.

@example Add the selection.

selectable.within_box(location: [[ 1, 10 ], [ 10, 1 ]])

@example Execute an $within/$box in a where query.

selectable.where(:field.within_box => [[ 1, 10 ], [ 10, 1 ]])

@param [ Hash ] criterion The field/box corner criterion.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 466
def within_box(criterion = nil)
  __expanded__(criterion, "$within", "$box")
end
within_circle(criterion = nil) click to toggle source

Adds the $within/$center selection to the selectable.

@example Add the selection.

selectable.within_circle(location: [[ 1, 10 ], 25 ])

@example Execute an $within/$center in a where query.

selectable.where(:field.within_circle => [[ 1, 10 ], 25 ])

@param [ Hash ] criterion The field/radius criterion.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 484
def within_circle(criterion = nil)
  __expanded__(criterion, "$within", "$center")
end
within_polygon(criterion = nil) click to toggle source

Adds the $within/$polygon selection to the selectable.

@example Add the selection.

selectable.within_polygon(
  location: [[ 10, 20 ], [ 10, 40 ], [ 30, 40 ], [ 30, 20 ]]
)

@example Execute an $within/$polygon in a where query.

selectable.where(
  :field.within_polygon => [[ 10, 20 ], [ 10, 40 ], [ 30, 40 ], [ 30, 20 ]]
)

@param [ Hash ] criterion The field/polygon points criterion.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 506
def within_polygon(criterion = nil)
  __expanded__(criterion, "$within", "$polygon")
end
within_spherical_circle(criterion = nil) click to toggle source

Adds the $within/$centerSphere selection to the selectable.

@example Add the selection.

selectable.within_spherical_circle(location: [[ 1, 10 ], 25 ])

@example Execute an $within/$centerSphere in a where query.

selectable.where(:field.within_spherical_circle => [[ 1, 10 ], 25 ])

@param [ Hash ] criterion The field/distance criterion.

@return [ Selectable ] The cloned selectable.

@since 1.0.0

# File lib/origin/selectable.rb, line 524
def within_spherical_circle(criterion = nil)
  __expanded__(criterion, "$within", "$centerSphere")
end