Removed apparently unnecessary finish statements
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Table.pm
index 9873ce4..d6f65c9 100644 (file)
@@ -3,18 +3,43 @@ package DBIx::Class::Table;
 use strict;
 use warnings;
 
-use base qw/Class::Data::Inheritable DBIx::Class::SQL/;
+use DBIx::Class::Cursor;
+
+use base qw/Class::Data::Inheritable/;
 
 __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->store_column($k => $v);
     }
@@ -24,24 +49,31 @@ sub 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) = @_;
-  die "create needs a hashref" unless ref $attrs eq 'HASH';
+  $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,
@@ -49,9 +81,9 @@ sub update {
   my $rows = $sth->execute( (map { $self->{_column_data}{$_} } @to_update),
                   $self->_ident_values );
   if ($rows == 0) {
-    die "Can't update $self: row not found";
+    $self->throw( "Can't update $self: row not found" );
   } elsif ($rows > 1) {
-    die "Can't update $self: updated more than one row";
+    $self->throw("Can't update $self: updated more than one row");
   }
   $self->{_dirty_columns} = {};
   return $self;
@@ -60,40 +92,49 @@ sub update {
 sub delete {
   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);
-    $sth->finish;
-    delete $self->{_in_database};
+    $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->_where_from_hash($query);
+    my ($cond, @param) = $self->_cond_resolve($query, $attrs);
     my $sth = $self->_get_sth('delete', undef, $self->_table_name, $cond);
-    $sth->execute(@$param);
-    $sth->finish;
+    $sth->execute(@param);
   }
   return $self;
 }
 
 sub get_column {
   my ($self, $column) = @_;
-  die "Can't fetch data as class method" unless ref $self;
-  die "No such column '${column}'" unless $self->_columns->{$column};
-  return $self->{_column_data}{$column} if $self->_columns->{$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_column {
   my $self = shift;
   my ($column) = @_;
+  my $old = $self->get_column($column);
   my $ret = $self->store_column(@_);
-  $self->{_dirty_columns}{$column} = 1;
+  $self->{_dirty_columns}{$column} = 1 unless defined $old && $old eq $ret;
   return $ret;
 }
 
 sub store_column {
   my ($self, $column, $value) = @_;
-  die "No such column '${column}'" unless $self->_columns->{$column};
-  die "set_column called for ${column} without value" if @_ < 3;
+  $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;
 }
 
@@ -118,37 +159,72 @@ sub add_columns {
 sub retrieve_from_sql {
   my ($class, $cond, @vals) = @_;
   $cond =~ s/^\s*WHERE//i;
-  my @cols = $class->_select_columns;
+  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);
-  return $class->sth_to_objects($sth, \@vals, \@cols);
+  #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) = @_;
+  my ($class, $sth, $args, $cols, $attrs) = @_;
   my @cols = ((ref $cols eq 'ARRAY') ? @$cols : @{$sth->{NAME_lc}} );
-  $sth->execute(@$args);
-  my @found;
-  while (my @row = $sth->fetchrow_array) {
-    my $new = $class->new;
-    $new->store_column($_, shift @row) for @cols;
-    $new->{_in_database} = 1;
-    push(@found, $new);
-  }
-  return @found;
+  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 $where    = ref $_[0] eq "HASH" ? shift: {@_};
-  my ($cond, $param)  = $class->_where_from_hash($where);
-  return $class->retrieve_from_sql($cond, @{$param});
+  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 $where    = ref $_[0] eq "HASH" ? shift: {@_};
-  my ($cond, $param)  = $class->_where_from_hash($where, { cmp => 'like' });
-  return $class->retrieve_from_sql($cond, @{$param});
+  my $attrs = { };
+  if (@_ > 1 && ref $_[$#_] eq 'HASH') {
+    $attrs = pop(@_);
+  }
+  return $class->search(@_, { %$attrs, cmp => 'LIKE' });
 }
 
 sub _select_columns {
@@ -162,19 +238,54 @@ sub copy {
   return $new->insert;
 }
 
-sub _where_from_hash {
-  my ($self, $query, $opts) = @_;
-  my $op = $opts->{'cmp'} || '=';
+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 ]);
+  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
+