consolidate other things
[scpubgit/Q-Branch.git] / lib / SQL / Abstract / ExtraClauses.pm
index a632896..39e6f51 100644 (file)
@@ -1,17 +1,44 @@
 package SQL::Abstract::ExtraClauses;
 
-use strict;
-use warnings;
-use if $] < '5.010', 'MRO::Compat';
-use mro 'c3';
-use base qw(SQL::Abstract::Clauses);
-
-BEGIN { *puke = \&SQL::Abstract::puke }
-
-sub register_defaults {
-  my $self = shift;
-  $self->next::method(@_);
-  my @clauses = $self->clauses_of('select');
+use Moo;
+
+has sqla => (
+  is => 'ro', init_arg => undef,
+  handles => [ qw(
+    expand_expr expand_maybe_list_expr render_aqt join_query_parts
+  ) ],
+);
+
+sub cb {
+  my ($self, $method, @args) = @_;
+  return sub {
+    local $self->{sqla} = shift;
+    $self->$method(@args, @_)
+  };
+}
+
+sub register {
+  my ($self, @pairs) = @_;
+  my $sqla = $self->sqla;
+  while (my ($method, $cases) = splice(@pairs, 0, 2)) {
+    my @cases = @$cases;
+    while (my ($name, $case) = splice(@cases, 0, 2)) {
+      $sqla->$method($name, $self->cb($case));
+    }
+  }
+  return $self;
+}
+
+sub apply_to {
+  my ($self, $sqla) = @_;
+  $self = $self->new unless ref($self);
+  local $self->{sqla} = $sqla;
+  $self->register_extensions($sqla);
+}
+
+sub register_extensions {
+  my ($self, $sqla) = @_;
+  my @clauses = $sqla->clauses_of('select');
   my @before_setop;
   CLAUSE: foreach my $idx (0..$#clauses) {
     if ($clauses[$idx] eq 'order_by') {
@@ -21,175 +48,105 @@ sub register_defaults {
     }
   }
   die "Huh?" unless @before_setop;
-  $self->clauses_of(select => 'with', @clauses);
-  $self->clause_expanders(
-    'select.group_by', sub {
-      $_[0]->_expand_maybe_list_expr($_[2], -ident)
-    },
-    'select.having', sub { $_[0]->expand_expr($_[2]) },
+  $sqla->clauses_of(select => 'with', @clauses);
+  $self->register(
+    clause_expanders => [
+      'select.group_by'
+        => sub { $_[0]->expand_maybe_list_expr($_[2], -ident) },
+      'select.having'
+        => sub { $_[0]->expand_expr($_[2]) },
+    ],
+    (map +(
+      "${_}er" => [
+        do {
+          my $x = $_;
+          (map +($_ => "_${x}_${_}"), qw(join from_list alias))
+        }
+       ]
+    ), qw(expand render)),
+    binop_expander => [ as => '_expand_op_as' ],
+    renderer => [ as => '_render_as' ],
+    expander => [ cast => '_expand_cast' ],
   );
-  foreach my $thing (qw(join from_list)) {
-    $self->expander($thing => "_expand_${thing}")
-         ->renderer($thing => "_render_${thing}")
-  }
-  $self->op_expander(as => '_expand_op_as');
-  $self->expander(as => '_expand_op_as');
-  $self->renderer(as => '_render_as');
-  $self->expander(alias => sub {
-    my ($self, undef, $args) = @_;
-    if (ref($args) eq 'HASH' and my $alias = $args->{-alias}) {
-      $args = $alias;
-    }
-    +{ -alias => [
-        map $self->expand_expr($_, -ident),
-        ref($args) eq 'ARRAY' ? @{$args} : $args
-      ]
-    }
-  });
-  $self->renderer(alias => '_render_alias');
 
-  $self->clauses_of(update => sub {
+  $sqla->clauses_of(update => sub {
     my ($self, @clauses) = @_;
     splice(@clauses, 2, 0, 'from');
     @clauses;
   });
 
-  $self->clauses_of(delete => sub {
+  $sqla->clauses_of(delete => sub {
     my ($self, @clauses) = @_;
     splice(@clauses, 1, 0, 'using');
     @clauses;
   });
 
-  $self->clause_expanders(
-    'update.from' => '_expand_select_clause_from',
-    'delete.using' => sub {
-      +(using => $_[0]->_expand_from_list(undef, $_[2]));
-    },
-    'insert.rowvalues' => sub {
+  $sqla->clause_expanders(
+    'update.from' => $self->cb('_expand_from_list'),
+    'delete.using' => $self->cb('_expand_from_list'),
+    'insert.rowvalues' => $self->cb(sub {
       +(from => $_[0]->expand_expr({ -values => $_[2] }));
-    },
-    'insert.select' => sub {
+    }),
+    'insert.select' => $self->cb(sub {
       +(from => $_[0]->expand_expr({ -select => $_[2] }));
-    },
+    }),
   );
 
   # set ops
-  $self->wrap_expander(select => sub {
-    my $orig = shift;
-    sub {
-      my $self = shift;
-      my $exp = $self->$orig(@_);
-      return $exp unless my $setop = (my $sel = $exp->{-select})->{setop};
-      if (my @keys = grep $sel->{$_}, @before_setop) {
-        my %inner; @inner{@keys} = delete @{$sel}{@keys};
-        unshift @{(values(%$setop))[0]{queries}},
-          { -select => \%inner };
-      }
-      return $exp;
-    }
+  $sqla->wrap_expander(select => sub {
+    $self->cb('_expand_select', $_[0], \@before_setop);
   });
-  my $expand_setop = sub {
-    my ($self, $setop, $args) = @_;
-    +{ "-${setop}" => {
-         %$args,
-         queries => [ map $self->expand_expr($_), @{$args->{queries}} ],
-    } };
-  };
-  $self->expanders(map +($_ => $expand_setop), qw(union intersect except));
 
-  $self->clause_renderer('select.setop' => sub {
-    my ($self, undef, $setop) = @_;
-    $self->render_aqt($setop);
-  });
+  $sqla->clause_renderer(
+    'select.setop' => $self->cb(sub { $_[0]->render_aqt($_[2]); })
+  );
 
-  $self->renderer($_ => sub {
-    my ($self, $setop, $args) = @_;
-    $self->join_query_parts(
-      ' '.$self->format_keyword(join '_', $setop, ($args->{type}||())).' ',
-      @{$args->{queries}}
-    );
-  }) for qw(union intersect except);
-
-  my $setop_expander = sub {
-    my ($self, $setop, $args) = @_;
-    my ($op, $type) = split '_', $setop;
-    +(setop => $self->expand_expr({
-      "-${op}" => {
-        ($type ? (type => $type) : ()),
-        queries => (ref($args) eq 'ARRAY' ? $args : [ $args ])
-      }
-    }));
-  };
+  foreach my $setop (qw(union intersect except)) {
+    $sqla->expander($setop => $self->cb('_expand_setop'));
+    $sqla->renderer($setop => $self->cb('_render_setop'));
+  }
 
-  $self->clause_expanders(
+  my $setop_expander = $self->cb('_expand_clause_setop');
+
+  $sqla->clause_expanders(
     map +($_ => $setop_expander),
       map "select.${_}",
         map +($_, "${_}_all", "${_}_distinct"),
           qw(union intersect except)
   );
 
-  $self->clause_expander('select.with' => my $with_expander = sub {
-    my ($self, $name, $with) = @_;
-    my (undef, $type) = split '_', $name;
-    if (ref($with) eq 'HASH') {
-      return +{
-        %$with,
-        queries => [
-          map +[
-            $self->expand_expr({ -alias => $_->[0] }, -ident),
-            $self->expand_expr($_->[1]),
-          ], @{$with->{queries}}
-        ]
-      }
-    }
-    my @with = @$with;
-    my @exp;
-    while (my ($alias, $query) = splice @with, 0, 2) {
-      push @exp, [
-        $self->expand_expr({ -alias => $alias }, -ident),
-        $self->expand_expr($query)
-      ];
-    }
-    return +(with => { ($type ? (type => $type) : ()), queries => \@exp });
-  });
-  $self->clause_expander('select.with_recursive', $with_expander);
-  $self->clause_renderer('select.with' => my $with_renderer = sub {
-    my ($self, undef, $with) = @_;
-    my $q_part = $self->join_query_parts(', ',
-      map {
-        my ($alias, $query) = @$_;
-        $self->join_query_parts(' ',
-            $alias,
-            $self->format_keyword('as'),
-            $query,
-        )
-      } @{$with->{queries}}
-    );
-    return $self->join_query_parts(' ',
-      $self->format_keyword(join '_', 'with', ($with->{type}||'')),
-      $q_part,
-    );
-  });
+  my $w_exp = $self->cb('_expand_with');
+  my $w_rdr = $self->cb('_render_with');
+  $sqla->clause_expander('select.with' => $w_exp);
+  $sqla->clause_expander('select.with_recursive' => $w_exp);
+  $sqla->clause_renderer('select.with' => $w_rdr);
+
   foreach my $stmt (qw(insert update delete)) {
-    $self->clauses_of($stmt => 'with', $self->clauses_of($stmt));
-    $self->clause_expander("${stmt}.$_", $with_expander)
+    $sqla->clauses_of($stmt => 'with', $sqla->clauses_of($stmt));
+    $sqla->clause_expander("${stmt}.$_" => $w_exp)
       for qw(with with_recursive);
-    $self->clause_renderer("${stmt}.with", $with_renderer);
+    $sqla->clause_renderer("${stmt}.with" => $w_rdr);
   }
-  $self->expander(cast => sub {
-    my ($cast, $to) = @{$_[2]};
-    +{ -func => [ cast => { -as => [
-      $self->expand_expr($cast),
-      $self->expand_expr($to, -ident),
-    ] } ] };
-  });
 
-  return $self;
+  $sqla->clause_expanders(
+    "select.from", $self->cb('_expand_from_list'),
+    "update.target", $self->cb('_expand_update_clause_target'),
+    "update.update", $self->cb('_expand_update_clause_target'),
+  );
+
+  return $sqla;
 }
 
-sub _expand_select_clause_from {
-  my ($self, undef, $from) = @_;
-  +(from => $self->_expand_from_list(undef, $from));
+sub _expand_select {
+  my ($self, $orig, $before_setop, @args) = @_;
+  my $exp = $self->sqla->$orig(@args);
+  return $exp unless my $setop = (my $sel = $exp->{-select})->{setop};
+  if (my @keys = grep $sel->{$_}, @$before_setop) {
+    my %inner; @inner{@keys} = delete @{$sel}{@keys};
+    unshift @{(values(%$setop))[0]{queries}},
+      { -select => \%inner };
+  }
+  return $exp;
 }
 
 sub _expand_from_list {
@@ -250,14 +207,14 @@ sub _render_join {
 
   my @parts = (
     $args->{from},
-    $self->format_keyword(join '_', ($args->{type}||()), 'join'),
+    { -keyword => join '_', ($args->{type}||()), 'join' },
     (map +($_->{-ident} || $_->{-as} ? $_ : ('(', $_, ')')), $args->{to}),
     ($args->{on} ? (
-      $self->format_keyword('on') ,
+      { -keyword => 'on' },
       $args->{on},
     ) : ()),
     ($args->{using} ? (
-      $self->format_keyword('using'),
+      { -keyword => 'using' },
       '(', $args->{using}, ')',
     ) : ()),
   );
@@ -267,7 +224,6 @@ sub _render_join {
 sub _expand_op_as {
   my ($self, undef, $vv, $k) = @_;
   my @vv = (ref($vv) eq 'ARRAY' ? @$vv : $vv);
-  $k ||= shift @vv;
   my $ik = $self->expand_expr($k, -ident);
   return +{ -as => [ $ik, $self->expand_expr($vv[0], -alias) ] }
     if @vv == 1 and ref($vv[0]) eq 'HASH';
@@ -282,7 +238,7 @@ sub _render_as {
   return $self->join_query_parts(
     ' ',
     $thing,
-    $self->format_keyword('as'),
+    { -keyword => 'as' },
     $alias,
   );
 }
@@ -309,4 +265,194 @@ sub _expand_update_clause_target {
   +(target => $self->_expand_from_list(undef, $target));
 }
 
+sub _expand_cast {
+  my ($self, undef, $thing) = @_;
+  return { -func => [ cast => $thing ] } if ref($thing) eq 'HASH';
+  my ($cast, $to) = @{$thing};
+  +{ -func => [ cast => { -as => [
+    $self->expand_expr($cast),
+    $self->expand_expr($to, -ident),
+  ] } ] };
+}
+
+sub _expand_alias {
+  my ($self, undef, $args) = @_;
+  if (ref($args) eq 'HASH' and my $alias = $args->{-alias}) {
+    $args = $alias;
+  }
+  +{ -alias => [
+      map $self->expand_expr($_, -ident),
+      ref($args) eq 'ARRAY' ? @{$args} : $args
+    ]
+  }
+}
+
+sub _expand_with {
+  my ($self, $name, $with) = @_;
+  my (undef, $type) = split '_', $name;
+  if (ref($with) eq 'HASH') {
+    return +{
+      %$with,
+      queries => [
+        map +[
+          $self->expand_expr({ -alias => $_->[0] }, -ident),
+          $self->expand_expr($_->[1]),
+        ], @{$with->{queries}}
+      ]
+    }
+  }
+  my @with = @$with;
+  my @exp;
+  while (my ($alias, $query) = splice @with, 0, 2) {
+    push @exp, [
+      $self->expand_expr({ -alias => $alias }, -ident),
+      $self->expand_expr($query)
+    ];
+  }
+  return +(with => { ($type ? (type => $type) : ()), queries => \@exp });
+}
+
+sub _render_with {
+  my ($self, undef, $with) = @_;
+  my $q_part = $self->join_query_parts(', ',
+    map {
+      my ($alias, $query) = @$_;
+      $self->join_query_parts(' ',
+          $alias,
+          { -keyword => 'as' },
+          $query,
+      )
+    } @{$with->{queries}}
+  );
+  return $self->join_query_parts(' ',
+    { -keyword => join '_', 'with', ($with->{type}||'') },
+    $q_part,
+  );
+}
+
+sub _expand_setop {
+  my ($self, $setop, $args) = @_;
+  +{ "-${setop}" => {
+       %$args,
+       queries => [ map $self->expand_expr($_), @{$args->{queries}} ],
+  } };
+}
+
+sub _render_setop {
+  my ($self, $setop, $args) = @_;
+  $self->join_query_parts(
+    { -keyword => ' '.join('_', $setop, ($args->{type}||())).' ' },
+    @{$args->{queries}}
+  );
+}
+
+sub _expand_clause_setop {
+  my ($self, $setop, $args) = @_;
+  my ($op, $type) = split '_', $setop;
+  +(setop => $self->expand_expr({
+    "-${op}" => {
+      ($type ? (type => $type) : ()),
+      queries => (ref($args) eq 'ARRAY' ? $args : [ $args ])
+    }
+  }));
+}
+
 1;
+
+__END__
+
+=head1 NAME
+
+SQL::Abstract::ExtraClauses - new/experimental additions to L<SQL::Abstract>
+
+=head1 SYNOPSIS
+
+  my $sqla = SQL::Abstract->new;
+  SQL::Abstract::ExtraClauses->apply_to($sqla);
+
+=head1 METHODS
+
+=head2 apply_to
+
+Applies the plugin to an L<SQL::Abstract> object.
+
+=head2 cb
+
+For plugin authors, creates a callback to call a method on the plugin.
+
+=head2 sqla
+
+Available only during plugin callback executions, contains the currently
+active L<SQL::Abstract> object.
+
+=head1 NODE TYPES
+
+=head2 alias
+
+Represents a table alias. Expands name and column names with ident as default.
+
+  # expr
+  { -alias => [ 't', 'x', 'y', 'z' ] }
+
+  # aqt
+  { -alias => [
+      { -ident => [ 't' ] }, { -ident => [ 'x' ] },
+      { -ident => [ 'y' ] }, { -ident => [ 'z' ] },
+  ] }
+
+  # query
+  t(x, y, z)
+  []
+
+=head2 as
+
+Represents an sql AS. LHS is expanded with ident as default, RHS is treated
+as a list of arguments for the alias node.
+
+  # expr
+  { foo => { -as => 'bar' } }
+
+  # aqt
+  { -as =>
+      [
+        { -ident => [ 'foo' ] },
+        { -alias => [ { -ident => [ 'bar' ] } ] },
+      ]
+  }
+
+  # query
+  foo AS bar
+  []
+
+  # expr
+  { -as => [ { -select => { _ => 'blah' } }, 't', 'blah' ] }
+
+  # aqt
+  { -as => [
+      { -select =>
+          { select => { -op => [ ',', { -ident => [ 'blah' ] } ] } }
+      },
+      { -alias => [ { -ident => [ 't' ] }, { -ident => [ 'blah' ] } ] },
+  ] }
+
+  # query
+  (SELECT blah) AS t(blah)
+  []
+
+=head2 cast
+
+  # expr
+  { -cast => [ { -ident => 'birthday' }, 'date' ] }
+
+  # aqt
+  { -func => [
+      'cast', {
+        -as => [ { -ident => [ 'birthday' ] }, { -ident => [ 'date' ] } ]
+      },
+  ] }
+
+  # query
+  CAST(birthday AS date)
+  []
+
+=cut