make sure extraclauses doesn't kill already extant overrides for from
[scpubgit/Q-Branch.git] / t / 04modifiers.t
index 5815af3..027b5d9 100644 (file)
@@ -1,23 +1,30 @@
-#!/usr/bin/perl
-
 use strict;
 use warnings;
 use Test::More;
 use Test::Exception;
-use SQL::Abstract::Test import => ['is_same_sql_bind'];
+use Test::Warn;
+use SQL::Abstract::Test import => [qw(is_same_sql_bind diag_where)];
 
-use Data::Dumper;
 use SQL::Abstract;
+use Storable 'dclone';
+
+#### WARNING ####
+#
+# -nest has been undocumented on purpose, but is still supported for the
+# foreseable future. Do not rip out the -nest tests before speaking to
+# someone on the DBIC mailing list or in irc.perl.org#dbix-class
+#
+#################
 
 =begin
-Test -and -or modifiers, assuming the following:
+Test -and -or and -nest modifiers, assuming the following:
 
   * Modifiers are respected in both hashrefs and arrayrefs (with the obvious
     limitation of one modifier type per hahsref)
-  * When in condition context i.e. where => { -or { a = 1 } }, each modifier
+  * When in condition context i.e. where => { -or => { a = 1 } }, each modifier
     affects only the immediate element following it.
-  * When in column multi-condition context i.e. 
-    where => { x => { '!=', [-and, [qw/1 2 3/]] } }, a modifier affects the
+  * When in column multi-condition context i.e.
+    where => { x => { '!=', [-and => [qw/1 2 3/]] } }, a modifier affects the
     OUTER ARRAYREF if and only if it is the first element of said ARRAYREF
 
 =cut
@@ -67,7 +74,7 @@ my @and_or_tests = (
     %{$and_or_args->{or}},
   },
 
