Rename non-schema-specific roles to SQLT::Role::Foo
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Schema / Index.pm
index 2a8593e..22d194d 100644 (file)
@@ -1,23 +1,5 @@
 package SQL::Translator::Schema::Index;
 
-# ----------------------------------------------------------------------
-# 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
-# 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
@@ -43,15 +25,20 @@ Primary and unique keys are table constraints, not indices.
 
 =cut
 
-use strict;
+use Moo;
 use SQL::Translator::Schema::Constants;
-use SQL::Translator::Utils 'parse_list_arg';
-
-use base 'SQL::Translator::Schema::Object';
-
-use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
+use SQL::Translator::Utils qw(parse_list_arg ex2err throw);
+use SQL::Translator::Types qw(schema_obj);
+use List::MoreUtils qw(uniq);
+
+with qw(
+  SQL::Translator::Role::Error
+  SQL::Translator::Role::BuildArgs
+  SQL::Translator::Schema::Role::Extra
+  SQL::Translator::Schema::Role::Compare
+);
 
-$VERSION = '1.59';
+our $VERSION = '1.59';
 
 my %VALID_INDEX_TYPE = (
   UNIQUE         => 1,
@@ -61,27 +48,12 @@ my %VALID_INDEX_TYPE = (
   SPATIAL        => 1, # MySQL only (?)
 );
 
-# ----------------------------------------------------------------------
-
-__PACKAGE__->_attributes( qw/
-    name type fields table options
-/);
-
-=pod
-
 =head2 new
 
 Object constructor.
 
   my $schema = SQL::Translator::Schema::Index->new;
 
-=cut
-
-# ----------------------------------------------------------------------
-sub fields {
-
-=pod
-
 =head2 fields
 
 Gets and set the fields the index is on.  Accepts a string, list or
@@ -98,24 +70,21 @@ names and keep them in order by the first occurrence of a field name.
 
 =cut
 
+has fields => (
+    is => 'rw',
+    default => sub { [] },
+    coerce => sub { [uniq @{parse_list_arg($_[0])}] },
+);
+
+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;
-        }
-
-        $self->{'fields'} = \@unique;
-    }
+    return wantarray ? @{ $self->$orig } : $self->$orig;
+};
 
-    return wantarray ? @{ $self->{'fields'} || [] } : $self->{'fields'};
-}
-
-# ----------------------------------------------------------------------
 sub is_valid {
 
 =pod
@@ -141,11 +110,6 @@ Determine whether the index is valid or not.
     return 1;
 }
 
-# ----------------------------------------------------------------------
-sub name {
-
-=pod
-
 =head2 name
 
 Get or set the index's name.
@@ -154,15 +118,7 @@ Get or set the index's name.
 
 =cut
 
-    my $self = shift;
-    $self->{'name'} = shift if @_;
-    return $self->{'name'} || '';
-}
-
-# ----------------------------------------------------------------------
-sub options {
-
-=pod
+has name => ( is => 'rw', coerce => sub { defined $_[0] ? $_[0] : '' }, default => sub { '' } );
 
 =head2 options
 
@@ -173,23 +129,21 @@ an array or array reference.
 
 =cut
 
+has options => (
+    is => 'rw',
+    default => sub { [] },
+    coerce => \&parse_list_arg,
+);
+
+around options => sub {
+    my $orig    = shift;
     my $self    = shift;
     my $options = parse_list_arg( @_ );
 
-    push @{ $self->{'options'} }, @$options;
-
-    if ( ref $self->{'options'} ) {
-        return wantarray ? @{ $self->{'options'} || [] } : $self->{'options'};
-    }
-    else {
-        return wantarray ? () : [];
-    }
-}
-
-# ----------------------------------------------------------------------
-sub table {
+    push @{ $self->$orig }, @$options;
 
-=pod
+    return wantarray ? @{ $self->$orig } : $self->$orig;
+};
 
 =head2 table
 
@@ -199,20 +153,9 @@ Get or set the index's table object.
 
 =cut
 
-    my $self = shift;
-    if ( my $arg = shift ) {
-        return $self->error('Not a table object') unless
-            UNIVERSAL::isa( $arg, 'SQL::Translator::Schema::Table' );
-        $self->{'table'} = $arg;
-    }
+has table => ( is => 'rw', isa => schema_obj('Table'), weak_ref => 1 );
 
-    return $self->{'table'};
-}
-
-# ----------------------------------------------------------------------
-sub type {
-
-=pod
+around table => \&ex2err;
 
 =head2 type
 
@@ -220,7 +163,7 @@ Get or set the index's type.
 
   my $type = $index->type('unique');
 
-Get or set the index's options (e.g., "using" or "where" for PG).  Returns
+Get or set the index's type.
 
 Currently there are only four acceptable types: UNIQUE, NORMAL, FULL_TEXT,
 and SPATIAL. The latter two might be MySQL-specific. While both lowercase
@@ -229,22 +172,17 @@ uppercase.
 
 =cut
 
-    my ( $self, $type ) = @_;
-
-    if ( $type ) {
-        $type = uc $type;
-        return $self->error("Invalid index type: $type")
-            unless $VALID_INDEX_TYPE{ $type };
-        $self->{'type'} = $type;
-    }
-
-    return $self->{'type'} || 'NORMAL';
-}
-
-# ----------------------------------------------------------------------
-sub equals {
+has type => (
+    is => 'rw',
+    isa => sub {
+        my $type = uc $_[0] or return;
+        throw("Invalid index type: $type") unless $VALID_INDEX_TYPE{$type};
+    },
+    coerce => sub { uc $_[0] },
+    default => sub { 'NORMAL' },
+);
 
-=pod
+around type => \&ex2err;
 
 =head2 equals
 
@@ -254,12 +192,14 @@ Determines if this index is the same as another
 
 =cut
 
+around equals => sub {
+    my $orig = shift;
     my $self = shift;
     my $other = shift;
     my $case_insensitive = shift;
     my $ignore_index_names = shift;
 
-    return 0 unless $self->SUPER::equals($other);
+    return 0 unless $self->$orig($other);
 
     unless ($ignore_index_names) {
       unless ((!$self->name && ($other->name eq $other->fields->[0])) ||
@@ -287,18 +227,13 @@ Determines if this index is the same as another
     return 0 unless $self->_compare_objects(scalar $self->options, scalar $other->options);
     return 0 unless $self->_compare_objects(scalar $self->extra, scalar $other->extra);
     return 1;
-}
+};
 
-# ----------------------------------------------------------------------
-sub DESTROY {
-    my $self = shift;
-    undef $self->{'table'}; # destroy cyclical reference
-}
+# Must come after all 'has' declarations
+around new => \&ex2err;
 
 1;
 
-# ----------------------------------------------------------------------
-
 =pod
 
 =head1 AUTHOR