X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FHelper%2FModel%2FDBIC%2FSchema.pm;h=2b9d8c2933e73a76c4227d6559149aca9bc4b24b;hb=726daa55ab1a08d8faffa58a4350359d9a8126db;hp=2895c86e00a3524f33571158b42e112ec1a85428;hpb=9f7cc709e5279d4e3ff0f419bcf67c43c668de94;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 2895c86..2b9d8c2 100644
--- a/lib/Catalyst/Helper/Model/DBIC/Schema.pm
+++ b/lib/Catalyst/Helper/Model/DBIC/Schema.pm
@@ -1,9 +1,11 @@
 package Catalyst::Helper::Model::DBIC::Schema;
 
+use namespace::autoclean;
 use Moose;
 no warnings 'uninitialized';
 
-our $VERSION = '0.24';
+our $VERSION = '0.53';
+$VERSION = eval $VERSION;
 
 use Carp;
 use Tie::IxHash ();
@@ -11,10 +13,11 @@ use Data::Dumper ();
 use List::Util 'first';
 use MooseX::Types::Moose qw/Str HashRef Bool ArrayRef/;
 use Catalyst::Model::DBIC::Schema::Types 'CreateOption';
-use Moose::Autobox;
 use List::MoreUtils 'firstidx';
-
-use namespace::clean -except => 'meta';
+use Scalar::Util 'looks_like_number';
+use File::Find 'finddepth';
+use Try::Tiny;
+use Cwd 'getcwd';
 
 =head1 NAME
 
@@ -23,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 ]
 
@@ -55,17 +58,18 @@ L<DBIx::Class::Schema::Loader> 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<roles> is the list of roles to apply to the model, see
+C<traits> is the list of traits to apply to the model, see
 L<Catalyst::Model::DBIC::Schema> for details.
 
-C<Schema::Loader opts> are described in L</TYPICAL EXAMPLES> below.
+C<Schema::Loader opts> are documented in L<DBIx::Class::Schema::Loader::Base>
+and some examples are given in L</TYPICAL EXAMPLES> below.
 
-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<create=>
-options.
+C<connect_info> arguments are the same as what L<DBIx::Class::Schema/connect>
+expects, and are storage_type-specific. They are documented in
+L<DBIx::Class::Storage::DBI/connect_info>. 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<create=> options.
 
 username and password can be omitted for C<SQLite> dsns.
 
@@ -85,7 +89,7 @@ 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='"'
+    on_connect_do='["select 1", "select 2"]' quote_names=1
 
 B<ON WINDOWS COMMAND LINES QUOTING RULES ARE DIFFERENT>
 
@@ -94,7 +98,7 @@ In C<cmd.exe> 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_char="\""
+    on_connect_do="[\"select 1\", \"select 2\"]" quote_names=1
 
 Same, but with extra Schema::Loader args (separate multiple values by commas):
 
@@ -103,6 +107,14 @@ Same, but with extra Schema::Loader args (separate multiple values by commas):
     exclude='^(wibble|wobble)$' moniker_map='{ foo => "FOO" }' \
     dbi:Pg:dbname=foodb myuname mypass
 
+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<DBIx::Class::Schema::Loader::Base> for a list of options
 
 Create a dynamic DBIx::Class::Schema::Loader-based Schema,
@@ -126,11 +138,13 @@ in your app config, or [not recommended] in the schema itself).
 has helper => (is => 'ro', isa => 'Catalyst::Helper', required => 1);
 has create => (is => 'rw', isa => CreateOption);
 has args => (is => 'ro', isa => ArrayRef);
