undocument private methods

[dbsrgits/DBIx-Class-DeploymentHandler.git] / lib / DBIx / Class / DeploymentHandler / DeployMethod / SQL / Translator.pm

diff --git a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm
index 0d232fd..982a62a 100644 (file)
--- a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm
+++ b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm
@@ -43,7 +43,7 @@ has sql_translator_args => (
   is  => 'ro',
   default => sub { {} },
 );
-has upgrade_directory => (
+has script_directory => (
   isa      => 'Str',
   is       => 'ro',
   required => 1,
@@ -65,13 +65,14 @@ has txn_wrap => (
 
 has schema_version => (
   is => 'ro',
+  isa => 'Str',
   lazy_build => 1,
 );
 
 method _build_schema_version { $self->schema->schema_version }
 
 method __ddl_consume_with_prefix($type, $versions, $prefix) {
-  my $base_dir = $self->upgrade_directory;
+  my $base_dir = $self->script_directory;
 
   my $main    = catfile( $base_dir, $type      );
   my $generic = catfile( $base_dir, '_generic' );
@@ -113,7 +114,7 @@ method _ddl_schema_consume_filenames($type, $version) {
 }
 
 method _ddl_schema_produce_filename($type, $version) {
-  my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
+  my $dirname = catfile( $self->script_directory, $type, 'schema', $version );
   mkpath($dirname) unless -d $dirname;
 
   return catfile( $dirname, '001-auto.sql' );
@@ -128,7 +129,7 @@ method _ddl_schema_down_consume_filenames($type, $versions) {
 }
 
 method _ddl_schema_up_produce_filename($type, $versions) {
-  my $dir = $self->upgrade_directory;
+  my $dir = $self->script_directory;
 
   my $dirname = catfile( $dir, $type, 'up', join q(-), @{$versions});
   mkpath($dirname) unless -d $dirname;
@@ -242,7 +243,7 @@ sub _prepare_install {
   my $to_file   = shift;
   my $schema    = $self->schema;
   my $databases = $self->databases;
-  my $dir       = $self->upgrade_directory;
+  my $dir       = $self->script_directory;
   my $version   = $self->schema_version;
 
   my $sqlt = SQL::Translator->new({
@@ -282,7 +283,7 @@ sub _resultsource_install_filename {
   my ($self, $source_name) = @_;
   return sub {
     my ($self, $type, $version) = @_;
-    my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
+    my $dirname = catfile( $self->script_directory, $type, 'schema', $version );
     mkpath($dirname) unless -d $dirname;
 
     return catfile( $dirname, "001-auto-$source_name.sql" );
@@ -337,7 +338,7 @@ sub prepare_downgrade {
 method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
   my $schema    = $self->schema;
   my $databases = $self->databases;
-  my $dir       = $self->upgrade_directory;
+  my $dir       = $self->script_directory;
   my $sqltargs  = $self->sql_translator_args;
 
   my $schema_version = $self->schema_version;
@@ -602,9 +603,9 @@ and generate the DDL.  This is automatically created with L</_build_storage>.
 
 The arguments that get passed to L<SQL::Translator> when it's used.
 
-=attr upgrade_directory
+=attr script_directory
 
-The directory (default C<'sql'>) that upgrades are stored in
+The directory (default C<'sql'>) that scripts are stored in
 
 =attr databases
 
@@ -621,7 +622,9 @@ transaction.
 The version the schema on your harddrive is at.  Defaults to
 C<< $self->schema->schema_version >>.
 
-=method __ddl_consume_with_prefix
+=begin comment
+
+=head2 __ddl_consume_with_prefix
 
  $dm->__ddl_consume_with_prefix( 'SQLite', [qw( 1.00 1.01 )], 'up' )
 
@@ -629,48 +632,48 @@ This is the meat of the multi-file upgrade/deploy stuff.  It returns a list of
 files in the order that they should be run for a generic "type" of upgrade.
 You should not be calling this in user code.
 
-=method _ddl_schema_consume_filenames
+=head2 _ddl_schema_consume_filenames
 
  $dm->__ddl_schema_consume_filenames( 'SQLite', [qw( 1.00 )] )
 
 Just a curried L</__ddl_consume_with_prefix>.  Get's a list of files for an
 initial deploy.
 
-=method _ddl_schema_produce_filename
+=head2 _ddl_schema_produce_filename
 
  $dm->__ddl_schema_produce_filename( 'SQLite', [qw( 1.00 )] )
 
 Returns a single file in which an initial schema will be stored.
 
-=method _ddl_schema_up_consume_filenames
+=head2 _ddl_schema_up_consume_filenames
 
  $dm->_ddl_schema_up_consume_filenames( 'SQLite', [qw( 1.00 )] )
 
 Just a curried L</__ddl_consume_with_prefix>.  Get's a list of files for an
 upgrade.
 
-=method _ddl_schema_down_consume_filenames
+=head2 _ddl_schema_down_consume_filenames
 
  $dm->_ddl_schema_down_consume_filenames( 'SQLite', [qw( 1.00 )] )
 
 Just a curried L</__ddl_consume_with_prefix>.  Get's a list of files for a
 downgrade.
 
-=method _ddl_schema_up_produce_filenames
+=head2 _ddl_schema_up_produce_filenames
 
  $dm->_ddl_schema_up_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
 
 Returns a single file in which the sql to upgrade from one schema to another
 will be stored.
 
-=method _ddl_schema_down_produce_filename
+=head2 _ddl_schema_down_produce_filename
 
  $dm->_ddl_schema_down_produce_filename( 'SQLite', [qw( 1.00 1.01 )] )
 
 Returns a single file in which the sql to downgrade from one schema to another
 will be stored.
 
-=method _resultsource_install_filename
+=head2 _resultsource_install_filename
 
  my $filename_fn = $dm->_resultsource_install_filename('User');
  $dm->$filename_fn('SQLite', '1.00')
@@ -678,7 +681,7 @@ will be stored.
 Returns a function which in turn returns a single filename used to install a
 single resultsource.  Weird interface is convenient for me.  Deal with it.
 
-=method _run_sql_and_perl
+=head2 _run_sql_and_perl
 
  $dm->_run_sql_and_perl([qw( list of filenames )])
 
@@ -688,7 +691,7 @@ C<.sql> it runs it as sql and if it ends in C<.pl> it runs it as a perl file.
 Depending on L</txn_wrap> all of the files run will be wrapped in a single
 transaction.
 
-=method _prepare_install
+=head2 _prepare_install
 
  $dm->_prepare_install({ add_drop_table => 0 }, sub { 'file_to_create' })
 
@@ -696,7 +699,7 @@ Generates the sql file for installing the database.  First arg is simply
 L<SQL::Translator> args and the second is a coderef that returns the filename
 to store the sql in.
 
-=method _prepare_changegrade
+=head2 _prepare_changegrade
 
  $dm->_prepare_changegrade('1.00', '1.01', [qw( 1.00 1.01)], 'up')
 
@@ -705,10 +708,11 @@ arg is the version to start from, second is the version to go to, third is the
 L<version set|DBIx::Class::DeploymentHandler/VERSION SET>, and last is the
 direction of the changegrade, be it 'up' or 'down'.
 
-=method _read_sql_file
+=head2 _read_sql_file
 
  $dm->_read_sql_file('foo.sql')
 
 Reads a sql file and returns lines in an C<ArrayRef>.  Strips out comments,
 transactions, and blank lines.
 
+=end comment