X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler%2FDeployMethod%2FSQL%2FTranslator.pm;h=6d00bddd8292f192bc2ef444fa6f5990a055c3a2;hb=0841a74313b0b1f813ba0211a7e665c7fcf93a4b;hp=c4e62f52525bbfee2d04d3e1ac7821beef942644;hpb=45d0d9d59e7b545fa37bdfeac517ccc0e71c5ac6;p=dbsrgits%2FDBIx-Class-DeploymentHandler.git

diff --git a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm
index c4e62f5..6d00bdd 100644
--- a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm
+++ b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm
@@ -1,12 +1,29 @@
 package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator;
 use Moose;
+
+use autodie;
+use Carp qw( carp croak );
+
 use Method::Signatures::Simple;
 use Try::Tiny;
+
 use SQL::Translator;
 require SQL::Translator::Diff;
+
 require DBIx::Class::Storage;   # loaded for type constraint
+use DBIx::Class::DeploymentHandler::Types;
 
-use Carp 'carp';
+use File::Path 'mkpath';
+use File::Spec::Functions;
+
+with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
+
+has schema => (
+  isa      => 'DBIx::Class::Schema',
+  is       => 'ro',
+  required => 1,
+  handles => [qw( schema_version )],
+);
 
 has storage => (
   isa        => 'DBIx::Class::Storage',
@@ -20,17 +37,6 @@ method _build_storage {
   $s
 }
 
-has backup_directory => (
-  isa => 'Str',
-  is  => 'ro',
-);
-
-has do_backup => (
-  isa     => 'Bool',
-  is      => 'ro',
-  default => undef,
-);
-
 has sqltargs => (
   isa => 'HashRef',
   is  => 'ro',
@@ -43,18 +49,6 @@ has upgrade_directory => (
   default  => 'sql',
 );
 
-has version_rs => (
-  isa        => 'DBIx::Class::ResultSet',
-  is         => 'ro',
-  lazy_build => 1,
-  handles    => [qw( is_installed db_version )],
-);
-
-method _build_version_rs {
-   $self->schema->set_us_up_the_bomb;
-   $self->schema->resultset('__VERSION')
-}
-
 has databases => (
   coerce  => 1,
   isa     => 'DBIx::Class::DeploymentHandler::Databases',
@@ -62,138 +56,168 @@ has databases => (
   default => sub { [qw( MySQL SQLite PostgreSQL )] },
 );
 
-has schema => (
-  isa      => 'DBIx::Class::Schema',
-  is       => 'ro',
-  required => 1,
-  handles => [qw( schema_version )],
-);
-
 has _filedata => (
   isa => 'ArrayRef[Str]',
   is  => 'rw',
+  default => sub { [] },
 );
 
-method _ddl_filename($type, $versions, $dir) {
-  my $filename = ref $self->schema;
-  $filename =~ s/::/-/g;
+has txn_wrap => (
+  is => 'ro',
+  isa => 'Bool',
+  default => 1,
+);
 
-  $filename = File::Spec->catfile(
-    $dir, "$filename-" . join( q(-), @{$versions} ) . "-$type.sql"
-  );
+method __ddl_consume_with_prefix($type, $versions, $prefix) {
+  my $base_dir = $self->upgrade_directory;
+
+  my $main    = catfile( $base_dir, $type      );
+  my $generic = catfile( $base_dir, '_generic' );
+  my $common  =
+    catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} );
+
+  my $dir;
+  if (-d $main) {
+    $dir = catfile($main, $prefix, join q(-), @{$versions})
+  } elsif (-d $generic) {
+    $dir = catfile($generic, $prefix, join q(-), @{$versions});
+  } else {
+    croak "neither $main or $generic exist; please write/generate some SQL";
+  }
 
-  return $filename;
-}
+  opendir my($dh), $dir;
+  my %files = map { $_ => "$dir/$_" } grep { /\.(?:sql|pl)$/ && -f "$dir/$_" } readdir $dh;
+  closedir $dh;
 
-method _deployment_statements {
-  my $dir      = $self->upgrade_directory;
-  my $schema   = $self->schema;
-  my $type     = $self->storage->sqlt_type;
-  my $sqltargs = $self->sqltargs;
-  my $version  = $self->schema_version || '1.x';
-
-  my $filename = $self->_ddl_filename($type, [ $version ], $dir);
-  if(-f $filename) {
-      my $file;
-      open $file, q(<), $filename
-        or carp "Can't open $filename ($!)";
-      my @rows = <$file>;
-      close $file;
-      return join '', @rows;
+  if (-d $common) {
+    opendir my($dh), $common;
+    for my $filename (grep { /\.(?:sql|pl)$/ && -f catfile($common,$_) } readdir $dh) {
+      unless ($files{$filename}) {
+        $files{$filename} = catfile($common,$filename);
+      }
+    }
+    closedir $dh;
   }
 
-  # sources needs to be a parser arg, but for simplicty allow at top level
-  # coming in
-  $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
-      if exists $sqltargs->{sources};
+  return [@files{sort keys %files}]
+}
 
-  my $tr = SQL::Translator->new(
-    producer => "SQL::Translator::Producer::${type}",
-    %$sqltargs,
-    parser => 'SQL::Translator::Parser::DBIx::Class',
-    data => $schema,
-  );
+method _ddl_schema_consume_filenames($type, $version) {
+  $self->__ddl_consume_with_prefix($type, [ $version ], 'schema')
+}
 
-  my @ret;
-  my $wa = wantarray;
-  if ($wa) {
-    @ret = $tr->translate;
-  }
-  else {
-    $ret[0] = $tr->translate;
-  }
+method _ddl_schema_produce_filename($type, $version) {
+  my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
+  mkpath($dirname) unless -d $dirname;
 
-  $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
-    unless (@ret && defined $ret[0]);
+  return catfile( $dirname, '001-auto.sql' );
+}
 
-  return $wa ? @ret : $ret[0];
+method _ddl_schema_up_consume_filenames($type, $versions) {
+  $self->__ddl_consume_with_prefix($type, $versions, 'up')
 }
 
-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 _ddl_schema_down_consume_filenames($type, $versions) {
+  $self->__ddl_consume_with_prefix($type, $versions, 'down')
+}
+
+method _ddl_schema_up_produce_filename($type, $versions) {
+  my $dir = $self->upgrade_directory;
+
+  my $dirname = catfile( $dir, $type, 'up', join q(-), @{$versions});
+  mkpath($dirname) unless -d $dirname;
+
+  return catfile( $dirname, '001-auto.sql'
+  );
+}
+
+method _ddl_schema_down_produce_filename($type, $versions, $dir) {
+  my $dirname = catfile( $dir, $type, 'down', join q(-), @{$versions} );
+  mkpath($dirname) unless -d $dirname;
+
+  return catfile( $dirname, '001-auto.sql');
+}
+
+method _run_sql_and_perl($filenames) {
+  my @files = @{$filenames};
+  my $storage = $self->storage;
+
+  my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
+
+  my $sql;
+  for my $filename (@files) {
+    if ($filename =~ /\.sql$/) {
+      my @sql = @{$self->_read_sql_file($filename)};
+      $sql .= join "\n", @sql;
+
+      foreach my $line (@sql) {
+        $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);
+      }
+    } elsif ( $filename =~ /^(.+)\.pl$/ ) {
+      my $package = $1;
+      my $filedata = do { local( @ARGV, $/ ) = $filename; <> };
+      # make the package name more palateable to perl
+      $package =~ s/\W/_/g;
+
+      no warnings 'redefine';
+      eval "package $package;\n\n$filedata";
+      use warnings;
+
+      $package->can('run')->($self->schema);
+    } else {
+      croak "A file got to deploy that wasn't sql or perl!";
     }
   }
+
+  $guard->commit if $self->txn_wrap;
+
+  return $sql;
+}
+
+sub deploy {
+  my $self = shift;
+
+  return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames(
+    $self->storage->sqlt_type,
+    $self->schema_version
+  ));
 }
 
-method prepare_install {
+sub prepare_install {
+  my $self = shift;
   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 = "./";
-  }
+  my $version = $schema->schema_version;
 
-  my $version = $schema->schema_version || '1.x';
-  my $schema_version = $schema->schema_version || '1.x';
-  $version ||= $schema_version;
-
-  $sqltargs = {
-    add_drop_table => 1,
+  my $sqlt = SQL::Translator->new({
+    add_drop_table          => 1,
     ignore_constraint_names => 1,
-    ignore_index_names => 1,
-    %{$sqltargs || {}}
-  };
-
-  my $sqlt = SQL::Translator->new( $sqltargs );
+    ignore_index_names      => 1,
+    parser                  => 'SQL::Translator::Parser::DBIx::Class',
+    %{$sqltargs}
+  });
 
-  $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
-  my $sqlt_schema = $sqlt->translate({ data => $schema })
-    or $self->throw_exception ($sqlt->error);
+  my $sqlt_schema = $sqlt->translate( data => $schema )
+    or croak($sqlt->error);
 
   foreach my $db (@$databases) {
     $sqlt->reset;
     $sqlt->{schema} = $sqlt_schema;
     $sqlt->producer($db);
 
-    my $filename = $self->_ddl_filename($db, [ $version ], $dir);
-    if (-e $filename && ($version eq $schema_version )) {
-      # if we are dumping the current version, overwrite the DDL
+    my $filename = $self->_ddl_schema_produce_filename($db, $version, $dir);
+    if (-e $filename ) {
       carp "Overwriting existing DDL file - $filename";
       unlink $filename;
     }
@@ -203,29 +227,36 @@ method prepare_install {
       carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
       next;
     }
-    my $file;
-    unless( open $file, q(>), $filename ) {
-      $self->throw_exception("Can't open $filename for writing ($!)");
-      next;
-    }
+    open my $file, q(>), $filename;
     print {$file} $output;
     close $file;
   }
 }
 
-method prepare_update($version, $preversion) {
+sub prepare_upgrade {
+  my ($self, $from_version, $to_version, $version_set) = @_;
+  # for updates prepared automatically (rob's stuff)
+  # one would want to explicitly set $version_set to
+  # [$to_version]
+  $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up');
+}
+
+sub prepare_downgrade {
+  my ($self, $from_version, $to_version, $version_set) = @_;
+
+  # for updates prepared automatically (rob's stuff)
+  # one would want to explicitly set $version_set to
+  # [$to_version]
+  $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down');
+}
+
+method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
   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 = "./";
-  }
-
-  my $schema_version = $schema->schema_version || '1.x';
-  $version ||= $schema_version;
+  my $schema_version = $schema->schema_version;
 
   $sqltargs = {
     add_drop_table => 1,
@@ -237,23 +268,23 @@ method prepare_update($version, $preversion) {
   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);
+  my $sqlt_schema = $sqlt->translate( data => $schema )
+    or croak($sqlt->error);
 
   foreach my $db (@$databases) {
     $sqlt->reset;
     $sqlt->{schema} = $sqlt_schema;
     $sqlt->producer($db);
 
-    my $prefilename = $self->_ddl_filename($db, [ $preversion ], $dir);
+    my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir);
     unless(-e $prefilename) {
       carp("No previous schema file found ($prefilename)");
       next;
     }
-
-    my $diff_file = $self->_ddl_filename($db, [ $preversion, $version ], $dir );
+    my $diff_file_method = "_ddl_schema_${direction}_produce_filename";
+    my $diff_file = $self->$diff_file_method($db, $version_set, $dir );
     if(-e $diff_file) {
-      carp("Overwriting existing diff file - $diff_file");
+      carp("Overwriting existing $direction-diff file - $diff_file");
       unlink $diff_file;
     }
 
@@ -266,10 +297,10 @@ method prepare_update($version, $preversion) {
       });
 
       $t->parser( $db ) # could this really throw an exception?
-        or $self->throw_exception ($t->error);
+        or croak($t->error);
 
       my $out = $t->translate( $prefilename )
-        or $self->throw_exception ($t->error);
+        or croak($t->error);
 
       $source_schema = $t->schema;
 
@@ -290,11 +321,11 @@ method prepare_update($version, $preversion) {
       });
 
       $t->parser( $db ) # could this really throw an exception?
-        or $self->throw_exception ($t->error);
+        or croak($t->error);
 
-      my $filename = $self->_ddl_filename($db, [ $version ], $dir);
+      my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir);
       my $out = $t->translate( $filename )
