more interface cleanup, dont use optional deps while this is not in core
[dbsrgits/DBIx-Class-DeploymentHandler.git] / lib / DBIx / Class / DeploymentHandler.pm
index cbae8ca..ffc4441 100644 (file)
@@ -6,12 +6,13 @@ require DBIx::Class::Schema;    # loaded for type constraint
 require DBIx::Class::Storage;   # loaded for type constraint
 require DBIx::Class::ResultSet; # loaded for type constraint
 use Carp::Clan '^DBIx::Class::DeploymentHandler';
+use SQL::Translator;
 
 has schema => (
   isa      => 'DBIx::Class::Schema',
   is       => 'ro',
   required => 1,
-  handles => [qw{schema_version}],
+  handles => [qw( ddl_filename schema_version )],
 );
 
 has upgrade_directory => (
@@ -39,7 +40,7 @@ method _build_storage {
 }
 
 has _filedata => (
-  isa => 'Str',
+  isa => 'ArrayRef[Str]',
   is  => 'rw',
 );
 
@@ -62,13 +63,29 @@ has version_rs => (
   handles    => [qw( is_installed db_version )],
 );
 
-method _build_version_rs { $self->schema->resultset('VersionResult') }
+has databases => (
+  # make this coerce from Str
+  isa => 'ArrayRef[Str]',
+  is  => 'ro',
+  default => sub { [qw( MySQL SQLite PostgreSQL )] },
+);
+
+has sqltargs => (
+  isa => 'HashRef',
+  is  => 'ro',
+  default => sub { {} },
+);
+
+method _build_version_rs {
+   $self->schema->set_us_up_the_bomb;
+   $self->schema->resultset('__VERSION')
+}
 
 method backup { $self->storage->backup($self->backup_directory) }
 
 method install($new_version) {
   carp 'Install not possible as versions table already exists in database'
-    unless $self->is_installed;
+    if $self->is_installed;
 
   $new_version ||= $self->schema_version;
 
@@ -85,7 +102,7 @@ method install($new_version) {
 
 method create_upgrade_path { }
 
-method ordered_schema_versions { }
+method ordered_schema_versions { undef }
 
 method upgrade {
   my $db_version     = $self->db_version;
@@ -161,86 +178,142 @@ method upgrade_single_step($db_version, $target_version) {
   });
 }
 
-method do_upgrade { $self->run_upgrade(qr/.*?/) }
+method create_ddl_dir($version, $preversion) {
+  my $schema    = $self->schema;
+  my $databases = $self->databases;
+  my $dir       = $self->upgrade_directory;
+  my $sqltargs  = $self->sqltargs;
+  unless( -d $dir ) {
+    carp "Upgrade directory $dir does not exist, using ./\n";
+    $dir = "./";
+  }
 
-method run_upgrade($stm) {
-  return unless $self->_filedata;
-  my @statements = grep { $_ =~ $stm } @{$self->_filedata};
+  my $schema_version = $schema->schema_version || '1.x';
+  $version ||= $schema_version;
 
-  for (@statements) {
-    $self->storage->debugobj->query_start($_) if $self->storage->debug;
-    $self->apply_statement($_);
-    $self->storage->debugobj->query_end($_) if $self->storage->debug;
-  }
-}
+  $sqltargs = {
+    add_drop_table => 1,
+    ignore_constraint_names => 1,
+    ignore_index_names => 1,
+    %{$sqltargs || {}}
+  };
+
+  my $sqlt = SQL::Translator->new( $sqltargs );
+
+  $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
+  my $sqlt_schema = $sqlt->translate({ data => $schema })
+    or $self->throw_exception ($sqlt->error);
+
+  foreach my $db (@$databases) {
+    $sqlt->reset();
+    $sqlt->{schema} = $sqlt_schema;
+    $sqlt->producer($db);
+
+    my $file;
+    my $filename = $schema->ddl_filename($db, $version, $dir);
+    if (-e $filename && ($version eq $schema_version )) {
+      # if we are dumping the current version, overwrite the DDL
+      carp "Overwriting existing DDL file - $filename";
+      unlink($filename);
+    }
 
-method apply_statement($statement) {
-  # croak?
-  $self->storage->dbh->do($_) or carp "SQL was: $_"
-}
+    my $output = $sqlt->translate;
+    if(!$output) {
+      carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
+      next;
+    }
+    if(!open($file, ">$filename")) {
+      $self->throw_exception("Can't open $filename for writing ($!)");
+      next;
+    }
+    print $file $output;
+    close($file);
 
-sub _create_db_to_schema_diff {
-  my $self = shift;
+    next unless ($preversion);
 
-  my %driver_to_db_map = (
-    'mysql' => 'MySQL'
-  );
+    require SQL::Translator::Diff;
 
-  my $db = $driver_to_db_map{$self->storage->dbh->{Driver}{Name}};
-  unless ($db) {
-    # croak?
-    print "Sorry, this is an unsupported DB\n";
-    return;
-  }
+    my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
+    if(!-e $prefilename) {
+      carp("No previous schema file found ($prefilename)");
+      next;
+    }
 
-  $self->throw_exception($self->storage->_sqlt_version_error)
-    unless $self->storage->_sqlt_version_ok;
+    my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
+    if(-e $difffile) {
+      carp("Overwriting existing diff file - $difffile");
+      unlink($difffile);
+    }
 
-  my $db_tr = SQL::Translator->new({
-    add_drop_table => 1,
-    parser         => 'DBI',
-    parser_args    => { dbh  => $self->storage->dbh },
-    producer       => $db,
-  });
+    my $source_schema;
+    {
+      my $t = SQL::Translator->new($sqltargs);
+      $t->debug( 0 );
+      $t->trace( 0 );
 
-  my $dbic_tr = SQL::Translator->new({
-    parser   => 'SQL::Translator::Parser::DBIx::Class',
-    data     => $self,
-    producer => $db,
-  });
+      $t->parser( $db )
+        or $self->throw_exception ($t->error);
 
-  $db_tr->schema->name('db_schema');
-  $dbic_tr->schema->name('dbic_schema');
+      my $out = $t->translate( $prefilename )
+        or $self->throw_exception ($t->error);
 
-  # is this really necessary?
-  foreach my $tr ($db_tr, $dbic_tr) {
-    my $data = $tr->data;
-    $tr->parser->($tr, $$data);
-  }
+      $source_schema = $t->schema;
 
-  my $diff = SQL::Translator::Diff::schema_diff(
-    $db_tr->schema,   $db,
-    $dbic_tr->schema, $db, {
-      ignore_constraint_names => 1,
-      ignore_index_names      => 1,
-      caseopt                 => 1,
+      $source_schema->name( $prefilename )
+        unless ( $source_schema->name );
     }
-  );
 
-  my $filename = $self->ddl_filename(
-    $db,
-    $self->schema_version,
-    $self->upgrade_directory,
-    'PRE',
-  );
+    # The "new" style of producers have sane normalization and can support
+    # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
+    # And we have to diff parsed SQL against parsed SQL.
+    my $dest_schema = $sqlt_schema;
+
+    unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
+      my $t = SQL::Translator->new($sqltargs);
+      $t->debug( 0 );
+      $t->trace( 0 );
+
+      $t->parser( $db )
+        or $self->throw_exception ($t->error);
+
+      my $out = $t->translate( $filename )
+        or $self->throw_exception ($t->error);
+
+      $dest_schema = $t->schema;
+
+      $dest_schema->name( $filename )
+        unless $dest_schema->name;
+    }
+
+    my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
+                                                  $dest_schema,   $db,
+                                                  $sqltargs
+                                                 );
+    if(!open $file, ">$difffile") {
+      $self->throw_exception("Can't write to $difffile ($!)");
+      next;
+    }
+    print $file $diff;
+    close($file);
+  }
+}
+
+method do_upgrade { $self->run_upgrade(qr/.*?/) }
+
+method run_upgrade($stm) {
+  return unless $self->_filedata;
+  my @statements = grep { $_ =~ $stm } @{$self->_filedata};
 
-  open my $file, '>', $filename
-    or $self->throw_exception("Can't open $filename for writing ($!)");
-  print {$file} $diff;
-  close $file;
+  for (@statements) {
+    $self->storage->debugobj->query_start($_) if $self->storage->debug;
+    $self->apply_statement($_);
+    $self->storage->debugobj->query_end($_) if $self->storage->debug;
+  }
+}
 
-  carp "WARNING: There may be differences between your DB and your DBIC schema.\n" .
-       "Please review and if necessary run the SQL in $filename to sync your DB.\n";
+method apply_statement($statement) {
+  # croak?
+  $self->storage->dbh->do($_) or carp "SQL was: $_"
 }
 
 method _read_sql_file($file) {