Improve docs by linking from implementations to their roles

[dbsrgits/DBIx-Class-DeploymentHandler.git] / lib / DBIx / Class / DeploymentHandler / VersionStorage / Deprecated.pm

diff --git a/lib/DBIx/Class/DeploymentHandler/VersionStorage/Deprecated.pm b/lib/DBIx/Class/DeploymentHandler/VersionStorage/Deprecated.pm
index 44c7a3d..9fd2b89 100644 (file)
--- a/lib/DBIx/Class/DeploymentHandler/VersionStorage/Deprecated.pm
+++ b/lib/DBIx/Class/DeploymentHandler/VersionStorage/Deprecated.pm
@@ -1,6 +1,13 @@
 package DBIx::Class::DeploymentHandler::VersionStorage::Deprecated;
 use Moose;
-use Method::Signatures::Simple;
+use DBIx::Class::DeploymentHandler::Logger;
+use Log::Contextual ':log', -package_logger =>
+  DBIx::Class::DeploymentHandler::Logger->new({
+    env_prefix => 'DBICDH'
+  });
+
+
+# ABSTRACT: (DEPRECATED) Use this if you are stuck in the past
 
 has schema => (
   isa      => 'DBIx::Class::Schema',
@@ -28,19 +35,35 @@ sub _build_version_rs {
 
 sub add_database_version {
   # deprecated doesn't support ddl or upgrade_ddl
-  $_[0]->version_rs->create({ version => $_[1]->{version} })
+  my $version = $_[1]->{version};
+  log_debug { "Adding database version $version" };
+  $_[0]->version_rs->create({ version => $version })
 }
 
 sub delete_database_version {
-  $_[0]->version_rs->search({ version => $_[1]->{version}})->delete
+  my $version = $_[1]->{version};
+  log_debug { "Deleting database version $version" };
+  $_[0]->version_rs->search({ version => $version})->delete
 }
 
 __PACKAGE__->meta->make_immutable;
 
 1;
 
+# vim: ts=2 sw=2 expandtab
+
 __END__
 
+=head1 DEPRECATED
+
+I begrudgingly made this module (and other related modules) to keep porting
+from L<DBIx::Class::Schema::Versioned> relatively simple.  I will make changes
+to ensure that it works with output from L<DBIx::Class::Schema::Versioned> etc,
+but I will not add any new features to it.
+
+Once I hit major version 1 usage of this module will emit a warning.
+On version 2 it will be removed entirely.
+
 =head1 THIS SUCKS
 
 Here's how to convert from that crufty old Deprecated VersionStorage to a shiny
@@ -61,4 +84,8 @@ new Standard VersionStorage:
  $dh->version_storage->add_database_vesion({ version => $_ })
    for @versions;
 
-vim: ts=2 sw=2 expandtab
+=head1 SEE ALSO
+
+This class is an implementation of
+L<DBIx::Class::DeploymentHandler::HandlesVersionStorage>.  Pretty much all the
+documentation is there.