-        or $self->throw_exception ($t->error);
+        or croak($t->error);
 
       $dest_schema = $t->schema;
 
@@ -307,11 +338,7 @@ method prepare_update($version, $preversion) {
        $dest_schema,   $db,
        $sqltargs
     );
-    my $file;
-    unless(open $file, q(>), $diff_file) {
-      $self->throw_exception("Can't write to $diff_file ($!)");
-      next;
-    }
+    open my $file, q(>), $diff_file;
     print {$file} $diff;
     close $file;
   }
@@ -320,68 +347,44 @@ method prepare_update($version, $preversion) {
 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>;
+  open my $fh, '<', $file;
+  my @data = split /;\n/, join '', <$fh>;
   close $fh;
 
   @data = grep {
-    $_ &&
-    !/^--/ &&
-    !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
-  } split /;/,
-    join '', @data;
+    $_ && # remove blank lines
+    !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's
+  } map {
+    s/^\s+//; s/\s+$//; # trim whitespace
+    join '', grep { !/^--/ } split /\n/ # remove comments
+  } @data;
 
   return \@data;
 }
 
-method _upgrade_single_step {
+sub downgrade_single_step {
+  my $self = shift;
   my @version_set = @{ shift @_ };
-  my $db_version = $self->db_version;
-  my $upgrade_file = $self->_ddl_filename(
+
+  my $sql = $self->_run_sql_and_perl($self->_ddl_schema_down_consume_filenames(
     $self->storage->sqlt_type,
     \@version_set,
-    $self->upgrade_directory,
-  );
+  ));
 
-  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     => $version_set[-1],
-    # ddl         => $ddl,
-    # upgrade_sql => $upgrade_sql,
-  });
+  return ['', $sql];
 }
 
-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;
-  }
-}
+sub upgrade_single_step {
+  my $self = shift;
+  my @version_set = @{ shift @_ };
 
-method _apply_statement($statement) {
-  # croak?
-  $self->storage->dbh->do($_) or carp "SQL was: $_"
+  my $sql = $self->_run_sql_and_perl($self->_ddl_schema_up_consume_filenames(
+    $self->storage->sqlt_type,
+    \@version_set,
+  ));
+  return ['', $sql];
 }
 
-method backup { $self->storage->backup($self->backup_directory) }
-
 __PACKAGE__->meta->make_immutable;
 
 1;