X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema%2FLoader%2FBase.pm;h=b1036e1feae088c617499bfcd993b16d93130997;hb=b308dcca0f50bb4b9f8d8ffbcb996cb4d16f2480;hp=e304c7c4b04f391c8c3105c9039fb4b9fd861f2d;hpb=1c4a389d6a924b30fa323659755ffe29baebf3ba;p=dbsrgits%2FDBIx-Class-Schema-Loader.git diff --git a/lib/DBIx/Class/Schema/Loader/Base.pm b/lib/DBIx/Class/Schema/Loader/Base.pm index e304c7c..b1036e1 100644 --- a/lib/DBIx/Class/Schema/Loader/Base.pm +++ b/lib/DBIx/Class/Schema/Loader/Base.pm @@ -3,6 +3,7 @@ package DBIx::Class::Schema::Loader::Base; use strict; use warnings; use base qw/Class::Accessor::Grouped Class::C3::Componentised/; +use namespace::autoclean; use Class::C3; use Carp::Clan qw/^DBIx::Class/; use DBIx::Class::Schema::Loader::RelBuilder; @@ -15,9 +16,12 @@ use Lingua::EN::Inflect::Number qw//; use File::Temp qw//; use Class::Unload; use Class::Inspector (); +use Data::Dumper::Concise; +use Scalar::Util 'looks_like_number'; +use File::Slurp 'slurp'; require DBIx::Class; -our $VERSION = '0.05002'; +our $VERSION = '0.06000'; __PACKAGE__->mk_group_ro_accessors('simple', qw/ schema @@ -55,6 +59,10 @@ __PACKAGE__->mk_group_ro_accessors('simple', qw/ monikers dynamic naming + datetime_timezone + datetime_locale + config_file + loader_class /); @@ -382,53 +390,52 @@ careful with this option. =head2 custom_column_info -Must be a coderef, returing a hashref with the custom column informations. - -Example: - - custom_column_info => sub { - my $info = shift; - # Example from $info hashref: - # $info = { - # 'DECIMAL_DIGITS' => undef, - # 'COLUMN_DEF' => undef, - # 'TABLE_CAT' => undef, - # 'NUM_PREC_RADIX' => undef, - # 'TABLE_SCHEM' => 'TESTS', - # 'BUFFER_LENGTH' => '8', - # 'CHAR_OCTET_LENGTH' => undef, - # 'IS_NULLABLE' => 'NO', - # 'REMARKS' => undef, - # 'COLUMN_SIZE' => '8', - # 'ORDINAL_POSITION' => '1', - # 'COLUMN_NAME' => 'LOADER_TEST9', - # 'TYPE_NAME' => 'VARCHAR2', - # 'NULLABLE' => '0', - # 'DATA_TYPE' => '12', - # 'TABLE_NAME' => 'LOADER_TEST9', - # 'SQL_DATA_TYPE' => '12', - # 'SQL_DATETIME_SUB' => undef - # }; - - if ( $info->{TYPE_NAME} eq 'DATE' ){ - return { timezone => "Europe/Berlin" }; - } - return; - } +Hook for adding extra attributes to the +L for a column. + +Must be a coderef that returns a hashref with the extra attributes. + +Receives the table name, column name and column_info. + +For example: + + custom_column_info => sub { + my ($table_name, $column_name, $column_info) = @_; + + if ($column_name eq 'dog' && $column_info->{default_value} eq 'snoopy') { + return { is_snoopy => 1 }; + } + }, + +This attribute can also be used to set C on a non-datetime +column so it also receives the L and/or L. + +=head2 datetime_timezone + +Sets the timezone attribute for L for all +columns with the DATE/DATETIME/TIMESTAMP data_types. + +=head2 datetime_locale + +Sets the locale attribute for L for all +columns with the DATE/DATETIME/TIMESTAMP data_types. -Add to all columns with type DATE the attribute timezone => "Europe/Berlin". +=head1 config_file + +File in Perl format, which should return a HASH reference, from which to read +loader options. =head1 METHODS None of these methods are intended for direct invocation by regular -users of L. Anything you can find here -can also be found via standard L methods somehow. +users of L. Some are proxied via +L. =cut -use constant CURRENT_V => 'v5'; +my $CURRENT_V = 'v6'; -use constant CLASS_ARGS => qw( +my @CLASS_ARGS = qw( schema_base_class result_base_class additional_base_classes left_base_classes additional_classes components resultset_components ); @@ -459,6 +466,18 @@ sub new { bless $self => $class; + if (my $config_file = $self->config_file) { + my $config_opts = do $config_file; + + croak "Error reading config from $config_file: $@" if $@; + + croak "Config file $config_file must be a hashref" unless ref($config_opts) eq 'HASH'; + + while (my ($k, $v) = each %$config_opts) { + $self->{$k} = $v unless exists $self->{$k}; + } + } + $self->_ensure_arrayref(qw/additional_classes additional_base_classes left_base_classes @@ -503,11 +522,15 @@ sub new { if ($self->naming) { for (values %{ $self->naming }) { - $_ = CURRENT_V if $_ eq 'current'; + $_ = $CURRENT_V if $_ eq 'current'; } } $self->{naming} ||= {}; + if ($self->custom_column_info && ref $self->custom_column_info ne 'CODE') { + croak 'custom_column_info must be a CODE ref'; + } + $self->_check_back_compat; $self->use_namespaces(1) unless defined $self->use_namespaces; @@ -613,7 +636,7 @@ EOF my ($v) = $real_ver =~ /([1-9])/; $v = "v$v"; - last if $v eq CURRENT_V || $real_ver =~ /^0\.\d\d999/; + last if $v eq $CURRENT_V || $real_ver =~ /^0\.\d\d999/; if (not %{ $self->naming }) { warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT}; @@ -623,8 +646,8 @@ Version $real_ver static schema detected, turning on backcompat mode. Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable to disable this warning. -See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more -details. +See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 if upgrading +from version 0.04006. EOF } else { @@ -647,7 +670,7 @@ sub _validate_class_args { my $self = shift; my $args = shift; - foreach my $k (CLASS_ARGS) { + foreach my $k (@CLASS_ARGS) { next unless $self->$k; my @classes = ref $self->$k eq 'ARRAY' ? @{ $self->$k } : $self->$k; @@ -794,9 +817,7 @@ sub _load_external { # upgrade. See skip_load_external to disable this feature. EOF - my $code = do { - local ($/, @ARGV) = (undef, $old_real_inc_path); <> - }; + my $code = slurp $old_real_inc_path; $code = $self->_rewrite_old_classnames($code); if ($self->dynamic) { @@ -835,7 +856,9 @@ Does the actual schema-construction work. sub load { my $self = shift; - $self->_load_tables($self->_tables_list); + $self->_load_tables( + $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude }) + ); } =head2 rescan @@ -860,8 +883,8 @@ sub rescan { $self->_relbuilder->{schema} = $schema; my @created; - my @current = $self->_tables_list; - foreach my $table ($self->_tables_list) { + my @current = $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude }); + foreach my $table (@current) { if(!exists $self->{_tables}->{$table}) { push(@created, $table); } @@ -897,21 +920,39 @@ sub _relbuilder { sub _load_tables { my ($self, @tables) = @_; - # First, use _tables_list with constraint and exclude - # to get a list of tables to operate on - - my $constraint = $self->constraint; - my $exclude = $self->exclude; - - @tables = grep { /$constraint/ } @tables if $constraint; - @tables = grep { ! /$exclude/ } @tables if $exclude; - # Save the new tables to the tables list foreach (@tables) { $self->{_tables}->{$_} = 1; } $self->_make_src_class($_) for @tables; + + # sanity-check for moniker clashes + my $inverse_moniker_idx; + for (keys %{$self->monikers}) { + push @{$inverse_moniker_idx->{$self->monikers->{$_}}}, $_; + } + + my @clashes; + for (keys %$inverse_moniker_idx) { + my $tables = $inverse_moniker_idx->{$_}; + if (@$tables > 1) { + push @clashes, sprintf ("tables %s reduced to the same source moniker '%s'", + join (', ', map { "'$_'" } @$tables), + $_, + ); + } + } + + if (@clashes) { + die 'Unable to load schema - chosen moniker/class naming style results in moniker clashes. ' + . 'Either change the naming style, or supply an explicit moniker_map: ' + . join ('; ', @clashes) + . "\n" + ; + } + + $self->_setup_src_meta($_) for @tables; if(!$self->skip_relationships) { @@ -1048,9 +1089,12 @@ sub _dump_to_dir { if ($self->use_namespaces) { $schema_text .= qq|__PACKAGE__->load_namespaces|; my $namespace_options; - for my $attr (qw(result_namespace - resultset_namespace - default_resultset_class)) { + + my @attr = qw/resultset_namespace default_resultset_class/; + + unshift @attr, 'result_namespace' unless (not $self->result_namespace) || $self->result_namespace eq 'Result'; + + for my $attr (@attr) { if ($self->$attr) { $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n| } @@ -1312,11 +1356,13 @@ sub _make_src_class { unless $table_class eq $old_class; } - my $table_normalized = lc $table; +# this was a bad idea, should be ok now without it +# my $table_normalized = lc $table; +# $self->classes->{$table_normalized} = $table_class; +# $self->monikers->{$table_normalized} = $table_moniker; + $self->classes->{$table} = $table_class; - $self->classes->{$table_normalized} = $table_class; $self->monikers->{$table} = $table_moniker; - $self->monikers->{$table_normalized} = $table_moniker; $self->_use ($table_class, @{$self->additional_classes}); $self->_inject($table_class, @{$self->left_base_classes}); @@ -1350,34 +1396,28 @@ sub _setup_src_meta { $self->_dbic_stmt($table_class,'table',$table_name); my $cols = $self->_table_columns($table); - my $col_info; - eval { $col_info = $self->_columns_info_for($table) }; - if($@) { - $self->_dbic_stmt($table_class,'add_columns',@$cols); - } - else { - if ($self->_is_case_sensitive) { - for my $col (keys %$col_info) { - $col_info->{$col}{accessor} = lc $col - if $col ne lc($col); - } - } else { - $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info }; + my $col_info = $self->__columns_info_for($table); + if ($self->_is_case_sensitive) { + for my $col (keys %$col_info) { + $col_info->{$col}{accessor} = lc $col + if $col ne lc($col); } + } else { + $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info }; + } - my $fks = $self->_table_fk_info($table); + my $fks = $self->_table_fk_info($table); - for my $fkdef (@$fks) { - for my $col (@{ $fkdef->{local_columns} }) { - $col_info->{$col}{is_foreign_key} = 1; - } + for my $fkdef (@$fks) { + for my $col (@{ $fkdef->{local_columns} }) { + $col_info->{$col}{is_foreign_key} = 1; } - $self->_dbic_stmt( - $table_class, - 'add_columns', - map { $_, ($col_info->{$_}||{}) } @$cols - ); } + $self->_dbic_stmt( + $table_class, + 'add_columns', + map { $_, ($col_info->{$_}||{}) } @$cols + ); my %uniq_tag; # used to eliminate duplicate uniqs @@ -1395,6 +1435,21 @@ sub _setup_src_meta { } +sub __columns_info_for { + my ($self, $table) = @_; + + my $result = $self->_columns_info_for($table); + + while (my ($col, $info) = each %$result) { + $info = { %$info, %{ $self->_custom_column_info ($table, $col, $info) } }; + $info = { %$info, %{ $self->_datetime_column_info($table, $col, $info) } }; + + $result->{$col} = $info; + } + + return $result; +} + =head2 tables Returns a sorted list of loaded tables, using the original database table @@ -1533,9 +1588,18 @@ sub _make_pod { $self->_pod( $class, join "\n", map { my $s = $attrs->{$_}; - $s = !defined $s ? 'undef' : - length($s) == 0 ? '(empty string)' : - $s; + $s = !defined $s ? 'undef' : + length($s) == 0 ? '(empty string)' : + ref($s) eq 'SCALAR' ? $$s : + ref($s) ? do { + my $dd = Dumper; + $dd->Indent(0); + $dd->Values([$s]); + $dd->Dump; + } : + looks_like_number($s) ? $s : + qq{'$s'} + ; " $_: $s" } sort keys %$attrs, @@ -1599,14 +1663,26 @@ sub _quote_table_name { sub _is_case_sensitive { 0 } sub _custom_column_info { - my ( $self, $info ) = @_; + my ( $self, $table_name, $column_name, $column_info ) = @_; - if( ref $self->custom_column_info eq 'CODE' ) { - return $self->custom_column_info->($info); + if (my $code = $self->custom_column_info) { + return $code->($table_name, $column_name, $column_info) || {}; } return {}; } +sub _datetime_column_info { + my ( $self, $table_name, $column_name, $column_info ) = @_; + my $result = {}; + my $type = $column_info->{data_type} || ''; + if ((grep $_, @{ $column_info }{map "inflate_$_", qw/date datetime timestamp/}) + or ($type =~ /date|timestamp/i)) { + $result->{timezone} = $self->datetime_timezone if $self->datetime_timezone; + $result->{locale} = $self->datetime_locale if $self->datetime_locale; + } + return $result; +} + # remove the dump dir from @INC on destruction sub DESTROY { my $self = shift; @@ -1644,3 +1720,4 @@ the same terms as Perl itself. =cut 1; +# vim:et sts=4 sw=4 tw=0: