X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FModel%2FDBIC%2FSchema.pm;h=d1cdc0ab5fd951690a7a439aee0f67cbff6c83cb;hb=2ff00e2b7f50d7a5a8403051dfbbad12d92398e9;hp=789a11d6162ba6c1467142b0fc61375e0ad15beb;hpb=f7a944f83ffadbc803d3155aa822f4d08a5b60af;p=catagits%2FCatalyst-Model-DBIC-Schema.git

diff --git a/lib/Catalyst/Model/DBIC/Schema.pm b/lib/Catalyst/Model/DBIC/Schema.pm
index 789a11d..d1cdc0a 100644
--- a/lib/Catalyst/Model/DBIC/Schema.pm
+++ b/lib/Catalyst/Model/DBIC/Schema.pm
@@ -1,15 +1,24 @@
 package Catalyst::Model::DBIC::Schema;
 
-use strict;
-use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
-use NEXT;
-use UNIVERSAL::require;
-use Carp;
+use Moose;
+no warnings 'uninitialized';
 
-our $VERSION = '0.02';
+our $VERSION = '0.24';
 
-__PACKAGE__->mk_classaccessor('composed_schema');
-__PACKAGE__->mk_accessors('schema');
+use mro 'c3';
+extends 'Catalyst::Model';
+with 'MooseX::Object::Pluggable';
+
+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/;
+
+use namespace::clean -except => 'meta';
 
 =head1 NAME
 
@@ -17,54 +26,163 @@ Catalyst::Model::DBIC::Schema - DBIx::Class::Schema Model Class
 
 =head1 SYNOPSIS
 
-    package MyApp::Model::Foo;
-    use strict;
-    use base 'Catalyst::Model::DBIC::Schema';
+Manual creation of a DBIx::Class::Schema and a Catalyst::Model::DBIC::Schema:
+
+=over
+
+=item 1.
+
+Create the DBIx:Class schema in MyApp/Schema/FilmDB.pm:
+
+  package MyApp::Schema::FilmDB;
+  use base qw/DBIx::Class::Schema/;
+
+  __PACKAGE__->load_classes(qw/Actor Role/);
+
+=item 2.
+
+Create some classes for the tables in the database, for example an 
+Actor in MyApp/Schema/FilmDB/Actor.pm:
+
+  package MyApp::Schema::FilmDB::Actor;
+  use base qw/DBIx::Class/
+
+  __PACKAGE__->load_components(qw/Core/);
+  __PACKAGE__->table('actor');
+
+  ...
+
+and a Role in MyApp/Schema/FilmDB/Role.pm:
+
+  package MyApp::Schema::FilmDB::Role;
+  use base qw/DBIx::Class/
+
+  __PACKAGE__->load_components(qw/Core/);
+  __PACKAGE__->table('role');
+
+  ...    
+
+Notice that the schema is in MyApp::Schema, not in MyApp::Model. This way it's 
+usable as a standalone module and you can test/run it without Catalyst. 
+
+=item 3.
+
+To expose it to Catalyst as a model, you should create a DBIC Model in
+MyApp/Model/FilmDB.pm:
+
+  package MyApp::Model::FilmDB;
+  use base qw/Catalyst::Model::DBIC::Schema/;
+
+  __PACKAGE__->config(
+      schema_class => 'MyApp::Schema::FilmDB',
+      connect_info => {
+                        dsn => "DBI:...",
+                        user => "username",
+                        password => "password",
+                      }
+  );
+
+See below for a full list of the possible config parameters.
+
+=back
 
-    __PACKAGE__->config(
-        schema_class => 'Foo::SchemaClass',
-        connect_info => [ 'dbi:Pg:dbname=foodb',
-                          'postgres',
-                          '',
-                          { AutoCommit => 1 },
-                        ],
-    );
+Now you have a working Model which accesses your separate DBIC Schema. This can
+be used/accessed in the normal Catalyst manner, via $c->model():
 
-    1;
+  my $actor = $c->model('FilmDB::Actor')->find(1);
 
-    # In controller code:
+You can also use it to set up DBIC authentication with 
+Authentication::Store::DBIC in MyApp.pm:
 
-    # ->schema To access schema methods:
-    $c->model('Foo')->schema->source(...);
+  package MyApp;
 
-    # certain ->schema methods (source, resultset, class) have shortcuts
-    $c->model('Foo')->source(...);
-    $c->model('Foo')->resultset(...);
-    $c->model('Foo')->class(...);
+  use Catalyst qw/... Authentication::Store::DBIC/;
 
-    # For resultsets, there's an even quicker shortcut:
-    $c->model('Foo::Bar')
-    # is the same as $c->model('Foo')->resultset('Bar')
+  ...
 
-    # To get the composed schema for making new connections:
-    my $newconn = $c->model('Foo')->composed_schema->connect(...);
+  __PACKAGE__->config->{authentication}{dbic} = {
+      user_class      => 'FilmDB::Actor',
+      user_field      => 'name',
+      password_field  => 'password'
+  }
 
-    # Or the same thing via a convenience shortcut:
-    my $newconn = $c->model('Foo')->connect(...);
+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 
+be called on a ResultSet, or how to add your own methods to it, please see 
+the ResultSet documentation in the L<DBIx::Class> distribution.
 
-    # or, if your schema works on different storage drivers:
-    my $newconn = $c->model('Foo')->composed_schema->clone();
-    $newconn->storage_type('::LDAP');
-    $newconn->connection(...);
+Some examples are given below:
 
-    # and again, a convenience shortcut
-    my $newconn = $c->model('Foo')->clone();
-    $newconn->storage_type('::LDAP');
-    $newconn->connection(...);
+  # to access schema methods directly:
+  $c->model('FilmDB')->schema->source(...);
+
+  # to access the source object, resultset, and class:
+  $c->model('FilmDB')->source(...);
+  $c->model('FilmDB')->resultset(...);
+  $c->model('FilmDB')->class(...);
+
+  # For resultsets, there's an even quicker shortcut:
+  $c->model('FilmDB::Actor')
+  # is the same as $c->model('FilmDB')->resultset('Actor')
+
+  # To get the composed schema for making new connections:
+  my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
+
+  # Or the same thing via a convenience shortcut:
+  my $newconn = $c->model('FilmDB')->connect(...);
+
+  # or, if your schema works on different storage drivers:
+  my $newconn = $c->model('FilmDB')->composed_schema->clone();
+  $newconn->storage_type('::LDAP');
+  $newconn->connection(...);
+
+  # and again, a convenience shortcut
+  my $newconn = $c->model('FilmDB')->clone();
+  $newconn->storage_type('::LDAP');
+  $newconn->connection(...);
 
 =head1 DESCRIPTION
 
-This is a Catalyst Model for L<DBIx::Class::Schema>-based Models.
+This is a Catalyst Model for L<DBIx::Class::Schema>-based Models.  See
+the documentation for L<Catalyst::Helper::Model::DBIC::Schema> for
+information on generating these Models via Helper scripts.
+
+When your Catalyst app starts up, a thin Model layer is created as an 
+interface to your DBIC Schema. It should be clearly noted that the model 
+object returned by C<< $c->model('FilmDB') >> is NOT itself a DBIC schema or 
+resultset object, but merely a wrapper proving L<methods|/METHODS> to access 
+the underlying schema. 
+
+In addition to this model class, a shortcut class is generated for each 
+source in the schema, allowing easy and direct access to a resultset of the 
+corresponding type. These generated classes are even thinner than the model 
+class, providing no public methods but simply hooking into Catalyst's 
+model() accessor via the 
+L<ACCEPT_CONTEXT|Catalyst::Component/ACCEPT_CONTEXT> mechanism. The complete 
+contents of each generated class is roughly equivalent to the following:
+
+  package MyApp::Model::FilmDB::Actor
+  sub ACCEPT_CONTEXT {
+      my ($self, $c) = @_;
+      $c->model('FilmDB')->resultset('Actor');
+  }
+
+In short, there are three techniques available for obtaining a DBIC 
+resultset object: 
+
+  # the long way
+  my $rs = $c->model('FilmDB')->schema->resultset('Actor');
+
+  # using the shortcut method on the model object
+  my $rs = $c->model('FilmDB')->resultset('Actor');
+
+  # using the generated class directly
+  my $rs = $c->model('FilmDB::Actor');
+
+In order to add methods to a DBIC resultset, you cannot simply add them to 
+the source (row, table) definition class; you must define a separate custom 
+resultset class. See L<DBIx::Class::Manual::Cookbook/"Predefined searches"> 
+for more info.
 
 =head1 CONFIG PARAMETERS
 
@@ -73,26 +191,141 @@ This is a Catalyst Model for L<DBIx::Class::Schema>-based Models.
 =item schema_class
 
 This is the classname of your L<DBIx::Class::Schema> Schema.  It needs
-to be findable in C<@INC>, but it does not need to be underneath
-C<Catalyst::Model::>.  This parameter is required.
+to be findable in C<@INC>, but it does not need to be inside the 
+C<Catalyst::Model::> namespace.  This parameter is required.
 
 =item connect_info
 
 This is an arrayref of connection parameters, which are specific to your
-C<storage_type>.  For C<::DBI>, which is the only supported C<storage_type>
-in L<DBIx::Class> at the time of this writing, the 4 parameters are your
-dsn, username, password, and connect options hashref.
+C<storage_type> (see your storage type documentation for more details). 
+If you only need one parameter (e.g. the DSN), you can just pass a string 
+instead of an arrayref.
 
 This is not required if C<schema_class> already has connection information
-defined in itself (which would be the case for a Schema defined by
-L<DBIx::Class::Schema::Loader>, for instance).
+defined inside itself (which isn't highly recommended, but can be done)
+
+For L<DBIx::Class::Storage::DBI>, which is the only supported
+C<storage_type> in L<DBIx::Class> at the time of this writing, the
+parameters are your dsn, username, password, and connect options hashref.
+
+See L<DBIx::Class::Storage::DBI/connect_info> for a detailed explanation
+of the arguments supported.
+
+Examples:
+
+  connect_info => {
+    dsn => 'dbi:Pg:dbname=mypgdb',
+    user => 'postgres',
+    password => ''
+  }
+
+  connect_info => {
+    dsn => 'dbi:SQLite:dbname=foo.db',
+    on_connect_do => [
+      'PRAGMA synchronous = OFF',
+    ]
+  }
+
+  connect_info => {
+    dsn => 'dbi:Pg:dbname=mypgdb',
+    user => 'postgres',
+    password => '',
+    pg_enable_utf8 => 1,
+    on_connect_do => [
+      'some SQL statement',
+      'another SQL statement',
+    ],
+  }
+
+Or using L<Config::General>:
+
+    <Model::FilmDB>
+        schema_class   MyApp::Schema::FilmDB
+        <connect_info>
+            dsn   dbi:Pg:dbname=mypgdb
+            user   postgres
+            password ''
+            auto_savepoint 1
+            on_connect_do   some SQL statement
+            on_connect_do   another SQL statement
+        </connect_info>
+    </Model::FilmDB>
+
+or
+
+    <Model::FilmDB>
+        schema_class   MyApp::Schema::FilmDB
+        connect_info   dbi:SQLite:dbname=foo.db
+    </Model::FilmDB>
+
+Or using L<YAML>:
+
+  Model::MyDB:
+      schema_class: MyDB
+      connect_info:
+          dsn: dbi:Oracle:mydb
+          user: mtfnpy
+          password: mypass
+          LongReadLen: 1000000
+          LongTruncOk: 1
+          on_connect_do: [ "alter session set nls_date_format = 'YYYY-MM-DD HH24:MI:SS'" ]
+          cursor_class: 'DBIx::Class::Cursor::Cached'
+
+The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
+supported:
+
+  connect_info => [
+    'dbi:Pg:dbname=mypgdb',
+    'postgres',
+    '',
+    {
+      pg_enable_utf8 => 1,
+    },
+    {
+      auto_savepoint => 1,
+      on_connect_do => [
+        'some SQL statement',
+        'another SQL statement',
+      ],
+    }
+  ]
+
+=item roles
+
+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.:
+
+    roles Caching
+    roles +MyApp::DB::Role::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.
+
+Roles are applied before setup, schema and connection are set, and have a chance
+to modify C<connect_info>.
+
+C<ref $self> will not be what you expect.
+
+WARNING: you cannot modify C<new>, modify C<setup> instead.
+
+Roles that come with the distribution:
+
+=over 4
+
+=item L<Catalyst::Model::DBIC::Schema::Role::Caching>
+
+=back
 
 =item storage_type
 
 Allows the use of a different C<storage_type> than what is set in your
 C<schema_class> (which in turn defaults to C<::DBI> if not set in current
-L<DBIx::Class>).  Completely optional, and probably unneccesary for most
-people, until other storage backends become available for L<DBIx::Class>.
+L<DBIx::Class>).  Completely optional, and probably unnecessary for most
+people until other storage backends become available for L<DBIx::Class>.
 
 =back
 
@@ -110,7 +343,7 @@ information defined for it.
 =item schema
 
 Accessor which returns the connected schema being used by the this model.
-There are already direct shortcuts on the model class itself for
+There are direct shortcuts on the model class itself for
 schema->resultset, schema->source, and schema->class.
 
 =item composed_schema
@@ -140,64 +373,147 @@ Shortcut for ->schema->class
 
 Shortcut for ->schema->resultset
 
-=back
+=item storage
+
+Provides an accessor for the connected schema's storage object.
+Used often for debugging and controlling transactions.
 
 =cut
 
-sub new {
-    my $self = shift->NEXT::new(@_);
-    
-    my $class = ref($self);
-    my $model_name = $class;
-    $model_name =~ s/^[\w:]+::(?:Model|M):://;
+class_has 'composed_schema' => (is => 'rw', isa => 'DBIx::Class::Schema');
+
+has 'schema' => (is => 'rw', isa => 'DBIx::Class::Schema');
+
+has 'schema_class' => (
+    is => 'ro',
+    isa => SchemaClass,
+    coerce => 1,
+    required => 1
+);
+
+has 'storage_type' => (is => 'ro', isa => 'Str');
+
+has 'connect_info' => (is => 'ro', isa => ConnectInfo, coerce => 1);
+
+# ref $self changes to anon after roles are applied, and _original_class_name is
+# broken in MX::O::P 0.0009
+has '_class_name' => (is => 'ro', isa => 'ClassName', default => sub {
+    ref shift
+});
+
+has 'model_name' => (is => 'ro', isa => 'Str', default => sub {
+    my $self = shift;
 
-    croak "->config->{schema_class} must be defined for this model"
-        unless $self->{schema_class};
+    my $class = ref $self;
+    (my $model_name = $class) =~ s/^[\w:]+::(?:Model|M):://;
 
-    my $schema_class = $self->{schema_class};
+    $model_name
+});
 
-    $schema_class->require
-        or croak "Cannot load schema class '$schema_class': $@";
+has 'roles' => (is => 'ro', isa => 'ArrayRef|Str');
 
-    if( !$self->{connect_info} ) {
+sub BUILD {
+    my $self = shift;
+    my $class = ref $self;
+    my $schema_class = $self->schema_class;
+
+    if( !$self->connect_info ) {
         if($schema_class->storage && $schema_class->storage->connect_info) {
-            $self->{connect_info} = $schema_class->storage->connect_info;
+            $self->connect_info($schema_class->storage->connect_info);
         }
         else {
             croak "Either ->config->{connect_info} must be defined for $class"
-                  . " or $schema_class must have connection defined on it";
+                  . " or $schema_class must have connect info defined on it."
+		  . " Here's what we got:\n"
+		  . Dumper($self);
         }
     }
 
+    if (exists $self->connect_info->{cursor_class}) {
+        eval { Class::MOP::load_class($self->connect_info->{cursor_class}) }
+            or croak "invalid connect_info: Cannot load your cursor_class"
+        . " ".$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->schema($self->composed_schema->clone);
-    $self->schema->storage_type($self->{storage_type}) if $self->{storage_type};
-    $self->schema->connection(@{$self->{connect_info}});
+
+    $self->schema->storage_type($self->storage_type)
+        if $self->storage_type;
+
+    $self->schema->connection($self->connect_info);
+
+    $self->_install_rs_models;
+}
+
+sub clone { shift->composed_schema->clone(@_); }
+
+sub connect { shift->composed_schema->connect(@_); }
+
+sub storage { shift->schema->storage(@_); }
+
+=item setup
+
+Called at C<<BUILD>> time, for modifying in roles/subclasses.
+
+=cut
+
+sub setup { 1 }
+
+=item 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.
+
+=cut
+
+sub ACCEPT_CONTEXT { shift }
+
+sub _install_rs_models {
+    my $self  = shift;
+    my $class = $self->_class_name;
 
     no strict 'refs';
     foreach my $moniker ($self->schema->sources) {
-        *{"${class}::${moniker}::ACCEPT_CONTEXT"} = sub {
+        my $classname = "${class}::$moniker";
+        *{"${classname}::ACCEPT_CONTEXT"} = sub {
             shift;
-            shift->model($model_name)->resultset($moniker);
+            shift->model($self->model_name)->resultset($moniker);
         }
     }
-
-    return $self;
 }
 
-sub clone { shift->composed_schema->clone(@_); }
+__PACKAGE__->meta->make_immutable;
 
-sub connect { shift->composed_schema->connect(@_); }
+=back
 
 =head1 SEE ALSO
 
-L<Catalyst>, L<DBIx::Class>, L<DBIx::Class::Schema>,
-L<DBIx::Class::Schema::Loader>
+General Catalyst Stuff:
+
+L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
+L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
+
+Stuff related to DBIC and this Model style:
+
+L<DBIx::Class>, L<DBIx::Class::Schema>,
+L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>
 
 =head1 AUTHOR
 
 Brandon L Black, C<blblack@gmail.com>
 
+Contributors:
+
+Rafael Kitover, C<<rkitover at cpan.org>>
+
 =head1 COPYRIGHT
 
 This program is free software, you can redistribute it and/or modify it