1 package Catalyst::Helper::Model::DBIC::Schema;
3 use namespace::autoclean;
5 no warnings 'uninitialized';
12 use List::Util 'first';
13 use MooseX::Types::Moose qw/Str HashRef Bool ArrayRef/;
14 use Catalyst::Model::DBIC::Schema::Types 'CreateOption';
16 use List::MoreUtils 'firstidx';
17 use Scalar::Util 'looks_like_number';
21 Catalyst::Helper::Model::DBIC::Schema - Helper for DBIC Schema Models
25 script/create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass \
26 [ create=dynamic | create=static ] [ traits=trait1,trait2... ] \
27 [ Schema::Loader opts ] [ dsn user pass ] \
28 [ other connect_info args ]
32 Helper for the DBIC Schema Models.
36 C<CatalystModelName> is the short name for the Catalyst Model class
37 being generated (i.e. callable with C<$c-E<gt>model('CatalystModelName')>).
39 C<MyApp::SchemaClass> is the fully qualified classname of your Schema,
40 which might or might not yet exist. Note that you should have a good
41 reason to create this under a new global namespace, otherwise use an
42 existing top level namespace for your schema class.
44 C<create=dynamic> instructs this Helper to generate the named Schema
45 class for you, basing it on L<DBIx::Class::Schema::Loader> (which
46 means the table information will always be dynamically loaded at
47 runtime from the database).
49 C<create=static> instructs this Helper to generate the named Schema
50 class for you, using L<DBIx::Class::Schema::Loader> in "one shot"
51 mode to create a standard, manually-defined L<DBIx::Class::Schema>
52 setup, based on what the Loader sees in your database at this moment.
53 A Schema/Model pair generated this way will not require
54 L<DBIx::Class::Schema::Loader> at runtime, and will not automatically
55 adapt itself to changes in your database structure. You can edit
56 the generated classes by hand to refine them.
58 C<traits> is the list of traits to apply to the model, see
59 L<Catalyst::Model::DBIC::Schema> for details.
61 C<Schema::Loader opts> are described in L</TYPICAL EXAMPLES> below.
63 C<connect_info> arguments are the same as what
64 DBIx::Class::Schema::connect expects, and are storage_type-specific.
65 For DBI-based storage, these arguments are the dsn, username,
66 password, and connect options, respectively. These are optional for
67 existing Schemas, but required if you use either of the C<create=>
70 username and password can be omitted for C<SQLite> dsns.
72 Use of either of the C<create=> options requires L<DBIx::Class::Schema::Loader>.
74 =head1 TYPICAL EXAMPLES
76 Use DBIx::Class::Schema::Loader to create a static DBIx::Class::Schema,
77 and a Model which references it:
79 script/myapp_create.pl model CatalystModelName DBIC::Schema \
80 MyApp::SchemaClass create=static dbi:mysql:foodb myuname mypass
82 Same, with extra connect_info args
83 user and pass can be omitted for sqlite, since they are always empty
85 script/myapp_create.pl model CatalystModelName DBIC::Schema \
86 MyApp::SchemaClass create=static dbi:SQLite:foo.db \
87 AutoCommit=1 cursor_class=DBIx::Class::Cursor::Cached \
88 on_connect_do='["select 1", "select 2"]' quote_char='"'
90 If using a 2 character quote_char:
92 script/myapp_create.pl ... quote_char='[]'
94 B<ON WINDOWS COMMAND LINES QUOTING RULES ARE DIFFERENT>
96 In C<cmd.exe> the above example would be:
98 script/myapp_create.pl model CatalystModelName DBIC::Schema \
99 MyApp::SchemaClass create=static dbi:SQLite:foo.db \
100 AutoCommit=1 cursor_class=DBIx::Class::Cursor::Cached \
101 on_connect_do="[\"select 1\", \"select 2\"]" quote_char="\""
103 Same, but with extra Schema::Loader args (separate multiple values by commas):
105 script/myapp_create.pl model CatalystModelName DBIC::Schema \
106 MyApp::SchemaClass create=static db_schema=foodb components=Foo,Bar \
107 exclude='^(wibble|wobble)$' moniker_map='{ foo => "FOO" }' \
108 dbi:Pg:dbname=foodb myuname mypass
110 See L<DBIx::Class::Schema::Loader::Base> for a list of options
112 Create a dynamic DBIx::Class::Schema::Loader-based Schema,
113 and a Model which references it (B<DEPRECATED>):
115 script/myapp_create.pl model CatalystModelName DBIC::Schema \
116 MyApp::SchemaClass create=dynamic dbi:mysql:foodb myuname mypass
118 Reference an existing Schema of any kind, and provide some connection information for ->config:
120 script/myapp_create.pl model CatalystModelName DBIC::Schema \
121 MyApp::SchemaClass dbi:mysql:foodb myuname mypass
123 Same, but don't supply connect information yet (you'll need to do this
124 in your app config, or [not recommended] in the schema itself).
126 script/myapp_create.pl model ModelName DBIC::Schema My::SchemaClass
130 has helper => (is => 'ro', isa => 'Catalyst::Helper', required => 1);
131 has create => (is => 'rw', isa => CreateOption);
132 has args => (is => 'ro', isa => ArrayRef);
133 has traits => (is => 'rw', isa => ArrayRef);
134 has schema_class => (is => 'ro', isa => Str, required => 1);
135 has loader_args => (is => 'rw', isa => HashRef);
136 has connect_info => (is => 'rw', isa => HashRef);
137 has old_schema => (is => 'rw', isa => Bool, lazy_build => 1);
138 has components => (is => 'rw', isa => ArrayRef);
144 This is called by L<Catalyst::Helper> with the commandline args to generate the
150 my ($package, $helper, $schema_class, @args) = @_;
152 my $self = $package->new(
154 schema_class => $schema_class,
163 my $helper = $self->helper;
164 my @args = $self->args->flatten if $self->args;
166 $helper->{schema_class} = $self->schema_class;
168 @args = $self->_cleanup_args(\@args);
170 my ($traits_idx, $traits);
171 if (($traits_idx = firstidx { ($traits) = /^traits=(\S*)\z/ } @args) != -1) {
172 my @traits = split /,/ => $traits;
174 $self->traits(\@traits);
176 $helper->{traits} = '['
177 .(join ',' => map { qq{'$_'} } ($self->traits->flatten))
180 splice @args, $traits_idx, 1, ();
183 if ($args[0] && $args[0] =~ /^create=(\S*)\z/) {
188 $self->_parse_loader_args(\@args);
190 $helper->{loader_args} = $self->_build_helper_loader_args;
192 if (first { /^dbi:/i } @args) {
193 $helper->{setup_connect_info} = 1;
195 $helper->{connect_info} =
196 $self->_build_helper_connect_info(\@args);
198 $self->_parse_connect_info(\@args);
203 $helper->{generator} = ref $self;
204 $helper->{generator_version} = $VERSION;
209 Can be called on an instance to generate the files.
216 if ($self->create eq 'dynamic') {
217 $self->_print_dynamic_deprecation_warning;
218 $self->_gen_dynamic_schema;
219 } elsif ($self->create eq 'static') {
220 $self->_gen_static_schema;
226 sub _parse_loader_args {
227 my ($self, $args) = @_;
229 my %loader_args = $self->_read_loader_args($args);
231 while (my ($key, $val) = each %loader_args) {
232 next if $key =~ /^(?:components|constraint|exclude)\z/;
234 $loader_args{$key} = $self->_eval($val);
235 die "syntax error for loader args key '$key' with value '$val': $@"
240 $self->_build_loader_components(delete $loader_args{components});
242 $self->components(\@components);
244 for my $re_opt (qw/constraint exclude/) {
245 $loader_args{$re_opt} = qr/$loader_args{$re_opt}/
246 if exists $loader_args{$re_opt};
249 tie my %result, 'Tie::IxHash';
253 (%loader_args ? %loader_args : ()),
254 (!$self->old_schema ? (
258 components => \@components
262 $self->loader_args(\%result);
264 wantarray ? %result : \%result;
267 sub _read_loader_args {
268 my ($self, $args) = @_;
272 while (@$args && $args->[0] !~ /^dbi:/) {
273 my ($key, $val) = split /=/, shift(@$args), 2;
275 if ($self->_is_struct($val)) {
276 $loader_args{$key} = $val;
277 } elsif ((my @vals = split /,/ => $val) > 1) {
278 $loader_args{$key} = \@vals;
280 $loader_args{$key} = $val;
284 wantarray ? %loader_args : \%loader_args;
287 sub _build_helper_loader_args {
290 my $args = $self->loader_args;
292 tie my %loader_args, 'Tie::IxHash';
294 while (my ($arg, $val) = each %$args) {
296 $loader_args{$arg} = $self->_data_struct_to_string($val);
298 $loader_args{$arg} = qq{'$val'};
305 sub _build_loader_components {
306 my ($self, $components) = @_;
308 my @components = $self->old_schema ? () : ('InflateColumn::DateTime');
311 $components = [ $components ] if !ref $components;
312 push @components, @$components;
315 wantarray ? @components : \@components;
318 sub _build_helper_connect_info {
319 my ($self, $connect_info) = @_;
321 my @connect_info = @$connect_info;
323 my ($dsn, $user, $password) = $self->_get_dsn_user_pass(\@connect_info);
325 tie my %helper_connect_info, 'Tie::IxHash';
327 %helper_connect_info = (
330 password => qq{'$password'}
333 for (@connect_info) {
334 if (/^\s*{.*}\s*\z/) {
335 my $hash = $self->_eval($_);
336 die "Syntax errorr in connect_info hash: $_: $@" if $@;
339 for my $key (keys %hash) {
340 my $val = $hash{$key};
343 $val = $self->_data_struct_to_string($val);
345 $val = $self->_quote($val);
348 $helper_connect_info{$key} = $val;
354 my ($key, $val) = split /=/, $_, 2;
356 if ($key eq 'quote_char') {
357 $helper_connect_info{$key} = length($val) == 1 ?
358 $self->_quote($val) :
359 $self->_data_struct_to_string([split //, $val]);
361 $helper_connect_info{$key} = $self->_quote_unless_struct($val);
365 \%helper_connect_info
368 sub _build_old_schema {
371 my @schema_pm = split '::', $self->schema_class;
372 $schema_pm[-1] .= '.pm';
374 File::Spec->catfile($self->helper->{base}, 'lib', @schema_pm);
376 if (-f $schema_file) {
377 my $schema_code = do { local (@ARGV, $/) = $schema_file; <> };
378 return 1 if $schema_code =~ /->load_classes/;
384 sub _data_struct_to_string {
385 my ($self, $data) = @_;
387 local $Data::Dumper::Terse = 1;
388 local $Data::Dumper::Quotekeys = 0;
389 local $Data::Dumper::Indent = 0;
390 local $Data::Dumper::Useqq = 1;
392 return Data::Dumper->Dump([$data]);
395 sub _get_dsn_user_pass {
396 my ($self, $connect_info) = @_;
398 my $dsn = shift @$connect_info;
399 my ($user, $password);
401 if ($dsn =~ /sqlite/i) {
402 ($user, $password) = ('', '');
403 shift @$connect_info while @$connect_info and $connect_info->[0] eq '';
405 ($user, $password) = splice @$connect_info, 0, 2;
408 ($dsn, $user, $password)
411 sub _parse_connect_info {
412 my ($self, $connect_info) = @_;
414 my @connect_info = @$connect_info;
416 my ($dsn, $user, $password) = $self->_get_dsn_user_pass(\@connect_info);
418 tie my %connect_info, 'Tie::IxHash';
419 @connect_info{qw/dsn user password/} = ($dsn, $user, $password);
421 for (@connect_info) {
422 if (/^\s*{.*}\s*\z/) {
423 my $hash = $self->_eval($_);
424 die "Syntax errorr in connect_info hash: $_: $@" if $@;
426 %connect_info = (%connect_info, %$hash);
431 my ($key, $val) = split /=/, $_, 2;
433 if ($key eq 'quote_char') {
434 $connect_info{$key} = length($val) == 1 ? $val : [split //, $val];
435 } elsif ($key =~ /^(?:name_sep|limit_dialect)\z/) {
436 $connect_info{$key} = $val;
438 $connect_info{$key} = $self->_eval($val);
441 die "syntax error for connect_info key '$key' with value '$val': $@"
445 $self->connect_info(\%connect_info);
451 my ($self, $val) = @_;
453 return $val =~ /^\s*[[{]/;
457 my ($self, $val) = @_;
459 return 'q{'.$val.'}';
462 sub _quote_unless_struct {
463 my ($self, $val) = @_;
465 $val = $self->_quote($val) if not $self->_is_struct($val);
471 my ($self, $code) = @_;
473 return $code if looks_like_number $code;
475 return $code if $code =~ m{^[\w;:/]*\z};
477 return eval "{no strict; $code}";
480 sub _gen_dynamic_schema {
483 my $helper = $self->helper;
485 my @schema_parts = split(/\:\:/, $self->schema_class);
486 my $schema_file_part = pop @schema_parts;
488 my $schema_dir = File::Spec->catfile(
489 $helper->{base}, 'lib', @schema_parts
491 my $schema_file = File::Spec->catfile(
492 $schema_dir, $schema_file_part . '.pm'
495 $helper->mk_dir($schema_dir);
496 $helper->render_file('schemaclass', $schema_file);
499 sub _gen_static_schema {
502 die "cannot load schema without connect info" unless $self->connect_info;
504 my $helper = $self->helper;
506 my $schema_dir = File::Spec->catfile($helper->{base}, 'lib');
508 eval { Class::MOP::load_class('DBIx::Class::Schema::Loader') };
509 die "Cannot load DBIx::Class::Schema::Loader: $@" if $@;
511 DBIx::Class::Schema::Loader->import(
512 "dump_to_dir:$schema_dir", 'make_schema_at'
518 [$self->connect_info]
524 my $helper = $self->helper;
526 $helper->render_file('compclass', $helper->{file} );
529 sub _print_dynamic_deprecation_warning {
531 ************************************ WARNING **********************************
532 * create=dynamic is DEPRECATED, please use create=static instead. *
533 *******************************************************************************
535 print "Continue? [y/n]: ";
536 chomp(my $response = <STDIN>);
537 exit 0 if $response =~ /^n(o)?\z/;
541 my ($self, $args) = @_;
543 # remove blanks, ie. someoned doing foo \ bar
544 my @res = grep !/^\s+\z/, @$args;
546 # remove leading whitespace, ie. foo \ bar
554 General Catalyst Stuff:
556 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
557 L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
559 Stuff related to DBIC and this Model style:
561 L<DBIx::Class>, L<DBIx::Class::Schema>,
562 L<DBIx::Class::Schema::Loader>, L<Catalyst::Model::DBIC::Schema>
566 Brandon L Black, C<blblack@gmail.com>
570 Rafael Kitover, C<rkitover at cpan.org>
574 This library is free software, you can redistribute it and/or modify
575 it under the same terms as Perl itself.
586 package [% schema_class %];
589 use base qw/DBIx::Class::Schema::Loader/;
591 __PACKAGE__->loader_options(
592 [%- FOREACH key = loader_args.keys %]
593 [% key %] => [% loader_args.${key} %],
600 [% schema_class %] - L<DBIx::Class::Schema::Loader> class
608 Dynamic L<DBIx::Class::Schema::Loader> schema for use in L<[% class %]>
612 [% generator %] - [% generator_version %]
616 [% author.replace(',+$', '') %]
620 This library is free software, you can redistribute it and/or modify
621 it under the same terms as Perl itself.
631 use base 'Catalyst::Model::DBIC::Schema';
634 schema_class => '[% schema_class %]',
635 [% IF traits %]traits => [% traits %],[% END %]
636 [% IF setup_connect_info %]connect_info => {
637 [%- FOREACH key = connect_info.keys %]
638 [% key %] => [% connect_info.${key} %],
646 [% class %] - Catalyst DBIC Schema Model
654 L<Catalyst::Model::DBIC::Schema> Model using schema L<[% schema_class %]>
658 [% generator %] - [% generator_version %]
662 [% author.replace(',+$', '') %]
666 This library is free software, you can redistribute it and/or modify
667 it under the same terms as Perl itself.