X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FModel%2FDBIC%2FSchema.pm;h=a1f229e1ffcebe3890215cff47b2ee9d5722214e;hb=566a0bcace1f933a42a84e4b92782d78911acbba;hp=d9fc47dc2d6135b21da408597593532578f1cf8a;hpb=ca7cf6f02f7378154b24cc6a6d4c66dee50cf902;p=catagits%2FCatalyst-Model-DBIC-Schema.git

diff --git a/lib/Catalyst/Model/DBIC/Schema.pm b/lib/Catalyst/Model/DBIC/Schema.pm
index d9fc47d..a1f229e 100644
--- a/lib/Catalyst/Model/DBIC/Schema.pm
+++ b/lib/Catalyst/Model/DBIC/Schema.pm
@@ -5,7 +5,7 @@ use mro 'c3';
 extends 'Catalyst::Model';
 with 'CatalystX::Component::Traits';
 
-our $VERSION = '0.30';
+our $VERSION = '0.59';
 $VERSION = eval $VERSION;
 
 use namespace::autoclean;
@@ -14,7 +14,7 @@ use Data::Dumper;
 use DBIx::Class ();
 
 use Catalyst::Model::DBIC::Schema::Types
-    qw/ConnectInfo LoadedClass SchemaClass/;
+    qw/ConnectInfo LoadedClass SchemaClass Schema/;
 
 use MooseX::Types::Moose qw/ArrayRef Str ClassName Undef/;
 
@@ -24,107 +24,60 @@ Catalyst::Model::DBIC::Schema - DBIx::Class::Schema Model Class
 
 =head1 SYNOPSIS
 
-Manual creation of a DBIx::Class::Schema and a Catalyst::Model::DBIC::Schema:
+First, prepare your database schema using L<DBIx::Class>, see
+L<Catalyst::Helper::Model::DBIC::Schema> for how to generate a
+L<DBIx::Class::Schema> from your database using the Helper script, and
+L<DBIx::Class::Schema::Loader::Base>.
 
-=over
+A typical usage of the helper script would be:
 
-=item 1.
+    script/myapp_create.pl model FilmDB DBIC::Schema MyApp::Schema::FilmDB \
+        create=static dbi:mysql:filmdb dbusername dbpass \
+        quote_names=1
 
-Create the DBIx:Class schema in MyApp/Schema/FilmDB.pm:
+If you are unfamiliar with L<DBIx::Class>, see L<DBIx::Class::Manual::Intro>
+first.
 
-  package MyApp::Schema::FilmDB;
-  use base qw/DBIx::Class::Schema/;
+These examples assume that you already have a schema called
+C<MyApp::Schema::FilmDB>, which defines some Result classes for tables in
+C<MyApp::Schema::FilmDB::Result::Actor> and
+C<MyApp::Schema::FilmDB::Result::Film>. Either created by the helper script (as
+shown above) or manually.
 
-  __PACKAGE__->load_classes(qw/Actor Role/);
+The helper also creates a Model in C<lib/MyApp/Model/FilmDB.pm>, if you already
+have a schema you can create just the Model using:
 
-=item 2.
+    script/myapp_create.pl model FilmDB DBIC::Schema MyApp::Schema::FilmDB
+        dbi:mysql:filmdb dbusername dbpass
 
-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
+The connect_info is optional and will be hardcoded into the Model if provided.
+It's better to configure it in your L<Catalyst> config file, which will also
+override any hardcoded config, see L</connect_info> for examples.
 
 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():
+be used/accessed in the normal Catalyst manner, via C<< $c->model() >>:
 
-  my $actor = $c->model('FilmDB::Actor')->find(1);
+  my $db_model = $c->model('FilmDB');         # a Catalyst::Model
+  my $dbic     = $c->model('FilmDB')->schema; # the actual DBIC object
 
-You can also use it to set up DBIC authentication with 
-L<Catalyst::Authentication::Store::DBIx::Class> in MyApp.pm:
+There is also a shortcut, which returns a L<DBIx::Class::ResultSet> directly,
+instead of a L<Catalyst::Model>:
 
-  package MyApp;
+  my $rs = $c->model('FilmDB::Actor');
 
-  use Catalyst qw/... Authentication .../;
+See L<DBIx::Class::ResultSet> to find out more about which methods can be
+called on ResultSets.
 
-  ...
+You can also define your own ResultSet methods to encapsulate the
+database/business logic of your applications. These go into, for example,
+C<lib/MyApp/Schema/FilmDB/ResultSet/Actor.pm>. The class must inherit from
+L<DBIx::Class::ResultSet> and is automatically loaded.
 
-  __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',                   
-                            }
-                        }
-                    }
-                };
+Then call your methods like any other L<DBIx::Class::ResultSet> method:
 
-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.
+    $c->model('FilmDB::Actor')->SAG_members
 
-Some examples are given below:
+=head2 Some examples:
 
   # to access schema methods directly:
   $c->model('FilmDB')->schema->source(...);
