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 File::Slurp 'slurp';
use DBIx::Class::Schema::Loader::Utils 'split_name';
require DBIx::Class;
+use namespace::clean;
our $VERSION = '0.07001';
resultset_namespace
default_resultset_class
schema_base_class
+ schema_roles
result_base_class
+ result_roles
use_moose
overwrite_modifications
__PACKAGE__->naming('current');
-Or if you prefer to use 0.05XXX features but insure that nothing breaks in the
+Or if you prefer to use 0.07XXX features but insure that nothing breaks in the
next major version upgrade:
- __PACKAGE__->naming('v5');
+ __PACKAGE__->naming('v7');
=head2 generate_pod
Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
+=head2 schema_roles
+
+Roles your schema class will consume, implies L</use_moose>.
+
=head2 result_base_class
Base class for your table classes (aka result classes). Defaults to
'DBIx::Class::Core'.
+=head2 result_roles
+
+Roles your Result classes will consume, implies L</use_moose>.
+
=head2 additional_base_classes
List of additional base classes all of your table classes will use.
Sets the locale attribute for L<DBIx::Class::InflateColumn::DateTime> for all
columns with the DATE/DATETIME/TIMESTAMP data_types.
-=head1 config_file
+=head2 config_file
File in Perl format, which should return a HASH reference, from which to read
loader options.
-=head1 preserve_case
+=head2 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
Currently the drivers for SQLite, mysql, MSSQL and Firebird/InterBase support
setting this option.
-=head1 qualify_objects
+=head2 qualify_objects
Set to true to prepend the L</db_schema> to table names for C<<
__PACKAGE__->table >> calls, and to some other things like Oracle sequences.
+=head2 use_moose
+
+Creates Schema and Result classes that use L<Moose>, L<MooseX::NonMoose> and
+L<namespace::autoclean>. The default content after the md5 sum also makes the
+classes immutable.
+
+It is safe to upgrade your existing Schema to this option.
+
=head1 METHODS
None of these methods are intended for direct invocation by regular
my @CLASS_ARGS = qw(
schema_base_class result_base_class additional_base_classes
left_base_classes additional_classes components resultset_components
+ schema_roles result_roles
);
# ensure that a peice of object data is a valid arrayref, creating
left_base_classes
components
resultset_components
+ schema_roles
+ result_roles
/);
$self->_validate_class_args;
+ if ($self->use_moose) {
+ eval <<'EOF';
+require Moose;
+require MooseX::NonMoose;
+require namespace::autoclean;
+EOF
+ if ($@) {
+ die sprintf "You must install the following CPAN modules to enable the use_moose option: %s.\n",
+ "Moose, MooseX::NonMoose and namespace::autoclean";
+ }
+ }
+
push(@{$self->{components}}, 'ResultSetManager')
if @{$self->{resultset_components}};
local *Class::C3::reinitialize = sub {};
use warnings;
+ if ($class->can('meta') && (ref $class->meta)->isa('Moose::Meta::Class')) {
+ $class->meta->make_mutable;
+ }
Class::Unload->unload($class) if $unload;
my ($source, $resultset_class);
if (
&& ($resultset_class ne 'DBIx::Class::ResultSet')
) {
my $has_file = Class::Inspector->loaded_filename($resultset_class);
+ if ($resultset_class->can('meta') && (ref $resultset_class->meta)->isa('Moose::Meta::Class')) {
+ $resultset_class->meta->make_mutable;
+ }
Class::Unload->unload($resultset_class) if $unload;
$self->_reload_class($resultset_class) if $has_file;
}
unless $_[0] =~ /^Subroutine \S+ redefined/;
};
eval "require $class;";
+ die "Failed to reload class $class: $@" if $@;
}
sub _get_dump_filename {
. qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
. qq|use strict;\nuse warnings;\n\n|;
if ($self->use_moose) {
- $schema_text.= qq|use Moose;\nuse MooseX::NonMoose;\nextends '$schema_base_class';\n\n|;
+ $schema_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;\nextends '$schema_base_class';\n\n|;
}
else {
$schema_text .= qq|use base '$schema_base_class';\n\n|;
. qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
. qq|use strict;\nuse warnings;\n\n|;
if ($self->use_moose) {
- $src_text.= qq|use Moose;\nuse MooseX::NonMoose;\nextends '$result_base_class';\n\n|;
+ $src_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;|;
+
+ # these options 'use base' which is compile time
+ if (@{ $self->left_base_classes } || @{ $self->additional_base_classes }) {
+ $src_text .= qq|\nBEGIN { extends '$result_base_class' }\n\n|;
+ }
+ else {
+ $src_text .= qq|\nextends '$result_base_class';\n\n|;
+ }
}
else {
$src_text .= qq|use base '$result_base_class';\n\n|;
my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename);
+ # If upgrading to use_moose=1 replace default custom content with default Moose custom content.
+ # If there is already custom content, which does not have the Moose content, add it.
+ if ($self->use_moose) {
+ local $self->{use_moose} = 0;
+
+ if ($custom_content eq $self->_default_custom_content) {
+ local $self->{use_moose} = 1;
+
+ $custom_content = $self->_default_custom_content;
+ }
+ else {
+ local $self->{use_moose} = 1;
+
+ if ($custom_content !~ /\Q@{[$self->_default_moose_custom_content]}\E/) {
+ $custom_content .= $self->_default_custom_content;
+ }
+ }
+ }
+
if (my $old_class = $self->_upgrading_classes->{$class}) {
my $old_filename = $self->_get_dump_filename($old_class);
or croak "Error closing '$filename': $!";
}
+sub _default_moose_custom_content {
+ return qq|\n__PACKAGE__->meta->make_immutable;|;
+}
+
sub _default_custom_content {
my $self = shift;
my $default = qq|\n\n# You can replace this text with custom|
. qq| content, and it will be preserved on regeneration|;
if ($self->use_moose) {
- $default .= qq|\nno Moose;\n__PACKAGE__->meta->make_immutable( inline_constructor => 0 );\n1;\n|;
+ $default .= $self->_default_moose_custom_content;
}
$default .= qq|\n1;\n|;
return $default;
sub _inject {
my $self = shift;
my $target = shift;
- my $schema_class = $self->schema_class;
my $blist = join(q{ }, @_);
- warn "$target: use base qw/ $blist /;" if $self->debug && @_;
- $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
+
+ return unless $blist;
+
+ warn "$target: use base qw/$blist/;" if $self->debug;
+ $self->_raw_stmt($target, "use base qw/$blist/;");
}
sub _result_namespace {
my @methods;
- for my $class ($base, @components) {
+ for my $class ($base, @components, $self->use_moose ? 'Moose::Object' : ()) {
eval "require ${class};";
die $@ if $@;
my %methods;
@methods{@methods} = ();
+ # futureproof meta
+ $methods{meta} = undef;
+
while (my ($col, $info) = each %$col_info) {
my $accessor = $info->{accessor} || $col;
my ($table) = @_;
my $pcm = $self->pod_comment_mode;
my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc);
- if ( $self->can('_table_comment') ) {
- $comment = $self->_table_comment($table);
- $comment_overflows = ($comment and length $comment > $self->pod_comment_spillover_length);
- $comment_in_name = ($pcm eq 'name' or ($pcm eq 'auto' and !$comment_overflows));
- $comment_in_desc = ($pcm eq 'description' or ($pcm eq 'auto' and $comment_overflows));
- }
+ $comment = $self->__table_comment($table);
+ $comment_overflows = ($comment and length $comment > $self->pod_comment_spillover_length);
+ $comment_in_name = ($pcm eq 'name' or ($pcm eq 'auto' and !$comment_overflows));
+ $comment_in_desc = ($pcm eq 'description' or ($pcm eq 'auto' and $comment_overflows));
$self->_pod( $class, "=head1 NAME" );
my $table_descr = $class;
$table_descr .= " - " . $comment if $comment and $comment_in_name;
} sort keys %$attrs,
);
- if( $self->can('_column_comment')
- and my $comment = $self->_column_comment( $self->{_class2table}{$class}, $col_counter)
- ) {
+ if (my $comment = $self->__column_comment($self->{_class2table}{$class}, $col_counter)) {
$self->_pod( $class, $comment );
}
}
}
}
+sub _filter_comment {
+ my ($self, $txt) = @_;
+
+ $txt = '' if not defined $txt;
+
+ $txt =~ s/(?:\015?\012|\015\012?)/\n/g;
+
+ return $txt;
+}
+
+sub __table_comment {
+ my $self = shift;
+
+ if (my $code = $self->can('_table_comment')) {
+ return $self->_filter_comment($self->$code(@_));
+ }
+
+ return '';
+}
+
+sub __column_comment {
+ my $self = shift;
+
+ if (my $code = $self->can('_column_comment')) {
+ return $self->_filter_comment($self->$code(@_));
+ }
+
+ return '';
+}
+
# Stores a POD documentation
sub _pod {
my ($self, $class, $stmt) = @_;
projects / dbsrgits/DBIx-Class-Schema-Loader.git / blobdiff