Class: Sequel::SQL::BooleanExpression

Inherits:
ComplexExpression show all
Includes:
BooleanMethods
Defined in:
lib/sequel/sql.rb

Overview

Subclass of ComplexExpression where the expression results in a boolean value in SQL.

Constant Summary

Constants inherited from ComplexExpression

ComplexExpression::BITWISE_OPERATORS, ComplexExpression::BOOLEAN_OPERATOR_METHODS, ComplexExpression::CONSTANT_INVERSIONS, ComplexExpression::CUSTOM_EXPRESSIONS, ComplexExpression::INEQUALITY_OPERATORS, ComplexExpression::IN_OPERATORS, ComplexExpression::IS_OPERATORS, ComplexExpression::MATHEMATICAL_OPERATORS, ComplexExpression::N_ARITY_OPERATORS, ComplexExpression::ONE_ARITY_OPERATORS, ComplexExpression::OPERTATOR_INVERSIONS, ComplexExpression::TWO_ARITY_OPERATORS

Instance Attribute Summary

Attributes inherited from ComplexExpression

#args, #op

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BooleanMethods

#~

Methods inherited from ComplexExpression

#initialize, #sql_number, #sql_string

Methods included from SubscriptMethods

#sql_subscript

Methods included from OrderMethods

#asc, #desc

Methods included from CastMethods

#cast, #cast_numeric, #cast_string

Methods included from AliasMethods

#as

Methods inherited from Expression

#==, attr_reader, comparison_attrs, #eql?, #hash, #inspect, #lit, #sql_literal

Constructor Details

This class inherits a constructor from Sequel::SQL::ComplexExpression

Class Method Details

.from_value_pairs(pairs, op = :AND, negate = false) ⇒ Object

Take pairs of values (e.g. a hash or array of two element arrays) and converts it to a BooleanExpression. The operator and args used depends on the case of the right (2nd) argument:

  • 0..10 - left >= 0 AND left <= 10

  • 1,2

    • left IN (1,2)

  • nil - left IS NULL

  • true - left IS TRUE

  • false - left IS FALSE

  • /as/ - left ~ ‘as’

  • :blah - left = blah

  • ‘blah’ - left = ‘blah’

If multiple arguments are given, they are joined with the op given (AND by default, OR possible). If negate is set to true, all subexpressions are inverted before used. Therefore, the following expressions are equivalent:

~from_value_pairs(hash)
from_value_pairs(hash, :OR, true)



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
 
# File 'lib/sequel/sql.rb', line 887

def self.from_value_pairs(pairs, op=:AND, negate=false)
  pairs = pairs.collect do |l,r|
    ce = case r
    when Range
      new(:AND, new(:>=, l, r.begin), new(r.exclude_end? ? :< : :<=, l, r.end))
    when ::Array, ::Sequel::Dataset
      new(:IN, l, r)
    when NegativeBooleanConstant
      new(:"IS NOT", l, r.constant)
    when BooleanConstant
      new(:IS, l, r.constant)
    when NilClass, TrueClass, FalseClass
      new(:IS, l, r)
    when Regexp
      StringExpression.like(l, r)
    else
      new(:'=', l, r)
    end
    negate ? invert(ce) : ce
  end
  pairs.length == 1 ? pairs.at(0) : new(op, *pairs)
end

.invert(ce) ⇒ Object

Invert the expression, if possible. If the expression cannot be inverted, raise an error. An inverted expression should match everything that the uninverted expression did not match, and vice-versa, except for possible issues with SQL NULL (i.e. 1 == NULL is NULL and 1 != NULL is also NULL).

BooleanExpression.invert(:a) # NOT "a"



916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/sequel/sql.rb', line 916

def self.invert(ce)
  case ce
  when BooleanExpression
    case op = ce.op
    when :AND, :OR
      BooleanExpression.new(OPERTATOR_INVERSIONS[op], *ce.args.collect{|a| BooleanExpression.invert(a)})
    else
      BooleanExpression.new(OPERTATOR_INVERSIONS[op], *ce.args.dup)
    end
  when StringExpression, NumericExpression
    raise(Sequel::Error, "cannot invert #{ce.inspect}")
  when Constant
    CONSTANT_INVERSIONS[ce] || raise(Sequel::Error, "cannot invert #{ce.inspect}")
  else
    BooleanExpression.new(:NOT, ce)
  end
end

Instance Method Details

#&(ce) ⇒ Object

Always use an AND operator for & on BooleanExpressions



935
936
937
 
# File 'lib/sequel/sql.rb', line 935

def &(ce)
  BooleanExpression.new(:AND, self, ce)
end

#sql_boolean ⇒ Object

Return self instead of creating a new object to save on memory.



945
946
947
 
# File 'lib/sequel/sql.rb', line 945

def sql_boolean
  self
end

#|(ce) ⇒ Object

Always use an OR operator for | on BooleanExpressions



940
941
942
 
# File 'lib/sequel/sql.rb', line 940

def |(ce)
  BooleanExpression.new(:OR, self, ce)
end