Removed apparently unnecessary finish statements
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Table.pm
index 9556eb9..d6f65c9 100644 (file)
@@ -3,84 +3,139 @@ package DBIx::Class::Table;
 use strict;
 use warnings;
 
-use base qw/Class::Data::Inheritable Class::Accessor DBIx::Class::SQL/;
+use DBIx::Class::Cursor;
 
-__PACKAGE__->mk_classdata('_columns' => {});
+use base qw/Class::Data::Inheritable/;
 
-__PACKAGE__->mk_classdata('_primaries' => {});
+__PACKAGE__->mk_classdata('_columns' => {});
 
 __PACKAGE__->mk_classdata('_table_name');
 
+__PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet!
+
+__PACKAGE__->mk_classdata('_cursor_class' => 'DBIx::Class::Cursor');
+
+sub iterator_class { shift->_cursor_class(@_) }
+
+=head1 NAME 
+
+DBIx::Class::Table - Basic table methods
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+This class is responsible for defining and doing basic operations on 
+L<DBIx::Class> objects.
+
+=head1 METHODS
+
+=over 4
+
+=cut
+
 sub new {
   my ($class, $attrs) = @_;
   $class = ref $class if ref $class;
   my $new = bless({ _column_data => { } }, $class);
   if ($attrs) {
-    die "Attrs must be a hashref" unless ref($attrs) eq 'HASH';
+    $new->throw("attrs must be a hashref" ) unless ref($attrs) eq 'HASH';
     while (my ($k, $v) = each %{$attrs}) {
-      $new->set_column($k => $v);
+      $new->store_column($k => $v);
     }
   }
+  return $new;
 }
 
 sub insert {
   my ($self) = @_;
-  return if $self->{_in_database};
+  return if $self->in_database;
+  #use Data::Dumper; warn Dumper($self);
   my $sth = $self->_get_sth('insert', [ keys %{$self->{_column_data}} ],
                               $self->_table_name, undef);
   $sth->execute(values %{$self->{_column_data}});
-  $self->{_in_database} = 1;
+  $self->in_database(1);
+  $self->{_dirty_columns} = {};
   return $self;
 }
 
+sub in_database {
+  my ($self, $val) = @_;
+  $self->{_in_database} = $val if @_ > 1;
+  return $self->{_in_database};
+}
+
 sub create {
   my ($class, $attrs) = @_;
+  $class->throw( "create needs a hashref" ) unless ref $attrs eq 'HASH';
   return $class->new($attrs)->insert;
 }
 
 sub update {
   my ($self) = @_;
-  die "Not in database" unless $self->{_in_database};
+  $self->throw( "Not in database" ) unless $self->in_database;
   my @to_update = keys %{$self->{_dirty_columns} || {}};
+  return -1 unless @to_update;
   my $sth = $self->_get_sth('update', \@to_update,
                               $self->_table_name, $self->_ident_cond);
-  $sth->execute( (map { $self->{_column_data}{$_} } @to_update),
+  my $rows = $sth->execute( (map { $self->{_column_data}{$_} } @to_update),
                   $self->_ident_values );
+  if ($rows == 0) {
+    $self->throw( "Can't update $self: row not found" );
+  } elsif ($rows > 1) {
+    $self->throw("Can't update $self: updated more than one row");
+  }
   $self->{_dirty_columns} = {};
   return $self;
 }
 
 sub delete {
-  my ($self) = @_;
-  my $sth = $self->_get_sth('delete', undef,
-                              $self->_table_name, $self->_ident_cond);
-  $sth->execute($self->_ident_values);
-  delete $self->{_in_database};
+  my $self = shift;
+  if (ref $self) {
+    $self->throw( "Not in database" ) unless $self->in_database;
+    #warn $self->_ident_cond.' '.join(', ', $self->_ident_values);
+    my $sth = $self->_get_sth('delete', undef,
+                                $self->_table_name, $self->_ident_cond);
+    $sth->execute($self->_ident_values);
+    $self->in_database(undef);
+  } else {
+    my $attrs = { };
+    if (@_ > 1 && ref $_[$#_] eq 'HASH') {
+      $attrs = { %{ pop(@_) } };
+    }
+    my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_});
+    my ($cond, @param) = $self->_cond_resolve($query, $attrs);
+    my $sth = $self->_get_sth('delete', undef, $self->_table_name, $cond);
+    $sth->execute(@param);
+  }
   return $self;
 }
 
