Class: Mongoid::Contextual::Memory

Inherits:
Object
  • Object
show all
Includes:
Enumerable, Association::EagerLoadable, Aggregable::Memory, Queryable, Positional
Defined in:
lib/mongoid/contextual/memory.rb

Overview

Context object used for performing bulk query and persistence operations on documents which have been loaded into application memory. The method interface of this class is consistent with Mongoid::Contextual::Mongo.

Instance Attribute Summary collapse

Attributes included from Queryable

#collection, #collection The collection to query against., #criteria, #criteria The criteria for the context., #klass, #klass The klass for the criteria.

Instance Method Summary collapse

Methods included from Positional

#positionally

Methods included from Queryable

#blank?

Methods included from Association::EagerLoadable

#eager_load, #eager_loadable?, #preload

Methods included from Aggregable::Memory

#aggregates, #avg, #max, #min, #sum

Constructor Details

#initialize(criteria) ⇒ Memory

Create the new in memory context.

Examples:

Create the new context.

Memory.new(criteria)

Parameters:



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/mongoid/contextual/memory.rb', line 173

def initialize(criteria)
  @criteria, @klass = criteria, criteria.klass
  @documents = criteria.documents.select do |doc|
    @root ||= doc._root
    @collection ||= root.collection
    doc._matches?(criteria.selector)
  end
  apply_sorting
  apply_options
end

Instance Attribute Details

#documents ⇒ Object (readonly)

Returns the value of attribute documents.



25
26
27
 
# File 'lib/mongoid/contextual/memory.rb', line 25

def documents
  @documents
end

#matching The in memory documents that match the selector.(The) ⇒ Object (readonly) 



25
 
# File 'lib/mongoid/contextual/memory.rb', line 25

attr_reader :documents, :path, :root, :selector

#path ⇒ Object (readonly)

Returns the value of attribute path.



25
26
27
 
# File 'lib/mongoid/contextual/memory.rb', line 25

def path
  @path
end

#path The atomic path.(Theatomicpath.) ⇒ Object (readonly) 



25
 
# File 'lib/mongoid/contextual/memory.rb', line 25

attr_reader :documents, :path, :root, :selector

#root ⇒ Object (readonly)

Returns the value of attribute root.



25
26
27
 
# File 'lib/mongoid/contextual/memory.rb', line 25

def root
  @root
end

#root The root document.(Therootdocument.) ⇒ Object (readonly) 



25
 
# File 'lib/mongoid/contextual/memory.rb', line 25

attr_reader :documents, :path, :root, :selector

#selector ⇒ Object (readonly)

Returns the value of attribute selector.



25
26
27
 
# File 'lib/mongoid/contextual/memory.rb', line 25

def selector
  @selector
end

#selector The root document selector.(Therootdocumentselector.) ⇒ Object (readonly) 



25
 
# File 'lib/mongoid/contextual/memory.rb', line 25

attr_reader :documents, :path, :root, :selector

Instance Method Details

#==(other) ⇒ true | false

Check if the context is equal to the other object.

Examples:

Check equality.

context == []

Parameters:

  • other (Array) —

    The other array.

Returns:

  • (true | false) —

    If the objects are equal.



35
36
37
38
 
# File 'lib/mongoid/contextual/memory.rb', line 35

def ==(other)
  return false unless other.respond_to?(:entries)
  entries == other.entries
end

#delete ⇒ nil Also known as: delete_all

Delete all documents in the database that match the selector.

Examples:

Delete all the documents.

context.delete

Returns:

  • (nil) —

    Nil.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/mongoid/contextual/memory.rb', line 46

def delete
  deleted = count
  removed = map do |doc|
    prepare_remove(doc)
    doc.send(:as_attributes)
  end
  unless removed.empty?
    collection.find(selector).update_one(
      positionally(selector, "$pullAll" => { path => removed }),
      session: _session
    )
  end
  deleted
end

#destroy ⇒ nil Also known as: destroy_all

Destroy all documents in the database that match the selector.

Examples:

Destroy all the documents.

context.destroy

Returns:

  • (nil) —

    Nil.



68
69
70
71
72
73
74
75
 
# File 'lib/mongoid/contextual/memory.rb', line 68

