Module: ROM::Relation::Materializable

Included in:

ROM::Relation, Composite, Curried, Graph

Defined in:

lib/rom/relation/materializable.rb

Overview

Interface for objects that can be materialized into a loaded relation

Instance Method Summary

• #each {|Hash, Object| ... } ⇒ Object

  Yield relation tuples.

• #first ⇒ Object

  Return first tuple from a relation coerced to an array.

• #one ⇒ Object

  Delegate to loaded relation and return one object.

• #one! ⇒ Object

  Delegate to loaded relation and return one object.

• #to_a ⇒ Array (also: #to_ary)

  Coerce the relation to an array.

Instance Method Details

#each {|Hash, Object| ... } ⇒ Object

Yield relation tuples

Yields:

• (Hash, Object)

# File 'lib/rom/relation/materializable.rb', line 22

def each(&)
  return to_enum unless block_given?

  to_a.each(&)
end

#first ⇒ Object

Return first tuple from a relation coerced to an array

Returns:

• (Object)

# File 'lib/rom/relation/materializable.rb', line 51

def first = to_a.first

#one ⇒ Object

Delegate to loaded relation and return one object

Returns:

• (Object)

See Also:

• Loaded#one

# File 'lib/rom/relation/materializable.rb', line 35

def one = call.one

#one! ⇒ Object

Delegate to loaded relation and return one object

Returns:

• (Object)

See Also:

• Loaded#one

# File 'lib/rom/relation/materializable.rb', line 44

def one! = call.one!

#to_a ⇒ Array Also known as: to_ary

Coerce the relation to an array

Returns:

• (Array)

# File 'lib/rom/relation/materializable.rb', line 14

def to_a = call.to_a