Expand annotations to cover all generated methods

[dbsrgits/DBIx-Class.git] / t / prefetch / standard.t

BEGIN { do "./t/lib/ANFANG.pm" or die ( $@ || $! ) }

use strict;
use warnings;

use Test::More;
use Test::Exception;

use DBICTest;

my $schema = DBICTest->init_schema();

my $rs;
$schema->is_executed_querycount( sub {
  my $search = { 'artist.name' => 'Caterwauler McCrae' };
  my $attr = { prefetch => [ qw/artist liner_notes/ ],
             order_by => 'me.cdid' };

  $rs = $schema->resultset("CD")->search($search, $attr);
  my @cd = $rs->all;

  is($cd[0]->title, 'Spoonful of bees', 'First record returned ok');

  ok(!defined $cd[0]->liner_notes, 'No prefetch for NULL LEFT join');

  is($cd[1]->{_relationship_data}{liner_notes}->notes, 'Buy Whiskey!', 'Prefetch for present LEFT JOIN');

  is(ref $cd[1]->liner_notes, 'DBICTest::LinerNotes', 'Prefetch returns correct class');

  is($cd[2]->{_inflated_column}{artist}->name, 'Caterwauler McCrae', 'Prefetch on parent object ok');
}, 1, 'prefetch ran only 1 select statement');

# test for partial prefetch via columns attr
my $cd = $schema->resultset('CD')->find(1,
    {
      columns => [qw/title artist artist.name/],
      join => { 'artist' => {} }
    }
);
is( $cd->artist->name, 'Caterwauler McCrae', 'single related column prefetched');

# start test for nested prefetch SELECT count
my $tag;
$schema->is_executed_querycount( sub {
  $rs = $schema->resultset('Tag')->search(
    { 'me.tagid' => 1 },
    {
      prefetch => { cd => 'artist' }
    }
  );

  $tag = $rs->first;

  is( $tag->cd->title, 'Spoonful of bees', 'step 1 ok for nested prefetch' );

  is( $tag->cd->artist->name, 'Caterwauler McCrae', 'step 2 ok for nested prefetch');
}, 1, 'nested prefetch ran exactly 1 select statement');


$schema->is_executed_querycount( sub {
  is($tag->search_related('cd')->search_related('artist')->first->name,
   'Caterwauler McCrae',
   'chained belongs_to->belongs_to search_related ok');
}, 0, 'chained search_related after belongs_to->belongs_to prefetch ran no queries');


$schema->is_executed_querycount( sub {
  $cd = $schema->resultset('CD')->find(1, { prefetch => 'artist' });

  is($cd->{_inflated_column}{artist}->name, 'Caterwauler McCrae', 'artist prefetched correctly on find');
}, 1, 'find with prefetch ran exactly 1 select statement (excluding column_info)');

$schema->is_executed_querycount( sub {
  $cd = $schema->resultset('CD')->find(1, { prefetch => { cd_to_producer => 'producer' }, order_by => 'producer.producerid' });

  is($cd->producers->first->name, 'Matt S Trout', 'many_to_many accessor ok');
}, 1, 'many_to_many accessor with nested prefetch ran exactly 1 query');

$schema->is_executed_querycount( sub {
  my $producers = $cd->search_related('cd_to_producer')->search_related('producer');

  is($producers->first->name, 'Matt S Trout', 'chained many_to_many search_related ok');
}, 0, 'chained search_related after many_to_many prefetch ran no queries');

$rs = $schema->resultset('Tag')->search(
  {},
  {
    join => { cd => 'artist' },
    prefetch => { cd => 'artist' }
  }
);

cmp_ok( $rs->count, '>=', 0, 'nested prefetch does not duplicate joins' );

my ($artist) = $schema->resultset("Artist")->search({ 'cds.year' => 2001 },
                 { order_by => 'artistid DESC', join => 'cds' });

is($artist->name, 'Random Boy Band', "Join search by object ok");

my @cds = $schema->resultset("CD")->search({ 'liner_notes.notes' => 'Buy Merch!' },
                               { join => 'liner_notes' });

cmp_ok(scalar @cds, '==', 1, "Single CD retrieved via might_have");

is($cds[0]->title, "Generic Manufactured Singles", "Correct CD retrieved");

my @artists = $schema->resultset("Artist")->search({ 'tags.tag' => 'Shiny' },
                                       { join => { 'cds' => 'tags' } });

cmp_ok( @artists, '==', 2, "two-join search ok" );

$rs = $schema->resultset("CD")->search(
  {},
  { group_by => [qw/ title me.cdid /] }
);

cmp_ok( $rs->count, '==', 5, "count() ok after group_by on main pk" );

cmp_ok( scalar $rs->all, '==', 5, "all() returns same count as count() after group_by on main pk" );

$rs = $schema->resultset("CD")->search(
  {},
  { join => [qw/ artist /], group_by => [qw/ artist.name /] }
);

cmp_ok( $rs->count, '==', 3, "count() ok after group_by on related column" );

$rs = $schema->resultset("Artist")->search({}, {
  join => [qw/ cds /],
  group_by => [qw/ me.name /],
  having => \[ 'MAX(cds.cdid) < ?', [ \'int' => 5 ] ],
});

cmp_ok( $rs->all, '==', 2, "results ok after group_by on related column with a having" );

