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