mongoid-rails2 1.9.3
Sign up to get free protection for your applications and to get access to all the features.
- data/MIT_LICENSE +20 -0
- data/README.rdoc +49 -0
- data/lib/mongoid/associations/belongs_to_related.rb +58 -0
- data/lib/mongoid/associations/embedded_in.rb +72 -0
- data/lib/mongoid/associations/embeds_many.rb +254 -0
- data/lib/mongoid/associations/embeds_one.rb +96 -0
- data/lib/mongoid/associations/has_many_related.rb +181 -0
- data/lib/mongoid/associations/has_one_related.rb +85 -0
- data/lib/mongoid/associations/meta_data.rb +29 -0
- data/lib/mongoid/associations/options.rb +57 -0
- data/lib/mongoid/associations/proxy.rb +24 -0
- data/lib/mongoid/associations.rb +300 -0
- data/lib/mongoid/attributes.rb +204 -0
- data/lib/mongoid/callbacks.rb +23 -0
- data/lib/mongoid/collection.rb +120 -0
- data/lib/mongoid/collections/cyclic_iterator.rb +34 -0
- data/lib/mongoid/collections/master.rb +29 -0
- data/lib/mongoid/collections/operations.rb +41 -0
- data/lib/mongoid/collections/slaves.rb +45 -0
- data/lib/mongoid/collections.rb +41 -0
- data/lib/mongoid/components.rb +27 -0
- data/lib/mongoid/concern.rb +31 -0
- data/lib/mongoid/config.rb +191 -0
- data/lib/mongoid/contexts/enumerable.rb +151 -0
- data/lib/mongoid/contexts/ids.rb +25 -0
- data/lib/mongoid/contexts/mongo.rb +285 -0
- data/lib/mongoid/contexts/paging.rb +50 -0
- data/lib/mongoid/contexts.rb +25 -0
- data/lib/mongoid/criteria.rb +249 -0
- data/lib/mongoid/criterion/complex.rb +21 -0
- data/lib/mongoid/criterion/exclusion.rb +65 -0
- data/lib/mongoid/criterion/inclusion.rb +110 -0
- data/lib/mongoid/criterion/optional.rb +136 -0
- data/lib/mongoid/cursor.rb +81 -0
- data/lib/mongoid/deprecation.rb +22 -0
- data/lib/mongoid/dirty.rb +253 -0
- data/lib/mongoid/document.rb +311 -0
- data/lib/mongoid/errors.rb +108 -0
- data/lib/mongoid/extensions/array/accessors.rb +17 -0
- data/lib/mongoid/extensions/array/aliasing.rb +4 -0
- data/lib/mongoid/extensions/array/assimilation.rb +26 -0
- data/lib/mongoid/extensions/array/conversions.rb +29 -0
- data/lib/mongoid/extensions/array/parentization.rb +13 -0
- data/lib/mongoid/extensions/big_decimal/conversions.rb +19 -0
- data/lib/mongoid/extensions/binary/conversions.rb +17 -0
- data/lib/mongoid/extensions/boolean/conversions.rb +22 -0
- data/lib/mongoid/extensions/date/conversions.rb +24 -0
- data/lib/mongoid/extensions/datetime/conversions.rb +12 -0
- data/lib/mongoid/extensions/float/conversions.rb +20 -0
- data/lib/mongoid/extensions/hash/accessors.rb +38 -0
- data/lib/mongoid/extensions/hash/assimilation.rb +39 -0
- data/lib/mongoid/extensions/hash/conversions.rb +45 -0
- data/lib/mongoid/extensions/hash/criteria_helpers.rb +21 -0
- data/lib/mongoid/extensions/hash/scoping.rb +12 -0
- data/lib/mongoid/extensions/integer/conversions.rb +20 -0
- data/lib/mongoid/extensions/nil/assimilation.rb +17 -0
- data/lib/mongoid/extensions/object/conversions.rb +33 -0
- data/lib/mongoid/extensions/objectid/conversions.rb +15 -0
- data/lib/mongoid/extensions/proc/scoping.rb +12 -0
- data/lib/mongoid/extensions/string/conversions.rb +15 -0
- data/lib/mongoid/extensions/string/inflections.rb +97 -0
- data/lib/mongoid/extensions/symbol/inflections.rb +36 -0
- data/lib/mongoid/extensions/time_conversions.rb +35 -0
- data/lib/mongoid/extensions.rb +101 -0
- data/lib/mongoid/extras.rb +61 -0
- data/lib/mongoid/factory.rb +20 -0
- data/lib/mongoid/field.rb +59 -0
- data/lib/mongoid/fields.rb +65 -0
- data/lib/mongoid/finders.rb +144 -0
- data/lib/mongoid/identity.rb +39 -0
- data/lib/mongoid/indexes.rb +30 -0
- data/lib/mongoid/javascript/functions.yml +37 -0
- data/lib/mongoid/javascript.rb +21 -0
- data/lib/mongoid/matchers/all.rb +11 -0
- data/lib/mongoid/matchers/default.rb +26 -0
- data/lib/mongoid/matchers/exists.rb +13 -0
- data/lib/mongoid/matchers/gt.rb +11 -0
- data/lib/mongoid/matchers/gte.rb +11 -0
- data/lib/mongoid/matchers/in.rb +11 -0
- data/lib/mongoid/matchers/lt.rb +11 -0
- data/lib/mongoid/matchers/lte.rb +11 -0
- data/lib/mongoid/matchers/ne.rb +11 -0
- data/lib/mongoid/matchers/nin.rb +11 -0
- data/lib/mongoid/matchers/size.rb +11 -0
- data/lib/mongoid/matchers.rb +36 -0
- data/lib/mongoid/memoization.rb +33 -0
- data/lib/mongoid/named_scope.rb +37 -0
- data/lib/mongoid/observable.rb +30 -0
- data/lib/mongoid/paths.rb +62 -0
- data/lib/mongoid/persistence/command.rb +39 -0
- data/lib/mongoid/persistence/insert.rb +50 -0
- data/lib/mongoid/persistence/insert_embedded.rb +38 -0
- data/lib/mongoid/persistence/remove.rb +39 -0
- data/lib/mongoid/persistence/remove_all.rb +37 -0
- data/lib/mongoid/persistence/remove_embedded.rb +50 -0
- data/lib/mongoid/persistence/update.rb +63 -0
- data/lib/mongoid/persistence.rb +222 -0
- data/lib/mongoid/scope.rb +75 -0
- data/lib/mongoid/state.rb +39 -0
- data/lib/mongoid/timestamps.rb +27 -0
- data/lib/mongoid/version.rb +4 -0
- data/lib/mongoid/versioning.rb +27 -0
- data/lib/mongoid.rb +122 -0
- metadata +298 -0
@@ -0,0 +1,25 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
require "mongoid/contexts/ids"
|
3
|
+
require "mongoid/contexts/paging"
|
4
|
+
require "mongoid/contexts/enumerable"
|
5
|
+
require "mongoid/contexts/mongo"
|
6
|
+
|
7
|
+
module Mongoid
|
8
|
+
module Contexts
|
9
|
+
# Determines the context to be used for this criteria. If the class is an
|
10
|
+
# embedded document, then the context will be the array in the has_many
|
11
|
+
# association it is in. If the class is a root, then the database itself
|
12
|
+
# will be the context.
|
13
|
+
#
|
14
|
+
# Example:
|
15
|
+
#
|
16
|
+
# <tt>Contexts.context_for(criteria)</tt>
|
17
|
+
def self.context_for(criteria)
|
18
|
+
if criteria.klass.embedded?
|
19
|
+
return Contexts::Enumerable.new(criteria)
|
20
|
+
end
|
21
|
+
Contexts::Mongo.new(criteria)
|
22
|
+
end
|
23
|
+
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,249 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
require "mongoid/criterion/complex"
|
3
|
+
require "mongoid/criterion/exclusion"
|
4
|
+
require "mongoid/criterion/inclusion"
|
5
|
+
require "mongoid/criterion/optional"
|
6
|
+
|
7
|
+
module Mongoid #:nodoc:
|
8
|
+
# The +Criteria+ class is the core object needed in Mongoid to retrieve
|
9
|
+
# objects from the database. It is a DSL that essentially sets up the
|
10
|
+
# selector and options arguments that get passed on to a <tt>Mongo::Collection</tt>
|
11
|
+
# in the Ruby driver. Each method on the +Criteria+ returns self to they
|
12
|
+
# can be chained in order to create a readable criterion to be executed
|
13
|
+
# against the database.
|
14
|
+
#
|
15
|
+
# Example setup:
|
16
|
+
#
|
17
|
+
# <tt>criteria = Criteria.new</tt>
|
18
|
+
#
|
19
|
+
# <tt>criteria.only(:field).where(:field => "value").skip(20).limit(20)</tt>
|
20
|
+
#
|
21
|
+
# <tt>criteria.execute</tt>
|
22
|
+
class Criteria
|
23
|
+
include Criterion::Exclusion
|
24
|
+
include Criterion::Inclusion
|
25
|
+
include Criterion::Optional
|
26
|
+
include Enumerable
|
27
|
+
|
28
|
+
attr_reader :collection, :ids, :klass, :options, :selector
|
29
|
+
attr_accessor :documents
|
30
|
+
|
31
|
+
delegate \
|
32
|
+
:aggregate,
|
33
|
+
:avg,
|
34
|
+
:blank?,
|
35
|
+
:count,
|
36
|
+
:distinct,
|
37
|
+
:empty?,
|
38
|
+
:execute,
|
39
|
+
:first,
|
40
|
+
:group,
|
41
|
+
:id_criteria,
|
42
|
+
:last,
|
43
|
+
:max,
|
44
|
+
:min,
|
45
|
+
:one,
|
46
|
+
:page,
|
47
|
+
:paginate,
|
48
|
+
:per_page,
|
49
|
+
:sum, :to => :context
|
50
|
+
|
51
|
+
# Concatinate the criteria with another enumerable. If the other is a
|
52
|
+
# +Criteria+ then it needs to get the collection from it.
|
53
|
+
def +(other)
|
54
|
+
entries + comparable(other)
|
55
|
+
end
|
56
|
+
|
57
|
+
# Returns the difference between the criteria and another enumerable. If
|
58
|
+
# the other is a +Criteria+ then it needs to get the collection from it.
|
59
|
+
def -(other)
|
60
|
+
entries - comparable(other)
|
61
|
+
end
|
62
|
+
|
63
|
+
# Returns true if the supplied +Enumerable+ or +Criteria+ is equal to the results
|
64
|
+
# of this +Criteria+ or the criteria itself.
|
65
|
+
#
|
66
|
+
# This will force a database load when called if an enumerable is passed.
|
67
|
+
#
|
68
|
+
# Options:
|
69
|
+
#
|
70
|
+
# other: The other +Enumerable+ or +Criteria+ to compare to.
|
71
|
+
def ==(other)
|
72
|
+
case other
|
73
|
+
when Criteria
|
74
|
+
self.selector == other.selector && self.options == other.options
|
75
|
+
when Enumerable
|
76
|
+
return (execute.entries == other)
|
77
|
+
else
|
78
|
+
return false
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
# Return or create the context in which this criteria should be executed.
|
83
|
+
#
|
84
|
+
# This will return an Enumerable context if the class is embedded,
|
85
|
+
# otherwise it will return a Mongo context for root classes.
|
86
|
+
def context
|
87
|
+
@context ||= Contexts.context_for(self)
|
88
|
+
end
|
89
|
+
|
90
|
+
# Iterate over each +Document+ in the results. This can take an optional
|
91
|
+
# block to pass to each argument in the results.
|
92
|
+
#
|
93
|
+
# Example:
|
94
|
+
#
|
95
|
+
# <tt>criteria.each { |doc| p doc }</tt>
|
96
|
+
def each(&block)
|
97
|
+
context.iterate(&block)
|
98
|
+
self
|
99
|
+
end
|
100
|
+
|
101
|
+
# Return true if the criteria has some Document or not
|
102
|
+
#
|
103
|
+
# Example:
|
104
|
+
#
|
105
|
+
# <tt>criteria.exists?</tt>
|
106
|
+
def exists?
|
107
|
+
context.count > 0
|
108
|
+
end
|
109
|
+
|
110
|
+
|
111
|
+
# Merges the supplied argument hash into a single criteria
|
112
|
+
#
|
113
|
+
# Options:
|
114
|
+
#
|
115
|
+
# criteria_conditions: Hash of criteria keys, and parameter values
|
116
|
+
#
|
117
|
+
# Example:
|
118
|
+
#
|
119
|
+
# <tt>criteria.fuse(:where => { :field => "value"}, :limit => 20)</tt>
|
120
|
+
#
|
121
|
+
# Returns <tt>self</tt>
|
122
|
+
def fuse(criteria_conditions = {})
|
123
|
+
criteria_conditions.inject(self) do |criteria, (key, value)|
|
124
|
+
criteria.send(key, value)
|
125
|
+
end
|
126
|
+
end
|
127
|
+
|
128
|
+
# Create the new +Criteria+ object. This will initialize the selector
|
129
|
+
# and options hashes, as well as the type of criteria.
|
130
|
+
#
|
131
|
+
# Options:
|
132
|
+
#
|
133
|
+
# type: One of :all, :first:, or :last
|
134
|
+
# klass: The class to execute on.
|
135
|
+
def initialize(klass)
|
136
|
+
@selector, @options, @klass, @documents = {}, {}, klass, []
|
137
|
+
end
|
138
|
+
|
139
|
+
# Merges another object into this +Criteria+. The other object may be a
|
140
|
+
# +Criteria+ or a +Hash+. This is used to combine multiple scopes together,
|
141
|
+
# where a chained scope situation may be desired.
|
142
|
+
#
|
143
|
+
# Options:
|
144
|
+
#
|
145
|
+
# other: The +Criteria+ or +Hash+ to merge with.
|
146
|
+
#
|
147
|
+
# Example:
|
148
|
+
#
|
149
|
+
# <tt>criteria.merge({ :conditions => { :title => "Sir" } })</tt>
|
150
|
+
def merge(other)
|
151
|
+
@selector.update(other.selector)
|
152
|
+
@options.update(other.options)
|
153
|
+
@documents = other.documents
|
154
|
+
end
|
155
|
+
|
156
|
+
# Used for chaining +Criteria+ scopes together in the for of class methods
|
157
|
+
# on the +Document+ the criteria is for.
|
158
|
+
#
|
159
|
+
# Options:
|
160
|
+
#
|
161
|
+
# name: The name of the class method on the +Document+ to chain.
|
162
|
+
# args: The arguments passed to the method.
|
163
|
+
#
|
164
|
+
# Returns: <tt>Criteria</tt>
|
165
|
+
def method_missing(name, *args)
|
166
|
+
if @klass.respond_to?(name)
|
167
|
+
new_scope = @klass.send(name, *args)
|
168
|
+
new_scope.merge(self)
|
169
|
+
return new_scope
|
170
|
+
else
|
171
|
+
return entries.send(name, *args)
|
172
|
+
end
|
173
|
+
end
|
174
|
+
|
175
|
+
alias :to_ary :to_a
|
176
|
+
|
177
|
+
# Returns the selector and options as a +Hash+ that would be passed to a
|
178
|
+
# scope for use with named scopes.
|
179
|
+
def scoped
|
180
|
+
{ :where => @selector }.merge(@options)
|
181
|
+
end
|
182
|
+
|
183
|
+
# Translate the supplied arguments into a +Criteria+ object.
|
184
|
+
#
|
185
|
+
# If the passed in args is a single +String+, then it will
|
186
|
+
# construct an id +Criteria+ from it.
|
187
|
+
#
|
188
|
+
# If the passed in args are a type and a hash, then it will construct
|
189
|
+
# the +Criteria+ with the proper selector, options, and type.
|
190
|
+
#
|
191
|
+
# Options:
|
192
|
+
#
|
193
|
+
# args: either a +String+ or a +Symbol+, +Hash combination.
|
194
|
+
#
|
195
|
+
# Example:
|
196
|
+
#
|
197
|
+
# <tt>Criteria.translate(Person, "4ab2bc4b8ad548971900005c")</tt>
|
198
|
+
# <tt>Criteria.translate(Person, :conditions => { :field => "value"}, :limit => 20)</tt>
|
199
|
+
def self.translate(*args)
|
200
|
+
klass = args[0]
|
201
|
+
params = args[1] || {}
|
202
|
+
unless params.is_a?(Hash)
|
203
|
+
return new(klass).id_criteria(params)
|
204
|
+
end
|
205
|
+
conditions = params.delete(:conditions) || {}
|
206
|
+
if conditions.include?(:id)
|
207
|
+
conditions[:_id] = conditions[:id]
|
208
|
+
conditions.delete(:id)
|
209
|
+
end
|
210
|
+
return new(klass).where(conditions).extras(params)
|
211
|
+
end
|
212
|
+
|
213
|
+
protected
|
214
|
+
|
215
|
+
# Filters the unused options out of the options +Hash+. Currently this
|
216
|
+
# takes into account the "page" and "per_page" options that would be passed
|
217
|
+
# in if using will_paginate.
|
218
|
+
#
|
219
|
+
# Example:
|
220
|
+
#
|
221
|
+
# Given a criteria with a selector of { :page => 1, :per_page => 40 }
|
222
|
+
#
|
223
|
+
# <tt>criteria.filter_options</tt> # selector: { :skip => 0, :limit => 40 }
|
224
|
+
def filter_options
|
225
|
+
page_num = @options.delete(:page)
|
226
|
+
per_page_num = @options.delete(:per_page)
|
227
|
+
if (page_num || per_page_num)
|
228
|
+
@options[:limit] = limits = (per_page_num || 20).to_i
|
229
|
+
@options[:skip] = (page_num || 1).to_i * limits - limits
|
230
|
+
end
|
231
|
+
end
|
232
|
+
|
233
|
+
# Return the entries of the other criteria or the object. Used for
|
234
|
+
# comparing criteria or an enumerable.
|
235
|
+
def comparable(other)
|
236
|
+
other.is_a?(Criteria) ? other.entries : other
|
237
|
+
end
|
238
|
+
|
239
|
+
# Update the selector setting the operator on the value for each key in the
|
240
|
+
# supplied attributes +Hash+.
|
241
|
+
#
|
242
|
+
# Example:
|
243
|
+
#
|
244
|
+
# <tt>criteria.update_selector({ :field => "value" }, "$in")</tt>
|
245
|
+
def update_selector(attributes, operator)
|
246
|
+
attributes.each { |key, value| @selector[key] = { operator => value } }; self
|
247
|
+
end
|
248
|
+
end
|
249
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
module Mongoid #:nodoc:
|
3
|
+
module Criterion #:nodoc:
|
4
|
+
# Complex criterion are used when performing operations on symbols to get
|
5
|
+
# get a shorthand syntax for where clauses.
|
6
|
+
#
|
7
|
+
# Example:
|
8
|
+
#
|
9
|
+
# <tt>{ :field => { "$lt" => "value" } }</tt>
|
10
|
+
# becomes:
|
11
|
+
# <tt> { :field.lt => "value }</tt>
|
12
|
+
class Complex
|
13
|
+
attr_accessor :key, :operator
|
14
|
+
|
15
|
+
# Create the new complex criterion.
|
16
|
+
def initialize(opts = {})
|
17
|
+
@key, @operator = opts[:key], opts[:operator]
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
@@ -0,0 +1,65 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
module Mongoid #:nodoc:
|
3
|
+
module Criterion #:nodoc:
|
4
|
+
module Exclusion
|
5
|
+
# Adds a criterion to the +Criteria+ that specifies values that are not allowed
|
6
|
+
# to match any document in the database. The MongoDB conditional operator that
|
7
|
+
# will be used is "$ne".
|
8
|
+
#
|
9
|
+
# Options:
|
10
|
+
#
|
11
|
+
# attributes: A +Hash+ where the key is the field name and the value is a
|
12
|
+
# value that must not be equal to the corresponding field value in the database.
|
13
|
+
#
|
14
|
+
# Example:
|
15
|
+
#
|
16
|
+
# <tt>criteria.excludes(:field => "value1")</tt>
|
17
|
+
#
|
18
|
+
# <tt>criteria.excludes(:field1 => "value1", :field2 => "value1")</tt>
|
19
|
+
#
|
20
|
+
# Returns: <tt>self</tt>
|
21
|
+
def excludes(attributes = {})
|
22
|
+
mongo_id = attributes.delete(:id)
|
23
|
+
attributes = attributes.merge(:_id => mongo_id) if mongo_id
|
24
|
+
update_selector(attributes, "$ne")
|
25
|
+
end
|
26
|
+
|
27
|
+
# Adds a criterion to the +Criteria+ that specifies values where none
|
28
|
+
# should match in order to return results. This is similar to an SQL "NOT IN"
|
29
|
+
# clause. The MongoDB conditional operator that will be used is "$nin".
|
30
|
+
#
|
31
|
+
# Options:
|
32
|
+
#
|
33
|
+
# exclusions: A +Hash+ where the key is the field name and the value is an
|
34
|
+
# +Array+ of values that none can match.
|
35
|
+
#
|
36
|
+
# Example:
|
37
|
+
#
|
38
|
+
# <tt>criteria.not_in(:field => ["value1", "value2"])</tt>
|
39
|
+
#
|
40
|
+
# <tt>criteria.not_in(:field1 => ["value1", "value2"], :field2 => ["value1"])</tt>
|
41
|
+
#
|
42
|
+
# Returns: <tt>self</tt>
|
43
|
+
def not_in(exclusions)
|
44
|
+
exclusions.each { |key, value| @selector[key] = { "$nin" => value } }; self
|
45
|
+
end
|
46
|
+
|
47
|
+
# Adds a criterion to the +Criteria+ that specifies the fields that will
|
48
|
+
# get returned from the Document. Used mainly for list views that do not
|
49
|
+
# require all fields to be present. This is similar to SQL "SELECT" values.
|
50
|
+
#
|
51
|
+
# Options:
|
52
|
+
#
|
53
|
+
# args: A list of field names to retrict the returned fields to.
|
54
|
+
#
|
55
|
+
# Example:
|
56
|
+
#
|
57
|
+
# <tt>criteria.only(:field1, :field2, :field3)</tt>
|
58
|
+
#
|
59
|
+
# Returns: <tt>self</tt>
|
60
|
+
def only(*args)
|
61
|
+
@options[:fields] = args.flatten if args.any?; self
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
@@ -0,0 +1,110 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
module Mongoid #:nodoc:
|
3
|
+
module Criterion #:nodoc:
|
4
|
+
module Inclusion
|
5
|
+
# Adds a criterion to the +Criteria+ that specifies values that must all
|
6
|
+
# be matched in order to return results. Similar to an "in" clause but the
|
7
|
+
# underlying conditional logic is an "AND" and not an "OR". The MongoDB
|
8
|
+
# conditional operator that will be used is "$all".
|
9
|
+
#
|
10
|
+
# Options:
|
11
|
+
#
|
12
|
+
# attributes: A +Hash+ where the key is the field name and the value is an
|
13
|
+
# +Array+ of values that must all match.
|
14
|
+
#
|
15
|
+
# Example:
|
16
|
+
#
|
17
|
+
# <tt>criteria.all(:field => ["value1", "value2"])</tt>
|
18
|
+
#
|
19
|
+
# <tt>criteria.all(:field1 => ["value1", "value2"], :field2 => ["value1"])</tt>
|
20
|
+
#
|
21
|
+
# Returns: <tt>self</tt>
|
22
|
+
def all(attributes = {})
|
23
|
+
update_selector(attributes, "$all")
|
24
|
+
end
|
25
|
+
alias :all_in :all
|
26
|
+
|
27
|
+
# Adds a criterion to the +Criteria+ that specifies values that must
|
28
|
+
# be matched in order to return results. This is similar to a SQL "WHERE"
|
29
|
+
# clause. This is the actual selector that will be provided to MongoDB,
|
30
|
+
# similar to the Javascript object that is used when performing a find()
|
31
|
+
# in the MongoDB console.
|
32
|
+
#
|
33
|
+
# Options:
|
34
|
+
#
|
35
|
+
# selectior: A +Hash+ that must match the attributes of the +Document+.
|
36
|
+
#
|
37
|
+
# Example:
|
38
|
+
#
|
39
|
+
# <tt>criteria.and(:field1 => "value1", :field2 => 15)</tt>
|
40
|
+
#
|
41
|
+
# Returns: <tt>self</tt>
|
42
|
+
def and(selector = nil)
|
43
|
+
where(selector)
|
44
|
+
end
|
45
|
+
|
46
|
+
# Adds a criterion to the +Criteria+ that specifies values where any can
|
47
|
+
# be matched in order to return results. This is similar to an SQL "IN"
|
48
|
+
# clause. The MongoDB conditional operator that will be used is "$in".
|
49
|
+
#
|
50
|
+
# Options:
|
51
|
+
#
|
52
|
+
# attributes: A +Hash+ where the key is the field name and the value is an
|
53
|
+
# +Array+ of values that any can match.
|
54
|
+
#
|
55
|
+
# Example:
|
56
|
+
#
|
57
|
+
# <tt>criteria.in(:field => ["value1", "value2"])</tt>
|
58
|
+
#
|
59
|
+
# <tt>criteria.in(:field1 => ["value1", "value2"], :field2 => ["value1"])</tt>
|
60
|
+
#
|
61
|
+
# Returns: <tt>self</tt>
|
62
|
+
def in(attributes = {})
|
63
|
+
update_selector(attributes, "$in")
|
64
|
+
end
|
65
|
+
alias :any_in :in
|
66
|
+
|
67
|
+
# Adds a criterion to the +Criteria+ that specifies values to do
|
68
|
+
# geospacial searches by. The field must be indexed with the "2d" option.
|
69
|
+
#
|
70
|
+
# Options:
|
71
|
+
#
|
72
|
+
# attributes: A +Hash+ where the keys are the field names and the values are
|
73
|
+
# +Arrays+ of [latitude, longitude] pairs.
|
74
|
+
#
|
75
|
+
# Example:
|
76
|
+
#
|
77
|
+
# <tt>criteria.near(:field1 => [30, -44])</tt>
|
78
|
+
#
|
79
|
+
# Returns: <tt>self</tt>
|
80
|
+
def near(attributes = {})
|
81
|
+
update_selector(attributes, "$near")
|
82
|
+
end
|
83
|
+
|
84
|
+
# Adds a criterion to the +Criteria+ that specifies values that must
|
85
|
+
# be matched in order to return results. This is similar to a SQL "WHERE"
|
86
|
+
# clause. This is the actual selector that will be provided to MongoDB,
|
87
|
+
# similar to the Javascript object that is used when performing a find()
|
88
|
+
# in the MongoDB console.
|
89
|
+
#
|
90
|
+
# Options:
|
91
|
+
#
|
92
|
+
# selectior: A +Hash+ that must match the attributes of the +Document+.
|
93
|
+
#
|
94
|
+
# Example:
|
95
|
+
#
|
96
|
+
# <tt>criteria.where(:field1 => "value1", :field2 => 15)</tt>
|
97
|
+
#
|
98
|
+
# Returns: <tt>self</tt>
|
99
|
+
def where(selector = nil)
|
100
|
+
case selector
|
101
|
+
when String
|
102
|
+
@selector.update("$where" => selector)
|
103
|
+
else
|
104
|
+
@selector.update(selector ? selector.expand_complex_criteria : {})
|
105
|
+
end
|
106
|
+
self
|
107
|
+
end
|
108
|
+
end
|
109
|
+
end
|
110
|
+
end
|
@@ -0,0 +1,136 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
module Mongoid #:nodoc:
|
3
|
+
module Criterion #:nodoc:
|
4
|
+
module Optional
|
5
|
+
# Tells the criteria that the cursor that gets returned needs to be
|
6
|
+
# cached. This is so multiple iterations don't hit the database multiple
|
7
|
+
# times, however this is not advisable when working with large data sets
|
8
|
+
# as the entire results will get stored in memory.
|
9
|
+
#
|
10
|
+
# Example:
|
11
|
+
#
|
12
|
+
# <tt>criteria.cache</tt>
|
13
|
+
def cache
|
14
|
+
@options.merge!(:cache => true); self
|
15
|
+
end
|
16
|
+
|
17
|
+
# Will return true if the cache option has been set.
|
18
|
+
#
|
19
|
+
# Example:
|
20
|
+
#
|
21
|
+
# <tt>criteria.cached?</tt>
|
22
|
+
def cached?
|
23
|
+
@options[:cache] == true
|
24
|
+
end
|
25
|
+
|
26
|
+
# Flags the criteria to execute against a read-only slave in the pool
|
27
|
+
# instead of master.
|
28
|
+
#
|
29
|
+
# Example:
|
30
|
+
#
|
31
|
+
# <tt>criteria.enslave</tt>
|
32
|
+
def enslave
|
33
|
+
@options.merge!(:enslave => true); self
|
34
|
+
end
|
35
|
+
|
36
|
+
# Will return true if the criteria is enslaved.
|
37
|
+
#
|
38
|
+
# Example:
|
39
|
+
#
|
40
|
+
# <tt>criteria.enslaved?</tt>
|
41
|
+
def enslaved?
|
42
|
+
@options[:enslave] == true
|
43
|
+
end
|
44
|
+
|
45
|
+
# Adds a criterion to the +Criteria+ that specifies additional options
|
46
|
+
# to be passed to the Ruby driver, in the exact format for the driver.
|
47
|
+
#
|
48
|
+
# Options:
|
49
|
+
#
|
50
|
+
# extras: A +Hash+ that gets set to the driver options.
|
51
|
+
#
|
52
|
+
# Example:
|
53
|
+
#
|
54
|
+
# <tt>criteria.extras(:limit => 20, :skip => 40)</tt>
|
55
|
+
#
|
56
|
+
# Returns: <tt>self</tt>
|
57
|
+
def extras(extras)
|
58
|
+
@options.merge!(extras); filter_options; self
|
59
|
+
end
|
60
|
+
|
61
|
+
# Adds a criterion to the +Criteria+ that specifies an id that must be matched.
|
62
|
+
#
|
63
|
+
# Options:
|
64
|
+
#
|
65
|
+
# object_id: A +String+ representation of a <tt>BSON::ObjectId</tt>
|
66
|
+
#
|
67
|
+
# Example:
|
68
|
+
#
|
69
|
+
# <tt>criteria.id("4ab2bc4b8ad548971900005c")</tt>
|
70
|
+
#
|
71
|
+
# Returns: <tt>self</tt>
|
72
|
+
def id(*args)
|
73
|
+
(args.flatten.size > 1) ? self.in(:_id => args.flatten) : (@selector[:_id] = args.first)
|
74
|
+
self
|
75
|
+
end
|
76
|
+
|
77
|
+
# Adds a criterion to the +Criteria+ that specifies the maximum number of
|
78
|
+
# results to return. This is mostly used in conjunction with <tt>skip()</tt>
|
79
|
+
# to handle paginated results.
|
80
|
+
#
|
81
|
+
# Options:
|
82
|
+
#
|
83
|
+
# value: An +Integer+ specifying the max number of results. Defaults to 20.
|
84
|
+
#
|
85
|
+
# Example:
|
86
|
+
#
|
87
|
+
# <tt>criteria.limit(100)</tt>
|
88
|
+
#
|
89
|
+
# Returns: <tt>self</tt>
|
90
|
+
def limit(value = 20)
|
91
|
+
@options[:limit] = value; self
|
92
|
+
end
|
93
|
+
|
94
|
+
# Returns the offset option. If a per_page option is in the list then it
|
95
|
+
# will replace it with a skip parameter and return the same value. Defaults
|
96
|
+
# to 20 if nothing was provided.
|
97
|
+
def offset(*args)
|
98
|
+
args.size > 0 ? skip(args.first) : @options[:skip]
|
99
|
+
end
|
100
|
+
|
101
|
+
# Adds a criterion to the +Criteria+ that specifies the sort order of
|
102
|
+
# the returned documents in the database. Similar to a SQL "ORDER BY".
|
103
|
+
#
|
104
|
+
# Options:
|
105
|
+
#
|
106
|
+
# params: An +Array+ of [field, direction] sorting pairs.
|
107
|
+
#
|
108
|
+
# Example:
|
109
|
+
#
|
110
|
+
# <tt>criteria.order_by([[:field1, :asc], [:field2, :desc]])</tt>
|
111
|
+
#
|
112
|
+
# Returns: <tt>self</tt>
|
113
|
+
def order_by(params = [])
|
114
|
+
@options[:sort] = params; self
|
115
|
+
end
|
116
|
+
|
117
|
+
# Adds a criterion to the +Criteria+ that specifies how many results to skip
|
118
|
+
# when returning Documents. This is mostly used in conjunction with
|
119
|
+
# <tt>limit()</tt> to handle paginated results, and is similar to the
|
120
|
+
# traditional "offset" parameter.
|
121
|
+
#
|
122
|
+
# Options:
|
123
|
+
#
|
124
|
+
# value: An +Integer+ specifying the number of results to skip. Defaults to 0.
|
125
|
+
#
|
126
|
+
# Example:
|
127
|
+
#
|
128
|
+
# <tt>criteria.skip(20)</tt>
|
129
|
+
#
|
130
|
+
# Returns: <tt>self</tt>
|
131
|
+
def skip(value = 0)
|
132
|
+
@options[:skip] = value; self
|
133
|
+
end
|
134
|
+
end
|
135
|
+
end
|
136
|
+
end
|
@@ -0,0 +1,81 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
module Mongoid #:nodoc
|
3
|
+
class Cursor
|
4
|
+
include Enumerable
|
5
|
+
# Operations on the Mongo::Cursor object that will not get overriden by the
|
6
|
+
# Mongoid::Cursor are defined here.
|
7
|
+
OPERATIONS = [
|
8
|
+
:close,
|
9
|
+
:closed?,
|
10
|
+
:count,
|
11
|
+
:explain,
|
12
|
+
:fields,
|
13
|
+
:full_collection_name,
|
14
|
+
:hint,
|
15
|
+
:limit,
|
16
|
+
:order,
|
17
|
+
:query_options_hash,
|
18
|
+
:query_opts,
|
19
|
+
:selector,
|
20
|
+
:skip,
|
21
|
+
:snapshot,
|
22
|
+
:sort,
|
23
|
+
:timeout
|
24
|
+
]
|
25
|
+
|
26
|
+
attr_reader :collection
|
27
|
+
|
28
|
+
# The operations above will all delegate to the proxied Mongo::Cursor.
|
29
|
+
#
|
30
|
+
# Example:
|
31
|
+
#
|
32
|
+
# <tt>cursor.close</tt>
|
33
|
+
OPERATIONS.each do |name|
|
34
|
+
define_method(name) { |*args| @cursor.send(name, *args) }
|
35
|
+
end
|
36
|
+
|
37
|
+
# Iterate over each document in the cursor and yield to it.
|
38
|
+
#
|
39
|
+
# Example:
|
40
|
+
#
|
41
|
+
# <tt>cursor.each { |doc| p doc.title }</tt>
|
42
|
+
def each
|
43
|
+
@cursor.each do |document|
|
44
|
+
yield Mongoid::Factory.build(@klass, document)
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# Create the new +Mongoid::Cursor+.
|
49
|
+
#
|
50
|
+
# Options:
|
51
|
+
#
|
52
|
+
# collection: The Mongoid::Collection instance.
|
53
|
+
# cursor: The Mongo::Cursor to be proxied.
|
54
|
+
#
|
55
|
+
# Example:
|
56
|
+
#
|
57
|
+
# <tt>Mongoid::Cursor.new(Person, cursor)</tt>
|
58
|
+
def initialize(klass, collection, cursor)
|
59
|
+
@klass, @collection, @cursor = klass, collection, cursor
|
60
|
+
end
|
61
|
+
|
62
|
+
# Return the next document in the cursor. Will instantiate a new Mongoid
|
63
|
+
# document with the attributes.
|
64
|
+
#
|
65
|
+
# Example:
|
66
|
+
#
|
67
|
+
# <tt>cursor.next_document</tt>
|
68
|
+
def next_document
|
69
|
+
Mongoid::Factory.build(@klass, @cursor.next_document)
|
70
|
+
end
|
71
|
+
|
72
|
+
# Returns an array of all the documents in the cursor.
|
73
|
+
#
|
74
|
+
# Example:
|
75
|
+
#
|
76
|
+
# <tt>cursor.to_a</tt>
|
77
|
+
def to_a
|
78
|
+
@cursor.to_a.collect { |attrs| Mongoid::Factory.build(@klass, attrs) }
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|