tiny cleanup, mark which attrs are purely for config
[dbsrgits/DBIx-Class-DeploymentHandler.git] / lib / DBIx / Class / DeploymentHandler.pm
index 52fabeb..b1c96de 100644 (file)
@@ -6,6 +6,22 @@ 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;
+require SQL::Translator::Diff;
+use Try::Tiny;
+
+with 'DBIx::Class::DeploymentHandler::WithSqltDeployMethod';
+
+BEGIN {
+  use Moose::Util::TypeConstraints;
+  subtype 'DBIx::Class::DeploymentHandler::Databases'
+    => as 'ArrayRef[Str]';
+
+  coerce 'DBIx::Class::DeploymentHandler::Databases'
+    => from 'Str'
+    => via { [$_] };
+  no Moose::Util::TypeConstraints;
+}
 
 has schema => (
   isa      => 'DBIx::Class::Schema',
@@ -14,16 +30,17 @@ has schema => (
   handles => [qw( ddl_filename schema_version )],
 );
 
-has upgrade_directory => (
+has upgrade_directory => ( # configuration
   isa      => 'Str',
   is       => 'ro',
   required => 1,
   default  => 'sql',
 );
 
-has backup_directory => (
+has backup_directory => ( # configuration
   isa => 'Str',
   is  => 'ro',
+  predicate  => 'has_backup_directory',
 );
 
 has storage => (
@@ -38,18 +55,7 @@ method _build_storage {
   $s
 }
 
-has _filedata => (
-  isa => 'ArrayRef[Str]',
-  is  => 'rw',
-);
-
-has do_backup => (
-  isa     => 'Bool',
-  is      => 'ro',
-  default => undef,
-);
-
-has do_diff_on_init => (
+has do_backup => ( # configuration
   isa     => 'Bool',
   is      => 'ro',
   default => undef,
@@ -62,19 +68,53 @@ has version_rs => (
   handles    => [qw( is_installed db_version )],
 );
 
-has databases => (
-  # make this coerce from Str
-  isa => 'ArrayRef[Str]',
-  is  => 'ro',
-  default => sub { [qw( MySQL SQLite PostgreSQL )] },
-);
-
 method _build_version_rs {
    $self->schema->set_us_up_the_bomb;
    $self->schema->resultset('__VERSION')
 }
 
-method backup { $self->storage->backup($self->backup_directory) }
+has databases => ( # configuration
+  coerce  => 1,
+  isa     => 'DBIx::Class::DeploymentHandler::Databases',
+  is      => 'ro',
+  default => sub { [qw( MySQL SQLite PostgreSQL )] },
+);
+
+has sqltargs => ( # configuration
+  isa => 'HashRef',
+  is  => 'ro',
+  default => sub { {} },
+);
+
+method deploy {
+  my $storage  = $self->storage;
+
+  my $deploy = sub {
+    my $line = shift;
+    return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
+    $storage->_query_start($line);
+    try {
+      # do a dbh_do cycle here, as we need some error checking in
+      # place (even though we will ignore errors)
+      $storage->dbh_do (sub { $_[1]->do($line) });
+    }
+    catch {
+      carp "$_ (running '${line}')"
+    }
+    $storage->_query_end($line);
+  };
+  my @statements = $self->deployment_statements;
+  if (@statements > 1) {
+    foreach my $statement (@statements) {
+      $deploy->( $statement );
+    }
+  }
+  elsif (@statements == 1) {
+    foreach my $line ( split(";\n", $statements[0])) {
+      $deploy->( $line );
+    }
+  }
+}
 
 method install($new_version) {
   carp 'Install not possible as versions table already exists in database'
@@ -83,7 +123,7 @@ method install($new_version) {
   $new_version ||= $self->schema_version;
 
   if ($new_version) {
-    $self->schema->deploy;
+    $self->deploy;
 
     $self->version_rs->create({
       version     => $new_version,
@@ -93,8 +133,6 @@ method install($new_version) {
   }
 }
 
-method create_upgrade_path { }
-
 method ordered_schema_versions { undef }
 
 method upgrade {
@@ -136,198 +174,7 @@ method upgrade {
   }
 }
 
-method upgrade_single_step($db_version, $target_version) {
-  if ($db_version eq $target_version) {
-    # croak?
-    carp "Upgrade not necessary\n";
-    return;
-  }
-
-  my $upgrade_file = $self->ddl_filename(
-    $self->storage->sqlt_type,
-    $target_version,
-    $self->upgrade_directory,
-    $db_version,
-  );
-
-  $self->create_upgrade_path({ upgrade_file => $upgrade_file });
-
-  unless (-f $upgrade_file) {
-    # croak?
-    carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
-    return;
-  }
-
-  carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
-
-  $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
-  $self->backup if $self->do_backup;
-  $self->schema->txn_do(sub { $self->do_upgrade });
-
-  $self->version_rs->create({
-    version     => $target_version,
-    # ddl         => $ddl,
-    # upgrade_sql => $upgrade_sql,
-  });
-}
-
-method create_ddl_dir($version, $preversion, $sqltargs) {
-  my $schema = $self->schema;
-  my $databases = $self->databases;
-  my $dir = $self->upgrade_directory;
-  unless( -d $dir ) {
-    carp "Upgrade directory $dir does not exist, using ./\n";
-    $dir = "./";
-  }
-
-  my $schema_version = $schema->schema_version || '1.x';
-  $version ||= $schema_version;
-
-  $sqltargs = {
-    add_drop_table => 1,
-    ignore_constraint_names => 1,
-    ignore_index_names => 1,
-    %{$sqltargs || {}}
-  };
-
-  unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
-    $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
-  }
-
-  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);
-    }
-
-    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);
-
-    next unless ($preversion);
-
-    require SQL::Translator::Diff;
-
-    my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
-    if(!-e $prefilename) {
-      carp("No previous schema file found ($prefilename)");
-      next;
-    }
-
-    my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
-    if(-e $difffile) {
-      carp("Overwriting existing diff file - $difffile");
-      unlink($difffile);
-    }
-
-    my $source_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( $prefilename )
-        or $self->throw_exception ($t->error);
-
-      $source_schema = $t->schema;
-
-      $source_schema->name( $prefilename )
-        unless ( $source_schema->name );
-    }
-
-    # 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};
-
-  for (@statements) {
-    $self->storage->debugobj->query_start($_) if $self->storage->debug;
-    $self->apply_statement($_);
-    $self->storage->debugobj->query_end($_) if $self->storage->debug;
-  }
-}
-
-method apply_statement($statement) {
-  # croak?
-  $self->storage->dbh->do($_) or carp "SQL was: $_"
-}
-
-method _read_sql_file($file) {
-  return unless $file;
-
-  open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
-  my @data = split /\n/, join '', <$fh>;
-  close $fh;
-
-  @data = grep {
-    $_ &&
-    !/^--/ &&
-    !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
-  } split /;/,
-    join '', @data;
-
-  return \@data;
-}
+__PACKAGE__->meta->make_immutable;
 
 1;