1 package Catalyst::Helper::Model::DBIC::Schema;
3 use namespace::autoclean;
5 no warnings 'uninitialized';
8 $VERSION = eval $VERSION;
13 use List::Util 'first';
14 use MooseX::Types::Moose qw/Str HashRef Bool ArrayRef/;
15 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 Coderefs are also supported:
112 script/myapp_create.pl model CatalystModelName DBIC::Schema \
113 MyApp::SchemaClass create=static \
114 inflect_singular='sub { $_[0] =~ /\A(.+?)(_id)?\z/; $1 }' \
115 moniker_map='sub { join(q{}, map ucfirst, split(/[\W_]+/, lc $_[0])); }' \
116 dbi:mysql:foodb myuname mypass
118 See L<DBIx::Class::Schema::Loader::Base> for a list of options
120 Create a dynamic DBIx::Class::Schema::Loader-based Schema,
121 and a Model which references it (B<DEPRECATED>):
123 script/myapp_create.pl model CatalystModelName DBIC::Schema \
124 MyApp::SchemaClass create=dynamic dbi:mysql:foodb myuname mypass
126 Reference an existing Schema of any kind, and provide some connection information for ->config:
128 script/myapp_create.pl model CatalystModelName DBIC::Schema \
129 MyApp::SchemaClass dbi:mysql:foodb myuname mypass
131 Same, but don't supply connect information yet (you'll need to do this
132 in your app config, or [not recommended] in the schema itself).
134 script/myapp_create.pl model ModelName DBIC::Schema My::SchemaClass
138 has helper => (is => 'ro', isa => 'Catalyst::Helper', required => 1);
139 has create => (is => 'rw', isa => CreateOption);
140 has args => (is => 'ro', isa => ArrayRef);
141 has traits => (is => 'rw', isa => ArrayRef);
142 has schema_class => (is => 'ro', isa => Str, required => 1);
143 has loader_args => (is => 'rw', isa => HashRef);
144 has connect_info => (is => 'rw', isa => HashRef);
145 has old_schema => (is => 'rw', isa => Bool, lazy_build => 1);
146 has components => (is => 'rw', isa => ArrayRef);
152 This is called by L<Catalyst::Helper> with the commandline args to generate the
158 my ($package, $helper, $schema_class, @args) = @_;
160 my $self = $package->new(
162 schema_class => $schema_class,
171 my $helper = $self->helper;
172 my @args = @{ $self->args || [] };
174 $helper->{schema_class} = $self->schema_class;
176 @args = $self->_cleanup_args(\@args);
178 my ($traits_idx, $traits);
179 if (($traits_idx = firstidx { ($traits) = /^traits=(\S*)\z/ } @args) != -1) {
180 my @traits = split /,/ => $traits;
182 $self->traits(\@traits);
184 $helper->{traits} = '['
185 .(join ',' => map { qq{'$_'} } @traits)
188 splice @args, $traits_idx, 1, ();
191 if ($args[0] && $args[0] =~ /^create=(\S*)\z/) {
196 $self->_parse_loader_args(\@args);
198 $helper->{loader_args} = $self->_build_helper_loader_args;
203 if (first { ($dbi_dsn_part) = /^(dbi):/i } @args) {
205 qq{DSN must start with 'dbi:' not '$dbi_dsn_part' (case matters!)}
206 if $dbi_dsn_part ne 'dbi';
208 $helper->{setup_connect_info} = 1;
210 $helper->{connect_info} =
211 $self->_build_helper_connect_info(\@args);
213 $self->_parse_connect_info(\@args);
216 $helper->{generator} = ref $self;
217 $helper->{generator_version} = $VERSION;
222 Can be called on an instance to generate the files.
229 if ($self->create eq 'dynamic') {
230 $self->_print_dynamic_deprecation_warning;
231 $self->_gen_dynamic_schema;
232 } elsif ($self->create eq 'static') {
233 $self->_gen_static_schema;
239 sub _parse_loader_args {
240 my ($self, $args) = @_;
242 my %loader_args = $self->_read_loader_args($args);
244 while (my ($key, $val) = each %loader_args) {
245 next if $key =~ /^(?:components|constraint|exclude)\z/;
247 $loader_args{$key} = $self->_eval($val);
248 die "syntax error for loader args key '$key' with value '$val': $@"
252 my @components = $self->_build_loader_components(
253 delete $loader_args{components},
254 $loader_args{use_namespaces},
257 $self->components(\@components);
259 for my $re_opt (qw/constraint exclude/) {
260 $loader_args{$re_opt} = qr/$loader_args{$re_opt}/
261 if exists $loader_args{$re_opt};
264 tie my %result, 'Tie::IxHash';
268 (!$self->old_schema ? (
272 components => \@components
274 (%loader_args ? %loader_args : ()),
277 $self->loader_args(\%result);
279 wantarray ? %result : \%result;
282 sub _read_loader_args {
283 my ($self, $args) = @_;
287 while (@$args && $args->[0] !~ /^dbi:/i) {
288 my ($key, $val) = split /=/, shift(@$args), 2;
290 if ($self->_is_struct($val)) {
291 $loader_args{$key} = $val;
292 } elsif ((my @vals = split /,/ => $val) > 1) {
293 $loader_args{$key} = \@vals;
295 $loader_args{$key} = $val;
299 wantarray ? %loader_args : \%loader_args;
302 sub _build_helper_loader_args {
305 my $args = $self->loader_args;
307 tie my %loader_args, 'Tie::IxHash';
309 while (my ($arg, $val) = each %$args) {
311 $loader_args{$arg} = $self->_data_struct_to_string($val);
313 $loader_args{$arg} = qq{'$val'};
320 sub _build_loader_components {
321 my ($self, $components, $use_namespaces) = @_;
323 my @components = $self->old_schema && (not $use_namespaces) ? ()
324 : ('InflateColumn::DateTime');
327 $components = [ $components ] if !ref $components;
328 push @components, @$components;
331 wantarray ? @components : \@components;
334 sub _build_helper_connect_info {
335 my ($self, $connect_info) = @_;
337 my @connect_info = @$connect_info;
339 my ($dsn, $user, $password) = $self->_get_dsn_user_pass(\@connect_info);
341 tie my %helper_connect_info, 'Tie::IxHash';
343 %helper_connect_info = (
346 password => qq{'$password'}
349 for (@connect_info) {
350 if (/^\s*{.*}\s*\z/) {
351 my $hash = $self->_eval($_);
352 die "Syntax errorr in connect_info hash: $_: $@" if $@;
355 for my $key (keys %hash) {
356 my $val = $hash{$key};
359 $val = $self->_data_struct_to_string($val);
361 $val = $self->_quote($val);
364 $helper_connect_info{$key} = $val;
370 my ($key, $val) = split /=/, $_, 2;
372 if ($key eq 'quote_char') {
373 $helper_connect_info{$key} = length($val) == 1 ?
374 $self->_quote($val) :
375 $self->_data_struct_to_string([split //, $val]);
377 $helper_connect_info{$key} = $self->_quote_unless_struct($val);
381 \%helper_connect_info
384 sub _build_old_schema {
387 my @schema_pm = split '::', $self->schema_class;
388 $schema_pm[-1] .= '.pm';
390 File::Spec->catfile($self->helper->{base}, 'lib', @schema_pm);
392 if (-f $schema_file) {
393 my $schema_code = do { local (@ARGV, $/) = $schema_file; <> };
394 return 1 if $schema_code =~ /->load_classes/;
400 sub _data_struct_to_string {
401 my ($self, $data) = @_;
403 local $Data::Dumper::Terse = 1;
404 local $Data::Dumper::Quotekeys = 0;
405 local $Data::Dumper::Indent = 0;
406 local $Data::Dumper::Useqq = 1;
408 return Data::Dumper->Dump([$data]);
411 sub _get_dsn_user_pass {
412 my ($self, $connect_info) = @_;
414 my $dsn = shift @$connect_info;
415 my ($user, $password);
417 if ($dsn =~ /sqlite/i) {
418 ($user, $password) = ('', '');
419 shift @$connect_info while @$connect_info and $connect_info->[0] eq '';
421 ($user, $password) = splice @$connect_info, 0, 2;
424 ($dsn, $user, $password)
427 sub _parse_connect_info {
428 my ($self, $connect_info) = @_;
430 my @connect_info = @$connect_info;
432 my ($dsn, $user, $password) = $self->_get_dsn_user_pass(\@connect_info);
434 tie my %connect_info, 'Tie::IxHash';
435 @connect_info{qw/dsn user password/} = ($dsn, $user, $password);
437 for (@connect_info) {
438 if (/^\s*{.*}\s*\z/) {
439 my $hash = $self->_eval($_);
440 die "Syntax errorr in connect_info hash: $_: $@" if $@;
442 %connect_info = (%connect_info, %$hash);
447 my ($key, $val) = split /=/, $_, 2;
449 if ($key eq 'quote_char') {
450 $connect_info{$key} = length($val) == 1 ? $val : [split //, $val];
451 } elsif ($key =~ /^(?:name_sep|limit_dialect)\z/) {
452 $connect_info{$key} = $val;
454 $connect_info{$key} = $self->_eval($val);
457 die "syntax error for connect_info key '$key' with value '$val': $@"
461 $self->connect_info(\%connect_info);
467 my ($self, $val) = @_;
469 return $val =~ /^\s*(?:sub|[[{])/;
473 my ($self, $val) = @_;
475 return 'q{'.$val.'}';
478 sub _quote_unless_struct {
479 my ($self, $val) = @_;
481 $val = $self->_quote($val) if not $self->_is_struct($val);
487 my ($self, $code) = @_;
489 return $code if looks_like_number $code;
491 return $code if $code =~ m{^[\w;:/]*\z};
493 return eval "{no strict; $code}";
496 sub _gen_dynamic_schema {
499 my $helper = $self->helper;
501 my @schema_parts = split(/\:\:/, $self->schema_class);
502 my $schema_file_part = pop @schema_parts;
504 my $schema_dir = File::Spec->catfile(
505 $helper->{base}, 'lib', @schema_parts
507 my $schema_file = File::Spec->catfile(
508 $schema_dir, $schema_file_part . '.pm'
511 $helper->mk_dir($schema_dir);
512 $helper->render_file('schemaclass', $schema_file);
515 sub _gen_static_schema {
518 die "cannot load schema without connect info" unless $self->connect_info;
520 my $helper = $self->helper;
522 my $schema_dir = File::Spec->catfile($helper->{base}, 'lib');
524 eval { Class::MOP::load_class('DBIx::Class::Schema::Loader') };
525 die "Cannot load DBIx::Class::Schema::Loader: $@" if $@;
527 DBIx::Class::Schema::Loader->import(
528 "dump_to_dir:$schema_dir", 'make_schema_at'
534 [$self->connect_info]
540 my $helper = $self->helper;
542 $helper->render_file('compclass', $helper->{file} );
545 sub _print_dynamic_deprecation_warning {
547 ************************************ WARNING **********************************
548 * create=dynamic is DEPRECATED, please use create=static instead. *
549 *******************************************************************************
551 print "Continue? [y/n]: ";
552 chomp(my $response = <STDIN>);
553 exit 0 if $response =~ /^n(o)?\z/;
557 my ($self, $args) = @_;
559 # remove blanks, ie. someoned doing foo \ bar
560 my @res = grep !/^\s+\z/, @$args;
562 # remove leading whitespace, ie. foo \ bar
570 General Catalyst Stuff:
572 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
573 L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
575 Stuff related to DBIC and this Model style:
577 L<DBIx::Class>, L<DBIx::Class::Schema>,
578 L<DBIx::Class::Schema::Loader>, L<Catalyst::Model::DBIC::Schema>
582 See L<Catalyst::Model::DBIC::Schema/AUTHOR> and
583 L<Catalyst::Model::DBIC::Schema/CONTRIBUTORS>.
587 See L<Catalyst::Model::DBIC::Schema/COPYRIGHT>.
591 This library is free software, you can redistribute it and/or modify
592 it under the same terms as Perl itself.
603 package [% schema_class %];
606 use base qw/DBIx::Class::Schema::Loader/;
608 __PACKAGE__->loader_options(
609 [%- FOREACH key = loader_args.keys %]
610 [% key %] => [% loader_args.${key} %],
617 [% schema_class %] - L<DBIx::Class::Schema::Loader> class
625 Dynamic L<DBIx::Class::Schema::Loader> schema for use in L<[% class %]>
629 [% generator %] - [% generator_version %]
633 [% author.replace(',+$', '') %]
637 This library is free software, you can redistribute it and/or modify
638 it under the same terms as Perl itself.
648 use base 'Catalyst::Model::DBIC::Schema';
651 schema_class => '[% schema_class %]',
652 [% IF traits %]traits => [% traits %],[% END %]
653 [% IF setup_connect_info %]connect_info => {
654 [%- FOREACH key = connect_info.keys %]
655 [% key %] => [% connect_info.${key} %],
663 [% class %] - Catalyst DBIC Schema Model
671 L<Catalyst::Model::DBIC::Schema> Model using schema L<[% schema_class %]>
675 [% generator %] - [% generator_version %]
679 [% author.replace(',+$', '') %]
683 This library is free software, you can redistribute it and/or modify
684 it under the same terms as Perl itself.