Add a hidden option to dbicadmin to self-inject autogenerated POD

[dbsrgits/DBIx-Class.git] / script / dbicadmin

diff --git a/script/dbicadmin b/script/dbicadmin
index c50c50b..44eba49 100755 (executable)
--- a/script/dbicadmin
+++ b/script/dbicadmin
@@ -3,26 +3,50 @@
 use strict;
 use warnings;
 
-use Getopt::Long::Descriptive;
+BEGIN {
+  use DBIx::Class;
+  die (  'The following modules are required for the dbicadmin utility: '
+       . DBIx::Class::Optional::Dependencies->req_missing_for ('admin_script')
+       . "\n"
+  ) unless DBIx::Class::Optional::Dependencies->req_ok_for ('admin_script');
+}
+
+use DBIx::Class::Admin::Descriptive;
+#use Getopt::Long::Descriptive;
 use DBIx::Class::Admin;
 
+my $short_description = "utility for administrating DBIx::Class schemata";
+my $synopsis_text =qq{ 
+  deploy a schema to a database
+  %c --schema=MyApp::Schema \
+    --connect='["dbi:SQLite:my.db", "", ""]' \
+    --deploy
+
+  update an existing record
+  %c --schema=MyApp::Schema --class=Employee \
+    --connect='["dbi:SQLite:my.db", "", ""]' \
+    --op=update --set='{ "name": "New_Employee" }'
+}
+;
+
 my ($opts, $usage) = describe_options(
-  "%c: %o",
+    "%c: %o",
   (
     ['Actions'],
     ["action" => hidden => { one_of => [
       ['create|c' => 'Create version diffs needs preversion',],
-      ['upgrade|u' => 'Upgrade the database to the current schema '],
-      ['install|i' => 'Install the schema to the database',],
+      ['upgrade|U' => 'Upgrade the database to the current schema '],
+      ['install|I' => 'Install the schema version tables to an existing database',],
       ['deploy|d' => 'Deploy the schema to the database',],
       ['select|s'   => 'Select data from the schema', ],
       ['insert|i'   => 'Insert data into the schema', ],
       ['update|u'   => 'Update data in the schema', ], 
       ['delete|D'   => 'Delete data from the schema',],
       ['op:s' => 'compatiblity option all of the above can be suppied as --op=<action>'],
-      ['help|h' => 'display this help'],
+      ['help|h' => 'display this help', { implies => { schema_class => '__dummy__' } } ],
+      ['selfinject-pod' => 'hidden', { implies => { schema_class => '__dummy__' } } ],
     ], required=> 1 }],
-    ['Options'],
+    ['Arguments'],
     ['schema-class|schema|C:s' => 'The class of the schema to load', { required => 1 } ],
     ['resultset|resultset_class|class|r:s' => 'The resultset to operate on for data manipulation' ],
     ['config-stanza|S:s' => 'Where in the config to find the connection_info, supply in form MyApp::Model::DB',],
@@ -34,7 +58,6 @@ my ($opts, $usage) = describe_options(
     ['version|v:i' => 'Supply a version install'],
     ['preversion|p:s' => 'The previous version to diff against',],
     ['set:s' => 'JSON data used to perform data operations' ],
-    ['lib|I:s' => 'Additonal library path to search in'], 
     ['attrs:s' => 'JSON string to be used for the second argument for search'],
     ['where:s' => 'JSON string to be used for the where clause of search'],
     ['force' => 'Be forceful with some operations'],
@@ -45,6 +68,25 @@ my ($opts, $usage) = describe_options(
 
 die "please only use one of --config or --connect-info\n" if ($opts->{config} and $opts->{connect_info});
 
+if($opts->{selfinject_pod}) {
+    $usage->synopsis($synopsis_text);
+    $usage->short_description($short_description);
+    exec (
+      $^X,
+      qw/-p -0777 -i -e/,
+      (
+        's/^# auto_pod_begin.*^# auto_pod_end/'
+      . quotemeta($usage->pod)
+      . '/ms'
+      ),
+      __FILE__
+    );
+}
+
+if($opts->{help}) {
+    $usage->die();
+}
+
 # option compatability mangle
 if($opts->{connect}) {
   $opts->{connect_info} = delete $opts->{connect};
@@ -78,14 +120,12 @@ if ($action eq 'select') {
 }
 
 
+__END__
 
-=head1 AUTHOR
-
-Aran Deltac <bluefeet@cpan.org>
-
-refactored by
-Gordon Irving <goraxe@cpan.org>
-
-=head1 LICENSE
+# auto_pod_begin
+#
+# This will be replaced by the actual pod when selfinject-pod is invoked
+#
+# auto_pod_end
 
-You may distribute this code under the same terms as Perl itself.
+# vim: et ft=perl