X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fp5-DBIx-Class-ResultSet-RecursiveUpdate;a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSet%2FRecursiveUpdate.pm;h=a152dc02c21530f4d7d9fc306341ea6e4eb85bbf;hp=64fe03e8feb266ba9063e7e0ef394e64a4dd2659;hb=264a28fa4c2fdab1244cdba5c9e606ce8c411c0a;hpb=95990f43d600e577f9c87adebbe3eea8212218b6 diff --git a/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm b/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm index 64fe03e..a152dc0 100644 --- a/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm +++ b/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm @@ -5,13 +5,30 @@ use version; $VERSION = qv('0.001'); use warnings; use strict; use Carp; +use Scalar::Util qw( blessed ); use base qw(DBIx::Class::ResultSet); sub recursive_update { - my( $self, $updates ) = @_; + my( $self, $updates, $fixed_fields ) = @_; + if( blessed( $updates ) && $updates->isa( 'DBIx::Class::Row' ) ){ + return $updates; + } my $object; - $object = $self->find( $updates, { key => 'primary' } ) || $self->new( {} ); +# warn 'cond: ' . Dumper( $self->{cond} ); use Data::Dumper; +# warn 'where: ' . Dumper( $self->{attrs}{where} ); use Data::Dumper; + my @missing = grep { !exists $updates->{$_} && !exists $fixed_fields->{$_} } $self->result_source->primary_columns; + if( defined $self->{cond} && $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION == $self->{cond} ){ + $self->{cond} = undef; + $self->{attrs}{where} = undef; + if( ! scalar @missing ){ + $object = $self->find( $updates, { key => 'primary' } ); + } + } + else{ + $object = $self->find( $updates, { key => 'primary' } ); + } + $object ||= $self->new( {} ); for my $name ( keys %$updates ){ if($object->can($name)){ @@ -43,7 +60,10 @@ sub recursive_update { } #warn Dumper($object->{_column_data}); use Data::Dumper; } - _delete_empty_auto_increment($object); + $self->_delete_empty_auto_increment($object); + # don't allow insert to recurse to related objects - we do the recursion ourselves + $object->{_rel_in_storage} = 1; +# warn Dumper( $object->{_column_data} ); $object->update_or_insert; # updating relations that can be done only after the row is inserted into the database @@ -53,16 +73,22 @@ sub recursive_update { # many to many case if( $self->is_m2m( $name ) ) { my ( $pk ) = $self->_get_pk_for_related( $name ); - my @values = @{$updates->{$name}}; my @rows; my $result_source = $object->$name->result_source; - @rows = $result_source->resultset->search({ $pk => [ @values ] } ) if @values; + for my $elem ( @{$updates->{$name}} ){ + if( ref $elem ){ + push @rows, $result_source->resultset->find( $elem ); + } + else{ + push @rows, $result_source->resultset->find( { $pk => $elem } ); + } + } my $set_meth = 'set_' . $name; $object->$set_meth( \@rows ); } elsif( $object->result_source->has_relationship($name) ){ my $info = $object->result_source->relationship_info( $name ); - # has many case + # has many case (and similar) if( ref $updates->{$name} eq 'ARRAY' ){ for my $sub_updates ( @{$updates->{$name}} ) { my $sub_object = $object->search_related( $name )->recursive_update( $sub_updates ); @@ -80,9 +106,14 @@ sub recursive_update { sub is_m2m { my( $self, $relation ) = @_; + my $rclass = $self->result_class; + # DBIx::Class::IntrospectableM2M + if( $rclass->can( '_m2m_metadata' ) ){ + return $rclass->_m2m_metadata->{$relation}; + } my $object = $self->new({}); if ( $object->can($relation) and - !$object->result_source->has_relationship($relation) and + !$self->result_source->has_relationship($relation) and $object->can( 'set_' . $relation) ){ return 1; @@ -92,6 +123,17 @@ sub is_m2m { sub get_m2m_source { my( $self, $relation ) = @_; + my $rclass = $self->result_class; + # DBIx::Class::IntrospectableM2M + if( $rclass->can( '_m2m_metadata' ) ){ + return $self->result_source + ->related_source( + $rclass->_m2m_metadata->{$relation}{relation} + ) + ->related_source( + $rclass->_m2m_metadata->{$relation}{foreign_relation} + ); + } my $object = $self->new({}); my $r = $object->$relation; return $r->result_source; @@ -99,7 +141,7 @@ sub get_m2m_source { sub _delete_empty_auto_increment { - my ( $object ) = @_; + my ( $self, $object ) = @_; for my $col ( keys %{$object->{_column_data}}){ if( $object->result_source->column_info( $col )->{is_auto_increment} and @@ -147,8 +189,6 @@ sub _master_relation_cond { return; } -# Module implementation here - 1; # Magic true value required at end of module __END__ @@ -160,7 +200,7 @@ DBIx::Class::ResultSet::RecursiveUpdate - like update_or_create - but recursive =head1 VERSION -This document describes DBIx::Class::ResultSet::RecursiveUpdate version 0.0.1 +This document describes DBIx::Class::ResultSet::RecursiveUpdate version 0.001 =head1 SYNOPSIS @@ -185,30 +225,66 @@ Then: =head1 DESCRIPTION - You can feed the ->create method with a recursive datastructure and have the related records - created. Unfortunately you cannot do a similar thing with update_or_create - this module - tries to fill that void. - - It is a base class for ResultSets providing just one method: recursive_update - which works just like update_or_create but can recursively update or create - data objects composed of multiple rows. All rows need to be identified by primary keys - - so you need to provide them in the update structure (unless they can be deduced from - the parent row - for example when you have a belongs_to relationship). - When creating new rows in a table with auto_increment primary keys you need to - put 'undef' for the key value - this is then removed - and a correct INSERT statement is generated. - - For a many_to_many (pseudo) relation you can supply a list of primary keys - from the other table - and it will link the record at hand to those and - only those records identified by them. This is convenient for handling web - forms with check boxes (or a SELECT box with multiple choice) that let you - update such (pseudo) relations. - - For a description how to set up base classes for ResultSets see load_namespaces - in DBIx::Class::Schema. - - The support for many to many pseudo relationships should be treated as prototype - - the DBIC author disagrees with the way I did it. +You can feed the ->create method with a recursive datastructure and have the related records +created. Unfortunately you cannot do a similar thing with update_or_create - this module +tries to fill that void. + +It is a base class for ResultSets providing just one method: recursive_update +which works just like update_or_create but can recursively update or create +data objects composed of multiple rows. All rows need to be identified by primary keys +- so you need to provide them in the update structure (unless they can be deduced from +the parent row - for example when you have a belongs_to relationship). +When creating new rows in a table with auto_increment primary keys you need to +put 'undef' for the key value - this is then removed +and a correct INSERT statement is generated. + +For a many_to_many (pseudo) relation you can supply a list of primary keys +from the other table - and it will link the record at hand to those and +only those records identified by them. This is convenient for handling web +forms with check boxes (or a SELECT box with multiple choice) that let you +update such (pseudo) relations. + +For a description how to set up base classes for ResultSets see load_namespaces +in DBIx::Class::Schema. + +=head1 DESIGN CHOICES + +=head2 Treatment of many to many pseudo relations + +Matt Trout expressed following criticism of the support for many to many in +RecursiveUpdate and since this is an extension of his DBIx::Class I feel obliged to +reply to it. It is about two points leading in his opinion to 'fragile and +implicitely broken code'. + +1. That I rely on the fact that + + if($object->can($name) and + !$object->result_source->has_relationship($name) and + $object->can( 'set_' . $name ) + ) + +then $name must be a many to many pseudo relation. And that in a +similarly ugly was I find out what is the ResultSource of objects from +that many to many pseudo relation. + +2. That I treat uniformly relations and many to many (which are +different from relations because they require traversal of the bridge +table). + +To answer 1) I've refactored that 'dirty' code into is_m2m and get_m2m_source so +that it can be easily overridden. I agree that this code is not too nice - but +currenlty it is the only way to do what I need - and I'll replace it as soon as +there is a more clean way. I don't think it is extremely brittle - sure it will +break if many to many (pseudo) relations don't get 'set_*' methods anymore - but +I would say it is rather justified for this kind of change in underlying library +to break it. + + +Ad 2) - first this is not strictly true - RecursiveUpdate does have +different code to cope with m2m and other cases (see the point above for +example) - but it let's the user to treat m2m and 'normal' relations in a +uniform way. I consider this a form of abstraction - it is the work that +RecursiveUpdate does for the programmer. =head1 INTERFACE