Clean up option parsing and identifier quoting in Producer::PostgreSQL
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Schema / View.pm
index 0f9a1bd..c5b9920 100644 (file)
@@ -1,25 +1,5 @@
 package SQL::Translator::Schema::View;
 
-# ----------------------------------------------------------------------
-# $Id: View.pm,v 1.1 2003-05-01 04:25:00 kycl4rk Exp $
-# ----------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
-#
-# 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
@@ -29,9 +9,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
@@ -42,37 +23,90 @@ C<SQL::Translator::Schema::View> is the view object.
 
 =cut
 
-use strict;
-use Class::Base;
-
-use base 'Class::Base';
-use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
+use Moo;
+use SQL::Translator::Utils qw(ex2err);
+use SQL::Translator::Types qw(schema_obj);
+use SQL::Translator::Role::ListAttr;
+use Sub::Quote qw(quote_sub);
 
-$VERSION = 1.00;
+extends 'SQL::Translator::Schema::Object';
 
-# ----------------------------------------------------------------------
-sub init {
-
-=pod
+our $VERSION = '1.59';
 
 =head2 new
 
 Object constructor.
 
-  my $schema = SQL::Translator::Schema::View->new;
+  my $view = SQL::Translator::Schema::View->new;
+
+=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, $config ) = @_;
-    $self->params( $config, qw[ name sql ] );
-    return $self;
-}
+with ListAttr fields => ( uniq => 1 );
+
+=head2 tables
+
+Gets and set the tables the SELECT mentions.  Accepts a string, list or
+arrayref; returns an array or array reference.  Will unique the table
+names and keep them in order by the first occurrence of a field name.
+
+  $view->tables('foo');
+  $view->tables('foo', 'bar');
+  $view->tables( 'foo, bar' );
+  $view->tables( [ 'foo', 'bar' ] );
+  $view->tables( qw[ foo bar ] );
+
+  my @tables = $view->tables;
+
+=cut
 
-# ----------------------------------------------------------------------
-sub name {
+with ListAttr tables => ( uniq => 1 );
+
+=head2 options
+
+Gets or appends a list of options on the view.
+
+  $view->options('ALGORITHM=UNDEFINED');
+
+  my @options = $view->options;
+
+=cut
+
+with ListAttr options => ( uniq => 1, append => 1 );
+
+sub is_valid {
 
 =pod
 
+=head2 is_valid
+
+Determine whether the view is valid or not.
+
+  my $ok = $view->is_valid;
+
+=cut
+
+    my $self = shift;
+
+    return $self->error('No name') unless $self->name;
+    return $self->error('No sql')  unless $self->sql;
+
+    return 1;
+}
+
 =head2 name
 
 Get or set the view's name.
@@ -81,15 +115,27 @@ Get or set the view's name.
 
 =cut
 
-    my $self        = shift;
-    $self->{'name'} = shift if @_;
-    return $self->{'name'} || '';
-}
+has name => ( is => 'rw', default => quote_sub(q{ '' }) );
 
-# ----------------------------------------------------------------------
-sub sql {
+=head2 order
 
-=pod
+Get or set the view's order.
+
+  my $order = $view->order(3);
+
+=cut
+
+has order => ( is => 'rw', default => quote_sub(q{ 0 }) );
+
+around order => sub {
+    my ( $orig, $self, $arg ) = @_;
+
+    if ( defined $arg && $arg =~ /^\d+$/ ) {
+        return $self->$orig($arg);
+    }
+
+    return $self->$orig;
+};
 
 =head2 sql
 
@@ -99,36 +145,68 @@ Get or set the view's SQL.
 
 =cut
 
-    my $self       = shift;
-    $self->{'sql'} = shift if @_;
-    return $self->{'sql'} || '';
-}
+has sql => ( is => 'rw', default => quote_sub(q{ '' }) );
 
-# ----------------------------------------------------------------------
-sub is_valid {
+=head2 schema
 
-=pod
+Get or set the view's schema object.
 
-=head2 is_valid
+  $view->schema( $schema );
+  my $schema = $view->schema;
 
-Determine whether the view is valid or not.
+=cut
 
-  my $ok = $view->is_valid;
+has schema => ( is => 'rw', isa => schema_obj('Schema'), weak_ref => 1 );
+
+around schema => \&ex2err;
+
+=head2 equals
+
+Determines if this view is the same as another
+
+  my $isIdentical = $view1->equals( $view2 );
 
 =cut
 
+around equals => sub {
+    my $orig = shift;
     my $self = shift;
-    return 1 if $self->name && $self->sql;
-}
+    my $other = shift;
+    my $case_insensitive = shift;
+    my $ignore_sql = shift;
+
+    return 0 unless $self->$orig($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;
+};
+
+# Must come after all 'has' declarations
+around new => \&ex2err;
 
 1;
 
-# ----------------------------------------------------------------------
-
 =pod
 
 =head1 AUTHOR
 
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
 
 =cut