Refactor SQLA/select interaction (in reality just cleanup)

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Admin.pm

diff --git a/lib/DBIx/Class/Admin.pm b/lib/DBIx/Class/Admin.pm
index 234a5bc..284f72d 100644 (file)
--- a/lib/DBIx/Class/Admin.pm
+++ b/lib/DBIx/Class/Admin.pm
@@ -2,44 +2,37 @@ package DBIx::Class::Admin;
 
 # check deps
 BEGIN {
-    my @_deps = qw(
-        Moose MooseX::Types MooseX::Types::JSON MooseX::Types::Path::Class
-        Try::Tiny parent JSON::Any Class::C3::Componentised
-        namespace::autoclean
-    );
-
-    my @_missing_deps;
-    foreach my $dep (@_deps) {
-      eval "require $dep";
-      if ($@) {
-        push @_missing_deps, $dep;
-      }
-    }
-
-    if (@_missing_deps > 0) {
-      die "The following dependecies are missing " . join ",", @_missing_deps;
-    }
+  use Carp::Clan qw/^DBIx::Class/;
+  use DBIx::Class;
+  croak('The following modules are required for DBIx::Class::Admin ' . DBIx::Class::Optional::Dependencies->req_missing_for ('admin') )
+    unless DBIx::Class::Optional::Dependencies->req_ok_for ('admin');
 }
 
 use Moose;
-use parent 'DBIx::Class::Schema';
-use Carp::Clan qw/^DBIx::Class/;
-
 use MooseX::Types::Moose qw/Int Str Any Bool/;
 use DBIx::Class::Admin::Types qw/DBICConnectInfo DBICHashRef/;
 use MooseX::Types::JSON qw(JSON);
 use MooseX::Types::Path::Class qw(Dir File);
 use Try::Tiny;
-use JSON::Any;
+use JSON::Any qw(DWIW XS JSON);
 use namespace::autoclean;
 
-
 =head1 NAME
 
 DBIx::Class::Admin - Administration object for schemas
 
 =head1 SYNOPSIS
 
+  $ dbicadmin --help
+
+  $ dbicadmin --schema=MyApp::Schema \
+    --connect='["dbi:SQLite:my.db", "", ""]' \
+    --deploy
+
+  $ dbicadmin --schema=MyApp::Schema --class=Employee \
+    --connect='["dbi:SQLite:my.db", "", ""]' \
+    --op=update --set='{ "name": "New_Employee" }'
+
   use DBIx::Class::Admin;
 
   # ddl manipulation
@@ -61,7 +54,12 @@ DBIx::Class::Admin - Administration object for schemas
   # install a version for an unversioned schema
   $admin->install("3.0");
 
-=head1 Attributes
+=head1 REQUIREMENTS
+
+The Admin interface has additional requirements not currently part of
+L<DBIx::Class>. See L<DBIx::Class::Optional::Dependencies> for more details.
+
+=head1 ATTRIBUTES
 
 =head2 schema_class
 
@@ -70,9 +68,8 @@ the class of the schema to load
 =cut
 
 has 'schema_class' => (
-  is    => 'ro',
-  isa    => Str,
-  coerce  => 1,
+  is  => 'ro',
+  isa => Str,
 );
 
 