def destroy
  deleted = count
  each do |doc|
    documents.delete_one(doc)
    doc.destroy
  end
  deleted
end

#distinct(field) ⇒ Array<Object>

Get the distinct values in the db for the provided field.

Examples:

Get the distinct values.

context.distinct(:name)

Parameters:

  • field (String | Symbol) —

    The name of the field.

Returns:

  • (Array<Object>) —

    The distinct values for the field.



86
87
88
 
# File 'lib/mongoid/contextual/memory.rb', line 86

def distinct(field)
  pluck(field).uniq
end

#each ⇒ Enumerator

Iterate over the context. If provided a block, yield to a Mongoid document for each, otherwise return an enum.

Examples:

Iterate over the context.

context.each do |doc|
  puts doc.name
end

Returns:

  • (Enumerator) —

    The enumerator.



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/mongoid/contextual/memory.rb', line 99

def each
  if block_given?
    documents_for_iteration.each do |doc|
      yield(doc)
    end
    self
  else
    to_enum
  end
end

#exists?(id_or_conditions = :none) ⇒ true | false

Do any documents exist for the context.

Examples:

Do any documents exist for the context.

context.exists?

Do any documents exist for given _id.

context.exists?(BSON::ObjectId(...))

Do any documents exist for given conditions.

context.exists?(name: "...")

Parameters:

  • id_or_conditions (Hash | Object | false) (defaults to: :none) —

    an _id to search for, a hash of conditions, nil or false.

Returns:

  • (true | false) —

    If the count is more than zero. Always false if passed nil or false.



126
127
128
129
130
131
132
133
 
# File 'lib/mongoid/contextual/memory.rb', line 126

def exists?(id_or_conditions = :none)
  case id_or_conditions
  when :none then any?
  when nil, false then false
  when Hash then Memory.new(criteria.where(id_or_conditions)).exists?
  else Memory.new(criteria.where(_id: id_or_conditions)).exists?
  end
end

#fifth ⇒ Document

Get the fifth document in the database for the criteria’s selector.

Examples:

Get the fifth document.

context.fifth

Returns:



454
455
456
 
# File 'lib/mongoid/contextual/memory.rb', line 454

def fifth
  eager_load([documents.fifth]).first
end

#fifth! ⇒ Document

Get the fifth document in the database for the criteria’s selector or raise an error if none is found.

Examples:

Get the fifth document.

context.fifth!

Returns:

Raises:



468
469
470
 
# File 'lib/mongoid/contextual/memory.rb', line 468

def fifth!
  fifth || raise_document_not_found_error
end

#first(limit = nil) ⇒ Document Also known as: one, find_first

Get the first document in the database for the criteria’s selector.

Examples:

Get the first document.

context.first

Parameters:

  • limit (Integer) (defaults to: nil) —

    The number of documents to return.

Returns:



143
144
145
146
147
148
149
 
# File 'lib/mongoid/contextual/memory.rb', line 143

def first(limit = nil)
  if limit
    eager_load(documents.first(limit))
  else
    eager_load([documents.first]).first
  end
end

#first! ⇒ Document

Get the first document in the database for the criteria’s selector or raise an error if none is found.

Examples:

Get the first document.

context.first!

Returns:

Raises:



163
164
165
 
# File 'lib/mongoid/contextual/memory.rb', line 163

def first!
  first || raise_document_not_found_error
end

#fourth ⇒ Document

Get the fourth document in the database for the criteria’s selector.

Examples:

Get the fourth document.

context.fourth

Returns:



430
431
432
 
# File 'lib/mongoid/contextual/memory.rb', line 430

def fourth
  eager_load([documents.fourth]).first
end

#fourth! ⇒ Document

Get the fourth document in the database for the criteria’s selector or raise an error if none is found.

Examples:

Get the fourth document.

context.fourth!

Returns:

Raises:



444
445
446
 
# File 'lib/mongoid/contextual/memory.rb', line 444

def fourth!
  fourth || raise_document_not_found_error
end

#inc(incs) ⇒ Enumerator

Increment a value on all documents.

Examples:

Perform the increment.

context.inc(likes: 10)

Parameters:

  • incs (Hash) —

    The operations.

