package SQL::Translator::Schema::Trigger;
-# ----------------------------------------------------------------------
-# $Id: Trigger.pm,v 1.4 2004-11-04 16:29:56 grommit Exp $
-# ----------------------------------------------------------------------
-# Copyright (C) 2002-4 SQLFairy Authors
-#
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License as
-# published by the Free Software Foundation; version 2.
-#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-# 02111-1307 USA
-# -------------------------------------------------------------------
-
=pod
=head1 NAME
use SQL::Translator::Schema::Trigger;
my $trigger = SQL::Translator::Schema::Trigger->new(
- name => 'foo',
- perform_action_when => 'before', # or after
- database_event => 'insert', # or update, update_on, delete
- fields => [], # fields if event is "update"
- on_table => 'foo', # table name
- action => '...', # text of trigger
- schema => $schema, # Schema object
+ name => 'foo',
+ perform_action_when => 'before', # or after
+ database_events => [qw/update insert/], # also update, update_on, delete
+ fields => [], # if event is "update"
+ on_table => 'foo', # table name
+ action => '...', # text of trigger
+ schema => $schema, # Schema object
+ scope => 'row', # or statement
);
=head1 DESCRIPTION
=cut
-use strict;
-use SQL::Translator::Utils 'parse_list_arg';
-
-use base 'SQL::Translator::Schema::Object';
+use Moo;
+use SQL::Translator::Utils qw(parse_list_arg ex2err throw);
+use SQL::Translator::Types qw(schema_obj);
+use List::MoreUtils qw(uniq);
-use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
+extends 'SQL::Translator::Schema::Object';
-$VERSION = sprintf "%d.%02d", q$Revision: 1.4 $ =~ /(\d+)\.(\d+)/;
-
-# ----------------------------------------------------------------------
-sub init {
-
-=pod
+our $VERSION = '1.59';
=head2 new
=cut
- my ( $self, $config ) = @_;
-
- for my $arg (
- qw[
- name perform_action_when database_event fields
- on_table action schema
- ]
- ) {
- next unless $config->{ $arg };
- $self->$arg( $config->{ $arg } );# or return;
+around BUILDARGS => sub {
+ my ($orig, $self, @args) = @_;
+ my $args = $self->$orig(@args);
+ if (exists $args->{on_table}) {
+ my $arg = delete $args->{on_table};
+ my $table = $args->{schema}->get_table($arg)
+ or die "Table named $arg doesn't exist";
+ $args->{table} = $table;
}
-
- return $self;
-}
-
-# ----------------------------------------------------------------------
-sub perform_action_when {
-
-=pod
+ if (exists $args->{database_event}) {
+ $args->{database_events} = delete $args->{database_event};
+ }
+ return $args;
+};
=head2 perform_action_when
-Gets or sets whether the event happens "before" or "after" the
+Gets or sets whether the event happens "before" or "after" the
C<database_event>.
$trigger->perform_action_when('after');
=cut
- my $self = shift;
-
- if ( my $arg = shift ) {
- $arg = lc $arg;
- $arg =~ s/\s+/ /g;
- if ( $arg =~ m/^(before|after)$/i ) {
- $self->{'perform_action_when'} = $arg;
- }
- else {
- return
- $self->error("Invalid argument '$arg' to perform_action_when");
- }
- }
+has perform_action_when => (
+ is => 'rw',
+ coerce => sub { defined $_[0] ? lc $_[0] : $_[0] },
+ isa => sub {
+ throw("Invalid argument '$_[0]' to perform_action_when")
+ if defined $_[0] and $_[0] !~ m/^(before|after)$/i;
+ },
+);
- return $self->{'perform_action_when'};
-}
+around perform_action_when => \&ex2err;
-# ----------------------------------------------------------------------
sub database_event {
=pod
=head2 database_event
-Gets or sets the event that triggers the trigger.
-
- my $ok = $trigger->database_event('insert');
+Obsolete please use database_events!
=cut
my $self = shift;
- if ( my $arg = shift ) {
- $arg = lc $arg;
- $arg =~ s/\s+/ /g;
- if ( $arg =~ /^(insert|update|update_on|delete)$/ ) {
- $self->{'database_event'} = $arg;
- }
- else {
- return
- $self->error("Invalid argument '$arg' to database_event");
+ return $self->database_events( @_ );
+}
+
+=head2 database_events
+
+Gets or sets the events that triggers the trigger.
+
+ my $ok = $trigger->database_events('insert');
+
+=cut
+
+has database_events => (
+ is => 'rw',
+ coerce => sub { [ map { lc } ref $_[0] eq 'ARRAY' ? @{$_[0]} : ($_[0]) ] },
+ isa => sub {
+ my @args = @{$_[0]};
+ my %valid = map { $_, 1 } qw[ insert update update_on delete ];
+ my @invalid = grep { !defined $valid{ $_ } } @args;
+
+ if ( @invalid ) {
+ throw(
+ sprintf("Invalid events '%s' in database_events",
+ join(', ', @invalid)
+ )
+ );
}
- }
+ },
+);
- return $self->{'database_event'};
-}
+around database_events => sub {
+ my ($orig,$self) = (shift, shift);
-# ----------------------------------------------------------------------
-sub fields {
+ if (@_) {
+ ex2err($orig, $self, ref $_[0] eq 'ARRAY' ? $_[0] : \@_)
+ or return;
+ }
-=pod
+ return wantarray
+ ? @{ $self->$orig || [] }
+ : $self->$orig;
+};
=head2 fields
=cut
- my $self = shift;
+has fields => (
+ is => 'rw',
+ coerce => sub {
+ my @fields = uniq @{parse_list_arg($_[0])};
+ @fields ? \@fields : undef;
+ },
+);
+
+around fields => sub {
+ my $orig = shift;
+ my $self = shift;
my $fields = parse_list_arg( @_ );
+ $self->$orig($fields) if @$fields;
- if ( @$fields ) {
- my ( %unique, @unique );
- for my $f ( @$fields ) {
- next if $unique{ $f };
- $unique{ $f } = 1;
- push @unique, $f;
- }
+ return wantarray ? @{ $self->$orig || [] } : $self->$orig;
+};
- $self->{'fields'} = \@unique;
- }
+=head2 table
- return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'};
-}
+Gets or set the table on which the trigger works, as a L<SQL::Translator::Schema::Table> object.
+ $trigger->table($triggered_table);
+
+=cut
+
+has table => ( is => 'rw', isa => schema_obj('Table'), weak_ref => 1 );
+
+around table => \&ex2err;
-# ----------------------------------------------------------------------
sub on_table {
=pod
=head2 on_table
-Gets or set the table name on which the trigger works.
-
- $trigger->table('foo');
+Gets or set the table name on which the trigger works, as a string.
+ $trigger->on_table('foo');
=cut
- my $self = shift;
- my $arg = shift || '';
- $self->{'on_table'} = $arg if $arg;
- return $self->{'on_table'};
+ my ($self, $arg) = @_;
+ if ( @_ == 2 ) {
+ my $table = $self->schema->get_table($arg);
+ die "Table named $arg doesn't exist"
+ if !$table;
+ $self->table($table);
+ }
+ return $self->table->name;
}
-# ----------------------------------------------------------------------
-sub action {
-
-=pod
-
=head2 action
-Gets or set the actions of the trigger.
+Gets or set the action of the trigger.
- $trigger->actions(
+ $trigger->action(
q[
BEGIN
select ...;
=cut
- my $self = shift;
- my $arg = shift || '';
- $self->{'action'} = $arg if $arg;
- return $self->{'action'};
-}
+has action => ( is => 'rw', default => sub { '' } );
-# ----------------------------------------------------------------------
sub is_valid {
=pod
my $self = shift;
- for my $attr (
- qw[ name perform_action_when database_event on_table action ]
+ for my $attr (
+ qw[ name perform_action_when database_events on_table action ]
) {
- return $self->error("No $attr") unless $self->$attr();
+ return $self->error("Invalid: missing '$attr'") unless $self->$attr();
}
-
- return $self->error("Missing fields for UPDATE ON") if
+
+ return $self->error("Missing fields for UPDATE ON") if
$self->database_event eq 'update_on' && !$self->fields;
return 1;
}
-# ----------------------------------------------------------------------
-sub name {
-
-=pod
-
=head2 name
Get or set the trigger's name.
=cut
- my $self = shift;
- $self->{'name'} = shift if @_;
- return $self->{'name'} || '';
-}
-
-# ----------------------------------------------------------------------
-sub order {
-
-=pod
+has name => ( is => 'rw', default => sub { '' } );
=head2 order
=cut
- my ( $self, $arg ) = @_;
+has order => ( is => 'rw', default => sub { 0 } );
+
+around order => sub {
+ my ( $orig, $self, $arg ) = @_;
if ( defined $arg && $arg =~ /^\d+$/ ) {
- $self->{'order'} = $arg;
+ return $self->$orig($arg);
}
- return $self->{'order'} || 0;
-}
+ return $self->$orig;
+};
-# ----------------------------------------------------------------------
-sub schema {
+=head2 scope
+
+Get or set the trigger's scope (row or statement).
+
+ my $scope = $trigger->scope('statement');
+
+=cut
+
+has scope => (
+ is => 'rw',
+ isa => sub {
+ my ($arg) = @_;
+ throw( "Invalid scope '$arg'" )
+ if defined $arg and $arg !~ /^(row|statement)$/i;
+ },
+);
+
+around scope => \&ex2err;
-=pod
=head2 schema
=cut
- my $self = shift;
- if ( my $arg = shift ) {
- return $self->error('Not a schema object') unless
- UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
- $self->{'schema'} = $arg;
+has schema => (is => 'rw', isa => schema_obj('Schema'), weak_ref => 1 );
+
+around schema => \&ex2err;
+
+sub compare_arrays {
+
+=pod
+
+=head2 compare_arrays
+
+Compare two arrays.
+
+=cut
+
+ my ($first, $second) = @_;
+ no warnings; # silence spurious -w undef complaints
+
+ return 0 unless (ref $first eq 'ARRAY' and ref $second eq 'ARRAY' ) ;
+
+ return 0 unless @$first == @$second;
+
+ my @first = sort @$first;
+
+ my @second = sort @$second;
+
+ for (my $i = 0; $i < scalar @first; $i++) {
+ return 0 if @first[$i] ne @second[$i];
}
- return $self->{'schema'};
+ return 1;
}
-# ----------------------------------------------------------------------
-sub DESTROY {
- my $self = shift;
- undef $self->{'schema'}; # destroy cyclical reference
-}
+=head2 equals
-1;
+Determines if this trigger is the same as another
+
+ my $is_identical = $trigger1->equals( $trigger2 );
+
+=cut
+
+around equals => sub {
+ my $orig = shift;
+ my $self = shift;
+ my $other = shift;
+ my $case_insensitive = shift;
+
+ return 0 unless $self->$orig($other);
-# ----------------------------------------------------------------------
+ my %names;
+ for my $name ( $self->name, $other->name ) {
+ $name = lc $name if $case_insensitive;
+ $names{ $name }++;
+ }
+
+ if ( keys %names > 1 ) {
+ return $self->error('Names not equal');
+ }
+
+ if ( !$self->perform_action_when eq $other->perform_action_when ) {
+ return $self->error('perform_action_when differs');
+ }
+
+ if (
+ !compare_arrays( [$self->database_events], [$other->database_events] )
+ ) {
+ return $self->error('database_events differ');
+ }
+
+ if ( $self->on_table ne $other->on_table ) {
+ return $self->error('on_table differs');
+ }
+
+ if ( $self->action ne $other->action ) {
+ return $self->error('action differs');
+ }
+
+ if (
+ !$self->_compare_objects( scalar $self->extra, scalar $other->extra )
+ ) {
+ return $self->error('extras differ');
+ }
+
+ return 1;
+};
+
+# Must come after all 'has' declarations
+around new => \&ex2err;
+
+1;
=pod
-=head1 AUTHOR
+=head1 AUTHORS
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
+Anonymous,
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
=cut