Merge branch 'master' into dq
[dbsrgits/SQL-Abstract.git] / t / 04modifiers.t
old mode 100755 (executable)
new mode 100644 (file)
index 9a3349d..2d88771
@@ -1,13 +1,20 @@
-#!/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 and -nest modifiers, assuming the following:
@@ -16,7 +23,7 @@ Test -and -or and -nest modifiers, assuming the following:
     limitation of one modifier type per hahsref)
   * 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. 
+  * 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
 
@@ -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 ],
@@ -155,14 +162,14 @@ my @and_or_tests = (
     where => { x => {
       -or => { '!=', 1, '>=', 2 }, -like => 'x%'
     }},
-    stmt => 'WHERE (x != ? OR x >= ?) AND x LIKE ?',
-    bind => [qw/1 2 x%/],
+    stmt => 'WHERE x LIKE ? AND ( x != ? OR x >= ? )',
+    bind => [qw/x% 1 2/],
   },
 
   # 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%/],
@@ -176,8 +183,8 @@ my @and_or_tests = (
 
   {
     where => { -and => [a => 1, b => 2, k => [11, 12] ], x => 9, -or => { c => 3, d => 4, l => { '=' => [21, 22] } } },
-    stmt => 'WHERE a = ? AND b = ? AND (k = ? OR k = ?) AND ((l = ? OR l = ?) OR c = ? OR d = ? ) AND x = ?',
-    bind => [qw/1 2 11 12 21 22 3 4 9/],
+    stmt => 'WHERE a = ? AND b = ? AND (k = ? OR k = ?) AND (c = ? OR d = ? OR (l = ? OR l = ?) ) AND x = ?',
+    bind => [qw/1 2 11 12 3 4 21 22 9/],
   },
 
   {
@@ -196,8 +203,8 @@ my @and_or_tests = (
     # explicit OR logic in arrays should leave everything intact
     args => { logic => 'or' },
     where => { -and => [a => 1, b => 2, k => [11, 12] ], x => 9, -or => { c => 3, d => 4, l => { '=' => [21, 22] } }  },
-    stmt => 'WHERE a = ? AND b = ? AND (k = ? OR k = ?) AND ( l = ? OR l = ? OR c = ? OR d = ? ) AND x = ? ',
-    bind => [qw/1 2 11 12 21 22 3 4 9/],
+    stmt => 'WHERE a = ? AND b = ? AND (k = ? OR k = ?) AND ( c = ? OR d = ? OR l = ? OR l = ? ) AND x = ? ',
+    bind => [qw/1 2 11 12 3 4 21 22 9/],
   },
 
   {
@@ -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 => [
@@ -298,10 +305,9 @@ my @and_or_tests = (
   },
 );
 
-# modN and mod_N were a bad design decision - they go away in SQLA2, warn now
-my @numbered_mods = (
-  {
-    backcompat => {
+# modN and mod_N were a bad design decision - they went away
+my @invalid_numbered_mods = (
+    {
       -and => [a => 10, b => 11],
       -and2 => [ c => 20, d => 21 ],
       -nest => [ x => 1 ],
@@ -309,17 +315,7 @@ my @numbered_mods = (
       -or => { m => 7, n => 8 },
       -or2 => { m => 17, n => 18 },
     },
-    correct => { -and => [
-      -and => [a => 10, b => 11],
-      -and => [ c => 20, d => 21 ],
-      -nest => [ x => 1 ],
-      -nest => [ y => 2 ],
-      -or => { m => 7, n => 8 },
-      -or => { m => 17, n => 18 },
-    ] },
-  },
-  {
-    backcompat => {
+    {
       -and2 => [a => 10, b => 11],
       -and_3 => [ c => 20, d => 21 ],
       -nest2 => [ x => 1 ],
@@ -327,71 +323,111 @@ my @numbered_mods = (
       -or2 => { m => 7, n => 8 },
       -or_3 => { m => 17, n => 18 },
     },
-    correct => [ -and => [
-      -and => [a => 10, b => 11],
-      -and => [ c => 20, d => 21 ],
-      -nest => [ x => 1 ],
-      -nest => [ y => 2 ],
-      -or => { m => 7, n => 8 },
-      -or => { m => 17, n => 18 },
-    ] ],
-  },
 );
 
-plan tests => @and_or_tests*3 + @numbered_mods*4;
+my @nest_tests = (
+ {
+   where => {a => 1, -nest => [b => 2, c => 3]},
+   stmt  => 'WHERE ( ( (b = ? OR c = ?) AND a = ? ) )',
+   bind  => [qw/2 3 1/],
+ },
+ {
+   where => {a => 1, -nest => {b => 2, c => 3}},
+   stmt  => 'WHERE ( ( b = ? AND c = ? AND a = ? ) )',
+   bind  => [qw/2 3 1/],
+ },
+ {
+   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 => {-nest => [b => 2, c => 3]}},
+   stmt  => 'WHERE ( ( (b = ? OR c = ?) AND a = ? ) )',
+   bind  => [qw/2 3 1/],
+ },
+ {
+   where => {a => 1, -nest => {-or => {b => 2, c => 3}}},
+   stmt  => 'WHERE ( ( (b = ? OR c = ?) AND a = ? ) )',
+   bind  => [qw/2 3 1/],
+ },
+ {
+   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/],
+ },
+ {
+   where => { -and => [
+    -and => [a => 10, b => 11],
+    -and => [ c => 20, d => 21 ],
+    -nest => [ x => 1 ],
+    -nest => [ y => 2 ],
+    -or => { m => 7, n => 8 },
+    -or => { m => 17, n => 18 },
+   ] },
+   stmt => 'WHERE ( ( a = ? AND b = ? AND c = ? AND d = ? AND ( x = ? ) AND ( y = ? ) AND ( m = ? OR n = ? ) AND ( m = ? OR n = ? ) ) )',
+   bind => [ 10, 11, 20, 21, 1, 2, 7, 8, 17, 18 ],
+ },
+ {
+   where => [ -and => [
+    -and => [a => 10, b => 11],
+    -and => [ c => 20, d => 21 ],
+    -nest => [ x => 1 ],
+    -nest => [ y => 2 ],
+    -or => { m => 7, n => 8 },
+    -or => { m => 17, n => 18 },
+   ] ],
+   stmt => 'WHERE ( ( ( a = ? AND b = ? AND c = ? AND d = ? AND ( x = ? ) AND ( y = ? ) AND ( m = ? OR n = ? ) AND ( m = ? OR n = ? ) ) ) )',
+   bind => [ 10, 11, 20, 21, 1, 2, 7, 8, 17, 18 ],
+ },
+);
 
 for my $case (@and_or_tests) {
   TODO: {
     local $TODO = $case->{todo} if $case->{todo};
 
-    local $Data::Dumper::Terse = 1;
-
-    my @w;
-    local $SIG{__WARN__} = sub { push @w, @_ };
     my $sql = SQL::Abstract->new ($case->{args} || {});
-    lives_ok (sub { 
+
+    my $where_copy = dclone($case->{where});
+
+    warnings_are {
       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;
+      ) || diag_where( $case->{where} );
+    } [], 'No warnings within and-or tests';
+
+    is_deeply ($case->{where}, $where_copy, 'Where conditions unchanged');
   }
 }
 
-my $w_str = "\QUse of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0\E";
-for my $case (@numbered_mods) {
-    local $Data::Dumper::Terse = 1;
+for my $case (@nest_tests) {
+  TODO: {
+    local $TODO = $case->{todo} if $case->{todo};
+
+    local $SQL::Abstract::Test::parenthesis_significant = 1;
 
-    my @w;
-    local $SIG{__WARN__} = sub { push @w, @_ };
     my $sql = SQL::Abstract->new ($case->{args} || {});
     lives_ok (sub {
-      my ($old_s, @old_b) = $sql->where($case->{backcompat});
-      my ($new_s, @new_b) = $sql->where($case->{correct});
+      my ($stmt, @bind) = $sql->where($case->{where});
       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},
-        };
+        $stmt,
+        \@bind,
+        $case->{stmt},
+        $case->{bind},
+      ) || diag_where ( $case->{where} );
     });
+  }
+}
 
-    ok (@w, 'Warnings were emitted about a mod_N construct');
-
-    my @non_match;
-    for (@w) {
-      push @non_match, $_ if ($_ !~ /$w_str/);
-    }
-
-    is (@non_match, 0, 'All warnings match the deprecation message')
-      || diag join "\n", 'Rogue warnings:', @non_match;
+for my $case (@invalid_numbered_mods) {
+    my $sql = SQL::Abstract->new ($case->{args} || {});
+    throws_ok (sub {
+      $sql->where($case);
+    }, qr/\QUse of [and|or|nest]_N modifiers is no longer supported/, 'Exception thrown on bogus syntax');
 }
 
+done_testing;