everything else is notreached, so rename unhandled to notreached
[scpubgit/Q-Branch.git] / lib / SQL / Abstract.pm
index b2cca87..077fa43 100644 (file)
@@ -200,8 +200,8 @@ sub new {
     'in' => '_expand_in',
     'not in' => '_expand_in',
     'nest' => '_expand_nest',
-    (map +($_ => '_expand_op_andor'),
-      qw(and or)),
+    (map +($_ => '_expand_op_andor'), ('and', 'or')),
+    (map +($_ => '_expand_op_is'), ('is', 'is not')),
   };
 
   # placeholder for _expand_unop system
@@ -226,7 +226,15 @@ sub new {
     %{$opt{render}||{}}
   };
 
-  $opt{render_op} = our $RENDER_OP;
+  $opt{render_op} = {
+    (map +($_ => '_render_op_between'), 'between', 'not between'),
+    (map +($_ => '_render_op_in'), 'in', 'not in'),
+    (map +($_ => '_render_unop_postfix'),
+      'is null', 'is not null', 'asc', 'desc',
+    ),
+    (not => '_render_op_not'),
+    (map +($_ => '_render_op_andor'), qw(and or)),
+  };
 
   return bless \%opt, $class;
 }
@@ -613,6 +621,15 @@ sub _expand_expr_hashpair {
 
 sub _expand_expr_hashpair_ident {
   my ($self, $k, $v) = @_;
+
+  # hash with multiple or no elements is andor
+
+  if (ref($v) eq 'HASH' and keys %$v != 1) {
+    return $self->_expand_op_andor(-and => $v, $k);
+  }
+
+  # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
+
   if (
     !defined($v)
     or (
@@ -623,7 +640,9 @@ sub _expand_expr_hashpair_ident {
   ) {
     return $self->_expand_expr({ $k => { $self->{cmp} => undef } });
   }
-  my $ik = $self->_expand_ident(-ident => $k);
+
+  # scalars and objects get expanded as whatever requested or values
+
   if (!ref($v) or Scalar::Util::blessed($v)) {
     my $d = our $Default_Scalar_To;
     local our $Cur_Col_Meta = $k;
@@ -636,97 +655,7 @@ sub _expand_expr_hashpair_ident {
     );
   }
   if (ref($v) eq 'HASH') {
-    if (keys %$v > 1) {
-      return $self->_expand_op_andor(-and => [
-        map +{ $k => { $_ => $v->{$_} } },
-          sort keys %$v
-      ]);
-    }
-    return undef unless keys %$v;
-    my ($vk, $vv) = %$v;
-    my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
-    $self->_assert_pass_injection_guard($op);
-    if ($op =~ s/ [_\s]? \d+ $//x ) {
-      return $self->_expand_expr($k, $v);
-    }
-    if (my $x = $self->{expand_op}{$op}) {
-      local our $Cur_Col_Meta = $k;
-      return $self->$x($op, $vv, $k);
-    }
-    if ($op =~ /^is(?: not)?$/) {
-      puke "$op can only take undef as argument"
-        if defined($vv)
-           and not (
-             ref($vv) eq 'HASH'
-             and exists($vv->{-value})
-             and !defined($vv->{-value})
-           );
-      return +{ -op => [ $op.' null', $ik ] };
-    }
-    if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
-      return { -op => [ $op, $ik, $vv ] };
-    }
-    if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
-      return { -op => [
-        $self->{cmp},
-        $ik,
-        { -op => [ $op, $vv ] }
-      ] };
-    }
-    if (ref($vv) eq 'ARRAY') {
-      my ($logic, @values) = (
-        (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
-          ? @$vv
-          : (-or => @$vv)
-      );
-      if (
-        $op =~ $self->{inequality_op}
-        or $op =~ $self->{not_like_op}
-      ) {
-        if (lc($logic) eq '-or' and @values > 1) {
-          belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
-              . 'is technically equivalent to an always-true 1=1 (you probably wanted '
-              . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
-          ;
-        }
-      }
-      unless (@values) {
-        # try to DWIM on equality operators
-        return
-          $op =~ $self->{equality_op}   ? $self->sqlfalse
-        : $op =~ $self->{like_op}       ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
-        : $op =~ $self->{inequality_op} ? $self->sqltrue
-        : $op =~ $self->{not_like_op}   ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
-        : puke "operator '$op' applied on an empty array (field '$k')";
-      }
-      return $self->_expand_op_andor($logic => [
-        map +{ $vk => $_ },
-          @values
-      ], $k);
-    }
-    if (
-      !defined($vv)
-      or (
-        ref($vv) eq 'HASH'
-        and exists $vv->{-value}
-        and not defined $vv->{-value}
-      )
-    ) {
-      my $is =
-        $op =~ /^not$/i               ? 'is not'  # legacy
-      : $op =~ $self->{equality_op}   ? 'is'
-      : $op =~ $self->{like_op}       ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
-      : $op =~ $self->{inequality_op} ? 'is not'
-      : $op =~ $self->{not_like_op}   ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
-      : puke "unexpected operator '$op' with undef operand";
-      return +{ -op => [ $is.' null', $ik ] };
-    }
-    local our $Cur_Col_Meta = $k;
-    return +{ -op => [
-      $op,
-      $ik,
-      $self->_expand_expr($vv)
-    ] };
+    return $self->_expand_expr_hashtriple($k, %$v);
   }
   if (ref($v) eq 'ARRAY') {
     return $self->sqlfalse unless @$v;
@@ -737,7 +666,7 @@ sub _expand_expr_hashpair_ident {
         : '-'.lc($self->{logic} || 'OR')
     );
     return $self->_expand_op_andor(
-      $logic => [ map +{ $k => $_ }, @$v ]
+      $logic => $v, $k
     );
   }
   if (my $literal = is_literal_value($v)) {
@@ -758,31 +687,44 @@ sub _expand_expr_hashpair_ident {
 
 sub _expand_expr_hashpair_op {
   my ($self, $k, $v) = @_;
+
   my $op = $k;
   $op =~ s/^-// if length($op) > 1;
   $self->_assert_pass_injection_guard($op);
+
+  # Ops prefixed with -not_ get converted
+
   if (my ($rest) = $op =~/^not[_ ](.*)$/) {
     return +{ -op => [
       'not',
       $self->_expand_expr({ "-${rest}", $v })
   ] };
   }
-  # top level special ops are illegal in general
-  # note that, arguably, if it makes no sense at top level, it also
-  # makes no sense on the other side of an = sign or similar but DBIC
-  # gets disappointingly upset if I disallow it
+
+  # the old special op system requires illegality for top-level use
+
   if (
     (our $Expand_Depth) == 1
     and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
   ) {
     puke "Illegal use of top-level '-$op'"
   }
+
+  # the old unary op system means we should touch nothing and let it work
+
   if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
     return { -op => [ $op, $v ] };
   }
+
+  # an explicit node type is currently assumed to be expanded (this is almost
+  # certainly wrong and there should be expansion anyway)
+
   if ($self->{render}{$k}) {
     return { $k => $v };
   }
+
+  # hashref RHS values get expanded and used as op/func args
+
   if (
     ref($v) eq 'HASH'
     and keys %$v == 1
@@ -794,12 +736,93 @@ sub _expand_expr_hashpair_op {
     }
     return +{ -func => [ $func, $self->_expand_expr($v) ] };
   }
+
+  # scalars and literals get simply expanded
+
   if (!ref($v) or is_literal_value($v)) {
     return +{ -op => [ $op, $self->_expand_expr($v) ] };
   }
+
   die "notreached";
 }
 
+sub _expand_expr_hashtriple {
+  my ($self, $k, $vk, $vv) = @_;
+
+  my $ik = $self->_expand_ident(-ident => $k);
+
+  my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
+  $self->_assert_pass_injection_guard($op);
+  if ($op =~ s/ [_\s]? \d+ $//x ) {
+    return $self->_expand_expr($k, { $vk, $vv });
+  }
+  if (my $x = $self->{expand_op}{$op}) {
+    local our $Cur_Col_Meta = $k;
+    return $self->$x($op, $vv, $k);
+  }
+  if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
+    return { -op => [ $op, $ik, $vv ] };
+  }
+  if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
+    return { -op => [
+      $self->{cmp},
+      $ik,
+      { -op => [ $op, $vv ] }
+    ] };
+  }
+  if (ref($vv) eq 'ARRAY') {
+    my @raw = @$vv;
+    my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
+      ? shift @raw : '-or';
+    my @values = map +{ $vk => $_ }, @raw;
+    if (
+      $op =~ $self->{inequality_op}
+      or $op =~ $self->{not_like_op}
+    ) {
+      if (lc($logic) eq '-or' and @values > 1) {
+        belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
+            . 'is technically equivalent to an always-true 1=1 (you probably wanted '
+            . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
+        ;
+      }
+    }
+    unless (@values) {
+      # try to DWIM on equality operators
+      return
+        $op =~ $self->{equality_op}   ? $self->sqlfalse
+      : $op =~ $self->{like_op}       ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
+      : $op =~ $self->{inequality_op} ? $self->sqltrue
+      : $op =~ $self->{not_like_op}   ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
+      : puke "operator '$op' applied on an empty array (field '$k')";
+    }
+    return $self->_expand_op_andor($logic => \@values, $k);
+  }
+  if (
+    !defined($vv)
+    or (
+      ref($vv) eq 'HASH'
+      and exists $vv->{-value}
+      and not defined $vv->{-value}
+    )
+  ) {
+    my $is =
+      $op =~ /^not$/i               ? 'is not'  # legacy
+    : $op =~ $self->{equality_op}   ? 'is'
+    : $op =~ $self->{like_op}       ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
+    : $op =~ $self->{inequality_op} ? 'is not'
+    : $op =~ $self->{not_like_op}   ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
+    : puke "unexpected operator '$op' with undef operand";
+
+    return $self->_expand_expr_hashpair($k => { $is, undef });
+  }
+  local our $Cur_Col_Meta = $k;
+  return +{ -op => [
+    $op,
+    $ik,
+    $self->_expand_expr($vv)
+  ] };
+}
+
 sub _expand_ident {
   my ($self, $op, $body) = @_;
   unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
@@ -842,6 +865,7 @@ sub _expand_op_andor {
   }
   my ($logop) = $logic =~ /^-?(.*)$/;
   if (ref($v) eq 'HASH') {
+    return undef unless keys %$v;
     return +{ -op => [
       $logop,
       map $self->_expand_expr({ $_ => $v->{$_} }),
@@ -884,6 +908,18 @@ sub _expand_op_andor {
   die "notreached";
 }
 
+sub _expand_op_is {
+  my ($self, $op, $vv, $k) = @_;
+  puke "$op can only take undef as argument"
+    if defined($vv)
+       and not (
+         ref($vv) eq 'HASH'
+         and exists($vv->{-value})
+         and !defined($vv->{-value})
+       );
+  return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
+}
+
 sub _expand_between {
   my ($self, $op, $vv, $k) = @_;
   local our $Cur_Col_Meta = $k;
@@ -1008,63 +1044,68 @@ sub _render_literal {
   return @$literal;
 }
 
-our $RENDER_OP = {
-  (map +($_ => sub {
-    my ($self, $op, $args) = @_;
-    my ($left, $low, $high) = @$args;
-    my ($rhsql, @rhbind) = do {
-      if (@$args == 2) {
-        puke "Single arg to between must be a literal"
-          unless $low->{-literal};
-        @{$low->{-literal}}
-      } else {
-        my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
-        (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
-         @{$l}[1..$#$l], @{$h}[1..$#$h])
-      }
-    };
-    my ($lhsql, @lhbind) = $self->render_aqt($left);
-    return (
-      join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
-      @lhbind, @rhbind
-    );
-  }), 'between', 'not between'),
-  (map +($_ => sub {
-    my ($self, $op, $args) = @_;
-    my ($lhs, $rhs) = @$args;
-    my @in_bind;
-    my @in_sql = map {
-      my ($sql, @bind) = $self->render_aqt($_);
-      push @in_bind, @bind;
-      $sql;
-    } @$rhs;
-    my ($lhsql, @lbind) = $self->render_aqt($lhs);
-    return (
-      $lhsql.' '.$self->_sqlcase($op).' ( '
-      .join(', ', @in_sql)
-      .' )',
-      @lbind, @in_bind
-    );
-  }), 'in', 'not in'),
-  (map +($_ => '_render_unop_postfix'),
-    'is null', 'is not null', 'asc', 'desc',
-  ),
-  (not => '_render_op_not'),
-  (map +($_ => sub {
-    my ($self, $op, $args) = @_;
-    my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
-    return '' unless @parts;
-    return @{$parts[0]} if @parts == 1;
-    my ($final_sql) = join(
-      ' '.$self->_sqlcase($op).' ',
-      map $_->[0], @parts
-    );
-    return (
-      '('.$final_sql.')',
-      map @{$_}[1..$#$_], @parts
-    );
-  }), qw(and or)),
-};
+sub _render_op_between {
+  my ($self, $op, $args) = @_;
+  my ($left, $low, $high) = @$args;
+  my ($rhsql, @rhbind) = do {
+    if (@$args == 2) {
+      puke "Single arg to between must be a literal"
+        unless $low->{-literal};
+      @{$low->{-literal}}
+    } else {
+      my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
+      (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
+       @{$l}[1..$#$l], @{$h}[1..$#$h])
+    }
+  };
+  my ($lhsql, @lhbind) = $self->render_aqt($left);
+  return (
+    join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
+    @lhbind, @rhbind
+  );
+}
+
+sub _render_op_in {
+  my ($self, $op, $args) = @_;
+  my ($lhs, $rhs) = @$args;
+  my @in_bind;
+  my @in_sql = map {
+    my ($sql, @bind) = $self->render_aqt($_);
+    push @in_bind, @bind;
+    $sql;
+  } @$rhs;
+  my ($lhsql, @lbind) = $self->render_aqt($lhs);
+  return (
+    $lhsql.' '.$self->_sqlcase($op).' ( '
+    .join(', ', @in_sql)
+    .' )',
+    @lbind, @in_bind
+  );
+}
+
+sub _render_op_andor {
+  my ($self, $op, $args) = @_;
+  my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
+  return '' unless @parts;
+  return @{$parts[0]} if @parts == 1;
+  my ($sql, @bind) = $self->_render_op_multop($op, $args);
+  return '( '.$sql.' )', @bind;
+}
+
+sub _render_op_multop {
+  my ($self, $op, $args) = @_;
+  my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
+  return '' unless @parts;
+  return @{$parts[0]} if @parts == 1;
+  my ($final_sql) = join(
+    ' '.$self->_sqlcase($op).' ',
+    map $_->[0], @parts
+  );
+  return (
+    $final_sql,
+    map @{$_}[1..$#$_], @parts
+  );
+}
 
 sub _render_op {
   my ($self, $v) = @_;
@@ -1086,18 +1127,9 @@ sub _render_op {
   if (@args == 1) {
     return $self->_render_unop_prefix($op, \@args);
   } else {
-     my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @args;
-     return '' unless @parts;
-     my ($final_sql) = join(
-       ' '.$self->_sqlcase($op).' ',
-       map $_->[0], @parts
-     );
-     return (
-       $final_sql,
-       map @{$_}[1..$#$_], @parts
-     );
-  }
-  die "unhandled";
+    return $self->_render_op_multop($op, \@args);
+  }
+  die "notreached";
 }
 
 sub _render_op_not {