[Jifty-commit] r4793 - in jifty/trunk: lib/Jifty/Script

[jifty-commit at lists.jifty.org]

Author: sterling
Date: Mon Jan  7 09:37:20 2008
New Revision: 4793

Added:
   jifty/trunk/lib/Jifty/Script/Script.pm
Modified:
   jifty/trunk/   (props changed)

Log:
 r14712 at dynpc145:  andrew | 2008-01-07 08:36:31 -0600
 Adding a CLI thingy to generate stubs for command-line scripts.


Added: jifty/trunk/lib/Jifty/Script/Script.pm
==============================================================================
--- (empty file)
+++ jifty/trunk/lib/Jifty/Script/Script.pm	Mon Jan  7 09:37:20 2008
@@ -0,0 +1,107 @@
+use warnings;
+use strict;
+
+package Jifty::Script::Script;
+use base qw/ App::CLI::Command /;
+
+=head1 NAME
+
+Jifty::Script::Script - Add a new Jifty script to your Jifty application
+
+=head1 DESCRIPTION
+
+This creates a skeleton of a new script file for your Jifty application. Often it such a script is needed for cron jobs, annual maintenance work, and any other server-side activity that would benefit from a command-line script.
+
+=head1 API
+
+=head2 options
+
+=over
+
+=item --name NAME (required)
+
+Name of the script to create.
+
+=item --force
+
+By default, this will stop and warn you if any of the files it is going to write already exist. Passing the --force flag will make it overwrite the files.
+
+=back
+
+=cut
+
+sub options {
+    (
+        'n|name=s' => 'name',
+        'force'    => 'force',
+    )
+}
+
+=head2 run
+
+Creates a skeleton file under C<bin/I<script>>.
+
+TODO Should this create skeleton test files too?
+
+=cut
+
+sub run {
+    my $self = shift;
+
+    my $script = $self->{name};
+    die "You need to give your new model a --name\n"
+        unless defined $script;
+
+    Jifty->new( no_handle => 1 );
+    my $root = Jifty::Util->app_root;
+
+    my $script_file = <<"END_OF_SCRIPT";
+#!/usr/bin/env perl
+use strict;
+use warnings;
+
+use Jifty;
+BEGIN { 
+    Jifty->new;
+    push \@INC, Jifty::Util->app_root . '/lib');
+}
+
+# Your script-specific code goes here.
+
+END_OF_SCRIPT
+
+    $self->_write("$root/bin/$script" => $script_file);
+}
+
+# TODO This should be moved to Jifty::Util or somewhere else so all these
+# scripts don't duplicate it!
+sub _write {
+    my $self = shift;
+    my %files = (@_);
+    my $halt;
+    for my $path (keys %files) {
+        my ($volume, $dir, $file) = File::Spec->splitpath($path);
+
+        # Make sure the directories we need are there
+	Jifty::Util->make_path($dir);
+
+        # If it already exists, bail
+        if (-e $path and not $self->{force}) {
+            print "File $path exists already; Use --force to overwrite\n";
+            $halt = 11;
+        }
+    }
+    exit if $halt;
+    
+    # Now that we've san-checked everything, we can write the files
+    for my $path (keys %files) {
+        print "Writing file $path\n";
+        # Actually write the file out
+        open(FILE, ">$path")
+          or die "Can't write to $path: $!";
+        print FILE $files{$path};
+        close FILE;
+    }
+}
+
+1;