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;
use Cwd qw//;
use Digest::MD5 qw//;
use Lingua::EN::Inflect::Number qw//;
+use Lingua::EN::Inflect::Phrase 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';
+use DBIx::Class::Schema::Loader::Constants 'BY_CASE_TRANSITION';
require DBIx::Class;
-our $VERSION = '0.05002';
+our $VERSION = '0.07000';
__PACKAGE__->mk_group_ro_accessors('simple', qw/
schema
naming
datetime_timezone
datetime_locale
+ config_file
+ loader_class
/);
generate_pod
pod_comment_mode
pod_comment_spillover_length
+ preserve_case
/);
=head1 NAME
=head2 naming
-Static schemas (ones dumped to disk) will, by default, use the new-style 0.05XXX
+Static schemas (ones dumped to disk) will, by default, use the new-style
relationship names and singularized Results, unless you're overwriting an
-existing dump made by a 0.04XXX version of L<DBIx::Class::Schema::Loader>, in
-which case the backward compatible RelBuilder will be activated, and
-singularization will be turned off.
+existing dump made by an older version of L<DBIx::Class::Schema::Loader>, in
+which case the backward compatible RelBuilder will be activated, and the
+appropriate monikerization used.
Specifying
- naming => 'v5'
+ naming => 'current'
will disable the backward-compatible RelBuilder and use
the new-style relationship names along with singularized Results, even when
The option also takes a hashref:
- naming => { relationships => 'v5', monikers => 'v4' }
+ naming => { relationships => 'v6', monikers => 'v6' }
The keys are:
How to name Result classes.
+=item column_accessors
+
+How to name column accessors in Result classes.
+
=back
The values can be:
=item current
-Latest default style, whatever that happens to be.
+Latest style, whatever that happens to be.
+
+=item v4
+
+Unsingularlized monikers, C<has_many> only relationships with no _id stripping.
=item v5
-Version 0.05XXX style.
+Monikers singularized as whole words, C<might_have> relationships for FKs on
+C<UNIQUE> constraints, C<_id> stripping for belongs_to relationships.
-=item v4
+Some of the C<_id> stripping edge cases in C<0.05003> have been reverted for
+the v5 RelBuilder.
+
+=item v6
+
+All monikers and relationships are inflected using
+L<Lingua::EN::Inflect::Phrase>, and there is more aggressive C<_id> stripping
+from relationship names.
-Version 0.04XXX style.
+In general, there is very little difference between v5 and v6 schemas.
+
+=item v7
+
+This mode is identical to C<v6> mode, except that monikerization of CamelCase
+table names is also done correctly.
+
+CamelCase column names in case-preserving mode will also be handled correctly
+for relationship name inflection. See L</preserve_case>.
+
+In this mode, CamelCase L</column_accessors> are normalized based on case
+transition instead of just being lowercased, so C<FooId> becomes C<foo_id>.
+
+If you don't have any CamelCase table or column names, you can upgrade without
+breaking any of your code.
=back
For example:
relationship_attrs => {
- all => { cascade_delete => 0 },
- has_many => { cascade_delete => 1 },
+ belongs_to => { is_deferrable => 1 },
},
-will set the C<cascade_delete> option to 0 for all generated relationships,
-except for C<has_many>, which will have cascade_delete as 1.
-
-NOTE: this option is not supported if v4 backward-compatible naming is
-set either globally (naming => 'v4') or just for relationships.
+use this to make your foreign key constraints DEFERRABLE.
=head2 debug
returns a false value, the code falls back to default behavior
for that table name.
-The default behavior is to singularize the table name, and: C<join '', map
-ucfirst, split /[\W_]+/, lc $table>, which is to say: lowercase everything,
-split up the table name into chunks anywhere a non-alpha-numeric character
-occurs, change the case of first letter of each chunk to upper case, and put
-the chunks back together. Examples:
+The default behavior is to split on case transition and non-alphanumeric
+boundaries, singularize the resulting phrase, then join the titlecased words
+together. Examples:
- Table Name | Moniker Name
- ---------------------------
- luser | Luser
- luser_group | LuserGroup
- luser-opts | LuserOpt
+ Table Name | Moniker Name
+ ---------------------------------
+ luser | Luser
+ luser_group | LuserGroup
+ luser-opts | LuserOpt
+ stations_visited | StationVisited
+ routeChange | RouteChange
=head2 inflect_plural
=head2 components
List of additional components to be loaded into all of your table
-classes. A good example would be C<ResultSetManager>.
+classes. A good example would be
+L<InflateColumn::DateTime|DBIx::Class::InflateColumn::DateTime>
=head2 resultset_components
=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<column_info|DBIx::Class::ResultSource/column_info> for a column.
+
+Must be a coderef that returns a hashref with the extra attributes.
+
+Receives the table name, column name and column_info.
-Add to all columns with type DATE the attribute timezone => "Europe/Berlin".
+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<inflate_datetime> on a non-datetime
+column so it also receives the L</datetime_timezone> and/or L</datetime_locale>.
=head2 datetime_timezone
-Set timezone attribute for L<DBIx::Class::InflateColumn::DateTime>
-to all columns with the type DATE.
+Sets the timezone attribute for L<DBIx::Class::InflateColumn::DateTime> for all
+columns with the DATE/DATETIME/TIMESTAMP data_types.
=head2 datetime_locale
-Set local attribute for L<DBIx::Class::InflateColumn::DateTime>
-to all columns with the type DATE.
+Sets the locale attribute for L<DBIx::Class::InflateColumn::DateTime> for all
+columns with the DATE/DATETIME/TIMESTAMP data_types.
+
+=head1 config_file
+
+File in Perl format, which should return a HASH reference, from which to read
+loader options.
+
+=head1 preserve_case
+
+Usually column names are lowercased, to make them easier to work with in
+L<DBIx::Class>. This option lets you turn this behavior off, if the driver
+supports it.
+
+Drivers for case sensitive databases like Sybase ASE or MSSQL with a
+case-sensitive collation will turn this option on unconditionally.
+
+Currently the drivers for SQLite, mysql, MSSQL and Firebird/InterBase support
+setting this option.
=head1 METHODS
None of these methods are intended for direct invocation by regular
-users of L<DBIx::Class::Schema::Loader>. Anything you can find here
-can also be found via standard L<DBIx::Class::Schema> methods somehow.
+users of L<DBIx::Class::Schema::Loader>. Some are proxied via
+L<DBIx::Class::Schema::Loader>.
=cut
-use constant CURRENT_V => 'v5';
+my $CURRENT_V = 'v7';
-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
);
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
$self->{naming} = {
relationships => $naming_ver,
monikers => $naming_ver,
+ column_accessors => $naming_ver,
};
}
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;
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};
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: 'naming' in perldoc DBIx::Class::Schema::Loader::Base .
+
+See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 if upgrading
+from version 0.04006.
EOF
}
else {
last;
}
- $self->naming->{relationships} ||= $v;
- $self->naming->{monikers} ||= $v;
+ $self->naming->{relationships} ||= $v;
+ $self->naming->{monikers} ||= $v;
+ $self->naming->{column_accessors} ||= $v;
$self->schema_version_to_dump($real_ver);
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;
$self->_ext_stmt($class, <<"EOF");
# These lines were loaded from '$old_real_inc_path',
-# based on the Result class name that would have been created by an 0.04006
+# based on the Result class name that would have been created by an older
# version of the Loader. For a static schema, this happens only once during
# 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) {
warn <<"EOF";
Detected external content in '$old_real_inc_path', a class name that would have
-been used by an 0.04006 version of the Loader.
+been used by an older version of the Loader.
* PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
new name of the Result.
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
$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);
}
}
+ my %current;
+ @current{@current} = ();
+ foreach my $table (keys %{ $self->{_tables} }) {
+ if (not exists $current{$table}) {
+ $self->_unregister_source_for_table($table);
+ }
+ }
+
my $loaded = $self->_load_tables(@created);
return map { $self->monikers->{$_} } @$loaded;
require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040;
return $self->{relbuilder} ||=
DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040->new(
- $self->schema, $self->inflect_plural, $self->inflect_singular
+ $self->schema,
+ $self->inflect_plural,
+ $self->inflect_singular,
+ $self->relationship_attrs,
);
}
+ elsif ($self->naming->{relationships} eq 'v5') {
+ require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_05;
+ return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_05->new (
+ $self->schema,
+ $self->inflect_plural,
+ $self->inflect_singular,
+ $self->relationship_attrs,
+ );
+ }
+ elsif ($self->naming->{relationships} eq 'v6') {
+ require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_06;
+ return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_06->new (
+ $self->schema,
+ $self->inflect_plural,
+ $self->inflect_singular,
+ $self->relationship_attrs,
+ );
+ }
- $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new (
- $self->schema,
- $self->inflect_plural,
- $self->inflect_singular,
- $self->relationship_attrs,
+ return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new (
+ $self->schema,
+ $self->inflect_plural,
+ $self->inflect_singular,
+ $self->relationship_attrs,
);
}
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) {
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|
}
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});
$self->_inject($table_class, @{$self->additional_base_classes});
}
+sub _resolve_col_accessor_collisions {
+ my ($self, $col_info) = @_;
+
+ my $base = $self->result_base_class || 'DBIx::Class::Core';
+ my @components = map "DBIx::Class::$_", @{ $self->components || [] };
+
+ my @methods;
+
+ for my $class ($base, @components) {
+ eval "require ${class};";
+ die $@ if $@;
+
+ push @methods, @{ Class::Inspector->methods($class) || [] };
+ }
+
+ my %methods;
+ @methods{@methods} = ();
+
+ while (my ($col, $info) = each %$col_info) {
+ my $accessor = $info->{accessor} || $col;
+
+ next if $accessor eq 'id'; # special case (very common column)
+
+ if (exists $methods{$accessor}) {
+ $info->{accessor} = undef;
+ }
+ }
+}
+
+sub _make_column_accessor_name {
+ my ($self, $column_name) = @_;
+
+ return join '_', map lc, split BY_CASE_TRANSITION, $column_name;
+}
+
# Set up metadata (cols, pks, etc)
sub _setup_src_meta {
my ($self, $table) = @_;
$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);
+ my $col_info = $self->__columns_info_for($table);
+ if ($self->preserve_case) {
+ for my $col (keys %$col_info) {
+ if ($col ne lc($col)) {
+ if ((not exists $self->naming->{column_accessors}) || (($self->naming->{column_accessors} =~ /(\d+)/)[0] >= 7)) {
+ $col_info->{$col}{accessor} = $self->_make_column_accessor_name($col);
+ }
+ else {
+ $col_info->{$col}{accessor} = lc $col;
+ }
}
- } else {
- $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info };
}
+ }
+ else {
+ # XXX this needs to go away
+ $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info };
+ }
- my $fks = $self->_table_fk_info($table);
+ $self->_resolve_col_accessor_collisions($col_info);
- for my $fkdef (@$fks) {
- for my $col (@{ $fkdef->{local_columns} }) {
- $col_info->{$col}{is_foreign_key} = 1;
- }
+ my $fks = $self->_table_fk_info($table);
+
+ 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
}
+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
if ($self->naming->{monikers} eq 'v4') {
return join '', map ucfirst, split /[\W_]+/, lc $table;
}
+ elsif ($self->naming->{monikers} eq 'v5') {
+ return join '', map ucfirst, split /[\W_]+/,
+ Lingua::EN::Inflect::Number::to_S(lc $table);
+ }
+ elsif ($self->naming->{monikers} eq 'v6') {
+ (my $as_phrase = lc $table) =~ s/_+/ /g;
+ my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase);
+
+ return join '', map ucfirst, split /\W+/, $inflected;
+ }
+
+ my @words = map lc, split BY_CASE_TRANSITION, $table;
+ my $as_phrase = join ' ', @words;
- return join '', map ucfirst, split /[\W_]+/,
- Lingua::EN::Inflect::Number::to_S(lc $table);
+ my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase);
+
+ return join '', map ucfirst, split /\W+/, $inflected;
}
sub _table2moniker {
my $s = $attrs->{$_};
$s = !defined $s ? 'undef' :
length($s) == 0 ? '(empty string)' :
- ref($s) eq 'SCALAR' ? $$s :
- $s
+ 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"
return $qt . $table . $qt;
}
-sub _is_case_sensitive { 0 }
-
sub _custom_column_info {
my ( $self, $table_name, $column_name, $column_info ) = @_;
- if( ref $self->custom_column_info eq 'CODE' ) {
- return $self->custom_column_info->( $table_name, $column_name, $column_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 $return = {};
- my $type = lc ( $column_info->{data_type} );
- if (
- ( defined $column_info->{inflate_datetime} and $column_info->{inflate_datetime} )
- or ( defined $column_info->{inflate_date} and $column_info->{inflate_date} )
- or ( $type eq 'date')
- or ( $type eq 'datetime')
- or ( $type eq 'timestamp')
- ){
- $return->{timezone} = $self->datetime_timezone if $self->datetime_timezone;
- $return->{locale} = $self->datetime_locale if $self->datetime_locale;
+ 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 $return;
+ return $result;
+}
+
+sub _lc {
+ my ($self, $name) = @_;
+
+ return $self->preserve_case ? $name : lc($name);
+}
+
+sub _uc {
+ my ($self, $name) = @_;
+
+ return $self->preserve_case ? $name : uc($name);
+}
+
+sub _unregister_source_for_table {
+ my ($self, $table) = @_;
+
+ eval {
+ local $@;
+ my $schema = $self->schema;
+ # in older DBIC it's a private method
+ my $unregister = $schema->can('unregister_source') || $schema->can('_unregister_source');
+ $schema->$unregister($self->_table2moniker($table));
+ delete $self->monikers->{$table};
+ delete $self->classes->{$table};
+ delete $self->_upgrading_classes->{$table};
+ delete $self->{_tables}{$table};
+ };
}
# remove the dump dir from @INC on destruction
=cut
1;
+# vim:et sts=4 sw=4 tw=0:
projects / dbsrgits/DBIx-Class-Schema-Loader.git / blobdiff