Prepping for release
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class.pm
index d473c2d..855f0b4 100644 (file)
@@ -3,30 +3,164 @@ package DBIx::Class;
 use strict;
 use warnings;
 
-use base qw/DBIx::Class::CDBICompat DBIx::Class::Core/;
-
 use vars qw($VERSION);
+use base qw/DBIx::Class::Componentised Class::Data::Accessor/;
+
+sub mk_classdata { shift->mk_classaccessor(@_); }
+sub component_base_class { 'DBIx::Class' }
+
+# Always remember to do all digits for the version even if they're 0
+# i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
+# brain damage and presumably various other packaging systems too
+
+$VERSION = '0.05005';
 
-$VERSION = '0.01';
+sub MODIFY_CODE_ATTRIBUTES {
+    my ($class,$code,@attrs) = @_;
+    unless ($class->can('_attr_cache')) {
+        $class->mk_classdata('_attr_cache');
+        $class->_attr_cache({});
+    }
+    my $cache = $class->_attr_cache;
+    $class->_attr_cache->{$code} = [@attrs];
+    return ();
+}
 
 1;
 
 =head1 NAME 
 
-DBIx::Class - Because the brain is a terrible thing to waste.
+DBIx::Class - Extensible and flexible object <-> relational mapper.
 
 =head1 SYNOPSIS
 
 =head1 DESCRIPTION
 
-This is a sql to oop mapper, inspired by the L<Class::DBI> framework, 
+This is an SQL to OO mapper, inspired by the L<Class::DBI> framework, 
 and meant to support compability with it, while restructuring the 
-insides, and making it possible to support some new features like 
+internals and making it possible to support some new features like 
 self-joins, distinct, group bys and more.
 
-=head1 AUTHORS
+This project is still at an early stage, so the maintainers don't make
+any absolute promise that full backwards-compatibility will be supported;
+however, if we can without compromising the improvements we're trying to
+make, we will, and any non-compatible changes will merit a full justification
+on the mailing list and a CPAN developer release for people to test against.
+
+The community can be found via -
+
+  Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
+
+  SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
+
+  Wiki: http://dbix-class.shadowcatsystems.co.uk/
+
+  IRC: irc.perl.org#dbix-class
+
+=head1 QUICKSTART
+
+If you're using L<Class::DBI>, and want an easy and fast way of migrating to
+DBIx::Class, take a look at L<DBIx::Class::CDBICompat>.
+
+There are two ways of using DBIx::Class, the "simple" way and the "schema" way.
+The "simple" way of using DBIx::Class needs less classes than the "schema"
+way but doesn't give you the ability to easily use different database connections.
+
+Some examples where different database connections are useful are:
+
+different users with different rights
+different databases with the same schema.
+
+=head2 Simple
+
+First you need to create a base class which all other classes will inherit from.
+See L<DBIx::Class::DB> for information on how to do this.
+
+Then you need to create a class for every table you want to use with DBIx::Class.
+See L<DBIx::Class::Table> for information on how to do this.
+
+=head2 Schema
+
+With this approach, the table classes inherit directly from DBIx::Class::Core,
+although it might be a good idea to create a "parent" class for all table
+classes that inherits from DBIx::Class::Core and adds additional methods
+needed by all table classes, e.g. reading a config file or loading auto primary
+key support.
+
+Look at L<DBIx::Class::Schema> for information on how to do this.
+
+If you need more help, check out the introduction in the 
+manual below.
+
+=head1 SEE ALSO
+
+=over 4
+
+=item L<DBIx::Class::Core> - DBIC Core Classes
+
+=item L<DBIx::Class::Manual> - User's manual
+
+=item L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer
+
+=item L<DBIx::Class::Schema>
+
+=item L<DBIx::Class::ResultSet>
+
+=item L<DBIx::Class::ResultSource>
+
+=item L<DBIx::Class::Row> - row-level methods
+
+=item L<DBIx::Class::PK> - primary key methods
+
+=item L<DBIx::Class::Relationship> - relationships between tables
+
+=back
+
+=head1 AUTHOR
+
+Matt S. Trout <mst@shadowcatsystems.co.uk>
+
+=head1 CONTRIBUTORS
+
+Andy Grundman <andy@hybridized.org>
+
+Brian Cassidy <bricas@cpan.org>
+
+Dan Kubb <dan.kubb-cpan@onautopilot.com>
+
+Dan Sully <daniel@cpan.org>
+
+David Kamholz <dkamholz@cpan.org>
+
+Jules Bean
+
+Marcus Ramberg <mramberg@cpan.org>
+
+Paul Makepeace
+
+CL Kao
+
+Jess Robinson
+
+Marcus Ramberg
+
+Will Hawes
+
+Todd Lipcon
+
+Daniel Westermann-Clark <danieltwc@cpan.org>
+
+Alexander Hartmaier <alex_hartmaier@hotmail.com>
+
+Zbigniew Lukasiak
+
+Nigel Metheringham <nigelm@cpan.org>
+
+Jesper Krogh
+
+Brandon Black
 
-Matt S. Trout <perl-stuff@trout.me.uk>
+Scotty Allen <scotty@scottyallen.com>
 
 =head1 LICENSE