-sub get {
+sub get_column {
   my ($self, $column) = @_;
-  die "No such column '${column}'" unless $self->_columns->{$column};
-  return $self->{_column_data}{$column};
+  $self->throw( "Can't fetch data as class method" ) unless ref $self;
+  $self->throw( "No such column '${column}'" ) unless $self->_columns->{$column};
+  return $self->{_column_data}{$column}
+    if exists $self->{_column_data}{$column};
+  return undef;
 }
 
-sub set {
-  my ($self, $column, $value) = @_;
-  die "No such column '${column}'" unless $self->_columns->{$column};
-  die "set_column called for ${column} without value" if @_ < 3;
-  $self->{_dirty_columns}{$column} = 1;
-  return $self->{_column_data}{$column} = $value;
+sub set_column {
+  my $self = shift;
+  my ($column) = @_;
+  my $old = $self->get_column($column);
+  my $ret = $self->store_column(@_);
+  $self->{_dirty_columns}{$column} = 1 unless defined $old && $old eq $ret;
+  return $ret;
 }
 
-sub _ident_cond {
-  my ($class) = @_;
-  return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries});
-}
-
-sub _ident_values {
-  my ($self) = @_;
-  return (map { $self->{_column_data}{$_} } keys %{$self->_primaries});
+sub store_column {
+  my ($self, $column, $value) = @_;
+  $self->throw( "No such column '${column}'" ) 
+    unless $self->_columns->{$column};
+  $self->throw( "set_column called for ${column} without value" ) 
+    if @_ < 3;
+  return $self->{_column_data}{$column} = $value;
 }
 
 sub _register_columns {
@@ -92,7 +147,145 @@ sub _register_columns {
 
 sub _mk_column_accessors {
   my ($class, @cols) = @_;
-  $class->mk_accessors(@cols);
+  $class->mk_group_accessors('column' => @cols);
+}
+
+sub add_columns {
+  my ($class, @cols) = @_;
+  $class->_register_columns(@cols);
+  $class->_mk_column_accessors(@cols);
+}
+
+sub retrieve_from_sql {
+  my ($class, $cond, @vals) = @_;
+  $cond =~ s/^\s*WHERE//i;
+  my $attrs = (ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
+  my @cols = $class->_select_columns($attrs);
+  my $sth = $class->_get_sth( 'select', \@cols, $class->_table_name, $cond);
+  #warn "$cond @vals";
+  return $class->sth_to_objects($sth, \@vals, \@cols, { where => $cond });
+}
+
+sub count_from_sql {
+  my ($class, $cond, @vals) = @_;
+  $cond =~ s/^\s*WHERE//i;
+  my $attrs = (ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
+  my @cols = 'COUNT(*)';
+  my $sth = $class->_get_sth( 'select', \@cols, $class->_table_name, $cond);
+  #warn "$cond @vals";
+  $sth->execute(@vals);
+  my ($count) = $sth->fetchrow_array;
+  return $count;
+}
+
+sub count {
+  my $class = shift;
+  my $attrs = { };
+  if (@_ > 1 && ref $_[$#_] eq 'HASH') {
+    $attrs = { %{ pop(@_) } };
+  }
+  my $query    = ref $_[0] eq "HASH" ? shift: {@_};
+  my ($cond, @param)  = $class->_cond_resolve($query, $attrs);
+  return $class->count_from_sql($cond, @param, $attrs);
+}
+
+sub sth_to_objects {
+  my ($class, $sth, $args, $cols, $attrs) = @_;
+  my @cols = ((ref $cols eq 'ARRAY') ? @$cols : @{$sth->{NAME_lc}} );
+  my @args = map { ref $_ ? ''.$_ : $_ } @$args; # Stringify objects
+  my $cursor_class = $class->_cursor_class;
+  eval "use $cursor_class;";
+  my $cursor = $cursor_class->new($class, $sth, \@args, \@cols, $attrs);
+  return (wantarray ? $cursor->all : $cursor);
+}
+
+sub _row_to_object { # WARNING: Destructive to @$row
+  my ($class, $cols, $row) = @_;
+  my $new = $class->new;
+  $new->store_column($_, shift @$row) for @$cols;
+  $new->in_database(1);
+  return $new;
+}
+
+sub search {
+  my $class = shift;
+  my $attrs = { };
+  if (@_ > 1 && ref $_[$#_] eq 'HASH') {
+    $attrs = { %{ pop(@_) } };
+  }
+  my $query    = ref $_[0] eq "HASH" ? shift: {@_};
+  my ($cond, @param)  = $class->_cond_resolve($query, $attrs);
+  return $class->retrieve_from_sql($cond, @param, $attrs);
+}
+
+sub search_like {
+  my $class    = shift;
+  my $attrs = { };
+  if (@_ > 1 && ref $_[$#_] eq 'HASH') {
+    $attrs = pop(@_);
+  }
+  return $class->search(@_, { %$attrs, cmp => 'LIKE' });
+}
+
+sub _select_columns {
+  return keys %{$_[0]->_columns};
+}
+
+sub copy {
+  my ($self, $changes) = @_;
+  my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self);
+  $new->set_column($_ => $changes->{$_}) for keys %$changes;
+  return $new->insert;
+}
+
+sub _cond_resolve {
+  my ($self, $query, $attrs) = @_;
+  return '1 = 1' unless keys %$query;
+  my $op = $attrs->{'cmp'} || '=';
+  my $cond = join(' AND ',
+               map { (defined $query->{$_}
+                       ? "$_ $op ?"
+                       : (do { delete $query->{$_}; "$_ IS NULL"; }));
+                   } keys %$query);
+  return ($cond, values %$query);
+}
+
+sub table {
+  shift->_table_name(@_);
+}
+
+sub find_or_create {
+  my $class    = shift;
+  my $hash     = ref $_[0] eq "HASH" ? shift: {@_};
+  my ($exists) = $class->search($hash);
+  return defined($exists) ? $exists : $class->create($hash);
+}
+
+sub insert_or_update {
+  my $self = shift;
+  return ($self->in_database ? $self->update : $self->insert);
+}
+
+sub retrieve_all {
+  my ($class) = @_;
+  return $class->retrieve_from_sql( '1' );
+}
+
+sub is_changed {
+  return keys %{shift->{_dirty_columns} || {}};
 }
 
 1;
+
+=back
+
+=head1 AUTHORS
+
+Matt S. Trout <perl-stuff@trout.me.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+