use object interface to Hash::Merge

[dbsrgits/SQL-Abstract.git] / lib / SQL / Abstract / Tree.pm
diff --git a/lib/SQL/Abstract/Tree.pm b/lib/SQL/Abstract/Tree.pm

index fedba48..c5abe28 100644 (file)
--- a/lib/SQL/Abstract/Tree.pm
+++ b/lib/SQL/Abstract/Tree.pm
@@ -5,6 +5,27 @@ 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 base 'Class::Accessor::Grouped';
 
@@ -103,6 +124,7 @@ my %indents = (
 
 my %profiles = (
    console => {
+      fill_in_placeholders => 1,
       indent_string => ' ',
       indent_amount => 2,
       newline       => "\n",
@@ -110,6 +132,7 @@ my %profiles = (
       indentmap     => { %indents },
    },
    console_monochrome => {
+      fill_in_placeholders => 1,
       indent_string => ' ',
       indent_amount => 2,
       newline       => "\n",
@@ -117,6 +140,7 @@ my %profiles = (
       indentmap     => { %indents },
    },
    html => {
+      fill_in_placeholders => 1,
       indent_string => '&nbsp;',
       indent_amount => 2,
       newline       => "<br />\n",
@@ -167,10 +191,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 = $merger->merge( $profiles{$profile}, $args );
 
    bless $data, $class
 }
@@ -278,6 +303,13 @@ sub format_keyword {
   return $keyword
 }
 
+my %starters = (
+   select        => 1,
+   update        => 1,
+   'insert into' => 1,
+   'delete from' => 1,
+);
+
 sub whitespace {
    my ($self, $keyword, $depth) = @_;
 
@@ -285,7 +317,7 @@ 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, ' '];
 }
 
@@ -302,7 +334,7 @@ sub _fill_in_placeholder {
    my ($self, $bindargs) = @_;
 
    if ($self->fill_in_placeholders) {
-      my $val = pop @{$bindargs};
+      my $val = pop @{$bindargs} || '';
       $val =~ s/\\/\\\\/g;
       $val =~ s/'/\\'/g;
       return qq('$val')
@@ -368,8 +400,40 @@ sub format { my $self = shift; $self->unparse($self->parse($_[0]), $_[1]) }
 
  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
+   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<none>, C<console>, C<console_monochrome>,
+and C<html>.  Typically a user will probably just use C<console> or
+C<console_monochrome>, 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')
+ $sqlat->format('SELECT * FROM bar WHERE x = ?', [1])
+
+Takes C<$sql> and C<\@bindargs>.
 
-Returns a formatting string based on wthe string passed in
+Returns a formatting string based on the string passed in