X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FOrdered.pm;h=bf7f954ff55c6da6e8f60a1c13432e215a095afd;hb=c5340bfac7aff784999be6ab4fa803fd9440043f;hp=54c6d46c3deff782a55654a4d01c71c2477ef972;hpb=5ef76b8b1094769245360ff8bf800fbde46119e6;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Ordered.pm b/lib/DBIx/Class/Ordered.pm index 54c6d46..bf7f954 100644 --- a/lib/DBIx/Class/Ordered.pm +++ b/lib/DBIx/Class/Ordered.pm @@ -3,9 +3,6 @@ use strict; use warnings; use base qw( DBIx::Class ); -use List::Util 'first'; -use namespace::clean; - =head1 NAME DBIx::Class::Ordered - Modify the position of objects in an ordered list. @@ -20,7 +17,7 @@ Create a table for your ordered data. position INTEGER NOT NULL ); -Optionally, add one or more columns to specify groupings, allowing you +Optionally, add one or more columns to specify groupings, allowing you to maintain independent ordered lists within one table: CREATE TABLE items ( @@ -40,12 +37,12 @@ Or even other_group_id INTEGER NOT NULL ); -In your Schema or DB class add "Ordered" to the top +In your Schema or DB class add "Ordered" to the top of the component list. __PACKAGE__->load_components(qw( Ordered ... )); -Specify the column that stores the position number for +Specify the column that stores the position number for each row. package My::Item; @@ -89,13 +86,13 @@ That's it, now you can change the position of your objects. =head1 DESCRIPTION -This module provides a simple interface for modifying the ordered +This module provides a simple interface for modifying the ordered position of DBIx::Class objects. =head1 AUTO UPDATE -All of the move_* methods automatically update the rows involved in -the query. This is not configurable and is due to the fact that if you +All of the move_* methods automatically update the rows involved in +the query. This is not configurable and is due to the fact that if you move a record it always causes other records in the list to be updated. =head1 METHODS @@ -104,24 +101,24 @@ move a record it always causes other records in the list to be updated. __PACKAGE__->position_column('position'); -Sets and retrieves the name of the column that stores the +Sets and retrieves the name of the column that stores the positional value of each record. Defaults to "position". =cut -__PACKAGE__->mk_classdata( 'position_column' => 'position' ); +__PACKAGE__->mk_classaccessor( 'position_column' => 'position' ); =head2 grouping_column __PACKAGE__->grouping_column('group_id'); -This method specifies a column to limit all queries in -this module by. This effectively allows you to have multiple +This method specifies a column to limit all queries in +this module by. This effectively allows you to have multiple ordered lists within the same table. =cut -__PACKAGE__->mk_classdata( 'grouping_column' ); +__PACKAGE__->mk_group_accessors( inherited => 'grouping_column' ); =head2 null_position_value @@ -136,7 +133,7 @@ indeed start from 0. =cut -__PACKAGE__->mk_classdata( 'null_position_value' => 0 ); +__PACKAGE__->mk_classaccessor( 'null_position_value' => 0 ); =head2 siblings @@ -147,7 +144,7 @@ Returns an B resultset of all other objects in the same group excluding the one you called it on. The ordering is a backwards-compatibility artifact - if you need -a resultset with no ordering applied use L +a resultset with no ordering applied use C<_siblings> =cut sub siblings { @@ -218,7 +215,7 @@ sub previous_sibling { my $sibling = $item->first_sibling(); -Returns the first sibling object, or 0 if the first sibling +Returns the first sibling object, or 0 if the first sibling is this sibling. =cut @@ -259,7 +256,7 @@ sub next_sibling { my $sibling = $item->last_sibling(); -Returns the last sibling, or 0 if the last sibling is this +Returns the last sibling, or 0 if the last sibling is this sibling. =cut @@ -275,7 +272,7 @@ sub last_sibling { return defined $lsib ? $lsib : 0; } -# an optimized method to get the last sibling position value without inflating a row object +# an optimized method to get the last sibling position value without inflating a result object sub _last_sibling_posval { my $self = shift; my $position_column = $self->position_column; @@ -367,7 +364,31 @@ sub move_to { my $position_column = $self->position_column; - if ($self->is_column_changed ($position_column) ) { + my $rsrc = $self->result_source; + + my $is_txn; + if ($is_txn = $rsrc->schema->storage->transaction_depth) { + # Reload position state from storage + # The thinking here is that if we are in a transaction, it is + # *more likely* the object went out of sync due to resultset + # level shenanigans. Instead of always reloading (slow) - go + # ahead and hand-hold only in the case of higher layers + # requesting the safety of a txn + + $self->store_column( + $position_column, + ( $rsrc->resultset + ->search($self->_storage_ident_condition, { rows => 1, columns => $position_column }) + ->cursor + ->next + )[0] || $self->throw_exception( + sprintf "Unable to locate object '%s' in storage - object went ouf of sync...?", + $self->ID + ), + ); + delete $self->{_dirty_columns}{$position_column}; + } + elsif ($self->is_column_changed ($position_column) ) { # something changed our position, we need to know where we # used to be - use the stashed value $self->store_column($position_column, delete $self->{_column_data_in_storage}{$position_column}); @@ -380,7 +401,7 @@ sub move_to { return 0; } - my $guard = $self->result_source->schema->txn_scope_guard; + my $guard = $is_txn ? undef : $rsrc->schema->txn_scope_guard; my ($direction, @between); if ( $from_position < $to_position ) { @@ -395,14 +416,14 @@ sub move_to { my $new_pos_val = $self->_position_value ($to_position); # record this before the shift # we need to null-position the moved row if the position column is part of a constraint - if (grep { $_ eq $position_column } ( map { @$_ } (values %{{ $self->result_source->unique_constraints }} ) ) ) { + if (grep { $_ eq $position_column } ( map { @$_ } (values %{{ $rsrc->unique_constraints }} ) ) ) { $self->_ordered_internal_update({ $position_column => $self->null_position_value }); } $self->_shift_siblings ($direction, @between); $self->_ordered_internal_update({ $position_column => $new_pos_val }); - $guard->commit; + $guard->commit if $guard; return 1; } @@ -415,7 +436,7 @@ group, or to the end of the group if $position is undef. 1 is returned on success, and 0 is returned if the object is already at the specified position of the specified group. -$group may be specified as a single scalar if only one +$group may be specified as a single scalar if only one grouping column is in use, or as a hashref of column => value pairs if multiple grouping columns are in use. @@ -489,8 +510,8 @@ sub move_to_group { =head2 insert -Overrides the DBIC insert() method by providing a default -position number. The default will be the number of rows in +Overrides the DBIC insert() method by providing a default +position number. The default will be the number of rows in the table +1, thus positioning the new record at the last position. =cut @@ -526,7 +547,7 @@ sub update { my $self = shift; # this is set by _ordered_internal_update() - return $self->next::method(@_) if $self->{_ORDERED_INTERNAL_UPDATE}; + return $self->next::method(@_) if $self->result_source->schema->{_ORDERED_INTERNAL_UPDATE}; my $upd = shift; $self->set_inflated_columns($upd) if $upd; @@ -541,7 +562,7 @@ sub update { if (! keys %$changed_ordering_cols) { return $self->next::method( undef, @_ ); } - elsif (defined first { exists $changed_ordering_cols->{$_} } @group_columns ) { + elsif (grep { exists $changed_ordering_cols->{$_} } @group_columns ) { $self->move_to_group( # since the columns are already re-set the _grouping_clause is correct # move_to_group() knows how to get the original storage values @@ -581,25 +602,21 @@ sub delete { $self->move_last; - my @res; - if (not defined wantarray) { - $self->next::method( @_ ); - } - elsif (wantarray) { - @res = $self->next::method( @_ ); - } - else { - $res[0] = $self->next::method( @_ ); - } + $self->next::method( @_ ); $guard->commit; - return wantarray ? @res : $res[0]; + + return $self; } # add the current position/group to the things we track old values for sub _track_storage_value { my ($self, $col) = @_; - return $self->next::method($col) || defined first { $_ eq $col } ($self->position_column, $self->_grouping_columns); + return ( + $self->next::method($col) + || + grep { $_ eq $col } ($self->position_column, $self->_grouping_columns) + ); } =head1 METHODS FOR EXTENDING ORDERED @@ -663,7 +680,7 @@ L below. Defaults to 1. =cut -__PACKAGE__->mk_classdata( '_initial_position_value' => 1 ); +__PACKAGE__->mk_classaccessor( '_initial_position_value' => 1 ); =head2 _next_position_value @@ -715,27 +732,25 @@ sub _shift_siblings { my $shift_rs = $self->_group_rs-> search ({ $position_column => { -between => \@between } }); - # some databases (sqlite) are dumb and can not do a blanket - # increment/decrement. So what we do here is check if the - # position column is part of a unique constraint, and do a - # one-by-one update if this is the case - + # some databases (sqlite, pg, perhaps others) are dumb and can not do a + # blanket increment/decrement without violating a unique constraint. + # So what we do here is check if the position column is part of a unique + # constraint, and do a one-by-one update if this is the case. my $rsrc = $self->result_source; - if (grep { $_ eq $position_column } ( map { @$_ } (values %{{ $rsrc->unique_constraints }} ) ) ) { - - my @pcols = $rsrc->_pri_cols; - my $cursor = $shift_rs->search ({}, { order_by => { "-$ord", $position_column }, columns => \@pcols } )->cursor; - my $rs = $self->result_source->resultset; - - my @all_pks = $cursor->all; - while (my $pks = shift @all_pks) { - my $cond; - for my $i (0.. $#pcols) { - $cond->{$pcols[$i]} = $pks->[$i]; - } - - $rs->search($cond)->update ({ $position_column => \ "$position_column $op 1" } ); + # set in case there are more cascades combined with $rs->update => $rs_update_all overrides + local $rsrc->schema->{_ORDERED_INTERNAL_UPDATE} = 1; + my @pcols = $rsrc->primary_columns; + if ( + grep { $_ eq $position_column } ( map { @$_ } (values %{{ $rsrc->unique_constraints }} ) ) + ) { + my $clean_rs = $rsrc->resultset; + + for ( $shift_rs->search ( + {}, { order_by => { "-$ord", $position_column }, select => [$position_column, @pcols] } + )->cursor->all ) { + my $pos = shift @$_; + $clean_rs->find(@$_)->update ({ $position_column => $pos + ( ($op eq '+') ? 1 : -1 ) }); } } else { @@ -743,71 +758,46 @@ sub _shift_siblings { } } -=head1 PRIVATE METHODS - -These methods are used internally. You should never have the -need to use them. - -=head2 _group_rs -This method returns a resultset containing all members of the row -group (including the row itself). - -=cut +# This method returns a resultset containing all members of the row +# group (including the row itself). sub _group_rs { my $self = shift; return $self->result_source->resultset->search({$self->_grouping_clause()}); } -=head2 _siblings - -Returns an unordered resultset of all objects in the same group -excluding the object you called this method on. - -=cut +# Returns an unordered resultset of all objects in the same group +# excluding the object you called this method on. sub _siblings { my $self = shift; my $position_column = $self->position_column; - return defined (my $pos = $self->get_column($position_column)) + my $pos; + return defined ($pos = $self->get_column($position_column)) ? $self->_group_rs->search( - { $position_column => { '!=' => $self->get_column($position_column) } }, + { $position_column => { '!=' => $pos } }, ) : $self->_group_rs ; } -=head2 _position - - my $num_pos = $item->_position; - -Returns the B of the current object, with the -first object being at position 1, its sibling at position 2 and so on. - -=cut +# Returns the B of the current object, with the +# first object being at position 1, its sibling at position 2 and so on. sub _position { my $self = shift; return $self->_position_from_value ($self->get_column ($self->position_column) ); } -=head2 _grouping_clause - -This method returns one or more name=>value pairs for limiting a search -by the grouping column(s). If the grouping column is not defined then -this will return an empty list. - -=cut +# This method returns one or more name=>value pairs for limiting a search +# by the grouping column(s). If the grouping column is not defined then +# this will return an empty list. sub _grouping_clause { my( $self ) = @_; return map { $_ => $self->get_column($_) } $self->_grouping_columns(); } -=head2 _get_grouping_columns - -Returns a list of the column names used for grouping, regardless of whether -they were specified as an arrayref or a single string, and returns () -if there is no grouping. - -=cut +# Returns a list of the column names used for grouping, regardless of whether +# they were specified as an arrayref or a single string, and returns () +# if there is no grouping. sub _grouping_columns { my( $self ) = @_; my $col = $self->grouping_column(); @@ -820,13 +810,7 @@ sub _grouping_columns { } } -=head2 _is_in_group - - $item->_is_in_group( {user => 'fred', list => 'work'} ) - -Returns true if the object is in the group represented by hashref $other - -=cut +# Returns true if the object is in the group represented by hashref $other sub _is_in_group { my ($self, $other) = @_; my $current = {$self->_grouping_clause}; @@ -844,26 +828,21 @@ sub _is_in_group { return 1; } -=head2 _ordered_internal_update - -This is a short-circuited method, that is used internally by this -module to update positioning values in isolation (i.e. without -triggering any of the positioning integrity code). - -Some day you might get confronted by datasets that have ambiguous -positioning data (e.g. duplicate position values within the same group, -in a table without unique constraints). When manually fixing such data -keep in mind that you can not invoke L like -you normally would, as it will get confused by the wrong data before -having a chance to update the ill-defined row. If you really know what -you are doing use this method which bypasses any hooks introduced by -this module. - -=cut - +# This is a short-circuited method, that is used internally by this +# module to update positioning values in isolation (i.e. without +# triggering any of the positioning integrity code). +# +# Some day you might get confronted by datasets that have ambiguous +# positioning data (e.g. duplicate position values within the same group, +# in a table without unique constraints). When manually fixing such data +# keep in mind that you can not invoke L like +# you normally would, as it will get confused by the wrong data before +# having a chance to update the ill-defined row. If you really know what +# you are doing use this method which bypasses any hooks introduced by +# this module. sub _ordered_internal_update { my $self = shift; - local $self->{_ORDERED_INTERNAL_UPDATE} = 1; + local $self->result_source->schema->{_ORDERED_INTERNAL_UPDATE} = 1; return $self->update (@_); } @@ -900,33 +879,31 @@ will prevent such race conditions going undetected. =head2 Multiple Moves -Be careful when issuing move_* methods to multiple objects. If -you've pre-loaded the objects then when you move one of the objects -the position of the other object will not reflect their new value -until you reload them from the database - see -L. +If you have multiple same-group result objects already loaded from storage, +you need to be careful when executing C operations on them: +without a L reload the L of the +"siblings" will be out of sync with the underlying storage. -There are times when you will want to move objects as groups, such -as changing the parent of several objects at once - this directly -conflicts with this problem. One solution is for us to write a -ResultSet class that supports a parent() method, for example. Another -solution is to somehow automagically modify the objects that exist -in the current object's result set to have the new position value. +Starting from version C<0.082800> DBIC will implicitly perform such +reloads when the C happens as a part of a transaction +(a good example of such situation is C<< $ordered_resultset->delete_all >>). + +If it is not possible for you to wrap the entire call-chain in a transaction, +you will need to call L to get an object +up-to-date before proceeding, otherwise undefined behavior will result. =head2 Default Values Using a database defined default_value on one of your group columns could result in the position not being assigned correctly. -=head1 AUTHOR - - Original code framework - Aran Deltac - - Constraints support and code generalisation - Peter Rabbitson +=head1 FURTHER QUESTIONS? -=head1 LICENSE +Check the list of L. -You may distribute this code under the same terms as Perl itself. +=head1 COPYRIGHT AND LICENSE +This module is free software L +by the L. You can +redistribute it and/or modify it under the same terms as the +L.