@@ -154,17 +107,19 @@ Some examples are given below:
   $newconn->storage_type('::LDAP');
   $newconn->connection(...);
 
+To set up authentication, see L</"Setting up DBIC authentication"> below.
+
 =head1 DESCRIPTION
 
 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. 
+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 
@@ -194,12 +149,17 @@ resultset object:
 
 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.
+resultset class. This is just a matter of making a
+C<lib/MyApp/Schema/ResultSet/Actor.pm> class that inherits from
+L<DBIx::Class::ResultSet>, if you are using
+L<DBIx::Class::Schema/load_namespaces>, the default for helper script generated
+schemas.
 
-=head1 CONFIG PARAMETERS
+See L<DBIx::Class::Manual::Cookbook/"Predefined searches"> 
+for information on definining your own L<DBIx::Class::ResultSet> classes for
+use with L<DBIx::Class::Schema/load_classes>, the old default.
 
-Any options in your config not listed here are passed to your schema.
+=head1 CONFIG PARAMETERS
 
 =head2 schema_class
 
@@ -209,13 +169,12 @@ C<Catalyst::Model::> namespace.  This parameter is required.
 
 =head2 connect_info
 
-This is an arrayref of connection parameters, which are specific to your
-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 a hashref or arrayref of connection parameters, which are specific to
+your 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.
 
 This is not required if C<schema_class> already has connection information
-defined inside itself (which isn't highly recommended, but can be done)
+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
@@ -260,7 +219,7 @@ Or using L<Config::General>:
             user   postgres
             password ""
             auto_savepoint 1
-	    quote_char """
+            quote_names 1
             on_connect_do   some SQL statement
             on_connect_do   another SQL statement
         </connect_info>
@@ -286,7 +245,7 @@ Or using L<YAML>:
           LongReadLen: 1000000
           LongTruncOk: 1
           on_connect_call: 'datetime_setup'
-	  quote_char: '"'
+          quote_names: 1
 
 The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
 supported:
@@ -311,9 +270,10 @@ supported:
 
 Array of Traits to apply to the instance. Traits are L<Moose::Role>s.
 
-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.:
+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::TraitFor::Model::Foo
@@ -338,6 +298,10 @@ Traits that come with the distribution:
 
 =item L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
 
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>
+
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::PerRequestSchema>
+
 =back
 
 =head2 storage_type
@@ -385,16 +349,14 @@ Unresolved arrayref of traits passed in the config.
 
 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:
+=head1 CONFIGURING YOUR SCHEMA AND RESULTSETS
 
-    $c->model('DB')->schema->my_accessor('foo');
-    # or
-    $c->model('DB')->my_accessor('foo');
+See the documentation for
+L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy> for instructions on how
+to pass config values from your L<Catalyst> config to your
+L<DBIx::Class::Schema> and/or L<DBIx::Class::ResultSet> classes.
 
-Methods on the model take precedence over schema methods.
+=head1 METHODS
 
 =head2 new
 
@@ -436,10 +398,19 @@ Shortcut for ->schema->class
 
 Shortcut for ->schema->resultset
 
+=head2 txn_do
+
+Shortcut for ->schema->txn_do
+
+=head2 txn_scope_guard
+
+Shortcut for ->schema->txn_scope_guard
+
 =head2 storage
 
 Provides an accessor for the connected schema's storage object.
-Used often for debugging and controlling transactions.
+
+See L<DBIx::Class::Storage> and L<DBIx::Class::Storage::DBI>.
 
 =cut
 
@@ -468,6 +439,16 @@ has _default_cursor_class => (
     coerce => 1
 );
 
+has schema => (is => 'rw', isa => Schema);
+
+my $app_class;
+
+before COMPONENT => sub {
+    $app_class = ref $_[1] || $_[1];
+};
+
+sub app_class { $app_class }
+
 sub BUILD {
     my ($self, $args) = @_;
     my $class = $self->_original_class_name;
@@ -481,7 +462,7 @@ sub BUILD {
             die "Either ->config->{connect_info} must be defined for $class"
                   . " or $schema_class must have connect info defined on it."
 		  . " Here's what we got:\n"
-		  . Dumper($self);
+		  . Dumper($args);
         }
     }
 
@@ -491,39 +472,45 @@ sub BUILD {
         . " ".$self->connect_info->{cursor_class}.": $@";
     }
 
-    $self->setup;
+    $self->setup($args);
 
-    $self->composed_schema($schema_class->compose_namespace($class));
+    my $is_installed = defined $self->composed_schema;
 
-    $self->meta->make_mutable;
-    $self->meta->add_attribute('schema',
-        is => 'rw',
-        isa => 'DBIx::Class::Schema',
-        handles => $self->_delegates
-    );
-    $self->meta->make_immutable;
+    $self->composed_schema($schema_class->compose_namespace($class))
+        unless $is_installed;
 
-    $self->schema($self->composed_schema->clone);
-
-    $self->_pass_options_to_schema($args);
+    $self->schema($self->composed_schema->clone)
+        unless $self->schema;
 
     $self->schema->storage_type($self->storage_type)
         if $self->storage_type;
 
     $self->schema->connection($self->connect_info);
 
-    $self->_install_rs_models;
+    $self->_install_rs_models unless $is_installed;
 }
 
 sub clone { shift->composed_schema->clone(@_); }
 
 sub connect { shift->composed_schema->connect(@_); }
 
+# some proxy methods, see also SchemaProxy
+
+sub resultset { shift->schema->resultset(@_); }
+
+sub txn_do { shift->schema->txn_do(@_); }
+
+sub txn_scope_guard { shift->schema->txn_scope_guard(@_); }
+
+sub storage { shift->schema->storage(@_); }
+
 =head2 setup
 
 Called at C<BUILD> time before configuration, but after L</connect_info> is
 set. To do something after configuuration use C<< after BUILD => >>.
 
+Receives a hashref of args passed to C<BUILD>.
+
 =cut
 
 sub setup { 1 }
@@ -596,67 +583,57 @@ sub _build_model_name {
     return $model_name;
 }
 
-sub _delegates {
-    my $self = shift;
-
-    my $schema_meta = Class::MOP::Class->initialize($self->schema_class);
-    my @schema_methods = $schema_meta->get_all_method_names;
-
-# 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 (it clears the handles for some reason.) May be a Moose bug.
-    eval { $self->meta->remove_attribute('schema') };
+__PACKAGE__->meta->make_immutable;
 
-    my %schema_methods;
-    @schema_methods{ @schema_methods, @handles } = ();
-    @schema_methods = keys %schema_methods;
+=head1 ENVIRONMENT
 
-    my @my_methods = $self->meta->get_all_method_names;
-    my %my_methods;
-    @my_methods{@my_methods} = ();
+=over 4
 
-    my @delegates;
-    for my $method (@schema_methods) {
-        push @delegates, $method unless exists $my_methods{$method};
-    }
+=item CMDS_NO_SOURCES
 
-    return \@delegates;
-}
+Set this variable if you will be using schemas with no sources (Result classes)
+to disable the warning. The warning is there because having no Result classes
+is usually a mistake.
 
-sub _pass_options_to_schema {
-    my ($self, $args) = @_;
+=back
 
-    my @attributes = map {
-        $_->init_arg || ()
-    } $self->meta->get_all_attributes;
+=head1 Setting up DBIC authentication
 
-    my %attributes;
-    @attributes{@attributes} = ();
+You can set this up with 
+L<Catalyst::Authentication::Store::DBIx::Class> in MyApp.pm:
 
-    for my $opt (keys %$args) {
-        if (not exists $attributes{$opt}) {
-            next unless $self->schema->can($opt);
-            $self->schema->$opt($self->{$opt});
-        }
-    }
-}
+  package MyApp;
 
-__PACKAGE__->meta->make_immutable;
+  use Catalyst qw/... Authentication .../;
 
-=head1 ENVIRONMENT
+  ...
 
-=over 4
+  __PACKAGE__->config('Plugin::Authentication' =>
+                {
+                    default_realm => 'members',
+                    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',
+                        }
+                    }
+                });
 
-=item CMDS_NO_SOURCES
+=head1 METHOD PROXYING
 
-Set this variable if you will be using schemas with no sources (tables) to
-disable the warning. The warning is there because this is usually a mistake.
+The automatic proxying to the underlying L<DBIx::Class::Schema> has been
+removed as of version C<0.34>, to enable this feature add C<SchemaProxy> to
+L</traits>.
 
-=back
+See L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>.
 
 =head1 SEE ALSO
 
@@ -674,7 +651,10 @@ L<CatalystX::Component::Traits>, L<MooseX::Traits::Pluggable>
 Traits:
 
 L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>,
-L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
+L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::PerRequestSchema>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::QueryLog>
 
 =head1 AUTHOR
 
@@ -684,16 +664,32 @@ Brandon L Black C<blblack at gmail.com>
 
 caelum: Rafael Kitover C<rkitover at cpan.org>
 
-Dan Dascalescu C<dandv at cpan.org>
+dandv: Dan Dascalescu C<dandv at cpan.org>
+
+bluefeet: Aran Deltac C<bluefeet@cpan.org>
+
+t0m: Tomas Doran C<bobtfish@bobtfish.net>
 
-Aran Deltac C<bluefeet@cpan.org>
+osfameron: C<osfameron@cpan.org>
+
+ozum: Ozum Eldogan C<ozum@ozum.net>
+
+Pavel I. Shaydo C<zwon@trinitum.org>
+
+SineSwiper: Brendan Byrd <byrd.b@insightcom.com>
 
 =head1 COPYRIGHT
 
+Copyright (c) 2006 - 2010
+the Catalyst::Model::DBIC::Schema L</AUTHOR> and L</CONTRIBUTORS>
+as listed above.
+
+=head1 LICENSE
+
 This program is free software. You can redistribute it and/or modify it
 under the same terms as Perl itself.
 
 =cut
 
 1;
-# vim:sts=4 sw=4 et:
+# vim:sts=4 sw=4 et tw=80: