use Moose;
use mro 'c3';
+with 'MooseX::Traits';
extends 'Catalyst::Model';
-with 'MooseX::Object::Pluggable';
our $VERSION = '0.24';
+use namespace::autoclean;
use Carp::Clan '^Catalyst::Model::DBIC::Schema';
use Data::Dumper;
use DBIx::Class ();
-use Scalar::Util 'reftype';
-use MooseX::ClassAttribute;
use Moose::Autobox;
use Catalyst::Model::DBIC::Schema::Types
qw/ConnectInfo SchemaClass CursorClass/;
-use MooseX::Types::Moose qw/ArrayRef Str ClassName/;
-
-use namespace::clean -except => 'meta';
+use MooseX::Types::Moose qw/ArrayRef Str ClassName Undef/;
=head1 NAME
my $actor = $c->model('FilmDB::Actor')->find(1);
You can also use it to set up DBIC authentication with
-Authentication::Store::DBIC in MyApp.pm:
+L<Catalyst::Authentication::Store::DBIx::Class> in MyApp.pm:
package MyApp;
- use Catalyst qw/... Authentication::Store::DBIC/;
+ use Catalyst qw/... Authentication .../;
...
- __PACKAGE__->config->{authentication}{dbic} = {
- user_class => 'FilmDB::Actor',
- user_field => 'name',
- password_field => 'password'
- }
+ __PACKAGE__->config->{authentication} =
+ {
+ default_realm => 'members',
+ realms => {
+ members => {
+ credential => {
+ class => 'Password',
+ password_field => 'password',
+ password_type => 'hashed'
+ password_hash_type => 'SHA-256'
+ },
+ store => {
+ class => 'DBIx::Class',
+ user_model => 'DB::User',
+ role_relation => 'roles',
+ role_field => 'rolename',
+ }
+ }
+ }
+ };
C<< $c->model('Schema::Source') >> returns a L<DBIx::Class::ResultSet> for
the source name parameter passed. To find out more about which methods can
=head2 traits
-Array of Traits to apply at BUILD time. Traits are relative to the
-C<<MyApp::Model::DB::Trait::> then C<<Catalyst::Model::DBIC::Schema::Trait::>>
-namespaces, unless prefixed with C<+> in which case they are taken to be a
-fully qualified name. E.g.:
+Array of Traits to apply to the instance. Traits are L<Moose::Role>s.
+
+They are relative to the C<< MyApp::Model::DB::Trait:: >>, then the C<<
+Catalyst::Model::DBIC::Schema::Trait:: >> namespaces, unless prefixed with C<+>
+in which case they are taken to be a fully qualified name. E.g.:
traits Caching
traits +MyApp::DB::Trait::Foo
-This is done using L<MooseX::Object::Pluggable>.
-
A new instance is created at application time, so any consumed required
attributes, coercions and modifiers will work.
-Traits are applied before setup, schema and connection are set.
+Traits are applied at L<Catalyst::Component/COMPONENT> time using L<MooseX::Traits>.
-C<ref $self> will be an anon class if any traits are applied.
+C<ref $self> will be an anon class if any traits are applied, C<<
+$self->_original_class_name >> will be the original class.
-You cannot modify C<new> or C<BUILD>, modify C<setup> instead.
-
-L</ACCEPT_CONTEXT> and L</finalize> can also be modified.
+When writing a Trait, interesting points to modify are C<BUILD>, L</setup> and
+L</ACCEPT_CONTEXT>.
Traits that come with the distribution:
L<DBIx::Class>). Completely optional, and probably unnecessary for most
people until other storage backends become available for L<DBIx::Class>.
+=head1 ATTRIBUTES
+
+The keys you pass in the model configuration are available as attributes.
+
+Other attributes available:
+
+=head2 connect_info
+
+Your connect_info args normalized to hashref form (with dsn/user/password.) See
+L<DBIx::Class::Storage::DBI/connect_info> for more info on the hashref form of
+L</connect_info>.
+
+=head2 model_name
+
+The model name L<Catalyst> uses to resolve this model, the part after
+C<::Model::> or C<::M::> in your class name. E.g. if your class name is
+C<MyApp::Model::DB> the L</model_name> will be C<DB>.
+
+=head2 _original_class_name
+
+The class name of your model before any L</traits> are applied. E.g.
+C<MyApp::Model::DB>.
+
+=head2 _default_cursor_class
+
+What to reset your L<DBIx::Class::Storage::DBI/cursor_class> to if a custom one
+doesn't work out. Defaults to L<DBIx::Class::Storage::DBI::Cursor>.
+
+=head2 _traits
+
+Unresolved arrayref of traits passed in the config.
+
+=head2 _resolved_traits
+
+Traits you used resolved to full class names.
+
=head1 METHODS
=head2 new
has connect_info => (is => 'ro', isa => ConnectInfo, coerce => 1);
-has model_name => (is => 'ro', isa => Str, default => sub {
- my $self = shift;
-
- my $class = ref $self;
- (my $model_name = $class) =~ s/^[\w:]+::(?:Model|M):://;
-
- $model_name
-});
+has model_name => (
+ is => 'ro',
+ isa => Str,
+ required => 1,
+ lazy_build => 1,
+);
-has traits => (is => 'ro', isa => ArrayRef|Str);
+has _traits => (is => 'ro', isa => ArrayRef);
+has _resolved_traits => (is => 'ro', isa => ArrayRef);
has _default_cursor_class => (
is => 'ro',
coerce => 1
);
+has _original_class_name => (
+ is => 'ro',
+ required => 1,
+ isa => Str,
+ default => sub { blessed $_[0] },
+);
+
+sub COMPONENT {
+ my ($class, $app, $args) = @_;
+
+ $args = $class->merge_config_hashes($class->config, $args);
+
+ if (my $traits = delete $args->{traits}) {
+ my @traits = $class->_resolve_traits($traits->flatten);
+ return $class->new_with_traits(
+ traits => \@traits,
+ _original_class_name => $class,
+ _traits => $traits,
+ _resolved_traits => \@traits,
+ %$args
+ );
+ }
+
+ return $class->new($args);
+}
+
sub BUILD {
my $self = shift;
my $class = ref $self;
. " ".$self->connect_info->{cursor_class}.": $@";
}
- $self->_plugin_ns('Trait');
-
- $self->load_plugins($self->traits->flatten) if $self->traits;
-
$self->setup;
$self->composed_schema($schema_class->compose_namespace($class));
$self->schema->connection($self->connect_info);
$self->_install_rs_models;
-
- $self->finalize;
}
sub clone { shift->composed_schema->clone(@_); }
=head2 setup
-Called at C<<BUILD>> time before configuration.
+Called at C<BUILD>> time before configuration, but after L</connect_info> is
+set. To do something after configuuration use C<< after BUILD => >>.
=cut
sub setup { 1 }
-=head2 finalize
-
-Called at the end of C<BUILD> after everything has been configured.
-
-=cut
-
-sub finalize { 1 }
-
=head2 ACCEPT_CONTEXT
-Point of extension for doing things at C<<$c->model>> time, returns the model
-instance, see L<Catalyst::Manual::Intro> for more information.
+Point of extension for doing things at C<< $c->model >> time with context,
+returns the model instance, see L<Catalyst::Manual::Intro/ACCEPT_CONTEXT> for
+more information.
=cut
}
}
+sub _resolve_traits {
+ my ($class, @names) = @_;
+ my $base = 'Trait';
+
+ my @search_ns = grep !/^(?:Moose|Class::MOP)::/,
+ $class->meta->class_precedence_list;
+
+ my @traits;
+
+ OUTER: for my $name (@names) {
+ if ($name =~ /^\+(.*)/) {
+ push @traits, $1;
+ next;
+ }
+ for my $ns (@search_ns) {
+ my $full = "${ns}::${base}::${name}";
+ if (eval { Class::MOP::load_class($full) }) {
+ push @traits, $full;
+ next OUTER;
+ }
+ }
+ }
+
+ return @traits;
+}
+
+sub _build_model_name {
+ my $self = shift;
+ my $class = $self->_original_class_name;
+ (my $model_name = $class) =~ s/^[\w:]+::(?:Model|M):://;
+
+ return $model_name;
+}
+
__PACKAGE__->meta->make_immutable;
=head1 SEE ALSO
=head1 AUTHOR
-Brandon L Black, C<blblack@gmail.com>
+Brandon L Black, C<blblack at gmail.com>
Contributors:
-Rafael Kitover, C<<rkitover at cpan.org>>
+Rafael Kitover, C<rkitover at cpan.org>
=head1 COPYRIGHT
=cut
1;
+# vim:sts=4 sw=4 et: