From: Arthur Axel 'fREW' Schmidt <frioux@gmail.com>
Date: Sat, 3 Apr 2010 09:01:24 +0000 (-0500)
Subject: add abstracts
X-Git-Tag: v0.001000_01~9
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=9deabd1fcf64a04422d1903f8656ac445e73336a;p=dbsrgits%2FDBIx-Class-DeploymentHandler.git

add abstracts
---

diff --git a/lib/DBIx/Class/DeploymentHandler/Dad.pm b/lib/DBIx/Class/DeploymentHandler/Dad.pm
index 8b6b8c4..57ccefd 100644
--- a/lib/DBIx/Class/DeploymentHandler/Dad.pm
+++ b/lib/DBIx/Class/DeploymentHandler/Dad.pm
@@ -1,5 +1,7 @@
 package DBIx::Class::DeploymentHandler::Dad;
 
+# ABSTRACT: Parent class for DeploymentHandlers
+
 use Moose;
 use Method::Signatures::Simple;
 require DBIx::Class::Schema;    # loaded for type constraint
diff --git a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm
index d8cf072..96fb073 100644
--- a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm
+++ b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm
@@ -1,5 +1,8 @@
 package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::Deprecated;
 use Moose;
+
+# ABSTRACT: (DEPRECATED) Use this if you are stuck in the past
+
 use Method::Signatures::Simple;
 
 use File::Spec::Functions;
diff --git a/lib/DBIx/Class/DeploymentHandler/Deprecated.pm b/lib/DBIx/Class/DeploymentHandler/Deprecated.pm
index 935ca74..3697761 100644
--- a/lib/DBIx/Class/DeploymentHandler/Deprecated.pm
+++ b/lib/DBIx/Class/DeploymentHandler/Deprecated.pm
@@ -1,5 +1,7 @@
 package DBIx::Class::DeploymentHandler::Deprecated;
 
+# ABSTRACT: (DEPRECATED) Use this if you are stuck in the past
+
 use Moose;
 use Moose::Util 'apply_all_roles';
 
diff --git a/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm b/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm
index 4eb2dba..05d4825 100644
--- a/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm
+++ b/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedSqltDeployMethod.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::Deprecated::WithDeprecatedSqltDeployMethod;
 use Moose::Role;
 
+# ABSTRACT: (DEPRECATED) Use this if you are stuck in the past
+
 use DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::Deprecated;
 
 has deploy_method => (
diff --git a/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedVersionStorage.pm b/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedVersionStorage.pm
index bbbe7bd..001a74a 100644
--- a/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedVersionStorage.pm
+++ b/lib/DBIx/Class/DeploymentHandler/Deprecated/WithDeprecatedVersionStorage.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::Deprecated::WithDeprecatedVersionStorage;
 use Moose::Role;
 
+# ABSTRACT: (DEPRECATED) Use this if you are stuck in the past
+
 use DBIx::Class::DeploymentHandler::VersionStorage::Deprecated;
 
 has version_storage => (
diff --git a/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm b/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
index ecb42f4..feba373 100644
--- a/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
+++ b/lib/DBIx/Class/DeploymentHandler/HandlesDeploy.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::HandlesDeploy;
 use Moose::Role;
 
+# ABSTRACT: Interface for deploy methods
+
 requires 'prepare_install';
 requires 'prepare_resultsource_install';
 requires 'install_resultsource';
diff --git a/lib/DBIx/Class/DeploymentHandler/HandlesVersionStorage.pm b/lib/DBIx/Class/DeploymentHandler/HandlesVersionStorage.pm
index 596a48e..9f8cfac 100644
--- a/lib/DBIx/Class/DeploymentHandler/HandlesVersionStorage.pm
+++ b/lib/DBIx/Class/DeploymentHandler/HandlesVersionStorage.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::HandlesVersionStorage;
 use Moose::Role;
 
+# ABSTRACT: Interface for version storage methods
+
 requires 'add_database_version';
 requires 'database_version';
 requires 'delete_database_version';
diff --git a/lib/DBIx/Class/DeploymentHandler/HandlesVersioning.pm b/lib/DBIx/Class/DeploymentHandler/HandlesVersioning.pm
index 77895d5..258b7a5 100644
--- a/lib/DBIx/Class/DeploymentHandler/HandlesVersioning.pm
+++ b/lib/DBIx/Class/DeploymentHandler/HandlesVersioning.pm
@@ -1,7 +1,8 @@
 package DBIx::Class::DeploymentHandler::HandlesVersioning;
 use Moose::Role;
 
-# note: the sets returned need to match!
+# ABSTRACT: Interface for version methods
+
 requires 'next_version_set';
 requires 'previous_version_set';
 
diff --git a/lib/DBIx/Class/DeploymentHandler/Types.pm b/lib/DBIx/Class/DeploymentHandler/Types.pm
index c4946c9..67e4780 100644
--- a/lib/DBIx/Class/DeploymentHandler/Types.pm
+++ b/lib/DBIx/Class/DeploymentHandler/Types.pm
@@ -2,6 +2,8 @@ package DBIx::Class::DeploymentHandler::Types;
 use strict;
 use warnings;
 
+# ABSTRACT: Types internal to DBIx::Class::DeploymentHandler
+
 use Moose::Util::TypeConstraints;
 subtype 'DBIx::Class::DeploymentHandler::Databases'
  => as 'ArrayRef[Str]';
diff --git a/lib/DBIx/Class/DeploymentHandler/VersionHandler/DatabaseToSchemaVersions.pm b/lib/DBIx/Class/DeploymentHandler/VersionHandler/DatabaseToSchemaVersions.pm
index f37a53b..1762553 100644
--- a/lib/DBIx/Class/DeploymentHandler/VersionHandler/DatabaseToSchemaVersions.pm
+++ b/lib/DBIx/Class/DeploymentHandler/VersionHandler/DatabaseToSchemaVersions.pm
@@ -1,5 +1,8 @@
 package DBIx::Class::DeploymentHandler::VersionHandler::DatabaseToSchemaVersions;
 use Moose;
+
+# ABSTRACT: Go straight from Database to Schema version
+
 use Method::Signatures::Simple;
 
 with 'DBIx::Class::DeploymentHandler::HandlesVersioning';
diff --git a/lib/DBIx/Class/DeploymentHandler/VersionHandler/ExplicitVersions.pm b/lib/DBIx/Class/DeploymentHandler/VersionHandler/ExplicitVersions.pm
index 60b01ff..2661cac 100644
--- a/lib/DBIx/Class/DeploymentHandler/VersionHandler/ExplicitVersions.pm
+++ b/lib/DBIx/Class/DeploymentHandler/VersionHandler/ExplicitVersions.pm
@@ -1,5 +1,8 @@
 package DBIx::Class::DeploymentHandler::VersionHandler::ExplicitVersions;
 use Moose;
+
+# ABSTRACT: Define your own list of versions to use for migrations
+
 use Carp 'croak';
 
 with 'DBIx::Class::DeploymentHandler::HandlesVersioning';
diff --git a/lib/DBIx/Class/DeploymentHandler/VersionHandler/Monotonic.pm b/lib/DBIx/Class/DeploymentHandler/VersionHandler/Monotonic.pm
index 4028404..c1fa768 100644
--- a/lib/DBIx/Class/DeploymentHandler/VersionHandler/Monotonic.pm
+++ b/lib/DBIx/Class/DeploymentHandler/VersionHandler/Monotonic.pm
@@ -1,5 +1,8 @@
 package DBIx::Class::DeploymentHandler::VersionHandler::Monotonic;
 use Moose;
+
+# ABSTRACT: Obvious version progressions
+
 use Carp 'croak';
 
 with 'DBIx::Class::DeploymentHandler::HandlesVersioning';
diff --git a/lib/DBIx/Class/DeploymentHandler/VersionStorage/Deprecated.pm b/lib/DBIx/Class/DeploymentHandler/VersionStorage/Deprecated.pm
index f39460b..144cca7 100644
--- a/lib/DBIx/Class/DeploymentHandler/VersionStorage/Deprecated.pm
+++ b/lib/DBIx/Class/DeploymentHandler/VersionStorage/Deprecated.pm
@@ -1,5 +1,8 @@
 package DBIx::Class::DeploymentHandler::VersionStorage::Deprecated;
 use Moose;
+
+# ABSTRACT: (DEPRECATED) Use this if you are stuck in the past
+
 use Method::Signatures::Simple;
 
 has schema => (
diff --git a/lib/DBIx/Class/DeploymentHandler/VersionStorage/Standard.pm b/lib/DBIx/Class/DeploymentHandler/VersionStorage/Standard.pm
index 2151714..3da6506 100644
--- a/lib/DBIx/Class/DeploymentHandler/VersionStorage/Standard.pm
+++ b/lib/DBIx/Class/DeploymentHandler/VersionStorage/Standard.pm
@@ -1,5 +1,8 @@
 package DBIx::Class::DeploymentHandler::VersionStorage::Standard;
 use Moose;
+
+# ABSTRACT: Version storage that does the normal stuff
+
 use Method::Signatures::Simple;
 
 has schema => (
diff --git a/lib/DBIx/Class/DeploymentHandler/WithDatabaseToSchemaVersions.pm b/lib/DBIx/Class/DeploymentHandler/WithDatabaseToSchemaVersions.pm
index f76ded6..f04effa 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithDatabaseToSchemaVersions.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithDatabaseToSchemaVersions.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::WithDatabaseToSchemaVersions;
 use Moose::Role;
 
+# ABSTRACT: Delegate/Role for DBIx::Class::DeploymentHandler::VersionHandler::DatabaseToSchemaVersions
+
 use DBIx::Class::DeploymentHandler::VersionHandler::DatabaseToSchemaVersions;
 
 use Carp 'carp';
diff --git a/lib/DBIx/Class/DeploymentHandler/WithExplicitVersions.pm b/lib/DBIx/Class/DeploymentHandler/WithExplicitVersions.pm
index b04ba26..076f6f0 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithExplicitVersions.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithExplicitVersions.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::WithExplicitVersions;
 use Moose::Role;
 
+# ABSTRACT: Delegate/Role for DBIx::Class::DeploymentHandler::VersionHandler::ExplicitVersions
+
 use DBIx::Class::DeploymentHandler::VersionHandler::ExplicitVersions;
 
 use Carp 'carp';
diff --git a/lib/DBIx/Class/DeploymentHandler/WithMonotonicVersions.pm b/lib/DBIx/Class/DeploymentHandler/WithMonotonicVersions.pm
index 704c8a3..a38d43a 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithMonotonicVersions.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithMonotonicVersions.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::WithMonotonicVersions;
 use Moose::Role;
 
+# ABSTRACT: Delegate/Role for DBIx::Class::DeploymentHandler::VersionHandler::Monotonic
+
 use DBIx::Class::DeploymentHandler::VersionHandler::Monotonic;
 
 has version_handler => (
diff --git a/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm b/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm
index 8a36cf0..1ccae70 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithReasonableDefaults.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::WithReasonableDefaults;
 use Moose::Role;
 
+# ABSTRACT: Make default arguments to a few methods sensible
+
 requires qw( prepare_upgrade prepare_downgrade database_version schema_version );
 
 around prepare_upgrade => sub {
diff --git a/lib/DBIx/Class/DeploymentHandler/WithSqltDeployMethod.pm b/lib/DBIx/Class/DeploymentHandler/WithSqltDeployMethod.pm
index 9bee8e8..62e854b 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithSqltDeployMethod.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithSqltDeployMethod.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::WithSqltDeployMethod;
 use Moose::Role;
 
+# ABSTRACT: Delegate/Role for DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator
+
 use DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator;
 
 has deploy_method => (
diff --git a/lib/DBIx/Class/DeploymentHandler/WithStandardVersionStorage.pm b/lib/DBIx/Class/DeploymentHandler/WithStandardVersionStorage.pm
index 83aa886..a986ac6 100644
--- a/lib/DBIx/Class/DeploymentHandler/WithStandardVersionStorage.pm
+++ b/lib/DBIx/Class/DeploymentHandler/WithStandardVersionStorage.pm
@@ -1,6 +1,8 @@
 package DBIx::Class::DeploymentHandler::WithStandardVersionStorage;
 use Moose::Role;
 
+# ABSTRACT: Delegate/Role for DBIx::Class::DeploymentHandler::VersionStorage::Standard
+
 use DBIx::Class::DeploymentHandler::VersionStorage::Standard;
 
 has version_storage => (