Deprecate rolled-out hash-condition in search()
[dbsrgits/DBIx-Class.git] / t / 60core.t
1 use strict;
2 use warnings;
3
4 use Test::More;
5 use Test::Exception;
6 use Test::Warn;
7 use lib qw(t/lib);
8 use DBICTest;
9 use DBIC::SqlMakerTest;
10
11 my $schema = DBICTest->init_schema();
12
13 eval { require DateTime::Format::SQLite };
14 my $NO_DTFM = $@ ? 1 : 0;
15
16 my @art = $schema->resultset("Artist")->search({ }, { order_by => 'name DESC'});
17
18 is(@art, 3, "Three artists returned");
19
20 my $art = $art[0];
21
22 is($art->name, 'We Are Goth', "Correct order too");
23
24 $art->name('We Are In Rehab');
25
26 is($art->name, 'We Are In Rehab', "Accessor update ok");
27
28 my %dirty = $art->get_dirty_columns();
29 is(scalar(keys(%dirty)), 1, '1 dirty column');
30 ok(grep($_ eq 'name', keys(%dirty)), 'name is dirty');
31
32 is($art->get_column("name"), 'We Are In Rehab', 'And via get_column');
33
34 ok($art->update, 'Update run');
35
36 my %not_dirty = $art->get_dirty_columns();
37 is(scalar(keys(%not_dirty)), 0, 'Nothing is dirty');
38
39 throws_ok ( sub {
40   my $ret = $art->make_column_dirty('name2');
41 }, qr/No such column 'name2'/, 'Failed to make non-existent column dirty');
42
43 $art->make_column_dirty('name');
44 my %fake_dirty = $art->get_dirty_columns();
45 is(scalar(keys(%fake_dirty)), 1, '1 fake dirty column');
46 ok(grep($_ eq 'name', keys(%fake_dirty)), 'name is fake dirty');
47
48 ok($art->update, 'Update run');
49
50 my $record_jp = $schema->resultset("Artist")->search(undef, { join => 'cds' })->search(undef, { prefetch => 'cds' })->next;
51
52 ok($record_jp, "prefetch on same rel okay");
53
54 my $record_fn = $schema->resultset("Artist")->search(undef, { join => 'cds' })->search({'cds.cdid' => '1'}, {join => 'artist_undirected_maps'})->next;
55
56 ok($record_fn, "funny join is okay");
57
58 @art = $schema->resultset("Artist")->search({ name => 'We Are In Rehab' });
59
60 is(@art, 1, "Changed artist returned by search");
61
62 is($art[0]->artistid, 3,'Correct artist too');
63
64 lives_ok (sub { $art->delete }, 'Cascading delete on Ordered has_many works' );  # real test in ordered.t
65
66 @art = $schema->resultset("Artist")->search({ });
67
68 is(@art, 2, 'And then there were two');
69
70 is($art->in_storage, 0, "It knows it's dead");
71
72 lives_ok { $art->update } 'No changes so update should be OK';
73
74 dies_ok ( sub { $art->delete }, "Can't delete twice");
75
76 is($art->name, 'We Are In Rehab', 'But the object is still live');
77
78 $art->insert;
79
80 ok($art->in_storage, "Re-created");
81
82 @art = $schema->resultset("Artist")->search({ });
83
84 is(@art, 3, 'And now there are three again');
85
86 my $new = $schema->resultset("Artist")->create({ artistid => 4 });
87
88 is($new->artistid, 4, 'Create produced record ok');
89
90 @art = $schema->resultset("Artist")->search({ });
91
92 is(@art, 4, "Oh my god! There's four of them!");
93
94 $new->set_column('name' => 'Man With A Fork');
95
96 is($new->name, 'Man With A Fork', 'set_column ok');
97
98 $new->discard_changes;
99
100 ok(!defined $new->name, 'Discard ok');
101
102 $new->name('Man With A Spoon');
103
104 $new->update;
105
106 my $new_again = $schema->resultset("Artist")->find(4);
107
108 is($new_again->name, 'Man With A Spoon', 'Retrieved correctly');
109
110 is($new_again->ID, 'DBICTest::Artist|artist|artistid=4', 'unique object id generated correctly');
111
112 # test that store_column is called once for create() for non sequence columns 
113 {
114   ok(my $artist = $schema->resultset('Artist')->create({name => 'store_column test'}));
115   is($artist->name, 'X store_column test'); # used to be 'X X store...'
116
117   # call store_column even though the column doesn't seem to be dirty
118   $artist->name($artist->name);
119   is($artist->name, 'X X store_column test');
120   ok($artist->is_column_changed('name'), 'changed column marked as dirty');
121
122   $artist->delete;
123 }
124
125 # deprecation of rolled-out search
126 warnings_exist {
127   $schema->resultset('Artist')->search_rs(id => 4)
128 } qr/\Qsearch( %condition ) is deprecated/, 'Deprecation warning on ->search( %condition )';
129
130 # this has been warning for 4 years, killing
131 throws_ok {
132   $schema->resultset('Artist')->find(artistid => 4);
133 } qr|expects either a column/value hashref, or a list of values corresponding to the columns of the specified unique constraint|;
134
135 is($schema->resultset("Artist")->count, 4, 'count ok');
136
137 # test find_or_new
138 {
139   my $existing_obj = $schema->resultset('Artist')->find_or_new({
140     artistid => 4,
141   });
142
143   is($existing_obj->name, 'Man With A Spoon', 'find_or_new: found existing artist');
144   ok($existing_obj->in_storage, 'existing artist is in storage');
145
146   my $new_obj = $schema->resultset('Artist')->find_or_new({
147     artistid => 5,
148     name     => 'find_or_new',
149   });
150
151   is($new_obj->name, 'find_or_new', 'find_or_new: instantiated a new artist');
152   is($new_obj->in_storage, 0, 'new artist is not in storage');
153 }
154
155 my $cd = $schema->resultset("CD")->find(1);
156 my %cols = $cd->get_columns;
157
158 is(keys %cols, 6, 'get_columns number of columns ok');
159
160 is($cols{title}, 'Spoonful of bees', 'get_columns values ok');
161
162 %cols = ( title => 'Forkful of bees', year => 2005);
163 $cd->set_columns(\%cols);
164
165 is($cd->title, 'Forkful of bees', 'set_columns ok');
166
167 is($cd->year, 2005, 'set_columns ok');
168
169 $cd->discard_changes;
170
171 # check whether ResultSource->columns returns columns in order originally supplied
172 my @cd = $schema->source("CD")->columns;
173
174 is_deeply( \@cd, [qw/cdid artist title year genreid single_track/], 'column order');
175
176 $cd = $schema->resultset("CD")->search({ title => 'Spoonful of bees' }, { columns => ['title'] })->next;
177 is($cd->title, 'Spoonful of bees', 'subset of columns returned correctly');
178
179 $cd = $schema->resultset("CD")->search(undef, { include_columns => [ 'artist.name' ], join => [ 'artist' ] })->find(1);
180
181 is($cd->title, 'Spoonful of bees', 'Correct CD returned with include');
182 is($cd->get_column('name'), 'Caterwauler McCrae', 'Additional column returned');
183
184 # check if new syntax +columns also works for this
185 $cd = $schema->resultset("CD")->search(undef, { '+columns' => [ 'artist.name' ], join => [ 'artist' ] })->find(1);
186
187 is($cd->title, 'Spoonful of bees', 'Correct CD returned with include');
188 is($cd->get_column('name'), 'Caterwauler McCrae', 'Additional column returned');
189
190 # check if new syntax for +columns select specifiers works for this
191 $cd = $schema->resultset("CD")->search(undef, { '+columns' => [ {artist_name => 'artist.name'} ], join => [ 'artist' ] })->find(1);
192
193 is($cd->title, 'Spoonful of bees', 'Correct CD returned with include');
194 is($cd->get_column('artist_name'), 'Caterwauler McCrae', 'Additional column returned');
195
196 # update_or_insert
197 $new = $schema->resultset("Track")->new( {
198   trackid => 100,
199   cd => 1,
200   title => 'Insert or Update',
201   last_updated_on => '1973-07-19 12:01:02'
202 } );
203 $new->update_or_insert;
204 ok($new->in_storage, 'update_or_insert insert ok');
205
206 # test in update mode
207 $new->title('Insert or Update - updated');
208 $new->update_or_insert;
209 is( $schema->resultset("Track")->find(100)->title, 'Insert or Update - updated', 'update_or_insert update ok');
210
211 # get_inflated_columns w/relation and accessor alias
212 SKIP: {
213     skip "This test requires DateTime::Format::SQLite", 8 if $NO_DTFM;
214
215     isa_ok($new->updated_date, 'DateTime', 'have inflated object via accessor');
216     my %tdata = $new->get_inflated_columns;
217     is($tdata{'trackid'}, 100, 'got id');
218     isa_ok($tdata{'cd'}, 'DBICTest::CD', 'cd is CD object');
219     is($tdata{'cd'}->id, 1, 'cd object is id 1');
220     is(
221         $tdata{'position'},
222         $schema->resultset ('Track')->search ({cd => 1})->count,
223         'Ordered assigned proper position',
224     );
225     is($tdata{'title'}, 'Insert or Update - updated');
226     is($tdata{'last_updated_on'}, '1973-07-19T12:01:02');
227     isa_ok($tdata{'last_updated_on'}, 'DateTime', 'inflated accessored column');
228 }
229
230 throws_ok (sub {
231   $schema->class("Track")->load_components('DoesNotExist');
232 }, qr!Can't locate DBIx/Class/DoesNotExist.pm!, 'exception on nonexisting component');
233
234 is($schema->class("Artist")->field_name_for->{name}, 'artist name', 'mk_classdata usage ok');
235
236 my $search = [ { 'tags.tag' => 'Cheesy' }, { 'tags.tag' => 'Blue' } ];
237
238 my( $or_rs ) = $schema->resultset("CD")->search_rs($search, { join => 'tags',
239                                                   order_by => 'cdid' });
240 is($or_rs->all, 5, 'Joined search with OR returned correct number of rows');
241 is($or_rs->count, 5, 'Search count with OR ok');
242
243 my $collapsed_or_rs = $or_rs->search ({}, { distinct => 1 }); # induce collapse
244 is ($collapsed_or_rs->all, 4, 'Collapsed joined search with OR returned correct number of rows');
245 is ($collapsed_or_rs->count, 4, 'Collapsed search count with OR ok');
246
247 # make sure sure distinct on a grouped rs is warned about
248 my $cd_rs = $schema->resultset ('CD')
249               ->search ({}, { distinct => 1, group_by => 'title' });
250 warnings_exist (sub {
251   $cd_rs->next;
252 }, qr/Useless use of distinct/, 'UUoD warning');
253
254 {
255   my $tcount = $schema->resultset('Track')->search(
256     {},
257     {
258       select => [ qw/position title/ ],
259       distinct => 1,
260     }
261   );
262   is($tcount->count, 13, 'multiple column COUNT DISTINCT ok');
263
264   $tcount = $schema->resultset('Track')->search(
265     {},
266     {
267       columns => [ qw/position title/ ],
268       distinct => 1,
269     }
270   );
271   is($tcount->count, 13, 'multiple column COUNT DISTINCT ok');
272
273   $tcount = $schema->resultset('Track')->search(
274     {},
275     {
276        group_by => [ qw/position title/ ]
277     }
278   );
279   is($tcount->count, 13, 'multiple column COUNT DISTINCT using column syntax ok');  
280 }
281
282 my $tag_rs = $schema->resultset('Tag')->search(
283                [ { 'me.tag' => 'Cheesy' }, { 'me.tag' => 'Blue' } ]);
284
285 my $rel_rs = $tag_rs->search_related('cd');
286
287 is($rel_rs->count, 5, 'Related search ok');
288
289 is($or_rs->next->cdid, $rel_rs->next->cdid, 'Related object ok');
290 $or_rs->reset;
291 $rel_rs->reset;
292
293 my $tag = $schema->resultset('Tag')->search(
294                [ { 'me.tag' => 'Blue' } ], { cols=>[qw/tagid/] } )->next;
295
296 ok($tag->has_column_loaded('tagid'), 'Has tagid loaded');
297 ok(!$tag->has_column_loaded('tag'), 'Has not tag loaded');
298
299 ok($schema->storage(), 'Storage available');
300
301 {
302   my $rs = $schema->resultset("Artist")->search({
303     -and => [
304       artistid => { '>=', 1 },
305       artistid => { '<', 3 }
306     ]
307   });
308
309   $rs->update({ rank => 6134 });
310
311   my $art;
312
313   $art = $schema->resultset("Artist")->find(1);
314   is($art->rank, 6134, 'updated first artist rank');
315
316   $art = $schema->resultset("Artist")->find(2);
317   is($art->rank, 6134, 'updated second artist rank');
318 }
319
320 # test source_name
321 {
322   # source_name should be set for normal modules
323   is($schema->source('CD')->source_name, 'CD', 'source_name is set to moniker');
324
325   # test the result source that sets source_name explictly
326   ok($schema->source('SourceNameArtists'), 'SourceNameArtists result source exists');
327
328   my @artsn = $schema->resultset('SourceNameArtists')->search({}, { order_by => 'name DESC' });
329   is(@artsn, 4, "Four artists returned");
330   
331   # make sure subclasses that don't set source_name are ok
332   ok($schema->source('ArtistSubclass'), 'ArtistSubclass exists');
333 }
334
335 my $newbook = $schema->resultset( 'Bookmark' )->find(1);
336
337 lives_ok (sub { my $newlink = $newbook->link}, "stringify to false value doesn't cause error");
338
339 # test cascade_delete through many_to_many relations
340 {
341   my $art_del = $schema->resultset("Artist")->find({ artistid => 1 });
342   lives_ok (sub { $art_del->delete }, 'Cascading delete on Ordered has_many works' );  # real test in ordered.t
343   is( $schema->resultset("CD")->search({artist => 1}), 0, 'Cascading through has_many top level.');
344   is( $schema->resultset("CD_to_Producer")->search({cd => 1}), 0, 'Cascading through has_many children.');
345 }
346
347 # test column_info
348 {
349   $schema->source("Artist")->{_columns}{'artistid'} = {};
350   $schema->source("Artist")->column_info_from_storage(1);
351
352   my $typeinfo = $schema->source("Artist")->column_info('artistid');
353   is($typeinfo->{data_type}, 'INTEGER', 'column_info ok');
354   $schema->source("Artist")->column_info('artistid');
355   ok($schema->source("Artist")->{_columns_info_loaded} == 1, 'Columns info loaded flag set');
356 }
357
358 # test columns_info
359 {
360   $schema->source("Artist")->{_columns}{'artistid'} = {};
361   $schema->source("Artist")->column_info_from_storage(1);
362   $schema->source("Artist")->{_columns_info_loaded} = 0;
363
364   is_deeply (
365     $schema->source('Artist')->columns_info,
366     {
367       artistid => {
368         data_type => "INTEGER",
369         default_value => undef,
370         is_nullable => 0,
371         size => undef
372       },
373       charfield => {
374         data_type => "char",
375         default_value => undef,
376         is_nullable => 1,
377         size => 10
378       },
379       name => {
380         data_type => "varchar",
381         default_value => undef,
382         is_nullable => 1,
383         is_numeric => 0,
384         size => 100
385       },
386       rank => {
387         data_type => "integer",
388         default_value => 13,
389         is_nullable => 0,
390         size => undef
391       },
392     },
393     'columns_info works',
394   );
395
396   ok($schema->source("Artist")->{_columns_info_loaded} == 1, 'Columns info loaded flag set');
397
398   is_deeply (
399     $schema->source('Artist')->columns_info([qw/artistid rank/]),
400     {
401       artistid => {
402         data_type => "INTEGER",
403         default_value => undef,
404         is_nullable => 0,
405         size => undef
406       },
407       rank => {
408         data_type => "integer",
409         default_value => 13,
410         is_nullable => 0,
411         size => undef
412       },
413     },
414     'limited columns_info works',
415   );
416 }
417
418 # test source_info
419 {
420   my $expected = {
421     "source_info_key_A" => "source_info_value_A",
422     "source_info_key_B" => "source_info_value_B",
423     "source_info_key_C" => "source_info_value_C",
424   };
425
426   my $sinfo = $schema->source("Artist")->source_info;
427
428   is_deeply($sinfo, $expected, 'source_info data works');
429 }
430
431 # test remove_columns
432 {
433   is_deeply(
434     [$schema->source('CD')->columns],
435     [qw/cdid artist title year genreid single_track/],
436     'initial columns',
437   );
438
439   $schema->source('CD')->remove_columns('coolyear'); #should not delete year
440   is_deeply(
441     [$schema->source('CD')->columns],
442     [qw/cdid artist title year genreid single_track/],
443     'nothing removed when removing a non-existent column',
444   );
445
446   $schema->source('CD')->remove_columns('genreid', 'year');
447   is_deeply(
448     [$schema->source('CD')->columns],
449     [qw/cdid artist title single_track/],
450     'removed two columns',
451   );
452
453   my $priv_columns = $schema->source('CD')->_columns;
454   ok(! exists $priv_columns->{'year'}, 'year purged from _columns');
455   ok(! exists $priv_columns->{'genreid'}, 'genreid purged from _columns');
456 }
457
458 # test get_inflated_columns with objects
459 SKIP: {
460     skip "This test requires DateTime::Format::SQLite", 5 if $NO_DTFM;
461     my $event = $schema->resultset('Event')->search->first;
462     my %edata = $event->get_inflated_columns;
463     is($edata{'id'}, $event->id, 'got id');
464     isa_ok($edata{'starts_at'}, 'DateTime', 'start_at is DateTime object');
465     isa_ok($edata{'created_on'}, 'DateTime', 'create_on DateTime object');
466     is($edata{'starts_at'}, $event->starts_at, 'got start date');
467     is($edata{'created_on'}, $event->created_on, 'got created date');
468 }
469
470 # test resultsource->table return value when setting
471 {
472     my $class = $schema->class('Event');
473     my $table = $class->table($class->table);
474     is($table, $class->table, '->table($table) returns $table');
475 }
476
477 #make sure insert doesn't use set_column
478 {
479   my $en_row = $schema->resultset('Encoded')->new_result({encoded => 'wilma'});
480   is($en_row->encoded, 'amliw', 'new encodes');
481   $en_row->insert;
482   is($en_row->encoded, 'amliw', 'insert does not encode again');
483 }
484
485 #make sure multicreate encoding still works
486 {
487   my $empl_rs = $schema->resultset('Employee');
488
489   my $empl = $empl_rs->create ({
490     name => 'Secret holder',
491     secretkey => {
492       encoded => 'CAN HAZ',
493     },
494   });
495   is($empl->secretkey->encoded, 'ZAH NAC', 'correctly encoding on multicreate');
496
497   my $empl2 = $empl_rs->create ({
498     name => 'Same secret holder',
499     secretkey => {
500       encoded => 'CAN HAZ',
501     },
502   });
503   is($empl2->secretkey->encoded, 'ZAH NAC', 'correctly encoding on preexisting multicreate');
504
505   $empl_rs->create ({
506     name => 'cat1',
507     secretkey => {
508       encoded => 'CHEEZBURGER',
509       keyholders => [
510         {
511           name => 'cat2',
512         },
513         {
514           name => 'cat3',
515         },
516       ],
517     },
518   });
519
520   is($empl_rs->find({name => 'cat1'})->secretkey->encoded, 'REGRUBZEEHC', 'correct secret in database for empl1');
521   is($empl_rs->find({name => 'cat2'})->secretkey->encoded, 'REGRUBZEEHC', 'correct secret in database for empl2');
522   is($empl_rs->find({name => 'cat3'})->secretkey->encoded, 'REGRUBZEEHC', 'correct secret in database for empl3');
523
524 }
525
526 # make sure we got rid of the compat shims
527 SKIP: {
528     skip "Remove in 0.082", 3 if $DBIx::Class::VERSION < 0.082;
529
530     for (qw/compare_relationship_keys pk_depends_on resolve_condition/) {
531       ok (! DBIx::Class::ResultSource->can ($_), "$_ no longer provided by DBIx::Class::ResultSource");
532     }
533 }
534
535 #------------------------------
536 # READ THIS BEFORE "FIXING"
537 #------------------------------
538 #
539 # make sure we got rid of discard_changes mess - this is a mess and a source
540 # of great confusion. Here I simply die if the methods are available, which
541 # is wrong on its own (we *have* to provide some sort of back-compat, even
542 # if with warnings). Here is how I envision things should actually be. Also
543 # note that a lot of the deprecation can be started today (i.e. the switch
544 # from get_from_storage to copy_from_storage). So:
545 #
546 # $row->discard_changes =>
547 #   warning, and delegation to reload_from_storage
548 #
549 # $row->reload_from_storage =>
550 #   does what discard changes did in 0.08 - issues a query to the db
551 #   and repopulates all column slots, regardless of dirty states etc.
552 #
553 # $row->revert_changes =>
554 #   does what discard_changes should have done initially (before it became
555 #   a dual-purpose call). In order to make this work we will have to
556 #   augment $row to carry its own initial-state, much like svn has a
557 #   copy of the current checkout in contrast to cvs.
558 #
559 # my $db_row = $row->get_from_storage =>
560 #   warns and delegates to an improved name copy_from_storage, with the
561 #   same semantics
562 #
563 # my $db_row = $row->copy_from_storage =>
564 #   a much better/descriptive name than get_from_storage
565 #
566 #------------------------------
567 # READ THIS BEFORE "FIXING"
568 #------------------------------
569 #
570 SKIP: {
571     skip "Something needs to be done before 0.09", 2 if $DBIx::Class::VERSION < 0.09;
572
573     my $row = $schema->resultset ('Artist')->next;
574
575     for (qw/discard_changes get_from_storage/) {
576       ok (! $row->can ($_), "$_ needs *some* sort of facelift before 0.09 ships - current state of affairs is unacceptable");
577     }
578 }
579
580 throws_ok { $schema->resultset} qr/resultset\(\) expects a source name/, 'resultset with no argument throws exception';
581
582 done_testing;