Simplified column handling code, moved primary key defs to Table.pm

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Table.pm

diff --git a/lib/DBIx/Class/Table.pm b/lib/DBIx/Class/Table.pm
index cce20ef..d824b0a 100644 (file)
--- a/lib/DBIx/Class/Table.pm
+++ b/lib/DBIx/Class/Table.pm
@@ -5,21 +5,17 @@ use warnings;
 
 use DBIx::Class::ResultSet;
 
-use base qw/DBIx::Class/;
-
-__PACKAGE__->mk_classdata('_columns' => {});
-
-__PACKAGE__->mk_classdata('_table_name');
+use Carp qw/croak/;
 
-__PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet!
-
-__PACKAGE__->mk_classdata('_resultset_class' => 'DBIx::Class::ResultSet');
+use base qw/DBIx::Class/;
+__PACKAGE__->load_components(qw/AccessorGroup/);
 
-sub iterator_class { shift->_resultset_class(@_) }
+__PACKAGE__->mk_group_accessors('simple' =>
+  qw/_columns _primaries name resultset_class result_class storage/);
 
 =head1 NAME 
 
-DBIx::Class::Table - Basic table methods
+DBIx::Class::Table - Table object
 
 =head1 SYNOPSIS
 
@@ -32,83 +28,54 @@ L<DBIx::Class> classes.
 
 =cut
 
-sub _register_columns {
-  my ($class, @cols) = @_;
-  my $names = { %{$class->_columns} };
-  while (my $col = shift @cols) {
-    $names->{$col} = (ref $cols[0] ? shift : {});
-  }
-  $class->_columns($names); 
-}
-
-sub _mk_column_accessors {
-  my ($class, @cols) = @_;
-  $class->mk_group_accessors('column' => @cols);
+sub new {
+  my ($class, $attrs) = @_;
+  $class = ref $class if ref $class;
+  my $new = bless({ %{$attrs || {}} }, $class);
+  $new->{resultset_class} ||= 'DBIx::Class::ResultSet';
+  $new->{_columns} ||= {};
+  $new->{name} ||= "!!NAME NOT SET!!";
+  return $new;
 }
 
-=head2 add_columns
-
-  __PACKAGE__->add_columns(qw/col1 col2 col3/);
-
-Adds columns to the current class and creates accessors for them.
-
-=cut
-
 sub add_columns {
-  my ($class, @cols) = @_;
-  $class->_register_columns(@cols);
-  $class->_mk_column_accessors(@cols);
-}
-
-sub resultset_instance {
-  my $class = shift;
-  $class->next::method($class->construct_resultset);
+  my ($self, @cols) = @_;
+  while (my $col = shift @cols) {
+    $self->_columns->{$col} = (ref $cols[0] ? shift : {});
+  }
 }
 
-sub construct_resultset {
-  my $class = shift;
-  my $rs_class = $class->_resultset_class;
-  eval "use $rs_class;";
-  return $rs_class->new($class);
-}
+*add_column = \&add_columns;
 
-sub _select_columns {
-  return keys %{$_[0]->_columns};
-}
-
-=head2 table
+=head2 add_columns
 
-  __PACKAGE__->table('tbl_name');
-  
-Gets or sets the table name.
+  $table->add_columns(qw/col1 col2 col3/);
 
-=cut
+  $table->add_columns('col1' => \%col1_info, 'col2' => \%col2_info, ...);
 
-sub table {
-  shift->_table_name(@_);
-}
+Adds columns to the table object. If supplied key => hashref pairs uses
+the hashref as the column_info for that column.
 
-=head2 find_or_create
+=head2 add_column
 
-  $class->find_or_create({ key => $val, ... });
+  $table->add_column('col' => \%info?);
 
-Searches for a record matching the search condition; if it doesn't find one,
-creates one and returns that instead.
+Convenience alias to add_columns
 
 =cut
 
-sub find_or_create {
-  my $class    = shift;
-  my $hash     = ref $_[0] eq "HASH" ? shift: {@_};
-  my $exists = $class->find($hash);
-  return defined($exists) ? $exists : $class->create($hash);
+sub resultset {
+  my $self = shift;
+  my $rs_class = $self->resultset_class;
+  eval "use $rs_class;";
+  return $rs_class->new($self);
 }
 
 =head2 has_column                                                                
                                                                                 
   if ($obj->has_column($col)) { ... }                                           
                                                                                 
-Returns 1 if the class has a column of this name, 0 otherwise.                  
+Returns 1 if the table has a column of this name, 0 otherwise.                  
                                                                                 
 =cut                                                                            
 
@@ -127,21 +94,49 @@ Returns the column metadata hashref for a column.
 
 sub column_info {
   my ($self, $column) = @_;
-  die "No such column $column" unless exists $self->_columns->{$column};
+  croak "No such column $column" unless exists $self->_columns->{$column};
   return $self->_columns->{$column};
 }
 
-=head2 columns                                                                   
-                                                                                
+=head2 columns
+
   my @column_names = $obj->columns;                                             
                                                                                 
 =cut                                                                            
 
 sub columns {
-  die "columns() is a read-only accessor, did you mean add_columns()?" if (@_ > 1);
+  croak "columns() is a read-only accessor, did you mean add_columns()?" if (@_ > 1);
   return keys %{shift->_columns};
 }
 
+=head2 set_primary_key(@cols)                                                   
+                                                                                
+Defines one or more columns as primary key for this table. Should be            
+called after C<add_columns>.
+                                                                                
+=cut                                                                            
+
+sub set_primary_key {
+  my ($self, @cols) = @_;
+  # check if primary key columns are valid columns
+  for (@cols) {
+    $self->throw("No such column $_ on table ".$self->name)
+      unless $self->has_column($_);
+  }
+  $self->_primaries(\@cols);
+}
+
+=head2 primary_columns                                                          
+                                                                                
+Read-only accessor which returns the list of primary keys.
+                                                                                
+=cut                                                                            
+
+sub primary_columns {
+  return @{shift->_primaries||[]};
+}
+
+
 1;
 
 =head1 AUTHORS