-  # test modifiers within hashrefs 
+  # test modifiers within hashrefs
   {
     where => { -or => [
       [ foo => 1, bar => 2 ],
@@ -83,7 +90,7 @@ my @and_or_tests = (
     %{$and_or_args->{or_and}},
   },
 
-  # test modifiers within arrayrefs 
+  # test modifiers within arrayrefs
   {
     where => [ -or => [
       [ foo => 1, bar => 2 ],
@@ -161,8 +168,8 @@ my @and_or_tests = (
 
   # the -and should affect the OUTER arrayref, while the internal structures remain intact
   {
-    where => { x => [ 
-      -and => [ 1, 2 ], { -like => 'x%' } 
+    where => { x => [
+      -and => [ 1, 2 ], { -like => 'x%' }
     ]},
     stmt => 'WHERE (x = ? OR x = ?) AND x LIKE ?',
     bind => [qw/1 2 x%/],
@@ -208,7 +215,7 @@ my @and_or_tests = (
     bind => [1 .. 13],
   },
 
-  # 1st -and is in column mode, thus flips the entire array, whereas the 
+  # 1st -and is in column mode, thus flips the entire array, whereas the
   # 2nd one is just a condition modifier
   {
     where => [
@@ -299,30 +306,29 @@ my @and_or_tests = (
 );
 
 # modN and mod_N were a bad design decision - they go away in SQLA2, warn now
-# -nest is renamed to -paren
-my @backcompat_mods = (
+my @numbered_mods = (
   {
     backcompat => {
-      -and5 => [a => 10, b => 11],
-      -and_2 => [ c => 20, d => 21 ],
+      -and => [a => 10, b => 11],
+      -and2 => [ c => 20, d => 21 ],
       -nest => [ x => 1 ],
       -nest2 => [ y => 2 ],
-      -or7 => { m => 7, n => 8 },
-      -or_2 => { m => 17, n => 18 },
+      -or => { m => 7, n => 8 },
+      -or2 => { m => 17, n => 18 },
     },
     correct => { -and => [
       -and => [a => 10, b => 11],
       -and => [ c => 20, d => 21 ],
-      -paren => [ x => 1 ],
-      -paren => [ y => 2 ],
+      -nest => [ x => 1 ],
+      -nest => [ y => 2 ],
       -or => { m => 7, n => 8 },
       -or => { m => 17, n => 18 },
     ] },
   },
   {
     backcompat => {
-      -and => [a => 10, b => 11],
-      -and2 => [ c => 20, d => 21 ],
+      -and2 => [a => 10, b => 11],
+      -and_3 => [ c => 20, d => 21 ],
       -nest2 => [ x => 1 ],
       -nest_3 => [ y => 2 ],
       -or2 => { m => 7, n => 8 },
@@ -331,81 +337,78 @@ my @backcompat_mods = (
     correct => [ -and => [
       -and => [a => 10, b => 11],
       -and => [ c => 20, d => 21 ],
-      -paren => [ x => 1 ],
-      -paren => [ y => 2 ],
+      -nest => [ x => 1 ],
+      -nest => [ y => 2 ],
       -or => { m => 7, n => 8 },
       -or => { m => 17, n => 18 },
     ] ],
   },
 );
 
-my @paren_tests = (
+my @nest_tests = (
  {
-   where => {a => 1, -paren => [b => 2, c => 3]},
+   where => {a => 1, -nest => [b => 2, c => 3]},
    stmt  => 'WHERE ( ( (b = ? OR c = ?) AND a = ? ) )',
    bind  => [qw/2 3 1/],
  },
  {
-   where => {a => 1, -paren => {b => 2, c => 3}},
+   where => {a => 1, -nest => {b => 2, c => 3}},
    stmt  => 'WHERE ( ( (b = ? AND c = ?) AND a = ? ) )',
    bind  => [qw/2 3 1/],
  },
  {
-   where => {a => 1, -or => {-paren => {b => 2, c => 3}}},
+   where => {a => 1, -or => {-nest => {b => 2, c => 3}}},
    stmt  => 'WHERE ( ( (b = ? AND c = ?) AND a = ? ) )',
    bind  => [qw/2 3 1/],
  },
  {
-   where => {a => 1, -or => {-paren => [b => 2, c => 3]}},
+   where => {a => 1, -or => {-nest => [b => 2, c => 3]}},
    stmt  => 'WHERE ( ( (b = ? OR c = ?) AND a = ? ) )',
    bind  => [qw/2 3 1/],
  },
  {
-   where => {a => 1, -paren => {-or => {b => 2, c => 3}}},
+   where => {a => 1, -nest => {-or => {b => 2, c => 3}}},
    stmt  => 'WHERE ( ( (b = ? OR c = ?) AND a = ? ) )',
    bind  => [qw/2 3 1/],
  },
  {
-   where => [a => 1, -paren => {b => 2, c => 3}, -paren => [d => 4, e => 5]],
+   where => [a => 1, -nest => {b => 2, c => 3}, -nest => [d => 4, e => 5]],
    stmt  => 'WHERE ( ( a = ? OR ( b = ? AND c = ? ) OR ( d = ? OR e = ? ) ) )',
    bind  => [qw/1 2 3 4 5/],
  },
 );
 
-plan tests => @and_or_tests*3 + @backcompat_mods*4 + @paren_tests*2;
-
 for my $case (@and_or_tests) {
   TODO: {
     local $TODO = $case->{todo} if $case->{todo};
 
-    local $Data::Dumper::Terse = 1;
+    my $sql = SQL::Abstract->new($case->{args} || {});
 
-    my @w;
-    local $SIG{__WARN__} = sub { push @w, @_ };
-    my $sql = SQL::Abstract->new ($case->{args} || {});
-    lives_ok (sub { 
-      my ($stmt, @bind) = $sql->where($case->{where});
-      is_same_sql_bind(
-        $stmt,
-        \@bind,
-        $case->{stmt},
-        $case->{bind},
-      )
-        || diag "Search term:\n" . Dumper $case->{where};
-    });
-    is (@w, 0, 'No warnings within and-or tests')
-      || diag join "\n", 'Emitted warnings:', @w;
+    my $where_copy = dclone($case->{where});
+
+    warnings_are {
+      lives_ok {
+        my ($stmt, @bind) = $sql->where($case->{where});
+        is_same_sql_bind(
+          $stmt,
+          \@bind,
+          $case->{stmt},
+          $case->{bind},
+        ) || (diag_where ( $case->{where} ), diag dumper ([ EXP => $sql->_expand_expr($case->{where}) ]));
+      } || (diag_where ( $case->{where} ), diag dumper ([ EXP => $sql->_expand_expr($case->{where}) ]));
+    } [], 'No warnings within and-or tests';
+
+    is_deeply ($case->{where}, $where_copy, 'Where conditions unchanged');
   }
 }
 
-for my $case (@paren_tests) {
+for my $case (@nest_tests) {
   TODO: {
     local $TODO = $case->{todo} if $case->{todo};
 
     local $SQL::Abstract::Test::parenthesis_significant = 1;
-    local $Data::Dumper::Terse = 1;
 
-    my $sql = SQL::Abstract->new ($case->{args} || {});
+    my $sql = SQL::Abstract->new($case->{args} || {});
     lives_ok (sub {
       my ($stmt, @bind) = $sql->where($case->{where});
       is_same_sql_bind(
@@ -413,48 +416,38 @@ for my $case (@paren_tests) {
         \@bind,
         $case->{stmt},
         $case->{bind},
-      )
-        || diag "Search term:\n" . Dumper $case->{where};
+      ) || (diag_where ( $case->{where} ), diag dumper ([ EXP => $sql->_expand_expr($case->{where}) ]));
     });
   }
 }
 
-my $numw_str = "\QUse of op_N modifiers is deprecated and will be removed in SQLA v2.0\E";
-my $nestw_str = "\QThe -nest modifier is deprecated in favor of -paren and will be removed in SQLA v2.0\E";
-for my $case (@backcompat_mods) {
+for my $case (@numbered_mods) {
   TODO: {
     local $TODO = $case->{todo} if $case->{todo};
 
-    local $Data::Dumper::Terse = 1;
-
-    my $w;
-    local $SIG{__WARN__} = sub {
-      if ($_[0] =~ /$numw_str/) {
-        push @{$w->{num}}, $_[0];
-      }
-      elsif ($_[0] =~ /$nestw_str/) {
-        push @{$w->{nest}}, $_[0];
-      }
-      else {
-        warn $_[0];
-      }
-    };
-    my $sql = SQL::Abstract->new ($case->{args} || {});
-    lives_ok (sub {
+    # not using Test::Warn here - variable amount of warnings
+    my @w;
+    local $SIG{__WARN__} = sub { push @w, @_ };
+
+    my $sql = SQL::Abstract->new($case->{args} || {});
+    lives_ok {
       my ($old_s, @old_b) = $sql->where($case->{backcompat});
       my ($new_s, @new_b) = $sql->where($case->{correct});
       is_same_sql_bind(
         $old_s, \@old_b,
         $new_s, \@new_b,
         'Backcompat and the correct(tm) syntax result in identical statements',
-      ) || diag "Search terms:\n" . Dumper {
-          backcompat => $case->{backcompat},
-          correct => $case->{correct},
-        };
-    });
+      ) || diag_where ( {
+        backcompat => $case->{backcompat},
+        correct => $case->{correct},
+      });
+    };
 
-    is (@{$w->{num} || []}, 5, 'Correct number of warnings were emitted about a mod_N operator');
-    is (@{$w->{nest} || []}, 2, 'Correct number of warnings were emitted about a -nest operator');
+    ok ( (grep
+      { $_ =~ qr/\QUse of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0/ }
+      @w
+    ), 'Warnings were emitted about a mod_N construct');
   }
 }
 
+done_testing;