X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FHelper%2FModel%2FDBIC%2FSchema.pm;h=b0f967e264efed29a0834da58fca47e60a69725e;hb=2ff00e2b7f50d7a5a8403051dfbbad12d92398e9;hp=86d5686a3fc27d94a8cb0431c5b8d49f09b44746;hpb=6116daed7cd87d13d4a9217ab86d9f221a08537d;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 86d5686..b0f967e 100644 --- a/lib/Catalyst/Helper/Model/DBIC/Schema.pm +++ b/lib/Catalyst/Helper/Model/DBIC/Schema.pm @@ -2,8 +2,21 @@ package Catalyst::Helper::Model::DBIC::Schema; use strict; use warnings; +no warnings 'uninitialized'; + +our $VERSION = '0.24'; + +use parent 'Class::Accessor::Fast'; + use Carp; use UNIVERSAL::require; +use Tie::IxHash (); +use Data::Dumper (); +use List::Util (); + +__PACKAGE__->mk_accessors(qw/ + helper schema_class loader_args connect_info _old_schema +/); =head1 NAME @@ -11,7 +24,10 @@ Catalyst::Helper::Model::DBIC::Schema - Helper for DBIC Schema Models =head1 SYNOPSIS - script/create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass [ create=dynamic | create=static ] [ connect_info arguments ] + script/create.pl model CatalystModelName DBIC::Schema MyApp::SchemaClass \ + [ create=dynamic | create=static ] [ roles=role1,role2... ] \ + [ Schema::Loader opts ] [ dsn user pass ] \ + [ other connect_info args ] =head1 DESCRIPTION @@ -19,20 +35,20 @@ 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 is the short name for the Catalyst Model class +being generated (i.e. callable with C<$c-Emodel('CatalystModelName')>). -C< MyApp::SchemaClass > is the fully qualified classname of your Schema, +C 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 +C 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 +C 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. @@ -41,7 +57,12 @@ 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 +C is the list of roles to apply to the model, see +L for details. + +C are described in L below. + +C 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 @@ -54,80 +75,342 @@ Use of either of the C options requires L. # 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 + script/myapp_create.pl model CatalystModelName DBIC::Schema \ + MyApp::SchemaClass create=static dbi:mysql:foodb myuname mypass + + # Same, with extra connect_info args + script/myapp_create.pl model CatalystModelName DBIC::Schema \ + MyApp::SchemaClass create=static dbi:SQLite:foo.db '' '' \ + AutoCommit=1 cursor_class=DBIx::Class::Cursor::Cached \ + on_connect_do='["select 1", "select 2"]' + + # Same, but with extra Schema::Loader args (separate multiple values by commas): + script/myapp_create.pl model CatalystModelName DBIC::Schema \ + MyApp::SchemaClass create=static db_schema=foodb components=Foo,Bar \ + exclude='^wibble|wobble$' moniker_map='{ foo => "FFFFUUUU" }' \ + dbi:Pg:dbname=foodb myuname mypass + + # See DBIx::Class::Schema::Loader::Base for list of options # 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 + 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 + 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 +=head1 METHODS + +=head2 mk_compclass -=head3 mk_compclass +This is called by L with the commandline args to generate the +files. =cut sub mk_compclass { - my ( $self, $helper, $schema_class, @connect_info) = @_; + my ($package, $helper, $schema_class, @args) = @_; + + my $self = $package->new; $helper->{schema_class} = $schema_class or croak "Must supply schema class name"; + $self->schema_class($schema_class); + $self->helper($helper); + my $create = ''; - if($connect_info[0] && $connect_info[0] =~ /^create=(dynamic|static)$/) { + if ($args[0] && $args[0] =~ /^create=(dynamic|static)\z/) { $create = $1; - shift @connect_info; + shift @args; + + if ($args[0] && $args[0] =~ /^roles=(.*)\z/) { + $helper->{roles} = '[' + .(join ',' => map { qq{'$_'} } (split /,/ => $1)) + .']'; + shift @args; + } + + if (@args) { + $self->_parse_loader_args(\@args); + + if (List::Util::first { /dbi:/ } @args) { + $helper->{setup_connect_info} = 1; + + $helper->{connect_info} = + $self->_build_helper_connect_info(\@args); + + $self->_parse_connect_info(\@args) if $create eq 'static'; + } + } + } + + $helper->{generator} = ref $self; + $helper->{generator_version} = $VERSION; + + if ($create eq 'dynamic') { + $self->helper->{loader_args} = $self->_build_helper_loader_args; + $self->_gen_dynamic_schema; + } elsif ($create eq 'static') { + $self->_gen_static_schema; + } + + $self->_gen_model; +} + +sub _parse_loader_args { + my ($self, $args) = @_; + + my %loader_args = $self->_read_loader_args($args); + + while (my ($key, $val) = each %loader_args) { + next if $key =~ /^(?:components|constraint|exclude)\z/; + + $loader_args{$key} = eval $val; + croak "syntax error for loader args key '$key' with value '$val': $@" + if $@; } - if(@connect_info) { - $helper->{setup_connect_info} = 1; - my @helper_connect_info = @connect_info; - for(@helper_connect_info) { - $_ = qq{'$_'} if $_ !~ /^\s*[[{]/; + my @components = + $self->_build_loader_components(delete $loader_args{components}); + + for my $re_opt (qw/constraint exclude/) { + $loader_args{$re_opt} = qr/$loader_args{$re_opt}/ + if exists $loader_args{$re_opt}; + } + + tie my %result, 'Tie::IxHash'; + + %result = ( + relationships => 1, + (%loader_args ? %loader_args : ()), + (!$self->_is_old_schema ? ( + use_namespaces => 1 + ) : ()), + (@components ? ( + components => \@components + ) : ()) + ); + + $self->loader_args(\%result); + + wantarray ? %result : \%result; +} + +sub _read_loader_args { + my ($self, $args) = @_; + + my %loader_args; + + while (@$args && $args->[0] !~ /^dbi:/) { + my ($key, $val) = split /=/, shift(@$args), 2; + + if ((my @vals = split /,/ => $val) > 1) { + $loader_args{$key} = \@vals; + } else { + $loader_args{$key} = $val; } - $helper->{connect_info} = \@helper_connect_info; } - if($create eq 'dynamic') { - my @schema_parts = split(/\:\:/, $helper->{schema_class}); - my $schema_file_part = pop @schema_parts; + wantarray ? %loader_args : \%loader_args; +} - my $schema_dir = File::Spec->catfile( $helper->{base}, 'lib', @schema_parts ); - my $schema_file = File::Spec->catfile( $schema_dir, $schema_file_part . '.pm' ); +sub _build_helper_loader_args { + my $self = shift; - $helper->mk_dir($schema_dir); - $helper->render_file( 'schemaclass', $schema_file ); + my $args = $self->loader_args; + + tie my %loader_args, 'Tie::IxHash'; + + while (my ($arg, $val) = each %$args) { + if (ref $val) { + $loader_args{$arg} = $self->_data_struct_to_string($val); + } else { + $loader_args{$arg} = qq{'$val'}; + } } - 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 $@; + + \%loader_args +} + +sub _build_loader_components { + my ($self, $components) = @_; + + my @components = $self->_is_old_schema ? () : ('InflateColumn::DateTime'); + + if ($components) { + $components = [ $components ] if !ref $components; + push @components, @$components; + } + + wantarray ? @components : \@components; +} + +sub _build_helper_connect_info { + my ($self, $connect_info) = @_; + + my @connect_info = @$connect_info; + + my ($dsn, $user, $password) = splice @connect_info, 0, 3; + + tie my %helper_connect_info, 'Tie::IxHash'; + + %helper_connect_info = ( + dsn => qq{'$dsn'}, + user => qq{'$user'}, + password => qq{'$password'} + ); + + for (@connect_info) { + if (/^\s*{.*}\s*\z/) { + my $hash = eval $_; + croak "Syntax errorr in connect_info hash: $_: $@" if $@; + my %hash = %$hash; + + for my $key (keys %hash) { + my $val = $hash{$key}; + + if (ref $val) { + $val = $self->_data_struct_to_string($val); + } else { + $val = qq{'$val'}; + } + + $helper_connect_info{$key} = $val; } - $num++; + + next; + } + + my ($key, $val) = split /=/, $_, 2; + + $helper_connect_info{$key} = $self->_quote_unless_struct($val); + } + + \%helper_connect_info +} + +sub _data_struct_to_string { + my ($self, $data) = @_; + + local $Data::Dumper::Terse = 1; + local $Data::Dumper::Quotekeys = 0; + local $Data::Dumper::Indent = 0; + local $Data::Dumper::Useqq = 1; + + return Data::Dumper->Dump([$data]); +} + +sub _parse_connect_info { + my ($self, $connect_info) = @_; + + my @connect_info = @$connect_info; + + my ($dsn, $user, $password) = splice @connect_info, 0, 3; + + tie my %connect_info, 'Tie::IxHash'; + @connect_info{qw/dsn user password/} = ($dsn, $user, $password); + + for (@connect_info) { + if (/^\s*{.*}\s*\z/) { + my $hash = eval $_; + croak "Syntax errorr in connect_info hash: $_: $@" if $@; + + %connect_info = (%connect_info, %$hash); + + next; } - make_schema_at( - $schema_class, - { relationships => 1 }, - \@loader_connect_info, - ); + my ($key, $val) = split /=/, $_, 2; + + $connect_info{$key} = eval $val; + croak "syntax error for connect_info key '$key' with value '$val': $@" + if $@; } - my $file = $helper->{file}; - $helper->render_file( 'compclass', $file ); + $self->connect_info(\%connect_info); + + \%connect_info +} + +sub _quote_unless_struct { + my ($self, $val) = @_; + + $val = qq{'$val'} if $val !~ /^\s*[[{]/; + + $val; +} + +sub _gen_dynamic_schema { + my $self = shift; + + my $helper = $self->helper; + + my @schema_parts = split(/\:\:/, $self->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); +} + +sub _gen_static_schema { + my $self = shift; + + croak "cannot load schema without connect info" unless $self->connect_info; + + my $helper = $self->helper; + + 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: $@"; + + make_schema_at( + $self->schema_class, + $self->loader_args, + [$self->connect_info] + ); +} + +sub _is_old_schema { + my $self = shift; + + return $self->_old_schema if defined $self->_old_schema; + + my @schema_pm = split '::', $self->schema_class; + $schema_pm[-1] .= '.pm'; + my $schema_file = + File::Spec->catfile($self->helper->{base}, 'lib', @schema_pm); + + if (-f $schema_file) { + my $schema_code = do { local (@ARGV, $/) = $schema_file; <> }; + $self->_old_schema(1) if $schema_code =~ /->load_classes/; + } else { + $self->_old_schema(0); + } + + return $self->_old_schema; +} + +sub _gen_model { + my $self = shift; + my $helper = $self->helper; + + $helper->render_file('compclass', $helper->{file} ); } =head1 SEE ALSO @@ -146,6 +429,10 @@ L, L Brandon L Black, C +Contributors: + +Rafael Kitover, C<> + =head1 LICENSE This library is free software, you can redistribute it and/or modify @@ -166,13 +453,15 @@ use strict; use base qw/DBIx::Class::Schema::Loader/; __PACKAGE__->loader_options( - relationships => 1, - # debug => 1, + [%- FOREACH key = loader_args.keys %] + [% key %] => [% loader_args.${key} %], + [%- END -%] + ); =head1 NAME -[% schema_class %] - DBIx::Class::Schema::Loader class +[% schema_class %] - L class =head1 SYNOPSIS @@ -180,11 +469,15 @@ See L<[% app %]> =head1 DESCRIPTION -Generated by L for use in L<[% class %]> +Dynamic L schema for use in L<[% class %]> + +=head1 GENERATED BY + +[% generator %] - [% generator_version %] =head1 AUTHOR -[% author %] +[% author.replace(',+$', '') %] =head1 LICENSE @@ -203,15 +496,19 @@ use base 'Catalyst::Model::DBIC::Schema'; __PACKAGE__->config( schema_class => '[% schema_class %]', - [% IF setup_connect_info %]connect_info => [ - [% FOREACH arg = connect_info %][% arg %], - [% END %] - ],[% END %] + [% IF roles %]roles => [% roles %],[% END %] + [% IF setup_connect_info %]connect_info => { + [%- FOREACH key = connect_info.keys %] + [% key %] => [% connect_info.${key} %], + [%- END -%] + + }[% END %] ); =head1 NAME [% class %] - Catalyst DBIC Schema Model + =head1 SYNOPSIS See L<[% app %]> @@ -220,9 +517,13 @@ See L<[% app %]> L Model using schema L<[% schema_class %]> +=head1 GENERATED BY + +[% generator %] - [% generator_version %] + =head1 AUTHOR -[% author %] +[% author.replace(',+$', '') %] =head1 LICENSE