remove dead function, fix logic error, add (for now) proxy method
[dbsrgits/DBIx-Class-DeploymentHandler.git] / lib / DBIx / Class / DeploymentHandler.pm
index a8380a7..6bbde02 100644 (file)
@@ -5,66 +5,72 @@ use Method::Signatures::Simple;
 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 'carp';
+use Carp::Clan '^DBIx::Class::DeploymentHandler';
 
 has schema => (
-   isa      => 'DBIx::Class::Schema',
-   is       => 'ro',
-   required => 1,
-   handles => [qw{schema_version}],
+  isa      => 'DBIx::Class::Schema',
+  is       => 'ro',
+  required => 1,
+  handles => [qw( schema_version )],
 );
 
 has upgrade_directory => (
-   isa      => 'Str',
-   is       => 'ro',
-   required => 1,
-   default  => 'sql',
+  isa      => 'Str',
+  is       => 'ro',
+  required => 1,
+  default  => 'upgrades',
 );
 
 has backup_directory => (
-   isa => 'Str',
-   is  => 'ro',
+  isa => 'Str',
+  is  => 'ro',
 );
 
 has storage => (
-   isa        => 'DBIx::Class::Storage',
-   is         => 'ro',
-   lazy_build => 1,
+  isa        => 'DBIx::Class::Storage',
+  is         => 'ro',
+  lazy_build => 1,
 );
 
-method _build_storage { $self->schema->storage }
+method _build_storage {
+  my $s = $self->schema->storage;
+  $s->_determine_driver;
+  $s
+}
 
 has _filedata => (
-   isa => 'Str',
-   is  => 'rw',
+  isa => 'Str',
+  is  => 'rw',
 );
 
 has do_backup => (
-   isa     => 'Bool',
-   is      => 'ro',
-   default => undef,
+  isa     => 'Bool',
+  is      => 'ro',
+  default => undef,
 );
 
 has do_diff_on_init => (
-   isa     => 'Bool',
-   is      => 'ro',
-   default => undef,
+  isa     => 'Bool',
+  is      => 'ro',
+  default => undef,
 );
 
 has version_rs => (
-   isa        => 'DBIx::Class::ResultSet',
-   is         => 'ro',
-   lazy_build => 1,
-   handles    => [qw( is_installed db_version )],
+  isa        => 'DBIx::Class::ResultSet',
+  is         => 'ro',
+  lazy_build => 1,
+  handles    => [qw( is_installed db_version )],
 );
 
 method _build_version_rs { $self->schema->resultset('VersionResult') }
 
 method backup { $self->storage->backup($self->backup_directory) }
 
+method create_ddl_dir { $self->storage->create_ddl_dir( $self->schema, @_ ) }
+
 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;
 
@@ -72,9 +78,9 @@ method install($new_version) {
     $self->schema->deploy;
 
     $self->version_rs->create({
-       version     => $new_version,
-       # ddl         => $ddl,
-       # upgrade_sql => $upgrade_sql,
+      version     => $new_version,
+      # ddl         => $ddl,
+      # upgrade_sql => $upgrade_sql,
     });
   }
 }
@@ -88,13 +94,15 @@ method upgrade {
   my $schema_version = $self->schema_version;
 
   unless ($db_version) {
-      carp 'Upgrade not possible as database is unversioned. Please call install first.';
-      return;
+    # croak?
+    carp 'Upgrade not possible as database is unversioned. Please call install first.';
+    return;
   }
 
   if ( $db_version eq $schema_version ) {
-      carp "Upgrade not necessary\n";
-      return;
+    # croak?
+    carp "Upgrade not necessary\n";
+    return;
   }
 
   my @version_list = $self->ordered_schema_versions ||
@@ -102,12 +110,12 @@ method upgrade {
 
   # remove all versions in list above the required version
   while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
-      pop @version_list;
+    pop @version_list;
   }
 
   # remove all versions in list below the current version
   while ( @version_list && ( $version_list[0] ne $db_version ) ) {
-      shift @version_list;
+    shift @version_list;
   }
 
   # check we have an appropriate list of versions
@@ -115,23 +123,18 @@ method upgrade {
 
   # do sets of upgrade
   while ( @version_list >= 2 ) {
-      $self->upgrade_single_step( $version_list[0], $version_list[1] );
-      shift @version_list;
+    $self->upgrade_single_step( $version_list[0], $version_list[1] );
+    shift @version_list;
   }
 }
 
 method upgrade_single_step($db_version, $target_version) {
   if ($db_version eq $target_version) {
+    # croak?
     carp "Upgrade not necessary\n";
     return;
   }
 
-  # strangely the first time this is called can
-  # differ to subsequent times. so we call it
-  # here to be sure.
-  # XXX - just fix it
-  $self->storage->sqlt_type;
-
   my $upgrade_file = $self->ddl_filename(
     $self->storage->sqlt_type,
     $target_version,
@@ -142,22 +145,21 @@ method upgrade_single_step($db_version, $target_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";
 
-  # backup if necessary then apply upgrade
-  $self->_filedata($self->_read_sql_file($upgrade_file));
+  $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 });
 
-  # set row in dbix_class_schema_versions table
   $self->version_rs->create({
-     version     => $target_version,
-     # ddl         => $ddl,
-     # upgrade_sql => $upgrade_sql,
+    version     => $target_version,
+    # ddl         => $ddl,
+    # upgrade_sql => $upgrade_sql,
   });
 }
 
@@ -175,72 +177,10 @@ method run_upgrade($stm) {
 }
 
 method apply_statement($statement) {
+  # croak?
   $self->storage->dbh->do($_) or carp "SQL was: $_"
 }
 
-sub _create_db_to_schema_diff {
-  my $self = shift;
-
-  my %driver_to_db_map = (
-    'mysql' => 'MySQL'
-  );
-
-  my $db = $driver_to_db_map{$self->storage->dbh->{Driver}{Name}};
-  unless ($db) {
-    print "Sorry, this is an unsupported DB\n";
-    return;
-  }
-
-  $self->throw_exception($self->storage->_sqlt_version_error)
-    unless $self->storage->_sqlt_version_ok;
-
-  my $db_tr = SQL::Translator->new({
-    add_drop_table => 1,
-    parser         => 'DBI',
-    parser_args    => { dbh  => $self->storage->dbh },
-    producer       => $db,
-  });
-
-  my $dbic_tr = SQL::Translator->new({
-    parser   => 'SQL::Translator::Parser::DBIx::Class',
-    data     => $self,
-    producer => $db,
-  });
-
-  $db_tr->schema->name('db_schema');
-  $dbic_tr->schema->name('dbic_schema');
-
-  # is this really necessary?
-  foreach my $tr ($db_tr, $dbic_tr) {
-    my $data = $tr->data;
-    $tr->parser->($tr, $$data);
-  }
-
-  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,
-    }
-  );
-
-  my $filename = $self->ddl_filename(
-    $db,
-    $self->schema_version,
-    $self->upgrade_directory,
-    'PRE',
-  );
-
-  open my $file, '>', $filename
-    or $self->throw_exception("Can't open $filename for writing ($!)");
-  print {$file} $diff;
-  close $file;
-
-  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 _read_sql_file($file) {
   return unless $file;
 
@@ -259,3 +199,7 @@ method _read_sql_file($file) {
 }
 
 1;
+
+__END__
+
+vim: ts=2,sw=2,expandtab