lib/SQL/Translator/Schema/View.pm

   1 package SQL::Translator::Schema::View;
   2
   3 =pod
   4
   5 =head1 NAME
   6
   7 SQL::Translator::Schema::View - SQL::Translator view object
   8
   9 =head1 SYNOPSIS
  10
  11   use SQL::Translator::Schema::View;
  12   my $view   = SQL::Translator::Schema::View->new(
  13       name   => 'foo',                      # name, required
  14       sql    => 'select id, name from foo', # SQL for view
  15       fields => 'id, name',                 # field names in view
  16   );
  17
  18 =head1 DESCRIPTION
  19
  20 C<SQL::Translator::Schema::View> is the view object.
  21
  22 =head1 METHODS
  23
  24 =cut
  25
  26 use strict;
  27 use warnings;
  28 use SQL::Translator::Utils 'parse_list_arg';
  29
  30 use base 'SQL::Translator::Schema::Object';
  31
  32 our ( $TABLE_COUNT, $VIEW_COUNT );
  33
  34 our $VERSION = '1.59';
  35
  36 __PACKAGE__->_attributes( qw/
  37     name sql fields schema order tables options
  38 /);
  39
  40 =pod
  41
  42 =head2 new
  43
  44 Object constructor.
  45
  46   my $view = SQL::Translator::Schema::View->new;
  47
  48 =cut
  49
  50 sub fields {
  51
  52 =pod
  53
  54 =head2 fields
  55
  56 Gets and set the fields the constraint is on.  Accepts a string, list or
  57 arrayref; returns an array or array reference.  Will unique the field
  58 names and keep them in order by the first occurrence of a field name.
  59
  60   $view->fields('id');
  61   $view->fields('id', 'name');
  62   $view->fields( 'id, name' );
  63   $view->fields( [ 'id', 'name' ] );
  64   $view->fields( qw[ id name ] );
  65
  66   my @fields = $view->fields;
  67
  68 =cut
  69
  70     my $self   = shift;
  71     my $fields = parse_list_arg( @_ );
  72
  73     if ( @$fields ) {
  74         my ( %unique, @unique );
  75         for my $f ( @$fields ) {
  76             next if $unique{ $f }++;
  77             push @unique, $f;
  78         }
  79
  80         $self->{'fields'} = \@unique;
  81     }
  82
  83     my @flds = @{ $self->{'fields'} || [] };
  84
  85     return wantarray ? @flds : \@flds;
  86 }
  87
  88 sub tables {
  89
  90 =pod
  91
  92 =head2 tables
  93
  94 Gets and set the tables the SELECT mentions.  Accepts a string, list or
  95 arrayref; returns an array or array reference.  Will unique the table
  96 names and keep them in order by the first occurrence of a field name.
  97
  98   $view->tables('foo');
  99   $view->tables('foo', 'bar');
 100   $view->tables( 'foo, bar' );
 101   $view->tables( [ 'foo', 'bar' ] );
 102   $view->tables( qw[ foo bar ] );
 103
 104   my @tables = $view->tables;
 105
 106 =cut
 107
 108     my $self   = shift;
 109     my $tables = parse_list_arg( @_ );
 110
 111     if ( @$tables ) {
 112         my ( %unique, @unique );
 113         for my $t ( @$tables ) {
 114             next if $unique{ $t }++;
 115             push @unique, $t;
 116         }
 117
 118         $self->{'tables'} = \@unique;
 119     }
 120
 121     my @tbls = @{ $self->{'tables'} || [] };
 122
 123     return wantarray ? @tbls : \@tbls;
 124 }
 125
 126 sub options {
 127
 128 =pod
 129
 130 =head2 options
 131
 132 Gets and sets a list of options on the view.
 133
 134   $view->options('ALGORITHM=UNDEFINED');
 135
 136   my @options = $view->options;
 137
 138 =cut
 139
 140     my $self    = shift;
 141     my $options = parse_list_arg( @_ );
 142
 143     if ( @$options ) {
 144         my ( %unique, @unique );
 145         for my $o ( @$options, @{ $self->{'options'} || [] } ) {
 146             next if $unique{ $o }++;
 147             push @unique, $o;
 148         }
 149
 150         $self->{'options'} = \@unique;
 151     }
 152
 153     my @opts = @{ $self->{'options'} || [] };
 154
 155     return wantarray ? @opts : \@opts;
 156 }
 157
 158 sub is_valid {
 159
 160 =pod
 161
 162 =head2 is_valid
 163
 164 Determine whether the view is valid or not.
 165
 166   my $ok = $view->is_valid;
 167
 168 =cut
 169
 170     my $self = shift;
 171
 172     return $self->error('No name') unless $self->name;
 173     return $self->error('No sql')  unless $self->sql;
 174
 175     return 1;
 176 }
 177
 178 sub name {
 179
 180 =pod
 181
 182 =head2 name
 183
 184 Get or set the view's name.
 185
 186   my $name = $view->name('foo');
 187
 188 =cut
 189
 190     my $self        = shift;
 191     $self->{'name'} = shift if @_;
 192     return $self->{'name'} || '';
 193 }
 194
 195 sub order {
 196
 197 =pod
 198
 199 =head2 order
 200
 201 Get or set the view's order.
 202
 203   my $order = $view->order(3);
 204
 205 =cut
 206
 207     my ( $self, $arg ) = @_;
 208
 209     if ( defined $arg && $arg =~ /^\d+$/ ) {
 210         $self->{'order'} = $arg;
 211     }
 212
 213     return $self->{'order'} || 0;
 214 }
 215
 216 sub sql {
 217
 218 =pod
 219
 220 =head2 sql
 221
 222 Get or set the view's SQL.
 223
 224   my $sql = $view->sql('select * from foo');
 225
 226 =cut
 227
 228     my $self       = shift;
 229     $self->{'sql'} = shift if @_;
 230     return $self->{'sql'} || '';
 231 }
 232
 233 sub schema {
 234
 235 =pod
 236
 237 =head2 schema
 238
 239 Get or set the view's schema object.
 240
 241   $view->schema( $schema );
 242   my $schema = $view->schema;
 243
 244 =cut
 245
 246     my $self = shift;
 247     if ( my $arg = shift ) {
 248         return $self->error('Not a schema object') unless
 249             UNIVERSAL::isa( $arg, 'SQL::Translator::Schema' );
 250         $self->{'schema'} = $arg;
 251     }
 252
 253     return $self->{'schema'};
 254 }
 255
 256 sub equals {
 257
 258 =pod
 259
 260 =head2 equals
 261
 262 Determines if this view is the same as another
 263
 264   my $isIdentical = $view1->equals( $view2 );
 265
 266 =cut
 267
 268     my $self = shift;
 269     my $other = shift;
 270     my $case_insensitive = shift;
 271     my $ignore_sql = shift;
 272
 273     return 0 unless $self->SUPER::equals($other);
 274     return 0 unless $case_insensitive ? uc($self->name) eq uc($other->name) : $self->name eq $other->name;
 275     #return 0 unless $self->is_valid eq $other->is_valid;
 276
 277     unless ($ignore_sql) {
 278         my $selfSql = $self->sql;
 279         my $otherSql = $other->sql;
 280         # Remove comments
 281         $selfSql =~ s/--.*$//mg;
 282         $otherSql =~ s/--.*$//mg;
 283         # Collapse whitespace to space to avoid whitespace comparison issues
 284         $selfSql =~ s/\s+/ /sg;
 285         $otherSql =~ s/\s+/ /sg;
 286         return 0 unless $selfSql eq $otherSql;
 287     }
 288
 289     my $selfFields = join(":", $self->fields);
 290     my $otherFields = join(":", $other->fields);
 291     return 0 unless $case_insensitive ? uc($selfFields) eq uc($otherFields) : $selfFields eq $otherFields;
 292     return 0 unless $self->_compare_objects(scalar $self->extra, scalar $other->extra);
 293     return 1;
 294 }
 295
 296 sub DESTROY {
 297     my $self = shift;
 298     undef $self->{'schema'}; # destroy cyclical reference
 299 }
 300
 301 1;
 302
 303 =pod
 304
 305 =head1 AUTHOR
 306
 307 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
 308
 309 =cut