X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FHelper%2FModel%2FDBIC%2FSchema.pm;h=b58a09375ec351eba0c752e3e509ffe9a5a57e8a;hb=8e1f4dbf45b813d4f4fd5caddccf3f3deadc410c;hp=1ca41358b3048405bd8cf67415a6cc5f04215bbd;hpb=2201c2e4eadb70fe4567d1a288604c62a473a6e4;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 1ca4135..b58a093 100644 --- a/lib/Catalyst/Helper/Model/DBIC/Schema.pm +++ b/lib/Catalyst/Helper/Model/DBIC/Schema.pm @@ -1,22 +1,19 @@ package Catalyst::Helper::Model::DBIC::Schema; -use strict; -use warnings; +use namespace::autoclean; +use Moose; no warnings 'uninitialized'; -our $VERSION = '0.24'; - -use parent 'Class::Accessor::Fast'; +our $VERSION = '0.30'; 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 -/); +use List::Util 'first'; +use MooseX::Types::Moose qw/Str HashRef Bool ArrayRef/; +use Catalyst::Model::DBIC::Schema::Types 'CreateOption'; +use List::MoreUtils 'firstidx'; +use Scalar::Util 'looks_like_number'; =head1 NAME @@ -25,8 +22,9 @@ 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 ] [ Schema::Loader opts ] \ - [ dsn user pass ] [ other connect_info arguments ] + [ create=dynamic | create=static ] [ traits=trait1,trait2... ] \ + [ Schema::Loader opts ] [ dsn user pass ] \ + [ other connect_info args ] =head1 DESCRIPTION @@ -56,6 +54,11 @@ 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 is the list of traits 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, @@ -63,85 +66,161 @@ password, and connect options, respectively. These are optional for existing Schemas, but required if you use either of the C options. +username and password can be omitted for C dsns. + 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: +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 - # Same, with extra connect_info args +Same, with extra connect_info args +user and pass can be omitted for sqlite, since they are always empty + + 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"]' quote_char='"' + +If using a 2 character quote_char: + + script/myapp_create.pl ... quote_char='[]' + +B + +In C the above example would be: + script/myapp_create.pl model CatalystModelName DBIC::Schema \ - MyApp::SchemaClass create=static dbi:SQLite:foo.db '' '' \ + MyApp::SchemaClass create=static dbi:SQLite:foo.db \ AutoCommit=1 cursor_class=DBIx::Class::Cursor::Cached \ - on_connect_do='["select 1", "select 2"]' + on_connect_do="[\"select 1\", \"select 2\"]" quote_char="\"" + +Same, but with extra Schema::Loader args (separate multiple values by commas): - # 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" }' \ + exclude='^(wibble|wobble)$' moniker_map='{ foo => "FOO" }' \ dbi:Pg:dbname=foodb myuname mypass - # See DBIx::Class::Schema::Loader::Base for list of options +See L for a list of options + +Create a dynamic DBIx::Class::Schema::Loader-based Schema, +and a Model which references it (B): - # 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: +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). +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 +=cut + +has helper => (is => 'ro', isa => 'Catalyst::Helper', required => 1); +has create => (is => 'rw', isa => CreateOption); +has args => (is => 'ro', isa => ArrayRef); +has traits => (is => 'rw', isa => ArrayRef); +has schema_class => (is => 'ro', isa => Str, required => 1); +has loader_args => (is => 'rw', isa => HashRef); +has connect_info => (is => 'rw', isa => HashRef); +has old_schema => (is => 'rw', isa => Bool, lazy_build => 1); +has components => (is => 'rw', isa => ArrayRef); + =head1 METHODS =head2 mk_compclass +This is called by L with the commandline args to generate the +files. + =cut sub mk_compclass { my ($package, $helper, $schema_class, @args) = @_; - my $self = $package->new; + my $self = $package->new( + helper => $helper, + schema_class => $schema_class, + args => \@args + ); + + $self->run; +} + +sub BUILD { + my $self = shift; + my $helper = $self->helper; + my @args = @{ $self->args || [] }; - $helper->{schema_class} = $schema_class - or croak "Must supply schema class name"; + $helper->{schema_class} = $self->schema_class; - $self->schema_class($schema_class); - $self->helper($helper); + @args = $self->_cleanup_args(\@args); - my $create = ''; - if ($args[0] && $args[0] =~ /^create=(dynamic|static)$/) { - $create = $1; + my ($traits_idx, $traits); + if (($traits_idx = firstidx { ($traits) = /^traits=(\S*)\z/ } @args) != -1) { + my @traits = split /,/ => $traits; + + $self->traits(\@traits); + + $helper->{traits} = '[' + .(join ',' => map { qq{'$_'} } @traits) + .']'; + + splice @args, $traits_idx, 1, (); + } + + if ($args[0] && $args[0] =~ /^create=(\S*)\z/) { + $self->create($1); shift @args; if (@args) { $self->_parse_loader_args(\@args); - if (List::Util::first { /dbi:/ } @args) { - $helper->{setup_connect_info} = 1; + $helper->{loader_args} = $self->_build_helper_loader_args; + } + } + + my $dbi_dsn_part; + if (first { ($dbi_dsn_part) = /^(dbi):/i } @args) { + die +qq{DSN must start with 'dbi:' not '$dbi_dsn_part' (case matters!)} + if $dbi_dsn_part ne 'dbi'; - $helper->{connect_info} = - $self->_build_helper_connect_info(\@args); + $helper->{setup_connect_info} = 1; - $self->_parse_connect_info(\@args) if $create eq 'static'; - } - } + $helper->{connect_info} = + $self->_build_helper_connect_info(\@args); + + $self->_parse_connect_info(\@args); } $helper->{generator} = ref $self; $helper->{generator_version} = $VERSION; +} + +=head2 run + +Can be called on an instance to generate the files. - if ($create eq 'dynamic') { - $self->helper->{loader_args} = $self->_build_helper_loader_args; +=cut + +sub run { + my $self = shift; + + if ($self->create eq 'dynamic') { + $self->_print_dynamic_deprecation_warning; $self->_gen_dynamic_schema; - } elsif ($create eq 'static') { + } elsif ($self->create eq 'static') { $self->_gen_static_schema; } @@ -156,7 +235,7 @@ sub _parse_loader_args { while (my ($key, $val) = each %loader_args) { next if $key =~ /^(?:components|constraint|exclude)\z/; - $loader_args{$key} = eval $val; + $loader_args{$key} = $self->_eval($val); die "syntax error for loader args key '$key' with value '$val': $@" if $@; } @@ -164,6 +243,8 @@ sub _parse_loader_args { my @components = $self->_build_loader_components(delete $loader_args{components}); + $self->components(\@components); + for my $re_opt (qw/constraint exclude/) { $loader_args{$re_opt} = qr/$loader_args{$re_opt}/ if exists $loader_args{$re_opt}; @@ -174,7 +255,7 @@ sub _parse_loader_args { %result = ( relationships => 1, (%loader_args ? %loader_args : ()), - (!$self->_is_old_schema ? ( + (!$self->old_schema ? ( use_namespaces => 1 ) : ()), (@components ? ( @@ -192,10 +273,12 @@ sub _read_loader_args { my %loader_args; - while (@$args && $args->[0] !~ /^dbi:/) { + while (@$args && $args->[0] !~ /^dbi:/i) { my ($key, $val) = split /=/, shift(@$args), 2; - if ((my @vals = split /,/ => $val) > 1) { + if ($self->_is_struct($val)) { + $loader_args{$key} = $val; + } elsif ((my @vals = split /,/ => $val) > 1) { $loader_args{$key} = \@vals; } else { $loader_args{$key} = $val; @@ -226,7 +309,7 @@ sub _build_helper_loader_args { sub _build_loader_components { my ($self, $components) = @_; - my @components = $self->_is_old_schema ? () : ('InflateColumn::DateTime'); + my @components = $self->old_schema ? () : ('InflateColumn::DateTime'); if ($components) { $components = [ $components ] if !ref $components; @@ -241,7 +324,7 @@ sub _build_helper_connect_info { my @connect_info = @$connect_info; - my ($dsn, $user, $password) = splice @connect_info, 0, 3; + my ($dsn, $user, $password) = $self->_get_dsn_user_pass(\@connect_info); tie my %helper_connect_info, 'Tie::IxHash'; @@ -253,7 +336,7 @@ sub _build_helper_connect_info { for (@connect_info) { if (/^\s*{.*}\s*\z/) { - my $hash = eval $_; + my $hash = $self->_eval($_); die "Syntax errorr in connect_info hash: $_: $@" if $@; my %hash = %$hash; @@ -263,7 +346,7 @@ sub _build_helper_connect_info { if (ref $val) { $val = $self->_data_struct_to_string($val); } else { - $val = qq{'$val'}; + $val = $self->_quote($val); } $helper_connect_info{$key} = $val; @@ -274,12 +357,34 @@ sub _build_helper_connect_info { my ($key, $val) = split /=/, $_, 2; - $helper_connect_info{$key} = $self->_quote_unless_struct($val); + if ($key eq 'quote_char') { + $helper_connect_info{$key} = length($val) == 1 ? + $self->_quote($val) : + $self->_data_struct_to_string([split //, $val]); + } else { + $helper_connect_info{$key} = $self->_quote_unless_struct($val); + } } \%helper_connect_info } +sub _build_old_schema { + my $self = shift; + + 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; <> }; + return 1 if $schema_code =~ /->load_classes/; + } + + 0; +} + sub _data_struct_to_string { my ($self, $data) = @_; @@ -291,19 +396,35 @@ sub _data_struct_to_string { return Data::Dumper->Dump([$data]); } +sub _get_dsn_user_pass { + my ($self, $connect_info) = @_; + + my $dsn = shift @$connect_info; + my ($user, $password); + + if ($dsn =~ /sqlite/i) { + ($user, $password) = ('', ''); + shift @$connect_info while @$connect_info and $connect_info->[0] eq ''; + } else { + ($user, $password) = splice @$connect_info, 0, 2; + } + + ($dsn, $user, $password) +} + sub _parse_connect_info { my ($self, $connect_info) = @_; my @connect_info = @$connect_info; - my ($dsn, $user, $password) = splice @connect_info, 0, 3; + my ($dsn, $user, $password) = $self->_get_dsn_user_pass(\@connect_info); 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 $_; + my $hash = $self->_eval($_); die "Syntax errorr in connect_info hash: $_: $@" if $@; %connect_info = (%connect_info, %$hash); @@ -313,7 +434,14 @@ sub _parse_connect_info { my ($key, $val) = split /=/, $_, 2; - $connect_info{$key} = eval $val; + if ($key eq 'quote_char') { + $connect_info{$key} = length($val) == 1 ? $val : [split //, $val]; + } elsif ($key =~ /^(?:name_sep|limit_dialect)\z/) { + $connect_info{$key} = $val; + } else { + $connect_info{$key} = $self->_eval($val); + } + die "syntax error for connect_info key '$key' with value '$val': $@" if $@; } @@ -323,12 +451,34 @@ sub _parse_connect_info { \%connect_info } +sub _is_struct { + my ($self, $val) = @_; + + return $val =~ /^\s*[[{]/; +} + +sub _quote { + my ($self, $val) = @_; + + return 'q{'.$val.'}'; +} + sub _quote_unless_struct { my ($self, $val) = @_; - $val = qq{'$val'} if $val !~ /^\s*[[{]/; + $val = $self->_quote($val) if not $self->_is_struct($val); + + return $val; +} + +sub _eval { + my ($self, $code) = @_; + + return $code if looks_like_number $code; + + return $code if $code =~ m{^[\w;:/]*\z}; - $val; + return eval "{no strict; $code}"; } sub _gen_dynamic_schema { @@ -359,9 +509,12 @@ sub _gen_static_schema { my $schema_dir = File::Spec->catfile($helper->{base}, 'lib'); - DBIx::Class::Schema::Loader->use( + eval { Class::MOP::load_class('DBIx::Class::Schema::Loader') }; + die "Cannot load DBIx::Class::Schema::Loader: $@" if $@; + + DBIx::Class::Schema::Loader->import( "dump_to_dir:$schema_dir", 'make_schema_at' - ) or croak "Cannot load DBIx::Class::Schema::Loader: $@"; + ); make_schema_at( $self->schema_class, @@ -370,31 +523,34 @@ sub _gen_static_schema { ); } -sub _is_old_schema { +sub _gen_model { my $self = shift; + my $helper = $self->helper; - return $self->_old_schema if defined $self->_old_schema; + $helper->render_file('compclass', $helper->{file} ); +} - my @schema_pm = split '::', $self->schema_class; - $schema_pm[-1] .= '.pm'; - my $schema_file = - File::Spec->catfile($self->helper->{base}, 'lib', @schema_pm); +sub _print_dynamic_deprecation_warning { + warn <); + exit 0 if $response =~ /^n(o)?\z/; +} - 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); - } +sub _cleanup_args { + my ($self, $args) = @_; - return $self->_old_schema; -} +# remove blanks, ie. someoned doing foo \ bar + my @res = grep !/^\s+\z/, @$args; -sub _gen_model { - my $self = shift; - my $helper = $self->helper; +# remove leading whitespace, ie. foo \ bar + s/^\s*// for @res; - $helper->render_file('compclass', $helper->{file} ); + @res } =head1 SEE ALSO @@ -413,6 +569,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 @@ -476,6 +636,7 @@ use base 'Catalyst::Model::DBIC::Schema'; __PACKAGE__->config( schema_class => '[% schema_class %]', + [% IF traits %]traits => [% traits %],[% END %] [% IF setup_connect_info %]connect_info => { [%- FOREACH key = connect_info.keys %] [% key %] => [% connect_info.${key} %], @@ -512,3 +673,5 @@ it under the same terms as Perl itself. =cut 1; +__END__ +# vim:sts=4 sw=4: