use Moose;
use mro 'c3';
-with 'MooseX::Traits';
extends 'Catalyst::Model';
+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 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 Undef/;
-use namespace::clean -except => 'meta';
-
=head1 NAME
Catalyst::Model::DBIC::Schema - DBIx::Class::Schema Model Class
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
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<+>
+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.:
traits Caching
- traits +MyApp::DB::Trait::Foo
+ traits +MyApp::TraitFor::Model::Foo
A new instance is created at application time, so any consumed required
attributes, coercions and modifiers will work.
-Traits are applied at L<Catalyst::Component/COMPONENT> time using L<MooseX::Traits>.
+Traits are applied at L<Catalyst::Component/COMPONENT> time using
+L<CatalystX::Component::Traits>.
C<ref $self> will be an anon class if any traits are applied, C<<
$self->_original_class_name >> will be the original class.
=over 4
-=item L<Catalyst::Model::DBIC::Schema::Trait::Caching>
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>
-=item L<Catalyst::Model::DBIC::Schema::Trait::Replicated>
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
=back
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 _default_cursor_class
-
-What to rest your L<DBIx::Class::Storage::DBI/cursor_class> if a custom one
-doesn't work out. Defaults to L<DBIx::Class::Storage::DBI::Cursor>.
-
=head2 _traits
-Unresolved arrayref of traits passed at C<COMPONENT> time.
+Unresolved arrayref of traits passed in the config.
=head2 _resolved_traits
=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 => (
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 connect_info => (is => 'rw', isa => ConnectInfo, coerce => 1);
has model_name => (
is => 'ro',
lazy_build => 1,
);
-has _traits => (is => 'ro', isa => ArrayRef);
-has _resolved_traits => (is => 'ro', isa => ArrayRef);
-
has _default_cursor_class => (
is => 'ro',
- isa => CursorClass,
+ isa => LoadedClass,
default => 'DBIx::Class::Storage::DBI::Cursor',
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);
-}
-
-# we override Catalyst::Component::BUILDARGS, which merges configs, because we
-# merge configs ourselves in COMPONENT. We also don't pass $app to ->new, so
-# Moose::Object::BUILDARGS works perfectly.
-sub BUILDARGS {
- goto &Moose::Object::BUILDARGS;
-}
-
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->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;
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, but after L</connect_info> is
+Called at C<BUILD> time before configuration, but after L</connect_info> is
set. To do something after configuuration use C<< after BUILD => >>.
=cut
=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;
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>
Traits:
-L<Catalyst::Model::DBIC::Schema::Trait::Caching>,
-L<Catalyst::Model::DBIC::Schema::Trait::Replicated>
+L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
=head1 AUTHOR
-Brandon L Black, C<blblack at 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
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff