7e7e05e4d8c41d00c13dd57a6c3f33dd6b163bc7
[dbsrgits/DBIx-Class-Fixtures.git] / lib / DBIx / Class / Fixtures.pm
1 package DBIx::Class::Fixtures;
2
3 use strict;
4 use warnings;
5
6 use DBIx::Class::Exception;
7 use Class::Accessor::Grouped;
8 use Path::Class qw(dir file);
9 use File::Slurp;
10 use Config::Any::JSON;
11 use Data::Dump::Streamer;
12 use Data::Visitor::Callback;
13 use File::Path;
14 use File::Copy::Recursive qw/dircopy/;
15 use File::Copy qw/move/;
16 use Hash::Merge qw( merge );
17 use Data::Dumper;
18 use Class::C3::Componentised;
19
20 use base qw(Class::Accessor::Grouped);
21
22 our $namespace_counter = 0;
23
24 __PACKAGE__->mk_group_accessors( 'simple' => qw/config_dir _inherited_attributes debug schema_class/);
25
26 =head1 VERSION
27
28 Version 1.001000
29
30 =cut
31
32 our $VERSION = '1.001002';
33
34 =head1 NAME
35
36 DBIx::Class::Fixtures
37
38 =head1 SYNOPSIS
39
40   use DBIx::Class::Fixtures;
41
42   ...
43
44   my $fixtures = DBIx::Class::Fixtures->new({ config_dir => '/home/me/app/fixture_configs' });
45
46   $fixtures->dump({
47     config => 'set_config.json',
48     schema => $source_dbic_schema,
49     directory => '/home/me/app/fixtures'
50   });
51
52   $fixtures->populate({
53     directory => '/home/me/app/fixtures',
54     ddl => '/home/me/app/sql/ddl.sql',
55     connection_details => ['dbi:mysql:dbname=app_dev', 'me', 'password'],
56     post_ddl => '/home/me/app/sql/post_ddl.sql',
57   });
58
59 =head1 DESCRIPTION
60
61 Dump fixtures from source database to filesystem then import to another database (with same schema)
62 at any time. Use as a constant dataset for running tests against or for populating development databases
63 when impractical to use production clones. Describe fixture set using relations and conditions based 
64 on your DBIx::Class schema.
65
66 =head1 DEFINE YOUR FIXTURE SET
67
68 Fixture sets are currently defined in .json files which must reside in your config_dir 
69 (e.g. /home/me/app/fixture_configs/a_fixture_set.json). They describe which data to pull and dump 
70 from the source database.
71
72 For example:
73
74     {
75         sets: [{
76             class: 'Artist',
77             ids: ['1', '3']
78         }, {
79             class: 'Producer',
80             ids: ['5'],
81             fetch: [{
82                 rel: 'artists',
83                 quantity: '2'
84             }]
85         }] 
86     }
87
88 This will fetch artists with primary keys 1 and 3, the producer with primary key 5 and two of producer 5's 
89 artists where 'artists' is a has_many DBIx::Class rel from Producer to Artist.
90
91 The top level attributes are as follows:
92
93 =head2 sets
94
95 Sets must be an array of hashes, as in the example given above. Each set defines a set of objects to be
96 included in the fixtures. For details on valid set attributes see L</SET ATTRIBUTES> below.
97
98 =head2 rules
99
100 Rules place general conditions on classes. For example if whenever an artist was dumped you also wanted all
101 of their cds dumped too, then you could use a rule to specify this. For example:
102
103     {
104         sets: [{
105             class: 'Artist',
106             ids: ['1', '3']
107         }, {
108             class: 'Producer',
109             ids: ['5'],
110             fetch: [{ 
111                 rel: 'artists',
112                 quantity: '2'
113             }]
114         }],
115         rules: {
116             Artist: {
117                 fetch: [{
118                     rel: 'cds',
119                     quantity: 'all'
120                 }]
121             }
122         }
123     }
124
125 In this case all the cds of artists 1, 3 and all producer 5's artists will be dumped as well. Note that 'cds' is a
126 has_many DBIx::Class relation from Artist to CD. This is eqivalent to:
127
128     {
129         sets: [{
130             class: 'Artist',
131             ids: ['1', '3'],
132             fetch: [{
133                 rel: 'cds',
134                 quantity: 'all'
135             }]
136         }, {
137             class: 'Producer',
138             ids: ['5'],
139             fetch: [{ 
140                 rel: 'artists',
141                 quantity: '2',
142                 fetch: [{
143                     rel: 'cds',
144                     quantity: 'all'
145                 }]
146             }]
147         }]
148     }
149
150 rules must be a hash keyed by class name.
151
152 L</RULE ATTRIBUTES>
153
154 =head2 includes
155
156 To prevent repetition between configs you can include other configs. For example:
157
158     {
159         sets: [{
160             class: 'Producer',
161             ids: ['5']
162         }],
163         includes: [{
164             file: 'base.json'
165         }]
166     }
167
168 Includes must be an arrayref of hashrefs where the hashrefs have key 'file' which is the name of another config
169 file in the same directory. The original config is merged with its includes using Hash::Merge.
170
171 =head2 datetime_relative
172
173 Only available for MySQL and PostgreSQL at the moment, must be a value that DateTime::Format::*
174 can parse. For example:
175
176     {
177         sets: [{
178             class: 'RecentItems',
179             ids: ['9']
180         }],
181         datetime_relative : "2007-10-30 00:00:00"
182     }
183
184 This will work when dumping from a MySQL database and will cause any datetime fields (where datatype => 'datetime' 
185 in the column def of the schema class) to be dumped as a DateTime::Duration object relative to the date specified in
186 the datetime_relative value. For example if the RecentItem object had a date field set to 2007-10-25, then when the
187 fixture is imported the field will be set to 5 days in the past relative to the current time.
188
189 =head2 might_have
190
191 Specifies whether to automatically dump might_have relationships. Should be a hash with one attribute - fetch. Set fetch to 1 or 0.
192
193     {
194         might_have: {
195             fetch: 1
196         },
197         sets: [{
198             class: 'Artist',
199             ids: ['1', '3']
200         }, {
201             class: 'Producer',
202             ids: ['5']
203         }]
204     }
205
206 Note: belongs_to rels are automatically dumped whether you like it or not, this is to avoid FKs to nowhere when importing.
207 General rules on has_many rels are not accepted at this top level, but you can turn them on for individual
208 sets - see L</SET ATTRIBUTES>.
209
210 =head1 SET ATTRIBUTES
211
212 =head2 class
213
214 Required attribute. Specifies the DBIx::Class object class you wish to dump.
215
216 =head2 ids
217
218 Array of primary key ids to fetch, basically causing an $rs->find($_) for each. If the id is not in the source db then it
219 just won't get dumped, no warnings or death.
220
221 =head2 quantity
222
223 Must be either an integer or the string 'all'. Specifying an integer will effectively set the 'rows' attribute on the resultset clause,
224 specifying 'all' will cause the rows attribute to be left off and for all matching rows to be dumped. There's no randomising
225 here, it's just the first x rows.
226
227 =head2 cond
228
229 A hash specifying the conditions dumped objects must match. Essentially this is a JSON representation of a DBIx::Class search clause. For example:
230
231     {
232         sets: [{
233             class: 'Artist',
234             quantiy: 'all',
235             cond: { name: 'Dave' }
236         }]
237     }
238
239 This will dump all artists whose name is 'dave'. Essentially $artist_rs->search({ name => 'Dave' })->all.
240
241 Sometimes in a search clause it's useful to use scalar refs to do things like:
242
243 $artist_rs->search({ no1_singles => \'> no1_albums' })
244
245 This could be specified in the cond hash like so:
246
247     {
248         sets: [{
249             class: 'Artist',
250             quantiy: 'all',
251             cond: { no1_singles: '\> no1_albums' }
252         }]
253     }
254
255 So if the value starts with a backslash the value is made a scalar ref before being passed to search.
256
257 =head2 join
258
259 An array of relationships to be used in the cond clause.
260
261     {
262         sets: [{
263             class: 'Artist',
264             quantiy: 'all',
265             cond: { 'cds.position': { '>': 4 } },
266             join: ['cds']
267         }]
268     }
269
270 Fetch all artists who have cds with position greater than 4.
271
272 =head2 fetch
273
274 Must be an array of hashes. Specifies which rels to also dump. For example:
275
276     {
277         sets: [{
278             class: 'Artist',
279             ids: ['1', '3'],
280             fetch: [{
281                 rel: 'cds',
282                 quantity: '3',
283                 cond: { position: '2' }
284             }]
285         }]
286     }
287
288 Will cause the cds of artists 1 and 3 to be dumped where the cd position is 2.
289
290 Valid attributes are: 'rel', 'quantity', 'cond', 'has_many', 'might_have' and 'join'. rel is the name of the DBIx::Class
291 rel to follow, the rest are the same as in the set attributes. quantity is necessary for has_many relationships,
292 but not if using for belongs_to or might_have relationships.
293
294 =head2 has_many
295
296 Specifies whether to fetch has_many rels for this set. Must be a hash containing keys fetch and quantity. 
297
298 Set fetch to 1 if you want to fetch them, and quantity to either 'all' or an integer.
299
300 Be careful here, dumping has_many rels can lead to a lot of data being dumped.
301
302 =head2 might_have
303
304 As with has_many but for might_have relationships. Quantity doesn't do anything in this case.
305
306 This value will be inherited by all fetches in this set. This is not true for the has_many attribute.
307
308 =head1 RULE ATTRIBUTES
309
310 =head2 cond
311
312 Same as with L</SET ATTRIBUTES>
313
314 =head2 fetch
315
316 Same as with L</SET ATTRIBUTES>
317
318 =head2 join
319
320 Same as with L</SET ATTRIBUTES>
321
322 =head2 has_many
323
324 Same as with L</SET ATTRIBUTES>
325
326 =head2 might_have
327
328 Same as with L</SET ATTRIBUTES>
329
330 =head1 METHODS
331
332 =head2 new
333
334 =over 4
335
336 =item Arguments: \%$attrs
337
338 =item Return Value: $fixture_object
339
340 =back
341
342 Returns a new DBIx::Class::Fixture object. %attrs can have the following parameters:
343
344 - config_dir: required. must contain a valid path to the directory in which your .json configs reside.
345 - debug: determines whether to be verbose
346 - ignore_sql_errors: ignore errors on import of DDL etc
347
348
349   my $fixtures = DBIx::Class::Fixtures->new({ config_dir => '/home/me/app/fixture_configs' });
350
351 =cut
352
353 sub new {
354   my $class = shift;
355
356   my ($params) = @_;
357   unless (ref $params eq 'HASH') {
358     return DBIx::Class::Exception->throw('first arg to DBIx::Class::Fixtures->new() must be hash ref');
359   }
360
361   unless ($params->{config_dir}) {
362     return DBIx::Class::Exception->throw('config_dir param not specified');
363   }
364
365   my $config_dir = dir($params->{config_dir});
366   unless (-e $params->{config_dir}) {
367     return DBIx::Class::Exception->throw('config_dir directory doesn\'t exist');
368   }
369
370   my $self = {
371               config_dir => $config_dir,
372               _inherited_attributes => [qw/datetime_relative might_have rules/],
373               debug => $params->{debug} || 0,
374               ignore_sql_errors => $params->{ignore_sql_errors}
375   };
376
377   bless $self, $class;
378
379   return $self;
380 }
381
382 =head2 dump
383
384 =over 4
385
386 =item Arguments: \%$attrs
387
388 =item Return Value: 1
389
390 =back
391
392   $fixtures->dump({
393     config => 'set_config.json', # config file to use. must be in the config directory specified in the constructor
394     schema => $source_dbic_schema,
395     directory => '/home/me/app/fixtures' # output directory
396   });
397
398   or
399
400   $fixtures->dump({
401     all => 1, # just dump everything that's in the schema
402     schema => $source_dbic_schema,
403     directory => '/home/me/app/fixtures' # output directory
404   });
405
406 In this case objects will be dumped to subdirectories in the specified directory. For example:
407
408   /home/me/app/fixtures/artist/1.fix
409   /home/me/app/fixtures/artist/3.fix
410   /home/me/app/fixtures/producer/5.fix
411
412 schema and directory are required attributes. also, one of config or all must be specified.
413
414 =cut
415
416 sub dump {
417   my $self = shift;
418
419   my ($params) = @_;
420   unless (ref $params eq 'HASH') {
421     return DBIx::Class::Exception->throw('first arg to dump must be hash ref');
422   }
423
424   foreach my $param (qw/schema directory/) {
425     unless ($params->{$param}) {
426       return DBIx::Class::Exception->throw($param . ' param not specified');
427     }
428   }
429
430   my $schema = $params->{schema};
431   my $config_file;
432   my $config;
433   if ($params->{config}) {
434     #read config
435     $config_file = file($self->config_dir, $params->{config});
436     unless (-e $config_file) {
437       return DBIx::Class::Exception->throw('config does not exist at ' . $config_file);
438     }
439     $config = Config::Any::JSON->load($config_file);
440
441     #process includes
442     if ($config->{includes}) {
443       $self->msg($config->{includes});
444       unless (ref $config->{includes} eq 'ARRAY') {
445         return DBIx::Class::Exception->throw('includes params of config must be an array ref of hashrefs');
446       }
447       foreach my $include_config (@{$config->{includes}}) {
448         unless ((ref $include_config eq 'HASH') && $include_config->{file}) {
449           return DBIx::Class::Exception->throw('includes params of config must be an array ref of hashrefs');
450         }
451         
452         my $include_file = file($self->config_dir, $include_config->{file});
453         unless (-e $include_file) {
454           return DBIx::Class::Exception->throw('config does not exist at ' . $include_file);
455         }
456         my $include = Config::Any::JSON->load($include_file);
457         $self->msg($include);
458         $config = merge( $config, $include );
459       }
460       delete $config->{includes};
461     }
462     
463     # validate config
464     unless ($config && $config->{sets} && ref $config->{sets} eq 'ARRAY' && scalar(@{$config->{sets}})) {
465       return DBIx::Class::Exception->throw('config has no sets');
466     }
467         
468     $config->{might_have} = { fetch => 0 } unless (exists $config->{might_have});
469     $config->{has_many} = { fetch => 0 } unless (exists $config->{has_many});
470     $config->{belongs_to} = { fetch => 1 } unless (exists $config->{belongs_to});
471   } elsif ($params->{all}) {
472     $config = { might_have => { fetch => 0 }, has_many => { fetch => 0 }, belongs_to => { fetch => 0 }, sets => [map {{ class => $_, quantity => 'all' }} $schema->sources] };
473   } else {
474     return DBIx::Class::Exception->throw('must pass config or set all');
475   }
476
477   my $output_dir = dir($params->{directory});
478   unless (-e $output_dir) {
479     $output_dir->mkpath ||
480       return DBIx::Class::Exception->throw('output directory does not exist at ' . $output_dir);
481   }
482
483   $self->msg("generating  fixtures");
484   my $tmp_output_dir = dir($output_dir, '-~dump~-' . $<);
485
486   if (-e $tmp_output_dir) {
487     $self->msg("- clearing existing $tmp_output_dir");
488     $tmp_output_dir->rmtree;
489   }
490   $self->msg("- creating $tmp_output_dir");
491   $tmp_output_dir->mkpath;
492
493   # write version file (for the potential benefit of populate)
494   my $version_file = file($tmp_output_dir, '_dumper_version');
495   write_file($version_file->stringify, $VERSION);
496
497   $config->{rules} ||= {};
498   my @sources = sort { $a->{class} cmp $b->{class} } @{delete $config->{sets}};
499   my %options = ( is_root => 1 );
500   $self->{queue} = [];
501   foreach my $source (@sources) {
502     # apply rule to set if specified
503     my $rule = $config->{rules}->{$source->{class}};
504     $source = merge( $source, $rule ) if ($rule);
505
506     # fetch objects
507     my $rs = $schema->resultset($source->{class});
508
509     if ($source->{cond} and ref $source->{cond} eq 'HASH') {
510       # if value starts with / assume it's meant to be passed as a scalar ref to dbic
511       # ideally this would substitute deeply
512       $source->{cond} = { map { $_ => ($source->{cond}->{$_} =~ s/^\\//) ? \$source->{cond}->{$_} : $source->{cond}->{$_} } keys %{$source->{cond}} };
513     }
514
515     $rs = $rs->search($source->{cond}, { join => $source->{join} }) if ($source->{cond});
516     $self->msg("- dumping $source->{class}");
517     my @objects;
518     my %source_options = ( set => { %{$config}, %{$source} } );
519     if ($source->{quantity}) {
520       $rs = $rs->search({}, { order_by => $source->{order_by} }) if ($source->{order_by});
521       if ($source->{quantity} eq 'all') {
522         push (@objects, $rs->all);
523       } elsif ($source->{quantity} =~ /^\d+$/) {
524         push (@objects, $rs->search({}, { rows => $source->{quantity} }));
525       } else {
526         DBIx::Class::Exception->throw('invalid value for quantity - ' . $source->{quantity});
527       }
528     }
529     if ($source->{ids}) {
530       my @ids = @{$source->{ids}};
531       my @id_objects = grep { $_ } map { $rs->find($_) } @ids;
532       push (@objects, @id_objects);
533     }
534     unless ($source->{quantity} || $source->{ids}) {
535       DBIx::Class::Exception->throw('must specify either quantity or ids');
536     }
537
538     # dump objects
539     foreach my $object (@objects) {
540       $source_options{set_dir} = $tmp_output_dir;
541       $self->dump_object($object, { %options, %source_options } );
542       next;
543     }
544   }
545
546   while (my $entry = shift @{$self->{queue}}) {
547     $self->dump_object(@$entry);
548   }
549
550   # clear existing output dir
551   foreach my $child ($output_dir->children) {
552     if ($child->is_dir) {
553       next if ($child eq $tmp_output_dir);
554       if (grep { $_ =~ /\.fix/ } $child->children) {
555         $child->rmtree;
556       }
557     } elsif ($child =~ /_dumper_version$/) {
558       $child->remove;
559     }
560   }
561
562   $self->msg("- moving temp dir to $output_dir");
563   move($_, dir($output_dir, $_->relative($_->parent)->stringify)) for $tmp_output_dir->children;
564   if (-e $output_dir) {
565     $self->msg("- clearing tmp dir $tmp_output_dir");
566     # delete existing fixture set
567     $tmp_output_dir->remove;
568   }
569
570   $self->msg("done");
571
572   return 1;
573 }
574
575 sub dump_object {
576   my ($self, $object, $params, $rr_info) = @_;  
577   my $set = $params->{set};
578   die 'no dir passed to dump_object' unless $params->{set_dir};
579   die 'no object passed to dump_object' unless $object;
580
581   my @inherited_attrs = @{$self->_inherited_attributes};
582
583   # write dir and gen filename
584   my $source_dir = dir($params->{set_dir}, lc($object->result_source->from));
585   mkdir($source_dir->stringify, 0777);
586
587   # strip dir separators from file name
588   my $file = file($source_dir, join('-', map { 
589     ( my $a = $object->get_column($_) ) =~ s|[/\\]|_|g; $a;
590   } sort $object->primary_columns) . '.fix');
591
592   # write file
593   my $exists = (-e $file->stringify) ? 1 : 0;
594   unless ($exists) {
595     $self->msg('-- dumping ' . $file->stringify, 2);
596     my %ds = $object->get_columns;
597
598     my $formatter= $object->result_source->schema->storage->datetime_parser;
599     # mess with dates if specified
600     if ($set->{datetime_relative}) {
601       unless ($@ || !$formatter) {
602         my $dt;
603         if ($set->{datetime_relative} eq 'today') {
604           $dt = DateTime->today;
605         } else {
606           $dt = $formatter->parse_datetime($set->{datetime_relative}) unless ($@);
607         }
608
609         while (my ($col, $value) = each %ds) {
610           my $col_info = $object->result_source->column_info($col);
611
612           next unless $value
613             && $col_info->{_inflate_info}
614               && uc($col_info->{data_type}) eq 'DATETIME';
615
616           $ds{$col} = $object->get_inflated_column($col)->subtract_datetime($dt);
617         }
618       } else {
619         warn "datetime_relative not supported for this db driver at the moment";
620       }
621     }
622
623     # do the actual dumping
624     my $serialized = Dump(\%ds)->Out();
625     write_file($file->stringify, $serialized);
626     my $mode = 0777; chmod $mode, $file->stringify;  
627   }
628
629   # don't bother looking at rels unless we are actually planning to dump at least one type
630   return unless ($set->{might_have}->{fetch} || $set->{belongs_to}->{fetch} || $set->{has_many}->{fetch} || $set->{fetch});
631
632   # dump rels of object
633   my $s = $object->result_source;
634   unless ($exists) {
635     foreach my $name (sort $s->relationships) {
636       my $info = $s->relationship_info($name);
637       my $r_source = $s->related_source($name);
638       # if belongs_to or might_have with might_have param set or has_many with has_many param set then
639       if (($info->{attrs}{accessor} eq 'single' && (!$info->{attrs}{join_type} || ($set->{might_have} && $set->{might_have}->{fetch}))) || $info->{attrs}{accessor} eq 'filter' || ($info->{attrs}{accessor} eq 'multi' && ($set->{has_many} && $set->{has_many}->{fetch}))) {
640         my $related_rs = $object->related_resultset($name);       
641         my $rule = $set->{rules}->{$related_rs->result_source->source_name};
642         # these parts of the rule only apply to has_many rels
643         if ($rule && $info->{attrs}{accessor} eq 'multi') {               
644           $related_rs = $related_rs->search($rule->{cond}, { join => $rule->{join} }) if ($rule->{cond});
645           $related_rs = $related_rs->search({}, { rows => $rule->{quantity} }) if ($rule->{quantity} && $rule->{quantity} ne 'all');
646           $related_rs = $related_rs->search({}, { order_by => $rule->{order_by} }) if ($rule->{order_by});                
647         }
648         if ($set->{has_many}->{quantity} && $set->{has_many}->{quantity} =~ /^\d+$/) {
649           $related_rs = $related_rs->search({}, { rows => $set->{has_many}->{quantity} });
650         }
651         my %c_params = %{$params};
652         # inherit date param
653         my %mock_set = map { $_ => $set->{$_} } grep { $set->{$_} } @inherited_attrs;
654         $c_params{set} = \%mock_set;
655         #               use Data::Dumper; print ' -- ' . Dumper($c_params{set}, $rule->{fetch}) if ($rule && $rule->{fetch});
656         $c_params{set} = merge( $c_params{set}, $rule) if ($rule && $rule->{fetch});
657         #               use Data::Dumper; print ' -- ' . Dumper(\%c_params) if ($rule && $rule->{fetch});
658         $self->dump_object($_, \%c_params) foreach $related_rs->all;      
659       } 
660     }
661   }
662   
663   return unless $set && $set->{fetch};
664   foreach my $fetch (@{$set->{fetch}}) {
665     # inherit date param
666     $fetch->{$_} = $set->{$_} foreach grep { !$fetch->{$_} && $set->{$_} } @inherited_attrs;
667     my $related_rs = $object->related_resultset($fetch->{rel});
668     my $rule = $set->{rules}->{$related_rs->result_source->source_name};
669     if ($rule) {
670       my $info = $object->result_source->relationship_info($fetch->{rel});
671       if ($info->{attrs}{accessor} eq 'multi') {
672         $fetch = merge( $fetch, $rule );
673       } elsif ($rule->{fetch}) {
674         $fetch = merge( $fetch, { fetch => $rule->{fetch} } );
675       }
676     } 
677     die "relationship " . $fetch->{rel} . " does not exist for " . $s->source_name unless ($related_rs);
678     if ($fetch->{cond} and ref $fetch->{cond} eq 'HASH') {
679       # if value starts with / assume it's meant to be passed as a scalar ref to dbic
680       # ideally this would substitute deeply
681       $fetch->{cond} = { map { $_ => ($fetch->{cond}->{$_} =~ s/^\\//) ? \$fetch->{cond}->{$_} : $fetch->{cond}->{$_} } keys %{$fetch->{cond}} };
682     }
683     $related_rs = $related_rs->search($fetch->{cond}, { join => $fetch->{join} }) if ($fetch->{cond});
684     $related_rs = $related_rs->search({}, { rows => $fetch->{quantity} }) if ($fetch->{quantity} && $fetch->{quantity} ne 'all');
685     $related_rs = $related_rs->search({}, { order_by => $fetch->{order_by} }) if ($fetch->{order_by});
686     $self->dump_object($_, { %{$params}, set => $fetch }) foreach $related_rs->all;
687   }
688 }
689
690 sub _generate_schema {
691   my $self = shift;
692   my $params = shift || {};
693   require DBI;
694   $self->msg("\ncreating schema");
695   #   die 'must pass version param to generate_schema_from_ddl' unless $params->{version};
696
697   my $schema_class = $self->schema_class || "DBIx::Class::Fixtures::Schema";
698   eval "require $schema_class";
699   die $@ if $@;
700
701   my $pre_schema;
702   my $connection_details = $params->{connection_details};
703   $namespace_counter++;
704   my $namespace = "DBIx::Class::Fixtures::GeneratedSchema_" . $namespace_counter;
705   Class::C3::Componentised->inject_base( $namespace => $schema_class );
706   $pre_schema = $namespace->connect(@{$connection_details});
707   unless( $pre_schema ) {
708     return DBIx::Class::Exception->throw('connection details not valid');
709   }
710   my @tables = map { $pre_schema->source($_)->from } $pre_schema->sources;
711   $self->msg("Tables to drop: [". join(', ', sort @tables) . "]");
712   my $dbh = $pre_schema->storage->dbh;
713
714   # clear existing db
715   $self->msg("- clearing DB of existing tables");
716   eval { $dbh->do('SET foreign_key_checks=0') };
717   foreach my $table (@tables) {
718     eval { $dbh->do('drop table ' . $table . ($params->{cascade} ? ' cascade' : '') ) };
719   }
720
721   # import new ddl file to db
722   my $ddl_file = $params->{ddl};
723   $self->msg("- deploying schema using $ddl_file");
724   my $data = _read_sql($ddl_file);
725   foreach (@$data) {
726     eval { $dbh->do($_) or warn "SQL was:\n $_"};
727           if ($@ && !$self->{ignore_sql_errors}) { die "SQL was:\n $_\n$@"; }
728   }
729   $self->msg("- finished importing DDL into DB");
730
731   # load schema object from our new DB
732   $namespace_counter++;
733   my $namespace2 = "DBIx::Class::Fixtures::GeneratedSchema_" . $namespace_counter;
734   Class::C3::Componentised->inject_base( $namespace2 => $schema_class );
735   my $schema = $namespace2->connect(@{$connection_details});
736   return $schema;
737 }
738
739 sub _read_sql {
740   my $ddl_file = shift;
741   my $fh;
742   open $fh, "<$ddl_file" or die ("Can't open DDL file, $ddl_file ($!)");
743   my @data = split(/\n/, join('', <$fh>));
744   @data = grep(!/^--/, @data);
745   @data = split(/;/, join('', @data));
746   close($fh);
747   @data = grep { $_ && $_ !~ /^-- / } @data;
748   return \@data;
749 }
750
751 =head2 populate
752
753 =over 4
754
755 =item Arguments: \%$attrs
756
757 =item Return Value: 1
758
759 =back
760
761   $fixtures->populate({
762     directory => '/home/me/app/fixtures', # directory to look for fixtures in, as specified to dump
763     ddl => '/home/me/app/sql/ddl.sql', # DDL to deploy
764     connection_details => ['dbi:mysql:dbname=app_dev', 'me', 'password'], # database to clear, deploy and then populate
765     post_ddl => '/home/me/app/sql/post_ddl.sql', # DDL to deploy after populating records, ie. FK constraints
766     cascade => 1, # use CASCADE option when dropping tables
767     no_populate => 0, # optional, set to 1 to run ddl but not populate 
768   });
769
770 In this case the database app_dev will be cleared of all tables, then the specified DDL deployed to it,
771 then finally all fixtures found in /home/me/app/fixtures will be added to it. populate will generate
772 its own DBIx::Class schema from the DDL rather than being passed one to use. This is better as
773 custom insert methods are avoided which can to get in the way. In some cases you might not
774 have a DDL, and so this method will eventually allow a $schema object to be passed instead.
775
776 If needed, you can specify a post_ddl attribute which is a DDL to be applied after all the fixtures
777 have been added to the database. A good use of this option would be to add foreign key constraints
778 since databases like Postgresql cannot disable foreign key checks.
779
780 If your tables have foreign key constraints you may want to use the cascade attribute which will
781 make the drop table functionality cascade, ie 'DROP TABLE $table CASCADE'.
782
783 directory, dll and connection_details are all required attributes.
784
785 =cut
786
787 sub populate {
788   my $self = shift;
789   my ($params) = @_;
790   unless (ref $params eq 'HASH') {
791     return DBIx::Class::Exception->throw('first arg to populate must be hash ref');
792   }
793
794   foreach my $param (qw/directory/) {
795     unless ($params->{$param}) {
796       return DBIx::Class::Exception->throw($param . ' param not specified');
797     }
798   }
799   my $fixture_dir = dir(delete $params->{directory});
800   unless (-e $fixture_dir) {
801     return DBIx::Class::Exception->throw('fixture directory does not exist at ' . $fixture_dir);
802   }
803
804   my $ddl_file;
805   my $dbh;  
806   if ($params->{ddl} && $params->{connection_details}) {
807     $ddl_file = file(delete $params->{ddl});
808     unless (-e $ddl_file) {
809       return DBIx::Class::Exception->throw('DDL does not exist at ' . $ddl_file);
810     }
811     unless (ref $params->{connection_details} eq 'ARRAY') {
812       return DBIx::Class::Exception->throw('connection details must be an arrayref');
813     }
814   } elsif ($params->{schema}) {
815     return DBIx::Class::Exception->throw('passing a schema is not supported at the moment');
816   } else {
817     return DBIx::Class::Exception->throw('you must set the ddl and connection_details params');
818   }
819
820   my $schema = $self->_generate_schema({ ddl => $ddl_file, connection_details => delete $params->{connection_details}, %{$params} });
821
822   return 1 if $params->{no_populate}; 
823   
824   $self->msg("\nimporting fixtures");
825   my $tmp_fixture_dir = dir($fixture_dir, "-~populate~-" . $<);
826
827   my $version_file = file($fixture_dir, '_dumper_version');
828   unless (-e $version_file) {
829 #     return DBIx::Class::Exception->throw('no version file found');
830   }
831
832   if (-e $tmp_fixture_dir) {
833     $self->msg("- deleting existing temp directory $tmp_fixture_dir");
834     $tmp_fixture_dir->rmtree;
835   }
836   $self->msg("- creating temp dir");
837   dircopy(dir($fixture_dir, $schema->source($_)->from), dir($tmp_fixture_dir, $schema->source($_)->from)) for grep { -e dir($fixture_dir, $schema->source($_)->from) } $schema->sources;
838
839   my $fixup_visitor;
840   my $formatter= $schema->storage->datetime_parser;
841   unless ($@ || !$formatter) {
842     my %callbacks;
843     if ($params->{datetime_relative_to}) {
844       $callbacks{'DateTime::Duration'} = sub {
845         $params->{datetime_relative_to}->clone->add_duration($_);
846       };
847     } else {
848       $callbacks{'DateTime::Duration'} = sub {
849         $formatter->format_datetime(DateTime->today->add_duration($_))
850       };
851     }
852     $callbacks{object} ||= "visit_ref"; 
853     $fixup_visitor = new Data::Visitor::Callback(%callbacks);
854   }
855
856   $schema->storage->with_deferred_fk_checks(sub {
857     foreach my $source (sort $schema->sources) {
858       $self->msg("- adding " . $source);
859       my $rs = $schema->resultset($source);
860       my $source_dir = dir($tmp_fixture_dir, lc($rs->result_source->from));
861       next unless (-e $source_dir);
862       my @rows;
863       while (my $file = $source_dir->next) {
864         next unless ($file =~ /\.fix$/);
865         next if $file->is_dir;
866         my $contents = $file->slurp;
867         my $HASH1;
868         eval($contents);
869         $HASH1 = $fixup_visitor->visit($HASH1) if $fixup_visitor;
870         push(@rows, $HASH1);
871       }
872       $rs->populate(\@rows) if (scalar(@rows));
873     }
874   });
875
876   $self->do_post_ddl({schema=>$schema, post_ddl=>$params->{post_ddl}}) if $params->{post_ddl};
877
878   $self->msg("- fixtures imported");
879   $self->msg("- cleaning up");
880   $tmp_fixture_dir->rmtree;
881   return 1;
882 }
883
884 sub do_post_ddl {
885   my ($self, $params) = @_;
886
887   my $schema = $params->{schema};
888   my $data = _read_sql($params->{post_ddl});
889   foreach (@$data) {
890     eval { $schema->storage->dbh->do($_) or warn "SQL was:\n $_"};
891           if ($@ && !$self->{ignore_sql_errors}) { die "SQL was:\n $_\n$@"; }
892   }
893   $self->msg("- finished importing post-populate DDL into DB");
894 }
895
896 sub msg {
897   my $self = shift;
898   my $subject = shift || return;
899   my $level = shift || 1;
900   return unless $self->debug >= $level;
901   if (ref $subject) {
902         print Dumper($subject);
903   } else {
904         print $subject . "\n";
905   }
906 }
907
908 =head1 AUTHOR
909
910   Luke Saunders <luke@shadowcatsystems.co.uk>
911
912   Initial development sponsored by and (c) Takkle, Inc. 2007
913
914 =head1 CONTRIBUTORS
915
916   Ash Berlin <ash@shadowcatsystems.co.uk>
917   Matt S. Trout <mst@shadowcatsystems.co.uk>
918   Drew Taylor <taylor.andrew.j@gmail.com>
919
920 =head1 LICENSE
921
922   This library is free software under the same license as perl itself
923
924 =cut
925
926 1;