Commit | Line | Data |
ad91060a |
1 | package Catalyst::Helper::Model::DBIC::Schema; |
2 | |
f090a149 |
3 | use Moose; |
ffbf1967 |
4 | no warnings 'uninitialized'; |
018eb0e2 |
5 | |
2201c2e4 |
6 | our $VERSION = '0.24'; |
7 | |
0f2fd2c0 |
8 | use Carp; |
2201c2e4 |
9 | use Tie::IxHash (); |
10 | use Data::Dumper (); |
c4fee9b8 |
11 | use List::Util 'first'; |
2201c2e4 |
12 | |
f090a149 |
13 | use namespace::clean -except => 'meta'; |
ad91060a |
14 | |
15 | =head1 NAME |
16 | |
17 | Catalyst::Helper::Model::DBIC::Schema - Helper for DBIC Schema Models |
18 | |
19 | =head1 SYNOPSIS |
20 | |
2201c2e4 |
21 | script/create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass \ |
2ff00e2b |
22 | [ create=dynamic | create=static ] [ roles=role1,role2... ] \ |
23 | [ Schema::Loader opts ] [ dsn user pass ] \ |
24 | [ other connect_info args ] |
0f2fd2c0 |
25 | |
d89e6c8a |
26 | =head1 DESCRIPTION |
27 | |
28 | Helper for the DBIC Schema Models. |
29 | |
30 | =head2 Arguments: |
31 | |
018eb0e2 |
32 | C<CatalystModelName> is the short name for the Catalyst Model class |
33 | being generated (i.e. callable with C<$c-E<gt>model('CatalystModelName')>). |
6116daed |
34 | |
018eb0e2 |
35 | C<MyApp::SchemaClass> is the fully qualified classname of your Schema, |
6116daed |
36 | which might or might not yet exist. Note that you should have a good |
37 | reason to create this under a new global namespace, otherwise use an |
38 | existing top level namespace for your schema class. |
39 | |
018eb0e2 |
40 | C<create=dynamic> instructs this Helper to generate the named Schema |
6116daed |
41 | class for you, basing it on L<DBIx::Class::Schema::Loader> (which |
42 | means the table information will always be dynamically loaded at |
43 | runtime from the database). |
44 | |
018eb0e2 |
45 | C<create=static> instructs this Helper to generate the named Schema |
6116daed |
46 | class for you, using L<DBIx::Class::Schema::Loader> in "one shot" |
47 | mode to create a standard, manually-defined L<DBIx::Class::Schema> |
48 | setup, based on what the Loader sees in your database at this moment. |
49 | A Schema/Model pair generated this way will not require |
50 | L<DBIx::Class::Schema::Loader> at runtime, and will not automatically |
51 | adapt itself to changes in your database structure. You can edit |
52 | the generated classes by hand to refine them. |
53 | |
2ff00e2b |
54 | C<roles> is the list of roles to apply to the model, see |
55 | L<Catalyst::Model::DBIC::Schema> for details. |
56 | |
57 | C<Schema::Loader opts> are described in L</TYPICAL EXAMPLES> below. |
58 | |
018eb0e2 |
59 | C<connect_info> arguments are the same as what |
6116daed |
60 | DBIx::Class::Schema::connect expects, and are storage_type-specific. |
61 | For DBI-based storage, these arguments are the dsn, username, |
62 | password, and connect options, respectively. These are optional for |
63 | existing Schemas, but required if you use either of the C<create=> |
64 | options. |
d89e6c8a |
65 | |
66 | Use of either of the C<create=> options requires L<DBIx::Class::Schema::Loader>. |
0b2a7108 |
67 | |
68 | =head1 TYPICAL EXAMPLES |
69 | |
d89e6c8a |
70 | # Use DBIx::Class::Schema::Loader to create a static DBIx::Class::Schema, |
71 | # and a Model which references it: |
2201c2e4 |
72 | script/myapp_create.pl model CatalystModelName DBIC::Schema \ |
73 | MyApp::SchemaClass create=static dbi:mysql:foodb myuname mypass |
74 | |
75 | # Same, with extra connect_info args |
76 | script/myapp_create.pl model CatalystModelName DBIC::Schema \ |
77 | MyApp::SchemaClass create=static dbi:SQLite:foo.db '' '' \ |
78 | AutoCommit=1 cursor_class=DBIx::Class::Cursor::Cached \ |
79 | on_connect_do='["select 1", "select 2"]' |
0b2a7108 |
80 | |
ca14239e |
81 | # Same, but with extra Schema::Loader args (separate multiple values by commas): |
2201c2e4 |
82 | script/myapp_create.pl model CatalystModelName DBIC::Schema \ |
83 | MyApp::SchemaClass create=static db_schema=foodb components=Foo,Bar \ |
84 | exclude='^wibble|wobble$' moniker_map='{ foo => "FFFFUUUU" }' \ |
85 | dbi:Pg:dbname=foodb myuname mypass |
34f036a0 |
86 | |
ca14239e |
87 | # See DBIx::Class::Schema::Loader::Base for list of options |
34f036a0 |
88 | |
d89e6c8a |
89 | # Create a dynamic DBIx::Class::Schema::Loader-based Schema, |
90 | # and a Model which references it: |
2201c2e4 |
91 | script/myapp_create.pl model CatalystModelName DBIC::Schema \ |
92 | MyApp::SchemaClass create=dynamic dbi:mysql:foodb myuname mypass |
ad91060a |
93 | |
d89e6c8a |
94 | # Reference an existing Schema of any kind, and provide some connection information for ->config: |
2201c2e4 |
95 | script/myapp_create.pl model CatalystModelName DBIC::Schema \ |
96 | MyApp::SchemaClass dbi:mysql:foodb myuname mypass |
ad91060a |
97 | |
d89e6c8a |
98 | # Same, but don't supply connect information yet (you'll need to do this |
99 | # in your app config, or [not recommended] in the schema itself). |
100 | script/myapp_create.pl model ModelName DBIC::Schema My::SchemaClass |
ad91060a |
101 | |
f090a149 |
102 | =cut |
103 | |
104 | has helper => (is => 'ro', isa => 'Catalyst::Helper', required => 1); |
105 | |
106 | has schema_class => (is => 'ro', isa => 'Str', required => 1); |
107 | |
108 | has loader_args => (is => 'rw', isa => 'HashRef'); |
109 | has connect_info => (is => 'rw', isa => 'HashRef'); |
110 | |
111 | has old_schema => (is => 'rw', isa => 'Bool', lazy => 1, default => sub { |
112 | my $self = shift; |
113 | |
114 | my @schema_pm = split '::', $self->schema_class; |
115 | $schema_pm[-1] .= '.pm'; |
116 | my $schema_file = |
117 | File::Spec->catfile($self->helper->{base}, 'lib', @schema_pm); |
118 | |
119 | if (-f $schema_file) { |
120 | my $schema_code = do { local (@ARGV, $/) = $schema_file; <> }; |
121 | return 1 if $schema_code =~ /->load_classes/; |
122 | } |
123 | |
124 | 0; |
125 | }); |
126 | |
018eb0e2 |
127 | =head1 METHODS |
ad91060a |
128 | |
018eb0e2 |
129 | =head2 mk_compclass |
ad91060a |
130 | |
0fbbc8d5 |
131 | This is called by L<Catalyst::Helper> with the commandline args to generate the |
132 | files. |
133 | |
ad91060a |
134 | =cut |
135 | |
136 | sub mk_compclass { |
2201c2e4 |
137 | my ($package, $helper, $schema_class, @args) = @_; |
138 | |
f090a149 |
139 | my $self = $package->new(helper => $helper, schema_class => $schema_class); |
0f2fd2c0 |
140 | |
d89e6c8a |
141 | $helper->{schema_class} = $schema_class |
c4fee9b8 |
142 | or die "Must supply schema class name"; |
143 | |
144 | @args = $self->_cleanup_args(\@args); |
d89e6c8a |
145 | |
146 | my $create = ''; |
2ff00e2b |
147 | if ($args[0] && $args[0] =~ /^create=(dynamic|static)\z/) { |
d89e6c8a |
148 | $create = $1; |
2201c2e4 |
149 | shift @args; |
150 | |
2ff00e2b |
151 | if ($args[0] && $args[0] =~ /^roles=(.*)\z/) { |
152 | $helper->{roles} = '[' |
153 | .(join ',' => map { qq{'$_'} } (split /,/ => $1)) |
154 | .']'; |
155 | shift @args; |
156 | } |
157 | |
2201c2e4 |
158 | if (@args) { |
159 | $self->_parse_loader_args(\@args); |
160 | |
c4fee9b8 |
161 | if (first { /^dbi:/i } @args) { |
2201c2e4 |
162 | $helper->{setup_connect_info} = 1; |
163 | |
164 | $helper->{connect_info} = |
f090a149 |
165 | $self->_build_helper_connect_info(\@args); |
2201c2e4 |
166 | |
167 | $self->_parse_connect_info(\@args) if $create eq 'static'; |
168 | } |
169 | } |
d89e6c8a |
170 | } |
0f2fd2c0 |
171 | |
2201c2e4 |
172 | $helper->{generator} = ref $self; |
173 | $helper->{generator_version} = $VERSION; |
174 | |
175 | if ($create eq 'dynamic') { |
c4fee9b8 |
176 | $self->_print_dynamic_deprecation_warning; |
2201c2e4 |
177 | $self->helper->{loader_args} = $self->_build_helper_loader_args; |
178 | $self->_gen_dynamic_schema; |
179 | } elsif ($create eq 'static') { |
180 | $self->_gen_static_schema; |
181 | } |
182 | |
183 | $self->_gen_model; |
184 | } |
185 | |
186 | sub _parse_loader_args { |
187 | my ($self, $args) = @_; |
188 | |
189 | my %loader_args = $self->_read_loader_args($args); |
190 | |
191 | while (my ($key, $val) = each %loader_args) { |
192 | next if $key =~ /^(?:components|constraint|exclude)\z/; |
193 | |
194 | $loader_args{$key} = eval $val; |
c4fee9b8 |
195 | die "syntax error for loader args key '$key' with value '$val': $@" |
2201c2e4 |
196 | if $@; |
197 | } |
198 | |
199 | my @components = |
200 | $self->_build_loader_components(delete $loader_args{components}); |
201 | |
202 | for my $re_opt (qw/constraint exclude/) { |
203 | $loader_args{$re_opt} = qr/$loader_args{$re_opt}/ |
204 | if exists $loader_args{$re_opt}; |
205 | } |
206 | |
207 | tie my %result, 'Tie::IxHash'; |
208 | |
209 | %result = ( |
210 | relationships => 1, |
211 | (%loader_args ? %loader_args : ()), |
f090a149 |
212 | (!$self->old_schema ? ( |
2201c2e4 |
213 | use_namespaces => 1 |
214 | ) : ()), |
215 | (@components ? ( |
216 | components => \@components |
217 | ) : ()) |
218 | ); |
219 | |
220 | $self->loader_args(\%result); |
221 | |
222 | wantarray ? %result : \%result; |
223 | } |
224 | |
225 | sub _read_loader_args { |
226 | my ($self, $args) = @_; |
227 | |
228 | my %loader_args; |
229 | |
230 | while (@$args && $args->[0] !~ /^dbi:/) { |
231 | my ($key, $val) = split /=/, shift(@$args), 2; |
ca14239e |
232 | |
233 | if ((my @vals = split /,/ => $val) > 1) { |
2201c2e4 |
234 | $loader_args{$key} = \@vals; |
ca14239e |
235 | } else { |
2201c2e4 |
236 | $loader_args{$key} = $val; |
ca14239e |
237 | } |
238 | } |
239 | |
2201c2e4 |
240 | wantarray ? %loader_args : \%loader_args; |
241 | } |
242 | |
243 | sub _build_helper_loader_args { |
244 | my $self = shift; |
245 | |
246 | my $args = $self->loader_args; |
247 | |
248 | tie my %loader_args, 'Tie::IxHash'; |
249 | |
250 | while (my ($arg, $val) = each %$args) { |
251 | if (ref $val) { |
252 | $loader_args{$arg} = $self->_data_struct_to_string($val); |
253 | } else { |
254 | $loader_args{$arg} = qq{'$val'}; |
0b2a7108 |
255 | } |
0f2fd2c0 |
256 | } |
257 | |
2201c2e4 |
258 | \%loader_args |
259 | } |
260 | |
261 | sub _build_loader_components { |
262 | my ($self, $components) = @_; |
d89e6c8a |
263 | |
f090a149 |
264 | my @components = $self->old_schema ? () : ('InflateColumn::DateTime'); |
d89e6c8a |
265 | |
2201c2e4 |
266 | if ($components) { |
267 | $components = [ $components ] if !ref $components; |
268 | push @components, @$components; |
d89e6c8a |
269 | } |
2201c2e4 |
270 | |
271 | wantarray ? @components : \@components; |
272 | } |
273 | |
274 | sub _build_helper_connect_info { |
275 | my ($self, $connect_info) = @_; |
276 | |
277 | my @connect_info = @$connect_info; |
278 | |
279 | my ($dsn, $user, $password) = splice @connect_info, 0, 3; |
280 | |
281 | tie my %helper_connect_info, 'Tie::IxHash'; |
282 | |
283 | %helper_connect_info = ( |
284 | dsn => qq{'$dsn'}, |
285 | user => qq{'$user'}, |
286 | password => qq{'$password'} |
287 | ); |
288 | |
289 | for (@connect_info) { |
290 | if (/^\s*{.*}\s*\z/) { |
291 | my $hash = eval $_; |
c4fee9b8 |
292 | die "Syntax errorr in connect_info hash: $_: $@" if $@; |
2201c2e4 |
293 | my %hash = %$hash; |
294 | |
295 | for my $key (keys %hash) { |
296 | my $val = $hash{$key}; |
297 | |
298 | if (ref $val) { |
299 | $val = $self->_data_struct_to_string($val); |
300 | } else { |
301 | $val = qq{'$val'}; |
302 | } |
303 | |
304 | $helper_connect_info{$key} = $val; |
592cd3ae |
305 | } |
2201c2e4 |
306 | |
307 | next; |
592cd3ae |
308 | } |
309 | |
2201c2e4 |
310 | my ($key, $val) = split /=/, $_, 2; |
1d155058 |
311 | |
2201c2e4 |
312 | $helper_connect_info{$key} = $self->_quote_unless_struct($val); |
313 | } |
1d155058 |
314 | |
2201c2e4 |
315 | \%helper_connect_info |
316 | } |
1d155058 |
317 | |
2201c2e4 |
318 | sub _data_struct_to_string { |
319 | my ($self, $data) = @_; |
34f036a0 |
320 | |
2201c2e4 |
321 | local $Data::Dumper::Terse = 1; |
322 | local $Data::Dumper::Quotekeys = 0; |
323 | local $Data::Dumper::Indent = 0; |
324 | local $Data::Dumper::Useqq = 1; |
34f036a0 |
325 | |
2201c2e4 |
326 | return Data::Dumper->Dump([$data]); |
327 | } |
34f036a0 |
328 | |
2201c2e4 |
329 | sub _parse_connect_info { |
330 | my ($self, $connect_info) = @_; |
331 | |
332 | my @connect_info = @$connect_info; |
333 | |
334 | my ($dsn, $user, $password) = splice @connect_info, 0, 3; |
335 | |
336 | tie my %connect_info, 'Tie::IxHash'; |
337 | @connect_info{qw/dsn user password/} = ($dsn, $user, $password); |
338 | |
339 | for (@connect_info) { |
340 | if (/^\s*{.*}\s*\z/) { |
341 | my $hash = eval $_; |
c4fee9b8 |
342 | die "Syntax errorr in connect_info hash: $_: $@" if $@; |
2201c2e4 |
343 | |
344 | %connect_info = (%connect_info, %$hash); |
ca14239e |
345 | |
2201c2e4 |
346 | next; |
ca14239e |
347 | } |
348 | |
2201c2e4 |
349 | my ($key, $val) = split /=/, $_, 2; |
350 | |
3f139b02 |
351 | if ($key =~ /^(?:quote_char|name_sep)\z/) { |
352 | $connect_info{$key} = $val; |
353 | } else { |
354 | $connect_info{$key} = eval $val; |
355 | } |
356 | |
c4fee9b8 |
357 | die "syntax error for connect_info key '$key' with value '$val': $@" |
2201c2e4 |
358 | if $@; |
d89e6c8a |
359 | } |
202d09c8 |
360 | |
2201c2e4 |
361 | $self->connect_info(\%connect_info); |
362 | |
363 | \%connect_info |
364 | } |
365 | |
366 | sub _quote_unless_struct { |
367 | my ($self, $val) = @_; |
368 | |
369 | $val = qq{'$val'} if $val !~ /^\s*[[{]/; |
370 | |
371 | $val; |
372 | } |
373 | |
374 | sub _gen_dynamic_schema { |
375 | my $self = shift; |
376 | |
377 | my $helper = $self->helper; |
378 | |
379 | my @schema_parts = split(/\:\:/, $self->schema_class); |
380 | my $schema_file_part = pop @schema_parts; |
381 | |
382 | my $schema_dir = File::Spec->catfile( |
383 | $helper->{base}, 'lib', @schema_parts |
384 | ); |
385 | my $schema_file = File::Spec->catfile( |
386 | $schema_dir, $schema_file_part . '.pm' |
387 | ); |
388 | |
389 | $helper->mk_dir($schema_dir); |
390 | $helper->render_file('schemaclass', $schema_file); |
391 | } |
392 | |
393 | sub _gen_static_schema { |
394 | my $self = shift; |
395 | |
c4fee9b8 |
396 | die "cannot load schema without connect info" unless $self->connect_info; |
2201c2e4 |
397 | |
398 | my $helper = $self->helper; |
399 | |
400 | my $schema_dir = File::Spec->catfile($helper->{base}, 'lib'); |
401 | |
f090a149 |
402 | eval { Class::MOP::load_class('DBIx::Class::Schema::Loader') }; |
c4fee9b8 |
403 | die "Cannot load DBIx::Class::Schema::Loader: $@" if $@; |
f090a149 |
404 | |
405 | DBIx::Class::Schema::Loader->import( |
2201c2e4 |
406 | "dump_to_dir:$schema_dir", 'make_schema_at' |
f090a149 |
407 | ); |
2201c2e4 |
408 | |
409 | make_schema_at( |
410 | $self->schema_class, |
411 | $self->loader_args, |
412 | [$self->connect_info] |
413 | ); |
414 | } |
415 | |
2201c2e4 |
416 | sub _gen_model { |
417 | my $self = shift; |
418 | my $helper = $self->helper; |
419 | |
420 | $helper->render_file('compclass', $helper->{file} ); |
ad91060a |
421 | } |
422 | |
c4fee9b8 |
423 | sub _print_dynamic_deprecation_warning { |
424 | warn <<EOF; |
425 | ************************************ WARNING ********************************** |
426 | * create=dynamic is DEPRECATED, please use create=static instead. * |
427 | ******************************************************************************* |
428 | EOF |
429 | print "Continue? [y/n]: "; |
430 | chomp(my $response = <STDIN>); |
431 | exit 0 if $response =~ /^n(o)?\z/; |
432 | } |
433 | |
434 | sub _cleanup_args { |
435 | my ($self, $args) = @_; |
436 | |
437 | # remove blanks, ie. someoned doing foo \ bar |
3f139b02 |
438 | # my @res = grep !/^\s*\z/, @$args; |
439 | # bad idea. |
440 | my @res = @$args; |
c4fee9b8 |
441 | |
442 | # remove leading whitespace, ie. foo \ bar |
443 | s/^\s*// for @res; |
444 | |
445 | @res |
446 | } |
447 | |
ad91060a |
448 | =head1 SEE ALSO |
449 | |
7b39f3f0 |
450 | General Catalyst Stuff: |
451 | |
ad91060a |
452 | L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>, |
7b39f3f0 |
453 | L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>, |
454 | |
455 | Stuff related to DBIC and this Model style: |
456 | |
457 | L<DBIx::Class>, L<DBIx::Class::Schema>, |
ef91bcf9 |
458 | L<DBIx::Class::Schema::Loader>, L<Catalyst::Model::DBIC::Schema> |
ad91060a |
459 | |
460 | =head1 AUTHOR |
461 | |
462 | Brandon L Black, C<blblack@gmail.com> |
463 | |
2ff00e2b |
464 | Contributors: |
465 | |
466 | Rafael Kitover, C<<rkitover at cpan.org>> |
467 | |
ad91060a |
468 | =head1 LICENSE |
469 | |
470 | This library is free software, you can redistribute it and/or modify |
471 | it under the same terms as Perl itself. |
472 | |
473 | =cut |
474 | |
dce0dfe8 |
475 | 1; |
476 | |
ad91060a |
477 | __DATA__ |
478 | |
5d11d759 |
479 | =begin pod_to_ignore |
480 | |
d89e6c8a |
481 | __schemaclass__ |
482 | package [% schema_class %]; |
483 | |
484 | use strict; |
485 | use base qw/DBIx::Class::Schema::Loader/; |
486 | |
487 | __PACKAGE__->loader_options( |
2201c2e4 |
488 | [%- FOREACH key = loader_args.keys %] |
489 | [% key %] => [% loader_args.${key} %], |
490 | [%- END -%] |
491 | |
d89e6c8a |
492 | ); |
493 | |
494 | =head1 NAME |
495 | |
2201c2e4 |
496 | [% schema_class %] - L<DBIx::Class::Schema::Loader> class |
d89e6c8a |
497 | |
498 | =head1 SYNOPSIS |
499 | |
500 | See L<[% app %]> |
501 | |
502 | =head1 DESCRIPTION |
503 | |
2201c2e4 |
504 | Dynamic L<DBIx::Class::Schema::Loader> schema for use in L<[% class %]> |
505 | |
506 | =head1 GENERATED BY |
507 | |
508 | [% generator %] - [% generator_version %] |
d89e6c8a |
509 | |
510 | =head1 AUTHOR |
511 | |
2201c2e4 |
512 | [% author.replace(',+$', '') %] |
d89e6c8a |
513 | |
514 | =head1 LICENSE |
515 | |
516 | This library is free software, you can redistribute it and/or modify |
517 | it under the same terms as Perl itself. |
518 | |
519 | =cut |
520 | |
521 | 1; |
522 | |
ad91060a |
523 | __compclass__ |
524 | package [% class %]; |
525 | |
526 | use strict; |
527 | use base 'Catalyst::Model::DBIC::Schema'; |
528 | |
529 | __PACKAGE__->config( |
0f2fd2c0 |
530 | schema_class => '[% schema_class %]', |
2ff00e2b |
531 | [% IF roles %]roles => [% roles %],[% END %] |
2201c2e4 |
532 | [% IF setup_connect_info %]connect_info => { |
533 | [%- FOREACH key = connect_info.keys %] |
534 | [% key %] => [% connect_info.${key} %], |
535 | [%- END -%] |
536 | |
537 | }[% END %] |
ad91060a |
538 | ); |
539 | |
540 | =head1 NAME |
541 | |
1aeb6e1e |
542 | [% class %] - Catalyst DBIC Schema Model |
2201c2e4 |
543 | |
ad91060a |
544 | =head1 SYNOPSIS |
545 | |
546 | See L<[% app %]> |
547 | |
548 | =head1 DESCRIPTION |
549 | |
d89e6c8a |
550 | L<Catalyst::Model::DBIC::Schema> Model using schema L<[% schema_class %]> |
ad91060a |
551 | |
2201c2e4 |
552 | =head1 GENERATED BY |
553 | |
554 | [% generator %] - [% generator_version %] |
555 | |
ad91060a |
556 | =head1 AUTHOR |
557 | |
2201c2e4 |
558 | [% author.replace(',+$', '') %] |
ad91060a |
559 | |
560 | =head1 LICENSE |
561 | |
562 | This library is free software, you can redistribute it and/or modify |
563 | it under the same terms as Perl itself. |
564 | |
565 | =cut |
566 | |
567 | 1; |