@@ -83,14 +80,15 @@ A pre-connected schema object can be provided for manipulation
 =cut
 
 has 'schema' => (
-  is      => 'ro',
-  isa      => 'DBIx::Class::Schema',
+  is          => 'ro',
+  isa         => 'DBIx::Class::Schema',
   lazy_build  => 1,
 );
 
 sub _build_schema {
   my ($self)  = @_;
-  $self->ensure_class_loaded($self->schema_class);
+  require Class::MOP;
+  Class::MOP::load_class($self->schema_class);
 
   $self->connect_info->[3]->{ignore_version} =1;
   return $self->schema_class->connect(@{$self->connect_info()} ); # ,  $self->connect_info->[3], { ignore_version => 1} );
@@ -104,8 +102,8 @@ a resultset from the schema to operate on
 =cut
 
 has 'resultset' => (
-  is      => 'rw',
-  isa      => Str,
+  is  => 'rw',
+  isa => Str,
 );
 
 
@@ -117,8 +115,8 @@ a hash ref or json string to be used for identifying data to manipulate
 
 has 'where' => (
   is      => 'rw',
-  isa      => DBICHashRef,
-  coerce    => 1,
+  isa     => DBICHashRef,
+  coerce  => 1,
 );
 
 
@@ -130,8 +128,8 @@ a hash ref or json string to be used for inserting or updating data
 
 has 'set' => (
   is      => 'rw',
-  isa      => DBICHashRef,
-  coerce    => 1,
+  isa     => DBICHashRef,
+  coerce  => 1,
 );
 
 
@@ -142,9 +140,9 @@ a hash ref or json string to be used for passing additonal info to the ->search
 =cut
 
 has 'attrs' => (
-  is       => 'rw',
-  isa      => DBICHashRef,
-  coerce    => 1,
+  is      => 'rw',
+  isa     => DBICHashRef,
+  coerce  => 1,
 );
 
 
@@ -155,10 +153,10 @@ connect_info the arguments to provide to the connect call of the schema_class
 =cut
 
 has 'connect_info' => (
-  is      => 'ro',
-  isa      => DBICConnectInfo,
+  is          => 'ro',
+  isa         => DBICConnectInfo,
   lazy_build  => 1,
-  coerce    => 1,
+  coerce      => 1,
 );
 
 sub _build_connect_info {
@@ -177,8 +175,8 @@ The config file should be in a format readable by Config::General
 
 has config_file => (
   is      => 'ro',
-  isa      => File,
-  coerce    => 1,
+  isa     => File,
+  coerce  => 1,
 );
 
 
@@ -190,8 +188,8 @@ designed for use with catalyst config files
 =cut
 
 has 'config_stanza' => (
-  is      => 'ro',
-  isa      => Str,
+  is  => 'ro',
+  isa => Str,
 );
 
 
@@ -203,14 +201,16 @@ config_stanza will still be required.
 =cut
 
 has config => (
-  is      => 'ro',
-  isa      => DBICHashRef,
+  is          => 'ro',
+  isa         => DBICHashRef,
   lazy_build  => 1,
 );
 
 sub _build_config {
   my ($self) = @_;
-  try { require Config::Any } catch { $self->throw_exception( "Config::Any is required to parse the config file"); };
+
+  eval { require Config::Any }
+    or die ("Config::Any is required to parse the config file.\n");
 
   my $cfg = Config::Any->load_files ( {files => [$self->config_file], use_ext =>1, flatten_to_hash=>1});
 
@@ -228,8 +228,8 @@ The location where sql ddl files should be created or found for an upgrade.
 
 has 'sql_dir' => (
   is      => 'ro',
-  isa      => Dir,
-  coerce    => 1,
+  isa     => Dir,
+  coerce  => 1,
 );
 
 
@@ -240,8 +240,8 @@ Used for install, the version which will be 'installed' in the schema
 =cut
 
 has version => (
-  is      => 'rw',
-  isa      => Str,
+  is  => 'rw',
+  isa => Str,
 );
 
 
@@ -252,8 +252,8 @@ Previouse version of the schema to create an upgrade diff for, the full sql for
 =cut
 
 has preversion => (
-  is      => 'rw',
-  isa      => Str,
+  is  => 'rw',
+  isa => Str,
 );
 
 
@@ -264,8 +264,8 @@ Try and force certain operations.
 =cut
 
 has force => (
-  is      => 'rw',
-  isa      => Bool,
+  is  => 'rw',
+  isa => Bool,
 );
 
 
@@ -276,13 +276,13 @@ Be less verbose about actions
 =cut
 
 has quiet => (
-  is      => 'rw',
-  isa      => Bool,
+  is  => 'rw',
+  isa => Bool,
 );
 
 has '_confirm' => (
-  is    => 'bare',
-  isa    => Bool,
+  is  => 'bare',
+  isa => Bool,
 );
 
 
@@ -336,7 +336,7 @@ sub upgrade {
   my $schema = $self->schema();
   if (!$schema->get_db_version()) {
     # schema is unversioned
-    $self->throw_exception ("could not determin current schema version, please either install or deploy");
+    $schema->throw_exception ("Could not determin current schema version, please either install() or deploy().\n");
   } else {
     my $ret = $schema->upgrade();
     return $ret;
@@ -377,7 +377,7 @@ sub install {
     }
   }
   else {
-    $self->throw_exception ("schema already has a version not installing, try upgrade instead");
+    $schema->throw_exception ("Schema already has a version. Try upgrade instead.\n");
   }
 
 }
@@ -402,9 +402,9 @@ sub deploy {
   if (!$schema->get_db_version() ) {
     # schema is unversioned
     $schema->deploy( $args, $self->sql_dir)
-      or $self->throw_exception ("could not deploy schema");
+      or $schema->throw_exception ("Could not deploy schema.\n"); # FIXME deploy() does not return 1/0 on success/fail
   } else {
-    $self->throw_exception("there already is a database with a version here, try upgrade instead");
+    $schema->throw_exception("A versioned schema has already been deployed, try upgrade instead.\n");
   }
 }
 
@@ -549,13 +549,13 @@ sub _find_stanza {
       $cfg = $cfg->{$path};
     }
     else {
-      $self->throw_exception("could not find $stanza in config, $path did not seem to exist");
+      die ("Could not find $stanza in config, $path does not seem to exist.\n");
     }
   }
   return $cfg;
 }
 
-=head1 AUTHORS
+=head1 AUTHOR
 
 See L<DBIx::Class/CONTRIBUTORS>.