X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FHelper%2FModel%2FDBIC%2FSchema.pm;h=7ab6ed912351ff6d7a28a851ac99fa7c97a4591b;hb=1714a8a0ad486c7956ce7bd3f62e7b78a3d7222e;hp=8e0a437076ae38ca01340624bf9afefb762eef91;hpb=c4fee9b88f9183e17c6499c077fcf8572a95c165;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 8e0a437..7ab6ed9 100644 --- a/lib/Catalyst/Helper/Model/DBIC/Schema.pm +++ b/lib/Catalyst/Helper/Model/DBIC/Schema.pm @@ -1,16 +1,23 @@ package Catalyst::Helper::Model::DBIC::Schema; +use namespace::autoclean; use Moose; no warnings 'uninitialized'; -our $VERSION = '0.24'; +our $VERSION = '0.58'; +$VERSION = eval $VERSION; use Carp; use Tie::IxHash (); use Data::Dumper (); use List::Util 'first'; - -use namespace::clean -except => 'meta'; +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'; +use File::Find 'finddepth'; +use Try::Tiny; +use Cwd 'getcwd'; =head1 NAME @@ -19,7 +26,7 @@ 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 ] [ roles=role1,role2... ] \ + [ create=dynamic | create=static ] [ traits=trait1,trait2... ] \ [ Schema::Loader opts ] [ dsn user pass ] \ [ other connect_info args ] @@ -51,78 +58,94 @@ 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 roles to apply to the model, see +C is the list of traits to apply to the model, see L for details. -C are described in L below. +C are documented in L +and some examples are given in L below. + +C arguments are the same as what L +expects, and are storage_type-specific. They are documented in +L. 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. -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 -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 '' '' \ + 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_names=1 + +B + +In C the above example would be: + + 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_names=1 + +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 +Coderefs are also supported: + + script/myapp_create.pl model CatalystModelName DBIC::Schema \ + MyApp::SchemaClass create=static \ + inflect_singular='sub { $_[0] =~ /\A(.+?)(_id)?\z/; $1 }' \ + moniker_map='sub { join(q{}, map ucfirst, split(/[\W_]+/, lc $_[0])); }' \ + dbi:mysql:foodb myuname mypass + +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 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 => 1, default => sub { - 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; -}); +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 is_moose_schema => (is => 'rw', isa => Bool, lazy_build => 1); +has result_namespace => (is => 'rw', isa => Str, lazy_build => 1); +has components => (is => 'rw', isa => ArrayRef); =head1 METHODS @@ -136,47 +159,79 @@ files. sub mk_compclass { my ($package, $helper, $schema_class, @args) = @_; - my $self = $package->new(helper => $helper, schema_class => $schema_class); + my $self = $package->new( + helper => $helper, + schema_class => $schema_class, + args => \@args + ); - $helper->{schema_class} = $schema_class - or die "Must supply schema class name"; + $self->run; +} + +sub BUILD { + my $self = shift; + my $helper = $self->helper; + my @args = @{ $self->args || [] }; + + $helper->{schema_class} = $self->schema_class; @args = $self->_cleanup_args(\@args); - my $create = ''; - if ($args[0] && $args[0] =~ /^create=(dynamic|static)\z/) { - $create = $1; - shift @args; + my ($traits_idx, $traits); + if (($traits_idx = firstidx { ($traits) = /^traits=(\S*)\z/ } @args) != -1) { + my @traits = split /,/ => $traits; - if ($args[0] && $args[0] =~ /^roles=(.*)\z/) { - $helper->{roles} = '[' - .(join ',' => map { qq{'$_'} } (split /,/ => $1)) - .']'; - shift @args; - } + $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 (first { /^dbi:/i } @args) { - $helper->{setup_connect_info} = 1; + $helper->{loader_args} = $self->_build_helper_loader_args; + } + } - $helper->{connect_info} = - $self->_build_helper_connect_info(\@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'; - $self->_parse_connect_info(\@args) if $create eq 'static'; - } - } + $helper->{setup_connect_info} = 1; + + $helper->{connect_info} = + $self->_build_helper_connect_info(\@args); + + $self->_parse_connect_info(\@args); } $helper->{generator} = ref $self; $helper->{generator_version} = $VERSION; +} - if ($create eq 'dynamic') { +=head2 run + +Can be called on an instance to generate the files. + +=cut + +sub run { + my $self = shift; + + if ($self->create eq 'dynamic') { $self->_print_dynamic_deprecation_warning; - $self->helper->{loader_args} = $self->_build_helper_loader_args; $self->_gen_dynamic_schema; - } elsif ($create eq 'static') { + } elsif ($self->create eq 'static') { $self->_gen_static_schema; } @@ -191,13 +246,17 @@ 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 $@; } - my @components = - $self->_build_loader_components(delete $loader_args{components}); + my @components = $self->_build_loader_components( + delete $loader_args{components}, + $loader_args{use_namespaces}, + ); + + $self->components(\@components); for my $re_opt (qw/constraint exclude/) { $loader_args{$re_opt} = qr/$loader_args{$re_opt}/ @@ -208,13 +267,15 @@ sub _parse_loader_args { %result = ( relationships => 1, - (%loader_args ? %loader_args : ()), + use_moose => $self->is_moose_schema ? 1 : 0, + col_collision_map => 'column_%s', (!$self->old_schema ? ( use_namespaces => 1 ) : ()), (@components ? ( components => \@components - ) : ()) + ) : ()), + (%loader_args ? %loader_args : ()), ); $self->loader_args(\%result); @@ -227,16 +288,59 @@ 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; } } + # Use args after connect_info as loader args as well, because people always + # get the order confused. + my $i = 1; + if ($args->[0] =~ /sqlite/i) { + $i++ if $args->[$i] eq ''; + $i++ if $args->[$i] eq ''; + } + else { + $i += 2; + } + + my $have_loader = try { + Class::MOP::load_class('DBIx::Class::Schema::Loader::Base'); + 1; + }; + + if ($have_loader) { + while (defined $args->[$i]) { + $i++ while $self->_is_struct($args->[$i]); + + last if not defined $args->[$i]; + + my ($key, $val) = split /=/, $args->[$i], 2; + + if (not DBIx::Class::Schema::Loader::Base->can($key)) { + $i++; + next; + } + + if ($self->_is_struct($val)) { + $loader_args{$key} = $val; + } elsif ((my @vals = split /,/ => $val) > 1) { + $loader_args{$key} = \@vals; + } else { + $loader_args{$key} = $val; + } + + splice @$args, $i, 1; + } + } + wantarray ? %loader_args : \%loader_args; } @@ -259,9 +363,10 @@ sub _build_helper_loader_args { } sub _build_loader_components { - my ($self, $components) = @_; + my ($self, $components, $use_namespaces) = @_; - my @components = $self->old_schema ? () : ('InflateColumn::DateTime'); + my @components = $self->old_schema && (not $use_namespaces) ? () + : ('InflateColumn::DateTime'); if ($components) { $components = [ $components ] if !ref $components; @@ -276,7 +381,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'; @@ -288,7 +393,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; @@ -298,7 +403,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; @@ -309,12 +414,89 @@ 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; + + return $self->result_namespace eq '' ? 1 : 0; +} + +sub _build_is_moose_schema { + my $self = shift; + + my @schema_parts = split '::', $self->schema_class; + + my $result_dir = File::Spec->catfile( + $self->helper->{base}, 'lib', @schema_parts, $self->result_namespace + ); + + # assume yes for new schemas + return 1 if not -d $result_dir; + + my $uses_moose = 1; + + my $cwd = getcwd; + + try { + finddepth(sub { + return if $File::Find::name !~ /\.pm\z/; + + open my $fh, '<', $File::Find::name + or die "Could not open $File::Find::name: $!"; + + my $code = do { local $/; <$fh> }; + close $fh; + + $uses_moose = 0 if $code !~ /\nuse Moose;\n/; + + die; + }, $result_dir); + }; + + chdir $cwd; + + return $uses_moose; +} + +sub _build_result_namespace { + my $self = shift; + + my @schema_parts = split '::', $self->schema_class; + my $schema_pm = + File::Spec->catfile($self->helper->{base}, 'lib', @schema_parts) . '.pm'; + + if (not -f $schema_pm) { + eval { Class::MOP::load_class('DBIx::Class::Schema::Loader') }; + + return 'Result' if $@; + + return (try { DBIx::Class::Schema::Loader->VERSION('0.05') }) ? 'Result' : ''; + } + + open my $fh, '<', $schema_pm or die "Could not open $schema_pm: $!"; + my $code = do { local $/; <$fh> }; + close $fh; + + my ($result_namespace) = $code =~ /result_namespace => '([^']+)'/; + + return $result_namespace if $result_namespace; + + return '' if $code =~ /->load_classes/; + + return 'Result'; +} + sub _data_struct_to_string { my ($self, $data) = @_; @@ -326,19 +508,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); @@ -348,7 +546,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 $@; } @@ -358,12 +563,34 @@ sub _parse_connect_info { \%connect_info } +sub _is_struct { + my ($self, $val) = @_; + + return $val =~ /^\s*(?:sub|[[{])/; +} + +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; - $val; + return $code if not $self->_is_struct($code); + + return eval "{no strict; $code}"; } sub _gen_dynamic_schema { @@ -394,8 +621,12 @@ sub _gen_static_schema { my $schema_dir = File::Spec->catfile($helper->{base}, 'lib'); - eval { Class::MOP::load_class('DBIx::Class::Schema::Loader') }; - die "Cannot load DBIx::Class::Schema::Loader: $@" if $@; + try { + Class::MOP::load_class('DBIx::Class::Schema::Loader') + } + catch { + die "Cannot load DBIx::Class::Schema::Loader: $_"; + }; DBIx::Class::Schema::Loader->import( "dump_to_dir:$schema_dir", 'make_schema_at' @@ -406,6 +637,19 @@ sub _gen_static_schema { $self->loader_args, [$self->connect_info] ); + + require lib; + lib->import($schema_dir); + + Class::MOP::load_class($self->schema_class); + + my @sources = $self->schema_class->sources; + + if (not @sources) { + warn <<'EOF'; +WARNING: No tables found, did you forget to specify db_schema? +EOF + } } sub _gen_model { @@ -430,7 +674,7 @@ sub _cleanup_args { my ($self, $args) = @_; # remove blanks, ie. someoned doing foo \ bar - my @res = grep !/^\s*\z/, @$args; + my @res = grep !/^\s+\z/, @$args; # remove leading whitespace, ie. foo \ bar s/^\s*// for @res; @@ -452,11 +696,12 @@ L, L =head1 AUTHOR -Brandon L Black, C +See L and +L. -Contributors: +=head1 COPYRIGHT -Rafael Kitover, C<> +See L. =head1 LICENSE @@ -521,7 +766,7 @@ use base 'Catalyst::Model::DBIC::Schema'; __PACKAGE__->config( schema_class => '[% schema_class %]', - [% IF roles %]roles => [% roles %],[% END %] + [% IF traits %]traits => [% traits %],[% END %] [% IF setup_connect_info %]connect_info => { [%- FOREACH key = connect_info.keys %] [% key %] => [% connect_info.${key} %], @@ -558,3 +803,5 @@ it under the same terms as Perl itself. =cut 1; +__END__ +# vim:sts=4 sw=4: