FilterColumn tweaks - docs and parameter tests
[dbsrgits/DBIx-Class.git] / t / row / filter_column.t
1 use strict;
2 use warnings;
3
4 use Test::More;
5 use Test::Exception;
6 use lib qw(t/lib);
7 use DBICTest;
8
9 my $from_storage_ran = 0;
10 my $to_storage_ran = 0;
11 my $schema = DBICTest->init_schema();
12 DBICTest::Schema::Artist->load_components(qw(FilterColumn InflateColumn));
13 DBICTest::Schema::Artist->filter_column(rank => {
14   filter_from_storage => sub { $from_storage_ran++; $_[1] * 2 },
15   filter_to_storage   => sub { $to_storage_ran++; $_[1] / 2 },
16 });
17 Class::C3->reinitialize();
18
19 my $artist = $schema->resultset('Artist')->create( { rank => 20 } );
20
21 # this should be using the cursor directly, no inflation/processing of any sort
22 my ($raw_db_rank) = $schema->resultset('Artist')
23                              ->search ($artist->ident_condition)
24                                ->get_column('rank')
25                                 ->_resultset
26                                  ->cursor
27                                   ->next;
28
29 is ($raw_db_rank, 10, 'INSERT: correctly unfiltered on insertion');
30
31 for my $reloaded (0, 1) {
32   my $test = $reloaded ? 'reloaded' : 'stored';
33   $artist->discard_changes if $reloaded;
34
35   is( $artist->rank , 20, "got $test filtered rank" );
36 }
37
38 $artist->update;
39 $artist->discard_changes;
40 is( $artist->rank , 20, "got filtered rank" );
41
42 $artist->update ({ rank => 40 });
43 ($raw_db_rank) = $schema->resultset('Artist')
44                              ->search ($artist->ident_condition)
45                                ->get_column('rank')
46                                 ->_resultset
47                                  ->cursor
48                                   ->next;
49 is ($raw_db_rank, 20, 'UPDATE: correctly unflitered on update');
50
51 $artist->discard_changes;
52 $artist->rank(40);
53 ok( !$artist->is_column_changed('rank'), 'column is not dirty after setting the same value' );
54
55 MC: {
56    my $cd = $schema->resultset('CD')->create({
57       artist => { rank => 20 },
58       title => 'fun time city!',
59       year => 'forevertime',
60    });
61    ($raw_db_rank) = $schema->resultset('Artist')
62                                 ->search ($cd->artist->ident_condition)
63                                   ->get_column('rank')
64                                    ->_resultset
65                                     ->cursor
66                                      ->next;
67
68    is $raw_db_rank, 10, 'artist rank gets correctly unfiltered w/ MC';
69    is $cd->artist->rank, 20, 'artist rank gets correctly filtered w/ MC';
70 }
71
72 CACHE_TEST: {
73   my $expected_from = $from_storage_ran;
74   my $expected_to   = $to_storage_ran;
75
76   # ensure we are creating a fresh obj
77   $artist = $schema->resultset('Artist')->single($artist->ident_condition);
78
79   is $from_storage_ran, $expected_from, 'from has not run yet';
80   is $to_storage_ran, $expected_to, 'to has not run yet';
81
82   $artist->rank;
83   cmp_ok (
84     $artist->get_filtered_column('rank'),
85       '!=',
86     $artist->get_column('rank'),
87     'filter/unfilter differ'
88   );
89   is $from_storage_ran, ++$expected_from, 'from ran once, therefor caches';
90   is $to_storage_ran, $expected_to,  'to did not run';
91
92   $artist->rank(6);
93   is $from_storage_ran, $expected_from, 'from did not run';
94   is $to_storage_ran, ++$expected_to,  'to ran once';
95
96   ok ($artist->is_column_changed ('rank'), 'Column marked as dirty');
97
98   $artist->rank;
99   is $from_storage_ran, $expected_from, 'from did not run';
100   is $to_storage_ran, $expected_to,  'to did not run';
101
102   $artist->update;
103
104   $artist->set_column(rank => 3);
105   ok (! $artist->is_column_changed ('rank'), 'Column not marked as dirty on same set_column value');
106   is ($artist->rank, '6', 'Column set properly (cache blown)');
107   is $from_storage_ran, ++$expected_from, 'from ran once (set_column blew cache)';
108   is $to_storage_ran, $expected_to,  'to did not run';
109
110   $artist->rank(6);
111   ok (! $artist->is_column_changed ('rank'), 'Column not marked as dirty on same accessor-set value');
112   is ($artist->rank, '6', 'Column set properly');
113   is $from_storage_ran, $expected_from, 'from did not run';
114   is $to_storage_ran, $expected_to,  'to did not run';
115
116   $artist->store_column(rank => 4);
117   ok (! $artist->is_column_changed ('rank'), 'Column not marked as dirty on differing store_column value');
118   is ($artist->rank, '8', 'Cache properly blown');
119   is $from_storage_ran, ++$expected_from, 'from did not run';
120   is $to_storage_ran, $expected_to,  'to did not run';
121 }
122
123 IC_DIE: {
124   dies_ok {
125      DBICTest::Schema::Artist->inflate_column(rank =>
126         { inflate => sub {}, deflate => sub {} }
127      );
128   } q(Can't inflate column after filter column);
129
130   DBICTest::Schema::Artist->inflate_column(name =>
131      { inflate => sub {}, deflate => sub {} }
132   );
133
134   dies_ok {
135      DBICTest::Schema::Artist->filter_column(name => {
136         filter_to_storage => sub {},
137         filter_from_storage => sub {}
138      });
139   } q(Can't filter column after inflate column);
140 }
141
142 # test when we do not set both filter_from_storage/filter_to_storage
143 DBICTest::Schema::Artist->filter_column(rank => {
144   filter_to_storage => sub { $to_storage_ran++; $_[1] },
145 });
146 Class::C3->reinitialize();
147
148 ASYMMETRIC_TO_TEST: {
149   # initialise value
150   $artist->rank(20);
151   $artist->update;
152
153   my $expected_from = $from_storage_ran;
154   my $expected_to   = $to_storage_ran;
155
156   $artist->rank(10);
157   ok ($artist->is_column_changed ('rank'), 'Column marked as dirty on accessor-set value');
158   is ($artist->rank, '10', 'Column set properly');
159   is $from_storage_ran, $expected_from, 'from did not run';
160   is $to_storage_ran, ++$expected_to,  'to did run';
161
162   $artist->discard_changes;
163
164   is ($artist->rank, '20', 'Column set properly');
165   is $from_storage_ran, $expected_from, 'from did not run';
166   is $to_storage_ran, $expected_to,  'to did not run';
167 }
168
169 DBICTest::Schema::Artist->filter_column(rank => {
170   filter_from_storage => sub { $from_storage_ran++; $_[1] },
171 });
172 Class::C3->reinitialize();
173
174 ASYMMETRIC_FROM_TEST: {
175   # initialise value
176   $artist->rank(23);
177   $artist->update;
178
179   my $expected_from = $from_storage_ran;
180   my $expected_to   = $to_storage_ran;
181
182   $artist->rank(13);
183   ok ($artist->is_column_changed ('rank'), 'Column marked as dirty on accessor-set value');
184   is ($artist->rank, '13', 'Column set properly');
185   is $from_storage_ran, $expected_from, 'from did not run';
186   is $to_storage_ran, $expected_to,  'to did not run';
187
188   $artist->discard_changes;
189
190   is ($artist->rank, '23', 'Column set properly');
191   is $from_storage_ran, ++$expected_from, 'from did run';
192   is $to_storage_ran, $expected_to,  'to did not run';
193 }
194
195 throws_ok { DBICTest::Schema::Artist->filter_column( rank => {} ) }
196   qr/\QAn invocation of filter_column() must specify either a filter_from_storage or filter_to_storage/,
197   'Correctly throws exception for empty attributes'
198 ;
199
200 done_testing;