further andor consolidation
[dbsrgits/SQL-Abstract.git] / lib / SQL / Abstract.pm
index c8f4a7f..b7dab99 100644 (file)
@@ -187,12 +187,11 @@ sub new {
   $opt{expand_unary} = {};
 
   $opt{expand} = {
-    -ident => '_expand_ident',
-    -value => '_expand_value',
     -not => '_expand_not',
     -bool => '_expand_bool',
-    -and => '_expand_andor',
-    -or => '_expand_andor',
+    -and => '_expand_op_andor',
+    -or => '_expand_op_andor',
+    -nest => '_expand_nest',
   };
 
   $opt{expand_op} = {
@@ -200,8 +199,28 @@ sub new {
     'not between' => '_expand_between',
     'in' => '_expand_in',
     'not in' => '_expand_in',
+    'nest' => '_expand_nest',
+    (map +($_ => '_expand_op_andor'),
+      qw(and or)),
   };
 
+  # placeholder for _expand_unop system
+  {
+    my %unops = (-ident => '_expand_ident', -value => '_expand_value');
+    foreach my $name (keys %unops) {
+      $opt{expand}{$name} = $unops{$name};
+      my ($op) = $name =~ /^-(.*)$/;
+      $opt{expand_op}{$op} = sub {
+        my ($self, $op, $arg, $k) = @_;
+        return +{ -op => [
+          $self->{cmp},
+          $self->_expand_ident(-ident => $k),
+          $self->_expand_expr({ '-'.$op => $arg }),
+        ] };
+      };
+    }
+  }
+
   $opt{render} = {
     (map +("-$_", "_render_$_"), qw(op func bind ident literal list)),
     %{$opt{render}||{}}
@@ -543,14 +562,13 @@ sub render_expr {
 }
 
 sub _expand_expr {
-  my ($self, $expr, $logic) = @_;
+  my ($self, $expr) = @_;
   our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
   return undef unless defined($expr);
   if (ref($expr) eq 'HASH') {
     return undef unless my $kc = keys %$expr;
     if ($kc > 1) {
-      $logic ||= 'and';
-      return $self->_expand_andor("-${logic}", $expr);
+      return $self->_expand_op_andor(-and => $expr);
     }
     my ($key, $value) = %$expr;
     if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
@@ -560,11 +578,11 @@ sub _expand_expr {
     if (my $exp = $self->{expand}{$key}) {
       return $self->$exp($key, $value);
     }
-    return $self->_expand_expr_hashpair($key, $value, $logic);
+    return $self->_expand_expr_hashpair($key, $value);
   }
   if (ref($expr) eq 'ARRAY') {
-    my $logic = lc($logic || $self->{logic});
-    return $self->_expand_andor("-${logic}", $expr);
+    my $logic = '-'.lc($self->{logic});
+    return $self->_expand_op_andor($logic, $expr);
   }
   if (my $literal = is_literal_value($expr)) {
     return +{ -literal => $literal };
@@ -579,7 +597,7 @@ sub _expand_expr {
 }
 
 sub _expand_expr_hashpair {
-  my ($self, $k, $v, $logic) = @_;
+  my ($self, $k, $v) = @_;
   unless (defined($k) and length($k)) {
     if (defined($k) and my $literal = is_literal_value($v)) {
       belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
@@ -588,63 +606,16 @@ sub _expand_expr_hashpair {
     puke "Supplying an empty left hand side argument is not supported";
   }
   if ($k =~ /^-/) {
-    $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
-    if ($k eq '-nest') {
-      # DBIx::Class requires a nest warning to be emitted once but the private
-      # method it overrode to do so no longer exists
-      if ($self->{is_dbic_sqlmaker}) {
-        unless (our $Nest_Warned) {
-          belch(
-            "-nest in search conditions is deprecated, you most probably wanted:\n"
-            .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
-          );
-          $Nest_Warned = 1;
-        }
-      }
-      return $self->_expand_expr($v);
-    }
-    if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
-      return +{ -op => [
-        'not',
-        $self->_expand_expr({ "-${rest}", $v }, $logic)
-      ] };
-    }
-    {
-      my $op = $k;
-      $op =~ s/^-// if length($op) > 1;
-
-      # 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
-      if (
-        (our $Expand_Depth) == 1
-        and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
-      ) {
-        puke "Illegal use of top-level '-$op'"
-      }
-      if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
-        return { -op => [ $op, $v ] };
-      }
-    }
-    if ($self->{render}{$k}) {
-      return { $k => $v };
-    }
-    if (
-      ref($v) eq 'HASH'
-      and keys %$v == 1
-      and (keys %$v)[0] =~ /^-/
-    ) {
-      my ($func) = $k =~ /^-(.*)$/;
-      if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
-        return +{ -op => [ $func, $self->_expand_expr($v) ] };
-      }
-      return +{ -func => [ $func, $self->_expand_expr($v) ] };
-    }
-    if (!ref($v) or is_literal_value($v)) {
-      return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
-    }
+    return $self->_expand_expr_hashpair_op($k, $v);
   }
+  return $self->_expand_expr_hashpair_ident($k, $v);
+}
+
+sub _expand_expr_hashpair_ident {
+  my ($self, $k, $v) = @_;
+
+  # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
+
   if (
     !defined($v)
     or (
@@ -655,56 +626,40 @@ sub _expand_expr_hashpair {
   ) {
     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;
-    return +{
-      -op => [
-        $self->{cmp},
-        $self->_expand_ident(-ident => $k),
-        ($d
-          ? $self->_expand_expr($d => $v)
-          : { -bind => [ $k, $v ] }
-        )
-      ]
-    };
+    local our $Cur_Col_Meta = $k;
+    return $self->_expand_expr_hashpair_ident(
+      $k,
+      ($d
+        ? $self->_expand_expr($d => $v)
+        : { -value => $v }
+      )
+    );
   }
   if (ref($v) eq 'HASH') {
     if (keys %$v > 1) {
-      return { -op => [
-        'and',
-        map $self->_expand_expr({ $k => { $_ => $v->{$_} } }),
+      return $self->_expand_op_andor(-and => [
+        map +{ $_ => $v->{$_} },
           sort keys %$v
-      ] };
+      ], $k);
     }
     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 ) {
-      belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
-          . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
+      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 eq 'ident') {
-      if (! defined $vv or (ref($vv) and ref($vv) eq 'ARRAY')) {
-        puke "-$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
-      }
-      return +{ -op => [
-        $self->{cmp},
-        $self->_expand_ident(-ident => $k),
-        $self->_expand_ident(-ident => $vv),
-      ] };
-    }
-    if ($op eq 'value') {
-      return $self->_expand_expr({ $k, undef }) unless defined($vv);
-      return +{ -op => [
-        $self->{cmp},
-        $self->_expand_ident(-ident => $k),
-        { -bind => [ $k, $vv ] }
-      ] };
-    }
     if ($op =~ /^is(?: not)?$/) {
       puke "$op can only take undef as argument"
         if defined($vv)
@@ -713,24 +668,15 @@ sub _expand_expr_hashpair {
              and exists($vv->{-value})
              and !defined($vv->{-value})
            );
-      return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
-    }
-    if ($op =~ /^(and|or)$/) {
-      if (ref($vv) eq 'HASH') {
-        return +{ -op => [
-          $op,
-          map $self->_expand_expr({ $k, { $_ => $vv->{$_} } }),
-            sort keys %$vv
-        ] };
-      }
+      return +{ -op => [ $op.' null', $ik ] };
     }
     if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
-      return { -op => [ $op, $self->_expand_ident(-ident => $k), $vv ] };
+      return { -op => [ $op, $ik, $vv ] };
     }
     if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
       return { -op => [
         $self->{cmp},
-        $self->_expand_ident(-ident => $k),
+        $ik,
         { -op => [ $op, $vv ] }
       ] };
     }
@@ -760,11 +706,10 @@ sub _expand_expr_hashpair {
         : $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 +{ -op => [
-        $logic =~ /^-(.*)$/,
-        map $self->_expand_expr({ $k => { $vk => $_ } }),
+      return $self->_expand_op_andor($logic => [
+        map +{ $vk => $_ },
           @values
-      ] };
+      ], $k);
     }
     if (
       !defined($vv)
@@ -781,26 +726,26 @@ sub _expand_expr_hashpair {
       : $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', $self->_expand_ident(-ident => $k) ] };
+      return +{ -op => [ $is.' null', $ik ] };
     }
     local our $Cur_Col_Meta = $k;
     return +{ -op => [
       $op,
-      $self->_expand_ident(-ident => $k),
+      $ik,
       $self->_expand_expr($vv)
     ] };
   }
   if (ref($v) eq 'ARRAY') {
     return $self->sqlfalse unless @$v;
     $self->_debug("ARRAY($k) means distribute over elements");
-    my $this_logic = lc(
+    my $logic = lc(
       $v->[0] =~ /^-(and|or)$/i
         ? shift(@{$v = [ @$v ]})
-        : '-'.($self->{logic} || 'or')
+        : '-'.lc($self->{logic} || 'OR')
+    );
+    return $self->_expand_op_andor(
+      $logic => $v, $k
     );
-    return $self->_expand_expr({
-      $this_logic => [ map +{ $k => $_ }, @$v ]
-    });
   }
   if (my $literal = is_literal_value($v)) {
     unless (length $k) {
@@ -818,8 +763,72 @@ sub _expand_expr_hashpair {
   die "notreached";
 }
 
+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 })
+  ] };
+  }
+
+  # 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
+    and (keys %$v)[0] =~ /^-/
+  ) {
+    my ($func) = $k =~ /^-(.*)$/;
+    if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
+      return +{ -op => [ $func, $self->_expand_expr($v) ] };
+    }
+    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_ident {
-  my ($self, undef, $body) = @_;
+  my ($self, $op, $body) = @_;
+  unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
+    puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
+  }
   my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
                 ref($body) ? @$body : $body;
   return { -ident => $parts[-1] } if $self->{_dequalify_idents};
@@ -846,18 +855,25 @@ sub _expand_bool {
   return $self->_expand_ident(-ident => $v);
 }
 
-sub _expand_andor {
-  my ($self, $k, $v) = @_;
-  my ($logic) = $k =~ /^-(.*)$/;
+sub _expand_op_andor {
+  my ($self, $logic, $v, $k) = @_;
+  if (defined $k) {
+    $v = [ map +{ $k, $_ },
+             (ref($v) eq 'HASH')
+              ? (map +{ $_ => $v->{$_} }, sort keys %$v)
+              : @$v,
+         ];
+  }
+  my ($logop) = $logic =~ /^-?(.*)$/;
   if (ref($v) eq 'HASH') {
     return +{ -op => [
-      $logic,
-      map $self->_expand_expr({ $_ => $v->{$_} }, $logic),
+      $logop,
+      map $self->_expand_expr({ $_ => $v->{$_} }),
         sort keys %$v
     ] };
   }
   if (ref($v) eq 'ARRAY') {
-    $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
+    $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
 
     my @expr = grep {
       (ref($_) eq 'ARRAY' and @$_)
@@ -887,7 +903,7 @@ sub _expand_andor {
     }
     # ???
     # return $res[0] if @res == 1;
-    return { -op => [ $logic, @res ] };
+    return { -op => [ $logop, @res ] };
   }
   die "notreached";
 }
@@ -942,6 +958,22 @@ sub _expand_in {
   ] };
 }
 
+sub _expand_nest {
+  my ($self, $op, $v) = @_;
+  # DBIx::Class requires a nest warning to be emitted once but the private
+  # method it overrode to do so no longer exists
+  if ($self->{is_dbic_sqlmaker}) {
+    unless (our $Nest_Warned) {
+      belch(
+        "-nest in search conditions is deprecated, you most probably wanted:\n"
+        .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
+      );
+      $Nest_Warned = 1;
+    }
+  }
+  return $self->_expand_expr($v);
+}
+
 sub _recurse_where {
   my ($self, $where, $logic) = @_;