whitespace tests
[dbsrgits/SQL-Abstract.git] / lib / SQL / Abstract / Tree.pm
index 49dbe04..0110fc5 100644 (file)
@@ -4,6 +4,13 @@ use strict;
 use warnings;
 use Carp;
 
+
+use base 'Class::Accessor::Grouped';
+
+__PACKAGE__->mk_group_accessors( simple => $_ ) for qw(
+   newline indent_string indent_amount colormap indentmap
+);
+
 # Parser states for _recurse_parse()
 use constant PARSE_TOP_LEVEL => 0;
 use constant PARSE_IN_EXPR => 1;
@@ -38,6 +45,7 @@ my @expression_terminator_sql_keywords = (
   'INTERSECT',
   'EXCEPT',
   'RETURNING',
+  'ROW_NUMBER \s* \( \s* \) \s+ OVER',
 );
 
 # These are binary operator keywords always a single LHS and RHS
@@ -70,7 +78,72 @@ my $tokenizer_re = qr/ \s* ( $tokenizer_re_str | \( | \) | \? ) \s* /xi;
 
 sub _binary_op_keywords { @binary_op_keywords }
 
-sub new { bless sub {}, shift }
+my %indents = (
+   select     => 0,
+   where      => 1,
+   from       => 1,
+   join       => 1,
+   on         => 2,
+   'group by' => 1,
+   'order by' => 1,
+);
+
+my %profiles = (
+   console => {
+      indent_string => ' ',
+      indent_amount => 2,
+      newline       => "\n",
+      colormap      => {},
+      indentmap     => { %indents },
+   },
+   console_monochrome => {
+      indent_string => ' ',
+      indent_amount => 2,
+      newline       => "\n",
+      colormap      => {},
+      indentmap     => { %indents },
+   },
+   html => {
+      indent_string => ' ',
+      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>'],
+      },
+      indentmap     => { %indents },
+   },
+   none => {
+      colormap      => {},
+      indentmap     => {},
+   },
+);
+
+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')],
+   };
+};
+
+sub new {
+   my ($class, $args) = @_;
+
+   my $profile = delete $args->{profile} || 'none';
+   my $data = {%{$profiles{$profile}}, %{$args||{}}};
+
+   bless $data, $class
+}
 
 sub parse {
   my ($self, $s) = @_;
@@ -165,46 +238,28 @@ sub _recurse_parse {
   }
 }
 
-use Term::ANSIColor 'color';
-
-my %ghetto_colormap = (
-  select => [color('red'), color('reset')],
-  where => [color('green'), color('reset')],
-  from => [color('cyan'), color('reset')],
-);
-
 sub format_keyword {
   my ($self, $keyword) = @_;
 
-  if (my $around = $ghetto_colormap{lc $keyword}) {
+  if (my $around = $self->colormap->{lc $keyword}) {
      $keyword = "$around->[0]$keyword$around->[1]";
   }
 
   return $keyword
 }
 
-
-my %ghetto_whitespacemap = (
-  select => 0,
-  where  => 1,
-  from   => 1,
-);
-
 sub whitespace {
    my ($self, $keyword, $depth) = @_;
 
    my $before = '';
-   my $after  = '';
-   if (defined $ghetto_whitespacemap{lc $keyword}) {
-      $before = $self->newline . $self->indent($depth + $ghetto_whitespacemap{lc $keyword});
+   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 newline { "\n" }
-
-sub indent { '   ' x $_[1] }
+sub indent { ($_[0]->indent_string||'') x ( ( $_[0]->indent_amount || 0 ) * $_[1] ) }
 
 sub _is_select {
    my $tree = shift;
@@ -235,7 +290,7 @@ sub unparse {
     return '(' .
       join(' ',
         map $self->unparse($_, $depth + 2), @{$cdr}) .
-    (_is_select($cdr)?$self->newline.$self->indent($depth + 1):'') . ')';
+    (_is_select($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});
@@ -250,3 +305,15 @@ sub format { my $self = shift; $self->unparse($self->parse(@_)) }
 
 1;
 
+=pod
+
+=head1 SYNOPSIS
+
+ my $sqla_tree = SQL::Abstract::Tree->new({ profile => 'console' });
+
+ print $sqla_tree->format('SELECT * FROM foo WHERE foo.a > 2');
+
+ # SELECT *
+ #   FROM foo
+ #   WHERE foo.a > 2
+