Mooify SQLT::Schema::Index
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Schema / Index.pm
index 5f067ca..7834350 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,32 +25,28 @@ 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 Readonly;
-
-use base 'SQL::Translator::Schema::Object';
-
-use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
+use List::MoreUtils qw(uniq);
 
-$VERSION = '1.60';
-
-Readonly my %VALID_INDEX_TYPE => (
-    UNIQUE    => 1,
-    NORMAL    => 1,
-    FULLTEXT  => 1,    # MySQL only (?)
-    FULL_TEXT => 1,    # MySQL only (?)
-    SPATIAL   => 1,    # MySQL only (?)
+with qw(
+  SQL::Translator::Schema::Role::Extra
+  SQL::Translator::Schema::Role::Error
+  SQL::Translator::Schema::Role::Compare
 );
 
-# ----------------------------------------------------------------------
+our ( $TABLE_COUNT, $VIEW_COUNT );
 
-__PACKAGE__->_attributes( qw/
-    name type fields table options
-/);
+our $VERSION = '1.59';
 
-=pod
+my %VALID_INDEX_TYPE = (
+  UNIQUE         => 1,
+  NORMAL         => 1,
+  FULLTEXT       => 1, # MySQL only (?)
+  FULL_TEXT      => 1, # MySQL only (?)
+  SPATIAL        => 1, # MySQL only (?)
+);
 
 =head2 new
 
@@ -78,10 +56,11 @@ Object constructor.
 
 =cut
 
-# ----------------------------------------------------------------------
-sub fields {
-
-=pod
+sub BUILD {
+    my ($self) = @_;
+    $self->$_(scalar $self->$_)
+        foreach qw(fields options);
+}
 
 =head2 fields
 
@@ -99,24 +78,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->{'fields'} || [] } : $self->{'fields'};
-}
+    return wantarray ? @{ $self->$orig } : $self->$orig;
+};
 
-# ----------------------------------------------------------------------
 sub is_valid {
 
 =pod
@@ -142,11 +118,6 @@ Determine whether the index is valid or not.
     return 1;
 }
 
-# ----------------------------------------------------------------------
-sub name {
-
-=pod
-
 =head2 name
 
 Get or set the index's name.
@@ -155,15 +126,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
 
@@ -174,23 +137,21 @@ an array or array reference.
 
 =cut
 
+has options => (
+    is => 'rw',
+    default => sub { [] },
+    coerce => sub { parse_list_arg($_[0]) },
+);
+
+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
 
@@ -200,20 +161,18 @@ Get or set the index's table object.
 
 =cut
 
+has table => ( is => 'rw' );
+
+around table => sub {
+    my $orig = shift;
     my $self = shift;
-    if ( my $arg = shift ) {
+    if ( my $arg = $_[0] ) {
         return $self->error('Not a table object') unless
             UNIVERSAL::isa( $arg, 'SQL::Translator::Schema::Table' );
-        $self->{'table'} = $arg;
     }
 
-    return $self->{'table'};
-}
-
-# ----------------------------------------------------------------------
-sub type {
-
-=pod
+    return $self->$orig(@_);
+};
 
 =head2 type
 
@@ -221,7 +180,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
@@ -230,22 +189,19 @@ uppercase.
 
 =cut
 
-    my ( $self, $type ) = @_;
+has type => ( is => 'rw', default => sub { 'NORMAL' } );
+
+around type => sub {
+    my ( $orig, $self) = (shift, shift);
 
-    if ( $type ) {
-        $type = uc $type;
-        return $self->error("Invalid index type: $type") 
+    if ( my $type = $_[0] ) {
+        my $type = uc $type;
+        return $self->error("Invalid index type: $type")
             unless $VALID_INDEX_TYPE{ $type };
-        $self->{'type'} = $type;
     }
 
-    return $self->{'type'} || 'NORMAL';
-}
-
-# ----------------------------------------------------------------------
-sub equals {
-
-=pod
+    return $self->$orig(@_);
+};
 
 =head2 equals
 
@@ -255,12 +211,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])) ||
@@ -270,17 +228,17 @@ Determines if this index is the same as another
     }
     #return 0 unless $self->is_valid eq $other->is_valid;
     return 0 unless $self->type eq $other->type;
-    
+
     # Check fields, regardless of order
-    my %otherFields = ();      # create a hash of the other fields
+    my %otherFields = ();  # create a hash of the other fields
     foreach my $otherField ($other->fields) {
-       $otherField = uc($otherField) if $case_insensitive;
-       $otherFields{$otherField} = 1;
+      $otherField = uc($otherField) if $case_insensitive;
+      $otherFields{$otherField} = 1;
     }
     foreach my $selfField ($self->fields) { # check for self fields in hash
-       $selfField = uc($selfField) if $case_insensitive;
-       return 0 unless $otherFields{$selfField};
-       delete $otherFields{$selfField};
+      $selfField = uc($selfField) if $case_insensitive;
+      return 0 unless $otherFields{$selfField};
+      delete $otherFields{$selfField};
     }
     # Check all other fields were accounted for
     return 0 unless keys %otherFields == 0;
@@ -288,9 +246,8 @@ 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
@@ -298,8 +255,6 @@ sub DESTROY {
 
 1;
 
-# ----------------------------------------------------------------------
-
 =pod
 
 =head1 AUTHOR