File Coverage

blib/lib/SQL/Translator/Schema/Index.pm

Criterion	Covered	Total	%
statement	27	27	100.0
branch	5	6	83.3
condition			n/a
subroutine	8	8	100.0
pod	1	1	100.0
total	41	42	97.6

package SQL::Translator::Schema::Index;

=pod

=head1 NAME

SQL::Translator::Schema::Index - SQL::Translator index object

=head1 SYNOPSIS

  use SQL::Translator::Schema::Index;
  my $index = SQL::Translator::Schema::Index->new(
      name   => 'foo',
      fields => [ id ],
      type   => 'unique',
  );

=head1 DESCRIPTION

C is the index object.

Primary and unique keys are table constraints, not indices.

=head1 METHODS

=cut

use Moo;
use SQL::Translator::Schema::Constants;
use SQL::Translator::Schema::IndexField;
use SQL::Translator::Utils qw(ex2err throw parse_list_arg);
use SQL::Translator::Role::ListAttr;
use SQL::Translator::Types qw(schema_obj enum);
use Sub::Quote             qw(quote_sub);

extends 'SQL::Translator::Schema::Object';

our $VERSION = '1.66';

my %VALID_INDEX_TYPE = (
  UNIQUE    => 1,
  NORMAL    => 1,
  FULLTEXT  => 1,    # MySQL only (?)
  FULL_TEXT => 1,    # MySQL only (?)
  SPATIAL   => 1,    # MySQL only (?)
);

=head2 new

Object constructor.

  my $schema = SQL::Translator::Schema::Index->new;

=head2 fields

Gets and set the fields the index 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.

  $index->fields('id');
  $index->fields('id', 'name');
  $index->fields( 'id, name' );
  $index->fields( [ 'id', 'name' ] );
  $index->fields( qw[ id name ] );
  $index->fields(id => { name => 'name', order_by => 'ASC NULLS LAST' });

  my @fields = $index->fields;

=cut

with ListAttr fields => (
  coerce => sub {
    my %seen;
    return [
      grep !$seen{ $_->name }++,
      map SQL::Translator::Schema::IndexField->new($_),
      @{ parse_list_arg($_[0]) }
    ];
  }
);

sub is_valid {

=pod

=head2 is_valid

Determine whether the index is valid or not.

  my $ok = $index->is_valid;

=cut

  my $self   = shift;
  my $table  = $self->table  or return $self->error('No table');
  my @fields = $self->fields or return $self->error('No fields');

  for my $field (@fields) {
    return $self->error("Field '$field' does not exist in table '", $table->name, "'")
        unless $table->get_field($field);
  }

  return 1;
}

=head2 name

Get or set the index's name.

  my $name = $index->name('foo');

=cut

has name => (
  is      => 'rw',
  coerce  => quote_sub(q{ defined $_[0] ? $_[0] : '' }),
  default => quote_sub(q{ '' }),
);

=head2 options

Get or set the index's options (e.g., "using" or "where" for PG).  Returns
an array or array reference.

  my @options = $index->options;

=cut

with ListAttr options => ();

=head2 table

Get or set the index's table object.

  my $table = $index->table;

=cut

has table => (is => 'rw', isa => schema_obj('Table'), weak_ref => 1);

around table => \&ex2err;

=head2 type

Get or set the index's type.

  my $type = $index->type('unique');

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
and uppercase types are acceptable input, this method returns the type in
uppercase.

=cut

has type => (
  is      => 'rw',
  coerce  => quote_sub(q{ uc $_[0] }),
  default => quote_sub(q{ 'NORMAL' }),
  isa     => enum(
    [ keys %VALID_INDEX_TYPE ],
    {
      msg         => "Invalid index type: %s",
      allow_false => 1,
    }
  ),
);

around type => \&ex2err;

=head2 equals

Determines if this index is the same as another

  my $isIdentical = $index1->equals( $index2 );

=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->$orig($other);

  unless ($ignore_index_names) {
    unless ((!$self->name && ($other->name eq $other->fields->[0]->name))
      || (!$other->name && ($self->name eq $self->fields->[0]->name))) {
      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;
  return 0 unless $self->type eq $other->type;

  # Check fields, regardless of order
  my $get_name    = sub { return $case_insensitive ? uc(shift->name) : shift->name; };
  my @otherFields = sort { $a->{key} cmp $b->{key} }
      map +{ item => $_, key => $get_name->($_) }, $other->fields;
  my @selfFields = sort { $a->{key} cmp $b->{key} }
      map +{ item => $_, key => $get_name->($_) }, $self->fields;
  return 0 unless @otherFields == @selfFields;
  for my $idx (0 .. $#selfFields) {
    return 0 unless $selfFields[$idx]{key} eq $otherFields[$idx]{key};
    return 0
        unless $self->_compare_objects(scalar $selfFields[$idx]{item}->extra, scalar $otherFields[$idx]{item}->extra);
  }

  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;
};

# Must come after all 'has' declarations
around new => \&ex2err;

1;

=pod

=head1 AUTHOR

Ken Youens-Clark [e-mail].

=cut