Class: Mongoid::Contextual::Memory

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

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.

Attributes included from Eager

#eager_loaded, #eager_loaded Has the context been eager loaded?

Instance Method Summary collapse

Methods included from Positional

#positionally

Methods included from Queryable

#blank?

Methods included from Aggregable::Memory

#avg, #max, #min, #sum

Constructor Details

#initialize(criteria) ⇒ Memory

Create the new in memory context.

Examples:

Create the new context.

Memory.new(criteria)

Parameters:

Since:

  • 3.0.0



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/mongoid/contextual/memory.rb', line 146

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.



17
18
19
 
# File 'lib/mongoid/contextual/memory.rb', line 17

def documents
  @documents
end

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



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

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

#path ⇒ Object (readonly)

Returns the value of attribute path.



17
18
19
 
# File 'lib/mongoid/contextual/memory.rb', line 17

def path
  @path
end

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



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

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

#root ⇒ Object (readonly)

Returns the value of attribute root.



17
18
19
 
# File 'lib/mongoid/contextual/memory.rb', line 17

def root
  @root
end

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



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

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

#selector ⇒ Object (readonly)

Returns the value of attribute selector.



17
18
19
 
# File 'lib/mongoid/contextual/memory.rb', line 17

def selector
  @selector
end

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



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

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.

Since:

  • 3.0.0



29
30
31
32
 
# File 'lib/mongoid/contextual/memory.rb', line 29

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.

Since:

  • 3.0.0



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/mongoid/contextual/memory.rb', line 42

def delete
  deleted = count
  removed = map do |doc|
    prepare_remove(doc)
    doc.as_document
  end
  unless removed.empty?
    collection.find(selector).update(
      positionally(selector, "$pullAll" => { path => removed })
    )
  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.

Since:

  • 3.0.0



65
66
67
68
69
70
71
72
 
# File 'lib/mongoid/contextual/memory.rb', line 65

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.

Since:

  • 3.0.0



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

def distinct(field)
  documents.map{ |doc| doc.send(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.

Since:

  • 3.0.0



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

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

#exists? ⇒ true, false

Do any documents exist for the context.

Examples:

Do any documents exist for the context.

context.exists?

Returns:

  • (true, false) —

    If the count is more than zero.

Since:

  • 3.0.0



119
120
121
 
# File 'lib/mongoid/contextual/memory.rb', line 119

def exists?
  count > 0
end

#first ⇒ Document Also known as: one

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

Examples:

Get the first document.

context.first

Returns:

Since:

  • 3.0.0



131
132
133
134
135
 
# File 'lib/mongoid/contextual/memory.rb', line 131

def first
  doc = documents.first
  eager_load_one(doc) if eager_loadable?(doc)
  doc
end

#last ⇒ Document

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

Examples:

Get the last document.

context.last

Returns:

Since:

  • 3.0.0



165
166
167
168
169
 
# File 'lib/mongoid/contextual/memory.rb', line 165

def last
  doc = documents.last
  eager_load_one(doc) if eager_loadable?(doc)
  doc
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.

Since:

  • 3.0.0



179
180
181
 
# File 'lib/mongoid/contextual/memory.rb', line 179

def length
  documents.length
end

#limit(value) ⇒ Mongo

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:

  • (Mongo) —

    The context.

Since:

  • 3.0.0



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

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

#skip(value) ⇒ Mongo

Skips the provided number of documents.

Examples:

Skip the documents.

context.skip(20)

Parameters:

  • value (Integer) —

    The number of documents to skip.

Returns:

  • (Mongo) —

    The context.

Since:

  • 3.0.0



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

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

#sort(values) ⇒ Mongo

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:

  • (Mongo) —

    The context.

Since:

  • 3.0.0



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

def sort(values)
  in_place_sort(values) and self
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.

Since:

  • 3.0.0



239
240
241
 
# File 'lib/mongoid/contextual/memory.rb', line 239

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.

Since:

  • 3.0.0



253
254
255
 
# File 'lib/mongoid/contextual/memory.rb', line 253

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