$rs = $rs->search( undef, {  having =>{ 'count(*)'=> \'> 2' }});

cmp_ok( $rs->all, '==', 1, "count() ok after group_by on related column with a having" );

$rs = $schema->resultset("Artist")->search(
        { 'cds.title' => 'Spoonful of bees',
          'cds_2.title' => 'Forkful of bees' },
        { join => [ 'cds', 'cds' ] });

cmp_ok($rs->count, '==', 1, "single artist returned from multi-join");

is($rs->next->name, 'Caterwauler McCrae', "Correct artist returned");

$cd = $schema->resultset('Artist')->search({ artistid => 1 })->first->create_related('cds',
    {
    title   => 'Unproduced Single',
    year    => 2007
});

my $left_join = $schema->resultset('CD')->search(
    { 'me.cdid' => $cd->cdid },
    { prefetch => { cd_to_producer => 'producer' } }
);

cmp_ok($left_join, '==', 1, 'prefetch with no join record present');

my $tree_like;
$schema->is_executed_querycount( sub {
  $tree_like =
    $schema->resultset('TreeLike')->find(5,
      { join     => { parent => { parent => 'parent' } },
         prefetch => { parent => { parent => 'parent' } } });

  is($tree_like->name, 'quux', 'Bottom of tree ok');
  $tree_like = $tree_like->parent;
  is($tree_like->name, 'baz', 'First level up ok');
  $tree_like = $tree_like->parent;
  is($tree_like->name, 'bar', 'Second level up ok');
  $tree_like = $tree_like->parent;
  is($tree_like->name, 'foo', 'Third level up ok');

}, 1, 'Only one query run');

$tree_like = $schema->resultset('TreeLike')->search({'me.id' => 2});
$tree_like = $tree_like->search_related('children')->search_related('children')->search_related('children')->first;
is($tree_like->name, 'quux', 'Tree search_related ok');

$tree_like = $schema->resultset('TreeLike')->search_related('children',
    { 'children.id' => 3, 'children_2.id' => 4 },
    { prefetch => { children => 'children' } }
  )->first;
is( $tree_like->children->first->children->first->name, 'quux',
   'Tree search_related with prefetch ok');

$tree_like = $schema->resultset('TreeLike')->search(
    { 'children.id' => 3, 'children_2.id' => 6 },
    { join => [qw/children children children/] }
  )->search_related('children', { 'children_4.id' => 7 }, { prefetch => 'children' }
  )->first->children->first;
is( $tree_like->name, 'fong', 'Tree with multiple has_many joins ok');

$rs = $schema->resultset('Artist');
$rs->create({ artistid => 4, name => 'Unknown singer-songwriter' });
$rs->create({ artistid => 5, name => 'Emo 4ever' });
@artists = $rs->search(undef, { prefetch => 'cds', order_by => 'artistid' });
is(scalar @artists, 5, 'has_many prefetch with adjacent empty rows ok');

lives_ok { @artists = $rs->search(undef, {
        join => ['cds'],
        prefetch => [],
        rows => 20,
    });
} 'join and empty prefetch ok';

# -------------
#
# Tests for multilevel has_many prefetch

# artist resultsets - with and without prefetch
my $art_rs = $schema->resultset('Artist');
my $art_rs_pr = $art_rs->search(
    {},
    {
        join     => [ { cds => ['tracks'] } ],
        prefetch => [ { cds => ['tracks'] } ],
        cache    => 1 # last test needs this
    }
);

# This test does the same operation twice - once on a
# set of items fetched from the db with no prefetch of has_many rels
# The second prefetches 2 levels of has_many
# We check things are the same by comparing the name or title
# we build everything into a hash structure and compare the one
# from each rs to see what differs

sub make_hash_struc {
    my $rs = shift;

    my $struc = {};
    # all of these ought to work, but do not for some reason
    # a noop cloning search() pollution?
    #foreach my $art ( $rs->search({}, { order_by => 'me.artistid' })->all ) {
    #foreach my $art ( $rs->search({}, {})->all ) {
    #foreach my $art ( $rs->search()->all ) {
    foreach my $art ( $rs->all ) {
        foreach my $cd ( $art->cds ) {
            foreach my $track ( $cd->tracks ) {
                $struc->{ $art->name }{ $cd->title }{ $track->title }++;
            }
        }
    }
    return $struc;
}


my $prefetch_result;
$schema->is_executed_querycount( sub {
  $prefetch_result = make_hash_struc($art_rs_pr);
}, 1, 'nested prefetch across has_many->has_many ran exactly 1 query');

my $nonpre_result = make_hash_struc($art_rs);
is_deeply( $prefetch_result, $nonpre_result,
    'Compare 2 level prefetch result to non-prefetch result' );

$schema->is_executed_querycount( sub {
  is_deeply(
    [ sort map { $_->title } $art_rs_pr->search_related('cds')->search_related('tracks')->all ],
    [ 'Apiary', 'Beehind You', 'Boring Name', 'Boring Song', 'Fowlin', 'Howlin',
      'No More Ideas', 'Sad', 'Sticky Honey', 'Stripy', 'Stung with Success',
      'Suicidal', 'The Bees Knees', 'Under The Weather', 'Yowlin' ],
    'chained has_many->has_many search_related ok'
  );
}, 0, 'chained search_related after has_many->has_many prefetch ran no queries');

done_testing;