X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler%2FDeployMethod%2FSQL%2FTranslator.pm;h=b7425883029bb3ec176e907bb2c0532aba718566;hb=86a86493b755e469429fd7b6674d7d5c78681e4f;hp=02684fdc856556d71ec31f6684ac6f6102b756c4;hpb=ff7f0e7d4be69cb76ad7fc18ac22249a189126a5;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 02684fd..b742588 100644
--- a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm
+++ b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm
@@ -1,16 +1,22 @@
 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 autodie;
-use File::Path;
+use DBIx::Class::DeploymentHandler::Types;
 
-with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
+use File::Path 'mkpath';
+use File::Spec::Functions;
 
-use Carp 'carp';
+with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
 
 has schema => (
   isa      => 'DBIx::Class::Schema',
@@ -53,33 +59,41 @@ has databases => (
 has _filedata => (
   isa => 'ArrayRef[Str]',
   is  => 'rw',
+  default => sub { [] },
 );
 
-method __ddl_in_with_prefix($type, $versions, $prefix) {
+has txn_wrap => (
+  is => 'ro',
+  isa => 'Bool',
+  default => 1,
+);
+
+method __ddl_consume_with_prefix($type, $versions, $prefix) {
   my $base_dir = $self->upgrade_directory;
 
-  my $main    = File::Spec->catfile( $base_dir, $type                         );
-  my $generic = File::Spec->catfile( $base_dir, '_generic'                    );
-  my $common =  File::Spec->catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} );
+  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 = File::Spec->catfile($main, $prefix, join q(-), @{$versions})
+    $dir = catfile($main, $prefix, join q(-), @{$versions})
   } elsif (-d $generic) {
-    $dir = File::Spec->catfile($main, $prefix, join q(-), @{$versions})
+    $dir = catfile($generic, $prefix, join q(-), @{$versions});
   } else {
-    die 'PREPARE TO SQL'
+    croak "neither $main or $generic exist; please write/generate some SQL";
   }
 
   opendir my($dh), $dir;
-  my %files = map { $_ => "$dir/$_" } grep { /\.sql$/ && -f "$dir/$_" } readdir($dh);
+  my %files = map { $_ => "$dir/$_" } grep { /\.(?:sql|pl)$/ && -f "$dir/$_" } readdir $dh;
   closedir $dh;
 
   if (-d $common) {
     opendir my($dh), $common;
-    for my $filename (grep { /\.sql$/ && -f "$common/$_" } readdir($dh)) {
+    for my $filename (grep { /\.(?:sql|pl)$/ && -f catfile($common,$_) } readdir $dh) {
       unless ($files{$filename}) {
-        $files{$filename} = "$common/$_";
+        $files{$filename} = catfile($common,$filename);
       }
     }
     closedir $dh;
@@ -88,165 +102,98 @@ method __ddl_in_with_prefix($type, $versions, $prefix) {
   return [@files{sort keys %files}]
 }
 
-method _ddl_schema_in_filenames($type, $version) {
-  $self->__ddl_in_with_prefix($type, [ $version ], 'schema')
+method _ddl_schema_consume_filenames($type, $version) {
+  $self->__ddl_consume_with_prefix($type, [ $version ], 'schema')
 }
 
-method _ddl_schema_out_filename($type, $version, $dir) {
-  my $dirname = File::Spec->catfile(
-    $dir, $type, 'schema', $version
-  );
-  File::Path::mkpath($dirname) unless -d $dirname;
+method _ddl_schema_produce_filename($type, $version) {
+  my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
+  mkpath($dirname) unless -d $dirname;
 
-  return File::Spec->catfile(
-    $dirname, '001-auto.sql'
-  );
+  return catfile( $dirname, '001-auto.sql' );
 }
 
-method _ddl_schema_up_in_filenames($type, $versions, $dir) {
-  $self->__ddl_in_with_prefix($type, $versions, 'up')
+method _ddl_schema_up_consume_filenames($type, $versions) {
+  $self->__ddl_consume_with_prefix($type, $versions, 'up')
 }
 
-method _ddl_schema_down_in_filenames($type, $versions, $dir) {
-  $self->__ddl_in_with_prefix($type, $versions, 'down')
+method _ddl_schema_down_consume_filenames($type, $versions) {
+  $self->__ddl_consume_with_prefix($type, $versions, 'down')
 }
 
-method _ddl_schema_up_out_filename($type, $versions, $dir) {
-  my $dirname = File::Spec->catfile(
-    $dir, $type, 'up', join( q(-), @{$versions} )
-  );
-  File::Path::mkpath($dirname) unless -d $dirname;
+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 File::Spec->catfile(
-    $dirname, '001-auto.sql'
+  return catfile( $dirname, '001-auto.sql'
   );
 }
 
-method _ddl_schema_down_out_filename($type, $versions, $dir) {
-  my $dirname = File::Spec->catfile(
-    $dir, $type, 'down', join( q(-), @{$versions} )
-  );
-  File::Path::mkpath($dirname) unless -d $dirname;
+method _ddl_schema_down_produce_filename($type, $versions, $dir) {
+  my $dirname = catfile( $dir, $type, 'down', join q(-), @{$versions} );
+  mkpath($dirname) unless -d $dirname;
 
-  return File::Spec->catfile(
-    $dirname, '001-auto.sql'
-  );
+  return catfile( $dirname, '001-auto.sql');
 }
 
-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;
-
-  my @filenames = @{$self->_ddl_schema_in_filenames($type, $version)};
-
-  for my $filename (@filenames) {
-    if(-f $filename) {
-        my $file;
-        open $file, q(<), $filename
-          or carp "Can't open $filename ($!)";
-        my @rows = <$file>;
-        close $file;
-        return join '', @rows;
+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;
+
+      if (my $fn = $package->can('run')) {
+        $fn->($self->schema);
+      } else {
+        carp "$filename should define a run method that takes a schema but it didn't!";
+      }
+    } else {
+      croak "A file got to deploy that wasn't sql or perl!";
     }
   }
 
-  # 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};
-
-  my $tr = SQL::Translator->new(
-    producer => "SQL::Translator::Producer::${type}",
-    %$sqltargs,
-    parser => 'SQL::Translator::Parser::DBIx::Class',
-    data => $schema,
-  );
-
-#< frew> now note that deploy in the same file calls deployment_statements
-#< ribasushi> right
-#< frew> ALWAYS in array context
-#< ribasushi> right, that's the only way
-#< ribasushi> but create_ddl_dir
-#< ribasushi> calls in scalar
-#< ribasushi> because this is how you get stuff writable to a file
-#< ribasushi> in list you get individual statements for dbh->do
-#< frew> right
-#< frew> ok...
-#< frew> so for *me* I need it *always* in scalar
-#< frew> because I *only* use it to generate the file
-#< ribasushi> correct
-  my @ret;
-  my $wa = wantarray;
-  if ($wa) {
-    @ret = $tr->translate;
-  }
-  else {
-    $ret[0] = $tr->translate;
-  }
-
-  $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
-    unless (@ret && defined $ret[0]);
+  $guard->commit if $self->txn_wrap;
 
-  return $wa ? @ret : $ret[0];
+  return $sql;
 }
 
-sub _deploy {
+sub deploy {
   my $self = shift;
-  my $storage  = $self->storage;
-
-  my $deploy = sub {
-    my $line = shift;
-#< frew> k, also, we filter out comments and transaction stuff and blank lines
-#< frew> is that really necesary?
-#< frew> and what if I want to run my upgrade in a txn?  seems like something you'd
-#        always want to do really
-#< ribasushi> again - some stuff chokes
-#< frew> ok, so I see filtering out -- and \s*
-#< frew> but I think the txn filtering should be optional and default to NOT filter it
-#        out
-#< ribasushi> then you have a problem
-#< frew> tell me
-#< ribasushi> someone runs a deploy in txn_do
-#< ribasushi> the inner begin will blow up
-#< frew> because it's a nested TXN?
-#< ribasushi> (you an't begin twice on most dbs)
-#< ribasushi> right
-#< ribasushi> on sqlite - for sure
-#< frew> so...read the docs and set txn_filter to true?
-#< ribasushi> more like wrap deploy in a txn
-#< frew> I like that better
-#< ribasushi> and make sure the ddl has no literal txns in them
-#< frew> sure
-#< ribasushi> this way you have stuff under control
-#< frew> so we have txn_wrap default to true
-#< frew> and if people wanna do that by hand they can
-
-    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 );
-    }
-  }
+
+  return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames(
+    $self->storage->sqlt_type,
+    $self->schema_version
+  ));
 }
 
 sub prepare_install {
@@ -257,29 +204,23 @@ sub prepare_install {
   my $sqltargs  = $self->sqltargs;
   my $version = $schema->schema_version;
 
-  unless( -d $dir ) {
-    carp "Upgrade directory $dir does not exist, using ./\n";
-    $dir = './';
-  }
-
-
   my $sqlt = SQL::Translator->new({
     add_drop_table          => 1,
     ignore_constraint_names => 1,
     ignore_index_names      => 1,
     parser                  => 'SQL::Translator::Parser::DBIx::Class',
-    %{$sqltargs || {}}
+    %{$sqltargs}
   });
 
-  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_schema_out_filename($db, $version, $dir);
+    my $filename = $self->_ddl_schema_produce_filename($db, $version, $dir);
     if (-e $filename ) {
       carp "Overwriting existing DDL file - $filename";
       unlink $filename;
@@ -290,11 +231,7 @@ sub 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;
   }
@@ -302,24 +239,27 @@ sub prepare_install {
 
 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');
+}
 
-  $from_version ||= $self->db_version;
-  $to_version   ||= $self->schema_version;
+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]
-  $version_set  ||= [$from_version, $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;
 
   $sqltargs = {
@@ -332,23 +272,23 @@ sub prepare_upgrade {
   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_schema_out_filename($db, $from_version, $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_schema_up_out_filename($db, $version_set, $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 up-diff file - $diff_file");
+      carp("Overwriting existing $direction-diff file - $diff_file");
       unlink $diff_file;
     }
 
@@ -361,10 +301,10 @@ sub prepare_upgrade {
       });
 
       $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;
 
@@ -385,11 +325,11 @@ sub prepare_upgrade {
       });
 
       $t->parser( $db ) # could this really throw an exception?
-        or $self->throw_exception ($t->error);
+        or croak($t->error);
 
-      my $filename = $self->_ddl_schema_out_filename($db, $to_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;
 
@@ -402,11 +342,7 @@ sub prepare_upgrade {
        $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;
   }
@@ -415,57 +351,45 @@ sub prepare_upgrade {
 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;
 }
 
-sub _upgrade_single_step {
+sub downgrade_single_step {
   my $self = shift;
   my @version_set = @{ shift @_ };
-  my @upgrade_files = @{$self->_ddl_schema_up_in_filenames(
+
+  my $sql = $self->_run_sql_and_perl($self->_ddl_schema_down_consume_filenames(
     $self->storage->sqlt_type,
     \@version_set,
-  )};
-
-  for my $upgrade_file (@upgrade_files) {
-    unless (-f $upgrade_file) {
-      # croak?
-      carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
-      return;
-    }
+  ));
 
-    $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
-    $self->schema->txn_do(sub { $self->_do_upgrade });
-  }
+  return ['', $sql];
 }
 
-method _do_upgrade { $self->_run_upgrade(qr/.*?/) }
-
-method _run_upgrade($stm) {
-  return unless $self->_filedata;
-  my @statements = grep { $_ =~ $stm } @{$self->_filedata};
+sub upgrade_single_step {
+  my $self = shift;
+  my @version_set = @{ shift @_ };
 
-  for (@statements) {
-    $self->storage->debugobj->query_start($_) if $self->storage->debug;
-    $self->_apply_statement($_);
-    $self->storage->debugobj->query_end($_) if $self->storage->debug;
-  }
+  my $sql = $self->_run_sql_and_perl($self->_ddl_schema_up_consume_filenames(
+    $self->storage->sqlt_type,
+    \@version_set,
+  ));
+  return ['', $sql];
 }
 
-method _apply_statement($statement) {
-  # croak?
-  $self->storage->dbh->do($_) or carp "SQL was: $_"
-}
+__PACKAGE__->meta->make_immutable;
 
 1;