1 package Catalyst::Helper::Model::DBIC::Schema;
5 no warnings 'uninitialized';
9 use parent 'Class::Accessor::Fast';
12 use UNIVERSAL::require;
17 __PACKAGE__->mk_accessors(qw/
18 helper schema_class loader_args connect_info _old_schema
23 Catalyst::Helper::Model::DBIC::Schema - Helper for DBIC Schema Models
27 script/create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass \
28 [ create=dynamic | create=static ] [ Schema::Loader opts ] \
29 [ dsn user pass ] [ other connect_info arguments ]
33 Helper for the DBIC Schema Models.
37 C<CatalystModelName> is the short name for the Catalyst Model class
38 being generated (i.e. callable with C<$c-E<gt>model('CatalystModelName')>).
40 C<MyApp::SchemaClass> is the fully qualified classname of your Schema,
41 which might or might not yet exist. Note that you should have a good
42 reason to create this under a new global namespace, otherwise use an
43 existing top level namespace for your schema class.
45 C<create=dynamic> instructs this Helper to generate the named Schema
46 class for you, basing it on L<DBIx::Class::Schema::Loader> (which
47 means the table information will always be dynamically loaded at
48 runtime from the database).
50 C<create=static> instructs this Helper to generate the named Schema
51 class for you, using L<DBIx::Class::Schema::Loader> in "one shot"
52 mode to create a standard, manually-defined L<DBIx::Class::Schema>
53 setup, based on what the Loader sees in your database at this moment.
54 A Schema/Model pair generated this way will not require
55 L<DBIx::Class::Schema::Loader> at runtime, and will not automatically
56 adapt itself to changes in your database structure. You can edit
57 the generated classes by hand to refine them.
59 C<connect_info> arguments are the same as what
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=>
66 Use of either of the C<create=> options requires L<DBIx::Class::Schema::Loader>.
68 =head1 TYPICAL EXAMPLES
70 # Use DBIx::Class::Schema::Loader to create a static DBIx::Class::Schema,
71 # and a Model which references it:
72 script/myapp_create.pl model CatalystModelName DBIC::Schema \
73 MyApp::SchemaClass create=static dbi:mysql:foodb myuname mypass
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"]'
81 # Same, but with extra Schema::Loader args (separate multiple values by commas):
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
87 # See DBIx::Class::Schema::Loader::Base for list of options
89 # Create a dynamic DBIx::Class::Schema::Loader-based Schema,
90 # and a Model which references it:
91 script/myapp_create.pl model CatalystModelName DBIC::Schema \
92 MyApp::SchemaClass create=dynamic dbi:mysql:foodb myuname mypass
94 # Reference an existing Schema of any kind, and provide some connection information for ->config:
95 script/myapp_create.pl model CatalystModelName DBIC::Schema \
96 MyApp::SchemaClass dbi:mysql:foodb myuname mypass
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
106 This is called by L<Catalyst::Helper> with the commandline args to generate the
112 my ($package, $helper, $schema_class, @args) = @_;
114 my $self = $package->new;
116 $helper->{schema_class} = $schema_class
117 or croak "Must supply schema class name";
119 $self->schema_class($schema_class);
120 $self->helper($helper);
123 if ($args[0] && $args[0] =~ /^create=(dynamic|static)$/) {
128 $self->_parse_loader_args(\@args);
130 if (List::Util::first { /dbi:/ } @args) {
131 $helper->{setup_connect_info} = 1;
133 $helper->{connect_info} =
134 $self->_build_helper_connect_info(\@args);
136 $self->_parse_connect_info(\@args) if $create eq 'static';
141 $helper->{generator} = ref $self;
142 $helper->{generator_version} = $VERSION;
144 if ($create eq 'dynamic') {
145 $self->helper->{loader_args} = $self->_build_helper_loader_args;
146 $self->_gen_dynamic_schema;
147 } elsif ($create eq 'static') {
148 $self->_gen_static_schema;
154 sub _parse_loader_args {
155 my ($self, $args) = @_;
157 my %loader_args = $self->_read_loader_args($args);
159 while (my ($key, $val) = each %loader_args) {
160 next if $key =~ /^(?:components|constraint|exclude)\z/;
162 $loader_args{$key} = eval $val;
163 croak "syntax error for loader args key '$key' with value '$val': $@"
168 $self->_build_loader_components(delete $loader_args{components});
170 for my $re_opt (qw/constraint exclude/) {
171 $loader_args{$re_opt} = qr/$loader_args{$re_opt}/
172 if exists $loader_args{$re_opt};
175 tie my %result, 'Tie::IxHash';
179 (%loader_args ? %loader_args : ()),
180 (!$self->_is_old_schema ? (
184 components => \@components
188 $self->loader_args(\%result);
190 wantarray ? %result : \%result;
193 sub _read_loader_args {
194 my ($self, $args) = @_;
198 while (@$args && $args->[0] !~ /^dbi:/) {
199 my ($key, $val) = split /=/, shift(@$args), 2;
201 if ((my @vals = split /,/ => $val) > 1) {
202 $loader_args{$key} = \@vals;
204 $loader_args{$key} = $val;
208 wantarray ? %loader_args : \%loader_args;
211 sub _build_helper_loader_args {
214 my $args = $self->loader_args;
216 tie my %loader_args, 'Tie::IxHash';
218 while (my ($arg, $val) = each %$args) {
220 $loader_args{$arg} = $self->_data_struct_to_string($val);
222 $loader_args{$arg} = qq{'$val'};
229 sub _build_loader_components {
230 my ($self, $components) = @_;
232 my @components = $self->_is_old_schema ? () : ('InflateColumn::DateTime');
235 $components = [ $components ] if !ref $components;
236 push @components, @$components;
239 wantarray ? @components : \@components;
242 sub _build_helper_connect_info {
243 my ($self, $connect_info) = @_;
245 my @connect_info = @$connect_info;
247 my ($dsn, $user, $password) = splice @connect_info, 0, 3;
249 tie my %helper_connect_info, 'Tie::IxHash';
251 %helper_connect_info = (
254 password => qq{'$password'}
257 for (@connect_info) {
258 if (/^\s*{.*}\s*\z/) {
260 croak "Syntax errorr in connect_info hash: $_: $@" if $@;
263 for my $key (keys %hash) {
264 my $val = $hash{$key};
267 $val = $self->_data_struct_to_string($val);
272 $helper_connect_info{$key} = $val;
278 my ($key, $val) = split /=/, $_, 2;
280 $helper_connect_info{$key} = $self->_quote_unless_struct($val);
283 \%helper_connect_info
286 sub _data_struct_to_string {
287 my ($self, $data) = @_;
289 local $Data::Dumper::Terse = 1;
290 local $Data::Dumper::Quotekeys = 0;
291 local $Data::Dumper::Indent = 0;
292 local $Data::Dumper::Useqq = 1;
294 return Data::Dumper->Dump([$data]);
297 sub _parse_connect_info {
298 my ($self, $connect_info) = @_;
300 my @connect_info = @$connect_info;
302 my ($dsn, $user, $password) = splice @connect_info, 0, 3;
304 tie my %connect_info, 'Tie::IxHash';
305 @connect_info{qw/dsn user password/} = ($dsn, $user, $password);
307 for (@connect_info) {
308 if (/^\s*{.*}\s*\z/) {
310 croak "Syntax errorr in connect_info hash: $_: $@" if $@;
312 %connect_info = (%connect_info, %$hash);
317 my ($key, $val) = split /=/, $_, 2;
319 $connect_info{$key} = eval $val;
320 croak "syntax error for connect_info key '$key' with value '$val': $@"
324 $self->connect_info(\%connect_info);
329 sub _quote_unless_struct {
330 my ($self, $val) = @_;
332 $val = qq{'$val'} if $val !~ /^\s*[[{]/;
337 sub _gen_dynamic_schema {
340 my $helper = $self->helper;
342 my @schema_parts = split(/\:\:/, $self->schema_class);
343 my $schema_file_part = pop @schema_parts;
345 my $schema_dir = File::Spec->catfile(
346 $helper->{base}, 'lib', @schema_parts
348 my $schema_file = File::Spec->catfile(
349 $schema_dir, $schema_file_part . '.pm'
352 $helper->mk_dir($schema_dir);
353 $helper->render_file('schemaclass', $schema_file);
356 sub _gen_static_schema {
359 croak "cannot load schema without connect info" unless $self->connect_info;
361 my $helper = $self->helper;
363 my $schema_dir = File::Spec->catfile($helper->{base}, 'lib');
365 DBIx::Class::Schema::Loader->use(
366 "dump_to_dir:$schema_dir", 'make_schema_at'
367 ) or croak "Cannot load DBIx::Class::Schema::Loader: $@";
372 [$self->connect_info]
379 return $self->_old_schema if defined $self->_old_schema;
381 my @schema_pm = split '::', $self->schema_class;
382 $schema_pm[-1] .= '.pm';
384 File::Spec->catfile($self->helper->{base}, 'lib', @schema_pm);
386 if (-f $schema_file) {
387 my $schema_code = do { local (@ARGV, $/) = $schema_file; <> };
388 $self->_old_schema(1) if $schema_code =~ /->load_classes/;
390 $self->_old_schema(0);
393 return $self->_old_schema;
398 my $helper = $self->helper;
400 $helper->render_file('compclass', $helper->{file} );
405 General Catalyst Stuff:
407 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
408 L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
410 Stuff related to DBIC and this Model style:
412 L<DBIx::Class>, L<DBIx::Class::Schema>,
413 L<DBIx::Class::Schema::Loader>, L<Catalyst::Model::DBIC::Schema>
417 Brandon L Black, C<blblack@gmail.com>
421 This library is free software, you can redistribute it and/or modify
422 it under the same terms as Perl itself.
433 package [% schema_class %];
436 use base qw/DBIx::Class::Schema::Loader/;
438 __PACKAGE__->loader_options(
439 [%- FOREACH key = loader_args.keys %]
440 [% key %] => [% loader_args.${key} %],
447 [% schema_class %] - L<DBIx::Class::Schema::Loader> class
455 Dynamic L<DBIx::Class::Schema::Loader> schema for use in L<[% class %]>
459 [% generator %] - [% generator_version %]
463 [% author.replace(',+$', '') %]
467 This library is free software, you can redistribute it and/or modify
468 it under the same terms as Perl itself.
478 use base 'Catalyst::Model::DBIC::Schema';
481 schema_class => '[% schema_class %]',
482 [% IF setup_connect_info %]connect_info => {
483 [%- FOREACH key = connect_info.keys %]
484 [% key %] => [% connect_info.${key} %],
492 [% class %] - Catalyst DBIC Schema Model
500 L<Catalyst::Model::DBIC::Schema> Model using schema L<[% schema_class %]>
504 [% generator %] - [% generator_version %]
508 [% author.replace(',+$', '') %]
512 This library is free software, you can redistribute it and/or modify
513 it under the same terms as Perl itself.