IS NOT? NULL support
[dbsrgits/SQL-Abstract-2.0-ish.git] / lib / SQL / Abstract / AST / v1.pm
index 81abf9d..e27584b 100644 (file)
@@ -6,161 +6,297 @@ class SQL::Abstract::AST::v1 extends SQL::Abstract {
   use Data::Dump qw/pp/;
 
   use Moose::Util::TypeConstraints;
-  use MooseX::Types -declare => [qw/NameSeparator/];
-  use MooseX::Types::Moose qw/ArrayRef Str Int/;
+  use MooseX::Types::Moose qw/ArrayRef Str Int Ref HashRef/;
   use MooseX::AttributeHelpers;
+  use SQL::Abstract::Types qw/AST/;
+  use Devel::PartialDump qw/dump/;
 
   clean;
 
-  override _build_where_dispatch_table {
+  # set things that are valid in where clauses
+  override _build_expr_dispatch_table {
     return { 
       %{super()},
-      -in => $self->can('_in'),
-      -not_in => $self->can('_in')
+      in => $self->can('_in'),
+      not_in => $self->can('_in'),
+      between => $self->can('_between'),
+      not_between => $self->can('_between'),
+      and => $self->can('_recurse_where'),
+      or => $self->can('_recurse_where'),
+      map { +"$_" => $self->can("_$_") } qw/
+        value
+        name
+        true
+        false
+        expr
+      /
     };
   }
 
-  method _select(ArrayRef $ast) {
+  method _select(AST $ast) {
+    # Default to requiring columns and from.
+    # DB specific ones (i.e. mysql/Pg) can not require the FROM part with a bit
+    # of refactoring
     
+    for (qw/columns tablespec/) {
+      confess "'$_' is required in select AST with " . dump ($ast)
+        unless exists $ast->{$_};
+    }
+   
+    # Check that columns is a -list
+    confess "'columns' should be an array ref, not " . dump($ast->{columns})
+      unless is_ArrayRef($ast->{columns});
+
+    my $cols = $self->_list({-type => 'list', args => $ast->{columns} });
+
+    my @output = (
+      SELECT => $cols
+    );
+
+    push @output, FROM => $self->dispatch($ast->{tablespec})
+      if exists $ast->{tablespec};
+
+    if (exists $ast->{where}) {
+      my $sub_ast = $ast->{where};
+
+      confess "$_ option is not an AST: " . dump($sub_ast)
+        unless is_AST($sub_ast);
+
+      push @output, "WHERE", $self->_expr($sub_ast);
+    }
+
+    for (qw/group_by having order_by/) {
+      if (exists $ast->{$_}) {
+        my $sub_ast = $ast->{$_};
+
+        confess "$_ option is not an AST or an ArrayRef: " . dump($sub_ast)
+          unless is_AST($sub_ast) || is_ArrayRef($sub_ast);;
+
+        my $meth = "__$_";
+        push @output, $self->$meth($sub_ast);
+      }
+    }
+
+    return join(' ', @output);
   }
 
-  method _where(ArrayRef $ast) {
-    my (undef, @clauses) = @$ast;
+  method _join(HashRef $ast) {
+
+    # TODO: Validate join type
+    my $type = $ast->{join_type} || "";
   
-    return 'WHERE ' . $self->_recurse_where(\@clauses);
+    my @output = $self->dispatch($ast->{lhs});
+
+    push @output, uc $type if $type;
+    push @output, "JOIN", $self->dispatch($ast->{rhs});
+
+    push @output, 
+        exists $ast->{on}
+      ? ('ON', '(' . $self->_expr( $ast->{on} ) . ')' )
+      : ('USING', '(' .$self->dispatch($ast->{using} 
+                        || croak "No 'on' or 'uinsg' clause passed to join cluase: " .
+                                 dump($ast) 
+                        ) .
+                  ')' );
+
+    return join(" ", @output);
+      
   }
 
-  method _order_by(ArrayRef $ast) {
-    my (undef, @clauses) = @$ast;
+  method _ordering(AST $ast) {
+    my $output = $self->_expr($ast->{expr});
 
-    my @output;
-   
-    for (@clauses) {
-      if ($_->[0] =~ /^-(asc|desc)$/) {
-        my $o = $1;
-        push @output, $self->dispatch($_->[1]) . " " . uc($o);
-        next;
-      }
-      push @output, $self->dispatch($_);
-    }
+    $output .= " " . uc $1
+      if $ast->{direction} && 
+         ( $ast->{direction} =~ /^(asc|desc)$/i 
+           || confess "Unknown ordering direction " . dump($ast)
+         );
 
-    return "ORDER BY " . join(", ", @output);
+    return $output;
   }
 
-  method _name(ArrayRef $ast) {
-    my (undef, @names) = @$ast;
+  method _name(AST $ast) {
+    my @names = @{$ast->{args}};
 
     my $sep = $self->name_separator;
+    my $quote = $self->is_quoting 
+              ? $self->quote_chars
+              : [ '' ];
 
-    return $sep->[0] . 
-           join( $sep->[1] . $sep->[0], @names ) . 
-           $sep->[1]
-              if (@$sep > 1);
+    my $join = $quote->[-1] . $sep . $quote->[0];
 
-    return join($sep->[0], @names);
-  }
+    # We dont want to quote * in [qw/me */]: `me`.* is the desired output there
+    # This means you can't have a field called `*`. I am willing to accept this
+    # situation, cos thats a really stupid thing to want.
+    my $post;
+    $post = pop @names if $names[-1] eq '*';
 
-  method _join(ArrayRef $ast) {
-    
+    my $ret;
+    $ret = $quote->[0] . 
+           join( $join, @names ) . 
+           $quote->[-1]
+      if @names;
+
+    $ret = $ret 
+         ? $ret . $sep . $post
+         : $post
+      if defined $post;
+
+
+    return $ret;
   }
 
-  method _list(ArrayRef $ast) {
-    my (undef, @items) = @$ast;
+
+  method _list(AST $ast) {
+    return "" unless $ast->{args};
+
+    my @items = is_ArrayRef($ast->{args})
+              ? @{$ast->{args}}
+              : $ast->{args};
 
     return join(
       $self->list_separator,
       map { $self->dispatch($_) } @items);
   }
 
-  method _alias(ArrayRef $ast) {
-    my (undef, $alias, $as) = @$ast;
-
-    return $self->dispatch($alias) . " AS $as";
+  # TODO: I think i want to parameterized AST type to get better validation
+  method _alias(AST $ast) {
+    
+    # TODO: Maybe we want qq{ AS "$as"} here
+    return $self->dispatch($ast->{ident}) . " AS " . $ast->{as};
 
   }
 
-  method _value(ArrayRef $ast) {
-    my ($undef, $value) = @$ast;
+  method _value(AST $ast) {
 
-    $self->add_bind($value);
+    $self->add_bind($ast->{value});
     return "?";
   }
 
-  method _recurse_where($clauses) {
+  # Not dispatchable to.
+  method __having($args) {
+    return "HAVING " . $self->_list({-type => 'list', args => $args});
+  }
 
-    my $OP = 'AND';
-    my $prio = $SQL::Abstract::PRIO{and};
-    my $first = $clauses->[0];
+  method __group_by($args) {
+    return "GROUP BY " . $self->_list({-type => 'list', args => $args});
+  }
 
-    if (!ref $first && $first =~ /^-(and|or)$/) {
-      $OP = uc($1);
-      $prio = $SQL::Abstract::PRIO{$1};
-      shift @$clauses;
-    }
+  method __order_by($args) {
+    return "ORDER BY " . $self->_list({-type => 'list', args => $args});
+  }
 
-    my $dispatch_table = $self->where_dispatch_table;
 
-    my @output;
-    foreach (@$clauses) {
-      croak "invalid component in where clause" unless ArrayRef->check($_);
-      my $op = $_->[0];
+  # Perhaps badly named. handles 'and' and 'or' clauses
+  method _recurse_where(AST $ast) {
+
+    my $op = $ast->{op};
+
+    my $OP = uc $op;
+    my $prio = $SQL::Abstract::PRIO{$op};
 
-      if (my $code = $dispatch_table->{$op}) { 
-        
-        push @output, $code->($self, $_);
+    my $dispatch_table = $self->expr_dispatch_table;
 
-      } elsif ($op =~ /^-(and|or)$/) {
+    my @output;
+    foreach ( @{$ast->{args}} ) {
+      croak "invalid component in where clause: $_" unless is_AST($_);
+
+      if ($_->{-type} eq 'expr' && $_->{op} =~ /^(and|or)$/) {
         my $sub_prio = $SQL::Abstract::PRIO{$1}; 
 
-        if ($sub_prio <= $prio) {
+        if ($sub_prio == $prio) {
+          # When the element below has same priority, i.e. 'or' as a child of
+          # 'or', dont produce extra brackets
           push @output, $self->_recurse_where($_);
         } else {
           push @output, '(' . $self->_recurse_where($_) . ')';
         }
       } else {
-        croak "Unknown where clause '$op'";
+        push @output, $self->_expr($_);
       }
     }
 
     return join(" $OP ", @output);
   }
 
-  method _binop($ast) {
-    my ($op, $lhs, $rhs) = @$ast;
+  method _expr(AST $ast) {
+    my $op = $ast->{-type};
+
+    $op = $ast->{op} if $op eq 'expr';
+
+    if (my $code = $self->lookup_expr_dispatch($op)) { 
+      
+      return $code->($self, $ast);
+
+    }
+    croak "'$op' is not a valid AST type in an expression with " . dump($ast)
+      if $ast->{-type} ne 'expr';
+
+    # This is an attempt to do some form of validation on function names. This
+    # might end up being a bad thing.
+    croak "'$op' is not a valid operator in an expression with " . dump($ast)
+      if $op =~ /\W/;
 
-    join (' ', $self->dispatch($lhs), 
+    return $self->_generic_function_op($ast);
+   
+  }
+
+  method _binop(AST $ast) {
+    my ($lhs, $rhs) = @{$ast->{args}};
+    my $op = $ast->{op};
+
+    # IS NOT? NULL
+    if ($rhs->{-type} eq 'value' && !defined $rhs->{value} &&
+        ($op eq '==' || $op eq '!='))
+    {
+      return $self->_expr($lhs) .
+             ($op eq '==' ? " IS " : " IS NOT ") .
+             "NULL";
+    }
+
+    join (' ', $self->_expr($lhs), 
                $self->binop_mapping($op) || croak("Unknown binary operator $op"),
-               $self->dispatch($rhs)
+               $self->_expr($rhs)
     );
   }
 
-  method _in($ast) {
-    my ($tag, $field, @values) = @$ast;
-
-    my $not = $tag =~ /^-not/ ? " NOT" : "";
+  method _generic_function_op(AST $ast) {
+    my $op = $ast->{op};
 
-    return $self->_false if @values == 0;
-    return $self->dispatch($field) .
-           $not. 
-           " IN (" .
-           join(", ", map { $self->dispatch($_) } @values ) .
-           ")";
+    return "$op(" . $self->_list($ast) . ")";
   }
 
-  method _like($ast) {
-    my ($tag, $field, @values) = @$ast;
+  method _in(AST $ast) {
+  
+    my ($field,@values) = @{$ast->{args}};
+
+    my $not = ($ast->{op} =~ /^not_/) ? " NOT" : "";
 
-    my $not = $tag =~ /^-not/ ? " NOT" : "";
+    return $self->_false unless @values;
 
-    return $self->_false if @values == 0;
-    return $self->dispatch($field) .
-           $not. 
-           " LIKE (" .
+    return $self->_expr($field) .
+           $not . 
+           " IN (" .
            join(", ", map { $self->dispatch($_) } @values ) .
            ")";
   }
 
-  method _generic_func(ArrayRef $ast) {
+  method _between(AST $ast) {
+  
+    my ($field,@values) = @{$ast->{args}};
+
+    my $not = ($ast->{op} =~ /^not_/) ? " NOT" : "";
+    croak "between requires 3 arguments: " . dump($ast)
+      unless @values == 2;
+
+    # The brackets are to work round an issue with SQL::A::Test
+    return "(" .
+           $self->_expr($field) .
+           $not . 
+           " BETWEEN " .
+           join(" AND ", map { $self->dispatch($_) } @values ) .
+           ")";
   }
 
   # 'constants' that are portable across DBs