initial start of warn-style caller info

[scpubgit/Q-Branch.git] / lib / SQL / Abstract / Tree.pm

diff --git a/lib/SQL/Abstract/Tree.pm b/lib/SQL/Abstract/Tree.pm
index 190ae41..28a276c 100644 (file)
--- a/lib/SQL/Abstract/Tree.pm
+++ b/lib/SQL/Abstract/Tree.pm
@@ -4,11 +4,32 @@ use strict;
 use warnings;
 use Carp;
 
+use List::Util;
+use Hash::Merge 'merge';
+
+Hash::Merge::specify_behavior({
+   SCALAR => {
+      SCALAR => sub { $_[1] },
+      ARRAY  => sub { [ $_[0], @{$_[1]} ] },
+      HASH   => sub { $_[1] },
+   },
+   ARRAY => {
+      SCALAR => sub { $_[1] },
+      ARRAY  => sub { $_[1] },
+      HASH   => sub { $_[1] },
+   },
+   HASH => {
+      SCALAR => sub { $_[1] },
+      ARRAY  => sub { [ values %{$_[0]}, @{$_[1]} ] },
+      HASH   => sub { Hash::Merge::_merge_hashes( $_[0], $_[1] ) },
+   },
+}, 'My Behavior' );
 
 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
+   include_caller caller_depth
 );
 
 # Parser states for _recurse_parse()
@@ -89,19 +110,21 @@ my %indents = (
    'insert into' => 0,
    'delete from' => 0,
    from          => 1,
-   where         => 1,
+   where         => 0,
    join          => 1,
    'left join'   => 1,
    on            => 2,
-   'group by'    => 1,
-   'order by'    => 1,
+   'group by'    => 0,
+   'order by'    => 0,
    set           => 1,
    into          => 1,
-   values        => 2,
+   values        => 1,
 );
 
 my %profiles = (
    console => {
+      caller_depth => 0,
+      fill_in_placeholders => 1,
       indent_string => ' ',
       indent_amount => 2,
       newline       => "\n",
@@ -109,6 +132,8 @@ my %profiles = (
       indentmap     => { %indents },
    },
    console_monochrome => {
+      caller_depth => 0,
+      fill_in_placeholders => 1,
       indent_string => ' ',
       indent_amount => 2,
       newline       => "\n",
@@ -116,6 +141,8 @@ my %profiles = (
       indentmap     => { %indents },
    },
    html => {
+      caller_depth => 0,
+      fill_in_placeholders => 1,
       indent_string => ' ',
       indent_amount => 2,
       newline       => "<br />\n",
@@ -151,10 +178,10 @@ eval {
       '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')],
-      from          => [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')],
@@ -166,10 +193,11 @@ eval {
 };
 
 sub new {
-   my ($class, $args) = @_;
+   my $class = shift;
+   my $args  = shift || {};
 
    my $profile = delete $args->{profile} || 'none';
-   my $data = {%{$profiles{$profile}}, %{$args||{}}};
+   my $data = merge( $profiles{$profile}, $args );
 
    bless $data, $class
 }
@@ -277,6 +305,13 @@ sub format_keyword {
   return $keyword
 }
 
+my %starters = (
+   select        => 1,
+   update        => 1,
+   'insert into' => 1,
+   'delete from' => 1,
+);
+
 sub whitespace {
    my ($self, $keyword, $depth) = @_;
 
@@ -284,23 +319,46 @@ sub whitespace {
    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';
+   $before = '' if $depth == 0 and defined $starters{lc $keyword};
    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 _caller_info {
+   my ($self, $depth) = @_;
+
+   return '' if $depth != 1 or !$self->include_caller;
+
+   my @caller_info = caller($self->caller_depth + 0);
+
+   " at $caller_info[1] line $caller_info[2].";
 }
 
 sub unparse {
-  my ($self, $tree, $depth) = @_;
+  my ($self, $tree, $bindargs, $indent, $depth) = @_;
 
-  $depth ||= 0;
+  $depth  ||= 0;
+  $indent ||= 0;
 
   if (not $tree ) {
     return '';
@@ -310,27 +368,30 @@ sub unparse {
   my $cdr = $tree->[1];
 
   if (ref $car) {
-    return join ('', map $self->unparse($_, $depth), @$tree);
+    return join ('', map $self->unparse($_, $bindargs, $indent, $depth + 1), @$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, $indent + 2, $depth + 1), @{$cdr}) .
+    ($self->_is_key($cdr)?( $self->newline||'' ).$self->indent($indent + 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, $indent, $depth + 1), @{$cdr});
   }
   else {
-    my ($l, $r) = @{$self->whitespace($car, $depth)};
-    return sprintf "$l%s %s$r", $self->format_keyword($car), $self->unparse($cdr, $depth);
+    my ($l, $r) = @{$self->whitespace($car, $indent)};
+    return sprintf "$l%s %s$r%s", $self->format_keyword($car), $self->unparse($cdr, $bindargs, $indent, $depth + 1), $self->_caller_info($depth);
   }
 }
 
-sub format { my $self = shift; $self->unparse($self->parse(@_)) }
+sub format { my $self = shift; $self->unparse($self->parse($_[0]), $_[1]) }
 
 1;
 
@@ -346,3 +407,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