Returns:

  • (Enumerator) —

    The enumerator.



192
193
194
195
196
 
# File 'lib/mongoid/contextual/memory.rb', line 192

def inc(incs)
  each do |document|
    document.inc(incs)
  end
end

#last(limit = nil) ⇒ Document

Get the last document in the database for the criteria’s selector.

Examples:

Get the last document.

context.last

Parameters:

  • limit (Integer) (defaults to: nil) —

    The number of documents to return.

Returns:



206
207
208
209
210
211
212
 
# File 'lib/mongoid/contextual/memory.rb', line 206

def last(limit = nil)
  if limit
    eager_load(documents.last(limit))
  else
    eager_load([documents.last]).first
  end
end

#last! ⇒ Document

Get the last document in the database for the criteria’s selector or raise an error if none is found.

Examples:

Get the last document.

context.last!

Returns:

Raises:



224
225
226
 
# File 'lib/mongoid/contextual/memory.rb', line 224

def last!
  last || raise_document_not_found_error
end

#length ⇒ Integer Also known as: size

Get the length of matching documents in the context.

Examples:

Get the length of matching documents.

context.length

Returns:

  • (Integer) —

    The matching length.



234
235
236
 
# File 'lib/mongoid/contextual/memory.rb', line 234

def length
  documents.length
end

#limit(value) ⇒ Memory

Limits the number of documents that are returned.

Examples:

Limit the documents.

context.limit(20)

Parameters:

  • value (Integer) —

    The number of documents to return.

Returns:



247
248
249
250
 
# File 'lib/mongoid/contextual/memory.rb', line 247

def limit(value)
  self.limiting = value
  self
end

#pick(*fields) ⇒ Object | Array<Object>

Pick the field values in memory.

Examples:

Get the values in memory.

context.pick(:name)

Parameters:

  • *fields ([ String | Symbol ]...) —

    Field(s) to pick.

Returns:

  • (Object | Array<Object>) —

    The picked values.



274
275
276
277
278
 
# File 'lib/mongoid/contextual/memory.rb', line 274

def pick(*fields)
  if doc = documents.first
    pluck_from_doc(doc, *fields)
  end
end

#pluck(*fields) ⇒ Array<Object> | Array<Array<Object>>

Pluck the field values in memory.

Examples:

Get the values in memory.

context.pluck(:name)

Parameters:

  • *fields ([ String | Symbol ]...) —

    Field(s) to pluck.

Returns:

  • (Array<Object> | Array<Array<Object>>) —

    The plucked values.



260
261
262
263
264
 
# File 'lib/mongoid/contextual/memory.rb', line 260

def pluck(*fields)
  documents.map do |doc|
    pluck_from_doc(doc, *fields)
  end
end

#second ⇒ Document

Get the second document in the database for the criteria’s selector.

Examples:

Get the second document.

context.second

Returns:



382
383
384
 
# File 'lib/mongoid/contextual/memory.rb', line 382

def second
  eager_load([documents.second]).first
end

#second! ⇒ Document

Get the second document in the database for the criteria’s selector or raise an error if none is found.

Examples:

Get the second document.

context.second!

Returns:

Raises:



396
397
398
 
# File 'lib/mongoid/contextual/memory.rb', line 396

def second!
  second || raise_document_not_found_error
end

#second_to_last ⇒ Document

Get the second to last document in the database for the criteria’s selector.

Examples:

Get the second to last document.

context.second_to_last

Returns:

  • (Document) —

    The second to last document.



478
479
480
 
# File 'lib/mongoid/contextual/memory.rb', line 478

def second_to_last
  eager_load([documents.second_to_last]).first
end

#second_to_last! ⇒ Document

Get the second to last document in the database for the criteria’s selector or raise an error if none is found.

Examples:

Get the second to last document.

context.second_to_last!

Returns:

  • (Document) —

    The second to last document.

Raises:



492
493
494
 
# File 'lib/mongoid/contextual/memory.rb', line 492

def second_to_last!
  second_to_last || raise_document_not_found_error
end

#skip(value) ⇒ Memory

Skips the provided number of documents.

Examples:

Skip the documents.

context.skip(20)

