Class: Sequel::SQL::Expression

Inherits:
Object
  • Object
show all
Defined in:
lib/sequel/sql.rb,
lib/sequel/extensions/eval_inspect.rb

Overview

Base class for all SQL expression objects.

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.comparison_attrs ⇒ Object (readonly)

All attributes used for equality and hash methods.



69
70
71
 
# File 'lib/sequel/sql.rb', line 69

def comparison_attrs
  @comparison_attrs
end

Class Method Details

.attr_reader(*args) ⇒ Object

Expression objects are assumed to be value objects, where their attribute values can’t change after assignment. In order to make it easy to define equality and hash methods, subclass instances assume that the only values that affect the results of such methods are the values of the object’s attributes.



76
77
78
79
 
# File 'lib/sequel/sql.rb', line 76

def attr_reader(*args)
  super
  comparison_attrs.concat(args)
end

.inherited(subclass) ⇒ Object

Copy the comparison_attrs into the subclass.



82
83
84
85
 
# File 'lib/sequel/sql.rb', line 82

def inherited(subclass)
  super
  subclass.instance_variable_set(:@comparison_attrs, comparison_attrs.dup)
end

Instance Method Details

#==(other) ⇒ Object

Alias of eql?



102
103
104
 
# File 'lib/sequel/sql.rb', line 102

def ==(other)
  eql?(other)
end

#eql?(other) ⇒ Boolean

Returns true if the receiver is the same expression as the the other expression.

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/sequel/sql.rb', line 108

def eql?(other)
  other.is_a?(self.class) && !self.class.comparison_attrs.find{|a| send(a) != other.send(a)}
end

#hash ⇒ Object

Make sure that the hash value is the same if the attributes are the same.



113
114
115
 
# File 'lib/sequel/sql.rb', line 113

def hash
  ([self.class] + self.class.comparison_attrs.map{|x| send(x)}).hash
end

#inspect ⇒ Object

Attempt to produce a string suitable for eval, such that:

eval(obj.inspect) == obj



119
120
121
 
# File 'lib/sequel/sql.rb', line 119

def inspect
  "#<#{self.class} #{instance_variables.map{|iv| "#{iv}=>#{instance_variable_get(iv).inspect}"}.join(', ')}>"
end

#lit ⇒ Object

Returns self, because SQL::Expression already acts like LiteralString.



124
125
126
 
# File 'lib/sequel/sql.rb', line 124

def lit
  self
end

#sql_literal(ds) ⇒ Object

Alias of to_s



129
130
131
 
# File 'lib/sequel/sql.rb', line 129

def sql_literal(ds)
  to_s(ds)
end