X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler%2FDeployMethod%2FSQL%2FTranslator.pm;h=5084bf8408c77c6a8ad71b0fd423da4b2a6bc075;hb=a65184c855392d390489326e8363ffbe9a0e7fee;hp=129000cc21d26aa64d924e58170b4b9ad0213813;hpb=3249629f430cb0e5a7ef9504f530fbc01ae59fb5;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 129000c..5084bf8 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',
@@ -50,11 +56,6 @@ has databases => (
   default => sub { [qw( MySQL SQLite PostgreSQL )] },
 );
 
-has _filedata => (
-  isa => 'ArrayRef[Str]',
-  is  => 'rw',
-);
-
 has txn_wrap => (
   is => 'ro',
   isa => 'Bool',
@@ -64,28 +65,29 @@ has txn_wrap => (
 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;
@@ -99,15 +101,10 @@ method _ddl_schema_consume_filenames($type, $version) {
 }
 
 method _ddl_schema_produce_filename($type, $version) {
-  my $base_dir = $self->upgrade_directory;
-  my $dirname = File::Spec->catfile(
-    $base_dir, $type, 'schema', $version
-  );
-  File::Path::mkpath($dirname) unless -d $dirname;
+  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_consume_filenames($type, $versions) {
@@ -121,122 +118,105 @@ method _ddl_schema_down_consume_filenames($type, $versions) {
 method _ddl_schema_up_produce_filename($type, $versions) {
   my $dir = $self->upgrade_directory;
 
-  my $dirname = File::Spec->catfile(
-    $dir, $type, 'up', join( q(-), @{$versions} )
-  );
-  File::Path::mkpath($dirname) unless -d $dirname;
+  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_produce_filename($type, $versions, $dir) {
-  my $dirname = File::Spec->catfile(
-    $dir, $type, 'down', join( q(-), @{$versions} )
-  );
-  File::Path::mkpath($dirname) unless -d $dirname;
+  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_consume_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;
 
-  # 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,
-  );
+  my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
 
-  my $ret = $tr->translate;
+  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!";
+    }
+  }
 
-  $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
-    unless defined $ret;
+  $guard->commit if $self->txn_wrap;
 
-  return $ret;
+  return $sql;
 }
 
-sub _deploy {
+sub deploy {
   my $self = shift;
-  my $storage  = $self->storage;
-
-  my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
 
-  foreach my $line ( split /;\n/, $self->_deployment_statements ) {
-    $line = join '', grep { !/^--/ } split /\n/, $line;
-    next 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);
-  }
-
-  $guard->commit if $self->txn_wrap;
+  return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames(
+    $self->storage->sqlt_type,
+    $self->schema_version
+  ));
 }
 
-sub prepare_install {
+sub _prepare_install {
   my $self = shift;
+  my $sqltargs  = { %{$self->sqltargs}, %{shift @_} };
+  my $to_file   = shift;
   my $schema    = $self->schema;
   my $databases = $self->databases;
   my $dir       = $self->upgrade_directory;
-  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_produce_filename($db, $version, $dir);
+    my $filename = $self->$to_file($db, $version, $dir);
     if (-e $filename ) {
       carp "Overwriting existing DDL file - $filename";
       unlink $filename;
@@ -247,41 +227,61 @@ 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;
   }
 }
 
-sub prepare_upgrade {
-  my ($self, $from_version, $to_version, $version_set) = @_;
+sub _resultsource_install_filename {
+  my ($self, $source_name) = @_;
+  return sub {
+    my ($self, $type, $version) = @_;
+    my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
+    mkpath($dirname) unless -d $dirname;
+
+    return catfile( $dirname, "001-auto-$source_name.sql" );
+  }
+}
 
-  $from_version ||= $self->db_version;
-  $to_version   ||= $self->schema_version;
+sub install_resultsource {
+  my ($self, $source, $version) = @_;
 
-  # for updates prepared automatically (rob's stuff)
-  # one would want to explicitly set $version_set to
-  # [$to_version]
-  $version_set  ||= [$from_version, $to_version];
+  my $rs_install_file =
+    $self->_resultsource_install_filename($source->source_name);
+
+  my $files = [
+     $self->$rs_install_file(
+      $self->storage->sqlt_type,
+      $version,
+    )
+  ];
+  $self->_run_sql_and_perl($files);
+}
+
+sub prepare_resultsource_install {
+  my $self = shift;
+  my $source = shift;
+
+  my $filename = $self->_resultsource_install_filename($source->source_name);
+  $self->_prepare_install({
+      parser_args => { sources => [$source->source_name], }
+    }, $filename);
+}
 
+sub prepare_install {
+  my $self = shift;
+  $self->_prepare_install({}, '_ddl_schema_produce_filename');
+}
+
+sub prepare_upgrade {
+  my ($self, $from_version, $to_version, $version_set) = @_;
   $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up');
 }
 
 sub prepare_downgrade {
   my ($self, $from_version, $to_version, $version_set) = @_;
 
-  $from_version ||= $self->db_version;
-  $to_version   ||= $self->schema_version;
-
-  # 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');
 }
 
@@ -303,8 +303,8 @@ method _prepare_changegrade($from_version, $to_version, $version_set, $direction
   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;
@@ -332,10 +332,10 @@ method _prepare_changegrade($from_version, $to_version, $version_set, $direction
       });
 
       $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;
 
@@ -356,11 +356,11 @@ method _prepare_changegrade($from_version, $to_version, $version_set, $direction
       });
 
       $t->parser( $db ) # could this really throw an exception?
-        or $self->throw_exception ($t->error);
+        or croak($t->error);
 
       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;
 
@@ -373,11 +373,7 @@ method _prepare_changegrade($from_version, $to_version, $version_set, $direction
        $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;
   }
@@ -386,86 +382,107 @@ method _prepare_changegrade($from_version, $to_version, $version_set, $direction
 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;
 }
 
-# these are exactly the same for now
-sub _downgrade_single_step {
+sub downgrade_single_step {
   my $self = shift;
-  my @version_set = @{ shift @_ };
-  my @upgrade_files = @{$self->_ddl_schema_up_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;
-    }
+  my $version_set = shift @_;
 
-    $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
+  my $sql = $self->_run_sql_and_perl($self->_ddl_schema_down_consume_filenames(
+    $self->storage->sqlt_type,
+    $version_set,
+  ));
 
-    my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
-    $self->_do_upgrade;
-    $guard->commit if $self->txn_wrap;
-  }
+  return ['', $sql];
 }
 
-sub _upgrade_single_step {
+sub upgrade_single_step {
   my $self = shift;
-  my @version_set = @{ shift @_ };
-  my @upgrade_files = @{$self->_ddl_schema_up_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;
-    }
+  my $version_set = shift @_;
 
-    $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
-    my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
-    $self->_do_upgrade;
-    $guard->commit if $self->txn_wrap;
-  }
+  my $sql = $self->_run_sql_and_perl($self->_ddl_schema_up_consume_filenames(
+    $self->storage->sqlt_type,
+    $version_set,
+  ));
+  return ['', $sql];
 }
 
-method _do_upgrade { $self->_run_upgrade(qr/.*?/) }
+__PACKAGE__->meta->make_immutable;
 
-method _run_upgrade($stm) {
-  return unless $self->_filedata;
-  my @statements = grep { $_ =~ $stm } @{$self->_filedata};
+1;
 
-  for (@statements) {
-    $self->storage->debugobj->query_start($_) if $self->storage->debug;
-    $self->_apply_statement($_);
-    $self->storage->debugobj->query_end($_) if $self->storage->debug;
-  }
-}
+__END__
 
-method _apply_statement($statement) {
-  # croak?
-  $self->storage->dbh->do($_) or carp "SQL was: $_"
-}
+=attr schema
 
-1;
+=attr storage
 
-__END__
+=attr sqltargs
+
+#rename
+
+=attr upgrade_directory
+
+The directory (default C<'sql'>) that upgrades are stored in
+
+=attr databases
+
+The types of databases (default C<< [qw( MySQL SQLite PostgreSQL )] >>) to
+generate files for
+
+=attr txn_wrap
+
+=method __ddl_consume_with_prefix
+
+=method _ddl_schema_consume_filenames
+
+=method _ddl_schema_produce_filename
+
+=method _ddl_schema_up_consume_filenames
+
+=method _ddl_schema_down_consume_filenames
+
+=method _ddl_schema_up_produce_filenames
+
+=method _ddl_schema_down_produce_filenames
+
+=method _resultsource_install_filename
+
+=method _run_sql_and_perl
+
+=method _prepare_install
+
+=method _prepare_changegrade
+
+=method _read_sql_file
+
+=method deploy
+
+=method install_resultsource
+
+=method prepare_resultsouce_install
+
+=method prepare_install
+
+=method prepare_upgrade
+
+=method prepare_downgrade
+
+=method upgrade_single_step
+
+=method downgrade_single_step
 
 vim: ts=2 sw=2 expandtab