Parameters:

  • value (Integer) —

    The number of documents to skip.

Returns:



334
335
336
337
 
# File 'lib/mongoid/contextual/memory.rb', line 334

def skip(value)
  self.skipping = value
  self
end

#sort(values) ⇒ Memory

Sorts the documents by the provided spec.

Examples:

Sort the documents.

context.sort(name: -1, title: 1)

Parameters:

  • values (Hash) —

    The sorting values as field/direction(1/-1) pairs.

Returns:



348
349
350
 
# File 'lib/mongoid/contextual/memory.rb', line 348

def sort(values)
  in_place_sort(values) and self
end

#take(limit = nil) ⇒ Document

Take the given number of documents from the database.

Examples:

Take a document.

context.take

Parameters:

  • limit (Integer | nil) (defaults to: nil) —

    The number of documents to take or nil.

Returns:



304
305
306
307
308
309
310
 
# File 'lib/mongoid/contextual/memory.rb', line 304

def take(limit = nil)
  if limit
    eager_load(documents.take(limit))
  else
    eager_load([documents.first]).first
  end
end

#take! ⇒ Document

Take the given number of documents from the database or raise an error if none are found.

Examples:

Take a document.

context.take

Returns:

Raises:



322
323
324
 
# File 'lib/mongoid/contextual/memory.rb', line 322

def take!
  take || raise_document_not_found_error
end

#tally(field) ⇒ Hash

Tally the field values in memory.

Examples:

Get the counts of values in memory.

context.tally(:name)

Parameters:

  • field (String | Symbol) —

    Field to tally.

Returns:

  • (Hash) —

    The hash of counts.



288
289
290
291
292
293
294
 
# File 'lib/mongoid/contextual/memory.rb', line 288

def tally(field)
  return documents.each_with_object({}) do |d, acc|
    v = retrieve_value_at_path(d, field)
    acc[v] ||= 0
    acc[v] += 1
  end
end

#third ⇒ Document

Get the third document in the database for the criteria’s selector.

Examples:

Get the third document.

context.third

Returns:



406
407
408
 
# File 'lib/mongoid/contextual/memory.rb', line 406

def third
  eager_load([documents.third]).first
end

#third! ⇒ Document

Get the third document in the database for the criteria’s selector or raise an error if none is found.

Examples:

Get the third document.

context.third!

Returns:

Raises:



420
421
422
 
# File 'lib/mongoid/contextual/memory.rb', line 420

def third!
  third || raise_document_not_found_error
end

#third_to_last ⇒ Document

Get the third to last document in the database for the criteria’s selector.

Examples:

Get the third to last document.

context.third_to_last

Returns:

  • (Document) —

    The third to last document.



502
503
504
 
# File 'lib/mongoid/contextual/memory.rb', line 502

def third_to_last
  eager_load([documents.third_to_last]).first
end

#third_to_last! ⇒ Document

Get the third to last document in the database for the criteria’s selector or raise an error if none is found.

Examples:

Get the third to last document.

context.third_to_last!

Returns:

  • (Document) —

    The third to last document.

Raises:



516
517
518
 
# File 'lib/mongoid/contextual/memory.rb', line 516

def third_to_last!
  third_to_last || raise_document_not_found_error
end

#update(attributes = nil) ⇒ nil | false

Update the first matching document atomically.

Examples:

Update the matching document.

context.update(name: "Smiths")

Parameters:

  • attributes (Hash) (defaults to: nil) —

    The new attributes for the document.

Returns:

  • (nil | false) —

    False if no attributes were provided.



360
361
362
 
# File 'lib/mongoid/contextual/memory.rb', line 360

def update(attributes = nil)
  update_documents(attributes, [ first ])
end

#update_all(attributes = nil) ⇒ nil | false

Update all the matching documents atomically.

Examples:

Update all the matching documents.

context.update_all(name: "Smiths")

Parameters:

  • attributes (Hash) (defaults to: nil) —

    The new attributes for each document.

Returns:

  • (nil | false) —

    False if no attributes were provided.



372
373
374
 
# File 'lib/mongoid/contextual/memory.rb', line 372

def update_all(attributes = nil)
  update_documents(attributes, entries)
end