Module: ActiveRecord::SpawnMethods

Included in:
Relation
Defined in:
lib/active_record/relation/spawn_methods.rb

Instance Method Summary collapse

Instance Method Details

#except(*skips) ⇒ Object

Removes from the query the condition(s) specified in skips.

Post.order('id asc').except(:order)                  # discards the order condition
Post.where('id > 10').order('id asc').except(:where) # discards the where condition but keeps the order



57
58
59
 
# File 'lib/active_record/relation/spawn_methods.rb', line 57

def except(*skips)
  relation_with values.except(*skips)
end

#merge(other) ⇒ Object

Merges in the conditions from other, if other is an ActiveRecord::Relation. Returns an array representing the intersection of the resulting records with other, if other is an array.

Post.where(published: true).joins(:comments).merge( Comment.where(spam: false) )
# Performs a single join query with both where conditions.

recent_posts = Post.order('created_at DESC').first(5)
Post.where(published: true).merge(recent_posts)
# Returns the intersection of all published posts with the 5 most recently created posts.
# (This is just an example. You'd probably want to do this with a single query!)

Procs will be evaluated by merge:

Post.where(published: true).merge(-> { joins(:comments) })
# => Post.where(published: true).joins(:comments)

This is mainly intended for sharing common conditions between multiple associations.



31
32
33
34
35
36
37
38
39
 
# File 'lib/active_record/relation/spawn_methods.rb', line 31

def merge(other)
  if other.is_a?(Array)
    records & other
  elsif other
    spawn.merge!(other)
  else
    raise ArgumentError, "invalid argument: #{other.inspect}."
  end
end

#merge!(other) ⇒ Object

:nodoc:



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/active_record/relation/spawn_methods.rb', line 41

def merge!(other) # :nodoc:
  if other.is_a?(Hash)
    Relation::HashMerger.new(self, other).merge
  elsif other.is_a?(Relation)
    Relation::Merger.new(self, other).merge
  elsif other.respond_to?(:to_proc)
    instance_exec(&other)
  else
    raise ArgumentError, "#{other.inspect} is not an ActiveRecord::Relation"
  end
end

#only(*onlies) ⇒ Object

Removes any condition from the query other than the one(s) specified in onlies.

Post.order('id asc').only(:where)         # discards the order condition
Post.order('id asc').only(:where, :order) # uses the specified order



65
66
67
 
# File 'lib/active_record/relation/spawn_methods.rb', line 65

def only(*onlies)
  relation_with values.slice(*onlies)
end

#spawn ⇒ Object

This is overridden by Associations::CollectionProxy



10
11
12
 
# File 'lib/active_record/relation/spawn_methods.rb', line 10

def spawn #:nodoc:
  already_in_scope? ? klass.all : clone
end