X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FAbstract%2FTree.pm;h=4cede05a0cb5d838df7ce85a182726360ef74e14;hb=aafbf8335720772329ee0cfff8a66cd46146ceb2;hp=d79f78735e268f750644fe8c0d21754a61cf1dad;hpb=1536de1518459a1ff30de0265f2a6b953c33deaa;p=dbsrgits%2FSQL-Abstract.git diff --git a/lib/SQL/Abstract/Tree.pm b/lib/SQL/Abstract/Tree.pm index d79f787..4cede05 100644 --- a/lib/SQL/Abstract/Tree.pm +++ b/lib/SQL/Abstract/Tree.pm @@ -4,12 +4,34 @@ use strict; use warnings; use Carp; +use List::Util; +use Hash::Merge; + +my $merger = Hash::Merge->new; + +$merger->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 Term::ANSIColor 'color'; 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 + placeholder_surround ); # Parser states for _recurse_parse() @@ -25,7 +47,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+ )? @@ -35,6 +61,7 @@ my @expression_terminator_sql_keywords = ( )', 'ON', 'WHERE', + 'VALUES', 'EXISTS', 'GROUP \s+ BY', 'HAVING', @@ -46,6 +73,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 @@ -78,21 +106,91 @@ my $tokenizer_re = qr/ \s* ( $tokenizer_re_str | \( | \) | \? ) \s* /xi; sub _binary_op_keywords { @binary_op_keywords } +my %indents = ( + 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 = ( console => { + fill_in_placeholders => 1, + placeholder_surround => ['?/', ''], indent_string => ' ', indent_amount => 2, newline => "\n", + colormap => {}, + indentmap => { %indents }, + + eval { require Term::ANSIColor } + ? do { + my $c = \&Term::ANSIColor::color; + ( + placeholder_surround => [$c->('black on_cyan'), $c->('reset')], + colormap => { + select => [$c->('red'), $c->('reset')], + 'insert into' => [$c->('red'), $c->('reset')], + update => [$c->('red'), $c->('reset')], + 'delete from' => [$c->('red'), $c->('reset')], + + set => [$c->('cyan'), $c->('reset')], + from => [$c->('cyan'), $c->('reset')], + + where => [$c->('green'), $c->('reset')], + values => [$c->('yellow'), $c->('reset')], + + join => [$c->('magenta'), $c->('reset')], + 'left join' => [$c->('magenta'), $c->('reset')], + on => [$c->('blue'), $c->('reset')], + + 'group by' => [$c->('yellow'), $c->('reset')], + 'order by' => [$c->('yellow'), $c->('reset')], + } + ); + } : (), + }, + console_monochrome => { + fill_in_placeholders => 1, + placeholder_surround => ['?/', ''], + indent_string => ' ', + indent_amount => 2, + newline => "\n", + colormap => {}, + indentmap => { %indents }, + }, + html => { + fill_in_placeholders => 1, + placeholder_surround => ['', ''], + indent_string => ' ', + indent_amount => 2, + newline => "
\n", colormap => { - select => [color('red'), color('reset')], - where => [color('green'), color('reset')], - from => [color('cyan'), color('reset')], - }, - indentmap => { - select => 0, - where => 1, - from => 1, + select => ['' , ''], + 'insert into' => ['' , ''], + update => ['' , ''], + 'delete from' => ['' , ''], + where => ['' , ''], + from => ['' , ''], + join => ['' , ''], + on => ['' , ''], + 'group by' => ['', ''], + 'order by' => ['', ''], + set => ['', ''], + into => ['', ''], + values => ['', ''], }, + indentmap => { %indents }, }, none => { colormap => {}, @@ -101,10 +199,11 @@ my %profiles = ( ); sub new { - my ($class, $args) = @_; + my $class = shift; + my $args = shift || {}; my $profile = delete $args->{profile} || 'none'; - my $data = {%{$profiles{$profile}}, %{$args||{}}}; + my $data = $merger->merge( $profiles{$profile}, $args ); bless $data, $class } @@ -212,29 +311,48 @@ sub format_keyword { return $keyword } -sub whitespace { +my %starters = ( + select => 1, + update => 1, + 'insert into' => 1, + 'delete from' => 1, +); + +sub pad_keyword { 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]; + $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} || ''; + my ($left, $right) = @{$self->placeholder_surround}; + $val =~ s/\\/\\\\/g; + $val =~ s/'/\\'/g; + return qq('$left$val$right') + } + return '?' } sub unparse { - my ($self, $tree, $depth) = @_; + my ($self, $tree, $bindargs, $depth) = @_; $depth ||= 0; @@ -246,27 +364,155 @@ 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); + my ($l, $r) = @{$self->pad_keyword($car, $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; +=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 + +=head1 METHODS + +=head2 new + + my $sqla_tree = SQL::Abstract::Tree->new({ profile => 'console' }); + + $args = { + profile => 'console', # predefined profile to use (default: 'none') + fill_in_placeholders => 1, # true for placeholder population + placeholder_surround => # The strings that will be wrapped around + [GREEN, RESET], # populated placeholders if the above is set + indent_string => ' ', # the string used when indenting + indent_amount => 2, # how many of above string to use for a single + # indent level + newline => "\n", # string for newline + colormap => { + select => [RED, RESET], # a pair of strings defining what to surround + # the keyword with for colorization + # ... + }, + indentmap => { + select => 0, # A zero means that the keyword will start on + # a new line + from => 1, # Any other positive integer means that after + on => 2, # said newline it will get that many indents + # ... + }, + } + +Returns a new SQL::Abstract::Tree object. All arguments are optional. + +=head3 profiles + +There are four predefined profiles, C, C, C, +and C. Typically a user will probably just use C or +C, but if something about a profile bothers you, merely +use the profile and override the parts that you don't like. + +=head2 format + + $sqlat->format('SELECT * FROM bar WHERE x = ?', [1]) + +Takes C<$sql> and C<\@bindargs>. + +Returns a formatting string based on the string passed in + +=head2 parse + + $sqlat->parse('SELECT * FROM bar WHERE x = ?') + +Returns a "tree" representing passed in SQL. Please do not depend on the +structure of the returned tree. It may be stable at some point, but not yet. + +=head2 unparse + + $sqlat->parse($tree_structure, \@bindargs) + +Transform "tree" into SQL, applying various transforms on the way. + +=head2 format_keyword + + $sqlat->format_keyword('SELECT') + +Currently this just takes a keyword and puts the C stuff around it. +Later on it may do more and allow for coderef based transforms. + +=head2 pad_keyword + + my ($before, $after) = @{$sqlat->pad_keyword('SELECT')}; + +Returns whitespace to be inserted around a keyword. + +=head2 fill_in_placeholder + + my $value = $sqlat->fill_in_placeholder(\@bindargs) + +Removes last arg from passed arrayref and returns it, surrounded with +the values in placeholder_surround, and then surrounded with single quotes. + +=head2 indent + +Returns as many indent strings as indent amounts times the first argument. + +=head1 ACCESSORS + +=head2 colormap + +See L + +=head2 fill_in_placeholders + +See L + +=head2 indent_amount + +See L + +=head2 indent_string + +See L + +=head2 indentmap + +See L + +=head2 newline + +See L + +=head2 placeholder_surround + +See L +