add DBIx::Class::Admin
Gordon Irving [Mon, 30 Nov 2009 00:26:39 +0000 (00:26 +0000)]
lib/DBIx/Class/Admin.pm [new file with mode: 0644]
t/admin/01load.t [new file with mode: 0644]
t/admin/02ddl.t [new file with mode: 0644]

diff --git a/lib/DBIx/Class/Admin.pm b/lib/DBIx/Class/Admin.pm
new file mode 100644 (file)
index 0000000..e6f8701
--- /dev/null
@@ -0,0 +1,307 @@
+#
+#===============================================================================
+#
+#         FILE:  Admin.pm
+#
+#  DESCRIPTION:  Administrative functions for DBIx::Class Schemata
+#
+#        FILES:  ---
+#         BUGS:  ---
+#        NOTES:  ---
+#       AUTHOR:  Gordon Irving (), <Gordon.irving@sophos.com>
+#      VERSION:  1.0
+#      CREATED:  28/11/09 12:27:15 GMT
+#     REVISION:  ---
+#===============================================================================
+
+package DBIx::Class::Admin;
+
+use Moose;
+use MooseX::Types;
+use MooseX::Types::Moose qw/Int HashRef ArrayRef Str Any/;
+use MooseX::Types::Path::Class qw(Dir File);
+#use DBIx::Class::Schema;
+use Try::Tiny;
+use parent 'Class::C3::Componentised';
+
+use Data::Dumper;
+=c
+               ['lib|I:s' => 'Additonal library path to search in'], 
+               ['schema|s:s' => 'The class of the schema to load', { required => 1 } ],
+               ['config-stanza|S:s' => 'Where in the config to find the connection_info, supply in form MyApp::Model::DB',],
+               ['config|C:s' => 'Supply the config file for parsing by Config::Any', { depends => 'config_stanza'} ],
+               ['connect-info|n:s%' => ' supply the connect info as additonal options ie -I dsn=<dsn> user=<user> password=<pass> '],
+               ['sql-dir|q:s' => 'The directory where sql diffs will be created'],
+               ['sql-type|t:s' => 'The RDBMs falvour you wish to use'],
+               ['version|v:i' => 'Supply a version install'],
+               ['preversion|p:s' => 'The previous version to diff against',],
+
+    'schema=s'  => \my $schema_class,
+    'class=s'   => \my $resultset_class,
+    'connect=s' => \my $connect,
+    'op=s'      => \my $op,
+    'set=s'     => \my $set,
+    'where=s'   => \my $where,
+    'attrs=s'   => \my $attrs,
+    'format=s'  => \my $format,
+    'force'     => \my $force,
+    'trace'     => \my $trace,
+    'quiet'     => \my $quiet,
+    'help'      => \my $help,
+    'tlibs'      => \my $t_libs,
+=cut
+
+=head1 Attributes
+
+=cut
+has lib => (
+       is              => 'ro',
+       isa             => Dir,
+       coerce  => 1,
+       trigger => \&_set_inc,
+);
+
+sub _set_inc {
+       my ($self, $lib) = @_;
+       push @INC, $lib->stringify;
+}
+
+
+has 'schema_class' => (
+       is              => 'ro',
+       isa             => 'Str',
+       coerce  => 1,
+);
+
+
+has 'schema' => (
+       is                      => 'ro',
+       isa                     => 'DBIx::Class::Schema',
+       lazy_build      => 1,
+);
+
+
+
+sub _build_schema {
+       my ($self)  = @_;
+       $self->ensure_class_loaded($self->schema_class);
+       warn Dumper $self->connect_info();
+
+       return $self->schema_class->connect($self->connect_info()},  $self->connect_info->[3], { ignore_version => 1} );
+}
+
+has 'connect_info' => (
+       is                      => 'ro',
+       isa                     => ArrayRef,
+       lazy_build      => 1,
+);
+
+sub _build_connect_info {
+       my ($self) = @_;
+       return find_stanza($self->config, $self->config_stanza);
+}
+
+has config => (
+       is                      => 'ro',
+       isa                     => HashRef,
+       lazy_build      => 1,
+);
+
+sub _build_config {
+       my ($self) = @_;
+       try { require 'Config::Any'; } catch { die "Config::Any is required to parse the config file"; };
+
+       my $cfg = Config::Any->load_files ( {files => [$self->config_file], use_ext =>1, flatten_to_hash=>1});
+
+       # just grab the config from the config file
+       $cfg = $cfg->{$self->config_file};
+       return $cfg;
+}
+
+has config_file => (
+       is                      => 'ro',
+       isa                     => File,
+);
+
+has 'config_stanza' => (
+       is                      => 'ro',
+       isa                     => 'Str',
+);
+
+has 'sql_dir' => (
+       is                      => 'ro',
+       isa                     => Dir,
+       coerce          => 1,
+);
+
+
+
+has 'sql_type' => (
+       is                      => 'ro',
+       isa                     => 'Str',
+);
+
+has version => (
+       is                      => 'ro',
+       isa                     => 'Str',
+);
+
+has preversion => (
+       is                      => 'rw',
+       isa                     => 'Str',
+       predicate       => 'has_preversion',
+);
+
+sub create {
+       my ($self, $sqlt_type, ) = @_;
+       if ($self->has_preversion) {
+               print "attempting to create diff file for ".$self->preversion."\n";
+       }
+       my $schema = $self->schema();
+#      warn "running with params sqlt_type = $sqlt_type, version = " .$schema->schema_version . " sql_dir = " . $self->sql_dir . " preversion = " . ($self->has_preversion ?  $self->preversion : "" ). "\n";
+       # create the dir if does not exist
+       $self->sql_dir->mkpath() if ( ! -d $self->sql_dir);
+
+       $schema->create_ddl_dir( $sqlt_type, (defined $schema->schema_version ? $schema->schema_version : ""), $self->sql_dir->stringify, $self->preversion );
+}
+
+sub upgrade {
+       my ($self) = @_;
+       my $schema = $self->schema();
+       if (!$schema->get_db_version()) {
+               # schema is unversioned
+               warn "could not determin current schema version, please either install or deploy";
+       } else {
+               $schema->upgrade();
+       }
+}
+
+sub install {
+       my ($self) = @_;
+
+       my $schema = $self->schema();
+       if (!$schema->get_db_version()) {
+               # schema is unversioned
+               print "Going to install schema version";
+               $schema->install($self->version);
+       } else {
+               warn "schema already has a version not installing, try upgrade instead";
+       }
+
+}
+
+sub deploy {
+       my ($self) = @_;
+       my $schema = $self->schema();
+       if (!$schema->get_db_version() ) {
+               # schema is unversioned
+               $schema->deploy();
+       } else {
+               warn "there already is a database with a version here, try upgrade instead";
+       }
+}
+
+sub find_stanza {
+       my ($self, $cfg, $stanza) = @_;
+       my @path = split /::/, $stanza;
+       while (my $path = shift @path) {
+               if (exists $cfg->{$path}) {
+                       $cfg = $cfg->{$path};
+               }
+               else {
+                       die "could not find $stanza in config, $path did not seem to exist";
+               }
+       }
+       return $cfg;
+}
+
+# FIXME ensure option spec compatability
+#die('Do not use the where option with the insert op') if ($where);
+#die('Do not use the attrs option with the insert op') if ($attrs);
+sub insert_data {
+       my ($self, $resultset, $set) = @_;
+       my $obj = $resultset->create( $set );
+    print ''.ref($resultset).' ID: '.join(',',$obj->id())."\n" if (!$self->quiet);
+}
+
+sub update_data {
+       my ($self, $resultset, $set, $where) = @_;
+    $resultset = $resultset->search( ($where||{}) );
+    my $count = $resultset->count();
+    print "This action will modify $count ".ref($resultset)." records.\n" if (!$self->quiet);
+    if ( $self->force || $self->confirm() ) {
+        $resultset->update_all( $set );
+    }
+}
+
+# FIXME
+#die('Do not use the set option with the delete op') if ($set);
+sub delete_data {
+       my ($self, $resultset, $where, $attrs) = @_;
+
+    $resultset = $resultset->search( ($where||{}), ($attrs||()) );
+    my $count = $resultset->count();
+    print "This action will delete $count ".ref($resultset)." records.\n" if (!$self->quiet);
+    if ( $self->force || $self->confirm() ) {
+        $resultset->delete_all();
+    }
+}
+
+
+#FIXME
+# die('Do not use the set option with the select op') if ($set);
+sub select_data {
+       my ($self, $resultset, $where, $attrs) = @_;
+
+       
+    $resultset = $resultset->search( ($where||{}), ($attrs||()) );
+}
+
+# TODO, make this more generic, for different data formats
+sub output_data {
+       my ($self, $resultset) = @_;
+
+#      eval {
+#              ensure_class_loaded 'Data::Tabular::Dumper';
+#      };
+#      if($@) {
+#              die "Data::Tabular::Dumper is needed for outputing data";
+#      }
+       my $csv_class;
+       # load compatible CSV generators
+       foreach $csv_class (qw(Text::CSV_XS Text::CSV_PP)) {
+               eval { ensure_class_loaded $csv_class};
+               if($@) {
+                       $csv_class = undef;
+                       next;
+               } 
+       }
+       if (not defined $csv_class) {
+               die ('The select op requires either the Text::CSV_XS or the Text::CSV_PP module');
+       }
+
+    my $csv = $csv_class->new({
+       sep_char => ( $self->csv_format eq 'tsv' ? "\t" : ',' ),
+    });
+
+    my @columns = $resultset->result_source->columns();
+    $csv->combine( @columns );
+    print $csv->string()."\n";
+    while (my $row = $resultset->next()) {
+        my @fields;
+        foreach my $column (@columns) {
+            push( @fields, $row->get_column($column) );
+        }
+        $csv->combine( @fields );
+        print $csv->string()."\n";
+    }
+}
+
+sub confirm {
+    print "Are you sure you want to do this? (type YES to confirm) ";
+    my $response = <STDIN>;
+    return 1 if ($response=~/^YES/);
+    return;
+}
+
+1;
diff --git a/t/admin/01load.t b/t/admin/01load.t
new file mode 100644 (file)
index 0000000..dd3a8ec
--- /dev/null
@@ -0,0 +1,31 @@
+#
+#===============================================================================
+#
+#         FILE:  01load.t
+#
+#  DESCRIPTION:  
+#
+#        FILES:  ---
+#         BUGS:  ---
+#        NOTES:  ---
+#       AUTHOR:  Gordon Irving (), <Gordon.irving@sophos.com>
+#      COMPANY:  Sophos
+#      VERSION:  1.0
+#      CREATED:  28/11/09 13:54:30 GMT
+#     REVISION:  ---
+#===============================================================================
+
+use strict;
+use warnings;
+
+use Test::More;                      # last test to print
+
+use Path::Class;
+use FindBin qw($Bin);
+use lib dir($Bin,'..', '..','lib')->stringify;
+use lib dir($Bin,'..', 'lib')->stringify;
+
+use ok 'DBIx::Class::Admin';
+
+
+done_testing;
diff --git a/t/admin/02ddl.t b/t/admin/02ddl.t
new file mode 100644 (file)
index 0000000..7631390
--- /dev/null
@@ -0,0 +1,82 @@
+#
+#===============================================================================
+#
+#         FILE:  02admin..t
+#
+#  DESCRIPTION:  
+#
+#        FILES:  ---
+#         BUGS:  ---
+#        NOTES:  ---
+#       AUTHOR:  Gordon Irving (), <Gordon.irving@sophos.com>
+#      COMPANY:  Sophos
+#      VERSION:  1.0
+#      CREATED:  28/11/09 16:14:21 GMT
+#     REVISION:  ---
+#===============================================================================
+
+use strict;
+use warnings;
+
+use Test::More;                      # last test to print
+
+use Test::Exception;
+
+use Path::Class;
+use FindBin qw($Bin);
+use lib dir($Bin,'..', '..','lib')->stringify;
+use lib dir($Bin,'..', 'lib')->stringify;
+
+use ok 'DBIx::Class::Admin';
+
+use DBICTest;
+
+my $sql_dir = dir($Bin,"var","sql");
+
+
+{ # create the schema
+
+my $schema = DBICTest->init_schema(
+    no_deploy=>1,
+    no_populate=>1,
+       );
+       clean_dir($sql_dir);
+my $admin = DBIx::Class::Admin->new(
+       schema_class=> "DBICTest::Schema",
+       sql_dir=> $sql_dir,
+       connect_info => $schema->storage->connect_info() 
+);
+
+lives_ok { $admin->create('MySQL'); } 'Can create MySQL sql';
+lives_ok { $admin->create('SQLite'); } 'Can Create SQLite sql';
+}
+
+
+{ # upgrade schema
+
+my $schema = DBICTest->init_schema(
+    no_deploy=>1,
+    no_populate=>1,
+       );
+
+       clean_dir($sql_dir);
+use DBICVersionOrig;
+
+my $admin = DBIx::Class::Admin->new(
+       schema_class => 'DBICVersion::Schema', 
+       sql_dir =>  $sql_dir,
+       connect_info => $schema->storage->connect_info(),
+);
+lives_ok { $admin->create($schema->storage->sqlt_type()); } 'Can create DBICVersionOrig sql in ' . $schema->storage->sqlt_type;
+lives_ok { $admin->deploy(); } 'Can Deploy schema';
+
+}
+
+sub clean_dir {
+       my ($dir)  =@_;
+       foreach my $file ($dir->children) {
+               unlink $file;
+       }
+}
+
+done_testing;