Upped version numbers, cleaned up code, fixed my name.
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Schema.pm
index 478feb2..c53789f 100644 (file)
@@ -1,9 +1,7 @@
 package SQL::Translator::Schema;
 
 # ----------------------------------------------------------------------
-# $Id: Schema.pm,v 1.21 2004-11-27 16:32:16 schiffbruechige Exp $
-# ----------------------------------------------------------------------
-# Copyright (C) 2002-4 SQLFairy Authors
+# Copyright (C) 2002-2009 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
@@ -29,9 +27,13 @@ SQL::Translator::Schema - SQL::Translator schema object
 =head1 SYNOPSIS
 
   use SQL::Translator::Schema;
-  my $schema = SQL::Translator::Schema->new;
-  my $table  = $schema->add_table( name => 'foo' );
-  my $view   = $schema->add_view( name => 'bar', sql => '...' );
+  my $schema   =  SQL::Translator::Schema->new(
+      name     => 'Foo',
+      database => 'MySQL',
+  );
+  my $table    = $schema->add_table( name => 'foo' );
+  my $view     = $schema->add_view( name => 'bar', sql => '...' );
+
 
 =head1 DESCSIPTION
 
@@ -48,34 +50,79 @@ use SQL::Translator::Schema::Procedure;
 use SQL::Translator::Schema::Table;
 use SQL::Translator::Schema::Trigger;
 use SQL::Translator::Schema::View;
-use SQL::Translator::Schema::Graph;
+
 use SQL::Translator::Utils 'parse_list_arg';
 
 use base 'SQL::Translator::Schema::Object';
-use vars qw[ $VERSION $TABLE_ORDER $VIEW_ORDER $TRIGGER_ORDER $PROC_ORDER ];
+use vars qw[ $VERSION ];
 
-$VERSION = sprintf "%d.%02d", q$Revision: 1.21 $ =~ /(\d+)\.(\d+)/;
+$VERSION = '1.60';
 
-# ----------------------------------------------------------------------
+__PACKAGE__->_attributes(qw/name database translator/);
+
+sub new {
+  my $class = shift;
+  my $self = $class->SUPER::new (@_)
+    or return;
+
+  $self->{_order} = { map { $_ => 0 } qw/
+    table
+    view
+    trigger
+    proc
+  /};
 
-__PACKAGE__->_attributes( qw/name database translator/ );
+  return $self;
+}
+
+# ----------------------------------------------------------------------
+sub as_graph {
 
 =pod
 
-=head2 new
+=head2 as_graph
 
-Object constructor.
+Returns the schema as an L<SQL::Translator::Schema::Graph> object.
 
-  my $schema   =  SQL::Translator::Schema->new(
-      name     => 'Foo',
-      database => 'MySQL',
-  );
+=cut
+    require  SQL::Translator::Schema::Graph;
+
+    my $self = shift;
+
+    return SQL::Translator::Schema::Graph->new(
+        translator => $self->translator );
+}
+
+# ----------------------------------------------------------------------
+sub as_graph_pm {
+
+=pod
+
+=head2 as_graph_pm
+
+Returns a Graph::Directed object with the table names for nodes.
 
 =cut
 
-sub as_graph {
-  my($self) = @_;
-  return SQL::Translator::Schema::Graph->new(translator => $self->translator);
+    require Graph::Directed;
+
+    my $self = shift;
+    my $g    = Graph::Directed->new;
+    
+    for my $table ( $self->get_tables ) { 
+        my $tname  = $table->name;
+        $g->add_vertex( $tname );
+    
+        for my $field ( $table->get_fields ) {
+            if ( $field->is_foreign_key ) {
+                my $fktable = $field->foreign_key_reference->reference_table;
+
+                $g->add_edge( $fktable, $tname );
+            }
+        }
+    }
+
+    return $g;
 }
 
 # ----------------------------------------------------------------------
@@ -102,24 +149,25 @@ not be created.
 
     if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
         $table = shift;
-        $table->schema( $self );
+        $table->schema($self);
     }
     else {
-        my %args = @_;
+        my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
         $args{'schema'} = $self;
-        $table = $table_class->new( \%args ) or return 
-            $self->error( $table_class->error );
+        $table = $table_class->new( \%args )
+          or return $self->error( $table_class->error );
     }
 
