use Moose;
use mro 'c3';
extends 'Catalyst::Model';
-with 'MooseX::Object::Pluggable';
+with 'CatalystX::Component::Traits';
-our $VERSION = '0.24';
+our $VERSION = '0.26';
+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 Class::Inspector ();
use Catalyst::Model::DBIC::Schema::Types
- qw/ConnectInfo SchemaClass CursorClass/;
+ qw/ConnectInfo LoadedClass/;
-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
<Model::FilmDB>
schema_class MyApp::Schema::FilmDB
- roles Caching
+ traits Caching
<connect_info>
dsn dbi:Pg:dbname=mypgdb
user postgres
}
]
-=head2 roles
+=head2 traits
-Array of Roles to apply at BUILD time. Roles are relative to the
-C<<MyApp::Model::DB::Role::> then C<<Catalyst::Model::DBIC::Schema::Role::>>
-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.
- roles Caching
- roles +MyApp::DB::Role::Foo
+They are relative to the C<< MyApp::TraitFor::Model::DBIC::Schema:: >>, then the C<<
+Catalyst::TraitFor::Model::DBIC::Schema:: >> namespaces, unless prefixed with C<+>
+in which case they are taken to be a fully qualified name. E.g.:
-This is done using L<MooseX::Object::Pluggable>.
+ traits Caching
+ traits +MyApp::TraitFor::Model::Foo
A new instance is created at application time, so any consumed required
attributes, coercions and modifiers will work.
-Roles are applied before setup, schema and connection are set.
-
-C<ref $self> will be an anon class if any roles are applied.
+Traits are applied at L<Catalyst::Component/COMPONENT> time using
+L<CatalystX::Component::Traits>.
-You cannot modify C<new> or C<BUILD>, modify C<setup> instead.
+C<ref $self> will be an anon class if any traits are applied, C<<
+$self->_original_class_name >> will be the original class.
-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>.
-Roles that come with the distribution:
+Traits that come with the distribution:
=over 4
-=item L<Catalyst::Model::DBIC::Schema::Role::Caching>
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>
-=item L<Catalyst::Model::DBIC::Schema::Role::Replicated>
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
=back
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 _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>.
+
+=head1 ATTRIBUTES FROM L<MooseX::Traits::Pluggable>
+
+=head2 _original_class_name
+
+The class name of your model before any L</traits> are applied. E.g.
+C<MyApp::Model::DB>.
+
+=head2 _traits
+
+Unresolved arrayref of traits passed in the config.
+
+=head2 _resolved_traits
+
+Traits you used resolved to full class names.
+
=head1 METHODS
+Methods not listed here are delegated to the connected schema used by the model
+instance, so the following are equivalent:
+
+ $c->model('DB')->schema->my_accessor('foo');
+ # or
+ $c->model('DB')->my_accessor('foo');
+
+Methods on the model take precedence over schema methods.
+
=head2 new
Instantiates the Model based on the above-documented ->config parameters.
=cut
-has 'schema' => (is => 'rw', isa => 'DBIx::Class::Schema');
-
-has 'schema_class' => (
+has schema_class => (
is => 'ro',
- isa => SchemaClass,
+ isa => LoadedClass,
coerce => 1,
required => 1
);
-has 'storage_type' => (is => 'rw', isa => Str);
-
-has 'connect_info' => (is => 'ro', isa => ConnectInfo, coerce => 1);
+has storage_type => (is => 'rw', isa => Str);
-has 'model_name' => (is => 'ro', isa => Str, default => sub {
- my $self = shift;
+has connect_info => (is => 'rw', isa => ConnectInfo, coerce => 1);
- my $class = ref $self;
- (my $model_name = $class) =~ s/^[\w:]+::(?:Model|M):://;
-
- $model_name
-});
-
-has 'roles' => (is => 'ro', isa => ArrayRef|Str);
+has model_name => (
+ is => 'ro',
+ isa => Str,
+ required => 1,
+ lazy_build => 1,
+);
-has '_default_cursor_class' => (
+has _default_cursor_class => (
is => 'ro',
- isa => CursorClass,
+ isa => LoadedClass,
default => 'DBIx::Class::Storage::DBI::Cursor',
coerce => 1
);
sub BUILD {
my $self = shift;
- my $class = ref $self;
+ my $class = $self->_original_class_name;
my $schema_class = $self->schema_class;
if( !$self->connect_info ) {
. " ".$self->connect_info->{cursor_class}.": $@";
}
- $self->_plugin_ns('Role');
-
- $self->load_plugins($self->roles->flatten) if $self->roles;
-
$self->setup;
$self->composed_schema($schema_class->compose_namespace($class));
+ $self->meta->make_mutable;
+ $self->meta->add_attribute('schema',
+ is => 'rw',
+ isa => 'DBIx::Class::Schema',
+ handles => $self->_delegates
+ );
+ $self->meta->make_immutable;
+
$self->schema($self->composed_schema->clone);
+ $self->_pass_options_to_schema;
+
$self->schema->storage_type($self->storage_type)
if $self->storage_type;
$self->schema->connection($self->connect_info);
$self->_install_rs_models;
-
- $self->finalize;
}
sub clone { shift->composed_schema->clone(@_); }
sub connect { shift->composed_schema->connect(@_); }
-sub storage { shift->schema->storage(@_); }
-
-sub resultset { shift->schema->resultset(@_); }
-
=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 _build_model_name {
+ my $self = shift;
+ my $class = $self->_original_class_name;
+ (my $model_name = $class) =~ s/^[\w:]+::(?:Model|M):://;
+
+ return $model_name;
+}
+
+sub _delegates {
+ my $self = shift;
+
+# XXX change this to CMOP once CAG is updated
+ my @schema_methods = @{ Class::Inspector->methods($self->schema_class) };
+
+# combine with any already added by other schemas
+ my @handles = eval {
+ @{ $self->meta->find_attribute_by_name('schema')->handles }
+ };
+
+# now kill the attribute, otherwise add_attribute in BUILD will not do the right
+# thing. May be a Moose bug.
+ eval { $self->meta->remove_attribute('schema') };
+
+ my %schema_methods;
+ @schema_methods{ @schema_methods, @handles } = ();
+ @schema_methods = keys %schema_methods;
+
+ my @my_methods = $self->meta->get_all_method_names;
+ my %my_methods;
+ @my_methods{@my_methods} = ();
+
+ my @delegates;
+ for my $method (@schema_methods) {
+ push @delegates, $method unless exists $my_methods{$method};
+ }
+
+ return \@delegates;
+}
+
+sub _pass_options_to_schema {
+ my $self = shift;
+
+ my @attributes = map $_->name, $self->meta->get_all_attributes;
+ my %attributes;
+ @attributes{@attributes} = ();
+
+ for my $opt (keys %$self) {
+ if (not exists $attributes{$opt}) {
+ die "Invalid schema option: $opt" unless $self->schema->can($opt);
+
+ $self->schema->$opt($self->{$opt});
+ }
+ }
+}
+
__PACKAGE__->meta->make_immutable;
=head1 SEE ALSO
L<DBIx::Class>, L<DBIx::Class::Schema>,
L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
-L<MooseX::Object::Pluggable>
+L<CatalystX::Component::Traits>, L<MooseX::Traits::Pluggable>
-Roles:
+Traits:
-L<Catalyst::Model::DBIC::Schema::Role::Caching>,
-L<Catalyst::Model::DBIC::Schema::Role::Replicated>
+L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
=head1 AUTHOR
-Brandon L Black, C<blblack@gmail.com>
+Brandon L Black C<blblack at gmail.com>
-Contributors:
+=head1 CONTRIBUTORS
-Rafael Kitover, C<<rkitover at cpan.org>>
+caelum: Rafael Kitover C<rkitover at cpan.org>
=head1 COPYRIGHT
=cut
1;
+# vim:sts=4 sw=4 et:
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff