add placeholder support
[dbsrgits/SQL-Abstract.git] / lib / SQL / Abstract / Tree.pm
index 7870e48..fedba48 100644 (file)
@@ -4,11 +4,12 @@ use strict;
 use warnings;
 use Carp;
 
+use List::Util;
 
 use base 'Class::Accessor::Grouped';
 
 __PACKAGE__->mk_group_accessors( simple => $_ ) for qw(
-   newline indent_string indent_amount colormap indentmap
+   newline indent_string indent_amount colormap indentmap fill_in_placeholders
 );
 
 # Parser states for _recurse_parse()
@@ -24,7 +25,11 @@ use constant PARSE_RHS => 3;
 # anchored to word boundaries to match the whole token).
 my @expression_terminator_sql_keywords = (
   'SELECT',
+  'UPDATE',
+  'INSERT \s+ INTO',
+  'DELETE \s+ FROM',
   'FROM',
+  'SET',
   '(?:
     (?:
         (?: \b (?: LEFT | RIGHT | FULL ) \s+ )?
@@ -34,6 +39,7 @@ my @expression_terminator_sql_keywords = (
   )',
   'ON',
   'WHERE',
+  'VALUES',
   'EXISTS',
   'GROUP \s+ BY',
   'HAVING',
@@ -79,13 +85,20 @@ my $tokenizer_re = qr/ \s* ( $tokenizer_re_str | \( | \) | \? ) \s* /xi;
 sub _binary_op_keywords { @binary_op_keywords }
 
 my %indents = (
-   select     => 0,
-   where      => 1,
-   from       => 1,
-   join       => 1,
-   on         => 2,
-   'group by' => 1,
-   'order by' => 1,
+   select        => 0,
+   update        => 0,
+   'insert into' => 0,
+   'delete from' => 0,
+   from          => 1,
+   where         => 0,
+   join          => 1,
+   'left join'   => 1,
+   on            => 2,
+   'group by'    => 0,
+   'order by'    => 0,
+   set           => 1,
+   into          => 1,
+   values        => 1,
 );
 
 my %profiles = (
@@ -108,12 +121,19 @@ my %profiles = (
       indent_amount => 2,
       newline       => "<br />\n",
       colormap      => {
-         select     => ['<span class="select">'  , '</span>'],
-         where      => ['<span class="where">'   , '</span>'],
-         from       => ['<span class="from">'    , '</span>'],
-         join       => ['<span class="join">'    , '</span>'],
-         on         => ['<span class="on">'      , '</span>'],
-         'group by' => ['<span class="group-by">', '</span>'],
+         select        => ['<span class="select">'  , '</span>'],
+         'insert into' => ['<span class="insert-into">'  , '</span>'],
+         update        => ['<span class="select">'  , '</span>'],
+         'delete from' => ['<span class="delete-from">'  , '</span>'],
+         where         => ['<span class="where">'   , '</span>'],
+         from          => ['<span class="from">'    , '</span>'],
+         join          => ['<span class="join">'    , '</span>'],
+         on            => ['<span class="on">'      , '</span>'],
+         'group by'    => ['<span class="group-by">', '</span>'],
+         'order by'    => ['<span class="order-by">', '</span>'],
+         set           => ['<span class="set">', '</span>'],
+         into          => ['<span class="into">', '</span>'],
+         values        => ['<span class="values">', '</span>'],
       },
       indentmap     => { %indents },
    },
@@ -126,13 +146,23 @@ my %profiles = (
 eval {
    require Term::ANSIColor;
    $profiles{console}->{colormap} = {
-      select     => [Term::ANSIColor::color('red'), Term::ANSIColor::color('reset')],
-      where      => [Term::ANSIColor::color('green'), Term::ANSIColor::color('reset')],
-      from       => [Term::ANSIColor::color('cyan'), Term::ANSIColor::color('reset')],
-      join       => [Term::ANSIColor::color('magenta'), Term::ANSIColor::color('reset')],
-      on         => [Term::ANSIColor::color('blue'), Term::ANSIColor::color('reset')],
-      'group by' => [Term::ANSIColor::color('cyan'), Term::ANSIColor::color('reset')],
-      'order by' => [Term::ANSIColor::color('yellow'), Term::ANSIColor::color('reset')],
+      select        => [Term::ANSIColor::color('red'), Term::ANSIColor::color('reset')],
+      'insert into' => [Term::ANSIColor::color('red'), Term::ANSIColor::color('reset')],
+      update        => [Term::ANSIColor::color('red'), Term::ANSIColor::color('reset')],
+      'delete from' => [Term::ANSIColor::color('red'), Term::ANSIColor::color('reset')],
+
+      set           => [Term::ANSIColor::color('cyan'), Term::ANSIColor::color('reset')],
+      from          => [Term::ANSIColor::color('cyan'), Term::ANSIColor::color('reset')],
+
+      where         => [Term::ANSIColor::color('green'), Term::ANSIColor::color('reset')],
+      values        => [Term::ANSIColor::color('yellow'), Term::ANSIColor::color('reset')],
+
+      join          => [Term::ANSIColor::color('magenta'), Term::ANSIColor::color('reset')],
+      'left join'   => [Term::ANSIColor::color('magenta'), Term::ANSIColor::color('reset')],
+      on            => [Term::ANSIColor::color('blue'), Term::ANSIColor::color('reset')],
+
+      'group by'    => [Term::ANSIColor::color('yellow'), Term::ANSIColor::color('reset')],
+      'order by'    => [Term::ANSIColor::color('yellow'), Term::ANSIColor::color('reset')],
    };
 };
 
@@ -252,25 +282,36 @@ sub whitespace {
    my ($self, $keyword, $depth) = @_;
 
    my $before = '';
-   my $after  = ' ';
    if (defined $self->indentmap->{lc $keyword}) {
       $before = $self->newline . $self->indent($depth + $self->indentmap->{lc $keyword});
    }
    $before = '' if $depth == 0 and lc $keyword eq 'select';
-   return [$before, $after];
+   return [$before, ' '];
 }
 
 sub indent { ($_[0]->indent_string||'') x ( ( $_[0]->indent_amount || 0 ) * $_[1] ) }
 
-sub _is_select {
-   my $tree = shift;
+sub _is_key {
+   my ($self, $tree) = @_;
    $tree = $tree->[0] while ref $tree;
 
-   defined $tree && lc $tree eq 'select';
+   defined $tree && defined $self->indentmap->{lc $tree};
+}
+
+sub _fill_in_placeholder {
+   my ($self, $bindargs) = @_;
+
+   if ($self->fill_in_placeholders) {
+      my $val = pop @{$bindargs};
+      $val =~ s/\\/\\\\/g;
+      $val =~ s/'/\\'/g;
+      return qq('$val')
+   }
+   return '?'
 }
 
 sub unparse {
-  my ($self, $tree, $depth) = @_;
+  my ($self, $tree, $bindargs, $depth) = @_;
 
   $depth ||= 0;
 
@@ -282,27 +323,30 @@ sub unparse {
   my $cdr = $tree->[1];
 
   if (ref $car) {
-    return join ('', map $self->unparse($_, $depth), @$tree);
+    return join ('', map $self->unparse($_, $bindargs, $depth), @$tree);
   }
   elsif ($car eq 'LITERAL') {
+    if ($cdr->[0] eq '?') {
+      return $self->_fill_in_placeholder($bindargs)
+    }
     return $cdr->[0];
   }
   elsif ($car eq 'PAREN') {
     return '(' .
       join(' ',
-        map $self->unparse($_, $depth + 2), @{$cdr}) .
-    (_is_select($cdr)?( $self->newline||'' ).$self->indent($depth + 1):'') . ') ';
+        map $self->unparse($_, $bindargs, $depth + 2), @{$cdr}) .
+    ($self->_is_key($cdr)?( $self->newline||'' ).$self->indent($depth + 1):'') . ') ';
   }
   elsif ($car eq 'OR' or $car eq 'AND' or (grep { $car =~ /^ $_ $/xi } @binary_op_keywords ) ) {
-    return join (" $car ", map $self->unparse($_, $depth), @{$cdr});
+    return join (" $car ", map $self->unparse($_, $bindargs, $depth), @{$cdr});
   }
   else {
     my ($l, $r) = @{$self->whitespace($car, $depth)};
-    return sprintf "$l%s %s$r", $self->format_keyword($car), $self->unparse($cdr, $depth);
+    return sprintf "$l%s %s$r", $self->format_keyword($car), $self->unparse($cdr, $bindargs, $depth);
   }
 }
 
-sub format { my $self = shift; $self->unparse($self->parse(@_)) }
+sub format { my $self = shift; $self->unparse($self->parse($_[0]), $_[1]) }
 
 1;
 
@@ -318,3 +362,14 @@ sub format { my $self = shift; $self->unparse($self->parse(@_)) }
  #   FROM foo
  #   WHERE foo.a > 2
 
+=head1 METHODS
+
+=head2 new
+
+ my $sqla_tree = SQL::Abstract::Tree->new({ profile => 'console' });
+
+=head2 format
+
+ $sqlat->format('SELECT * FROM bar')
+
+Returns a formatting string based on wthe string passed in