File Coverage

blib/lib/MySQL/Workbench/DBIC.pm

Criterion	Covered	Total	%
statement	384	396	96.9
branch	161	176	91.4
condition	28	31	90.3
subroutine	27	27	100.0
pod	1	1	100.0
total	601	631	95.2

package MySQL::Workbench::DBIC;

use warnings;
use strict;

use Carp;
use Data::Dumper;
use File::Path qw(make_path);
use File::Spec;
use JSON;
use List::Util qw(first);
use Moo;
use MySQL::Workbench::Parser;

# ABSTRACT: create DBIC scheme for MySQL workbench .mwb files

our $VERSION = '1.20';

has output_path              => ( is => 'ro', required => 1, default => sub { '.' } );
has file                     => ( is => 'ro', required => 1 );
has uppercase                => ( is => 'ro' );
has inherit_from_core        => ( is => 'ro' );
has namespace                => ( is => 'ro', isa => sub{ _check_namespace( @_, 1) }, required => 1, default => sub { '' } );
has result_namespace         => ( is => 'ro', isa => \&_check_namespace, required => 1, default => sub { '' } );
has resultset_namespace      => ( is => 'ro', isa => \&_check_namespace, required => 1, default => sub { '' } );
has load_result_namespace    => ( is => 'ro', isa => \&_check_namespace_array, default => sub { '' } );
has load_resultset_namespace => ( is => 'ro', isa => \&_check_namespace_array, default => sub { '' } );
has schema_name              => ( is => 'rwp', isa => sub { defined $_[0] && $_[0] =~ m{ \A [A-Za-z0-9_]+ \z }xms } );
has parser                   => ( is => 'rwp' );
has version_add              => ( is => 'ro', required => 1, default => sub { 0.01 } );
has column_details           => ( is => 'ro', required => 1, default => sub { 0 } );
has use_fake_dbic            => ( is => 'ro', required => 1, default => sub { 0 } );
has skip_indexes             => ( is => 'ro', required => 1, default => sub { 0 } );
has belongs_to_prefix        => ( is => 'ro', required => 1, default => sub { '' } );
has has_many_prefix          => ( is => 'ro', required => 1, default => sub { '' } );
has has_one_prefix           => ( is => 'ro', required => 1, default => sub { '' } );
has many_to_many_prefix      => ( is => 'ro', required => 1, default => sub { '' } );
has utf8                     => ( is => 'ro', required => 1, default => sub { 0 } );
has schema_base_class        => ( is => 'ro', required => 1, default => sub { 'DBIx::Class::Schema' } );
has remove_table_prefix      => ( is => 'ro' );

has version => ( is => 'rwp' );
has classes => ( is => 'rwp', isa => sub { ref $_[0] && ref $_[0] eq 'ARRAY' }, default => sub { [] } );

sub _check_namespace {
    my ($namespace, $allow_empty_string) = @_;

    return if !defined $namespace;
    return if ref $namespace;

    return 1 if $namespace eq '' && $allow_empty_string;

    return $namespace =~ m{ \A [A-Z]\w*(::\w+)* \z }xms;
}

sub _check_namespace_array {
    my ($namespaces) = @_;

    if ( !ref $namespaces ) {
        return _check_namespace( $namespaces );
    }

    return if 'ARRAY' ne ref $namespaces;

    for my $namespace ( @{ $namespaces } ) {
        return if !_check_namespace( $namespace );
    }

    return 1;
}

around new => sub {
    my ($next, $class, %args) = @_;

    if ( $args{use_fake_dbic} || !eval{ require DBIx::Class } ) {
        require MySQL::Workbench::DBIC::FakeDBIC;
    }

    my $self = $class->$next( %args );

    my $parser = MySQL::Workbench::Parser->new( file => $self->file );
    $self->_set_parser( $parser );

    return $self;
};

sub create_schema{
    my $self = shift;

    my $parser = $self->parser;
    my @tables = @{ $parser->tables };

    my @classes;
    my %relations;
    for my $table ( @tables ){
        my $name = $table->name;

        push @classes, $name;

        my $rels = $table->foreign_keys;
        for my $to_table ( keys %$rels ){
            $relations{$to_table}->{to}->{$name}   = $rels->{$to_table};
            $relations{$name}->{from}->{$to_table} = $rels->{$to_table};
        }
    }

    $self->_set_classes( \@classes );

    my @scheme = $self->_main_template;

    my @files;
    for my $table ( @tables ){
        my $custom_code = $self->_custom_code_table( $table );
        push @files, $self->_class_template( $table, $relations{$table->name}, $custom_code );
    }

    for my $view ( @{ $parser->views || [] } ) {
        my $custom_code = $self->_custom_code_table( $view );
        push @files, $self->_view_template( $view, $custom_code );
    }

    push @files, @scheme;

    $self->_write_files( @files );
}

sub _custom_code_table {
    my ($self, $table) = @_;

    my $name = $table->name;
    if ( $self->uppercase ) {
        $name = join '', map{ ucfirst } split /[_-]/, $table->name;
    }

    my @base_path;
    push @base_path, $self->output_path if $self->output_path;

    my $path = File::Spec->catfile(
        @base_path,
        (split /::/, $self->namespace),
        $self->schema_name,
        $self->result_namespace,
        'Result',
        $name . '.pm'
    );

    return '' if !-f $path;

    return $self->_custom_code( $path );
}

sub _custom_code {
    my ($self, $path) = @_;

    my $content = do { local (@ARGV, $/) = $path; <> };

    my ($code) = $content =~ m{
        ^[#] \s+ --- \s*
        ^[#] \s+ Put \s+ your \s+ own \s+ code \s+ below \s+ this \s+ comment \s*
        ^[#] \s+ --- \s*
        (.*?) \s+
        ^[#] \s+ --- \s*
    }xms;

    return $code;
}

sub _write_files{
    my ($self, %files) = @_;

    for my $package ( keys %files ){
        my @path;
        push @path, $self->output_path if $self->output_path;
        push @path, split /::/, $package;
        my $file = pop @path;
        my $dir  = File::Spec->catdir( @path );

        if( !-e $dir ){
            make_path( $dir ) or croak "Cannot create directory $dir";
        }

        if( open my $fh, '>', $dir . '/' . $file . '.pm' ){
            if ( $self->utf8 ) {
                binmode $fh, ':encoding(utf-8)';
            }

            print $fh $files{$package};
            close $fh;
        }
        else{
            croak "Couldn't create $file.pm: $!";
        }
    }
}

sub _has_many_template{
    my ($self, $to, $rels) = @_;

    my $name                 = $to;
    my ($to_class, $package) = $self->_create_class_and_package_name( $to );

    if ( defined $self->remove_table_prefix ) {
        my $prefix = $self->remove_table_prefix;
        $name      =~ s{\A\Q$prefix\E}{};
    }

    my %has_many_rels;
    my $counter = 1;

    my $string = '';
    for my $field ( @{ $rels || [] } ) {
        my $me_field      = $field->{foreign};
        my $foreign_field = $field->{me};

        my $temp_field = $self->has_many_prefix . $name;
        while ( $has_many_rels{$temp_field} ) {
            $temp_field = $self->has_many_prefix . $name . $counter++;
        }

        $has_many_rels{$temp_field}++;

        $string .= qq~
__PACKAGE__->has_many($temp_field => '$package',
             { 'foreign.$foreign_field' => 'self.$me_field' });
~;
    }

    return $string;
}

sub _belongs_to_template{
    my ($self, $from, $rels) = @_;

    my $name                   = $from;
    my ($from_class, $package) = $self->_create_class_and_package_name( $from );

    if ( defined $self->remove_table_prefix ) {
        my $prefix  = $self->remove_table_prefix;
        $name       =~ s{\A\Q$prefix\E}{};
    }

    my %belongs_to_rels;
    my $counter = 1;

    my $string = '';
    for my $field ( @{ $rels || [] } ) {
        my $me_field      = $field->{me};
        my $foreign_field = $field->{foreign};

        my $temp_field = $self->belongs_to_prefix . $name;
        while ( $belongs_to_rels{$temp_field} ) {
            $temp_field = $self->belongs_to_prefix . $name . $counter++;
        }

        $belongs_to_rels{$temp_field}++;

        $string .= qq~
__PACKAGE__->belongs_to($temp_field => '$package',
             { 'foreign.$foreign_field' => 'self.$me_field' });
~;
    }

    return $string;
}

sub _create_class_and_package_name {
    my ($self, $name) = @_;

    my $class = $name;

    if ( defined $self->remove_table_prefix ) {
        my $prefix = $self->remove_table_prefix;
        $class =~ s{\A\Q$prefix\E}{};
    }

    if ( $self->uppercase ) {
        $class = join '', map{ ucfirst $_ }split /[_-]/, $name;
    }

    my $package = join '::', (
       ( $self->namespace ? $self->namespace : () ),
       $self->schema_name,
       ( length $self->result_namespace ? $self->result_namespace : () ),
       'Result',
       $class,
    );

    return ($class, $package);
}

sub _class_template{
    my ($self, $table, $relations, $custom_code) = @_;

    my $name              = $table->name;
    my ($class, $package) = $self->_create_class_and_package_name( $name );

    my ($has_many, $belongs_to) = ('','');

    my $comment = $table->comment // '{}';
    utf8::upgrade( $comment );

    my $data;
    my $table_comment_perl = '';
    eval {
        $data = JSON->new->decode( $comment );
    };

    if ( !ref $data || 'HASH' ne ref $data ) {
        $data               = {};
        $table_comment_perl = $comment if $comment;
    }
    elsif ( $data->{comment} ) {
        $table_comment_perl = $data->{comment};
    }

    if ( $table_comment_perl ) {
        $table_comment_perl = sprintf "\n\n=head1 DESCRIPTION\n\n%s\n\n=cut", $table_comment_perl;
    }

    my @core_components = $self->inherit_from_core ? () : qw(PK::Auto Core);
    my $components      = join( ' ', @core_components, @{ $data->{components} || [] } );
    my $load_components = $components ? "__PACKAGE__->load_components( qw/$components/ );" : '';

    my %foreign_keys;

    for my $to_table ( sort keys %{ $relations->{to} } ){
        $has_many .= $self->_has_many_template( $to_table, $relations->{to}->{$to_table} );
    }

    for my $from_table ( sort keys %{ $relations->{from} } ){
        $belongs_to .= $self->_belongs_to_template( $from_table, $relations->{from}->{$from_table} );

        my @foreign_key_names = map{ $_->{me} }@{ $relations->{from}->{$from_table} };
        @foreign_keys{ @foreign_key_names } = (1) x @foreign_key_names;
    }

    my @columns = map{ $_->name }@{ $table->columns };
    my $column_string = '';

    if ( !$self->column_details ) {
        $column_string = "qw/\n" . join "\n", map{ "    " . $_ }@columns, "    /";
    }
    else {
        my @columns = @{ $table->columns };

        for my $column ( @columns ) {
            $column_string .= $self->_column_details( $table, $column, \%foreign_keys, $data );
        }
    }

    my @indexes      = @{ $table->indexes };
    my $indexes_hook = $self->_indexes_template( @indexes );

    my $primary_key   = join " ", @{ $table->primary_key };
    my $version       = $self->version;
    my $inherit_from  = $self->inherit_from_core ? '::Core' : '';
    my $use_utf8      = $self->utf8 ? "\nuse utf8;" : '';

    my $template = qq~package $package;

# ABSTRACT: Result class for $name$table_comment_perl

use strict;
use warnings;$use_utf8
use base qw(DBIx::Class$inherit_from);

our \$VERSION = $version;

$load_components
__PACKAGE__->table( '$name' );
__PACKAGE__->add_columns(
$column_string
);
__PACKAGE__->set_primary_key( qw/ $primary_key / );

$has_many
$belongs_to

$indexes_hook

# ---
# Put your own code below this comment
# ---
$custom_code
# ---

1;~;

    return $package, $template;
}

sub _view_template{
    my ($self, $view, $custom_code) = @_;

    my $name              = $view->name;
    my ($class, $package) = $self->_create_class_and_package_name( $name );

    my $comment = $view->comment // '{}';
    utf8::upgrade( $comment );

    my $data;
    my $view_comment_perl = '';
    eval {
        $data = JSON->new->decode( $comment );
    };

    if ( !ref $data || 'HASH' ne ref $data ) {
        $data               = {};
        $view_comment_perl = $comment if $comment;
    }
    elsif ( $data->{comment} ) {
        $view_comment_perl = $data->{comment};
    }

    if ( $view_comment_perl ) {
        $view_comment_perl = sprintf "\n\n=head1 DESCRIPTION\n\n%s\n\n=cut", $view_comment_perl;
    }

    my @core_components = $self->inherit_from_core ? () : qw(PK::Auto Core);
    my $components      = join( ' ', @core_components, @{ $data->{components} || [] } );
    my $load_components = $components ? "__PACKAGE__->load_components( qw/$components/ );" : '';

    my @columns = map{ $_->name }@{ $view->columns };
    my $column_string = '';

    if ( !$self->column_details ) {
        $column_string = "qw/\n" . join "\n", map{ "    " . $_ }@columns, "    /";
    }
    else {
        my @columns = @{ $view->columns };

        for my $column ( @columns ) {
            $column_string .= $self->_column_details( $view, $column, {}, $data );
        }
    }

    my $version       = $self->version;
    my $inherit_from  = $self->inherit_from_core ? '::Core' : '';
    my $use_utf8      = $self->utf8 ? "\nuse utf8;" : '';
    my $definition    = $view->definition;
    my $classes       = join ', ', map {
        my ($class, $package) = $self->_create_class_and_package_name( $_ );
        qq~"$package"~
    } @{ $view->tables || [] };

    my $template = qq~package $package;

# ABSTRACT: Result class for $name$view_comment_perl

use strict;
use warnings;$use_utf8
use base qw(DBIx::Class$inherit_from);

our \$VERSION = $version;

$load_components
__PACKAGE__->table_class('DBIx::Class::ResultSource::View');
__PACKAGE__->table( '$name' );

__PACKAGE__->result_source_instance->view_definition(
    "$definition"
);

__PACKAGE__->add_columns(
$column_string
);

# ---
# Put your own code below this comment
# ---
$custom_code
# ---

1;~;

    return $package, $template;
}

sub _column_details {
    my ($self, $table, $column, $foreign_keys, $data) = @_;

    my $default_value = $column->default_value // '';
    $default_value =~ s/'/\\'/g;

    my $size = $column->length;

    if ( $column->datatype =~ /char/i && $column->length <= 0 ) {
        $size = 255;
    }

    my @options;

    my $name        = $column->name;
    my $col_comment = $column->comment;

    push @options, "data_type          => '" . $column->datatype . "',";
    push @options, "is_auto_increment  => 1,"                            if $column->autoincrement;
    push @options, "is_nullable        => 1,"                            if !$column->not_null;
    push @options, "size               => " . $size . ","                if $size > 0;
    push @options, "default_value      => '" . $default_value . "',"     if length $default_value;

    if ( first { $column->datatype eq $_ }qw/SMALLINT INT INTEGER BIGINT MEDIUMINT NUMERIC DECIMAL/ ) {
        push @options, "is_numeric         => 1,";
    }

    if ( $table->isa('MySQL::Workbench::Parser::Table') ) {
        push @options, "retrieve_on_insert => 1," if first{ $name eq $_ }@{ $table->primary_key };
        push @options, "is_foreign_key     => 1," if $foreign_keys->{$name};
    }

    my %flags = %{ $column->flags };
    if ( %flags ) {
        my $extras = join ', ', map { "$_ => 1" }sort keys %flags;
        push @options, sprintf "extra => {%s},", $extras;
    }

    my $column_comment_perl_raw = '';

    if ( ( $data && $data->{column_info}->{$name} ) || $col_comment ) {
        local $Data::Dumper::Sortkeys = 1;
        local $Data::Dumper::Indent   = 1;
        local $Data::Dumper::Pad      = '      ';

        utf8::upgrade( $col_comment );

        my $comment_data;
        eval {
            $comment_data = JSON->new->decode( $col_comment );
            1;
        } or do {
            if ( $col_comment =~ /\{/ ) {
            print STDERR $col_comment, ": ", $@;
            }
        };

        if ( !$comment_data || 'HASH' ne ref $comment_data ) {
            $column_comment_perl_raw = $col_comment;
            $comment_data            = {};
        }
        else {
            $column_comment_perl_raw = delete $comment_data->{comment} // '';
        }

        my %hash = (
            %{ $data->{column_info}->{$name} || {} },
            %{ $comment_data },
        );

        if ( %hash ) {
            my $dump = Dumper( \%hash );
            $dump    =~ s{\$VAR1 \s+ = \s* \{ \s*? $}{}xms;
            $dump    =~ s{\A\s+\n\s{8}}{}xms;
            $dump    =~ s{\n[ ]+\};\s*\z}{}xms;

            push @options, $dump;
        }
    }

    my $option_string = join "\n        ", @options;

    my @column_comment_lines = split /\r?\n/, $column_comment_perl_raw;
    my $column_comment_perl  = '';

    if ( @column_comment_lines ) {
        my $sep = sprintf "\n%s%s%s# ", ' ' x 4, ' ' x length $name, ' ' x 6;
        $column_comment_perl = ' # ' . join ( $sep, @column_comment_lines );
    }

    my $details = sprintf "    %s => {%s\n        %s\n    },\n",
        $name,
        $column_comment_perl,
        $option_string;

    return $details;
}

sub _indexes_template {
    my ($self, @indexes) = @_;

    return '' if !@indexes;
    return '' if $self->skip_indexes;

    my $hooks     = '';
    my $indexlist = '';

    my $unique_indexes = '';

    INDEX:
    for my $index ( @indexes ) {
        my $type = $index->type;
        $type    = 'normal' if !$type;
        $type    = lc $type;

        next INDEX if $type eq 'primary';

        if ( $type eq 'unique' ) {
            $unique_indexes .= sprintf q~__PACKAGE__->add_unique_constraint(
    %s => [qw/%s/],
);~, $index->name, ( join ' ', @{ $index->columns } );
            next INDEX;
        }

        $type = 'normal' if $type eq 'index';

        $hooks .= sprintf '    $table->add_index(
        type   => "%s",
        name   => "%s",
        fields => [%s],
    );

', $type, $index->name, join ', ', map{ "'$_'" }@{ $index->columns };

        $indexlist.= sprintf "=item * %s\n\n", $index->name;
    }

    my $sub_string = '';
    $sub_string .= $unique_indexes if $unique_indexes;

    return $sub_string if !$hooks;

    $sub_string .= qq~
=head1 DEPLOYMENT

=head2 sqlt_deploy_hook

These indexes are added to the table during deployment

=over 4

$indexlist

=back

=cut

sub sqlt_deploy_hook {
    my (\$self, \$table) = \@_;

$hooks
    return 1;
}
~;

    return $sub_string;
}

sub _main_template{
    my ($self) = @_;

    my @class_names = @{ $self->classes };
    my $classes     = join "\n", map{ "    " . $_ }@class_names;

    my $schema_name = $self->schema_name;
    $schema_name    = '' if !defined $schema_name;

    if (!$schema_name) {
        my @schema_names = qw(DBIC_Schema Database DBIC MySchema MyDatabase DBIxClass_Schema);

        for my $schema ( @schema_names ){
            if( !grep{ $_ eq $schema }@class_names ){
                $schema_name = $schema;
                last;
            }
        }
    }

    croak "couldn't determine a package name for the schema" unless $schema_name;


    $self->_set_schema_name( $schema_name );

    my $namespace  = $self->namespace . '::' . $schema_name;
       $namespace  =~ s/^:://;

    my $version;
    do {
        my $lib_path = $self->output_path;
        my @paths    = @INC;
        unshift @INC, $lib_path;

        eval "require $namespace";
        $version = $namespace->VERSION();
    };

    my $custom_code;
    if ( $version ) {
        (my $path       = $namespace) =~ s{::}{/}g;
        my $schema_file = $self->output_path . '/' . $path . '.pm';
        $custom_code    = $self->_custom_code( $schema_file );
    }

    $custom_code //= '';

    my %all_namespaces_to_load;
    if ( $self->resultset_namespace ) {
        push @{ $all_namespaces_to_load{resultset_namespace} }, sprintf "'%s'", $self->resultset_namespace;
    }

    if ( $self->load_resultset_namespace ) {
        push @{ $all_namespaces_to_load{resultset_namespace} }, map { "'$_'" }
            ref $self->load_resultset_namespace ?
                @{ $self->load_resultset_namespace } :
                $self->load_resultset_namespace;
    }

    if ( $self->load_result_namespace ) {
        push @{ $all_namespaces_to_load{result_namespace} }, map { "'$_'" }
            ref $self->load_result_namespace ?
                @{ $self->load_result_namespace } :
                $self->load_result_namespace;
    }

    if ( $self->result_namespace ) {
        my $namespace = sprintf "'%s::Result'", $self->result_namespace;
        my $found     = grep { $namespace eq $_ }@{ $all_namespaces_to_load{result_namespace} };
        unshift @{ $all_namespaces_to_load{result_namespace} }, $namespace if !$found;
    }

    my $version_add = $self->version_add;
    $version_add    = 0.01 if !$version_add;

    if ( $version ) {
        $version += $version_add;
    }

    $version = $version_add if !$version;

    $self->_set_version( $version );

    my @namespace_types;
    for my $namespace_type ( sort keys %all_namespaces_to_load ) {
        my @namespaces = @{ $all_namespaces_to_load{$namespace_type} };

        push @namespace_types, sprintf "\n    %s => %s,",
            $namespace_type,
            ( @namespaces == 1 ? $namespaces[0] : '[' . (join ', ', @namespaces ) . ']' );
    }

    my $namespaces_to_load = '';
    $namespaces_to_load    = "(" . (join '', @namespace_types) . "\n)" if @namespace_types;

    my $use_utf8   = $self->utf8 ? "\nuse utf8;" : '';
    my $base_class = $self->schema_base_class ? $self->schema_base_class : 'DBIx::Class::Schema';

    my $template = qq~package $namespace;

# ABSTRACT: Schema class

use strict;
use warnings;$use_utf8

use base qw/$base_class/;

our \$VERSION = $version;

__PACKAGE__->load_namespaces$namespaces_to_load;

# ---
# Put your own code below this comment
# ---
$custom_code
# ---

1;~;

    return $namespace, $template;
}


1;

__END__