-    $table->order( ++$TABLE_ORDER );
+    $table->order( ++$self->{_order}{table} );
+
     # We know we have a name as the Table->new above errors if none given.
     my $table_name = $table->name;
 
-    if ( defined $self->{'tables'}{ $table_name } ) {
+    if ( defined $self->{'tables'}{$table_name} ) {
         return $self->error(qq[Can't create table: "$table_name" exists]);
     }
     else {
-        $self->{'tables'}{ $table_name } = $table;
+        $self->{'tables'}{$table_name} = $table;
     }
 
     return $table;
@@ -142,8 +190,8 @@ can be set to 1 to also drop all triggers on the table, default is 0.
 
 =cut
 
-    my $self         = shift;
-    my $table_class  = 'SQL::Translator::Schema::Table';
+    my $self        = shift;
+    my $table_class = 'SQL::Translator::Schema::Table';
     my $table_name;
 
     if ( UNIVERSAL::isa( $_[0], $table_class ) ) {
@@ -152,20 +200,20 @@ can be set to 1 to also drop all triggers on the table, default is 0.
     else {
         $table_name = shift;
     }
-    my %args = @_;
+    my %args    = @_;
     my $cascade = $args{'cascade'};
 
-    if ( ! exists $self->{'tables'}{ $table_name } ) {
+    if ( !exists $self->{'tables'}{$table_name} ) {
         return $self->error(qq[Can't drop table: $table_name" doesn't exist]);
     }
 
-    my $table = delete $self->{'tables'}{ $table_name };
+    my $table = delete $self->{'tables'}{$table_name};
+
+    if ($cascade) {
 
-    if ( $cascade ) {
         # Drop all triggers on this table
-        $self->drop_trigger() for (grep { $_->on_table eq $table_name }
-                                   @{ $self->{'triggers'}}
-                                  );
+        $self->drop_trigger()
+          for ( grep { $_->on_table eq $table_name } @{ $self->{'triggers'} } );
     }
     return $table;
 }
@@ -194,31 +242,31 @@ procedure will not be created.
 
     if ( UNIVERSAL::isa( $_[0], $procedure_class ) ) {
         $procedure = shift;
-        $procedure->schema( $self );
+        $procedure->schema($self);
     }
     else {
-        my %args = @_;
+        my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
         $args{'schema'} = $self;
         return $self->error('No procedure name') unless $args{'name'};
-        $procedure = $procedure_class->new( \%args ) or 
-            return $self->error( $procedure_class->error );
+        $procedure = $procedure_class->new( \%args )
+          or return $self->error( $procedure_class->error );
     }
 
-    $procedure->order( ++$PROC_ORDER );
-    my $procedure_name = $procedure->name or return 
-        $self->error('No procedure name');
+    $procedure->order( ++$self->{_order}{proc} );
+    my $procedure_name = $procedure->name
+      or return $self->error('No procedure name');
 
-    if ( defined $self->{'procedures'}{ $procedure_name } ) { 
+    if ( defined $self->{'procedures'}{$procedure_name} ) {
         return $self->error(
-            qq[Can't create procedure: "$procedure_name" exists]
-        );
+            qq[Can't create procedure: "$procedure_name" exists] );
     }
     else {
-        $self->{'procedures'}{ $procedure_name } = $procedure;
+        $self->{'procedures'}{$procedure_name} = $procedure;
     }
 
     return $procedure;
 }
+
 # ----------------------------------------------------------------------
 sub drop_procedure {
 
@@ -235,8 +283,8 @@ object.
 
 =cut
 
-    my $self         = shift;
-    my $proc_class  = 'SQL::Translator::Schema::Procedure';
+    my $self       = shift;
+    my $proc_class = 'SQL::Translator::Schema::Procedure';
     my $proc_name;
 
     if ( UNIVERSAL::isa( $_[0], $proc_class ) ) {
@@ -246,11 +294,12 @@ object.
         $proc_name = shift;
     }
 
-    if ( ! exists $self->{'procedures'}{ $proc_name } ) {
-        return $self->error(qq[Can't drop procedure: $proc_name" doesn't exist]);
+    if ( !exists $self->{'procedures'}{$proc_name} ) {
+        return $self->error(
+            qq[Can't drop procedure: $proc_name" doesn't exist]);
     }
 
-    my $proc = delete $self->{'procedures'}{ $proc_name };
+    my $proc = delete $self->{'procedures'}{$proc_name};
 
     return $proc;
 }
@@ -279,28 +328,29 @@ not be created.
 
     if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
         $trigger = shift;
-        $trigger->schema( $self );
+        $trigger->schema($self);
     }
     else {
-        my %args = @_;
+        my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
         $args{'schema'} = $self;
         return $self->error('No trigger name') unless $args{'name'};
-        $trigger = $trigger_class->new( \%args ) or 
-            return $self->error( $trigger_class->error );
+        $trigger = $trigger_class->new( \%args )
+          or return $self->error( $trigger_class->error );
     }
 
-    $trigger->order( ++$TRIGGER_ORDER );
-    my $trigger_name = $trigger->name or return $self->error('No trigger name');
+    $trigger->order( ++$self->{_order}{trigger} );
 
-    if ( defined $self->{'triggers'}{ $trigger_name } ) { 
+    my $trigger_name = $trigger->name or return $self->error('No trigger name');
+    if ( defined $self->{'triggers'}{$trigger_name} ) {
         return $self->error(qq[Can't create trigger: "$trigger_name" exists]);
     }
     else {
-        $self->{'triggers'}{ $trigger_name } = $trigger;
+        $self->{'triggers'}{$trigger_name} = $trigger;
     }
 
     return $trigger;
 }
+
 # ----------------------------------------------------------------------
 sub drop_trigger {
 
@@ -316,8 +366,8 @@ trigger name or an C<SQL::Translator::Schema::Trigger> object.
 
 =cut
 
-    my $self         = shift;
-    my $trigger_class  = 'SQL::Translator::Schema::Trigger';
+    my $self          = shift;
+    my $trigger_class = 'SQL::Translator::Schema::Trigger';
     my $trigger_name;
 
     if ( UNIVERSAL::isa( $_[0], $trigger_class ) ) {
@@ -327,11 +377,12 @@ trigger name or an C<SQL::Translator::Schema::Trigger> object.
         $trigger_name = shift;
     }
 
-    if ( ! exists $self->{'triggers'}{ $trigger_name } ) {
-        return $self->error(qq[Can't drop trigger: $trigger_name" doesn't exist]);
+    if ( !exists $self->{'triggers'}{$trigger_name} ) {
+        return $self->error(
+            qq[Can't drop trigger: $trigger_name" doesn't exist]);
     }
 
-    my $trigger = delete $self->{'triggers'}{ $trigger_name };
+    my $trigger = delete $self->{'triggers'}{$trigger_name};
 
     return $trigger;
 }
@@ -354,29 +405,29 @@ not be created.
 
 =cut
 
-    my $self        = shift;
+    my $self       = shift;
     my $view_class = 'SQL::Translator::Schema::View';
     my $view;
 
     if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
         $view = shift;
-        $view->schema( $self );
+        $view->schema($self);
     }
     else {
-        my %args = @_;
+        my %args = ref $_[0] eq 'HASH' ? %{ $_[0] } : @_;
         $args{'schema'} = $self;
         return $self->error('No view name') unless $args{'name'};
         $view = $view_class->new( \%args ) or return $view_class->error;
     }
 
-    $view->order( ++$VIEW_ORDER );
+    $view->order( ++$self->{_order}{view} );
     my $view_name = $view->name or return $self->error('No view name');
 
-    if ( defined $self->{'views'}{ $view_name } ) { 
+    if ( defined $self->{'views'}{$view_name} ) {
         return $self->error(qq[Can't create view: "$view_name" exists]);
     }
     else {
-        $self->{'views'}{ $view_name } = $view;
+        $self->{'views'}{$view_name} = $view;
     }
 
     return $view;
@@ -397,8 +448,8 @@ name or an C<SQL::Translator::Schema::View> object.
 
 =cut
 
-    my $self         = shift;
-    my $view_class  = 'SQL::Translator::Schema::View';
+    my $self       = shift;
+    my $view_class = 'SQL::Translator::Schema::View';
     my $view_name;
 
     if ( UNIVERSAL::isa( $_[0], $view_class ) ) {
@@ -408,11 +459,11 @@ name or an C<SQL::Translator::Schema::View> object.
         $view_name = shift;
     }
 
-    if ( ! exists $self->{'views'}{ $view_name } ) {
+    if ( !exists $self->{'views'}{$view_name} ) {
         return $self->error(qq[Can't drop view: $view_name" doesn't exist]);
     }
 
-    my $view = delete $self->{'views'}{ $view_name };
+    my $view = delete $self->{'views'}{$view_name};
 
     return $view;
 }
@@ -472,11 +523,11 @@ Returns a procedure by the name provided.
 
 =cut
 
-    my $self       = shift;
+    my $self = shift;
     my $procedure_name = shift or return $self->error('No procedure name');
-    return $self->error( qq[Table "$procedure_name" does not exist] ) unless
-        exists $self->{'procedures'}{ $procedure_name };
-    return $self->{'procedures'}{ $procedure_name };
+    return $self->error(qq[Table "$procedure_name" does not exist])
+      unless exists $self->{'procedures'}{$procedure_name};
+    return $self->{'procedures'}{$procedure_name};
 }
 
 # ----------------------------------------------------------------------
@@ -492,14 +543,13 @@ Returns all the procedures as an array or array reference.
 
 =cut
 
-    my $self   = shift;
-    my @procedures = 
-        map  { $_->[1] } 
-        sort { $a->[0] <=> $b->[0] } 
-        map  { [ $_->order, $_ ] }
-        values %{ $self->{'procedures'} };
+    my $self       = shift;
+    my @procedures =
+      map  { $_->[1] }
+      sort { $a->[0] <=> $b->[0] }
+      map  { [ $_->order, $_ ] } values %{ $self->{'procedures'} };
 
-    if ( @procedures ) {
+    if (@procedures) {
         return wantarray ? @procedures : \@procedures;
     }
     else {
@@ -521,11 +571,19 @@ Returns a table by the name provided.
 
 =cut
 
-    my $self       = shift;
+    my $self = shift;
     my $table_name = shift or return $self->error('No table name');
-    return $self->error( qq[Table "$table_name" does not exist] ) unless
-        exists $self->{'tables'}{ $table_name };
-    return $self->{'tables'}{ $table_name };
+    my $case_insensitive = shift;
+    if ( $case_insensitive ) {
+       $table_name = uc($table_name);
+       foreach my $table ( keys %{$self->{tables}} ) {
+               return $self->{tables}{$table} if $table_name eq uc($table);
+       }
+       return $self->error(qq[Table "$table_name" does not exist]);
+    }
+    return $self->error(qq[Table "$table_name" does not exist])
+      unless exists $self->{'tables'}{$table_name};
+    return $self->{'tables'}{$table_name};
 }
 
 # ----------------------------------------------------------------------
@@ -542,13 +600,12 @@ Returns all the tables as an array or array reference.
 =cut
 
     my $self   = shift;
-    my @tables = 
-        map  { $_->[1] } 
-        sort { $a->[0] <=> $b->[0] } 
-        map  { [ $_->order, $_ ] }
-        values %{ $self->{'tables'} };
+    my @tables =
+      map  { $_->[1] }
+      sort { $a->[0] <=> $b->[0] }
+      map  { [ $_->order, $_ ] } values %{ $self->{'tables'} };
 
-    if ( @tables ) {
+    if (@tables) {
         return wantarray ? @tables : \@tables;
     }
     else {
@@ -570,11 +627,11 @@ Returns a trigger by the name provided.
 
 =cut
 
-    my $self       = shift;
+    my $self = shift;
     my $trigger_name = shift or return $self->error('No trigger name');
-    return $self->error( qq[Table "$trigger_name" does not exist] ) unless
-        exists $self->{'triggers'}{ $trigger_name };
-    return $self->{'triggers'}{ $trigger_name };
+    return $self->error(qq[Table "$trigger_name" does not exist])
+      unless exists $self->{'triggers'}{$trigger_name};
+    return $self->{'triggers'}{$trigger_name};
 }
 
 # ----------------------------------------------------------------------
@@ -590,14 +647,13 @@ Returns all the triggers as an array or array reference.
 
 =cut
 
-    my $self   = shift;
-    my @triggers = 
-        map  { $_->[1] } 
-        sort { $a->[0] <=> $b->[0] } 
-        map  { [ $_->order, $_ ] }
-        values %{ $self->{'triggers'} };
+    my $self     = shift;
+    my @triggers =
+      map  { $_->[1] }
+      sort { $a->[0] <=> $b->[0] }
+      map  { [ $_->order, $_ ] } values %{ $self->{'triggers'} };
 
-    if ( @triggers ) {
+    if (@triggers) {
         return wantarray ? @triggers : \@triggers;
     }
     else {
@@ -619,11 +675,11 @@ Returns a view by the name provided.
 
 =cut
 
-    my $self      = shift;
+    my $self = shift;
     my $view_name = shift or return $self->error('No view name');
-    return $self->error('View "$view_name" does not exist') unless
-        exists $self->{'views'}{ $view_name };
-    return $self->{'views'}{ $view_name };
+    return $self->error('View "$view_name" does not exist')
+      unless exists $self->{'views'}{$view_name};
+    return $self->{'views'}{$view_name};
 }
 
 # ----------------------------------------------------------------------
@@ -640,13 +696,12 @@ Returns all the views as an array or array reference.
 =cut
 
     my $self  = shift;
-    my @views = 
-        map  { $_->[1] } 
-        sort { $a->[0] <=> $b->[0] } 
-        map  { [ $_->order, $_ ] }
-        values %{ $self->{'views'} };
+    my @views =
+      map  { $_->[1] }
+      sort { $a->[0] <=> $b->[0] }
+      map  { [ $_->order, $_ ] } values %{ $self->{'views'} };
 
-    if ( @views ) {
+    if (@views) {
         return wantarray ? @views : \@views;
     }
     else {
@@ -676,7 +731,7 @@ the joins from primary keys to fields of the same name in other tables
 
 A list of fields to skip in the joins
 
-=back 4
+=back
 
   $schema->make_natural_joins(
       join_pk_only => 1,
@@ -688,31 +743,30 @@ A list of fields to skip in the joins
     my $self         = shift;
     my %args         = @_;
     my $join_pk_only = $args{'join_pk_only'} || 0;
-    my %skip_fields  = map { s/^\s+|\s+$//g; $_, 1 } @{ 
-        parse_list_arg( $args{'skip_fields'} ) 
-    };
+    my %skip_fields  =
+      map { s/^\s+|\s+$//g; $_, 1 } @{ parse_list_arg( $args{'skip_fields'} ) };
 
     my ( %common_keys, %pk );
     for my $table ( $self->get_tables ) {
         for my $field ( $table->get_fields ) {
             my $field_name = $field->name or next;
-            next if $skip_fields{ $field_name };
-            $pk{ $field_name } = 1 if $field->is_primary_key;
-            push @{ $common_keys{ $field_name } }, $table->name;
+            next if $skip_fields{$field_name};
+            $pk{$field_name} = 1 if $field->is_primary_key;
+            push @{ $common_keys{$field_name} }, $table->name;
         }
-    } 
-   
+    }
+
     for my $field ( keys %common_keys ) {
-        next if $join_pk_only and !defined $pk{ $field };
+        next if $join_pk_only and !defined $pk{$field};
 
-        my @table_names = @{ $common_keys{ $field } };
+        my @table_names = @{ $common_keys{$field} };
         next unless scalar @table_names > 1;
 
         for my $i ( 0 .. $#table_names ) {
-            my $table1 = $self->get_table( $table_names[ $i ] ) or next;
+            my $table1 = $self->get_table( $table_names[$i] ) or next;
 
             for my $j ( 1 .. $#table_names ) {
-                my $table2 = $self->get_table( $table_names[ $j ] ) or next;
+                my $table2 = $self->get_table( $table_names[$j] ) or next;
                 next if $table1->name eq $table2->name;
 
                 $table1->add_constraint(
@@ -746,13 +800,17 @@ Get or set the schema's name.  (optional)
     return $self->{'name'} || '';
 }
 
+# ----------------------------------------------------------------------
+sub translator {
+
+=pod
+
 =head2 translator
 
-get the SQL::Translator instance that instatiated me
+Get the SQL::Translator instance that instantiated the parser.
 
 =cut
 
-sub translator {
     my $self = shift;
     $self->{'translator'} = shift if @_;
     return $self->{'translator'};
@@ -762,7 +820,7 @@ sub translator {
 sub DESTROY {
     my $self = shift;
     undef $_ for values %{ $self->{'tables'} };
-    undef $_ for values %{ $self->{'views'}  };
+    undef $_ for values %{ $self->{'views'} };
 }
 
 1;
@@ -773,6 +831,7 @@ sub DESTROY {
 
 =head1 AUTHOR
 
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
 
 =cut
+