-has roles => (is => 'rw', 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
@@ -157,23 +171,23 @@ sub mk_compclass {
 sub BUILD {
     my $self   = shift;
     my $helper = $self->helper;
-    my @args   = $self->args->flatten if $self->args;
+    my @args   = @{ $self->args || [] };
 
     $helper->{schema_class} = $self->schema_class;
 
     @args = $self->_cleanup_args(\@args);
 
-    my ($roles_idx, $roles);
-    if (($roles_idx = firstidx { ($roles) = /^roles=(\S*)\z/ } @args) != -1) {
-        my @roles = split /,/ => $roles;
+    my ($traits_idx, $traits);
+    if (($traits_idx = firstidx { ($traits) = /^traits=(\S*)\z/ } @args) != -1) {
+        my @traits = split /,/ => $traits;
 
-        $self->roles(\@roles);
+        $self->traits(\@traits);
 
-        $helper->{roles} = '['
-            .(join ',' => map { qq{'$_'} } ($self->roles->flatten))
+        $helper->{traits} = '['
+            .(join ',' => map { qq{'$_'} } @traits)
             .']';
 
-        splice @args, $roles_idx, 1, ();
+        splice @args, $traits_idx, 1, ();
     }
 
     if ($args[0] && $args[0] =~ /^create=(\S*)\z/) {
@@ -184,16 +198,21 @@ sub BUILD {
             $self->_parse_loader_args(\@args);
 
             $helper->{loader_args} = $self->_build_helper_loader_args;
+        }
+    }
 
-            if (first { /^dbi:/i } @args) {
-                $helper->{setup_connect_info} = 1;
+    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);
-            }
-        }
+        $helper->{connect_info} =
+            $self->_build_helper_connect_info(\@args);
+
+        $self->_parse_connect_info(\@args);
     }
 
     $helper->{generator} = ref $self;
@@ -227,13 +246,15 @@ 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);
 
@@ -246,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);
@@ -265,7 +288,7 @@ 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 ($self->_is_struct($val)) {
@@ -277,6 +300,47 @@ sub _read_loader_args {
         }
     }
 
+    # 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;
 }
 
@@ -299,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;
@@ -328,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;
 
@@ -338,7 +403,7 @@ sub _build_helper_connect_info {
                 if (ref $val) {
                     $val = $self->_data_struct_to_string($val);
                 } else {
-                    $val = 'q{'.$val.'}';
+                    $val = $self->_quote($val);
                 }
 
                 $helper_connect_info{$key} = $val;
@@ -349,7 +414,13 @@ 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
@@ -358,17 +429,72 @@ sub _build_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);
+    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;
 
-    if (-f $schema_file) {
-        my $schema_code = do { local (@ARGV, $/) = $schema_file; <> };
-        return 1 if $schema_code =~ /->load_classes/;
+    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' : '';
     }
 
-    0;
+    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 {
@@ -390,7 +516,7 @@ sub _get_dsn_user_pass {
 
     if ($dsn =~ /sqlite/i) {
         ($user, $password) = ('', '');
-        shift @$connect_info while $connect_info->[0] eq '';
+        shift @$connect_info while @$connect_info and $connect_info->[0] eq '';
     } else {
         ($user, $password) = splice @$connect_info, 0, 2;
     }
@@ -410,7 +536,7 @@ sub _parse_connect_info {
 
     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);
@@ -420,10 +546,12 @@ sub _parse_connect_info {
 
         my ($key, $val) = split /=/, $_, 2;
 
-        if ($key =~ /^(?:quote_char|name_sep|limit_dialect)\z/) {
+        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} = eval $val;
+            $connect_info{$key} = $self->_eval($val);
         }
 
         die "syntax error for connect_info key '$key' with value '$val': $@"
@@ -438,15 +566,31 @@ sub _parse_connect_info {
 sub _is_struct {
     my ($self, $val) = @_;
 
-    return $val =~ /^\s*[[{]/;
+    return $val =~ /^\s*(?:sub|[[{])/;
+}
+
+sub _quote {
+    my ($self, $val) = @_;
+
+    return 'q{'.$val.'}';
 }
 
 sub _quote_unless_struct {
     my ($self, $val) = @_;
 
-    $val = 'q{'.$val.'}' if not $self->_is_struct($val);
+    $val = $self->_quote($val) if not $self->_is_struct($val);
 
-    $val;
+    return $val;
+}
+
+sub _eval {
+    my ($self, $code) = @_;
+
+    return $code if looks_like_number $code;
+
+    return $code if not $self->_is_struct($code);
+
+    return eval "{no strict; $code}";
 }
 
 sub _gen_dynamic_schema {
@@ -477,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'
@@ -489,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 {
@@ -535,11 +696,12 @@ L<DBIx::Class::Schema::Loader>, L<Catalyst::Model::DBIC::Schema>
 
 =head1 AUTHOR
 
-Brandon L Black, C<blblack@gmail.com>
+See L<Catalyst::Model::DBIC::Schema/AUTHOR> and
+L<Catalyst::Model::DBIC::Schema/CONTRIBUTORS>.
 
-Contributors:
+=head1 COPYRIGHT
 
-Rafael Kitover, C<<rkitover at cpan.org>>
+See L<Catalyst::Model::DBIC::Schema/COPYRIGHT>.
 
 =head1 LICENSE
 
@@ -604,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} %],