Some cleaup, make use of Text::CSV
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Admin.pm
index 213dae0..bd7cec6 100644 (file)
@@ -1,69 +1,54 @@
-#
-#===============================================================================
-#
-#         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 -declare => [qw( DBICConnectInfo )];
-use MooseX::Types::Moose qw/Int HashRef ArrayRef Str Any/;
-use MooseX::Types::JSON qw(JSON);
-use MooseX::Types::Path::Class qw(Dir File);
-use Try::Tiny;
+# 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;
+      }
+    }
 
-use Carp::Clan qw/^DBIx::Class/;
+    if (@_missing_deps > 0) {
+      die "The following dependecies are missing " . join ",", @_missing_deps;
+    }
+}
 
-use parent 'Class::C3::Componentised';
+use Moose;
 use parent 'DBIx::Class::Schema';
+use Carp::Clan qw/^DBIx::Class/;
 
-use JSON::Any;
-
+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 qw(DWIW XS JSON);
 use namespace::autoclean;
 
-my @_deps = qw(Moose MooseX::Types MooseX::Types::JSON MooseX::Types::Path::Class Try::Tiny parent JSON::Any Class::C3::Componentised namespace::autoclean);
-
-coerce ArrayRef,
-  from JSON,
-  via { _json_to_data ($_) };
-
-coerce HashRef,
-  from JSON,
-  via { _json_to_data($_) };
-
-subtype DBICConnectInfo,
-  as ArrayRef;
-
-coerce DBICConnectInfo,
-  from JSON,
-   via { return _json_to_data($_) } ;
-
-coerce DBICConnectInfo,
-  from Str,
-    via { return _json_to_data($_) };
-
-coerce DBICConnectInfo,
-  from HashRef,
-   via { [ $_->{dsn}, $_->{user}, $_->{password} ]  };
-
-
 =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
@@ -85,6 +70,32 @@ DBIx::Class::Admin - Administration object for schemas
   # install a version for an unversioned schema
   $admin->install("3.0");
 
+=head1 REQUIREMENTS
+
+The following CPAN modules are required to use C<dbicadmin> and this module:
+
+L<Moose>
+
+L<MooseX::Types>
+
+L<MooseX::Types::JSON>
+
+L<MooseX::Types::Path::Class>
+
+L<Try::Tiny>
+
+L<parent>
+
+L<JSON::Any>
+
+(L<JSON::DWIW> preferred for barekey support)
+
+L<namespace::autoclean>
+
+L<Getopt::Long::Descriptive>
+
+L<Text::CSV>
+
 =head1 Attributes
 
 =head2 schema_class
@@ -95,8 +106,7 @@ the class of the schema to load
 
 has 'schema_class' => (
   is    => 'ro',
-  isa    => 'Str',
-  coerce  => 1,
+  isa    => Str,
 );
 
 
@@ -141,7 +151,7 @@ a hash ref or json string to be used for identifying data to manipulate
 
 has 'where' => (
   is      => 'rw',
-  isa      => HashRef,
+  isa      => DBICHashRef,
   coerce    => 1,
 );
 
@@ -154,7 +164,7 @@ a hash ref or json string to be used for inserting or updating data
 
 has 'set' => (
   is      => 'rw',
-  isa      => HashRef,
+  isa      => DBICHashRef,
   coerce    => 1,
 );
 
@@ -167,7 +177,7 @@ a hash ref or json string to be used for passing additonal info to the ->search
 
 has 'attrs' => (
   is       => 'rw',
-  isa      => HashRef,
+  isa      => DBICHashRef,
   coerce    => 1,
 );
 
@@ -215,7 +225,7 @@ designed for use with catalyst config files
 
 has 'config_stanza' => (
   is      => 'ro',
-  isa      => 'Str',
+  isa      => Str,
 );
 
 
@@ -228,7 +238,7 @@ config_stanza will still be required.
 
 has config => (
   is      => 'ro',
-  isa      => HashRef,
+  isa      => DBICHashRef,
   lazy_build  => 1,
 );
 
@@ -265,7 +275,7 @@ Used for install, the version which will be 'installed' in the schema
 
 has version => (
   is      => 'rw',
-  isa      => 'Str',
+  isa      => Str,
 );
 
 
@@ -277,7 +287,7 @@ Previouse version of the schema to create an upgrade diff for, the full sql for
 
 has preversion => (
   is      => 'rw',
-  isa      => 'Str',
+  isa      => Str,
 );
 
 
@@ -289,7 +299,7 @@ Try and force certain operations.
 
 has force => (
   is      => 'rw',
-  isa      => 'Bool',
+  isa      => Bool,
 );
 
 
@@ -301,12 +311,12 @@ Be less verbose about actions
 
 has quiet => (
   is      => 'rw',
-  isa      => 'Bool',
+  isa      => Bool,
 );
 
 has '_confirm' => (
   is    => 'bare',
-  isa    => 'Bool',
+  isa    => Bool,
 );
 
 
@@ -579,33 +589,7 @@ sub _find_stanza {
   return $cfg;
 }
 
-sub _json_to_data {
-  my ($json_str) = @_;
-  my $json = JSON::Any->new(allow_barekey => 1, allow_singlequote => 1, relaxed=>1);
-  my $ret = $json->jsonToObj($json_str);
-  return $ret;
-}
-
-
-{  # deps check
-
-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;
-}
-
-
-}
-
-
-=head1 AUTHORS
+=head1 AUTHOR
 
 See L<DBIx::Class/CONTRIBUTORS>.