X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FHelper%2FModel%2FDBIC%2FSchema.pm;h=86d5686a3fc27d94a8cb0431c5b8d49f09b44746;hb=6116daed7cd87d13d4a9217ab86d9f221a08537d;hp=19ab06a3b91f861a63406f0bfad7423d7e4a724a;hpb=5d11d759b2ed5340a2f8da9e8cdd1ae8aab52be7;p=catagits%2FCatalyst-Model-DBIC-Schema.git diff --git a/lib/Catalyst/Helper/Model/DBIC/Schema.pm b/lib/Catalyst/Helper/Model/DBIC/Schema.pm index 19ab06a..86d5686 100644 --- a/lib/Catalyst/Helper/Model/DBIC/Schema.pm +++ b/lib/Catalyst/Helper/Model/DBIC/Schema.pm @@ -3,6 +3,7 @@ package Catalyst::Helper::Model::DBIC::Schema; use strict; use warnings; use Carp; +use UNIVERSAL::require; =head1 NAME @@ -10,20 +11,62 @@ Catalyst::Helper::Model::DBIC::Schema - Helper for DBIC Schema Models =head1 SYNOPSIS - script/create.pl model Foo DBIC::Schema Foo::SchemaClass [ dsn user password ] - - Where: - Foo is the short name for the Model class being generated - Foo::SchemaClass is the fully qualified classname of your Schema, - which isa DBIx::Class::Schema defined elsewhere. - dsn, user, and password are optional if connection info is already - defined in your Schema class (as it would be in the case of - DBIx::Class::Schema::Loader). + script/create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass [ create=dynamic | create=static ] [ connect_info arguments ] =head1 DESCRIPTION Helper for the DBIC Schema Models. +=head2 Arguments: + +C< CatalystModelName > is the short name for the Catalyst Model class +being generated (i.e. callable with C< $c->model > + +C< MyApp::SchemaClass > is the fully qualified classname of your Schema, +which might or might not yet exist. Note that you should have a good +reason to create this under a new global namespace, otherwise use an +existing top level namespace for your schema class. + +C< create=dynamic > instructs this Helper to generate the named Schema +class for you, basing it on L (which +means the table information will always be dynamically loaded at +runtime from the database). + +C< create=static > instructs this Helper to generate the named Schema +class for you, using L in "one shot" +mode to create a standard, manually-defined L +setup, based on what the Loader sees in your database at this moment. +A Schema/Model pair generated this way will not require +L at runtime, and will not automatically +adapt itself to changes in your database structure. You can edit +the generated classes by hand to refine them. + +C< connect_info > arguments are the same as what +DBIx::Class::Schema::connect expects, and are storage_type-specific. +For DBI-based storage, these arguments are the dsn, username, +password, and connect options, respectively. These are optional for +existing Schemas, but required if you use either of the C +options. + +Use of either of the C options requires L. + +=head1 TYPICAL EXAMPLES + + # Use DBIx::Class::Schema::Loader to create a static DBIx::Class::Schema, + # and a Model which references it: + script/myapp_create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass create=static dbi:mysql:foodb myuname mypass + + # Create a dynamic DBIx::Class::Schema::Loader-based Schema, + # and a Model which references it: + script/myapp_create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass create=dynamic dbi:mysql:foodb myuname mypass + + # Reference an existing Schema of any kind, and provide some connection information for ->config: + script/myapp_create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass dbi:mysql:foodb myuname mypass + + # Same, but don't supply connect information yet (you'll need to do this + # in your app config, or [not recommended] in the schema itself). + script/myapp_create.pl model ModelName DBIC::Schema My::SchemaClass + =head2 METHODS =head3 mk_compclass @@ -31,15 +74,56 @@ Helper for the DBIC Schema Models. =cut sub mk_compclass { - my ( $self, $helper, $schema_class, $dsn, $user, $pass ) = @_; + my ( $self, $helper, $schema_class, @connect_info) = @_; - $helper->{schema_class} = $schema_class || ''; + $helper->{schema_class} = $schema_class + or croak "Must supply schema class name"; - if(defined($dsn)) { + my $create = ''; + if($connect_info[0] && $connect_info[0] =~ /^create=(dynamic|static)$/) { + $create = $1; + shift @connect_info; + } + + if(@connect_info) { $helper->{setup_connect_info} = 1; - $helper->{dsn} = $dsn || ''; - $helper->{user} = $user || ''; - $helper->{pass} = $pass || ''; + my @helper_connect_info = @connect_info; + for(@helper_connect_info) { + $_ = qq{'$_'} if $_ !~ /^\s*[[{]/; + } + $helper->{connect_info} = \@helper_connect_info; + } + + if($create eq 'dynamic') { + my @schema_parts = split(/\:\:/, $helper->{schema_class}); + my $schema_file_part = pop @schema_parts; + + my $schema_dir = File::Spec->catfile( $helper->{base}, 'lib', @schema_parts ); + my $schema_file = File::Spec->catfile( $schema_dir, $schema_file_part . '.pm' ); + + $helper->mk_dir($schema_dir); + $helper->render_file( 'schemaclass', $schema_file ); + } + elsif($create eq 'static') { + my $schema_dir = File::Spec->catfile( $helper->{base}, 'lib' ); + DBIx::Class::Schema::Loader->use("dump_to_dir:$schema_dir", 'make_schema_at') + or croak "Cannot load DBIx::Class::Schema::Loader: $@"; + + my @loader_connect_info = @connect_info; + my $num = 6; # argument number on the commandline for "dbi:..." + for(@loader_connect_info) { + if(/^\s*[[{]/) { + $_ = eval "$_"; + croak "Perl syntax error in commandline argument $num: $@" if $@; + } + $num++; + } + + make_schema_at( + $schema_class, + { relationships => 1 }, + \@loader_connect_info, + ); } my $file = $helper->{file}; @@ -56,8 +140,7 @@ L, L, L, Stuff related to DBIC and this Model style: L, L, -L, L, -L +L, L =head1 AUTHOR @@ -76,6 +159,42 @@ __DATA__ =begin pod_to_ignore +__schemaclass__ +package [% schema_class %]; + +use strict; +use base qw/DBIx::Class::Schema::Loader/; + +__PACKAGE__->loader_options( + relationships => 1, + # debug => 1, +); + +=head1 NAME + +[% schema_class %] - DBIx::Class::Schema::Loader class + +=head1 SYNOPSIS + +See L<[% app %]> + +=head1 DESCRIPTION + +Generated by L for use in L<[% class %]> + +=head1 AUTHOR + +[% author %] + +=head1 LICENSE + +This library is free software, you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut + +1; + __compclass__ package [% class %]; @@ -84,33 +203,22 @@ use base 'Catalyst::Model::DBIC::Schema'; __PACKAGE__->config( schema_class => '[% schema_class %]', - [% IF setup_connect_info %] - connect_info => [ '[% dsn %]', - '[% user %]', - '[% pass %]', - { - RaiseError => 1, - PrintError => 0, - ShowErrorStatement => 1, - TraceLevel => 0, - AutoCommit => 1, - } - ], - [% END %] + [% IF setup_connect_info %]connect_info => [ + [% FOREACH arg = connect_info %][% arg %], + [% END %] + ],[% END %] ); =head1 NAME [% class %] - Catalyst DBIC Schema Model - =head1 SYNOPSIS See L<[% app %]> =head1 DESCRIPTION -L Model using schema -L<[% schema_class %]> +L Model using schema L<[% schema_class %]> =head1 AUTHOR