- Added some stuff to MANIFEST.SKIP
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Schema / View.pm
index 0f9a1bd..7c9d125 100644 (file)
@@ -1,9 +1,9 @@
 package SQL::Translator::Schema::View;
 
 # ----------------------------------------------------------------------
-# $Id: View.pm,v 1.1 2003-05-01 04:25:00 kycl4rk Exp $
+# $Id$
 # ----------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
+# 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
@@ -29,9 +29,10 @@ SQL::Translator::Schema::View - SQL::Translator view object
 =head1 SYNOPSIS
 
   use SQL::Translator::Schema::View;
-  my $view = SQL::Translator::Schema::View->new(
-      name => 'foo',
-      sql  => 'select * from foo',
+  my $view   = SQL::Translator::Schema::View->new(
+      name   => 'foo',                      # name, required
+      sql    => 'select id, name from foo', # SQL for view
+      fields => 'id, name',                 # field names in view
   );
 
 =head1 DESCRIPTION
@@ -43,15 +44,19 @@ C<SQL::Translator::Schema::View> is the view object.
 =cut
 
 use strict;
-use Class::Base;
+use SQL::Translator::Utils 'parse_list_arg';
+
+use base 'SQL::Translator::Schema::Object';
 
-use base 'Class::Base';
 use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
 
-$VERSION = 1.00;
+$VERSION = sprintf "%d.%02d", q$Revision$ =~ /(\d+)\.(\d+)/;
 
 # ----------------------------------------------------------------------
-sub init {
+
+__PACKAGE__->_attributes( qw/
+    name sql fields schema order
+/);
 
 =pod
 
@@ -59,13 +64,67 @@ sub init {
 
 Object constructor.
 
-  my $schema = SQL::Translator::Schema::View->new;
+  my $view = SQL::Translator::Schema::View->new;
+
+=cut
+
+# ----------------------------------------------------------------------
+sub fields {
+
+=pod
+
+=head2 fields
+
+Gets and set the fields the constraint is on.  Accepts a string, list or
+arrayref; returns an array or array reference.  Will unique the field
+names and keep them in order by the first occurrence of a field name.
+
+  $view->fields('id');
+  $view->fields('id', 'name');
+  $view->fields( 'id, name' );
+  $view->fields( [ 'id', 'name' ] );
+  $view->fields( qw[ id name ] );
+
+  my @fields = $view->fields;
+
+=cut
+
+    my $self   = shift;
+    my $fields = parse_list_arg( @_ );
+
+    if ( @$fields ) {
+        my ( %unique, @unique );
+        for my $f ( @$fields ) {
+            next if $unique{ $f };
+            $unique{ $f } = 1;
+            push @unique, $f;
+        }
+
+        $self->{'fields'} = \@unique;
+    }
+
+    return wantarray ? @{ $self->{'fields'} || [] } : ($self->{'fields'} || '');
+}
+
+# ----------------------------------------------------------------------
+sub is_valid {
+
+=pod
+
+=head2 is_valid
+
+Determine whether the view is valid or not.
+
+  my $ok = $view->is_valid;
 
 =cut
 
-    my ( $self, $config ) = @_;
-    $self->params( $config, qw[ name sql ] );
-    return $self;
+    my $self = shift;
+
+    return $self->error('No name') unless $self->name;
+    return $self->error('No sql')  unless $self->sql;
+
+    return 1;
 }
 
 # ----------------------------------------------------------------------
@@ -87,6 +146,28 @@ Get or set the view's name.
 }
 
 # ----------------------------------------------------------------------
+sub order {
+
+=pod
+
+=head2 order
+
+Get or set the view's order.
+
+  my $order = $view->order(3);
+
+=cut
+
+    my ( $self, $arg ) = @_;
+
+    if ( defined $arg && $arg =~ /^\d+$/ ) {
+        $self->{'order'} = $arg;
+    }
+
+    return $self->{'order'} || 0;
+}
+
+# ----------------------------------------------------------------------
 sub sql {
 
 =pod
@@ -105,20 +186,74 @@ Get or set the view's SQL.
 }
 
 # ----------------------------------------------------------------------
-sub is_valid {
+sub schema {
 
 =pod
 
-=head2 is_valid
+=head2 schema
 
-Determine whether the view is valid or not.
+Get or set the view's schema object.
 
-  my $ok = $view->is_valid;
+  $view->schema( $schema );
+  my $schema = $view->schema;
 
 =cut
 
     my $self = shift;
-    return 1 if $self->name && $self->sql;
+    if ( my $arg = shift ) {
+        return $self->error('Not a schema object') unless
+            UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
+        $self->{'schema'} = $arg;
+    }
+
+    return $self->{'schema'};
+}
+
+# ----------------------------------------------------------------------
+sub equals {
+
+=pod
+
+=head2 equals
+
+Determines if this view is the same as another
+
+  my $isIdentical = $view1->equals( $view2 );
+
+=cut
+
+    my $self = shift;
+    my $other = shift;
+    my $case_insensitive = shift;
+    my $ignore_sql = shift;
+    
+    return 0 unless $self->SUPER::equals($other);
+    return 0 unless $case_insensitive ? uc($self->name) eq uc($other->name) : $self->name eq $other->name;
+    #return 0 unless $self->is_valid eq $other->is_valid;
+    
+    unless ($ignore_sql) {
+        my $selfSql = $self->sql;
+        my $otherSql = $other->sql;
+        # Remove comments
+        $selfSql =~ s/--.*$//mg;
+        $otherSql =~ s/--.*$//mg;
+        # Collapse whitespace to space to avoid whitespace comparison issues
+        $selfSql =~ s/\s+/ /sg;
+        $otherSql =~ s/\s+/ /sg;
+        return 0 unless $selfSql eq $otherSql;
+    }
+    
+    my $selfFields = join(":", $self->fields);
+    my $otherFields = join(":", $other->fields);
+    return 0 unless $case_insensitive ? uc($selfFields) eq uc($otherFields) : $selfFields eq $otherFields;
+    return 0 unless $self->_compare_objects(scalar $self->extra, scalar $other->extra);
+    return 1;
+}
+
+# ----------------------------------------------------------------------
+sub DESTROY {
+    my $self = shift;
+    undef $self->{'schema'}; # destroy cyclical reference
 }
 
 1;
@@ -129,6 +264,6 @@ Determine whether the view is valid or not.
 
 =head1 AUTHOR
 
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 
 =cut