Class: Arel::Nodes::Node

Inherits:
Object
  • Object
show all
Includes:
FactoryMethods, Enumerable
Defined in:
lib/arel/nodes/node.rb

Overview

Abstract base class for all AST nodes

Instance Method Summary collapse

Methods included from FactoryMethods

#create_and, #create_false, #create_join, #create_on, #create_string_join, #create_table_alias, #create_true, #grouping, #lower

Constructor Details

#initialize ⇒ Node

Returns a new instance of Node.



16
17
18
 
# File 'lib/arel/nodes/node.rb', line 16

def initialize
  @caller = caller.dup
end

Instance Method Details

#_caller ⇒ Object 



12
13
14
 
# File 'lib/arel/nodes/node.rb', line 12

def _caller
  @caller
end

#and(right) ⇒ Object

Factory method to create an Nodes::And node.



37
38
39
 
# File 'lib/arel/nodes/node.rb', line 37

def and right
  Nodes::And.new [self, right]
end

#each(&block) ⇒ Object

Iterate through AST, nodes will be yielded depth-first



53
54
55
56
57
 
# File 'lib/arel/nodes/node.rb', line 53

def each &block
  return enum_for(:each) unless block_given?

  ::Arel::Visitors::DepthFirst.new(block).accept self
end

#not ⇒ Object

Factory method to create a Nodes::Not node that has the recipient of the caller as a child.



24
25
26
 
# File 'lib/arel/nodes/node.rb', line 24

def not
  Nodes::Not.new self
end

#or(right) ⇒ Object

Factory method to create a Nodes::Grouping node that has an Nodes::Or node as a child.



31
32
33
 
# File 'lib/arel/nodes/node.rb', line 31

def or right
  Nodes::Grouping.new Nodes::Or.new(self, right)
end

#to_sql(engine = Table.engine) ⇒ Object

FIXME: this method should go away. I don’t like people calling to_sql on non-head nodes. This forces us to walk the AST until we can find a node that has a “relation” member.

Maybe we should just use ‘Table.engine`? :’(



46
47
48
49
50
 
# File 'lib/arel/nodes/node.rb', line 46

def to_sql engine = Table.engine
  collector = Arel::Collectors::SQLString.new
  collector = engine.connection.visitor.accept self, collector
  collector.value
end